diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a655ceea5..9eb4ffcd2 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -16,6 +16,18 @@ Catena-X alliance focusing on parts traceability. * https://projects.eclipse.org/projects/automotive.tractusx +## Project licenses + +The Tractus-X project uses the following licenses: + +* CC-BY-4.0 for non-code + +## Terms of Use + +This repository is subject to the Terms of Use of the Eclipse Foundation + +* https://www.eclipse.org/legal/termsofuse.php + ## Developer resources Information regarding source code management, builds, coding standards, and @@ -23,9 +35,12 @@ more. * https://projects.eclipse.org/projects/automotive.tractusx/developer +Getting started: + +* https://eclipse-tractusx.github.io/docs/developer + The project maintains the following source code repositories -* https://github.com/eclipse/tractusx * https://github.com/eclipse-tractusx/sldt-semantic-hub * https://github.com/eclipse-tractusx/sldt-digital-twin-registry * https://github.com/eclipse-tractusx/portal-frontend diff --git a/LICENSE b/LICENSE deleted file mode 100644 index 2e0acad08..000000000 --- a/LICENSE +++ /dev/null @@ -1,104 +0,0 @@ -Creative Commons Attribution 4.0 International - -Creative Commons Corporation ("Creative Commons") is not a law firm and does not provide legal services or legal advice. Distribution of Creative Commons public licenses does not create a lawyer-client or other relationship. Creative Commons makes its licenses and related information available on an "as-is" basis. Creative Commons gives no warranties regarding its licenses, any material licensed under their terms and conditions, or any related information. Creative Commons disclaims all liability for damages resulting from their use to the fullest extent possible. - -Using Creative Commons Public Licenses - -Creative Commons public licenses provide a standard set of terms and conditions that creators and other rights holders may use to share original works of authorship and other material subject to copyright and certain other rights specified in the public license below. The following considerations are for informational purposes only, are not exhaustive, and do not form part of our licenses. - -Considerations for licensors: Our public licenses are intended for use by those authorized to give the public permission to use material in ways otherwise restricted by copyright and certain other rights. Our licenses are irrevocable. Licensors should read and understand the terms and conditions of the license they choose before applying it. Licensors should also secure all rights necessary before applying our licenses so that the public can reuse the material as expected. Licensors should clearly mark any material not subject to the license. This includes other CC-licensed material, or material used under an exception or limitation to copyright. More considerations for licensors : wiki.creativecommons.org/Considerations_for_licensors - -Considerations for the public: By using one of our public licenses, a licensor grants the public permission to use the licensed material under specified terms and conditions. If the licensor's permission is not necessary for any reason–for example, because of any applicable exception or limitation to copyright–then that use is not regulated by the license. Our licenses grant only permissions under copyright and certain other rights that a licensor has authority to grant. Use of the licensed material may still be restricted for other reasons, including because others have copyright or other rights in the material. A licensor may make special requests, such as asking that all changes be marked or described. Although not required by our licenses, you are encouraged to respect those requests where reasonable. More considerations for the public : wiki.creativecommons.org/Considerations_for_licensees - -Creative Commons Attribution 4.0 International Public License - -By exercising the Licensed Rights (defined below), You accept and agree to be bound by the terms and conditions of this Creative Commons Attribution 4.0 International Public License ("Public License"). To the extent this Public License may be interpreted as a contract, You are granted the Licensed Rights in consideration of Your acceptance of these terms and conditions, and the Licensor grants You such rights in consideration of benefits the Licensor receives from making the Licensed Material available under these terms and conditions. - -Section 1 – Definitions. - -a. Adapted Material means material subject to Copyright and Similar Rights that is derived from or based upon the Licensed Material and in which the Licensed Material is translated, altered, arranged, transformed, or otherwise modified in a manner requiring permission under the Copyright and Similar Rights held by the Licensor. For purposes of this Public License, where the Licensed Material is a musical work, performance, or sound recording, Adapted Material is always produced where the Licensed Material is synched in timed relation with a moving image. -b. Adapter's License means the license You apply to Your Copyright and Similar Rights in Your contributions to Adapted Material in accordance with the terms and conditions of this Public License. -c. Copyright and Similar Rights means copyright and/or similar rights closely related to copyright including, without limitation, performance, broadcast, sound recording, and Sui Generis Database Rights, without regard to how the rights are labeled or categorized. For purposes of this Public License, the rights specified in Section 2(b)(1)-(2) are not Copyright and Similar Rights. -d. Effective Technological Measures means those measures that, in the absence of proper authority, may not be circumvented under laws fulfilling obligations under Article 11 of the WIPO Copyright Treaty adopted on December 20, 1996, and/or similar international agreements. -e. Exceptions and Limitations means fair use, fair dealing, and/or any other exception or limitation to Copyright and Similar Rights that applies to Your use of the Licensed Material. -f. Licensed Material means the artistic or literary work, database, or other material to which the Licensor applied this Public License. -g. Licensed Rights means the rights granted to You subject to the terms and conditions of this Public License, which are limited to all Copyright and Similar Rights that apply to Your use of the Licensed Material and that the Licensor has authority to license. -h. Licensor means the individual(s) or entity(ies) granting rights under this Public License. -i. Share means to provide material to the public by any means or process that requires permission under the Licensed Rights, such as reproduction, public display, public performance, distribution, dissemination, communication, or importation, and to make material available to the public including in ways that members of the public may access the material from a place and at a time individually chosen by them. -j. Sui Generis Database Rights means rights other than copyright resulting from Directive 96/9/EC of the European Parliament and of the Council of 11 March 1996 on the legal protection of databases, as amended and/or succeeded, as well as other essentially equivalent rights anywhere in the world. -k. You means the individual or entity exercising the Licensed Rights under this Public License. Your has a corresponding meaning. - -Section 2 – Scope. - -a. License grant. -1. Subject to the terms and conditions of this Public License, the Licensor hereby grants You a worldwide, royalty-free, non-sublicensable, non-exclusive, irrevocable license to exercise the Licensed Rights in the Licensed Material to: -A. reproduce and Share the Licensed Material, in whole or in part; and -B. produce, reproduce, and Share Adapted Material. -2. Exceptions and Limitations. For the avoidance of doubt, where Exceptions and Limitations apply to Your use, this Public License does not apply, and You do not need to comply with its terms and conditions. -3. Term. The term of this Public License is specified in Section 6(a). -4. Media and formats; technical modifications allowed. The Licensor authorizes You to exercise the Licensed Rights in all media and formats whether now known or hereafter created, and to make technical modifications necessary to do so. The Licensor waives and/or agrees not to assert any right or authority to forbid You from making technical modifications necessary to exercise the Licensed Rights, including technical modifications necessary to circumvent Effective Technological Measures. For purposes of this Public License, simply making modifications authorized by this Section 2(a)(4) never produces Adapted Material. -5. Downstream recipients. -A. Offer from the Licensor – Licensed Material. Every recipient of the Licensed Material automatically receives an offer from the Licensor to exercise the Licensed Rights under the terms and conditions of this Public License. -B. No downstream restrictions. You may not offer or impose any additional or different terms or conditions on, or apply any Effective Technological Measures to, the Licensed Material if doing so restricts exercise of the Licensed Rights by any recipient of the Licensed Material. -6. No endorsement. Nothing in this Public License constitutes or may be construed as permission to assert or imply that You are, or that Your use of the Licensed Material is, connected with, or sponsored, endorsed, or granted official status by, the Licensor or others designated to receive attribution as provided in Section 3(a)(1)(A)(i). -b. Other rights. -1. Moral rights, such as the right of integrity, are not licensed under this Public License, nor are publicity, privacy, and/or other similar personality rights; however, to the extent possible, the Licensor waives and/or agrees not to assert any such rights held by the Licensor to the limited extent necessary to allow You to exercise the Licensed Rights, but not otherwise. -2. Patent and trademark rights are not licensed under this Public License. -3. To the extent possible, the Licensor waives any right to collect royalties from You for the exercise of the Licensed Rights, whether directly or through a collecting society under any voluntary or waivable statutory or compulsory licensing scheme. In all other cases the Licensor expressly reserves any right to collect such royalties. - -Section 3 – License Conditions. - -Your exercise of the Licensed Rights is expressly made subject to the following conditions. - -a. Attribution. -1. If You Share the Licensed Material (including in modified form), You must: -A. retain the following if it is supplied by the Licensor with the Licensed Material: -i. identification of the creator(s) of the Licensed Material and any others designated to receive attribution, in any reasonable manner requested by the Licensor (including by pseudonym if designated); -ii. a copyright notice; -iii. a notice that refers to this Public License; -iv. a notice that refers to the disclaimer of warranties; -v. a URI or hyperlink to the Licensed Material to the extent reasonably practicable; -B. indicate if You modified the Licensed Material and retain an indication of any previous modifications; and -C. indicate the Licensed Material is licensed under this Public License, and include the text of, or the URI or hyperlink to, this Public License. -2. You may satisfy the conditions in Section 3(a)(1) in any reasonable manner based on the medium, means, and context in which You Share the Licensed Material. For example, it may be reasonable to satisfy the conditions by providing a URI or hyperlink to a resource that includes the required information. -3. If requested by the Licensor, You must remove any of the information required by Section 3(a)(1)(A) to the extent reasonably practicable. -4. If You Share Adapted Material You produce, the Adapter's License You apply must not prevent recipients of the Adapted Material from complying with this Public License. - -Section 4 – Sui Generis Database Rights. - -Where the Licensed Rights include Sui Generis Database Rights that apply to Your use of the Licensed Material: - -a. for the avoidance of doubt, Section 2(a)(1) grants You the right to extract, reuse, reproduce, and Share all or a substantial portion of the contents of the database; -b. if You include all or a substantial portion of the database contents in a database in which You have Sui Generis Database Rights, then the database in which You have Sui Generis Database Rights (but not its individual contents) is Adapted Material; and -c. You must comply with the conditions in Section 3(a) if You Share all or a substantial portion of the contents of the database. -For the avoidance of doubt, this Section 4 supplements and does not replace Your obligations under this Public License where the Licensed Rights include other Copyright and Similar Rights. - -Section 5 – Disclaimer of Warranties and Limitation of Liability. - -a. Unless otherwise separately undertaken by the Licensor, to the extent possible, the Licensor offers the Licensed Material as-is and as-available, and makes no representations or warranties of any kind concerning the Licensed Material, whether express, implied, statutory, or other. This includes, without limitation, warranties of title, merchantability, fitness for a particular purpose, non-infringement, absence of latent or other defects, accuracy, or the presence or absence of errors, whether or not known or discoverable. Where disclaimers of warranties are not allowed in full or in part, this disclaimer may not apply to You. -b. To the extent possible, in no event will the Licensor be liable to You on any legal theory (including, without limitation, negligence) or otherwise for any direct, special, indirect, incidental, consequential, punitive, exemplary, or other losses, costs, expenses, or damages arising out of this Public License or use of the Licensed Material, even if the Licensor has been advised of the possibility of such losses, costs, expenses, or damages. Where a limitation of liability is not allowed in full or in part, this limitation may not apply to You. -c. The disclaimer of warranties and limitation of liability provided above shall be interpreted in a manner that, to the extent possible, most closely approximates an absolute disclaimer and waiver of all liability. -Section 6 – Term and Termination. - -a. This Public License applies for the term of the Copyright and Similar Rights licensed here. However, if You fail to comply with this Public License, then Your rights under this Public License terminate automatically. -b. Where Your right to use the Licensed Material has terminated under Section 6(a), it reinstates: -1. automatically as of the date the violation is cured, provided it is cured within 30 days of Your discovery of the violation; or -2. upon express reinstatement by the Licensor. -c. For the avoidance of doubt, this Section 6(b) does not affect any right the Licensor may have to seek remedies for Your violations of this Public License. -d. For the avoidance of doubt, the Licensor may also offer the Licensed Material under separate terms or conditions or stop distributing the Licensed Material at any time; however, doing so will not terminate this Public License. -e. Sections 1, 5, 6, 7, and 8 survive termination of this Public License. - -Section 7 – Other Terms and Conditions. - -a. The Licensor shall not be bound by any additional or different terms or conditions communicated by You unless expressly agreed. -b. Any arrangements, understandings, or agreements regarding the Licensed Material not stated herein are separate from and independent of the terms and conditions of this Public License. - -ection 8 – Interpretation. - -a. For the avoidance of doubt, this Public License does not, and shall not be interpreted to, reduce, limit, restrict, or impose conditions on any use of the Licensed Material that could lawfully be made without permission under this Public License. -b. To the extent possible, if any provision of this Public License is deemed unenforceable, it shall be automatically reformed to the minimum extent necessary to make it enforceable. If the provision cannot be reformed, it shall be severed from this Public License without affecting the enforceability of the remaining terms and conditions. -c. No term or condition of this Public License will be waived and no failure to comply consented to unless expressly agreed to by the Licensor. -d. Nothing in this Public License constitutes or may be interpreted as a limitation upon, or waiver of, any privileges and immunities that apply to the Licensor or You, including from the legal processes of any jurisdiction or authority. -Creative Commons is not a party to its public licenses. Notwithstanding, Creative Commons may elect to apply one of its public licenses to material it publishes and in those instances will be considered the "Licensor." The text of the Creative Commons public licenses is dedicated to the public domain under the CC0 Public Domain Dedication. Except for the limited purpose of indicating that material is shared under a Creative Commons public license or as otherwise permitted by the Creative Commons policies published at creativecommons.org/policies, Creative Commons does not authorize the use of the trademark "Creative Commons" or any other trademark or logo of Creative Commons without its prior written consent including, without limitation, in connection with any unauthorized modifications to any of its public licenses or any other arrangements, understandings, or agreements concerning use of licensed material. For the avoidance of doubt, this paragraph does not form part of the public licenses. - -Creative Commons may be contacted at creativecommons.org. diff --git a/LICENSE_non-code b/LICENSE_non-code new file mode 100644 index 000000000..52665ed2a --- /dev/null +++ b/LICENSE_non-code @@ -0,0 +1,395 @@ +Creative Commons Attribution 4.0 International + +======================================================================= + +Creative Commons Corporation ("Creative Commons") is not a law firm and +does not provide legal services or legal advice. Distribution of +Creative Commons public licenses does not create a lawyer-client or +other relationship. Creative Commons makes its licenses and related +information available on an "as-is" basis. Creative Commons gives no +warranties regarding its licenses, any material licensed under their +terms and conditions, or any related information. Creative Commons +disclaims all liability for damages resulting from their use to the +fullest extent possible. + +Using Creative Commons Public Licenses + +Creative Commons public licenses provide a standard set of terms and +conditions that creators and other rights holders may use to share +original works of authorship and other material subject to copyright +and certain other rights specified in the public license below. The +following considerations are for informational purposes only, are not +exhaustive, and do not form part of our licenses. + + Considerations for licensors: Our public licenses are + intended for use by those authorized to give the public + permission to use material in ways otherwise restricted by + copyright and certain other rights. Our licenses are + irrevocable. Licensors should read and understand the terms + and conditions of the license they choose before applying it. + Licensors should also secure all rights necessary before + applying our licenses so that the public can reuse the + material as expected. Licensors should clearly mark any + material not subject to the license. This includes other CC- + licensed material, or material used under an exception or + limitation to copyright. More considerations for licensors: + wiki.creativecommons.org/Considerations_for_licensors + + Considerations for the public: By using one of our public + licenses, a licensor grants the public permission to use the + licensed material under specified terms and conditions. If + the licensor's permission is not necessary for any reason--for + example, because of any applicable exception or limitation to + copyright--then that use is not regulated by the license. Our + licenses grant only permissions under copyright and certain + other rights that a licensor has authority to grant. Use of + the licensed material may still be restricted for other + reasons, including because others have copyright or other + rights in the material. A licensor may make special requests, + such as asking that all changes be marked or described. + Although not required by our licenses, you are encouraged to + respect those requests where reasonable. More considerations + for the public: + wiki.creativecommons.org/Considerations_for_licensees + +======================================================================= + +Creative Commons Attribution 4.0 International Public License + +By exercising the Licensed Rights (defined below), You accept and agree +to be bound by the terms and conditions of this Creative Commons +Attribution 4.0 International Public License ("Public License"). To the +extent this Public License may be interpreted as a contract, You are +granted the Licensed Rights in consideration of Your acceptance of +these terms and conditions, and the Licensor grants You such rights in +consideration of benefits the Licensor receives from making the +Licensed Material available under these terms and conditions. + + +Section 1 -- Definitions. + + a. Adapted Material means material subject to Copyright and Similar + Rights that is derived from or based upon the Licensed Material + and in which the Licensed Material is translated, altered, + arranged, transformed, or otherwise modified in a manner requiring + permission under the Copyright and Similar Rights held by the + Licensor. For purposes of this Public License, where the Licensed + Material is a musical work, performance, or sound recording, + Adapted Material is always produced where the Licensed Material is + synched in timed relation with a moving image. + + b. Adapter's License means the license You apply to Your Copyright + and Similar Rights in Your contributions to Adapted Material in + accordance with the terms and conditions of this Public License. + + c. Copyright and Similar Rights means copyright and/or similar rights + closely related to copyright including, without limitation, + performance, broadcast, sound recording, and Sui Generis Database + Rights, without regard to how the rights are labeled or + categorized. For purposes of this Public License, the rights + specified in Section 2(b)(1)-(2) are not Copyright and Similar + Rights. + + d. Effective Technological Measures means those measures that, in the + absence of proper authority, may not be circumvented under laws + fulfilling obligations under Article 11 of the WIPO Copyright + Treaty adopted on December 20, 1996, and/or similar international + agreements. + + e. Exceptions and Limitations means fair use, fair dealing, and/or + any other exception or limitation to Copyright and Similar Rights + that applies to Your use of the Licensed Material. + + f. Licensed Material means the artistic or literary work, database, + or other material to which the Licensor applied this Public + License. + + g. Licensed Rights means the rights granted to You subject to the + terms and conditions of this Public License, which are limited to + all Copyright and Similar Rights that apply to Your use of the + Licensed Material and that the Licensor has authority to license. + + h. Licensor means the individual(s) or entity(ies) granting rights + under this Public License. + + i. Share means to provide material to the public by any means or + process that requires permission under the Licensed Rights, such + as reproduction, public display, public performance, distribution, + dissemination, communication, or importation, and to make material + available to the public including in ways that members of the + public may access the material from a place and at a time + individually chosen by them. + + j. Sui Generis Database Rights means rights other than copyright + resulting from Directive 96/9/EC of the European Parliament and of + the Council of 11 March 1996 on the legal protection of databases, + as amended and/or succeeded, as well as other essentially + equivalent rights anywhere in the world. + + k. You means the individual or entity exercising the Licensed Rights + under this Public License. Your has a corresponding meaning. + + +Section 2 -- Scope. + + a. License grant. + + 1. Subject to the terms and conditions of this Public License, + the Licensor hereby grants You a worldwide, royalty-free, + non-sublicensable, non-exclusive, irrevocable license to + exercise the Licensed Rights in the Licensed Material to: + + a. reproduce and Share the Licensed Material, in whole or + in part; and + + b. produce, reproduce, and Share Adapted Material. + + 2. Exceptions and Limitations. For the avoidance of doubt, where + Exceptions and Limitations apply to Your use, this Public + License does not apply, and You do not need to comply with + its terms and conditions. + + 3. Term. The term of this Public License is specified in Section + 6(a). + + 4. Media and formats; technical modifications allowed. The + Licensor authorizes You to exercise the Licensed Rights in + all media and formats whether now known or hereafter created, + and to make technical modifications necessary to do so. The + Licensor waives and/or agrees not to assert any right or + authority to forbid You from making technical modifications + necessary to exercise the Licensed Rights, including + technical modifications necessary to circumvent Effective + Technological Measures. For purposes of this Public License, + simply making modifications authorized by this Section 2(a) + (4) never produces Adapted Material. + + 5. Downstream recipients. + + a. Offer from the Licensor -- Licensed Material. Every + recipient of the Licensed Material automatically + receives an offer from the Licensor to exercise the + Licensed Rights under the terms and conditions of this + Public License. + + b. No downstream restrictions. You may not offer or impose + any additional or different terms or conditions on, or + apply any Effective Technological Measures to, the + Licensed Material if doing so restricts exercise of the + Licensed Rights by any recipient of the Licensed + Material. + + 6. No endorsement. Nothing in this Public License constitutes or + may be construed as permission to assert or imply that You + are, or that Your use of the Licensed Material is, connected + with, or sponsored, endorsed, or granted official status by, + the Licensor or others designated to receive attribution as + provided in Section 3(a)(1)(A)(i). + + b. Other rights. + + 1. Moral rights, such as the right of integrity, are not + licensed under this Public License, nor are publicity, + privacy, and/or other similar personality rights; however, to + the extent possible, the Licensor waives and/or agrees not to + assert any such rights held by the Licensor to the limited + extent necessary to allow You to exercise the Licensed + Rights, but not otherwise. + + 2. Patent and trademark rights are not licensed under this + Public License. + + 3. To the extent possible, the Licensor waives any right to + collect royalties from You for the exercise of the Licensed + Rights, whether directly or through a collecting society + under any voluntary or waivable statutory or compulsory + licensing scheme. In all other cases the Licensor expressly + reserves any right to collect such royalties. + + +Section 3 -- License Conditions. + +Your exercise of the Licensed Rights is expressly made subject to the +following conditions. + + a. Attribution. + + 1. If You Share the Licensed Material (including in modified + form), You must: + + a. retain the following if it is supplied by the Licensor + with the Licensed Material: + + i. identification of the creator(s) of the Licensed + Material and any others designated to receive + attribution, in any reasonable manner requested by + the Licensor (including by pseudonym if + designated); + + ii. a copyright notice; + + iii. a notice that refers to this Public License; + + iv. a notice that refers to the disclaimer of + warranties; + + v. a URI or hyperlink to the Licensed Material to the + extent reasonably practicable; + + b. indicate if You modified the Licensed Material and + retain an indication of any previous modifications; and + + c. indicate the Licensed Material is licensed under this + Public License, and include the text of, or the URI or + hyperlink to, this Public License. + + 2. You may satisfy the conditions in Section 3(a)(1) in any + reasonable manner based on the medium, means, and context in + which You Share the Licensed Material. For example, it may be + reasonable to satisfy the conditions by providing a URI or + hyperlink to a resource that includes the required + information. + + 3. If requested by the Licensor, You must remove any of the + information required by Section 3(a)(1)(A) to the extent + reasonably practicable. + + 4. If You Share Adapted Material You produce, the Adapter's + License You apply must not prevent recipients of the Adapted + Material from complying with this Public License. + + +Section 4 -- Sui Generis Database Rights. + +Where the Licensed Rights include Sui Generis Database Rights that +apply to Your use of the Licensed Material: + + a. for the avoidance of doubt, Section 2(a)(1) grants You the right + to extract, reuse, reproduce, and Share all or a substantial + portion of the contents of the database; + + b. if You include all or a substantial portion of the database + contents in a database in which You have Sui Generis Database + Rights, then the database in which You have Sui Generis Database + Rights (but not its individual contents) is Adapted Material; and + + c. You must comply with the conditions in Section 3(a) if You Share + all or a substantial portion of the contents of the database. + +For the avoidance of doubt, this Section 4 supplements and does not +replace Your obligations under this Public License where the Licensed +Rights include other Copyright and Similar Rights. + + +Section 5 -- Disclaimer of Warranties and Limitation of Liability. + + a. UNLESS OTHERWISE SEPARATELY UNDERTAKEN BY THE LICENSOR, TO THE + EXTENT POSSIBLE, THE LICENSOR OFFERS THE LICENSED MATERIAL AS-IS + AND AS-AVAILABLE, AND MAKES NO REPRESENTATIONS OR WARRANTIES OF + ANY KIND CONCERNING THE LICENSED MATERIAL, WHETHER EXPRESS, + IMPLIED, STATUTORY, OR OTHER. THIS INCLUDES, WITHOUT LIMITATION, + WARRANTIES OF TITLE, MERCHANTABILITY, FITNESS FOR A PARTICULAR + PURPOSE, NON-INFRINGEMENT, ABSENCE OF LATENT OR OTHER DEFECTS, + ACCURACY, OR THE PRESENCE OR ABSENCE OF ERRORS, WHETHER OR NOT + KNOWN OR DISCOVERABLE. WHERE DISCLAIMERS OF WARRANTIES ARE NOT + ALLOWED IN FULL OR IN PART, THIS DISCLAIMER MAY NOT APPLY TO YOU. + + b. TO THE EXTENT POSSIBLE, IN NO EVENT WILL THE LICENSOR BE LIABLE + TO YOU ON ANY LEGAL THEORY (INCLUDING, WITHOUT LIMITATION, + NEGLIGENCE) OR OTHERWISE FOR ANY DIRECT, SPECIAL, INDIRECT, + INCIDENTAL, CONSEQUENTIAL, PUNITIVE, EXEMPLARY, OR OTHER LOSSES, + COSTS, EXPENSES, OR DAMAGES ARISING OUT OF THIS PUBLIC LICENSE OR + USE OF THE LICENSED MATERIAL, EVEN IF THE LICENSOR HAS BEEN + ADVISED OF THE POSSIBILITY OF SUCH LOSSES, COSTS, EXPENSES, OR + DAMAGES. WHERE A LIMITATION OF LIABILITY IS NOT ALLOWED IN FULL OR + IN PART, THIS LIMITATION MAY NOT APPLY TO YOU. + + c. The disclaimer of warranties and limitation of liability provided + above shall be interpreted in a manner that, to the extent + possible, most closely approximates an absolute disclaimer and + waiver of all liability. + + +Section 6 -- Term and Termination. + + a. This Public License applies for the term of the Copyright and + Similar Rights licensed here. However, if You fail to comply with + this Public License, then Your rights under this Public License + terminate automatically. + + b. Where Your right to use the Licensed Material has terminated under + Section 6(a), it reinstates: + + 1. automatically as of the date the violation is cured, provided + it is cured within 30 days of Your discovery of the + violation; or + + 2. upon express reinstatement by the Licensor. + + For the avoidance of doubt, this Section 6(b) does not affect any + right the Licensor may have to seek remedies for Your violations + of this Public License. + + c. For the avoidance of doubt, the Licensor may also offer the + Licensed Material under separate terms or conditions or stop + distributing the Licensed Material at any time; however, doing so + will not terminate this Public License. + + d. Sections 1, 5, 6, 7, and 8 survive termination of this Public + License. + + +Section 7 -- Other Terms and Conditions. + + a. The Licensor shall not be bound by any additional or different + terms or conditions communicated by You unless expressly agreed. + + b. Any arrangements, understandings, or agreements regarding the + Licensed Material not stated herein are separate from and + independent of the terms and conditions of this Public License. + + +Section 8 -- Interpretation. + + a. For the avoidance of doubt, this Public License does not, and + shall not be interpreted to, reduce, limit, restrict, or impose + conditions on any use of the Licensed Material that could lawfully + be made without permission under this Public License. + + b. To the extent possible, if any provision of this Public License is + deemed unenforceable, it shall be automatically reformed to the + minimum extent necessary to make it enforceable. If the provision + cannot be reformed, it shall be severed from this Public License + without affecting the enforceability of the remaining terms and + conditions. + + c. No term or condition of this Public License will be waived and no + failure to comply consented to unless expressly agreed to by the + Licensor. + + d. Nothing in this Public License constitutes or may be interpreted + as a limitation upon, or waiver of, any privileges and immunities + that apply to the Licensor or You, including from the legal + processes of any jurisdiction or authority. + + +======================================================================= + +Creative Commons is not a party to its public +licenses. Notwithstanding, Creative Commons may elect to apply one of +its public licenses to material it publishes and in those instances +will be considered the “Licensor.” The text of the Creative Commons +public licenses is dedicated to the public domain under the CC0 Public +Domain Dedication. Except for the limited purpose of indicating that +material is shared under a Creative Commons public license or as +otherwise permitted by the Creative Commons policies published at +creativecommons.org/policies, Creative Commons does not authorize the +use of the trademark "Creative Commons" or any other trademark or logo +of Creative Commons without its prior written consent including, +without limitation, in connection with any unauthorized modifications +to any of its public licenses or any other arrangements, +understandings, or agreements concerning use of licensed material. For +the avoidance of doubt, this paragraph does not form part of the +public licenses. + +Creative Commons may be contacted at creativecommons.org. \ No newline at end of file diff --git a/NOTICE.md b/NOTICE.md index 9006dbcef..2594b96c2 100644 --- a/NOTICE.md +++ b/NOTICE.md @@ -18,6 +18,10 @@ source code repository logs. ## Declared Project Licenses +The Tractus-X project uses the following licenses: + +- CC-BY-4.0 for non-code + The materials in this repository is made available under the terms of the Creative Commons Attribution 4.0 International License, which is available at https://spdx.org/licenses/CC-BY-4.0.html. diff --git a/io.catenax.assembly_part_relationship/1.1.1/AssemblyPartRelationship.ttl b/io.catenax.assembly_part_relationship/1.1.1/AssemblyPartRelationship.ttl deleted file mode 100644 index ca09881e7..000000000 --- a/io.catenax.assembly_part_relationship/1.1.1/AssemblyPartRelationship.ttl +++ /dev/null @@ -1,141 +0,0 @@ -####################################################################### -# Copyright (c) 2022 BASF SE -# Copyright (c) 2022 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) -# Copyright (c) 2022 Fraunhofer-Gesellschaft zur Foerderung der angewandten Forschung e.V. (represented by Fraunhofer ISST & Fraunhofer IML) -# Copyright (c) 2022 German Edge Cloud GmbH & Co. KG -# Copyright (c) 2022 Henkel AG & Co. KGaA -# Copyright (c) 2022 Mercedes Benz AG -# Copyright (c) 2022 Robert Bosch Manufacturing Solutions GmbH -# Copyright (c) 2022 SAP SE -# Copyright (c) 2022 Siemens AG -# Copyright (c) 2022 T-Systems International GmbH -# Copyright (c) 2022 ZF Friedrichshafen AG -# Copyright (c) 2022 Contributors to the Eclipse Foundation -# -# 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 bamm: . -@prefix bamm-c: . -@prefix bamm-e: . -@prefix unit: . -@prefix rdf: . -@prefix rdfs: . -@prefix xsd: . -@prefix : . - -:AssemblyPartRelationship a bamm:Aspect; - bamm:name "AssemblyPartRelationship"; - bamm:preferredName "Assembly Part Relationship"@en; - bamm:properties (:catenaXId :childParts); - bamm:description "The aspect provides the child parts (one structural level down) which the given object assembles."@en; - bamm:operations (). - -:catenaXId a bamm:Property; - bamm:name "catenaXId"; - bamm:preferredName "Catena-X Identifier"@en; - bamm:description "The Catena-X ID of the given part (e.g. the assembly), valid for the Catena-X dataspace."@en; - bamm:characteristic :CatenaXIdTraitCharacteristic; - bamm:exampleValue "urn:uuid:055c1128-0375-47c8-98de-7cf802c3241d". -:childParts a bamm:Property; - bamm:name "childParts"; - bamm:preferredName "Child Parts"@en; - bamm:description "Set of child parts, of which the given parent object is assembled by (one structural level down)."@en; - bamm:characteristic :SetOfChildPartsCharacteristic. -:UUIDv4Characteristic a bamm:Characteristic; - bamm:name "UUIDv4Characteristic"; - bamm:preferredName "UUID v4"@en; - bamm:description "A version 4 UUID is a universally unique identifier that is generated using random 32 hexadecimal characters."@en; - bamm:dataType xsd:string; - bamm:see . -:UUIDv4RegularExpression a bamm-c:RegularExpressionConstraint; - bamm:name "UUIDv4RegularExpression"; - bamm:preferredName "Catena-X Id Regular Expression"@en; - bamm: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."@en; - bamm:value "(^[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}$)"; - bamm:see . -:ChildData a bamm:Entity; - bamm:name "ChildData"; - bamm:preferredName "Child Data"@en; - bamm:properties (:createdOn :quantity [ - bamm:property :lastModifiedOn; - bamm:optional "true"^^xsd:boolean -] :lifecycleContext :childCatenaXId); - bamm:description "Catena-X ID and meta data of the assembled child part."@en. -:createdOn a bamm:Property; - bamm:name "createdOn"; - bamm:preferredName "Created On"@en; - bamm:description "Timestamp when the relation between the parent part and the child part was created, e.g. when the serialized child part was assembled into the given part."@en; - bamm:characteristic bamm-c:Timestamp; - bamm:exampleValue "2022-02-03T14:48:54.709Z"^^xsd:dateTime. -:quantity a bamm:Property; - bamm:name "quantity"; - bamm:preferredName "Quantity"@en; - bamm:description "Quantity of which the child part is assembled into the parent part. In general it is '1' for serialized parts."@en; - bamm:characteristic :QuantityCharacteristic. -:lastModifiedOn a bamm:Property; - bamm:name "lastModifiedOn"; - bamm:preferredName "Last Modification Date"@en; - bamm:description "Timestamp when the assembly relationship between parent part and child part was last modified."@en; - bamm:characteristic bamm-c:Timestamp; - bamm:exampleValue "2022-02-03T14:48:54.709Z"^^xsd:dateTime. -:childCatenaXId a bamm:Property; - bamm:name "childCatenaXId"; - bamm:preferredName "Catena-X Child Identifier"@en; - bamm:description "The Catena-X ID of the child object which is assembled into the given parent part."@en; - bamm:characteristic :CatenaXIdTraitCharacteristic. -:QuantityCharacteristic a bamm-c:Quantifiable; - bamm:name "QuantityCharacteristic"; - bamm:description "Describes the quantity in which the child part is assembled in the given parent object by providing a quantity value and the measurement unit in which the quantity is measured."@en; - bamm:dataType :Quantity. -:Quantity a bamm:Entity; - bamm:name "Quantity"; - bamm:properties (:quantityNumber :measurementUnit); - bamm:description "Comprises the number of objects and the unit of measurement for the respective child objects"@en. -:quantityNumber a bamm:Property; - bamm:name "quantityNumber"; - bamm:preferredName "Quantity Number"@en; - bamm:description "The number of objects related to the measurement unit"@en; - bamm:characteristic :NumberofObjects; - bamm:exampleValue "2.5"^^xsd:double. -:NumberofObjects a bamm:Characteristic; - bamm:name "NumberofObjects"; - bamm:description "Quantifiable number of objects in reference to the measurementUnit"@en; - bamm:dataType xsd:double. -:measurementUnit a bamm:Property; - bamm:name "measurementUnit"; - bamm:description "Unit of Measurement for the quantity of serialized objects"@en; - bamm:characteristic bamm-c:UnitReference; - bamm:exampleValue "litre"^^bamm:curie; - bamm:see . -:SetOfChildPartsCharacteristic a bamm-c:Set; - bamm:name "SetOfChildPartsCharacteristic"; - bamm:preferredName "Set of Child Parts"@en; - bamm:description "Set of child parts the parent object is assembled by (one structural level down)."@en; - bamm:dataType :ChildData. -:lifecycleContext a bamm:Property; - bamm:name "lifecycleContext"; - bamm:preferredName "Lifecycle Context"@en; - bamm:description "The lifecycle context in which the child part was assembled into the parent part."@en; - bamm:characteristic :LifecycleContextCharacteristic; - bamm:exampleValue "AsBuilt". -:LifecycleContextCharacteristic a bamm-c:Enumeration; - bamm:name "LifecycleContextCharacteristic"; - bamm:preferredName "Lifecycle Context"@en; - bamm:description "The possible values for lifecycle context as defined by STEP: AsRequired, AsDesigned, AsPlanned, AsBuilt, AsMaintained, AsRecycled"@en; - bamm:dataType xsd:string; - bamm-c:values ("AsRequired" "AsDesigned" "AsPlanned" "AsBuilt" "AsMaintained" "AsRecycled"); - bamm:see . -:CatenaXIdTraitCharacteristic a bamm-c:Trait; - bamm:name "CatenaXIdTraitCharacteristic"; - bamm:description "Trait to ensure UUID v4 data format"@en; - bamm-c:baseCharacteristic :UUIDv4Characteristic; - bamm-c:constraint :UUIDv4RegularExpression. diff --git a/io.catenax.assembly_part_relationship/1.1.1/gen/AssemblyPartRelationship-aas.xml b/io.catenax.assembly_part_relationship/1.1.1/gen/AssemblyPartRelationship-aas.xml deleted file mode 100644 index e204ed1cd..000000000 --- a/io.catenax.assembly_part_relationship/1.1.1/gen/AssemblyPartRelationship-aas.xml +++ /dev/null @@ -1,785 +0,0 @@ - - - - - defaultAdminShell - - - en - defaultAdminShell - - - - urn:samm:io.catenax.assembly_part_relationship:1.1.1#AssemblyPartRelationship - - Type - - - - ModelReference - - - Submodel - urn:samm:io.catenax.assembly_part_relationship:1.1.1#AssemblyPartRelationship/submodel - - - - - - - - - AssemblyPartRelationship - - - en - The aspect provides the child parts (one structural level down) which the given object assembles. - - - - urn:samm:io.catenax.assembly_part_relationship:1.1.1#AssemblyPartRelationship/submodel - Template - - ModelReference - - - ConceptDescription - urn:samm:io.catenax.assembly_part_relationship:1.1.1#AssemblyPartRelationship - - - - - - catenaXId - - - en - Catena-X Identifier - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.assembly_part_relationship:1.1.1#catenaXId - - - - xs:string - - - - childParts - - - en - Child Parts - - - - - en - Set of child parts, of which the given parent object is assembled by (one structural level down). - - - true - DataElement - - - ChildData - - - en - Child Data - - - - - en - Catena-X ID and meta data of the assembled child part. - - - - - createdOn - - - en - Created On - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.assembly_part_relationship:1.1.1#createdOn - - - - xs:dateTime - - - - Quantity - - - en - Comprises the number of objects and the unit of measurement for the respective child objects - - - - - quantityNumber - - - en - Quantity Number - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.assembly_part_relationship:1.1.1#quantityNumber - - - - xs:double - - - - measurementUnit - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.assembly_part_relationship:1.1.1#measurementUnit - - - - - - ExternalReference - - - GlobalReference - https://openmanufacturingplatform.github.io/sds-bamm-aspect-meta-model/bamm-specification/snapshot/appendix/unitcatalog.html - - - - - xs:string - - - - - - lastModifiedOn - - - en - Last Modification Date - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.assembly_part_relationship:1.1.1#lastModifiedOn - - - - xs:dateTime - - - - lifecycleContext - - - en - Lifecycle Context - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.assembly_part_relationship:1.1.1#lifecycleContext - - - - xs:string - - - - childCatenaXId - - - en - Catena-X Child Identifier - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.assembly_part_relationship:1.1.1#childCatenaXId - - - - xs:string - - - - - - - - - - - - APPLICATION_CLASS - AssemblyPartRelationship - - - en - Assembly Part Relationship - - - - - en - The aspect provides the child parts (one structural level down) which the given object assembles. - - - urn:samm:io.catenax.assembly_part_relationship:1.1.1#AssemblyPartRelationship - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Assembly Part Relationship - - - - - en - AssemblyPartRelationship - - - - - en - The aspect provides the child parts (one structural level down) which the given object assembles. - - - - - - - - - catenaXId - - - en - Catena-X Identifier - - - urn:samm:io.catenax.assembly_part_relationship:1.1.1#catenaXId - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Catena-X Identifier - - - - - en - catenaXId - - - STRING - - - en - The Catena-X ID of the given part (e.g. the assembly), valid for the Catena-X dataspace. - - - - - - - - - createdOn - - - en - Created On - - - urn:samm:io.catenax.assembly_part_relationship:1.1.1#createdOn - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Created On - - - - - en - createdOn - - - STRING - - - en - Timestamp when the relation between the parent part and the child part was created, e.g. when the serialized child part was assembled into the given part. - - - - - - - - - quantityNumber - - - en - Quantity Number - - - urn:samm:io.catenax.assembly_part_relationship:1.1.1#quantityNumber - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Quantity Number - - - - - en - quantityNumber - - - REAL_MEASURE - - - en - The number of objects related to the measurement unit - - - - - - - - - measurementUnit - urn:samm:io.catenax.assembly_part_relationship:1.1.1#measurementUnit - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - measurementUnit - - - - - en - measurementUnit - - - STRING - - - en - Unit of Measurement for the quantity of serialized objects - - - - - - - - - quantity - - - en - Quantity - - - urn:samm:io.catenax.assembly_part_relationship:1.1.1#quantity - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Quantity - - - - - en - quantity - - - STRING - - - en - Quantity of which the child part is assembled into the parent part. In general it is '1' for serialized parts. - - - - - - - - - lastModifiedOn - - - en - Last Modification Date - - - urn:samm:io.catenax.assembly_part_relationship:1.1.1#lastModifiedOn - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Last Modification Date - - - - - en - lastModifiedOn - - - STRING - - - en - Timestamp when the assembly relationship between parent part and child part was last modified. - - - - - - - - - lifecycleContext - - - en - Lifecycle Context - - - urn:samm:io.catenax.assembly_part_relationship:1.1.1#lifecycleContext - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Lifecycle Context - - - - - en - lifecycleContext - - - STRING - - - en - The lifecycle context in which the child part was assembled into the parent part. - - - - - - AsRequired - - ModelReference - - - DataElement - urn:samm:io.catenax.assembly_part_relationship:1.1.1#LifecycleContextCharacteristic:AsRequired - - - - - - AsDesigned - - ModelReference - - - DataElement - urn:samm:io.catenax.assembly_part_relationship:1.1.1#LifecycleContextCharacteristic:AsDesigned - - - - - - AsPlanned - - ModelReference - - - DataElement - urn:samm:io.catenax.assembly_part_relationship:1.1.1#LifecycleContextCharacteristic:AsPlanned - - - - - - AsBuilt - - ModelReference - - - DataElement - urn:samm:io.catenax.assembly_part_relationship:1.1.1#LifecycleContextCharacteristic:AsBuilt - - - - - - AsMaintained - - ModelReference - - - DataElement - urn:samm:io.catenax.assembly_part_relationship:1.1.1#LifecycleContextCharacteristic:AsMaintained - - - - - - AsRecycled - - ModelReference - - - DataElement - urn:samm:io.catenax.assembly_part_relationship:1.1.1#LifecycleContextCharacteristic:AsRecycled - - - - - - - - - - - - - childCatenaXId - - - en - Catena-X Child Identifier - - - urn:samm:io.catenax.assembly_part_relationship:1.1.1#childCatenaXId - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Catena-X Child Identifier - - - - - en - childCatenaXId - - - STRING - - - en - The Catena-X ID of the child object which is assembled into the given parent part. - - - - - - - - - childParts - - - en - Child Parts - - - urn:samm:io.catenax.assembly_part_relationship:1.1.1#childParts - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Child Parts - - - - - en - childParts - - - STRING - - - en - Set of child parts, of which the given parent object is assembled by (one structural level down). - - - - - - - - - diff --git a/io.catenax.assembly_part_relationship/1.1.1/gen/AssemblyPartRelationship-schema.json b/io.catenax.assembly_part_relationship/1.1.1/gen/AssemblyPartRelationship-schema.json deleted file mode 100644 index f4c66010c..000000000 --- a/io.catenax.assembly_part_relationship/1.1.1/gen/AssemblyPartRelationship-schema.json +++ /dev/null @@ -1,94 +0,0 @@ -{ - "$schema" : "http://json-schema.org/draft-04/schema", - "description" : "The aspect provides the child parts (one structural level down) which the given object assembles.", - "type" : "object", - "components" : { - "schemas" : { - "urn_bamm_io.catenax.assembly_part_relationship_1.1.1_CatenaXIdTraitCharacteristic" : { - "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_bamm_io.openmanufacturing_characteristic_2.0.0_Timestamp" : { - "type" : "string", - "pattern" : "-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T(([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](\\.[0-9]+)?|(24:00:00(\\.0+)?))(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?", - "description" : "Describes a Property which contains the date and time with an optional timezone." - }, - "urn_bamm_io.catenax.assembly_part_relationship_1.1.1_NumberofObjects" : { - "type" : "number", - "description" : "Quantifiable number of objects in reference to the measurementUnit" - }, - "urn_bamm_io.openmanufacturing_characteristic_2.0.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_bamm_io.catenax.assembly_part_relationship_1.1.1_QuantityCharacteristic" : { - "description" : "Describes the quantity in which the child part is assembled in the given parent object by providing a quantity value and the measurement unit in which the quantity is measured.", - "type" : "object", - "properties" : { - "quantityNumber" : { - "description" : "The number of objects related to the measurement unit", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.assembly_part_relationship_1.1.1_NumberofObjects" - }, - "measurementUnit" : { - "description" : "Unit of Measurement for the quantity of serialized objects", - "$ref" : "#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_UnitReference" - } - }, - "required" : [ "quantityNumber", "measurementUnit" ] - }, - "urn_bamm_io.catenax.assembly_part_relationship_1.1.1_LifecycleContextCharacteristic" : { - "type" : "string", - "description" : "The possible values for lifecycle context as defined by STEP: AsRequired, AsDesigned, AsPlanned, AsBuilt, AsMaintained, AsRecycled", - "enum" : [ "AsRequired", "AsDesigned", "AsPlanned", "AsBuilt", "AsMaintained", "AsRecycled" ] - }, - "urn_bamm_io.catenax.assembly_part_relationship_1.1.1_ChildData" : { - "description" : "Catena-X ID and meta data of the assembled child part.", - "type" : "object", - "properties" : { - "createdOn" : { - "description" : "Timestamp when the relation between the parent part and the child part was created, e.g. when the serialized child part was assembled into the given part.", - "$ref" : "#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Timestamp" - }, - "quantity" : { - "description" : "Quantity of which the child part is assembled into the parent part. In general it is '1' for serialized parts.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.assembly_part_relationship_1.1.1_QuantityCharacteristic" - }, - "lastModifiedOn" : { - "description" : "Timestamp when the assembly relationship between parent part and child part was last modified.", - "$ref" : "#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Timestamp" - }, - "lifecycleContext" : { - "description" : "The lifecycle context in which the child part was assembled into the parent part.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.assembly_part_relationship_1.1.1_LifecycleContextCharacteristic" - }, - "childCatenaXId" : { - "description" : "The Catena-X ID of the child object which is assembled into the given parent part.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.assembly_part_relationship_1.1.1_CatenaXIdTraitCharacteristic" - } - }, - "required" : [ "createdOn", "quantity", "lifecycleContext", "childCatenaXId" ] - }, - "urn_bamm_io.catenax.assembly_part_relationship_1.1.1_SetOfChildPartsCharacteristic" : { - "description" : "Set of child parts the parent object is assembled by (one structural level down).", - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/urn_bamm_io.catenax.assembly_part_relationship_1.1.1_ChildData" - }, - "uniqueItems" : true - } - } - }, - "properties" : { - "catenaXId" : { - "description" : "The Catena-X ID of the given part (e.g. the assembly), valid for the Catena-X dataspace.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.assembly_part_relationship_1.1.1_CatenaXIdTraitCharacteristic" - }, - "childParts" : { - "description" : "Set of child parts, of which the given parent object is assembled by (one structural level down).", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.assembly_part_relationship_1.1.1_SetOfChildPartsCharacteristic" - } - }, - "required" : [ "catenaXId", "childParts" ] -} \ No newline at end of file diff --git a/io.catenax.assembly_part_relationship/1.1.1/gen/AssemblyPartRelationship.aasx b/io.catenax.assembly_part_relationship/1.1.1/gen/AssemblyPartRelationship.aasx deleted file mode 100644 index 5bd63c5f8..000000000 Binary files a/io.catenax.assembly_part_relationship/1.1.1/gen/AssemblyPartRelationship.aasx and /dev/null differ diff --git a/io.catenax.assembly_part_relationship/1.1.1/gen/AssemblyPartRelationship.html b/io.catenax.assembly_part_relationship/1.1.1/gen/AssemblyPartRelationship.html deleted file mode 100644 index f14fac0ba..000000000 --- a/io.catenax.assembly_part_relationship/1.1.1/gen/AssemblyPartRelationship.html +++ /dev/null @@ -1,945 +0,0 @@ - - - - - - - - - - - - - - Dokumentation Assembly Part Relationship - - -
-
-
-
-

Aspect Model Assembly Part Relationship

-
urn:bamm:io.catenax.assembly_part_relationship:1.1.1#AssemblyPartRelationship
-
-
-
-
-
-
-
- -
- - -
- The aspect provides the child parts (one structural level down) which the given object assembles. -
- - -
-

Übersicht

-
-
-
-
- Aspect Model Diagram -
-
-
- - -
-
-

Properties

-
- -
- -
-

Catena-X Identifier

-
- -The Catena-X ID of the given part (e.g. the assembly), valid for the Catena-X dataspace. - -
-
Name
-
catenaXId
-
- - - -
-
Characteristic
-
-
-
-
Trait
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Beispiel
-
urn:uuid:055c1128-0375-47c8-98de-7cf802c3241d
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
catenaXId
-
- - -
-
Bedingungen
-
-
    -
  • -
    - -
    - Catena-X Id Regular Expression -
    - -
    -
    Beschreibung
    -
    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.
    -
    - -
    -
    Referenz
    -
    -
    -
      -
    • https://datatracker.ietf.org/doc/html/rfc4122
      • -
    -
    -
    -
    - -
    -
    Regulärer Ausdruck
    -
    (^[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}$)
    -
    - -
    • -
-
-
-
-
- -
-

Child Parts

-
- -Set of child parts, of which the given parent object is assembled by (one structural level down). - -
-
Name
-
childParts
-
- - - -
-
Characteristic
-
-
-
-
Set
-
-
-
Has no order
-
-
-
Duplicates not allowed
-
-
-
- Typ urn:bamm:io.catenax.assembly_part_relationship:1.1.1#ChildData - -
-
-
-
-
- - -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
childParts
-
- - -
-
- - - -
-
-

Objekt

-
- -
-
-

Child Data

-
-
- Catena-X ID and meta data of the assembled child part. -
- -
-

Properties

-
-
- -
-
Created On
-
- -Timestamp when the relation between the parent part and the child part was created, e.g. when the serialized child part was assembled into the given part. - -
-
Name
-
createdOn
-
- - - -
-
Characteristic
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#dateTime - -
-
-
-
-
- -
-
Beispiel
-
2022-02-03T14:48:54.709Z
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
createdOn
-
- - -
-
- -
-
Quantity
-
- -Quantity of which the child part is assembled into the parent part. In general it is '1' for serialized parts. - -
-
Name
-
quantity
-
- - - -
-
Characteristic
-
-
-
-
Quantifiable
-
-
-
Duration
-
-
-
Describes the quantity in which the child part is assembled in the given parent object by providing a quantity value and the measurement unit in which the quantity is measured.
-
-
-
- Typ urn:bamm:io.catenax.assembly_part_relationship:1.1.1#Quantity - -
-
-
-
-
- - -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
quantity
-
- - -
-
- -
-
Last Modification Date
-
- -Timestamp when the assembly relationship between parent part and child part was last modified. - -
-
Name
-
lastModifiedOn
-
- - - -
-
Characteristic
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#dateTime - -
-
-
-
-
- -
-
Beispiel
-
2022-02-03T14:48:54.709Z
-
- -
-
Optional
-
- Ja
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
lastModifiedOn
-
- - -
-
- -
-
Lifecycle Context
-
- -The lifecycle context in which the child part was assembled into the parent part. - -
-
Name
-
lifecycleContext
-
- - - -
-
Characteristic
-
-
-
-
Enumeration
-
-
-
Werte
-
-
-
-
    -
  • AsRequired
    • -
  • AsDesigned
    • -
  • AsPlanned
    • -
  • AsBuilt
    • -
  • AsMaintained
    • -
  • AsRecycled
    • -
-
-
-
-
- Referenz -
-
    -
  • http://private.pdm-if.org/web/pdm-if/recommended-practices1
    • -
-
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Beispiel
-
AsBuilt
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
lifecycleContext
-
- - -
-
- -
-
Catena-X Child Identifier
-
- -The Catena-X ID of the child object which is assembled into the given parent part. - -
-
Name
-
childCatenaXId
-
- - - -
-
Characteristic
-
-
-
-
Trait
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- - -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
childCatenaXId
-
- - -
-
Bedingungen
-
-
    -
  • -
    - -
    - Catena-X Id Regular Expression -
    - -
    -
    Beschreibung
    -
    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.
    -
    - -
    -
    Referenz
    -
    -
    -
      -
    • https://datatracker.ietf.org/doc/html/rfc4122
      • -
    -
    -
    -
    - -
    -
    Regulärer Ausdruck
    -
    (^[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}$)
    -
    - -
    • -
-
-
-
-
-
-
-

Quantity

-
-
- Comprises the number of objects and the unit of measurement for the respective child objects -
- -
-

Properties

-
-
- -
-
Quantity Number
-
- -The number of objects related to the measurement unit - -
-
Name
-
quantityNumber
-
- - - -
-
Characteristic
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#double - -
-
-
-
-
- -
-
Beispiel
-
2.5
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
quantityNumber
-
- - -
-
- -
-
measurementUnit
-
- -Unit of Measurement for the quantity of serialized objects - -
-
Name
-
measurementUnit
-
- - - -
-
Characteristic
-
-
-
-
- Typ urn:bamm:io.openmanufacturing:meta-model:2.0.0#curie - -
-
-
-
-
- -
-
Beispiel
-
litre
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
measurementUnit
-
- -
-
Referenz
-
-
    -
  • https://openmanufacturingplatform.github.io/sds-bamm-aspect-meta-model/bamm-specification/snapshot/appendix/unitcatalog.html
    • -
-
-
- -
-
-
- -
- Third party licenses - -
- -
- - -
- - - \ No newline at end of file diff --git a/io.catenax.assembly_part_relationship/1.1.1/gen/AssemblyPartRelationship.json b/io.catenax.assembly_part_relationship/1.1.1/gen/AssemblyPartRelationship.json deleted file mode 100644 index eb0d211e6..000000000 --- a/io.catenax.assembly_part_relationship/1.1.1/gen/AssemblyPartRelationship.json +++ /dev/null @@ -1,13 +0,0 @@ -{ - "catenaXId" : "urn:uuid:055c1128-0375-47c8-98de-7cf802c3241d", - "childParts" : [ { - "lifecycleContext" : "AsRequired", - "quantity" : { - "quantityNumber" : 2.5, - "measurementUnit" : "litre" - }, - "createdOn" : "2022-02-03T14:48:54.709Z", - "lastModifiedOn" : "2022-02-03T14:48:54.709Z", - "childCatenaXId" : "D4b69Cd5-9e5e-4b2E-fB07-ff51Cf049EDa" - } ] -} \ No newline at end of file diff --git a/io.catenax.assembly_part_relationship/1.1.1/gen/AssemblyPartRelationship.yml b/io.catenax.assembly_part_relationship/1.1.1/gen/AssemblyPartRelationship.yml deleted file mode 100644 index 45e69f4a1..000000000 --- a/io.catenax.assembly_part_relationship/1.1.1/gen/AssemblyPartRelationship.yml +++ /dev/null @@ -1,223 +0,0 @@ ---- -openapi: 3.0.3 -info: - title: Assembly Part Relationship - version: v1 -servers: -- url: catenax.io/api/v1 - variables: - api-version: - default: v1 -paths: - /{tenant-id}/assembly-part-relationship: - get: - tags: - - AssemblyPartRelationship - operationId: getAssemblyPartRelationship - 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/AssemblyPartRelationship' - "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/AssemblyPartRelationship' - totalItems: - type: number - totalPages: - type: number - pageSize: - type: number - currentPage: - type: number - urn_bamm_io.catenax.assembly_part_relationship_1.1.1_CatenaXIdTraitCharacteristic: - 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_bamm_io.openmanufacturing_characteristic_2.0.0_Timestamp: - type: string - pattern: "-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T(([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](\\\ - .[0-9]+)?|(24:00:00(\\.0+)?))(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?" - description: Describes a Property which contains the date and time with an optional - timezone. - urn_bamm_io.catenax.assembly_part_relationship_1.1.1_NumberofObjects: - type: number - description: Quantifiable number of objects in reference to the measurementUnit - urn_bamm_io.openmanufacturing_characteristic_2.0.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_bamm_io.catenax.assembly_part_relationship_1.1.1_QuantityCharacteristic: - description: Describes the quantity in which the child part is assembled in - the given parent object by providing a quantity value and the measurement - unit in which the quantity is measured. - type: object - properties: - quantityNumber: - description: The number of objects related to the measurement unit - $ref: '#/components/schemas/urn_bamm_io.catenax.assembly_part_relationship_1.1.1_NumberofObjects' - measurementUnit: - description: Unit of Measurement for the quantity of serialized objects - $ref: '#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_UnitReference' - required: - - quantityNumber - - measurementUnit - urn_bamm_io.catenax.assembly_part_relationship_1.1.1_LifecycleContextCharacteristic: - type: string - description: "The possible values for lifecycle context as defined by STEP:\ - \ AsRequired, AsDesigned, AsPlanned, AsBuilt, AsMaintained, AsRecycled" - enum: - - AsRequired - - AsDesigned - - AsPlanned - - AsBuilt - - AsMaintained - - AsRecycled - urn_bamm_io.catenax.assembly_part_relationship_1.1.1_ChildData: - description: Catena-X ID and meta data of the assembled child part. - type: object - properties: - createdOn: - description: "Timestamp when the relation between the parent part and the\ - \ child part was created, e.g. when the serialized child part was assembled\ - \ into the given part." - $ref: '#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Timestamp' - quantity: - description: Quantity of which the child part is assembled into the parent - part. In general it is '1' for serialized parts. - $ref: '#/components/schemas/urn_bamm_io.catenax.assembly_part_relationship_1.1.1_QuantityCharacteristic' - lastModifiedOn: - description: Timestamp when the assembly relationship between parent part - and child part was last modified. - $ref: '#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Timestamp' - lifecycleContext: - description: The lifecycle context in which the child part was assembled - into the parent part. - $ref: '#/components/schemas/urn_bamm_io.catenax.assembly_part_relationship_1.1.1_LifecycleContextCharacteristic' - childCatenaXId: - description: The Catena-X ID of the child object which is assembled into - the given parent part. - $ref: '#/components/schemas/urn_bamm_io.catenax.assembly_part_relationship_1.1.1_CatenaXIdTraitCharacteristic' - required: - - createdOn - - quantity - - lifecycleContext - - childCatenaXId - urn_bamm_io.catenax.assembly_part_relationship_1.1.1_SetOfChildPartsCharacteristic: - description: Set of child parts the parent object is assembled by (one structural - level down). - type: array - items: - $ref: '#/components/schemas/urn_bamm_io.catenax.assembly_part_relationship_1.1.1_ChildData' - uniqueItems: true - AssemblyPartRelationship: - description: The aspect provides the child parts (one structural level down) - which the given object assembles. - type: object - properties: - catenaXId: - description: "The Catena-X ID of the given part (e.g. the assembly), valid\ - \ for the Catena-X dataspace." - $ref: '#/components/schemas/urn_bamm_io.catenax.assembly_part_relationship_1.1.1_CatenaXIdTraitCharacteristic' - childParts: - description: "Set of child parts, of which the given parent object is assembled\ - \ by (one structural level down)." - $ref: '#/components/schemas/urn_bamm_io.catenax.assembly_part_relationship_1.1.1_SetOfChildPartsCharacteristic' - required: - - catenaXId - - childParts - 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' - AssemblyPartRelationship: - content: - application/json: - schema: - $ref: '#/components/schemas/PagingSchema' - description: The request was successful. - requestBodies: - AssemblyPartRelationship: - content: - application/json: - schema: - $ref: '#/components/schemas/AssemblyPartRelationship' diff --git a/io.catenax.assembly_part_relationship/1.1.1/metadata.json b/io.catenax.assembly_part_relationship/1.1.1/metadata.json deleted file mode 100644 index bf40b864e..000000000 --- a/io.catenax.assembly_part_relationship/1.1.1/metadata.json +++ /dev/null @@ -1 +0,0 @@ -{ "status" : "deprecate"} diff --git a/io.catenax.batch/1.0.1/Batch.ttl b/io.catenax.batch/1.0.1/Batch.ttl deleted file mode 100644 index f6890cd5a..000000000 --- a/io.catenax.batch/1.0.1/Batch.ttl +++ /dev/null @@ -1,212 +0,0 @@ -####################################################################### -# Copyright (c) 2022 BASF SE -# Copyright (c) 2022 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) -# Copyright (c) 2022 Fraunhofer-Gesellschaft zur Foerderung der angewandten Forschung e.V. (represented by Fraunhofer ISST & Fraunhofer IML) -# Copyright (c) 2022 German Edge Cloud GmbH & Co. KG -# Copyright (c) 2022 Henkel AG & Co. KGaA -# Copyright (c) 2022 Mercedes Benz AG -# Copyright (c) 2022 Robert Bosch Manufacturing Solutions GmbH -# Copyright (c) 2022 SAP SE -# Copyright (c) 2022 Siemens AG -# Copyright (c) 2022 T-Systems International GmbH -# Copyright (c) 2022 ZF Friedrichshafen AG -# Copyright (c) 2022 Contributors to the Eclipse Foundation -# -# 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 xsd: . -@prefix bamm: . -@prefix unit: . -@prefix bamm-c: . -@prefix bamm-e: . -@prefix : . - -:ProductionCountryCodeTrait a bamm-c:Trait; - bamm:name "ProductionCountryCodeTrait"; - bamm:preferredName "Production Country Code Trait"@en; - bamm:description "Trait to ensure standard data format for country code"@en; - bamm-c:constraint :CountryCodeRegularExpression; - bamm-c:baseCharacteristic :CountryCodeCharacteristic. -:CountryCodeRegularExpression a bamm-c:RegularExpressionConstraint; - bamm:name "CountryCodeRegularExpression"; - bamm:preferredName "Country Code Regular Expression"@en; - bamm:description "Regular Expression that ensures a three-letter code "@en; - bamm:value "^[A-Z][A-Z][A-Z]$". -:CountryCodeCharacteristic a bamm:Characteristic; - bamm:name "CountryCodeCharacteristic"; - bamm:preferredName "Country Code Characteristic"@en; - bamm:description "ISO 3166-1 alpha-3 – three-letter country codes "@en; - bamm:dataType xsd:string; - bamm:see . -:UUIDv4RegularExpression a bamm-c:RegularExpressionConstraint; - bamm:name "UUIDv4RegularExpression"; - bamm:preferredName "Catena-X Id Regular Expression"@en; - bamm: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)."@en; - bamm:value "^[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}$". -:UUIDv4 a bamm:Characteristic; - bamm:name "UUIDv4"; - bamm:preferredName "UUIDv4"@en; - bamm:description "A version 4 UUID is a universally unique identifier that is generated using random 32 hexadecimal characters."@en; - bamm:dataType xsd:string. -:KeyValueList a bamm:Entity; - bamm:name "KeyValueList"; - bamm:preferredName "Key Value List"@en; - bamm:description "A list of key value pairs for local identifiers, which are composed of a key and a corresponding value."@en; - bamm:properties (:key :value). -:key a bamm:Property; - bamm:name "key"; - bamm:preferredName "Identifier Key"@en; - bamm:description "The key of a local identifier. "@en; - bamm:characteristic :KeyCharacteristic; - bamm:exampleValue "BatchID". -:value a bamm:Property; - bamm:name "value"; - bamm:preferredName "Identifier Value"@en; - bamm:description "The value of an identifier."@en; - bamm:characteristic :ValueCharacteristic; - bamm:exampleValue "BID12345678". -:KeyCharacteristic a bamm:Characteristic; - bamm:name "KeyCharacteristic"; - bamm:preferredName "Key Characteristic"@en; - bamm:description "The key characteristic of a local identifier. A specific subset of keys is predefined, but additionally any other custom key is allowed. Predefined keys (to be used when applicable):\n- \"manufacturerId\" - The Business Partner Number (BPN) of the manufacturer. Value: BPN-Nummer\n- \"batchId\" - The identifier of the batch, to which the serialzed part belongs"@en; - bamm:dataType xsd:string. -:ValueCharacteristic a bamm:Characteristic; - bamm:name "ValueCharacteristic"; - bamm:preferredName "Value Characteristic"@en; - bamm:description "The value of an identifier."@en; - bamm:dataType xsd:string. -:catenaXId a bamm:Property; - bamm:name "catenaXId"; - bamm:preferredName "Catena-X Identifier"@en; - bamm:description "The fully anonymous Catena-X ID of the batch, valid for the Catena-X dataspace."@en; - bamm:characteristic :CatenaXIdTrait; - bamm:exampleValue "580d3adf-1981-44a0-a214-13d6ceed9379". -:CatenaXIdTrait a bamm-c:Trait; - bamm:name "CatenaXIdTrait"; - bamm:preferredName "Catena-X ID Trait"@en; - bamm:description "Trait to ensure data format for Catena-X ID"@en; - bamm-c:constraint :UUIDv4RegularExpression; - bamm-c:baseCharacteristic :UUIDv4. -:localIdentifiers a bamm:Property; - bamm:name "localIdentifiers"; - bamm:preferredName "Local Identifiers"@en; - bamm:description "A local identifier enables identification of a part in a specific dataspace, but is not unique in Catena-X dataspace. Multiple local identifiers may exist."@en; - bamm:characteristic :LocalIdentifierCharacteristic. -:LocalIdentifierCharacteristic a bamm-c:Set; - bamm:name "LocalIdentifierCharacteristic"; - bamm:preferredName "Local Identifier Characteristic"@en; - bamm:description "A batch may have multiple attributes, which uniquely identify that batch in a specific dataspace (e.g. the manufacturer`s dataspace)"@en; - bamm:dataType :KeyValueList. -:manufacturingInformation a bamm:Property; - bamm:name "manufacturingInformation"; - bamm:preferredName "Manufacturing Information"@en; - bamm:description "Information from manufacturing process, such as manufacturing date and manufacturing country"@en; - bamm:characteristic :ManufacturingCharacteristic. -:ManufacturingCharacteristic a bamm:Characteristic; - bamm:name "ManufacturingCharacteristic"; - bamm:preferredName "Manufacturing Characteristic"@en; - bamm:description "Characteristic to describe manufacturing related data"@en; - bamm:dataType :ManufacturingEntity. -:ManufacturingEntity a bamm:Entity; - bamm:name "ManufacturingEntity"; - bamm:preferredName "Manufacturing Entity"@en; - bamm:description "Encapsulates the manufacturing relevant attributes"@en; - bamm:properties (:date [ - bamm:property :country; - bamm:optional "true"^^xsd:boolean -]). -:date a bamm:Property; - bamm:name "date"; - bamm:preferredName "Production Date"@en; - bamm:description "Timestamp of the manufacturing date as the final step in production process (e.g. final quality check, ready-for-shipment event)"@en; - bamm:characteristic bamm-c:Timestamp; - bamm:exampleValue "2022-02-04T14:48:54"^^xsd:dateTime. -:country a bamm:Property; - bamm:name "country"; - bamm:preferredName "Country code"@en; - bamm:description "Country code where the part was manufactured"@en; - bamm:characteristic :ProductionCountryCodeTrait; - bamm:exampleValue "HUR". -:partTypeInformation a bamm:Property; - bamm:name "partTypeInformation"; - bamm:preferredName "Part Type Information"@en; - bamm:description "The part type of which the batch has been instantiated of."@en; - bamm:characteristic :PartTypeInformationCharacteristic. -:PartTypeInformationCharacteristic a bamm:Characteristic; - bamm:name "PartTypeInformationCharacteristic"; - bamm:preferredName "Part Type Information Characteristic"@en; - bamm:description "The characteristics of the part type"@en; - bamm:dataType :PartTypeInformationEntity. -:PartTypeInformationEntity a bamm:Entity; - bamm:name "PartTypeInformationEntity"; - bamm:preferredName "Part Type Information Entity"@en; - bamm:description "Encapsulation for data related to the part type"@en; - bamm:properties (:manufacturerPartId [ - bamm:property :customerPartId; - bamm:optional "true"^^xsd:boolean -] :nameAtManufacturer [ - bamm:property :nameAtCustomer; - bamm:optional "true"^^xsd:boolean -] :classification). -:manufacturerPartId a bamm:Property; - bamm:name "manufacturerPartId"; - bamm:preferredName "Manufacturer Part ID"@en; - bamm:description "Part ID as assigned by the manufacturer of the part. The Part ID identifies the part (as designed) in the manufacturer`s dataspace. The Part ID does not reference a specific instance of a part and thus should not be confused with the serial number or batch number."@en; - bamm:characteristic :PartIdCharacteristic; - bamm:exampleValue "123-0.740-3434-A". -:customerPartId a bamm:Property; - bamm:name "customerPartId"; - bamm:preferredName "Customer Part ID"@en; - bamm:description "Part ID as assigned by the manufacturer of the part. The Part ID identifies the part (as designed) in the customer`s dataspace. The Part ID does not reference a specific instance of a part and thus should not be confused with the serial number or batch number. Note: This property may only be populated in case there is a single customer for the batch."@en; - bamm:characteristic :PartIdCharacteristic; - bamm:exampleValue "PRT-12345". -:nameAtManufacturer a bamm:Property; - bamm:name "nameAtManufacturer"; - bamm:preferredName "Name at Manufacturer"@en; - bamm:description "Name of the part as assigned by the manufacturer"@en; - bamm:characteristic :PartNameCharacteristic; - bamm:exampleValue "Mirror left". -:nameAtCustomer a bamm:Property; - bamm:name "nameAtCustomer"; - bamm:preferredName "Name at Customer"@en; - bamm:description "Name of the part as assigned by the customer"@en; - bamm:characteristic :PartNameCharacteristic; - bamm:exampleValue "side element A". -:classification a bamm:Property; - bamm:name "classification"; - bamm:preferredName "Classifcation"@en; - bamm:description "The classification of the part type according to STEP standard definition"@en; - bamm:characteristic :ClassificationCharacteristic; - bamm:exampleValue "raw material". -:PartIdCharacteristic a bamm:Characteristic; - bamm:name "PartIdCharacteristic"; - bamm:preferredName "Part ID Characteristic"@en; - bamm:description "The part ID is a multi-character string, ususally assigned by an ERP system"@en; - bamm:dataType xsd:string. -:PartNameCharacteristic a bamm:Characteristic; - bamm:name "PartNameCharacteristic"; - bamm:preferredName "Part Name Characteristic"@en; - bamm:description "Part Name in string format from the respective system in the value chain"@en; - bamm:dataType xsd:string. -:ClassificationCharacteristic a bamm-c:Enumeration; - bamm:name "ClassificationCharacteristic"; - bamm:preferredName "Classification Characteristic"@en; - bamm:description "A part type must be placed into one of the following classes: 'component', 'product', 'software', ‘assembly’, 'tool', or 'raw material'."@en; - bamm:dataType xsd:string; - bamm:see ; - bamm-c:values ("product" "raw material" "software" "assembly" "tool" "component"). -:Batch a bamm:Aspect; - bamm:name "Batch"; - bamm:preferredName "Batch"@en; - bamm:description "A batch is a quantity of (semi-) finished products or (raw) material product that have been produced under the same circumstances (e.g. same production location), as specified groups or amounts, within a certain time frame. Every batch can differ in the number or amount of products. Different batches can have varied specifications, e.g., different colors. A batch is identified via a Batch ID."@en; - bamm:properties (:catenaXId :localIdentifiers :manufacturingInformation :partTypeInformation); - bamm:operations (). diff --git a/io.catenax.batch/1.0.1/gen/Batch-aas.xml b/io.catenax.batch/1.0.1/gen/Batch-aas.xml deleted file mode 100644 index bc071b1c7..000000000 --- a/io.catenax.batch/1.0.1/gen/Batch-aas.xml +++ /dev/null @@ -1,1053 +0,0 @@ - - - - - defaultAdminShell - - - en - defaultAdminShell - - - - urn:samm:io.catenax.batch:1.0.1#Batch - - Type - - - - ModelReference - - - Submodel - urn:samm:io.catenax.batch:1.0.1#Batch/submodel - - - - - - - - - Batch - - - en - A batch is a quantity of (semi-) finished products or (raw) material product that have been produced under the same circumstances (e.g. same production location), as specified groups or amounts, within a certain time frame. Every batch can differ in the number or amount of products. Different batches can have varied specifications, e.g., different colors. A batch is identified via a Batch ID. - - - - urn:samm:io.catenax.batch:1.0.1#Batch/submodel - Template - - ModelReference - - - ConceptDescription - urn:samm:io.catenax.batch:1.0.1#Batch - - - - - - catenaXId - - - en - Catena-X Identifier - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.batch:1.0.1#catenaXId - - - - xs:string - - - - localIdentifiers - - - en - Local Identifiers - - - - - en - A local identifier enables identification of a part in a specific dataspace, but is not unique in Catena-X dataspace. Multiple local identifiers may exist. - - - true - DataElement - - - KeyValueList - - - en - Key Value List - - - - - en - A list of key value pairs for local identifiers, which are composed of a key and a corresponding value. - - - - - key - - - en - Identifier Key - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.batch:1.0.1#key - - - - xs:string - - - - value - - - en - Identifier Value - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.batch:1.0.1#value - - - - xs:string - - - - - - - - ManufacturingEntity - - - en - Manufacturing Entity - - - - - en - Encapsulates the manufacturing relevant attributes - - - - - date - - - en - Production Date - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.batch:1.0.1#date - - - - xs:dateTime - - - - country - - - en - Country code - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.batch:1.0.1#country - - - - xs:string - - - - - - PartTypeInformationEntity - - - en - Part Type Information Entity - - - - - en - Encapsulation for data related to the part type - - - - - manufacturerPartId - - - en - Manufacturer Part ID - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.batch:1.0.1#manufacturerPartId - - - - xs:string - - - - customerPartId - - - en - Customer Part ID - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.batch:1.0.1#customerPartId - - - - xs:string - - - - nameAtManufacturer - - - en - Name at Manufacturer - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.batch:1.0.1#nameAtManufacturer - - - - xs:string - - - - nameAtCustomer - - - en - Name at Customer - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.batch:1.0.1#nameAtCustomer - - - - xs:string - - - - classification - - - en - Classifcation - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.batch:1.0.1#classification - - - - xs:string - - - - - - - - - - APPLICATION_CLASS - Batch - - - en - Batch - - - - - en - A batch is a quantity of (semi-) finished products or (raw) material product that have been produced under the same circumstances (e.g. same production location), as specified groups or amounts, within a certain time frame. Every batch can differ in the number or amount of products. Different batches can have varied specifications, e.g., different colors. A batch is identified via a Batch ID. - - - urn:samm:io.catenax.batch:1.0.1#Batch - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Batch - - - - - en - Batch - - - - - en - A batch is a quantity of (semi-) finished products or (raw) material product that have been produced under the same circumstances (e.g. same production location), as specified groups or amounts, within a certain time frame. Every batch can differ in the number or amount of products. Different batches can have varied specifications, e.g., different colors. A batch is identified via a Batch ID. - - - - - - - - - catenaXId - - - en - Catena-X Identifier - - - urn:samm:io.catenax.batch:1.0.1#catenaXId - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Catena-X Identifier - - - - - en - catenaXId - - - STRING - - - en - The fully anonymous Catena-X ID of the batch, valid for the Catena-X dataspace. - - - - - - - - - key - - - en - Identifier Key - - - urn:samm:io.catenax.batch:1.0.1#key - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Identifier Key - - - - - en - key - - - STRING - - - en - The key of a local identifier. - - - - - - - - - value - - - en - Identifier Value - - - urn:samm:io.catenax.batch:1.0.1#value - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Identifier Value - - - - - en - value - - - STRING - - - en - The value of an identifier. - - - - - - - - - localIdentifiers - - - en - Local Identifiers - - - urn:samm:io.catenax.batch:1.0.1#localIdentifiers - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Local Identifiers - - - - - en - localIdentifiers - - - STRING - - - en - A local identifier enables identification of a part in a specific dataspace, but is not unique in Catena-X dataspace. Multiple local identifiers may exist. - - - - - - - - - date - - - en - Production Date - - - urn:samm:io.catenax.batch:1.0.1#date - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Production Date - - - - - en - date - - - STRING - - - en - Timestamp of the manufacturing date as the final step in production process (e.g. final quality check, ready-for-shipment event) - - - - - - - - - country - - - en - Country code - - - urn:samm:io.catenax.batch:1.0.1#country - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Country code - - - - - en - country - - - STRING - - - en - Country code where the part was manufactured - - - - - - - - - manufacturingInformation - - - en - Manufacturing Information - - - urn:samm:io.catenax.batch:1.0.1#manufacturingInformation - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Manufacturing Information - - - - - en - manufacturingInformation - - - STRING - - - en - Information from manufacturing process, such as manufacturing date and manufacturing country - - - - - - - - - manufacturerPartId - - - en - Manufacturer Part ID - - - urn:samm:io.catenax.batch:1.0.1#manufacturerPartId - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Manufacturer Part ID - - - - - en - manufacturerPartId - - - STRING - - - en - Part ID as assigned by the manufacturer of the part. The Part ID identifies the part (as designed) in the manufacturer`s dataspace. The Part ID does not reference a specific instance of a part and thus should not be confused with the serial number or batch number. - - - - - - - - - customerPartId - - - en - Customer Part ID - - - urn:samm:io.catenax.batch:1.0.1#customerPartId - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Customer Part ID - - - - - en - customerPartId - - - STRING - - - en - Part ID as assigned by the manufacturer of the part. The Part ID identifies the part (as designed) in the customer`s dataspace. The Part ID does not reference a specific instance of a part and thus should not be confused with the serial number or batch number. Note: This property may only be populated in case there is a single customer for the batch. - - - - - - - - - nameAtManufacturer - - - en - Name at Manufacturer - - - urn:samm:io.catenax.batch:1.0.1#nameAtManufacturer - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Name at Manufacturer - - - - - en - nameAtManufacturer - - - STRING - - - en - Name of the part as assigned by the manufacturer - - - - - - - - - nameAtCustomer - - - en - Name at Customer - - - urn:samm:io.catenax.batch:1.0.1#nameAtCustomer - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Name at Customer - - - - - en - nameAtCustomer - - - STRING - - - en - Name of the part as assigned by the customer - - - - - - - - - classification - - - en - Classifcation - - - urn:samm:io.catenax.batch:1.0.1#classification - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Classifcation - - - - - en - classification - - - STRING - - - en - The classification of the part type according to STEP standard definition - - - - - - product - - ModelReference - - - DataElement - urn:samm:io.catenax.batch:1.0.1#ClassificationCharacteristic:product - - - - - - raw material - - ModelReference - - - DataElement - urn:samm:io.catenax.batch:1.0.1#ClassificationCharacteristic:raw material - - - - - - software - - ModelReference - - - DataElement - urn:samm:io.catenax.batch:1.0.1#ClassificationCharacteristic:software - - - - - - assembly - - ModelReference - - - DataElement - urn:samm:io.catenax.batch:1.0.1#ClassificationCharacteristic:assembly - - - - - - tool - - ModelReference - - - DataElement - urn:samm:io.catenax.batch:1.0.1#ClassificationCharacteristic:tool - - - - - - component - - ModelReference - - - DataElement - urn:samm:io.catenax.batch:1.0.1#ClassificationCharacteristic:component - - - - - - - - - - - - - partTypeInformation - - - en - Part Type Information - - - urn:samm:io.catenax.batch:1.0.1#partTypeInformation - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Part Type Information - - - - - en - partTypeInformation - - - STRING - - - en - The part type of which the batch has been instantiated of. - - - - - - - - - diff --git a/io.catenax.batch/1.0.1/gen/Batch-schema.json b/io.catenax.batch/1.0.1/gen/Batch-schema.json deleted file mode 100644 index 006043e6a..000000000 --- a/io.catenax.batch/1.0.1/gen/Batch-schema.json +++ /dev/null @@ -1,129 +0,0 @@ -{ - "$schema" : "http://json-schema.org/draft-04/schema", - "description" : "A batch is a quantity of (semi-) finished products or (raw) material product that have been produced under the same circumstances (e.g. same production location), as specified groups or amounts, within a certain time frame. Every batch can differ in the number or amount of products. Different batches can have varied specifications, e.g., different colors. A batch is identified via a Batch ID.", - "type" : "object", - "components" : { - "schemas" : { - "urn_bamm_io.catenax.batch_1.0.1_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).", - "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_bamm_io.catenax.batch_1.0.1_KeyCharacteristic" : { - "type" : "string", - "description" : "The key characteristic of a local identifier. A specific subset of keys is predefined, but additionally any other custom key is allowed. Predefined keys (to be used when applicable):\n- \"manufacturerId\" - The Business Partner Number (BPN) of the manufacturer. Value: BPN-Nummer\n- \"batchId\" - The identifier of the batch, to which the serialzed part belongs" - }, - "urn_bamm_io.catenax.batch_1.0.1_ValueCharacteristic" : { - "type" : "string", - "description" : "The value of an identifier." - }, - "urn_bamm_io.catenax.batch_1.0.1_KeyValueList" : { - "description" : "A list of key value pairs for local identifiers, which are composed of a key and a corresponding value.", - "type" : "object", - "properties" : { - "key" : { - "description" : "The key of a local identifier. ", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.batch_1.0.1_KeyCharacteristic" - }, - "value" : { - "description" : "The value of an identifier.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.batch_1.0.1_ValueCharacteristic" - } - }, - "required" : [ "key", "value" ] - }, - "urn_bamm_io.catenax.batch_1.0.1_LocalIdentifierCharacteristic" : { - "description" : "A batch may have multiple attributes, which uniquely identify that batch in a specific dataspace (e.g. the manufacturer`s dataspace)", - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/urn_bamm_io.catenax.batch_1.0.1_KeyValueList" - }, - "uniqueItems" : true - }, - "urn_bamm_io.openmanufacturing_characteristic_2.0.0_Timestamp" : { - "type" : "string", - "pattern" : "-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T(([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](\\.[0-9]+)?|(24:00:00(\\.0+)?))(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?", - "description" : "Describes a Property which contains the date and time with an optional timezone." - }, - "urn_bamm_io.catenax.batch_1.0.1_ProductionCountryCodeTrait" : { - "type" : "string", - "description" : "Regular Expression that ensures a three-letter code ", - "pattern" : "^[A-Z][A-Z][A-Z]$" - }, - "urn_bamm_io.catenax.batch_1.0.1_ManufacturingCharacteristic" : { - "description" : "Characteristic to describe manufacturing related data", - "type" : "object", - "properties" : { - "date" : { - "description" : "Timestamp of the manufacturing date as the final step in production process (e.g. final quality check, ready-for-shipment event)", - "$ref" : "#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Timestamp" - }, - "country" : { - "description" : "Country code where the part was manufactured", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.batch_1.0.1_ProductionCountryCodeTrait" - } - }, - "required" : [ "date" ] - }, - "urn_bamm_io.catenax.batch_1.0.1_PartIdCharacteristic" : { - "type" : "string", - "description" : "The part ID is a multi-character string, ususally assigned by an ERP system" - }, - "urn_bamm_io.catenax.batch_1.0.1_PartNameCharacteristic" : { - "type" : "string", - "description" : "Part Name in string format from the respective system in the value chain" - }, - "urn_bamm_io.catenax.batch_1.0.1_ClassificationCharacteristic" : { - "type" : "string", - "description" : "A part type must be placed into one of the following classes: 'component', 'product', 'software', ‘assembly’, 'tool', or 'raw material'.", - "enum" : [ "product", "raw material", "software", "assembly", "tool", "component" ] - }, - "urn_bamm_io.catenax.batch_1.0.1_PartTypeInformationCharacteristic" : { - "description" : "The characteristics of the part type", - "type" : "object", - "properties" : { - "manufacturerPartId" : { - "description" : "Part ID as assigned by the manufacturer of the part. The Part ID identifies the part (as designed) in the manufacturer`s dataspace. The Part ID does not reference a specific instance of a part and thus should not be confused with the serial number or batch number.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.batch_1.0.1_PartIdCharacteristic" - }, - "customerPartId" : { - "description" : "Part ID as assigned by the manufacturer of the part. The Part ID identifies the part (as designed) in the customer`s dataspace. The Part ID does not reference a specific instance of a part and thus should not be confused with the serial number or batch number. Note: This property may only be populated in case there is a single customer for the batch.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.batch_1.0.1_PartIdCharacteristic" - }, - "nameAtManufacturer" : { - "description" : "Name of the part as assigned by the manufacturer", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.batch_1.0.1_PartNameCharacteristic" - }, - "nameAtCustomer" : { - "description" : "Name of the part as assigned by the customer", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.batch_1.0.1_PartNameCharacteristic" - }, - "classification" : { - "description" : "The classification of the part type according to STEP standard definition", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.batch_1.0.1_ClassificationCharacteristic" - } - }, - "required" : [ "manufacturerPartId", "nameAtManufacturer", "classification" ] - } - } - }, - "properties" : { - "catenaXId" : { - "description" : "The fully anonymous Catena-X ID of the batch, valid for the Catena-X dataspace.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.batch_1.0.1_CatenaXIdTrait" - }, - "localIdentifiers" : { - "description" : "A local identifier enables identification of a part in a specific dataspace, but is not unique in Catena-X dataspace. Multiple local identifiers may exist.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.batch_1.0.1_LocalIdentifierCharacteristic" - }, - "manufacturingInformation" : { - "description" : "Information from manufacturing process, such as manufacturing date and manufacturing country", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.batch_1.0.1_ManufacturingCharacteristic" - }, - "partTypeInformation" : { - "description" : "The part type of which the batch has been instantiated of.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.batch_1.0.1_PartTypeInformationCharacteristic" - } - }, - "required" : [ "catenaXId", "localIdentifiers", "manufacturingInformation", "partTypeInformation" ] -} \ No newline at end of file diff --git a/io.catenax.batch/1.0.1/gen/Batch.aasx b/io.catenax.batch/1.0.1/gen/Batch.aasx deleted file mode 100644 index 2293e8470..000000000 Binary files a/io.catenax.batch/1.0.1/gen/Batch.aasx and /dev/null differ diff --git a/io.catenax.batch/1.0.1/gen/Batch.html b/io.catenax.batch/1.0.1/gen/Batch.html deleted file mode 100644 index 851188a1b..000000000 --- a/io.catenax.batch/1.0.1/gen/Batch.html +++ /dev/null @@ -1,1142 +0,0 @@ - - - - - - - - - - - - - - Dokumentation Batch - - -
-
-
-
-

Aspect Model Batch

-
urn:bamm:io.catenax.batch:1.0.1#Batch
-
-
-
-
-
-
-
- -
- - -
- A batch is a quantity of (semi-) finished products or (raw) material product that have been produced under the same circumstances (e.g. same production location), as specified groups or amounts, within a certain time frame. Every batch can differ in the number or amount of products. Different batches can have varied specifications, e.g., different colors. A batch is identified via a Batch ID. -
- - -
-

Übersicht

-
-
-
-
- Aspect Model Diagram -
-
-
- - -
-
-

Properties

-
- -
- -
-

Catena-X Identifier

-
- -The fully anonymous Catena-X ID of the batch, valid for the Catena-X dataspace. - -
-
Name
-
catenaXId
-
- - - -
-
Characteristic
-
-
-
-
Trait
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Beispiel
-
580d3adf-1981-44a0-a214-13d6ceed9379
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
catenaXId
-
- - -
-
Bedingungen
-
-
    -
  • -
    - -
    - Catena-X Id Regular Expression -
    - -
    -
    Beschreibung
    -
    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).
    -
    - - -
    -
    Regulärer Ausdruck
    -
    ^[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}$
    -
    - -
    • -
-
-
-
-
- -
-

Local Identifiers

-
- -A local identifier enables identification of a part in a specific dataspace, but is not unique in Catena-X dataspace. Multiple local identifiers may exist. - -
-
Name
-
localIdentifiers
-
- - - -
-
Characteristic
-
-
-
-
Set
-
-
-
Has no order
-
-
-
Duplicates not allowed
-
-
-
- Typ urn:bamm:io.catenax.batch:1.0.1#KeyValueList - -
-
-
-
-
- - -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
localIdentifiers
-
- - -
-
- -
-

Manufacturing Information

-
- -Information from manufacturing process, such as manufacturing date and manufacturing country - -
-
Name
-
manufacturingInformation
-
- - - -
-
Characteristic
-
-
-
-
SingleEntity
-
-
-
- Typ urn:bamm:io.catenax.batch:1.0.1#ManufacturingEntity - -
-
-
-
-
- - -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
manufacturingInformation
-
- - -
-
- -
-

Part Type Information

-
- -The part type of which the batch has been instantiated of. - -
-
Name
-
partTypeInformation
-
- - - -
-
Characteristic
-
-
-
-
SingleEntity
-
-
-
- Typ urn:bamm:io.catenax.batch:1.0.1#PartTypeInformationEntity - -
-
-
-
-
- - -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
partTypeInformation
-
- - -
-
- - - -
-
-

Objekt

-
- -
-
-

Key Value List

-
-
- A list of key value pairs for local identifiers, which are composed of a key and a corresponding value. -
- -
-

Properties

-
-
- -
-
Identifier Key
-
- -The key of a local identifier. - -
-
Name
-
key
-
- - - -
-
Characteristic
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Beispiel
-
BatchID
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
key
-
- - -
-
- -
-
Identifier Value
-
- -The value of an identifier. - -
-
Name
-
value
-
- - - -
-
Characteristic
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Beispiel
-
BID12345678
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
value
-
- - -
-
-
-
-

Manufacturing Entity

-
-
- Encapsulates the manufacturing relevant attributes -
- -
-

Properties

-
-
- -
-
Production Date
-
- -Timestamp of the manufacturing date as the final step in production process (e.g. final quality check, ready-for-shipment event) - -
-
Name
-
date
-
- - - -
-
Characteristic
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#dateTime - -
-
-
-
-
- -
-
Beispiel
-
2022-02-04T14:48:54
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
date
-
- - -
-
- -
-
Country code
-
- -Country code where the part was manufactured - -
-
Name
-
country
-
- - - -
-
Characteristic
-
-
-
-
Trait
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Beispiel
-
HUR
-
- -
-
Optional
-
- Ja
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
country
-
- - -
-
Bedingungen
-
-
    -
  • -
    - -
    - Country Code Regular Expression -
    - -
    -
    Beschreibung
    -
    Regular Expression that ensures a three-letter code
    -
    - - -
    -
    Regulärer Ausdruck
    -
    ^[A-Z][A-Z][A-Z]$
    -
    - -
    • -
-
-
-
-
-
-
-

Part Type Information Entity

-
-
- Encapsulation for data related to the part type -
- -
-

Properties

-
-
- -
-
Manufacturer Part ID
-
- -Part ID as assigned by the manufacturer of the part. The Part ID identifies the part (as designed) in the manufacturer`s dataspace. The Part ID does not reference a specific instance of a part and thus should not be confused with the serial number or batch number. - -
-
Name
-
manufacturerPartId
-
- - - -
-
Characteristic
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Beispiel
-
123-0.740-3434-A
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
manufacturerPartId
-
- - -
-
- -
-
Customer Part ID
-
- -Part ID as assigned by the manufacturer of the part. The Part ID identifies the part (as designed) in the customer`s dataspace. The Part ID does not reference a specific instance of a part and thus should not be confused with the serial number or batch number. Note: This property may only be populated in case there is a single customer for the batch. - -
-
Name
-
customerPartId
-
- - - -
-
Characteristic
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Beispiel
-
PRT-12345
-
- -
-
Optional
-
- Ja
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
customerPartId
-
- - -
-
- -
-
Name at Manufacturer
-
- -Name of the part as assigned by the manufacturer - -
-
Name
-
nameAtManufacturer
-
- - - -
-
Characteristic
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Beispiel
-
Mirror left
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
nameAtManufacturer
-
- - -
-
- -
-
Name at Customer
-
- -Name of the part as assigned by the customer - -
-
Name
-
nameAtCustomer
-
- - - -
-
Characteristic
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Beispiel
-
side element A
-
- -
-
Optional
-
- Ja
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
nameAtCustomer
-
- - -
-
- -
-
Classifcation
-
- -The classification of the part type according to STEP standard definition - -
-
Name
-
classification
-
- - - -
-
Characteristic
-
-
-
-
Enumeration
-
-
-
Werte
-
-
-
-
    -
  • product
    • -
  • raw material
    • -
  • software
    • -
  • assembly
    • -
  • tool
    • -
  • component
    • -
-
-
-
-
- Referenz -
-
    -
  • http://private.pdm-if.org/pdm-if/Frecommended-practices1
    • -
-
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Beispiel
-
raw material
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
classification
-
- - -
-
-
- -
- Third party licenses - -
- -
- - -
- - - \ No newline at end of file diff --git a/io.catenax.batch/1.0.1/gen/Batch.json b/io.catenax.batch/1.0.1/gen/Batch.json deleted file mode 100644 index 89042c6db..000000000 --- a/io.catenax.batch/1.0.1/gen/Batch.json +++ /dev/null @@ -1,18 +0,0 @@ -{ - "localIdentifiers" : [ { - "value" : "BID12345678", - "key" : "BatchID" - } ], - "manufacturingInformation" : { - "date" : "2022-02-04T14:48:54", - "country" : "HUR" - }, - "catenaXId" : "580d3adf-1981-44a0-a214-13d6ceed9379", - "partTypeInformation" : { - "manufacturerPartId" : "123-0.740-3434-A", - "customerPartId" : "PRT-12345", - "classification" : "product", - "nameAtManufacturer" : "Mirror left", - "nameAtCustomer" : "side element A" - } -} \ No newline at end of file diff --git a/io.catenax.batch/1.0.1/gen/Batch.yml b/io.catenax.batch/1.0.1/gen/Batch.yml deleted file mode 100644 index 5d103e5b8..000000000 --- a/io.catenax.batch/1.0.1/gen/Batch.yml +++ /dev/null @@ -1,262 +0,0 @@ ---- -openapi: 3.0.3 -info: - title: Batch - version: v1 -servers: -- url: catenax.io/api/v1 - variables: - api-version: - default: v1 -paths: - /{tenant-id}/batch: - get: - tags: - - Batch - operationId: getBatch - 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/Batch' - "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/Batch' - totalItems: - type: number - totalPages: - type: number - pageSize: - type: number - currentPage: - type: number - urn_bamm_io.catenax.batch_1.0.1_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)." - 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_bamm_io.catenax.batch_1.0.1_KeyCharacteristic: - type: string - description: |- - The key characteristic of a local identifier. A specific subset of keys is predefined, but additionally any other custom key is allowed. Predefined keys (to be used when applicable): - - "manufacturerId" - The Business Partner Number (BPN) of the manufacturer. Value: BPN-Nummer - - "batchId" - The identifier of the batch, to which the serialzed part belongs - urn_bamm_io.catenax.batch_1.0.1_ValueCharacteristic: - type: string - description: The value of an identifier. - urn_bamm_io.catenax.batch_1.0.1_KeyValueList: - description: "A list of key value pairs for local identifiers, which are composed\ - \ of a key and a corresponding value." - type: object - properties: - key: - description: 'The key of a local identifier. ' - $ref: '#/components/schemas/urn_bamm_io.catenax.batch_1.0.1_KeyCharacteristic' - value: - description: The value of an identifier. - $ref: '#/components/schemas/urn_bamm_io.catenax.batch_1.0.1_ValueCharacteristic' - required: - - key - - value - urn_bamm_io.catenax.batch_1.0.1_LocalIdentifierCharacteristic: - description: "A batch may have multiple attributes, which uniquely identify\ - \ that batch in a specific dataspace (e.g. the manufacturer`s dataspace)" - type: array - items: - $ref: '#/components/schemas/urn_bamm_io.catenax.batch_1.0.1_KeyValueList' - uniqueItems: true - urn_bamm_io.openmanufacturing_characteristic_2.0.0_Timestamp: - type: string - pattern: "-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T(([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](\\\ - .[0-9]+)?|(24:00:00(\\.0+)?))(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?" - description: Describes a Property which contains the date and time with an optional - timezone. - urn_bamm_io.catenax.batch_1.0.1_ProductionCountryCodeTrait: - type: string - description: 'Regular Expression that ensures a three-letter code ' - pattern: "^[A-Z][A-Z][A-Z]$" - urn_bamm_io.catenax.batch_1.0.1_ManufacturingCharacteristic: - description: Characteristic to describe manufacturing related data - type: object - properties: - date: - description: "Timestamp of the manufacturing date as the final step in production\ - \ process (e.g. final quality check, ready-for-shipment event)" - $ref: '#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Timestamp' - country: - description: Country code where the part was manufactured - $ref: '#/components/schemas/urn_bamm_io.catenax.batch_1.0.1_ProductionCountryCodeTrait' - required: - - date - urn_bamm_io.catenax.batch_1.0.1_PartIdCharacteristic: - type: string - description: "The part ID is a multi-character string, ususally assigned by\ - \ an ERP system" - urn_bamm_io.catenax.batch_1.0.1_PartNameCharacteristic: - type: string - description: Part Name in string format from the respective system in the value - chain - urn_bamm_io.catenax.batch_1.0.1_ClassificationCharacteristic: - type: string - description: "A part type must be placed into one of the following classes:\ - \ 'component', 'product', 'software', ‘assembly’, 'tool', or 'raw material'." - enum: - - product - - raw material - - software - - assembly - - tool - - component - urn_bamm_io.catenax.batch_1.0.1_PartTypeInformationCharacteristic: - description: The characteristics of the part type - type: object - properties: - manufacturerPartId: - description: Part ID as assigned by the manufacturer of the part. The Part - ID identifies the part (as designed) in the manufacturer`s dataspace. - The Part ID does not reference a specific instance of a part and thus - should not be confused with the serial number or batch number. - $ref: '#/components/schemas/urn_bamm_io.catenax.batch_1.0.1_PartIdCharacteristic' - customerPartId: - description: "Part ID as assigned by the manufacturer of the part. The Part\ - \ ID identifies the part (as designed) in the customer`s dataspace. The\ - \ Part ID does not reference a specific instance of a part and thus should\ - \ not be confused with the serial number or batch number. Note: This property\ - \ may only be populated in case there is a single customer for the batch." - $ref: '#/components/schemas/urn_bamm_io.catenax.batch_1.0.1_PartIdCharacteristic' - nameAtManufacturer: - description: Name of the part as assigned by the manufacturer - $ref: '#/components/schemas/urn_bamm_io.catenax.batch_1.0.1_PartNameCharacteristic' - nameAtCustomer: - description: Name of the part as assigned by the customer - $ref: '#/components/schemas/urn_bamm_io.catenax.batch_1.0.1_PartNameCharacteristic' - classification: - description: The classification of the part type according to STEP standard - definition - $ref: '#/components/schemas/urn_bamm_io.catenax.batch_1.0.1_ClassificationCharacteristic' - required: - - manufacturerPartId - - nameAtManufacturer - - classification - Batch: - description: "A batch is a quantity of (semi-) finished products or (raw) material\ - \ product that have been produced under the same circumstances (e.g. same\ - \ production location), as specified groups or amounts, within a certain time\ - \ frame. Every batch can differ in the number or amount of products. Different\ - \ batches can have varied specifications, e.g., different colors. A batch\ - \ is identified via a Batch ID." - type: object - properties: - catenaXId: - description: "The fully anonymous Catena-X ID of the batch, valid for the\ - \ Catena-X dataspace." - $ref: '#/components/schemas/urn_bamm_io.catenax.batch_1.0.1_CatenaXIdTrait' - localIdentifiers: - description: "A local identifier enables identification of a part in a specific\ - \ dataspace, but is not unique in Catena-X dataspace. Multiple local identifiers\ - \ may exist." - $ref: '#/components/schemas/urn_bamm_io.catenax.batch_1.0.1_LocalIdentifierCharacteristic' - manufacturingInformation: - description: "Information from manufacturing process, such as manufacturing\ - \ date and manufacturing country" - $ref: '#/components/schemas/urn_bamm_io.catenax.batch_1.0.1_ManufacturingCharacteristic' - partTypeInformation: - description: The part type of which the batch has been instantiated of. - $ref: '#/components/schemas/urn_bamm_io.catenax.batch_1.0.1_PartTypeInformationCharacteristic' - required: - - catenaXId - - localIdentifiers - - manufacturingInformation - - partTypeInformation - 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' - Batch: - content: - application/json: - schema: - $ref: '#/components/schemas/PagingSchema' - description: The request was successful. - requestBodies: - Batch: - content: - application/json: - schema: - $ref: '#/components/schemas/Batch' diff --git a/io.catenax.batch/1.0.1/metadata.json b/io.catenax.batch/1.0.1/metadata.json deleted file mode 100644 index a2ec4de55..000000000 --- a/io.catenax.batch/1.0.1/metadata.json +++ /dev/null @@ -1 +0,0 @@ -{"status": "deprecate"} diff --git a/io.catenax.battery.battery_pass/2.0.0/BatteryPass.ttl b/io.catenax.battery.battery_pass/2.0.0/BatteryPass.ttl deleted file mode 100644 index debcea9ae..000000000 --- a/io.catenax.battery.battery_pass/2.0.0/BatteryPass.ttl +++ /dev/null @@ -1,924 +0,0 @@ -####################################################################### -# Copyright (c) 2022 Badische Anilin und Sodafabrik societates Europaea -# Copyright (c) 2022 Bayerische Motoren Werke Aktiengesellschaft -# Copyright (c) 2022 Robert Bosch GmbH -# Copyright (c) 2022 Henkel AG & Co. KGaA -# Copyright (c) 2022 SAP SE -# Copyright (c) 2022 T-Systems International GmbH -# Copyright (c) 2022 ZF Friedrichshafen AG -# Copyright (c) 2022 Contributors to the Eclipse Foundation -# -# 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 bamm: . -@prefix bamm-c: . -@prefix bamm-e: . -@prefix unit: . -@prefix rdf: . -@prefix rdfs: . -@prefix xsd: . -@prefix : . -@prefix address-c: . -@prefix contact-c: . - -:BatteryPass a bamm:Aspect; - bamm:name "BatteryPass"; - bamm:properties ([ - bamm:property :document; - bamm:optional "true"^^xsd:boolean -] :manufacturer :electrochemicalProperties :physicalDimensions :stateOfBattery :batteryIdentification :manufacturing :datePlacedOnMarket :cellChemistry :composition :cO2FootprintTotal :temperatureRangeIdleState :warrantyPeriod :batteryCycleLife); - bamm:operations (); - bamm:preferredName "battery pass"@en; - bamm:description "The battery pass describes information collected during the lifecycle of a battery"@en; - bamm:see ; - bamm:events (). -:document a bamm:Property; - bamm:name "document"; - bamm:preferredName "document"@en; - bamm:description "Set of documents containing the description of battery components"@en; - bamm:characteristic :DocumentCharacteristic. -:manufacturer a bamm:Property; - bamm:name "manufacturer"; - bamm:preferredName "manufacturer"@en; - bamm:description "Legal entity which sells and invoices the battery"@en; - bamm:characteristic :ManufacturerCharacteristic. -:electrochemicalProperties a bamm:Property; - bamm:name "electrochemicalProperties"; - bamm:preferredName "electrochemical properties"@en; - bamm:description "Electrochemical properties of an electrochemical energy storage"@en; - bamm:characteristic :ElectrochemicalPropertiesCharacteristic. -:physicalDimensions a bamm:Property; - bamm:name "physicalDimensions"; - bamm:preferredName "physical dimensions"@en; - bamm:description "Geometrical properties of the battery"@en; - bamm:characteristic :PhysicalDimensionsCharacteristic. -:stateOfBattery a bamm:Property; - bamm:name "stateOfBattery"; - bamm:preferredName "state of battery"@en; - bamm:description "The condition of the battery at the end of life i.e. when entering recycling scheme"@en; - bamm:characteristic :StateOfBatteryCharacteristic. -:batteryIdentification a bamm:Property; - bamm:name "batteryIdentification"; - bamm:preferredName "battery identification"@en; - bamm:description "Information to identify a specific battery."@en; - bamm:characteristic :BatteryIdentificationCharacteristic. -:manufacturing a bamm:Property; - bamm:name "manufacturing"; - bamm:preferredName "manufacturing"@en; - bamm:description "Information about the manufacturing process of a battery"@en; - bamm:characteristic :ManufacturingCharacteristic. -:datePlacedOnMarket a bamm:Property; - bamm:name "datePlacedOnMarket"; - bamm:preferredName "date placed on market"@en; - bamm:description "Date on which vehicle is produced i.e. when battery is put in the market or production date of the vehicle is describing a regulatory requirement."@en; - bamm:characteristic :Datestamp. -:cellChemistry a bamm:Property; - bamm:name "cellChemistry"; - bamm:preferredName "cell chemistry"@en; - bamm:description "Information about the cell chemistry of a battery cell"@en; - bamm:characteristic :CellChemistryCharacteristic. -:composition a bamm:Property; - bamm:name "composition"; - bamm:preferredName "composition"@en; - bamm:description "Information about the composition of a battery and the combination of materials is describing a business requirement."@en; - bamm:characteristic :CompositionCharacteristic. -:cO2FootprintTotal a bamm:Property; - bamm:name "cO2FootprintTotal"; - bamm:preferredName "CO2 footprint total"@en; - bamm:description "The total carbon footprint of the battery, calculated as kg of carbon dioxide equivalent is describing a regulatory requirement."@en; - bamm:characteristic :CO2FootprintTotalCharacteristic; - bamm:exampleValue "124.00"^^xsd:double. -:temperatureRangeIdleState a bamm:Property; - bamm:name "temperatureRangeIdleState"; - bamm:preferredName "temperature range idle state"@en; - bamm:description "The range of temperature the battery can withstand when not in use is describing a regulatory requirement."@en; - bamm:characteristic :TemperatureRangeIdleStateCharacterisitic. -:warrantyPeriod a bamm:Property; - bamm:name "warrantyPeriod"; - bamm:preferredName "warranty period"@en; - bamm:description "Commercial warranty period of the battery is describing a regulatory requirement."@en; - bamm:characteristic :WarrantyPeriodCharacterisitic; - bamm:exampleValue "60"^^xsd:positiveInteger. -:batteryCycleLife a bamm:Property; - bamm:name "batteryCycleLife"; - bamm:preferredName "battery cycle life"@en; - bamm:description "Property describing the cycle life of a battery"@en; - bamm:characteristic :BatteryCycleLifeCharacteristic. -:DocumentCharacteristic a bamm:Characteristic; - bamm:name "DocumentCharacteristic"; - bamm:preferredName "document characteristic"@en; - bamm:description "Set of documents containing the description of battery components"@en; - bamm:dataType :DocumentEntity. -:ManufacturerCharacteristic a bamm:Characteristic; - bamm:name "ManufacturerCharacteristic"; - bamm:preferredName "manufacturer characteristic"@en; - bamm:description "A manufacturer of goods"@en; - bamm:dataType :ManufacturerEntity. -:ElectrochemicalPropertiesCharacteristic a bamm:Characteristic; - bamm:name "ElectrochemicalPropertiesCharacteristic"; - bamm:preferredName "electrochemical properties characteristic"@en; - bamm:description "Electrochemical characteristics to describe a battery"@en; - bamm:dataType :ElectrochemicalPropertiesEntity. -:PhysicalDimensionsCharacteristic a bamm:Characteristic; - bamm:name "PhysicalDimensionsCharacteristic"; - bamm:preferredName "physical dimensions characteristic"@en; - bamm:description "Geometrical properties of the battery"@en; - bamm:dataType :PhysicalDimensionsEntity. -:StateOfBatteryCharacteristic a bamm:Characteristic; - bamm:name "StateOfBatteryCharacteristic"; - bamm:preferredName "state of battery characteristic"@en; - bamm:description "The condition of the battery at the end of life i.e. when entering recycling scheme"@en; - bamm:dataType :StateOfBatteryEntity. -:BatteryIdentificationCharacteristic a bamm:Characteristic; - bamm:name "BatteryIdentificationCharacteristic"; - bamm:preferredName "battery identification characteristic"@en; - bamm:description "Information to identify a specific battery."@en; - bamm:dataType :BatteryIdentificationEntity. -:ManufacturingCharacteristic a bamm:Characteristic; - bamm:name "ManufacturingCharacteristic"; - bamm:preferredName "manufacturing characteristic"@en; - bamm:description "Information about the manufacturing process of a battery"@en; - bamm:dataType :ManufacturingEntity. -:Datestamp a bamm:Characteristic; - bamm:name "Datestamp"; - bamm:preferredName "datestamp"@en; - bamm:description "Describes a Property which contains the date and time with an optional timezone."@en; - bamm:dataType xsd:date. -:CellChemistryCharacteristic a bamm:Characteristic; - bamm:name "CellChemistryCharacteristic"; - bamm:preferredName "cell chemistry"@en; - bamm:description "Information about the the cell chemistry of a battery cell"@en; - bamm:dataType :CellChemistryEntity. -:CompositionCharacteristic a bamm:Characteristic; - bamm:name "CompositionCharacteristic"; - bamm:preferredName "composition"@en; - bamm:description "Information about the composition of a battery and the combination of materials is describing a business requirement."@en; - bamm:dataType :CompositionEntity. -:CO2FootprintTotalCharacteristic a bamm-c:Measurement; - bamm:name "CO2FootprintTotalCharacteristic"; - bamm:preferredName "co2 footprint total"@en; - bamm:description "The total carbon footprint of the battery, calculated as kg of carbon dioxide equivalent is describing a regulatory requirement."@en; - bamm:dataType xsd:double; - bamm-c:unit unit:kilogram. -:TemperatureRangeIdleStateCharacterisitic a bamm:Characteristic; - bamm:name "TemperatureRangeIdleStateCharacterisitic"; - bamm:preferredName "temperature range idle state"@en; - bamm:description "The range of temperature the battery can withstand when not in use is describing a regulatory requirement."@en; - bamm:dataType :TemperatureRangeIdleStateEntity. -:WarrantyPeriodCharacterisitic a bamm-c:Measurement; - bamm:name "WarrantyPeriodCharacterisitic"; - bamm:preferredName "warranty period"@en; - bamm:description "Commercial warranty period of the battery is describing a regulatory requirement."@en; - bamm:dataType xsd:positiveInteger; - bamm-c:unit unit:month. -:BatteryCycleLifeCharacteristic a bamm:Characteristic; - bamm:name "BatteryCycleLifeCharacteristic"; - bamm:preferredName "battery cycle life"@en; - bamm:description "Characterisitic describing the cycle life of a battery"@en; - bamm:dataType :BatteryCycleLifeEntity. -:DocumentEntity a bamm:Entity; - bamm:name "DocumentEntity"; - bamm:properties ([ - bamm:property :packagingInstructions; - bamm:optional "true"^^xsd:boolean -] [ - bamm:property :transportationInstructions; - bamm:optional "true"^^xsd:boolean -] [ - bamm:property :vehicleDismantlingProcedure; - bamm:optional "true"^^xsd:boolean -] [ - bamm:property :batteryDismantlingProcedure; - bamm:optional "true"^^xsd:boolean -] [ - bamm:property :safetyMeasures; - bamm:optional "true"^^xsd:boolean -] [ - bamm:property :testReportsResults; - bamm:optional "true"^^xsd:boolean -] [ - bamm:property :declarationOfConformity; - bamm:optional "true"^^xsd:boolean -] [ - bamm:property :responsibleSourcing; - bamm:optional "true"^^xsd:boolean -]); - bamm:preferredName "document entity"@en; - bamm:description "Entity encapsulating the details of a attachment for the battery"@en. -:ManufacturerEntity a bamm:Entity; - bamm:name "ManufacturerEntity"; - bamm:properties (:name :contact :address); - bamm:preferredName "manufacturer"@en; - bamm:description "Entity encapsulating the details of a manufacturer of goods"@en. -:ElectrochemicalPropertiesEntity a bamm:Entity; - bamm:name "ElectrochemicalPropertiesEntity"; - bamm:properties (:batteryPower :batteryVoltage :ratedCapacity :capacityFade :internalResistance :capacityThresholdExhaustion :batteryEnergy :ratioMaximumAllowedBatteryPowerAndMaximumAllowedBatteryEnergy); - bamm:preferredName "electrochemical properties entity"@en; - bamm:description "Entity encapsulating the electrochemical details of a battery"@en. -:PhysicalDimensionsEntity a bamm:Entity; - bamm:name "PhysicalDimensionsEntity"; - bamm:properties (:length :width :height :diameter :weight); - bamm:preferredName "physical dimensions entity"@en; - bamm:description "Entity to bundle the characterisitics describing the physical dimensions"@en. -:StateOfBatteryEntity a bamm:Entity; - bamm:name "StateOfBatteryEntity"; - bamm:properties (:stateOfHealth :stateOfCharge :statusBattery); - bamm:preferredName "state of battery entity"@en; - bamm:description "Entity to bundle the characterisitics describing the state of a battery"@en. -:BatteryIdentificationEntity a bamm:Entity; - bamm:name "BatteryIdentificationEntity"; - bamm:properties (:batteryType :batteryModel :batteryIDDMCCode); - bamm:preferredName "battery identification entity"@en; - bamm:description "Entity to bundle the characterisitics describing the identification of a battery"@en. -:ManufacturingEntity a bamm:Entity; - bamm:name "ManufacturingEntity"; - bamm:properties (:dateOfManufacturing :address); - bamm:preferredName "manufacturing entity"@en; - bamm:description "Entity to bundle the characterisitics describing the manufacturing (place and date of manufacture)"@en. -:CellChemistryEntity a bamm:Entity; - bamm:name "CellChemistryEntity"; - bamm:properties (:cathodeActiveMaterials :recyclateContentActiveMaterials :anodeActiveMaterials :cathodeCompositionOther :anodeCompositionOther :electrolyteComposition); - bamm:preferredName "cell chemistry"@en; - bamm:description "Entity to bundle the characterisitics describing a battery's cell chemistry"@en. -:CompositionEntity a bamm:Entity; - bamm:name "CompositionEntity"; - bamm:properties (:components :compositionOfBattery :criticalRawMaterials); - bamm:preferredName "composition"@en; - bamm:description "Entity to bundle the characterisitics describing a battery's composition"@en. -:TemperatureRangeIdleStateEntity a bamm:Entity; - bamm:name "TemperatureRangeIdleStateEntity"; - bamm:properties (:temperatureRangeIdleStateLowerLimit :temperatureRangeIdleStateUpperLimit); - bamm:preferredName "temperature range idle state"@en; - bamm:description "Entity to bundle the characterisitics describing the battery's temperature range"@en. -:BatteryCycleLifeEntity a bamm:Entity; - bamm:name "BatteryCycleLifeEntity"; - bamm:properties (:cycleLifeTestCRate :cycleLifeTestDepthOfDischarge :expectedLifetime); - bamm:preferredName "battery cycle life entity"@en; - bamm:description "Entity to bundle the characterisitics describing the cycle life of a battery"@en. -:packagingInstructions a bamm:Property; - bamm:name "packagingInstructions"; - bamm:preferredName "packaging instructions"@en; - bamm:description "Instructions for safely packaging\nbatteries is describing a business requirement."@en; - bamm:characteristic :AttachmentLinkCharacteristic. -:transportationInstructions a bamm:Property; - bamm:name "transportationInstructions"; - bamm:preferredName "transportation instructions"@en; - bamm:description "Instructions for safely transporting\nbatteries is describing a business requirement."@en; - bamm:characteristic :AttachmentLinkCharacteristic. -:vehicleDismantlingProcedure a bamm:Property; - bamm:name "vehicleDismantlingProcedure"; - bamm:preferredName "vehicle dismantling procedure"@en; - bamm:description "Document containing the vehicle dismantling procedure is describing a regulatory requirement."@en; - bamm:characteristic :AttachmentLinkCharacteristic. -:batteryDismantlingProcedure a bamm:Property; - bamm:name "batteryDismantlingProcedure"; - bamm:preferredName "battery dismantling procedure"@en; - bamm:description "Document containing the battery dismantling procedure is describing a regulatory requirement."@en; - bamm:characteristic :AttachmentLinkCharacteristic. -:safetyMeasures a bamm:Property; - bamm:name "safetyMeasures"; - bamm:preferredName "safety measures"@en; - bamm:description "Safety measures document(s) is describing a regulatory requirement."@en; - bamm:characteristic :AttachmentLinkCharacteristic. -:testReportsResults a bamm:Property; - bamm:name "testReportsResults"; - bamm:preferredName "test reports results"@en; - bamm:description "Results of test reports which prove that the battery fulfills this regulation and its delegated regulations is describing a regulatory requirement."@en; - bamm:characteristic :AttachmentLinkCharacteristic. -:declarationOfConformity a bamm:Property; - bamm:name "declarationOfConformity"; - bamm:preferredName "declaration of conformity"@en; - bamm:description "Declaration of conformity (CE) is describing a regulatory requirement."@en; - bamm:characteristic :AttachmentLinkCharacteristic. -:responsibleSourcing a bamm:Property; - bamm:name "responsibleSourcing"; - bamm:preferredName "responsible sourcing"@en; - bamm:description "Document/Certificates on organizations compliance to ethical business practices"@en; - bamm:characteristic :AttachmentLinkCharacteristic. -:name a bamm:Property; - bamm:name "name"; - bamm:preferredName "name"@en; - bamm:description "Name of the manufacturer is describing a regulatory requirement."@en; - bamm:characteristic bamm-c:Text; - bamm:exampleValue "Samsung". -:contact a bamm:Property; - bamm:name "contact"; - bamm:preferredName "contact"@en; - bamm:description "Contact details of the manufacturer"@en; - bamm:characteristic contact-c:ContactCharacteristic. -:address a bamm:Property; - bamm:name "address"; - bamm:preferredName "address"@en; - bamm:description "An postal address"@en; - bamm:characteristic address-c:PostalAddress. -:batteryPower a bamm:Property; - bamm:name "batteryPower"; - bamm:preferredName "attachment"@en; - bamm:description "Characterisitic to describe the power (W) properties of the batterie."@en; - bamm:characteristic :BatteryPowerCharacteristic. -:batteryVoltage a bamm:Property; - bamm:name "batteryVoltage"; - bamm:preferredName "battery voltage"@en; - bamm:description "Voltage (V) of the battery."@en; - bamm:characteristic :BatteryVoltageCharacteristiC. -:ratedCapacity a bamm:Property; - bamm:name "ratedCapacity"; - bamm:preferredName "rated capacity"@en; - bamm:description "The total number of ampere-hours (Ah) that can be withdrawn from a fully charged battery under specific conditions is describing a regulatory requirement."@en; - bamm:characteristic :RatedCapacityCharacteristic; - bamm:exampleValue "210"^^xsd:decimal. -:capacityFade a bamm:Property; - bamm:name "capacityFade"; - bamm:preferredName "capacity fade"@en; - bamm:description "The decrease over time and upon usage in the amount of charge that a battery can deliver at the rated voltage, with respect to the original rated capacity declared by the manufacturer is describing a regulatory requirement."@en; - bamm:characteristic :CapacityFadeCharacteristic; - bamm:exampleValue "34"^^xsd:decimal. -:internalResistance a bamm:Property; - bamm:name "internalResistance"; - bamm:preferredName "internal resistance"@en; - bamm:description "Internal resistance in a battery cell or pack is describing a regulatory requirement."@en; - bamm:characteristic :InternalResistanceCharacteristic. -:capacityThresholdExhaustion a bamm:Property; - bamm:name "capacityThresholdExhaustion"; - bamm:preferredName "internal resistance"@en; - bamm:description "Capacity threshold for exhaustion as percentage value is describing a regulatory requirement."@en; - bamm:characteristic :CapacityThresholdExhaustionCharacterisitic; - bamm:exampleValue "23"^^xsd:decimal. -:batteryEnergy a bamm:Property; - bamm:name "batteryEnergy"; - bamm:preferredName "battery energy"@en; - bamm:description "Characterisitic to describe the energy (kWh) properties of the batterie."@en; - bamm:characteristic :BatteryEnergyCharacterisitc. -:ratioMaximumAllowedBatteryPowerAndMaximumAllowedBatteryEnergy a bamm:Property; - bamm:name "ratioMaximumAllowedBatteryPowerAndMaximumAllowedBatteryEnergy"; - bamm:preferredName "ratio maximum allowed battery power and maximum allowed battery energy"@en; - bamm:description "Ratio between maximum allowed battery power (W) and battery energy (Wh) is describing a regulatory requirement."@en; - bamm:characteristic :RatioMaximumAllowedBatteryPowerAndMaximumAllowedBatteryEnergyCharacterisitic; - bamm:exampleValue "0.611"^^xsd:float. -:length a bamm:Property; - bamm:name "length"; - bamm:preferredName "length"@en; - bamm:description "Length of the item is describing a business requirement."@en; - bamm:characteristic :MillimetreCharacteristic; - bamm:exampleValue "20000"^^xsd:integer. -:width a bamm:Property; - bamm:name "width"; - bamm:preferredName "width"@en; - bamm:description "Width of the item is describing a business requirement."@en; - bamm:characteristic :MillimetreCharacteristic; - bamm:exampleValue "1000"^^xsd:integer. -:height a bamm:Property; - bamm:name "height"; - bamm:preferredName "height"@en; - bamm:description "Height of the item is describing a business requirement."@en; - bamm:characteristic :MillimetreCharacteristic; - bamm:exampleValue "1"^^xsd:integer. -:diameter a bamm:Property; - bamm:name "diameter"; - bamm:preferredName "diameter"@en; - bamm:description "Diameter of the item."@en; - bamm:characteristic :MillimetreCharacteristic; - bamm:exampleValue "3"^^xsd:integer. -:weight a bamm:Property; - bamm:name "weight"; - bamm:preferredName "weight"@en; - bamm:description "Weight of the item is describing a regulatory requirement."@en; - bamm:characteristic :KilogramCharacteristic; - bamm:exampleValue "1007"^^xsd:integer. -:stateOfHealth a bamm:Property; - bamm:name "stateOfHealth"; - bamm:preferredName "state of health"@en; - bamm:description "Evidence/Certificate of the health evaluation of a battery for its use following repurposing or remanufacturing operations is describing a business requirement."@en; - bamm:characteristic :StateOfHealthCharacteristic; - bamm:exampleValue "12"^^xsd:integer. -:stateOfCharge a bamm:Property; - bamm:name "stateOfCharge"; - bamm:preferredName "state of charge"@en; - bamm:description "The value of the state of charge of the battery at the end of life i.e. when entering recycling scheme is describing a business requirement."@en; - bamm:characteristic :StateOfChargeCharacteristic; - bamm:exampleValue "23"^^xsd:integer. -:statusBattery a bamm:Property; - bamm:name "statusBattery"; - bamm:preferredName "status battery"@en; - bamm:description "Status of the battery is describing a regulatory requirement. Value list provided by the regulators."@en; - bamm:characteristic bamm-c:Text; - bamm:exampleValue "first life/ waste/ repaired/ repurposed/ recycled". -:batteryType a bamm:Property; - bamm:name "batteryType"; - bamm:preferredName "battery type"@en; - bamm:description "Battery type as described by the contents of the battery e.g. cell chemistry is describing a regulatory requirement."@en; - bamm:characteristic bamm-c:Text; - bamm:exampleValue "LFP, Natrium, Li-Ion, NMC, NCA, Solid-State". -:batteryModel a bamm:Property; - bamm:name "batteryModel"; - bamm:preferredName "battery model"@en; - bamm:description "Battery type as described by the contents of the battery e.g. cell chemistry is describing a regulatory requirement."@en; - bamm:characteristic bamm-c:Text; - bamm:exampleValue "LFP, Natrium, Li-Ion, NMC, NCA, Solid-State". -:batteryIDDMCCode a bamm:Property; - bamm:name "batteryIDDMCCode"; - bamm:preferredName "battery ID DMC code"@en; - bamm:description "Digital Matrix Code (DMC) of the battery i.e. serial number allowing for unequivocal identification of a battery is describing a regulatory requirement."@en; - bamm:characteristic bamm-c:Text; - bamm:exampleValue "X123456789012X12345678901234567". -:dateOfManufacturing a bamm:Property; - bamm:name "dateOfManufacturing"; - bamm:preferredName "date of manufacturing"@en; - bamm:description "Manufacturing date of the battery is describing a regulatory requirement."@en; - bamm:characteristic :Datestamp; - bamm:exampleValue "2022-03-07"^^xsd:date. -:cathodeActiveMaterials a bamm:Property; - bamm:name "cathodeActiveMaterials"; - bamm:preferredName "cathode active materials"@en; - bamm:description "The total amount of valuable materials contained in CAM material: Nickel, Cobalt, Lithium."@en; - bamm:characteristic :CathodeActiveMaterialsCharacterisitic. -:recyclateContentActiveMaterials a bamm:Property; - bamm:name "recyclateContentActiveMaterials"; - bamm:preferredName "recyclate content active materials"@en; - bamm:description "List of recovered Recyclate Content in Active Material Recycled is describing a regulatory requirement. The following materials have to be reported on as a minimium: Cobalt, Lithium, Nickel, Lead"@en; - bamm:characteristic :RecyclateContentActiveMaterialsCharacteristic. -:anodeActiveMaterials a bamm:Property; - bamm:name "anodeActiveMaterials"; - bamm:preferredName "anode active materials"@en; - bamm:description "The total amount of valuable materials contained in Anode: graphite"@en; - bamm:characteristic :AnodeActiveMaterialsCharacteristic. -:cathodeCompositionOther a bamm:Property; - bamm:name "cathodeCompositionOther"; - bamm:preferredName "cathode composition other"@en; - bamm:description "The composition or materials contained in the Cathode is describing a regulatory requirement."@en; - bamm:characteristic :CathodeCompositionOtherCharacteristic. -:anodeCompositionOther a bamm:Property; - bamm:name "anodeCompositionOther"; - bamm:preferredName "anode composition other"@en; - bamm:description "The composition or materials contained in the anode is describing a regulatory requirement."@en; - bamm:characteristic :AnodeCompositionOtherCharacteristic. -:electrolyteComposition a bamm:Property; - bamm:name "electrolyteComposition"; - bamm:preferredName "electrolyte composition"@en; - bamm:description "List of materials contained in the electrolyte is describing a regulatory requirement."@en; - bamm:see ; - bamm:characteristic :ElectrolyteCompositionCharacteristic. -:components a bamm:Property; - bamm:name "components"; - bamm:preferredName "components"@en; - bamm:description "Properties of the batterie's comoponents."@en; - bamm:characteristic :ComponentsCharacteristic. -:compositionOfBattery a bamm:Property; - bamm:name "compositionOfBattery"; - bamm:preferredName "composition of battery"@en; - bamm:description "Full composition of battery is describing a business requirement."@en; - bamm:characteristic :CompositionOfBatteryCharacteristic. -:criticalRawMaterials a bamm:Property; - bamm:name "criticalRawMaterials"; - bamm:preferredName "critical raw materials"@en; - bamm:description "List of critical raw materials (CRM) as specified by EU in a battery is describing a regulatory requirement."@en; - bamm:characteristic :CriticalRawMaterialsCharacteristic. -:temperatureRangeIdleStateLowerLimit a bamm:Property; - bamm:name "temperatureRangeIdleStateLowerLimit"; - bamm:preferredName "temperature range idle state lower limit"@en; - bamm:description "The lower range of temperature the battery can withstand when not in use is describing a regulatory requirement."@en; - bamm:characteristic :TemperatureRangeCharacterisitic; - bamm:exampleValue "67"^^xsd:decimal. -:temperatureRangeIdleStateUpperLimit a bamm:Property; - bamm:name "temperatureRangeIdleStateUpperLimit"; - bamm:preferredName "temperature rangeIdle state upper limit"@en; - bamm:description "The upper range of temperature the battery can withstand when not in use is describing a regulatory requirement."@en; - bamm:characteristic :TemperatureRangeCharacterisitic; - bamm:exampleValue "67"^^xsd:decimal. -:cycleLifeTestCRate a bamm:Property; - bamm:name "cycleLifeTestCRate"; - bamm:preferredName "cycle life test c-rate"@en; - bamm:description "C-rate of Relevant Cycle-life Test is describing a regulatory requirement."@en; - bamm:characteristic :CycleLifeTestCRateCharacterisitc; - bamm:exampleValue "45"^^xsd:decimal. -:cycleLifeTestDepthOfDischarge a bamm:Property; - bamm:name "cycleLifeTestDepthOfDischarge"; - bamm:preferredName "cycle-life test depth of discharge"@en; - bamm:description "Depth of discharge in the cycle-life test is describing a regulatory requirement."@en; - bamm:characteristic :CycleLifeTestDepthOfDischargeCharacteristic; - bamm:exampleValue "23"^^xsd:decimal. -:expectedLifetime a bamm:Property; - bamm:name "expectedLifetime"; - bamm:preferredName "expected lifetime"@en; - bamm:description "Expected battery lifetime expressed in cycles, and reference test used is describing a regulatory requirement."@en; - bamm:characteristic :ExpectedLifetime; - bamm:exampleValue "456"^^xsd:decimal. -:AttachmentLinkCharacteristic a bamm-c:Set; - bamm:name "AttachmentLinkCharacteristic"; - bamm:preferredName "attachment"@en; - bamm:description "Links the referenced attachments"@en; - bamm:dataType :AttachmentEntity. -:BatteryPowerCharacteristic a bamm:Characteristic; - bamm:name "BatteryPowerCharacteristic"; - bamm:preferredName "battery power characteristic"@en; - bamm:description "Characterisitic to describe the power (W) properties of the batterie."@en; - bamm:dataType :BatteryPowerEntity. -:BatteryVoltageCharacteristiC a bamm:Characteristic; - bamm:name "BatteryVoltageCharacteristiC"; - bamm:preferredName "BatteryVoltageCharacteristic"@en; - bamm:description "Characterisitic to describe the voltage (V) properties of the batterie."@en; - bamm:dataType :BatteryVoltageEntity. -:RatedCapacityCharacteristic a bamm-c:Measurement; - bamm:name "RatedCapacityCharacteristic"; - bamm:preferredName "rated capacity characteristic"@en; - bamm:description "The total number of ampere-hours (Ah) that can be withdrawn from a fully charged battery under specific conditions is describing a regulatory requirement."@en; - bamm:dataType xsd:decimal; - bamm-c:unit unit:ampere. -:CapacityFadeCharacteristic a bamm-c:Measurement; - bamm:name "CapacityFadeCharacteristic"; - bamm:preferredName "capacity fade characteristic"@en; - bamm:description "The decrease over time and upon usage in the amount of charge that a battery can deliver at the rated voltage, with respect to the original rated capacity declared by the manufacturer is describing a regulatory requirement."@en; - bamm:dataType xsd:decimal; - bamm-c:unit unit:percent. -:InternalResistanceCharacteristic a bamm:Characteristic; - bamm:name "InternalResistanceCharacteristic"; - bamm:preferredName "internal resistance"@en; - bamm:description "Internal resistance in a battery cell or pack is describing a regulatory requirement."@en; - bamm:dataType :InternalResistanceEntity. -:CapacityThresholdExhaustionCharacterisitic a bamm-c:Measurement; - bamm:name "CapacityThresholdExhaustionCharacterisitic"; - bamm:preferredName "capacity threshold exhaustion characterisitic"@en; - bamm:description "Capacity threshold for exhaustion as percentage value is describing a regulatory requirement."@en; - bamm:dataType xsd:decimal; - bamm-c:unit unit:percent. -:BatteryEnergyCharacterisitc a bamm:Characteristic; - bamm:name "BatteryEnergyCharacterisitc"; - bamm:preferredName "battery energy characterisitc"@en; - bamm:description "Characterisitic to describe the energy (kWh) properties of the batterie."@en; - bamm:dataType :BatteryEnergyEntity. -:RatioMaximumAllowedBatteryPowerAndMaximumAllowedBatteryEnergyCharacterisitic a bamm:Characteristic; - bamm:name "RatioMaximumAllowedBatteryPowerAndMaximumAllowedBatteryEnergyCharacterisitic"; - bamm:preferredName "ratio maximum allowed battery power and maximum allowed battery energy characterisitic"@en; - bamm:description "Ratio between maximum allowed battery power (W) and battery energy (Wh) is describing a regulatory requirement."@en; - bamm:dataType xsd:float. -:MillimetreCharacteristic a bamm-c:Measurement; - bamm:name "MillimetreCharacteristic"; - bamm:preferredName "millimetre characteristic"@en; - bamm:description "A measurment for the length/width/height of an item."@en; - bamm:dataType xsd:integer; - bamm-c:unit unit:millimetre. -:KilogramCharacteristic a bamm-c:Measurement; - bamm:name "KilogramCharacteristic"; - bamm:preferredName "kilogram characteristic"@en; - bamm:description "A measurement for the weight of an item."@en; - bamm:dataType xsd:integer; - bamm-c:unit unit:kilogram. -:StateOfHealthCharacteristic a bamm-c:Measurement; - bamm:name "StateOfHealthCharacteristic"; - bamm:preferredName "state of health characteristic"@en; - bamm:description "Evidence/Certificate of the health evaluation of a battery for its use following repurposing or remanufacturing operations is describing a business requirement."@en; - bamm:dataType xsd:integer; - bamm-c:unit unit:percent. -:StateOfChargeCharacteristic a bamm-c:Measurement; - bamm:name "StateOfChargeCharacteristic"; - bamm:preferredName "state of charge characteristic"@en; - bamm:description "The value of the state of charge of the battery at the end of life i.e. when entering recycling scheme is describing a business requirement."@en; - bamm:dataType xsd:integer; - bamm-c:unit unit:percent. -:CathodeActiveMaterialsCharacterisitic a bamm-c:Set; - bamm:name "CathodeActiveMaterialsCharacterisitic"; - bamm:preferredName "cathode active materials"@en; - bamm:description "The total amount of valuable materials contained in CAM material: Nickel, Cobalt, Lithium."@en; - bamm:dataType :MaterialNameAndWeightAndPercentageMassFractionEntity. -:RecyclateContentActiveMaterialsCharacteristic a bamm-c:Set; - bamm:name "RecyclateContentActiveMaterialsCharacteristic"; - bamm:preferredName "recyclate content active materials"@en; - bamm:description "List of recovered Recyclate Content in Active Material Recycled is describing a regulatory requirement. The following materials have to be reported on as a minimium: Cobalt, Lithium, Nickel, Lead"@en; - bamm:dataType :MaterialNameAndWeightAndPercentageMassFractionEntity. -:AnodeActiveMaterialsCharacteristic a bamm-c:Set; - bamm:name "AnodeActiveMaterialsCharacteristic"; - bamm:preferredName "anode active materials"@en; - bamm:description "The total amount of valuable materials contained in Anode: graphite"@en; - bamm:dataType :MaterialNameAndWeightAndPercentageMassFractionEntity. -:CathodeCompositionOtherCharacteristic a bamm-c:Set; - bamm:name "CathodeCompositionOtherCharacteristic"; - bamm:preferredName "cathode composition other"@en; - bamm:description "The composition or materials contained in the Cathode is describing a regulatory requirement."@en; - bamm:dataType :MaterialNameAndWeightAndPercentageMassFractionEntity. -:AnodeCompositionOtherCharacteristic a bamm-c:Set; - bamm:name "AnodeCompositionOtherCharacteristic"; - bamm:preferredName "anode composition other"@en; - bamm:description "The composition or materials contained in the anode is describing a regulatory requirement."@en; - bamm:dataType :MaterialNameAndWeightAndPercentageMassFractionEntity. -:ElectrolyteCompositionCharacteristic a bamm-c:Set; - bamm:name "ElectrolyteCompositionCharacteristic"; - bamm:preferredName "electrolyte composition"@en; - bamm:description "List of materials contained in the electrolyte is describing a regulatory requirement."@en; - bamm:see ; - bamm:dataType :MaterialNameAndWeightAndPercentageMassFractionEntity. -:ComponentsCharacteristic a bamm:Characteristic; - bamm:name "ComponentsCharacteristic"; - bamm:preferredName "components"@en; - bamm:description "Characteristics of the batterie's comoponents."@en; - bamm:dataType :CompomenentsEntity. -:CompositionOfBatteryCharacteristic a bamm-c:Set; - bamm:name "CompositionOfBatteryCharacteristic"; - bamm:preferredName "composition of battery"@en; - bamm:description "Full composition of battery is describing a business requirement."@en; - bamm:dataType :MaterialNameAndWeightAndPercentageMassFractionEntity. -:CriticalRawMaterialsCharacteristic a bamm:Characteristic; - bamm:name "CriticalRawMaterialsCharacteristic"; - bamm:preferredName "critical raw materials"@en; - bamm:description "List of critical raw materials (CRM) as specified by EU in a battery is describing a regulatory requirement."@en; - bamm:dataType xsd:string. -:TemperatureRangeCharacterisitic a bamm-c:Measurement; - bamm:name "TemperatureRangeCharacterisitic"; - bamm:preferredName "temperature range"@en; - bamm:description "The lower range of temperature the battery can withstand when not in use is describing a regulatory requirement."@en; - bamm:dataType xsd:decimal; - bamm-c:unit unit:degreeCelsius. -:CycleLifeTestCRateCharacterisitc a bamm:Characteristic; - bamm:name "CycleLifeTestCRateCharacterisitc"; - bamm:preferredName "cycle life test c-rate"@en; - bamm:description "C-rate of Relevant Cycle-life Test is describing a regulatory requirement."@en; - bamm:dataType xsd:decimal. -:CycleLifeTestDepthOfDischargeCharacteristic a bamm-c:Measurement; - bamm:name "CycleLifeTestDepthOfDischargeCharacteristic"; - bamm:preferredName "cycle life test depth of discharge"@en; - bamm:description "Depth of discharge in the cycle-life test is describing a regulatory requirement."@en; - bamm:dataType xsd:decimal; - bamm-c:unit unit:percent. -:ExpectedLifetime a bamm-c:Measurement; - bamm:name "ExpectedLifetime"; - bamm:preferredName "expected lifetime"@en; - bamm:description "Expected battery lifetime expressed in cycles, and reference test used is describing a regulatory requirement."@en; - bamm:dataType xsd:decimal; - bamm-c:unit unit:piece. -:AttachmentEntity a bamm:Entity; - bamm:name "AttachmentEntity"; - bamm:properties (:fileLocation :title); - bamm:preferredName "AttachmentEntity"@en; - bamm:description "Entity encapsulating the details of a attachment for the battery"@en. -:BatteryPowerEntity a bamm:Entity; - bamm:name "BatteryPowerEntity"; - bamm:properties (:maximumAllowedBatteryPower :originalPower :powerFade :powerCapabilityAt20Charge :powerCapabilityAt80Charge :originalPowerCapability :originalPowerCapabilityLimits); - bamm:preferredName "battery power entity"@en; - bamm:description "Entity to bundle the power properties of a battery."@en. -:BatteryVoltageEntity a bamm:Entity; - bamm:name "BatteryVoltageEntity"; - bamm:properties (:minVoltage :nominalVoltage :maxVoltage); - bamm:preferredName "battery voltage entity"@en; - bamm:description "Entity to bundle the voltage properties of a battery."@en. -:InternalResistanceEntity a bamm:Entity; - bamm:name "InternalResistanceEntity"; - bamm:properties (:cellInternalResistance :packInternalResistance :packInternalResistanceIncrease); - bamm:preferredName "internal resistance"@en; - bamm:description "Entity to bundle the internal resistance properties of a battery."@en. -:BatteryEnergyEntity a bamm:Entity; - bamm:name "BatteryEnergyEntity"; - bamm:properties (:maximumAllowedBatteryEnergy :energyRoundtripEfficiency :energyRoundtripEfficiencyChange); - bamm:preferredName "battery energy entity"@en; - bamm:description "Entity to bundle the energy properties of a battery."@en. -:MaterialNameAndWeightAndPercentageMassFractionEntity a bamm:Entity; - bamm:name "MaterialNameAndWeightAndPercentageMassFractionEntity"; - bamm:properties ([ - bamm:property :matierialPercentageMassFraction; - bamm:optional "true"^^xsd:boolean -] [ - bamm:property :matierialWeight; - bamm:optional "true"^^xsd:boolean -] :materialName); - bamm:preferredName "material name and weight and percent"@en; - bamm:description "Entity to bundle a material's name, weight and percentage of mass."@en. -:CompomenentsEntity a bamm:Entity; - bamm:name "CompomenentsEntity"; - bamm:properties (:componentsSupplier :componentsPartNumber); - bamm:preferredName "components"@en; - bamm:description "Entity to bundle the components properties of a battery."@en. -:fileLocation a bamm:Property; - bamm:name "fileLocation"; - bamm:preferredName "file location"@en; - bamm:description "Location of the file"@en; - bamm:characteristic :FileLocationCharacteristic. -:title a bamm:Property; - bamm:name "title"; - bamm:preferredName "title"@en; - bamm:description "Title of the attached file"@en; - bamm:characteristic bamm-c:Text. -:maximumAllowedBatteryPower a bamm:Property; - bamm:name "maximumAllowedBatteryPower"; - bamm:preferredName "maximum allowed battery power"@en; - bamm:description "Maximum allowed battery power (W) of the battery is describing a business requirement."@en; - bamm:see ; - bamm:characteristic :PowerCharacteristic; - bamm:exampleValue "55000.0"^^xsd:float. -:originalPower a bamm:Property; - bamm:name "originalPower"; - bamm:preferredName "battery original power"@en; - bamm:description "Original power capability in Watts is describing a regulatory requirement."@en; - bamm:characteristic :PowerCharacteristic; - bamm:exampleValue "7.56"^^xsd:float. -:powerFade a bamm:Property; - bamm:name "powerFade"; - bamm:preferredName "maximum allowed battery power"@en; - bamm:description "Maximum allowed battery power (W) of the battery is describing a business requirement."@en; - bamm:see ; - bamm:characteristic :PowerFadeCharacteristic; - bamm:exampleValue "23.0"^^xsd:float. -:powerCapabilityAt20Charge a bamm:Property; - bamm:name "powerCapabilityAt20Charge"; - bamm:preferredName "power capability at 20 charge"@en; - bamm:description "Power (capability) at 20% state of charge. Description from the Regulation is describing a regulatory requirement."@en; - bamm:characteristic :PowerCharacteristic; - bamm:exampleValue "643"^^xsd:float. -:powerCapabilityAt80Charge a bamm:Property; - bamm:name "powerCapabilityAt80Charge"; - bamm:preferredName "power capability at 80 charge"@en; - bamm:description "Power (capability) at 80% state of charge. Description from the Regulation is describing a regulatory requirement."@en; - bamm:characteristic :PowerCharacteristic; - bamm:exampleValue "47"^^xsd:float. -:originalPowerCapability a bamm:Property; - bamm:name "originalPowerCapability"; - bamm:preferredName "original power capability"@en; - bamm:description "Performance ability of the high voltage battery i.e. the amount of energy that a battery is capable to provide over a given period of time is describing a regulatory requirement."@en; - bamm:characteristic :KilowattCharacteristic; - bamm:exampleValue "123"^^xsd:decimal. -:originalPowerCapabilityLimits a bamm:Property; - bamm:name "originalPowerCapabilityLimits"; - bamm:preferredName "original power capability limits"@en; - bamm:description "Performance ability of the high voltage battery according to limits i.e. how much power it can provide within given limits is describing a regulatory requirement."@en; - bamm:characteristic :KilowattCharacteristic; - bamm:exampleValue "123"^^xsd:decimal. -:minVoltage a bamm:Property; - bamm:name "minVoltage"; - bamm:preferredName "min voltage"@en; - bamm:description "Value of the minimal voltage the battery is rated for is describing a regulatory requirement."@en; - bamm:characteristic :VoltCharacteristic; - bamm:exampleValue "2"^^xsd:float. -:nominalVoltage a bamm:Property; - bamm:name "nominalVoltage"; - bamm:preferredName "nominal voltage"@en; - bamm:description "Value of the nominal voltage the battery is rated for is describing a regulatory requirement."@en; - bamm:characteristic :VoltCharacteristic; - bamm:exampleValue "4.3"^^xsd:float. -:maxVoltage a bamm:Property; - bamm:name "maxVoltage"; - bamm:preferredName "max voltage"@en; - bamm:description "Value of the maximum voltage the battery is rated for is describing a regulatory requirement."@en; - bamm:characteristic :VoltCharacteristic; - bamm:exampleValue "6"^^xsd:float. -:cellInternalResistance a bamm:Property; - bamm:name "cellInternalResistance"; - bamm:preferredName "cell internal resistance"@en; - bamm:description "The resistance offered by the cell in the flow of the current"@en; - bamm:characteristic :MilliohmCharacteristic; - bamm:exampleValue "45"^^xsd:decimal. -:packInternalResistance a bamm:Property; - bamm:name "packInternalResistance"; - bamm:preferredName "pack internal resistance"@en; - bamm:description "Total internal resistance in a battery pack is describing a regulatory requirement."@en; - bamm:characteristic :OhmCharacterisitic; - bamm:exampleValue "67"^^xsd:decimal. -:packInternalResistanceIncrease a bamm:Property; - bamm:name "packInternalResistanceIncrease"; - bamm:preferredName "pack internal resistanceIncrease"@en; - bamm:description "Increase in internal resistance of a battery pack over a period of time is describing a regulatory requirement."@en; - bamm:characteristic :PercentCharacteristic; - bamm:exampleValue "23"^^xsd:decimal. -:maximumAllowedBatteryEnergy a bamm:Property; - bamm:name "maximumAllowedBatteryEnergy"; - bamm:preferredName "maximum allowed battery energy"@en; - bamm:description "Maximum allowed battery energy (Wh) of the battery is describing a regulatory requirement."@en; - bamm:see ; - bamm:characteristic :MaximumAllowedBatteryEnergyCharacteristic; - bamm:exampleValue "90000"^^xsd:float. -:energyRoundtripEfficiency a bamm:Property; - bamm:name "energyRoundtripEfficiency"; - bamm:preferredName "energy roundtrip efficiency"@en; - bamm:description "Round-trip efficiency is the percentage of electricity put into storage is describing a regulatory requirement."@en; - bamm:characteristic :EnergyRoundtripEfficiency; - bamm:exampleValue "56"^^xsd:decimal. -:energyRoundtripEfficiencyChange a bamm:Property; - bamm:name "energyRoundtripEfficiencyChange"; - bamm:preferredName "energy roundtrip efficiency"@en; - bamm:description "Round-trip efficiency is the percentage of electricity put into storage is describing a regulatory requirement."@en; - bamm:characteristic :EnergyRoundtripEfficiencyChangeCharacterisitic; - bamm:exampleValue "67"^^xsd:decimal. -:matierialPercentageMassFraction a bamm:Property; - bamm:name "matierialPercentageMassFraction"; - bamm:preferredName "matierial percentage mass fraction"@en; - bamm:description "Percentage mass fraction of a material."@en; - bamm:characteristic :MatierialPercentageMassFractionCharacteristic; - bamm:exampleValue "19"^^xsd:decimal. -:matierialWeight a bamm:Property; - bamm:name "matierialWeight"; - bamm:preferredName "material weight"@en; - bamm:description "Weight of the material (in gram)"@en; - bamm:characteristic :GramCharacteristic; - bamm:exampleValue "2.5"^^xsd:decimal. -:materialName a bamm:Property; - bamm:name "materialName"; - bamm:preferredName "material name"@en; - bamm:description "Name of the material"@en; - bamm:characteristic :Text. -:componentsSupplier a bamm:Property; - bamm:name "componentsSupplier"; - bamm:preferredName "components supplier"@en; - bamm:description "Contact details of the suppliers of replacement parts / spare parts is describing a regulatory requirement. Available fields should be like:\nName - Street - Number - ZIP Code - City - State - Country - Phone - Fax - Email - Website"@en; - bamm:characteristic :ComponentsSupplierCharacteristic. -:componentsPartNumber a bamm:Property; - bamm:name "componentsPartNumber"; - bamm:preferredName "components part number"@en; - bamm:description "The unique serial numbers of the different parts of a battery is describing a regulatory requirement."@en; - bamm:characteristic bamm-c:Text; - bamm:exampleValue "Case xxxxxxx/xx; Controller xxxxxxx/xx". -:FileLocationCharacteristic a bamm:Characteristic; - bamm:name "FileLocationCharacteristic"; - bamm:preferredName "file location"@en; - bamm:description "The path to the file"@en; - bamm:dataType xsd:anyURI. -:PowerCharacteristic a bamm-c:Measurement; - bamm:name "PowerCharacteristic"; - bamm:preferredName "power characteristic"@en; - bamm:description "Power capability in Watts"@en; - bamm:dataType xsd:float; - bamm-c:unit unit:watt. -:PowerFadeCharacteristic a bamm-c:Measurement; - bamm:name "PowerFadeCharacteristic"; - bamm:preferredName "power fade characteristic"@en; - bamm:description "The decrease over time and upon usage in the amount of power that a battery can deliver at the rated voltage is describing a regulatory requirement."@en; - bamm:dataType xsd:float; - bamm-c:unit unit:percent. -:KilowattCharacteristic a bamm-c:Measurement; - bamm:name "KilowattCharacteristic"; - bamm:preferredName "kilowatt characteristic"@en; - bamm:description "A measurement for the power of the battery."@en; - bamm:dataType xsd:decimal; - bamm-c:unit unit:kilowatt. -:VoltCharacteristic a bamm-c:Measurement; - bamm:name "VoltCharacteristic"; - bamm:preferredName "volt characteristic"@en; - bamm:description "Value of the voltage the battery is rated for"@en; - bamm:dataType xsd:float; - bamm-c:unit unit:volt. -:MilliohmCharacteristic a bamm-c:Measurement; - bamm:name "MilliohmCharacteristic"; - bamm:preferredName "milliohm characteristic"@en; - bamm:description "The resistance offered by the cell in the flow of the current"@en; - bamm:dataType xsd:decimal; - bamm-c:unit unit:milliohm. -:OhmCharacterisitic a bamm-c:Measurement; - bamm:name "OhmCharacterisitic"; - bamm:preferredName "ohm characterisitic"@en; - bamm:description "Total internal resistance in a battery pack"@en; - bamm:dataType xsd:decimal; - bamm-c:unit unit:ohm. -:PercentCharacteristic a bamm-c:Measurement; - bamm:name "PercentCharacteristic"; - bamm:preferredName "percent characteristic"@en; - bamm:description "Increase in internal resistance of a battery pack over a period of time"@en; - bamm:dataType xsd:decimal; - bamm-c:unit unit:percent. -:MaximumAllowedBatteryEnergyCharacteristic a bamm-c:Measurement; - bamm:name "MaximumAllowedBatteryEnergyCharacteristic"; - bamm:preferredName "maximum allowed battery energy"@en; - bamm:description "Characterisitic to describe the energy (Wh) properties of the battery is describing a regulatory requirement."@en; - bamm:dataType xsd:float; - bamm-c:unit unit:wattHour. -:EnergyRoundtripEfficiency a bamm-c:Measurement; - bamm:name "EnergyRoundtripEfficiency"; - bamm:preferredName "energy roundtrip efficiency"@en; - bamm:description "Round-trip efficiency is the percentage of electricity put into storage is describing a regulatory requirement."@en; - bamm:dataType xsd:decimal; - bamm-c:unit unit:percent. -:EnergyRoundtripEfficiencyChangeCharacterisitic a bamm-c:Measurement; - bamm:name "EnergyRoundtripEfficiencyChangeCharacterisitic"; - bamm:preferredName "energy roundtrip efficiency change"@en; - bamm:description "Round-trip efficiency is the percentage of electricity put into storage after 50% of life of the battery is describing a regulatory requirement."@en; - bamm:dataType xsd:decimal; - bamm-c:unit unit:percent. -:MatierialPercentageMassFractionCharacteristic a bamm-c:Measurement; - bamm:name "MatierialPercentageMassFractionCharacteristic"; - bamm:preferredName "matierial percentage mass fraction"@en; - bamm:description "Percentage mass fraction of a material"@en; - bamm:dataType xsd:decimal; - bamm-c:unit unit:percent. -:GramCharacteristic a bamm-c:Measurement; - bamm:name "GramCharacteristic"; - bamm:preferredName "gram characteristic"@en; - bamm:description "Weight of the material (in gram)"@en; - bamm:dataType xsd:decimal; - bamm-c:unit unit:gram. -:Text a bamm:Characteristic; - bamm:name "Text"; - bamm:description "Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc."@en; - bamm:dataType xsd:string. -:ComponentsSupplierCharacteristic a bamm-c:Set; - bamm:name "ComponentsSupplierCharacteristic"; - bamm:preferredName "components supplier"@en; - bamm:description "Contact details of the suppliers of replacement parts / spare parts is describing a regulatory requirement."@en; - bamm:dataType :ComponentsSupplierEntity. -:ComponentsSupplierEntity a bamm:Entity; - bamm:name "ComponentsSupplierEntity"; - bamm:properties (:address :contact); - bamm:preferredName "components supplier"@en; - bamm:description "Entity encapsulating the details of a components supplier"@en. diff --git a/io.catenax.battery.battery_pass/2.0.0/gen/BatteryPass-schema.json b/io.catenax.battery.battery_pass/2.0.0/gen/BatteryPass-schema.json deleted file mode 100644 index 0a3a61599..000000000 --- a/io.catenax.battery.battery_pass/2.0.0/gen/BatteryPass-schema.json +++ /dev/null @@ -1,878 +0,0 @@ -{ - "$schema" : "http://json-schema.org/draft-04/schema", - "description" : "The battery pass describes information collected during the lifecycle of a battery", - "type" : "object", - "components" : { - "schemas" : { - "urn_bamm_io.catenax.battery.battery_pass_2.0.0_FileLocationCharacteristic" : { - "type" : "string", - "format" : "uri", - "description" : "The path to the file" - }, - "urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text" : { - "type" : "string", - "description" : "Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc." - }, - "urn_bamm_io.catenax.battery.battery_pass_2.0.0_AttachmentEntity" : { - "description" : "Entity encapsulating the details of a attachment for the battery", - "type" : "object", - "properties" : { - "fileLocation" : { - "description" : "Location of the file", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_FileLocationCharacteristic" - }, - "title" : { - "description" : "Title of the attached file", - "$ref" : "#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text" - } - }, - "required" : [ "fileLocation", "title" ] - }, - "urn_bamm_io.catenax.battery.battery_pass_2.0.0_AttachmentLinkCharacteristic" : { - "description" : "Links the referenced attachments", - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_AttachmentEntity" - }, - "uniqueItems" : true - }, - "urn_bamm_io.catenax.battery.battery_pass_2.0.0_DocumentCharacteristic" : { - "description" : "Set of documents containing the description of battery components", - "type" : "object", - "properties" : { - "packagingInstructions" : { - "description" : "Instructions for safely packaging\nbatteries is describing a business requirement.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_AttachmentLinkCharacteristic" - }, - "transportationInstructions" : { - "description" : "Instructions for safely transporting\nbatteries is describing a business requirement.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_AttachmentLinkCharacteristic" - }, - "vehicleDismantlingProcedure" : { - "description" : "Document containing the vehicle dismantling procedure is describing a regulatory requirement.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_AttachmentLinkCharacteristic" - }, - "batteryDismantlingProcedure" : { - "description" : "Document containing the battery dismantling procedure is describing a regulatory requirement.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_AttachmentLinkCharacteristic" - }, - "safetyMeasures" : { - "description" : "Safety measures document(s) is describing a regulatory requirement.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_AttachmentLinkCharacteristic" - }, - "testReportsResults" : { - "description" : "Results of test reports which prove that the battery fulfills this regulation and its delegated regulations is describing a regulatory requirement.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_AttachmentLinkCharacteristic" - }, - "declarationOfConformity" : { - "description" : "Declaration of conformity (CE) is describing a regulatory requirement.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_AttachmentLinkCharacteristic" - }, - "responsibleSourcing" : { - "description" : "Document/Certificates on organizations compliance to ethical business practices", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_AttachmentLinkCharacteristic" - } - } - }, - "urn_bamm_io.catenax.shared.contact_information_1.0.0_WebsiteCharacteristic" : { - "type" : "string", - "format" : "uri", - "description" : "Address of the website" - }, - "urn_bamm_io.catenax.shared.contact_information_1.0.0_PhoneNumberTrait" : { - "type" : "string", - "description" : "Constraint to allow only numbers, whitespaces and an optional leading + sign.", - "pattern" : "^[+]?[0-9 ]+$" - }, - "urn_bamm_io.catenax.shared.contact_information_1.0.0_EMailTrait" : { - "type" : "string", - "description" : "Regular expression for mail address as defined in W3C (see https://html.spec.whatwg.org/multipage/input.html#valid-e-mail-address)", - "pattern" : "^[a-zA-Z0-9.!#$%&’*+\\/=?^_`{|}~-]+@[a-zA-Z0-9-]+(?:\\.[a-zA-Z0-9-]+)*$" - }, - "urn_bamm_io.catenax.shared.contact_information_1.0.0_ContactCharacteristic" : { - "description" : "Characteristic describing information on how to contact an organization", - "type" : "object", - "properties" : { - "website" : { - "description" : "Website of the contact.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.shared.contact_information_1.0.0_WebsiteCharacteristic" - }, - "phoneNumber" : { - "description" : "Phone number with country and area code", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.shared.contact_information_1.0.0_PhoneNumberTrait" - }, - "email" : { - "description" : "An email address", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.shared.contact_information_1.0.0_EMailTrait" - }, - "faxNumber" : { - "description" : "Fax number with country and area code", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.shared.contact_information_1.0.0_PhoneNumberTrait" - } - } - }, - "urn_bamm_io.catenax.shared.address_characteristic_1.0.1_ThoroughfareTechnicalKeyCharacteristic" : { - "type" : "string", - "description" : "Characteristic of the technical key of a thoroughfare", - "enum" : [ "STREET", "INDUSTRIAL_ZONE", "OTHER", "RIVER", "SQUARE" ] - }, - "urn_bamm_io.catenax.shared.address_characteristic_1.0.1_Text" : { - "type" : "string", - "description" : "Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc." - }, - "urn_bamm_io.catenax.shared.address_characteristic_1.0.1_ThoroughfareEntity" : { - "description" : "Characteristic for defining a thoroughfare which can consist of a type (e.g. \"STREET\"), value (e.g. \"Bernstraße\") and number (e.g. \"45\"). Model follows the specification of BPDM.", - "type" : "object", - "properties" : { - "technicalKey" : { - "description" : "Technical key of a thoroughfare. As specified by BPDM, this can be a \"STREET\" or a different type.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.shared.address_characteristic_1.0.1_ThoroughfareTechnicalKeyCharacteristic" - }, - "value" : { - "description" : "Value of a thoroughfare, e.g. name of a street.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.shared.address_characteristic_1.0.1_Text" - }, - "number" : { - "description" : "Number of a thoroughfare. As used differently in international context, this number can contain both numerical and alphanumerical values", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.shared.address_characteristic_1.0.1_Text" - } - }, - "required" : [ "technicalKey", "value", "number" ] - }, - "urn_bamm_io.catenax.shared.address_characteristic_1.0.1_LocalityTechnicalKeyCharacteristic" : { - "type" : "string", - "description" : "Characteristic of the technical key of a locality", - "enum" : [ "BLOCK", "CITY", "DISTRICT", "OTHER", "POST_OFFICE_CITY", "QUARTER" ] - }, - "urn_bamm_io.catenax.shared.address_characteristic_1.0.1_LocalityEntity" : { - "description" : "Characteristic for defining a locality which belongs to an address and which consists of a type (e.g. \"CITY\") and value (e.g. \"Mannheim\"). Model follows the specification of BPDM.", - "type" : "object", - "properties" : { - "technicalKey" : { - "description" : "Technical key of a locality", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.shared.address_characteristic_1.0.1_LocalityTechnicalKeyCharacteristic" - }, - "value" : { - "description" : "Value of a locality, e.g. name of a city (\"Mannheim\").", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.shared.address_characteristic_1.0.1_Text" - } - }, - "required" : [ "technicalKey", "value" ] - }, - "urn_bamm_io.catenax.shared.address_characteristic_1.0.1_PremiseTechnicalKeyCharacteristic" : { - "type" : "string", - "description" : "Characteristic of the technical key of a premise", - "enum" : [ "BUILDING", "HARBOUR", "LEVEL", "OTHER", "ROOM", "SUITE", "UNIT", "WAREHOUSE" ] - }, - "urn_bamm_io.catenax.shared.address_characteristic_1.0.1_PremiseEntity" : { - "description" : "Characteristic for defining a premise which consists of a technical key (e.g. \"BUILDING\" or \"OTHER\") and a value (e.g. \"Werk 1\").", - "type" : "object", - "properties" : { - "technicalKey" : { - "description" : "Technical key of a premise", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.shared.address_characteristic_1.0.1_PremiseTechnicalKeyCharacteristic" - }, - "value" : { - "description" : "Value of a premise, e.g. name or designation of a particular site", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.shared.address_characteristic_1.0.1_Text" - } - }, - "required" : [ "technicalKey", "value" ] - }, - "urn_bamm_io.catenax.shared.address_characteristic_1.0.1_PostalDeliveryPointTechnicalKeyCharacteristic" : { - "type" : "string", - "description" : "Characteristic of the technical key of a postal delivery point", - "enum" : [ "INTERURBAN_DELIVERY_POINT", "MAIL_STATION", "MAILBOX", "OTHER", "POST_OFFICE_BOX" ] - }, - "urn_bamm_io.catenax.shared.address_characteristic_1.0.1_PostalDeliveryPointEntity" : { - "description" : "Characteristic for defining a postal delivery point which consists of a technical key (e.g. \"MAILBOX\" or \"OTHER\") and a value. Model follows the specification of BPDM.", - "type" : "object", - "properties" : { - "technicalKey" : { - "description" : "Technical key of a postal delivery point", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.shared.address_characteristic_1.0.1_PostalDeliveryPointTechnicalKeyCharacteristic" - }, - "value" : { - "description" : "Value of a postal delivery point, e.g. designation of a gate", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.shared.address_characteristic_1.0.1_Text" - } - }, - "required" : [ "technicalKey", "value" ] - }, - "urn_bamm_io.catenax.shared.address_characteristic_1.0.1_CountryTrait" : { - "type" : "string", - "description" : "Regular expression for designation of a short name of a country as defined in ISO 3166-2", - "pattern" : "([A-Z]{2}-[A-Z0-9]{1,3}|)" - }, - "urn_bamm_io.catenax.shared.address_characteristic_1.0.1_CountryEntity" : { - "description" : "Characteristic of a country belonging to an address", - "type" : "object", - "properties" : { - "shortName" : { - "$ref" : "#/components/schemas/urn_bamm_io.catenax.shared.address_characteristic_1.0.1_CountryTrait" - } - }, - "required" : [ "shortName" ] - }, - "urn_bamm_io.catenax.shared.address_characteristic_1.0.1_PostCodeTrait" : { - "type" : "string", - "description" : "Regular expression for post codes", - "pattern" : "^[a-z0-9][a-z0-9\\- ]{0,10}$" - }, - "urn_bamm_io.catenax.shared.address_characteristic_1.0.1_PostCodeTechnicalKeyCharacteristic" : { - "type" : "string", - "description" : "Characteristic for the technical key of a post code", - "enum" : [ "CEDEX", "LARGE_MAIL_USER", "OTHER", "POST_BOX", "REGULAR" ] - }, - "urn_bamm_io.catenax.shared.address_characteristic_1.0.1_PostCodeEntity" : { - "description" : "Characteristic for defining a postcode which can consist of a type (e.g. \"REGULAR\" for zip codes) and a value (e.g. \"68161\\12\"). Model follows the specification of BPDM.", - "type" : "object", - "properties" : { - "value" : { - "description" : "The value of a post code", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.shared.address_characteristic_1.0.1_PostCodeTrait" - }, - "technicalKey" : { - "description" : "The technical key of a post code", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.shared.address_characteristic_1.0.1_PostCodeTechnicalKeyCharacteristic" - } - }, - "required" : [ "value", "technicalKey" ] - }, - "urn_bamm_io.catenax.shared.address_characteristic_1.0.1_PostalAddress" : { - "description" : "A characteristic to express the postal adress and which is intended to be referenced by other aspects", - "type" : "object", - "properties" : { - "thoroughfare" : { - "description" : "Street or thorough road name", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.shared.address_characteristic_1.0.1_ThoroughfareEntity" - }, - "locality" : { - "description" : "Locality belonging to an address", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.shared.address_characteristic_1.0.1_LocalityEntity" - }, - "premise" : { - "description" : "Premise of an address, e.g. a specific \"BUILDING\" but can also be used for naming a particular site", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.shared.address_characteristic_1.0.1_PremiseEntity" - }, - "postalDeliveryPoint" : { - "description" : "Delivery point, e.g. designation of a gate", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.shared.address_characteristic_1.0.1_PostalDeliveryPointEntity" - }, - "country" : { - "description" : "Country of an address", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.shared.address_characteristic_1.0.1_CountryEntity" - }, - "postCode" : { - "$ref" : "#/components/schemas/urn_bamm_io.catenax.shared.address_characteristic_1.0.1_PostCodeEntity" - } - }, - "required" : [ "thoroughfare", "locality", "country", "postCode" ] - }, - "urn_bamm_io.catenax.battery.battery_pass_2.0.0_ManufacturerCharacteristic" : { - "description" : "A manufacturer of goods", - "type" : "object", - "properties" : { - "name" : { - "description" : "Name of the manufacturer is describing a regulatory requirement.", - "$ref" : "#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text" - }, - "contact" : { - "description" : "Contact details of the manufacturer", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.shared.contact_information_1.0.0_ContactCharacteristic" - }, - "address" : { - "description" : "An postal address", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.shared.address_characteristic_1.0.1_PostalAddress" - } - }, - "required" : [ "name", "contact", "address" ] - }, - "urn_bamm_io.catenax.battery.battery_pass_2.0.0_PowerCharacteristic" : { - "type" : "number", - "description" : "Power capability in Watts" - }, - "urn_bamm_io.catenax.battery.battery_pass_2.0.0_PowerFadeCharacteristic" : { - "type" : "number", - "description" : "The decrease over time and upon usage in the amount of power that a battery can deliver at the rated voltage is describing a regulatory requirement." - }, - "urn_bamm_io.catenax.battery.battery_pass_2.0.0_KilowattCharacteristic" : { - "type" : "number", - "description" : "A measurement for the power of the battery." - }, - "urn_bamm_io.catenax.battery.battery_pass_2.0.0_BatteryPowerCharacteristic" : { - "description" : "Characterisitic to describe the power (W) properties of the batterie.", - "type" : "object", - "properties" : { - "maximumAllowedBatteryPower" : { - "description" : "Maximum allowed battery power (W) of the battery is describing a business requirement.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_PowerCharacteristic" - }, - "originalPower" : { - "description" : "Original power capability in Watts is describing a regulatory requirement.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_PowerCharacteristic" - }, - "powerFade" : { - "description" : "Maximum allowed battery power (W) of the battery is describing a business requirement.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_PowerFadeCharacteristic" - }, - "powerCapabilityAt20Charge" : { - "description" : "Power (capability) at 20% state of charge. Description from the Regulation is describing a regulatory requirement.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_PowerCharacteristic" - }, - "powerCapabilityAt80Charge" : { - "description" : "Power (capability) at 80% state of charge. Description from the Regulation is describing a regulatory requirement.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_PowerCharacteristic" - }, - "originalPowerCapability" : { - "description" : "Performance ability of the high voltage battery i.e. the amount of energy that a battery is capable to provide over a given period of time is describing a regulatory requirement.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_KilowattCharacteristic" - }, - "originalPowerCapabilityLimits" : { - "description" : "Performance ability of the high voltage battery according to limits i.e. how much power it can provide within given limits is describing a regulatory requirement.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_KilowattCharacteristic" - } - }, - "required" : [ "maximumAllowedBatteryPower", "originalPower", "powerFade", "powerCapabilityAt20Charge", "powerCapabilityAt80Charge", "originalPowerCapability", "originalPowerCapabilityLimits" ] - }, - "urn_bamm_io.catenax.battery.battery_pass_2.0.0_VoltCharacteristic" : { - "type" : "number", - "description" : "Value of the voltage the battery is rated for" - }, - "urn_bamm_io.catenax.battery.battery_pass_2.0.0_BatteryVoltageCharacteristiC" : { - "description" : "Characterisitic to describe the voltage (V) properties of the batterie.", - "type" : "object", - "properties" : { - "minVoltage" : { - "description" : "Value of the minimal voltage the battery is rated for is describing a regulatory requirement.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_VoltCharacteristic" - }, - "nominalVoltage" : { - "description" : "Value of the nominal voltage the battery is rated for is describing a regulatory requirement.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_VoltCharacteristic" - }, - "maxVoltage" : { - "description" : "Value of the maximum voltage the battery is rated for is describing a regulatory requirement.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_VoltCharacteristic" - } - }, - "required" : [ "minVoltage", "nominalVoltage", "maxVoltage" ] - }, - "urn_bamm_io.catenax.battery.battery_pass_2.0.0_RatedCapacityCharacteristic" : { - "type" : "number", - "description" : "The total number of ampere-hours (Ah) that can be withdrawn from a fully charged battery under specific conditions is describing a regulatory requirement." - }, - "urn_bamm_io.catenax.battery.battery_pass_2.0.0_CapacityFadeCharacteristic" : { - "type" : "number", - "description" : "The decrease over time and upon usage in the amount of charge that a battery can deliver at the rated voltage, with respect to the original rated capacity declared by the manufacturer is describing a regulatory requirement." - }, - "urn_bamm_io.catenax.battery.battery_pass_2.0.0_MilliohmCharacteristic" : { - "type" : "number", - "description" : "The resistance offered by the cell in the flow of the current" - }, - "urn_bamm_io.catenax.battery.battery_pass_2.0.0_OhmCharacterisitic" : { - "type" : "number", - "description" : "Total internal resistance in a battery pack" - }, - "urn_bamm_io.catenax.battery.battery_pass_2.0.0_PercentCharacteristic" : { - "type" : "number", - "description" : "Increase in internal resistance of a battery pack over a period of time" - }, - "urn_bamm_io.catenax.battery.battery_pass_2.0.0_InternalResistanceCharacteristic" : { - "description" : "Internal resistance in a battery cell or pack is describing a regulatory requirement.", - "type" : "object", - "properties" : { - "cellInternalResistance" : { - "description" : "The resistance offered by the cell in the flow of the current", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_MilliohmCharacteristic" - }, - "packInternalResistance" : { - "description" : "Total internal resistance in a battery pack is describing a regulatory requirement.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_OhmCharacterisitic" - }, - "packInternalResistanceIncrease" : { - "description" : "Increase in internal resistance of a battery pack over a period of time is describing a regulatory requirement.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_PercentCharacteristic" - } - }, - "required" : [ "cellInternalResistance", "packInternalResistance", "packInternalResistanceIncrease" ] - }, - "urn_bamm_io.catenax.battery.battery_pass_2.0.0_CapacityThresholdExhaustionCharacterisitic" : { - "type" : "number", - "description" : "Capacity threshold for exhaustion as percentage value is describing a regulatory requirement." - }, - "urn_bamm_io.catenax.battery.battery_pass_2.0.0_MaximumAllowedBatteryEnergyCharacteristic" : { - "type" : "number", - "description" : "Characterisitic to describe the energy (Wh) properties of the battery is describing a regulatory requirement." - }, - "urn_bamm_io.catenax.battery.battery_pass_2.0.0_EnergyRoundtripEfficiency" : { - "type" : "number", - "description" : "Round-trip efficiency is the percentage of electricity put into storage is describing a regulatory requirement." - }, - "urn_bamm_io.catenax.battery.battery_pass_2.0.0_EnergyRoundtripEfficiencyChangeCharacterisitic" : { - "type" : "number", - "description" : "Round-trip efficiency is the percentage of electricity put into storage after 50% of life of the battery is describing a regulatory requirement." - }, - "urn_bamm_io.catenax.battery.battery_pass_2.0.0_BatteryEnergyCharacterisitc" : { - "description" : "Characterisitic to describe the energy (kWh) properties of the batterie.", - "type" : "object", - "properties" : { - "maximumAllowedBatteryEnergy" : { - "description" : "Maximum allowed battery energy (Wh) of the battery is describing a regulatory requirement.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_MaximumAllowedBatteryEnergyCharacteristic" - }, - "energyRoundtripEfficiency" : { - "description" : "Round-trip efficiency is the percentage of electricity put into storage is describing a regulatory requirement.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_EnergyRoundtripEfficiency" - }, - "energyRoundtripEfficiencyChange" : { - "description" : "Round-trip efficiency is the percentage of electricity put into storage is describing a regulatory requirement.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_EnergyRoundtripEfficiencyChangeCharacterisitic" - } - }, - "required" : [ "maximumAllowedBatteryEnergy", "energyRoundtripEfficiency", "energyRoundtripEfficiencyChange" ] - }, - "urn_bamm_io.catenax.battery.battery_pass_2.0.0_RatioMaximumAllowedBatteryPowerAndMaximumAllowedBatteryEnergyCharacterisitic" : { - "type" : "number", - "description" : "Ratio between maximum allowed battery power (W) and battery energy (Wh) is describing a regulatory requirement." - }, - "urn_bamm_io.catenax.battery.battery_pass_2.0.0_ElectrochemicalPropertiesCharacteristic" : { - "description" : "Electrochemical characteristics to describe a battery", - "type" : "object", - "properties" : { - "batteryPower" : { - "description" : "Characterisitic to describe the power (W) properties of the batterie.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_BatteryPowerCharacteristic" - }, - "batteryVoltage" : { - "description" : "Voltage (V) of the battery.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_BatteryVoltageCharacteristiC" - }, - "ratedCapacity" : { - "description" : "The total number of ampere-hours (Ah) that can be withdrawn from a fully charged battery under specific conditions is describing a regulatory requirement.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_RatedCapacityCharacteristic" - }, - "capacityFade" : { - "description" : "The decrease over time and upon usage in the amount of charge that a battery can deliver at the rated voltage, with respect to the original rated capacity declared by the manufacturer is describing a regulatory requirement.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_CapacityFadeCharacteristic" - }, - "internalResistance" : { - "description" : "Internal resistance in a battery cell or pack is describing a regulatory requirement.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_InternalResistanceCharacteristic" - }, - "capacityThresholdExhaustion" : { - "description" : "Capacity threshold for exhaustion as percentage value is describing a regulatory requirement.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_CapacityThresholdExhaustionCharacterisitic" - }, - "batteryEnergy" : { - "description" : "Characterisitic to describe the energy (kWh) properties of the batterie.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_BatteryEnergyCharacterisitc" - }, - "ratioMaximumAllowedBatteryPowerAndMaximumAllowedBatteryEnergy" : { - "description" : "Ratio between maximum allowed battery power (W) and battery energy (Wh) is describing a regulatory requirement.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_RatioMaximumAllowedBatteryPowerAndMaximumAllowedBatteryEnergyCharacterisitic" - } - }, - "required" : [ "batteryPower", "batteryVoltage", "ratedCapacity", "capacityFade", "internalResistance", "capacityThresholdExhaustion", "batteryEnergy", "ratioMaximumAllowedBatteryPowerAndMaximumAllowedBatteryEnergy" ] - }, - "urn_bamm_io.catenax.battery.battery_pass_2.0.0_MillimetreCharacteristic" : { - "type" : "number", - "description" : "A measurment for the length/width/height of an item." - }, - "urn_bamm_io.catenax.battery.battery_pass_2.0.0_KilogramCharacteristic" : { - "type" : "number", - "description" : "A measurement for the weight of an item." - }, - "urn_bamm_io.catenax.battery.battery_pass_2.0.0_PhysicalDimensionsCharacteristic" : { - "description" : "Geometrical properties of the battery", - "type" : "object", - "properties" : { - "length" : { - "description" : "Length of the item is describing a business requirement.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_MillimetreCharacteristic" - }, - "width" : { - "description" : "Width of the item is describing a business requirement.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_MillimetreCharacteristic" - }, - "height" : { - "description" : "Height of the item is describing a business requirement.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_MillimetreCharacteristic" - }, - "diameter" : { - "description" : "Diameter of the item.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_MillimetreCharacteristic" - }, - "weight" : { - "description" : "Weight of the item is describing a regulatory requirement.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_KilogramCharacteristic" - } - }, - "required" : [ "length", "width", "height", "diameter", "weight" ] - }, - "urn_bamm_io.catenax.battery.battery_pass_2.0.0_StateOfHealthCharacteristic" : { - "type" : "number", - "description" : "Evidence/Certificate of the health evaluation of a battery for its use following repurposing or remanufacturing operations is describing a business requirement." - }, - "urn_bamm_io.catenax.battery.battery_pass_2.0.0_StateOfChargeCharacteristic" : { - "type" : "number", - "description" : "The value of the state of charge of the battery at the end of life i.e. when entering recycling scheme is describing a business requirement." - }, - "urn_bamm_io.catenax.battery.battery_pass_2.0.0_StateOfBatteryCharacteristic" : { - "description" : "The condition of the battery at the end of life i.e. when entering recycling scheme", - "type" : "object", - "properties" : { - "stateOfHealth" : { - "description" : "Evidence/Certificate of the health evaluation of a battery for its use following repurposing or remanufacturing operations is describing a business requirement.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_StateOfHealthCharacteristic" - }, - "stateOfCharge" : { - "description" : "The value of the state of charge of the battery at the end of life i.e. when entering recycling scheme is describing a business requirement.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_StateOfChargeCharacteristic" - }, - "statusBattery" : { - "description" : "Status of the battery is describing a regulatory requirement. Value list provided by the regulators.", - "$ref" : "#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text" - } - }, - "required" : [ "stateOfHealth", "stateOfCharge", "statusBattery" ] - }, - "urn_bamm_io.catenax.battery.battery_pass_2.0.0_BatteryIdentificationCharacteristic" : { - "description" : "Information to identify a specific battery.", - "type" : "object", - "properties" : { - "batteryType" : { - "description" : "Battery type as described by the contents of the battery e.g. cell chemistry is describing a regulatory requirement.", - "$ref" : "#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text" - }, - "batteryModel" : { - "description" : "Battery type as described by the contents of the battery e.g. cell chemistry is describing a regulatory requirement.", - "$ref" : "#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text" - }, - "batteryIDDMCCode" : { - "description" : "Digital Matrix Code (DMC) of the battery i.e. serial number allowing for unequivocal identification of a battery is describing a regulatory requirement.", - "$ref" : "#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text" - } - }, - "required" : [ "batteryType", "batteryModel", "batteryIDDMCCode" ] - }, - "urn_bamm_io.catenax.battery.battery_pass_2.0.0_Datestamp" : { - "type" : "string", - "format" : "date", - "description" : "Describes a Property which contains the date and time with an optional timezone." - }, - "urn_bamm_io.catenax.battery.battery_pass_2.0.0_ManufacturingCharacteristic" : { - "description" : "Information about the manufacturing process of a battery", - "type" : "object", - "properties" : { - "dateOfManufacturing" : { - "description" : "Manufacturing date of the battery is describing a regulatory requirement.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_Datestamp" - }, - "address" : { - "description" : "An postal address", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.shared.address_characteristic_1.0.1_PostalAddress" - } - }, - "required" : [ "dateOfManufacturing", "address" ] - }, - "urn_bamm_io.catenax.battery.battery_pass_2.0.0_MatierialPercentageMassFractionCharacteristic" : { - "type" : "number", - "description" : "Percentage mass fraction of a material" - }, - "urn_bamm_io.catenax.battery.battery_pass_2.0.0_GramCharacteristic" : { - "type" : "number", - "description" : "Weight of the material (in gram)" - }, - "urn_bamm_io.catenax.battery.battery_pass_2.0.0_Text" : { - "type" : "string", - "description" : "Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc." - }, - "urn_bamm_io.catenax.battery.battery_pass_2.0.0_MaterialNameAndWeightAndPercentageMassFractionEntity" : { - "description" : "Entity to bundle a material's name, weight and percentage of mass.", - "type" : "object", - "properties" : { - "matierialPercentageMassFraction" : { - "description" : "Percentage mass fraction of a material.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_MatierialPercentageMassFractionCharacteristic" - }, - "matierialWeight" : { - "description" : "Weight of the material (in gram)", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_GramCharacteristic" - }, - "materialName" : { - "description" : "Name of the material", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_Text" - } - }, - "required" : [ "materialName" ] - }, - "urn_bamm_io.catenax.battery.battery_pass_2.0.0_CathodeActiveMaterialsCharacterisitic" : { - "description" : "The total amount of valuable materials contained in CAM material: Nickel, Cobalt, Lithium.", - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_MaterialNameAndWeightAndPercentageMassFractionEntity" - }, - "uniqueItems" : true - }, - "urn_bamm_io.catenax.battery.battery_pass_2.0.0_RecyclateContentActiveMaterialsCharacteristic" : { - "description" : "List of recovered Recyclate Content in Active Material Recycled is describing a regulatory requirement. The following materials have to be reported on as a minimium: Cobalt, Lithium, Nickel, Lead", - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_MaterialNameAndWeightAndPercentageMassFractionEntity" - }, - "uniqueItems" : true - }, - "urn_bamm_io.catenax.battery.battery_pass_2.0.0_AnodeActiveMaterialsCharacteristic" : { - "description" : "The total amount of valuable materials contained in Anode: graphite", - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_MaterialNameAndWeightAndPercentageMassFractionEntity" - }, - "uniqueItems" : true - }, - "urn_bamm_io.catenax.battery.battery_pass_2.0.0_CathodeCompositionOtherCharacteristic" : { - "description" : "The composition or materials contained in the Cathode is describing a regulatory requirement.", - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_MaterialNameAndWeightAndPercentageMassFractionEntity" - }, - "uniqueItems" : true - }, - "urn_bamm_io.catenax.battery.battery_pass_2.0.0_AnodeCompositionOtherCharacteristic" : { - "description" : "The composition or materials contained in the anode is describing a regulatory requirement.", - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_MaterialNameAndWeightAndPercentageMassFractionEntity" - }, - "uniqueItems" : true - }, - "urn_bamm_io.catenax.battery.battery_pass_2.0.0_ElectrolyteCompositionCharacteristic" : { - "description" : "List of materials contained in the electrolyte is describing a regulatory requirement.", - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_MaterialNameAndWeightAndPercentageMassFractionEntity" - }, - "uniqueItems" : true - }, - "urn_bamm_io.catenax.battery.battery_pass_2.0.0_CellChemistryCharacteristic" : { - "description" : "Information about the the cell chemistry of a battery cell", - "type" : "object", - "properties" : { - "cathodeActiveMaterials" : { - "description" : "The total amount of valuable materials contained in CAM material: Nickel, Cobalt, Lithium.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_CathodeActiveMaterialsCharacterisitic" - }, - "recyclateContentActiveMaterials" : { - "description" : "List of recovered Recyclate Content in Active Material Recycled is describing a regulatory requirement. The following materials have to be reported on as a minimium: Cobalt, Lithium, Nickel, Lead", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_RecyclateContentActiveMaterialsCharacteristic" - }, - "anodeActiveMaterials" : { - "description" : "The total amount of valuable materials contained in Anode: graphite", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_AnodeActiveMaterialsCharacteristic" - }, - "cathodeCompositionOther" : { - "description" : "The composition or materials contained in the Cathode is describing a regulatory requirement.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_CathodeCompositionOtherCharacteristic" - }, - "anodeCompositionOther" : { - "description" : "The composition or materials contained in the anode is describing a regulatory requirement.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_AnodeCompositionOtherCharacteristic" - }, - "electrolyteComposition" : { - "description" : "List of materials contained in the electrolyte is describing a regulatory requirement.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_ElectrolyteCompositionCharacteristic" - } - }, - "required" : [ "cathodeActiveMaterials", "recyclateContentActiveMaterials", "anodeActiveMaterials", "cathodeCompositionOther", "anodeCompositionOther", "electrolyteComposition" ] - }, - "urn_bamm_io.catenax.battery.battery_pass_2.0.0_ComponentsSupplierEntity" : { - "description" : "Entity encapsulating the details of a components supplier", - "type" : "object", - "properties" : { - "address" : { - "description" : "An postal address", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.shared.address_characteristic_1.0.1_PostalAddress" - }, - "contact" : { - "description" : "Contact details of the manufacturer", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.shared.contact_information_1.0.0_ContactCharacteristic" - } - }, - "required" : [ "address", "contact" ] - }, - "urn_bamm_io.catenax.battery.battery_pass_2.0.0_ComponentsSupplierCharacteristic" : { - "description" : "Contact details of the suppliers of replacement parts / spare parts is describing a regulatory requirement.", - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_ComponentsSupplierEntity" - }, - "uniqueItems" : true - }, - "urn_bamm_io.catenax.battery.battery_pass_2.0.0_ComponentsCharacteristic" : { - "description" : "Characteristics of the batterie's comoponents.", - "type" : "object", - "properties" : { - "componentsSupplier" : { - "description" : "Contact details of the suppliers of replacement parts / spare parts is describing a regulatory requirement. Available fields should be like:\nName - Street - Number - ZIP Code - City - State - Country - Phone - Fax - Email - Website", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_ComponentsSupplierCharacteristic" - }, - "componentsPartNumber" : { - "description" : "The unique serial numbers of the different parts of a battery is describing a regulatory requirement.", - "$ref" : "#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text" - } - }, - "required" : [ "componentsSupplier", "componentsPartNumber" ] - }, - "urn_bamm_io.catenax.battery.battery_pass_2.0.0_CompositionOfBatteryCharacteristic" : { - "description" : "Full composition of battery is describing a business requirement.", - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_MaterialNameAndWeightAndPercentageMassFractionEntity" - }, - "uniqueItems" : true - }, - "urn_bamm_io.catenax.battery.battery_pass_2.0.0_CriticalRawMaterialsCharacteristic" : { - "type" : "string", - "description" : "List of critical raw materials (CRM) as specified by EU in a battery is describing a regulatory requirement." - }, - "urn_bamm_io.catenax.battery.battery_pass_2.0.0_CompositionCharacteristic" : { - "description" : "Information about the composition of a battery and the combination of materials is describing a business requirement.", - "type" : "object", - "properties" : { - "components" : { - "description" : "Properties of the batterie's comoponents.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_ComponentsCharacteristic" - }, - "compositionOfBattery" : { - "description" : "Full composition of battery is describing a business requirement.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_CompositionOfBatteryCharacteristic" - }, - "criticalRawMaterials" : { - "description" : "List of critical raw materials (CRM) as specified by EU in a battery is describing a regulatory requirement.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_CriticalRawMaterialsCharacteristic" - } - }, - "required" : [ "components", "compositionOfBattery", "criticalRawMaterials" ] - }, - "urn_bamm_io.catenax.battery.battery_pass_2.0.0_CO2FootprintTotalCharacteristic" : { - "type" : "number", - "description" : "The total carbon footprint of the battery, calculated as kg of carbon dioxide equivalent is describing a regulatory requirement." - }, - "urn_bamm_io.catenax.battery.battery_pass_2.0.0_TemperatureRangeCharacterisitic" : { - "type" : "number", - "description" : "The lower range of temperature the battery can withstand when not in use is describing a regulatory requirement." - }, - "urn_bamm_io.catenax.battery.battery_pass_2.0.0_TemperatureRangeIdleStateCharacterisitic" : { - "description" : "The range of temperature the battery can withstand when not in use is describing a regulatory requirement.", - "type" : "object", - "properties" : { - "temperatureRangeIdleStateLowerLimit" : { - "description" : "The lower range of temperature the battery can withstand when not in use is describing a regulatory requirement.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_TemperatureRangeCharacterisitic" - }, - "temperatureRangeIdleStateUpperLimit" : { - "description" : "The upper range of temperature the battery can withstand when not in use is describing a regulatory requirement.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_TemperatureRangeCharacterisitic" - } - }, - "required" : [ "temperatureRangeIdleStateLowerLimit", "temperatureRangeIdleStateUpperLimit" ] - }, - "urn_bamm_io.catenax.battery.battery_pass_2.0.0_WarrantyPeriodCharacterisitic" : { - "type" : "number", - "minimum" : 1, - "description" : "Commercial warranty period of the battery is describing a regulatory requirement." - }, - "urn_bamm_io.catenax.battery.battery_pass_2.0.0_CycleLifeTestCRateCharacterisitc" : { - "type" : "number", - "description" : "C-rate of Relevant Cycle-life Test is describing a regulatory requirement." - }, - "urn_bamm_io.catenax.battery.battery_pass_2.0.0_CycleLifeTestDepthOfDischargeCharacteristic" : { - "type" : "number", - "description" : "Depth of discharge in the cycle-life test is describing a regulatory requirement." - }, - "urn_bamm_io.catenax.battery.battery_pass_2.0.0_ExpectedLifetime" : { - "type" : "number", - "description" : "Expected battery lifetime expressed in cycles, and reference test used is describing a regulatory requirement." - }, - "urn_bamm_io.catenax.battery.battery_pass_2.0.0_BatteryCycleLifeCharacteristic" : { - "description" : "Characterisitic describing the cycle life of a battery", - "type" : "object", - "properties" : { - "cycleLifeTestCRate" : { - "description" : "C-rate of Relevant Cycle-life Test is describing a regulatory requirement.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_CycleLifeTestCRateCharacterisitc" - }, - "cycleLifeTestDepthOfDischarge" : { - "description" : "Depth of discharge in the cycle-life test is describing a regulatory requirement.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_CycleLifeTestDepthOfDischargeCharacteristic" - }, - "expectedLifetime" : { - "description" : "Expected battery lifetime expressed in cycles, and reference test used is describing a regulatory requirement.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_ExpectedLifetime" - } - }, - "required" : [ "cycleLifeTestCRate", "cycleLifeTestDepthOfDischarge", "expectedLifetime" ] - } - } - }, - "properties" : { - "document" : { - "description" : "Set of documents containing the description of battery components", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_DocumentCharacteristic" - }, - "manufacturer" : { - "description" : "Legal entity which sells and invoices the battery", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_ManufacturerCharacteristic" - }, - "electrochemicalProperties" : { - "description" : "Electrochemical properties of an electrochemical energy storage", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_ElectrochemicalPropertiesCharacteristic" - }, - "physicalDimensions" : { - "description" : "Geometrical properties of the battery", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_PhysicalDimensionsCharacteristic" - }, - "stateOfBattery" : { - "description" : "The condition of the battery at the end of life i.e. when entering recycling scheme", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_StateOfBatteryCharacteristic" - }, - "batteryIdentification" : { - "description" : "Information to identify a specific battery.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_BatteryIdentificationCharacteristic" - }, - "manufacturing" : { - "description" : "Information about the manufacturing process of a battery", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_ManufacturingCharacteristic" - }, - "datePlacedOnMarket" : { - "description" : "Date on which vehicle is produced i.e. when battery is put in the market or production date of the vehicle is describing a regulatory requirement.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_Datestamp" - }, - "cellChemistry" : { - "description" : "Information about the cell chemistry of a battery cell", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_CellChemistryCharacteristic" - }, - "composition" : { - "description" : "Information about the composition of a battery and the combination of materials is describing a business requirement.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_CompositionCharacteristic" - }, - "cO2FootprintTotal" : { - "description" : "The total carbon footprint of the battery, calculated as kg of carbon dioxide equivalent is describing a regulatory requirement.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_CO2FootprintTotalCharacteristic" - }, - "temperatureRangeIdleState" : { - "description" : "The range of temperature the battery can withstand when not in use is describing a regulatory requirement.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_TemperatureRangeIdleStateCharacterisitic" - }, - "warrantyPeriod" : { - "description" : "Commercial warranty period of the battery is describing a regulatory requirement.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_WarrantyPeriodCharacterisitic" - }, - "batteryCycleLife" : { - "description" : "Property describing the cycle life of a battery", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_BatteryCycleLifeCharacteristic" - } - }, - "required" : [ "manufacturer", "electrochemicalProperties", "physicalDimensions", "stateOfBattery", "batteryIdentification", "manufacturing", "datePlacedOnMarket", "cellChemistry", "composition", "cO2FootprintTotal", "temperatureRangeIdleState", "warrantyPeriod", "batteryCycleLife" ] -} \ No newline at end of file diff --git a/io.catenax.battery.battery_pass/2.0.0/gen/BatteryPass.aasx b/io.catenax.battery.battery_pass/2.0.0/gen/BatteryPass.aasx deleted file mode 100644 index 7cb5b434b..000000000 Binary files a/io.catenax.battery.battery_pass/2.0.0/gen/BatteryPass.aasx and /dev/null differ diff --git a/io.catenax.battery.battery_pass/2.0.0/gen/BatteryPass.html b/io.catenax.battery.battery_pass/2.0.0/gen/BatteryPass.html deleted file mode 100644 index f01c8aa07..000000000 --- a/io.catenax.battery.battery_pass/2.0.0/gen/BatteryPass.html +++ /dev/null @@ -1,7568 +0,0 @@ - - - - - - - - - - - - - - Dokumentation battery pass - - -
-
-
-
-

Aspect Model battery pass

-
urn:bamm:io.catenax.battery.battery_pass:2.0.0#BatteryPass
-
-
-
-
-
-
-
- -
- - -
- The battery pass describes information collected during the lifecycle of a battery -
- - -
-

Übersicht

-
-
-
-
- Aspect Model Diagram -
-
-
- - -
-
-

Properties

-
- -
- -
-

CO2 footprint total

-
- -The total carbon footprint of the battery, calculated as kg of carbon dioxide equivalent is describing a regulatory requirement. - -
-
Name
-
cO2FootprintTotal
-
- - - -
-
Characteristic
-
-
-
-
Measurement
-
-
-
The total carbon footprint of the battery, calculated as kg of carbon dioxide equivalent is describing a regulatory requirement.
-
-
-
Einheit
-
-
-
-
    -
  • - kilogram -
    • -
  • - Symbol kg -
    • -
  • - Code KGM -
    • -
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#double - -
-
-
-
-
- -
-
Beispiel
-
124.0
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
cO2FootprintTotal
-
- - -
-
- -
-

battery cycle life

-
- -Property describing the cycle life of a battery - -
-
Name
-
batteryCycleLife
-
- - - -
-
Characteristic
-
-
-
-
SingleEntity
-
-
-
- Typ urn:bamm:io.catenax.battery.battery_pass:2.0.0#BatteryCycleLifeEntity - -
-
-
-
-
- - -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
batteryCycleLife
-
- - -
-
- -
-

battery identification

-
- -Information to identify a specific battery. - -
-
Name
-
batteryIdentification
-
- - - -
-
Characteristic
-
-
-
-
SingleEntity
-
-
-
- Typ urn:bamm:io.catenax.battery.battery_pass:2.0.0#BatteryIdentificationEntity - -
-
-
-
-
- - -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
batteryIdentification
-
- - -
-
- -
-

cell chemistry

-
- -Information about the cell chemistry of a battery cell - -
-
Name
-
cellChemistry
-
- - - -
-
Characteristic
-
-
-
-
SingleEntity
-
-
-
- Typ urn:bamm:io.catenax.battery.battery_pass:2.0.0#CellChemistryEntity - -
-
-
-
-
- - -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
cellChemistry
-
- - -
-
- -
-

composition

-
- -Information about the composition of a battery and the combination of materials is describing a business requirement. - -
-
Name
-
composition
-
- - - -
-
Characteristic
-
-
-
-
SingleEntity
-
-
-
- Typ urn:bamm:io.catenax.battery.battery_pass:2.0.0#CompositionEntity - -
-
-
-
-
- - -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
composition
-
- - -
-
- -
-

date placed on market

-
- -Date on which vehicle is produced i.e. when battery is put in the market or production date of the vehicle is describing a regulatory requirement. - -
-
Name
-
datePlacedOnMarket
-
- - - -
-
Characteristic
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#date - -
-
-
-
-
- - -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
datePlacedOnMarket
-
- - -
-
- -
-

document

-
- -Set of documents containing the description of battery components - -
-
Name
-
document
-
- - - -
-
Characteristic
-
-
-
-
SingleEntity
-
-
-
- Typ urn:bamm:io.catenax.battery.battery_pass:2.0.0#DocumentEntity - -
-
-
-
-
- - -
-
Optional
-
- Ja
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
document
-
- - -
-
- -
-

electrochemical properties

-
- -Electrochemical properties of an electrochemical energy storage - -
-
Name
-
electrochemicalProperties
-
- - - -
-
Characteristic
-
-
-
-
SingleEntity
-
-
-
- Typ urn:bamm:io.catenax.battery.battery_pass:2.0.0#ElectrochemicalPropertiesEntity - -
-
-
-
-
- - -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
electrochemicalProperties
-
- - -
-
- -
-

manufacturer

-
- -Legal entity which sells and invoices the battery - -
-
Name
-
manufacturer
-
- - - -
-
Characteristic
-
-
-
-
SingleEntity
-
-
-
- Typ urn:bamm:io.catenax.battery.battery_pass:2.0.0#ManufacturerEntity - -
-
-
-
-
- - -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
manufacturer
-
- - -
-
- -
-

manufacturing

-
- -Information about the manufacturing process of a battery - -
-
Name
-
manufacturing
-
- - - -
-
Characteristic
-
-
-
-
SingleEntity
-
-
-
- Typ urn:bamm:io.catenax.battery.battery_pass:2.0.0#ManufacturingEntity - -
-
-
-
-
- - -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
manufacturing
-
- - -
-
- -
-

physical dimensions

-
- -Geometrical properties of the battery - -
-
Name
-
physicalDimensions
-
- - - -
-
Characteristic
-
-
-
-
SingleEntity
-
-
-
- Typ urn:bamm:io.catenax.battery.battery_pass:2.0.0#PhysicalDimensionsEntity - -
-
-
-
-
- - -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
physicalDimensions
-
- - -
-
- -
-

state of battery

-
- -The condition of the battery at the end of life i.e. when entering recycling scheme - -
-
Name
-
stateOfBattery
-
- - - -
-
Characteristic
-
-
-
-
SingleEntity
-
-
-
- Typ urn:bamm:io.catenax.battery.battery_pass:2.0.0#StateOfBatteryEntity - -
-
-
-
-
- - -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
stateOfBattery
-
- - -
-
- -
-

temperature range idle state

-
- -The range of temperature the battery can withstand when not in use is describing a regulatory requirement. - -
-
Name
-
temperatureRangeIdleState
-
- - - -
-
Characteristic
-
-
-
-
SingleEntity
-
-
-
- Typ urn:bamm:io.catenax.battery.battery_pass:2.0.0#TemperatureRangeIdleStateEntity - -
-
-
-
-
- - -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
temperatureRangeIdleState
-
- - -
-
- -
-

warranty period

-
- -Commercial warranty period of the battery is describing a regulatory requirement. - -
-
Name
-
warrantyPeriod
-
- - - -
-
Characteristic
-
-
-
-
Measurement
-
-
-
Commercial warranty period of the battery is describing a regulatory requirement.
-
-
-
Einheit
-
-
-
-
    -
  • - month -
    • -
  • - Symbol mo -
    • -
  • - Code MON -
    • -
  • - Überführungsfaktor 2.629800 × 10⁶ s -
    • -
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#positiveInteger - -
-
-
-
-
- -
-
Beispiel
-
60
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
warrantyPeriod
-
- - -
-
- - - -
-
-

Objekt

-
- -
-
-

Address Entity

-
-
- Entity of an address. Model follows specification of BPDM (Business Partner Data Management). -
- -
-

Properties

-
-
- -
-
Thoroughfare
-
- -Street or thorough road name - -
-
Name
-
thoroughfare
-
- - - -
-
Characteristic
-
-
-
-
SingleEntity
-
-
-
- Typ urn:bamm:io.catenax.shared.address_characteristic:1.0.1#ThoroughfareEntity - -
-
-
-
-
- - -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
thoroughfare
-
- - -
-
- -
-
Locality
-
- -Locality belonging to an address - -
-
Name
-
locality
-
- - - -
-
Characteristic
-
-
-
-
SingleEntity
-
-
-
- Typ urn:bamm:io.catenax.shared.address_characteristic:1.0.1#LocalityEntity - -
-
-
-
-
- - -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
locality
-
- - -
-
- -
-
Premise
-
- -Premise of an address, e.g. a specific "BUILDING" but can also be used for naming a particular site - -
-
Name
-
premise
-
- - - -
-
Characteristic
-
-
-
-
SingleEntity
-
-
-
- Typ urn:bamm:io.catenax.shared.address_characteristic:1.0.1#PremiseEntity - -
-
-
-
-
- - -
-
Optional
-
- Ja
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
premise
-
- - -
-
- -
-
Postal Delivery Point
-
- -Delivery point, e.g. designation of a gate - -
-
Name
-
postalDeliveryPoint
-
- - - -
-
Characteristic
-
-
-
-
SingleEntity
-
-
-
- Typ urn:bamm:io.catenax.shared.address_characteristic:1.0.1#PostalDeliveryPointEntity - -
-
-
-
-
- - -
-
Optional
-
- Ja
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
postalDeliveryPoint
-
- - -
-
- -
-
Country
-
- -Country of an address - -
-
Name
-
country
-
- - - -
-
Characteristic
-
-
-
-
SingleEntity
-
-
-
- Typ urn:bamm:io.catenax.shared.address_characteristic:1.0.1#CountryEntity - -
-
-
-
-
- - -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
country
-
- - -
-
- -
-
Post Code
-
- - -
-
Name
-
postCode
-
- - - -
-
Characteristic
-
-
-
-
SingleEntity
-
-
-
- Typ urn:bamm:io.catenax.shared.address_characteristic:1.0.1#PostCodeEntity - -
-
-
-
-
- - -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
postCode
-
- - -
-
-
-
-

AttachmentEntity

-
-
- Entity encapsulating the details of a attachment for the battery -
- -
-

Properties

-
-
- -
-
file location
-
- -Location of the file - -
-
Name
-
fileLocation
-
- - - -
-
Characteristic
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#anyURI - -
-
-
-
-
- - -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
fileLocation
-
- - -
-
- -
-
title
-
- -Title of the attached file - -
-
Name
-
title
-
- - - -
-
Characteristic
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- - -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
title
-
- - -
-
-
-
-

Contact Entity

-
-
- Entity to bundle the properties for the information on how to contact an organization -
- -
-

Properties

-
-
- -
-
website
-
- -Website of the contact. - -
-
Name
-
website
-
- - - -
-
Characteristic
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#anyURI - -
-
-
-
-
- -
-
Beispiel
-
https://www.samsung.com
-
- -
-
Optional
-
- Ja
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
website
-
- - -
-
- -
-
phone number
-
- -Phone number with country and area code - -
-
Name
-
phoneNumber
-
- - - -
-
Characteristic
-
-
-
-
Trait
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Beispiel
-
+49 89 1234567890
-
- -
-
Optional
-
- Ja
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
phoneNumber
-
- - -
-
Bedingungen
-
-
    -
  • -
    - -
    - PhoneNumberConstraint -
    - -
    -
    Beschreibung
    -
    Constraint to allow only numbers, whitespaces and an optional leading + sign.
    -
    - - -
    -
    Regulärer Ausdruck
    -
    ^[+]?[0-9 ]+$
    -
    - -
    • -
-
-
-
-
- -
-
email
-
- -An email address - -
-
Name
-
email
-
- - - -
-
Characteristic
-
-
-
-
Trait
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Beispiel
-
test.mail@example.com
-
- -
-
Optional
-
- Ja
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
email
-
- - -
-
Bedingungen
-
-
    -
  • -
    - -
    - EMailConstraint -
    - -
    -
    Beschreibung
    -
    Regular expression for mail address as defined in W3C (see https://html.spec.whatwg.org/multipage/input.html#valid-e-mail-address)
    -
    - - -
    -
    Regulärer Ausdruck
    -
    ^[a-zA-Z0-9.!#$%&’*+\/=?^_`{|}~-]+@[a-zA-Z0-9-]+(?:\.[a-zA-Z0-9-]+)*$
    -
    - -
    • -
-
-
-
-
- -
-
faxNumber
-
- -Fax number with country and area code - -
-
Name
-
faxNumber
-
- - - -
-
Characteristic
-
-
-
-
Trait
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Beispiel
-
+49 89 0987654321
-
- -
-
Optional
-
- Ja
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
faxNumber
-
- - -
-
Bedingungen
-
-
    -
  • -
    - -
    - PhoneNumberConstraint -
    - -
    -
    Beschreibung
    -
    Constraint to allow only numbers, whitespaces and an optional leading + sign.
    -
    - - -
    -
    Regulärer Ausdruck
    -
    ^[+]?[0-9 ]+$
    -
    - -
    • -
-
-
-
-
-
-
-

Country Entity

-
-
- Entity definition for a country -
- -
-

Properties

-
-
- -
-
Country Short Name
-
- - -
-
Name
-
countryShortName
-
- - - -
-
Characteristic
-
-
-
-
Trait
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- - -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
shortName
-
- - -
-
Bedingungen
-
-
    -
  • -
    - -
    - CountryShortNameConstraint -
    - -
    -
    Beschreibung
    -
    Regular expression for designation of a short name of a country as defined in ISO 3166-2
    -
    - - -
    -
    Regulärer Ausdruck
    -
    ([A-Z]{2}-[A-Z0-9]{1,3}|)
    -
    - -
    • -
-
-
-
-
-
-
-

PostCode Entity

-
-
- Entity for a postcode which consists of a type plus a value -
- -
-

Properties

-
-
- -
-
Post Code Value
-
- -The value of a post code - -
-
Name
-
postCodeValue
-
- - - -
-
Characteristic
-
-
-
-
Trait
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Beispiel
-
68161\12
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
value
-
- - -
-
Bedingungen
-
-
    -
  • -
    - -
    - Post Code Constraint -
    - -
    -
    Beschreibung
    -
    Regular expression for post codes
    -
    - - -
    -
    Regulärer Ausdruck
    -
    ^[a-z0-9][a-z0-9\- ]{0,10}$
    -
    - -
    • -
-
-
-
-
- -
-
Post Code Technical Key
-
- -The technical key of a post code - -
-
Name
-
postCodeTechnicalKey
-
- - - -
-
Characteristic
-
-
-
-
Enumeration
-
-
-
Werte
-
-
-
-
    -
  • CEDEX
    • -
  • LARGE_MAIL_USER
    • -
  • OTHER
    • -
  • POST_BOX
    • -
  • REGULAR
    • -
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- - -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
technicalKey
-
- - -
-
-
-
-

Postal Delivery Point Entity

-
-
- Entity for a postal delivery point which consists of a technical key and a value. -
- -
-

Properties

-
-
- -
-
Postal Delivery Point Technical Key
-
- -Technical key of a postal delivery point - -
-
Name
-
postalDeliveryPointTechnicalKey
-
- - - -
-
Characteristic
-
-
-
-
Enumeration
-
-
-
Werte
-
-
-
-
    -
  • INTERURBAN_DELIVERY_POINT
    • -
  • MAIL_STATION
    • -
  • MAILBOX
    • -
  • OTHER
    • -
  • POST_OFFICE_BOX
    • -
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Beispiel
-
OTHER
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
technicalKey
-
- - -
-
- -
-
Postal Delivery Point Value
-
- -Value of a postal delivery point, e.g. designation of a gate - -
-
Name
-
postalDeliveryPointValue
-
- - - -
-
Characteristic
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Beispiel
-
Tor 1
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
value
-
- - -
-
-
-
-

Premise Entity

-
-
- Entity for a premise which consists of a type (technical key) and a value -
- -
-

Properties

-
-
- -
-
Premise Technical Key
-
- -Technical key of a premise - -
-
Name
-
premiseTechnicalKey
-
- - - -
-
Characteristic
-
-
-
-
Enumeration
-
-
-
Werte
-
-
-
-
    -
  • BUILDING
    • -
  • HARBOUR
    • -
  • LEVEL
    • -
  • OTHER
    • -
  • ROOM
    • -
  • SUITE
    • -
  • UNIT
    • -
  • WAREHOUSE
    • -
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Beispiel
-
OTHER
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
technicalKey
-
- - -
-
- -
-
Premise Value
-
- -Value of a premise, e.g. name or designation of a particular site - -
-
Name
-
premiseValue
-
- - - -
-
Characteristic
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Beispiel
-
Werk 1
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
value
-
- - -
-
-
-
-

Thoroughfare Entity

-
-
- Entity for a thoroughfare which consists of a type, value and number. -
- -
-

Properties

-
-
- -
-
Thoroughfare Technical Key
-
- -Technical key of a thoroughfare. As specified by BPDM, this can be a "STREET" or a different type. - -
-
Name
-
thoroughfareTechnicalKey
-
- - - -
-
Characteristic
-
-
-
-
Enumeration
-
-
-
Werte
-
-
-
-
    -
  • STREET
    • -
  • INDUSTRIAL_ZONE
    • -
  • OTHER
    • -
  • RIVER
    • -
  • SQUARE
    • -
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Beispiel
-
STREET
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
technicalKey
-
- - -
-
- -
-
Value Thoroughfare
-
- -Value of a thoroughfare, e.g. name of a street. - -
-
Name
-
thoroughfareValue
-
- - - -
-
Characteristic
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Beispiel
-
Bernstraße
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
value
-
- - -
-
- -
-
Thoroughfare Number
-
- -Number of a thoroughfare. As used differently in international context, this number can contain both numerical and alphanumerical values - -
-
Name
-
thoroughfareNumber
-
- - - -
-
Characteristic
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Beispiel
-
45
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
number
-
- - -
-
-
-
-

Thoroughfare Entity

-
-
- Entity for a thoroughfare which consists of a type, value and number. -
- -
-

Properties

-
-
- -
-
Locality Technical Key
-
- -Technical key of a locality - -
-
Name
-
localityTechnicalKey
-
- - - -
-
Characteristic
-
-
-
-
Enumeration
-
-
-
Werte
-
-
-
-
    -
  • BLOCK
    • -
  • CITY
    • -
  • DISTRICT
    • -
  • OTHER
    • -
  • POST_OFFICE_CITY
    • -
  • QUARTER
    • -
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Beispiel
-
CITY
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
technicalKey
-
- - -
-
- -
-
Locality Value
-
- -Value of a locality, e.g. name of a city ("Mannheim"). - -
-
Name
-
localityValue
-
- - - -
-
Characteristic
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Beispiel
-
Mannheim
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
value
-
- - -
-
-
-
-

battery cycle life entity

-
-
- Entity to bundle the characterisitics describing the cycle life of a battery -
- -
-

Properties

-
-
- -
-
cycle life test c-rate
-
- -C-rate of Relevant Cycle-life Test is describing a regulatory requirement. - -
-
Name
-
cycleLifeTestCRate
-
- - - -
-
Characteristic
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#decimal - -
-
-
-
-
- -
-
Beispiel
-
45
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
cycleLifeTestCRate
-
- - -
-
- -
-
cycle-life test depth of discharge
-
- -Depth of discharge in the cycle-life test is describing a regulatory requirement. - -
-
Name
-
cycleLifeTestDepthOfDischarge
-
- - - -
-
Characteristic
-
-
-
-
Measurement
-
-
-
Depth of discharge in the cycle-life test is describing a regulatory requirement.
-
-
-
Einheit
-
-
-
-
    -
  • - percent -
    • -
  • - Symbol % -
    • -
  • - Code P1 -
    • -
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#decimal - -
-
-
-
-
- -
-
Beispiel
-
23
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
cycleLifeTestDepthOfDischarge
-
- - -
-
- -
-
expected lifetime
-
- -Expected battery lifetime expressed in cycles, and reference test used is describing a regulatory requirement. - -
-
Name
-
expectedLifetime
-
- - - -
-
Characteristic
-
-
-
-
Measurement
-
-
-
Expected battery lifetime expressed in cycles, and reference test used is describing a regulatory requirement.
-
-
-
Einheit
-
-
-
-
    -
  • - piece -
    • -
  • - Code H87 -
    • -
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#decimal - -
-
-
-
-
- -
-
Beispiel
-
456
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
expectedLifetime
-
- - -
-
-
-
-

battery energy entity

-
-
- Entity to bundle the energy properties of a battery. -
- -
-

Properties

-
-
- -
-
maximum allowed battery energy
-
- -Maximum allowed battery energy (Wh) of the battery is describing a regulatory requirement. - -
-
Name
-
maximumAllowedBatteryEnergy
-
- - - -
-
Characteristic
-
-
-
-
Measurement
-
-
-
Characterisitic to describe the energy (Wh) properties of the battery is describing a regulatory requirement.
-
-
-
Einheit
-
-
-
-
    -
  • - watt hour -
    • -
  • - Symbol W·h -
    • -
  • - Code WHR -
    • -
  • - Überführungsfaktor 3.6 × 10³ J -
    • -
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#float - -
-
-
-
-
- -
-
Beispiel
-
90000.0
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
maximumAllowedBatteryEnergy
-
- -
-
Referenz
-
-
    -
  • file:///Users/johannes/Projects/sldt-semantic-models/https%3A%2F%2Feur-lex.europa.eu%2Flegal-content%2FEN%2FTXT%2F%3Furi%3DCELEX%3A52020PC0798
    • -
-
-
- -
-
- -
-
energy roundtrip efficiency
-
- -Round-trip efficiency is the percentage of electricity put into storage is describing a regulatory requirement. - -
-
Name
-
energyRoundtripEfficiency
-
- - - -
-
Characteristic
-
-
-
-
Measurement
-
-
-
Round-trip efficiency is the percentage of electricity put into storage is describing a regulatory requirement.
-
-
-
Einheit
-
-
-
-
    -
  • - percent -
    • -
  • - Symbol % -
    • -
  • - Code P1 -
    • -
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#decimal - -
-
-
-
-
- -
-
Beispiel
-
56
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
energyRoundtripEfficiency
-
- - -
-
- -
-
energy roundtrip efficiency
-
- -Round-trip efficiency is the percentage of electricity put into storage is describing a regulatory requirement. - -
-
Name
-
energyRoundtripEfficiencyChange
-
- - - -
-
Characteristic
-
-
-
-
Measurement
-
-
-
Round-trip efficiency is the percentage of electricity put into storage after 50% of life of the battery is describing a regulatory requirement.
-
-
-
Einheit
-
-
-
-
    -
  • - percent -
    • -
  • - Symbol % -
    • -
  • - Code P1 -
    • -
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#decimal - -
-
-
-
-
- -
-
Beispiel
-
67
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
energyRoundtripEfficiencyChange
-
- - -
-
-
-
-

battery identification entity

-
-
- Entity to bundle the characterisitics describing the identification of a battery -
- -
-

Properties

-
-
- -
-
battery type
-
- -Battery type as described by the contents of the battery e.g. cell chemistry is describing a regulatory requirement. - -
-
Name
-
batteryType
-
- - - -
-
Characteristic
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Beispiel
-
LFP, Natrium, Li-Ion, NMC, NCA, Solid-State
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
batteryType
-
- - -
-
- -
-
battery model
-
- -Battery type as described by the contents of the battery e.g. cell chemistry is describing a regulatory requirement. - -
-
Name
-
batteryModel
-
- - - -
-
Characteristic
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Beispiel
-
LFP, Natrium, Li-Ion, NMC, NCA, Solid-State
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
batteryModel
-
- - -
-
- -
-
battery ID DMC code
-
- -Digital Matrix Code (DMC) of the battery i.e. serial number allowing for unequivocal identification of a battery is describing a regulatory requirement. - -
-
Name
-
batteryIDDMCCode
-
- - - -
-
Characteristic
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Beispiel
-
X123456789012X12345678901234567
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
batteryIDDMCCode
-
- - -
-
-
-
-

battery power entity

-
-
- Entity to bundle the power properties of a battery. -
- -
-

Properties

-
-
- -
-
maximum allowed battery power
-
- -Maximum allowed battery power (W) of the battery is describing a business requirement. - -
-
Name
-
maximumAllowedBatteryPower
-
- - - -
-
Characteristic
-
-
-
-
Measurement
-
-
-
Power capability in Watts
-
-
-
Einheit
-
-
-
-
    -
  • - watt -
    • -
  • - Symbol W -
    • -
  • - Code WTT -
    • -
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#float - -
-
-
-
-
- -
-
Beispiel
-
55000.0
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
maximumAllowedBatteryPower
-
- -
-
Referenz
-
-
    -
  • file:///Users/johannes/Projects/sldt-semantic-models/https%3A%2F%2Feur-lex.europa.eu%2Flegal-content%2FEN%2FTXT%2F%3Furi%3DCELEX%3A52020PC0798
    • -
-
-
- -
-
- -
-
battery original power
-
- -Original power capability in Watts is describing a regulatory requirement. - -
-
Name
-
originalPower
-
- - - -
-
Characteristic
-
-
-
-
Measurement
-
-
-
Power capability in Watts
-
-
-
Einheit
-
-
-
-
    -
  • - watt -
    • -
  • - Symbol W -
    • -
  • - Code WTT -
    • -
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#float - -
-
-
-
-
- -
-
Beispiel
-
7.56
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
originalPower
-
- - -
-
- -
-
maximum allowed battery power
-
- -Maximum allowed battery power (W) of the battery is describing a business requirement. - -
-
Name
-
powerFade
-
- - - -
-
Characteristic
-
-
-
-
Measurement
-
-
-
The decrease over time and upon usage in the amount of power that a battery can deliver at the rated voltage is describing a regulatory requirement.
-
-
-
Einheit
-
-
-
-
    -
  • - percent -
    • -
  • - Symbol % -
    • -
  • - Code P1 -
    • -
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#float - -
-
-
-
-
- -
-
Beispiel
-
23.0
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
powerFade
-
- -
-
Referenz
-
-
    -
  • https://eur-lex.europa.eu/legal-content/EN/TXT/?uri=CELEX:52020PC0798
    • -
-
-
- -
-
- -
-
power capability at 20 charge
-
- -Power (capability) at 20% state of charge. Description from the Regulation is describing a regulatory requirement. - -
-
Name
-
powerCapabilityAt20Charge
-
- - - -
-
Characteristic
-
-
-
-
Measurement
-
-
-
Power capability in Watts
-
-
-
Einheit
-
-
-
-
    -
  • - watt -
    • -
  • - Symbol W -
    • -
  • - Code WTT -
    • -
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#float - -
-
-
-
-
- -
-
Beispiel
-
643.0
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
powerCapabilityAt20Charge
-
- - -
-
- -
-
power capability at 80 charge
-
- -Power (capability) at 80% state of charge. Description from the Regulation is describing a regulatory requirement. - -
-
Name
-
powerCapabilityAt80Charge
-
- - - -
-
Characteristic
-
-
-
-
Measurement
-
-
-
Power capability in Watts
-
-
-
Einheit
-
-
-
-
    -
  • - watt -
    • -
  • - Symbol W -
    • -
  • - Code WTT -
    • -
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#float - -
-
-
-
-
- -
-
Beispiel
-
47.0
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
powerCapabilityAt80Charge
-
- - -
-
- -
-
original power capability
-
- -Performance ability of the high voltage battery i.e. the amount of energy that a battery is capable to provide over a given period of time is describing a regulatory requirement. - -
-
Name
-
originalPowerCapability
-
- - - -
-
Characteristic
-
-
-
-
Measurement
-
-
-
A measurement for the power of the battery.
-
-
-
Einheit
-
-
-
-
    -
  • - kilowatt -
    • -
  • - Symbol kW -
    • -
  • - Code KWT -
    • -
  • - Überführungsfaktor 10³ W -
    • -
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#decimal - -
-
-
-
-
- -
-
Beispiel
-
123
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
originalPowerCapability
-
- - -
-
- -
-
original power capability limits
-
- -Performance ability of the high voltage battery according to limits i.e. how much power it can provide within given limits is describing a regulatory requirement. - -
-
Name
-
originalPowerCapabilityLimits
-
- - - -
-
Characteristic
-
-
-
-
Measurement
-
-
-
A measurement for the power of the battery.
-
-
-
Einheit
-
-
-
-
    -
  • - kilowatt -
    • -
  • - Symbol kW -
    • -
  • - Code KWT -
    • -
  • - Überführungsfaktor 10³ W -
    • -
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#decimal - -
-
-
-
-
- -
-
Beispiel
-
123
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
originalPowerCapabilityLimits
-
- - -
-
-
-
-

battery voltage entity

-
-
- Entity to bundle the voltage properties of a battery. -
- -
-

Properties

-
-
- -
-
min voltage
-
- -Value of the minimal voltage the battery is rated for is describing a regulatory requirement. - -
-
Name
-
minVoltage
-
- - - -
-
Characteristic
-
-
-
-
Measurement
-
-
-
Value of the voltage the battery is rated for
-
-
-
Einheit
-
-
-
-
    -
  • - volt -
    • -
  • - Symbol V -
    • -
  • - Code VLT -
    • -
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#float - -
-
-
-
-
- -
-
Beispiel
-
2.0
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
minVoltage
-
- - -
-
- -
-
nominal voltage
-
- -Value of the nominal voltage the battery is rated for is describing a regulatory requirement. - -
-
Name
-
nominalVoltage
-
- - - -
-
Characteristic
-
-
-
-
Measurement
-
-
-
Value of the voltage the battery is rated for
-
-
-
Einheit
-
-
-
-
    -
  • - volt -
    • -
  • - Symbol V -
    • -
  • - Code VLT -
    • -
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#float - -
-
-
-
-
- -
-
Beispiel
-
4.3
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
nominalVoltage
-
- - -
-
- -
-
max voltage
-
- -Value of the maximum voltage the battery is rated for is describing a regulatory requirement. - -
-
Name
-
maxVoltage
-
- - - -
-
Characteristic
-
-
-
-
Measurement
-
-
-
Value of the voltage the battery is rated for
-
-
-
Einheit
-
-
-
-
    -
  • - volt -
    • -
  • - Symbol V -
    • -
  • - Code VLT -
    • -
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#float - -
-
-
-
-
- -
-
Beispiel
-
6.0
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
maxVoltage
-
- - -
-
-
-
-

cell chemistry

-
-
- Entity to bundle the characterisitics describing a battery's cell chemistry -
- -
-

Properties

-
-
- -
-
cathode active materials
-
- -The total amount of valuable materials contained in CAM material: Nickel, Cobalt, Lithium. - -
-
Name
-
cathodeActiveMaterials
-
- - - -
-
Characteristic
-
-
-
-
Set
-
-
-
Has no order
-
-
-
Duplicates not allowed
-
-
-
- Typ urn:bamm:io.catenax.battery.battery_pass:2.0.0#MaterialNameAndWeightAndPercentageMassFractionEntity - -
-
-
-
-
- - -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
cathodeActiveMaterials
-
- - -
-
- -
-
recyclate content active materials
-
- -List of recovered Recyclate Content in Active Material Recycled is describing a regulatory requirement. The following materials have to be reported on as a minimium: Cobalt, Lithium, Nickel, Lead - -
-
Name
-
recyclateContentActiveMaterials
-
- - - -
-
Characteristic
-
-
-
-
Set
-
-
-
Has no order
-
-
-
Duplicates not allowed
-
-
-
- Typ urn:bamm:io.catenax.battery.battery_pass:2.0.0#MaterialNameAndWeightAndPercentageMassFractionEntity - -
-
-
-
-
- - -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
recyclateContentActiveMaterials
-
- - -
-
- -
-
anode active materials
-
- -The total amount of valuable materials contained in Anode: graphite - -
-
Name
-
anodeActiveMaterials
-
- - - -
-
Characteristic
-
-
-
-
Set
-
-
-
Has no order
-
-
-
Duplicates not allowed
-
-
-
- Typ urn:bamm:io.catenax.battery.battery_pass:2.0.0#MaterialNameAndWeightAndPercentageMassFractionEntity - -
-
-
-
-
- - -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
anodeActiveMaterials
-
- - -
-
- -
-
cathode composition other
-
- -The composition or materials contained in the Cathode is describing a regulatory requirement. - -
-
Name
-
cathodeCompositionOther
-
- - - -
-
Characteristic
-
-
-
-
Set
-
-
-
Has no order
-
-
-
Duplicates not allowed
-
-
-
- Typ urn:bamm:io.catenax.battery.battery_pass:2.0.0#MaterialNameAndWeightAndPercentageMassFractionEntity - -
-
-
-
-
- - -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
cathodeCompositionOther
-
- - -
-
- -
-
anode composition other
-
- -The composition or materials contained in the anode is describing a regulatory requirement. - -
-
Name
-
anodeCompositionOther
-
- - - -
-
Characteristic
-
-
-
-
Set
-
-
-
Has no order
-
-
-
Duplicates not allowed
-
-
-
- Typ urn:bamm:io.catenax.battery.battery_pass:2.0.0#MaterialNameAndWeightAndPercentageMassFractionEntity - -
-
-
-
-
- - -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
anodeCompositionOther
-
- - -
-
- -
-
electrolyte composition
-
- -List of materials contained in the electrolyte is describing a regulatory requirement. - -
-
Name
-
electrolyteComposition
-
- - - -
-
Characteristic
-
-
-
-
Set
-
-
-
Has no order
-
-
-
Duplicates not allowed
-
-
-
- Referenz -
-
    -
  • https://eur-lex.europa.eu/legal-content/EN/TXT/?uri=CELEX:52020DC0474
    • -
-
-
-
-
-
- Typ urn:bamm:io.catenax.battery.battery_pass:2.0.0#MaterialNameAndWeightAndPercentageMassFractionEntity - -
-
-
-
-
- - -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
electrolyteComposition
-
- -
-
Referenz
-
-
    -
  • https://eur-lex.europa.eu/legal-content/EN/TXT/?uri=CELEX:52020DC0474
    • -
-
-
- -
-
-
-
-

components

-
-
- Entity to bundle the components properties of a battery. -
- -
-

Properties

-
-
- -
-
components supplier
-
- -Contact details of the suppliers of replacement parts / spare parts is describing a regulatory requirement. Available fields should be like: -Name - Street - Number - ZIP Code - City - State - Country - Phone - Fax - Email - Website - -
-
Name
-
componentsSupplier
-
- - - -
-
Characteristic
-
-
-
-
Set
-
-
-
Has no order
-
-
-
Duplicates not allowed
-
-
-
- Typ urn:bamm:io.catenax.battery.battery_pass:2.0.0#ComponentsSupplierEntity - -
-
-
-
-
- - -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
componentsSupplier
-
- - -
-
- -
-
components part number
-
- -The unique serial numbers of the different parts of a battery is describing a regulatory requirement. - -
-
Name
-
componentsPartNumber
-
- - - -
-
Characteristic
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Beispiel
-
Case xxxxxxx/xx; Controller xxxxxxx/xx
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
componentsPartNumber
-
- - -
-
-
-
-

components supplier

-
-
- Entity encapsulating the details of a components supplier -
- -
-

Properties

-
-
- -
-
address
-
- -An postal address - -
-
Name
-
address
-
- - - -
-
Characteristic
-
-
-
-
SingleEntity
-
-
-
- Typ urn:bamm:io.catenax.shared.address_characteristic:1.0.1#AddressEntity - -
-
-
-
-
- - -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
address
-
- - -
-
- -
-
contact
-
- -Contact details of the manufacturer - -
-
Name
-
contact
-
- - - -
-
Characteristic
-
-
-
-
SingleEntity
-
-
-
- Typ urn:bamm:io.catenax.shared.contact_information:1.0.0#ContactEntity - -
-
-
-
-
- - -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
contact
-
- - -
-
-
-
-

composition

-
-
- Entity to bundle the characterisitics describing a battery's composition -
- -
-

Properties

-
-
- -
-
components
-
- -Properties of the batterie's comoponents. - -
-
Name
-
components
-
- - - -
-
Characteristic
-
-
-
-
SingleEntity
-
-
-
- Typ urn:bamm:io.catenax.battery.battery_pass:2.0.0#CompomenentsEntity - -
-
-
-
-
- - -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
components
-
- - -
-
- -
-
composition of battery
-
- -Full composition of battery is describing a business requirement. - -
-
Name
-
compositionOfBattery
-
- - - -
-
Characteristic
-
-
-
-
Set
-
-
-
Has no order
-
-
-
Duplicates not allowed
-
-
-
- Typ urn:bamm:io.catenax.battery.battery_pass:2.0.0#MaterialNameAndWeightAndPercentageMassFractionEntity - -
-
-
-
-
- - -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
compositionOfBattery
-
- - -
-
- -
-
critical raw materials
-
- -List of critical raw materials (CRM) as specified by EU in a battery is describing a regulatory requirement. - -
-
Name
-
criticalRawMaterials
-
- - - -
-
Characteristic
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- - -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
criticalRawMaterials
-
- - -
-
-
-
-

document entity

-
-
- Entity encapsulating the details of a attachment for the battery -
- -
-

Properties

-
-
- -
-
packaging instructions
-
- -Instructions for safely packaging -batteries is describing a business requirement. - -
-
Name
-
packagingInstructions
-
- - - -
-
Characteristic
-
-
-
-
Set
-
-
-
Has no order
-
-
-
Duplicates not allowed
-
-
-
- Typ urn:bamm:io.catenax.battery.battery_pass:2.0.0#AttachmentEntity - -
-
-
-
-
- - -
-
Optional
-
- Ja
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
packagingInstructions
-
- - -
-
- -
-
transportation instructions
-
- -Instructions for safely transporting -batteries is describing a business requirement. - -
-
Name
-
transportationInstructions
-
- - - -
-
Characteristic
-
-
-
-
Set
-
-
-
Has no order
-
-
-
Duplicates not allowed
-
-
-
- Typ urn:bamm:io.catenax.battery.battery_pass:2.0.0#AttachmentEntity - -
-
-
-
-
- - -
-
Optional
-
- Ja
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
transportationInstructions
-
- - -
-
- -
-
vehicle dismantling procedure
-
- -Document containing the vehicle dismantling procedure is describing a regulatory requirement. - -
-
Name
-
vehicleDismantlingProcedure
-
- - - -
-
Characteristic
-
-
-
-
Set
-
-
-
Has no order
-
-
-
Duplicates not allowed
-
-
-
- Typ urn:bamm:io.catenax.battery.battery_pass:2.0.0#AttachmentEntity - -
-
-
-
-
- - -
-
Optional
-
- Ja
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
vehicleDismantlingProcedure
-
- - -
-
- -
-
battery dismantling procedure
-
- -Document containing the battery dismantling procedure is describing a regulatory requirement. - -
-
Name
-
batteryDismantlingProcedure
-
- - - -
-
Characteristic
-
-
-
-
Set
-
-
-
Has no order
-
-
-
Duplicates not allowed
-
-
-
- Typ urn:bamm:io.catenax.battery.battery_pass:2.0.0#AttachmentEntity - -
-
-
-
-
- - -
-
Optional
-
- Ja
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
batteryDismantlingProcedure
-
- - -
-
- -
-
safety measures
-
- -Safety measures document(s) is describing a regulatory requirement. - -
-
Name
-
safetyMeasures
-
- - - -
-
Characteristic
-
-
-
-
Set
-
-
-
Has no order
-
-
-
Duplicates not allowed
-
-
-
- Typ urn:bamm:io.catenax.battery.battery_pass:2.0.0#AttachmentEntity - -
-
-
-
-
- - -
-
Optional
-
- Ja
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
safetyMeasures
-
- - -
-
- -
-
test reports results
-
- -Results of test reports which prove that the battery fulfills this regulation and its delegated regulations is describing a regulatory requirement. - -
-
Name
-
testReportsResults
-
- - - -
-
Characteristic
-
-
-
-
Set
-
-
-
Has no order
-
-
-
Duplicates not allowed
-
-
-
- Typ urn:bamm:io.catenax.battery.battery_pass:2.0.0#AttachmentEntity - -
-
-
-
-
- - -
-
Optional
-
- Ja
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
testReportsResults
-
- - -
-
- -
-
declaration of conformity
-
- -Declaration of conformity (CE) is describing a regulatory requirement. - -
-
Name
-
declarationOfConformity
-
- - - -
-
Characteristic
-
-
-
-
Set
-
-
-
Has no order
-
-
-
Duplicates not allowed
-
-
-
- Typ urn:bamm:io.catenax.battery.battery_pass:2.0.0#AttachmentEntity - -
-
-
-
-
- - -
-
Optional
-
- Ja
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
declarationOfConformity
-
- - -
-
- -
-
responsible sourcing
-
- -Document/Certificates on organizations compliance to ethical business practices - -
-
Name
-
responsibleSourcing
-
- - - -
-
Characteristic
-
-
-
-
Set
-
-
-
Has no order
-
-
-
Duplicates not allowed
-
-
-
- Typ urn:bamm:io.catenax.battery.battery_pass:2.0.0#AttachmentEntity - -
-
-
-
-
- - -
-
Optional
-
- Ja
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
responsibleSourcing
-
- - -
-
-
-
-

electrochemical properties entity

-
-
- Entity encapsulating the electrochemical details of a battery -
- -
-

Properties

-
-
- -
-
attachment
-
- -Characterisitic to describe the power (W) properties of the batterie. - -
-
Name
-
batteryPower
-
- - - -
-
Characteristic
-
-
-
-
SingleEntity
-
-
-
- Typ urn:bamm:io.catenax.battery.battery_pass:2.0.0#BatteryPowerEntity - -
-
-
-
-
- - -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
batteryPower
-
- - -
-
- -
-
battery voltage
-
- -Voltage (V) of the battery. - -
-
Name
-
batteryVoltage
-
- - - -
-
Characteristic
-
-
-
-
SingleEntity
-
-
-
- Typ urn:bamm:io.catenax.battery.battery_pass:2.0.0#BatteryVoltageEntity - -
-
-
-
-
- - -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
batteryVoltage
-
- - -
-
- -
-
rated capacity
-
- -The total number of ampere-hours (Ah) that can be withdrawn from a fully charged battery under specific conditions is describing a regulatory requirement. - -
-
Name
-
ratedCapacity
-
- - - -
-
Characteristic
-
-
-
-
Measurement
-
-
-
The total number of ampere-hours (Ah) that can be withdrawn from a fully charged battery under specific conditions is describing a regulatory requirement.
-
-
-
Einheit
-
-
-
-
    -
  • - ampere -
    • -
  • - Symbol A -
    • -
  • - Code AMP -
    • -
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#decimal - -
-
-
-
-
- -
-
Beispiel
-
210
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
ratedCapacity
-
- - -
-
- -
-
capacity fade
-
- -The decrease over time and upon usage in the amount of charge that a battery can deliver at the rated voltage, with respect to the original rated capacity declared by the manufacturer is describing a regulatory requirement. - -
-
Name
-
capacityFade
-
- - - -
-
Characteristic
-
-
-
-
Measurement
-
-
-
The decrease over time and upon usage in the amount of charge that a battery can deliver at the rated voltage, with respect to the original rated capacity declared by the manufacturer is describing a regulatory requirement.
-
-
-
Einheit
-
-
-
-
    -
  • - percent -
    • -
  • - Symbol % -
    • -
  • - Code P1 -
    • -
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#decimal - -
-
-
-
-
- -
-
Beispiel
-
34
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
capacityFade
-
- - -
-
- -
-
internal resistance
-
- -Internal resistance in a battery cell or pack is describing a regulatory requirement. - -
-
Name
-
internalResistance
-
- - - -
-
Characteristic
-
-
-
-
SingleEntity
-
-
-
- Typ urn:bamm:io.catenax.battery.battery_pass:2.0.0#InternalResistanceEntity - -
-
-
-
-
- - -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
internalResistance
-
- - -
-
- -
-
internal resistance
-
- -Capacity threshold for exhaustion as percentage value is describing a regulatory requirement. - -
-
Name
-
capacityThresholdExhaustion
-
- - - -
-
Characteristic
-
-
-
-
Measurement
-
-
-
Capacity threshold for exhaustion as percentage value is describing a regulatory requirement.
-
-
-
Einheit
-
-
-
-
    -
  • - percent -
    • -
  • - Symbol % -
    • -
  • - Code P1 -
    • -
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#decimal - -
-
-
-
-
- -
-
Beispiel
-
23
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
capacityThresholdExhaustion
-
- - -
-
- -
-
battery energy
-
- -Characterisitic to describe the energy (kWh) properties of the batterie. - -
-
Name
-
batteryEnergy
-
- - - -
-
Characteristic
-
-
-
-
SingleEntity
-
-
-
- Typ urn:bamm:io.catenax.battery.battery_pass:2.0.0#BatteryEnergyEntity - -
-
-
-
-
- - -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
batteryEnergy
-
- - -
-
- -
-
ratio maximum allowed battery power and maximum allowed battery energy
-
- -Ratio between maximum allowed battery power (W) and battery energy (Wh) is describing a regulatory requirement. - -
-
Name
-
ratioMaximumAllowedBatteryPowerAndMaximumAllowedBatteryEnergy
-
- - - -
-
Characteristic
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#float - -
-
-
-
-
- -
-
Beispiel
-
0.611
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
ratioMaximumAllowedBatteryPowerAndMaximumAllowedBatteryEnergy
-
- - -
-
-
-
-

internal resistance

-
-
- Entity to bundle the internal resistance properties of a battery. -
- -
-

Properties

-
-
- -
-
cell internal resistance
-
- -The resistance offered by the cell in the flow of the current - -
-
Name
-
cellInternalResistance
-
- - - -
-
Characteristic
-
-
-
-
Measurement
-
-
-
The resistance offered by the cell in the flow of the current
-
-
-
Einheit
-
-
-
-
    -
  • - milliohm -
    • -
  • - Symbol mΩ -
    • -
  • - Code E45 -
    • -
  • - Überführungsfaktor 10⁻³ Ω -
    • -
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#decimal - -
-
-
-
-
- -
-
Beispiel
-
45
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
cellInternalResistance
-
- - -
-
- -
-
pack internal resistance
-
- -Total internal resistance in a battery pack is describing a regulatory requirement. - -
-
Name
-
packInternalResistance
-
- - - -
-
Characteristic
-
-
-
-
Measurement
-
-
-
Total internal resistance in a battery pack
-
-
-
Einheit
-
-
-
-
    -
  • - ohm -
    • -
  • - Symbol Ω -
    • -
  • - Code OHM -
    • -
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#decimal - -
-
-
-
-
- -
-
Beispiel
-
67
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
packInternalResistance
-
- - -
-
- -
-
pack internal resistanceIncrease
-
- -Increase in internal resistance of a battery pack over a period of time is describing a regulatory requirement. - -
-
Name
-
packInternalResistanceIncrease
-
- - - -
-
Characteristic
-
-
-
-
Measurement
-
-
-
Increase in internal resistance of a battery pack over a period of time
-
-
-
Einheit
-
-
-
-
    -
  • - percent -
    • -
  • - Symbol % -
    • -
  • - Code P1 -
    • -
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#decimal - -
-
-
-
-
- -
-
Beispiel
-
23
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
packInternalResistanceIncrease
-
- - -
-
-
-
-

manufacturer

-
-
- Entity encapsulating the details of a manufacturer of goods -
- -
-

Properties

-
-
- -
-
name
-
- -Name of the manufacturer is describing a regulatory requirement. - -
-
Name
-
name
-
- - - -
-
Characteristic
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Beispiel
-
Samsung
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
name
-
- - -
-
- -
-
contact
-
- -Contact details of the manufacturer - -
-
Name
-
contact
-
- - - -
-
Characteristic
-
-
-
-
SingleEntity
-
-
-
- Typ urn:bamm:io.catenax.shared.contact_information:1.0.0#ContactEntity - -
-
-
-
-
- - -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
contact
-
- - -
-
- -
-
address
-
- -An postal address - -
-
Name
-
address
-
- - - -
-
Characteristic
-
-
-
-
SingleEntity
-
-
-
- Typ urn:bamm:io.catenax.shared.address_characteristic:1.0.1#AddressEntity - -
-
-
-
-
- - -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
address
-
- - -
-
-
-
-

manufacturing entity

-
-
- Entity to bundle the characterisitics describing the manufacturing (place and date of manufacture) -
- -
-

Properties

-
-
- -
-
date of manufacturing
-
- -Manufacturing date of the battery is describing a regulatory requirement. - -
-
Name
-
dateOfManufacturing
-
- - - -
-
Characteristic
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#date - -
-
-
-
-
- -
-
Beispiel
-
2022-03-07
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
dateOfManufacturing
-
- - -
-
- -
-
address
-
- -An postal address - -
-
Name
-
address
-
- - - -
-
Characteristic
-
-
-
-
SingleEntity
-
-
-
- Typ urn:bamm:io.catenax.shared.address_characteristic:1.0.1#AddressEntity - -
-
-
-
-
- - -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
address
-
- - -
-
-
-
-

material name and weight and percent

-
-
- Entity to bundle a material's name, weight and percentage of mass. -
- -
-

Properties

-
-
- -
-
matierial percentage mass fraction
-
- -Percentage mass fraction of a material. - -
-
Name
-
matierialPercentageMassFraction
-
- - - -
-
Characteristic
-
-
-
-
Measurement
-
-
-
Percentage mass fraction of a material
-
-
-
Einheit
-
-
-
-
    -
  • - percent -
    • -
  • - Symbol % -
    • -
  • - Code P1 -
    • -
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#decimal - -
-
-
-
-
- -
-
Beispiel
-
19
-
- -
-
Optional
-
- Ja
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
matierialPercentageMassFraction
-
- - -
-
- -
-
material weight
-
- -Weight of the material (in gram) - -
-
Name
-
matierialWeight
-
- - - -
-
Characteristic
-
-
-
-
Measurement
-
-
-
Weight of the material (in gram)
-
-
-
Einheit
-
-
-
-
    -
  • - gram -
    • -
  • - Symbol g -
    • -
  • - Code GRM -
    • -
  • - Überführungsfaktor 10⁻³ kg -
    • -
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#decimal - -
-
-
-
-
- -
-
Beispiel
-
2.5
-
- -
-
Optional
-
- Ja
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
matierialWeight
-
- - -
-
- -
-
material name
-
- -Name of the material - -
-
Name
-
materialName
-
- - - -
-
Characteristic
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- - -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
materialName
-
- - -
-
-
-
-

physical dimensions entity

-
-
- Entity to bundle the characterisitics describing the physical dimensions -
- -
-

Properties

-
-
- -
-
length
-
- -Length of the item is describing a business requirement. - -
-
Name
-
length
-
- - - -
-
Characteristic
-
-
-
-
Measurement
-
-
-
A measurment for the length/width/height of an item.
-
-
-
Einheit
-
-
-
-
    -
  • - millimetre -
    • -
  • - Symbol mm -
    • -
  • - Code MMT -
    • -
  • - Überführungsfaktor 10⁻³ m -
    • -
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#integer - -
-
-
-
-
- -
-
Beispiel
-
20000
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
length
-
- - -
-
- -
-
width
-
- -Width of the item is describing a business requirement. - -
-
Name
-
width
-
- - - -
-
Characteristic
-
-
-
-
Measurement
-
-
-
A measurment for the length/width/height of an item.
-
-
-
Einheit
-
-
-
-
    -
  • - millimetre -
    • -
  • - Symbol mm -
    • -
  • - Code MMT -
    • -
  • - Überführungsfaktor 10⁻³ m -
    • -
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#integer - -
-
-
-
-
- -
-
Beispiel
-
1000
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
width
-
- - -
-
- -
-
height
-
- -Height of the item is describing a business requirement. - -
-
Name
-
height
-
- - - -
-
Characteristic
-
-
-
-
Measurement
-
-
-
A measurment for the length/width/height of an item.
-
-
-
Einheit
-
-
-
-
    -
  • - millimetre -
    • -
  • - Symbol mm -
    • -
  • - Code MMT -
    • -
  • - Überführungsfaktor 10⁻³ m -
    • -
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#integer - -
-
-
-
-
- -
-
Beispiel
-
1
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
height
-
- - -
-
- -
-
diameter
-
- -Diameter of the item. - -
-
Name
-
diameter
-
- - - -
-
Characteristic
-
-
-
-
Measurement
-
-
-
A measurment for the length/width/height of an item.
-
-
-
Einheit
-
-
-
-
    -
  • - millimetre -
    • -
  • - Symbol mm -
    • -
  • - Code MMT -
    • -
  • - Überführungsfaktor 10⁻³ m -
    • -
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#integer - -
-
-
-
-
- -
-
Beispiel
-
3
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
diameter
-
- - -
-
- -
-
weight
-
- -Weight of the item is describing a regulatory requirement. - -
-
Name
-
weight
-
- - - -
-
Characteristic
-
-
-
-
Measurement
-
-
-
A measurement for the weight of an item.
-
-
-
Einheit
-
-
-
-
    -
  • - kilogram -
    • -
  • - Symbol kg -
    • -
  • - Code KGM -
    • -
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#integer - -
-
-
-
-
- -
-
Beispiel
-
1007
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
weight
-
- - -
-
-
-
-

state of battery entity

-
-
- Entity to bundle the characterisitics describing the state of a battery -
- -
-

Properties

-
-
- -
-
state of health
-
- -Evidence/Certificate of the health evaluation of a battery for its use following repurposing or remanufacturing operations is describing a business requirement. - -
-
Name
-
stateOfHealth
-
- - - -
-
Characteristic
-
-
-
-
Measurement
-
-
-
Evidence/Certificate of the health evaluation of a battery for its use following repurposing or remanufacturing operations is describing a business requirement.
-
-
-
Einheit
-
-
-
-
    -
  • - percent -
    • -
  • - Symbol % -
    • -
  • - Code P1 -
    • -
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#integer - -
-
-
-
-
- -
-
Beispiel
-
12
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
stateOfHealth
-
- - -
-
- -
-
state of charge
-
- -The value of the state of charge of the battery at the end of life i.e. when entering recycling scheme is describing a business requirement. - -
-
Name
-
stateOfCharge
-
- - - -
-
Characteristic
-
-
-
-
Measurement
-
-
-
The value of the state of charge of the battery at the end of life i.e. when entering recycling scheme is describing a business requirement.
-
-
-
Einheit
-
-
-
-
    -
  • - percent -
    • -
  • - Symbol % -
    • -
  • - Code P1 -
    • -
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#integer - -
-
-
-
-
- -
-
Beispiel
-
23
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
stateOfCharge
-
- - -
-
- -
-
status battery
-
- -Status of the battery is describing a regulatory requirement. Value list provided by the regulators. - -
-
Name
-
statusBattery
-
- - - -
-
Characteristic
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Beispiel
-
first life/ waste/ repaired/ repurposed/ recycled
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
statusBattery
-
- - -
-
-
-
-

temperature range idle state

-
-
- Entity to bundle the characterisitics describing the battery's temperature range -
- -
-

Properties

-
-
- -
-
temperature range idle state lower limit
-
- -The lower range of temperature the battery can withstand when not in use is describing a regulatory requirement. - -
-
Name
-
temperatureRangeIdleStateLowerLimit
-
- - - -
-
Characteristic
-
-
-
-
Measurement
-
-
-
The lower range of temperature the battery can withstand when not in use is describing a regulatory requirement.
-
-
-
Einheit
-
-
-
-
    -
  • - degree Celsius -
    • -
  • - Symbol °C -
    • -
  • - Code CEL -
    • -
  • - Überführungsfaktor 1 × K -
    • -
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#decimal - -
-
-
-
-
- -
-
Beispiel
-
67
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
temperatureRangeIdleStateLowerLimit
-
- - -
-
- -
-
temperature rangeIdle state upper limit
-
- -The upper range of temperature the battery can withstand when not in use is describing a regulatory requirement. - -
-
Name
-
temperatureRangeIdleStateUpperLimit
-
- - - -
-
Characteristic
-
-
-
-
Measurement
-
-
-
The lower range of temperature the battery can withstand when not in use is describing a regulatory requirement.
-
-
-
Einheit
-
-
-
-
    -
  • - degree Celsius -
    • -
  • - Symbol °C -
    • -
  • - Code CEL -
    • -
  • - Überführungsfaktor 1 × K -
    • -
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#decimal - -
-
-
-
-
- -
-
Beispiel
-
67
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
temperatureRangeIdleStateUpperLimit
-
- - -
-
-
- -
- Third party licenses - -
- -
- - -
- - - \ No newline at end of file diff --git a/io.catenax.battery.battery_pass/2.0.0/gen/BatteryPass.json b/io.catenax.battery.battery_pass/2.0.0/gen/BatteryPass.json deleted file mode 100644 index 28722a7db..000000000 --- a/io.catenax.battery.battery_pass/2.0.0/gen/BatteryPass.json +++ /dev/null @@ -1,236 +0,0 @@ -{ - "electrochemicalProperties" : { - "ratedCapacity" : 210, - "batteryEnergy" : { - "energyRoundtripEfficiencyChange" : 67, - "maximumAllowedBatteryEnergy" : 90000.0, - "energyRoundtripEfficiency" : 56 - }, - "ratioMaximumAllowedBatteryPowerAndMaximumAllowedBatteryEnergy" : 0.611, - "batteryVoltage" : { - "nominalVoltage" : 4.3, - "maxVoltage" : 6.0, - "minVoltage" : 2.0 - }, - "internalResistance" : { - "cellInternalResistance" : 45, - "packInternalResistanceIncrease" : 23, - "packInternalResistance" : 67 - }, - "capacityThresholdExhaustion" : 23, - "batteryPower" : { - "originalPowerCapability" : 123, - "powerFade" : 23.0, - "originalPowerCapabilityLimits" : 123, - "maximumAllowedBatteryPower" : 55000.0, - "powerCapabilityAt20Charge" : 643.0, - "originalPower" : 7.56, - "powerCapabilityAt80Charge" : 47.0 - }, - "capacityFade" : 34 - }, - "document" : { - "responsibleSourcing" : [ { - "title" : "LlN", - "fileLocation" : "telnet://192.0.2.16:80/" - } ], - "packagingInstructions" : [ { - "title" : "eOMtThyhVNLWUZNRcBaQKxI", - "fileLocation" : "telnet://192.0.2.16:80/" - } ], - "transportationInstructions" : [ { - "title" : "yedUsFwdkelQbxeTeQOvaScfqIOOmaa", - "fileLocation" : "ftp://ftp.is.co.za/rfc/rfc1808.txt" - } ], - "vehicleDismantlingProcedure" : [ { - "title" : "JxkyvRnL", - "fileLocation" : "http://www.ietf.org/rfc/rfc2396.txt" - } ], - "testReportsResults" : [ { - "title" : "UMaAIKKIkknjWEXJUfPxxQHeWKEJ", - "fileLocation" : "telnet://192.0.2.16:80/" - } ], - "batteryDismantlingProcedure" : [ { - "title" : "RYtGKbgicZaHCBRQDSx", - "fileLocation" : "http://www.wikipedia.org" - } ], - "safetyMeasures" : [ { - "title" : "VLhpfQGTMDYpsBZxvfBoeygjb", - "fileLocation" : "ftp://ftp.is.co.za/rfc/rfc1808.txt" - } ], - "declarationOfConformity" : [ { - "title" : "dpHYZGhtgdntugzvvKAXLhM", - "fileLocation" : "http://www.wikipedia.org" - } ] - }, - "datePlacedOnMarket" : "2023-03-14T17:10:53.975+01:00", - "cellChemistry" : { - "electrolyteComposition" : [ { - "matierialPercentageMassFraction" : 19, - "matierialWeight" : 2.5, - "materialName" : "sPB" - } ], - "anodeCompositionOther" : [ { - "matierialPercentageMassFraction" : 19, - "matierialWeight" : 2.5, - "materialName" : "YdvDhtAsLghPXAgtbprXPZkhnfLTBSX" - } ], - "recyclateContentActiveMaterials" : [ { - "matierialPercentageMassFraction" : 19, - "matierialWeight" : 2.5, - "materialName" : "UfzQhdgLLfDTDGspDb" - } ], - "anodeActiveMaterials" : [ { - "matierialPercentageMassFraction" : 19, - "matierialWeight" : 2.5, - "materialName" : "QvBQYuxiXXVytGCxzVllpgTJKhRQq" - } ], - "cathodeActiveMaterials" : [ { - "matierialPercentageMassFraction" : 19, - "matierialWeight" : 2.5, - "materialName" : "gNfZBdyFGRajVfJNonEnOinZj" - } ], - "cathodeCompositionOther" : [ { - "matierialPercentageMassFraction" : 19, - "matierialWeight" : 2.5, - "materialName" : "qszYL" - } ] - }, - "physicalDimensions" : { - "length" : 20000, - "width" : 1000, - "weight" : 1007, - "diameter" : 3, - "height" : 1 - }, - "temperatureRangeIdleState" : { - "temperatureRangeIdleStateUpperLimit" : 67, - "temperatureRangeIdleStateLowerLimit" : 67 - }, - "batteryCycleLife" : { - "cycleLifeTestCRate" : 45, - "cycleLifeTestDepthOfDischarge" : 23, - "expectedLifetime" : 456 - }, - "manufacturer" : { - "name" : "Samsung", - "contact" : { - "faxNumber" : "+49 89 0987654321", - "website" : "https://www.samsung.com", - "phoneNumber" : "+49 89 1234567890", - "email" : "test.mail@example.com" - }, - "address" : { - "locality" : { - "value" : "Mannheim", - "technicalKey" : "BLOCK" - }, - "country" : { - "shortName" : "" - }, - "postCode" : { - "value" : "68161\\12", - "technicalKey" : "CEDEX" - }, - "thoroughfare" : { - "value" : "Bernstraße", - "number" : "45", - "technicalKey" : "STREET" - }, - "premise" : { - "value" : "Werk 1", - "technicalKey" : "BUILDING" - }, - "postalDeliveryPoint" : { - "value" : "Tor 1", - "technicalKey" : "INTERURBAN_DELIVERY_POINT" - } - } - }, - "warrantyPeriod" : 60, - "composition" : { - "compositionOfBattery" : [ { - "matierialPercentageMassFraction" : 19, - "matierialWeight" : 2.5, - "materialName" : "Oxm" - } ], - "criticalRawMaterials" : "QIn", - "components" : { - "componentsPartNumber" : "Case xxxxxxx/xx; Controller xxxxxxx/xx", - "componentsSupplier" : [ { - "address" : { - "locality" : { - "value" : "Mannheim", - "technicalKey" : "BLOCK" - }, - "country" : { - "shortName" : "XH-VZ" - }, - "postCode" : { - "value" : "68161\\12", - "technicalKey" : "CEDEX" - }, - "thoroughfare" : { - "value" : "Bernstraße", - "number" : "45", - "technicalKey" : "STREET" - }, - "premise" : { - "value" : "Werk 1", - "technicalKey" : "BUILDING" - }, - "postalDeliveryPoint" : { - "value" : "Tor 1", - "technicalKey" : "INTERURBAN_DELIVERY_POINT" - } - }, - "contact" : { - "faxNumber" : "+49 89 0987654321", - "website" : "https://www.samsung.com", - "phoneNumber" : "+49 89 1234567890", - "email" : "test.mail@example.com" - } - } ] - } - }, - "manufacturing" : { - "dateOfManufacturing" : "2022-03-07", - "address" : { - "locality" : { - "value" : "Mannheim", - "technicalKey" : "BLOCK" - }, - "country" : { - "shortName" : "" - }, - "postCode" : { - "value" : "68161\\12", - "technicalKey" : "CEDEX" - }, - "thoroughfare" : { - "value" : "Bernstraße", - "number" : "45", - "technicalKey" : "STREET" - }, - "premise" : { - "value" : "Werk 1", - "technicalKey" : "BUILDING" - }, - "postalDeliveryPoint" : { - "value" : "Tor 1", - "technicalKey" : "INTERURBAN_DELIVERY_POINT" - } - } - }, - "batteryIdentification" : { - "batteryType" : "LFP, Natrium, Li-Ion, NMC, NCA, Solid-State", - "batteryIDDMCCode" : "X123456789012X12345678901234567", - "batteryModel" : "LFP, Natrium, Li-Ion, NMC, NCA, Solid-State" - }, - "stateOfBattery" : { - "stateOfHealth" : 12, - "statusBattery" : "first life/ waste/ repaired/ repurposed/ recycled", - "stateOfCharge" : 23 - }, - "cO2FootprintTotal" : 124.0 -} \ No newline at end of file diff --git a/io.catenax.battery.battery_pass/2.0.0/gen/BatteryPass.yml b/io.catenax.battery.battery_pass/2.0.0/gen/BatteryPass.yml deleted file mode 100644 index d1ffaa0fc..000000000 --- a/io.catenax.battery.battery_pass/2.0.0/gen/BatteryPass.yml +++ /dev/null @@ -1,983 +0,0 @@ ---- -openapi: 3.0.3 -info: - title: battery pass - version: v2 -servers: -- url: catenax.io/api/v2 - variables: - api-version: - default: v2 -paths: - /{tenant-id}/battery-pass: - get: - tags: - - BatteryPass - operationId: getBatteryPass - 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/BatteryPass' - "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_bamm_io.catenax.battery.battery_pass_2.0.0_FileLocationCharacteristic: - type: string - format: uri - description: The path to the file - urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text: - type: string - description: "Describes a Property which contains plain text. This is intended\ - \ exclusively for human readable strings, not for identifiers, measurement\ - \ values, etc." - urn_bamm_io.catenax.battery.battery_pass_2.0.0_AttachmentEntity: - description: Entity encapsulating the details of a attachment for the battery - type: object - properties: - fileLocation: - description: Location of the file - $ref: '#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_FileLocationCharacteristic' - title: - description: Title of the attached file - $ref: '#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text' - required: - - fileLocation - - title - urn_bamm_io.catenax.battery.battery_pass_2.0.0_AttachmentLinkCharacteristic: - description: Links the referenced attachments - type: array - items: - $ref: '#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_AttachmentEntity' - uniqueItems: true - urn_bamm_io.catenax.battery.battery_pass_2.0.0_DocumentCharacteristic: - description: Set of documents containing the description of battery components - type: object - properties: - packagingInstructions: - description: |- - Instructions for safely packaging - batteries is describing a business requirement. - $ref: '#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_AttachmentLinkCharacteristic' - transportationInstructions: - description: |- - Instructions for safely transporting - batteries is describing a business requirement. - $ref: '#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_AttachmentLinkCharacteristic' - vehicleDismantlingProcedure: - description: Document containing the vehicle dismantling procedure is describing - a regulatory requirement. - $ref: '#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_AttachmentLinkCharacteristic' - batteryDismantlingProcedure: - description: Document containing the battery dismantling procedure is describing - a regulatory requirement. - $ref: '#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_AttachmentLinkCharacteristic' - safetyMeasures: - description: Safety measures document(s) is describing a regulatory requirement. - $ref: '#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_AttachmentLinkCharacteristic' - testReportsResults: - description: Results of test reports which prove that the battery fulfills - this regulation and its delegated regulations is describing a regulatory - requirement. - $ref: '#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_AttachmentLinkCharacteristic' - declarationOfConformity: - description: Declaration of conformity (CE) is describing a regulatory requirement. - $ref: '#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_AttachmentLinkCharacteristic' - responsibleSourcing: - description: Document/Certificates on organizations compliance to ethical - business practices - $ref: '#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_AttachmentLinkCharacteristic' - urn_bamm_io.catenax.shared.contact_information_1.0.0_WebsiteCharacteristic: - type: string - format: uri - description: Address of the website - urn_bamm_io.catenax.shared.contact_information_1.0.0_PhoneNumberTrait: - type: string - description: "Constraint to allow only numbers, whitespaces and an optional\ - \ leading + sign." - pattern: "^[+]?[0-9 ]+$" - urn_bamm_io.catenax.shared.contact_information_1.0.0_EMailTrait: - type: string - description: Regular expression for mail address as defined in W3C (see https://html.spec.whatwg.org/multipage/input.html#valid-e-mail-address) - pattern: "^[a-zA-Z0-9.!#$%&’*+\\/=?^_`{|}~-]+@[a-zA-Z0-9-]+(?:\\.[a-zA-Z0-9-]+)*$" - urn_bamm_io.catenax.shared.contact_information_1.0.0_ContactCharacteristic: - description: Characteristic describing information on how to contact an organization - type: object - properties: - website: - description: Website of the contact. - $ref: '#/components/schemas/urn_bamm_io.catenax.shared.contact_information_1.0.0_WebsiteCharacteristic' - phoneNumber: - description: Phone number with country and area code - $ref: '#/components/schemas/urn_bamm_io.catenax.shared.contact_information_1.0.0_PhoneNumberTrait' - email: - description: An email address - $ref: '#/components/schemas/urn_bamm_io.catenax.shared.contact_information_1.0.0_EMailTrait' - faxNumber: - description: Fax number with country and area code - $ref: '#/components/schemas/urn_bamm_io.catenax.shared.contact_information_1.0.0_PhoneNumberTrait' - urn_bamm_io.catenax.shared.address_characteristic_1.0.1_ThoroughfareTechnicalKeyCharacteristic: - type: string - description: Characteristic of the technical key of a thoroughfare - enum: - - STREET - - INDUSTRIAL_ZONE - - OTHER - - RIVER - - SQUARE - urn_bamm_io.catenax.shared.address_characteristic_1.0.1_Text: - type: string - description: "Describes a Property which contains plain text. This is intended\ - \ exclusively for human readable strings, not for identifiers, measurement\ - \ values, etc." - urn_bamm_io.catenax.shared.address_characteristic_1.0.1_ThoroughfareEntity: - description: "Characteristic for defining a thoroughfare which can consist of\ - \ a type (e.g. \"STREET\"), value (e.g. \"Bernstraße\") and number (e.g. \"\ - 45\"). Model follows the specification of BPDM." - type: object - properties: - technicalKey: - description: "Technical key of a thoroughfare. As specified by BPDM, this\ - \ can be a \"STREET\" or a different type." - $ref: '#/components/schemas/urn_bamm_io.catenax.shared.address_characteristic_1.0.1_ThoroughfareTechnicalKeyCharacteristic' - value: - description: "Value of a thoroughfare, e.g. name of a street." - $ref: '#/components/schemas/urn_bamm_io.catenax.shared.address_characteristic_1.0.1_Text' - number: - description: "Number of a thoroughfare. As used differently in international\ - \ context, this number can contain both numerical and alphanumerical values" - $ref: '#/components/schemas/urn_bamm_io.catenax.shared.address_characteristic_1.0.1_Text' - required: - - technicalKey - - value - - number - urn_bamm_io.catenax.shared.address_characteristic_1.0.1_LocalityTechnicalKeyCharacteristic: - type: string - description: Characteristic of the technical key of a locality - enum: - - BLOCK - - CITY - - DISTRICT - - OTHER - - POST_OFFICE_CITY - - QUARTER - urn_bamm_io.catenax.shared.address_characteristic_1.0.1_LocalityEntity: - description: Characteristic for defining a locality which belongs to an address - and which consists of a type (e.g. "CITY") and value (e.g. "Mannheim"). Model - follows the specification of BPDM. - type: object - properties: - technicalKey: - description: Technical key of a locality - $ref: '#/components/schemas/urn_bamm_io.catenax.shared.address_characteristic_1.0.1_LocalityTechnicalKeyCharacteristic' - value: - description: "Value of a locality, e.g. name of a city (\"Mannheim\")." - $ref: '#/components/schemas/urn_bamm_io.catenax.shared.address_characteristic_1.0.1_Text' - required: - - technicalKey - - value - urn_bamm_io.catenax.shared.address_characteristic_1.0.1_PremiseTechnicalKeyCharacteristic: - type: string - description: Characteristic of the technical key of a premise - enum: - - BUILDING - - HARBOUR - - LEVEL - - OTHER - - ROOM - - SUITE - - UNIT - - WAREHOUSE - urn_bamm_io.catenax.shared.address_characteristic_1.0.1_PremiseEntity: - description: Characteristic for defining a premise which consists of a technical - key (e.g. "BUILDING" or "OTHER") and a value (e.g. "Werk 1"). - type: object - properties: - technicalKey: - description: Technical key of a premise - $ref: '#/components/schemas/urn_bamm_io.catenax.shared.address_characteristic_1.0.1_PremiseTechnicalKeyCharacteristic' - value: - description: "Value of a premise, e.g. name or designation of a particular\ - \ site" - $ref: '#/components/schemas/urn_bamm_io.catenax.shared.address_characteristic_1.0.1_Text' - required: - - technicalKey - - value - urn_bamm_io.catenax.shared.address_characteristic_1.0.1_PostalDeliveryPointTechnicalKeyCharacteristic: - type: string - description: Characteristic of the technical key of a postal delivery point - enum: - - INTERURBAN_DELIVERY_POINT - - MAIL_STATION - - MAILBOX - - OTHER - - POST_OFFICE_BOX - urn_bamm_io.catenax.shared.address_characteristic_1.0.1_PostalDeliveryPointEntity: - description: Characteristic for defining a postal delivery point which consists - of a technical key (e.g. "MAILBOX" or "OTHER") and a value. Model follows - the specification of BPDM. - type: object - properties: - technicalKey: - description: Technical key of a postal delivery point - $ref: '#/components/schemas/urn_bamm_io.catenax.shared.address_characteristic_1.0.1_PostalDeliveryPointTechnicalKeyCharacteristic' - value: - description: "Value of a postal delivery point, e.g. designation of a gate" - $ref: '#/components/schemas/urn_bamm_io.catenax.shared.address_characteristic_1.0.1_Text' - required: - - technicalKey - - value - urn_bamm_io.catenax.shared.address_characteristic_1.0.1_CountryTrait: - type: string - description: Regular expression for designation of a short name of a country - as defined in ISO 3166-2 - pattern: "([A-Z]{2}-[A-Z0-9]{1,3}|)" - urn_bamm_io.catenax.shared.address_characteristic_1.0.1_CountryEntity: - description: Characteristic of a country belonging to an address - type: object - properties: - shortName: - $ref: '#/components/schemas/urn_bamm_io.catenax.shared.address_characteristic_1.0.1_CountryTrait' - required: - - shortName - urn_bamm_io.catenax.shared.address_characteristic_1.0.1_PostCodeTrait: - type: string - description: Regular expression for post codes - pattern: "^[a-z0-9][a-z0-9\\- ]{0,10}$" - urn_bamm_io.catenax.shared.address_characteristic_1.0.1_PostCodeTechnicalKeyCharacteristic: - type: string - description: Characteristic for the technical key of a post code - enum: - - CEDEX - - LARGE_MAIL_USER - - OTHER - - POST_BOX - - REGULAR - urn_bamm_io.catenax.shared.address_characteristic_1.0.1_PostCodeEntity: - description: Characteristic for defining a postcode which can consist of a type - (e.g. "REGULAR" for zip codes) and a value (e.g. "68161\12"). Model follows - the specification of BPDM. - type: object - properties: - value: - description: The value of a post code - $ref: '#/components/schemas/urn_bamm_io.catenax.shared.address_characteristic_1.0.1_PostCodeTrait' - technicalKey: - description: The technical key of a post code - $ref: '#/components/schemas/urn_bamm_io.catenax.shared.address_characteristic_1.0.1_PostCodeTechnicalKeyCharacteristic' - required: - - value - - technicalKey - urn_bamm_io.catenax.shared.address_characteristic_1.0.1_PostalAddress: - description: A characteristic to express the postal adress and which is intended - to be referenced by other aspects - type: object - properties: - thoroughfare: - description: Street or thorough road name - $ref: '#/components/schemas/urn_bamm_io.catenax.shared.address_characteristic_1.0.1_ThoroughfareEntity' - locality: - description: Locality belonging to an address - $ref: '#/components/schemas/urn_bamm_io.catenax.shared.address_characteristic_1.0.1_LocalityEntity' - premise: - description: "Premise of an address, e.g. a specific \"BUILDING\" but can\ - \ also be used for naming a particular site" - $ref: '#/components/schemas/urn_bamm_io.catenax.shared.address_characteristic_1.0.1_PremiseEntity' - postalDeliveryPoint: - description: "Delivery point, e.g. designation of a gate" - $ref: '#/components/schemas/urn_bamm_io.catenax.shared.address_characteristic_1.0.1_PostalDeliveryPointEntity' - country: - description: Country of an address - $ref: '#/components/schemas/urn_bamm_io.catenax.shared.address_characteristic_1.0.1_CountryEntity' - postCode: - $ref: '#/components/schemas/urn_bamm_io.catenax.shared.address_characteristic_1.0.1_PostCodeEntity' - required: - - thoroughfare - - locality - - country - - postCode - urn_bamm_io.catenax.battery.battery_pass_2.0.0_ManufacturerCharacteristic: - description: A manufacturer of goods - type: object - properties: - name: - description: Name of the manufacturer is describing a regulatory requirement. - $ref: '#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text' - contact: - description: Contact details of the manufacturer - $ref: '#/components/schemas/urn_bamm_io.catenax.shared.contact_information_1.0.0_ContactCharacteristic' - address: - description: An postal address - $ref: '#/components/schemas/urn_bamm_io.catenax.shared.address_characteristic_1.0.1_PostalAddress' - required: - - name - - contact - - address - urn_bamm_io.catenax.battery.battery_pass_2.0.0_PowerCharacteristic: - type: number - description: Power capability in Watts - urn_bamm_io.catenax.battery.battery_pass_2.0.0_PowerFadeCharacteristic: - type: number - description: The decrease over time and upon usage in the amount of power that - a battery can deliver at the rated voltage is describing a regulatory requirement. - urn_bamm_io.catenax.battery.battery_pass_2.0.0_KilowattCharacteristic: - type: number - description: A measurement for the power of the battery. - urn_bamm_io.catenax.battery.battery_pass_2.0.0_BatteryPowerCharacteristic: - description: Characterisitic to describe the power (W) properties of the batterie. - type: object - properties: - maximumAllowedBatteryPower: - description: Maximum allowed battery power (W) of the battery is describing - a business requirement. - $ref: '#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_PowerCharacteristic' - originalPower: - description: Original power capability in Watts is describing a regulatory - requirement. - $ref: '#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_PowerCharacteristic' - powerFade: - description: Maximum allowed battery power (W) of the battery is describing - a business requirement. - $ref: '#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_PowerFadeCharacteristic' - powerCapabilityAt20Charge: - description: Power (capability) at 20% state of charge. Description from - the Regulation is describing a regulatory requirement. - $ref: '#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_PowerCharacteristic' - powerCapabilityAt80Charge: - description: Power (capability) at 80% state of charge. Description from - the Regulation is describing a regulatory requirement. - $ref: '#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_PowerCharacteristic' - originalPowerCapability: - description: Performance ability of the high voltage battery i.e. the amount - of energy that a battery is capable to provide over a given period of - time is describing a regulatory requirement. - $ref: '#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_KilowattCharacteristic' - originalPowerCapabilityLimits: - description: Performance ability of the high voltage battery according to - limits i.e. how much power it can provide within given limits is describing - a regulatory requirement. - $ref: '#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_KilowattCharacteristic' - required: - - maximumAllowedBatteryPower - - originalPower - - powerFade - - powerCapabilityAt20Charge - - powerCapabilityAt80Charge - - originalPowerCapability - - originalPowerCapabilityLimits - urn_bamm_io.catenax.battery.battery_pass_2.0.0_VoltCharacteristic: - type: number - description: Value of the voltage the battery is rated for - urn_bamm_io.catenax.battery.battery_pass_2.0.0_BatteryVoltageCharacteristiC: - description: Characterisitic to describe the voltage (V) properties of the batterie. - type: object - properties: - minVoltage: - description: Value of the minimal voltage the battery is rated for is describing - a regulatory requirement. - $ref: '#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_VoltCharacteristic' - nominalVoltage: - description: Value of the nominal voltage the battery is rated for is describing - a regulatory requirement. - $ref: '#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_VoltCharacteristic' - maxVoltage: - description: Value of the maximum voltage the battery is rated for is describing - a regulatory requirement. - $ref: '#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_VoltCharacteristic' - required: - - minVoltage - - nominalVoltage - - maxVoltage - urn_bamm_io.catenax.battery.battery_pass_2.0.0_RatedCapacityCharacteristic: - type: number - description: The total number of ampere-hours (Ah) that can be withdrawn from - a fully charged battery under specific conditions is describing a regulatory - requirement. - urn_bamm_io.catenax.battery.battery_pass_2.0.0_CapacityFadeCharacteristic: - type: number - description: "The decrease over time and upon usage in the amount of charge\ - \ that a battery can deliver at the rated voltage, with respect to the original\ - \ rated capacity declared by the manufacturer is describing a regulatory requirement." - urn_bamm_io.catenax.battery.battery_pass_2.0.0_MilliohmCharacteristic: - type: number - description: The resistance offered by the cell in the flow of the current - urn_bamm_io.catenax.battery.battery_pass_2.0.0_OhmCharacterisitic: - type: number - description: Total internal resistance in a battery pack - urn_bamm_io.catenax.battery.battery_pass_2.0.0_PercentCharacteristic: - type: number - description: Increase in internal resistance of a battery pack over a period - of time - urn_bamm_io.catenax.battery.battery_pass_2.0.0_InternalResistanceCharacteristic: - description: Internal resistance in a battery cell or pack is describing a regulatory - requirement. - type: object - properties: - cellInternalResistance: - description: The resistance offered by the cell in the flow of the current - $ref: '#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_MilliohmCharacteristic' - packInternalResistance: - description: Total internal resistance in a battery pack is describing a - regulatory requirement. - $ref: '#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_OhmCharacterisitic' - packInternalResistanceIncrease: - description: Increase in internal resistance of a battery pack over a period - of time is describing a regulatory requirement. - $ref: '#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_PercentCharacteristic' - required: - - cellInternalResistance - - packInternalResistance - - packInternalResistanceIncrease - urn_bamm_io.catenax.battery.battery_pass_2.0.0_CapacityThresholdExhaustionCharacterisitic: - type: number - description: Capacity threshold for exhaustion as percentage value is describing - a regulatory requirement. - urn_bamm_io.catenax.battery.battery_pass_2.0.0_MaximumAllowedBatteryEnergyCharacteristic: - type: number - description: Characterisitic to describe the energy (Wh) properties of the battery - is describing a regulatory requirement. - urn_bamm_io.catenax.battery.battery_pass_2.0.0_EnergyRoundtripEfficiency: - type: number - description: Round-trip efficiency is the percentage of electricity put into - storage is describing a regulatory requirement. - urn_bamm_io.catenax.battery.battery_pass_2.0.0_EnergyRoundtripEfficiencyChangeCharacterisitic: - type: number - description: Round-trip efficiency is the percentage of electricity put into - storage after 50% of life of the battery is describing a regulatory requirement. - urn_bamm_io.catenax.battery.battery_pass_2.0.0_BatteryEnergyCharacterisitc: - description: Characterisitic to describe the energy (kWh) properties of the - batterie. - type: object - properties: - maximumAllowedBatteryEnergy: - description: Maximum allowed battery energy (Wh) of the battery is describing - a regulatory requirement. - $ref: '#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_MaximumAllowedBatteryEnergyCharacteristic' - energyRoundtripEfficiency: - description: Round-trip efficiency is the percentage of electricity put - into storage is describing a regulatory requirement. - $ref: '#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_EnergyRoundtripEfficiency' - energyRoundtripEfficiencyChange: - description: Round-trip efficiency is the percentage of electricity put - into storage is describing a regulatory requirement. - $ref: '#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_EnergyRoundtripEfficiencyChangeCharacterisitic' - required: - - maximumAllowedBatteryEnergy - - energyRoundtripEfficiency - - energyRoundtripEfficiencyChange - urn_bamm_io.catenax.battery.battery_pass_2.0.0_RatioMaximumAllowedBatteryPowerAndMaximumAllowedBatteryEnergyCharacterisitic: - type: number - description: Ratio between maximum allowed battery power (W) and battery energy - (Wh) is describing a regulatory requirement. - urn_bamm_io.catenax.battery.battery_pass_2.0.0_ElectrochemicalPropertiesCharacteristic: - description: Electrochemical characteristics to describe a battery - type: object - properties: - batteryPower: - description: Characterisitic to describe the power (W) properties of the - batterie. - $ref: '#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_BatteryPowerCharacteristic' - batteryVoltage: - description: Voltage (V) of the battery. - $ref: '#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_BatteryVoltageCharacteristiC' - ratedCapacity: - description: The total number of ampere-hours (Ah) that can be withdrawn - from a fully charged battery under specific conditions is describing a - regulatory requirement. - $ref: '#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_RatedCapacityCharacteristic' - capacityFade: - description: "The decrease over time and upon usage in the amount of charge\ - \ that a battery can deliver at the rated voltage, with respect to the\ - \ original rated capacity declared by the manufacturer is describing a\ - \ regulatory requirement." - $ref: '#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_CapacityFadeCharacteristic' - internalResistance: - description: Internal resistance in a battery cell or pack is describing - a regulatory requirement. - $ref: '#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_InternalResistanceCharacteristic' - capacityThresholdExhaustion: - description: Capacity threshold for exhaustion as percentage value is describing - a regulatory requirement. - $ref: '#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_CapacityThresholdExhaustionCharacterisitic' - batteryEnergy: - description: Characterisitic to describe the energy (kWh) properties of - the batterie. - $ref: '#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_BatteryEnergyCharacterisitc' - ratioMaximumAllowedBatteryPowerAndMaximumAllowedBatteryEnergy: - description: Ratio between maximum allowed battery power (W) and battery - energy (Wh) is describing a regulatory requirement. - $ref: '#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_RatioMaximumAllowedBatteryPowerAndMaximumAllowedBatteryEnergyCharacterisitic' - required: - - batteryPower - - batteryVoltage - - ratedCapacity - - capacityFade - - internalResistance - - capacityThresholdExhaustion - - batteryEnergy - - ratioMaximumAllowedBatteryPowerAndMaximumAllowedBatteryEnergy - urn_bamm_io.catenax.battery.battery_pass_2.0.0_MillimetreCharacteristic: - type: number - description: A measurment for the length/width/height of an item. - urn_bamm_io.catenax.battery.battery_pass_2.0.0_KilogramCharacteristic: - type: number - description: A measurement for the weight of an item. - urn_bamm_io.catenax.battery.battery_pass_2.0.0_PhysicalDimensionsCharacteristic: - description: Geometrical properties of the battery - type: object - properties: - length: - description: Length of the item is describing a business requirement. - $ref: '#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_MillimetreCharacteristic' - width: - description: Width of the item is describing a business requirement. - $ref: '#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_MillimetreCharacteristic' - height: - description: Height of the item is describing a business requirement. - $ref: '#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_MillimetreCharacteristic' - diameter: - description: Diameter of the item. - $ref: '#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_MillimetreCharacteristic' - weight: - description: Weight of the item is describing a regulatory requirement. - $ref: '#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_KilogramCharacteristic' - required: - - length - - width - - height - - diameter - - weight - urn_bamm_io.catenax.battery.battery_pass_2.0.0_StateOfHealthCharacteristic: - type: number - description: Evidence/Certificate of the health evaluation of a battery for - its use following repurposing or remanufacturing operations is describing - a business requirement. - urn_bamm_io.catenax.battery.battery_pass_2.0.0_StateOfChargeCharacteristic: - type: number - description: The value of the state of charge of the battery at the end of life - i.e. when entering recycling scheme is describing a business requirement. - urn_bamm_io.catenax.battery.battery_pass_2.0.0_StateOfBatteryCharacteristic: - description: The condition of the battery at the end of life i.e. when entering - recycling scheme - type: object - properties: - stateOfHealth: - description: Evidence/Certificate of the health evaluation of a battery - for its use following repurposing or remanufacturing operations is describing - a business requirement. - $ref: '#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_StateOfHealthCharacteristic' - stateOfCharge: - description: The value of the state of charge of the battery at the end - of life i.e. when entering recycling scheme is describing a business requirement. - $ref: '#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_StateOfChargeCharacteristic' - statusBattery: - description: Status of the battery is describing a regulatory requirement. - Value list provided by the regulators. - $ref: '#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text' - required: - - stateOfHealth - - stateOfCharge - - statusBattery - urn_bamm_io.catenax.battery.battery_pass_2.0.0_BatteryIdentificationCharacteristic: - description: Information to identify a specific battery. - type: object - properties: - batteryType: - description: Battery type as described by the contents of the battery e.g. - cell chemistry is describing a regulatory requirement. - $ref: '#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text' - batteryModel: - description: Battery type as described by the contents of the battery e.g. - cell chemistry is describing a regulatory requirement. - $ref: '#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text' - batteryIDDMCCode: - description: Digital Matrix Code (DMC) of the battery i.e. serial number - allowing for unequivocal identification of a battery is describing a regulatory - requirement. - $ref: '#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text' - required: - - batteryType - - batteryModel - - batteryIDDMCCode - urn_bamm_io.catenax.battery.battery_pass_2.0.0_Datestamp: - type: string - format: date - description: Describes a Property which contains the date and time with an optional - timezone. - urn_bamm_io.catenax.battery.battery_pass_2.0.0_ManufacturingCharacteristic: - description: Information about the manufacturing process of a battery - type: object - properties: - dateOfManufacturing: - description: Manufacturing date of the battery is describing a regulatory - requirement. - $ref: '#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_Datestamp' - address: - description: An postal address - $ref: '#/components/schemas/urn_bamm_io.catenax.shared.address_characteristic_1.0.1_PostalAddress' - required: - - dateOfManufacturing - - address - urn_bamm_io.catenax.battery.battery_pass_2.0.0_MatierialPercentageMassFractionCharacteristic: - type: number - description: Percentage mass fraction of a material - urn_bamm_io.catenax.battery.battery_pass_2.0.0_GramCharacteristic: - type: number - description: Weight of the material (in gram) - urn_bamm_io.catenax.battery.battery_pass_2.0.0_Text: - type: string - description: "Describes a Property which contains plain text. This is intended\ - \ exclusively for human readable strings, not for identifiers, measurement\ - \ values, etc." - urn_bamm_io.catenax.battery.battery_pass_2.0.0_MaterialNameAndWeightAndPercentageMassFractionEntity: - description: "Entity to bundle a material's name, weight and percentage of mass." - type: object - properties: - matierialPercentageMassFraction: - description: Percentage mass fraction of a material. - $ref: '#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_MatierialPercentageMassFractionCharacteristic' - matierialWeight: - description: Weight of the material (in gram) - $ref: '#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_GramCharacteristic' - materialName: - description: Name of the material - $ref: '#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_Text' - required: - - materialName - urn_bamm_io.catenax.battery.battery_pass_2.0.0_CathodeActiveMaterialsCharacterisitic: - description: "The total amount of valuable materials contained in CAM material:\ - \ Nickel, Cobalt, Lithium." - type: array - items: - $ref: '#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_MaterialNameAndWeightAndPercentageMassFractionEntity' - uniqueItems: true - urn_bamm_io.catenax.battery.battery_pass_2.0.0_RecyclateContentActiveMaterialsCharacteristic: - description: "List of recovered Recyclate Content in Active Material Recycled\ - \ is describing a regulatory requirement. The following materials have to\ - \ be reported on as a minimium: Cobalt, Lithium, Nickel, Lead" - type: array - items: - $ref: '#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_MaterialNameAndWeightAndPercentageMassFractionEntity' - uniqueItems: true - urn_bamm_io.catenax.battery.battery_pass_2.0.0_AnodeActiveMaterialsCharacteristic: - description: "The total amount of valuable materials contained in Anode: graphite" - type: array - items: - $ref: '#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_MaterialNameAndWeightAndPercentageMassFractionEntity' - uniqueItems: true - urn_bamm_io.catenax.battery.battery_pass_2.0.0_CathodeCompositionOtherCharacteristic: - description: The composition or materials contained in the Cathode is describing - a regulatory requirement. - type: array - items: - $ref: '#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_MaterialNameAndWeightAndPercentageMassFractionEntity' - uniqueItems: true - urn_bamm_io.catenax.battery.battery_pass_2.0.0_AnodeCompositionOtherCharacteristic: - description: The composition or materials contained in the anode is describing - a regulatory requirement. - type: array - items: - $ref: '#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_MaterialNameAndWeightAndPercentageMassFractionEntity' - uniqueItems: true - urn_bamm_io.catenax.battery.battery_pass_2.0.0_ElectrolyteCompositionCharacteristic: - description: List of materials contained in the electrolyte is describing a - regulatory requirement. - type: array - items: - $ref: '#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_MaterialNameAndWeightAndPercentageMassFractionEntity' - uniqueItems: true - urn_bamm_io.catenax.battery.battery_pass_2.0.0_CellChemistryCharacteristic: - description: Information about the the cell chemistry of a battery cell - type: object - properties: - cathodeActiveMaterials: - description: "The total amount of valuable materials contained in CAM material:\ - \ Nickel, Cobalt, Lithium." - $ref: '#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_CathodeActiveMaterialsCharacterisitic' - recyclateContentActiveMaterials: - description: "List of recovered Recyclate Content in Active Material Recycled\ - \ is describing a regulatory requirement. The following materials have\ - \ to be reported on as a minimium: Cobalt, Lithium, Nickel, Lead" - $ref: '#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_RecyclateContentActiveMaterialsCharacteristic' - anodeActiveMaterials: - description: "The total amount of valuable materials contained in Anode:\ - \ graphite" - $ref: '#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_AnodeActiveMaterialsCharacteristic' - cathodeCompositionOther: - description: The composition or materials contained in the Cathode is describing - a regulatory requirement. - $ref: '#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_CathodeCompositionOtherCharacteristic' - anodeCompositionOther: - description: The composition or materials contained in the anode is describing - a regulatory requirement. - $ref: '#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_AnodeCompositionOtherCharacteristic' - electrolyteComposition: - description: List of materials contained in the electrolyte is describing - a regulatory requirement. - $ref: '#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_ElectrolyteCompositionCharacteristic' - required: - - cathodeActiveMaterials - - recyclateContentActiveMaterials - - anodeActiveMaterials - - cathodeCompositionOther - - anodeCompositionOther - - electrolyteComposition - urn_bamm_io.catenax.battery.battery_pass_2.0.0_ComponentsSupplierEntity: - description: Entity encapsulating the details of a components supplier - type: object - properties: - address: - description: An postal address - $ref: '#/components/schemas/urn_bamm_io.catenax.shared.address_characteristic_1.0.1_PostalAddress' - contact: - description: Contact details of the manufacturer - $ref: '#/components/schemas/urn_bamm_io.catenax.shared.contact_information_1.0.0_ContactCharacteristic' - required: - - address - - contact - urn_bamm_io.catenax.battery.battery_pass_2.0.0_ComponentsSupplierCharacteristic: - description: Contact details of the suppliers of replacement parts / spare parts - is describing a regulatory requirement. - type: array - items: - $ref: '#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_ComponentsSupplierEntity' - uniqueItems: true - urn_bamm_io.catenax.battery.battery_pass_2.0.0_ComponentsCharacteristic: - description: Characteristics of the batterie's comoponents. - type: object - properties: - componentsSupplier: - description: |- - Contact details of the suppliers of replacement parts / spare parts is describing a regulatory requirement. Available fields should be like: - Name - Street - Number - ZIP Code - City - State - Country - Phone - Fax - Email - Website - $ref: '#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_ComponentsSupplierCharacteristic' - componentsPartNumber: - description: The unique serial numbers of the different parts of a battery - is describing a regulatory requirement. - $ref: '#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text' - required: - - componentsSupplier - - componentsPartNumber - urn_bamm_io.catenax.battery.battery_pass_2.0.0_CompositionOfBatteryCharacteristic: - description: Full composition of battery is describing a business requirement. - type: array - items: - $ref: '#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_MaterialNameAndWeightAndPercentageMassFractionEntity' - uniqueItems: true - urn_bamm_io.catenax.battery.battery_pass_2.0.0_CriticalRawMaterialsCharacteristic: - type: string - description: List of critical raw materials (CRM) as specified by EU in a battery - is describing a regulatory requirement. - urn_bamm_io.catenax.battery.battery_pass_2.0.0_CompositionCharacteristic: - description: Information about the composition of a battery and the combination - of materials is describing a business requirement. - type: object - properties: - components: - description: Properties of the batterie's comoponents. - $ref: '#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_ComponentsCharacteristic' - compositionOfBattery: - description: Full composition of battery is describing a business requirement. - $ref: '#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_CompositionOfBatteryCharacteristic' - criticalRawMaterials: - description: List of critical raw materials (CRM) as specified by EU in - a battery is describing a regulatory requirement. - $ref: '#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_CriticalRawMaterialsCharacteristic' - required: - - components - - compositionOfBattery - - criticalRawMaterials - urn_bamm_io.catenax.battery.battery_pass_2.0.0_CO2FootprintTotalCharacteristic: - type: number - description: "The total carbon footprint of the battery, calculated as kg of\ - \ carbon dioxide equivalent is describing a regulatory requirement." - urn_bamm_io.catenax.battery.battery_pass_2.0.0_TemperatureRangeCharacterisitic: - type: number - description: The lower range of temperature the battery can withstand when not - in use is describing a regulatory requirement. - urn_bamm_io.catenax.battery.battery_pass_2.0.0_TemperatureRangeIdleStateCharacterisitic: - description: The range of temperature the battery can withstand when not in - use is describing a regulatory requirement. - type: object - properties: - temperatureRangeIdleStateLowerLimit: - description: The lower range of temperature the battery can withstand when - not in use is describing a regulatory requirement. - $ref: '#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_TemperatureRangeCharacterisitic' - temperatureRangeIdleStateUpperLimit: - description: The upper range of temperature the battery can withstand when - not in use is describing a regulatory requirement. - $ref: '#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_TemperatureRangeCharacterisitic' - required: - - temperatureRangeIdleStateLowerLimit - - temperatureRangeIdleStateUpperLimit - urn_bamm_io.catenax.battery.battery_pass_2.0.0_WarrantyPeriodCharacterisitic: - type: number - minimum: 1 - description: Commercial warranty period of the battery is describing a regulatory - requirement. - urn_bamm_io.catenax.battery.battery_pass_2.0.0_CycleLifeTestCRateCharacterisitc: - type: number - description: C-rate of Relevant Cycle-life Test is describing a regulatory requirement. - urn_bamm_io.catenax.battery.battery_pass_2.0.0_CycleLifeTestDepthOfDischargeCharacteristic: - type: number - description: Depth of discharge in the cycle-life test is describing a regulatory - requirement. - urn_bamm_io.catenax.battery.battery_pass_2.0.0_ExpectedLifetime: - type: number - description: "Expected battery lifetime expressed in cycles, and reference test\ - \ used is describing a regulatory requirement." - urn_bamm_io.catenax.battery.battery_pass_2.0.0_BatteryCycleLifeCharacteristic: - description: Characterisitic describing the cycle life of a battery - type: object - properties: - cycleLifeTestCRate: - description: C-rate of Relevant Cycle-life Test is describing a regulatory - requirement. - $ref: '#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_CycleLifeTestCRateCharacterisitc' - cycleLifeTestDepthOfDischarge: - description: Depth of discharge in the cycle-life test is describing a regulatory - requirement. - $ref: '#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_CycleLifeTestDepthOfDischargeCharacteristic' - expectedLifetime: - description: "Expected battery lifetime expressed in cycles, and reference\ - \ test used is describing a regulatory requirement." - $ref: '#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_ExpectedLifetime' - required: - - cycleLifeTestCRate - - cycleLifeTestDepthOfDischarge - - expectedLifetime - BatteryPass: - description: The battery pass describes information collected during the lifecycle - of a battery - type: object - properties: - document: - description: Set of documents containing the description of battery components - $ref: '#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_DocumentCharacteristic' - manufacturer: - description: Legal entity which sells and invoices the battery - $ref: '#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_ManufacturerCharacteristic' - electrochemicalProperties: - description: Electrochemical properties of an electrochemical energy storage - $ref: '#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_ElectrochemicalPropertiesCharacteristic' - physicalDimensions: - description: Geometrical properties of the battery - $ref: '#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_PhysicalDimensionsCharacteristic' - stateOfBattery: - description: The condition of the battery at the end of life i.e. when entering - recycling scheme - $ref: '#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_StateOfBatteryCharacteristic' - batteryIdentification: - description: Information to identify a specific battery. - $ref: '#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_BatteryIdentificationCharacteristic' - manufacturing: - description: Information about the manufacturing process of a battery - $ref: '#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_ManufacturingCharacteristic' - datePlacedOnMarket: - description: Date on which vehicle is produced i.e. when battery is put - in the market or production date of the vehicle is describing a regulatory - requirement. - $ref: '#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_Datestamp' - cellChemistry: - description: Information about the cell chemistry of a battery cell - $ref: '#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_CellChemistryCharacteristic' - composition: - description: Information about the composition of a battery and the combination - of materials is describing a business requirement. - $ref: '#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_CompositionCharacteristic' - cO2FootprintTotal: - description: "The total carbon footprint of the battery, calculated as kg\ - \ of carbon dioxide equivalent is describing a regulatory requirement." - $ref: '#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_CO2FootprintTotalCharacteristic' - temperatureRangeIdleState: - description: The range of temperature the battery can withstand when not - in use is describing a regulatory requirement. - $ref: '#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_TemperatureRangeIdleStateCharacterisitic' - warrantyPeriod: - description: Commercial warranty period of the battery is describing a regulatory - requirement. - $ref: '#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_WarrantyPeriodCharacterisitic' - batteryCycleLife: - description: Property describing the cycle life of a battery - $ref: '#/components/schemas/urn_bamm_io.catenax.battery.battery_pass_2.0.0_BatteryCycleLifeCharacteristic' - required: - - manufacturer - - electrochemicalProperties - - physicalDimensions - - stateOfBattery - - batteryIdentification - - manufacturing - - datePlacedOnMarket - - cellChemistry - - composition - - cO2FootprintTotal - - temperatureRangeIdleState - - warrantyPeriod - - batteryCycleLife - 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' - BatteryPass: - content: - application/json: - schema: - $ref: '#/components/schemas/BatteryPass' - description: The request was successful. - requestBodies: - BatteryPass: - content: - application/json: - schema: - $ref: '#/components/schemas/BatteryPass' diff --git a/io.catenax.battery.battery_pass/2.0.0/metadata.json b/io.catenax.battery.battery_pass/2.0.0/metadata.json deleted file mode 100644 index 9e759dfb1..000000000 --- a/io.catenax.battery.battery_pass/2.0.0/metadata.json +++ /dev/null @@ -1 +0,0 @@ -{ "status" : "deprecate"} diff --git a/io.catenax.battery.battery_pass/6.0.0/BatteryPass.ttl b/io.catenax.battery.battery_pass/6.0.0/BatteryPass.ttl new file mode 100644 index 000000000..c214e9aea --- /dev/null +++ b/io.catenax.battery.battery_pass/6.0.0/BatteryPass.ttl @@ -0,0 +1,1142 @@ +####################################################################### +# Copyright (c) 2022-2024 BASF SE +# Copyright (c) 2022-2024 BMW AG +# Copyright (c) 2024-2024 CGI Deutschland B.V. & Co. KG +# Copyright (c) 2022-2024 Henkel AG & Co. KGaA +# Copyright (c) 2022-2023 Robert Bosch GmbH +# Copyright (c) 2022-2024 SAP SE +# Copyright (c) 2022-2024 T-Systems International GmbH +# Copyright (c) 2022-2024 ZF Friedrichshafen AG +# Copyright (c) 2022-2024 Contributors to the Eclipse Foundation +# +# 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-passport: . + +:BatteryPass a samm:Aspect ; + samm:preferredName "Battery Passport"@en ; + samm:description "The battery pass describes information collected during the lifecycle of a battery. The battery passport is heavily based on the Regulation (EU) 2023/1542 of the European Parliament and of the Council of 12 July 2023 concerning batteries and waste batteries, amending Directive 2008/98/EC and Regulation (EU) 2019/1020 and repealing Directive 2006/66/EC.\nAdditionally attributes come from the Proposal for Ecodesign for Sustainable Products Regulation."@en ; + samm:see ; + samm:see ; + samm:properties ( :identification :operation :characteristics :sustainability :materials :performance :conformity :safety [ samm:property :sources; samm:optional true ] ext-passport:metadata ext-passport:commercial ext-passport:handling ) ; + samm:operations ( ) ; + samm:events ( ) . + +:identification a samm:Property ; + samm:preferredName "Identification"@en ; + samm:description "Battery identification involves specific battery identifiers, including those assigned locally by the manufacturer. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1)(a) refers to AnnexVi PartA (2) refers to Article 38 (6):\nbattery batch number or serial number or product number or another element allowing their identification."@en ; + samm:characteristic :IdentificationCharacteristic . + +:operation a samm:Property ; + samm:preferredName "Operation"@en ; + samm:description "General operation information includes details such as the manufacturer's identification and the date of production. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1) (a) and refers to ANNEX VI Part A which refers to Article 38:\n7. Manufacturers shall indicate on the battery their name, registered trade name or registered trade mark, their postal address, indicating a single contact point, and, if available, web and e-mail address. \nFrom Annex XIII (1) (a) and found in ANNEX VI Part A :\n3. the place of manufacture (geographical location of a battery manufacturing plant).\n4. the date of manufacture (month and year)."@en ; + samm:characteristic :OperationCharacteristic . + +:characteristics a samm:Property ; + samm:preferredName "Characteristics"@en ; + samm:description "Characteristics of the battery, such as the warranty and the physical dimensions."@en ; + samm:characteristic :CharacteristicsElement . + +:sustainability a samm:Property ; + samm:preferredName "Sustainability"@en ; + samm:description "Sustainability includes information on the carbon footprint, sustainability documents and the status of the battery."@en ; + samm:characteristic :SustainabilityCharacteristic . + +:materials a samm:Property ; + samm:preferredName "Materials"@en ; + samm:description "Chemical materials relevant for the composition of the battery. These include active, hazardous and critical materials."@en ; + samm:characteristic :ChemicalMaterialCharacteristic . + +:performance a samm:Property ; + samm:preferredName "Performance"@en ; + samm:description "Performance attributes of the battery including rated and dynamic values."@en ; + samm:characteristic :PerformanceCharacteristic . + +:conformity a samm:Property ; + samm:preferredName "Conformity"@en ; + samm:description "Conformity documents for the battery passport."@en ; + samm:characteristic :ConformityCharacteristic . + +:safety a samm:Property ; + samm:preferredName "Safety"@en ; + samm:description "Safety information on the battery. Included are the attributes safety measurements, meaning of labels, safe discharging and dismantling. These are all documents. Additionally information about usable extinguish agent can be provided."@en ; + samm:characteristic :SafetyCharacteristic . + +:sources a samm:Property ; + samm:preferredName "Sources"@en ; + samm:description "Consider additional available sources to enhance the content of the battery passport."@en ; + samm:characteristic ext-passport:SourceList . + +:IdentificationCharacteristic a samm:Characteristic ; + samm:preferredName "Identification Characteristic"@en ; + samm:description "Battery identification involves specific battery identifiers, including those assigned locally by the manufacturer."@en ; + samm:dataType :IdentificationEntity . + +:OperationCharacteristic a samm:Characteristic ; + samm:preferredName "Operation Characteristic"@en ; + samm:description "Characteristic includes details for operational data."@en ; + samm:dataType :OperationEntity . + +:CharacteristicsElement a samm:Characteristic ; + samm:preferredName "Characteristics ELement"@en ; + samm:description "Characteristic for the product characteristics."@en ; + samm:dataType :CharacteristicsEntity . + +:SustainabilityCharacteristic a samm:Characteristic ; + samm:preferredName "Sustainability Characteristic"@en ; + samm:description "Characteristic for sustainability attributes."@en ; + samm:dataType :SustainabilityEntity . + +:ChemicalMaterialCharacteristic a samm:Characteristic ; + samm:preferredName "Chemical Material Characteristic"@en ; + samm:description "Chemical Material Characteristic for the battery."@en ; + samm:dataType :ChemicalMaterialEntity . + +:PerformanceCharacteristic a samm:Characteristic ; + samm:preferredName "Performance Characteristic"@en ; + samm:description "Performance Characteristic for the battery."@en ; + samm:dataType :PerformanceEntity . + +:ConformityCharacteristic a samm:Characteristic ; + samm:preferredName "Conformity Characteristic"@en ; + samm:description "Characteristic for conformity documents."@en ; + samm:dataType :ConformityEntity . + +:SafetyCharacteristic a samm:Characteristic ; + samm:preferredName "Safety Characteristic"@en ; + samm:description "Safety Characteristic for mostly safety documents."@en ; + samm:dataType :SafetyEntity . + +:IdentificationEntity a samm:Entity ; + samm:preferredName "Identification Entity"@en ; + samm:description "Entity for the identification of the battery."@en ; + samm:properties ( [ samm:property :batteryCategory; samm:payloadName "category" ] :idDmc [ samm:property :batteryChemistry; samm:payloadName "chemistry" ] ext-passport:identification ) . + +:OperationEntity a samm:Entity ; + samm:preferredName "Operation Entity"@en ; + samm:description "Entity which includes details such as the manufacturer's identification and the date of production. The date of the putting into service is optional."@en ; + samm:properties ( [ samm:property :intoServiceDate; samm:optional true ] ext-passport:manufacturer ) . + +:CharacteristicsEntity a samm:Entity ; + samm:preferredName "Characteristics Entity"@en ; + samm:description "Entity for the product characteristics."@en ; + samm:properties ( :warranty :physicalDimension ) . + +:SustainabilityEntity a samm:Entity ; + samm:preferredName "Sustainability Entity"@en ; + samm:description "Entity which includes information on the carbon footprint, sustainability documents and the status of the battery."@en ; + samm:properties ( [ samm:property :sustainabilityDocuments; samm:payloadName "documents" ] :carbonFootprint [ samm:property ext-passport:state; samm:payloadName "status" ] ) . + +:ChemicalMaterialEntity a samm:Entity ; + samm:preferredName "Chemical Material Entity"@en ; + samm:description "Chemical Material Entity for the battery. Included are active, hazardous and critical materials as well as a material symbol. This is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Article 13:\n5. All batteries containing more than 0,002 % cadmium or more than 0,004 % lead, shall be marked with the chemical symbol for the metal concerned: Cd or Pb."@en ; + samm:properties ( [ samm:property :activeMaterials; samm:payloadName "active" ] [ samm:property :hazardousSubstance; samm:payloadName "hazardous" ] [ samm:property :materialComposition; samm:payloadName "composition" ] ) . + +:PerformanceEntity a samm:Entity ; + samm:preferredName "Performance Entity"@en ; + samm:description "Performance Entity with attributes of the battery including rated and dynamic values."@en ; + samm:properties ( [ samm:property :ratedPerformance; samm:payloadName "rated" ] [ samm:property :dynamicPerformance; samm:payloadName "dynamic" ] ) . + +:ConformityEntity a samm:Entity ; + samm:preferredName "Conformity Entity"@en ; + samm:description "Entity for conformity documents."@en ; + samm:properties ( [ samm:property :declarationOfConformityId; samm:optional true ] :declarationOfConformity :resultOfTestReport :thirdPartyAssurance :dueDiligencePolicy ) . + +:SafetyEntity a samm:Entity ; + samm:preferredName "Safety Entity"@en ; + samm:description "Entity with the attributes safety measurements, meaning of labels, safe discharging and dismantling. These are all documents. Additionally information about usable extinguish agent can be provided."@en ; + samm:properties ( :usableExtinguishAgent :safetyMeasures :meaningOfLabels [ samm:property :safeDischarging; samm:optional true ] :dismantling [ samm:property :removalFromAppliance; samm:optional true ] ) . + +:batteryCategory a samm:Property ; + samm:preferredName "Battery Category"@en ; + samm:description "The battery category, which can be a portable battery; starting, lighting and ignition battery (SLI); light means of transport battery (LMT); electric vehicle battery (EV), industrial battery and incorporated battery. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1) (a) and refers to ANNEX VI Part A:\n2. the battery category and information identifying the battery in accordance with Article 38(6)."@en ; + samm:characteristic :CategoryEnumeration ; + samm:exampleValue "EV" . + +:idDmc a samm:Property ; + samm:preferredName "Id DMC"@en ; + samm:description "The unique identifier of the product, when it is placed on the market. Through this identifier a web link can be accessed. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Article 77:\n3. The battery passport shall be accessible through the QR code referred to in Article 13(6) which links to a unique identifier that the economic operator placing the battery on the market shall attribute to it. The QR code and the unique identifier shall comply with the ISO/IEC standards 15459-1:2014, 15459-2:2015, 15459-3:2014, 15459-4:2014, 15459-5:2014 and 15459-6:2014 or their equivalent.\nDefined is the QR code in Article 3:\n(24) \"QR code\" means a machine-readable matrix code that links to information as required by this Regulation.\n(66) \"unique identifier\" means a unique string of characters for the identification of batteries that also enables a web link to the battery passport."@en ; + samm:characteristic ext-passport:IdentifierCharacteristic ; + samm:exampleValue "34567890" . + +:batteryChemistry a samm:Property ; + samm:preferredName "Battery Chemistry"@en ; + samm:description "Battery chemistry refers to the specific chemical composition and reactions that occur within a battery to produce and store electrical energy. The chemistry has to be stated as detailed as possible for example: the Nickel Cobalt Manganese battery 'NCM'. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1) (a) and refers to ANNEX VI Part A:\n7. the chemestry."@en ; + samm:characteristic samm-c:Text ; + samm:exampleValue "Nickel Cobalt Manganese (NCM)". + +:intoServiceDate a samm:Property ; + samm:preferredName "Into Service Date"@en ; + samm:description "Putting into service is the transition from a state of readiness to actual use or operation. The date should be formatted as yyyy-mm-dd. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex VII Part B: \n1.the date of manufacture of the battery and, where appropriate, the date of putting into service;\nDefined is \"putting into service\" in Article 3:\n(18) \"putting into service\" means the first use, for its intended purpose, in the Union, of a battery, without having been previously placed on the market."@en ; + samm:characteristic ext-passport:DateTrait . + +:warranty a samm:Property ; + samm:preferredName "Warranty"@en ; + samm:description "The warranty of the battery. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in ANNEX XIII:\n(m) period for which the commercial warranty for the calendar life applies."@en ; + samm:characteristic :WarrantyCharacteristic . + +:physicalDimension a samm:Property ; + samm:preferredName "Physical Dimension"@en ; + samm:description "The weight of the battery. For calculation of the energy density, the volume is also needed. The energy density of a battery is measured in watt-hours per kilogram (Wh/kg) and watt-hours per liter (Wh/L). These measures indicate how much energy a battery can store relative to its weight and volume, respectively. Other measurements are optional.These are mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1)(a) and refers to Annex VI Part A:\n5. the weight."@en ; + samm:characteristic :PhysicalDimensionCharacteristic . + +:sustainabilityDocuments a samm:Property ; + samm:preferredName "sustainability Documents"@en ; + samm:description "Sustainability documents of the battery."@en ; + samm:characteristic :SustainabilityDocumentCharacteristic . + +:carbonFootprint a samm:Property ; + samm:preferredName "Carbon Footprint"@en ; + samm:description "The carbon footprint of the battery calculated as kg of carbon dioxide equivalent per one kWh of the total energy provided by the battery over its expected service life. Relevant attributes are the value, the unit, the referenced rulebook, the lifecycle where applied, the declaration, the performance class, the type (PCF), the declaration and the facility. These attributes are mentioned in the Battery regulation 2023/1542 from 12 July 2023 in several places.\nAnnex XIII (1) (c) refers to Article 7 (2) which refers to Article 7 (1)(d):\n1. For electric vehicle batteries, rechargeable industrial batteries with a capacity greater than 2 kWh and LMT batteries a carbon footprint declaration shall be drawn up for each battery model per manufacturing plant, in accordance with the implementing act referred to in the fourth subparagraph and containing, at least, the following information:\n[...] (d) the carbon footprint of the battery, calculated as kg of carbon dioxide equivalent per one kWh of the total energy provided by the battery over its expected service life;\nAnd as well in Article 7:\n2. Electric vehicle batteries, rechargeable industrial batteries with a capacity greater than 2 kWh and LMT batteries shall bear a conspicuous, clearly legible and indelible label indicating the carbon footprint of the battery referred to in paragraph 1, first subparagraph, point (d) and declaring the carbon footprint performance class to which the relevant battery model per manufacturing plant corresponds.\nFurther specified in Annex XIII (1) (c) and refers to Article 7 (1):\n[...] The Commission shall, by 18 February 2024 for electric vehicle batteries, 18 February 2025 for rechargeable industrial batteries, except those with external storage, 18 February 2027 for LMT batteries and 18 February 2029 for industrial batteries with external storage, adopt:\n(a) a delegated act in accordance with Article 89 to supplement this Regulation by establishing the methodology for the calculation and verification of the carbon footprint of the battery referred to in the first subparagraph, point (d), in accordance with the essential elements set out in Annex II;\nThese parameters are defined by Article 3:\n(21) \"carbon footprint\" means the sum of greenhouse gas emissions and greenhouse gas removals in a product system, expressed as carbon dioxide equivalents and based on a Product Environmental Footprint (PEF) study using the single impact category of climate change;\nand defined by Annex II (2):\n(e) \"life cycle\" means the consecutive and interlinked stages of a product system, from raw material acquisition or generation from natural resources to final disposal (ISO 14040:2006 or an equivalent standard)."@en ; + samm:characteristic ext-passport:FootprintList . + +:activeMaterials a samm:Property ; + samm:preferredName "Active Materials"@en ; + samm:description "The active materials included in the battery. Mandatory are nickel, lithium, cobalt and lead. Others are optional. Defined by the Battery regulation 2023/1542 from 12 July 2023 in Article 3 Definitions:\n(5) ‘active material’ means a material which reacts chemically to produce electric energy when the battery cell discharges or to store electric energy when the battery is being charged."@en ; + samm:characteristic :ActiveMaterialsCharacteristic . + +:hazardousSubstance a samm:Property ; + samm:preferredName "Hazardous Substance"@en ; + samm:description "Hazardous substances like lead, cadmium and mercury."@en ; + samm:characteristic :HazardousSubstanceCharacteristic . + +:materialComposition a samm:Property ; + samm:preferredName "Material Composition"@en ; + samm:description "The materials which are necessary to describe the material composition, especially if they are active, critical or hazardous. This can be redundant to the specifically mentioned active or hazardous materials. This is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1):\n(b) the material composition of the battery, including its chemistry, hazardous substances present in the battery, other than mercury, cadmium or lead, and critical raw materials present in the battery; \n(f) the share of renewable content.\nand in Annex XIII (2):\n(a) detailed composition, including materials used in the cathode, anode and electrolyte;\nDefinition from Article 3:\n(52) \"hazardous substance\" means a substance classified as hazardous pursuant to Article 3 of Regulation (EC) No 1272/2008:\nA substance or a mixture fulfilling the criteria relating to physical hazards, health hazards or environmental hazards, laid down in Parts 2 to 5 of Annex I is hazardous and shall be classified in relation to the respective hazard classes provided for in that Annex.\nWhere, in Annex I, hazard classes are differentiated on the basis of the route of exposure or the nature of the effects, the substance or mixture shall be classified in accordance with such differentiation.\nDefined in Article 2 of Regulation (EC) No 1272/2008:\n1. hazard class\" means the nature of the physical, health or environmental hazard."@en ; + samm:characteristic :MaterialCompositionList . + +:ratedPerformance a samm:Property ; + samm:preferredName "Rated Performance"@en ; + samm:description "Rated performance values of the battery such as voltage, round trip efficiency, energy, resistance, power, capacity, temperature ranges and self-discharging rate."@en ; + samm:characteristic :RatedPerformanceCharacteristic . + +:dynamicPerformance a samm:Property ; + samm:preferredName "Dynamic Performance"@en ; + samm:description "Dynamic performance values of the battery."@en ; + samm:characteristic :DynamicPerformanceCharacteristic . + +:declarationOfConformityId a samm:Property ; + samm:preferredName "Declaration of Conformity Id"@en ; + samm:description "Identification number of the EU declaration of conformity. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1):\n(r) the EU declaration of conformity referred to in Article 18."@en ; + samm:characteristic ext-passport:IdentifierCharacteristic ; + samm:exampleValue "0978234-34567890-01" . + +:declarationOfConformity a samm:Property ; + samm:preferredName "Declaration of Conformity"@en ; + samm:description "The EU Declaration of Conformity is a document in which the manufacturer or their authorized representative declares that the battery complies with all relevant European Union product safety directives and regulations. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1):\n(r) the EU declaration of conformity referred to in Article 18."@en ; + samm:characteristic ext-passport:DocumentList . + +:resultOfTestReport a samm:Property ; + samm:preferredName "Result of Test Report"@en ; + samm:description "The result of tests reports refers to the results of various tests conducted with the battery, testing its life cycle, life span, c-rate and various other aspects. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1):\n(l) temperature range the battery can withstand when not in use (reference test);\nand Annex XIII (3):\nresults of test reports proving compliance with the requirements laid down in this Regulation or any delegated or implementing act adopted pursuant to this Regulation."@en ; + samm:characteristic ext-passport:DocumentList . + +:thirdPartyAssurance a samm:Property ; + samm:preferredName "Third Party Assurance"@en ; + samm:description "A summary report from third-parties, covering the verifications. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1) (d) refers to the Article 52:\n3. The economic operator referred to in Article 48(1) shall on an annual basis review and make publicly available, including on the internet, a report on its battery due diligence policy. [...], as well as a summary report of the third-party verifications carried out in accordance with Article 51, including the name of the notified body, with due regard for business confidentiality and other competitive concerns. That report shall also cover, where relevant, access to information, public participation in decision-making and access to justice in environmental matters in relation to the sourcing, processing and trading of the raw materials present in batteries."@en ; + samm:characteristic ext-passport:DocumentList . + +:dueDiligencePolicy a samm:Property ; + samm:preferredName "Due Diligence Policy"@en ; + samm:description "A report containing the information concerning the due diligence policy, a set of procedures and guidelines the organization follows to thoroughly assess and evaluate the various aspects of the battery. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1) (d) refers to the Article 52:\n3. The economic operator referred to in Article 48(1) shall on an annual basis review and make publicly available, including on the internet, a report on its battery due diligence policy. That report shall contain, in a manner that is easily comprehensible for end-users and clearly identifies the batteries concerned, the data and information on steps taken by that economic operator to comply with the requirements laid down in Articles 49 and 50, including findings of significant adverse impacts in the risk categories listed in point 2 of Annex X, and how they have been addressed, as well as a summary report of the third-party verifications carried out in accordance with Article 51, including the name of the notified body, with due regard for business confidentiality and other competitive concerns. That report shall also cover, where relevant, access to information, public participation in decision-making and access to justice in environmental matters in relation to the sourcing, processing and trading of the raw materials present in batteries."@en ; + samm:characteristic ext-passport:DocumentList . + +:usableExtinguishAgent a samm:Property ; + samm:preferredName "Usable Extinguish Agent"@en ; + samm:description "The usable extinguish agents for the battery in case of a fire. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1)(a) and refers to Annex VI Part A\n9. usable extinguishing agent."@en ; + samm:characteristic :ExtinguishAgentList . + +:safetyMeasures a samm:Property ; + samm:preferredName "Safety Measures"@en ; + samm:description "Safety instruction in the form of a documentation. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (2):\n(d) safety measures."@en ; + samm:characteristic ext-passport:DocumentList . + +:meaningOfLabels a samm:Property ; + samm:preferredName "Meaning of Labels"@en ; + samm:description "Documentation on the meaning of labels on a battery which provide information to help users understand the various symbols, markings, and information present on the battery's label. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1)(s) and refers to Article 74 (1):\n(e) the meaning of the labels and symbols on batteries in accordance with Article 13 or printed on their packaging or in the documents accompanying batteries [...]."@en ; + samm:characteristic ext-passport:DocumentList . + +:safeDischarging a samm:Property ; + samm:preferredName "Safe Discharging"@en ; + samm:description "Safe discharging documentation explaining for example the setting of a minimum voltage threshold for the battery. Discharging a battery below this threshold can lead to damage, reduced capacity, and safety hazards."@en ; + samm:characteristic ext-passport:DocumentList . + +:dismantling a samm:Property ; + samm:preferredName "Dismantling"@en ; + samm:description "Dismantling refers to the proper way of dismantling the battery itself. It refers to the process of taking apart the battery for various purposes, such as recycling, disposal, or examination of its components. This attribute is mentioned in the Battery Regulation 2023/1542 from 12 July 2023 in Annex XIII (2) (c) dismantling information, including at least:\n- exploded diagrams of the battery system/pack showing the location of battery cells,\n- disassembly sequences,\n- type and number of fastening techniques to be unlocked,\n- tools required for disassembly,\n- warnings if risk of damaging parts exist,\n- amount of cells used and layout."@en ; + samm:characteristic ext-passport:DocumentList . + +:removalFromAppliance a samm:Property ; + samm:preferredName "Removal From Appliance"@en ; + samm:description "Removal refers to the proper process of disassembling a battery from an appliance, typically for purposes such as repairs, replacements, or disposal."@en ; + samm:characteristic ext-passport:DocumentList . + +:CategoryEnumeration a samm-c:Enumeration ; + samm:preferredName "Category Enumeration"@en ; + samm:description "Enumeration with the values, portable battery; starting, lighting and ignition battery (SLI); light means of transport battery (LMT); electric vehicle battery (EV), industrial battery and incorporated battery."@en ; + samm:dataType xsd:string ; + samm-c:values ( "SLI" "LMT" "EV" "industrial" "portable" "incorporated" ) . + +:WarrantyCharacteristic a samm:Characteristic ; + samm:preferredName "Warranty Characteristic"@en ; + samm:description "Characteristic for the warranty."@en ; + samm:dataType :WarrantyEntity . + +:PhysicalDimensionCharacteristic a samm:Characteristic ; + samm:preferredName "Physical Dimension Characteristic"@en ; + samm:description "Characteristic for the physical dimensions."@en ; + samm:dataType :PhysicalDimensionEntity . + +:SustainabilityDocumentCharacteristic a samm:Characteristic ; + samm:preferredName "Sustainability Document Characteristic"@en ; + samm:description "Characteristic for sustainability documents of the battery."@en ; + samm:dataType :SustainabilityDocumentEntity . + +:ActiveMaterialsCharacteristic a samm:Characteristic ; + samm:preferredName "Active Materials Characteristic"@en ; + samm:description "Characteristic for the active materials."@en ; + samm:dataType :ActiveMaterialEntity . + +:HazardousSubstanceCharacteristic a samm:Characteristic ; + samm:preferredName "Hazardous Substance Characteristic"@en ; + samm:description "Hazardous Substance Characteristic for the battery chemical materials."@en ; + samm:dataType :HazardousSubstanceEntity . + +:MaterialCompositionList a samm-c:List ; + samm:preferredName "Material Composition List"@en ; + samm:description "List for the material composition."@en ; + samm:dataType :MaterialCompositionEntity . + +:RatedPerformanceCharacteristic a samm:Characteristic ; + samm:preferredName "Rated Performance Characteristic"@en ; + samm:description "Characteristic for rated performance values of the battery."@en ; + samm:dataType :RatedPerformanceEntity . + +:DynamicPerformanceCharacteristic a samm:Characteristic ; + samm:preferredName "Dynamic Performance Characteristic"@en ; + samm:description "Characteristic for dynamic performance values of the battery."@en ; + samm:dataType :DynamicPerformanceEntity . + +:ExtinguishAgentList a samm-c:List ; + samm:preferredName "Extinguish Agent List"@en ; + samm:description "List of extinguish agents."@en ; + samm:dataType :ExtinguishAgentEntity . + +:WarrantyEntity a samm:Entity ; + samm:preferredName "Warranty Entity"@en ; + samm:description "Entity for the warranty with a value and unit."@en ; + samm:properties ( ext-passport:lifeValue ext-passport:lifeUnit ) . + +:PhysicalDimensionEntity a samm:Entity ; + samm:preferredName "Physical Dimension Entity"@en ; + samm:description "Entity for the physical dimension with weight, volume and other optional values."@en ; + samm:properties ( [ samm:property ext-passport:height; samm:optional true ] [ samm:property ext-passport:length; samm:optional true ] [ samm:property ext-passport:width; samm:optional true ] ext-passport:weight ) . + +:SustainabilityDocumentEntity a samm:Entity ; + samm:preferredName "Sustainability Document Entity"@en ; + samm:description "Sustainability Document Entity which encapsulates relevant information in the form of documents."@en ; + samm:properties ( :separateCollection :wastePrevention [ samm:property :euTaxonomyDisclosureStatement; samm:optional true ] [ samm:property :sustainabilityReport; samm:optional true ] ) . + +:ActiveMaterialEntity a samm:Entity ; + samm:preferredName "Active Material Entity"@en ; + samm:description "Entity for the active materials included in the battery. Mandatory are nickel, lithium, cobalt and lead."@en ; + samm:properties ( :nickel :lithium :cobalt :lead [ samm:property :otherActiveMaterials; samm:optional true; samm:payloadName "other" ] ) . + +:HazardousSubstanceEntity a samm:Entity ; + samm:preferredName "Hazardous Substance Entity"@en ; + samm:description "Hazardous Substance Entity for hazardous chemical materials."@en ; + samm:properties ( [ samm:property :hazardousCadmium; samm:payloadName "cadmium" ] [ samm:property :hazardousMercury; samm:payloadName "mercury" ] [ samm:property :otherHazardousMaterial; samm:optional true; samm:payloadName "other" ] :lead ) . + +:MaterialCompositionEntity a samm:Entity ; + samm:preferredName "Material Composition Entity"@en ; + samm:description "Entity for the material composition."@en ; + samm:properties ( [ samm:property ext-passport:materialIdentification; samm:payloadName "id" ] ext-passport:concentration [ samm:property ext-passport:materialUnit; samm:payloadName "unit" ] ext-passport:critical ext-passport:documentation ext-passport:recycled ext-passport:location ext-passport:renewable ) . + +:RatedPerformanceEntity a samm:Entity ; + samm:preferredName "Rated Performance Entity"@en ; + samm:description "Entity for rated performance values of the battery."@en ; + samm:properties ( :voltage [ samm:property :ratedRoundTripEfficiency; samm:payloadName "roundTripEfficiency" ] [ samm:property :ratedEnergy; samm:optional true; samm:payloadName "energy" ] [ samm:property :ratedResistance; samm:payloadName "resistance" ] [ samm:property :ratedPower; samm:payloadName "power" ] [ samm:property :ratedCapacity; samm:payloadName "capacity" ] [ samm:property :performanceDocument; samm:optional true ] [ samm:property :performanceTemperature; samm:payloadName "temperature" ] :selfDischargingRate [ samm:property :testReport; samm:optional true ] :lifetime ) . + +:DynamicPerformanceEntity a samm:Entity ; + samm:preferredName "Dynamic Performance Entity"@en ; + samm:description "Entity for dynamic performance values of the battery."@en ; + samm:properties ( :stateOfCharge :fullCycles [ samm:property :performanceDocument; samm:optional true ] :selfDischargingRate [ samm:property :dynamicPower; samm:payloadName "power" ] [ samm:property :dynamicCapacity; samm:payloadName "capacity" ] [ samm:property :dynamicRoundTripEfficiency; samm:payloadName "roundTripEfficiency" ] [ samm:property :dynamicInternalResistance; samm:payloadName "resistance" ] [ samm:property :dynamicEnergy; samm:payloadName "energy" ] [ samm:property :negativeEvents; samm:optional true ] [ samm:property :operatingEnvironment; samm:optional true ] ) . + +:ExtinguishAgentEntity a samm:Entity ; + samm:preferredName "Extinguish Agent Entity"@en ; + samm:description "Entity for the extinguish agents."@en ; + samm:properties ( [ samm:property :agentDocument; samm:optional true; samm:payloadName "document" ] [ samm:property :usableExtinguishingMedia; samm:payloadName "media" ] :fireClass ) . + +:separateCollection a samm:Property ; + samm:preferredName "Separate Collection"@en ; + samm:description "Documentation about separate collection of batteries involve information on how to properly collect, handle, and recycle batteries to ensure environmental sustainability and compliance with regulations. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1) (s), refers to Article 74:\n1. In addition to the information referred to in Article 8a(2) of Directive 2008/98/EC, producers or, where appointed in accordance with Article 57(1), producer responsibility organisations shall make available to end-users and distributors the following information regarding the prevention and management of waste batteries with regard to the categories of batteries that they supply within the territory of a Member State:\n(a) the role of end-users in contributing to waste prevention, including by information on good practices and recommendations concerning the use of batteries aimed at extending their use phase and the possibilities of re-use, preparation for re-use, preparation for repurposing, repurposing and remanufacturing;\n(b) the role of end-users in contributing to the separate collection of waste batteries in accordance with their obligations under Article 64 to allow their treatment;\n(c) the separate collection, take-back and collection points, preparation for re-use, preparation for repurposing and treatment available for waste batteries;\n(d) the necessary safety instructions to handle waste batteries, including in relation to the risks associated with, and the handling of, batteries containing lithium;\n(e) the meaning of the labels and symbols on batteries in accordance with Article 13 or printed on their packaging or in the documents accompanying batteries; and\n(f) the impact of substances, in particular hazardous substances, present in batteries on the environment and on human health or the safety of persons, including the impact due to inappropriate discarding of waste batteries, such as littering or discarding as unsorted municipal waste."@en ; + samm:characteristic ext-passport:DocumentList . + +:wastePrevention a samm:Property ; + samm:preferredName "Waste Prevention"@en ; + samm:description "Documentation about waste prevention for batteries which include guidelines, recommendations, and information on minimizing the environmental impact associated with the use and disposal of batteries. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1) (s), refers to Article 74 (1) which call Article 8a of Directive 2008/98/EC:\n2. Member States shall take the necessary measures to ensure that the waste holders targeted by the extended producer responsibility schemes established in accordance with Article 8 (1), are informed about waste prevention measures, centres for re-use and preparing for re-use, take-back and collection systems, and the prevention of littering. Member States shall also take measures to create incentives for the waste holders to assume their responsibility to deliver their waste into the separate collection systems in place, notably, where appropriate, through economic incentives or regulations."@en ; + samm:characteristic ext-passport:DocumentList . + +:euTaxonomyDisclosureStatement a samm:Property ; + samm:preferredName "EU Taxonomy Disclosure Statement"@en ; + samm:description "Optional disclosure regarding the EU taxonomy, with the choice to voluntarily provide the EU Taxonomy disclosure through the battery passport."@en ; + samm:characteristic ext-passport:DocumentList . + +:sustainabilityReport a samm:Property ; + samm:preferredName "Sustainability Report"@en ; + samm:description "Voluntarily making the Sustainability Report available via the battery passport. A report containing the information concerning the sustainability in form of a document."@en ; + samm:characteristic ext-passport:DocumentList . + +:nickel a samm:Property ; + samm:preferredName "Nickel"@en ; + samm:description "Information about the percentage of recovered nickel from waste. These attribute are mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1)(e) refers to Article 8:\n1. From 18 August 2028 or 24 months after the date of entry into force of the delegated act referred to in the third subparagraph, whichever is the latest, industrial batteries with a capacity greater than 2 kWh, except those with exclusively external storage, electric vehicle batteries and SLI batteries that contain cobalt, lead, lithium or nickel in active materials, shall be accompanied by documentation containing information about the percentage share of cobalt, lithium or nickel that is present in active materials and that has been recovered from battery manufacturing waste or post-consumer waste, and the percentage share of lead that is present in the battery and that has been recovered from waste, for each battery model per year and per manufacturing plant."@en ; + samm:characteristic :MaterialActive . + +:lithium a samm:Property ; + samm:preferredName "Lithium"@en ; + samm:description "Information about the percentage of recovered lithium from waste. These attribute are mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1)(e) refers to Article 8:\n1. From 18 August 2028 or 24 months after the date of entry into force of the delegated act referred to in the third subparagraph, whichever is the latest, industrial batteries with a capacity greater than 2 kWh, except those with exclusively external storage, electric vehicle batteries and SLI batteries that contain cobalt, lead, lithium or nickel in active materials, shall be accompanied by documentation containing information about the percentage share of cobalt, lithium or nickel that is present in active materials and that has been recovered from battery manufacturing waste or post-consumer waste, and the percentage share of lead that is present in the battery and that has been recovered from waste, for each battery model per year and per manufacturing plant."@en ; + samm:characteristic :MaterialActive . + +:cobalt a samm:Property ; + samm:preferredName "Cobalt"@en ; + samm:description "Information about the percentage of recovered cobalt from waste. These attribute are mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1)(e) refers to Article 8:\n1. From 18 August 2028 or 24 months after the date of entry into force of the delegated act referred to in the third subparagraph, whichever is the latest, industrial batteries with a capacity greater than 2 kWh, except those with exclusively external storage, electric vehicle batteries and SLI batteries that contain cobalt, lead, lithium or nickel in active materials, shall be accompanied by documentation containing information about the percentage share of cobalt, lithium or nickel that is present in active materials and that has been recovered from battery manufacturing waste or post-consumer waste, and the percentage share of lead that is present in the battery and that has been recovered from waste, for each battery model per year and per manufacturing plant."@en ; + samm:characteristic :MaterialActive . + +:lead a samm:Property ; + samm:preferredName "Lead"@en ; + samm:description "Information about the lead in the battery. As this is an active and hazardous material, all properties for hazardous as well as active materials are required. These attribute are mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1)(e) refers to Article 8:\n1. From 18 August 2028 or 24 months after the date of entry into force of the delegated act referred to in the third subparagraph, whichever is the latest, industrial batteries with a capacity greater than 2 kWh, except those with exclusively external storage, electric vehicle batteries and SLI batteries that contain cobalt, lead, lithium or nickel in active materials, shall be accompanied by documentation containing information about the percentage share of cobalt, lithium or nickel that is present in active materials and that has been recovered from battery manufacturing waste or post-consumer waste, and the percentage share of lead that is present in the battery and that has been recovered from waste, for each battery model per year and per manufacturing plant.\nAnd for hazardous materials this is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1) (a) refers to Annex VI Part A: \n8. the hazardous substances present in the battery, other than mercury, cadmium or lead;\nAdditionally in Article 13:\n5. All batteries containing more than 0,002 % cadmium or more than 0,004 % lead, shall be marked with the chemical symbol for the metal concerned: Cd or Pb.\nDefined in Article 3:\n(52) \"hazardous substance\" means a substance classified as hazardous pursuant to Article 3 of Regulation (EC) No 1272/2008."@en ; + samm:characteristic :LeadCharacteristic . + +:otherActiveMaterials a samm:Property ; + samm:preferredName "Other Active Materials"@en ; + samm:description "Other active materials in the battery."@en ; + samm:characteristic :OtherActiveMaterialsList . + +:hazardousCadmium a samm:Property ; + samm:preferredName "Hazardous Cadmium"@en ; + samm:description "Information about the presence of cadmium in the battery. Therefore, a concentration and the location within the battery has to be given. This is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1) (a) refers to Annex VI Part A: \n8. the hazardous substances present in the battery, other than mercury, cadmium or lead;\nDefined in Article 3:\n(52) \"hazardous substance\" means a substance classified as hazardous pursuant to Article 3 of Regulation (EC) No 1272/2008.\nAdditionally in Article 13:\n5. All batteries containing more than 0,002 % cadmium or more than 0,004 % lead, shall be marked with the chemical symbol for the metal concerned: Cd or Pb."@en ; + samm:characteristic :HazardousCharacteristic . + +:hazardousMercury a samm:Property ; + samm:preferredName "Hazardous Mercury"@en ; + samm:description "Information about the presence of mercury in the battery. Therefore, a concentration and the location within the battery has to be given. This is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1) (a) refers to Annex VI Part A: \n8. the hazardous substances present in the battery, other than mercury, cadmium or lead;\nDefined in Article 3:\n(52) \"hazardous substance\" means a substance classified as hazardous pursuant to Article 3 of Regulation (EC) No 1272/2008."@en ; + samm:characteristic :HazardousCharacteristic . + +:otherHazardousMaterial a samm:Property ; + samm:preferredName "Other Hazardous Material"@en ; + samm:description "Other hazardous materials."@en ; + samm:characteristic :OtherHazardousMaterialList . + +:voltage a samm:Property ; + samm:preferredName "Voltage"@en ; + samm:description "Voltage values are mandatory for the battery, with the option to include temperature values voluntarily. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1):\n(h) minimal, nominal and maximum voltage, with temperature ranges when relevant."@en ; + samm:characteristic :VoltageCharacteristic . + +:ratedRoundTripEfficiency a samm:Property ; + samm:preferredName "Rated Round Trip Efficiency"@en ; + samm:description "The efficiency value of a battery refers to the ratio of useful output energy to the input energy, expressed as a percentage. With the option to include temperature values voluntarily."@en ; + samm:characteristic :RatedRoundTripEfficiencyCharacteristic . + +:ratedEnergy a samm:Property ; + samm:preferredName "Rated Energy"@en ; + samm:description "Representation of the total amount of energy that the battery can store and subsequently deliver during its discharge cycle. It is necessary to calculate the SOCE."@en ; + samm:characteristic :RatedEnergyCharacteristic . + +:ratedResistance a samm:Property ; + samm:preferredName "Rated Resistance"@en ; + samm:description "Rated resistance of the battery on the level of the pack, module (optional) and cell."@en ; + samm:characteristic :RatedResistanceCharacteristic . + +:ratedPower a samm:Property ; + samm:preferredName "Rated Power"@en ; + samm:description "The power value is the rate at which energy is delivered or consumed. It is measured in watts (W) and represents how quickly energy is transferred. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (4)(a) refers to Article 10(1), refers to Annex IV Part A: \t\n2. Power (in W) and power fade (in %).\nDefinition from Annex IV:\n(3) \"Power\" means the amount of energy that a battery is capable of providing over a given period under reference conditions."@en ; + samm:characteristic :RatedPowerCharacteristic . + +:ratedCapacity a samm:Property ; + samm:preferredName "Rated Capacity"@en ; + samm:description "Capacity value refers to the amount of electric charge that a battery can store and subsequently deliver when needed. It is a fundamental characteristic of a battery and is expressed in ampere-hours. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1):\n(g) rated capacity (in Ah);\nand in Annex XIII (4)(a) referring to Article 10 (1) and referring to Annex IV Part A:\n1. Rated capacity (in Ah) and capacity fade (in %). \nAnd in Annex XIII (1)(a) referring to Annex VI Part A:\n6. the capacity;\nDefinition from Annex IV:\n(1) \"Rated capacity\" means the total number of ampere-hours (Ah) that can be withdrawn from a fully charged battery under reference conditions."@en ; + samm:characteristic :RatedCapacityCharacteristic . + +:performanceDocument a samm:Property ; + samm:preferredName "Performance Document"@en ; + samm:description "The performance document lists information regarding the performance of the battery. This can be an overview about several rated performance attributes. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (3):\n[...] results of test reports proving compliance with the requirements laid down in this Regulation or any delegated or implementing act adopted pursuant to this Regulation.\nAnd Annex XIII (4)(a) refers to Article 10(1) and refer to Annex IV Part B:\n5. Any calculations performed with the measured parameters, if applicable."@en ; + samm:characteristic ext-passport:DocumentList . + +:performanceTemperature a samm:Property ; + samm:preferredName "Performance Temperature"@en ; + samm:description "The battery temperatures. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1):\n(l) temperature range the battery can withstand when not in use (reference test)."@en ; + samm:characteristic :PerformanceTemperatureCharacteristic . + +:selfDischargingRate a samm:Property ; + samm:preferredName "Self Discharging Rate"@en ; + samm:description "The self-discharge rate of a battery refers to the rate at which the battery loses its stored energy when not in use. It's the discharge of the battery that occurs internally without any external load recorded in percentage for every month. This attribute is mentioned in the Battery Regulation 2023/1542 from 12 July 2023 in Annex XIII (4) (b) refers to Article 14, refers to Annex VII Part A:\n4. the evolution of self-discharging rates."@en ; + samm:characteristic :PercentMeasurement ; + samm:exampleValue "0.25"^^xsd:double . + +:testReport a samm:Property ; + samm:preferredName "Test Report"@en ; + samm:description "The test reports refer to the testing conducted during the determination of the rated values of the battery. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (3):\n[...] results of test reports proving compliance with the requirements laid down in this Regulation or any delegated or implementing act adopted pursuant to this Regulation.\nAnd Annex XIII (4)(a) refers to Article 10(1) and refer to Annex IV Part B:\n5. Any calculations performed with the measured parameters, if applicable."@en ; + samm:characteristic ext-passport:DocumentList . + +:lifetime a samm:Property ; + samm:preferredName "Lifetime"@en ; + samm:description "Attributes for the lifetime evaluation of a battery."@en ; + samm:characteristic :LifeCycleCharacteristic . + +:stateOfCharge a samm:Property ; + samm:preferredName "State of Charge"@en ; + samm:description "State of Charge (SOC) refers to the amount of energy remaining in a battery at a given point in time, expressed as a percentage of the total capacity. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (4):\n(d) information and data resulting from its use, including the number of charging and discharging cycles and negative events, such as accidents, as well as periodically recorded information on the operating environmental conditions, including temperature, and on the state of charge."@en ; + samm:characteristic :RecordCharacteristic . + +:fullCycles a samm:Property ; + samm:preferredName "Full Cycles"@en ; + samm:description "Full cycles include the cumulative and equivalent count of complete charge and discharge cycles experienced by the battery over its entire life. This attribute is mentioned in the Battery Regulation 2023/1542 from 12 July 2023 in Annex XIII (4) (d) information and data resulting from its use, including the number of charging and discharging cycles and negative events, such as accidents, as well as periodically recorded information on the operating environmental conditions, including temperature, and on the state of charge.\nAnd in AnnexVII Part B:\n5. the number of full equivalent charge-discharge cycles."@en ; + samm:characteristic :FullCycleCharacteristic . + +:dynamicPower a samm:Property ; + samm:preferredName "Dynamic Power"@en ; + samm:description "Values that describe dynamically captured power values."@en ; + samm:characteristic :DynamicPowerCharacteristic . + +:dynamicCapacity a samm:Property ; + samm:preferredName "Dynamic Capacity"@en ; + samm:description "Values that describe dynamically captured capacity values."@en ; + samm:characteristic :DynamicCapacityCharacteristic . + +:dynamicRoundTripEfficiency a samm:Property ; + samm:preferredName "Dynamic Round Trip Efficiency"@en ; + samm:description "Dynamic round trip efficiency values."@en ; + samm:characteristic :DynamicRoundTripEfficiencyCharacteristic . + +:dynamicInternalResistance a samm:Property ; + samm:preferredName "Dynamic Internal Resistance"@en ; + samm:description "Values that describe dynamically captured internal resistance values."@en ; + samm:characteristic :DynamicInternalResistanceCharacteristic . + +:dynamicEnergy a samm:Property ; + samm:preferredName "Dynamic Energy"@en ; + samm:description "Values that describe dynamically captured energy values."@en ; + samm:characteristic :DynamicEnergyCharacteristic . + +:negativeEvents a samm:Property ; + samm:preferredName "Negative Events"@en ; + samm:description "Mandatory if applicable. Negative events refers to several possible events influencing the battery's condition and lifetime such as extreme temperatures. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (4):\n(d) information and data resulting from its use, including the number of charging and discharging cycles and negative events, such as accidents, as well as periodically recorded information on the operating environmental conditions, including temperature, and on the state of charge.\nAnd Annex VII Part B:\n4. the tracking of harmful events, such as the number of deep discharge events, time spent in extreme temperatures, time spent charging in extreme temperatures."@en ; + samm:characteristic ext-passport:DocumentList . + +:operatingEnvironment a samm:Property ; + samm:preferredName "Operating Environment"@en ; + samm:description "Mandatory if applicable. The operating environment refers to the conditions in which the battery is designed to function optimally. The environment includes factors such as temperature, humidity, pressure, and other external conditions that can impact the performance, safety, and lifespan of the battery. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (4):\n(d) information and data resulting from its use, including the number of charging and discharging cycles and negative events, such as accidents, as well as periodically recorded information on the operating environmental conditions, including temperature, and on the state of charge.\nAnd Annex VII Part B:\n4. the tracking of harmful events, such as the number of deep discharge events, time spent in extreme temperatures, time spent charging in extreme temperatures."@en ; + samm:characteristic ext-passport:DocumentList . + +:agentDocument a samm:Property ; + samm:preferredName "Agent Document"@en ; + samm:description "Documentation about the extinguishing agent."@en ; + samm:characteristic ext-passport:DocumentList . + +:usableExtinguishingMedia a samm:Property ; + samm:preferredName "Usable Extinguishing Media"@en ; + samm:description "The agent used to extinguish a fire, based on the fire class. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1)(a) and refers to Annex VI Part A:\n9. usable extinguishing agent."@en ; + samm:characteristic samm-c:Text ; + samm:exampleValue "Dry Powder" . + +:fireClass a samm:Property ; + samm:preferredName "Fire Class"@en ; + samm:description "Safety classification based on the chemistry and construction of the battery. It determines the means of handling a fire caused by the battery. Possible values are A, B and C and a combination of these."@en ; + samm:characteristic samm-c:Text ; + samm:exampleValue "A, B" . + +:MaterialActive a samm:Characteristic ; + samm:preferredName "Material Active"@en ; + samm:description "Characteristic to describe the active material."@en ; + samm:dataType :MaterialActiveEntity . + +:LeadCharacteristic a samm:Characteristic ; + samm:preferredName "Lead Characteristic"@en ; + samm:description "Characteristic for specific hazardous/active lead information."@en ; + samm:dataType :LeadEntity . + +:OtherActiveMaterialsList a samm-c:List ; + samm:preferredName "Other Active Materials List"@en ; + samm:description "List of other active materials."@en ; + samm:dataType :OtherActiveMaterialsEntity . + +:HazardousCharacteristic a samm:Characteristic ; + samm:preferredName "Hazardous Characteristic"@en ; + samm:description "Material attributes for hazardous materials."@en ; + samm:dataType :HazardousEntity . + +:OtherHazardousMaterialList a samm-c:List ; + samm:preferredName "Other Hazardous Material List"@en ; + samm:description "List of other hazardous materials."@en ; + samm:dataType :OtherHazardousMaterialEntity . + +:VoltageCharacteristic a samm:Characteristic ; + samm:preferredName "Voltage Characteristic"@en ; + samm:description "Characteristic for voltage values."@en ; + samm:dataType :VoltageEntity . + +:RatedRoundTripEfficiencyCharacteristic a samm:Characteristic ; + samm:preferredName "Rated Round Trip Efficiency Characteristic"@en ; + samm:description "Characteristic for the rated round trip efficiency."@en ; + samm:dataType :RatedRoundTripEfficiencyEntity . + +:RatedEnergyCharacteristic a samm:Characteristic ; + samm:preferredName "Rated Energy Characteristic"@en ; + samm:description "Characteristic for the rated energy."@en ; + samm:dataType :RatedEnergyEntity . + +:RatedResistanceCharacteristic a samm:Characteristic ; + samm:preferredName "Rated Resistance Characteristic"@en ; + samm:description "Characteristic for rated resistance values of the battery on different levels."@en ; + samm:dataType :RatedResistanceEntity . + +:RatedPowerCharacteristic a samm:Characteristic ; + samm:preferredName "Rated Power Characteristic"@en ; + samm:description "Characteristic for rated power values."@en ; + samm:dataType :RatedPowerEntity . + +:RatedCapacityCharacteristic a samm:Characteristic ; + samm:preferredName "Rated Capacity Characteristic"@en ; + samm:description "Characteristic for rated capacity values."@en ; + samm:dataType :RatedCapacityEntity . + +:PerformanceTemperatureCharacteristic a samm:Characteristic ; + samm:preferredName "Performance Temperature Characteristic"@en ; + samm:description "Characteristic for temperature values."@en ; + samm:dataType :PerformanceTemperatureEntity . + +:PercentMeasurement a samm-c:Measurement ; + samm:preferredName "Percent Measurement"@en ; + samm:description "Measurement in percent as double."@en ; + samm:dataType xsd:double ; + samm-c:unit unit:percent . + +:LifeCycleCharacteristic a samm:Characteristic ; + samm:preferredName "Life Cycle Characteristic"@en ; + samm:description "Life Cycle Characteristic with attributes for the lifetime evaluation of a battery."@en ; + samm:dataType :LifeCycleEntity . + +:RecordCharacteristic a samm:Characteristic ; + samm:preferredName "Record Characteristic"@en ; + samm:description "Characteristic for a dynamic record with a value and timestamp."@en ; + samm:dataType :RecordEntity . + +:FullCycleCharacteristic a samm:Characteristic ; + samm:preferredName "Full Cycle Characteristic"@en ; + samm:description "Characteristic for dynamic cycle values."@en ; + samm:dataType :FullCycleEntity . + +:DynamicPowerCharacteristic a samm:Characteristic ; + samm:preferredName "Dynamic Power Characteristic"@en ; + samm:description "Characteristic for dynamic power values."@en ; + samm:dataType :DynamicPowerEntity . + +:DynamicCapacityCharacteristic a samm:Characteristic ; + samm:preferredName "Dynamic Capacity Characteristic"@en ; + samm:description "Characteristic for dynamic capacity values."@en ; + samm:dataType :DynamicCapacityEntity . + +:DynamicRoundTripEfficiencyCharacteristic a samm:Characteristic ; + samm:preferredName "Dynamic Round Trip Efficiency Characteristic"@en ; + samm:description "Characteristic for dynamic round trip efficiency values."@en ; + samm:dataType :DynamicRoundTripEfficiencyEntity . + +:DynamicInternalResistanceCharacteristic a samm:Characteristic ; + samm:preferredName "Dynamic Internal Resistance Characteristic"@en ; + samm:description "Characteristic for dynamic internal resistance values."@en ; + samm:dataType :DynamicInternalResistanceEntity . + +:DynamicEnergyCharacteristic a samm:Characteristic ; + samm:preferredName "Dynamic Energy Characteristic"@en ; + samm:description "Characteristic for dynamic energy values."@en ; + samm:dataType :DynamicEnergyEntity . + +:MaterialActiveEntity a samm:Entity ; + samm:preferredName "Material Active Entity"@en ; + samm:description "The information on the active material with the recycled share, location and supporting document(s)."@en ; + samm:properties ( ext-passport:location ext-passport:recycled ext-passport:documentation ext-passport:critical ) . + +:LeadEntity a samm:Entity ; + samm:preferredName "Lead Entity"@en ; + samm:description "Entity for lead."@en ; + samm:properties ( :impactOfSubstances ext-passport:critical ext-passport:documentation ext-passport:recycled ext-passport:location ext-passport:concentration ext-passport:materialUnit ) . + +:OtherActiveMaterialsEntity a samm:Entity ; + samm:preferredName "Other Active Materials Entity"@en ; + samm:description "Entity for other active materials."@en ; + samm:properties ( ext-passport:location ext-passport:recycled ext-passport:documentation ext-passport:critical ext-passport:materialIdentification ) . + +:HazardousEntity a samm:Entity ; + samm:preferredName "Hazardous Entity"@en ; + samm:description "Material Entity to describe the material composition for hazardous materials."@en ; + samm:properties ( :impactOfSubstances ext-passport:concentration ext-passport:location ext-passport:materialUnit ext-passport:critical ext-passport:documentation ) . + +:OtherHazardousMaterialEntity a samm:Entity ; + samm:preferredName "Other HazardousMaterial Entity"@en ; + samm:description "Entity for other hazardous materials."@en ; + samm:properties ( :impactOfSubstances ext-passport:materialUnit ext-passport:concentration ext-passport:materialIdentification ext-passport:documentation ext-passport:critical ext-passport:location ) . + +:VoltageEntity a samm:Entity ; + samm:preferredName "Voltage Entity"@en ; + samm:description "Entity for voltage values."@en ; + samm:properties ( [ samm:property :minVoltage; samm:payloadName "min" ] [ samm:property :maxVoltage; samm:payloadName "max" ] [ samm:property :nominalVoltage; samm:payloadName "nominal" ] [ samm:property :testingTemperature; samm:optional true; samm:payloadName "temperature" ] ) . + +:RatedRoundTripEfficiencyEntity a samm:Entity ; + samm:preferredName "Rated Round Trip Efficiency Entity"@en ; + samm:description "Entity for the rated round trip efficiency."@en ; + samm:properties ( :depthOfDischarge [ samm:property :initialRoundTripEfficiency; samm:payloadName "initial" ] [ samm:property :roundTripEfficiency50Percent; samm:payloadName "50PercentLife" ] [ samm:property :testingTemperature; samm:optional true; samm:payloadName "temperature" ] ) . + +:RatedEnergyEntity a samm:Entity ; + samm:preferredName "Rated Energy Entity"@en ; + samm:description "Entity for the rated energy."@en ; + samm:properties ( [ samm:property :energyValue; samm:payloadName "value" ] [ samm:property :testingTemperature; samm:optional true; samm:payloadName "temperature" ] ) . + +:RatedResistanceEntity a samm:Entity ; + samm:preferredName "Rated Resistance Entity"@en ; + samm:description "Entity for rated resistance values of the battery on different levels."@en ; + samm:properties ( [ samm:property :cellResistance; samm:payloadName "cell" ] [ samm:property :moduleResistance; samm:optional true; samm:payloadName "module" ] [ samm:property :packResistance; samm:payloadName "pack" ] [ samm:property :testingTemperature; samm:optional true; samm:payloadName "temperature" ] ) . + +:RatedPowerEntity a samm:Entity ; + samm:preferredName "Rated Power Entity"@en ; + samm:description "Entity for rated power values."@en ; + samm:properties ( [ samm:property :powerValue; samm:payloadName "value" ] [ samm:property :capabilityAt20SoC; samm:payloadName "at20SoC" ] [ samm:property :capabilityAt80SoC; samm:payloadName "at80SoC" ] [ samm:property :testingTemperature; samm:optional true; samm:payloadName "temperature" ] ) . + +:RatedCapacityEntity a samm:Entity ; + samm:preferredName "Rated Capacity Entity"@en ; + samm:description "Entity for rated capacity values."@en ; + samm:properties ( [ samm:property :capacityValue; samm:payloadName "value" ] [ samm:property :capacityThresholdExhaustion; samm:payloadName "thresholdExhaustion" ] [ samm:property :testingTemperature; samm:optional true; samm:payloadName "temperature" ] ) . + +:PerformanceTemperatureEntity a samm:Entity ; + samm:preferredName "Performance Temperature Entity"@en ; + samm:description "Entity for temperature values."@en ; + samm:properties ( [ samm:property :lowerTemperatureBoundary; samm:payloadName "lower" ] [ samm:property :upperTemperatureBoundary; samm:payloadName "upper" ] ) . + +:LifeCycleEntity a samm:Entity ; + samm:preferredName "Life Cycle Entity"@en ; + samm:description "Life Cycle Entity with attributes for the lifetime evaluation of a battery such as expected years and cycles, if applicable."@en ; + samm:properties ( :expectedYears [ samm:property :testReport; samm:payloadName "report" ] :cycleLifeTesting ) . + +:RecordEntity a samm:Entity ; + samm:preferredName "Record Entity"@en ; + samm:description "Entity for a dynamic record with a value and timestamp."@en ; + samm:properties ( [ samm:property :percentValue; samm:payloadName "value" ] [ samm:property :dataRecordTime; samm:payloadName "time" ] ) . + +:FullCycleEntity a samm:Entity ; + samm:preferredName "Full Cycle Entity"@en ; + samm:description "Entity for dynamic cycle values."@en ; + samm:properties ( [ samm:property :dataRecordTime; samm:payloadName "time" ] [ samm:property :cycles; samm:payloadName "value" ] ) . + +:DynamicPowerEntity a samm:Entity ; + samm:preferredName "Dynamic Power Entity"@en ; + samm:description "Entity for dynamic power values."@en ; + samm:properties ( [ samm:property :powerFade; samm:payloadName "fade" ] [ samm:property :remainingPower; samm:payloadName "remaining" ] ) . + +:DynamicCapacityEntity a samm:Entity ; + samm:preferredName "Dynamic Capacity Entity"@en ; + samm:description "Entity for dynamic capacity values."@en ; + samm:properties ( [ samm:property :capacityFade; samm:payloadName "fade" ] [ samm:property :capacityThroughput; samm:payloadName "throughput" ] [ samm:property :remainingCapacity; samm:payloadName "capacity" ] ) . + +:DynamicRoundTripEfficiencyEntity a samm:Entity ; + samm:preferredName "Dynamic Round Trip Efficiency Entity"@en ; + samm:description "Entity for dynamic round trip efficiency values."@en ; + samm:properties ( [ samm:property :roundTripEfficiencyFade; samm:payloadName "fade" ] [ samm:property :remainingRoundTripEfficiency; samm:payloadName "remaining" ] ) . + +:DynamicInternalResistanceEntity a samm:Entity ; + samm:preferredName "Dynamic Internal Resistance Entity"@en ; + samm:description "Entity for dynamic internal resistance values."@en ; + samm:properties ( [ samm:property :resistanceIncrease; samm:payloadName "increase" ] [ samm:property :remainingResistance; samm:payloadName "remaining" ] ) . + +:DynamicEnergyEntity a samm:Entity ; + samm:preferredName "Dynamic Energy Entity"@en ; + samm:description "Entity for dynamic energy values."@en ; + samm:properties ( :soce [ samm:property :remainingEnergy; samm:payloadName "remaining" ] [ samm:property :energyThroughput; samm:optional true; samm:payloadName "throughput" ] ) . + +:impactOfSubstances a samm:Property ; + samm:preferredName "Impact of Substances"@en ; + samm:description "An accumulation of documents that refer to the impact, especially hazardous substances, on the battery. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1) (s), refers to Article 74:\n1. In addition to the information referred to in Article 8a(2) of Directive 2008/98/EC, producers or, where appointed in accordance with Article 57(1), producer responsibility organisations shall make available to end-users and distributors the following information regarding the prevention and management of waste batteries with regard to the categories of batteries that they supply within the territory of a Member State:\n[...]\n(f) the impact of substances, in particular hazardous substances, present in batteries on the environment and on human health or the safety of persons, including the impact due to inappropriate discarding of waste batteries, such as littering or discarding as unsorted municipal waste."@en ; + samm:characteristic ext-passport:DocumentList . + +:minVoltage a samm:Property ; + samm:preferredName "Minimum Voltage"@en ; + samm:description "Minimum voltage refers to the lowest voltage the battery is able to reach. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1):\n(h) minimal, nominal and maximum voltage, with temperature ranges when relevant."@en ; + samm:characteristic :VoltMeasurement ; + samm:exampleValue "2.5"^^xsd:double . + +:maxVoltage a samm:Property ; + samm:preferredName "Maximum Voltage"@en ; + samm:description "Maximum voltage refers to the highest voltage the battery is able to reach. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1):\n(h) minimal, nominal and maximum voltage, with temperature ranges when relevant."@en ; + samm:characteristic :VoltMeasurement ; + samm:exampleValue "4.2"^^xsd:double . + +:nominalVoltage a samm:Property ; + samm:preferredName "Nominal Voltage"@en ; + samm:description "Nominal voltage is a standardized or average voltage value assigned to the battery. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1):\n(h) minimal, nominal and maximum voltage, with temperature ranges when relevant."@en ; + samm:characteristic :VoltMeasurement ; + samm:exampleValue "3.7"^^xsd:double . + +:testingTemperature a samm:Property ; + samm:preferredName "Testing Temperature"@en ; + samm:description "Temperature refers to the temperature of the battery during it's cycle-life testing or as boundary condition for other rated values in celsius."@en ; + samm:characteristic :DegreeMeasurement ; + samm:exampleValue "20.0"^^xsd:double . + +:depthOfDischarge a samm:Property ; + samm:preferredName "Depth of Discharge"@en ; + samm:description "Depth of discharge is a measure used to quantify the extent to which the battery has been discharged relative to its maximum capacity during its cycle-life testing. It represents the percentage of the total available capacity that has been drained or used during a particular discharge cycle. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (4) (a) refers to Article 10 (1), refers to Annex IV Part B:\n3. Depth of discharge in the cycle-life test."@en ; + samm:characteristic :PercentMeasurement ; + samm:exampleValue "90.5"^^xsd:double . + +:initialRoundTripEfficiency a samm:Property ; + samm:preferredName "Initial Round Trip Efficiency"@en ; + samm:description "The efficiency value of a battery refers to the ratio of useful output energy to the input energy, expressed as a percentage. It quantifies how effectively a battery can convert and deliver stored energy during the discharge process relative to the energy input during charging. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1):\n(n) initial round trip energy efficiency and at 50 % of cycle-life."@en ; + samm:characteristic :PercentMeasurement ; + samm:exampleValue "96.0"^^xsd:double . + +:roundTripEfficiency50Percent a samm:Property ; + samm:preferredName "Round Trip Efficiency 50 Percent"@en ; + samm:description "The round trip efficiency at 50 percent refers to the efficiency of a rechargeable battery's energy storage and retrieval process when the battery has undergone approximately half of its expected number of charge-discharge cycles. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1):\n(n) initial round trip energy efficiency and at 50 % of cycle-life."@en ; + samm:characteristic :PercentMeasurement ; + samm:exampleValue "89.0"^^xsd:double . + +:energyValue a samm:Property ; + samm:preferredName "Energy Value"@en ; + samm:description "Value describing the energy in a specific measurement period, expressed in kilowatt-hours."@en ; + samm:characteristic :KilowattHourMeasurement ; + samm:exampleValue "0.5"^^xsd:double . + +:cellResistance a samm:Property ; + samm:preferredName "Cell Resistance"@en ; + samm:description "Cell resistance refers to the internal resistance of an individual battery cell in ohms. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1):\n(o) internal battery cell and pack resistance;\nDefinition from Annex IV:\n(5) \"Internal resistance\" means the opposition to the flow of current within a cell or a battery under reference conditions, that is, the sum of electronic resistance and ionic resistance to the contribution to total effective resistance including inductive/capacitive properties."@en ; + samm:characteristic :OhmMeasurement ; + samm:exampleValue "0.025"^^xsd:double . + +:moduleResistance a samm:Property ; + samm:preferredName "Module Resistance"@en ; + samm:description "The module resistance in ohms includes the internal resistance of each cell within the module as well as the resistance introduced by interconnecting components such as busbars, connectors, and thermal management systems."@en ; + samm:characteristic :OhmMeasurement ; + samm:exampleValue "0.2"^^xsd:double . + +:packResistance a samm:Property ; + samm:preferredName "Pack Resistance"@en ; + samm:description "Pack resistance refers to the overall electrical resistance within a battery pack in ohms. This resistance is a combination of the individual resistances in various components within the pack, including the electrodes, connectors, and other conductive elements. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1):\n(o) internal battery cell and pack resistance;\nDefinition from Annex IV:\n(5) \"Internal resistance\" means the opposition to the flow of current within a cell or a battery under reference conditions, that is, the sum of electronic resistance and ionic resistance to the contribution to total effective resistance including inductive/capacitive properties."@en ; + samm:characteristic :OhmMeasurement ; + samm:exampleValue "0.55"^^xsd:double . + +:powerValue a samm:Property ; + samm:preferredName "Power Value"@en ; + samm:description "Value describing the power in a specific measurement period, expressed in watt."@en ; + samm:characteristic :WattMeasurement ; + samm:exampleValue "40000.0"^^xsd:double . + +:capabilityAt20SoC a samm:Property ; + samm:preferredName "Capability at 20 SoC"@en ; + samm:description "Capability at 20% SoC refers to the battery's capability at 80% State of Charge. This measurement is indicative of the immediate available energy in the battery. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (4)(a) refers to Article 10 (1), refers to Annex IV Part B:\t\n4. Power capability at 80 % and 20 % state of charge."@en ; + samm:characteristic :WattMeasurement ; + samm:exampleValue "35000.0"^^xsd:double . + +:capabilityAt80SoC a samm:Property ; + samm:preferredName "Capability at 80 SoC"@en ; + samm:description "Capability at 80% SoC refers to the battery's capability at 80% State of Charge. This measurement is indicative of the immediate available energy in the battery. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (4)(a) refers to Article 10 (1), refers to Annex IV Part B:\t\n4. Power capability at 80 % and 20 % state of charge"@en ; + samm:characteristic :WattMeasurement ; + samm:exampleValue "39000.0"^^xsd:double . + +:capacityValue a samm:Property ; + samm:preferredName "Capacity Value"@en ; + samm:description "Value describing the capacity in a specific measurement period, expressed in ampere-hours."@en ; + samm:characteristic :AmpereHourMeasurement ; + samm:exampleValue "4.0"^^xsd:double . + +:capacityThresholdExhaustion a samm:Property ; + samm:preferredName "Capacity Threshold Exhaustion"@en ; + samm:description "Capacity threshold exhaustion refers to the condition where a battery's capacity diminishes to a level that is considered unacceptable for its intended use. The capacity threshold is a predetermined level below which the battery is considered to be no longer effective or reliable for the specific application. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1):\n(k) capacity threshold for exhaustion (only for electric vehicle batteries)."@en ; + samm:characteristic :PercentMeasurement ; + samm:exampleValue "80.0"^^xsd:double . + +:lowerTemperatureBoundary a samm:Property ; + samm:preferredName "Lower Temperature Boundary"@en ; + samm:description "The lower temperature boundary (in Celsius) refers to the minimum temperature at which a battery can effectively operate. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1):\n(l) temperature range the battery can withstand when not in use (reference test)."@en ; + samm:characteristic :DegreeMeasurement ; + samm:exampleValue "-18.0"^^xsd:double . + +:upperTemperatureBoundary a samm:Property ; + samm:preferredName "Upper Temperature Boundary"@en ; + samm:description "The upper temperature boundary (in Celsius) refers to the minimum temperature at which a battery can effectively operate. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1):\n(l) temperature range the battery can withstand when not in use (reference test)."@en ; + samm:characteristic :DegreeMeasurement ; + samm:exampleValue "60.0"^^xsd:double . + +:expectedYears a samm:Property ; + samm:preferredName "Expected Years"@en ; + samm:description "The expected years refer to the expected life-time of the battery before it starts heavily degrading in its capacity and c-rate in calendar years. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (4) (a) refers to the Article 10 (1) refers to Annex IV Part A: \n5. The expected life-time of the battery under the reference conditions for which it has been designed, in terms of cycles, except for non-cycle applications, and calendar years."@en ; + samm:characteristic :IntegerCharacteristic ; + samm:exampleValue 8 . + +:cycleLifeTesting a samm:Property ; + samm:preferredName "Cycle Life Testing"@en ; + samm:description "The cycle life testing of the battery."@en ; + samm:characteristic :CycleLifeCharacteristic . + +:percentValue a samm:Property ; + samm:preferredName "Percent Value"@en ; + samm:description "A value as a percentage in the form of a double."@en ; + samm:characteristic :PercentMeasurement ; + samm:exampleValue "50.0"^^xsd:double . + +:dataRecordTime a samm:Property ; + samm:preferredName "Data Record Time"@en ; + samm:description "The entry date and time corresponding to when a specific parameter was measured. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (4):\n(d) information and data resulting from its use, including the number of charging and discharging cycles and negative events, such as accidents, as well as periodically recorded information on the operating environmental conditions, including temperature, and on the state of charge."@en ; + samm:characteristic samm-c:Timestamp ; + samm:exampleValue "2023-12-07T10:39:13.576+01:00"^^xsd:dateTime . + +:cycles a samm:Property ; + samm:preferredName "Cycles"@en ; + samm:description "Cycle refers to one complete charging and discharging sequence. Either during the battery's cycle-life testing or as full equivalent while in use."@en ; + samm:characteristic :IntegerCharacteristic ; + samm:exampleValue 1500 . + +:powerFade a samm:Property ; + samm:preferredName "PowerFade"@en ; + samm:description "Power fade refers to a reduction in the power of the battery system over time expressed as a percentage in reference to the initial value. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (4)(a) refers to Article 10 (1), refers to Annex IV Part A: \t\n2. Power (in W) and power fade (in %).\nDefinition from Annex IV:\n(4) \"Power fade\" means the decrease over time and upon usage in the amount of power that a battery can deliver at the rated voltage."@en ; + samm:characteristic :RecordCharacteristic . + +:remainingPower a samm:Property ; + samm:preferredName "Remaining Power"@en ; + samm:description "The remaining power capability in the battery expressed in watt. This attribute is mentioned in the Battery Regulation 2023/1542 from 12 July 2023 in Annex XIII (4) (b) refers to Article 14, refers to Annex VII Part A:\n2. where possible, the remaining power capability;\nDefinition from Annex IV:\n(3) \"Power\" means the amount of energy that a battery is capable of providing over a given period under reference\nconditions."@en ; + samm:characteristic :RemainingPowerCharacteristic . + +:capacityFade a samm:Property ; + samm:preferredName "Capacity Fade"@en ; + samm:description "Capacity fade refers to a reduction in the capacity of the battery system over time expressed as a percentage in reference to the initial value. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (4)(a) refers to Article 10(1) and refer to Annex IV Part A: \n1. Rated capacity (in Ah) and capacity fade (in %).\nDefinition from Annex IV:\n(2) \"Capacity fade\" means the decrease over time and upon usage in the amount of charge that a battery can deliver at the rated voltage, with respect to the original rated capacity."@en ; + samm:characteristic :RecordCharacteristic . + +:capacityThroughput a samm:Property ; + samm:preferredName "Capacity Throughput"@en ; + samm:description "Capacity throughput refers to the total amount of energy that a battery has delivered over its lifetime. It represents the cumulative energy discharge and recharge cycles a battery has undergone. Capacity throughput is expressed in ampere-hours. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex VII Part B: \n3. the capacity throughput."@en ; + samm:characteristic :CapacityCharacteristic . + +:remainingCapacity a samm:Property ; + samm:preferredName "Remaining Capacity"@en ; + samm:description "The remaining capacity in the battery expressed in ampere hours. This attribute is mentioned in the Battery Regulation 2023/1542 from 12 July 2023 in Annex XIII (4) (b) refers to Article 14, refers to Annex VII Part A:\n1. the remaining capacity.\n"@en ; + samm:characteristic :CapacityCharacteristic . + +:roundTripEfficiencyFade a samm:Property ; + samm:preferredName "Round Trip Efficiency Fade"@en ; + samm:description "Round trip efficiency fade refers to a reduction in the round trip efficiency of the battery system over time expressed as a percentage in reference to the initial value. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (4)(a) refers to Article 10(1) and refers to Annex IV: \n4. Where applicable, energy round trip efficiency and its fade (in %).\nDefinition from Annex IV:\n(6) \"Energy round trip efficiency\" means the ratio of the net energy delivered by a battery during a discharge test to the total energy required to restore the initial state of charge by a standard charge."@en ; + samm:characteristic :RecordCharacteristic . + +:remainingRoundTripEfficiency a samm:Property ; + samm:preferredName "Remaining Round Trip Efficiency"@en ; + samm:description "The remaining round trip efficiency in the battery expressed as percentage. This attribute is mentioned in the Battery Regulation 2023/1542 from 12 July 2023 in Annex XIII (4) (b) refers to Article 14, refers to Annex VII Part A:\n3. where possible, the remaining round trip efficiency.\nDefinition from Annex IV:\n(6) \"Energy round trip efficiency\" means the ratio of the net energy delivered by a battery during a discharge test to the total energy required to restore the initial state of charge by a standard charge."@en ; + samm:characteristic :RecordCharacteristic . + +:resistanceIncrease a samm:Property ; + samm:preferredName "Resistance Increase"@en ; + samm:description "The increase as percentage in the battery resistance on the level of the pack, module (optional) and cell."@en ; + samm:characteristic :ResistanceIncreaseCharacteristic . + +:remainingResistance a samm:Property ; + samm:preferredName "Remaining Resistance"@en ; + samm:description "The remaining resistance in ohms in the battery on the level of the pack, module (optional) and cell."@en ; + samm:characteristic :RemainingResistanceCharacteristic . + +:soce a samm:Property ; + samm:preferredName "SOCE"@en ; + samm:description "The state of certified energy (SOCE) refers to the current measured or on-board usable battery energy (UBE) performance expressed as a percentage. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (4)(b) refers to Article 14) and refers to Annex VII Part A: \nstate of certified energy (SOCE)."@en ; + samm:characteristic :RecordCharacteristic . + +:remainingEnergy a samm:Property ; + samm:preferredName "Remaining Energy"@en ; + samm:description "The remaining energy in the battery expressed in kilowatt-hours."@en ; + samm:characteristic :EnergyCharacteristic . + +:energyThroughput a samm:Property ; + samm:preferredName "Energy Throughput"@en ; + samm:description "Energy throughput refers to the total amount of energy that passes through a system over a specific period. This measure encompasses both the energy input (during charging) and the energy output (during discharging). Energy throughput is expressed in kilowatt-hours. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex VII Part B: \n2. the energy throughput."@en ; + samm:characteristic :EnergyCharacteristic . + +:VoltMeasurement a samm-c:Measurement ; + samm:preferredName "Volt Measurement"@en ; + samm:description "Measurement for volt as a double."@en ; + samm:dataType xsd:double ; + samm-c:unit unit:volt . + +:DegreeMeasurement a samm-c:Measurement ; + samm:preferredName "Degree Measurement"@en ; + samm:description "Degree measurement in celsius."@en ; + samm:dataType xsd:double ; + samm-c:unit unit:degreeCelsius . + +:KilowattHourMeasurement a samm-c:Measurement ; + samm:preferredName "Kilowatt Hour Measurement"@en ; + samm:description "Measurement for the energy expressed in kilowatt hours as double."@en ; + samm:dataType xsd:double ; + samm-c:unit unit:kilowattHour . + +:OhmMeasurement a samm-c:Measurement ; + samm:preferredName "Ohm Measurement"@en ; + samm:description "Measurement in ohms as double."@en ; + samm:dataType xsd:double ; + samm-c:unit unit:ohm . + +:WattMeasurement a samm-c:Measurement ; + samm:preferredName "Watt Measurement"@en ; + samm:description "Measurement in watt as double."@en ; + samm:dataType xsd:double ; + samm-c:unit unit:watt . + +:AmpereHourMeasurement a samm-c:Measurement ; + samm:preferredName "Ampere Hour Measurement"@en ; + samm:description "Measurement for the capacity expressed in ampere hours as double."@en ; + samm:dataType xsd:double ; + samm-c:unit unit:ampereHour . + +:IntegerCharacteristic a samm:Characteristic ; + samm:preferredName "Integer Characteristic"@en ; + samm:description "Characteristic for an integer value."@en ; + samm:dataType xsd:integer . + +:CycleLifeCharacteristic a samm:Characteristic ; + samm:preferredName "Cycle Life Characteristic"@en ; + samm:description "Cycle Life Characteristic for the battery lifetime testing."@en ; + samm:dataType :CycleLifeEntity . + +:RemainingPowerCharacteristic a samm:Characteristic ; + samm:preferredName "Remaining Power Characteristic"@en ; + samm:description "Characteristic for the remaining power."@en ; + samm:dataType :RemainingPowerEntity . + +:CapacityCharacteristic a samm:Characteristic ; + samm:preferredName "Capacity Characteristic"@en ; + samm:description "Characteristic for dynamic capacity values such as the throughput and the remaining capacity."@en ; + samm:dataType :CapacityEntity . + +:ResistanceIncreaseCharacteristic a samm:Characteristic ; + samm:preferredName "Resistance Increase Characteristic"@en ; + samm:description "Characteristic for the increase of the battery resistance."@en ; + samm:dataType :ResistanceIncreaseEntity . + +:RemainingResistanceCharacteristic a samm:Characteristic ; + samm:preferredName "Remaining Resistance Characteristic"@en ; + samm:description "Characteristic for the remaining battery resistance."@en ; + samm:dataType :RemainingResistanceEntity . + +:EnergyCharacteristic a samm:Characteristic ; + samm:preferredName "Energy Characteristic"@en ; + samm:description "Characteristic for energy values expressed in a timestamp and a kilowatt-hours value."@en ; + samm:dataType :EnergyEntity . + +:CycleLifeEntity a samm:Entity ; + samm:preferredName "Cycle Life Entity"@en ; + samm:description "Cycle Life Characteristic for the battery lifetime testing with the cycles, temperature, depth of discharge and applied c-rates."@en ; + samm:properties ( [ samm:property :testingTemperature; samm:payloadName "temperature" ] :cycles :depthOfDischarge :appliedChargeRate :appliedDischargeRate ) . + +:RemainingPowerEntity a samm:Entity ; + samm:preferredName "Remaining Power Entity"@en ; + samm:description "Entity for the remaining power."@en ; + samm:properties ( [ samm:property :dataRecordTime; samm:payloadName "time" ] [ samm:property :powerValue; samm:payloadName "value" ] ) . + +:CapacityEntity a samm:Entity ; + samm:preferredName "Capacity Entity"@en ; + samm:description "Entity for dynamic capacity values such as the throughput and the remaining capacity."@en ; + samm:properties ( [ samm:property :dataRecordTime; samm:payloadName "time" ] [ samm:property :capacityValue; samm:payloadName "value" ] ) . + +:ResistanceIncreaseEntity a samm:Entity ; + samm:preferredName "Resistance Increase Entity"@en ; + samm:description "Entity for the increase of the battery resistance."@en ; + samm:properties ( [ samm:property :packResistanceIncrease; samm:payloadName "pack" ] [ samm:property :moduleResistanceIncrease; samm:optional true; samm:payloadName "module" ] [ samm:property :cellResistanceIncrease; samm:payloadName "cell" ] ) . + +:RemainingResistanceEntity a samm:Entity ; + samm:preferredName "Remaining Resistance Entity"@en ; + samm:description "Entity for the remaining battery resistance."@en ; + samm:properties ( [ samm:property :remainingPackResistance; samm:payloadName "pack" ] [ samm:property :remainingModuleResistance; samm:optional true; samm:payloadName "module" ] [ samm:property :remainingCellResistance; samm:payloadName "cell" ] ) . + +:EnergyEntity a samm:Entity ; + samm:preferredName "Energy Entity"@en ; + samm:description "Entity for energy values expressed in a timestamp and a kilowatt-hours value."@en ; + samm:properties ( [ samm:property :dataRecordTime; samm:payloadName "time" ] [ samm:property :energyValue; samm:payloadName "value" ] ) . + +:appliedChargeRate a samm:Property ; + samm:preferredName "Applied Charge Rate"@en ; + samm:description "The applied charge rate (c rate) refers to the rate at which a battery is charged. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1):\n(p) c-rate of relevant cycle-life test;\nand Annex XIII (4)(a) refers to Article 10(1) refers to Annex IV Part B:\n1. Applied discharge rate and charge rate."@en ; + samm:characteristic :CRateCharacteristic ; + samm:exampleValue "3"^^xsd:double . + +:appliedDischargeRate a samm:Property ; + samm:preferredName "Applied Discharge Rate"@en ; + samm:description "The applied discharge rate (c rate) refers to the rate at which a battery is discharged. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1):\n(p) c-rate of relevant cycle-life test;\nand Annex XIII (4)(a) refers to Article 10(1) refers to Annex IV Part B:\n1. Applied discharge rate and charge rate."@en ; + samm:characteristic :CRateCharacteristic ; + samm:exampleValue "4"^^xsd:double . + +:packResistanceIncrease a samm:Property ; + samm:preferredName "Pack Resistance Increase"@en ; + samm:description "Pack resistance increase refers to the overall electrical resistance within a battery pack. This resistance is a combination of the individual resistances in various components within the pack, including the electrodes, connectors, and other conductive elements. The rise in the pack resistance is expressed as a percentage in reference to the initial value.\nThis attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (4)(a) refers to Article 10(1) and refers to Annex IV Part A: \n3. Internal resistance (in \") and internal resistance increase (in %).\nDefinition from Annex IV:\n(5) \"Internal resistance\" means the opposition to the flow of current within a cell or a battery under reference conditions, that is, the sum of electronic resistance and ionic resistance to the contribution to total effective resistance including inductive/capacitive properties."@en ; + samm:characteristic :RecordCharacteristic . + +:moduleResistanceIncrease a samm:Property ; + samm:preferredName "module Resistance Increase"@en ; + samm:description "The module resistance increase includes the internal resistance of each cell within the module as well as the resistance introduced by interconnecting components such as busbars, connectors, and thermal management systems. The rise in the module resistance is expressed as a percentage in reference to the initial value."@en ; + samm:characteristic :RecordCharacteristic . + +:cellResistanceIncrease a samm:Property ; + samm:preferredName "Cell Resistance Increase"@en ; + samm:description "Cell resistance increase refers to the internal resistance of an individual battery cell. The rise in the cell resistance is expressed as a percentage in reference to the initial value. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (4)(a) refers to Article 10(1) and refers to Annex IV Part A: \n3. Internal resistance (in ohms) and internal resistance increase (in %).\nDefinition from Annex IV:\n(5) \"Internal resistance\" means the opposition to the flow of current within a cell or a battery under reference conditions, that is, the sum of electronic resistance and ionic resistance to the contribution to total effective resistance including inductive/capacitive properties."@en ; + samm:characteristic :RecordCharacteristic . + +:remainingPackResistance a samm:Property ; + samm:preferredName "Remaining Pack Resistance"@en ; + samm:description "Pack resistance refers to the overall electrical resistance within a battery pack. This resistance is a combination of the individual resistances in various components within the pack, including the electrodes, connectors, and other conductive elements. This attribute is mentioned in the Battery Regulation 2023/1542 from 12 July 2023 in Annex XIII (4) (b) refers to Article 14, refers to Annex VII Part A:\n5. where possible, the ohmic resistance."@en ; + samm:characteristic :RemainingResistanceCharacteristicRecord . + +:remainingModuleResistance a samm:Property ; + samm:preferredName "Remaining Module Resistance"@en ; + samm:description "Module resistance in ohms includes the internal resistance of each cell within the module as well as the resistance introduced by interconnecting components such as busbars, connectors, and thermal management systems."@en ; + samm:characteristic :RemainingResistanceCharacteristicRecord . + +:remainingCellResistance a samm:Property ; + samm:preferredName "Remaining Cell Resistance"@en ; + samm:description "Cell resistance refers to the internal resistance of an individual battery cell expressed in ohms. This attribute is mentioned in the Battery Regulation 2023/1542 from 12 July 2023 in Annex XIII (4) (b) refers to Article 14, refers to Annex VII Part A:\n5. where possible, the ohmic resistance."@en ; + samm:characteristic :RemainingResistanceCharacteristicRecord . + +:CRateCharacteristic a samm:Characteristic ; + samm:preferredName "C Rate Characteristic"@en ; + samm:description "The C-rate, also known as the charge/discharge rate, quantifies how quickly a battery is charged or discharged in relation to its capacity. It is dimensionless."@en ; + samm:dataType xsd:double . + +:RemainingResistanceCharacteristicRecord a samm:Characteristic ; + samm:preferredName "Remaining Resistance Characteristic Record"@en ; + samm:description "Characteristic for the remaining battery resistance."@en ; + samm:dataType :RemainingResistanceEntityRecord . + +:RemainingResistanceEntityRecord a samm:Entity ; + samm:preferredName "Remaining Resistance Entity Record"@en ; + samm:description "Entity for the remaining battery resistance with a timestamp and value."@en ; + samm:properties ( [ samm:property :dataRecordTime; samm:payloadName "time" ] [ samm:property :remainingResistanceValue; samm:payloadName "value" ] ) . + +:remainingResistanceValue a samm:Property ; + samm:preferredName "Remaining Resistance Value"@en ; + samm:description "The remaining resistance value expressed in ohms."@en ; + samm:characteristic :OhmsMeasurement ; + samm:exampleValue "0.3"^^xsd:double . + +:OhmsMeasurement a samm-c:Measurement ; + samm:preferredName "Ohms Measurement"@en ; + samm:description "Measurement for ohm as double."@en ; + samm:dataType xsd:double ; + samm-c:unit unit:ohm . + diff --git a/io.catenax.battery.battery_pass/6.0.0/gen/BatteryPass-aas.xml b/io.catenax.battery.battery_pass/6.0.0/gen/BatteryPass-aas.xml new file mode 100644 index 000000000..e8d3e5643 --- /dev/null +++ b/io.catenax.battery.battery_pass/6.0.0/gen/BatteryPass-aas.xml @@ -0,0 +1,29604 @@ + + + + + defaultAdminShell + + + en + defaultAdminShell + + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#BatteryPass + + Type + + + + ModelReference + + + Submodel + urn:samm:io.catenax.battery.battery_pass:6.0.0#BatteryPass/submodel + + + + + + + + + BatteryPass + + + en + The battery pass describes information collected during the lifecycle of a battery. The battery passport is heavily based on the Regulation (EU) 2023/1542 of the European Parliament and of the Council of 12 July 2023 concerning batteries and waste batteries, amending Directive 2008/98/EC and Regulation (EU) 2019/1020 and repealing Directive 2006/66/EC. +Additionally attributes come from the Proposal for Ecodesign for Sustainable Products Regulation. + + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#BatteryPass/submodel + Template + + ModelReference + + + ConceptDescription + urn:samm:io.catenax.battery.battery_pass:6.0.0#BatteryPass + + + + + + ExternalReference + + + GlobalReference + https://environment.ec.europa.eu/publications/proposal-ecodesign-sustainable-products-regulation_en + + + + + ExternalReference + + + GlobalReference + https://eur-lex.europa.eu/legal-content/EN/TXT/?uri=CELEX:32023R1542&qid=1693215264963 + + + + + + + IdentificationEntity + + + en + Identification Entity + + + + + en + Entity for the identification of the battery. + + + + + batteryCategory + + + en + Battery Category + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.battery.battery_pass:6.0.0#batteryCategory + + + + xs:string + + + + idDmc + + + en + Id DMC + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.battery.battery_pass:6.0.0#idDmc + + + + xs:string + + + + batteryChemistry + + + en + Battery Chemistry + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.battery.battery_pass:6.0.0#batteryChemistry + + + + xs:string + + + + IdentificationEntity + + + en + Identification Entity + + + + + en + Entity with identification information of the product with part type information, local identifiers, other codes and the data carrier. + + + + + serialInformation + + + en + Serial Information + + + + + en + Identifier for a serial part if available. This is mentioned in the ESPR provisional agreement from January 9th, 2024 Recital (27): +[...] an 'item' usually means a single unit of a model. + + + true + DataElement + + + KeyValueList + + + en + Key Value List + + + + + en + A list of key value pairs for local identifiers, which are composed of a key and a corresponding value. + + + + + key + + + en + Identifier Key + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.serial_part:3.0.0#key + + + + xs:string + + + + value + + + en + Identifier Value + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.serial_part:3.0.0#value + + + + xs:string + + + + + + + + batchInformation + + + en + Batch Information + + + + + en + Identifier for a batch part if available. Identifier for a serial part if available. This is mentioned in the ESPR provisional agreement from January 9th, 2024 Recital (27): +[...] a 'batch' usually means a subset of a specific model composed of all products produced in a specific manufacturing plant at a specific moment in time [...]. + + + true + DataElement + + + KeyValueList + + + en + Key Value List + + + + + en + A list of key value pairs for local identifiers, which are composed of a key and a corresponding value. + + + + + key + + + en + Identifier Key + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.batch:3.0.0#key + + + + xs:string + + + + value + + + en + Identifier Value + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.batch:3.0.0#value + + + + xs:string + + + + + + + + PartTypeEntity + + + en + Part Type Entity + + + + + en + Entity for the part type with manufacturer id and name. + + + + + manufacturerPartId + + + en + Manufacturer Part ID + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.part_type_information:1.0.0#manufacturerPartId + + + + xs:string + + + + nameAtManufacturer + + + en + Name at manufacturer + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.part_type_information:1.0.0#nameAtManufacturer + + + + xs:string + + + + + + codes + + + en + Codes + + + + + en + Codes for identification. + + + true + DataElement + + + CodeEntity + + + en + Code Entity + + + + + en + Code entity with code key and value. + + + + + codeKey + + + en + Code Key + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#codeKey + + + + xs:string + + + + codeValue + + + en + Code Value + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#codeValue + + + + xs:string + + + + + + + + DataCarrierEntity + + + en + Data Carrier Entity + + + + + en + Data Carrier Entity with type and layout of the data carrier. + + + + + carrierType + + + en + Carrier Type + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#carrierType + + + + xs:string + + + + carrierLayout + + + en + Carrier Layout + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#carrierLayout + + + + xs:string + + + + + + partClassification + + + en + Part Classification + + + + + en + Property describing the classification of a part. + + + true + DataElement + + + ClassificationEntity + + + en + ClassificationEntity + + + + + en + Encapsulates data related to the classification of the part. + + + + + classificationStandard + + + en + Classification Standard + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.shared.part_classification:1.0.0#classificationStandard + + + + xs:string + + + + classificationID + + + en + Classification ID + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.shared.part_classification:1.0.0#classificationID + + + + xs:string + + + + classificationDescription + + + en + Classification Description + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.shared.part_classification:1.0.0#classificationDescription + + + + xs:string + + + + + + + + + + + + OperationEntity + + + en + Operation Entity + + + + + en + Entity which includes details such as the manufacturer's identification and the date of production. The date of the putting into service is optional. + + + + + intoServiceDate + + + en + Into Service Date + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.battery.battery_pass:6.0.0#intoServiceDate + + + + xs:string + + + + ManufacturerEntity + + + en + Manufacturer Entity + + + + + en + Manufacturing Entity with the identification of the main manufacturer and the facility location as well as the manufacturing date. + + + + + facilityIdentification + + + en + Facility Identification + + + + + en + The identifier used for a location. In the CATENA-X use case, the BPNA can be stated. This attribute is mentioned in the ESPR provisional agreement from January 9th 2024 Annex III: +(i) unique facility identifiers; +Article 2 Definitions: (33) 'unique facility identifier' means a unique string of characters for the identification of locations or buildings involved in the value chain of a product or used by actors involved in the value chain of a product. + + + true + DataElement + + + FacilityEntity + + + en + Facility Entity + + + + + en + The entity for a facility with the BPNA identifier. + + + + + facility + + + en + Facility + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#facility + + + + xs:string + + + + + + + + manufacturerIdentification + + + en + Manufacturer Identification + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#manufacturerIdentification + + + + xs:string + + + + manufacturingDate + + + en + Manufacturing Date + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#manufacturingDate + + + + xs:string + + + + + + + + CharacteristicsEntity + + + en + Characteristics Entity + + + + + en + Entity for the product characteristics. + + + + + WarrantyEntity + + + en + Warranty Entity + + + + + en + Entity for the warranty with a value and unit. + + + + + lifeValue + + + en + Life Value + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#lifeValue + + + + xs:integer + + + + lifeUnit + + + en + Life Unit + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#lifeUnit + + + + + + ExternalReference + + + GlobalReference + https://eclipse-esmf.github.io/samm-specification/2.1.0/index.html + + + + + xs:string + + + + + + PhysicalDimensionEntity + + + en + Physical Dimension Entity + + + + + en + Entity for the physical dimension with weight, volume and other optional values. + + + + + LinearEntity + + + en + Linear Entity + + + + + en + Entity for linear measurements of an item with an unit and value. + + + + + quantityValue + + + en + Quantity Value + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.shared.quantity:2.0.0#quantityValue + + + + xs:float + + + + linearUnit + + + en + Linear Unit + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.shared.quantity:2.0.0#linearUnit + + + + + + ExternalReference + + + GlobalReference + https://eclipse-esmf.github.io/samm-specification/2.1.0/index.html + + + + + xs:string + + + + + + LinearEntity + + + en + Linear Entity + + + + + en + Entity for linear measurements of an item with an unit and value. + + + + + quantityValue + + + en + Quantity Value + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.shared.quantity:2.0.0#quantityValue + + + + xs:float + + + + linearUnit + + + en + Linear Unit + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.shared.quantity:2.0.0#linearUnit + + + + + + ExternalReference + + + GlobalReference + https://eclipse-esmf.github.io/samm-specification/2.1.0/index.html + + + + + xs:string + + + + + + LinearEntity + + + en + Linear Entity + + + + + en + Entity for linear measurements of an item with an unit and value. + + + + + quantityValue + + + en + Quantity Value + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.shared.quantity:2.0.0#quantityValue + + + + xs:float + + + + linearUnit + + + en + Linear Unit + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.shared.quantity:2.0.0#linearUnit + + + + + + ExternalReference + + + GlobalReference + https://eclipse-esmf.github.io/samm-specification/2.1.0/index.html + + + + + xs:string + + + + + + MassEntity + + + en + Mass Entity + + + + + en + Entity for mass measurements of an item with an unit and value. + + + + + quantityValue + + + en + Quantity Value + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.shared.quantity:2.0.0#quantityValue + + + + xs:float + + + + massUnit + + + en + Mass Unit + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.shared.quantity:2.0.0#massUnit + + + + + + ExternalReference + + + GlobalReference + https://eclipse-esmf.github.io/samm-specification/2.1.0/index.html + + + + + xs:string + + + + + + + + + + SustainabilityEntity + + + en + Sustainability Entity + + + + + en + Entity which includes information on the carbon footprint, sustainability documents and the status of the battery. + + + + + SustainabilityDocumentEntity + + + en + Sustainability Document Entity + + + + + en + Sustainability Document Entity which encapsulates relevant information in the form of documents. + + + + + separateCollection + + + en + Separate Collection + + + + + en + Documentation about separate collection of batteries involve information on how to properly collect, handle, and recycle batteries to ensure environmental sustainability and compliance with regulations. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1) (s), refers to Article 74: +1. In addition to the information referred to in Article 8a(2) of Directive 2008/98/EC, producers or, where appointed in accordance with Article 57(1), producer responsibility organisations shall make available to end-users and distributors the following information regarding the prevention and management of waste batteries with regard to the categories of batteries that they supply within the territory of a Member State: +(a) the role of end-users in contributing to waste prevention, including by information on good practices and recommendations concerning the use of batteries aimed at extending their use phase and the possibilities of re-use, preparation for re-use, preparation for repurposing, repurposing and remanufacturing; +(b) the role of end-users in contributing to the separate collection of waste batteries in accordance with their obligations under Article 64 to allow their treatment; +(c) the separate collection, take-back and collection points, preparation for re-use, preparation for repurposing and treatment available for waste batteries; +(d) the necessary safety instructions to handle waste batteries, including in relation to the risks associated with, and the handling of, batteries containing lithium; +(e) the meaning of the labels and symbols on batteries in accordance with Article 13 or printed on their packaging or in the documents accompanying batteries; and +(f) the impact of substances, in particular hazardous substances, present in batteries on the environment and on human health or the safety of persons, including the impact due to inappropriate discarding of waste batteries, such as littering or discarding as unsorted municipal waste. + + + true + DataElement + + + DocumentationEntity + + + en + Documentation Entity + + + + + en + Entity for a document with a header, type and content. + + + + + content + + + en + Content + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + xs:string + + + + contentType + + + en + Content Type + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + xs:string + + + + header + + + en + Header + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + xs:string + + + + + + + + wastePrevention + + + en + Waste Prevention + + + + + en + Documentation about waste prevention for batteries which include guidelines, recommendations, and information on minimizing the environmental impact associated with the use and disposal of batteries. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1) (s), refers to Article 74 (1) which call Article 8a of Directive 2008/98/EC: +2. Member States shall take the necessary measures to ensure that the waste holders targeted by the extended producer responsibility schemes established in accordance with Article 8 (1), are informed about waste prevention measures, centres for re-use and preparing for re-use, take-back and collection systems, and the prevention of littering. Member States shall also take measures to create incentives for the waste holders to assume their responsibility to deliver their waste into the separate collection systems in place, notably, where appropriate, through economic incentives or regulations. + + + true + DataElement + + + DocumentationEntity + + + en + Documentation Entity + + + + + en + Entity for a document with a header, type and content. + + + + + content + + + en + Content + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + xs:string + + + + contentType + + + en + Content Type + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + xs:string + + + + header + + + en + Header + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + xs:string + + + + + + + + euTaxonomyDisclosureStatement + + + en + EU Taxonomy Disclosure Statement + + + + + en + Optional disclosure regarding the EU taxonomy, with the choice to voluntarily provide the EU Taxonomy disclosure through the battery passport. + + + true + DataElement + + + DocumentationEntity + + + en + Documentation Entity + + + + + en + Entity for a document with a header, type and content. + + + + + content + + + en + Content + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + xs:string + + + + contentType + + + en + Content Type + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + xs:string + + + + header + + + en + Header + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + xs:string + + + + + + + + sustainabilityReport + + + en + Sustainability Report + + + + + en + Voluntarily making the Sustainability Report available via the battery passport. A report containing the information concerning the sustainability in form of a document. + + + true + DataElement + + + DocumentationEntity + + + en + Documentation Entity + + + + + en + Entity for a document with a header, type and content. + + + + + content + + + en + Content + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + xs:string + + + + contentType + + + en + Content Type + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + xs:string + + + + header + + + en + Header + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + xs:string + + + + + + + + + + carbonFootprint + + + en + Carbon Footprint + + + + + en + The carbon footprint of the battery calculated as kg of carbon dioxide equivalent per one kWh of the total energy provided by the battery over its expected service life. Relevant attributes are the value, the unit, the referenced rulebook, the lifecycle where applied, the declaration, the performance class, the type (PCF), the declaration and the facility. These attributes are mentioned in the Battery regulation 2023/1542 from 12 July 2023 in several places. +Annex XIII (1) (c) refers to Article 7 (2) which refers to Article 7 (1)(d): +1. For electric vehicle batteries, rechargeable industrial batteries with a capacity greater than 2 kWh and LMT batteries a carbon footprint declaration shall be drawn up for each battery model per manufacturing plant, in accordance with the implementing act referred to in the fourth subparagraph and containing, at least, the following information: +[...] (d) the carbon footprint of the battery, calculated as kg of carbon dioxide equivalent per one kWh of the total energy provided by the battery over its expected service life; +And as well in Article 7: +2. Electric vehicle batteries, rechargeable industrial batteries with a capacity greater than 2 kWh and LMT batteries shall bear a conspicuous, clearly legible and indelible label indicating the carbon footprint of the battery referred to in paragraph 1, first subparagraph, point (d) and declaring the carbon footprint performance class to which the relevant battery model per manufacturing plant corresponds. +Further specified in Annex XIII (1) (c) and refers to Article 7 (1): +[...] The Commission shall, by 18 February 2024 for electric vehicle batteries, 18 February 2025 for rechargeable industrial batteries, except those with external storage, 18 February 2027 for LMT batteries and 18 February 2029 for industrial batteries with external storage, adopt: +(a) a delegated act in accordance with Article 89 to supplement this Regulation by establishing the methodology for the calculation and verification of the carbon footprint of the battery referred to in the first subparagraph, point (d), in accordance with the essential elements set out in Annex II; +These parameters are defined by Article 3: +(21) "carbon footprint" means the sum of greenhouse gas emissions and greenhouse gas removals in a product system, expressed as carbon dioxide equivalents and based on a Product Environmental Footprint (PEF) study using the single impact category of climate change; +and defined by Annex II (2): +(e) "life cycle" means the consecutive and interlinked stages of a product system, from raw material acquisition or generation from natural resources to final disposal (ISO 14040:2006 or an equivalent standard). + + + true + DataElement + + + FootprintEntity + + + en + Footprint Entity + + + + + en + Footprint Entity for the carbon and environmental footprint with the total value, unit, impact category type, lifecycle, rulebook, declaration, performance class and the facility. + + + + + footprintValue + + + en + Footprint Value + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#footprintValue + + + + xs:float + + + + footprintRulebook + + + en + Footprint Rulebook + + + + + en + The applied rulebook for the environmental footprint of the product. + + + true + DataElement + + + DocumentationEntity + + + en + Documentation Entity + + + + + en + Entity for a document with a header, type and content. + + + + + content + + + en + Content + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + xs:string + + + + contentType + + + en + Content Type + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + xs:string + + + + header + + + en + Header + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + xs:string + + + + + + + + footprintLifecycle + + + en + Footprint Lifecycle + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#footprintLifecycle + + + + xs:string + + + + footprintUnit + + + en + Footprint Unit + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#footprintUnit + + + + xs:string + + + + footprintType + + + en + Footprint Type + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#footprintType + + + + xs:string + + + + performanceClass + + + en + Performance Class + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#performanceClass + + + + xs:string + + + + manufacturingPlant + + + en + Manufacturing Plant + + + + + en + The manufacturing plant of the footprint in the specific lifecycle phase. + + + true + DataElement + + + FacilityEntity + + + en + Facility Entity + + + + + en + The entity for a facility with the BPNA identifier. + + + + + facility + + + en + Facility + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#facility + + + + xs:string + + + + + + + + declaration + + + en + Declaration + + + + + en + The footprint declaration in the format of a link + + + true + DataElement + + + DocumentationEntity + + + en + Documentation Entity + + + + + en + Entity for a document with a header, type and content. + + + + + content + + + en + Content + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + xs:string + + + + contentType + + + en + Content Type + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + xs:string + + + + header + + + en + Header + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + xs:string + + + + + + + + + + + + state + + + en + State + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#state + + + + xs:string + + + + + + ChemicalMaterialEntity + + + en + Chemical Material Entity + + + + + en + Chemical Material Entity for the battery. Included are active, hazardous and critical materials as well as a material symbol. This is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Article 13: +5. All batteries containing more than 0,002 % cadmium or more than 0,004 % lead, shall be marked with the chemical symbol for the metal concerned: Cd or Pb. + + + + + ActiveMaterialEntity + + + en + Active Material Entity + + + + + en + Entity for the active materials included in the battery. Mandatory are nickel, lithium, cobalt and lead. + + + + + MaterialActiveEntity + + + en + Material Active Entity + + + + + en + The information on the active material with the recycled share, location and supporting document(s). + + + + + location + + + en + Location + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#location + + + + xs:string + + + + recycled + + + en + Recycled + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#recycled + + + + xs:float + + + + documentation + + + en + Documentation + + + + + en + Documentation accompanying the material. + + + true + DataElement + + + DocumentationEntity + + + en + Documentation Entity + + + + + en + Entity for a document with a header, type and content. + + + + + content + + + en + Content + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + xs:string + + + + contentType + + + en + Content Type + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + xs:string + + + + header + + + en + Header + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + xs:string + + + + + + + + critical + + + en + Critical + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#critical + + + + + + ExternalReference + + + GlobalReference + https://eur-lex.europa.eu/legal-content/EN/TXT/?uri=COM:2023:0160:FIN + + + + + xs:boolean + + + + + + MaterialActiveEntity + + + en + Material Active Entity + + + + + en + The information on the active material with the recycled share, location and supporting document(s). + + + + + location + + + en + Location + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#location + + + + xs:string + + + + recycled + + + en + Recycled + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#recycled + + + + xs:float + + + + documentation + + + en + Documentation + + + + + en + Documentation accompanying the material. + + + true + DataElement + + + DocumentationEntity + + + en + Documentation Entity + + + + + en + Entity for a document with a header, type and content. + + + + + content + + + en + Content + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + xs:string + + + + contentType + + + en + Content Type + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + xs:string + + + + header + + + en + Header + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + xs:string + + + + + + + + critical + + + en + Critical + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#critical + + + + + + ExternalReference + + + GlobalReference + https://eur-lex.europa.eu/legal-content/EN/TXT/?uri=COM:2023:0160:FIN + + + + + xs:boolean + + + + + + MaterialActiveEntity + + + en + Material Active Entity + + + + + en + The information on the active material with the recycled share, location and supporting document(s). + + + + + location + + + en + Location + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#location + + + + xs:string + + + + recycled + + + en + Recycled + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#recycled + + + + xs:float + + + + documentation + + + en + Documentation + + + + + en + Documentation accompanying the material. + + + true + DataElement + + + DocumentationEntity + + + en + Documentation Entity + + + + + en + Entity for a document with a header, type and content. + + + + + content + + + en + Content + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + xs:string + + + + contentType + + + en + Content Type + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + xs:string + + + + header + + + en + Header + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + xs:string + + + + + + + + critical + + + en + Critical + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#critical + + + + + + ExternalReference + + + GlobalReference + https://eur-lex.europa.eu/legal-content/EN/TXT/?uri=COM:2023:0160:FIN + + + + + xs:boolean + + + + + + LeadEntity + + + en + Lead Entity + + + + + en + Entity for lead. + + + + + impactOfSubstances + + + en + Impact of Substances + + + + + en + An accumulation of documents that refer to the impact, especially hazardous substances, on the battery. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1) (s), refers to Article 74: +1. In addition to the information referred to in Article 8a(2) of Directive 2008/98/EC, producers or, where appointed in accordance with Article 57(1), producer responsibility organisations shall make available to end-users and distributors the following information regarding the prevention and management of waste batteries with regard to the categories of batteries that they supply within the territory of a Member State: +[...] +(f) the impact of substances, in particular hazardous substances, present in batteries on the environment and on human health or the safety of persons, including the impact due to inappropriate discarding of waste batteries, such as littering or discarding as unsorted municipal waste. + + + true + DataElement + + + DocumentationEntity + + + en + Documentation Entity + + + + + en + Entity for a document with a header, type and content. + + + + + content + + + en + Content + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + xs:string + + + + contentType + + + en + Content Type + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + xs:string + + + + header + + + en + Header + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + xs:string + + + + + + + + critical + + + en + Critical + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#critical + + + + + + ExternalReference + + + GlobalReference + https://eur-lex.europa.eu/legal-content/EN/TXT/?uri=COM:2023:0160:FIN + + + + + xs:boolean + + + + documentation + + + en + Documentation + + + + + en + Documentation accompanying the material. + + + true + DataElement + + + DocumentationEntity + + + en + Documentation Entity + + + + + en + Entity for a document with a header, type and content. + + + + + content + + + en + Content + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + xs:string + + + + contentType + + + en + Content Type + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + xs:string + + + + header + + + en + Header + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + xs:string + + + + + + + + recycled + + + en + Recycled + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#recycled + + + + xs:float + + + + location + + + en + Location + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#location + + + + xs:string + + + + concentration + + + en + Concentration + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#concentration + + + + xs:float + + + + materialUnit + + + en + Material Unit + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#materialUnit + + + + + + ExternalReference + + + GlobalReference + https://eclipse-esmf.github.io/samm-specification/2.1.0/index.html + + + + + xs:string + + + + + + otherActiveMaterials + + + en + Other Active Materials + + + + + en + Other active materials in the battery. + + + true + DataElement + + + OtherActiveMaterialsEntity + + + en + Other Active Materials Entity + + + + + en + Entity for other active materials. + + + + + location + + + en + Location + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#location + + + + xs:string + + + + recycled + + + en + Recycled + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#recycled + + + + xs:float + + + + documentation + + + en + Documentation + + + + + en + Documentation accompanying the material. + + + true + DataElement + + + DocumentationEntity + + + en + Documentation Entity + + + + + en + Entity for a document with a header, type and content. + + + + + content + + + en + Content + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + xs:string + + + + contentType + + + en + Content Type + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + xs:string + + + + header + + + en + Header + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + xs:string + + + + + + + + critical + + + en + Critical + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#critical + + + + + + ExternalReference + + + GlobalReference + https://eur-lex.europa.eu/legal-content/EN/TXT/?uri=COM:2023:0160:FIN + + + + + xs:boolean + + + + materialIdentification + + + en + Material Identification + + + + + en + The chemical material name and identification, in accordance with the specification in the attribute for the list type. Preference is given to the IUPAC name. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Article 7: +(5) (a) the name of the substances of concern present in the product, as follows: + - name(s) in the International Union of Pure and Applied Chemistry (IUPAC) nomenclature, or another international name when IUPAC name is not available; +- other names (usual name, trade name, abbreviation); +- European Community (EC) number, as indicated in the European Inventory of Existing Commercial Chemical Substances (EINECS), the European List of Notified Chemical Substances (ELINCS) or the No Longer Polymer (NLP) list or assigned by the European Chemicals Agency (ECHA), if available; +- the Chemical Abstract Service (CAS) name(s) and number(s), if available; . + + + true + DataElement + + + MaterialIdEntity + + + en + Material Id Entity + + + + + en + Id Entity with identifier, name and list type. + + + + + chemicalId + + + en + Chemical Id + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#chemicalId + + + + xs:string + + + + listTypeId + + + en + List Type Id + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#listTypeId + + + + xs:string + + + + chemicalName + + + en + Chemical Name + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#chemicalName + + + + xs:string + + + + + + + + + + + + + + HazardousSubstanceEntity + + + en + Hazardous Substance Entity + + + + + en + Hazardous Substance Entity for hazardous chemical materials. + + + + + HazardousEntity + + + en + Hazardous Entity + + + + + en + Material Entity to describe the material composition for hazardous materials. + + + + + impactOfSubstances + + + en + Impact of Substances + + + + + en + An accumulation of documents that refer to the impact, especially hazardous substances, on the battery. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1) (s), refers to Article 74: +1. In addition to the information referred to in Article 8a(2) of Directive 2008/98/EC, producers or, where appointed in accordance with Article 57(1), producer responsibility organisations shall make available to end-users and distributors the following information regarding the prevention and management of waste batteries with regard to the categories of batteries that they supply within the territory of a Member State: +[...] +(f) the impact of substances, in particular hazardous substances, present in batteries on the environment and on human health or the safety of persons, including the impact due to inappropriate discarding of waste batteries, such as littering or discarding as unsorted municipal waste. + + + true + DataElement + + + DocumentationEntity + + + en + Documentation Entity + + + + + en + Entity for a document with a header, type and content. + + + + + content + + + en + Content + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + xs:string + + + + contentType + + + en + Content Type + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + xs:string + + + + header + + + en + Header + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + xs:string + + + + + + + + concentration + + + en + Concentration + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#concentration + + + + xs:float + + + + location + + + en + Location + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#location + + + + xs:string + + + + materialUnit + + + en + Material Unit + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#materialUnit + + + + + + ExternalReference + + + GlobalReference + https://eclipse-esmf.github.io/samm-specification/2.1.0/index.html + + + + + xs:string + + + + critical + + + en + Critical + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#critical + + + + + + ExternalReference + + + GlobalReference + https://eur-lex.europa.eu/legal-content/EN/TXT/?uri=COM:2023:0160:FIN + + + + + xs:boolean + + + + documentation + + + en + Documentation + + + + + en + Documentation accompanying the material. + + + true + DataElement + + + DocumentationEntity + + + en + Documentation Entity + + + + + en + Entity for a document with a header, type and content. + + + + + content + + + en + Content + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + xs:string + + + + contentType + + + en + Content Type + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + xs:string + + + + header + + + en + Header + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + xs:string + + + + + + + + + + HazardousEntity + + + en + Hazardous Entity + + + + + en + Material Entity to describe the material composition for hazardous materials. + + + + + impactOfSubstances + + + en + Impact of Substances + + + + + en + An accumulation of documents that refer to the impact, especially hazardous substances, on the battery. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1) (s), refers to Article 74: +1. In addition to the information referred to in Article 8a(2) of Directive 2008/98/EC, producers or, where appointed in accordance with Article 57(1), producer responsibility organisations shall make available to end-users and distributors the following information regarding the prevention and management of waste batteries with regard to the categories of batteries that they supply within the territory of a Member State: +[...] +(f) the impact of substances, in particular hazardous substances, present in batteries on the environment and on human health or the safety of persons, including the impact due to inappropriate discarding of waste batteries, such as littering or discarding as unsorted municipal waste. + + + true + DataElement + + + DocumentationEntity + + + en + Documentation Entity + + + + + en + Entity for a document with a header, type and content. + + + + + content + + + en + Content + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + xs:string + + + + contentType + + + en + Content Type + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + xs:string + + + + header + + + en + Header + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + xs:string + + + + + + + + concentration + + + en + Concentration + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#concentration + + + + xs:float + + + + location + + + en + Location + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#location + + + + xs:string + + + + materialUnit + + + en + Material Unit + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#materialUnit + + + + + + ExternalReference + + + GlobalReference + https://eclipse-esmf.github.io/samm-specification/2.1.0/index.html + + + + + xs:string + + + + critical + + + en + Critical + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#critical + + + + + + ExternalReference + + + GlobalReference + https://eur-lex.europa.eu/legal-content/EN/TXT/?uri=COM:2023:0160:FIN + + + + + xs:boolean + + + + documentation + + + en + Documentation + + + + + en + Documentation accompanying the material. + + + true + DataElement + + + DocumentationEntity + + + en + Documentation Entity + + + + + en + Entity for a document with a header, type and content. + + + + + content + + + en + Content + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + xs:string + + + + contentType + + + en + Content Type + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + xs:string + + + + header + + + en + Header + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + xs:string + + + + + + + + + + otherHazardousMaterial + + + en + Other Hazardous Material + + + + + en + Other hazardous materials. + + + true + DataElement + + + OtherHazardousMaterialEntity + + + en + Other HazardousMaterial Entity + + + + + en + Entity for other hazardous materials. + + + + + impactOfSubstances + + + en + Impact of Substances + + + + + en + An accumulation of documents that refer to the impact, especially hazardous substances, on the battery. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1) (s), refers to Article 74: +1. In addition to the information referred to in Article 8a(2) of Directive 2008/98/EC, producers or, where appointed in accordance with Article 57(1), producer responsibility organisations shall make available to end-users and distributors the following information regarding the prevention and management of waste batteries with regard to the categories of batteries that they supply within the territory of a Member State: +[...] +(f) the impact of substances, in particular hazardous substances, present in batteries on the environment and on human health or the safety of persons, including the impact due to inappropriate discarding of waste batteries, such as littering or discarding as unsorted municipal waste. + + + true + DataElement + + + DocumentationEntity + + + en + Documentation Entity + + + + + en + Entity for a document with a header, type and content. + + + + + content + + + en + Content + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + xs:string + + + + contentType + + + en + Content Type + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + xs:string + + + + header + + + en + Header + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + xs:string + + + + + + + + materialUnit + + + en + Material Unit + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#materialUnit + + + + + + ExternalReference + + + GlobalReference + https://eclipse-esmf.github.io/samm-specification/2.1.0/index.html + + + + + xs:string + + + + concentration + + + en + Concentration + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#concentration + + + + xs:float + + + + materialIdentification + + + en + Material Identification + + + + + en + The chemical material name and identification, in accordance with the specification in the attribute for the list type. Preference is given to the IUPAC name. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Article 7: +(5) (a) the name of the substances of concern present in the product, as follows: + - name(s) in the International Union of Pure and Applied Chemistry (IUPAC) nomenclature, or another international name when IUPAC name is not available; +- other names (usual name, trade name, abbreviation); +- European Community (EC) number, as indicated in the European Inventory of Existing Commercial Chemical Substances (EINECS), the European List of Notified Chemical Substances (ELINCS) or the No Longer Polymer (NLP) list or assigned by the European Chemicals Agency (ECHA), if available; +- the Chemical Abstract Service (CAS) name(s) and number(s), if available; . + + + true + DataElement + + + MaterialIdEntity + + + en + Material Id Entity + + + + + en + Id Entity with identifier, name and list type. + + + + + chemicalId + + + en + Chemical Id + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#chemicalId + + + + xs:string + + + + listTypeId + + + en + List Type Id + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#listTypeId + + + + xs:string + + + + chemicalName + + + en + Chemical Name + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#chemicalName + + + + xs:string + + + + + + + + documentation + + + en + Documentation + + + + + en + Documentation accompanying the material. + + + true + DataElement + + + DocumentationEntity + + + en + Documentation Entity + + + + + en + Entity for a document with a header, type and content. + + + + + content + + + en + Content + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + xs:string + + + + contentType + + + en + Content Type + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + xs:string + + + + header + + + en + Header + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + xs:string + + + + + + + + critical + + + en + Critical + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#critical + + + + + + ExternalReference + + + GlobalReference + https://eur-lex.europa.eu/legal-content/EN/TXT/?uri=COM:2023:0160:FIN + + + + + xs:boolean + + + + location + + + en + Location + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#location + + + + xs:string + + + + + + + + LeadEntity + + + en + Lead Entity + + + + + en + Entity for lead. + + + + + impactOfSubstances + + + en + Impact of Substances + + + + + en + An accumulation of documents that refer to the impact, especially hazardous substances, on the battery. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1) (s), refers to Article 74: +1. In addition to the information referred to in Article 8a(2) of Directive 2008/98/EC, producers or, where appointed in accordance with Article 57(1), producer responsibility organisations shall make available to end-users and distributors the following information regarding the prevention and management of waste batteries with regard to the categories of batteries that they supply within the territory of a Member State: +[...] +(f) the impact of substances, in particular hazardous substances, present in batteries on the environment and on human health or the safety of persons, including the impact due to inappropriate discarding of waste batteries, such as littering or discarding as unsorted municipal waste. + + + true + DataElement + + + DocumentationEntity + + + en + Documentation Entity + + + + + en + Entity for a document with a header, type and content. + + + + + content + + + en + Content + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + xs:string + + + + contentType + + + en + Content Type + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + xs:string + + + + header + + + en + Header + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + xs:string + + + + + + + + critical + + + en + Critical + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#critical + + + + + + ExternalReference + + + GlobalReference + https://eur-lex.europa.eu/legal-content/EN/TXT/?uri=COM:2023:0160:FIN + + + + + xs:boolean + + + + documentation + + + en + Documentation + + + + + en + Documentation accompanying the material. + + + true + DataElement + + + DocumentationEntity + + + en + Documentation Entity + + + + + en + Entity for a document with a header, type and content. + + + + + content + + + en + Content + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + xs:string + + + + contentType + + + en + Content Type + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + xs:string + + + + header + + + en + Header + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + xs:string + + + + + + + + recycled + + + en + Recycled + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#recycled + + + + xs:float + + + + location + + + en + Location + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#location + + + + xs:string + + + + concentration + + + en + Concentration + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#concentration + + + + xs:float + + + + materialUnit + + + en + Material Unit + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#materialUnit + + + + + + ExternalReference + + + GlobalReference + https://eclipse-esmf.github.io/samm-specification/2.1.0/index.html + + + + + xs:string + + + + + + + + materialComposition + + + en + Material Composition + + + + + en + The materials which are necessary to describe the material composition, especially if they are active, critical or hazardous. This can be redundant to the specifically mentioned active or hazardous materials. This is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1): +(b) the material composition of the battery, including its chemistry, hazardous substances present in the battery, other than mercury, cadmium or lead, and critical raw materials present in the battery; +(f) the share of renewable content. +and in Annex XIII (2): +(a) detailed composition, including materials used in the cathode, anode and electrolyte; +Definition from Article 3: +(52) "hazardous substance" means a substance classified as hazardous pursuant to Article 3 of Regulation (EC) No 1272/2008: +A substance or a mixture fulfilling the criteria relating to physical hazards, health hazards or environmental hazards, laid down in Parts 2 to 5 of Annex I is hazardous and shall be classified in relation to the respective hazard classes provided for in that Annex. +Where, in Annex I, hazard classes are differentiated on the basis of the route of exposure or the nature of the effects, the substance or mixture shall be classified in accordance with such differentiation. +Defined in Article 2 of Regulation (EC) No 1272/2008: +1. hazard class" means the nature of the physical, health or environmental hazard. + + + true + DataElement + + + MaterialCompositionEntity + + + en + Material Composition Entity + + + + + en + Entity for the material composition. + + + + + materialIdentification + + + en + Material Identification + + + + + en + The chemical material name and identification, in accordance with the specification in the attribute for the list type. Preference is given to the IUPAC name. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Article 7: +(5) (a) the name of the substances of concern present in the product, as follows: + - name(s) in the International Union of Pure and Applied Chemistry (IUPAC) nomenclature, or another international name when IUPAC name is not available; +- other names (usual name, trade name, abbreviation); +- European Community (EC) number, as indicated in the European Inventory of Existing Commercial Chemical Substances (EINECS), the European List of Notified Chemical Substances (ELINCS) or the No Longer Polymer (NLP) list or assigned by the European Chemicals Agency (ECHA), if available; +- the Chemical Abstract Service (CAS) name(s) and number(s), if available; . + + + true + DataElement + + + MaterialIdEntity + + + en + Material Id Entity + + + + + en + Id Entity with identifier, name and list type. + + + + + chemicalId + + + en + Chemical Id + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#chemicalId + + + + xs:string + + + + listTypeId + + + en + List Type Id + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#listTypeId + + + + xs:string + + + + chemicalName + + + en + Chemical Name + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#chemicalName + + + + xs:string + + + + + + + + concentration + + + en + Concentration + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#concentration + + + + xs:float + + + + materialUnit + + + en + Material Unit + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#materialUnit + + + + + + ExternalReference + + + GlobalReference + https://eclipse-esmf.github.io/samm-specification/2.1.0/index.html + + + + + xs:string + + + + critical + + + en + Critical + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#critical + + + + + + ExternalReference + + + GlobalReference + https://eur-lex.europa.eu/legal-content/EN/TXT/?uri=COM:2023:0160:FIN + + + + + xs:boolean + + + + documentation + + + en + Documentation + + + + + en + Documentation accompanying the material. + + + true + DataElement + + + DocumentationEntity + + + en + Documentation Entity + + + + + en + Entity for a document with a header, type and content. + + + + + content + + + en + Content + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + xs:string + + + + contentType + + + en + Content Type + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + xs:string + + + + header + + + en + Header + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + xs:string + + + + + + + + recycled + + + en + Recycled + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#recycled + + + + xs:float + + + + location + + + en + Location + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#location + + + + xs:string + + + + renewable + + + en + Renewable + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#renewable + + + + xs:float + + + + + + + + + + PerformanceEntity + + + en + Performance Entity + + + + + en + Performance Entity with attributes of the battery including rated and dynamic values. + + + + + RatedPerformanceEntity + + + en + Rated Performance Entity + + + + + en + Entity for rated performance values of the battery. + + + + + VoltageEntity + + + en + Voltage Entity + + + + + en + Entity for voltage values. + + + + + minVoltage + + + en + Minimum Voltage + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.battery.battery_pass:6.0.0#minVoltage + + + + xs:double + + + + maxVoltage + + + en + Maximum Voltage + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.battery.battery_pass:6.0.0#maxVoltage + + + + xs:double + + + + nominalVoltage + + + en + Nominal Voltage + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.battery.battery_pass:6.0.0#nominalVoltage + + + + xs:double + + + + testingTemperature + + + en + Testing Temperature + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.battery.battery_pass:6.0.0#testingTemperature + + + + xs:double + + + + + + RatedRoundTripEfficiencyEntity + + + en + Rated Round Trip Efficiency Entity + + + + + en + Entity for the rated round trip efficiency. + + + + + depthOfDischarge + + + en + Depth of Discharge + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.battery.battery_pass:6.0.0#depthOfDischarge + + + + xs:double + + + + initialRoundTripEfficiency + + + en + Initial Round Trip Efficiency + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.battery.battery_pass:6.0.0#initialRoundTripEfficiency + + + + xs:double + + + + roundTripEfficiency50Percent + + + en + Round Trip Efficiency 50 Percent + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.battery.battery_pass:6.0.0#roundTripEfficiency50Percent + + + + xs:double + + + + testingTemperature + + + en + Testing Temperature + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.battery.battery_pass:6.0.0#testingTemperature + + + + xs:double + + + + + + RatedEnergyEntity + + + en + Rated Energy Entity + + + + + en + Entity for the rated energy. + + + + + energyValue + + + en + Energy Value + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.battery.battery_pass:6.0.0#energyValue + + + + xs:double + + + + testingTemperature + + + en + Testing Temperature + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.battery.battery_pass:6.0.0#testingTemperature + + + + xs:double + + + + + + RatedResistanceEntity + + + en + Rated Resistance Entity + + + + + en + Entity for rated resistance values of the battery on different levels. + + + + + cellResistance + + + en + Cell Resistance + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.battery.battery_pass:6.0.0#cellResistance + + + + xs:double + + + + moduleResistance + + + en + Module Resistance + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.battery.battery_pass:6.0.0#moduleResistance + + + + xs:double + + + + packResistance + + + en + Pack Resistance + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.battery.battery_pass:6.0.0#packResistance + + + + xs:double + + + + testingTemperature + + + en + Testing Temperature + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.battery.battery_pass:6.0.0#testingTemperature + + + + xs:double + + + + + + RatedPowerEntity + + + en + Rated Power Entity + + + + + en + Entity for rated power values. + + + + + powerValue + + + en + Power Value + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.battery.battery_pass:6.0.0#powerValue + + + + xs:double + + + + capabilityAt20SoC + + + en + Capability at 20 SoC + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.battery.battery_pass:6.0.0#capabilityAt20SoC + + + + xs:double + + + + capabilityAt80SoC + + + en + Capability at 80 SoC + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.battery.battery_pass:6.0.0#capabilityAt80SoC + + + + xs:double + + + + testingTemperature + + + en + Testing Temperature + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.battery.battery_pass:6.0.0#testingTemperature + + + + xs:double + + + + + + RatedCapacityEntity + + + en + Rated Capacity Entity + + + + + en + Entity for rated capacity values. + + + + + capacityValue + + + en + Capacity Value + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.battery.battery_pass:6.0.0#capacityValue + + + + xs:double + + + + capacityThresholdExhaustion + + + en + Capacity Threshold Exhaustion + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.battery.battery_pass:6.0.0#capacityThresholdExhaustion + + + + xs:double + + + + testingTemperature + + + en + Testing Temperature + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.battery.battery_pass:6.0.0#testingTemperature + + + + xs:double + + + + + + performanceDocument + + + en + Performance Document + + + + + en + The performance document lists information regarding the performance of the battery. This can be an overview about several rated performance attributes. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (3): +[...] results of test reports proving compliance with the requirements laid down in this Regulation or any delegated or implementing act adopted pursuant to this Regulation. +And Annex XIII (4)(a) refers to Article 10(1) and refer to Annex IV Part B: +5. Any calculations performed with the measured parameters, if applicable. + + + true + DataElement + + + DocumentationEntity + + + en + Documentation Entity + + + + + en + Entity for a document with a header, type and content. + + + + + content + + + en + Content + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + xs:string + + + + contentType + + + en + Content Type + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + xs:string + + + + header + + + en + Header + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + xs:string + + + + + + + + PerformanceTemperatureEntity + + + en + Performance Temperature Entity + + + + + en + Entity for temperature values. + + + + + lowerTemperatureBoundary + + + en + Lower Temperature Boundary + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.battery.battery_pass:6.0.0#lowerTemperatureBoundary + + + + xs:double + + + + upperTemperatureBoundary + + + en + Upper Temperature Boundary + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.battery.battery_pass:6.0.0#upperTemperatureBoundary + + + + xs:double + + + + + + selfDischargingRate + + + en + Self Discharging Rate + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.battery.battery_pass:6.0.0#selfDischargingRate + + + + xs:double + + + + testReport + + + en + Test Report + + + + + en + The test reports refer to the testing conducted during the determination of the rated values of the battery. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (3): +[...] results of test reports proving compliance with the requirements laid down in this Regulation or any delegated or implementing act adopted pursuant to this Regulation. +And Annex XIII (4)(a) refers to Article 10(1) and refer to Annex IV Part B: +5. Any calculations performed with the measured parameters, if applicable. + + + true + DataElement + + + DocumentationEntity + + + en + Documentation Entity + + + + + en + Entity for a document with a header, type and content. + + + + + content + + + en + Content + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + xs:string + + + + contentType + + + en + Content Type + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + xs:string + + + + header + + + en + Header + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + xs:string + + + + + + + + LifeCycleEntity + + + en + Life Cycle Entity + + + + + en + Life Cycle Entity with attributes for the lifetime evaluation of a battery such as expected years and cycles, if applicable. + + + + + expectedYears + + + en + Expected Years + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.battery.battery_pass:6.0.0#expectedYears + + + + xs:integer + + + + testReport + + + en + Test Report + + + + + en + The test reports refer to the testing conducted during the determination of the rated values of the battery. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (3): +[...] results of test reports proving compliance with the requirements laid down in this Regulation or any delegated or implementing act adopted pursuant to this Regulation. +And Annex XIII (4)(a) refers to Article 10(1) and refer to Annex IV Part B: +5. Any calculations performed with the measured parameters, if applicable. + + + true + DataElement + + + DocumentationEntity + + + en + Documentation Entity + + + + + en + Entity for a document with a header, type and content. + + + + + content + + + en + Content + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + xs:string + + + + contentType + + + en + Content Type + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + xs:string + + + + header + + + en + Header + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + xs:string + + + + + + + + CycleLifeEntity + + + en + Cycle Life Entity + + + + + en + Cycle Life Characteristic for the battery lifetime testing with the cycles, temperature, depth of discharge and applied c-rates. + + + + + testingTemperature + + + en + Testing Temperature + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.battery.battery_pass:6.0.0#testingTemperature + + + + xs:double + + + + cycles + + + en + Cycles + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.battery.battery_pass:6.0.0#cycles + + + + xs:integer + + + + depthOfDischarge + + + en + Depth of Discharge + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.battery.battery_pass:6.0.0#depthOfDischarge + + + + xs:double + + + + appliedChargeRate + + + en + Applied Charge Rate + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.battery.battery_pass:6.0.0#appliedChargeRate + + + + xs:double + + + + appliedDischargeRate + + + en + Applied Discharge Rate + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.battery.battery_pass:6.0.0#appliedDischargeRate + + + + xs:double + + + + + + + + + + DynamicPerformanceEntity + + + en + Dynamic Performance Entity + + + + + en + Entity for dynamic performance values of the battery. + + + + + RecordEntity + + + en + Record Entity + + + + + en + Entity for a dynamic record with a value and timestamp. + + + + + percentValue + + + en + Percent Value + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.battery.battery_pass:6.0.0#percentValue + + + + xs:double + + + + dataRecordTime + + + en + Data Record Time + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.battery.battery_pass:6.0.0#dataRecordTime + + + + xs:dateTime + + + + + + FullCycleEntity + + + en + Full Cycle Entity + + + + + en + Entity for dynamic cycle values. + + + + + dataRecordTime + + + en + Data Record Time + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.battery.battery_pass:6.0.0#dataRecordTime + + + + xs:dateTime + + + + cycles + + + en + Cycles + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.battery.battery_pass:6.0.0#cycles + + + + xs:integer + + + + + + performanceDocument + + + en + Performance Document + + + + + en + The performance document lists information regarding the performance of the battery. This can be an overview about several rated performance attributes. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (3): +[...] results of test reports proving compliance with the requirements laid down in this Regulation or any delegated or implementing act adopted pursuant to this Regulation. +And Annex XIII (4)(a) refers to Article 10(1) and refer to Annex IV Part B: +5. Any calculations performed with the measured parameters, if applicable. + + + true + DataElement + + + DocumentationEntity + + + en + Documentation Entity + + + + + en + Entity for a document with a header, type and content. + + + + + content + + + en + Content + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + xs:string + + + + contentType + + + en + Content Type + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + xs:string + + + + header + + + en + Header + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + xs:string + + + + + + + + selfDischargingRate + + + en + Self Discharging Rate + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.battery.battery_pass:6.0.0#selfDischargingRate + + + + xs:double + + + + DynamicPowerEntity + + + en + Dynamic Power Entity + + + + + en + Entity for dynamic power values. + + + + + RecordEntity + + + en + Record Entity + + + + + en + Entity for a dynamic record with a value and timestamp. + + + + + percentValue + + + en + Percent Value + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.battery.battery_pass:6.0.0#percentValue + + + + xs:double + + + + dataRecordTime + + + en + Data Record Time + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.battery.battery_pass:6.0.0#dataRecordTime + + + + xs:dateTime + + + + + + RemainingPowerEntity + + + en + Remaining Power Entity + + + + + en + Entity for the remaining power. + + + + + dataRecordTime + + + en + Data Record Time + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.battery.battery_pass:6.0.0#dataRecordTime + + + + xs:dateTime + + + + powerValue + + + en + Power Value + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.battery.battery_pass:6.0.0#powerValue + + + + xs:double + + + + + + + + DynamicCapacityEntity + + + en + Dynamic Capacity Entity + + + + + en + Entity for dynamic capacity values. + + + + + RecordEntity + + + en + Record Entity + + + + + en + Entity for a dynamic record with a value and timestamp. + + + + + percentValue + + + en + Percent Value + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.battery.battery_pass:6.0.0#percentValue + + + + xs:double + + + + dataRecordTime + + + en + Data Record Time + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.battery.battery_pass:6.0.0#dataRecordTime + + + + xs:dateTime + + + + + + CapacityEntity + + + en + Capacity Entity + + + + + en + Entity for dynamic capacity values such as the throughput and the remaining capacity. + + + + + dataRecordTime + + + en + Data Record Time + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.battery.battery_pass:6.0.0#dataRecordTime + + + + xs:dateTime + + + + capacityValue + + + en + Capacity Value + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.battery.battery_pass:6.0.0#capacityValue + + + + xs:double + + + + + + CapacityEntity + + + en + Capacity Entity + + + + + en + Entity for dynamic capacity values such as the throughput and the remaining capacity. + + + + + dataRecordTime + + + en + Data Record Time + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.battery.battery_pass:6.0.0#dataRecordTime + + + + xs:dateTime + + + + capacityValue + + + en + Capacity Value + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.battery.battery_pass:6.0.0#capacityValue + + + + xs:double + + + + + + + + DynamicRoundTripEfficiencyEntity + + + en + Dynamic Round Trip Efficiency Entity + + + + + en + Entity for dynamic round trip efficiency values. + + + + + RecordEntity + + + en + Record Entity + + + + + en + Entity for a dynamic record with a value and timestamp. + + + + + percentValue + + + en + Percent Value + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.battery.battery_pass:6.0.0#percentValue + + + + xs:double + + + + dataRecordTime + + + en + Data Record Time + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.battery.battery_pass:6.0.0#dataRecordTime + + + + xs:dateTime + + + + + + RecordEntity + + + en + Record Entity + + + + + en + Entity for a dynamic record with a value and timestamp. + + + + + percentValue + + + en + Percent Value + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.battery.battery_pass:6.0.0#percentValue + + + + xs:double + + + + dataRecordTime + + + en + Data Record Time + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.battery.battery_pass:6.0.0#dataRecordTime + + + + xs:dateTime + + + + + + + + DynamicInternalResistanceEntity + + + en + Dynamic Internal Resistance Entity + + + + + en + Entity for dynamic internal resistance values. + + + + + ResistanceIncreaseEntity + + + en + Resistance Increase Entity + + + + + en + Entity for the increase of the battery resistance. + + + + + RecordEntity + + + en + Record Entity + + + + + en + Entity for a dynamic record with a value and timestamp. + + + + + percentValue + + + en + Percent Value + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.battery.battery_pass:6.0.0#percentValue + + + + xs:double + + + + dataRecordTime + + + en + Data Record Time + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.battery.battery_pass:6.0.0#dataRecordTime + + + + xs:dateTime + + + + + + RecordEntity + + + en + Record Entity + + + + + en + Entity for a dynamic record with a value and timestamp. + + + + + percentValue + + + en + Percent Value + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.battery.battery_pass:6.0.0#percentValue + + + + xs:double + + + + dataRecordTime + + + en + Data Record Time + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.battery.battery_pass:6.0.0#dataRecordTime + + + + xs:dateTime + + + + + + RecordEntity + + + en + Record Entity + + + + + en + Entity for a dynamic record with a value and timestamp. + + + + + percentValue + + + en + Percent Value + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.battery.battery_pass:6.0.0#percentValue + + + + xs:double + + + + dataRecordTime + + + en + Data Record Time + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.battery.battery_pass:6.0.0#dataRecordTime + + + + xs:dateTime + + + + + + + + RemainingResistanceEntity + + + en + Remaining Resistance Entity + + + + + en + Entity for the remaining battery resistance. + + + + + RemainingResistanceEntityRecord + + + en + Remaining Resistance Entity Record + + + + + en + Entity for the remaining battery resistance with a timestamp and value. + + + + + dataRecordTime + + + en + Data Record Time + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.battery.battery_pass:6.0.0#dataRecordTime + + + + xs:dateTime + + + + remainingResistanceValue + + + en + Remaining Resistance Value + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.battery.battery_pass:6.0.0#remainingResistanceValue + + + + xs:double + + + + + + RemainingResistanceEntityRecord + + + en + Remaining Resistance Entity Record + + + + + en + Entity for the remaining battery resistance with a timestamp and value. + + + + + dataRecordTime + + + en + Data Record Time + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.battery.battery_pass:6.0.0#dataRecordTime + + + + xs:dateTime + + + + remainingResistanceValue + + + en + Remaining Resistance Value + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.battery.battery_pass:6.0.0#remainingResistanceValue + + + + xs:double + + + + + + RemainingResistanceEntityRecord + + + en + Remaining Resistance Entity Record + + + + + en + Entity for the remaining battery resistance with a timestamp and value. + + + + + dataRecordTime + + + en + Data Record Time + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.battery.battery_pass:6.0.0#dataRecordTime + + + + xs:dateTime + + + + remainingResistanceValue + + + en + Remaining Resistance Value + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.battery.battery_pass:6.0.0#remainingResistanceValue + + + + xs:double + + + + + + + + + + DynamicEnergyEntity + + + en + Dynamic Energy Entity + + + + + en + Entity for dynamic energy values. + + + + + RecordEntity + + + en + Record Entity + + + + + en + Entity for a dynamic record with a value and timestamp. + + + + + percentValue + + + en + Percent Value + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.battery.battery_pass:6.0.0#percentValue + + + + xs:double + + + + dataRecordTime + + + en + Data Record Time + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.battery.battery_pass:6.0.0#dataRecordTime + + + + xs:dateTime + + + + + + EnergyEntity + + + en + Energy Entity + + + + + en + Entity for energy values expressed in a timestamp and a kilowatt-hours value. + + + + + dataRecordTime + + + en + Data Record Time + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.battery.battery_pass:6.0.0#dataRecordTime + + + + xs:dateTime + + + + energyValue + + + en + Energy Value + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.battery.battery_pass:6.0.0#energyValue + + + + xs:double + + + + + + EnergyEntity + + + en + Energy Entity + + + + + en + Entity for energy values expressed in a timestamp and a kilowatt-hours value. + + + + + dataRecordTime + + + en + Data Record Time + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.battery.battery_pass:6.0.0#dataRecordTime + + + + xs:dateTime + + + + energyValue + + + en + Energy Value + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.battery.battery_pass:6.0.0#energyValue + + + + xs:double + + + + + + + + negativeEvents + + + en + Negative Events + + + + + en + Mandatory if applicable. Negative events refers to several possible events influencing the battery's condition and lifetime such as extreme temperatures. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (4): +(d) information and data resulting from its use, including the number of charging and discharging cycles and negative events, such as accidents, as well as periodically recorded information on the operating environmental conditions, including temperature, and on the state of charge. +And Annex VII Part B: +4. the tracking of harmful events, such as the number of deep discharge events, time spent in extreme temperatures, time spent charging in extreme temperatures. + + + true + DataElement + + + DocumentationEntity + + + en + Documentation Entity + + + + + en + Entity for a document with a header, type and content. + + + + + content + + + en + Content + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + xs:string + + + + contentType + + + en + Content Type + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + xs:string + + + + header + + + en + Header + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + xs:string + + + + + + + + operatingEnvironment + + + en + Operating Environment + + + + + en + Mandatory if applicable. The operating environment refers to the conditions in which the battery is designed to function optimally. The environment includes factors such as temperature, humidity, pressure, and other external conditions that can impact the performance, safety, and lifespan of the battery. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (4): +(d) information and data resulting from its use, including the number of charging and discharging cycles and negative events, such as accidents, as well as periodically recorded information on the operating environmental conditions, including temperature, and on the state of charge. +And Annex VII Part B: +4. the tracking of harmful events, such as the number of deep discharge events, time spent in extreme temperatures, time spent charging in extreme temperatures. + + + true + DataElement + + + DocumentationEntity + + + en + Documentation Entity + + + + + en + Entity for a document with a header, type and content. + + + + + content + + + en + Content + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + xs:string + + + + contentType + + + en + Content Type + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + xs:string + + + + header + + + en + Header + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + xs:string + + + + + + + + + + + + ConformityEntity + + + en + Conformity Entity + + + + + en + Entity for conformity documents. + + + + + declarationOfConformityId + + + en + Declaration of Conformity Id + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.battery.battery_pass:6.0.0#declarationOfConformityId + + + + xs:string + + + + declarationOfConformity + + + en + Declaration of Conformity + + + + + en + The EU Declaration of Conformity is a document in which the manufacturer or their authorized representative declares that the battery complies with all relevant European Union product safety directives and regulations. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1): +(r) the EU declaration of conformity referred to in Article 18. + + + true + DataElement + + + DocumentationEntity + + + en + Documentation Entity + + + + + en + Entity for a document with a header, type and content. + + + + + content + + + en + Content + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + xs:string + + + + contentType + + + en + Content Type + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + xs:string + + + + header + + + en + Header + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + xs:string + + + + + + + + resultOfTestReport + + + en + Result of Test Report + + + + + en + The result of tests reports refers to the results of various tests conducted with the battery, testing its life cycle, life span, c-rate and various other aspects. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1): +(l) temperature range the battery can withstand when not in use (reference test); +and Annex XIII (3): +results of test reports proving compliance with the requirements laid down in this Regulation or any delegated or implementing act adopted pursuant to this Regulation. + + + true + DataElement + + + DocumentationEntity + + + en + Documentation Entity + + + + + en + Entity for a document with a header, type and content. + + + + + content + + + en + Content + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + xs:string + + + + contentType + + + en + Content Type + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + xs:string + + + + header + + + en + Header + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + xs:string + + + + + + + + thirdPartyAssurance + + + en + Third Party Assurance + + + + + en + A summary report from third-parties, covering the verifications. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1) (d) refers to the Article 52: +3. The economic operator referred to in Article 48(1) shall on an annual basis review and make publicly available, including on the internet, a report on its battery due diligence policy. [...], as well as a summary report of the third-party verifications carried out in accordance with Article 51, including the name of the notified body, with due regard for business confidentiality and other competitive concerns. That report shall also cover, where relevant, access to information, public participation in decision-making and access to justice in environmental matters in relation to the sourcing, processing and trading of the raw materials present in batteries. + + + true + DataElement + + + DocumentationEntity + + + en + Documentation Entity + + + + + en + Entity for a document with a header, type and content. + + + + + content + + + en + Content + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + xs:string + + + + contentType + + + en + Content Type + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + xs:string + + + + header + + + en + Header + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + xs:string + + + + + + + + dueDiligencePolicy + + + en + Due Diligence Policy + + + + + en + A report containing the information concerning the due diligence policy, a set of procedures and guidelines the organization follows to thoroughly assess and evaluate the various aspects of the battery. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1) (d) refers to the Article 52: +3. The economic operator referred to in Article 48(1) shall on an annual basis review and make publicly available, including on the internet, a report on its battery due diligence policy. That report shall contain, in a manner that is easily comprehensible for end-users and clearly identifies the batteries concerned, the data and information on steps taken by that economic operator to comply with the requirements laid down in Articles 49 and 50, including findings of significant adverse impacts in the risk categories listed in point 2 of Annex X, and how they have been addressed, as well as a summary report of the third-party verifications carried out in accordance with Article 51, including the name of the notified body, with due regard for business confidentiality and other competitive concerns. That report shall also cover, where relevant, access to information, public participation in decision-making and access to justice in environmental matters in relation to the sourcing, processing and trading of the raw materials present in batteries. + + + true + DataElement + + + DocumentationEntity + + + en + Documentation Entity + + + + + en + Entity for a document with a header, type and content. + + + + + content + + + en + Content + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + xs:string + + + + contentType + + + en + Content Type + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + xs:string + + + + header + + + en + Header + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + xs:string + + + + + + + + + + SafetyEntity + + + en + Safety Entity + + + + + en + Entity with the attributes safety measurements, meaning of labels, safe discharging and dismantling. These are all documents. Additionally information about usable extinguish agent can be provided. + + + + + usableExtinguishAgent + + + en + Usable Extinguish Agent + + + + + en + The usable extinguish agents for the battery in case of a fire. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1)(a) and refers to Annex VI Part A +9. usable extinguishing agent. + + + true + DataElement + + + ExtinguishAgentEntity + + + en + Extinguish Agent Entity + + + + + en + Entity for the extinguish agents. + + + + + agentDocument + + + en + Agent Document + + + + + en + Documentation about the extinguishing agent. + + + true + DataElement + + + DocumentationEntity + + + en + Documentation Entity + + + + + en + Entity for a document with a header, type and content. + + + + + content + + + en + Content + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + xs:string + + + + contentType + + + en + Content Type + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + xs:string + + + + header + + + en + Header + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + xs:string + + + + + + + + usableExtinguishingMedia + + + en + Usable Extinguishing Media + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.battery.battery_pass:6.0.0#usableExtinguishingMedia + + + + xs:string + + + + fireClass + + + en + Fire Class + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.battery.battery_pass:6.0.0#fireClass + + + + xs:string + + + + + + + + safetyMeasures + + + en + Safety Measures + + + + + en + Safety instruction in the form of a documentation. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (2): +(d) safety measures. + + + true + DataElement + + + DocumentationEntity + + + en + Documentation Entity + + + + + en + Entity for a document with a header, type and content. + + + + + content + + + en + Content + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + xs:string + + + + contentType + + + en + Content Type + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + xs:string + + + + header + + + en + Header + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + xs:string + + + + + + + + meaningOfLabels + + + en + Meaning of Labels + + + + + en + Documentation on the meaning of labels on a battery which provide information to help users understand the various symbols, markings, and information present on the battery's label. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1)(s) and refers to Article 74 (1): +(e) the meaning of the labels and symbols on batteries in accordance with Article 13 or printed on their packaging or in the documents accompanying batteries [...]. + + + true + DataElement + + + DocumentationEntity + + + en + Documentation Entity + + + + + en + Entity for a document with a header, type and content. + + + + + content + + + en + Content + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + xs:string + + + + contentType + + + en + Content Type + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + xs:string + + + + header + + + en + Header + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + xs:string + + + + + + + + safeDischarging + + + en + Safe Discharging + + + + + en + Safe discharging documentation explaining for example the setting of a minimum voltage threshold for the battery. Discharging a battery below this threshold can lead to damage, reduced capacity, and safety hazards. + + + true + DataElement + + + DocumentationEntity + + + en + Documentation Entity + + + + + en + Entity for a document with a header, type and content. + + + + + content + + + en + Content + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + xs:string + + + + contentType + + + en + Content Type + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + xs:string + + + + header + + + en + Header + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + xs:string + + + + + + + + dismantling + + + en + Dismantling + + + + + en + Dismantling refers to the proper way of dismantling the battery itself. It refers to the process of taking apart the battery for various purposes, such as recycling, disposal, or examination of its components. This attribute is mentioned in the Battery Regulation 2023/1542 from 12 July 2023 in Annex XIII (2) (c) dismantling information, including at least: +- exploded diagrams of the battery system/pack showing the location of battery cells, +- disassembly sequences, +- type and number of fastening techniques to be unlocked, +- tools required for disassembly, +- warnings if risk of damaging parts exist, +- amount of cells used and layout. + + + true + DataElement + + + DocumentationEntity + + + en + Documentation Entity + + + + + en + Entity for a document with a header, type and content. + + + + + content + + + en + Content + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + xs:string + + + + contentType + + + en + Content Type + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + xs:string + + + + header + + + en + Header + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + xs:string + + + + + + + + removalFromAppliance + + + en + Removal From Appliance + + + + + en + Removal refers to the proper process of disassembling a battery from an appliance, typically for purposes such as repairs, replacements, or disposal. + + + true + DataElement + + + DocumentationEntity + + + en + Documentation Entity + + + + + en + Entity for a document with a header, type and content. + + + + + content + + + en + Content + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + xs:string + + + + contentType + + + en + Content Type + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + xs:string + + + + header + + + en + Header + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + xs:string + + + + + + + + + + sources + + + en + Sources + + + + + en + Consider additional available sources to enhance the content of the battery passport. + + + true + DataElement + + + DocumentEntity + + + en + Document Entity + + + + + en + Document entity with header, content, category and type. + + + + + content + + + en + Content + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + xs:string + + + + category + + + en + Category + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#category + + + + xs:string + + + + contentType + + + en + Content Type + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + xs:string + + + + header + + + en + Header + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + xs:string + + + + + + + + MetadataEntity + + + en + Metadata Entity + + + + + en + Passport Entity to describe version, status, end and issue date. + + + + + version + + + en + Version + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#version + + + + xs:string + + + + status + + + en + Status + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#status + + + + xs:string + + + + expirationDate + + + en + Expiration Date + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#expirationDate + + + + xs:string + + + + issueDate + + + en + Issue Date + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#issueDate + + + + xs:string + + + + economicOperatorId + + + en + Economic Operator Id + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#economicOperatorId + + + + xs:string + + + + passportIdentifier + + + en + Passport Identifier + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#passportIdentifier + + + + xs:string + + + + predecessor + + + en + Predecessor + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#predecessor + + + + xs:string + + + + backupReference + + + en + Backup Reference + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#backupReference + + + + xs:string + + + + registrationIdentifier + + + en + Registration Identifier + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#registrationIdentifier + + + + xs:string + + + + lastModification + + + en + Last Modification + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#lastModification + + + + xs:string + + + + + + CommercialEntity + + + en + Commercial Entity + + + + + en + Commercial information. + + + + + placedOnMarket + + + en + Placed on Market + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#placedOnMarket + + + + xs:string + + + + purpose + + + en + Purpose + + + + + en + One or more intended industry/industries of the product described by the digital product passport. If exchanged via Catena-X, 'automotive ' is a must choice included in the list. + + + true + DataElement + + + purpose + + + en + Purpose + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#purpose + + + + xs:string + + + + + + + + HandlingEntity + + + en + Handling Entity + + + + + en + Entity to describe different aspects in relation with the handling of the product with attributes if applicable to the product. + + + + + SparePartEntity + + + en + Spare Part Entity + + + + + en + Information regarding possible spare parts. This is mentioned in the ESPR proposal from March 30th, 2022 Annex I: +(b) ease of repair and maintenance as expressed through: characteristics, availability and delivery time of spare parts, modularity, compatibility with commonly available spare parts, availability of repair and maintenance instructions, number of materials and components used, use of standard components, use of component and material coding standards for the identification of components and materials, number and complexity of processes and tools needed, ease of non-destructive disassembly and re-assembly, conditions for access to product data, conditions for access to or use of hardware and software needed; +(c) the Global Trade Identification Number as provided for in standard ISO/IEC 15459-6 or equivalent of products or their parts. + + + + + sparePartSources + + + en + Spare Part Sources + + + + + en + Sources of possible spare parts. + + + true + DataElement + + + SourcesEntity + + + en + Sources Entity + + + + + en + Entity for a possible spare part sources. + + + + + sourcesIdentification + + + en + Sources Identification + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#sourcesIdentification + + + + xs:string + + + + + + + + sparePart + + + en + Spare Part + + + + + en + Possible spare parts of the product. + + + true + DataElement + + + PartsEntity + + + en + Parts Entity + + + + + en + Possible spare parts of the product with identifiers and names. + + + + + manufacturerPartId + + + en + Manufacturer Part ID + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.part_type_information:1.0.0#manufacturerPartId + + + + xs:string + + + + nameAtManufacturer + + + en + Name at manufacturer + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.part_type_information:1.0.0#nameAtManufacturer + + + + xs:string + + + + + + + + + + applicable + + + en + Applicable + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#applicable + + + + xs:boolean + + + + + + + + + + APPLICATION_CLASS + BatteryPass + + + en + Battery Passport + + + + + en + The battery pass describes information collected during the lifecycle of a battery. The battery passport is heavily based on the Regulation (EU) 2023/1542 of the European Parliament and of the Council of 12 July 2023 concerning batteries and waste batteries, amending Directive 2008/98/EC and Regulation (EU) 2019/1020 and repealing Directive 2006/66/EC. +Additionally attributes come from the Proposal for Ecodesign for Sustainable Products Regulation. + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#BatteryPass + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Battery Passport + + + + + en + BatteryPass + + + + + en + The battery pass describes information collected during the lifecycle of a battery. The battery passport is heavily based on the Regulation (EU) 2023/1542 of the European Parliament and of the Council of 12 July 2023 concerning batteries and waste batteries, amending Directive 2008/98/EC and Regulation (EU) 2019/1020 and repealing Directive 2006/66/EC. +Additionally attributes come from the Proposal for Ecodesign for Sustainable Products Regulation. + + + + + + + + + batteryCategory + + + en + Battery Category + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#batteryCategory + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Battery Category + + + + + en + batteryCategory + + + STRING + + + en + The battery category, which can be a portable battery; starting, lighting and ignition battery (SLI); light means of transport battery (LMT); electric vehicle battery (EV), industrial battery and incorporated battery. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1) (a) and refers to ANNEX VI Part A: +2. the battery category and information identifying the battery in accordance with Article 38(6). + + + + + + SLI + + ModelReference + + + DataElement + urn:samm:io.catenax.battery.battery_pass:6.0.0#CategoryEnumeration:SLI + + + + + + LMT + + ModelReference + + + DataElement + urn:samm:io.catenax.battery.battery_pass:6.0.0#CategoryEnumeration:LMT + + + + + + EV + + ModelReference + + + DataElement + urn:samm:io.catenax.battery.battery_pass:6.0.0#CategoryEnumeration:EV + + + + + + industrial + + ModelReference + + + DataElement + urn:samm:io.catenax.battery.battery_pass:6.0.0#CategoryEnumeration:industrial + + + + + + portable + + ModelReference + + + DataElement + urn:samm:io.catenax.battery.battery_pass:6.0.0#CategoryEnumeration:portable + + + + + + incorporated + + ModelReference + + + DataElement + urn:samm:io.catenax.battery.battery_pass:6.0.0#CategoryEnumeration:incorporated + + + + + + + + + + + + + idDmc + + + en + Id DMC + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#idDmc + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Id DMC + + + + + en + idDmc + + + STRING + + + en + The unique identifier of the product, when it is placed on the market. Through this identifier a web link can be accessed. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Article 77: +3. The battery passport shall be accessible through the QR code referred to in Article 13(6) which links to a unique identifier that the economic operator placing the battery on the market shall attribute to it. The QR code and the unique identifier shall comply with the ISO/IEC standards 15459-1:2014, 15459-2:2015, 15459-3:2014, 15459-4:2014, 15459-5:2014 and 15459-6:2014 or their equivalent. +Defined is the QR code in Article 3: +(24) "QR code" means a machine-readable matrix code that links to information as required by this Regulation. +(66) "unique identifier" means a unique string of characters for the identification of batteries that also enables a web link to the battery passport. + + + + + + + + + batteryChemistry + + + en + Battery Chemistry + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#batteryChemistry + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Battery Chemistry + + + + + en + batteryChemistry + + + STRING + + + en + Battery chemistry refers to the specific chemical composition and reactions that occur within a battery to produce and store electrical energy. The chemistry has to be stated as detailed as possible for example: the Nickel Cobalt Manganese battery 'NCM'. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1) (a) and refers to ANNEX VI Part A: +7. the chemestry. + + + + + + + + + key + + + en + Identifier Key + + + urn:samm:io.catenax.serial_part:3.0.0#key + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Identifier Key + + + + + en + key + + + STRING + + + en + The key of a local identifier. + + + + + + + + + value + + + en + Identifier Value + + + urn:samm:io.catenax.serial_part:3.0.0#value + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Identifier Value + + + + + en + value + + + STRING + + + en + The value of an identifier. + + + + + + + + + serialInformation + + + en + Serial Information + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#serialInformation + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Serial Information + + + + + en + serialInformation + + + STRING + + + en + Identifier for a serial part if available. This is mentioned in the ESPR provisional agreement from January 9th, 2024 Recital (27): +[...] an 'item' usually means a single unit of a model. + + + + + + + + + key + + + en + Identifier Key + + + urn:samm:io.catenax.batch:3.0.0#key + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Identifier Key + + + + + en + key + + + STRING + + + en + The key of a local identifier. + + + + + + + + + value + + + en + Identifier Value + + + urn:samm:io.catenax.batch:3.0.0#value + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Identifier Value + + + + + en + value + + + STRING + + + en + The value of an identifier. + + + + + + + + + batchInformation + + + en + Batch Information + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#batchInformation + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Batch Information + + + + + en + batchInformation + + + STRING + + + en + Identifier for a batch part if available. Identifier for a serial part if available. This is mentioned in the ESPR provisional agreement from January 9th, 2024 Recital (27): +[...] a 'batch' usually means a subset of a specific model composed of all products produced in a specific manufacturing plant at a specific moment in time [...]. + + + + + + + + + manufacturerPartId + + + en + Manufacturer Part ID + + + urn:samm:io.catenax.part_type_information:1.0.0#manufacturerPartId + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Manufacturer Part ID + + + + + en + manufacturerPartId + + + STRING + + + en + Part ID as assigned by the manufacturer of the part. The part ID identifies the part in the manufacturer`s dataspace. The part ID references a specific version of a part. The version number must be included in the part ID if it is available. The part ID does not reference a specific instance of a part and must not be confused with the serial number. + + + + + + + + + nameAtManufacturer + + + en + Name at manufacturer + + + urn:samm:io.catenax.part_type_information:1.0.0#nameAtManufacturer + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Name at manufacturer + + + + + en + nameAtManufacturer + + + STRING + + + en + Name of the part as assigned by the manufacturer. + + + + + + + + + partTypeInformation + + + en + Part Type Information + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#partTypeInformation + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Part Type Information + + + + + en + partTypeInformation + + + STRING + + + en + Identifier on the level of a part model or type. Identifier for a serial part if available. This is mentioned in the ESPR provisional agreement from January 9th, 2024 Recital (27): +[...] A 'model' usually means a version of a product of which all units share the same technical characteristics relevant for the ecodesign requirements and the same model identifier [...]. + + + + + + + + + codeKey + + + en + Code Key + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#codeKey + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Code Key + + + + + en + codeKey + + + STRING + + + en + The code key for the identification of the product. Examples are GTIN, hash, DID, ISBN, TARIC. This attribute is mentioned in the ESPR proposal from March 30th, 2022 ANNEX III: +(b) the unique product identifier at the level indicated in the applicable delegated act adopted pursuant to Article 4; +(c) the Global Trade Identification Number as provided for in standard ISO/IEC 15459-6 or equivalent of products or their parts; +(d) relevant commodity codes, such as a TARIC code as defined in Council Regulation (EEC) No 2658/87. + + + + + + + + + codeValue + + + en + Code Value + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#codeValue + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Code Value + + + + + en + codeValue + + + STRING + + + en + The code value for the identification of the product in regard to the chosen code name. + + + + + + + + + codes + + + en + Codes + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#codes + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Codes + + + + + en + codes + + + STRING + + + en + Codes for identification. + + + + + + + + + carrierType + + + en + Carrier Type + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#carrierType + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Carrier Type + + + + + en + carrierType + + + STRING + + + en + The type of data carrier such as a QR code on the product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 8: +(2) (b) the types of data carrier to be used. + + + + + + + + + carrierLayout + + + en + Carrier Layout + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#carrierLayout + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Carrier Layout + + + + + en + carrierLayout + + + STRING + + + en + The positioning of data carrier on the product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 8: +(2) (c) the layout in which the data carrier shall be presented and its positioning. + + + + + + + + + dataCarrier + + + en + Data Carrier + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#dataCarrier + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Data Carrier + + + + + en + dataCarrier + + + STRING + + + en + The type and layout of the data carrier on the product. These are mentioned in the ESPR proposal from March 30th, 2022 Article 8: +(b) the types of data carrier to be used; +(c) the layout in which the data carrier shall be presented and its positioning; +Article 2 defines: +(30) 'data carrier' means a linear bar code symbol, a two-dimensional symbol or other automatic identification data capture medium that can be read by a device. + + + + + + + + + classificationStandard + + + en + Classification Standard + + + urn:samm:io.catenax.shared.part_classification:1.0.0#classificationStandard + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Classification Standard + + + + + en + classificationStandard + + + STRING + + + en + Identified classification standards that align to the Catena-X needs. + + + + + + + + + classificationID + + + en + Classification ID + + + urn:samm:io.catenax.shared.part_classification:1.0.0#classificationID + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Classification ID + + + + + en + classificationID + + + STRING + + + en + The classification ID of the part type according to the corresponding standard definition mentioned in the key value pair. + + + + + + + + + classificationDescription + + + en + Classification Description + + + urn:samm:io.catenax.shared.part_classification:1.0.0#classificationDescription + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Classification Description + + + + + en + classificationDescription + + + STRING + + + en + Optional property describing the classification standard. + + + + + + + + + partClassification + + + en + Part Classification + + + urn:samm:io.catenax.shared.part_classification:1.0.0#partClassification + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Part Classification + + + + + en + partClassification + + + STRING + + + en + Property describing the classification of a part. + + + + + + + + + identification + + + en + Identification + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#identification + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Identification + + + + + en + identification + + + STRING + + + en + Identification information of the product, especially identifiers and codes. These are mentioned in the ESPR provisional agreement from January 9th, 2024 ANNEX III: +(b) the unique product identifier at the level indicated in the applicable delegated act adopted pursuant to Article 4. +Additionally in Article 9 regarding general requirements for the product passport is stated that: +A product passport shall meet the following conditions: +(a) it shall be connected through a data carrier to a persistent unique product identifier; +(e) the information included in the product passport shall refer to the product model, batch, or item as specified in the delegated act adopted pursuant to Article 4. +Article 2 Definitions: +(31) 'unique product identifier' means a unique string of characters for the identification of products that also enables a web link to the product passport; +Recital (27): A 'model' usually means a version of a product of which all units share the same technical characteristics relevant for the ecodesign requirements and the same model identifier, a 'batch' usually means a subset of a specific model composed of all products produced in a specific manufacturing plant at a specific moment in time and an 'item' usually means a single unit of a model. + + + + + + + + + identification + + + en + Identification + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#identification + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Identification + + + + + en + identification + + + STRING + + + en + Battery identification involves specific battery identifiers, including those assigned locally by the manufacturer. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1)(a) refers to AnnexVi PartA (2) refers to Article 38 (6): +battery batch number or serial number or product number or another element allowing their identification. + + + + + + + + + intoServiceDate + + + en + Into Service Date + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#intoServiceDate + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Into Service Date + + + + + en + intoServiceDate + + + STRING + + + en + Putting into service is the transition from a state of readiness to actual use or operation. The date should be formatted as yyyy-mm-dd. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex VII Part B: +1.the date of manufacture of the battery and, where appropriate, the date of putting into service; +Defined is "putting into service" in Article 3: +(18) "putting into service" means the first use, for its intended purpose, in the Union, of a battery, without having been previously placed on the market. + + + + + + + + + facility + + + en + Facility + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#facility + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Facility + + + + + en + facility + + + STRING + + + en + The identifier used for a location. This attribute is mentioned in the ESPR provisional agreement from January 9th 2024 Annex III: +(i) unique facility identifiers; +Article 2 Definitions: (33) 'unique facility identifier' means a unique string of characters for the identification of locations or buildings involved in the value chain of a product or used by actors involved in the value chain of a product. + + + + + + + + + facilityIdentification + + + en + Facility Identification + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#facilityIdentification + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Facility Identification + + + + + en + facilityIdentification + + + STRING + + + en + The identifier used for a location. In the CATENA-X use case, the BPNA can be stated. This attribute is mentioned in the ESPR provisional agreement from January 9th 2024 Annex III: +(i) unique facility identifiers; +Article 2 Definitions: (33) 'unique facility identifier' means a unique string of characters for the identification of locations or buildings involved in the value chain of a product or used by actors involved in the value chain of a product. + + + + + + + + + manufacturerIdentification + + + en + Manufacturer Identification + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#manufacturerIdentification + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Manufacturer Identification + + + + + en + manufacturerIdentification + + + STRING + + + en + The main manufacturer, if different from the passport owner, represented by an identification number. In the Catena-X use case, the BPNL can be stated. This attribute is mentioned in the ESPR provisional agreement from January 9th 2024 Annex III: +(h) unique operator identifiers other than that of the manufacturer; +(k) the name, contact details and unique operator identifier code of the economic operator established in the Union responsible for carrying out the tasks set out in Article 4 of Regulation (EU) 2019/1020, or Article 15 of Regulation (EU) [.../...] on general product safety, or similar tasks pursuant to other EU legislation applicable to the product. + + + + + + + + + manufacturingDate + + + en + Manufacturing Date + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#manufacturingDate + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Manufacturing Date + + + + + en + manufacturingDate + + + STRING + + + en + The timestamp in the format (yyyy-mm-dd) of the manufacturing date as the final step in production process (e.g. final quality check, ready-for-shipment event). + + + + + + + + + manufacturer + + + en + Manufacturer + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#manufacturer + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Manufacturer + + + + + en + manufacturer + + + STRING + + + en + Manufacturing information of the product. In the CATENA-X use case, the BPNL and BPNA can be stated. These attributes are mentioned in the ESPR provisional agreement from January 9th 2024 Annex III: +(h) unique operator identifiers other than that of the manufacturer; +(k) the name, contact details and unique operator identifier code of the economic operator established in the Union responsible for carrying out the tasks set out in Article 4 of Regulation (EU) 2019/1020, or Article 15 of Regulation (EU) [.../...] on general product safety, or similar tasks pursuant to other EU legislation applicable to the product. + + + + + + + + + operation + + + en + Operation + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#operation + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Operation + + + + + en + operation + + + STRING + + + en + General operation information includes details such as the manufacturer's identification and the date of production. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1) (a) and refers to ANNEX VI Part A which refers to Article 38: +7. Manufacturers shall indicate on the battery their name, registered trade name or registered trade mark, their postal address, indicating a single contact point, and, if available, web and e-mail address. +From Annex XIII (1) (a) and found in ANNEX VI Part A : +3. the place of manufacture (geographical location of a battery manufacturing plant). +4. the date of manufacture (month and year). + + + + + + + + + lifeValue + + + en + Life Value + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#lifeValue + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Life Value + + + + + en + lifeValue + + + INTEGER_MEASURE + + + en + The value as an integer for the respective lifespan. + + + + + + + + + lifeUnit + + + en + Life Unit + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#lifeUnit + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Life Unit + + + + + en + lifeUnit + + + STRING + + + en + The unit of the respective lifespan expressed through the possible units day, month, cycle, year and runningOrOperatingHour. + + + + + + unit:day + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#LifeEnumeration:unit:day + + + + + + unit:month + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#LifeEnumeration:unit:month + + + + + + unit:year + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#LifeEnumeration:unit:year + + + + + + unit:cycle + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#LifeEnumeration:unit:cycle + + + + + + unit:runningOrOperatingHour + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#LifeEnumeration:unit:runningOrOperatingHour + + + + + + + + + + + + + warranty + + + en + Warranty + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#warranty + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Warranty + + + + + en + warranty + + + STRING + + + en + The warranty of the battery. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in ANNEX XIII: +(m) period for which the commercial warranty for the calendar life applies. + + + + + + + + + quantityValue + + + en + Quantity Value + + + urn:samm:io.catenax.shared.quantity:2.0.0#quantityValue + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Quantity Value + + + + + en + quantityValue + + + REAL_MEASURE + + + en + The quantity value associated with the unit. + + + + + + + + + linearUnit + + + en + Linear Unit + + + urn:samm:io.catenax.shared.quantity:2.0.0#linearUnit + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Linear Unit + + + + + en + linearUnit + + + STRING + + + en + The unit of a linear attribute. + + + + + + unit:millimetre + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#LinearUnitEnumeration:unit:millimetre + + + + + + unit:centimetre + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#LinearUnitEnumeration:unit:centimetre + + + + + + unit:metre + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#LinearUnitEnumeration:unit:metre + + + + + + unit:kilometre + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#LinearUnitEnumeration:unit:kilometre + + + + + + unit:inch + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#LinearUnitEnumeration:unit:inch + + + + + + unit:foot + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#LinearUnitEnumeration:unit:foot + + + + + + unit:yard + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#LinearUnitEnumeration:unit:yard + + + + + + + + + + + + + height + + + en + Height + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#height + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Height + + + + + en + height + + + STRING + + + en + The height of the item measured in a specific linear unit which can be declared in the corresponding unit attribute. + + + + + + + + + quantityValue + + + en + Quantity Value + + + urn:samm:io.catenax.shared.quantity:2.0.0#quantityValue + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Quantity Value + + + + + en + quantityValue + + + REAL_MEASURE + + + en + The quantity value associated with the unit. + + + + + + + + + linearUnit + + + en + Linear Unit + + + urn:samm:io.catenax.shared.quantity:2.0.0#linearUnit + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Linear Unit + + + + + en + linearUnit + + + STRING + + + en + The unit of a linear attribute. + + + + + + + + + length + + + en + Length + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#length + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Length + + + + + en + length + + + STRING + + + en + The length of the item measured in a specific linear unit which can be declared in the corresponding unit attribute. + + + + + + + + + quantityValue + + + en + Quantity Value + + + urn:samm:io.catenax.shared.quantity:2.0.0#quantityValue + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Quantity Value + + + + + en + quantityValue + + + REAL_MEASURE + + + en + The quantity value associated with the unit. + + + + + + + + + linearUnit + + + en + Linear Unit + + + urn:samm:io.catenax.shared.quantity:2.0.0#linearUnit + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Linear Unit + + + + + en + linearUnit + + + STRING + + + en + The unit of a linear attribute. + + + + + + + + + width + + + en + Width + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#width + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Width + + + + + en + width + + + STRING + + + en + The width of the item measured in a specific linear unit which can be declared in the corresponding unit attribute. + + + + + + + + + quantityValue + + + en + Quantity Value + + + urn:samm:io.catenax.shared.quantity:2.0.0#quantityValue + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Quantity Value + + + + + en + quantityValue + + + REAL_MEASURE + + + en + The quantity value associated with the unit. + + + + + + + + + massUnit + + + en + Mass Unit + + + urn:samm:io.catenax.shared.quantity:2.0.0#massUnit + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Mass Unit + + + + + en + massUnit + + + STRING + + + en + The unit of a mass related attribute. + + + + + + unit:gram + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#MassUnitEnumeration:unit:gram + + + + + + unit:kilogram + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#MassUnitEnumeration:unit:kilogram + + + + + + unit:tonneMetricTon + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#MassUnitEnumeration:unit:tonneMetricTon + + + + + + unit:tonUsOrShortTonUkorus + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#MassUnitEnumeration:unit:tonUsOrShortTonUkorus + + + + + + unit:ounceAvoirdupois + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#MassUnitEnumeration:unit:ounceAvoirdupois + + + + + + unit:pound + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#MassUnitEnumeration:unit:pound + + + + + + + + + + + + + weight + + + en + Weight + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#weight + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Weight + + + + + en + weight + + + STRING + + + en + Weight of the product measured in a specific mass unit which can be declared in the corresponding unit attribute. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7: +(2) (b) (i) information on the performance of the product in relation to the product parameters referred to in Annex I; +Annex I (i) weight and volume of the product [...]. + + + + + + + + + physicalDimension + + + en + Physical Dimension + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#physicalDimension + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Physical Dimension + + + + + en + physicalDimension + + + STRING + + + en + The weight of the battery. For calculation of the energy density, the volume is also needed. The energy density of a battery is measured in watt-hours per kilogram (Wh/kg) and watt-hours per liter (Wh/L). These measures indicate how much energy a battery can store relative to its weight and volume, respectively. Other measurements are optional.These are mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1)(a) and refers to Annex VI Part A: +5. the weight. + + + + + + + + + characteristics + + + en + Characteristics + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#characteristics + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Characteristics + + + + + en + characteristics + + + STRING + + + en + Characteristics of the battery, such as the warranty and the physical dimensions. + + + + + + + + + content + + + en + Content + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Content + + + + + en + content + + + STRING + + + en + The content of the document e.g a link. + + + + + + + + + contentType + + + en + Content Type + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Content Type + + + + + en + contentType + + + STRING + + + en + The type of content which can be expected in the "content" property. Examples are a link, restricted link, pdf, excel, etc. + + + + + + + + + header + + + en + Header + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Header + + + + + en + header + + + STRING + + + en + The header as a short description of the document with a maximum of 100 characters. + + + + + + + + + separateCollection + + + en + Separate Collection + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#separateCollection + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Separate Collection + + + + + en + separateCollection + + + STRING + + + en + Documentation about separate collection of batteries involve information on how to properly collect, handle, and recycle batteries to ensure environmental sustainability and compliance with regulations. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1) (s), refers to Article 74: +1. In addition to the information referred to in Article 8a(2) of Directive 2008/98/EC, producers or, where appointed in accordance with Article 57(1), producer responsibility organisations shall make available to end-users and distributors the following information regarding the prevention and management of waste batteries with regard to the categories of batteries that they supply within the territory of a Member State: +(a) the role of end-users in contributing to waste prevention, including by information on good practices and recommendations concerning the use of batteries aimed at extending their use phase and the possibilities of re-use, preparation for re-use, preparation for repurposing, repurposing and remanufacturing; +(b) the role of end-users in contributing to the separate collection of waste batteries in accordance with their obligations under Article 64 to allow their treatment; +(c) the separate collection, take-back and collection points, preparation for re-use, preparation for repurposing and treatment available for waste batteries; +(d) the necessary safety instructions to handle waste batteries, including in relation to the risks associated with, and the handling of, batteries containing lithium; +(e) the meaning of the labels and symbols on batteries in accordance with Article 13 or printed on their packaging or in the documents accompanying batteries; and +(f) the impact of substances, in particular hazardous substances, present in batteries on the environment and on human health or the safety of persons, including the impact due to inappropriate discarding of waste batteries, such as littering or discarding as unsorted municipal waste. + + + + + + + + + content + + + en + Content + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Content + + + + + en + content + + + STRING + + + en + The content of the document e.g a link. + + + + + + + + + contentType + + + en + Content Type + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Content Type + + + + + en + contentType + + + STRING + + + en + The type of content which can be expected in the "content" property. Examples are a link, restricted link, pdf, excel, etc. + + + + + + + + + header + + + en + Header + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Header + + + + + en + header + + + STRING + + + en + The header as a short description of the document with a maximum of 100 characters. + + + + + + + + + wastePrevention + + + en + Waste Prevention + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#wastePrevention + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Waste Prevention + + + + + en + wastePrevention + + + STRING + + + en + Documentation about waste prevention for batteries which include guidelines, recommendations, and information on minimizing the environmental impact associated with the use and disposal of batteries. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1) (s), refers to Article 74 (1) which call Article 8a of Directive 2008/98/EC: +2. Member States shall take the necessary measures to ensure that the waste holders targeted by the extended producer responsibility schemes established in accordance with Article 8 (1), are informed about waste prevention measures, centres for re-use and preparing for re-use, take-back and collection systems, and the prevention of littering. Member States shall also take measures to create incentives for the waste holders to assume their responsibility to deliver their waste into the separate collection systems in place, notably, where appropriate, through economic incentives or regulations. + + + + + + + + + content + + + en + Content + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Content + + + + + en + content + + + STRING + + + en + The content of the document e.g a link. + + + + + + + + + contentType + + + en + Content Type + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Content Type + + + + + en + contentType + + + STRING + + + en + The type of content which can be expected in the "content" property. Examples are a link, restricted link, pdf, excel, etc. + + + + + + + + + header + + + en + Header + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Header + + + + + en + header + + + STRING + + + en + The header as a short description of the document with a maximum of 100 characters. + + + + + + + + + euTaxonomyDisclosureStatement + + + en + EU Taxonomy Disclosure Statement + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#euTaxonomyDisclosureStatement + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + EU Taxonomy Disclosure Statement + + + + + en + euTaxonomyDisclosureStatement + + + STRING + + + en + Optional disclosure regarding the EU taxonomy, with the choice to voluntarily provide the EU Taxonomy disclosure through the battery passport. + + + + + + + + + content + + + en + Content + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Content + + + + + en + content + + + STRING + + + en + The content of the document e.g a link. + + + + + + + + + contentType + + + en + Content Type + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Content Type + + + + + en + contentType + + + STRING + + + en + The type of content which can be expected in the "content" property. Examples are a link, restricted link, pdf, excel, etc. + + + + + + + + + header + + + en + Header + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Header + + + + + en + header + + + STRING + + + en + The header as a short description of the document with a maximum of 100 characters. + + + + + + + + + sustainabilityReport + + + en + Sustainability Report + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#sustainabilityReport + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Sustainability Report + + + + + en + sustainabilityReport + + + STRING + + + en + Voluntarily making the Sustainability Report available via the battery passport. A report containing the information concerning the sustainability in form of a document. + + + + + + + + + sustainabilityDocuments + + + en + sustainability Documents + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#sustainabilityDocuments + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + sustainability Documents + + + + + en + sustainabilityDocuments + + + STRING + + + en + Sustainability documents of the battery. + + + + + + + + + footprintValue + + + en + Footprint Value + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#footprintValue + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Footprint Value + + + + + en + footprintValue + + + REAL_MEASURE + + + en + The value of the footprint of the product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Annex I: +(l) the environmental footprint of the product, expressed as a quantification, in accordance with the applicable delegated act, of a product's life cycle environmental impacts, whether in relation to one or more environmental impact categories or an aggregated set of impact categories; +(m) the carbon footprint of the product; +(ma) the material footprint of the product. + + + + + + + + + + content + + + en + Content + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Content + + + + + en + content + + + STRING + + + en + The content of the document e.g a link. + + + + + + + + + contentType + + + en + Content Type + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Content Type + + + + + en + contentType + + + STRING + + + en + The type of content which can be expected in the "content" property. Examples are a link, restricted link, pdf, excel, etc. + + + + + + + + + header + + + en + Header + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Header + + + + + en + header + + + STRING + + + en + The header as a short description of the document with a maximum of 100 characters. + + + + + + + + + footprintRulebook + + + en + Footprint Rulebook + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#footprintRulebook + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Footprint Rulebook + + + + + en + footprintRulebook + + + STRING + + + en + The applied rulebook for the environmental footprint of the product. + + + + + + + + + footprintLifecycle + + + en + Footprint Lifecycle + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#footprintLifecycle + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Footprint Lifecycle + + + + + en + footprintLifecycle + + + STRING + + + en + The lifecycle stage, to which the environmental footprint corresponds. These could be for example "raw material acquisition and pre-processing", "main product production", "distribution" or "end of life and recycling". + + + + + + + + + footprintUnit + + + en + Footprint Unit + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#footprintUnit + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Footprint Unit + + + + + en + footprintUnit + + + STRING + + + en + The unit of measurement of the environmental impact category. For each impact category a specific unit is used. If an aggregation is used, utilize the normalization and weighting methods used in the referenced rulebook. + + + + + + + + + footprintType + + + en + Footprint Type + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#footprintType + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Footprint Type + + + + + en + footprintType + + + STRING + + + en + The type of the environmental footprint of the product. This could be one of the environmental impact categories. This attribute is mentioned in the ESPR provisional agreement from January 9th 2024 Article 7: +(2)(b)(i) information on the performance of the product in relation to one or more of the product parameters referred to in Annex I, including a scoring of reparability or durability, carbon footprint or environmental footprint; +Annex I: +(l) the environmental footprint of the product, expressed as a quantification, in accordance with the applicable delegated act, of a product's life cycle environmental impacts, whether in relation to one or more environmental impact categories or an aggregated set of impact categories. +(m) the carbon footprint of the product; +(ma) the material footprint of the product. + + + + + + Climate Change Total + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#CategoryEnumeration:Climate Change Total + + + + + + Climate Change Fossil + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#CategoryEnumeration:Climate Change Fossil + + + + + + Climate Change Biogenic Removals and Emissions + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#CategoryEnumeration:Climate Change Biogenic Removals and Emissions + + + + + + Climate Change Land Use and Land Use Change + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#CategoryEnumeration:Climate Change Land Use and Land Use Change + + + + + + Ozone Depletion + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#CategoryEnumeration:Ozone Depletion + + + + + + Acidification + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#CategoryEnumeration:Acidification + + + + + + Eutrophication Aquatic Freshwater + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#CategoryEnumeration:Eutrophication Aquatic Freshwater + + + + + + Eutrophication Fresh Marine + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#CategoryEnumeration:Eutrophication Fresh Marine + + + + + + Eutrophication Terrestrial + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#CategoryEnumeration:Eutrophication Terrestrial + + + + + + Photochemical Ozone Formation + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#CategoryEnumeration:Photochemical Ozone Formation + + + + + + Abiotic Depletion- Minerals and Metals + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#CategoryEnumeration:Abiotic Depletion- Minerals and Metals + + + + + + Fossil Fuels + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#CategoryEnumeration:Fossil Fuels + + + + + + Water Use + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#CategoryEnumeration:Water Use + + + + + + Particulate Matter Emissions + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#CategoryEnumeration:Particulate Matter Emissions + + + + + + Ionizing Radiation, Human Health + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#CategoryEnumeration:Ionizing Radiation, Human Health + + + + + + Eco-Toxicity + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#CategoryEnumeration:Eco-Toxicity + + + + + + Human Toxicity, Cancer Effects + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#CategoryEnumeration:Human Toxicity, Cancer Effects + + + + + + Human Toxicity, Non-Cancer Effects + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#CategoryEnumeration:Human Toxicity, Non-Cancer Effects + + + + + + Land Use Related Impacts/Soil Quality + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#CategoryEnumeration:Land Use Related Impacts/Soil Quality + + + + + + + + + + + + + performanceClass + + + en + Performance Class + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#performanceClass + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Performance Class + + + + + en + performanceClass + + + STRING + + + en + The performance classification of the footprint. + + + + + + + + + facility + + + en + Facility + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#facility + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Facility + + + + + en + facility + + + STRING + + + en + The identifier used for a location. This attribute is mentioned in the ESPR provisional agreement from January 9th 2024 Annex III: +(i) unique facility identifiers; +Article 2 Definitions: (33) 'unique facility identifier' means a unique string of characters for the identification of locations or buildings involved in the value chain of a product or used by actors involved in the value chain of a product. + + + + + + + + + manufacturingPlant + + + en + Manufacturing Plant + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#manufacturingPlant + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Manufacturing Plant + + + + + en + manufacturingPlant + + + STRING + + + en + The manufacturing plant of the footprint in the specific lifecycle phase. + + + + + + + + + content + + + en + Content + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Content + + + + + en + content + + + STRING + + + en + The content of the document e.g a link. + + + + + + + + + contentType + + + en + Content Type + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Content Type + + + + + en + contentType + + + STRING + + + en + The type of content which can be expected in the "content" property. Examples are a link, restricted link, pdf, excel, etc. + + + + + + + + + header + + + en + Header + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Header + + + + + en + header + + + STRING + + + en + The header as a short description of the document with a maximum of 100 characters. + + + + + + + + + declaration + + + en + Declaration + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#declaration + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Declaration + + + + + en + declaration + + + STRING + + + en + The footprint declaration in the format of a link + + + + + + + + + carbonFootprint + + + en + Carbon Footprint + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#carbonFootprint + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Carbon Footprint + + + + + en + carbonFootprint + + + STRING + + + en + The carbon footprint of the battery calculated as kg of carbon dioxide equivalent per one kWh of the total energy provided by the battery over its expected service life. Relevant attributes are the value, the unit, the referenced rulebook, the lifecycle where applied, the declaration, the performance class, the type (PCF), the declaration and the facility. These attributes are mentioned in the Battery regulation 2023/1542 from 12 July 2023 in several places. +Annex XIII (1) (c) refers to Article 7 (2) which refers to Article 7 (1)(d): +1. For electric vehicle batteries, rechargeable industrial batteries with a capacity greater than 2 kWh and LMT batteries a carbon footprint declaration shall be drawn up for each battery model per manufacturing plant, in accordance with the implementing act referred to in the fourth subparagraph and containing, at least, the following information: +[...] (d) the carbon footprint of the battery, calculated as kg of carbon dioxide equivalent per one kWh of the total energy provided by the battery over its expected service life; +And as well in Article 7: +2. Electric vehicle batteries, rechargeable industrial batteries with a capacity greater than 2 kWh and LMT batteries shall bear a conspicuous, clearly legible and indelible label indicating the carbon footprint of the battery referred to in paragraph 1, first subparagraph, point (d) and declaring the carbon footprint performance class to which the relevant battery model per manufacturing plant corresponds. +Further specified in Annex XIII (1) (c) and refers to Article 7 (1): +[...] The Commission shall, by 18 February 2024 for electric vehicle batteries, 18 February 2025 for rechargeable industrial batteries, except those with external storage, 18 February 2027 for LMT batteries and 18 February 2029 for industrial batteries with external storage, adopt: +(a) a delegated act in accordance with Article 89 to supplement this Regulation by establishing the methodology for the calculation and verification of the carbon footprint of the battery referred to in the first subparagraph, point (d), in accordance with the essential elements set out in Annex II; +These parameters are defined by Article 3: +(21) "carbon footprint" means the sum of greenhouse gas emissions and greenhouse gas removals in a product system, expressed as carbon dioxide equivalents and based on a Product Environmental Footprint (PEF) study using the single impact category of climate change; +and defined by Annex II (2): +(e) "life cycle" means the consecutive and interlinked stages of a product system, from raw material acquisition or generation from natural resources to final disposal (ISO 14040:2006 or an equivalent standard). + + + + + + + + + state + + + en + State + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#state + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + State + + + + + en + state + + + STRING + + + en + The status of the product (original, repurposed, re-used, remanufactured or waste) to indicated, whether it is a used product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Annex I: +(j) incorporation of used components. + + + + + + original + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#StateEnumeration:original + + + + + + repurposed + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#StateEnumeration:repurposed + + + + + + re-used + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#StateEnumeration:re-used + + + + + + remanufactured + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#StateEnumeration:remanufactured + + + + + + waste + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#StateEnumeration:waste + + + + + + + + + + + + + sustainability + + + en + Sustainability + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#sustainability + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Sustainability + + + + + en + sustainability + + + STRING + + + en + Sustainability includes information on the carbon footprint, sustainability documents and the status of the battery. + + + + + + + + + location + + + en + Location + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#location + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Location + + + + + en + location + + + STRING + + + en + The location of the substances of concern within the product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7: +(5) (b) the location of the substances of concern within the product. + + + + + + + + + recycled + + + en + Recycled + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#recycled + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Recycled + + + + + en + recycled + + + REAL_MEASURE + + + en + The share of the material, which is recovered recycled content from the product. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I: +(h) use or content of recycled materials and recovery of materials, including critical raw materials; + + + + + + + + + content + + + en + Content + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Content + + + + + en + content + + + STRING + + + en + The content of the document e.g a link. + + + + + + + + + contentType + + + en + Content Type + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Content Type + + + + + en + contentType + + + STRING + + + en + The type of content which can be expected in the "content" property. Examples are a link, restricted link, pdf, excel, etc. + + + + + + + + + header + + + en + Header + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Header + + + + + en + header + + + STRING + + + en + The header as a short description of the document with a maximum of 100 characters. + + + + + + + + + documentation + + + en + Documentation + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#documentation + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Documentation + + + + + en + documentation + + + STRING + + + en + Documentation accompanying the material. + + + + + + + + + critical + + + en + Critical + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#critical + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Critical + + + + + en + critical + + + BOOLEAN + + + en + A flag, if the material is a critical raw material. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I: +(h) use or content of recycled materials and recovery of materials, including critical raw materials; +In Annex II of the connected proposal Act of Critical Raw Materials, a list of critical raw materials can be found. + + + + + + + + + nickel + + + en + Nickel + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#nickel + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Nickel + + + + + en + nickel + + + STRING + + + en + Information about the percentage of recovered nickel from waste. These attribute are mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1)(e) refers to Article 8: +1. From 18 August 2028 or 24 months after the date of entry into force of the delegated act referred to in the third subparagraph, whichever is the latest, industrial batteries with a capacity greater than 2 kWh, except those with exclusively external storage, electric vehicle batteries and SLI batteries that contain cobalt, lead, lithium or nickel in active materials, shall be accompanied by documentation containing information about the percentage share of cobalt, lithium or nickel that is present in active materials and that has been recovered from battery manufacturing waste or post-consumer waste, and the percentage share of lead that is present in the battery and that has been recovered from waste, for each battery model per year and per manufacturing plant. + + + + + + + + + location + + + en + Location + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#location + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Location + + + + + en + location + + + STRING + + + en + The location of the substances of concern within the product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7: +(5) (b) the location of the substances of concern within the product. + + + + + + + + + recycled + + + en + Recycled + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#recycled + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Recycled + + + + + en + recycled + + + REAL_MEASURE + + + en + The share of the material, which is recovered recycled content from the product. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I: +(h) use or content of recycled materials and recovery of materials, including critical raw materials; + + + + + + + + + content + + + en + Content + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Content + + + + + en + content + + + STRING + + + en + The content of the document e.g a link. + + + + + + + + + contentType + + + en + Content Type + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Content Type + + + + + en + contentType + + + STRING + + + en + The type of content which can be expected in the "content" property. Examples are a link, restricted link, pdf, excel, etc. + + + + + + + + + header + + + en + Header + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Header + + + + + en + header + + + STRING + + + en + The header as a short description of the document with a maximum of 100 characters. + + + + + + + + + documentation + + + en + Documentation + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#documentation + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Documentation + + + + + en + documentation + + + STRING + + + en + Documentation accompanying the material. + + + + + + + + + critical + + + en + Critical + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#critical + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Critical + + + + + en + critical + + + BOOLEAN + + + en + A flag, if the material is a critical raw material. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I: +(h) use or content of recycled materials and recovery of materials, including critical raw materials; +In Annex II of the connected proposal Act of Critical Raw Materials, a list of critical raw materials can be found. + + + + + + + + + lithium + + + en + Lithium + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#lithium + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Lithium + + + + + en + lithium + + + STRING + + + en + Information about the percentage of recovered lithium from waste. These attribute are mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1)(e) refers to Article 8: +1. From 18 August 2028 or 24 months after the date of entry into force of the delegated act referred to in the third subparagraph, whichever is the latest, industrial batteries with a capacity greater than 2 kWh, except those with exclusively external storage, electric vehicle batteries and SLI batteries that contain cobalt, lead, lithium or nickel in active materials, shall be accompanied by documentation containing information about the percentage share of cobalt, lithium or nickel that is present in active materials and that has been recovered from battery manufacturing waste or post-consumer waste, and the percentage share of lead that is present in the battery and that has been recovered from waste, for each battery model per year and per manufacturing plant. + + + + + + + + + location + + + en + Location + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#location + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Location + + + + + en + location + + + STRING + + + en + The location of the substances of concern within the product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7: +(5) (b) the location of the substances of concern within the product. + + + + + + + + + recycled + + + en + Recycled + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#recycled + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Recycled + + + + + en + recycled + + + REAL_MEASURE + + + en + The share of the material, which is recovered recycled content from the product. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I: +(h) use or content of recycled materials and recovery of materials, including critical raw materials; + + + + + + + + + content + + + en + Content + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Content + + + + + en + content + + + STRING + + + en + The content of the document e.g a link. + + + + + + + + + contentType + + + en + Content Type + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Content Type + + + + + en + contentType + + + STRING + + + en + The type of content which can be expected in the "content" property. Examples are a link, restricted link, pdf, excel, etc. + + + + + + + + + header + + + en + Header + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Header + + + + + en + header + + + STRING + + + en + The header as a short description of the document with a maximum of 100 characters. + + + + + + + + + documentation + + + en + Documentation + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#documentation + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Documentation + + + + + en + documentation + + + STRING + + + en + Documentation accompanying the material. + + + + + + + + + critical + + + en + Critical + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#critical + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Critical + + + + + en + critical + + + BOOLEAN + + + en + A flag, if the material is a critical raw material. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I: +(h) use or content of recycled materials and recovery of materials, including critical raw materials; +In Annex II of the connected proposal Act of Critical Raw Materials, a list of critical raw materials can be found. + + + + + + + + + cobalt + + + en + Cobalt + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#cobalt + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Cobalt + + + + + en + cobalt + + + STRING + + + en + Information about the percentage of recovered cobalt from waste. These attribute are mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1)(e) refers to Article 8: +1. From 18 August 2028 or 24 months after the date of entry into force of the delegated act referred to in the third subparagraph, whichever is the latest, industrial batteries with a capacity greater than 2 kWh, except those with exclusively external storage, electric vehicle batteries and SLI batteries that contain cobalt, lead, lithium or nickel in active materials, shall be accompanied by documentation containing information about the percentage share of cobalt, lithium or nickel that is present in active materials and that has been recovered from battery manufacturing waste or post-consumer waste, and the percentage share of lead that is present in the battery and that has been recovered from waste, for each battery model per year and per manufacturing plant. + + + + + + + + + content + + + en + Content + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Content + + + + + en + content + + + STRING + + + en + The content of the document e.g a link. + + + + + + + + + contentType + + + en + Content Type + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Content Type + + + + + en + contentType + + + STRING + + + en + The type of content which can be expected in the "content" property. Examples are a link, restricted link, pdf, excel, etc. + + + + + + + + + header + + + en + Header + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Header + + + + + en + header + + + STRING + + + en + The header as a short description of the document with a maximum of 100 characters. + + + + + + + + + impactOfSubstances + + + en + Impact of Substances + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#impactOfSubstances + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Impact of Substances + + + + + en + impactOfSubstances + + + STRING + + + en + An accumulation of documents that refer to the impact, especially hazardous substances, on the battery. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1) (s), refers to Article 74: +1. In addition to the information referred to in Article 8a(2) of Directive 2008/98/EC, producers or, where appointed in accordance with Article 57(1), producer responsibility organisations shall make available to end-users and distributors the following information regarding the prevention and management of waste batteries with regard to the categories of batteries that they supply within the territory of a Member State: +[...] +(f) the impact of substances, in particular hazardous substances, present in batteries on the environment and on human health or the safety of persons, including the impact due to inappropriate discarding of waste batteries, such as littering or discarding as unsorted municipal waste. + + + + + + + + + critical + + + en + Critical + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#critical + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Critical + + + + + en + critical + + + BOOLEAN + + + en + A flag, if the material is a critical raw material. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I: +(h) use or content of recycled materials and recovery of materials, including critical raw materials; +In Annex II of the connected proposal Act of Critical Raw Materials, a list of critical raw materials can be found. + + + + + + + + + content + + + en + Content + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Content + + + + + en + content + + + STRING + + + en + The content of the document e.g a link. + + + + + + + + + contentType + + + en + Content Type + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Content Type + + + + + en + contentType + + + STRING + + + en + The type of content which can be expected in the "content" property. Examples are a link, restricted link, pdf, excel, etc. + + + + + + + + + header + + + en + Header + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Header + + + + + en + header + + + STRING + + + en + The header as a short description of the document with a maximum of 100 characters. + + + + + + + + + documentation + + + en + Documentation + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#documentation + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Documentation + + + + + en + documentation + + + STRING + + + en + Documentation accompanying the material. + + + + + + + + + recycled + + + en + Recycled + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#recycled + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Recycled + + + + + en + recycled + + + REAL_MEASURE + + + en + The share of the material, which is recovered recycled content from the product. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I: +(h) use or content of recycled materials and recovery of materials, including critical raw materials; + + + + + + + + + location + + + en + Location + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#location + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Location + + + + + en + location + + + STRING + + + en + The location of the substances of concern within the product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7: +(5) (b) the location of the substances of concern within the product. + + + + + + + + + concentration + + + en + Concentration + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#concentration + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Concentration + + + + + en + concentration + + + REAL_MEASURE + + + en + Concentration of the material at the level of the product. This attribute is specially mentioned for substances of concern mentioned in the ESPR proposal from March 30th, 2022 Article 7: +(5) (c) the concentration, maximum concentration or concentration range of the substances of concern, at the level of the product [...]. +Other substances are mentioned for the purpose of recycling in the ESPR provisional agreement from January 9th, 2024 Annex I: +(d) design for recycling, ease and quality of recycling as expressed through: use of easily recyclable materials, safe, easy and non-destructive access to recyclable components and materials or components and materials containing hazardous substances and material composition and homogeneity, possibility for high-purity sorting, number of materials and components used, use of standard components, use of component and material coding standards for the identification of components and materials, number and complexity of processes and tools needed, ease of nondestructive disassembly and re-assembly, conditions for access to product data, conditions for access to or use of hardware and software needed. + + + + + + + + + + materialUnit + + + en + Material Unit + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#materialUnit + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Material Unit + + + + + en + materialUnit + + + STRING + + + en + The unit of concentration chosen from an enumeration: mass percent, volume percent, parts per thousand, parts per million, parts per billion and parts per trillion. + + + + + + unit:partPerMillion + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#ConcentrationEnumeration:unit:partPerMillion + + + + + + unit:percent + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#ConcentrationEnumeration:unit:percent + + + + + + unit:percentVolume + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#ConcentrationEnumeration:unit:percentVolume + + + + + + unit:partPerThousand + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#ConcentrationEnumeration:unit:partPerThousand + + + + + + unit:partPerTrillionUs + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#ConcentrationEnumeration:unit:partPerTrillionUs + + + + + + unit:partPerBillionUs + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#ConcentrationEnumeration:unit:partPerBillionUs + + + + + + + + + + + + + lead + + + en + Lead + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#lead + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Lead + + + + + en + lead + + + STRING + + + en + Information about the lead in the battery. As this is an active and hazardous material, all properties for hazardous as well as active materials are required. These attribute are mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1)(e) refers to Article 8: +1. From 18 August 2028 or 24 months after the date of entry into force of the delegated act referred to in the third subparagraph, whichever is the latest, industrial batteries with a capacity greater than 2 kWh, except those with exclusively external storage, electric vehicle batteries and SLI batteries that contain cobalt, lead, lithium or nickel in active materials, shall be accompanied by documentation containing information about the percentage share of cobalt, lithium or nickel that is present in active materials and that has been recovered from battery manufacturing waste or post-consumer waste, and the percentage share of lead that is present in the battery and that has been recovered from waste, for each battery model per year and per manufacturing plant. +And for hazardous materials this is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1) (a) refers to Annex VI Part A: +8. the hazardous substances present in the battery, other than mercury, cadmium or lead; +Additionally in Article 13: +5. All batteries containing more than 0,002 % cadmium or more than 0,004 % lead, shall be marked with the chemical symbol for the metal concerned: Cd or Pb. +Defined in Article 3: +(52) "hazardous substance" means a substance classified as hazardous pursuant to Article 3 of Regulation (EC) No 1272/2008. + + + + + + + + + location + + + en + Location + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#location + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Location + + + + + en + location + + + STRING + + + en + The location of the substances of concern within the product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7: +(5) (b) the location of the substances of concern within the product. + + + + + + + + + recycled + + + en + Recycled + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#recycled + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Recycled + + + + + en + recycled + + + REAL_MEASURE + + + en + The share of the material, which is recovered recycled content from the product. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I: +(h) use or content of recycled materials and recovery of materials, including critical raw materials; + + + + + + + + + content + + + en + Content + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Content + + + + + en + content + + + STRING + + + en + The content of the document e.g a link. + + + + + + + + + contentType + + + en + Content Type + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Content Type + + + + + en + contentType + + + STRING + + + en + The type of content which can be expected in the "content" property. Examples are a link, restricted link, pdf, excel, etc. + + + + + + + + + header + + + en + Header + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Header + + + + + en + header + + + STRING + + + en + The header as a short description of the document with a maximum of 100 characters. + + + + + + + + + documentation + + + en + Documentation + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#documentation + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Documentation + + + + + en + documentation + + + STRING + + + en + Documentation accompanying the material. + + + + + + + + + critical + + + en + Critical + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#critical + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Critical + + + + + en + critical + + + BOOLEAN + + + en + A flag, if the material is a critical raw material. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I: +(h) use or content of recycled materials and recovery of materials, including critical raw materials; +In Annex II of the connected proposal Act of Critical Raw Materials, a list of critical raw materials can be found. + + + + + + + + + chemicalId + + + en + Chemical Id + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#chemicalId + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Chemical Id + + + + + en + chemicalId + + + STRING + + + en + The substance identification, in accordance with the specification in the attribute for the list type. + + + + + + + + + listTypeId + + + en + List Type Id + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#listTypeId + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + List Type Id + + + + + en + listTypeId + + + STRING + + + en + The type of standard used for the identification of the substances. Selected can be for example CAS, IUPAC or EC. + + + + + + CAS + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#ListTypeEnumerationId:CAS + + + + + + EC + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#ListTypeEnumerationId:EC + + + + + + IUPAC + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#ListTypeEnumerationId:IUPAC + + + + + + + + + + + + + chemicalName + + + en + Chemical Name + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#chemicalName + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Chemical Name + + + + + en + chemicalName + + + STRING + + + en + The name of the material which is present in the product. + + + + + + + + + materialIdentification + + + en + Material Identification + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#materialIdentification + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Material Identification + + + + + en + materialIdentification + + + STRING + + + en + The chemical material name and identification, in accordance with the specification in the attribute for the list type. Preference is given to the IUPAC name. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Article 7: +(5) (a) the name of the substances of concern present in the product, as follows: + - name(s) in the International Union of Pure and Applied Chemistry (IUPAC) nomenclature, or another international name when IUPAC name is not available; +- other names (usual name, trade name, abbreviation); +- European Community (EC) number, as indicated in the European Inventory of Existing Commercial Chemical Substances (EINECS), the European List of Notified Chemical Substances (ELINCS) or the No Longer Polymer (NLP) list or assigned by the European Chemicals Agency (ECHA), if available; +- the Chemical Abstract Service (CAS) name(s) and number(s), if available; . + + + + + + + + + otherActiveMaterials + + + en + Other Active Materials + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#otherActiveMaterials + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Other Active Materials + + + + + en + otherActiveMaterials + + + STRING + + + en + Other active materials in the battery. + + + + + + + + + activeMaterials + + + en + Active Materials + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#activeMaterials + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Active Materials + + + + + en + activeMaterials + + + STRING + + + en + The active materials included in the battery. Mandatory are nickel, lithium, cobalt and lead. Others are optional. Defined by the Battery regulation 2023/1542 from 12 July 2023 in Article 3 Definitions: +(5) ‘active material’ means a material which reacts chemically to produce electric energy when the battery cell discharges or to store electric energy when the battery is being charged. + + + + + + + + + content + + + en + Content + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Content + + + + + en + content + + + STRING + + + en + The content of the document e.g a link. + + + + + + + + + contentType + + + en + Content Type + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Content Type + + + + + en + contentType + + + STRING + + + en + The type of content which can be expected in the "content" property. Examples are a link, restricted link, pdf, excel, etc. + + + + + + + + + header + + + en + Header + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Header + + + + + en + header + + + STRING + + + en + The header as a short description of the document with a maximum of 100 characters. + + + + + + + + + impactOfSubstances + + + en + Impact of Substances + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#impactOfSubstances + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Impact of Substances + + + + + en + impactOfSubstances + + + STRING + + + en + An accumulation of documents that refer to the impact, especially hazardous substances, on the battery. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1) (s), refers to Article 74: +1. In addition to the information referred to in Article 8a(2) of Directive 2008/98/EC, producers or, where appointed in accordance with Article 57(1), producer responsibility organisations shall make available to end-users and distributors the following information regarding the prevention and management of waste batteries with regard to the categories of batteries that they supply within the territory of a Member State: +[...] +(f) the impact of substances, in particular hazardous substances, present in batteries on the environment and on human health or the safety of persons, including the impact due to inappropriate discarding of waste batteries, such as littering or discarding as unsorted municipal waste. + + + + + + + + + concentration + + + en + Concentration + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#concentration + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Concentration + + + + + en + concentration + + + REAL_MEASURE + + + en + Concentration of the material at the level of the product. This attribute is specially mentioned for substances of concern mentioned in the ESPR proposal from March 30th, 2022 Article 7: +(5) (c) the concentration, maximum concentration or concentration range of the substances of concern, at the level of the product [...]. +Other substances are mentioned for the purpose of recycling in the ESPR provisional agreement from January 9th, 2024 Annex I: +(d) design for recycling, ease and quality of recycling as expressed through: use of easily recyclable materials, safe, easy and non-destructive access to recyclable components and materials or components and materials containing hazardous substances and material composition and homogeneity, possibility for high-purity sorting, number of materials and components used, use of standard components, use of component and material coding standards for the identification of components and materials, number and complexity of processes and tools needed, ease of nondestructive disassembly and re-assembly, conditions for access to product data, conditions for access to or use of hardware and software needed. + + + + + + + + + + location + + + en + Location + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#location + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Location + + + + + en + location + + + STRING + + + en + The location of the substances of concern within the product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7: +(5) (b) the location of the substances of concern within the product. + + + + + + + + + materialUnit + + + en + Material Unit + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#materialUnit + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Material Unit + + + + + en + materialUnit + + + STRING + + + en + The unit of concentration chosen from an enumeration: mass percent, volume percent, parts per thousand, parts per million, parts per billion and parts per trillion. + + + + + + + + + critical + + + en + Critical + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#critical + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Critical + + + + + en + critical + + + BOOLEAN + + + en + A flag, if the material is a critical raw material. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I: +(h) use or content of recycled materials and recovery of materials, including critical raw materials; +In Annex II of the connected proposal Act of Critical Raw Materials, a list of critical raw materials can be found. + + + + + + + + + content + + + en + Content + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Content + + + + + en + content + + + STRING + + + en + The content of the document e.g a link. + + + + + + + + + contentType + + + en + Content Type + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Content Type + + + + + en + contentType + + + STRING + + + en + The type of content which can be expected in the "content" property. Examples are a link, restricted link, pdf, excel, etc. + + + + + + + + + header + + + en + Header + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Header + + + + + en + header + + + STRING + + + en + The header as a short description of the document with a maximum of 100 characters. + + + + + + + + + documentation + + + en + Documentation + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#documentation + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Documentation + + + + + en + documentation + + + STRING + + + en + Documentation accompanying the material. + + + + + + + + + hazardousCadmium + + + en + Hazardous Cadmium + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#hazardousCadmium + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Hazardous Cadmium + + + + + en + hazardousCadmium + + + STRING + + + en + Information about the presence of cadmium in the battery. Therefore, a concentration and the location within the battery has to be given. This is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1) (a) refers to Annex VI Part A: +8. the hazardous substances present in the battery, other than mercury, cadmium or lead; +Defined in Article 3: +(52) "hazardous substance" means a substance classified as hazardous pursuant to Article 3 of Regulation (EC) No 1272/2008. +Additionally in Article 13: +5. All batteries containing more than 0,002 % cadmium or more than 0,004 % lead, shall be marked with the chemical symbol for the metal concerned: Cd or Pb. + + + + + + + + + content + + + en + Content + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Content + + + + + en + content + + + STRING + + + en + The content of the document e.g a link. + + + + + + + + + contentType + + + en + Content Type + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Content Type + + + + + en + contentType + + + STRING + + + en + The type of content which can be expected in the "content" property. Examples are a link, restricted link, pdf, excel, etc. + + + + + + + + + header + + + en + Header + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Header + + + + + en + header + + + STRING + + + en + The header as a short description of the document with a maximum of 100 characters. + + + + + + + + + impactOfSubstances + + + en + Impact of Substances + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#impactOfSubstances + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Impact of Substances + + + + + en + impactOfSubstances + + + STRING + + + en + An accumulation of documents that refer to the impact, especially hazardous substances, on the battery. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1) (s), refers to Article 74: +1. In addition to the information referred to in Article 8a(2) of Directive 2008/98/EC, producers or, where appointed in accordance with Article 57(1), producer responsibility organisations shall make available to end-users and distributors the following information regarding the prevention and management of waste batteries with regard to the categories of batteries that they supply within the territory of a Member State: +[...] +(f) the impact of substances, in particular hazardous substances, present in batteries on the environment and on human health or the safety of persons, including the impact due to inappropriate discarding of waste batteries, such as littering or discarding as unsorted municipal waste. + + + + + + + + + concentration + + + en + Concentration + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#concentration + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Concentration + + + + + en + concentration + + + REAL_MEASURE + + + en + Concentration of the material at the level of the product. This attribute is specially mentioned for substances of concern mentioned in the ESPR proposal from March 30th, 2022 Article 7: +(5) (c) the concentration, maximum concentration or concentration range of the substances of concern, at the level of the product [...]. +Other substances are mentioned for the purpose of recycling in the ESPR provisional agreement from January 9th, 2024 Annex I: +(d) design for recycling, ease and quality of recycling as expressed through: use of easily recyclable materials, safe, easy and non-destructive access to recyclable components and materials or components and materials containing hazardous substances and material composition and homogeneity, possibility for high-purity sorting, number of materials and components used, use of standard components, use of component and material coding standards for the identification of components and materials, number and complexity of processes and tools needed, ease of nondestructive disassembly and re-assembly, conditions for access to product data, conditions for access to or use of hardware and software needed. + + + + + + + + + + location + + + en + Location + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#location + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Location + + + + + en + location + + + STRING + + + en + The location of the substances of concern within the product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7: +(5) (b) the location of the substances of concern within the product. + + + + + + + + + materialUnit + + + en + Material Unit + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#materialUnit + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Material Unit + + + + + en + materialUnit + + + STRING + + + en + The unit of concentration chosen from an enumeration: mass percent, volume percent, parts per thousand, parts per million, parts per billion and parts per trillion. + + + + + + + + + critical + + + en + Critical + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#critical + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Critical + + + + + en + critical + + + BOOLEAN + + + en + A flag, if the material is a critical raw material. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I: +(h) use or content of recycled materials and recovery of materials, including critical raw materials; +In Annex II of the connected proposal Act of Critical Raw Materials, a list of critical raw materials can be found. + + + + + + + + + content + + + en + Content + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Content + + + + + en + content + + + STRING + + + en + The content of the document e.g a link. + + + + + + + + + contentType + + + en + Content Type + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Content Type + + + + + en + contentType + + + STRING + + + en + The type of content which can be expected in the "content" property. Examples are a link, restricted link, pdf, excel, etc. + + + + + + + + + header + + + en + Header + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Header + + + + + en + header + + + STRING + + + en + The header as a short description of the document with a maximum of 100 characters. + + + + + + + + + documentation + + + en + Documentation + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#documentation + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Documentation + + + + + en + documentation + + + STRING + + + en + Documentation accompanying the material. + + + + + + + + + hazardousMercury + + + en + Hazardous Mercury + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#hazardousMercury + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Hazardous Mercury + + + + + en + hazardousMercury + + + STRING + + + en + Information about the presence of mercury in the battery. Therefore, a concentration and the location within the battery has to be given. This is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1) (a) refers to Annex VI Part A: +8. the hazardous substances present in the battery, other than mercury, cadmium or lead; +Defined in Article 3: +(52) "hazardous substance" means a substance classified as hazardous pursuant to Article 3 of Regulation (EC) No 1272/2008. + + + + + + + + + content + + + en + Content + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Content + + + + + en + content + + + STRING + + + en + The content of the document e.g a link. + + + + + + + + + contentType + + + en + Content Type + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Content Type + + + + + en + contentType + + + STRING + + + en + The type of content which can be expected in the "content" property. Examples are a link, restricted link, pdf, excel, etc. + + + + + + + + + header + + + en + Header + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Header + + + + + en + header + + + STRING + + + en + The header as a short description of the document with a maximum of 100 characters. + + + + + + + + + impactOfSubstances + + + en + Impact of Substances + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#impactOfSubstances + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Impact of Substances + + + + + en + impactOfSubstances + + + STRING + + + en + An accumulation of documents that refer to the impact, especially hazardous substances, on the battery. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1) (s), refers to Article 74: +1. In addition to the information referred to in Article 8a(2) of Directive 2008/98/EC, producers or, where appointed in accordance with Article 57(1), producer responsibility organisations shall make available to end-users and distributors the following information regarding the prevention and management of waste batteries with regard to the categories of batteries that they supply within the territory of a Member State: +[...] +(f) the impact of substances, in particular hazardous substances, present in batteries on the environment and on human health or the safety of persons, including the impact due to inappropriate discarding of waste batteries, such as littering or discarding as unsorted municipal waste. + + + + + + + + + materialUnit + + + en + Material Unit + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#materialUnit + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Material Unit + + + + + en + materialUnit + + + STRING + + + en + The unit of concentration chosen from an enumeration: mass percent, volume percent, parts per thousand, parts per million, parts per billion and parts per trillion. + + + + + + + + + concentration + + + en + Concentration + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#concentration + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Concentration + + + + + en + concentration + + + REAL_MEASURE + + + en + Concentration of the material at the level of the product. This attribute is specially mentioned for substances of concern mentioned in the ESPR proposal from March 30th, 2022 Article 7: +(5) (c) the concentration, maximum concentration or concentration range of the substances of concern, at the level of the product [...]. +Other substances are mentioned for the purpose of recycling in the ESPR provisional agreement from January 9th, 2024 Annex I: +(d) design for recycling, ease and quality of recycling as expressed through: use of easily recyclable materials, safe, easy and non-destructive access to recyclable components and materials or components and materials containing hazardous substances and material composition and homogeneity, possibility for high-purity sorting, number of materials and components used, use of standard components, use of component and material coding standards for the identification of components and materials, number and complexity of processes and tools needed, ease of nondestructive disassembly and re-assembly, conditions for access to product data, conditions for access to or use of hardware and software needed. + + + + + + + + + + chemicalId + + + en + Chemical Id + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#chemicalId + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Chemical Id + + + + + en + chemicalId + + + STRING + + + en + The substance identification, in accordance with the specification in the attribute for the list type. + + + + + + + + + listTypeId + + + en + List Type Id + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#listTypeId + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + List Type Id + + + + + en + listTypeId + + + STRING + + + en + The type of standard used for the identification of the substances. Selected can be for example CAS, IUPAC or EC. + + + + + + + + + chemicalName + + + en + Chemical Name + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#chemicalName + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Chemical Name + + + + + en + chemicalName + + + STRING + + + en + The name of the material which is present in the product. + + + + + + + + + materialIdentification + + + en + Material Identification + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#materialIdentification + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Material Identification + + + + + en + materialIdentification + + + STRING + + + en + The chemical material name and identification, in accordance with the specification in the attribute for the list type. Preference is given to the IUPAC name. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Article 7: +(5) (a) the name of the substances of concern present in the product, as follows: + - name(s) in the International Union of Pure and Applied Chemistry (IUPAC) nomenclature, or another international name when IUPAC name is not available; +- other names (usual name, trade name, abbreviation); +- European Community (EC) number, as indicated in the European Inventory of Existing Commercial Chemical Substances (EINECS), the European List of Notified Chemical Substances (ELINCS) or the No Longer Polymer (NLP) list or assigned by the European Chemicals Agency (ECHA), if available; +- the Chemical Abstract Service (CAS) name(s) and number(s), if available; . + + + + + + + + + content + + + en + Content + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Content + + + + + en + content + + + STRING + + + en + The content of the document e.g a link. + + + + + + + + + contentType + + + en + Content Type + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Content Type + + + + + en + contentType + + + STRING + + + en + The type of content which can be expected in the "content" property. Examples are a link, restricted link, pdf, excel, etc. + + + + + + + + + header + + + en + Header + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Header + + + + + en + header + + + STRING + + + en + The header as a short description of the document with a maximum of 100 characters. + + + + + + + + + documentation + + + en + Documentation + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#documentation + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Documentation + + + + + en + documentation + + + STRING + + + en + Documentation accompanying the material. + + + + + + + + + critical + + + en + Critical + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#critical + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Critical + + + + + en + critical + + + BOOLEAN + + + en + A flag, if the material is a critical raw material. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I: +(h) use or content of recycled materials and recovery of materials, including critical raw materials; +In Annex II of the connected proposal Act of Critical Raw Materials, a list of critical raw materials can be found. + + + + + + + + + location + + + en + Location + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#location + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Location + + + + + en + location + + + STRING + + + en + The location of the substances of concern within the product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7: +(5) (b) the location of the substances of concern within the product. + + + + + + + + + otherHazardousMaterial + + + en + Other Hazardous Material + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#otherHazardousMaterial + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Other Hazardous Material + + + + + en + otherHazardousMaterial + + + STRING + + + en + Other hazardous materials. + + + + + + + + + content + + + en + Content + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Content + + + + + en + content + + + STRING + + + en + The content of the document e.g a link. + + + + + + + + + contentType + + + en + Content Type + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Content Type + + + + + en + contentType + + + STRING + + + en + The type of content which can be expected in the "content" property. Examples are a link, restricted link, pdf, excel, etc. + + + + + + + + + header + + + en + Header + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Header + + + + + en + header + + + STRING + + + en + The header as a short description of the document with a maximum of 100 characters. + + + + + + + + + impactOfSubstances + + + en + Impact of Substances + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#impactOfSubstances + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Impact of Substances + + + + + en + impactOfSubstances + + + STRING + + + en + An accumulation of documents that refer to the impact, especially hazardous substances, on the battery. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1) (s), refers to Article 74: +1. In addition to the information referred to in Article 8a(2) of Directive 2008/98/EC, producers or, where appointed in accordance with Article 57(1), producer responsibility organisations shall make available to end-users and distributors the following information regarding the prevention and management of waste batteries with regard to the categories of batteries that they supply within the territory of a Member State: +[...] +(f) the impact of substances, in particular hazardous substances, present in batteries on the environment and on human health or the safety of persons, including the impact due to inappropriate discarding of waste batteries, such as littering or discarding as unsorted municipal waste. + + + + + + + + + critical + + + en + Critical + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#critical + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Critical + + + + + en + critical + + + BOOLEAN + + + en + A flag, if the material is a critical raw material. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I: +(h) use or content of recycled materials and recovery of materials, including critical raw materials; +In Annex II of the connected proposal Act of Critical Raw Materials, a list of critical raw materials can be found. + + + + + + + + + content + + + en + Content + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Content + + + + + en + content + + + STRING + + + en + The content of the document e.g a link. + + + + + + + + + contentType + + + en + Content Type + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Content Type + + + + + en + contentType + + + STRING + + + en + The type of content which can be expected in the "content" property. Examples are a link, restricted link, pdf, excel, etc. + + + + + + + + + header + + + en + Header + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Header + + + + + en + header + + + STRING + + + en + The header as a short description of the document with a maximum of 100 characters. + + + + + + + + + documentation + + + en + Documentation + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#documentation + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Documentation + + + + + en + documentation + + + STRING + + + en + Documentation accompanying the material. + + + + + + + + + recycled + + + en + Recycled + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#recycled + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Recycled + + + + + en + recycled + + + REAL_MEASURE + + + en + The share of the material, which is recovered recycled content from the product. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I: +(h) use or content of recycled materials and recovery of materials, including critical raw materials; + + + + + + + + + location + + + en + Location + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#location + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Location + + + + + en + location + + + STRING + + + en + The location of the substances of concern within the product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7: +(5) (b) the location of the substances of concern within the product. + + + + + + + + + concentration + + + en + Concentration + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#concentration + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Concentration + + + + + en + concentration + + + REAL_MEASURE + + + en + Concentration of the material at the level of the product. This attribute is specially mentioned for substances of concern mentioned in the ESPR proposal from March 30th, 2022 Article 7: +(5) (c) the concentration, maximum concentration or concentration range of the substances of concern, at the level of the product [...]. +Other substances are mentioned for the purpose of recycling in the ESPR provisional agreement from January 9th, 2024 Annex I: +(d) design for recycling, ease and quality of recycling as expressed through: use of easily recyclable materials, safe, easy and non-destructive access to recyclable components and materials or components and materials containing hazardous substances and material composition and homogeneity, possibility for high-purity sorting, number of materials and components used, use of standard components, use of component and material coding standards for the identification of components and materials, number and complexity of processes and tools needed, ease of nondestructive disassembly and re-assembly, conditions for access to product data, conditions for access to or use of hardware and software needed. + + + + + + + + + + materialUnit + + + en + Material Unit + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#materialUnit + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Material Unit + + + + + en + materialUnit + + + STRING + + + en + The unit of concentration chosen from an enumeration: mass percent, volume percent, parts per thousand, parts per million, parts per billion and parts per trillion. + + + + + + + + + lead + + + en + Lead + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#lead + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Lead + + + + + en + lead + + + STRING + + + en + Information about the lead in the battery. As this is an active and hazardous material, all properties for hazardous as well as active materials are required. These attribute are mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1)(e) refers to Article 8: +1. From 18 August 2028 or 24 months after the date of entry into force of the delegated act referred to in the third subparagraph, whichever is the latest, industrial batteries with a capacity greater than 2 kWh, except those with exclusively external storage, electric vehicle batteries and SLI batteries that contain cobalt, lead, lithium or nickel in active materials, shall be accompanied by documentation containing information about the percentage share of cobalt, lithium or nickel that is present in active materials and that has been recovered from battery manufacturing waste or post-consumer waste, and the percentage share of lead that is present in the battery and that has been recovered from waste, for each battery model per year and per manufacturing plant. +And for hazardous materials this is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1) (a) refers to Annex VI Part A: +8. the hazardous substances present in the battery, other than mercury, cadmium or lead; +Additionally in Article 13: +5. All batteries containing more than 0,002 % cadmium or more than 0,004 % lead, shall be marked with the chemical symbol for the metal concerned: Cd or Pb. +Defined in Article 3: +(52) "hazardous substance" means a substance classified as hazardous pursuant to Article 3 of Regulation (EC) No 1272/2008. + + + + + + + + + hazardousSubstance + + + en + Hazardous Substance + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#hazardousSubstance + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Hazardous Substance + + + + + en + hazardousSubstance + + + STRING + + + en + Hazardous substances like lead, cadmium and mercury. + + + + + + + + + chemicalId + + + en + Chemical Id + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#chemicalId + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Chemical Id + + + + + en + chemicalId + + + STRING + + + en + The substance identification, in accordance with the specification in the attribute for the list type. + + + + + + + + + listTypeId + + + en + List Type Id + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#listTypeId + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + List Type Id + + + + + en + listTypeId + + + STRING + + + en + The type of standard used for the identification of the substances. Selected can be for example CAS, IUPAC or EC. + + + + + + + + + chemicalName + + + en + Chemical Name + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#chemicalName + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Chemical Name + + + + + en + chemicalName + + + STRING + + + en + The name of the material which is present in the product. + + + + + + + + + materialIdentification + + + en + Material Identification + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#materialIdentification + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Material Identification + + + + + en + materialIdentification + + + STRING + + + en + The chemical material name and identification, in accordance with the specification in the attribute for the list type. Preference is given to the IUPAC name. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Article 7: +(5) (a) the name of the substances of concern present in the product, as follows: + - name(s) in the International Union of Pure and Applied Chemistry (IUPAC) nomenclature, or another international name when IUPAC name is not available; +- other names (usual name, trade name, abbreviation); +- European Community (EC) number, as indicated in the European Inventory of Existing Commercial Chemical Substances (EINECS), the European List of Notified Chemical Substances (ELINCS) or the No Longer Polymer (NLP) list or assigned by the European Chemicals Agency (ECHA), if available; +- the Chemical Abstract Service (CAS) name(s) and number(s), if available; . + + + + + + + + + concentration + + + en + Concentration + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#concentration + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Concentration + + + + + en + concentration + + + REAL_MEASURE + + + en + Concentration of the material at the level of the product. This attribute is specially mentioned for substances of concern mentioned in the ESPR proposal from March 30th, 2022 Article 7: +(5) (c) the concentration, maximum concentration or concentration range of the substances of concern, at the level of the product [...]. +Other substances are mentioned for the purpose of recycling in the ESPR provisional agreement from January 9th, 2024 Annex I: +(d) design for recycling, ease and quality of recycling as expressed through: use of easily recyclable materials, safe, easy and non-destructive access to recyclable components and materials or components and materials containing hazardous substances and material composition and homogeneity, possibility for high-purity sorting, number of materials and components used, use of standard components, use of component and material coding standards for the identification of components and materials, number and complexity of processes and tools needed, ease of nondestructive disassembly and re-assembly, conditions for access to product data, conditions for access to or use of hardware and software needed. + + + + + + + + + + materialUnit + + + en + Material Unit + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#materialUnit + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Material Unit + + + + + en + materialUnit + + + STRING + + + en + The unit of concentration chosen from an enumeration: mass percent, volume percent, parts per thousand, parts per million, parts per billion and parts per trillion. + + + + + + + + + critical + + + en + Critical + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#critical + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Critical + + + + + en + critical + + + BOOLEAN + + + en + A flag, if the material is a critical raw material. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I: +(h) use or content of recycled materials and recovery of materials, including critical raw materials; +In Annex II of the connected proposal Act of Critical Raw Materials, a list of critical raw materials can be found. + + + + + + + + + content + + + en + Content + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Content + + + + + en + content + + + STRING + + + en + The content of the document e.g a link. + + + + + + + + + contentType + + + en + Content Type + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Content Type + + + + + en + contentType + + + STRING + + + en + The type of content which can be expected in the "content" property. Examples are a link, restricted link, pdf, excel, etc. + + + + + + + + + header + + + en + Header + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Header + + + + + en + header + + + STRING + + + en + The header as a short description of the document with a maximum of 100 characters. + + + + + + + + + documentation + + + en + Documentation + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#documentation + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Documentation + + + + + en + documentation + + + STRING + + + en + Documentation accompanying the material. + + + + + + + + + recycled + + + en + Recycled + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#recycled + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Recycled + + + + + en + recycled + + + REAL_MEASURE + + + en + The share of the material, which is recovered recycled content from the product. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I: +(h) use or content of recycled materials and recovery of materials, including critical raw materials; + + + + + + + + + location + + + en + Location + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#location + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Location + + + + + en + location + + + STRING + + + en + The location of the substances of concern within the product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7: +(5) (b) the location of the substances of concern within the product. + + + + + + + + + renewable + + + en + Renewable + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#renewable + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Renewable + + + + + en + renewable + + + REAL_MEASURE + + + en + The share of the material, which is from a renewable resource that can be replenished. Renewable resources are those that can be reproduced by physical, chemical, or mechanical processes. These are the kind of resources that can be regenerated throughout time. Forest wood, for example, can be grown through reforestation. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I: +(ha) use or content of sustainable renewable materials; + + + + + + + + + + materialComposition + + + en + Material Composition + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#materialComposition + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Material Composition + + + + + en + materialComposition + + + STRING + + + en + The materials which are necessary to describe the material composition, especially if they are active, critical or hazardous. This can be redundant to the specifically mentioned active or hazardous materials. This is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1): +(b) the material composition of the battery, including its chemistry, hazardous substances present in the battery, other than mercury, cadmium or lead, and critical raw materials present in the battery; +(f) the share of renewable content. +and in Annex XIII (2): +(a) detailed composition, including materials used in the cathode, anode and electrolyte; +Definition from Article 3: +(52) "hazardous substance" means a substance classified as hazardous pursuant to Article 3 of Regulation (EC) No 1272/2008: +A substance or a mixture fulfilling the criteria relating to physical hazards, health hazards or environmental hazards, laid down in Parts 2 to 5 of Annex I is hazardous and shall be classified in relation to the respective hazard classes provided for in that Annex. +Where, in Annex I, hazard classes are differentiated on the basis of the route of exposure or the nature of the effects, the substance or mixture shall be classified in accordance with such differentiation. +Defined in Article 2 of Regulation (EC) No 1272/2008: +1. hazard class" means the nature of the physical, health or environmental hazard. + + + + + + + + + materials + + + en + Materials + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#materials + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Materials + + + + + en + materials + + + STRING + + + en + Chemical materials relevant for the composition of the battery. These include active, hazardous and critical materials. + + + + + + + + + minVoltage + + + en + Minimum Voltage + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#minVoltage + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Minimum Voltage + + + + + en + minVoltage + + + volt + REAL_MEASURE + + + en + Minimum voltage refers to the lowest voltage the battery is able to reach. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1): +(h) minimal, nominal and maximum voltage, with temperature ranges when relevant. + + + + + + + + + maxVoltage + + + en + Maximum Voltage + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#maxVoltage + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Maximum Voltage + + + + + en + maxVoltage + + + volt + REAL_MEASURE + + + en + Maximum voltage refers to the highest voltage the battery is able to reach. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1): +(h) minimal, nominal and maximum voltage, with temperature ranges when relevant. + + + + + + + + + nominalVoltage + + + en + Nominal Voltage + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#nominalVoltage + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Nominal Voltage + + + + + en + nominalVoltage + + + volt + REAL_MEASURE + + + en + Nominal voltage is a standardized or average voltage value assigned to the battery. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1): +(h) minimal, nominal and maximum voltage, with temperature ranges when relevant. + + + + + + + + + testingTemperature + + + en + Testing Temperature + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#testingTemperature + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Testing Temperature + + + + + en + testingTemperature + + + degreeCelsius + REAL_MEASURE + + + en + Temperature refers to the temperature of the battery during it's cycle-life testing or as boundary condition for other rated values in celsius. + + + + + + + + + voltage + + + en + Voltage + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#voltage + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Voltage + + + + + en + voltage + + + STRING + + + en + Voltage values are mandatory for the battery, with the option to include temperature values voluntarily. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1): +(h) minimal, nominal and maximum voltage, with temperature ranges when relevant. + + + + + + + + + depthOfDischarge + + + en + Depth of Discharge + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#depthOfDischarge + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Depth of Discharge + + + + + en + depthOfDischarge + + + percent + REAL_MEASURE + + + en + Depth of discharge is a measure used to quantify the extent to which the battery has been discharged relative to its maximum capacity during its cycle-life testing. It represents the percentage of the total available capacity that has been drained or used during a particular discharge cycle. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (4) (a) refers to Article 10 (1), refers to Annex IV Part B: +3. Depth of discharge in the cycle-life test. + + + + + + + + + initialRoundTripEfficiency + + + en + Initial Round Trip Efficiency + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#initialRoundTripEfficiency + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Initial Round Trip Efficiency + + + + + en + initialRoundTripEfficiency + + + percent + REAL_MEASURE + + + en + The efficiency value of a battery refers to the ratio of useful output energy to the input energy, expressed as a percentage. It quantifies how effectively a battery can convert and deliver stored energy during the discharge process relative to the energy input during charging. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1): +(n) initial round trip energy efficiency and at 50 % of cycle-life. + + + + + + + + + roundTripEfficiency50Percent + + + en + Round Trip Efficiency 50 Percent + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#roundTripEfficiency50Percent + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Round Trip Efficiency 50 Percent + + + + + en + roundTripEfficiency50Percent + + + percent + REAL_MEASURE + + + en + The round trip efficiency at 50 percent refers to the efficiency of a rechargeable battery's energy storage and retrieval process when the battery has undergone approximately half of its expected number of charge-discharge cycles. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1): +(n) initial round trip energy efficiency and at 50 % of cycle-life. + + + + + + + + + testingTemperature + + + en + Testing Temperature + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#testingTemperature + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Testing Temperature + + + + + en + testingTemperature + + + REAL_MEASURE + + + en + Temperature refers to the temperature of the battery during it's cycle-life testing or as boundary condition for other rated values in celsius. + + + + + + + + + ratedRoundTripEfficiency + + + en + Rated Round Trip Efficiency + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#ratedRoundTripEfficiency + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Rated Round Trip Efficiency + + + + + en + ratedRoundTripEfficiency + + + STRING + + + en + The efficiency value of a battery refers to the ratio of useful output energy to the input energy, expressed as a percentage. With the option to include temperature values voluntarily. + + + + + + + + + energyValue + + + en + Energy Value + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#energyValue + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Energy Value + + + + + en + energyValue + + + kilowattHour + REAL_MEASURE + + + en + Value describing the energy in a specific measurement period, expressed in kilowatt-hours. + + + + + + + + + testingTemperature + + + en + Testing Temperature + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#testingTemperature + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Testing Temperature + + + + + en + testingTemperature + + + REAL_MEASURE + + + en + Temperature refers to the temperature of the battery during it's cycle-life testing or as boundary condition for other rated values in celsius. + + + + + + + + + ratedEnergy + + + en + Rated Energy + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#ratedEnergy + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Rated Energy + + + + + en + ratedEnergy + + + STRING + + + en + Representation of the total amount of energy that the battery can store and subsequently deliver during its discharge cycle. It is necessary to calculate the SOCE. + + + + + + + + + cellResistance + + + en + Cell Resistance + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#cellResistance + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Cell Resistance + + + + + en + cellResistance + + + ohm + REAL_MEASURE + + + en + Cell resistance refers to the internal resistance of an individual battery cell in ohms. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1): +(o) internal battery cell and pack resistance; +Definition from Annex IV: +(5) "Internal resistance" means the opposition to the flow of current within a cell or a battery under reference conditions, that is, the sum of electronic resistance and ionic resistance to the contribution to total effective resistance including inductive/capacitive properties. + + + + + + + + + moduleResistance + + + en + Module Resistance + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#moduleResistance + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Module Resistance + + + + + en + moduleResistance + + + ohm + REAL_MEASURE + + + en + The module resistance in ohms includes the internal resistance of each cell within the module as well as the resistance introduced by interconnecting components such as busbars, connectors, and thermal management systems. + + + + + + + + + packResistance + + + en + Pack Resistance + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#packResistance + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Pack Resistance + + + + + en + packResistance + + + ohm + REAL_MEASURE + + + en + Pack resistance refers to the overall electrical resistance within a battery pack in ohms. This resistance is a combination of the individual resistances in various components within the pack, including the electrodes, connectors, and other conductive elements. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1): +(o) internal battery cell and pack resistance; +Definition from Annex IV: +(5) "Internal resistance" means the opposition to the flow of current within a cell or a battery under reference conditions, that is, the sum of electronic resistance and ionic resistance to the contribution to total effective resistance including inductive/capacitive properties. + + + + + + + + + testingTemperature + + + en + Testing Temperature + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#testingTemperature + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Testing Temperature + + + + + en + testingTemperature + + + REAL_MEASURE + + + en + Temperature refers to the temperature of the battery during it's cycle-life testing or as boundary condition for other rated values in celsius. + + + + + + + + + ratedResistance + + + en + Rated Resistance + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#ratedResistance + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Rated Resistance + + + + + en + ratedResistance + + + STRING + + + en + Rated resistance of the battery on the level of the pack, module (optional) and cell. + + + + + + + + + powerValue + + + en + Power Value + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#powerValue + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Power Value + + + + + en + powerValue + + + watt + REAL_MEASURE + + + en + Value describing the power in a specific measurement period, expressed in watt. + + + + + + + + + capabilityAt20SoC + + + en + Capability at 20 SoC + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#capabilityAt20SoC + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Capability at 20 SoC + + + + + en + capabilityAt20SoC + + + watt + REAL_MEASURE + + + en + Capability at 20% SoC refers to the battery's capability at 80% State of Charge. This measurement is indicative of the immediate available energy in the battery. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (4)(a) refers to Article 10 (1), refers to Annex IV Part B: +4. Power capability at 80 % and 20 % state of charge. + + + + + + + + + capabilityAt80SoC + + + en + Capability at 80 SoC + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#capabilityAt80SoC + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Capability at 80 SoC + + + + + en + capabilityAt80SoC + + + watt + REAL_MEASURE + + + en + Capability at 80% SoC refers to the battery's capability at 80% State of Charge. This measurement is indicative of the immediate available energy in the battery. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (4)(a) refers to Article 10 (1), refers to Annex IV Part B: +4. Power capability at 80 % and 20 % state of charge + + + + + + + + + testingTemperature + + + en + Testing Temperature + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#testingTemperature + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Testing Temperature + + + + + en + testingTemperature + + + REAL_MEASURE + + + en + Temperature refers to the temperature of the battery during it's cycle-life testing or as boundary condition for other rated values in celsius. + + + + + + + + + ratedPower + + + en + Rated Power + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#ratedPower + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Rated Power + + + + + en + ratedPower + + + STRING + + + en + The power value is the rate at which energy is delivered or consumed. It is measured in watts (W) and represents how quickly energy is transferred. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (4)(a) refers to Article 10(1), refers to Annex IV Part A: +2. Power (in W) and power fade (in %). +Definition from Annex IV: +(3) "Power" means the amount of energy that a battery is capable of providing over a given period under reference conditions. + + + + + + + + + capacityValue + + + en + Capacity Value + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#capacityValue + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Capacity Value + + + + + en + capacityValue + + + ampereHour + REAL_MEASURE + + + en + Value describing the capacity in a specific measurement period, expressed in ampere-hours. + + + + + + + + + capacityThresholdExhaustion + + + en + Capacity Threshold Exhaustion + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#capacityThresholdExhaustion + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Capacity Threshold Exhaustion + + + + + en + capacityThresholdExhaustion + + + percent + REAL_MEASURE + + + en + Capacity threshold exhaustion refers to the condition where a battery's capacity diminishes to a level that is considered unacceptable for its intended use. The capacity threshold is a predetermined level below which the battery is considered to be no longer effective or reliable for the specific application. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1): +(k) capacity threshold for exhaustion (only for electric vehicle batteries). + + + + + + + + + testingTemperature + + + en + Testing Temperature + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#testingTemperature + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Testing Temperature + + + + + en + testingTemperature + + + REAL_MEASURE + + + en + Temperature refers to the temperature of the battery during it's cycle-life testing or as boundary condition for other rated values in celsius. + + + + + + + + + ratedCapacity + + + en + Rated Capacity + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#ratedCapacity + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Rated Capacity + + + + + en + ratedCapacity + + + STRING + + + en + Capacity value refers to the amount of electric charge that a battery can store and subsequently deliver when needed. It is a fundamental characteristic of a battery and is expressed in ampere-hours. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1): +(g) rated capacity (in Ah); +and in Annex XIII (4)(a) referring to Article 10 (1) and referring to Annex IV Part A: +1. Rated capacity (in Ah) and capacity fade (in %). +And in Annex XIII (1)(a) referring to Annex VI Part A: +6. the capacity; +Definition from Annex IV: +(1) "Rated capacity" means the total number of ampere-hours (Ah) that can be withdrawn from a fully charged battery under reference conditions. + + + + + + + + + content + + + en + Content + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Content + + + + + en + content + + + STRING + + + en + The content of the document e.g a link. + + + + + + + + + contentType + + + en + Content Type + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Content Type + + + + + en + contentType + + + STRING + + + en + The type of content which can be expected in the "content" property. Examples are a link, restricted link, pdf, excel, etc. + + + + + + + + + header + + + en + Header + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Header + + + + + en + header + + + STRING + + + en + The header as a short description of the document with a maximum of 100 characters. + + + + + + + + + performanceDocument + + + en + Performance Document + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#performanceDocument + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Performance Document + + + + + en + performanceDocument + + + STRING + + + en + The performance document lists information regarding the performance of the battery. This can be an overview about several rated performance attributes. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (3): +[...] results of test reports proving compliance with the requirements laid down in this Regulation or any delegated or implementing act adopted pursuant to this Regulation. +And Annex XIII (4)(a) refers to Article 10(1) and refer to Annex IV Part B: +5. Any calculations performed with the measured parameters, if applicable. + + + + + + + + + lowerTemperatureBoundary + + + en + Lower Temperature Boundary + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#lowerTemperatureBoundary + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Lower Temperature Boundary + + + + + en + lowerTemperatureBoundary + + + degreeCelsius + REAL_MEASURE + + + en + The lower temperature boundary (in Celsius) refers to the minimum temperature at which a battery can effectively operate. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1): +(l) temperature range the battery can withstand when not in use (reference test). + + + + + + + + + upperTemperatureBoundary + + + en + Upper Temperature Boundary + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#upperTemperatureBoundary + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Upper Temperature Boundary + + + + + en + upperTemperatureBoundary + + + degreeCelsius + REAL_MEASURE + + + en + The upper temperature boundary (in Celsius) refers to the minimum temperature at which a battery can effectively operate. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1): +(l) temperature range the battery can withstand when not in use (reference test). + + + + + + + + + performanceTemperature + + + en + Performance Temperature + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#performanceTemperature + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Performance Temperature + + + + + en + performanceTemperature + + + STRING + + + en + The battery temperatures. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1): +(l) temperature range the battery can withstand when not in use (reference test). + + + + + + + + + selfDischargingRate + + + en + Self Discharging Rate + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#selfDischargingRate + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Self Discharging Rate + + + + + en + selfDischargingRate + + + percent + REAL_MEASURE + + + en + The self-discharge rate of a battery refers to the rate at which the battery loses its stored energy when not in use. It's the discharge of the battery that occurs internally without any external load recorded in percentage for every month. This attribute is mentioned in the Battery Regulation 2023/1542 from 12 July 2023 in Annex XIII (4) (b) refers to Article 14, refers to Annex VII Part A: +4. the evolution of self-discharging rates. + + + + + + + + + content + + + en + Content + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Content + + + + + en + content + + + STRING + + + en + The content of the document e.g a link. + + + + + + + + + contentType + + + en + Content Type + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Content Type + + + + + en + contentType + + + STRING + + + en + The type of content which can be expected in the "content" property. Examples are a link, restricted link, pdf, excel, etc. + + + + + + + + + header + + + en + Header + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Header + + + + + en + header + + + STRING + + + en + The header as a short description of the document with a maximum of 100 characters. + + + + + + + + + testReport + + + en + Test Report + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#testReport + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Test Report + + + + + en + testReport + + + STRING + + + en + The test reports refer to the testing conducted during the determination of the rated values of the battery. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (3): +[...] results of test reports proving compliance with the requirements laid down in this Regulation or any delegated or implementing act adopted pursuant to this Regulation. +And Annex XIII (4)(a) refers to Article 10(1) and refer to Annex IV Part B: +5. Any calculations performed with the measured parameters, if applicable. + + + + + + + + + expectedYears + + + en + Expected Years + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#expectedYears + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Expected Years + + + + + en + expectedYears + + + INTEGER_MEASURE + + + en + The expected years refer to the expected life-time of the battery before it starts heavily degrading in its capacity and c-rate in calendar years. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (4) (a) refers to the Article 10 (1) refers to Annex IV Part A: +5. The expected life-time of the battery under the reference conditions for which it has been designed, in terms of cycles, except for non-cycle applications, and calendar years. + + + + + + + + + content + + + en + Content + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Content + + + + + en + content + + + STRING + + + en + The content of the document e.g a link. + + + + + + + + + contentType + + + en + Content Type + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Content Type + + + + + en + contentType + + + STRING + + + en + The type of content which can be expected in the "content" property. Examples are a link, restricted link, pdf, excel, etc. + + + + + + + + + header + + + en + Header + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Header + + + + + en + header + + + STRING + + + en + The header as a short description of the document with a maximum of 100 characters. + + + + + + + + + testReport + + + en + Test Report + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#testReport + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Test Report + + + + + en + testReport + + + STRING + + + en + The test reports refer to the testing conducted during the determination of the rated values of the battery. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (3): +[...] results of test reports proving compliance with the requirements laid down in this Regulation or any delegated or implementing act adopted pursuant to this Regulation. +And Annex XIII (4)(a) refers to Article 10(1) and refer to Annex IV Part B: +5. Any calculations performed with the measured parameters, if applicable. + + + + + + + + + testingTemperature + + + en + Testing Temperature + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#testingTemperature + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Testing Temperature + + + + + en + testingTemperature + + + REAL_MEASURE + + + en + Temperature refers to the temperature of the battery during it's cycle-life testing or as boundary condition for other rated values in celsius. + + + + + + + + + cycles + + + en + Cycles + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#cycles + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Cycles + + + + + en + cycles + + + INTEGER_MEASURE + + + en + Cycle refers to one complete charging and discharging sequence. Either during the battery's cycle-life testing or as full equivalent while in use. + + + + + + + + + depthOfDischarge + + + en + Depth of Discharge + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#depthOfDischarge + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Depth of Discharge + + + + + en + depthOfDischarge + + + REAL_MEASURE + + + en + Depth of discharge is a measure used to quantify the extent to which the battery has been discharged relative to its maximum capacity during its cycle-life testing. It represents the percentage of the total available capacity that has been drained or used during a particular discharge cycle. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (4) (a) refers to Article 10 (1), refers to Annex IV Part B: +3. Depth of discharge in the cycle-life test. + + + + + + + + + appliedChargeRate + + + en + Applied Charge Rate + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#appliedChargeRate + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Applied Charge Rate + + + + + en + appliedChargeRate + + + REAL_MEASURE + + + en + The applied charge rate (c rate) refers to the rate at which a battery is charged. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1): +(p) c-rate of relevant cycle-life test; +and Annex XIII (4)(a) refers to Article 10(1) refers to Annex IV Part B: +1. Applied discharge rate and charge rate. + + + + + + + + + appliedDischargeRate + + + en + Applied Discharge Rate + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#appliedDischargeRate + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Applied Discharge Rate + + + + + en + appliedDischargeRate + + + REAL_MEASURE + + + en + The applied discharge rate (c rate) refers to the rate at which a battery is discharged. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1): +(p) c-rate of relevant cycle-life test; +and Annex XIII (4)(a) refers to Article 10(1) refers to Annex IV Part B: +1. Applied discharge rate and charge rate. + + + + + + + + + cycleLifeTesting + + + en + Cycle Life Testing + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#cycleLifeTesting + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Cycle Life Testing + + + + + en + cycleLifeTesting + + + STRING + + + en + The cycle life testing of the battery. + + + + + + + + + lifetime + + + en + Lifetime + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#lifetime + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Lifetime + + + + + en + lifetime + + + STRING + + + en + Attributes for the lifetime evaluation of a battery. + + + + + + + + + ratedPerformance + + + en + Rated Performance + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#ratedPerformance + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Rated Performance + + + + + en + ratedPerformance + + + STRING + + + en + Rated performance values of the battery such as voltage, round trip efficiency, energy, resistance, power, capacity, temperature ranges and self-discharging rate. + + + + + + + + + percentValue + + + en + Percent Value + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#percentValue + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Percent Value + + + + + en + percentValue + + + percent + REAL_MEASURE + + + en + A value as a percentage in the form of a double. + + + + + + + + + dataRecordTime + + + en + Data Record Time + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#dataRecordTime + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Data Record Time + + + + + en + dataRecordTime + + + STRING + + + en + The entry date and time corresponding to when a specific parameter was measured. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (4): +(d) information and data resulting from its use, including the number of charging and discharging cycles and negative events, such as accidents, as well as periodically recorded information on the operating environmental conditions, including temperature, and on the state of charge. + + + + + + + + + stateOfCharge + + + en + State of Charge + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#stateOfCharge + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + State of Charge + + + + + en + stateOfCharge + + + STRING + + + en + State of Charge (SOC) refers to the amount of energy remaining in a battery at a given point in time, expressed as a percentage of the total capacity. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (4): +(d) information and data resulting from its use, including the number of charging and discharging cycles and negative events, such as accidents, as well as periodically recorded information on the operating environmental conditions, including temperature, and on the state of charge. + + + + + + + + + dataRecordTime + + + en + Data Record Time + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#dataRecordTime + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Data Record Time + + + + + en + dataRecordTime + + + STRING + + + en + The entry date and time corresponding to when a specific parameter was measured. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (4): +(d) information and data resulting from its use, including the number of charging and discharging cycles and negative events, such as accidents, as well as periodically recorded information on the operating environmental conditions, including temperature, and on the state of charge. + + + + + + + + + cycles + + + en + Cycles + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#cycles + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Cycles + + + + + en + cycles + + + INTEGER_MEASURE + + + en + Cycle refers to one complete charging and discharging sequence. Either during the battery's cycle-life testing or as full equivalent while in use. + + + + + + + + + fullCycles + + + en + Full Cycles + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#fullCycles + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Full Cycles + + + + + en + fullCycles + + + STRING + + + en + Full cycles include the cumulative and equivalent count of complete charge and discharge cycles experienced by the battery over its entire life. This attribute is mentioned in the Battery Regulation 2023/1542 from 12 July 2023 in Annex XIII (4) (d) information and data resulting from its use, including the number of charging and discharging cycles and negative events, such as accidents, as well as periodically recorded information on the operating environmental conditions, including temperature, and on the state of charge. +And in AnnexVII Part B: +5. the number of full equivalent charge-discharge cycles. + + + + + + + + + content + + + en + Content + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Content + + + + + en + content + + + STRING + + + en + The content of the document e.g a link. + + + + + + + + + contentType + + + en + Content Type + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Content Type + + + + + en + contentType + + + STRING + + + en + The type of content which can be expected in the "content" property. Examples are a link, restricted link, pdf, excel, etc. + + + + + + + + + header + + + en + Header + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Header + + + + + en + header + + + STRING + + + en + The header as a short description of the document with a maximum of 100 characters. + + + + + + + + + performanceDocument + + + en + Performance Document + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#performanceDocument + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Performance Document + + + + + en + performanceDocument + + + STRING + + + en + The performance document lists information regarding the performance of the battery. This can be an overview about several rated performance attributes. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (3): +[...] results of test reports proving compliance with the requirements laid down in this Regulation or any delegated or implementing act adopted pursuant to this Regulation. +And Annex XIII (4)(a) refers to Article 10(1) and refer to Annex IV Part B: +5. Any calculations performed with the measured parameters, if applicable. + + + + + + + + + selfDischargingRate + + + en + Self Discharging Rate + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#selfDischargingRate + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Self Discharging Rate + + + + + en + selfDischargingRate + + + REAL_MEASURE + + + en + The self-discharge rate of a battery refers to the rate at which the battery loses its stored energy when not in use. It's the discharge of the battery that occurs internally without any external load recorded in percentage for every month. This attribute is mentioned in the Battery Regulation 2023/1542 from 12 July 2023 in Annex XIII (4) (b) refers to Article 14, refers to Annex VII Part A: +4. the evolution of self-discharging rates. + + + + + + + + + percentValue + + + en + Percent Value + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#percentValue + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Percent Value + + + + + en + percentValue + + + REAL_MEASURE + + + en + A value as a percentage in the form of a double. + + + + + + + + + dataRecordTime + + + en + Data Record Time + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#dataRecordTime + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Data Record Time + + + + + en + dataRecordTime + + + STRING + + + en + The entry date and time corresponding to when a specific parameter was measured. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (4): +(d) information and data resulting from its use, including the number of charging and discharging cycles and negative events, such as accidents, as well as periodically recorded information on the operating environmental conditions, including temperature, and on the state of charge. + + + + + + + + + powerFade + + + en + PowerFade + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#powerFade + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + PowerFade + + + + + en + powerFade + + + STRING + + + en + Power fade refers to a reduction in the power of the battery system over time expressed as a percentage in reference to the initial value. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (4)(a) refers to Article 10 (1), refers to Annex IV Part A: +2. Power (in W) and power fade (in %). +Definition from Annex IV: +(4) "Power fade" means the decrease over time and upon usage in the amount of power that a battery can deliver at the rated voltage. + + + + + + + + + dataRecordTime + + + en + Data Record Time + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#dataRecordTime + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Data Record Time + + + + + en + dataRecordTime + + + STRING + + + en + The entry date and time corresponding to when a specific parameter was measured. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (4): +(d) information and data resulting from its use, including the number of charging and discharging cycles and negative events, such as accidents, as well as periodically recorded information on the operating environmental conditions, including temperature, and on the state of charge. + + + + + + + + + powerValue + + + en + Power Value + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#powerValue + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Power Value + + + + + en + powerValue + + + REAL_MEASURE + + + en + Value describing the power in a specific measurement period, expressed in watt. + + + + + + + + + remainingPower + + + en + Remaining Power + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#remainingPower + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Remaining Power + + + + + en + remainingPower + + + STRING + + + en + The remaining power capability in the battery expressed in watt. This attribute is mentioned in the Battery Regulation 2023/1542 from 12 July 2023 in Annex XIII (4) (b) refers to Article 14, refers to Annex VII Part A: +2. where possible, the remaining power capability; +Definition from Annex IV: +(3) "Power" means the amount of energy that a battery is capable of providing over a given period under reference +conditions. + + + + + + + + + dynamicPower + + + en + Dynamic Power + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#dynamicPower + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Dynamic Power + + + + + en + dynamicPower + + + STRING + + + en + Values that describe dynamically captured power values. + + + + + + + + + percentValue + + + en + Percent Value + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#percentValue + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Percent Value + + + + + en + percentValue + + + REAL_MEASURE + + + en + A value as a percentage in the form of a double. + + + + + + + + + dataRecordTime + + + en + Data Record Time + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#dataRecordTime + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Data Record Time + + + + + en + dataRecordTime + + + STRING + + + en + The entry date and time corresponding to when a specific parameter was measured. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (4): +(d) information and data resulting from its use, including the number of charging and discharging cycles and negative events, such as accidents, as well as periodically recorded information on the operating environmental conditions, including temperature, and on the state of charge. + + + + + + + + + capacityFade + + + en + Capacity Fade + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#capacityFade + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Capacity Fade + + + + + en + capacityFade + + + STRING + + + en + Capacity fade refers to a reduction in the capacity of the battery system over time expressed as a percentage in reference to the initial value. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (4)(a) refers to Article 10(1) and refer to Annex IV Part A: +1. Rated capacity (in Ah) and capacity fade (in %). +Definition from Annex IV: +(2) "Capacity fade" means the decrease over time and upon usage in the amount of charge that a battery can deliver at the rated voltage, with respect to the original rated capacity. + + + + + + + + + dataRecordTime + + + en + Data Record Time + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#dataRecordTime + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Data Record Time + + + + + en + dataRecordTime + + + STRING + + + en + The entry date and time corresponding to when a specific parameter was measured. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (4): +(d) information and data resulting from its use, including the number of charging and discharging cycles and negative events, such as accidents, as well as periodically recorded information on the operating environmental conditions, including temperature, and on the state of charge. + + + + + + + + + capacityValue + + + en + Capacity Value + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#capacityValue + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Capacity Value + + + + + en + capacityValue + + + REAL_MEASURE + + + en + Value describing the capacity in a specific measurement period, expressed in ampere-hours. + + + + + + + + + capacityThroughput + + + en + Capacity Throughput + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#capacityThroughput + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Capacity Throughput + + + + + en + capacityThroughput + + + STRING + + + en + Capacity throughput refers to the total amount of energy that a battery has delivered over its lifetime. It represents the cumulative energy discharge and recharge cycles a battery has undergone. Capacity throughput is expressed in ampere-hours. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex VII Part B: +3. the capacity throughput. + + + + + + + + + dataRecordTime + + + en + Data Record Time + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#dataRecordTime + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Data Record Time + + + + + en + dataRecordTime + + + STRING + + + en + The entry date and time corresponding to when a specific parameter was measured. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (4): +(d) information and data resulting from its use, including the number of charging and discharging cycles and negative events, such as accidents, as well as periodically recorded information on the operating environmental conditions, including temperature, and on the state of charge. + + + + + + + + + capacityValue + + + en + Capacity Value + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#capacityValue + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Capacity Value + + + + + en + capacityValue + + + REAL_MEASURE + + + en + Value describing the capacity in a specific measurement period, expressed in ampere-hours. + + + + + + + + + remainingCapacity + + + en + Remaining Capacity + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#remainingCapacity + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Remaining Capacity + + + + + en + remainingCapacity + + + STRING + + + en + The remaining capacity in the battery expressed in ampere hours. This attribute is mentioned in the Battery Regulation 2023/1542 from 12 July 2023 in Annex XIII (4) (b) refers to Article 14, refers to Annex VII Part A: +1. the remaining capacity. + + + + + + + + + + dynamicCapacity + + + en + Dynamic Capacity + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#dynamicCapacity + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Dynamic Capacity + + + + + en + dynamicCapacity + + + STRING + + + en + Values that describe dynamically captured capacity values. + + + + + + + + + percentValue + + + en + Percent Value + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#percentValue + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Percent Value + + + + + en + percentValue + + + REAL_MEASURE + + + en + A value as a percentage in the form of a double. + + + + + + + + + dataRecordTime + + + en + Data Record Time + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#dataRecordTime + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Data Record Time + + + + + en + dataRecordTime + + + STRING + + + en + The entry date and time corresponding to when a specific parameter was measured. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (4): +(d) information and data resulting from its use, including the number of charging and discharging cycles and negative events, such as accidents, as well as periodically recorded information on the operating environmental conditions, including temperature, and on the state of charge. + + + + + + + + + roundTripEfficiencyFade + + + en + Round Trip Efficiency Fade + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#roundTripEfficiencyFade + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Round Trip Efficiency Fade + + + + + en + roundTripEfficiencyFade + + + STRING + + + en + Round trip efficiency fade refers to a reduction in the round trip efficiency of the battery system over time expressed as a percentage in reference to the initial value. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (4)(a) refers to Article 10(1) and refers to Annex IV: +4. Where applicable, energy round trip efficiency and its fade (in %). +Definition from Annex IV: +(6) "Energy round trip efficiency" means the ratio of the net energy delivered by a battery during a discharge test to the total energy required to restore the initial state of charge by a standard charge. + + + + + + + + + percentValue + + + en + Percent Value + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#percentValue + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Percent Value + + + + + en + percentValue + + + REAL_MEASURE + + + en + A value as a percentage in the form of a double. + + + + + + + + + dataRecordTime + + + en + Data Record Time + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#dataRecordTime + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Data Record Time + + + + + en + dataRecordTime + + + STRING + + + en + The entry date and time corresponding to when a specific parameter was measured. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (4): +(d) information and data resulting from its use, including the number of charging and discharging cycles and negative events, such as accidents, as well as periodically recorded information on the operating environmental conditions, including temperature, and on the state of charge. + + + + + + + + + remainingRoundTripEfficiency + + + en + Remaining Round Trip Efficiency + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#remainingRoundTripEfficiency + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Remaining Round Trip Efficiency + + + + + en + remainingRoundTripEfficiency + + + STRING + + + en + The remaining round trip efficiency in the battery expressed as percentage. This attribute is mentioned in the Battery Regulation 2023/1542 from 12 July 2023 in Annex XIII (4) (b) refers to Article 14, refers to Annex VII Part A: +3. where possible, the remaining round trip efficiency. +Definition from Annex IV: +(6) "Energy round trip efficiency" means the ratio of the net energy delivered by a battery during a discharge test to the total energy required to restore the initial state of charge by a standard charge. + + + + + + + + + dynamicRoundTripEfficiency + + + en + Dynamic Round Trip Efficiency + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#dynamicRoundTripEfficiency + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Dynamic Round Trip Efficiency + + + + + en + dynamicRoundTripEfficiency + + + STRING + + + en + Dynamic round trip efficiency values. + + + + + + + + + percentValue + + + en + Percent Value + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#percentValue + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Percent Value + + + + + en + percentValue + + + REAL_MEASURE + + + en + A value as a percentage in the form of a double. + + + + + + + + + dataRecordTime + + + en + Data Record Time + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#dataRecordTime + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Data Record Time + + + + + en + dataRecordTime + + + STRING + + + en + The entry date and time corresponding to when a specific parameter was measured. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (4): +(d) information and data resulting from its use, including the number of charging and discharging cycles and negative events, such as accidents, as well as periodically recorded information on the operating environmental conditions, including temperature, and on the state of charge. + + + + + + + + + packResistanceIncrease + + + en + Pack Resistance Increase + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#packResistanceIncrease + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Pack Resistance Increase + + + + + en + packResistanceIncrease + + + STRING + + + en + Pack resistance increase refers to the overall electrical resistance within a battery pack. This resistance is a combination of the individual resistances in various components within the pack, including the electrodes, connectors, and other conductive elements. The rise in the pack resistance is expressed as a percentage in reference to the initial value. +This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (4)(a) refers to Article 10(1) and refers to Annex IV Part A: +3. Internal resistance (in ") and internal resistance increase (in %). +Definition from Annex IV: +(5) "Internal resistance" means the opposition to the flow of current within a cell or a battery under reference conditions, that is, the sum of electronic resistance and ionic resistance to the contribution to total effective resistance including inductive/capacitive properties. + + + + + + + + + percentValue + + + en + Percent Value + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#percentValue + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Percent Value + + + + + en + percentValue + + + REAL_MEASURE + + + en + A value as a percentage in the form of a double. + + + + + + + + + dataRecordTime + + + en + Data Record Time + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#dataRecordTime + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Data Record Time + + + + + en + dataRecordTime + + + STRING + + + en + The entry date and time corresponding to when a specific parameter was measured. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (4): +(d) information and data resulting from its use, including the number of charging and discharging cycles and negative events, such as accidents, as well as periodically recorded information on the operating environmental conditions, including temperature, and on the state of charge. + + + + + + + + + moduleResistanceIncrease + + + en + module Resistance Increase + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#moduleResistanceIncrease + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + module Resistance Increase + + + + + en + moduleResistanceIncrease + + + STRING + + + en + The module resistance increase includes the internal resistance of each cell within the module as well as the resistance introduced by interconnecting components such as busbars, connectors, and thermal management systems. The rise in the module resistance is expressed as a percentage in reference to the initial value. + + + + + + + + + percentValue + + + en + Percent Value + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#percentValue + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Percent Value + + + + + en + percentValue + + + REAL_MEASURE + + + en + A value as a percentage in the form of a double. + + + + + + + + + dataRecordTime + + + en + Data Record Time + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#dataRecordTime + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Data Record Time + + + + + en + dataRecordTime + + + STRING + + + en + The entry date and time corresponding to when a specific parameter was measured. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (4): +(d) information and data resulting from its use, including the number of charging and discharging cycles and negative events, such as accidents, as well as periodically recorded information on the operating environmental conditions, including temperature, and on the state of charge. + + + + + + + + + cellResistanceIncrease + + + en + Cell Resistance Increase + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#cellResistanceIncrease + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Cell Resistance Increase + + + + + en + cellResistanceIncrease + + + STRING + + + en + Cell resistance increase refers to the internal resistance of an individual battery cell. The rise in the cell resistance is expressed as a percentage in reference to the initial value. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (4)(a) refers to Article 10(1) and refers to Annex IV Part A: +3. Internal resistance (in ohms) and internal resistance increase (in %). +Definition from Annex IV: +(5) "Internal resistance" means the opposition to the flow of current within a cell or a battery under reference conditions, that is, the sum of electronic resistance and ionic resistance to the contribution to total effective resistance including inductive/capacitive properties. + + + + + + + + + resistanceIncrease + + + en + Resistance Increase + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#resistanceIncrease + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Resistance Increase + + + + + en + resistanceIncrease + + + STRING + + + en + The increase as percentage in the battery resistance on the level of the pack, module (optional) and cell. + + + + + + + + + dataRecordTime + + + en + Data Record Time + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#dataRecordTime + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Data Record Time + + + + + en + dataRecordTime + + + STRING + + + en + The entry date and time corresponding to when a specific parameter was measured. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (4): +(d) information and data resulting from its use, including the number of charging and discharging cycles and negative events, such as accidents, as well as periodically recorded information on the operating environmental conditions, including temperature, and on the state of charge. + + + + + + + + + remainingResistanceValue + + + en + Remaining Resistance Value + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#remainingResistanceValue + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Remaining Resistance Value + + + + + en + remainingResistanceValue + + + ohm + REAL_MEASURE + + + en + The remaining resistance value expressed in ohms. + + + + + + + + + remainingPackResistance + + + en + Remaining Pack Resistance + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#remainingPackResistance + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Remaining Pack Resistance + + + + + en + remainingPackResistance + + + STRING + + + en + Pack resistance refers to the overall electrical resistance within a battery pack. This resistance is a combination of the individual resistances in various components within the pack, including the electrodes, connectors, and other conductive elements. This attribute is mentioned in the Battery Regulation 2023/1542 from 12 July 2023 in Annex XIII (4) (b) refers to Article 14, refers to Annex VII Part A: +5. where possible, the ohmic resistance. + + + + + + + + + dataRecordTime + + + en + Data Record Time + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#dataRecordTime + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Data Record Time + + + + + en + dataRecordTime + + + STRING + + + en + The entry date and time corresponding to when a specific parameter was measured. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (4): +(d) information and data resulting from its use, including the number of charging and discharging cycles and negative events, such as accidents, as well as periodically recorded information on the operating environmental conditions, including temperature, and on the state of charge. + + + + + + + + + remainingResistanceValue + + + en + Remaining Resistance Value + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#remainingResistanceValue + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Remaining Resistance Value + + + + + en + remainingResistanceValue + + + REAL_MEASURE + + + en + The remaining resistance value expressed in ohms. + + + + + + + + + remainingModuleResistance + + + en + Remaining Module Resistance + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#remainingModuleResistance + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Remaining Module Resistance + + + + + en + remainingModuleResistance + + + STRING + + + en + Module resistance in ohms includes the internal resistance of each cell within the module as well as the resistance introduced by interconnecting components such as busbars, connectors, and thermal management systems. + + + + + + + + + dataRecordTime + + + en + Data Record Time + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#dataRecordTime + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Data Record Time + + + + + en + dataRecordTime + + + STRING + + + en + The entry date and time corresponding to when a specific parameter was measured. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (4): +(d) information and data resulting from its use, including the number of charging and discharging cycles and negative events, such as accidents, as well as periodically recorded information on the operating environmental conditions, including temperature, and on the state of charge. + + + + + + + + + remainingResistanceValue + + + en + Remaining Resistance Value + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#remainingResistanceValue + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Remaining Resistance Value + + + + + en + remainingResistanceValue + + + REAL_MEASURE + + + en + The remaining resistance value expressed in ohms. + + + + + + + + + remainingCellResistance + + + en + Remaining Cell Resistance + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#remainingCellResistance + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Remaining Cell Resistance + + + + + en + remainingCellResistance + + + STRING + + + en + Cell resistance refers to the internal resistance of an individual battery cell expressed in ohms. This attribute is mentioned in the Battery Regulation 2023/1542 from 12 July 2023 in Annex XIII (4) (b) refers to Article 14, refers to Annex VII Part A: +5. where possible, the ohmic resistance. + + + + + + + + + remainingResistance + + + en + Remaining Resistance + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#remainingResistance + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Remaining Resistance + + + + + en + remainingResistance + + + STRING + + + en + The remaining resistance in ohms in the battery on the level of the pack, module (optional) and cell. + + + + + + + + + dynamicInternalResistance + + + en + Dynamic Internal Resistance + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#dynamicInternalResistance + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Dynamic Internal Resistance + + + + + en + dynamicInternalResistance + + + STRING + + + en + Values that describe dynamically captured internal resistance values. + + + + + + + + + percentValue + + + en + Percent Value + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#percentValue + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Percent Value + + + + + en + percentValue + + + REAL_MEASURE + + + en + A value as a percentage in the form of a double. + + + + + + + + + dataRecordTime + + + en + Data Record Time + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#dataRecordTime + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Data Record Time + + + + + en + dataRecordTime + + + STRING + + + en + The entry date and time corresponding to when a specific parameter was measured. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (4): +(d) information and data resulting from its use, including the number of charging and discharging cycles and negative events, such as accidents, as well as periodically recorded information on the operating environmental conditions, including temperature, and on the state of charge. + + + + + + + + + soce + + + en + SOCE + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#soce + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + SOCE + + + + + en + soce + + + STRING + + + en + The state of certified energy (SOCE) refers to the current measured or on-board usable battery energy (UBE) performance expressed as a percentage. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (4)(b) refers to Article 14) and refers to Annex VII Part A: +state of certified energy (SOCE). + + + + + + + + + dataRecordTime + + + en + Data Record Time + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#dataRecordTime + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Data Record Time + + + + + en + dataRecordTime + + + STRING + + + en + The entry date and time corresponding to when a specific parameter was measured. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (4): +(d) information and data resulting from its use, including the number of charging and discharging cycles and negative events, such as accidents, as well as periodically recorded information on the operating environmental conditions, including temperature, and on the state of charge. + + + + + + + + + energyValue + + + en + Energy Value + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#energyValue + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Energy Value + + + + + en + energyValue + + + REAL_MEASURE + + + en + Value describing the energy in a specific measurement period, expressed in kilowatt-hours. + + + + + + + + + remainingEnergy + + + en + Remaining Energy + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#remainingEnergy + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Remaining Energy + + + + + en + remainingEnergy + + + STRING + + + en + The remaining energy in the battery expressed in kilowatt-hours. + + + + + + + + + dataRecordTime + + + en + Data Record Time + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#dataRecordTime + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Data Record Time + + + + + en + dataRecordTime + + + STRING + + + en + The entry date and time corresponding to when a specific parameter was measured. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (4): +(d) information and data resulting from its use, including the number of charging and discharging cycles and negative events, such as accidents, as well as periodically recorded information on the operating environmental conditions, including temperature, and on the state of charge. + + + + + + + + + energyValue + + + en + Energy Value + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#energyValue + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Energy Value + + + + + en + energyValue + + + REAL_MEASURE + + + en + Value describing the energy in a specific measurement period, expressed in kilowatt-hours. + + + + + + + + + energyThroughput + + + en + Energy Throughput + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#energyThroughput + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Energy Throughput + + + + + en + energyThroughput + + + STRING + + + en + Energy throughput refers to the total amount of energy that passes through a system over a specific period. This measure encompasses both the energy input (during charging) and the energy output (during discharging). Energy throughput is expressed in kilowatt-hours. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex VII Part B: +2. the energy throughput. + + + + + + + + + dynamicEnergy + + + en + Dynamic Energy + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#dynamicEnergy + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Dynamic Energy + + + + + en + dynamicEnergy + + + STRING + + + en + Values that describe dynamically captured energy values. + + + + + + + + + content + + + en + Content + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Content + + + + + en + content + + + STRING + + + en + The content of the document e.g a link. + + + + + + + + + contentType + + + en + Content Type + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Content Type + + + + + en + contentType + + + STRING + + + en + The type of content which can be expected in the "content" property. Examples are a link, restricted link, pdf, excel, etc. + + + + + + + + + header + + + en + Header + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Header + + + + + en + header + + + STRING + + + en + The header as a short description of the document with a maximum of 100 characters. + + + + + + + + + negativeEvents + + + en + Negative Events + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#negativeEvents + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Negative Events + + + + + en + negativeEvents + + + STRING + + + en + Mandatory if applicable. Negative events refers to several possible events influencing the battery's condition and lifetime such as extreme temperatures. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (4): +(d) information and data resulting from its use, including the number of charging and discharging cycles and negative events, such as accidents, as well as periodically recorded information on the operating environmental conditions, including temperature, and on the state of charge. +And Annex VII Part B: +4. the tracking of harmful events, such as the number of deep discharge events, time spent in extreme temperatures, time spent charging in extreme temperatures. + + + + + + + + + content + + + en + Content + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Content + + + + + en + content + + + STRING + + + en + The content of the document e.g a link. + + + + + + + + + contentType + + + en + Content Type + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Content Type + + + + + en + contentType + + + STRING + + + en + The type of content which can be expected in the "content" property. Examples are a link, restricted link, pdf, excel, etc. + + + + + + + + + header + + + en + Header + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Header + + + + + en + header + + + STRING + + + en + The header as a short description of the document with a maximum of 100 characters. + + + + + + + + + operatingEnvironment + + + en + Operating Environment + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#operatingEnvironment + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Operating Environment + + + + + en + operatingEnvironment + + + STRING + + + en + Mandatory if applicable. The operating environment refers to the conditions in which the battery is designed to function optimally. The environment includes factors such as temperature, humidity, pressure, and other external conditions that can impact the performance, safety, and lifespan of the battery. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (4): +(d) information and data resulting from its use, including the number of charging and discharging cycles and negative events, such as accidents, as well as periodically recorded information on the operating environmental conditions, including temperature, and on the state of charge. +And Annex VII Part B: +4. the tracking of harmful events, such as the number of deep discharge events, time spent in extreme temperatures, time spent charging in extreme temperatures. + + + + + + + + + dynamicPerformance + + + en + Dynamic Performance + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#dynamicPerformance + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Dynamic Performance + + + + + en + dynamicPerformance + + + STRING + + + en + Dynamic performance values of the battery. + + + + + + + + + performance + + + en + Performance + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#performance + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Performance + + + + + en + performance + + + STRING + + + en + Performance attributes of the battery including rated and dynamic values. + + + + + + + + + declarationOfConformityId + + + en + Declaration of Conformity Id + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#declarationOfConformityId + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Declaration of Conformity Id + + + + + en + declarationOfConformityId + + + STRING + + + en + Identification number of the EU declaration of conformity. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1): +(r) the EU declaration of conformity referred to in Article 18. + + + + + + + + + content + + + en + Content + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Content + + + + + en + content + + + STRING + + + en + The content of the document e.g a link. + + + + + + + + + contentType + + + en + Content Type + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Content Type + + + + + en + contentType + + + STRING + + + en + The type of content which can be expected in the "content" property. Examples are a link, restricted link, pdf, excel, etc. + + + + + + + + + header + + + en + Header + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Header + + + + + en + header + + + STRING + + + en + The header as a short description of the document with a maximum of 100 characters. + + + + + + + + + declarationOfConformity + + + en + Declaration of Conformity + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#declarationOfConformity + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Declaration of Conformity + + + + + en + declarationOfConformity + + + STRING + + + en + The EU Declaration of Conformity is a document in which the manufacturer or their authorized representative declares that the battery complies with all relevant European Union product safety directives and regulations. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1): +(r) the EU declaration of conformity referred to in Article 18. + + + + + + + + + content + + + en + Content + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Content + + + + + en + content + + + STRING + + + en + The content of the document e.g a link. + + + + + + + + + contentType + + + en + Content Type + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Content Type + + + + + en + contentType + + + STRING + + + en + The type of content which can be expected in the "content" property. Examples are a link, restricted link, pdf, excel, etc. + + + + + + + + + header + + + en + Header + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Header + + + + + en + header + + + STRING + + + en + The header as a short description of the document with a maximum of 100 characters. + + + + + + + + + resultOfTestReport + + + en + Result of Test Report + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#resultOfTestReport + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Result of Test Report + + + + + en + resultOfTestReport + + + STRING + + + en + The result of tests reports refers to the results of various tests conducted with the battery, testing its life cycle, life span, c-rate and various other aspects. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1): +(l) temperature range the battery can withstand when not in use (reference test); +and Annex XIII (3): +results of test reports proving compliance with the requirements laid down in this Regulation or any delegated or implementing act adopted pursuant to this Regulation. + + + + + + + + + content + + + en + Content + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Content + + + + + en + content + + + STRING + + + en + The content of the document e.g a link. + + + + + + + + + contentType + + + en + Content Type + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Content Type + + + + + en + contentType + + + STRING + + + en + The type of content which can be expected in the "content" property. Examples are a link, restricted link, pdf, excel, etc. + + + + + + + + + header + + + en + Header + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Header + + + + + en + header + + + STRING + + + en + The header as a short description of the document with a maximum of 100 characters. + + + + + + + + + thirdPartyAssurance + + + en + Third Party Assurance + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#thirdPartyAssurance + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Third Party Assurance + + + + + en + thirdPartyAssurance + + + STRING + + + en + A summary report from third-parties, covering the verifications. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1) (d) refers to the Article 52: +3. The economic operator referred to in Article 48(1) shall on an annual basis review and make publicly available, including on the internet, a report on its battery due diligence policy. [...], as well as a summary report of the third-party verifications carried out in accordance with Article 51, including the name of the notified body, with due regard for business confidentiality and other competitive concerns. That report shall also cover, where relevant, access to information, public participation in decision-making and access to justice in environmental matters in relation to the sourcing, processing and trading of the raw materials present in batteries. + + + + + + + + + content + + + en + Content + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Content + + + + + en + content + + + STRING + + + en + The content of the document e.g a link. + + + + + + + + + contentType + + + en + Content Type + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Content Type + + + + + en + contentType + + + STRING + + + en + The type of content which can be expected in the "content" property. Examples are a link, restricted link, pdf, excel, etc. + + + + + + + + + header + + + en + Header + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Header + + + + + en + header + + + STRING + + + en + The header as a short description of the document with a maximum of 100 characters. + + + + + + + + + dueDiligencePolicy + + + en + Due Diligence Policy + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#dueDiligencePolicy + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Due Diligence Policy + + + + + en + dueDiligencePolicy + + + STRING + + + en + A report containing the information concerning the due diligence policy, a set of procedures and guidelines the organization follows to thoroughly assess and evaluate the various aspects of the battery. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1) (d) refers to the Article 52: +3. The economic operator referred to in Article 48(1) shall on an annual basis review and make publicly available, including on the internet, a report on its battery due diligence policy. That report shall contain, in a manner that is easily comprehensible for end-users and clearly identifies the batteries concerned, the data and information on steps taken by that economic operator to comply with the requirements laid down in Articles 49 and 50, including findings of significant adverse impacts in the risk categories listed in point 2 of Annex X, and how they have been addressed, as well as a summary report of the third-party verifications carried out in accordance with Article 51, including the name of the notified body, with due regard for business confidentiality and other competitive concerns. That report shall also cover, where relevant, access to information, public participation in decision-making and access to justice in environmental matters in relation to the sourcing, processing and trading of the raw materials present in batteries. + + + + + + + + + conformity + + + en + Conformity + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#conformity + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Conformity + + + + + en + conformity + + + STRING + + + en + Conformity documents for the battery passport. + + + + + + + + + content + + + en + Content + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Content + + + + + en + content + + + STRING + + + en + The content of the document e.g a link. + + + + + + + + + contentType + + + en + Content Type + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Content Type + + + + + en + contentType + + + STRING + + + en + The type of content which can be expected in the "content" property. Examples are a link, restricted link, pdf, excel, etc. + + + + + + + + + header + + + en + Header + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Header + + + + + en + header + + + STRING + + + en + The header as a short description of the document with a maximum of 100 characters. + + + + + + + + + agentDocument + + + en + Agent Document + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#agentDocument + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Agent Document + + + + + en + agentDocument + + + STRING + + + en + Documentation about the extinguishing agent. + + + + + + + + + usableExtinguishingMedia + + + en + Usable Extinguishing Media + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#usableExtinguishingMedia + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Usable Extinguishing Media + + + + + en + usableExtinguishingMedia + + + STRING + + + en + The agent used to extinguish a fire, based on the fire class. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1)(a) and refers to Annex VI Part A: +9. usable extinguishing agent. + + + + + + + + + fireClass + + + en + Fire Class + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#fireClass + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Fire Class + + + + + en + fireClass + + + STRING + + + en + Safety classification based on the chemistry and construction of the battery. It determines the means of handling a fire caused by the battery. Possible values are A, B and C and a combination of these. + + + + + + + + + usableExtinguishAgent + + + en + Usable Extinguish Agent + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#usableExtinguishAgent + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Usable Extinguish Agent + + + + + en + usableExtinguishAgent + + + STRING + + + en + The usable extinguish agents for the battery in case of a fire. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1)(a) and refers to Annex VI Part A +9. usable extinguishing agent. + + + + + + + + + content + + + en + Content + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Content + + + + + en + content + + + STRING + + + en + The content of the document e.g a link. + + + + + + + + + contentType + + + en + Content Type + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Content Type + + + + + en + contentType + + + STRING + + + en + The type of content which can be expected in the "content" property. Examples are a link, restricted link, pdf, excel, etc. + + + + + + + + + header + + + en + Header + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Header + + + + + en + header + + + STRING + + + en + The header as a short description of the document with a maximum of 100 characters. + + + + + + + + + safetyMeasures + + + en + Safety Measures + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#safetyMeasures + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Safety Measures + + + + + en + safetyMeasures + + + STRING + + + en + Safety instruction in the form of a documentation. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (2): +(d) safety measures. + + + + + + + + + content + + + en + Content + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Content + + + + + en + content + + + STRING + + + en + The content of the document e.g a link. + + + + + + + + + contentType + + + en + Content Type + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Content Type + + + + + en + contentType + + + STRING + + + en + The type of content which can be expected in the "content" property. Examples are a link, restricted link, pdf, excel, etc. + + + + + + + + + header + + + en + Header + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Header + + + + + en + header + + + STRING + + + en + The header as a short description of the document with a maximum of 100 characters. + + + + + + + + + meaningOfLabels + + + en + Meaning of Labels + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#meaningOfLabels + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Meaning of Labels + + + + + en + meaningOfLabels + + + STRING + + + en + Documentation on the meaning of labels on a battery which provide information to help users understand the various symbols, markings, and information present on the battery's label. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1)(s) and refers to Article 74 (1): +(e) the meaning of the labels and symbols on batteries in accordance with Article 13 or printed on their packaging or in the documents accompanying batteries [...]. + + + + + + + + + content + + + en + Content + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Content + + + + + en + content + + + STRING + + + en + The content of the document e.g a link. + + + + + + + + + contentType + + + en + Content Type + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Content Type + + + + + en + contentType + + + STRING + + + en + The type of content which can be expected in the "content" property. Examples are a link, restricted link, pdf, excel, etc. + + + + + + + + + header + + + en + Header + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Header + + + + + en + header + + + STRING + + + en + The header as a short description of the document with a maximum of 100 characters. + + + + + + + + + safeDischarging + + + en + Safe Discharging + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#safeDischarging + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Safe Discharging + + + + + en + safeDischarging + + + STRING + + + en + Safe discharging documentation explaining for example the setting of a minimum voltage threshold for the battery. Discharging a battery below this threshold can lead to damage, reduced capacity, and safety hazards. + + + + + + + + + content + + + en + Content + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Content + + + + + en + content + + + STRING + + + en + The content of the document e.g a link. + + + + + + + + + contentType + + + en + Content Type + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Content Type + + + + + en + contentType + + + STRING + + + en + The type of content which can be expected in the "content" property. Examples are a link, restricted link, pdf, excel, etc. + + + + + + + + + header + + + en + Header + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Header + + + + + en + header + + + STRING + + + en + The header as a short description of the document with a maximum of 100 characters. + + + + + + + + + dismantling + + + en + Dismantling + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#dismantling + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Dismantling + + + + + en + dismantling + + + STRING + + + en + Dismantling refers to the proper way of dismantling the battery itself. It refers to the process of taking apart the battery for various purposes, such as recycling, disposal, or examination of its components. This attribute is mentioned in the Battery Regulation 2023/1542 from 12 July 2023 in Annex XIII (2) (c) dismantling information, including at least: +- exploded diagrams of the battery system/pack showing the location of battery cells, +- disassembly sequences, +- type and number of fastening techniques to be unlocked, +- tools required for disassembly, +- warnings if risk of damaging parts exist, +- amount of cells used and layout. + + + + + + + + + content + + + en + Content + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Content + + + + + en + content + + + STRING + + + en + The content of the document e.g a link. + + + + + + + + + contentType + + + en + Content Type + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Content Type + + + + + en + contentType + + + STRING + + + en + The type of content which can be expected in the "content" property. Examples are a link, restricted link, pdf, excel, etc. + + + + + + + + + header + + + en + Header + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Header + + + + + en + header + + + STRING + + + en + The header as a short description of the document with a maximum of 100 characters. + + + + + + + + + removalFromAppliance + + + en + Removal From Appliance + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#removalFromAppliance + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Removal From Appliance + + + + + en + removalFromAppliance + + + STRING + + + en + Removal refers to the proper process of disassembling a battery from an appliance, typically for purposes such as repairs, replacements, or disposal. + + + + + + + + + safety + + + en + Safety + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#safety + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Safety + + + + + en + safety + + + STRING + + + en + Safety information on the battery. Included are the attributes safety measurements, meaning of labels, safe discharging and dismantling. These are all documents. Additionally information about usable extinguish agent can be provided. + + + + + + + + + content + + + en + Content + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Content + + + + + en + content + + + STRING + + + en + The content of the document e.g a link. + + + + + + + + + category + + + en + Category + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#category + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Category + + + + + en + category + + + STRING + + + en + The category in which the document can be sorted. These are mentioned in the ESPR proposal from March 30th, 2022 ANNEX III: +(e) compliance documentation and information required under this Regulation or other Union law applicable to the product, such as the declaration of conformity, technical documentation or conformity certificates; +ANNEX IV states additional information regarding the content of the technical documentation +Further information on documents are mentioned in the proposal from March 30th, 2022 ANNEX III: +(f) user manuals, instructions, warnings or safety information, as required by other Union legislation applicable to the product. +Additionally requirements are mentioned in Article 21: +(7) Manufacturers shall ensure that that a product covered by a delegated act adopted pursuant to Article 4 is accompanied by instructions that enable consumers and other end-users to safely assemble, install, operate, store, maintain, repair and dispose of the product in a language that can be easily understood by consumers and other end-users, as determined by the Member State concerned. Such instructions shall be clear, understandable and legible and include at least the information specified in the delegated acts adopted pursuant to Article 4 and pursuant to Article 7(2)(b), point (ii). +Article 7 states additionally: +(2) (b) (ii) information for consumers and other end-users on how to install, use, maintain and repair the product in order to minimize its impact on the environment and to ensure optimum durability, as well as on how to return or dispose of the product at end-of-life; +(2) (b) (iii) information for treatment facilities on disassembly, recycling, or disposal at end-of-life; +(2) (b) (iv) other information that may influence the way the product is handled by parties other than the manufacturer in order to improve performance in relation to product parameters referred to in Annex I. +(5) (d) relevant instructions for the safe use of the product. + + + + + + Product Specifications + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#SourceCategoryEnumeration:Product Specifications + + + + + + Manufacturer Information + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#SourceCategoryEnumeration:Manufacturer Information + + + + + + User Manuals and Guides + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#SourceCategoryEnumeration:User Manuals and Guides + + + + + + Certifications and Compliance + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#SourceCategoryEnumeration:Certifications and Compliance + + + + + + Product Images and Videos + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#SourceCategoryEnumeration:Product Images and Videos + + + + + + Warranty Information + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#SourceCategoryEnumeration:Warranty Information + + + + + + Reviews and Ratings + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#SourceCategoryEnumeration:Reviews and Ratings + + + + + + Product Variations + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#SourceCategoryEnumeration:Product Variations + + + + + + Supply Chain Information + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#SourceCategoryEnumeration:Supply Chain Information + + + + + + Environmental Impact + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#SourceCategoryEnumeration:Environmental Impact + + + + + + Compatibility and Accessories + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#SourceCategoryEnumeration:Compatibility and Accessories + + + + + + FAQs and Support + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#SourceCategoryEnumeration:FAQs and Support + + + + + + Purchase and Retail Information + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#SourceCategoryEnumeration:Purchase and Retail Information + + + + + + Privacy and Data Handling + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#SourceCategoryEnumeration:Privacy and Data Handling + + + + + + Third-Party Integrations + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#SourceCategoryEnumeration:Third-Party Integrations + + + + + + Legal Information + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#SourceCategoryEnumeration:Legal Information + + + + + + Safety Information + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#SourceCategoryEnumeration:Safety Information + + + + + + Repair and Installation + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#SourceCategoryEnumeration:Repair and Installation + + + + + + Waste Generation and Prevention + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#SourceCategoryEnumeration:Waste Generation and Prevention + + + + + + Specific Voluntary Labels + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#SourceCategoryEnumeration:Specific Voluntary Labels + + + + + + Product Packaging + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#SourceCategoryEnumeration:Product Packaging + + + + + + Return and Disposal + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#SourceCategoryEnumeration:Return and Disposal + + + + + + End of Life + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#SourceCategoryEnumeration:End of Life + + + + + + Material and Substance Information + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#SourceCategoryEnumeration:Material and Substance Information + + + + + + Technical Documentation + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#SourceCategoryEnumeration:Technical Documentation + + + + + + Treatment facilities + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#SourceCategoryEnumeration:Treatment facilities + + + + + + Other + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#SourceCategoryEnumeration:Other + + + + + + + + + + + + + contentType + + + en + Content Type + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Content Type + + + + + en + contentType + + + STRING + + + en + The type of content which can be expected in the "content" property. Examples are a link, restricted link, pdf, excel, etc. + + + + + + + + + header + + + en + Header + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Header + + + + + en + header + + + STRING + + + en + The header as a short description of the document with a maximum of 100 characters. + + + + + + + + + sources + + + en + Sources + + + urn:samm:io.catenax.battery.battery_pass:6.0.0#sources + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Sources + + + + + en + sources + + + STRING + + + en + Consider additional available sources to enhance the content of the battery passport. + + + + + + + + + version + + + en + Version + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#version + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Version + + + + + en + version + + + STRING + + + en + The current version of the product passport. The possibility of modification/ updating the product passport needs to include versioning of the dataset. This attribute is an internal versioning from the passport issuer. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Article 8: +(1) [...] The information in the product passport shall be accurate, complete, and up to date. + + + + + + + + + status + + + en + Status + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#status + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Status + + + + + en + status + + + STRING + + + en + The current status of the product passport declared through either: draft, approved, invalid or expired. + + + + + + draft + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#StatusEnumeration:draft + + + + + + approved + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#StatusEnumeration:approved + + + + + + invalid + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#StatusEnumeration:invalid + + + + + + expired + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#StatusEnumeration:expired + + + + + + + + + + + + + expirationDate + + + en + Expiration Date + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#expirationDate + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Expiration Date + + + + + en + expirationDate + + + STRING + + + en + The timestamp in the format (yyyy-mm-dd) for the product passport until when it is available or a comment describing this period. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Article 8: +(2) (h) the period during which the product passport is to remain available, which shall correspond to at least the expected lifetime of a specific product. + + + + + + + + + issueDate + + + en + Issue Date + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#issueDate + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Issue Date + + + + + en + issueDate + + + STRING + + + en + The timestamp in the format (yyyy-mm-dd) since when the product passport is available. + + + + + + + + + economicOperatorId + + + en + Economic Operator Id + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#economicOperatorId + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Economic Operator Id + + + + + en + economicOperatorId + + + STRING + + + en + The identification of the owner/economic operator of the passport. Proposed, according to ISO 15459, is the CIN (company identification code). Other identification numbers like the tax identification number, value added tax identification number, commercial register number and the like are also valid entries. In the Catena-X network, the BPNL is used for the identification of companies and the information stored like contact information and addresses. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Annex III: +(k) the [...] unique operator identifier code of the economic operator established in the Union responsible for carrying out the tasks set out in Article 4 of Regulation (EU) 2019/1020, or Article 15 of Regulation (EU) on general product safety, or similar tasks pursuant to other EU legislation applicable to the product. + + + + + + + + + passportIdentifier + + + en + Passport Identifier + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#passportIdentifier + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Passport Identifier + + + + + en + passportIdentifier + + + STRING + + + en + The identifier of the product passport, which is an uuidv4. + + + + + + + + + predecessor + + + en + Predecessor + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#predecessor + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Predecessor + + + + + en + predecessor + + + STRING + + + en + Identification of the preceding product passport. If there is no preceding passport, input a dummy value. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Article 8: +(2)(g) [...] Any new product passport shall be linked to the product passport or passports of the original product whenever appropriate. + + + + + + + + + backupReference + + + en + Backup Reference + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#backupReference + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Backup Reference + + + + + en + backupReference + + + STRING + + + en + A reference to the data backup of the passport. This mandatory attribute will be further defined in the future. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex III: +(kb) the reference of the certified independent third-party product passport service provider hosting the back-up copy of the product passport. +Article 10 also mentions: +(c) the data included in the product passport shall be stored by the economic operator responsible for its creation or by certified independent third-party product passport service providers authorised to act on their behalf. + + + + + + + + + registrationIdentifier + + + en + Registration Identifier + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#registrationIdentifier + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Registration Identifier + + + + + en + registrationIdentifier + + + STRING + + + en + Identifier in the respective registry. This will be further defined in the future. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 in Article 12: +By [2 years from entering into force of this Regulation], the Commission shall set up and manage a digital registry ("the registry") storing in a secure manner at least the unique product identifier, the unique operator identifier, the unique facility identifiers. In case of products intended to be placed under the customs procedure 'release for free circulation', the registry shall also store the product commodity code. The registry shall also store the batteries' unique identifiers referred to in Article 77(3) of Regulation (EU) 2023/1542. + + + + + + + + + lastModification + + + en + Last Modification + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#lastModification + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Last Modification + + + + + en + lastModification + + + STRING + + + en + Date of the latest modification. + + + + + + + + + metadata + + + en + Metadata + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#metadata + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Metadata + + + + + en + metadata + + + STRING + + + en + Metadata of the product passport. These are mentioned in the ESPR proposal from March 30th, 2022 and some changed by the provisional agreement from January 9th, 2024. + + + + + + + + + placedOnMarket + + + en + Placed on Market + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#placedOnMarket + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Placed on Market + + + + + en + placedOnMarket + + + STRING + + + en + The timestamp in the format (yyyy-mm-dd) with or without time zone when the product was put in the market. + + + + + + + + + purpose + + + en + Purpose + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#purpose + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Purpose + + + + + en + purpose + + + STRING + + + en + One or more intended industry/industries of the product described by the digital product passport. If exchanged via Catena-X, 'automotive ' is a must choice included in the list. + + + + + + + + + commercial + + + en + Commercial + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#commercial + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Commercial + + + + + en + commercial + + + STRING + + + en + Commercial information of the product. + + + + + + + + + sourcesIdentification + + + en + Sources Identification + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#sourcesIdentification + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Sources Identification + + + + + en + sourcesIdentification + + + STRING + + + en + The identifier of a spare part producer of the product. In the Catena-X network, the BPNL is used for the identification of companies and the information stored for this like contact information and addresses. + + + + + + + + + sparePartSources + + + en + Spare Part Sources + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#sparePartSources + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Spare Part Sources + + + + + en + sparePartSources + + + STRING + + + en + Sources of possible spare parts. + + + + + + + + + manufacturerPartId + + + en + Manufacturer Part ID + + + urn:samm:io.catenax.part_type_information:1.0.0#manufacturerPartId + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Manufacturer Part ID + + + + + en + manufacturerPartId + + + STRING + + + en + Part ID as assigned by the manufacturer of the part. The part ID identifies the part in the manufacturer`s dataspace. The part ID references a specific version of a part. The version number must be included in the part ID if it is available. The part ID does not reference a specific instance of a part and must not be confused with the serial number. + + + + + + + + + nameAtManufacturer + + + en + Name at manufacturer + + + urn:samm:io.catenax.part_type_information:1.0.0#nameAtManufacturer + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Name at manufacturer + + + + + en + nameAtManufacturer + + + STRING + + + en + Name of the part as assigned by the manufacturer. + + + + + + + + + sparePart + + + en + Spare Part + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#sparePart + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Spare Part + + + + + en + sparePart + + + STRING + + + en + Possible spare parts of the product. + + + + + + + + + spareParts + + + en + spareParts + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#spareParts + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + spareParts + + + + + en + spareParts + + + STRING + + + en + The list of spare parts available for the product from various suppliers. + + + + + + + + + applicable + + + en + Applicable + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#applicable + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Applicable + + + + + en + applicable + + + BOOLEAN + + + en + Check whether the connected attributes are applicable to the product. If it is not applicable (false), dummy data can be delivered. + + + + + + + + + handling + + + en + handling + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#handling + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + handling + + + + + en + handling + + + STRING + + + en + Properties connected with the handling of the product. + + + + + + + + + diff --git a/io.catenax.battery.battery_pass/6.0.0/gen/BatteryPass-schema.json b/io.catenax.battery.battery_pass/6.0.0/gen/BatteryPass-schema.json new file mode 100644 index 000000000..097534535 --- /dev/null +++ b/io.catenax.battery.battery_pass/6.0.0/gen/BatteryPass-schema.json @@ -0,0 +1,1752 @@ +{ + "$schema" : "http://json-schema.org/draft-04/schema", + "description" : "The battery pass describes information collected during the lifecycle of a battery. The battery passport is heavily based on the Regulation (EU) 2023/1542 of the European Parliament and of the Council of 12 July 2023 concerning batteries and waste batteries, amending Directive 2008/98/EC and Regulation (EU) 2019/1020 and repealing Directive 2006/66/EC.\nAdditionally attributes come from the Proposal for Ecodesign for Sustainable Products Regulation.", + "type" : "object", + "components" : { + "schemas" : { + "urn_samm_io.catenax.battery.battery_pass_6.0.0_CategoryEnumeration" : { + "type" : "string", + "description" : "Enumeration with the values, portable battery; starting, lighting and ignition battery (SLI); light means of transport battery (LMT); electric vehicle battery (EV), industrial battery and incorporated battery.", + "enum" : [ "SLI", "LMT", "EV", "industrial", "portable", "incorporated" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_IdentifierCharacteristic" : { + "type" : "string", + "description" : "Characteristic for Identifiers." + }, + "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.serial_part_3.0.0_KeyTrait" : { + "type" : "string", + "description" : "Constraint that ensures that the standard keys and custom key prefixes can be used.", + "pattern" : "^(manufacturerId|partInstanceId|batchId|van|customKey:\\w+)$" + }, + "urn_samm_io.catenax.serial_part_3.0.0_ValueCharacteristic" : { + "type" : "string", + "description" : "The value of an identifier." + }, + "urn_samm_io.catenax.serial_part_3.0.0_KeyValueList" : { + "description" : "A list of key value pairs for local identifiers, which are composed of a key and a corresponding value.", + "type" : "object", + "properties" : { + "key" : { + "description" : "The key of a local identifier. ", + "$ref" : "#/components/schemas/urn_samm_io.catenax.serial_part_3.0.0_KeyTrait" + }, + "value" : { + "description" : "The value of an identifier.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.serial_part_3.0.0_ValueCharacteristic" + } + }, + "required" : [ "key", "value" ] + }, + "urn_samm_io.catenax.serial_part_3.0.0_LocalIdentifierCharacteristic" : { + "description" : "A single serialized part may have multiple attributes, that uniquely identify a that part in a specific dataspace (e.g. the manufacturer`s dataspace)", + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/urn_samm_io.catenax.serial_part_3.0.0_KeyValueList" + }, + "uniqueItems" : true + }, + "urn_samm_io.catenax.batch_3.0.0_KeyTrait" : { + "type" : "string", + "description" : "Constraint that ensures that the predefined keys are used.", + "pattern" : "^(manufacturerId|batchId|customKey:\\w+)$" + }, + "urn_samm_io.catenax.batch_3.0.0_ValueCharacteristic" : { + "type" : "string", + "description" : "The value of an identifier." + }, + "urn_samm_io.catenax.batch_3.0.0_KeyValueList" : { + "description" : "A list of key value pairs for local identifiers, which are composed of a key and a corresponding value.", + "type" : "object", + "properties" : { + "key" : { + "description" : "The key of a local identifier.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.batch_3.0.0_KeyTrait" + }, + "value" : { + "description" : "The value of an identifier.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.batch_3.0.0_ValueCharacteristic" + } + }, + "required" : [ "key", "value" ] + }, + "urn_samm_io.catenax.batch_3.0.0_LocalIdentifierCharacteristic" : { + "description" : "A batch may have multiple attributes, which uniquely identify that batch in a specific dataspace(e.g. the manufacturer`s dataspace)", + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/urn_samm_io.catenax.batch_3.0.0_KeyValueList" + }, + "uniqueItems" : true + }, + "urn_samm_io.catenax.part_type_information_1.0.0_PartIdCharacteristic" : { + "type" : "string", + "description" : "The part ID is a multi-character string, usually assigned by an ERP system." + }, + "urn_samm_io.catenax.part_type_information_1.0.0_PartNameCharacteristic" : { + "type" : "string", + "description" : "Part name in string format from the respective system in the value chain." + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PartTypeCharacteristic" : { + "description" : "Characteristic for the part type.", + "type" : "object", + "properties" : { + "manufacturerPartId" : { + "description" : "Part ID as assigned by the manufacturer of the part. The part ID identifies the part in the manufacturer`s dataspace. The part ID references a specific version of a part. The version number must be included in the part ID if it is available. The part ID does not reference a specific instance of a part and must not be confused with the serial number.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.part_type_information_1.0.0_PartIdCharacteristic" + }, + "nameAtManufacturer" : { + "description" : "Name of the part as assigned by the manufacturer.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.part_type_information_1.0.0_PartNameCharacteristic" + } + }, + "required" : [ "manufacturerPartId", "nameAtManufacturer" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_CodeEntity" : { + "description" : "Code entity with code key and value.", + "type" : "object", + "properties" : { + "key" : { + "description" : "The code key for the identification of the product. Examples are GTIN, hash, DID, ISBN, TARIC. This attribute is mentioned in the ESPR proposal from March 30th, 2022 ANNEX III:\n(b) the unique product identifier at the level indicated in the applicable delegated act adopted pursuant to Article 4;\n(c) the Global Trade Identification Number as provided for in standard ISO/IEC 15459-6 or equivalent of products or their parts;\n(d) relevant commodity codes, such as a TARIC code as defined in Council Regulation (EEC) No 2658/87.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_IdentifierCharacteristic" + }, + "value" : { + "description" : "The code value for the identification of the product in regard to the chosen code name.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_IdentifierCharacteristic" + } + }, + "required" : [ "key", "value" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_CodeList" : { + "description" : "A list of additional codes.", + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_CodeEntity" + } + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DataCarrierCharacteristic" : { + "description" : "Data Carrier Characteristic for the product.", + "type" : "object", + "properties" : { + "carrierType" : { + "description" : "The type of data carrier such as a QR code on the product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 8:\n(2) (b) the types of data carrier to be used.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "carrierLayout" : { + "description" : "The positioning of data carrier on the product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 8:\n(2) (c) the layout in which the data carrier shall be presented and its positioning.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + } + }, + "required" : [ "carrierType", "carrierLayout" ] + }, + "urn_samm_io.catenax.shared.part_classification_1.0.0_ClassificationStandardCharacteristic" : { + "type" : "string", + "description" : "Identified classification standards that align to the Catena-X needs." + }, + "urn_samm_io.catenax.shared.part_classification_1.0.0_ClassificationIDCharacteristic" : { + "type" : "string", + "description" : "It can be numeric or a string, depending on the chosen classification standard." + }, + "urn_samm_io.catenax.shared.part_classification_1.0.0_ClassificationEntity" : { + "description" : "Encapsulates data related to the classification of the part.", + "type" : "object", + "properties" : { + "classificationStandard" : { + "description" : "Identified classification standards that align to the Catena-X needs.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.part_classification_1.0.0_ClassificationStandardCharacteristic" + }, + "classificationID" : { + "description" : "The classification ID of the part type according to the corresponding standard definition mentioned in the key value pair.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.part_classification_1.0.0_ClassificationIDCharacteristic" + }, + "classificationDescription" : { + "description" : "Optional property describing the classification standard.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + } + }, + "required" : [ "classificationStandard", "classificationID" ] + }, + "urn_samm_io.catenax.shared.part_classification_1.0.0_ClassificationCharacteristic" : { + "description" : "Classification characteristic enabling a set of further properties.", + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.part_classification_1.0.0_ClassificationEntity" + }, + "uniqueItems" : true + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_IdentificationCharacteristic" : { + "description" : "Identification information of the product.", + "type" : "object", + "properties" : { + "serial" : { + "description" : "Identifier for a serial part if available. This is mentioned in the ESPR provisional agreement from January 9th, 2024 Recital (27):\n[...] an 'item' usually means a single unit of a model.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.serial_part_3.0.0_LocalIdentifierCharacteristic" + }, + "batch" : { + "description" : "Identifier for a batch part if available. Identifier for a serial part if available. This is mentioned in the ESPR provisional agreement from January 9th, 2024 Recital (27):\n[...] a 'batch' usually means a subset of a specific model composed of all products produced in a specific manufacturing plant at a specific moment in time [...].", + "$ref" : "#/components/schemas/urn_samm_io.catenax.batch_3.0.0_LocalIdentifierCharacteristic" + }, + "type" : { + "description" : "Identifier on the level of a part model or type. Identifier for a serial part if available. This is mentioned in the ESPR provisional agreement from January 9th, 2024 Recital (27):\n[...] A 'model' usually means a version of a product of which all units share the same technical characteristics relevant for the ecodesign requirements and the same model identifier [...].", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PartTypeCharacteristic" + }, + "codes" : { + "description" : "Codes for identification.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_CodeList" + }, + "dataCarrier" : { + "description" : "The type and layout of the data carrier on the product. These are mentioned in the ESPR proposal from March 30th, 2022 Article 8:\n(b) the types of data carrier to be used;\n(c) the layout in which the data carrier shall be presented and its positioning;\nArticle 2 defines:\n(30) 'data carrier' means a linear bar code symbol, a two-dimensional symbol or other automatic identification data capture medium that can be read by a device.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DataCarrierCharacteristic" + }, + "classification" : { + "description" : "Property describing the classification of a part.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.part_classification_1.0.0_ClassificationCharacteristic" + } + }, + "required" : [ "type", "codes", "dataCarrier", "classification" ] + }, + "urn_samm_io.catenax.battery.battery_pass_6.0.0_IdentificationCharacteristic" : { + "description" : "Battery identification involves specific battery identifiers, including those assigned locally by the manufacturer.", + "type" : "object", + "properties" : { + "category" : { + "description" : "The battery category, which can be a portable battery; starting, lighting and ignition battery (SLI); light means of transport battery (LMT); electric vehicle battery (EV), industrial battery and incorporated battery. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1) (a) and refers to ANNEX VI Part A:\n2. the battery category and information identifying the battery in accordance with Article 38(6).", + "$ref" : "#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_CategoryEnumeration" + }, + "idDmc" : { + "description" : "The unique identifier of the product, when it is placed on the market. Through this identifier a web link can be accessed. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Article 77:\n3. The battery passport shall be accessible through the QR code referred to in Article 13(6) which links to a unique identifier that the economic operator placing the battery on the market shall attribute to it. The QR code and the unique identifier shall comply with the ISO/IEC standards 15459-1:2014, 15459-2:2015, 15459-3:2014, 15459-4:2014, 15459-5:2014 and 15459-6:2014 or their equivalent.\nDefined is the QR code in Article 3:\n(24) \"QR code\" means a machine-readable matrix code that links to information as required by this Regulation.\n(66) \"unique identifier\" means a unique string of characters for the identification of batteries that also enables a web link to the battery passport.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_IdentifierCharacteristic" + }, + "chemistry" : { + "description" : "Battery chemistry refers to the specific chemical composition and reactions that occur within a battery to produce and store electrical energy. The chemistry has to be stated as detailed as possible for example: the Nickel Cobalt Manganese battery 'NCM'. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1) (a) and refers to ANNEX VI Part A:\n7. the chemestry.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "identification" : { + "description" : "Identification information of the product, especially identifiers and codes. These are mentioned in the ESPR provisional agreement from January 9th, 2024 ANNEX III:\n(b) the unique product identifier at the level indicated in the applicable delegated act adopted pursuant to Article 4.\nAdditionally in Article 9 regarding general requirements for the product passport is stated that:\nA product passport shall meet the following conditions:\n(a) it shall be connected through a data carrier to a persistent unique product identifier;\n(e) the information included in the product passport shall refer to the product model, batch, or item as specified in the delegated act adopted pursuant to Article 4.\nArticle 2 Definitions: \n(31) 'unique product identifier' means a unique string of characters for the identification of products that also enables a web link to the product passport;\nRecital (27): A 'model' usually means a version of a product of which all units share the same technical characteristics relevant for the ecodesign requirements and the same model identifier, a 'batch' usually means a subset of a specific model composed of all products produced in a specific manufacturing plant at a specific moment in time and an 'item' usually means a single unit of a model.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_IdentificationCharacteristic" + } + }, + "required" : [ "category", "idDmc", "chemistry", "identification" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DateTrait" : { + "type" : "string", + "description" : "Constraint fo a timestamp in the format (yyyy-mm-dd).", + "pattern" : "^\\d{4}-\\d{2}-\\d{2}$" + }, + "urn_samm_io.catenax.shared.business_partner_number_2.0.0_BpnaTrait" : { + "type" : "string", + "description" : "The provided regular expression ensures that the BPNA is composed of prefix 'BPNA', 10 digits and two alphanumeric letters.", + "pattern" : "^BPNA[a-zA-Z0-9]{12}$" + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_FacilityEntity" : { + "description" : "The entity for a facility with the BPNA identifier.", + "type" : "object", + "properties" : { + "facility" : { + "description" : "The identifier used for a location. This attribute is mentioned in the ESPR provisional agreement from January 9th 2024 Annex III:\n(i) unique facility identifiers;\nArticle 2 Definitions: (33) 'unique facility identifier' means a unique string of characters for the identification of locations or buildings involved in the value chain of a product or used by actors involved in the value chain of a product.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.business_partner_number_2.0.0_BpnaTrait" + } + }, + "required" : [ "facility" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_FacilityList" : { + "description" : "List of facilities.", + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_FacilityEntity" + } + }, + "urn_samm_io.catenax.shared.business_partner_number_2.0.0_BpnlTrait" : { + "type" : "string", + "description" : "The provided regular expression ensures that the BPNL is composed of prefix 'BPNL', 10 digits and two alphanumeric letters.", + "pattern" : "^BPNL[a-zA-Z0-9]{12}$" + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_ManufacturerCharacteristic" : { + "description" : "Manufacturing information.", + "type" : "object", + "properties" : { + "facility" : { + "description" : "The identifier used for a location. In the CATENA-X use case, the BPNA can be stated. This attribute is mentioned in the ESPR provisional agreement from January 9th 2024 Annex III:\n(i) unique facility identifiers;\nArticle 2 Definitions: (33) 'unique facility identifier' means a unique string of characters for the identification of locations or buildings involved in the value chain of a product or used by actors involved in the value chain of a product.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_FacilityList" + }, + "manufacturer" : { + "description" : "The main manufacturer, if different from the passport owner, represented by an identification number. In the Catena-X use case, the BPNL can be stated. This attribute is mentioned in the ESPR provisional agreement from January 9th 2024 Annex III:\n(h) unique operator identifiers other than that of the manufacturer;\n(k) the name, contact details and unique operator identifier code of the economic operator established in the Union responsible for carrying out the tasks set out in Article 4 of Regulation (EU) 2019/1020, or Article 15 of Regulation (EU) [.../...] on general product safety, or similar tasks pursuant to other EU legislation applicable to the product.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.business_partner_number_2.0.0_BpnlTrait" + }, + "manufacturingDate" : { + "description" : "The timestamp in the format (yyyy-mm-dd) of the manufacturing date as the final step in production process (e.g. final quality check, ready-for-shipment event).", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DateTrait" + } + }, + "required" : [ "facility", "manufacturer" ] + }, + "urn_samm_io.catenax.battery.battery_pass_6.0.0_OperationCharacteristic" : { + "description" : "Characteristic includes details for operational data.", + "type" : "object", + "properties" : { + "intoServiceDate" : { + "description" : "Putting into service is the transition from a state of readiness to actual use or operation. The date should be formatted as yyyy-mm-dd. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex VII Part B: \n1.the date of manufacture of the battery and, where appropriate, the date of putting into service;\nDefined is \"putting into service\" in Article 3:\n(18) \"putting into service\" means the first use, for its intended purpose, in the Union, of a battery, without having been previously placed on the market.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DateTrait" + }, + "manufacturer" : { + "description" : "Manufacturing information of the product. In the CATENA-X use case, the BPNL and BPNA can be stated. These attributes are mentioned in the ESPR provisional agreement from January 9th 2024 Annex III:\n(h) unique operator identifiers other than that of the manufacturer;\n(k) the name, contact details and unique operator identifier code of the economic operator established in the Union responsible for carrying out the tasks set out in Article 4 of Regulation (EU) 2019/1020, or Article 15 of Regulation (EU) [.../...] on general product safety, or similar tasks pursuant to other EU legislation applicable to the product.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_ManufacturerCharacteristic" + } + }, + "required" : [ "manufacturer" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_LifeValueCharacteristic" : { + "type" : "number", + "description" : "Characteristic for the life span value as an integer." + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_LifeEnumeration" : { + "type" : "string", + "description" : "Enumeration with the possible units day, month, cycle, year and runningOrOperatingHour.", + "enum" : [ "unit:day", "unit:month", "unit:year", "unit:cycle", "unit:runningOrOperatingHour" ] + }, + "urn_samm_io.catenax.battery.battery_pass_6.0.0_WarrantyCharacteristic" : { + "description" : "Characteristic for the warranty.", + "type" : "object", + "properties" : { + "lifeValue" : { + "description" : "The value as an integer for the respective lifespan.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_LifeValueCharacteristic" + }, + "lifeUnit" : { + "description" : "The unit of the respective lifespan expressed through the possible units day, month, cycle, year and runningOrOperatingHour.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_LifeEnumeration" + } + }, + "required" : [ "lifeValue", "lifeUnit" ] + }, + "urn_samm_io.catenax.shared.quantity_2.0.0_QuantityValueCharacteristic" : { + "type" : "number", + "description" : "The quantity value associated with the unit expressed as float." + }, + "urn_samm_io.catenax.shared.quantity_2.0.0_LinearUnitEnumeration" : { + "type" : "string", + "pattern" : "[a-zA-Z]*:[a-zA-Z]+", + "description" : "The unit of a linear attribute that may be used for height, width, length and diameter.", + "enum" : [ "unit:millimetre", "unit:centimetre", "unit:metre", "unit:kilometre", "unit:inch", "unit:foot", "unit:yard" ] + }, + "urn_samm_io.catenax.shared.quantity_2.0.0_LinearCharacteristic" : { + "description" : "Characteristic for linear measurements of an item.", + "type" : "object", + "properties" : { + "value" : { + "description" : "The quantity value associated with the unit.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.quantity_2.0.0_QuantityValueCharacteristic" + }, + "unit" : { + "description" : "The unit of a linear attribute.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.quantity_2.0.0_LinearUnitEnumeration" + } + }, + "required" : [ "value", "unit" ] + }, + "urn_samm_io.catenax.shared.quantity_2.0.0_MassUnitEnumeration" : { + "type" : "string", + "pattern" : "[a-zA-Z]*:[a-zA-Z]+", + "description" : "Enumeration for mass units.", + "enum" : [ "unit:gram", "unit:kilogram", "unit:tonneMetricTon", "unit:tonUsOrShortTonUkorus", "unit:ounceAvoirdupois", "unit:pound" ] + }, + "urn_samm_io.catenax.shared.quantity_2.0.0_MassCharacteristic" : { + "description" : "Characteristic for mass measurements of an item.", + "type" : "object", + "properties" : { + "value" : { + "description" : "The quantity value associated with the unit.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.quantity_2.0.0_QuantityValueCharacteristic" + }, + "unit" : { + "description" : "The unit of a mass related attribute.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.quantity_2.0.0_MassUnitEnumeration" + } + }, + "required" : [ "value", "unit" ] + }, + "urn_samm_io.catenax.battery.battery_pass_6.0.0_PhysicalDimensionCharacteristic" : { + "description" : "Characteristic for the physical dimensions.", + "type" : "object", + "properties" : { + "height" : { + "description" : "The height of the item measured in a specific linear unit which can be declared in the corresponding unit attribute.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.quantity_2.0.0_LinearCharacteristic" + }, + "length" : { + "description" : "The length of the item measured in a specific linear unit which can be declared in the corresponding unit attribute.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.quantity_2.0.0_LinearCharacteristic" + }, + "width" : { + "description" : "The width of the item measured in a specific linear unit which can be declared in the corresponding unit attribute.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.quantity_2.0.0_LinearCharacteristic" + }, + "weight" : { + "description" : "Weight of the product measured in a specific mass unit which can be declared in the corresponding unit attribute. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7:\n(2) (b) (i) information on the performance of the product in relation to the product parameters referred to in Annex I;\nAnnex I (i) weight and volume of the product [...].", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.quantity_2.0.0_MassCharacteristic" + } + }, + "required" : [ "weight" ] + }, + "urn_samm_io.catenax.battery.battery_pass_6.0.0_CharacteristicsElement" : { + "description" : "Characteristic for the product characteristics.", + "type" : "object", + "properties" : { + "warranty" : { + "description" : "The warranty of the battery. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in ANNEX XIII:\n(m) period for which the commercial warranty for the calendar life applies.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_WarrantyCharacteristic" + }, + "physicalDimension" : { + "description" : "The weight of the battery. For calculation of the energy density, the volume is also needed. The energy density of a battery is measured in watt-hours per kilogram (Wh/kg) and watt-hours per liter (Wh/L). These measures indicate how much energy a battery can store relative to its weight and volume, respectively. Other measurements are optional.These are mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1)(a) and refers to Annex VI Part A:\n5. the weight.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_PhysicalDimensionCharacteristic" + } + }, + "required" : [ "warranty", "physicalDimension" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_HeaderTrait" : { + "type" : "string", + "description" : "Constraint for a maximum of 100 characters.", + "maxLength" : 100 + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentationEntity" : { + "description" : "Entity for a document with a header, type and content.", + "type" : "object", + "properties" : { + "content" : { + "description" : "The content of the document e.g a link.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "contentType" : { + "description" : "The type of content which can be expected in the \"content\" property. Examples are a link, restricted link, pdf, excel, etc.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "header" : { + "description" : "The header as a short description of the document with a maximum of 100 characters.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_HeaderTrait" + } + }, + "required" : [ "content", "contentType", "header" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentList" : { + "description" : "List of documents.", + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentationEntity" + } + }, + "urn_samm_io.catenax.battery.battery_pass_6.0.0_SustainabilityDocumentCharacteristic" : { + "description" : "Characteristic for sustainability documents of the battery.", + "type" : "object", + "properties" : { + "separateCollection" : { + "description" : "Documentation about separate collection of batteries involve information on how to properly collect, handle, and recycle batteries to ensure environmental sustainability and compliance with regulations. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1) (s), refers to Article 74:\n1. In addition to the information referred to in Article 8a(2) of Directive 2008/98/EC, producers or, where appointed in accordance with Article 57(1), producer responsibility organisations shall make available to end-users and distributors the following information regarding the prevention and management of waste batteries with regard to the categories of batteries that they supply within the territory of a Member State:\n(a) the role of end-users in contributing to waste prevention, including by information on good practices and recommendations concerning the use of batteries aimed at extending their use phase and the possibilities of re-use, preparation for re-use, preparation for repurposing, repurposing and remanufacturing;\n(b) the role of end-users in contributing to the separate collection of waste batteries in accordance with their obligations under Article 64 to allow their treatment;\n(c) the separate collection, take-back and collection points, preparation for re-use, preparation for repurposing and treatment available for waste batteries;\n(d) the necessary safety instructions to handle waste batteries, including in relation to the risks associated with, and the handling of, batteries containing lithium;\n(e) the meaning of the labels and symbols on batteries in accordance with Article 13 or printed on their packaging or in the documents accompanying batteries; and\n(f) the impact of substances, in particular hazardous substances, present in batteries on the environment and on human health or the safety of persons, including the impact due to inappropriate discarding of waste batteries, such as littering or discarding as unsorted municipal waste.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentList" + }, + "wastePrevention" : { + "description" : "Documentation about waste prevention for batteries which include guidelines, recommendations, and information on minimizing the environmental impact associated with the use and disposal of batteries. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1) (s), refers to Article 74 (1) which call Article 8a of Directive 2008/98/EC:\n2. Member States shall take the necessary measures to ensure that the waste holders targeted by the extended producer responsibility schemes established in accordance with Article 8 (1), are informed about waste prevention measures, centres for re-use and preparing for re-use, take-back and collection systems, and the prevention of littering. Member States shall also take measures to create incentives for the waste holders to assume their responsibility to deliver their waste into the separate collection systems in place, notably, where appropriate, through economic incentives or regulations.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentList" + }, + "euTaxonomyDisclosureStatement" : { + "description" : "Optional disclosure regarding the EU taxonomy, with the choice to voluntarily provide the EU Taxonomy disclosure through the battery passport.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentList" + }, + "sustainabilityReport" : { + "description" : "Voluntarily making the Sustainability Report available via the battery passport. A report containing the information concerning the sustainability in form of a document.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentList" + } + }, + "required" : [ "separateCollection", "wastePrevention" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PositiveTrait" : { + "type" : "number", + "description" : "Constraint for only positive values.", + "minimum" : 0.0, + "exclusiveMinimum" : false + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_CategoryEnumeration" : { + "type" : "string", + "description" : "Enumeration of the 19 impact categories in accordance to EN15804+A2.", + "enum" : [ "Climate Change Total", "Climate Change Fossil", "Climate Change Biogenic Removals and Emissions", "Climate Change Land Use and Land Use Change", "Ozone Depletion", "Acidification", "Eutrophication Aquatic Freshwater", "Eutrophication Fresh Marine", "Eutrophication Terrestrial", "Photochemical Ozone Formation", "Abiotic Depletion- Minerals and Metals", "Fossil Fuels", "Water Use", "Particulate Matter Emissions", "Ionizing Radiation, Human Health", "Eco-Toxicity", "Human Toxicity, Cancer Effects", "Human Toxicity, Non-Cancer Effects", "Land Use Related Impacts/Soil Quality" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_FootprintEntity" : { + "description" : "Footprint Entity for the carbon and environmental footprint with the total value, unit, impact category type, lifecycle, rulebook, declaration, performance class and the facility.", + "type" : "object", + "properties" : { + "value" : { + "description" : "The value of the footprint of the product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Annex I:\n(l) the environmental footprint of the product, expressed as a quantification, in accordance with the applicable delegated act, of a product's life cycle environmental impacts, whether in relation to one or more environmental impact categories or an aggregated set of impact categories;\n(m) the carbon footprint of the product;\n(ma) the material footprint of the product.\n", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PositiveTrait" + }, + "rulebook" : { + "description" : "The applied rulebook for the environmental footprint of the product.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentList" + }, + "lifecycle" : { + "description" : "The lifecycle stage, to which the environmental footprint corresponds. These could be for example \"raw material acquisition and pre-processing\", \"main product production\", \"distribution\" or \"end of life and recycling\".", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "unit" : { + "description" : "The unit of measurement of the environmental impact category. For each impact category a specific unit is used. If an aggregation is used, utilize the normalization and weighting methods used in the referenced rulebook.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "type" : { + "description" : "The type of the environmental footprint of the product. This could be one of the environmental impact categories. This attribute is mentioned in the ESPR provisional agreement from January 9th 2024 Article 7:\n(2)(b)(i) information on the performance of the product in relation to one or more of the product parameters referred to in Annex I, including a scoring of reparability or durability, carbon footprint or environmental footprint;\nAnnex I:\n(l) the environmental footprint of the product, expressed as a quantification, in accordance with the applicable delegated act, of a product's life cycle environmental impacts, whether in relation to one or more environmental impact categories or an aggregated set of impact categories.\n(m) the carbon footprint of the product;\n(ma) the material footprint of the product.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_CategoryEnumeration" + }, + "performanceClass" : { + "description" : "The performance classification of the footprint.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "manufacturingPlant" : { + "description" : "The manufacturing plant of the footprint in the specific lifecycle phase.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_FacilityList" + }, + "declaration" : { + "description" : "The footprint declaration in the format of a link ", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentList" + } + }, + "required" : [ "value", "rulebook", "lifecycle", "unit", "type", "manufacturingPlant", "declaration" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_FootprintList" : { + "description" : "Footprint List for the environmental footprint.", + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_FootprintEntity" + } + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_StateEnumeration" : { + "type" : "string", + "description" : "Enumeration defined as original, repurposed, re-used, remanufactured or waste.", + "enum" : [ "original", "repurposed", "re-used", "remanufactured", "waste" ] + }, + "urn_samm_io.catenax.battery.battery_pass_6.0.0_SustainabilityCharacteristic" : { + "description" : "Characteristic for sustainability attributes.", + "type" : "object", + "properties" : { + "documents" : { + "description" : "Sustainability documents of the battery.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_SustainabilityDocumentCharacteristic" + }, + "carbonFootprint" : { + "description" : "The carbon footprint of the battery calculated as kg of carbon dioxide equivalent per one kWh of the total energy provided by the battery over its expected service life. Relevant attributes are the value, the unit, the referenced rulebook, the lifecycle where applied, the declaration, the performance class, the type (PCF), the declaration and the facility. These attributes are mentioned in the Battery regulation 2023/1542 from 12 July 2023 in several places.\nAnnex XIII (1) (c) refers to Article 7 (2) which refers to Article 7 (1)(d):\n1. For electric vehicle batteries, rechargeable industrial batteries with a capacity greater than 2 kWh and LMT batteries a carbon footprint declaration shall be drawn up for each battery model per manufacturing plant, in accordance with the implementing act referred to in the fourth subparagraph and containing, at least, the following information:\n[...] (d) the carbon footprint of the battery, calculated as kg of carbon dioxide equivalent per one kWh of the total energy provided by the battery over its expected service life;\nAnd as well in Article 7:\n2. Electric vehicle batteries, rechargeable industrial batteries with a capacity greater than 2 kWh and LMT batteries shall bear a conspicuous, clearly legible and indelible label indicating the carbon footprint of the battery referred to in paragraph 1, first subparagraph, point (d) and declaring the carbon footprint performance class to which the relevant battery model per manufacturing plant corresponds.\nFurther specified in Annex XIII (1) (c) and refers to Article 7 (1):\n[...] The Commission shall, by 18 February 2024 for electric vehicle batteries, 18 February 2025 for rechargeable industrial batteries, except those with external storage, 18 February 2027 for LMT batteries and 18 February 2029 for industrial batteries with external storage, adopt:\n(a) a delegated act in accordance with Article 89 to supplement this Regulation by establishing the methodology for the calculation and verification of the carbon footprint of the battery referred to in the first subparagraph, point (d), in accordance with the essential elements set out in Annex II;\nThese parameters are defined by Article 3:\n(21) \"carbon footprint\" means the sum of greenhouse gas emissions and greenhouse gas removals in a product system, expressed as carbon dioxide equivalents and based on a Product Environmental Footprint (PEF) study using the single impact category of climate change;\nand defined by Annex II (2):\n(e) \"life cycle\" means the consecutive and interlinked stages of a product system, from raw material acquisition or generation from natural resources to final disposal (ISO 14040:2006 or an equivalent standard).", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_FootprintList" + }, + "status" : { + "description" : "The status of the product (original, repurposed, re-used, remanufactured or waste) to indicated, whether it is a used product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Annex I:\n(j) incorporation of used components.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_StateEnumeration" + } + }, + "required" : [ "documents", "carbonFootprint", "status" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PercentageTrait" : { + "type" : "number", + "description" : "Range constraint for a positive percentage value.", + "maximum" : 100.0, + "exclusiveMaximum" : false, + "minimum" : 0.0, + "exclusiveMinimum" : false + }, + "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.battery.battery_pass_6.0.0_MaterialActive" : { + "description" : "Characteristic to describe the active material.", + "type" : "object", + "properties" : { + "location" : { + "description" : "The location of the substances of concern within the product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7:\n(5) (b) the location of the substances of concern within the product.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "recycled" : { + "description" : "The share of the material, which is recovered recycled content from the product. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I:\n(h) use or content of recycled materials and recovery of materials, including critical raw materials;", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PercentageTrait" + }, + "documentation" : { + "description" : "Documentation accompanying the material.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentList" + }, + "critical" : { + "description" : "A flag, if the material is a critical raw material. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I:\n(h) use or content of recycled materials and recovery of materials, including critical raw materials;\nIn Annex II of the connected proposal Act of Critical Raw Materials, a list of critical raw materials can be found.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Boolean" + } + }, + "required" : [ "location", "recycled", "documentation", "critical" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_ConcentrationEnumeration" : { + "type" : "string", + "description" : "Enumeration of possible units of concentration with percent, volume percent, parts per thousand, parts per million, parts per billion and parts per trillion.", + "enum" : [ "unit:partPerMillion", "unit:percent", "unit:percentVolume", "unit:partPerThousand", "unit:partPerTrillionUs", "unit:partPerBillionUs" ] + }, + "urn_samm_io.catenax.battery.battery_pass_6.0.0_LeadCharacteristic" : { + "description" : "Characteristic for specific hazardous/active lead information.", + "type" : "object", + "properties" : { + "impactOfSubstances" : { + "description" : "An accumulation of documents that refer to the impact, especially hazardous substances, on the battery. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1) (s), refers to Article 74:\n1. In addition to the information referred to in Article 8a(2) of Directive 2008/98/EC, producers or, where appointed in accordance with Article 57(1), producer responsibility organisations shall make available to end-users and distributors the following information regarding the prevention and management of waste batteries with regard to the categories of batteries that they supply within the territory of a Member State:\n[...]\n(f) the impact of substances, in particular hazardous substances, present in batteries on the environment and on human health or the safety of persons, including the impact due to inappropriate discarding of waste batteries, such as littering or discarding as unsorted municipal waste.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentList" + }, + "critical" : { + "description" : "A flag, if the material is a critical raw material. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I:\n(h) use or content of recycled materials and recovery of materials, including critical raw materials;\nIn Annex II of the connected proposal Act of Critical Raw Materials, a list of critical raw materials can be found.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Boolean" + }, + "documentation" : { + "description" : "Documentation accompanying the material.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentList" + }, + "recycled" : { + "description" : "The share of the material, which is recovered recycled content from the product. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I:\n(h) use or content of recycled materials and recovery of materials, including critical raw materials;", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PercentageTrait" + }, + "location" : { + "description" : "The location of the substances of concern within the product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7:\n(5) (b) the location of the substances of concern within the product.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "concentration" : { + "description" : "Concentration of the material at the level of the product. This attribute is specially mentioned for substances of concern mentioned in the ESPR proposal from March 30th, 2022 Article 7:\n(5) (c) the concentration, maximum concentration or concentration range of the substances of concern, at the level of the product [...].\nOther substances are mentioned for the purpose of recycling in the ESPR provisional agreement from January 9th, 2024 Annex I:\n(d) design for recycling, ease and quality of recycling as expressed through: use of easily recyclable materials, safe, easy and non-destructive access to recyclable components and materials or components and materials containing hazardous substances and material composition and homogeneity, possibility for high-purity sorting, number of materials and components used, use of standard components, use of component and material coding standards for the identification of components and materials, number and complexity of processes and tools needed, ease of nondestructive disassembly and re-assembly, conditions for access to product data, conditions for access to or use of hardware and software needed.\n", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PositiveTrait" + }, + "materialUnit" : { + "description" : "The unit of concentration chosen from an enumeration: mass percent, volume percent, parts per thousand, parts per million, parts per billion and parts per trillion.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_ConcentrationEnumeration" + } + }, + "required" : [ "impactOfSubstances", "critical", "documentation", "recycled", "location", "concentration", "materialUnit" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_ListTypeEnumerationId" : { + "type" : "string", + "description" : "Enumeration of different systems and organizations related to the identification and classification of chemical substances in the field of chemistry. The enumeration values are EC or CAS.", + "enum" : [ "CAS", "EC", "IUPAC" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_MaterialIdEntity" : { + "description" : "Id Entity with identifier, name and list type.", + "type" : "object", + "properties" : { + "id" : { + "description" : "The substance identification, in accordance with the specification in the attribute for the list type.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_IdentifierCharacteristic" + }, + "type" : { + "description" : "The type of standard used for the identification of the substances. Selected can be for example CAS, IUPAC or EC.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_ListTypeEnumerationId" + }, + "name" : { + "description" : "The name of the material which is present in the product.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + } + }, + "required" : [ "id", "type", "name" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_MaterialIdList" : { + "description" : "List of ids for the identification.", + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_MaterialIdEntity" + } + }, + "urn_samm_io.catenax.battery.battery_pass_6.0.0_OtherActiveMaterialsEntity" : { + "description" : "Entity for other active materials.", + "type" : "object", + "properties" : { + "location" : { + "description" : "The location of the substances of concern within the product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7:\n(5) (b) the location of the substances of concern within the product.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "recycled" : { + "description" : "The share of the material, which is recovered recycled content from the product. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I:\n(h) use or content of recycled materials and recovery of materials, including critical raw materials;", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PercentageTrait" + }, + "documentation" : { + "description" : "Documentation accompanying the material.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentList" + }, + "critical" : { + "description" : "A flag, if the material is a critical raw material. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I:\n(h) use or content of recycled materials and recovery of materials, including critical raw materials;\nIn Annex II of the connected proposal Act of Critical Raw Materials, a list of critical raw materials can be found.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Boolean" + }, + "materialIdentification" : { + "description" : "The chemical material name and identification, in accordance with the specification in the attribute for the list type. Preference is given to the IUPAC name. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Article 7:\n(5) (a) the name of the substances of concern present in the product, as follows:\n - name(s) in the International Union of Pure and Applied Chemistry (IUPAC) nomenclature, or another international name when IUPAC name is not available; \n- other names (usual name, trade name, abbreviation);\n- European Community (EC) number, as indicated in the European Inventory of Existing Commercial Chemical Substances (EINECS), the European List of Notified Chemical Substances (ELINCS) or the No Longer Polymer (NLP) list or assigned by the European Chemicals Agency (ECHA), if available;\n- the Chemical Abstract Service (CAS) name(s) and number(s), if available; .", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_MaterialIdList" + } + }, + "required" : [ "location", "recycled", "documentation", "critical", "materialIdentification" ] + }, + "urn_samm_io.catenax.battery.battery_pass_6.0.0_OtherActiveMaterialsList" : { + "description" : "List of other active materials.", + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_OtherActiveMaterialsEntity" + } + }, + "urn_samm_io.catenax.battery.battery_pass_6.0.0_ActiveMaterialsCharacteristic" : { + "description" : "Characteristic for the active materials.", + "type" : "object", + "properties" : { + "nickel" : { + "description" : "Information about the percentage of recovered nickel from waste. These attribute are mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1)(e) refers to Article 8:\n1. From 18 August 2028 or 24 months after the date of entry into force of the delegated act referred to in the third subparagraph, whichever is the latest, industrial batteries with a capacity greater than 2 kWh, except those with exclusively external storage, electric vehicle batteries and SLI batteries that contain cobalt, lead, lithium or nickel in active materials, shall be accompanied by documentation containing information about the percentage share of cobalt, lithium or nickel that is present in active materials and that has been recovered from battery manufacturing waste or post-consumer waste, and the percentage share of lead that is present in the battery and that has been recovered from waste, for each battery model per year and per manufacturing plant.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_MaterialActive" + }, + "lithium" : { + "description" : "Information about the percentage of recovered lithium from waste. These attribute are mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1)(e) refers to Article 8:\n1. From 18 August 2028 or 24 months after the date of entry into force of the delegated act referred to in the third subparagraph, whichever is the latest, industrial batteries with a capacity greater than 2 kWh, except those with exclusively external storage, electric vehicle batteries and SLI batteries that contain cobalt, lead, lithium or nickel in active materials, shall be accompanied by documentation containing information about the percentage share of cobalt, lithium or nickel that is present in active materials and that has been recovered from battery manufacturing waste or post-consumer waste, and the percentage share of lead that is present in the battery and that has been recovered from waste, for each battery model per year and per manufacturing plant.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_MaterialActive" + }, + "cobalt" : { + "description" : "Information about the percentage of recovered cobalt from waste. These attribute are mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1)(e) refers to Article 8:\n1. From 18 August 2028 or 24 months after the date of entry into force of the delegated act referred to in the third subparagraph, whichever is the latest, industrial batteries with a capacity greater than 2 kWh, except those with exclusively external storage, electric vehicle batteries and SLI batteries that contain cobalt, lead, lithium or nickel in active materials, shall be accompanied by documentation containing information about the percentage share of cobalt, lithium or nickel that is present in active materials and that has been recovered from battery manufacturing waste or post-consumer waste, and the percentage share of lead that is present in the battery and that has been recovered from waste, for each battery model per year and per manufacturing plant.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_MaterialActive" + }, + "lead" : { + "description" : "Information about the lead in the battery. As this is an active and hazardous material, all properties for hazardous as well as active materials are required. These attribute are mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1)(e) refers to Article 8:\n1. From 18 August 2028 or 24 months after the date of entry into force of the delegated act referred to in the third subparagraph, whichever is the latest, industrial batteries with a capacity greater than 2 kWh, except those with exclusively external storage, electric vehicle batteries and SLI batteries that contain cobalt, lead, lithium or nickel in active materials, shall be accompanied by documentation containing information about the percentage share of cobalt, lithium or nickel that is present in active materials and that has been recovered from battery manufacturing waste or post-consumer waste, and the percentage share of lead that is present in the battery and that has been recovered from waste, for each battery model per year and per manufacturing plant.\nAnd for hazardous materials this is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1) (a) refers to Annex VI Part A: \n8. the hazardous substances present in the battery, other than mercury, cadmium or lead;\nAdditionally in Article 13:\n5. All batteries containing more than 0,002 % cadmium or more than 0,004 % lead, shall be marked with the chemical symbol for the metal concerned: Cd or Pb.\nDefined in Article 3:\n(52) \"hazardous substance\" means a substance classified as hazardous pursuant to Article 3 of Regulation (EC) No 1272/2008.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_LeadCharacteristic" + }, + "other" : { + "description" : "Other active materials in the battery.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_OtherActiveMaterialsList" + } + }, + "required" : [ "nickel", "lithium", "cobalt", "lead" ] + }, + "urn_samm_io.catenax.battery.battery_pass_6.0.0_HazardousCharacteristic" : { + "description" : "Material attributes for hazardous materials.", + "type" : "object", + "properties" : { + "impactOfSubstances" : { + "description" : "An accumulation of documents that refer to the impact, especially hazardous substances, on the battery. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1) (s), refers to Article 74:\n1. In addition to the information referred to in Article 8a(2) of Directive 2008/98/EC, producers or, where appointed in accordance with Article 57(1), producer responsibility organisations shall make available to end-users and distributors the following information regarding the prevention and management of waste batteries with regard to the categories of batteries that they supply within the territory of a Member State:\n[...]\n(f) the impact of substances, in particular hazardous substances, present in batteries on the environment and on human health or the safety of persons, including the impact due to inappropriate discarding of waste batteries, such as littering or discarding as unsorted municipal waste.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentList" + }, + "concentration" : { + "description" : "Concentration of the material at the level of the product. This attribute is specially mentioned for substances of concern mentioned in the ESPR proposal from March 30th, 2022 Article 7:\n(5) (c) the concentration, maximum concentration or concentration range of the substances of concern, at the level of the product [...].\nOther substances are mentioned for the purpose of recycling in the ESPR provisional agreement from January 9th, 2024 Annex I:\n(d) design for recycling, ease and quality of recycling as expressed through: use of easily recyclable materials, safe, easy and non-destructive access to recyclable components and materials or components and materials containing hazardous substances and material composition and homogeneity, possibility for high-purity sorting, number of materials and components used, use of standard components, use of component and material coding standards for the identification of components and materials, number and complexity of processes and tools needed, ease of nondestructive disassembly and re-assembly, conditions for access to product data, conditions for access to or use of hardware and software needed.\n", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PositiveTrait" + }, + "location" : { + "description" : "The location of the substances of concern within the product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7:\n(5) (b) the location of the substances of concern within the product.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "materialUnit" : { + "description" : "The unit of concentration chosen from an enumeration: mass percent, volume percent, parts per thousand, parts per million, parts per billion and parts per trillion.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_ConcentrationEnumeration" + }, + "critical" : { + "description" : "A flag, if the material is a critical raw material. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I:\n(h) use or content of recycled materials and recovery of materials, including critical raw materials;\nIn Annex II of the connected proposal Act of Critical Raw Materials, a list of critical raw materials can be found.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Boolean" + }, + "documentation" : { + "description" : "Documentation accompanying the material.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentList" + } + }, + "required" : [ "impactOfSubstances", "concentration", "location", "materialUnit", "critical", "documentation" ] + }, + "urn_samm_io.catenax.battery.battery_pass_6.0.0_OtherHazardousMaterialEntity" : { + "description" : "Entity for other hazardous materials.", + "type" : "object", + "properties" : { + "impactOfSubstances" : { + "description" : "An accumulation of documents that refer to the impact, especially hazardous substances, on the battery. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1) (s), refers to Article 74:\n1. In addition to the information referred to in Article 8a(2) of Directive 2008/98/EC, producers or, where appointed in accordance with Article 57(1), producer responsibility organisations shall make available to end-users and distributors the following information regarding the prevention and management of waste batteries with regard to the categories of batteries that they supply within the territory of a Member State:\n[...]\n(f) the impact of substances, in particular hazardous substances, present in batteries on the environment and on human health or the safety of persons, including the impact due to inappropriate discarding of waste batteries, such as littering or discarding as unsorted municipal waste.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentList" + }, + "materialUnit" : { + "description" : "The unit of concentration chosen from an enumeration: mass percent, volume percent, parts per thousand, parts per million, parts per billion and parts per trillion.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_ConcentrationEnumeration" + }, + "concentration" : { + "description" : "Concentration of the material at the level of the product. This attribute is specially mentioned for substances of concern mentioned in the ESPR proposal from March 30th, 2022 Article 7:\n(5) (c) the concentration, maximum concentration or concentration range of the substances of concern, at the level of the product [...].\nOther substances are mentioned for the purpose of recycling in the ESPR provisional agreement from January 9th, 2024 Annex I:\n(d) design for recycling, ease and quality of recycling as expressed through: use of easily recyclable materials, safe, easy and non-destructive access to recyclable components and materials or components and materials containing hazardous substances and material composition and homogeneity, possibility for high-purity sorting, number of materials and components used, use of standard components, use of component and material coding standards for the identification of components and materials, number and complexity of processes and tools needed, ease of nondestructive disassembly and re-assembly, conditions for access to product data, conditions for access to or use of hardware and software needed.\n", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PositiveTrait" + }, + "materialIdentification" : { + "description" : "The chemical material name and identification, in accordance with the specification in the attribute for the list type. Preference is given to the IUPAC name. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Article 7:\n(5) (a) the name of the substances of concern present in the product, as follows:\n - name(s) in the International Union of Pure and Applied Chemistry (IUPAC) nomenclature, or another international name when IUPAC name is not available; \n- other names (usual name, trade name, abbreviation);\n- European Community (EC) number, as indicated in the European Inventory of Existing Commercial Chemical Substances (EINECS), the European List of Notified Chemical Substances (ELINCS) or the No Longer Polymer (NLP) list or assigned by the European Chemicals Agency (ECHA), if available;\n- the Chemical Abstract Service (CAS) name(s) and number(s), if available; .", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_MaterialIdList" + }, + "documentation" : { + "description" : "Documentation accompanying the material.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentList" + }, + "critical" : { + "description" : "A flag, if the material is a critical raw material. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I:\n(h) use or content of recycled materials and recovery of materials, including critical raw materials;\nIn Annex II of the connected proposal Act of Critical Raw Materials, a list of critical raw materials can be found.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Boolean" + }, + "location" : { + "description" : "The location of the substances of concern within the product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7:\n(5) (b) the location of the substances of concern within the product.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + } + }, + "required" : [ "impactOfSubstances", "materialUnit", "concentration", "materialIdentification", "documentation", "critical", "location" ] + }, + "urn_samm_io.catenax.battery.battery_pass_6.0.0_OtherHazardousMaterialList" : { + "description" : "List of other hazardous materials.", + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_OtherHazardousMaterialEntity" + } + }, + "urn_samm_io.catenax.battery.battery_pass_6.0.0_HazardousSubstanceCharacteristic" : { + "description" : "Hazardous Substance Characteristic for the battery chemical materials.", + "type" : "object", + "properties" : { + "cadmium" : { + "description" : "Information about the presence of cadmium in the battery. Therefore, a concentration and the location within the battery has to be given. This is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1) (a) refers to Annex VI Part A: \n8. the hazardous substances present in the battery, other than mercury, cadmium or lead;\nDefined in Article 3:\n(52) \"hazardous substance\" means a substance classified as hazardous pursuant to Article 3 of Regulation (EC) No 1272/2008.\nAdditionally in Article 13:\n5. All batteries containing more than 0,002 % cadmium or more than 0,004 % lead, shall be marked with the chemical symbol for the metal concerned: Cd or Pb.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_HazardousCharacteristic" + }, + "mercury" : { + "description" : "Information about the presence of mercury in the battery. Therefore, a concentration and the location within the battery has to be given. This is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1) (a) refers to Annex VI Part A: \n8. the hazardous substances present in the battery, other than mercury, cadmium or lead;\nDefined in Article 3:\n(52) \"hazardous substance\" means a substance classified as hazardous pursuant to Article 3 of Regulation (EC) No 1272/2008.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_HazardousCharacteristic" + }, + "other" : { + "description" : "Other hazardous materials.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_OtherHazardousMaterialList" + }, + "lead" : { + "description" : "Information about the lead in the battery. As this is an active and hazardous material, all properties for hazardous as well as active materials are required. These attribute are mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1)(e) refers to Article 8:\n1. From 18 August 2028 or 24 months after the date of entry into force of the delegated act referred to in the third subparagraph, whichever is the latest, industrial batteries with a capacity greater than 2 kWh, except those with exclusively external storage, electric vehicle batteries and SLI batteries that contain cobalt, lead, lithium or nickel in active materials, shall be accompanied by documentation containing information about the percentage share of cobalt, lithium or nickel that is present in active materials and that has been recovered from battery manufacturing waste or post-consumer waste, and the percentage share of lead that is present in the battery and that has been recovered from waste, for each battery model per year and per manufacturing plant.\nAnd for hazardous materials this is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1) (a) refers to Annex VI Part A: \n8. the hazardous substances present in the battery, other than mercury, cadmium or lead;\nAdditionally in Article 13:\n5. All batteries containing more than 0,002 % cadmium or more than 0,004 % lead, shall be marked with the chemical symbol for the metal concerned: Cd or Pb.\nDefined in Article 3:\n(52) \"hazardous substance\" means a substance classified as hazardous pursuant to Article 3 of Regulation (EC) No 1272/2008.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_LeadCharacteristic" + } + }, + "required" : [ "cadmium", "mercury", "lead" ] + }, + "urn_samm_io.catenax.battery.battery_pass_6.0.0_MaterialCompositionEntity" : { + "description" : "Entity for the material composition.", + "type" : "object", + "properties" : { + "id" : { + "description" : "The chemical material name and identification, in accordance with the specification in the attribute for the list type. Preference is given to the IUPAC name. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Article 7:\n(5) (a) the name of the substances of concern present in the product, as follows:\n - name(s) in the International Union of Pure and Applied Chemistry (IUPAC) nomenclature, or another international name when IUPAC name is not available; \n- other names (usual name, trade name, abbreviation);\n- European Community (EC) number, as indicated in the European Inventory of Existing Commercial Chemical Substances (EINECS), the European List of Notified Chemical Substances (ELINCS) or the No Longer Polymer (NLP) list or assigned by the European Chemicals Agency (ECHA), if available;\n- the Chemical Abstract Service (CAS) name(s) and number(s), if available; .", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_MaterialIdList" + }, + "concentration" : { + "description" : "Concentration of the material at the level of the product. This attribute is specially mentioned for substances of concern mentioned in the ESPR proposal from March 30th, 2022 Article 7:\n(5) (c) the concentration, maximum concentration or concentration range of the substances of concern, at the level of the product [...].\nOther substances are mentioned for the purpose of recycling in the ESPR provisional agreement from January 9th, 2024 Annex I:\n(d) design for recycling, ease and quality of recycling as expressed through: use of easily recyclable materials, safe, easy and non-destructive access to recyclable components and materials or components and materials containing hazardous substances and material composition and homogeneity, possibility for high-purity sorting, number of materials and components used, use of standard components, use of component and material coding standards for the identification of components and materials, number and complexity of processes and tools needed, ease of nondestructive disassembly and re-assembly, conditions for access to product data, conditions for access to or use of hardware and software needed.\n", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PositiveTrait" + }, + "unit" : { + "description" : "The unit of concentration chosen from an enumeration: mass percent, volume percent, parts per thousand, parts per million, parts per billion and parts per trillion.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_ConcentrationEnumeration" + }, + "critical" : { + "description" : "A flag, if the material is a critical raw material. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I:\n(h) use or content of recycled materials and recovery of materials, including critical raw materials;\nIn Annex II of the connected proposal Act of Critical Raw Materials, a list of critical raw materials can be found.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Boolean" + }, + "documentation" : { + "description" : "Documentation accompanying the material.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentList" + }, + "recycled" : { + "description" : "The share of the material, which is recovered recycled content from the product. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I:\n(h) use or content of recycled materials and recovery of materials, including critical raw materials;", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PercentageTrait" + }, + "location" : { + "description" : "The location of the substances of concern within the product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7:\n(5) (b) the location of the substances of concern within the product.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "renewable" : { + "description" : "The share of the material, which is from a renewable resource that can be replenished. Renewable resources are those that can be reproduced by physical, chemical, or mechanical processes. These are the kind of resources that can be regenerated throughout time. Forest wood, for example, can be grown through reforestation. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I:\n(ha) use or content of sustainable renewable materials;\n", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PercentageTrait" + } + }, + "required" : [ "id", "concentration", "unit", "critical", "documentation", "recycled", "location", "renewable" ] + }, + "urn_samm_io.catenax.battery.battery_pass_6.0.0_MaterialCompositionList" : { + "description" : "List for the material composition.", + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_MaterialCompositionEntity" + } + }, + "urn_samm_io.catenax.battery.battery_pass_6.0.0_ChemicalMaterialCharacteristic" : { + "description" : "Chemical Material Characteristic for the battery.", + "type" : "object", + "properties" : { + "active" : { + "description" : "The active materials included in the battery. Mandatory are nickel, lithium, cobalt and lead. Others are optional. Defined by the Battery regulation 2023/1542 from 12 July 2023 in Article 3 Definitions:\n(5) ‘active material’ means a material which reacts chemically to produce electric energy when the battery cell discharges or to store electric energy when the battery is being charged.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_ActiveMaterialsCharacteristic" + }, + "hazardous" : { + "description" : "Hazardous substances like lead, cadmium and mercury.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_HazardousSubstanceCharacteristic" + }, + "composition" : { + "description" : "The materials which are necessary to describe the material composition, especially if they are active, critical or hazardous. This can be redundant to the specifically mentioned active or hazardous materials. This is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1):\n(b) the material composition of the battery, including its chemistry, hazardous substances present in the battery, other than mercury, cadmium or lead, and critical raw materials present in the battery; \n(f) the share of renewable content.\nand in Annex XIII (2):\n(a) detailed composition, including materials used in the cathode, anode and electrolyte;\nDefinition from Article 3:\n(52) \"hazardous substance\" means a substance classified as hazardous pursuant to Article 3 of Regulation (EC) No 1272/2008:\nA substance or a mixture fulfilling the criteria relating to physical hazards, health hazards or environmental hazards, laid down in Parts 2 to 5 of Annex I is hazardous and shall be classified in relation to the respective hazard classes provided for in that Annex.\nWhere, in Annex I, hazard classes are differentiated on the basis of the route of exposure or the nature of the effects, the substance or mixture shall be classified in accordance with such differentiation.\nDefined in Article 2 of Regulation (EC) No 1272/2008:\n1. hazard class\" means the nature of the physical, health or environmental hazard.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_MaterialCompositionList" + } + }, + "required" : [ "active", "hazardous", "composition" ] + }, + "urn_samm_io.catenax.battery.battery_pass_6.0.0_VoltMeasurement" : { + "type" : "number", + "description" : "Measurement for volt as a double." + }, + "urn_samm_io.catenax.battery.battery_pass_6.0.0_DegreeMeasurement" : { + "type" : "number", + "description" : "Degree measurement in celsius." + }, + "urn_samm_io.catenax.battery.battery_pass_6.0.0_VoltageCharacteristic" : { + "description" : "Characteristic for voltage values.", + "type" : "object", + "properties" : { + "min" : { + "description" : "Minimum voltage refers to the lowest voltage the battery is able to reach. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1):\n(h) minimal, nominal and maximum voltage, with temperature ranges when relevant.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_VoltMeasurement" + }, + "max" : { + "description" : "Maximum voltage refers to the highest voltage the battery is able to reach. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1):\n(h) minimal, nominal and maximum voltage, with temperature ranges when relevant.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_VoltMeasurement" + }, + "nominal" : { + "description" : "Nominal voltage is a standardized or average voltage value assigned to the battery. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1):\n(h) minimal, nominal and maximum voltage, with temperature ranges when relevant.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_VoltMeasurement" + }, + "temperature" : { + "description" : "Temperature refers to the temperature of the battery during it's cycle-life testing or as boundary condition for other rated values in celsius.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_DegreeMeasurement" + } + }, + "required" : [ "min", "max", "nominal" ] + }, + "urn_samm_io.catenax.battery.battery_pass_6.0.0_PercentMeasurement" : { + "type" : "number", + "description" : "Measurement in percent as double." + }, + "urn_samm_io.catenax.battery.battery_pass_6.0.0_RatedRoundTripEfficiencyCharacteristic" : { + "description" : "Characteristic for the rated round trip efficiency.", + "type" : "object", + "properties" : { + "depthOfDischarge" : { + "description" : "Depth of discharge is a measure used to quantify the extent to which the battery has been discharged relative to its maximum capacity during its cycle-life testing. It represents the percentage of the total available capacity that has been drained or used during a particular discharge cycle. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (4) (a) refers to Article 10 (1), refers to Annex IV Part B:\n3. Depth of discharge in the cycle-life test.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_PercentMeasurement" + }, + "initial" : { + "description" : "The efficiency value of a battery refers to the ratio of useful output energy to the input energy, expressed as a percentage. It quantifies how effectively a battery can convert and deliver stored energy during the discharge process relative to the energy input during charging. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1):\n(n) initial round trip energy efficiency and at 50 % of cycle-life.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_PercentMeasurement" + }, + "50PercentLife" : { + "description" : "The round trip efficiency at 50 percent refers to the efficiency of a rechargeable battery's energy storage and retrieval process when the battery has undergone approximately half of its expected number of charge-discharge cycles. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1):\n(n) initial round trip energy efficiency and at 50 % of cycle-life.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_PercentMeasurement" + }, + "temperature" : { + "description" : "Temperature refers to the temperature of the battery during it's cycle-life testing or as boundary condition for other rated values in celsius.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_DegreeMeasurement" + } + }, + "required" : [ "depthOfDischarge", "initial", "50PercentLife" ] + }, + "urn_samm_io.catenax.battery.battery_pass_6.0.0_KilowattHourMeasurement" : { + "type" : "number", + "description" : "Measurement for the energy expressed in kilowatt hours as double." + }, + "urn_samm_io.catenax.battery.battery_pass_6.0.0_RatedEnergyCharacteristic" : { + "description" : "Characteristic for the rated energy.", + "type" : "object", + "properties" : { + "value" : { + "description" : "Value describing the energy in a specific measurement period, expressed in kilowatt-hours.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_KilowattHourMeasurement" + }, + "temperature" : { + "description" : "Temperature refers to the temperature of the battery during it's cycle-life testing or as boundary condition for other rated values in celsius.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_DegreeMeasurement" + } + }, + "required" : [ "value" ] + }, + "urn_samm_io.catenax.battery.battery_pass_6.0.0_OhmMeasurement" : { + "type" : "number", + "description" : "Measurement in ohms as double." + }, + "urn_samm_io.catenax.battery.battery_pass_6.0.0_RatedResistanceCharacteristic" : { + "description" : "Characteristic for rated resistance values of the battery on different levels.", + "type" : "object", + "properties" : { + "cell" : { + "description" : "Cell resistance refers to the internal resistance of an individual battery cell in ohms. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1):\n(o) internal battery cell and pack resistance;\nDefinition from Annex IV:\n(5) \"Internal resistance\" means the opposition to the flow of current within a cell or a battery under reference conditions, that is, the sum of electronic resistance and ionic resistance to the contribution to total effective resistance including inductive/capacitive properties.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_OhmMeasurement" + }, + "module" : { + "description" : "The module resistance in ohms includes the internal resistance of each cell within the module as well as the resistance introduced by interconnecting components such as busbars, connectors, and thermal management systems.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_OhmMeasurement" + }, + "pack" : { + "description" : "Pack resistance refers to the overall electrical resistance within a battery pack in ohms. This resistance is a combination of the individual resistances in various components within the pack, including the electrodes, connectors, and other conductive elements. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1):\n(o) internal battery cell and pack resistance;\nDefinition from Annex IV:\n(5) \"Internal resistance\" means the opposition to the flow of current within a cell or a battery under reference conditions, that is, the sum of electronic resistance and ionic resistance to the contribution to total effective resistance including inductive/capacitive properties.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_OhmMeasurement" + }, + "temperature" : { + "description" : "Temperature refers to the temperature of the battery during it's cycle-life testing or as boundary condition for other rated values in celsius.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_DegreeMeasurement" + } + }, + "required" : [ "cell", "pack" ] + }, + "urn_samm_io.catenax.battery.battery_pass_6.0.0_WattMeasurement" : { + "type" : "number", + "description" : "Measurement in watt as double." + }, + "urn_samm_io.catenax.battery.battery_pass_6.0.0_RatedPowerCharacteristic" : { + "description" : "Characteristic for rated power values.", + "type" : "object", + "properties" : { + "value" : { + "description" : "Value describing the power in a specific measurement period, expressed in watt.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_WattMeasurement" + }, + "at20SoC" : { + "description" : "Capability at 20% SoC refers to the battery's capability at 80% State of Charge. This measurement is indicative of the immediate available energy in the battery. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (4)(a) refers to Article 10 (1), refers to Annex IV Part B:\t\n4. Power capability at 80 % and 20 % state of charge.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_WattMeasurement" + }, + "at80SoC" : { + "description" : "Capability at 80% SoC refers to the battery's capability at 80% State of Charge. This measurement is indicative of the immediate available energy in the battery. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (4)(a) refers to Article 10 (1), refers to Annex IV Part B:\t\n4. Power capability at 80 % and 20 % state of charge", + "$ref" : "#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_WattMeasurement" + }, + "temperature" : { + "description" : "Temperature refers to the temperature of the battery during it's cycle-life testing or as boundary condition for other rated values in celsius.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_DegreeMeasurement" + } + }, + "required" : [ "value", "at20SoC", "at80SoC" ] + }, + "urn_samm_io.catenax.battery.battery_pass_6.0.0_AmpereHourMeasurement" : { + "type" : "number", + "description" : "Measurement for the capacity expressed in ampere hours as double." + }, + "urn_samm_io.catenax.battery.battery_pass_6.0.0_RatedCapacityCharacteristic" : { + "description" : "Characteristic for rated capacity values.", + "type" : "object", + "properties" : { + "value" : { + "description" : "Value describing the capacity in a specific measurement period, expressed in ampere-hours.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_AmpereHourMeasurement" + }, + "thresholdExhaustion" : { + "description" : "Capacity threshold exhaustion refers to the condition where a battery's capacity diminishes to a level that is considered unacceptable for its intended use. The capacity threshold is a predetermined level below which the battery is considered to be no longer effective or reliable for the specific application. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1):\n(k) capacity threshold for exhaustion (only for electric vehicle batteries).", + "$ref" : "#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_PercentMeasurement" + }, + "temperature" : { + "description" : "Temperature refers to the temperature of the battery during it's cycle-life testing or as boundary condition for other rated values in celsius.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_DegreeMeasurement" + } + }, + "required" : [ "value", "thresholdExhaustion" ] + }, + "urn_samm_io.catenax.battery.battery_pass_6.0.0_PerformanceTemperatureCharacteristic" : { + "description" : "Characteristic for temperature values.", + "type" : "object", + "properties" : { + "lower" : { + "description" : "The lower temperature boundary (in Celsius) refers to the minimum temperature at which a battery can effectively operate. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1):\n(l) temperature range the battery can withstand when not in use (reference test).", + "$ref" : "#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_DegreeMeasurement" + }, + "upper" : { + "description" : "The upper temperature boundary (in Celsius) refers to the minimum temperature at which a battery can effectively operate. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1):\n(l) temperature range the battery can withstand when not in use (reference test).", + "$ref" : "#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_DegreeMeasurement" + } + }, + "required" : [ "lower", "upper" ] + }, + "urn_samm_io.catenax.battery.battery_pass_6.0.0_IntegerCharacteristic" : { + "type" : "number", + "description" : "Characteristic for an integer value." + }, + "urn_samm_io.catenax.battery.battery_pass_6.0.0_CRateCharacteristic" : { + "type" : "number", + "description" : "The C-rate, also known as the charge/discharge rate, quantifies how quickly a battery is charged or discharged in relation to its capacity. It is dimensionless." + }, + "urn_samm_io.catenax.battery.battery_pass_6.0.0_CycleLifeCharacteristic" : { + "description" : "Cycle Life Characteristic for the battery lifetime testing.", + "type" : "object", + "properties" : { + "temperature" : { + "description" : "Temperature refers to the temperature of the battery during it's cycle-life testing or as boundary condition for other rated values in celsius.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_DegreeMeasurement" + }, + "cycles" : { + "description" : "Cycle refers to one complete charging and discharging sequence. Either during the battery's cycle-life testing or as full equivalent while in use.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_IntegerCharacteristic" + }, + "depthOfDischarge" : { + "description" : "Depth of discharge is a measure used to quantify the extent to which the battery has been discharged relative to its maximum capacity during its cycle-life testing. It represents the percentage of the total available capacity that has been drained or used during a particular discharge cycle. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (4) (a) refers to Article 10 (1), refers to Annex IV Part B:\n3. Depth of discharge in the cycle-life test.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_PercentMeasurement" + }, + "appliedChargeRate" : { + "description" : "The applied charge rate (c rate) refers to the rate at which a battery is charged. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1):\n(p) c-rate of relevant cycle-life test;\nand Annex XIII (4)(a) refers to Article 10(1) refers to Annex IV Part B:\n1. Applied discharge rate and charge rate.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_CRateCharacteristic" + }, + "appliedDischargeRate" : { + "description" : "The applied discharge rate (c rate) refers to the rate at which a battery is discharged. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1):\n(p) c-rate of relevant cycle-life test;\nand Annex XIII (4)(a) refers to Article 10(1) refers to Annex IV Part B:\n1. Applied discharge rate and charge rate.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_CRateCharacteristic" + } + }, + "required" : [ "temperature", "cycles", "depthOfDischarge", "appliedChargeRate", "appliedDischargeRate" ] + }, + "urn_samm_io.catenax.battery.battery_pass_6.0.0_LifeCycleCharacteristic" : { + "description" : "Life Cycle Characteristic with attributes for the lifetime evaluation of a battery.", + "type" : "object", + "properties" : { + "expectedYears" : { + "description" : "The expected years refer to the expected life-time of the battery before it starts heavily degrading in its capacity and c-rate in calendar years. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (4) (a) refers to the Article 10 (1) refers to Annex IV Part A: \n5. The expected life-time of the battery under the reference conditions for which it has been designed, in terms of cycles, except for non-cycle applications, and calendar years.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_IntegerCharacteristic" + }, + "report" : { + "description" : "The test reports refer to the testing conducted during the determination of the rated values of the battery. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (3):\n[...] results of test reports proving compliance with the requirements laid down in this Regulation or any delegated or implementing act adopted pursuant to this Regulation.\nAnd Annex XIII (4)(a) refers to Article 10(1) and refer to Annex IV Part B:\n5. Any calculations performed with the measured parameters, if applicable.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentList" + }, + "cycleLifeTesting" : { + "description" : "The cycle life testing of the battery.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_CycleLifeCharacteristic" + } + }, + "required" : [ "expectedYears", "report", "cycleLifeTesting" ] + }, + "urn_samm_io.catenax.battery.battery_pass_6.0.0_RatedPerformanceCharacteristic" : { + "description" : "Characteristic for rated performance values of the battery.", + "type" : "object", + "properties" : { + "voltage" : { + "description" : "Voltage values are mandatory for the battery, with the option to include temperature values voluntarily. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1):\n(h) minimal, nominal and maximum voltage, with temperature ranges when relevant.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_VoltageCharacteristic" + }, + "roundTripEfficiency" : { + "description" : "The efficiency value of a battery refers to the ratio of useful output energy to the input energy, expressed as a percentage. With the option to include temperature values voluntarily.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_RatedRoundTripEfficiencyCharacteristic" + }, + "energy" : { + "description" : "Representation of the total amount of energy that the battery can store and subsequently deliver during its discharge cycle. It is necessary to calculate the SOCE.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_RatedEnergyCharacteristic" + }, + "resistance" : { + "description" : "Rated resistance of the battery on the level of the pack, module (optional) and cell.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_RatedResistanceCharacteristic" + }, + "power" : { + "description" : "The power value is the rate at which energy is delivered or consumed. It is measured in watts (W) and represents how quickly energy is transferred. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (4)(a) refers to Article 10(1), refers to Annex IV Part A: \t\n2. Power (in W) and power fade (in %).\nDefinition from Annex IV:\n(3) \"Power\" means the amount of energy that a battery is capable of providing over a given period under reference conditions.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_RatedPowerCharacteristic" + }, + "capacity" : { + "description" : "Capacity value refers to the amount of electric charge that a battery can store and subsequently deliver when needed. It is a fundamental characteristic of a battery and is expressed in ampere-hours. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1):\n(g) rated capacity (in Ah);\nand in Annex XIII (4)(a) referring to Article 10 (1) and referring to Annex IV Part A:\n1. Rated capacity (in Ah) and capacity fade (in %). \nAnd in Annex XIII (1)(a) referring to Annex VI Part A:\n6. the capacity;\nDefinition from Annex IV:\n(1) \"Rated capacity\" means the total number of ampere-hours (Ah) that can be withdrawn from a fully charged battery under reference conditions.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_RatedCapacityCharacteristic" + }, + "performanceDocument" : { + "description" : "The performance document lists information regarding the performance of the battery. This can be an overview about several rated performance attributes. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (3):\n[...] results of test reports proving compliance with the requirements laid down in this Regulation or any delegated or implementing act adopted pursuant to this Regulation.\nAnd Annex XIII (4)(a) refers to Article 10(1) and refer to Annex IV Part B:\n5. Any calculations performed with the measured parameters, if applicable.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentList" + }, + "temperature" : { + "description" : "The battery temperatures. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1):\n(l) temperature range the battery can withstand when not in use (reference test).", + "$ref" : "#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_PerformanceTemperatureCharacteristic" + }, + "selfDischargingRate" : { + "description" : "The self-discharge rate of a battery refers to the rate at which the battery loses its stored energy when not in use. It's the discharge of the battery that occurs internally without any external load recorded in percentage for every month. This attribute is mentioned in the Battery Regulation 2023/1542 from 12 July 2023 in Annex XIII (4) (b) refers to Article 14, refers to Annex VII Part A:\n4. the evolution of self-discharging rates.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_PercentMeasurement" + }, + "testReport" : { + "description" : "The test reports refer to the testing conducted during the determination of the rated values of the battery. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (3):\n[...] results of test reports proving compliance with the requirements laid down in this Regulation or any delegated or implementing act adopted pursuant to this Regulation.\nAnd Annex XIII (4)(a) refers to Article 10(1) and refer to Annex IV Part B:\n5. Any calculations performed with the measured parameters, if applicable.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentList" + }, + "lifetime" : { + "description" : "Attributes for the lifetime evaluation of a battery.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_LifeCycleCharacteristic" + } + }, + "required" : [ "voltage", "roundTripEfficiency", "resistance", "power", "capacity", "temperature", "selfDischargingRate", "lifetime" ] + }, + "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.battery.battery_pass_6.0.0_RecordCharacteristic" : { + "description" : "Characteristic for a dynamic record with a value and timestamp.", + "type" : "object", + "properties" : { + "value" : { + "description" : "A value as a percentage in the form of a double.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_PercentMeasurement" + }, + "time" : { + "description" : "The entry date and time corresponding to when a specific parameter was measured. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (4):\n(d) information and data resulting from its use, including the number of charging and discharging cycles and negative events, such as accidents, as well as periodically recorded information on the operating environmental conditions, including temperature, and on the state of charge.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Timestamp" + } + }, + "required" : [ "value", "time" ] + }, + "urn_samm_io.catenax.battery.battery_pass_6.0.0_FullCycleCharacteristic" : { + "description" : "Characteristic for dynamic cycle values.", + "type" : "object", + "properties" : { + "time" : { + "description" : "The entry date and time corresponding to when a specific parameter was measured. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (4):\n(d) information and data resulting from its use, including the number of charging and discharging cycles and negative events, such as accidents, as well as periodically recorded information on the operating environmental conditions, including temperature, and on the state of charge.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Timestamp" + }, + "value" : { + "description" : "Cycle refers to one complete charging and discharging sequence. Either during the battery's cycle-life testing or as full equivalent while in use.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_IntegerCharacteristic" + } + }, + "required" : [ "time", "value" ] + }, + "urn_samm_io.catenax.battery.battery_pass_6.0.0_RemainingPowerCharacteristic" : { + "description" : "Characteristic for the remaining power.", + "type" : "object", + "properties" : { + "time" : { + "description" : "The entry date and time corresponding to when a specific parameter was measured. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (4):\n(d) information and data resulting from its use, including the number of charging and discharging cycles and negative events, such as accidents, as well as periodically recorded information on the operating environmental conditions, including temperature, and on the state of charge.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Timestamp" + }, + "value" : { + "description" : "Value describing the power in a specific measurement period, expressed in watt.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_WattMeasurement" + } + }, + "required" : [ "time", "value" ] + }, + "urn_samm_io.catenax.battery.battery_pass_6.0.0_DynamicPowerCharacteristic" : { + "description" : "Characteristic for dynamic power values.", + "type" : "object", + "properties" : { + "fade" : { + "description" : "Power fade refers to a reduction in the power of the battery system over time expressed as a percentage in reference to the initial value. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (4)(a) refers to Article 10 (1), refers to Annex IV Part A: \t\n2. Power (in W) and power fade (in %).\nDefinition from Annex IV:\n(4) \"Power fade\" means the decrease over time and upon usage in the amount of power that a battery can deliver at the rated voltage.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_RecordCharacteristic" + }, + "remaining" : { + "description" : "The remaining power capability in the battery expressed in watt. This attribute is mentioned in the Battery Regulation 2023/1542 from 12 July 2023 in Annex XIII (4) (b) refers to Article 14, refers to Annex VII Part A:\n2. where possible, the remaining power capability;\nDefinition from Annex IV:\n(3) \"Power\" means the amount of energy that a battery is capable of providing over a given period under reference\nconditions.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_RemainingPowerCharacteristic" + } + }, + "required" : [ "fade", "remaining" ] + }, + "urn_samm_io.catenax.battery.battery_pass_6.0.0_CapacityCharacteristic" : { + "description" : "Characteristic for dynamic capacity values such as the throughput and the remaining capacity.", + "type" : "object", + "properties" : { + "time" : { + "description" : "The entry date and time corresponding to when a specific parameter was measured. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (4):\n(d) information and data resulting from its use, including the number of charging and discharging cycles and negative events, such as accidents, as well as periodically recorded information on the operating environmental conditions, including temperature, and on the state of charge.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Timestamp" + }, + "value" : { + "description" : "Value describing the capacity in a specific measurement period, expressed in ampere-hours.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_AmpereHourMeasurement" + } + }, + "required" : [ "time", "value" ] + }, + "urn_samm_io.catenax.battery.battery_pass_6.0.0_DynamicCapacityCharacteristic" : { + "description" : "Characteristic for dynamic capacity values.", + "type" : "object", + "properties" : { + "fade" : { + "description" : "Capacity fade refers to a reduction in the capacity of the battery system over time expressed as a percentage in reference to the initial value. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (4)(a) refers to Article 10(1) and refer to Annex IV Part A: \n1. Rated capacity (in Ah) and capacity fade (in %).\nDefinition from Annex IV:\n(2) \"Capacity fade\" means the decrease over time and upon usage in the amount of charge that a battery can deliver at the rated voltage, with respect to the original rated capacity.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_RecordCharacteristic" + }, + "throughput" : { + "description" : "Capacity throughput refers to the total amount of energy that a battery has delivered over its lifetime. It represents the cumulative energy discharge and recharge cycles a battery has undergone. Capacity throughput is expressed in ampere-hours. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex VII Part B: \n3. the capacity throughput.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_CapacityCharacteristic" + }, + "capacity" : { + "description" : "The remaining capacity in the battery expressed in ampere hours. This attribute is mentioned in the Battery Regulation 2023/1542 from 12 July 2023 in Annex XIII (4) (b) refers to Article 14, refers to Annex VII Part A:\n1. the remaining capacity.\n", + "$ref" : "#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_CapacityCharacteristic" + } + }, + "required" : [ "fade", "throughput", "capacity" ] + }, + "urn_samm_io.catenax.battery.battery_pass_6.0.0_DynamicRoundTripEfficiencyCharacteristic" : { + "description" : "Characteristic for dynamic round trip efficiency values.", + "type" : "object", + "properties" : { + "fade" : { + "description" : "Round trip efficiency fade refers to a reduction in the round trip efficiency of the battery system over time expressed as a percentage in reference to the initial value. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (4)(a) refers to Article 10(1) and refers to Annex IV: \n4. Where applicable, energy round trip efficiency and its fade (in %).\nDefinition from Annex IV:\n(6) \"Energy round trip efficiency\" means the ratio of the net energy delivered by a battery during a discharge test to the total energy required to restore the initial state of charge by a standard charge.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_RecordCharacteristic" + }, + "remaining" : { + "description" : "The remaining round trip efficiency in the battery expressed as percentage. This attribute is mentioned in the Battery Regulation 2023/1542 from 12 July 2023 in Annex XIII (4) (b) refers to Article 14, refers to Annex VII Part A:\n3. where possible, the remaining round trip efficiency.\nDefinition from Annex IV:\n(6) \"Energy round trip efficiency\" means the ratio of the net energy delivered by a battery during a discharge test to the total energy required to restore the initial state of charge by a standard charge.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_RecordCharacteristic" + } + }, + "required" : [ "fade", "remaining" ] + }, + "urn_samm_io.catenax.battery.battery_pass_6.0.0_ResistanceIncreaseCharacteristic" : { + "description" : "Characteristic for the increase of the battery resistance.", + "type" : "object", + "properties" : { + "pack" : { + "description" : "Pack resistance increase refers to the overall electrical resistance within a battery pack. This resistance is a combination of the individual resistances in various components within the pack, including the electrodes, connectors, and other conductive elements. The rise in the pack resistance is expressed as a percentage in reference to the initial value.\nThis attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (4)(a) refers to Article 10(1) and refers to Annex IV Part A: \n3. Internal resistance (in \") and internal resistance increase (in %).\nDefinition from Annex IV:\n(5) \"Internal resistance\" means the opposition to the flow of current within a cell or a battery under reference conditions, that is, the sum of electronic resistance and ionic resistance to the contribution to total effective resistance including inductive/capacitive properties.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_RecordCharacteristic" + }, + "module" : { + "description" : "The module resistance increase includes the internal resistance of each cell within the module as well as the resistance introduced by interconnecting components such as busbars, connectors, and thermal management systems. The rise in the module resistance is expressed as a percentage in reference to the initial value.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_RecordCharacteristic" + }, + "cell" : { + "description" : "Cell resistance increase refers to the internal resistance of an individual battery cell. The rise in the cell resistance is expressed as a percentage in reference to the initial value. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (4)(a) refers to Article 10(1) and refers to Annex IV Part A: \n3. Internal resistance (in ohms) and internal resistance increase (in %).\nDefinition from Annex IV:\n(5) \"Internal resistance\" means the opposition to the flow of current within a cell or a battery under reference conditions, that is, the sum of electronic resistance and ionic resistance to the contribution to total effective resistance including inductive/capacitive properties.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_RecordCharacteristic" + } + }, + "required" : [ "pack", "cell" ] + }, + "urn_samm_io.catenax.battery.battery_pass_6.0.0_OhmsMeasurement" : { + "type" : "number", + "description" : "Measurement for ohm as double." + }, + "urn_samm_io.catenax.battery.battery_pass_6.0.0_RemainingResistanceCharacteristicRecord" : { + "description" : "Characteristic for the remaining battery resistance.", + "type" : "object", + "properties" : { + "time" : { + "description" : "The entry date and time corresponding to when a specific parameter was measured. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (4):\n(d) information and data resulting from its use, including the number of charging and discharging cycles and negative events, such as accidents, as well as periodically recorded information on the operating environmental conditions, including temperature, and on the state of charge.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Timestamp" + }, + "value" : { + "description" : "The remaining resistance value expressed in ohms.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_OhmsMeasurement" + } + }, + "required" : [ "time", "value" ] + }, + "urn_samm_io.catenax.battery.battery_pass_6.0.0_RemainingResistanceCharacteristic" : { + "description" : "Characteristic for the remaining battery resistance.", + "type" : "object", + "properties" : { + "pack" : { + "description" : "Pack resistance refers to the overall electrical resistance within a battery pack. This resistance is a combination of the individual resistances in various components within the pack, including the electrodes, connectors, and other conductive elements. This attribute is mentioned in the Battery Regulation 2023/1542 from 12 July 2023 in Annex XIII (4) (b) refers to Article 14, refers to Annex VII Part A:\n5. where possible, the ohmic resistance.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_RemainingResistanceCharacteristicRecord" + }, + "module" : { + "description" : "Module resistance in ohms includes the internal resistance of each cell within the module as well as the resistance introduced by interconnecting components such as busbars, connectors, and thermal management systems.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_RemainingResistanceCharacteristicRecord" + }, + "cell" : { + "description" : "Cell resistance refers to the internal resistance of an individual battery cell expressed in ohms. This attribute is mentioned in the Battery Regulation 2023/1542 from 12 July 2023 in Annex XIII (4) (b) refers to Article 14, refers to Annex VII Part A:\n5. where possible, the ohmic resistance.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_RemainingResistanceCharacteristicRecord" + } + }, + "required" : [ "pack", "cell" ] + }, + "urn_samm_io.catenax.battery.battery_pass_6.0.0_DynamicInternalResistanceCharacteristic" : { + "description" : "Characteristic for dynamic internal resistance values.", + "type" : "object", + "properties" : { + "increase" : { + "description" : "The increase as percentage in the battery resistance on the level of the pack, module (optional) and cell.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_ResistanceIncreaseCharacteristic" + }, + "remaining" : { + "description" : "The remaining resistance in ohms in the battery on the level of the pack, module (optional) and cell.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_RemainingResistanceCharacteristic" + } + }, + "required" : [ "increase", "remaining" ] + }, + "urn_samm_io.catenax.battery.battery_pass_6.0.0_EnergyCharacteristic" : { + "description" : "Characteristic for energy values expressed in a timestamp and a kilowatt-hours value.", + "type" : "object", + "properties" : { + "time" : { + "description" : "The entry date and time corresponding to when a specific parameter was measured. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (4):\n(d) information and data resulting from its use, including the number of charging and discharging cycles and negative events, such as accidents, as well as periodically recorded information on the operating environmental conditions, including temperature, and on the state of charge.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Timestamp" + }, + "value" : { + "description" : "Value describing the energy in a specific measurement period, expressed in kilowatt-hours.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_KilowattHourMeasurement" + } + }, + "required" : [ "time", "value" ] + }, + "urn_samm_io.catenax.battery.battery_pass_6.0.0_DynamicEnergyCharacteristic" : { + "description" : "Characteristic for dynamic energy values.", + "type" : "object", + "properties" : { + "soce" : { + "description" : "The state of certified energy (SOCE) refers to the current measured or on-board usable battery energy (UBE) performance expressed as a percentage. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (4)(b) refers to Article 14) and refers to Annex VII Part A: \nstate of certified energy (SOCE).", + "$ref" : "#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_RecordCharacteristic" + }, + "remaining" : { + "description" : "The remaining energy in the battery expressed in kilowatt-hours.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_EnergyCharacteristic" + }, + "throughput" : { + "description" : "Energy throughput refers to the total amount of energy that passes through a system over a specific period. This measure encompasses both the energy input (during charging) and the energy output (during discharging). Energy throughput is expressed in kilowatt-hours. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex VII Part B: \n2. the energy throughput.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_EnergyCharacteristic" + } + }, + "required" : [ "soce", "remaining" ] + }, + "urn_samm_io.catenax.battery.battery_pass_6.0.0_DynamicPerformanceCharacteristic" : { + "description" : "Characteristic for dynamic performance values of the battery.", + "type" : "object", + "properties" : { + "stateOfCharge" : { + "description" : "State of Charge (SOC) refers to the amount of energy remaining in a battery at a given point in time, expressed as a percentage of the total capacity. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (4):\n(d) information and data resulting from its use, including the number of charging and discharging cycles and negative events, such as accidents, as well as periodically recorded information on the operating environmental conditions, including temperature, and on the state of charge.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_RecordCharacteristic" + }, + "fullCycles" : { + "description" : "Full cycles include the cumulative and equivalent count of complete charge and discharge cycles experienced by the battery over its entire life. This attribute is mentioned in the Battery Regulation 2023/1542 from 12 July 2023 in Annex XIII (4) (d) information and data resulting from its use, including the number of charging and discharging cycles and negative events, such as accidents, as well as periodically recorded information on the operating environmental conditions, including temperature, and on the state of charge.\nAnd in AnnexVII Part B:\n5. the number of full equivalent charge-discharge cycles.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_FullCycleCharacteristic" + }, + "performanceDocument" : { + "description" : "The performance document lists information regarding the performance of the battery. This can be an overview about several rated performance attributes. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (3):\n[...] results of test reports proving compliance with the requirements laid down in this Regulation or any delegated or implementing act adopted pursuant to this Regulation.\nAnd Annex XIII (4)(a) refers to Article 10(1) and refer to Annex IV Part B:\n5. Any calculations performed with the measured parameters, if applicable.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentList" + }, + "selfDischargingRate" : { + "description" : "The self-discharge rate of a battery refers to the rate at which the battery loses its stored energy when not in use. It's the discharge of the battery that occurs internally without any external load recorded in percentage for every month. This attribute is mentioned in the Battery Regulation 2023/1542 from 12 July 2023 in Annex XIII (4) (b) refers to Article 14, refers to Annex VII Part A:\n4. the evolution of self-discharging rates.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_PercentMeasurement" + }, + "power" : { + "description" : "Values that describe dynamically captured power values.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_DynamicPowerCharacteristic" + }, + "capacity" : { + "description" : "Values that describe dynamically captured capacity values.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_DynamicCapacityCharacteristic" + }, + "roundTripEfficiency" : { + "description" : "Dynamic round trip efficiency values.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_DynamicRoundTripEfficiencyCharacteristic" + }, + "resistance" : { + "description" : "Values that describe dynamically captured internal resistance values.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_DynamicInternalResistanceCharacteristic" + }, + "energy" : { + "description" : "Values that describe dynamically captured energy values.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_DynamicEnergyCharacteristic" + }, + "negativeEvents" : { + "description" : "Mandatory if applicable. Negative events refers to several possible events influencing the battery's condition and lifetime such as extreme temperatures. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (4):\n(d) information and data resulting from its use, including the number of charging and discharging cycles and negative events, such as accidents, as well as periodically recorded information on the operating environmental conditions, including temperature, and on the state of charge.\nAnd Annex VII Part B:\n4. the tracking of harmful events, such as the number of deep discharge events, time spent in extreme temperatures, time spent charging in extreme temperatures.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentList" + }, + "operatingEnvironment" : { + "description" : "Mandatory if applicable. The operating environment refers to the conditions in which the battery is designed to function optimally. The environment includes factors such as temperature, humidity, pressure, and other external conditions that can impact the performance, safety, and lifespan of the battery. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (4):\n(d) information and data resulting from its use, including the number of charging and discharging cycles and negative events, such as accidents, as well as periodically recorded information on the operating environmental conditions, including temperature, and on the state of charge.\nAnd Annex VII Part B:\n4. the tracking of harmful events, such as the number of deep discharge events, time spent in extreme temperatures, time spent charging in extreme temperatures.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentList" + } + }, + "required" : [ "stateOfCharge", "fullCycles", "selfDischargingRate", "power", "capacity", "roundTripEfficiency", "resistance", "energy" ] + }, + "urn_samm_io.catenax.battery.battery_pass_6.0.0_PerformanceCharacteristic" : { + "description" : "Performance Characteristic for the battery.", + "type" : "object", + "properties" : { + "rated" : { + "description" : "Rated performance values of the battery such as voltage, round trip efficiency, energy, resistance, power, capacity, temperature ranges and self-discharging rate.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_RatedPerformanceCharacteristic" + }, + "dynamic" : { + "description" : "Dynamic performance values of the battery.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_DynamicPerformanceCharacteristic" + } + }, + "required" : [ "rated", "dynamic" ] + }, + "urn_samm_io.catenax.battery.battery_pass_6.0.0_ConformityCharacteristic" : { + "description" : "Characteristic for conformity documents.", + "type" : "object", + "properties" : { + "declarationOfConformityId" : { + "description" : "Identification number of the EU declaration of conformity. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1):\n(r) the EU declaration of conformity referred to in Article 18.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_IdentifierCharacteristic" + }, + "declarationOfConformity" : { + "description" : "The EU Declaration of Conformity is a document in which the manufacturer or their authorized representative declares that the battery complies with all relevant European Union product safety directives and regulations. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1):\n(r) the EU declaration of conformity referred to in Article 18.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentList" + }, + "resultOfTestReport" : { + "description" : "The result of tests reports refers to the results of various tests conducted with the battery, testing its life cycle, life span, c-rate and various other aspects. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1):\n(l) temperature range the battery can withstand when not in use (reference test);\nand Annex XIII (3):\nresults of test reports proving compliance with the requirements laid down in this Regulation or any delegated or implementing act adopted pursuant to this Regulation.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentList" + }, + "thirdPartyAssurance" : { + "description" : "A summary report from third-parties, covering the verifications. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1) (d) refers to the Article 52:\n3. The economic operator referred to in Article 48(1) shall on an annual basis review and make publicly available, including on the internet, a report on its battery due diligence policy. [...], as well as a summary report of the third-party verifications carried out in accordance with Article 51, including the name of the notified body, with due regard for business confidentiality and other competitive concerns. That report shall also cover, where relevant, access to information, public participation in decision-making and access to justice in environmental matters in relation to the sourcing, processing and trading of the raw materials present in batteries.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentList" + }, + "dueDiligencePolicy" : { + "description" : "A report containing the information concerning the due diligence policy, a set of procedures and guidelines the organization follows to thoroughly assess and evaluate the various aspects of the battery. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1) (d) refers to the Article 52:\n3. The economic operator referred to in Article 48(1) shall on an annual basis review and make publicly available, including on the internet, a report on its battery due diligence policy. That report shall contain, in a manner that is easily comprehensible for end-users and clearly identifies the batteries concerned, the data and information on steps taken by that economic operator to comply with the requirements laid down in Articles 49 and 50, including findings of significant adverse impacts in the risk categories listed in point 2 of Annex X, and how they have been addressed, as well as a summary report of the third-party verifications carried out in accordance with Article 51, including the name of the notified body, with due regard for business confidentiality and other competitive concerns. That report shall also cover, where relevant, access to information, public participation in decision-making and access to justice in environmental matters in relation to the sourcing, processing and trading of the raw materials present in batteries.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentList" + } + }, + "required" : [ "declarationOfConformity", "resultOfTestReport", "thirdPartyAssurance", "dueDiligencePolicy" ] + }, + "urn_samm_io.catenax.battery.battery_pass_6.0.0_ExtinguishAgentEntity" : { + "description" : "Entity for the extinguish agents.", + "type" : "object", + "properties" : { + "document" : { + "description" : "Documentation about the extinguishing agent.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentList" + }, + "media" : { + "description" : "The agent used to extinguish a fire, based on the fire class. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1)(a) and refers to Annex VI Part A:\n9. usable extinguishing agent.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "fireClass" : { + "description" : "Safety classification based on the chemistry and construction of the battery. It determines the means of handling a fire caused by the battery. Possible values are A, B and C and a combination of these.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + } + }, + "required" : [ "media", "fireClass" ] + }, + "urn_samm_io.catenax.battery.battery_pass_6.0.0_ExtinguishAgentList" : { + "description" : "List of extinguish agents.", + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_ExtinguishAgentEntity" + } + }, + "urn_samm_io.catenax.battery.battery_pass_6.0.0_SafetyCharacteristic" : { + "description" : "Safety Characteristic for mostly safety documents.", + "type" : "object", + "properties" : { + "usableExtinguishAgent" : { + "description" : "The usable extinguish agents for the battery in case of a fire. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1)(a) and refers to Annex VI Part A\n9. usable extinguishing agent.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_ExtinguishAgentList" + }, + "safetyMeasures" : { + "description" : "Safety instruction in the form of a documentation. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (2):\n(d) safety measures.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentList" + }, + "meaningOfLabels" : { + "description" : "Documentation on the meaning of labels on a battery which provide information to help users understand the various symbols, markings, and information present on the battery's label. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1)(s) and refers to Article 74 (1):\n(e) the meaning of the labels and symbols on batteries in accordance with Article 13 or printed on their packaging or in the documents accompanying batteries [...].", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentList" + }, + "safeDischarging" : { + "description" : "Safe discharging documentation explaining for example the setting of a minimum voltage threshold for the battery. Discharging a battery below this threshold can lead to damage, reduced capacity, and safety hazards.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentList" + }, + "dismantling" : { + "description" : "Dismantling refers to the proper way of dismantling the battery itself. It refers to the process of taking apart the battery for various purposes, such as recycling, disposal, or examination of its components. This attribute is mentioned in the Battery Regulation 2023/1542 from 12 July 2023 in Annex XIII (2) (c) dismantling information, including at least:\n- exploded diagrams of the battery system/pack showing the location of battery cells,\n- disassembly sequences,\n- type and number of fastening techniques to be unlocked,\n- tools required for disassembly,\n- warnings if risk of damaging parts exist,\n- amount of cells used and layout.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentList" + }, + "removalFromAppliance" : { + "description" : "Removal refers to the proper process of disassembling a battery from an appliance, typically for purposes such as repairs, replacements, or disposal.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentList" + } + }, + "required" : [ "usableExtinguishAgent", "safetyMeasures", "meaningOfLabels", "dismantling" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_SourceCategoryEnumeration" : { + "type" : "string", + "description" : "The types of sources that can be linked in a digital product passport can vary depending on the nature of the product and the information that needs to be included. This is an enumeration of possible sources.", + "enum" : [ "Product Specifications", "Manufacturer Information", "User Manuals and Guides", "Certifications and Compliance", "Product Images and Videos", "Warranty Information", "Reviews and Ratings", "Product Variations", "Supply Chain Information", "Environmental Impact", "Compatibility and Accessories", "FAQs and Support", "Purchase and Retail Information", "Privacy and Data Handling", "Third-Party Integrations", "Legal Information", "Safety Information", "Repair and Installation", "Waste Generation and Prevention", "Specific Voluntary Labels", "Product Packaging", "Return and Disposal", "End of Life", "Material and Substance Information", "Technical Documentation", "Treatment facilities", "Other" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentEntity" : { + "description" : "Document entity with header, content, category and type.", + "type" : "object", + "properties" : { + "content" : { + "description" : "The content of the document e.g a link.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "category" : { + "description" : "The category in which the document can be sorted. These are mentioned in the ESPR proposal from March 30th, 2022 ANNEX III:\n(e) compliance documentation and information required under this Regulation or other Union law applicable to the product, such as the declaration of conformity, technical documentation or conformity certificates;\nANNEX IV states additional information regarding the content of the technical documentation\nFurther information on documents are mentioned in the proposal from March 30th, 2022 ANNEX III:\n(f) user manuals, instructions, warnings or safety information, as required by other Union legislation applicable to the product.\nAdditionally requirements are mentioned in Article 21:\n(7) Manufacturers shall ensure that that a product covered by a delegated act adopted pursuant to Article 4 is accompanied by instructions that enable consumers and other end-users to safely assemble, install, operate, store, maintain, repair and dispose of the product in a language that can be easily understood by consumers and other end-users, as determined by the Member State concerned. Such instructions shall be clear, understandable and legible and include at least the information specified in the delegated acts adopted pursuant to Article 4 and pursuant to Article 7(2)(b), point (ii).\nArticle 7 states additionally:\n(2) (b) (ii) information for consumers and other end-users on how to install, use, maintain and repair the product in order to minimize its impact on the environment and to ensure optimum durability, as well as on how to return or dispose of the product at end-of-life;\n(2) (b) (iii) information for treatment facilities on disassembly, recycling, or disposal at end-of-life;\n(2) (b) (iv) other information that may influence the way the product is handled by parties other than the manufacturer in order to improve performance in relation to product parameters referred to in Annex I.\n(5) (d) relevant instructions for the safe use of the product.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_SourceCategoryEnumeration" + }, + "type" : { + "description" : "The type of content which can be expected in the \"content\" property. Examples are a link, restricted link, pdf, excel, etc.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "header" : { + "description" : "The header as a short description of the document with a maximum of 100 characters.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_HeaderTrait" + } + }, + "required" : [ "content", "category", "type", "header" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_SourceList" : { + "description" : "A list of documents.", + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentEntity" + } + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_StatusEnumeration" : { + "type" : "string", + "description" : "The current status of the product passport declared through either: draft, approved, invalid or expired.", + "enum" : [ "draft", "approved", "invalid", "expired" ] + }, + "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_io.catenax.generic.digital_product_passport_5.0.0_MetadataCharacteristic" : { + "description" : "Characteristic for the passport metadata of the digital product passport.", + "type" : "object", + "properties" : { + "version" : { + "description" : "The current version of the product passport. The possibility of modification/ updating the product passport needs to include versioning of the dataset. This attribute is an internal versioning from the passport issuer. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Article 8:\n(1) [...] The information in the product passport shall be accurate, complete, and up to date.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "status" : { + "description" : "The current status of the product passport declared through either: draft, approved, invalid or expired.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_StatusEnumeration" + }, + "expirationDate" : { + "description" : "The timestamp in the format (yyyy-mm-dd) for the product passport until when it is available or a comment describing this period. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Article 8:\n(2) (h) the period during which the product passport is to remain available, which shall correspond to at least the expected lifetime of a specific product.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DateTrait" + }, + "issueDate" : { + "description" : "The timestamp in the format (yyyy-mm-dd) since when the product passport is available.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DateTrait" + }, + "economicOperatorId" : { + "description" : "The identification of the owner/economic operator of the passport. Proposed, according to ISO 15459, is the CIN (company identification code). Other identification numbers like the tax identification number, value added tax identification number, commercial register number and the like are also valid entries. In the Catena-X network, the BPNL is used for the identification of companies and the information stored like contact information and addresses. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Annex III:\n(k) the [...] unique operator identifier code of the economic operator established in the Union responsible for carrying out the tasks set out in Article 4 of Regulation (EU) 2019/1020, or Article 15 of Regulation (EU) on general product safety, or similar tasks pursuant to other EU legislation applicable to the product.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.business_partner_number_2.0.0_BpnlTrait" + }, + "passportIdentifier" : { + "description" : "The identifier of the product passport, which is an uuidv4.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.uuid_2.0.0_UuidV4Trait" + }, + "predecessor" : { + "description" : "Identification of the preceding product passport. If there is no preceding passport, input a dummy value. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Article 8:\n(2)(g) [...] Any new product passport shall be linked to the product passport or passports of the original product whenever appropriate.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.uuid_2.0.0_UuidV4Trait" + }, + "backupReference" : { + "description" : "A reference to the data backup of the passport. This mandatory attribute will be further defined in the future. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex III:\n(kb) the reference of the certified independent third-party product passport service provider hosting the back-up copy of the product passport.\nArticle 10 also mentions:\n(c) the data included in the product passport shall be stored by the economic operator responsible for its creation or by certified independent third-party product passport service providers authorised to act on their behalf.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "registrationIdentifier" : { + "description" : "Identifier in the respective registry. This will be further defined in the future. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 in Article 12:\nBy [2 years from entering into force of this Regulation], the Commission shall set up and manage a digital registry (\"the registry\") storing in a secure manner at least the unique product identifier, the unique operator identifier, the unique facility identifiers. In case of products intended to be placed under the customs procedure 'release for free circulation', the registry shall also store the product commodity code. The registry shall also store the batteries' unique identifiers referred to in Article 77(3) of Regulation (EU) 2023/1542.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_IdentifierCharacteristic" + }, + "lastModification" : { + "description" : "Date of the latest modification.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DateTrait" + } + }, + "required" : [ "version", "expirationDate", "issueDate", "economicOperatorId", "passportIdentifier", "predecessor", "backupReference" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_StringList" : { + "description" : "List of strings.", + "type" : "array", + "items" : { + "type" : "string" + } + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_CommercialCharacteristic" : { + "description" : "Commercial information of the product.", + "type" : "object", + "properties" : { + "placedOnMarket" : { + "description" : "The timestamp in the format (yyyy-mm-dd) with or without time zone when the product was put in the market.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DateTrait" + }, + "purpose" : { + "description" : "One or more intended industry/industries of the product described by the digital product passport. If exchanged via Catena-X, 'automotive ' is a must choice included in the list.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_StringList" + } + }, + "required" : [ "purpose" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_SourcesEntity" : { + "description" : "Entity for a possible spare part sources.", + "type" : "object", + "properties" : { + "id" : { + "description" : "The identifier of a spare part producer of the product. In the Catena-X network, the BPNL is used for the identification of companies and the information stored for this like contact information and addresses.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.business_partner_number_2.0.0_BpnlTrait" + } + }, + "required" : [ "id" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_SourcesList" : { + "description" : "List of possible spare part sources.", + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_SourcesEntity" + } + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PartsEntity" : { + "description" : "Possible spare parts of the product with identifiers and names.", + "type" : "object", + "properties" : { + "manufacturerPartId" : { + "description" : "Part ID as assigned by the manufacturer of the part. The part ID identifies the part in the manufacturer`s dataspace. The part ID references a specific version of a part. The version number must be included in the part ID if it is available. The part ID does not reference a specific instance of a part and must not be confused with the serial number.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.part_type_information_1.0.0_PartIdCharacteristic" + }, + "nameAtManufacturer" : { + "description" : "Name of the part as assigned by the manufacturer.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.part_type_information_1.0.0_PartNameCharacteristic" + } + }, + "required" : [ "manufacturerPartId", "nameAtManufacturer" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PartList" : { + "description" : "A list of possible spare parts of the product.", + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PartsEntity" + } + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_SparePart" : { + "description" : "Characteristic describing sources and spare parts.", + "type" : "object", + "properties" : { + "producer" : { + "description" : "Sources of possible spare parts.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_SourcesList" + }, + "sparePart" : { + "description" : "Possible spare parts of the product.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PartList" + } + }, + "required" : [ "producer", "sparePart" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_HandlingCharacteristic" : { + "description" : "Characteristic to describe aspects which are connected with the handling of the product.", + "type" : "object", + "properties" : { + "content" : { + "description" : "The list of spare parts available for the product from various suppliers.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_SparePart" + }, + "applicable" : { + "description" : "Check whether the connected attributes are applicable to the product. If it is not applicable (false), dummy data can be delivered.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Boolean" + } + }, + "required" : [ "content", "applicable" ] + } + } + }, + "properties" : { + "identification" : { + "description" : "Battery identification involves specific battery identifiers, including those assigned locally by the manufacturer. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1)(a) refers to AnnexVi PartA (2) refers to Article 38 (6):\nbattery batch number or serial number or product number or another element allowing their identification.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_IdentificationCharacteristic" + }, + "operation" : { + "description" : "General operation information includes details such as the manufacturer's identification and the date of production. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1) (a) and refers to ANNEX VI Part A which refers to Article 38:\n7. Manufacturers shall indicate on the battery their name, registered trade name or registered trade mark, their postal address, indicating a single contact point, and, if available, web and e-mail address. \nFrom Annex XIII (1) (a) and found in ANNEX VI Part A :\n3. the place of manufacture (geographical location of a battery manufacturing plant).\n4. the date of manufacture (month and year).", + "$ref" : "#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_OperationCharacteristic" + }, + "characteristics" : { + "description" : "Characteristics of the battery, such as the warranty and the physical dimensions.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_CharacteristicsElement" + }, + "sustainability" : { + "description" : "Sustainability includes information on the carbon footprint, sustainability documents and the status of the battery.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_SustainabilityCharacteristic" + }, + "materials" : { + "description" : "Chemical materials relevant for the composition of the battery. These include active, hazardous and critical materials.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_ChemicalMaterialCharacteristic" + }, + "performance" : { + "description" : "Performance attributes of the battery including rated and dynamic values.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_PerformanceCharacteristic" + }, + "conformity" : { + "description" : "Conformity documents for the battery passport.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_ConformityCharacteristic" + }, + "safety" : { + "description" : "Safety information on the battery. Included are the attributes safety measurements, meaning of labels, safe discharging and dismantling. These are all documents. Additionally information about usable extinguish agent can be provided.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_SafetyCharacteristic" + }, + "sources" : { + "description" : "Consider additional available sources to enhance the content of the battery passport.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_SourceList" + }, + "metadata" : { + "description" : "Metadata of the product passport. These are mentioned in the ESPR proposal from March 30th, 2022 and some changed by the provisional agreement from January 9th, 2024.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_MetadataCharacteristic" + }, + "commercial" : { + "description" : "Commercial information of the product.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_CommercialCharacteristic" + }, + "handling" : { + "description" : "Properties connected with the handling of the product.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_HandlingCharacteristic" + } + }, + "required" : [ "identification", "operation", "characteristics", "sustainability", "materials", "performance", "conformity", "safety", "metadata", "commercial", "handling" ] +} \ No newline at end of file diff --git a/io.catenax.battery.battery_pass/6.0.0/gen/BatteryPass.aasx b/io.catenax.battery.battery_pass/6.0.0/gen/BatteryPass.aasx new file mode 100644 index 000000000..e62f5356d Binary files /dev/null and b/io.catenax.battery.battery_pass/6.0.0/gen/BatteryPass.aasx differ diff --git a/io.catenax.battery.battery_pass/6.0.0/gen/BatteryPass.html b/io.catenax.battery.battery_pass/6.0.0/gen/BatteryPass.html new file mode 100644 index 000000000..d0d6e82d8 --- /dev/null +++ b/io.catenax.battery.battery_pass/6.0.0/gen/BatteryPass.html @@ -0,0 +1,17189 @@ + + + + + + + + + + + + + + Documentation Battery Passport + + +
+
+
+
+

Aspect Model Battery Passport

+
urn:samm:io.catenax.battery.battery_pass:6.0.0#BatteryPass
+
+
+
+
+
+
+
+ +
+ + +
+ The battery pass describes information collected during the lifecycle of a battery. The battery passport is heavily based on the Regulation (EU) 2023/1542 of the European Parliament and of the Council of 12 July 2023 concerning batteries and waste batteries, amending Directive 2008/98/EC and Regulation (EU) 2019/1020 and repealing Directive 2006/66/EC. +Additionally attributes come from the Proposal for Ecodesign for Sustainable Products Regulation. +
+ + +
+

Overview

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

Properties

+
+ +
+ +
+

Characteristics

+
+ +Characteristics of the battery, such as the warranty and the physical dimensions. + +
+
Name
+
characteristics
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.battery.battery_pass:6.0.0#CharacteristicsEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
characteristics
+
+ + +
+
+ +
+

Commercial

+
+ +Commercial information of the product. + +
+
Name
+
commercial
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#CommercialEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
commercial
+
+ + +
+
+ +
+

Conformity

+
+ +Conformity documents for the battery passport. + +
+
Name
+
conformity
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.battery.battery_pass:6.0.0#ConformityEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
conformity
+
+ + +
+
+ +
+

Identification

+
+ +Battery identification involves specific battery identifiers, including those assigned locally by the manufacturer. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1)(a) refers to AnnexVi PartA (2) refers to Article 38 (6): +battery batch number or serial number or product number or another element allowing their identification. + +
+
Name
+
identification
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.battery.battery_pass:6.0.0#IdentificationEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
identification
+
+ + +
+
+ +
+

Materials

+
+ +Chemical materials relevant for the composition of the battery. These include active, hazardous and critical materials. + +
+
Name
+
materials
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.battery.battery_pass:6.0.0#ChemicalMaterialEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
materials
+
+ + +
+
+ +
+

Metadata

+
+ +Metadata of the product passport. These are mentioned in the ESPR proposal from March 30th, 2022 and some changed by the provisional agreement from January 9th, 2024. + +
+
Name
+
metadata
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#MetadataEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
metadata
+
+ + +
+
+ +
+

Operation

+
+ +General operation information includes details such as the manufacturer's identification and the date of production. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1) (a) and refers to ANNEX VI Part A which refers to Article 38: +7. Manufacturers shall indicate on the battery their name, registered trade name or registered trade mark, their postal address, indicating a single contact point, and, if available, web and e-mail address. +From Annex XIII (1) (a) and found in ANNEX VI Part A : +3. the place of manufacture (geographical location of a battery manufacturing plant). +4. the date of manufacture (month and year). + +
+
Name
+
operation
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.battery.battery_pass:6.0.0#OperationEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
operation
+
+ + +
+
+ +
+

Performance

+
+ +Performance attributes of the battery including rated and dynamic values. + +
+
Name
+
performance
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.battery.battery_pass:6.0.0#PerformanceEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
performance
+
+ + +
+
+ +
+

Safety

+
+ +Safety information on the battery. Included are the attributes safety measurements, meaning of labels, safe discharging and dismantling. These are all documents. Additionally information about usable extinguish agent can be provided. + +
+
Name
+
safety
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.battery.battery_pass:6.0.0#SafetyEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
safety
+
+ + +
+
+ +
+

Sources

+
+ +Consider additional available sources to enhance the content of the battery passport. + +
+
Name
+
sources
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#DocumentEntity + +
+
+
+
+
+ + +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
sources
+
+ + +
+
+ +
+

Sustainability

+
+ +Sustainability includes information on the carbon footprint, sustainability documents and the status of the battery. + +
+
Name
+
sustainability
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.battery.battery_pass:6.0.0#SustainabilityEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
sustainability
+
+ + +
+
+ +
+

handling

+
+ +Properties connected with the handling of the product. + +
+
Name
+
handling
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#HandlingEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
handling
+
+ + +
+
+ + + +
+
+

Entities

+
+ +
+
+

Active Material Entity

+
+
+ Entity for the active materials included in the battery. Mandatory are nickel, lithium, cobalt and lead. +
+ +
+

Properties

+
+
+ +
+
Nickel
+
+ +Information about the percentage of recovered nickel from waste. These attribute are mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1)(e) refers to Article 8: +1. From 18 August 2028 or 24 months after the date of entry into force of the delegated act referred to in the third subparagraph, whichever is the latest, industrial batteries with a capacity greater than 2 kWh, except those with exclusively external storage, electric vehicle batteries and SLI batteries that contain cobalt, lead, lithium or nickel in active materials, shall be accompanied by documentation containing information about the percentage share of cobalt, lithium or nickel that is present in active materials and that has been recovered from battery manufacturing waste or post-consumer waste, and the percentage share of lead that is present in the battery and that has been recovered from waste, for each battery model per year and per manufacturing plant. + +
+
Name
+
nickel
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.battery.battery_pass:6.0.0#MaterialActiveEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
nickel
+
+ + +
+
+ +
+
Lithium
+
+ +Information about the percentage of recovered lithium from waste. These attribute are mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1)(e) refers to Article 8: +1. From 18 August 2028 or 24 months after the date of entry into force of the delegated act referred to in the third subparagraph, whichever is the latest, industrial batteries with a capacity greater than 2 kWh, except those with exclusively external storage, electric vehicle batteries and SLI batteries that contain cobalt, lead, lithium or nickel in active materials, shall be accompanied by documentation containing information about the percentage share of cobalt, lithium or nickel that is present in active materials and that has been recovered from battery manufacturing waste or post-consumer waste, and the percentage share of lead that is present in the battery and that has been recovered from waste, for each battery model per year and per manufacturing plant. + +
+
Name
+
lithium
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.battery.battery_pass:6.0.0#MaterialActiveEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
lithium
+
+ + +
+
+ +
+
Cobalt
+
+ +Information about the percentage of recovered cobalt from waste. These attribute are mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1)(e) refers to Article 8: +1. From 18 August 2028 or 24 months after the date of entry into force of the delegated act referred to in the third subparagraph, whichever is the latest, industrial batteries with a capacity greater than 2 kWh, except those with exclusively external storage, electric vehicle batteries and SLI batteries that contain cobalt, lead, lithium or nickel in active materials, shall be accompanied by documentation containing information about the percentage share of cobalt, lithium or nickel that is present in active materials and that has been recovered from battery manufacturing waste or post-consumer waste, and the percentage share of lead that is present in the battery and that has been recovered from waste, for each battery model per year and per manufacturing plant. + +
+
Name
+
cobalt
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.battery.battery_pass:6.0.0#MaterialActiveEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
cobalt
+
+ + +
+
+ +
+
Lead
+
+ +Information about the lead in the battery. As this is an active and hazardous material, all properties for hazardous as well as active materials are required. These attribute are mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1)(e) refers to Article 8: +1. From 18 August 2028 or 24 months after the date of entry into force of the delegated act referred to in the third subparagraph, whichever is the latest, industrial batteries with a capacity greater than 2 kWh, except those with exclusively external storage, electric vehicle batteries and SLI batteries that contain cobalt, lead, lithium or nickel in active materials, shall be accompanied by documentation containing information about the percentage share of cobalt, lithium or nickel that is present in active materials and that has been recovered from battery manufacturing waste or post-consumer waste, and the percentage share of lead that is present in the battery and that has been recovered from waste, for each battery model per year and per manufacturing plant. +And for hazardous materials this is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1) (a) refers to Annex VI Part A: +8. the hazardous substances present in the battery, other than mercury, cadmium or lead; +Additionally in Article 13: +5. All batteries containing more than 0,002 % cadmium or more than 0,004 % lead, shall be marked with the chemical symbol for the metal concerned: Cd or Pb. +Defined in Article 3: +(52) "hazardous substance" means a substance classified as hazardous pursuant to Article 3 of Regulation (EC) No 1272/2008. + +
+
Name
+
lead
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.battery.battery_pass:6.0.0#LeadEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
lead
+
+ + +
+
+ +
+
Other Active Materials
+
+ +Other active materials in the battery. + +
+
Name
+
otherActiveMaterials
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.battery.battery_pass:6.0.0#OtherActiveMaterialsEntity + +
+
+
+
+
+ + +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
other
+
+ + +
+
+
+
+

Capacity Entity

+
+
+ Entity for dynamic capacity values such as the throughput and the remaining capacity. +
+ +
+

Properties

+
+
+ +
+
Data Record Time
+
+ +The entry date and time corresponding to when a specific parameter was measured. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (4): +(d) information and data resulting from its use, including the number of charging and discharging cycles and negative events, such as accidents, as well as periodically recorded information on the operating environmental conditions, including temperature, and on the state of charge. + +
+
Name
+
dataRecordTime
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#dateTime + +
+
+
+
+
+ +
+
Example
+
2023-12-07T10:39:13.576+01:00
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
time
+
+ + +
+
+ +
+
Capacity Value
+
+ +Value describing the capacity in a specific measurement period, expressed in ampere-hours. + +
+
Name
+
capacityValue
+
+ + + +
+
Characteristic
+
+
+
+
Measurement
+
+
+
Measurement for the capacity expressed in ampere hours as double.
+
+
+
Unit
+
+
+
+
    +
  • + ampere hour +
    • +
  • + Symbol A·h +
    • +
  • + Code AMH +
    • +
  • + Conversion factor 3.6 × 10³ C +
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#double + +
+
+
+
+
+ +
+
Example
+
4.0
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
value
+
+ + +
+
+
+
+

Characteristics Entity

+
+
+ Entity for the product characteristics. +
+ +
+

Properties

+
+
+ +
+
Warranty
+
+ +The warranty of the battery. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in ANNEX XIII: +(m) period for which the commercial warranty for the calendar life applies. + +
+
Name
+
warranty
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.battery.battery_pass:6.0.0#WarrantyEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
warranty
+
+ + +
+
+ +
+
Physical Dimension
+
+ +The weight of the battery. For calculation of the energy density, the volume is also needed. The energy density of a battery is measured in watt-hours per kilogram (Wh/kg) and watt-hours per liter (Wh/L). These measures indicate how much energy a battery can store relative to its weight and volume, respectively. Other measurements are optional.These are mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1)(a) and refers to Annex VI Part A: +5. the weight. + +
+
Name
+
physicalDimension
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.battery.battery_pass:6.0.0#PhysicalDimensionEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
physicalDimension
+
+ + +
+
+
+
+

Chemical Material Entity

+
+
+ Chemical Material Entity for the battery. Included are active, hazardous and critical materials as well as a material symbol. This is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Article 13: +5. All batteries containing more than 0,002 % cadmium or more than 0,004 % lead, shall be marked with the chemical symbol for the metal concerned: Cd or Pb. +
+ +
+

Properties

+
+
+ +
+
Active Materials
+
+ +The active materials included in the battery. Mandatory are nickel, lithium, cobalt and lead. Others are optional. Defined by the Battery regulation 2023/1542 from 12 July 2023 in Article 3 Definitions: +(5) ‘active material’ means a material which reacts chemically to produce electric energy when the battery cell discharges or to store electric energy when the battery is being charged. + +
+
Name
+
activeMaterials
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.battery.battery_pass:6.0.0#ActiveMaterialEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
active
+
+ + +
+
+ +
+
Hazardous Substance
+
+ +Hazardous substances like lead, cadmium and mercury. + +
+
Name
+
hazardousSubstance
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.battery.battery_pass:6.0.0#HazardousSubstanceEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
hazardous
+
+ + +
+
+ +
+
Material Composition
+
+ +The materials which are necessary to describe the material composition, especially if they are active, critical or hazardous. This can be redundant to the specifically mentioned active or hazardous materials. This is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1): +(b) the material composition of the battery, including its chemistry, hazardous substances present in the battery, other than mercury, cadmium or lead, and critical raw materials present in the battery; +(f) the share of renewable content. +and in Annex XIII (2): +(a) detailed composition, including materials used in the cathode, anode and electrolyte; +Definition from Article 3: +(52) "hazardous substance" means a substance classified as hazardous pursuant to Article 3 of Regulation (EC) No 1272/2008: +A substance or a mixture fulfilling the criteria relating to physical hazards, health hazards or environmental hazards, laid down in Parts 2 to 5 of Annex I is hazardous and shall be classified in relation to the respective hazard classes provided for in that Annex. +Where, in Annex I, hazard classes are differentiated on the basis of the route of exposure or the nature of the effects, the substance or mixture shall be classified in accordance with such differentiation. +Defined in Article 2 of Regulation (EC) No 1272/2008: +1. hazard class" means the nature of the physical, health or environmental hazard. + +
+
Name
+
materialComposition
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.battery.battery_pass:6.0.0#MaterialCompositionEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
composition
+
+ + +
+
+
+
+

ClassificationEntity

+
+
+ Encapsulates data related to the classification of the part. +
+ +
+

Properties

+
+
+ +
+
Classification Standard
+
+ +Identified classification standards that align to the Catena-X needs. + +
+
Name
+
classificationStandard
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
GIN 20510-21513
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
classificationStandard
+
+ + +
+
+ +
+
Classification ID
+
+ +The classification ID of the part type according to the corresponding standard definition mentioned in the key value pair. + +
+
Name
+
classificationID
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
1004712
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
classificationID
+
+ + +
+
+ +
+
Classification Description
+
+ +Optional property describing the classification standard. + +
+
Name
+
classificationDescription
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Generic standard for classification of parts in the automotive industry.
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
classificationDescription
+
+ + +
+
+
+
+

Code Entity

+
+
+ Code entity with code key and value. +
+ +
+

Properties

+
+
+ +
+
Code Key
+
+ +The code key for the identification of the product. Examples are GTIN, hash, DID, ISBN, TARIC. This attribute is mentioned in the ESPR proposal from March 30th, 2022 ANNEX III: +(b) the unique product identifier at the level indicated in the applicable delegated act adopted pursuant to Article 4; +(c) the Global Trade Identification Number as provided for in standard ISO/IEC 15459-6 or equivalent of products or their parts; +(d) relevant commodity codes, such as a TARIC code as defined in Council Regulation (EEC) No 2658/87. + +
+
Name
+
codeKey
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
TARIC
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
key
+
+ + +
+
+ +
+
Code Value
+
+ +The code value for the identification of the product in regard to the chosen code name. + +
+
Name
+
codeValue
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
8703 24 10 00
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
value
+
+ + +
+
+
+
+

Commercial Entity

+
+
+ Commercial information. +
+ +
+

Properties

+
+
+ +
+
Placed on Market
+
+ +The timestamp in the format (yyyy-mm-dd) with or without time zone when the product was put in the market. + +
+
Name
+
placedOnMarket
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
2000-01-01
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
placedOnMarket
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + Date Constraint +
    + +
    +
    Description
    +
    Constraint fo a timestamp in the format (yyyy-mm-dd).
    +
    + + +
    +
    Regular expression
    +
    ^\d{4}-\d{2}-\d{2}$
    +
    + +
    • +
+
+
+
+
+ +
+
Purpose
+
+ +One or more intended industry/industries of the product described by the digital product passport. If exchanged via Catena-X, 'automotive ' is a must choice included in the list. + +
+
Name
+
purpose
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
automotive
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
purpose
+
+ + +
+
+
+
+

Conformity Entity

+
+
+ Entity for conformity documents. +
+ +
+

Properties

+
+
+ +
+
Declaration of Conformity Id
+
+ +Identification number of the EU declaration of conformity. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1): +(r) the EU declaration of conformity referred to in Article 18. + +
+
Name
+
declarationOfConformityId
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
0978234-34567890-01
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
declarationOfConformityId
+
+ + +
+
+ +
+
Declaration of Conformity
+
+ +The EU Declaration of Conformity is a document in which the manufacturer or their authorized representative declares that the battery complies with all relevant European Union product safety directives and regulations. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1): +(r) the EU declaration of conformity referred to in Article 18. + +
+
Name
+
declarationOfConformity
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#DocumentationEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
declarationOfConformity
+
+ + +
+
+ +
+
Result of Test Report
+
+ +The result of tests reports refers to the results of various tests conducted with the battery, testing its life cycle, life span, c-rate and various other aspects. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1): +(l) temperature range the battery can withstand when not in use (reference test); +and Annex XIII (3): +results of test reports proving compliance with the requirements laid down in this Regulation or any delegated or implementing act adopted pursuant to this Regulation. + +
+
Name
+
resultOfTestReport
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#DocumentationEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
resultOfTestReport
+
+ + +
+
+ +
+
Third Party Assurance
+
+ +A summary report from third-parties, covering the verifications. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1) (d) refers to the Article 52: +3. The economic operator referred to in Article 48(1) shall on an annual basis review and make publicly available, including on the internet, a report on its battery due diligence policy. [...], as well as a summary report of the third-party verifications carried out in accordance with Article 51, including the name of the notified body, with due regard for business confidentiality and other competitive concerns. That report shall also cover, where relevant, access to information, public participation in decision-making and access to justice in environmental matters in relation to the sourcing, processing and trading of the raw materials present in batteries. + +
+
Name
+
thirdPartyAssurance
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#DocumentationEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
thirdPartyAssurance
+
+ + +
+
+ +
+
Due Diligence Policy
+
+ +A report containing the information concerning the due diligence policy, a set of procedures and guidelines the organization follows to thoroughly assess and evaluate the various aspects of the battery. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1) (d) refers to the Article 52: +3. The economic operator referred to in Article 48(1) shall on an annual basis review and make publicly available, including on the internet, a report on its battery due diligence policy. That report shall contain, in a manner that is easily comprehensible for end-users and clearly identifies the batteries concerned, the data and information on steps taken by that economic operator to comply with the requirements laid down in Articles 49 and 50, including findings of significant adverse impacts in the risk categories listed in point 2 of Annex X, and how they have been addressed, as well as a summary report of the third-party verifications carried out in accordance with Article 51, including the name of the notified body, with due regard for business confidentiality and other competitive concerns. That report shall also cover, where relevant, access to information, public participation in decision-making and access to justice in environmental matters in relation to the sourcing, processing and trading of the raw materials present in batteries. + +
+
Name
+
dueDiligencePolicy
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#DocumentationEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
dueDiligencePolicy
+
+ + +
+
+
+
+

Cycle Life Entity

+
+
+ Cycle Life Characteristic for the battery lifetime testing with the cycles, temperature, depth of discharge and applied c-rates. +
+ +
+

Properties

+
+
+ +
+
Testing Temperature
+
+ +Temperature refers to the temperature of the battery during it's cycle-life testing or as boundary condition for other rated values in celsius. + +
+
Name
+
testingTemperature
+
+ + + +
+
Characteristic
+
+
+
+
Measurement
+
+
+
Degree measurement in celsius.
+
+
+
Unit
+
+
+
+
    +
  • + degree Celsius +
    • +
  • + Symbol °C +
    • +
  • + Code CEL +
    • +
  • + Conversion factor 1 × K +
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#double + +
+
+
+
+
+ +
+
Example
+
20.0
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
temperature
+
+ + +
+
+ +
+
Cycles
+
+ +Cycle refers to one complete charging and discharging sequence. Either during the battery's cycle-life testing or as full equivalent while in use. + +
+
Name
+
cycles
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#integer + +
+
+
+
+
+ +
+
Example
+
1500
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
cycles
+
+ + +
+
+ +
+
Depth of Discharge
+
+ +Depth of discharge is a measure used to quantify the extent to which the battery has been discharged relative to its maximum capacity during its cycle-life testing. It represents the percentage of the total available capacity that has been drained or used during a particular discharge cycle. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (4) (a) refers to Article 10 (1), refers to Annex IV Part B: +3. Depth of discharge in the cycle-life test. + +
+
Name
+
depthOfDischarge
+
+ + + +
+
Characteristic
+
+
+
+
Measurement
+
+
+
Measurement in percent as double.
+
+
+
Unit
+
+
+
+
    +
  • + percent +
    • +
  • + Symbol % +
    • +
  • + Code P1 +
    • +
  • + Conversion factor 1 × 10⁻² +
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#double + +
+
+
+
+
+ +
+
Example
+
90.5
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
depthOfDischarge
+
+ + +
+
+ +
+
Applied Charge Rate
+
+ +The applied charge rate (c rate) refers to the rate at which a battery is charged. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1): +(p) c-rate of relevant cycle-life test; +and Annex XIII (4)(a) refers to Article 10(1) refers to Annex IV Part B: +1. Applied discharge rate and charge rate. + +
+
Name
+
appliedChargeRate
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#double + +
+
+
+
+
+ +
+
Example
+
3.0
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
appliedChargeRate
+
+ + +
+
+ +
+
Applied Discharge Rate
+
+ +The applied discharge rate (c rate) refers to the rate at which a battery is discharged. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1): +(p) c-rate of relevant cycle-life test; +and Annex XIII (4)(a) refers to Article 10(1) refers to Annex IV Part B: +1. Applied discharge rate and charge rate. + +
+
Name
+
appliedDischargeRate
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#double + +
+
+
+
+
+ +
+
Example
+
4.0
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
appliedDischargeRate
+
+ + +
+
+
+
+

Data Carrier Entity

+
+
+ Data Carrier Entity with type and layout of the data carrier. +
+ +
+

Properties

+
+
+ +
+
Carrier Type
+
+ +The type of data carrier such as a QR code on the product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 8: +(2) (b) the types of data carrier to be used. + +
+
Name
+
carrierType
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
QR
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
carrierType
+
+ + +
+
+ +
+
Carrier Layout
+
+ +The positioning of data carrier on the product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 8: +(2) (c) the layout in which the data carrier shall be presented and its positioning. + +
+
Name
+
carrierLayout
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
upper-left side
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
carrierLayout
+
+ + +
+
+
+
+

Document Entity

+
+
+ Document entity with header, content, category and type. +
+ +
+

Properties

+
+
+ +
+
Content
+
+ +The content of the document e.g a link. + +
+
Name
+
content
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
https://dummy.link
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
content
+
+ + +
+
+ +
+
Category
+
+ +The category in which the document can be sorted. These are mentioned in the ESPR proposal from March 30th, 2022 ANNEX III: +(e) compliance documentation and information required under this Regulation or other Union law applicable to the product, such as the declaration of conformity, technical documentation or conformity certificates; +ANNEX IV states additional information regarding the content of the technical documentation +Further information on documents are mentioned in the proposal from March 30th, 2022 ANNEX III: +(f) user manuals, instructions, warnings or safety information, as required by other Union legislation applicable to the product. +Additionally requirements are mentioned in Article 21: +(7) Manufacturers shall ensure that that a product covered by a delegated act adopted pursuant to Article 4 is accompanied by instructions that enable consumers and other end-users to safely assemble, install, operate, store, maintain, repair and dispose of the product in a language that can be easily understood by consumers and other end-users, as determined by the Member State concerned. Such instructions shall be clear, understandable and legible and include at least the information specified in the delegated acts adopted pursuant to Article 4 and pursuant to Article 7(2)(b), point (ii). +Article 7 states additionally: +(2) (b) (ii) information for consumers and other end-users on how to install, use, maintain and repair the product in order to minimize its impact on the environment and to ensure optimum durability, as well as on how to return or dispose of the product at end-of-life; +(2) (b) (iii) information for treatment facilities on disassembly, recycling, or disposal at end-of-life; +(2) (b) (iv) other information that may influence the way the product is handled by parties other than the manufacturer in order to improve performance in relation to product parameters referred to in Annex I. +(5) (d) relevant instructions for the safe use of the product. + +
+
Name
+
category
+
+ + + +
+
Characteristic
+
+
+
+
Enumeration
+
+
+
Values
+
+
+
+
    +
  • Product Specifications
    • +
  • Manufacturer Information
    • +
  • User Manuals and Guides
    • +
  • Certifications and Compliance
    • +
  • Product Images and Videos
    • +
  • Warranty Information
    • +
  • Reviews and Ratings
    • +
  • Product Variations
    • +
  • Supply Chain Information
    • +
  • Environmental Impact
    • +
  • Compatibility and Accessories
    • +
  • FAQs and Support
    • +
  • Purchase and Retail Information
    • +
  • Privacy and Data Handling
    • +
  • Third-Party Integrations
    • +
  • Legal Information
    • +
  • Safety Information
    • +
  • Repair and Installation
    • +
  • Waste Generation and Prevention
    • +
  • Specific Voluntary Labels
    • +
  • Product Packaging
    • +
  • Return and Disposal
    • +
  • End of Life
    • +
  • Material and Substance Information
    • +
  • Technical Documentation
    • +
  • Treatment facilities
    • +
  • Other
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Legal Information
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
category
+
+ + +
+
+ +
+
Content Type
+
+ +The type of content which can be expected in the "content" property. Examples are a link, restricted link, pdf, excel, etc. + +
+
Name
+
contentType
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
URL
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
type
+
+ + +
+
+ +
+
Header
+
+ +The header as a short description of the document with a maximum of 100 characters. + +
+
Name
+
header
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Example Document XYZ
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
header
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + Header Constraint +
    + +
    +
    Description
    +
    Constraint for a maximum of 100 characters.
    +
    + + +
    +
    Max. length
    +
    100
    +
    + +
    • +
+
+
+
+
+
+
+

Documentation Entity

+
+
+ Entity for a document with a header, type and content. +
+ +
+

Properties

+
+
+ +
+
Content
+
+ +The content of the document e.g a link. + +
+
Name
+
content
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
https://dummy.link
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
content
+
+ + +
+
+ +
+
Content Type
+
+ +The type of content which can be expected in the "content" property. Examples are a link, restricted link, pdf, excel, etc. + +
+
Name
+
contentType
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
URL
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
contentType
+
+ + +
+
+ +
+
Header
+
+ +The header as a short description of the document with a maximum of 100 characters. + +
+
Name
+
header
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Example Document XYZ
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
header
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + Header Constraint +
    + +
    +
    Description
    +
    Constraint for a maximum of 100 characters.
    +
    + + +
    +
    Max. length
    +
    100
    +
    + +
    • +
+
+
+
+
+
+
+

Dynamic Capacity Entity

+
+
+ Entity for dynamic capacity values. +
+ +
+

Properties

+
+
+ +
+
Capacity Fade
+
+ +Capacity fade refers to a reduction in the capacity of the battery system over time expressed as a percentage in reference to the initial value. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (4)(a) refers to Article 10(1) and refer to Annex IV Part A: +1. Rated capacity (in Ah) and capacity fade (in %). +Definition from Annex IV: +(2) "Capacity fade" means the decrease over time and upon usage in the amount of charge that a battery can deliver at the rated voltage, with respect to the original rated capacity. + +
+
Name
+
capacityFade
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.battery.battery_pass:6.0.0#RecordEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
fade
+
+ + +
+
+ +
+
Capacity Throughput
+
+ +Capacity throughput refers to the total amount of energy that a battery has delivered over its lifetime. It represents the cumulative energy discharge and recharge cycles a battery has undergone. Capacity throughput is expressed in ampere-hours. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex VII Part B: +3. the capacity throughput. + +
+
Name
+
capacityThroughput
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.battery.battery_pass:6.0.0#CapacityEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
throughput
+
+ + +
+
+ +
+
Remaining Capacity
+
+ +The remaining capacity in the battery expressed in ampere hours. This attribute is mentioned in the Battery Regulation 2023/1542 from 12 July 2023 in Annex XIII (4) (b) refers to Article 14, refers to Annex VII Part A: +1. the remaining capacity. + + +
+
Name
+
remainingCapacity
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.battery.battery_pass:6.0.0#CapacityEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
capacity
+
+ + +
+
+
+
+

Dynamic Energy Entity

+
+
+ Entity for dynamic energy values. +
+ +
+

Properties

+
+
+ +
+
SOCE
+
+ +The state of certified energy (SOCE) refers to the current measured or on-board usable battery energy (UBE) performance expressed as a percentage. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (4)(b) refers to Article 14) and refers to Annex VII Part A: +state of certified energy (SOCE). + +
+
Name
+
soce
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.battery.battery_pass:6.0.0#RecordEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
soce
+
+ + +
+
+ +
+
Remaining Energy
+
+ +The remaining energy in the battery expressed in kilowatt-hours. + +
+
Name
+
remainingEnergy
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.battery.battery_pass:6.0.0#EnergyEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
remaining
+
+ + +
+
+ +
+
Energy Throughput
+
+ +Energy throughput refers to the total amount of energy that passes through a system over a specific period. This measure encompasses both the energy input (during charging) and the energy output (during discharging). Energy throughput is expressed in kilowatt-hours. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex VII Part B: +2. the energy throughput. + +
+
Name
+
energyThroughput
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.battery.battery_pass:6.0.0#EnergyEntity + +
+
+
+
+
+ + +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
throughput
+
+ + +
+
+
+
+

Dynamic Internal Resistance Entity

+
+
+ Entity for dynamic internal resistance values. +
+ +
+

Properties

+
+
+ +
+
Resistance Increase
+
+ +The increase as percentage in the battery resistance on the level of the pack, module (optional) and cell. + +
+
Name
+
resistanceIncrease
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.battery.battery_pass:6.0.0#ResistanceIncreaseEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
increase
+
+ + +
+
+ +
+
Remaining Resistance
+
+ +The remaining resistance in ohms in the battery on the level of the pack, module (optional) and cell. + +
+
Name
+
remainingResistance
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.battery.battery_pass:6.0.0#RemainingResistanceEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
remaining
+
+ + +
+
+
+
+

Dynamic Performance Entity

+
+
+ Entity for dynamic performance values of the battery. +
+ +
+

Properties

+
+
+ +
+
State of Charge
+
+ +State of Charge (SOC) refers to the amount of energy remaining in a battery at a given point in time, expressed as a percentage of the total capacity. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (4): +(d) information and data resulting from its use, including the number of charging and discharging cycles and negative events, such as accidents, as well as periodically recorded information on the operating environmental conditions, including temperature, and on the state of charge. + +
+
Name
+
stateOfCharge
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.battery.battery_pass:6.0.0#RecordEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
stateOfCharge
+
+ + +
+
+ +
+
Full Cycles
+
+ +Full cycles include the cumulative and equivalent count of complete charge and discharge cycles experienced by the battery over its entire life. This attribute is mentioned in the Battery Regulation 2023/1542 from 12 July 2023 in Annex XIII (4) (d) information and data resulting from its use, including the number of charging and discharging cycles and negative events, such as accidents, as well as periodically recorded information on the operating environmental conditions, including temperature, and on the state of charge. +And in AnnexVII Part B: +5. the number of full equivalent charge-discharge cycles. + +
+
Name
+
fullCycles
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.battery.battery_pass:6.0.0#FullCycleEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
fullCycles
+
+ + +
+
+ +
+
Performance Document
+
+ +The performance document lists information regarding the performance of the battery. This can be an overview about several rated performance attributes. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (3): +[...] results of test reports proving compliance with the requirements laid down in this Regulation or any delegated or implementing act adopted pursuant to this Regulation. +And Annex XIII (4)(a) refers to Article 10(1) and refer to Annex IV Part B: +5. Any calculations performed with the measured parameters, if applicable. + +
+
Name
+
performanceDocument
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#DocumentationEntity + +
+
+
+
+
+ + +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
performanceDocument
+
+ + +
+
+ +
+
Self Discharging Rate
+
+ +The self-discharge rate of a battery refers to the rate at which the battery loses its stored energy when not in use. It's the discharge of the battery that occurs internally without any external load recorded in percentage for every month. This attribute is mentioned in the Battery Regulation 2023/1542 from 12 July 2023 in Annex XIII (4) (b) refers to Article 14, refers to Annex VII Part A: +4. the evolution of self-discharging rates. + +
+
Name
+
selfDischargingRate
+
+ + + +
+
Characteristic
+
+
+
+
Measurement
+
+
+
Measurement in percent as double.
+
+
+
Unit
+
+
+
+
    +
  • + percent +
    • +
  • + Symbol % +
    • +
  • + Code P1 +
    • +
  • + Conversion factor 1 × 10⁻² +
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#double + +
+
+
+
+
+ +
+
Example
+
0.25
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
selfDischargingRate
+
+ + +
+
+ +
+
Dynamic Power
+
+ +Values that describe dynamically captured power values. + +
+
Name
+
dynamicPower
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.battery.battery_pass:6.0.0#DynamicPowerEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
power
+
+ + +
+
+ +
+
Dynamic Capacity
+
+ +Values that describe dynamically captured capacity values. + +
+
Name
+
dynamicCapacity
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.battery.battery_pass:6.0.0#DynamicCapacityEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
capacity
+
+ + +
+
+ +
+
Dynamic Round Trip Efficiency
+
+ +Dynamic round trip efficiency values. + +
+
Name
+
dynamicRoundTripEfficiency
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.battery.battery_pass:6.0.0#DynamicRoundTripEfficiencyEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
roundTripEfficiency
+
+ + +
+
+ +
+
Dynamic Internal Resistance
+
+ +Values that describe dynamically captured internal resistance values. + +
+
Name
+
dynamicInternalResistance
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.battery.battery_pass:6.0.0#DynamicInternalResistanceEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
resistance
+
+ + +
+
+ +
+
Dynamic Energy
+
+ +Values that describe dynamically captured energy values. + +
+
Name
+
dynamicEnergy
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.battery.battery_pass:6.0.0#DynamicEnergyEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
energy
+
+ + +
+
+ +
+
Negative Events
+
+ +Mandatory if applicable. Negative events refers to several possible events influencing the battery's condition and lifetime such as extreme temperatures. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (4): +(d) information and data resulting from its use, including the number of charging and discharging cycles and negative events, such as accidents, as well as periodically recorded information on the operating environmental conditions, including temperature, and on the state of charge. +And Annex VII Part B: +4. the tracking of harmful events, such as the number of deep discharge events, time spent in extreme temperatures, time spent charging in extreme temperatures. + +
+
Name
+
negativeEvents
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#DocumentationEntity + +
+
+
+
+
+ + +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
negativeEvents
+
+ + +
+
+ +
+
Operating Environment
+
+ +Mandatory if applicable. The operating environment refers to the conditions in which the battery is designed to function optimally. The environment includes factors such as temperature, humidity, pressure, and other external conditions that can impact the performance, safety, and lifespan of the battery. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (4): +(d) information and data resulting from its use, including the number of charging and discharging cycles and negative events, such as accidents, as well as periodically recorded information on the operating environmental conditions, including temperature, and on the state of charge. +And Annex VII Part B: +4. the tracking of harmful events, such as the number of deep discharge events, time spent in extreme temperatures, time spent charging in extreme temperatures. + +
+
Name
+
operatingEnvironment
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#DocumentationEntity + +
+
+
+
+
+ + +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
operatingEnvironment
+
+ + +
+
+
+
+

Dynamic Power Entity

+
+
+ Entity for dynamic power values. +
+ +
+

Properties

+
+
+ +
+
PowerFade
+
+ +Power fade refers to a reduction in the power of the battery system over time expressed as a percentage in reference to the initial value. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (4)(a) refers to Article 10 (1), refers to Annex IV Part A: +2. Power (in W) and power fade (in %). +Definition from Annex IV: +(4) "Power fade" means the decrease over time and upon usage in the amount of power that a battery can deliver at the rated voltage. + +
+
Name
+
powerFade
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.battery.battery_pass:6.0.0#RecordEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
fade
+
+ + +
+
+ +
+
Remaining Power
+
+ +The remaining power capability in the battery expressed in watt. This attribute is mentioned in the Battery Regulation 2023/1542 from 12 July 2023 in Annex XIII (4) (b) refers to Article 14, refers to Annex VII Part A: +2. where possible, the remaining power capability; +Definition from Annex IV: +(3) "Power" means the amount of energy that a battery is capable of providing over a given period under reference +conditions. + +
+
Name
+
remainingPower
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.battery.battery_pass:6.0.0#RemainingPowerEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
remaining
+
+ + +
+
+
+
+

Dynamic Round Trip Efficiency Entity

+
+
+ Entity for dynamic round trip efficiency values. +
+ +
+

Properties

+
+
+ +
+
Round Trip Efficiency Fade
+
+ +Round trip efficiency fade refers to a reduction in the round trip efficiency of the battery system over time expressed as a percentage in reference to the initial value. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (4)(a) refers to Article 10(1) and refers to Annex IV: +4. Where applicable, energy round trip efficiency and its fade (in %). +Definition from Annex IV: +(6) "Energy round trip efficiency" means the ratio of the net energy delivered by a battery during a discharge test to the total energy required to restore the initial state of charge by a standard charge. + +
+
Name
+
roundTripEfficiencyFade
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.battery.battery_pass:6.0.0#RecordEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
fade
+
+ + +
+
+ +
+
Remaining Round Trip Efficiency
+
+ +The remaining round trip efficiency in the battery expressed as percentage. This attribute is mentioned in the Battery Regulation 2023/1542 from 12 July 2023 in Annex XIII (4) (b) refers to Article 14, refers to Annex VII Part A: +3. where possible, the remaining round trip efficiency. +Definition from Annex IV: +(6) "Energy round trip efficiency" means the ratio of the net energy delivered by a battery during a discharge test to the total energy required to restore the initial state of charge by a standard charge. + +
+
Name
+
remainingRoundTripEfficiency
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.battery.battery_pass:6.0.0#RecordEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
remaining
+
+ + +
+
+
+
+

Energy Entity

+
+
+ Entity for energy values expressed in a timestamp and a kilowatt-hours value. +
+ +
+

Properties

+
+
+ +
+
Data Record Time
+
+ +The entry date and time corresponding to when a specific parameter was measured. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (4): +(d) information and data resulting from its use, including the number of charging and discharging cycles and negative events, such as accidents, as well as periodically recorded information on the operating environmental conditions, including temperature, and on the state of charge. + +
+
Name
+
dataRecordTime
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#dateTime + +
+
+
+
+
+ +
+
Example
+
2023-12-07T10:39:13.576+01:00
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
time
+
+ + +
+
+ +
+
Energy Value
+
+ +Value describing the energy in a specific measurement period, expressed in kilowatt-hours. + +
+
Name
+
energyValue
+
+ + + +
+
Characteristic
+
+
+
+
Measurement
+
+
+
Measurement for the energy expressed in kilowatt hours as double.
+
+
+
Unit
+
+
+
+
    +
  • + kilowatt hour +
    • +
  • + Symbol kW·h +
    • +
  • + Code KWH +
    • +
  • + Conversion factor 3.6 × 10⁶ J +
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#double + +
+
+
+
+
+ +
+
Example
+
0.5
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
value
+
+ + +
+
+
+
+

Extinguish Agent Entity

+
+
+ Entity for the extinguish agents. +
+ +
+

Properties

+
+
+ +
+
Agent Document
+
+ +Documentation about the extinguishing agent. + +
+
Name
+
agentDocument
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#DocumentationEntity + +
+
+
+
+
+ + +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
document
+
+ + +
+
+ +
+
Usable Extinguishing Media
+
+ +The agent used to extinguish a fire, based on the fire class. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1)(a) and refers to Annex VI Part A: +9. usable extinguishing agent. + +
+
Name
+
usableExtinguishingMedia
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Dry Powder
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
media
+
+ + +
+
+ +
+
Fire Class
+
+ +Safety classification based on the chemistry and construction of the battery. It determines the means of handling a fire caused by the battery. Possible values are A, B and C and a combination of these. + +
+
Name
+
fireClass
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
A, B
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
fireClass
+
+ + +
+
+
+
+

Facility Entity

+
+
+ The entity for a facility with the BPNA identifier. +
+ +
+

Properties

+
+
+ +
+
Facility
+
+ +The identifier used for a location. This attribute is mentioned in the ESPR provisional agreement from January 9th 2024 Annex III: +(i) unique facility identifiers; +Article 2 Definitions: (33) 'unique facility identifier' means a unique string of characters for the identification of locations or buildings involved in the value chain of a product or used by actors involved in the value chain of a product. + +
+
Name
+
facility
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
    +
  • https://catena-x.net/fileadmin/user_upload/Standard-Bibliothek/Update_PDF_Maerz/5_BPDM/CX_-_0010_BUSINESS_PARTNER_NUMBER_PlatformCapabilityBPDM_v_1.0.1.pdf
    • +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
BPNA1234567890AA
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
facility
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + BPNA Regular Expression +
    + +
    +
    Description
    +
    The provided regular expression ensures that the BPNA is composed of prefix 'BPNA', 10 digits and two alphanumeric letters.
    +
    + + +
    +
    Regular expression
    +
    ^BPNA[a-zA-Z0-9]{12}$
    +
    + +
    • +
+
+
+
+
+
+
+

Footprint Entity

+
+
+ Footprint Entity for the carbon and environmental footprint with the total value, unit, impact category type, lifecycle, rulebook, declaration, performance class and the facility. +
+ +
+

Properties

+
+
+ +
+
Footprint Value
+
+ +The value of the footprint of the product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Annex I: +(l) the environmental footprint of the product, expressed as a quantification, in accordance with the applicable delegated act, of a product's life cycle environmental impacts, whether in relation to one or more environmental impact categories or an aggregated set of impact categories; +(m) the carbon footprint of the product; +(ma) the material footprint of the product. + + +
+
Name
+
footprintValue
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#float + +
+
+
+
+
+ +
+
Example
+
12.678
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
value
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + Positive Range Constraint +
    + +
    +
    Description
    +
    Constraint for only positive values.
    +
    + + +
    +
    +>= +
    + DefaultScalarValue[value=0.0, typeUri='DefaultScalar[metaModelVersion=SAMM_2_1_0, urn='http://www.w3.org/2001/XMLSchema#float']'] +
    +
    + +
    • +
+
+
+
+
+ +
+
Footprint Rulebook
+
+ +The applied rulebook for the environmental footprint of the product. + +
+
Name
+
footprintRulebook
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#DocumentationEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
rulebook
+
+ + +
+
+ +
+
Footprint Lifecycle
+
+ +The lifecycle stage, to which the environmental footprint corresponds. These could be for example "raw material acquisition and pre-processing", "main product production", "distribution" or "end of life and recycling". + +
+
Name
+
footprintLifecycle
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
main product production
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
lifecycle
+
+ + +
+
+ +
+
Footprint Unit
+
+ +The unit of measurement of the environmental impact category. For each impact category a specific unit is used. If an aggregation is used, utilize the normalization and weighting methods used in the referenced rulebook. + +
+
Name
+
footprintUnit
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
kg CO2 / kWh
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
unit
+
+ + +
+
+ +
+
Footprint Type
+
+ +The type of the environmental footprint of the product. This could be one of the environmental impact categories. This attribute is mentioned in the ESPR provisional agreement from January 9th 2024 Article 7: +(2)(b)(i) information on the performance of the product in relation to one or more of the product parameters referred to in Annex I, including a scoring of reparability or durability, carbon footprint or environmental footprint; +Annex I: +(l) the environmental footprint of the product, expressed as a quantification, in accordance with the applicable delegated act, of a product's life cycle environmental impacts, whether in relation to one or more environmental impact categories or an aggregated set of impact categories. +(m) the carbon footprint of the product; +(ma) the material footprint of the product. + +
+
Name
+
footprintType
+
+ + + +
+
Characteristic
+
+
+
+
Enumeration
+
+
+
Values
+
+
+
+
    +
  • Climate Change Total
    • +
  • Climate Change Fossil
    • +
  • Climate Change Biogenic Removals and Emissions
    • +
  • Climate Change Land Use and Land Use Change
    • +
  • Ozone Depletion
    • +
  • Acidification
    • +
  • Eutrophication Aquatic Freshwater
    • +
  • Eutrophication Fresh Marine
    • +
  • Eutrophication Terrestrial
    • +
  • Photochemical Ozone Formation
    • +
  • Abiotic Depletion- Minerals and Metals
    • +
  • Fossil Fuels
    • +
  • Water Use
    • +
  • Particulate Matter Emissions
    • +
  • Ionizing Radiation, Human Health
    • +
  • Eco-Toxicity
    • +
  • Human Toxicity, Cancer Effects
    • +
  • Human Toxicity, Non-Cancer Effects
    • +
  • Land Use Related Impacts/Soil Quality
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Climate Change
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
type
+
+ + +
+
+ +
+
Performance Class
+
+ +The performance classification of the footprint. + +
+
Name
+
performanceClass
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
A
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
performanceClass
+
+ + +
+
+ +
+
Manufacturing Plant
+
+ +The manufacturing plant of the footprint in the specific lifecycle phase. + +
+
Name
+
manufacturingPlant
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#FacilityEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
manufacturingPlant
+
+ + +
+
+ +
+
Declaration
+
+ +The footprint declaration in the format of a link + +
+
Name
+
declaration
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#DocumentationEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
declaration
+
+ + +
+
+
+
+

Full Cycle Entity

+
+
+ Entity for dynamic cycle values. +
+ +
+

Properties

+
+
+ +
+
Data Record Time
+
+ +The entry date and time corresponding to when a specific parameter was measured. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (4): +(d) information and data resulting from its use, including the number of charging and discharging cycles and negative events, such as accidents, as well as periodically recorded information on the operating environmental conditions, including temperature, and on the state of charge. + +
+
Name
+
dataRecordTime
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#dateTime + +
+
+
+
+
+ +
+
Example
+
2023-12-07T10:39:13.576+01:00
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
time
+
+ + +
+
+ +
+
Cycles
+
+ +Cycle refers to one complete charging and discharging sequence. Either during the battery's cycle-life testing or as full equivalent while in use. + +
+
Name
+
cycles
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#integer + +
+
+
+
+
+ +
+
Example
+
1500
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
value
+
+ + +
+
+
+
+

Handling Entity

+
+
+ Entity to describe different aspects in relation with the handling of the product with attributes if applicable to the product. +
+ +
+

Properties

+
+
+ +
+
spareParts
+
+ +The list of spare parts available for the product from various suppliers. + +
+
Name
+
spareParts
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#SparePartEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
content
+
+ + +
+
+ +
+
Applicable
+
+ +Check whether the connected attributes are applicable to the product. If it is not applicable (false), dummy data can be delivered. + +
+
Name
+
applicable
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#boolean + +
+
+
+
+
+ +
+
Example
+
true
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
applicable
+
+ + +
+
+
+
+

Hazardous Entity

+
+
+ Material Entity to describe the material composition for hazardous materials. +
+ +
+

Properties

+
+
+ +
+
Impact of Substances
+
+ +An accumulation of documents that refer to the impact, especially hazardous substances, on the battery. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1) (s), refers to Article 74: +1. In addition to the information referred to in Article 8a(2) of Directive 2008/98/EC, producers or, where appointed in accordance with Article 57(1), producer responsibility organisations shall make available to end-users and distributors the following information regarding the prevention and management of waste batteries with regard to the categories of batteries that they supply within the territory of a Member State: +[...] +(f) the impact of substances, in particular hazardous substances, present in batteries on the environment and on human health or the safety of persons, including the impact due to inappropriate discarding of waste batteries, such as littering or discarding as unsorted municipal waste. + +
+
Name
+
impactOfSubstances
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#DocumentationEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
impactOfSubstances
+
+ + +
+
+ +
+
Concentration
+
+ +Concentration of the material at the level of the product. This attribute is specially mentioned for substances of concern mentioned in the ESPR proposal from March 30th, 2022 Article 7: +(5) (c) the concentration, maximum concentration or concentration range of the substances of concern, at the level of the product [...]. +Other substances are mentioned for the purpose of recycling in the ESPR provisional agreement from January 9th, 2024 Annex I: +(d) design for recycling, ease and quality of recycling as expressed through: use of easily recyclable materials, safe, easy and non-destructive access to recyclable components and materials or components and materials containing hazardous substances and material composition and homogeneity, possibility for high-purity sorting, number of materials and components used, use of standard components, use of component and material coding standards for the identification of components and materials, number and complexity of processes and tools needed, ease of nondestructive disassembly and re-assembly, conditions for access to product data, conditions for access to or use of hardware and software needed. + + +
+
Name
+
concentration
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#float + +
+
+
+
+
+ +
+
Example
+
5.3
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
concentration
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + Positive Range Constraint +
    + +
    +
    Description
    +
    Constraint for only positive values.
    +
    + + +
    +
    +>= +
    + DefaultScalarValue[value=0.0, typeUri='DefaultScalar[metaModelVersion=SAMM_2_1_0, urn='http://www.w3.org/2001/XMLSchema#float']'] +
    +
    + +
    • +
+
+
+
+
+ +
+
Location
+
+ +The location of the substances of concern within the product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7: +(5) (b) the location of the substances of concern within the product. + +
+
Name
+
location
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Housing
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
location
+
+ + +
+
+ +
+
Material Unit
+
+ +The unit of concentration chosen from an enumeration: mass percent, volume percent, parts per thousand, parts per million, parts per billion and parts per trillion. + +
+
Name
+
materialUnit
+
+ + + +
+
Characteristic
+
+
+
+
Enumeration
+
+
+
Values
+
+
+
+
    +
  • unit:partPerMillion
    • +
  • unit:percent
    • +
  • unit:percentVolume
    • +
  • unit:partPerThousand
    • +
  • unit:partPerTrillionUs
    • +
  • unit:partPerBillionUs
    • +
+
+
+
+
+ Reference +
+
    +
  • https://eclipse-esmf.github.io/samm-specification/2.1.0/index.html
    • +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
unit:percent
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
materialUnit
+
+ +
+
Reference
+
+
    +
  • https://eclipse-esmf.github.io/samm-specification/2.1.0/index.html
    • +
+
+
+ +
+
+ +
+
Critical
+
+ +A flag, if the material is a critical raw material. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I: +(h) use or content of recycled materials and recovery of materials, including critical raw materials; +In Annex II of the connected proposal Act of Critical Raw Materials, a list of critical raw materials can be found. + +
+
Name
+
critical
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#boolean + +
+
+
+
+
+ +
+
Example
+
true
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
critical
+
+ +
+
Reference
+
+
    +
  • https://eur-lex.europa.eu/legal-content/EN/TXT/?uri=COM:2023:0160:FIN
    • +
+
+
+ +
+
+ +
+
Documentation
+
+ +Documentation accompanying the material. + +
+
Name
+
documentation
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#DocumentationEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
documentation
+
+ + +
+
+
+
+

Hazardous Substance Entity

+
+
+ Hazardous Substance Entity for hazardous chemical materials. +
+ +
+

Properties

+
+
+ +
+
Hazardous Cadmium
+
+ +Information about the presence of cadmium in the battery. Therefore, a concentration and the location within the battery has to be given. This is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1) (a) refers to Annex VI Part A: +8. the hazardous substances present in the battery, other than mercury, cadmium or lead; +Defined in Article 3: +(52) "hazardous substance" means a substance classified as hazardous pursuant to Article 3 of Regulation (EC) No 1272/2008. +Additionally in Article 13: +5. All batteries containing more than 0,002 % cadmium or more than 0,004 % lead, shall be marked with the chemical symbol for the metal concerned: Cd or Pb. + +
+
Name
+
hazardousCadmium
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.battery.battery_pass:6.0.0#HazardousEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
cadmium
+
+ + +
+
+ +
+
Hazardous Mercury
+
+ +Information about the presence of mercury in the battery. Therefore, a concentration and the location within the battery has to be given. This is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1) (a) refers to Annex VI Part A: +8. the hazardous substances present in the battery, other than mercury, cadmium or lead; +Defined in Article 3: +(52) "hazardous substance" means a substance classified as hazardous pursuant to Article 3 of Regulation (EC) No 1272/2008. + +
+
Name
+
hazardousMercury
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.battery.battery_pass:6.0.0#HazardousEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
mercury
+
+ + +
+
+ +
+
Other Hazardous Material
+
+ +Other hazardous materials. + +
+
Name
+
otherHazardousMaterial
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.battery.battery_pass:6.0.0#OtherHazardousMaterialEntity + +
+
+
+
+
+ + +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
other
+
+ + +
+
+ +
+
Lead
+
+ +Information about the lead in the battery. As this is an active and hazardous material, all properties for hazardous as well as active materials are required. These attribute are mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1)(e) refers to Article 8: +1. From 18 August 2028 or 24 months after the date of entry into force of the delegated act referred to in the third subparagraph, whichever is the latest, industrial batteries with a capacity greater than 2 kWh, except those with exclusively external storage, electric vehicle batteries and SLI batteries that contain cobalt, lead, lithium or nickel in active materials, shall be accompanied by documentation containing information about the percentage share of cobalt, lithium or nickel that is present in active materials and that has been recovered from battery manufacturing waste or post-consumer waste, and the percentage share of lead that is present in the battery and that has been recovered from waste, for each battery model per year and per manufacturing plant. +And for hazardous materials this is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1) (a) refers to Annex VI Part A: +8. the hazardous substances present in the battery, other than mercury, cadmium or lead; +Additionally in Article 13: +5. All batteries containing more than 0,002 % cadmium or more than 0,004 % lead, shall be marked with the chemical symbol for the metal concerned: Cd or Pb. +Defined in Article 3: +(52) "hazardous substance" means a substance classified as hazardous pursuant to Article 3 of Regulation (EC) No 1272/2008. + +
+
Name
+
lead
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.battery.battery_pass:6.0.0#LeadEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
lead
+
+ + +
+
+
+
+

Identification Entity

+
+
+ Entity for the identification of the battery. +
+ +
+

Properties

+
+
+ +
+
Battery Category
+
+ +The battery category, which can be a portable battery; starting, lighting and ignition battery (SLI); light means of transport battery (LMT); electric vehicle battery (EV), industrial battery and incorporated battery. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1) (a) and refers to ANNEX VI Part A: +2. the battery category and information identifying the battery in accordance with Article 38(6). + +
+
Name
+
batteryCategory
+
+ + + +
+
Characteristic
+
+
+
+
Enumeration
+
+
+
Values
+
+
+
+
    +
  • SLI
    • +
  • LMT
    • +
  • EV
    • +
  • industrial
    • +
  • portable
    • +
  • incorporated
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
EV
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
category
+
+ + +
+
+ +
+
Id DMC
+
+ +The unique identifier of the product, when it is placed on the market. Through this identifier a web link can be accessed. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Article 77: +3. The battery passport shall be accessible through the QR code referred to in Article 13(6) which links to a unique identifier that the economic operator placing the battery on the market shall attribute to it. The QR code and the unique identifier shall comply with the ISO/IEC standards 15459-1:2014, 15459-2:2015, 15459-3:2014, 15459-4:2014, 15459-5:2014 and 15459-6:2014 or their equivalent. +Defined is the QR code in Article 3: +(24) "QR code" means a machine-readable matrix code that links to information as required by this Regulation. +(66) "unique identifier" means a unique string of characters for the identification of batteries that also enables a web link to the battery passport. + +
+
Name
+
idDmc
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
34567890
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
idDmc
+
+ + +
+
+ +
+
Battery Chemistry
+
+ +Battery chemistry refers to the specific chemical composition and reactions that occur within a battery to produce and store electrical energy. The chemistry has to be stated as detailed as possible for example: the Nickel Cobalt Manganese battery 'NCM'. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1) (a) and refers to ANNEX VI Part A: +7. the chemestry. + +
+
Name
+
batteryChemistry
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Nickel Cobalt Manganese (NCM)
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
chemistry
+
+ + +
+
+ +
+
Identification
+
+ +Identification information of the product, especially identifiers and codes. These are mentioned in the ESPR provisional agreement from January 9th, 2024 ANNEX III: +(b) the unique product identifier at the level indicated in the applicable delegated act adopted pursuant to Article 4. +Additionally in Article 9 regarding general requirements for the product passport is stated that: +A product passport shall meet the following conditions: +(a) it shall be connected through a data carrier to a persistent unique product identifier; +(e) the information included in the product passport shall refer to the product model, batch, or item as specified in the delegated act adopted pursuant to Article 4. +Article 2 Definitions: +(31) 'unique product identifier' means a unique string of characters for the identification of products that also enables a web link to the product passport; +Recital (27): A 'model' usually means a version of a product of which all units share the same technical characteristics relevant for the ecodesign requirements and the same model identifier, a 'batch' usually means a subset of a specific model composed of all products produced in a specific manufacturing plant at a specific moment in time and an 'item' usually means a single unit of a model. + +
+
Name
+
identification
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#IdentificationEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
identification
+
+ + +
+
+
+
+

Identification Entity

+
+
+ Entity with identification information of the product with part type information, local identifiers, other codes and the data carrier. +
+ +
+

Properties

+
+
+ +
+
Serial Information
+
+ +Identifier for a serial part if available. This is mentioned in the ESPR provisional agreement from January 9th, 2024 Recital (27): +[...] an 'item' usually means a single unit of a model. + +
+
Name
+
serialInformation
+
+ + + +
+
Characteristic
+
+
+
+
Set
+
+
+
Has no order
+
+
+
Duplicates not allowed
+
+
+
+ Type urn:samm:io.catenax.serial_part:3.0.0#KeyValueList + +
+
+
+
+
+ + +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
serial
+
+ + +
+
+ +
+
Batch Information
+
+ +Identifier for a batch part if available. Identifier for a serial part if available. This is mentioned in the ESPR provisional agreement from January 9th, 2024 Recital (27): +[...] a 'batch' usually means a subset of a specific model composed of all products produced in a specific manufacturing plant at a specific moment in time [...]. + +
+
Name
+
batchInformation
+
+ + + +
+
Characteristic
+
+
+
+
Set
+
+
+
Has no order
+
+
+
Duplicates not allowed
+
+
+
+ Type urn:samm:io.catenax.batch:3.0.0#KeyValueList + +
+
+
+
+
+ + +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
batch
+
+ + +
+
+ +
+
Part Type Information
+
+ +Identifier on the level of a part model or type. Identifier for a serial part if available. This is mentioned in the ESPR provisional agreement from January 9th, 2024 Recital (27): +[...] A 'model' usually means a version of a product of which all units share the same technical characteristics relevant for the ecodesign requirements and the same model identifier [...]. + +
+
Name
+
partTypeInformation
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#PartTypeEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
type
+
+ + +
+
+ +
+
Codes
+
+ +Codes for identification. + +
+
Name
+
codes
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#CodeEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
codes
+
+ + +
+
+ +
+
Data Carrier
+
+ +The type and layout of the data carrier on the product. These are mentioned in the ESPR proposal from March 30th, 2022 Article 8: +(b) the types of data carrier to be used; +(c) the layout in which the data carrier shall be presented and its positioning; +Article 2 defines: +(30) 'data carrier' means a linear bar code symbol, a two-dimensional symbol or other automatic identification data capture medium that can be read by a device. + +
+
Name
+
dataCarrier
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#DataCarrierEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
dataCarrier
+
+ + +
+
+ +
+
Part Classification
+
+ +Property describing the classification of a part. + +
+
Name
+
partClassification
+
+ + + +
+
Characteristic
+
+
+
+
SortedSet
+
+
+
Has a certain order
+
+
+
Duplicates not allowed
+
+
+
+ Type urn:samm:io.catenax.shared.part_classification:1.0.0#ClassificationEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
classification
+
+ + +
+
+
+
+

Key Value List

+
+
+ A list of key value pairs for local identifiers, which are composed of a key and a corresponding value. +
+ +
+

Properties

+
+
+ +
+
Identifier Key
+
+ +The key of a local identifier. + +
+
Name
+
key
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
partInstanceId
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
key
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + Key Regular Expression +
    + +
    +
    Description
    +
    Constraint that ensures that the standard keys and custom key prefixes can be used.
    +
    + + +
    +
    Regular expression
    +
    ^(manufacturerId|partInstanceId|batchId|van|customKey:\w+)$
    +
    + +
    • +
+
+
+
+
+ +
+
Identifier Value
+
+ +The value of an identifier. + +
+
Name
+
value
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
SN12345678
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
value
+
+ + +
+
+
+
+

Key Value List

+
+
+ A list of key value pairs for local identifiers, which are composed of a key and a corresponding value. +
+ +
+

Properties

+
+
+ +
+
Identifier Key
+
+ +The key of a local identifier. + +
+
Name
+
key
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
batchId
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
key
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + Key Regular Expression +
    + +
    +
    Description
    +
    Constraint that ensures that the predefined keys are used.
    +
    + + +
    +
    Regular expression
    +
    ^(manufacturerId|batchId|customKey:\w+)$
    +
    + +
    • +
+
+
+
+
+ +
+
Identifier Value
+
+ +The value of an identifier. + +
+
Name
+
value
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
BID12345678
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
value
+
+ + +
+
+
+
+

Lead Entity

+
+
+ Entity for lead. +
+ +
+

Properties

+
+
+ +
+
Impact of Substances
+
+ +An accumulation of documents that refer to the impact, especially hazardous substances, on the battery. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1) (s), refers to Article 74: +1. In addition to the information referred to in Article 8a(2) of Directive 2008/98/EC, producers or, where appointed in accordance with Article 57(1), producer responsibility organisations shall make available to end-users and distributors the following information regarding the prevention and management of waste batteries with regard to the categories of batteries that they supply within the territory of a Member State: +[...] +(f) the impact of substances, in particular hazardous substances, present in batteries on the environment and on human health or the safety of persons, including the impact due to inappropriate discarding of waste batteries, such as littering or discarding as unsorted municipal waste. + +
+
Name
+
impactOfSubstances
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#DocumentationEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
impactOfSubstances
+
+ + +
+
+ +
+
Critical
+
+ +A flag, if the material is a critical raw material. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I: +(h) use or content of recycled materials and recovery of materials, including critical raw materials; +In Annex II of the connected proposal Act of Critical Raw Materials, a list of critical raw materials can be found. + +
+
Name
+
critical
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#boolean + +
+
+
+
+
+ +
+
Example
+
true
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
critical
+
+ +
+
Reference
+
+
    +
  • https://eur-lex.europa.eu/legal-content/EN/TXT/?uri=COM:2023:0160:FIN
    • +
+
+
+ +
+
+ +
+
Documentation
+
+ +Documentation accompanying the material. + +
+
Name
+
documentation
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#DocumentationEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
documentation
+
+ + +
+
+ +
+
Recycled
+
+ +The share of the material, which is recovered recycled content from the product. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I: +(h) use or content of recycled materials and recovery of materials, including critical raw materials; + +
+
Name
+
recycled
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#float + +
+
+
+
+
+ +
+
Example
+
12.5
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
recycled
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + Percentage Constraint +
    + +
    +
    Description
    +
    Range constraint for a positive percentage value.
    +
    + + +
    +
    +>= +
    + DefaultScalarValue[value=0.0, typeUri='DefaultScalar[metaModelVersion=SAMM_2_1_0, urn='http://www.w3.org/2001/XMLSchema#float']'] +
    +
    ...
    +
    +< + DefaultScalarValue[value=100.0, typeUri='DefaultScalar[metaModelVersion=SAMM_2_1_0, urn='http://www.w3.org/2001/XMLSchema#float']'] +
    + +
    • +
+
+
+
+
+ +
+
Location
+
+ +The location of the substances of concern within the product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7: +(5) (b) the location of the substances of concern within the product. + +
+
Name
+
location
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Housing
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
location
+
+ + +
+
+ +
+
Concentration
+
+ +Concentration of the material at the level of the product. This attribute is specially mentioned for substances of concern mentioned in the ESPR proposal from March 30th, 2022 Article 7: +(5) (c) the concentration, maximum concentration or concentration range of the substances of concern, at the level of the product [...]. +Other substances are mentioned for the purpose of recycling in the ESPR provisional agreement from January 9th, 2024 Annex I: +(d) design for recycling, ease and quality of recycling as expressed through: use of easily recyclable materials, safe, easy and non-destructive access to recyclable components and materials or components and materials containing hazardous substances and material composition and homogeneity, possibility for high-purity sorting, number of materials and components used, use of standard components, use of component and material coding standards for the identification of components and materials, number and complexity of processes and tools needed, ease of nondestructive disassembly and re-assembly, conditions for access to product data, conditions for access to or use of hardware and software needed. + + +
+
Name
+
concentration
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#float + +
+
+
+
+
+ +
+
Example
+
5.3
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
concentration
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + Positive Range Constraint +
    + +
    +
    Description
    +
    Constraint for only positive values.
    +
    + + +
    +
    +>= +
    + DefaultScalarValue[value=0.0, typeUri='DefaultScalar[metaModelVersion=SAMM_2_1_0, urn='http://www.w3.org/2001/XMLSchema#float']'] +
    +
    + +
    • +
+
+
+
+
+ +
+
Material Unit
+
+ +The unit of concentration chosen from an enumeration: mass percent, volume percent, parts per thousand, parts per million, parts per billion and parts per trillion. + +
+
Name
+
materialUnit
+
+ + + +
+
Characteristic
+
+
+
+
Enumeration
+
+
+
Values
+
+
+
+
    +
  • unit:partPerMillion
    • +
  • unit:percent
    • +
  • unit:percentVolume
    • +
  • unit:partPerThousand
    • +
  • unit:partPerTrillionUs
    • +
  • unit:partPerBillionUs
    • +
+
+
+
+
+ Reference +
+
    +
  • https://eclipse-esmf.github.io/samm-specification/2.1.0/index.html
    • +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
unit:percent
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
materialUnit
+
+ +
+
Reference
+
+
    +
  • https://eclipse-esmf.github.io/samm-specification/2.1.0/index.html
    • +
+
+
+ +
+
+
+
+

Life Cycle Entity

+
+
+ Life Cycle Entity with attributes for the lifetime evaluation of a battery such as expected years and cycles, if applicable. +
+ +
+

Properties

+
+
+ +
+
Expected Years
+
+ +The expected years refer to the expected life-time of the battery before it starts heavily degrading in its capacity and c-rate in calendar years. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (4) (a) refers to the Article 10 (1) refers to Annex IV Part A: +5. The expected life-time of the battery under the reference conditions for which it has been designed, in terms of cycles, except for non-cycle applications, and calendar years. + +
+
Name
+
expectedYears
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#integer + +
+
+
+
+
+ +
+
Example
+
8
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
expectedYears
+
+ + +
+
+ +
+
Test Report
+
+ +The test reports refer to the testing conducted during the determination of the rated values of the battery. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (3): +[...] results of test reports proving compliance with the requirements laid down in this Regulation or any delegated or implementing act adopted pursuant to this Regulation. +And Annex XIII (4)(a) refers to Article 10(1) and refer to Annex IV Part B: +5. Any calculations performed with the measured parameters, if applicable. + +
+
Name
+
testReport
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#DocumentationEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
report
+
+ + +
+
+ +
+
Cycle Life Testing
+
+ +The cycle life testing of the battery. + +
+
Name
+
cycleLifeTesting
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.battery.battery_pass:6.0.0#CycleLifeEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
cycleLifeTesting
+
+ + +
+
+
+
+

Linear Entity

+
+
+ Entity for linear measurements of an item with an unit and value. +
+ +
+

Properties

+
+
+ +
+
Quantity Value
+
+ +The quantity value associated with the unit. + +
+
Name
+
quantityValue
+
+ + + +
+
Characteristic
+
+
+
+
Quantifiable
+
+
+
Duration
+
+
+
The quantity value associated with the unit expressed as float.
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#float + +
+
+
+
+
+ +
+
Example
+
20.0
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
value
+
+ + +
+
+ +
+
Linear Unit
+
+ +The unit of a linear attribute. + +
+
Name
+
linearUnit
+
+ + + +
+
Characteristic
+
+
+
+
Enumeration
+
+
+
Values
+
+
+
+
    +
  • unit:millimetre
    • +
  • unit:centimetre
    • +
  • unit:metre
    • +
  • unit:kilometre
    • +
  • unit:inch
    • +
  • unit:foot
    • +
  • unit:yard
    • +
+
+
+
+
+ Reference +
+
    +
  • https://eclipse-esmf.github.io/samm-specification/2.1.0/index.html
    • +
+
+
+
+
+
+ Type urn:samm:org.eclipse.esmf.samm:meta-model:2.1.0#curie + +
+
+
+
+
+ +
+
Example
+
unit:millimetre
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
unit
+
+ +
+
Reference
+
+
    +
  • https://eclipse-esmf.github.io/samm-specification/2.1.0/index.html
    • +
+
+
+ +
+
+
+
+

Manufacturer Entity

+
+
+ Manufacturing Entity with the identification of the main manufacturer and the facility location as well as the manufacturing date. +
+ +
+

Properties

+
+
+ +
+
Facility Identification
+
+ +The identifier used for a location. In the CATENA-X use case, the BPNA can be stated. This attribute is mentioned in the ESPR provisional agreement from January 9th 2024 Annex III: +(i) unique facility identifiers; +Article 2 Definitions: (33) 'unique facility identifier' means a unique string of characters for the identification of locations or buildings involved in the value chain of a product or used by actors involved in the value chain of a product. + +
+
Name
+
facilityIdentification
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#FacilityEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
facility
+
+ + +
+
+ +
+
Manufacturer Identification
+
+ +The main manufacturer, if different from the passport owner, represented by an identification number. In the Catena-X use case, the BPNL can be stated. This attribute is mentioned in the ESPR provisional agreement from January 9th 2024 Annex III: +(h) unique operator identifiers other than that of the manufacturer; +(k) the name, contact details and unique operator identifier code of the economic operator established in the Union responsible for carrying out the tasks set out in Article 4 of Regulation (EU) 2019/1020, or Article 15 of Regulation (EU) [.../...] on general product safety, or similar tasks pursuant to other EU legislation applicable to the product. + +
+
Name
+
manufacturerIdentification
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
    +
  • https://catena-x.net/fileadmin/user_upload/Standard-Bibliothek/Update_PDF_Maerz/5_BPDM/CX_-_0010_BUSINESS_PARTNER_NUMBER_PlatformCapabilityBPDM_v_1.0.1.pdf
    • +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
manufacturer
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + BPNL Regular Expression +
    + +
    +
    Description
    +
    The provided regular expression ensures that the BPNL is composed of prefix 'BPNL', 10 digits and two alphanumeric letters.
    +
    + + +
    +
    Regular expression
    +
    ^BPNL[a-zA-Z0-9]{12}$
    +
    + +
    • +
+
+
+
+
+ +
+
Manufacturing Date
+
+ +The timestamp in the format (yyyy-mm-dd) of the manufacturing date as the final step in production process (e.g. final quality check, ready-for-shipment event). + +
+
Name
+
manufacturingDate
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
2000-01-31
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
manufacturingDate
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + Date Constraint +
    + +
    +
    Description
    +
    Constraint fo a timestamp in the format (yyyy-mm-dd).
    +
    + + +
    +
    Regular expression
    +
    ^\d{4}-\d{2}-\d{2}$
    +
    + +
    • +
+
+
+
+
+
+
+

Mass Entity

+
+
+ Entity for mass measurements of an item with an unit and value. +
+ +
+

Properties

+
+
+ +
+
Quantity Value
+
+ +The quantity value associated with the unit. + +
+
Name
+
quantityValue
+
+ + + +
+
Characteristic
+
+
+
+
Quantifiable
+
+
+
Duration
+
+
+
The quantity value associated with the unit expressed as float.
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#float + +
+
+
+
+
+ +
+
Example
+
20.0
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
value
+
+ + +
+
+ +
+
Mass Unit
+
+ +The unit of a mass related attribute. + +
+
Name
+
massUnit
+
+ + + +
+
Characteristic
+
+
+
+
Enumeration
+
+
+
Values
+
+
+
+
    +
  • unit:gram
    • +
  • unit:kilogram
    • +
  • unit:tonneMetricTon
    • +
  • unit:tonUsOrShortTonUkorus
    • +
  • unit:ounceAvoirdupois
    • +
  • unit:pound
    • +
+
+
+
+
+ Reference +
+
    +
  • https://eclipse-esmf.github.io/samm-specification/2.1.0/index.html
    • +
+
+
+
+
+
+ Type urn:samm:org.eclipse.esmf.samm:meta-model:2.1.0#curie + +
+
+
+
+
+ +
+
Example
+
unit:kilogram
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
unit
+
+ +
+
Reference
+
+
    +
  • https://eclipse-esmf.github.io/samm-specification/2.1.0/index.html
    • +
+
+
+ +
+
+
+
+

Material Active Entity

+
+
+ The information on the active material with the recycled share, location and supporting document(s). +
+ +
+

Properties

+
+
+ +
+
Location
+
+ +The location of the substances of concern within the product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7: +(5) (b) the location of the substances of concern within the product. + +
+
Name
+
location
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Housing
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
location
+
+ + +
+
+ +
+
Recycled
+
+ +The share of the material, which is recovered recycled content from the product. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I: +(h) use or content of recycled materials and recovery of materials, including critical raw materials; + +
+
Name
+
recycled
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#float + +
+
+
+
+
+ +
+
Example
+
12.5
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
recycled
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + Percentage Constraint +
    + +
    +
    Description
    +
    Range constraint for a positive percentage value.
    +
    + + +
    +
    +>= +
    + DefaultScalarValue[value=0.0, typeUri='DefaultScalar[metaModelVersion=SAMM_2_1_0, urn='http://www.w3.org/2001/XMLSchema#float']'] +
    +
    ...
    +
    +< + DefaultScalarValue[value=100.0, typeUri='DefaultScalar[metaModelVersion=SAMM_2_1_0, urn='http://www.w3.org/2001/XMLSchema#float']'] +
    + +
    • +
+
+
+
+
+ +
+
Documentation
+
+ +Documentation accompanying the material. + +
+
Name
+
documentation
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#DocumentationEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
documentation
+
+ + +
+
+ +
+
Critical
+
+ +A flag, if the material is a critical raw material. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I: +(h) use or content of recycled materials and recovery of materials, including critical raw materials; +In Annex II of the connected proposal Act of Critical Raw Materials, a list of critical raw materials can be found. + +
+
Name
+
critical
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#boolean + +
+
+
+
+
+ +
+
Example
+
true
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
critical
+
+ +
+
Reference
+
+
    +
  • https://eur-lex.europa.eu/legal-content/EN/TXT/?uri=COM:2023:0160:FIN
    • +
+
+
+ +
+
+
+
+

Material Composition Entity

+
+
+ Entity for the material composition. +
+ +
+

Properties

+
+
+ +
+
Material Identification
+
+ +The chemical material name and identification, in accordance with the specification in the attribute for the list type. Preference is given to the IUPAC name. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Article 7: +(5) (a) the name of the substances of concern present in the product, as follows: + - name(s) in the International Union of Pure and Applied Chemistry (IUPAC) nomenclature, or another international name when IUPAC name is not available; +- other names (usual name, trade name, abbreviation); +- European Community (EC) number, as indicated in the European Inventory of Existing Commercial Chemical Substances (EINECS), the European List of Notified Chemical Substances (ELINCS) or the No Longer Polymer (NLP) list or assigned by the European Chemicals Agency (ECHA), if available; +- the Chemical Abstract Service (CAS) name(s) and number(s), if available; . + +
+
Name
+
materialIdentification
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#MaterialIdEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
id
+
+ + +
+
+ +
+
Concentration
+
+ +Concentration of the material at the level of the product. This attribute is specially mentioned for substances of concern mentioned in the ESPR proposal from March 30th, 2022 Article 7: +(5) (c) the concentration, maximum concentration or concentration range of the substances of concern, at the level of the product [...]. +Other substances are mentioned for the purpose of recycling in the ESPR provisional agreement from January 9th, 2024 Annex I: +(d) design for recycling, ease and quality of recycling as expressed through: use of easily recyclable materials, safe, easy and non-destructive access to recyclable components and materials or components and materials containing hazardous substances and material composition and homogeneity, possibility for high-purity sorting, number of materials and components used, use of standard components, use of component and material coding standards for the identification of components and materials, number and complexity of processes and tools needed, ease of nondestructive disassembly and re-assembly, conditions for access to product data, conditions for access to or use of hardware and software needed. + + +
+
Name
+
concentration
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#float + +
+
+
+
+
+ +
+
Example
+
5.3
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
concentration
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + Positive Range Constraint +
    + +
    +
    Description
    +
    Constraint for only positive values.
    +
    + + +
    +
    +>= +
    + DefaultScalarValue[value=0.0, typeUri='DefaultScalar[metaModelVersion=SAMM_2_1_0, urn='http://www.w3.org/2001/XMLSchema#float']'] +
    +
    + +
    • +
+
+
+
+
+ +
+
Material Unit
+
+ +The unit of concentration chosen from an enumeration: mass percent, volume percent, parts per thousand, parts per million, parts per billion and parts per trillion. + +
+
Name
+
materialUnit
+
+ + + +
+
Characteristic
+
+
+
+
Enumeration
+
+
+
Values
+
+
+
+
    +
  • unit:partPerMillion
    • +
  • unit:percent
    • +
  • unit:percentVolume
    • +
  • unit:partPerThousand
    • +
  • unit:partPerTrillionUs
    • +
  • unit:partPerBillionUs
    • +
+
+
+
+
+ Reference +
+
    +
  • https://eclipse-esmf.github.io/samm-specification/2.1.0/index.html
    • +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
unit:percent
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
unit
+
+ +
+
Reference
+
+
    +
  • https://eclipse-esmf.github.io/samm-specification/2.1.0/index.html
    • +
+
+
+ +
+
+ +
+
Critical
+
+ +A flag, if the material is a critical raw material. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I: +(h) use or content of recycled materials and recovery of materials, including critical raw materials; +In Annex II of the connected proposal Act of Critical Raw Materials, a list of critical raw materials can be found. + +
+
Name
+
critical
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#boolean + +
+
+
+
+
+ +
+
Example
+
true
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
critical
+
+ +
+
Reference
+
+
    +
  • https://eur-lex.europa.eu/legal-content/EN/TXT/?uri=COM:2023:0160:FIN
    • +
+
+
+ +
+
+ +
+
Documentation
+
+ +Documentation accompanying the material. + +
+
Name
+
documentation
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#DocumentationEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
documentation
+
+ + +
+
+ +
+
Recycled
+
+ +The share of the material, which is recovered recycled content from the product. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I: +(h) use or content of recycled materials and recovery of materials, including critical raw materials; + +
+
Name
+
recycled
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#float + +
+
+
+
+
+ +
+
Example
+
12.5
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
recycled
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + Percentage Constraint +
    + +
    +
    Description
    +
    Range constraint for a positive percentage value.
    +
    + + +
    +
    +>= +
    + DefaultScalarValue[value=0.0, typeUri='DefaultScalar[metaModelVersion=SAMM_2_1_0, urn='http://www.w3.org/2001/XMLSchema#float']'] +
    +
    ...
    +
    +< + DefaultScalarValue[value=100.0, typeUri='DefaultScalar[metaModelVersion=SAMM_2_1_0, urn='http://www.w3.org/2001/XMLSchema#float']'] +
    + +
    • +
+
+
+
+
+ +
+
Location
+
+ +The location of the substances of concern within the product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7: +(5) (b) the location of the substances of concern within the product. + +
+
Name
+
location
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Housing
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
location
+
+ + +
+
+ +
+
Renewable
+
+ +The share of the material, which is from a renewable resource that can be replenished. Renewable resources are those that can be reproduced by physical, chemical, or mechanical processes. These are the kind of resources that can be regenerated throughout time. Forest wood, for example, can be grown through reforestation. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I: +(ha) use or content of sustainable renewable materials; + + +
+
Name
+
renewable
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#float + +
+
+
+
+
+ +
+
Example
+
23.5
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
renewable
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + Percentage Constraint +
    + +
    +
    Description
    +
    Range constraint for a positive percentage value.
    +
    + + +
    +
    +>= +
    + DefaultScalarValue[value=0.0, typeUri='DefaultScalar[metaModelVersion=SAMM_2_1_0, urn='http://www.w3.org/2001/XMLSchema#float']'] +
    +
    ...
    +
    +< + DefaultScalarValue[value=100.0, typeUri='DefaultScalar[metaModelVersion=SAMM_2_1_0, urn='http://www.w3.org/2001/XMLSchema#float']'] +
    + +
    • +
+
+
+
+
+
+
+

Material Id Entity

+
+
+ Id Entity with identifier, name and list type. +
+ +
+

Properties

+
+
+ +
+
Chemical Id
+
+ +The substance identification, in accordance with the specification in the attribute for the list type. + +
+
Name
+
chemicalId
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
201-004-7
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
id
+
+ + +
+
+ +
+
List Type Id
+
+ +The type of standard used for the identification of the substances. Selected can be for example CAS, IUPAC or EC. + +
+
Name
+
listTypeId
+
+ + + +
+
Characteristic
+
+
+
+
Enumeration
+
+
+
Values
+
+
+
+
    +
  • CAS
    • +
  • EC
    • +
  • IUPAC
    • +
+
+
+
+
+ Reference +
+
    +
  • https://www.cas.org/cas-data/cas-registry
    • +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
CAS
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
type
+
+ + +
+
+ +
+
Chemical Name
+
+ +The name of the material which is present in the product. + +
+
Name
+
chemicalName
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
phenolphthalein
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
name
+
+ + +
+
+
+
+

Metadata Entity

+
+
+ Passport Entity to describe version, status, end and issue date. +
+ +
+

Properties

+
+
+ +
+
Version
+
+ +The current version of the product passport. The possibility of modification/ updating the product passport needs to include versioning of the dataset. This attribute is an internal versioning from the passport issuer. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Article 8: +(1) [...] The information in the product passport shall be accurate, complete, and up to date. + +
+
Name
+
version
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
1.0.0
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
version
+
+ + +
+
+ +
+
Status
+
+ +The current status of the product passport declared through either: draft, approved, invalid or expired. + +
+
Name
+
status
+
+ + + +
+
Characteristic
+
+
+
+
Enumeration
+
+
+
Values
+
+
+
+
    +
  • draft
    • +
  • approved
    • +
  • invalid
    • +
  • expired
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
draft
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
status
+
+ + +
+
+ +
+
Expiration Date
+
+ +The timestamp in the format (yyyy-mm-dd) for the product passport until when it is available or a comment describing this period. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Article 8: +(2) (h) the period during which the product passport is to remain available, which shall correspond to at least the expected lifetime of a specific product. + +
+
Name
+
expirationDate
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
2030-01-01
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
expirationDate
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + Date Constraint +
    + +
    +
    Description
    +
    Constraint fo a timestamp in the format (yyyy-mm-dd).
    +
    + + +
    +
    Regular expression
    +
    ^\d{4}-\d{2}-\d{2}$
    +
    + +
    • +
+
+
+
+
+ +
+
Issue Date
+
+ +The timestamp in the format (yyyy-mm-dd) since when the product passport is available. + +
+
Name
+
issueDate
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
2000-01-01
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
issueDate
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + Date Constraint +
    + +
    +
    Description
    +
    Constraint fo a timestamp in the format (yyyy-mm-dd).
    +
    + + +
    +
    Regular expression
    +
    ^\d{4}-\d{2}-\d{2}$
    +
    + +
    • +
+
+
+
+
+ +
+
Economic Operator Id
+
+ +The identification of the owner/economic operator of the passport. Proposed, according to ISO 15459, is the CIN (company identification code). Other identification numbers like the tax identification number, value added tax identification number, commercial register number and the like are also valid entries. In the Catena-X network, the BPNL is used for the identification of companies and the information stored like contact information and addresses. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Annex III: +(k) the [...] unique operator identifier code of the economic operator established in the Union responsible for carrying out the tasks set out in Article 4 of Regulation (EU) 2019/1020, or Article 15 of Regulation (EU) on general product safety, or similar tasks pursuant to other EU legislation applicable to the product. + +
+
Name
+
economicOperatorId
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
    +
  • https://catena-x.net/fileadmin/user_upload/Standard-Bibliothek/Update_PDF_Maerz/5_BPDM/CX_-_0010_BUSINESS_PARTNER_NUMBER_PlatformCapabilityBPDM_v_1.0.1.pdf
    • +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
BPNL0123456789ZZ
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
economicOperatorId
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + BPNL Regular Expression +
    + +
    +
    Description
    +
    The provided regular expression ensures that the BPNL is composed of prefix 'BPNL', 10 digits and two alphanumeric letters.
    +
    + + +
    +
    Regular expression
    +
    ^BPNL[a-zA-Z0-9]{12}$
    +
    + +
    • +
+
+
+
+
+ +
+
Passport Identifier
+
+ +The identifier of the product passport, which is an uuidv4. + +
+
Name
+
passportIdentifier
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
    +
  • https://tools.ietf.org/html/rfc4122
    • +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
urn:uuid:550e8400-e29b-41d4-a716-446655440000
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
passportIdentifier
+
+ + +
+
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
    +
    (^[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}$)
    +
    + +
    • +
+
+
+
+
+ +
+
Predecessor
+
+ +Identification of the preceding product passport. If there is no preceding passport, input a dummy value. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Article 8: +(2)(g) [...] Any new product passport shall be linked to the product passport or passports of the original product whenever appropriate. + +
+
Name
+
predecessor
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
    +
  • https://tools.ietf.org/html/rfc4122
    • +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
urn:uuid:00000000-0000-0000-0000-000000000000
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
predecessor
+
+ + +
+
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
    +
    (^[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}$)
    +
    + +
    • +
+
+
+
+
+ +
+
Backup Reference
+
+ +A reference to the data backup of the passport. This mandatory attribute will be further defined in the future. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex III: +(kb) the reference of the certified independent third-party product passport service provider hosting the back-up copy of the product passport. +Article 10 also mentions: +(c) the data included in the product passport shall be stored by the economic operator responsible for its creation or by certified independent third-party product passport service providers authorised to act on their behalf. + +
+
Name
+
backupReference
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
https://dummy.link
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
backupReference
+
+ + +
+
+ +
+
Registration Identifier
+
+ +Identifier in the respective registry. This will be further defined in the future. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 in Article 12: +By [2 years from entering into force of this Regulation], the Commission shall set up and manage a digital registry ("the registry") storing in a secure manner at least the unique product identifier, the unique operator identifier, the unique facility identifiers. In case of products intended to be placed under the customs procedure 'release for free circulation', the registry shall also store the product commodity code. The registry shall also store the batteries' unique identifiers referred to in Article 77(3) of Regulation (EU) 2023/1542. + +
+
Name
+
registrationIdentifier
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
https://dummy.link/ID8283746239078
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
registrationIdentifier
+
+ + +
+
+ +
+
Last Modification
+
+ +Date of the latest modification. + +
+
Name
+
lastModification
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
2000-01-01
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
lastModification
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + Date Constraint +
    + +
    +
    Description
    +
    Constraint fo a timestamp in the format (yyyy-mm-dd).
    +
    + + +
    +
    Regular expression
    +
    ^\d{4}-\d{2}-\d{2}$
    +
    + +
    • +
+
+
+
+
+
+
+

Operation Entity

+
+
+ Entity which includes details such as the manufacturer's identification and the date of production. The date of the putting into service is optional. +
+ +
+

Properties

+
+
+ +
+
Into Service Date
+
+ +Putting into service is the transition from a state of readiness to actual use or operation. The date should be formatted as yyyy-mm-dd. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex VII Part B: +1.the date of manufacture of the battery and, where appropriate, the date of putting into service; +Defined is "putting into service" in Article 3: +(18) "putting into service" means the first use, for its intended purpose, in the Union, of a battery, without having been previously placed on the market. + +
+
Name
+
intoServiceDate
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ + +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
intoServiceDate
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + Date Constraint +
    + +
    +
    Description
    +
    Constraint fo a timestamp in the format (yyyy-mm-dd).
    +
    + + +
    +
    Regular expression
    +
    ^\d{4}-\d{2}-\d{2}$
    +
    + +
    • +
+
+
+
+
+ +
+
Manufacturer
+
+ +Manufacturing information of the product. In the CATENA-X use case, the BPNL and BPNA can be stated. These attributes are mentioned in the ESPR provisional agreement from January 9th 2024 Annex III: +(h) unique operator identifiers other than that of the manufacturer; +(k) the name, contact details and unique operator identifier code of the economic operator established in the Union responsible for carrying out the tasks set out in Article 4 of Regulation (EU) 2019/1020, or Article 15 of Regulation (EU) [.../...] on general product safety, or similar tasks pursuant to other EU legislation applicable to the product. + +
+
Name
+
manufacturer
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#ManufacturerEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
manufacturer
+
+ + +
+
+
+
+

Other Active Materials Entity

+
+
+ Entity for other active materials. +
+ +
+

Properties

+
+
+ +
+
Location
+
+ +The location of the substances of concern within the product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7: +(5) (b) the location of the substances of concern within the product. + +
+
Name
+
location
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Housing
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
location
+
+ + +
+
+ +
+
Recycled
+
+ +The share of the material, which is recovered recycled content from the product. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I: +(h) use or content of recycled materials and recovery of materials, including critical raw materials; + +
+
Name
+
recycled
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#float + +
+
+
+
+
+ +
+
Example
+
12.5
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
recycled
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + Percentage Constraint +
    + +
    +
    Description
    +
    Range constraint for a positive percentage value.
    +
    + + +
    +
    +>= +
    + DefaultScalarValue[value=0.0, typeUri='DefaultScalar[metaModelVersion=SAMM_2_1_0, urn='http://www.w3.org/2001/XMLSchema#float']'] +
    +
    ...
    +
    +< + DefaultScalarValue[value=100.0, typeUri='DefaultScalar[metaModelVersion=SAMM_2_1_0, urn='http://www.w3.org/2001/XMLSchema#float']'] +
    + +
    • +
+
+
+
+
+ +
+
Documentation
+
+ +Documentation accompanying the material. + +
+
Name
+
documentation
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#DocumentationEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
documentation
+
+ + +
+
+ +
+
Critical
+
+ +A flag, if the material is a critical raw material. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I: +(h) use or content of recycled materials and recovery of materials, including critical raw materials; +In Annex II of the connected proposal Act of Critical Raw Materials, a list of critical raw materials can be found. + +
+
Name
+
critical
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#boolean + +
+
+
+
+
+ +
+
Example
+
true
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
critical
+
+ +
+
Reference
+
+
    +
  • https://eur-lex.europa.eu/legal-content/EN/TXT/?uri=COM:2023:0160:FIN
    • +
+
+
+ +
+
+ +
+
Material Identification
+
+ +The chemical material name and identification, in accordance with the specification in the attribute for the list type. Preference is given to the IUPAC name. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Article 7: +(5) (a) the name of the substances of concern present in the product, as follows: + - name(s) in the International Union of Pure and Applied Chemistry (IUPAC) nomenclature, or another international name when IUPAC name is not available; +- other names (usual name, trade name, abbreviation); +- European Community (EC) number, as indicated in the European Inventory of Existing Commercial Chemical Substances (EINECS), the European List of Notified Chemical Substances (ELINCS) or the No Longer Polymer (NLP) list or assigned by the European Chemicals Agency (ECHA), if available; +- the Chemical Abstract Service (CAS) name(s) and number(s), if available; . + +
+
Name
+
materialIdentification
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#MaterialIdEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
materialIdentification
+
+ + +
+
+
+
+

Other HazardousMaterial Entity

+
+
+ Entity for other hazardous materials. +
+ +
+

Properties

+
+
+ +
+
Impact of Substances
+
+ +An accumulation of documents that refer to the impact, especially hazardous substances, on the battery. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1) (s), refers to Article 74: +1. In addition to the information referred to in Article 8a(2) of Directive 2008/98/EC, producers or, where appointed in accordance with Article 57(1), producer responsibility organisations shall make available to end-users and distributors the following information regarding the prevention and management of waste batteries with regard to the categories of batteries that they supply within the territory of a Member State: +[...] +(f) the impact of substances, in particular hazardous substances, present in batteries on the environment and on human health or the safety of persons, including the impact due to inappropriate discarding of waste batteries, such as littering or discarding as unsorted municipal waste. + +
+
Name
+
impactOfSubstances
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#DocumentationEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
impactOfSubstances
+
+ + +
+
+ +
+
Material Unit
+
+ +The unit of concentration chosen from an enumeration: mass percent, volume percent, parts per thousand, parts per million, parts per billion and parts per trillion. + +
+
Name
+
materialUnit
+
+ + + +
+
Characteristic
+
+
+
+
Enumeration
+
+
+
Values
+
+
+
+
    +
  • unit:partPerMillion
    • +
  • unit:percent
    • +
  • unit:percentVolume
    • +
  • unit:partPerThousand
    • +
  • unit:partPerTrillionUs
    • +
  • unit:partPerBillionUs
    • +
+
+
+
+
+ Reference +
+
    +
  • https://eclipse-esmf.github.io/samm-specification/2.1.0/index.html
    • +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
unit:percent
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
materialUnit
+
+ +
+
Reference
+
+
    +
  • https://eclipse-esmf.github.io/samm-specification/2.1.0/index.html
    • +
+
+
+ +
+
+ +
+
Concentration
+
+ +Concentration of the material at the level of the product. This attribute is specially mentioned for substances of concern mentioned in the ESPR proposal from March 30th, 2022 Article 7: +(5) (c) the concentration, maximum concentration or concentration range of the substances of concern, at the level of the product [...]. +Other substances are mentioned for the purpose of recycling in the ESPR provisional agreement from January 9th, 2024 Annex I: +(d) design for recycling, ease and quality of recycling as expressed through: use of easily recyclable materials, safe, easy and non-destructive access to recyclable components and materials or components and materials containing hazardous substances and material composition and homogeneity, possibility for high-purity sorting, number of materials and components used, use of standard components, use of component and material coding standards for the identification of components and materials, number and complexity of processes and tools needed, ease of nondestructive disassembly and re-assembly, conditions for access to product data, conditions for access to or use of hardware and software needed. + + +
+
Name
+
concentration
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#float + +
+
+
+
+
+ +
+
Example
+
5.3
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
concentration
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + Positive Range Constraint +
    + +
    +
    Description
    +
    Constraint for only positive values.
    +
    + + +
    +
    +>= +
    + DefaultScalarValue[value=0.0, typeUri='DefaultScalar[metaModelVersion=SAMM_2_1_0, urn='http://www.w3.org/2001/XMLSchema#float']'] +
    +
    + +
    • +
+
+
+
+
+ +
+
Material Identification
+
+ +The chemical material name and identification, in accordance with the specification in the attribute for the list type. Preference is given to the IUPAC name. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Article 7: +(5) (a) the name of the substances of concern present in the product, as follows: + - name(s) in the International Union of Pure and Applied Chemistry (IUPAC) nomenclature, or another international name when IUPAC name is not available; +- other names (usual name, trade name, abbreviation); +- European Community (EC) number, as indicated in the European Inventory of Existing Commercial Chemical Substances (EINECS), the European List of Notified Chemical Substances (ELINCS) or the No Longer Polymer (NLP) list or assigned by the European Chemicals Agency (ECHA), if available; +- the Chemical Abstract Service (CAS) name(s) and number(s), if available; . + +
+
Name
+
materialIdentification
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#MaterialIdEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
materialIdentification
+
+ + +
+
+ +
+
Documentation
+
+ +Documentation accompanying the material. + +
+
Name
+
documentation
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#DocumentationEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
documentation
+
+ + +
+
+ +
+
Critical
+
+ +A flag, if the material is a critical raw material. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I: +(h) use or content of recycled materials and recovery of materials, including critical raw materials; +In Annex II of the connected proposal Act of Critical Raw Materials, a list of critical raw materials can be found. + +
+
Name
+
critical
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#boolean + +
+
+
+
+
+ +
+
Example
+
true
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
critical
+
+ +
+
Reference
+
+
    +
  • https://eur-lex.europa.eu/legal-content/EN/TXT/?uri=COM:2023:0160:FIN
    • +
+
+
+ +
+
+ +
+
Location
+
+ +The location of the substances of concern within the product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7: +(5) (b) the location of the substances of concern within the product. + +
+
Name
+
location
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Housing
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
location
+
+ + +
+
+
+
+

Part Type Entity

+
+
+ Entity for the part type with manufacturer id and name. +
+ +
+

Properties

+
+
+ +
+
Manufacturer Part ID
+
+ +Part ID as assigned by the manufacturer of the part. The part ID identifies the part in the manufacturer`s dataspace. The part ID references a specific version of a part. The version number must be included in the part ID if it is available. The part ID does not reference a specific instance of a part and must not be confused with the serial number. + +
+
Name
+
manufacturerPartId
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
123-0.740-3434-A
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
manufacturerPartId
+
+ + +
+
+ +
+
Name at manufacturer
+
+ +Name of the part as assigned by the manufacturer. + +
+
Name
+
nameAtManufacturer
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Mirror left
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
nameAtManufacturer
+
+ + +
+
+
+
+

Parts Entity

+
+
+ Possible spare parts of the product with identifiers and names. +
+ +
+

Properties

+
+
+ +
+
Manufacturer Part ID
+
+ +Part ID as assigned by the manufacturer of the part. The part ID identifies the part in the manufacturer`s dataspace. The part ID references a specific version of a part. The version number must be included in the part ID if it is available. The part ID does not reference a specific instance of a part and must not be confused with the serial number. + +
+
Name
+
manufacturerPartId
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
123-0.740-3434-A
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
manufacturerPartId
+
+ + +
+
+ +
+
Name at manufacturer
+
+ +Name of the part as assigned by the manufacturer. + +
+
Name
+
nameAtManufacturer
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Mirror left
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
nameAtManufacturer
+
+ + +
+
+
+
+

Performance Entity

+
+
+ Performance Entity with attributes of the battery including rated and dynamic values. +
+ +
+

Properties

+
+
+ +
+
Rated Performance
+
+ +Rated performance values of the battery such as voltage, round trip efficiency, energy, resistance, power, capacity, temperature ranges and self-discharging rate. + +
+
Name
+
ratedPerformance
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.battery.battery_pass:6.0.0#RatedPerformanceEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
rated
+
+ + +
+
+ +
+
Dynamic Performance
+
+ +Dynamic performance values of the battery. + +
+
Name
+
dynamicPerformance
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.battery.battery_pass:6.0.0#DynamicPerformanceEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
dynamic
+
+ + +
+
+
+
+

Performance Temperature Entity

+
+
+ Entity for temperature values. +
+ +
+

Properties

+
+
+ +
+
Lower Temperature Boundary
+
+ +The lower temperature boundary (in Celsius) refers to the minimum temperature at which a battery can effectively operate. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1): +(l) temperature range the battery can withstand when not in use (reference test). + +
+
Name
+
lowerTemperatureBoundary
+
+ + + +
+
Characteristic
+
+
+
+
Measurement
+
+
+
Degree measurement in celsius.
+
+
+
Unit
+
+
+
+
    +
  • + degree Celsius +
    • +
  • + Symbol °C +
    • +
  • + Code CEL +
    • +
  • + Conversion factor 1 × K +
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#double + +
+
+
+
+
+ +
+
Example
+
-18.0
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
lower
+
+ + +
+
+ +
+
Upper Temperature Boundary
+
+ +The upper temperature boundary (in Celsius) refers to the minimum temperature at which a battery can effectively operate. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1): +(l) temperature range the battery can withstand when not in use (reference test). + +
+
Name
+
upperTemperatureBoundary
+
+ + + +
+
Characteristic
+
+
+
+
Measurement
+
+
+
Degree measurement in celsius.
+
+
+
Unit
+
+
+
+
    +
  • + degree Celsius +
    • +
  • + Symbol °C +
    • +
  • + Code CEL +
    • +
  • + Conversion factor 1 × K +
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#double + +
+
+
+
+
+ +
+
Example
+
60.0
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
upper
+
+ + +
+
+
+
+

Physical Dimension Entity

+
+
+ Entity for the physical dimension with weight, volume and other optional values. +
+ +
+

Properties

+
+
+ +
+
Height
+
+ +The height of the item measured in a specific linear unit which can be declared in the corresponding unit attribute. + +
+
Name
+
height
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.shared.quantity:2.0.0#LinearEntity + +
+
+
+
+
+ + +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
height
+
+ + +
+
+ +
+
Length
+
+ +The length of the item measured in a specific linear unit which can be declared in the corresponding unit attribute. + +
+
Name
+
length
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.shared.quantity:2.0.0#LinearEntity + +
+
+
+
+
+ + +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
length
+
+ + +
+
+ +
+
Width
+
+ +The width of the item measured in a specific linear unit which can be declared in the corresponding unit attribute. + +
+
Name
+
width
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.shared.quantity:2.0.0#LinearEntity + +
+
+
+
+
+ + +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
width
+
+ + +
+
+ +
+
Weight
+
+ +Weight of the product measured in a specific mass unit which can be declared in the corresponding unit attribute. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7: +(2) (b) (i) information on the performance of the product in relation to the product parameters referred to in Annex I; +Annex I (i) weight and volume of the product [...]. + +
+
Name
+
weight
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.shared.quantity:2.0.0#MassEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
weight
+
+ + +
+
+
+
+

Rated Capacity Entity

+
+
+ Entity for rated capacity values. +
+ +
+

Properties

+
+
+ +
+
Capacity Value
+
+ +Value describing the capacity in a specific measurement period, expressed in ampere-hours. + +
+
Name
+
capacityValue
+
+ + + +
+
Characteristic
+
+
+
+
Measurement
+
+
+
Measurement for the capacity expressed in ampere hours as double.
+
+
+
Unit
+
+
+
+
    +
  • + ampere hour +
    • +
  • + Symbol A·h +
    • +
  • + Code AMH +
    • +
  • + Conversion factor 3.6 × 10³ C +
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#double + +
+
+
+
+
+ +
+
Example
+
4.0
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
value
+
+ + +
+
+ +
+
Capacity Threshold Exhaustion
+
+ +Capacity threshold exhaustion refers to the condition where a battery's capacity diminishes to a level that is considered unacceptable for its intended use. The capacity threshold is a predetermined level below which the battery is considered to be no longer effective or reliable for the specific application. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1): +(k) capacity threshold for exhaustion (only for electric vehicle batteries). + +
+
Name
+
capacityThresholdExhaustion
+
+ + + +
+
Characteristic
+
+
+
+
Measurement
+
+
+
Measurement in percent as double.
+
+
+
Unit
+
+
+
+
    +
  • + percent +
    • +
  • + Symbol % +
    • +
  • + Code P1 +
    • +
  • + Conversion factor 1 × 10⁻² +
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#double + +
+
+
+
+
+ +
+
Example
+
80.0
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
thresholdExhaustion
+
+ + +
+
+ +
+
Testing Temperature
+
+ +Temperature refers to the temperature of the battery during it's cycle-life testing or as boundary condition for other rated values in celsius. + +
+
Name
+
testingTemperature
+
+ + + +
+
Characteristic
+
+
+
+
Measurement
+
+
+
Degree measurement in celsius.
+
+
+
Unit
+
+
+
+
    +
  • + degree Celsius +
    • +
  • + Symbol °C +
    • +
  • + Code CEL +
    • +
  • + Conversion factor 1 × K +
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#double + +
+
+
+
+
+ +
+
Example
+
20.0
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
temperature
+
+ + +
+
+
+
+

Rated Energy Entity

+
+
+ Entity for the rated energy. +
+ +
+

Properties

+
+
+ +
+
Energy Value
+
+ +Value describing the energy in a specific measurement period, expressed in kilowatt-hours. + +
+
Name
+
energyValue
+
+ + + +
+
Characteristic
+
+
+
+
Measurement
+
+
+
Measurement for the energy expressed in kilowatt hours as double.
+
+
+
Unit
+
+
+
+
    +
  • + kilowatt hour +
    • +
  • + Symbol kW·h +
    • +
  • + Code KWH +
    • +
  • + Conversion factor 3.6 × 10⁶ J +
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#double + +
+
+
+
+
+ +
+
Example
+
0.5
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
value
+
+ + +
+
+ +
+
Testing Temperature
+
+ +Temperature refers to the temperature of the battery during it's cycle-life testing or as boundary condition for other rated values in celsius. + +
+
Name
+
testingTemperature
+
+ + + +
+
Characteristic
+
+
+
+
Measurement
+
+
+
Degree measurement in celsius.
+
+
+
Unit
+
+
+
+
    +
  • + degree Celsius +
    • +
  • + Symbol °C +
    • +
  • + Code CEL +
    • +
  • + Conversion factor 1 × K +
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#double + +
+
+
+
+
+ +
+
Example
+
20.0
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
temperature
+
+ + +
+
+
+
+

Rated Performance Entity

+
+
+ Entity for rated performance values of the battery. +
+ +
+

Properties

+
+
+ +
+
Voltage
+
+ +Voltage values are mandatory for the battery, with the option to include temperature values voluntarily. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1): +(h) minimal, nominal and maximum voltage, with temperature ranges when relevant. + +
+
Name
+
voltage
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.battery.battery_pass:6.0.0#VoltageEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
voltage
+
+ + +
+
+ +
+
Rated Round Trip Efficiency
+
+ +The efficiency value of a battery refers to the ratio of useful output energy to the input energy, expressed as a percentage. With the option to include temperature values voluntarily. + +
+
Name
+
ratedRoundTripEfficiency
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.battery.battery_pass:6.0.0#RatedRoundTripEfficiencyEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
roundTripEfficiency
+
+ + +
+
+ +
+
Rated Energy
+
+ +Representation of the total amount of energy that the battery can store and subsequently deliver during its discharge cycle. It is necessary to calculate the SOCE. + +
+
Name
+
ratedEnergy
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.battery.battery_pass:6.0.0#RatedEnergyEntity + +
+
+
+
+
+ + +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
energy
+
+ + +
+
+ +
+
Rated Resistance
+
+ +Rated resistance of the battery on the level of the pack, module (optional) and cell. + +
+
Name
+
ratedResistance
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.battery.battery_pass:6.0.0#RatedResistanceEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
resistance
+
+ + +
+
+ +
+
Rated Power
+
+ +The power value is the rate at which energy is delivered or consumed. It is measured in watts (W) and represents how quickly energy is transferred. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (4)(a) refers to Article 10(1), refers to Annex IV Part A: +2. Power (in W) and power fade (in %). +Definition from Annex IV: +(3) "Power" means the amount of energy that a battery is capable of providing over a given period under reference conditions. + +
+
Name
+
ratedPower
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.battery.battery_pass:6.0.0#RatedPowerEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
power
+
+ + +
+
+ +
+
Rated Capacity
+
+ +Capacity value refers to the amount of electric charge that a battery can store and subsequently deliver when needed. It is a fundamental characteristic of a battery and is expressed in ampere-hours. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1): +(g) rated capacity (in Ah); +and in Annex XIII (4)(a) referring to Article 10 (1) and referring to Annex IV Part A: +1. Rated capacity (in Ah) and capacity fade (in %). +And in Annex XIII (1)(a) referring to Annex VI Part A: +6. the capacity; +Definition from Annex IV: +(1) "Rated capacity" means the total number of ampere-hours (Ah) that can be withdrawn from a fully charged battery under reference conditions. + +
+
Name
+
ratedCapacity
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.battery.battery_pass:6.0.0#RatedCapacityEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
capacity
+
+ + +
+
+ +
+
Performance Document
+
+ +The performance document lists information regarding the performance of the battery. This can be an overview about several rated performance attributes. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (3): +[...] results of test reports proving compliance with the requirements laid down in this Regulation or any delegated or implementing act adopted pursuant to this Regulation. +And Annex XIII (4)(a) refers to Article 10(1) and refer to Annex IV Part B: +5. Any calculations performed with the measured parameters, if applicable. + +
+
Name
+
performanceDocument
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#DocumentationEntity + +
+
+
+
+
+ + +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
performanceDocument
+
+ + +
+
+ +
+
Performance Temperature
+
+ +The battery temperatures. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1): +(l) temperature range the battery can withstand when not in use (reference test). + +
+
Name
+
performanceTemperature
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.battery.battery_pass:6.0.0#PerformanceTemperatureEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
temperature
+
+ + +
+
+ +
+
Self Discharging Rate
+
+ +The self-discharge rate of a battery refers to the rate at which the battery loses its stored energy when not in use. It's the discharge of the battery that occurs internally without any external load recorded in percentage for every month. This attribute is mentioned in the Battery Regulation 2023/1542 from 12 July 2023 in Annex XIII (4) (b) refers to Article 14, refers to Annex VII Part A: +4. the evolution of self-discharging rates. + +
+
Name
+
selfDischargingRate
+
+ + + +
+
Characteristic
+
+
+
+
Measurement
+
+
+
Measurement in percent as double.
+
+
+
Unit
+
+
+
+
    +
  • + percent +
    • +
  • + Symbol % +
    • +
  • + Code P1 +
    • +
  • + Conversion factor 1 × 10⁻² +
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#double + +
+
+
+
+
+ +
+
Example
+
0.25
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
selfDischargingRate
+
+ + +
+
+ +
+
Test Report
+
+ +The test reports refer to the testing conducted during the determination of the rated values of the battery. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (3): +[...] results of test reports proving compliance with the requirements laid down in this Regulation or any delegated or implementing act adopted pursuant to this Regulation. +And Annex XIII (4)(a) refers to Article 10(1) and refer to Annex IV Part B: +5. Any calculations performed with the measured parameters, if applicable. + +
+
Name
+
testReport
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#DocumentationEntity + +
+
+
+
+
+ + +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
testReport
+
+ + +
+
+ +
+
Lifetime
+
+ +Attributes for the lifetime evaluation of a battery. + +
+
Name
+
lifetime
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.battery.battery_pass:6.0.0#LifeCycleEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
lifetime
+
+ + +
+
+
+
+

Rated Power Entity

+
+
+ Entity for rated power values. +
+ +
+

Properties

+
+
+ +
+
Power Value
+
+ +Value describing the power in a specific measurement period, expressed in watt. + +
+
Name
+
powerValue
+
+ + + +
+
Characteristic
+
+
+
+
Measurement
+
+
+
Measurement in watt as double.
+
+
+
Unit
+
+
+
+
    +
  • + watt +
    • +
  • + Symbol W +
    • +
  • + Code WTT +
    • +
  • + Conversion factor W +
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#double + +
+
+
+
+
+ +
+
Example
+
40000.0
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
value
+
+ + +
+
+ +
+
Capability at 20 SoC
+
+ +Capability at 20% SoC refers to the battery's capability at 80% State of Charge. This measurement is indicative of the immediate available energy in the battery. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (4)(a) refers to Article 10 (1), refers to Annex IV Part B: +4. Power capability at 80 % and 20 % state of charge. + +
+
Name
+
capabilityAt20SoC
+
+ + + +
+
Characteristic
+
+
+
+
Measurement
+
+
+
Measurement in watt as double.
+
+
+
Unit
+
+
+
+
    +
  • + watt +
    • +
  • + Symbol W +
    • +
  • + Code WTT +
    • +
  • + Conversion factor W +
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#double + +
+
+
+
+
+ +
+
Example
+
35000.0
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
at20SoC
+
+ + +
+
+ +
+
Capability at 80 SoC
+
+ +Capability at 80% SoC refers to the battery's capability at 80% State of Charge. This measurement is indicative of the immediate available energy in the battery. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (4)(a) refers to Article 10 (1), refers to Annex IV Part B: +4. Power capability at 80 % and 20 % state of charge + +
+
Name
+
capabilityAt80SoC
+
+ + + +
+
Characteristic
+
+
+
+
Measurement
+
+
+
Measurement in watt as double.
+
+
+
Unit
+
+
+
+
    +
  • + watt +
    • +
  • + Symbol W +
    • +
  • + Code WTT +
    • +
  • + Conversion factor W +
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#double + +
+
+
+
+
+ +
+
Example
+
39000.0
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
at80SoC
+
+ + +
+
+ +
+
Testing Temperature
+
+ +Temperature refers to the temperature of the battery during it's cycle-life testing or as boundary condition for other rated values in celsius. + +
+
Name
+
testingTemperature
+
+ + + +
+
Characteristic
+
+
+
+
Measurement
+
+
+
Degree measurement in celsius.
+
+
+
Unit
+
+
+
+
    +
  • + degree Celsius +
    • +
  • + Symbol °C +
    • +
  • + Code CEL +
    • +
  • + Conversion factor 1 × K +
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#double + +
+
+
+
+
+ +
+
Example
+
20.0
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
temperature
+
+ + +
+
+
+
+

Rated Resistance Entity

+
+
+ Entity for rated resistance values of the battery on different levels. +
+ +
+

Properties

+
+
+ +
+
Cell Resistance
+
+ +Cell resistance refers to the internal resistance of an individual battery cell in ohms. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1): +(o) internal battery cell and pack resistance; +Definition from Annex IV: +(5) "Internal resistance" means the opposition to the flow of current within a cell or a battery under reference conditions, that is, the sum of electronic resistance and ionic resistance to the contribution to total effective resistance including inductive/capacitive properties. + +
+
Name
+
cellResistance
+
+ + + +
+
Characteristic
+
+
+
+
Measurement
+
+
+
Measurement in ohms as double.
+
+
+
Unit
+
+
+
+
    +
  • + ohm +
    • +
  • + Symbol Ω +
    • +
  • + Code OHM +
    • +
  • + Conversion factor Ω +
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#double + +
+
+
+
+
+ +
+
Example
+
0.025
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
cell
+
+ + +
+
+ +
+
Module Resistance
+
+ +The module resistance in ohms includes the internal resistance of each cell within the module as well as the resistance introduced by interconnecting components such as busbars, connectors, and thermal management systems. + +
+
Name
+
moduleResistance
+
+ + + +
+
Characteristic
+
+
+
+
Measurement
+
+
+
Measurement in ohms as double.
+
+
+
Unit
+
+
+
+
    +
  • + ohm +
    • +
  • + Symbol Ω +
    • +
  • + Code OHM +
    • +
  • + Conversion factor Ω +
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#double + +
+
+
+
+
+ +
+
Example
+
0.2
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
module
+
+ + +
+
+ +
+
Pack Resistance
+
+ +Pack resistance refers to the overall electrical resistance within a battery pack in ohms. This resistance is a combination of the individual resistances in various components within the pack, including the electrodes, connectors, and other conductive elements. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1): +(o) internal battery cell and pack resistance; +Definition from Annex IV: +(5) "Internal resistance" means the opposition to the flow of current within a cell or a battery under reference conditions, that is, the sum of electronic resistance and ionic resistance to the contribution to total effective resistance including inductive/capacitive properties. + +
+
Name
+
packResistance
+
+ + + +
+
Characteristic
+
+
+
+
Measurement
+
+
+
Measurement in ohms as double.
+
+
+
Unit
+
+
+
+
    +
  • + ohm +
    • +
  • + Symbol Ω +
    • +
  • + Code OHM +
    • +
  • + Conversion factor Ω +
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#double + +
+
+
+
+
+ +
+
Example
+
0.55
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
pack
+
+ + +
+
+ +
+
Testing Temperature
+
+ +Temperature refers to the temperature of the battery during it's cycle-life testing or as boundary condition for other rated values in celsius. + +
+
Name
+
testingTemperature
+
+ + + +
+
Characteristic
+
+
+
+
Measurement
+
+
+
Degree measurement in celsius.
+
+
+
Unit
+
+
+
+
    +
  • + degree Celsius +
    • +
  • + Symbol °C +
    • +
  • + Code CEL +
    • +
  • + Conversion factor 1 × K +
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#double + +
+
+
+
+
+ +
+
Example
+
20.0
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
temperature
+
+ + +
+
+
+
+

Rated Round Trip Efficiency Entity

+
+
+ Entity for the rated round trip efficiency. +
+ +
+

Properties

+
+
+ +
+
Depth of Discharge
+
+ +Depth of discharge is a measure used to quantify the extent to which the battery has been discharged relative to its maximum capacity during its cycle-life testing. It represents the percentage of the total available capacity that has been drained or used during a particular discharge cycle. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (4) (a) refers to Article 10 (1), refers to Annex IV Part B: +3. Depth of discharge in the cycle-life test. + +
+
Name
+
depthOfDischarge
+
+ + + +
+
Characteristic
+
+
+
+
Measurement
+
+
+
Measurement in percent as double.
+
+
+
Unit
+
+
+
+
    +
  • + percent +
    • +
  • + Symbol % +
    • +
  • + Code P1 +
    • +
  • + Conversion factor 1 × 10⁻² +
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#double + +
+
+
+
+
+ +
+
Example
+
90.5
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
depthOfDischarge
+
+ + +
+
+ +
+
Initial Round Trip Efficiency
+
+ +The efficiency value of a battery refers to the ratio of useful output energy to the input energy, expressed as a percentage. It quantifies how effectively a battery can convert and deliver stored energy during the discharge process relative to the energy input during charging. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1): +(n) initial round trip energy efficiency and at 50 % of cycle-life. + +
+
Name
+
initialRoundTripEfficiency
+
+ + + +
+
Characteristic
+
+
+
+
Measurement
+
+
+
Measurement in percent as double.
+
+
+
Unit
+
+
+
+
    +
  • + percent +
    • +
  • + Symbol % +
    • +
  • + Code P1 +
    • +
  • + Conversion factor 1 × 10⁻² +
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#double + +
+
+
+
+
+ +
+
Example
+
96.0
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
initial
+
+ + +
+
+ +
+
Round Trip Efficiency 50 Percent
+
+ +The round trip efficiency at 50 percent refers to the efficiency of a rechargeable battery's energy storage and retrieval process when the battery has undergone approximately half of its expected number of charge-discharge cycles. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1): +(n) initial round trip energy efficiency and at 50 % of cycle-life. + +
+
Name
+
roundTripEfficiency50Percent
+
+ + + +
+
Characteristic
+
+
+
+
Measurement
+
+
+
Measurement in percent as double.
+
+
+
Unit
+
+
+
+
    +
  • + percent +
    • +
  • + Symbol % +
    • +
  • + Code P1 +
    • +
  • + Conversion factor 1 × 10⁻² +
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#double + +
+
+
+
+
+ +
+
Example
+
89.0
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
50PercentLife
+
+ + +
+
+ +
+
Testing Temperature
+
+ +Temperature refers to the temperature of the battery during it's cycle-life testing or as boundary condition for other rated values in celsius. + +
+
Name
+
testingTemperature
+
+ + + +
+
Characteristic
+
+
+
+
Measurement
+
+
+
Degree measurement in celsius.
+
+
+
Unit
+
+
+
+
    +
  • + degree Celsius +
    • +
  • + Symbol °C +
    • +
  • + Code CEL +
    • +
  • + Conversion factor 1 × K +
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#double + +
+
+
+
+
+ +
+
Example
+
20.0
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
temperature
+
+ + +
+
+
+
+

Record Entity

+
+
+ Entity for a dynamic record with a value and timestamp. +
+ +
+

Properties

+
+
+ +
+
Percent Value
+
+ +A value as a percentage in the form of a double. + +
+
Name
+
percentValue
+
+ + + +
+
Characteristic
+
+
+
+
Measurement
+
+
+
Measurement in percent as double.
+
+
+
Unit
+
+
+
+
    +
  • + percent +
    • +
  • + Symbol % +
    • +
  • + Code P1 +
    • +
  • + Conversion factor 1 × 10⁻² +
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#double + +
+
+
+
+
+ +
+
Example
+
50.0
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
value
+
+ + +
+
+ +
+
Data Record Time
+
+ +The entry date and time corresponding to when a specific parameter was measured. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (4): +(d) information and data resulting from its use, including the number of charging and discharging cycles and negative events, such as accidents, as well as periodically recorded information on the operating environmental conditions, including temperature, and on the state of charge. + +
+
Name
+
dataRecordTime
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#dateTime + +
+
+
+
+
+ +
+
Example
+
2023-12-07T10:39:13.576+01:00
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
time
+
+ + +
+
+
+
+

Remaining Power Entity

+
+
+ Entity for the remaining power. +
+ +
+

Properties

+
+
+ +
+
Data Record Time
+
+ +The entry date and time corresponding to when a specific parameter was measured. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (4): +(d) information and data resulting from its use, including the number of charging and discharging cycles and negative events, such as accidents, as well as periodically recorded information on the operating environmental conditions, including temperature, and on the state of charge. + +
+
Name
+
dataRecordTime
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#dateTime + +
+
+
+
+
+ +
+
Example
+
2023-12-07T10:39:13.576+01:00
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
time
+
+ + +
+
+ +
+
Power Value
+
+ +Value describing the power in a specific measurement period, expressed in watt. + +
+
Name
+
powerValue
+
+ + + +
+
Characteristic
+
+
+
+
Measurement
+
+
+
Measurement in watt as double.
+
+
+
Unit
+
+
+
+
    +
  • + watt +
    • +
  • + Symbol W +
    • +
  • + Code WTT +
    • +
  • + Conversion factor W +
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#double + +
+
+
+
+
+ +
+
Example
+
40000.0
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
value
+
+ + +
+
+
+
+

Remaining Resistance Entity

+
+
+ Entity for the remaining battery resistance. +
+ +
+

Properties

+
+
+ +
+
Remaining Pack Resistance
+
+ +Pack resistance refers to the overall electrical resistance within a battery pack. This resistance is a combination of the individual resistances in various components within the pack, including the electrodes, connectors, and other conductive elements. This attribute is mentioned in the Battery Regulation 2023/1542 from 12 July 2023 in Annex XIII (4) (b) refers to Article 14, refers to Annex VII Part A: +5. where possible, the ohmic resistance. + +
+
Name
+
remainingPackResistance
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.battery.battery_pass:6.0.0#RemainingResistanceEntityRecord + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
pack
+
+ + +
+
+ +
+
Remaining Module Resistance
+
+ +Module resistance in ohms includes the internal resistance of each cell within the module as well as the resistance introduced by interconnecting components such as busbars, connectors, and thermal management systems. + +
+
Name
+
remainingModuleResistance
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.battery.battery_pass:6.0.0#RemainingResistanceEntityRecord + +
+
+
+
+
+ + +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
module
+
+ + +
+
+ +
+
Remaining Cell Resistance
+
+ +Cell resistance refers to the internal resistance of an individual battery cell expressed in ohms. This attribute is mentioned in the Battery Regulation 2023/1542 from 12 July 2023 in Annex XIII (4) (b) refers to Article 14, refers to Annex VII Part A: +5. where possible, the ohmic resistance. + +
+
Name
+
remainingCellResistance
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.battery.battery_pass:6.0.0#RemainingResistanceEntityRecord + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
cell
+
+ + +
+
+
+
+

Remaining Resistance Entity Record

+
+
+ Entity for the remaining battery resistance with a timestamp and value. +
+ +
+

Properties

+
+
+ +
+
Data Record Time
+
+ +The entry date and time corresponding to when a specific parameter was measured. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (4): +(d) information and data resulting from its use, including the number of charging and discharging cycles and negative events, such as accidents, as well as periodically recorded information on the operating environmental conditions, including temperature, and on the state of charge. + +
+
Name
+
dataRecordTime
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#dateTime + +
+
+
+
+
+ +
+
Example
+
2023-12-07T10:39:13.576+01:00
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
time
+
+ + +
+
+ +
+
Remaining Resistance Value
+
+ +The remaining resistance value expressed in ohms. + +
+
Name
+
remainingResistanceValue
+
+ + + +
+
Characteristic
+
+
+
+
Measurement
+
+
+
Measurement for ohm as double.
+
+
+
Unit
+
+
+
+
    +
  • + ohm +
    • +
  • + Symbol Ω +
    • +
  • + Code OHM +
    • +
  • + Conversion factor Ω +
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#double + +
+
+
+
+
+ +
+
Example
+
0.3
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
value
+
+ + +
+
+
+
+

Resistance Increase Entity

+
+
+ Entity for the increase of the battery resistance. +
+ +
+

Properties

+
+
+ +
+
Pack Resistance Increase
+
+ +Pack resistance increase refers to the overall electrical resistance within a battery pack. This resistance is a combination of the individual resistances in various components within the pack, including the electrodes, connectors, and other conductive elements. The rise in the pack resistance is expressed as a percentage in reference to the initial value. +This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (4)(a) refers to Article 10(1) and refers to Annex IV Part A: +3. Internal resistance (in ") and internal resistance increase (in %). +Definition from Annex IV: +(5) "Internal resistance" means the opposition to the flow of current within a cell or a battery under reference conditions, that is, the sum of electronic resistance and ionic resistance to the contribution to total effective resistance including inductive/capacitive properties. + +
+
Name
+
packResistanceIncrease
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.battery.battery_pass:6.0.0#RecordEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
pack
+
+ + +
+
+ +
+
module Resistance Increase
+
+ +The module resistance increase includes the internal resistance of each cell within the module as well as the resistance introduced by interconnecting components such as busbars, connectors, and thermal management systems. The rise in the module resistance is expressed as a percentage in reference to the initial value. + +
+
Name
+
moduleResistanceIncrease
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.battery.battery_pass:6.0.0#RecordEntity + +
+
+
+
+
+ + +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
module
+
+ + +
+
+ +
+
Cell Resistance Increase
+
+ +Cell resistance increase refers to the internal resistance of an individual battery cell. The rise in the cell resistance is expressed as a percentage in reference to the initial value. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (4)(a) refers to Article 10(1) and refers to Annex IV Part A: +3. Internal resistance (in ohms) and internal resistance increase (in %). +Definition from Annex IV: +(5) "Internal resistance" means the opposition to the flow of current within a cell or a battery under reference conditions, that is, the sum of electronic resistance and ionic resistance to the contribution to total effective resistance including inductive/capacitive properties. + +
+
Name
+
cellResistanceIncrease
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.battery.battery_pass:6.0.0#RecordEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
cell
+
+ + +
+
+
+
+

Safety Entity

+
+
+ Entity with the attributes safety measurements, meaning of labels, safe discharging and dismantling. These are all documents. Additionally information about usable extinguish agent can be provided. +
+ +
+

Properties

+
+
+ +
+
Usable Extinguish Agent
+
+ +The usable extinguish agents for the battery in case of a fire. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1)(a) and refers to Annex VI Part A +9. usable extinguishing agent. + +
+
Name
+
usableExtinguishAgent
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.battery.battery_pass:6.0.0#ExtinguishAgentEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
usableExtinguishAgent
+
+ + +
+
+ +
+
Safety Measures
+
+ +Safety instruction in the form of a documentation. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (2): +(d) safety measures. + +
+
Name
+
safetyMeasures
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#DocumentationEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
safetyMeasures
+
+ + +
+
+ +
+
Meaning of Labels
+
+ +Documentation on the meaning of labels on a battery which provide information to help users understand the various symbols, markings, and information present on the battery's label. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1)(s) and refers to Article 74 (1): +(e) the meaning of the labels and symbols on batteries in accordance with Article 13 or printed on their packaging or in the documents accompanying batteries [...]. + +
+
Name
+
meaningOfLabels
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#DocumentationEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
meaningOfLabels
+
+ + +
+
+ +
+
Safe Discharging
+
+ +Safe discharging documentation explaining for example the setting of a minimum voltage threshold for the battery. Discharging a battery below this threshold can lead to damage, reduced capacity, and safety hazards. + +
+
Name
+
safeDischarging
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#DocumentationEntity + +
+
+
+
+
+ + +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
safeDischarging
+
+ + +
+
+ +
+
Dismantling
+
+ +Dismantling refers to the proper way of dismantling the battery itself. It refers to the process of taking apart the battery for various purposes, such as recycling, disposal, or examination of its components. This attribute is mentioned in the Battery Regulation 2023/1542 from 12 July 2023 in Annex XIII (2) (c) dismantling information, including at least: +- exploded diagrams of the battery system/pack showing the location of battery cells, +- disassembly sequences, +- type and number of fastening techniques to be unlocked, +- tools required for disassembly, +- warnings if risk of damaging parts exist, +- amount of cells used and layout. + +
+
Name
+
dismantling
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#DocumentationEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
dismantling
+
+ + +
+
+ +
+
Removal From Appliance
+
+ +Removal refers to the proper process of disassembling a battery from an appliance, typically for purposes such as repairs, replacements, or disposal. + +
+
Name
+
removalFromAppliance
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#DocumentationEntity + +
+
+
+
+
+ + +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
removalFromAppliance
+
+ + +
+
+
+
+

Sources Entity

+
+
+ Entity for a possible spare part sources. +
+ +
+

Properties

+
+
+ +
+
Sources Identification
+
+ +The identifier of a spare part producer of the product. In the Catena-X network, the BPNL is used for the identification of companies and the information stored for this like contact information and addresses. + +
+
Name
+
sourcesIdentification
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
    +
  • https://catena-x.net/fileadmin/user_upload/Standard-Bibliothek/Update_PDF_Maerz/5_BPDM/CX_-_0010_BUSINESS_PARTNER_NUMBER_PlatformCapabilityBPDM_v_1.0.1.pdf
    • +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
BPNL0123456789ZZ
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
id
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + BPNL Regular Expression +
    + +
    +
    Description
    +
    The provided regular expression ensures that the BPNL is composed of prefix 'BPNL', 10 digits and two alphanumeric letters.
    +
    + + +
    +
    Regular expression
    +
    ^BPNL[a-zA-Z0-9]{12}$
    +
    + +
    • +
+
+
+
+
+
+
+

Spare Part Entity

+
+
+ Information regarding possible spare parts. This is mentioned in the ESPR proposal from March 30th, 2022 Annex I: +(b) ease of repair and maintenance as expressed through: characteristics, availability and delivery time of spare parts, modularity, compatibility with commonly available spare parts, availability of repair and maintenance instructions, number of materials and components used, use of standard components, use of component and material coding standards for the identification of components and materials, number and complexity of processes and tools needed, ease of non-destructive disassembly and re-assembly, conditions for access to product data, conditions for access to or use of hardware and software needed; +(c) the Global Trade Identification Number as provided for in standard ISO/IEC 15459-6 or equivalent of products or their parts. +
+ +
+

Properties

+
+
+ +
+
Spare Part Sources
+
+ +Sources of possible spare parts. + +
+
Name
+
sparePartSources
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#SourcesEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
producer
+
+ + +
+
+ +
+
Spare Part
+
+ +Possible spare parts of the product. + +
+
Name
+
sparePart
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#PartsEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
sparePart
+
+ + +
+
+
+
+

Sustainability Document Entity

+
+
+ Sustainability Document Entity which encapsulates relevant information in the form of documents. +
+ +
+

Properties

+
+
+ +
+
Separate Collection
+
+ +Documentation about separate collection of batteries involve information on how to properly collect, handle, and recycle batteries to ensure environmental sustainability and compliance with regulations. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1) (s), refers to Article 74: +1. In addition to the information referred to in Article 8a(2) of Directive 2008/98/EC, producers or, where appointed in accordance with Article 57(1), producer responsibility organisations shall make available to end-users and distributors the following information regarding the prevention and management of waste batteries with regard to the categories of batteries that they supply within the territory of a Member State: +(a) the role of end-users in contributing to waste prevention, including by information on good practices and recommendations concerning the use of batteries aimed at extending their use phase and the possibilities of re-use, preparation for re-use, preparation for repurposing, repurposing and remanufacturing; +(b) the role of end-users in contributing to the separate collection of waste batteries in accordance with their obligations under Article 64 to allow their treatment; +(c) the separate collection, take-back and collection points, preparation for re-use, preparation for repurposing and treatment available for waste batteries; +(d) the necessary safety instructions to handle waste batteries, including in relation to the risks associated with, and the handling of, batteries containing lithium; +(e) the meaning of the labels and symbols on batteries in accordance with Article 13 or printed on their packaging or in the documents accompanying batteries; and +(f) the impact of substances, in particular hazardous substances, present in batteries on the environment and on human health or the safety of persons, including the impact due to inappropriate discarding of waste batteries, such as littering or discarding as unsorted municipal waste. + +
+
Name
+
separateCollection
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#DocumentationEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
separateCollection
+
+ + +
+
+ +
+
Waste Prevention
+
+ +Documentation about waste prevention for batteries which include guidelines, recommendations, and information on minimizing the environmental impact associated with the use and disposal of batteries. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1) (s), refers to Article 74 (1) which call Article 8a of Directive 2008/98/EC: +2. Member States shall take the necessary measures to ensure that the waste holders targeted by the extended producer responsibility schemes established in accordance with Article 8 (1), are informed about waste prevention measures, centres for re-use and preparing for re-use, take-back and collection systems, and the prevention of littering. Member States shall also take measures to create incentives for the waste holders to assume their responsibility to deliver their waste into the separate collection systems in place, notably, where appropriate, through economic incentives or regulations. + +
+
Name
+
wastePrevention
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#DocumentationEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
wastePrevention
+
+ + +
+
+ +
+
EU Taxonomy Disclosure Statement
+
+ +Optional disclosure regarding the EU taxonomy, with the choice to voluntarily provide the EU Taxonomy disclosure through the battery passport. + +
+
Name
+
euTaxonomyDisclosureStatement
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#DocumentationEntity + +
+
+
+
+
+ + +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
euTaxonomyDisclosureStatement
+
+ + +
+
+ +
+
Sustainability Report
+
+ +Voluntarily making the Sustainability Report available via the battery passport. A report containing the information concerning the sustainability in form of a document. + +
+
Name
+
sustainabilityReport
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#DocumentationEntity + +
+
+
+
+
+ + +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
sustainabilityReport
+
+ + +
+
+
+
+

Sustainability Entity

+
+
+ Entity which includes information on the carbon footprint, sustainability documents and the status of the battery. +
+ +
+

Properties

+
+
+ +
+
sustainability Documents
+
+ +Sustainability documents of the battery. + +
+
Name
+
sustainabilityDocuments
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.battery.battery_pass:6.0.0#SustainabilityDocumentEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
documents
+
+ + +
+
+ +
+
Carbon Footprint
+
+ +The carbon footprint of the battery calculated as kg of carbon dioxide equivalent per one kWh of the total energy provided by the battery over its expected service life. Relevant attributes are the value, the unit, the referenced rulebook, the lifecycle where applied, the declaration, the performance class, the type (PCF), the declaration and the facility. These attributes are mentioned in the Battery regulation 2023/1542 from 12 July 2023 in several places. +Annex XIII (1) (c) refers to Article 7 (2) which refers to Article 7 (1)(d): +1. For electric vehicle batteries, rechargeable industrial batteries with a capacity greater than 2 kWh and LMT batteries a carbon footprint declaration shall be drawn up for each battery model per manufacturing plant, in accordance with the implementing act referred to in the fourth subparagraph and containing, at least, the following information: +[...] (d) the carbon footprint of the battery, calculated as kg of carbon dioxide equivalent per one kWh of the total energy provided by the battery over its expected service life; +And as well in Article 7: +2. Electric vehicle batteries, rechargeable industrial batteries with a capacity greater than 2 kWh and LMT batteries shall bear a conspicuous, clearly legible and indelible label indicating the carbon footprint of the battery referred to in paragraph 1, first subparagraph, point (d) and declaring the carbon footprint performance class to which the relevant battery model per manufacturing plant corresponds. +Further specified in Annex XIII (1) (c) and refers to Article 7 (1): +[...] The Commission shall, by 18 February 2024 for electric vehicle batteries, 18 February 2025 for rechargeable industrial batteries, except those with external storage, 18 February 2027 for LMT batteries and 18 February 2029 for industrial batteries with external storage, adopt: +(a) a delegated act in accordance with Article 89 to supplement this Regulation by establishing the methodology for the calculation and verification of the carbon footprint of the battery referred to in the first subparagraph, point (d), in accordance with the essential elements set out in Annex II; +These parameters are defined by Article 3: +(21) "carbon footprint" means the sum of greenhouse gas emissions and greenhouse gas removals in a product system, expressed as carbon dioxide equivalents and based on a Product Environmental Footprint (PEF) study using the single impact category of climate change; +and defined by Annex II (2): +(e) "life cycle" means the consecutive and interlinked stages of a product system, from raw material acquisition or generation from natural resources to final disposal (ISO 14040:2006 or an equivalent standard). + +
+
Name
+
carbonFootprint
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#FootprintEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
carbonFootprint
+
+ + +
+
+ +
+
State
+
+ +The status of the product (original, repurposed, re-used, remanufactured or waste) to indicated, whether it is a used product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Annex I: +(j) incorporation of used components. + +
+
Name
+
state
+
+ + + +
+
Characteristic
+
+
+
+
Enumeration
+
+
+
Values
+
+
+
+
    +
  • original
    • +
  • repurposed
    • +
  • re-used
    • +
  • remanufactured
    • +
  • waste
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
original
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
status
+
+ + +
+
+
+
+

Voltage Entity

+
+
+ Entity for voltage values. +
+ +
+

Properties

+
+
+ +
+
Minimum Voltage
+
+ +Minimum voltage refers to the lowest voltage the battery is able to reach. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1): +(h) minimal, nominal and maximum voltage, with temperature ranges when relevant. + +
+
Name
+
minVoltage
+
+ + + +
+
Characteristic
+
+
+
+
Measurement
+
+
+
Measurement for volt as a double.
+
+
+
Unit
+
+
+
+
    +
  • + volt +
    • +
  • + Symbol V +
    • +
  • + Code VLT +
    • +
  • + Conversion factor V +
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#double + +
+
+
+
+
+ +
+
Example
+
2.5
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
min
+
+ + +
+
+ +
+
Maximum Voltage
+
+ +Maximum voltage refers to the highest voltage the battery is able to reach. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1): +(h) minimal, nominal and maximum voltage, with temperature ranges when relevant. + +
+
Name
+
maxVoltage
+
+ + + +
+
Characteristic
+
+
+
+
Measurement
+
+
+
Measurement for volt as a double.
+
+
+
Unit
+
+
+
+
    +
  • + volt +
    • +
  • + Symbol V +
    • +
  • + Code VLT +
    • +
  • + Conversion factor V +
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#double + +
+
+
+
+
+ +
+
Example
+
4.2
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
max
+
+ + +
+
+ +
+
Nominal Voltage
+
+ +Nominal voltage is a standardized or average voltage value assigned to the battery. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1): +(h) minimal, nominal and maximum voltage, with temperature ranges when relevant. + +
+
Name
+
nominalVoltage
+
+ + + +
+
Characteristic
+
+
+
+
Measurement
+
+
+
Measurement for volt as a double.
+
+
+
Unit
+
+
+
+
    +
  • + volt +
    • +
  • + Symbol V +
    • +
  • + Code VLT +
    • +
  • + Conversion factor V +
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#double + +
+
+
+
+
+ +
+
Example
+
3.7
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
nominal
+
+ + +
+
+ +
+
Testing Temperature
+
+ +Temperature refers to the temperature of the battery during it's cycle-life testing or as boundary condition for other rated values in celsius. + +
+
Name
+
testingTemperature
+
+ + + +
+
Characteristic
+
+
+
+
Measurement
+
+
+
Degree measurement in celsius.
+
+
+
Unit
+
+
+
+
    +
  • + degree Celsius +
    • +
  • + Symbol °C +
    • +
  • + Code CEL +
    • +
  • + Conversion factor 1 × K +
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#double + +
+
+
+
+
+ +
+
Example
+
20.0
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
temperature
+
+ + +
+
+
+
+

Warranty Entity

+
+
+ Entity for the warranty with a value and unit. +
+ +
+

Properties

+
+
+ +
+
Life Value
+
+ +The value as an integer for the respective lifespan. + +
+
Name
+
lifeValue
+
+ + + +
+
Characteristic
+
+
+
+
Quantifiable
+
+
+
Duration
+
+
+
Characteristic for the life span value as an integer.
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#integer + +
+
+
+
+
+ +
+
Example
+
36
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
lifeValue
+
+ + +
+
+ +
+
Life Unit
+
+ +The unit of the respective lifespan expressed through the possible units day, month, cycle, year and runningOrOperatingHour. + +
+
Name
+
lifeUnit
+
+ + + +
+
Characteristic
+
+
+
+
Enumeration
+
+
+
Values
+
+
+
+
    +
  • unit:day
    • +
  • unit:month
    • +
  • unit:year
    • +
  • unit:cycle
    • +
  • unit:runningOrOperatingHour
    • +
+
+
+
+
+ Reference +
+
    +
  • https://eclipse-esmf.github.io/samm-specification/2.1.0/index.html
    • +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
unit:month
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
lifeUnit
+
+ +
+
Reference
+
+
    +
  • https://eclipse-esmf.github.io/samm-specification/2.1.0/index.html
    • +
+
+
+ +
+
+
+ +
+ Third party licenses + +
+ +
+ + +
+ + + \ No newline at end of file diff --git a/io.catenax.battery.battery_pass/6.0.0/gen/BatteryPass.json b/io.catenax.battery.battery_pass/6.0.0/gen/BatteryPass.json new file mode 100644 index 000000000..637757984 --- /dev/null +++ b/io.catenax.battery.battery_pass/6.0.0/gen/BatteryPass.json @@ -0,0 +1,533 @@ +{ + "characteristics" : { + "physicalDimension" : { + "length" : { + "value" : 20.0, + "unit" : "unit:millimetre" + }, + "width" : { + "value" : 20.0, + "unit" : "unit:millimetre" + }, + "weight" : { + "value" : 20.0, + "unit" : "unit:gram" + }, + "height" : { + "value" : 20.0, + "unit" : "unit:millimetre" + } + }, + "warranty" : { + "lifeValue" : 36, + "lifeUnit" : "unit:day" + } + }, + "metadata" : { + "backupReference" : "https://dummy.link", + "registrationIdentifier" : "https://dummy.link/ID8283746239078", + "economicOperatorId" : "BPNL0123456789ZZ", + "lastModification" : "2000-01-01", + "predecessor" : "urn:uuid:00000000-0000-0000-0000-000000000000", + "issueDate" : "2000-01-01", + "version" : "1.0.0", + "passportIdentifier" : "urn:uuid:550e8400-e29b-41d4-a716-446655440000", + "status" : "draft", + "expirationDate" : "2030-01-01" + }, + "commercial" : { + "placedOnMarket" : "2000-01-01", + "purpose" : [ "automotive" ] + }, + "identification" : { + "chemistry" : "Nickel Cobalt Manganese (NCM)", + "idDmc" : "34567890", + "identification" : { + "batch" : [ { + "value" : "BID12345678", + "key" : "batchId" + } ], + "codes" : [ { + "value" : "8703 24 10 00", + "key" : "TARIC" + } ], + "type" : { + "manufacturerPartId" : "123-0.740-3434-A", + "nameAtManufacturer" : "Mirror left" + }, + "classification" : [ { + "classificationStandard" : "GIN 20510-21513", + "classificationID" : "1004712", + "classificationDescription" : "Generic standard for classification of parts in the automotive industry." + } ], + "serial" : [ { + "value" : "SN12345678", + "key" : "partInstanceId" + } ], + "dataCarrier" : { + "carrierType" : "QR", + "carrierLayout" : "upper-left side" + } + }, + "category" : "SLI" + }, + "performance" : { + "rated" : { + "roundTripEfficiency" : { + "depthOfDischarge" : 90.5, + "temperature" : 20.0, + "50PercentLife" : 89.0, + "initial" : 96.0 + }, + "selfDischargingRate" : 0.25, + "performanceDocument" : [ { + "contentType" : "URL", + "header" : "Example Document XYZ", + "content" : "https://dummy.link" + } ], + "testReport" : [ { + "contentType" : "URL", + "header" : "Example Document XYZ", + "content" : "https://dummy.link" + } ], + "temperature" : { + "lower" : -18.0, + "upper" : 60.0 + }, + "lifetime" : { + "report" : [ { + "contentType" : "URL", + "header" : "Example Document XYZ", + "content" : "https://dummy.link" + } ], + "cycleLifeTesting" : { + "temperature" : 20.0, + "depthOfDischarge" : 90.5, + "appliedDischargeRate" : 4.0, + "cycles" : 1500, + "appliedChargeRate" : 3.0 + }, + "expectedYears" : 8 + }, + "power" : { + "at20SoC" : 35000.0, + "temperature" : 20.0, + "value" : 40000.0, + "at80SoC" : 39000.0 + }, + "resistance" : { + "temperature" : 20.0, + "cell" : 0.025, + "pack" : 0.55, + "module" : 0.2 + }, + "voltage" : { + "temperature" : 20.0, + "min" : 2.5, + "nominal" : 3.7, + "max" : 4.2 + }, + "energy" : { + "temperature" : 20.0, + "value" : 0.5 + }, + "capacity" : { + "temperature" : 20.0, + "value" : 4.0, + "thresholdExhaustion" : 80.0 + } + }, + "dynamic" : { + "selfDischargingRate" : 0.25, + "roundTripEfficiency" : { + "remaining" : { + "value" : 50.0, + "time" : "2023-12-07T10:39:13.576+01:00" + }, + "fade" : { + "value" : 50.0, + "time" : "2023-12-07T10:39:13.576+01:00" + } + }, + "operatingEnvironment" : [ { + "contentType" : "URL", + "header" : "Example Document XYZ", + "content" : "https://dummy.link" + } ], + "stateOfCharge" : { + "value" : 50.0, + "time" : "2023-12-07T10:39:13.576+01:00" + }, + "performanceDocument" : [ { + "contentType" : "URL", + "header" : "Example Document XYZ", + "content" : "https://dummy.link" + } ], + "fullCycles" : { + "value" : 1500, + "time" : "2023-12-07T10:39:13.576+01:00" + }, + "power" : { + "remaining" : { + "value" : 40000.0, + "time" : "2023-12-07T10:39:13.576+01:00" + }, + "fade" : { + "value" : 50.0, + "time" : "2023-12-07T10:39:13.576+01:00" + } + }, + "negativeEvents" : [ { + "contentType" : "URL", + "header" : "Example Document XYZ", + "content" : "https://dummy.link" + } ], + "resistance" : { + "increase" : { + "cell" : { + "value" : 50.0, + "time" : "2023-12-07T10:39:13.576+01:00" + }, + "pack" : { + "value" : 50.0, + "time" : "2023-12-07T10:39:13.576+01:00" + }, + "module" : { + "value" : 50.0, + "time" : "2023-12-07T10:39:13.576+01:00" + } + }, + "remaining" : { + "cell" : { + "value" : 0.3, + "time" : "2023-12-07T10:39:13.576+01:00" + }, + "pack" : { + "value" : 0.3, + "time" : "2023-12-07T10:39:13.576+01:00" + }, + "module" : { + "value" : 0.3, + "time" : "2023-12-07T10:39:13.576+01:00" + } + } + }, + "capacity" : { + "fade" : { + "value" : 50.0, + "time" : "2023-12-07T10:39:13.576+01:00" + }, + "throughput" : { + "value" : 4.0, + "time" : "2023-12-07T10:39:13.576+01:00" + }, + "capacity" : { + "value" : 4.0, + "time" : "2023-12-07T10:39:13.576+01:00" + } + }, + "energy" : { + "remaining" : { + "value" : 0.5, + "time" : "2023-12-07T10:39:13.576+01:00" + }, + "soce" : { + "value" : 50.0, + "time" : "2023-12-07T10:39:13.576+01:00" + }, + "throughput" : { + "value" : 0.5, + "time" : "2023-12-07T10:39:13.576+01:00" + } + } + } + }, + "sources" : [ { + "header" : "Example Document XYZ", + "category" : "Product Specifications", + "type" : "URL", + "content" : "https://dummy.link" + } ], + "materials" : { + "hazardous" : { + "cadmium" : { + "concentration" : 5.3, + "location" : "Housing", + "critical" : true, + "impactOfSubstances" : [ { + "contentType" : "URL", + "header" : "Example Document XYZ", + "content" : "https://dummy.link" + } ], + "materialUnit" : "unit:partPerMillion", + "documentation" : [ { + "contentType" : "URL", + "header" : "Example Document XYZ", + "content" : "https://dummy.link" + } ] + }, + "other" : [ { + "critical" : true, + "impactOfSubstances" : [ { + "contentType" : "URL", + "header" : "Example Document XYZ", + "content" : "https://dummy.link" + } ], + "documentation" : [ { + "contentType" : "URL", + "header" : "Example Document XYZ", + "content" : "https://dummy.link" + } ], + "concentration" : 5.3, + "materialIdentification" : [ { + "type" : "CAS", + "name" : "phenolphthalein", + "id" : "201-004-7" + } ], + "location" : "Housing", + "materialUnit" : "unit:partPerMillion" + } ], + "mercury" : { + "concentration" : 5.3, + "location" : "Housing", + "critical" : true, + "impactOfSubstances" : [ { + "contentType" : "URL", + "header" : "Example Document XYZ", + "content" : "https://dummy.link" + } ], + "materialUnit" : "unit:partPerMillion", + "documentation" : [ { + "contentType" : "URL", + "header" : "Example Document XYZ", + "content" : "https://dummy.link" + } ] + }, + "lead" : { + "recycled" : 12.5, + "critical" : true, + "impactOfSubstances" : [ { + "contentType" : "URL", + "header" : "Example Document XYZ", + "content" : "https://dummy.link" + } ], + "documentation" : [ { + "contentType" : "URL", + "header" : "Example Document XYZ", + "content" : "https://dummy.link" + } ], + "location" : "Housing", + "concentration" : 5.3, + "materialUnit" : "unit:partPerMillion" + } + }, + "active" : { + "nickel" : { + "location" : "Housing", + "recycled" : 12.5, + "critical" : true, + "documentation" : [ { + "contentType" : "URL", + "header" : "Example Document XYZ", + "content" : "https://dummy.link" + } ] + }, + "lithium" : { + "location" : "Housing", + "recycled" : 12.5, + "critical" : true, + "documentation" : [ { + "contentType" : "URL", + "header" : "Example Document XYZ", + "content" : "https://dummy.link" + } ] + }, + "cobalt" : { + "location" : "Housing", + "recycled" : 12.5, + "critical" : true, + "documentation" : [ { + "contentType" : "URL", + "header" : "Example Document XYZ", + "content" : "https://dummy.link" + } ] + }, + "other" : [ { + "location" : "Housing", + "materialIdentification" : [ { + "type" : "CAS", + "name" : "phenolphthalein", + "id" : "201-004-7" + } ], + "recycled" : 12.5, + "critical" : true, + "documentation" : [ { + "contentType" : "URL", + "header" : "Example Document XYZ", + "content" : "https://dummy.link" + } ] + } ], + "lead" : { + "recycled" : 12.5, + "critical" : true, + "impactOfSubstances" : [ { + "contentType" : "URL", + "header" : "Example Document XYZ", + "content" : "https://dummy.link" + } ], + "documentation" : [ { + "contentType" : "URL", + "header" : "Example Document XYZ", + "content" : "https://dummy.link" + } ], + "location" : "Housing", + "concentration" : 5.3, + "materialUnit" : "unit:partPerMillion" + } + }, + "composition" : [ { + "unit" : "unit:partPerMillion", + "recycled" : 12.5, + "critical" : true, + "renewable" : 23.5, + "documentation" : [ { + "contentType" : "URL", + "header" : "Example Document XYZ", + "content" : "https://dummy.link" + } ], + "concentration" : 5.3, + "location" : "Housing", + "id" : [ { + "type" : "CAS", + "name" : "phenolphthalein", + "id" : "201-004-7" + } ] + } ] + }, + "safety" : { + "usableExtinguishAgent" : [ { + "fireClass" : "A, B", + "document" : [ { + "contentType" : "URL", + "header" : "Example Document XYZ", + "content" : "https://dummy.link" + } ], + "media" : "Dry Powder" + } ], + "safeDischarging" : [ { + "contentType" : "URL", + "header" : "Example Document XYZ", + "content" : "https://dummy.link" + } ], + "meaningOfLabels" : [ { + "contentType" : "URL", + "header" : "Example Document XYZ", + "content" : "https://dummy.link" + } ], + "dismantling" : [ { + "contentType" : "URL", + "header" : "Example Document XYZ", + "content" : "https://dummy.link" + } ], + "removalFromAppliance" : [ { + "contentType" : "URL", + "header" : "Example Document XYZ", + "content" : "https://dummy.link" + } ], + "safetyMeasures" : [ { + "contentType" : "URL", + "header" : "Example Document XYZ", + "content" : "https://dummy.link" + } ] + }, + "handling" : { + "applicable" : true, + "content" : { + "producer" : [ { + "id" : "BPNL0123456789ZZ" + } ], + "sparePart" : [ { + "manufacturerPartId" : "123-0.740-3434-A", + "nameAtManufacturer" : "Mirror left" + } ] + } + }, + "conformity" : { + "declarationOfConformityId" : "0978234-34567890-01", + "thirdPartyAssurance" : [ { + "contentType" : "URL", + "header" : "Example Document XYZ", + "content" : "https://dummy.link" + } ], + "resultOfTestReport" : [ { + "contentType" : "URL", + "header" : "Example Document XYZ", + "content" : "https://dummy.link" + } ], + "declarationOfConformity" : [ { + "contentType" : "URL", + "header" : "Example Document XYZ", + "content" : "https://dummy.link" + } ], + "dueDiligencePolicy" : [ { + "contentType" : "URL", + "header" : "Example Document XYZ", + "content" : "https://dummy.link" + } ] + }, + "operation" : { + "intoServiceDate" : "7345-31-31", + "manufacturer" : { + "facility" : [ { + "facility" : "BPNA1234567890AA" + } ], + "manufacturingDate" : "2000-01-31", + "manufacturer" : "BPNL6XI3KZ55MzYB" + } + }, + "sustainability" : { + "documents" : { + "separateCollection" : [ { + "contentType" : "URL", + "header" : "Example Document XYZ", + "content" : "https://dummy.link" + } ], + "sustainabilityReport" : [ { + "contentType" : "URL", + "header" : "Example Document XYZ", + "content" : "https://dummy.link" + } ], + "euTaxonomyDisclosureStatement" : [ { + "contentType" : "URL", + "header" : "Example Document XYZ", + "content" : "https://dummy.link" + } ], + "wastePrevention" : [ { + "contentType" : "URL", + "header" : "Example Document XYZ", + "content" : "https://dummy.link" + } ] + }, + "carbonFootprint" : [ { + "lifecycle" : "main product production", + "rulebook" : [ { + "contentType" : "URL", + "header" : "Example Document XYZ", + "content" : "https://dummy.link" + } ], + "unit" : "kg CO2 / kWh", + "performanceClass" : "A", + "manufacturingPlant" : [ { + "facility" : "BPNA1234567890AA" + } ], + "type" : "Climate Change Total", + "value" : 12.678, + "declaration" : [ { + "contentType" : "URL", + "header" : "Example Document XYZ", + "content" : "https://dummy.link" + } ] + } ], + "status" : "original" + } +} \ No newline at end of file diff --git a/io.catenax.battery.battery_pass/6.0.0/gen/BatteryPass.yml b/io.catenax.battery.battery_pass/6.0.0/gen/BatteryPass.yml new file mode 100644 index 000000000..4b46b2b3b --- /dev/null +++ b/io.catenax.battery.battery_pass/6.0.0/gen/BatteryPass.yml @@ -0,0 +1,2430 @@ +--- +openapi: 3.0.3 +info: + title: Battery Passport + version: v6 +servers: +- url: catenax.io/api/v6 + variables: + api-version: + default: v6 +paths: + /{tenant-id}/battery-pass: + get: + tags: + - BatteryPass + operationId: getBatteryPass + 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/BatteryPass' + "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/BatteryPass' + totalItems: + type: number + totalPages: + type: number + pageSize: + type: number + currentPage: + type: number + urn_samm_io.catenax.battery.battery_pass_6.0.0_CategoryEnumeration: + type: string + description: "Enumeration with the values, portable battery; starting, lighting\ + \ and ignition battery (SLI); light means of transport battery (LMT); electric\ + \ vehicle battery (EV), industrial battery and incorporated battery." + enum: + - SLI + - LMT + - EV + - industrial + - portable + - incorporated + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_IdentifierCharacteristic: + type: string + description: Characteristic for Identifiers. + 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.serial_part_3.0.0_KeyTrait: + type: string + description: Constraint that ensures that the standard keys and custom key prefixes + can be used. + pattern: ^(manufacturerId|partInstanceId|batchId|van|customKey:\w+)$ + urn_samm_io.catenax.serial_part_3.0.0_ValueCharacteristic: + type: string + description: The value of an identifier. + urn_samm_io.catenax.serial_part_3.0.0_KeyValueList: + description: "A list of key value pairs for local identifiers, which are composed\ + \ of a key and a corresponding value." + type: object + properties: + key: + description: 'The key of a local identifier. ' + $ref: '#/components/schemas/urn_samm_io.catenax.serial_part_3.0.0_KeyTrait' + value: + description: The value of an identifier. + $ref: '#/components/schemas/urn_samm_io.catenax.serial_part_3.0.0_ValueCharacteristic' + required: + - key + - value + urn_samm_io.catenax.serial_part_3.0.0_LocalIdentifierCharacteristic: + description: "A single serialized part may have multiple attributes, that uniquely\ + \ identify a that part in a specific dataspace (e.g. the manufacturer`s dataspace)" + type: array + items: + $ref: '#/components/schemas/urn_samm_io.catenax.serial_part_3.0.0_KeyValueList' + uniqueItems: true + urn_samm_io.catenax.batch_3.0.0_KeyTrait: + type: string + description: Constraint that ensures that the predefined keys are used. + pattern: ^(manufacturerId|batchId|customKey:\w+)$ + urn_samm_io.catenax.batch_3.0.0_ValueCharacteristic: + type: string + description: The value of an identifier. + urn_samm_io.catenax.batch_3.0.0_KeyValueList: + description: "A list of key value pairs for local identifiers, which are composed\ + \ of a key and a corresponding value." + type: object + properties: + key: + description: The key of a local identifier. + $ref: '#/components/schemas/urn_samm_io.catenax.batch_3.0.0_KeyTrait' + value: + description: The value of an identifier. + $ref: '#/components/schemas/urn_samm_io.catenax.batch_3.0.0_ValueCharacteristic' + required: + - key + - value + urn_samm_io.catenax.batch_3.0.0_LocalIdentifierCharacteristic: + description: "A batch may have multiple attributes, which uniquely identify\ + \ that batch in a specific dataspace(e.g. the manufacturer`s dataspace)" + type: array + items: + $ref: '#/components/schemas/urn_samm_io.catenax.batch_3.0.0_KeyValueList' + uniqueItems: true + urn_samm_io.catenax.part_type_information_1.0.0_PartIdCharacteristic: + type: string + description: "The part ID is a multi-character string, usually assigned by an\ + \ ERP system." + urn_samm_io.catenax.part_type_information_1.0.0_PartNameCharacteristic: + type: string + description: Part name in string format from the respective system in the value + chain. + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PartTypeCharacteristic: + description: Characteristic for the part type. + type: object + properties: + manufacturerPartId: + description: Part ID as assigned by the manufacturer of the part. The part + ID identifies the part in the manufacturer`s dataspace. The part ID references + a specific version of a part. The version number must be included in the + part ID if it is available. The part ID does not reference a specific + instance of a part and must not be confused with the serial number. + $ref: '#/components/schemas/urn_samm_io.catenax.part_type_information_1.0.0_PartIdCharacteristic' + nameAtManufacturer: + description: Name of the part as assigned by the manufacturer. + $ref: '#/components/schemas/urn_samm_io.catenax.part_type_information_1.0.0_PartNameCharacteristic' + required: + - manufacturerPartId + - nameAtManufacturer + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_CodeEntity: + description: Code entity with code key and value. + type: object + properties: + key: + description: |- + The code key for the identification of the product. Examples are GTIN, hash, DID, ISBN, TARIC. This attribute is mentioned in the ESPR proposal from March 30th, 2022 ANNEX III: + (b) the unique product identifier at the level indicated in the applicable delegated act adopted pursuant to Article 4; + (c) the Global Trade Identification Number as provided for in standard ISO/IEC 15459-6 or equivalent of products or their parts; + (d) relevant commodity codes, such as a TARIC code as defined in Council Regulation (EEC) No 2658/87. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_IdentifierCharacteristic' + value: + description: The code value for the identification of the product in regard + to the chosen code name. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_IdentifierCharacteristic' + required: + - key + - value + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_CodeList: + description: A list of additional codes. + type: array + items: + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_CodeEntity' + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DataCarrierCharacteristic: + description: Data Carrier Characteristic for the product. + type: object + properties: + carrierType: + description: |- + The type of data carrier such as a QR code on the product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 8: + (2) (b) the types of data carrier to be used. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + carrierLayout: + description: |- + The positioning of data carrier on the product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 8: + (2) (c) the layout in which the data carrier shall be presented and its positioning. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + required: + - carrierType + - carrierLayout + urn_samm_io.catenax.shared.part_classification_1.0.0_ClassificationStandardCharacteristic: + type: string + description: Identified classification standards that align to the Catena-X + needs. + urn_samm_io.catenax.shared.part_classification_1.0.0_ClassificationIDCharacteristic: + type: string + description: "It can be numeric or a string, depending on the chosen classification\ + \ standard." + urn_samm_io.catenax.shared.part_classification_1.0.0_ClassificationEntity: + description: Encapsulates data related to the classification of the part. + type: object + properties: + classificationStandard: + description: Identified classification standards that align to the Catena-X + needs. + $ref: '#/components/schemas/urn_samm_io.catenax.shared.part_classification_1.0.0_ClassificationStandardCharacteristic' + classificationID: + description: The classification ID of the part type according to the corresponding + standard definition mentioned in the key value pair. + $ref: '#/components/schemas/urn_samm_io.catenax.shared.part_classification_1.0.0_ClassificationIDCharacteristic' + classificationDescription: + description: Optional property describing the classification standard. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + required: + - classificationStandard + - classificationID + urn_samm_io.catenax.shared.part_classification_1.0.0_ClassificationCharacteristic: + description: Classification characteristic enabling a set of further properties. + type: array + items: + $ref: '#/components/schemas/urn_samm_io.catenax.shared.part_classification_1.0.0_ClassificationEntity' + uniqueItems: true + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_IdentificationCharacteristic: + description: Identification information of the product. + type: object + properties: + serial: + description: |- + Identifier for a serial part if available. This is mentioned in the ESPR provisional agreement from January 9th, 2024 Recital (27): + [...] an 'item' usually means a single unit of a model. + $ref: '#/components/schemas/urn_samm_io.catenax.serial_part_3.0.0_LocalIdentifierCharacteristic' + batch: + description: |- + Identifier for a batch part if available. Identifier for a serial part if available. This is mentioned in the ESPR provisional agreement from January 9th, 2024 Recital (27): + [...] a 'batch' usually means a subset of a specific model composed of all products produced in a specific manufacturing plant at a specific moment in time [...]. + $ref: '#/components/schemas/urn_samm_io.catenax.batch_3.0.0_LocalIdentifierCharacteristic' + type: + description: |- + Identifier on the level of a part model or type. Identifier for a serial part if available. This is mentioned in the ESPR provisional agreement from January 9th, 2024 Recital (27): + [...] A 'model' usually means a version of a product of which all units share the same technical characteristics relevant for the ecodesign requirements and the same model identifier [...]. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PartTypeCharacteristic' + codes: + description: Codes for identification. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_CodeList' + dataCarrier: + description: |- + The type and layout of the data carrier on the product. These are mentioned in the ESPR proposal from March 30th, 2022 Article 8: + (b) the types of data carrier to be used; + (c) the layout in which the data carrier shall be presented and its positioning; + Article 2 defines: + (30) 'data carrier' means a linear bar code symbol, a two-dimensional symbol or other automatic identification data capture medium that can be read by a device. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DataCarrierCharacteristic' + classification: + description: Property describing the classification of a part. + $ref: '#/components/schemas/urn_samm_io.catenax.shared.part_classification_1.0.0_ClassificationCharacteristic' + required: + - type + - codes + - dataCarrier + - classification + urn_samm_io.catenax.battery.battery_pass_6.0.0_IdentificationCharacteristic: + description: "Battery identification involves specific battery identifiers,\ + \ including those assigned locally by the manufacturer." + type: object + properties: + category: + description: |- + The battery category, which can be a portable battery; starting, lighting and ignition battery (SLI); light means of transport battery (LMT); electric vehicle battery (EV), industrial battery and incorporated battery. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1) (a) and refers to ANNEX VI Part A: + 2. the battery category and information identifying the battery in accordance with Article 38(6). + $ref: '#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_CategoryEnumeration' + idDmc: + description: |- + The unique identifier of the product, when it is placed on the market. Through this identifier a web link can be accessed. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Article 77: + 3. The battery passport shall be accessible through the QR code referred to in Article 13(6) which links to a unique identifier that the economic operator placing the battery on the market shall attribute to it. The QR code and the unique identifier shall comply with the ISO/IEC standards 15459-1:2014, 15459-2:2015, 15459-3:2014, 15459-4:2014, 15459-5:2014 and 15459-6:2014 or their equivalent. + Defined is the QR code in Article 3: + (24) "QR code" means a machine-readable matrix code that links to information as required by this Regulation. + (66) "unique identifier" means a unique string of characters for the identification of batteries that also enables a web link to the battery passport. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_IdentifierCharacteristic' + chemistry: + description: |- + Battery chemistry refers to the specific chemical composition and reactions that occur within a battery to produce and store electrical energy. The chemistry has to be stated as detailed as possible for example: the Nickel Cobalt Manganese battery 'NCM'. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1) (a) and refers to ANNEX VI Part A: + 7. the chemestry. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + identification: + description: "Identification information of the product, especially identifiers\ + \ and codes. These are mentioned in the ESPR provisional agreement from\ + \ January 9th, 2024 ANNEX III:\n(b) the unique product identifier at the\ + \ level indicated in the applicable delegated act adopted pursuant to\ + \ Article 4.\nAdditionally in Article 9 regarding general requirements\ + \ for the product passport is stated that:\nA product passport shall meet\ + \ the following conditions:\n(a) it shall be connected through a data\ + \ carrier to a persistent unique product identifier;\n(e) the information\ + \ included in the product passport shall refer to the product model, batch,\ + \ or item as specified in the delegated act adopted pursuant to Article\ + \ 4.\nArticle 2 Definitions: \n(31) 'unique product identifier' means\ + \ a unique string of characters for the identification of products that\ + \ also enables a web link to the product passport;\nRecital (27): A 'model'\ + \ usually means a version of a product of which all units share the same\ + \ technical characteristics relevant for the ecodesign requirements and\ + \ the same model identifier, a 'batch' usually means a subset of a specific\ + \ model composed of all products produced in a specific manufacturing\ + \ plant at a specific moment in time and an 'item' usually means a single\ + \ unit of a model." + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_IdentificationCharacteristic' + required: + - category + - idDmc + - chemistry + - identification + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DateTrait: + type: string + description: Constraint fo a timestamp in the format (yyyy-mm-dd). + pattern: "^\\d{4}-\\d{2}-\\d{2}$" + urn_samm_io.catenax.shared.business_partner_number_2.0.0_BpnaTrait: + type: string + description: "The provided regular expression ensures that the BPNA is composed\ + \ of prefix 'BPNA', 10 digits and two alphanumeric letters." + pattern: "^BPNA[a-zA-Z0-9]{12}$" + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_FacilityEntity: + description: The entity for a facility with the BPNA identifier. + type: object + properties: + facility: + description: |- + The identifier used for a location. This attribute is mentioned in the ESPR provisional agreement from January 9th 2024 Annex III: + (i) unique facility identifiers; + Article 2 Definitions: (33) 'unique facility identifier' means a unique string of characters for the identification of locations or buildings involved in the value chain of a product or used by actors involved in the value chain of a product. + $ref: '#/components/schemas/urn_samm_io.catenax.shared.business_partner_number_2.0.0_BpnaTrait' + required: + - facility + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_FacilityList: + description: List of facilities. + type: array + items: + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_FacilityEntity' + urn_samm_io.catenax.shared.business_partner_number_2.0.0_BpnlTrait: + type: string + description: "The provided regular expression ensures that the BPNL is composed\ + \ of prefix 'BPNL', 10 digits and two alphanumeric letters." + pattern: "^BPNL[a-zA-Z0-9]{12}$" + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_ManufacturerCharacteristic: + description: Manufacturing information. + type: object + properties: + facility: + description: |- + The identifier used for a location. In the CATENA-X use case, the BPNA can be stated. This attribute is mentioned in the ESPR provisional agreement from January 9th 2024 Annex III: + (i) unique facility identifiers; + Article 2 Definitions: (33) 'unique facility identifier' means a unique string of characters for the identification of locations or buildings involved in the value chain of a product or used by actors involved in the value chain of a product. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_FacilityList' + manufacturer: + description: |- + The main manufacturer, if different from the passport owner, represented by an identification number. In the Catena-X use case, the BPNL can be stated. This attribute is mentioned in the ESPR provisional agreement from January 9th 2024 Annex III: + (h) unique operator identifiers other than that of the manufacturer; + (k) the name, contact details and unique operator identifier code of the economic operator established in the Union responsible for carrying out the tasks set out in Article 4 of Regulation (EU) 2019/1020, or Article 15 of Regulation (EU) [.../...] on general product safety, or similar tasks pursuant to other EU legislation applicable to the product. + $ref: '#/components/schemas/urn_samm_io.catenax.shared.business_partner_number_2.0.0_BpnlTrait' + manufacturingDate: + description: "The timestamp in the format (yyyy-mm-dd) of the manufacturing\ + \ date as the final step in production process (e.g. final quality check,\ + \ ready-for-shipment event)." + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DateTrait' + required: + - facility + - manufacturer + urn_samm_io.catenax.battery.battery_pass_6.0.0_OperationCharacteristic: + description: Characteristic includes details for operational data. + type: object + properties: + intoServiceDate: + description: "Putting into service is the transition from a state of readiness\ + \ to actual use or operation. The date should be formatted as yyyy-mm-dd.\ + \ This attribute is mentioned in the Battery regulation 2023/1542 from\ + \ 12 July 2023 in Annex VII Part B: \n1.the date of manufacture of the\ + \ battery and, where appropriate, the date of putting into service;\n\ + Defined is \"putting into service\" in Article 3:\n(18) \"putting into\ + \ service\" means the first use, for its intended purpose, in the Union,\ + \ of a battery, without having been previously placed on the market." + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DateTrait' + manufacturer: + description: |- + Manufacturing information of the product. In the CATENA-X use case, the BPNL and BPNA can be stated. These attributes are mentioned in the ESPR provisional agreement from January 9th 2024 Annex III: + (h) unique operator identifiers other than that of the manufacturer; + (k) the name, contact details and unique operator identifier code of the economic operator established in the Union responsible for carrying out the tasks set out in Article 4 of Regulation (EU) 2019/1020, or Article 15 of Regulation (EU) [.../...] on general product safety, or similar tasks pursuant to other EU legislation applicable to the product. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_ManufacturerCharacteristic' + required: + - manufacturer + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_LifeValueCharacteristic: + type: number + description: Characteristic for the life span value as an integer. + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_LifeEnumeration: + type: string + description: "Enumeration with the possible units day, month, cycle, year and\ + \ runningOrOperatingHour." + enum: + - unit:day + - unit:month + - unit:year + - unit:cycle + - unit:runningOrOperatingHour + urn_samm_io.catenax.battery.battery_pass_6.0.0_WarrantyCharacteristic: + description: Characteristic for the warranty. + type: object + properties: + lifeValue: + description: The value as an integer for the respective lifespan. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_LifeValueCharacteristic' + lifeUnit: + description: "The unit of the respective lifespan expressed through the\ + \ possible units day, month, cycle, year and runningOrOperatingHour." + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_LifeEnumeration' + required: + - lifeValue + - lifeUnit + urn_samm_io.catenax.shared.quantity_2.0.0_QuantityValueCharacteristic: + type: number + description: The quantity value associated with the unit expressed as float. + urn_samm_io.catenax.shared.quantity_2.0.0_LinearUnitEnumeration: + type: string + pattern: "[a-zA-Z]*:[a-zA-Z]+" + description: "The unit of a linear attribute that may be used for height, width,\ + \ length and diameter." + enum: + - unit:millimetre + - unit:centimetre + - unit:metre + - unit:kilometre + - unit:inch + - unit:foot + - unit:yard + urn_samm_io.catenax.shared.quantity_2.0.0_LinearCharacteristic: + description: Characteristic for linear measurements of an item. + type: object + properties: + value: + description: The quantity value associated with the unit. + $ref: '#/components/schemas/urn_samm_io.catenax.shared.quantity_2.0.0_QuantityValueCharacteristic' + unit: + description: The unit of a linear attribute. + $ref: '#/components/schemas/urn_samm_io.catenax.shared.quantity_2.0.0_LinearUnitEnumeration' + required: + - value + - unit + urn_samm_io.catenax.shared.quantity_2.0.0_MassUnitEnumeration: + type: string + pattern: "[a-zA-Z]*:[a-zA-Z]+" + description: Enumeration for mass units. + enum: + - unit:gram + - unit:kilogram + - unit:tonneMetricTon + - unit:tonUsOrShortTonUkorus + - unit:ounceAvoirdupois + - unit:pound + urn_samm_io.catenax.shared.quantity_2.0.0_MassCharacteristic: + description: Characteristic for mass measurements of an item. + type: object + properties: + value: + description: The quantity value associated with the unit. + $ref: '#/components/schemas/urn_samm_io.catenax.shared.quantity_2.0.0_QuantityValueCharacteristic' + unit: + description: The unit of a mass related attribute. + $ref: '#/components/schemas/urn_samm_io.catenax.shared.quantity_2.0.0_MassUnitEnumeration' + required: + - value + - unit + urn_samm_io.catenax.battery.battery_pass_6.0.0_PhysicalDimensionCharacteristic: + description: Characteristic for the physical dimensions. + type: object + properties: + height: + description: The height of the item measured in a specific linear unit which + can be declared in the corresponding unit attribute. + $ref: '#/components/schemas/urn_samm_io.catenax.shared.quantity_2.0.0_LinearCharacteristic' + length: + description: The length of the item measured in a specific linear unit which + can be declared in the corresponding unit attribute. + $ref: '#/components/schemas/urn_samm_io.catenax.shared.quantity_2.0.0_LinearCharacteristic' + width: + description: The width of the item measured in a specific linear unit which + can be declared in the corresponding unit attribute. + $ref: '#/components/schemas/urn_samm_io.catenax.shared.quantity_2.0.0_LinearCharacteristic' + weight: + description: |- + Weight of the product measured in a specific mass unit which can be declared in the corresponding unit attribute. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7: + (2) (b) (i) information on the performance of the product in relation to the product parameters referred to in Annex I; + Annex I (i) weight and volume of the product [...]. + $ref: '#/components/schemas/urn_samm_io.catenax.shared.quantity_2.0.0_MassCharacteristic' + required: + - weight + urn_samm_io.catenax.battery.battery_pass_6.0.0_CharacteristicsElement: + description: Characteristic for the product characteristics. + type: object + properties: + warranty: + description: |- + The warranty of the battery. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in ANNEX XIII: + (m) period for which the commercial warranty for the calendar life applies. + $ref: '#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_WarrantyCharacteristic' + physicalDimension: + description: |- + The weight of the battery. For calculation of the energy density, the volume is also needed. The energy density of a battery is measured in watt-hours per kilogram (Wh/kg) and watt-hours per liter (Wh/L). These measures indicate how much energy a battery can store relative to its weight and volume, respectively. Other measurements are optional.These are mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1)(a) and refers to Annex VI Part A: + 5. the weight. + $ref: '#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_PhysicalDimensionCharacteristic' + required: + - warranty + - physicalDimension + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_HeaderTrait: + type: string + description: Constraint for a maximum of 100 characters. + maxLength: 100 + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentationEntity: + description: "Entity for a document with a header, type and content." + type: object + properties: + content: + description: The content of the document e.g a link. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + contentType: + description: "The type of content which can be expected in the \"content\"\ + \ property. Examples are a link, restricted link, pdf, excel, etc." + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + header: + description: The header as a short description of the document with a maximum + of 100 characters. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_HeaderTrait' + required: + - content + - contentType + - header + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentList: + description: List of documents. + type: array + items: + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentationEntity' + urn_samm_io.catenax.battery.battery_pass_6.0.0_SustainabilityDocumentCharacteristic: + description: Characteristic for sustainability documents of the battery. + type: object + properties: + separateCollection: + description: |- + Documentation about separate collection of batteries involve information on how to properly collect, handle, and recycle batteries to ensure environmental sustainability and compliance with regulations. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1) (s), refers to Article 74: + 1. In addition to the information referred to in Article 8a(2) of Directive 2008/98/EC, producers or, where appointed in accordance with Article 57(1), producer responsibility organisations shall make available to end-users and distributors the following information regarding the prevention and management of waste batteries with regard to the categories of batteries that they supply within the territory of a Member State: + (a) the role of end-users in contributing to waste prevention, including by information on good practices and recommendations concerning the use of batteries aimed at extending their use phase and the possibilities of re-use, preparation for re-use, preparation for repurposing, repurposing and remanufacturing; + (b) the role of end-users in contributing to the separate collection of waste batteries in accordance with their obligations under Article 64 to allow their treatment; + (c) the separate collection, take-back and collection points, preparation for re-use, preparation for repurposing and treatment available for waste batteries; + (d) the necessary safety instructions to handle waste batteries, including in relation to the risks associated with, and the handling of, batteries containing lithium; + (e) the meaning of the labels and symbols on batteries in accordance with Article 13 or printed on their packaging or in the documents accompanying batteries; and + (f) the impact of substances, in particular hazardous substances, present in batteries on the environment and on human health or the safety of persons, including the impact due to inappropriate discarding of waste batteries, such as littering or discarding as unsorted municipal waste. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentList' + wastePrevention: + description: |- + Documentation about waste prevention for batteries which include guidelines, recommendations, and information on minimizing the environmental impact associated with the use and disposal of batteries. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1) (s), refers to Article 74 (1) which call Article 8a of Directive 2008/98/EC: + 2. Member States shall take the necessary measures to ensure that the waste holders targeted by the extended producer responsibility schemes established in accordance with Article 8 (1), are informed about waste prevention measures, centres for re-use and preparing for re-use, take-back and collection systems, and the prevention of littering. Member States shall also take measures to create incentives for the waste holders to assume their responsibility to deliver their waste into the separate collection systems in place, notably, where appropriate, through economic incentives or regulations. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentList' + euTaxonomyDisclosureStatement: + description: "Optional disclosure regarding the EU taxonomy, with the choice\ + \ to voluntarily provide the EU Taxonomy disclosure through the battery\ + \ passport." + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentList' + sustainabilityReport: + description: Voluntarily making the Sustainability Report available via + the battery passport. A report containing the information concerning the + sustainability in form of a document. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentList' + required: + - separateCollection + - wastePrevention + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PositiveTrait: + type: number + description: Constraint for only positive values. + minimum: 0.0 + exclusiveMinimum: false + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_CategoryEnumeration: + type: string + description: Enumeration of the 19 impact categories in accordance to EN15804+A2. + enum: + - Climate Change Total + - Climate Change Fossil + - Climate Change Biogenic Removals and Emissions + - Climate Change Land Use and Land Use Change + - Ozone Depletion + - Acidification + - Eutrophication Aquatic Freshwater + - Eutrophication Fresh Marine + - Eutrophication Terrestrial + - Photochemical Ozone Formation + - Abiotic Depletion- Minerals and Metals + - Fossil Fuels + - Water Use + - Particulate Matter Emissions + - "Ionizing Radiation, Human Health" + - Eco-Toxicity + - "Human Toxicity, Cancer Effects" + - "Human Toxicity, Non-Cancer Effects" + - Land Use Related Impacts/Soil Quality + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_FootprintEntity: + description: "Footprint Entity for the carbon and environmental footprint with\ + \ the total value, unit, impact category type, lifecycle, rulebook, declaration,\ + \ performance class and the facility." + type: object + properties: + value: + description: | + The value of the footprint of the product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Annex I: + (l) the environmental footprint of the product, expressed as a quantification, in accordance with the applicable delegated act, of a product's life cycle environmental impacts, whether in relation to one or more environmental impact categories or an aggregated set of impact categories; + (m) the carbon footprint of the product; + (ma) the material footprint of the product. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PositiveTrait' + rulebook: + description: The applied rulebook for the environmental footprint of the + product. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentList' + lifecycle: + description: "The lifecycle stage, to which the environmental footprint\ + \ corresponds. These could be for example \"raw material acquisition and\ + \ pre-processing\", \"main product production\", \"distribution\" or \"\ + end of life and recycling\"." + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + unit: + description: "The unit of measurement of the environmental impact category.\ + \ For each impact category a specific unit is used. If an aggregation\ + \ is used, utilize the normalization and weighting methods used in the\ + \ referenced rulebook." + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + type: + description: |- + The type of the environmental footprint of the product. This could be one of the environmental impact categories. This attribute is mentioned in the ESPR provisional agreement from January 9th 2024 Article 7: + (2)(b)(i) information on the performance of the product in relation to one or more of the product parameters referred to in Annex I, including a scoring of reparability or durability, carbon footprint or environmental footprint; + Annex I: + (l) the environmental footprint of the product, expressed as a quantification, in accordance with the applicable delegated act, of a product's life cycle environmental impacts, whether in relation to one or more environmental impact categories or an aggregated set of impact categories. + (m) the carbon footprint of the product; + (ma) the material footprint of the product. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_CategoryEnumeration' + performanceClass: + description: The performance classification of the footprint. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + manufacturingPlant: + description: The manufacturing plant of the footprint in the specific lifecycle + phase. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_FacilityList' + declaration: + description: 'The footprint declaration in the format of a link ' + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentList' + required: + - value + - rulebook + - lifecycle + - unit + - type + - manufacturingPlant + - declaration + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_FootprintList: + description: Footprint List for the environmental footprint. + type: array + items: + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_FootprintEntity' + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_StateEnumeration: + type: string + description: "Enumeration defined as original, repurposed, re-used, remanufactured\ + \ or waste." + enum: + - original + - repurposed + - re-used + - remanufactured + - waste + urn_samm_io.catenax.battery.battery_pass_6.0.0_SustainabilityCharacteristic: + description: Characteristic for sustainability attributes. + type: object + properties: + documents: + description: Sustainability documents of the battery. + $ref: '#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_SustainabilityDocumentCharacteristic' + carbonFootprint: + description: |- + The carbon footprint of the battery calculated as kg of carbon dioxide equivalent per one kWh of the total energy provided by the battery over its expected service life. Relevant attributes are the value, the unit, the referenced rulebook, the lifecycle where applied, the declaration, the performance class, the type (PCF), the declaration and the facility. These attributes are mentioned in the Battery regulation 2023/1542 from 12 July 2023 in several places. + Annex XIII (1) (c) refers to Article 7 (2) which refers to Article 7 (1)(d): + 1. For electric vehicle batteries, rechargeable industrial batteries with a capacity greater than 2 kWh and LMT batteries a carbon footprint declaration shall be drawn up for each battery model per manufacturing plant, in accordance with the implementing act referred to in the fourth subparagraph and containing, at least, the following information: + [...] (d) the carbon footprint of the battery, calculated as kg of carbon dioxide equivalent per one kWh of the total energy provided by the battery over its expected service life; + And as well in Article 7: + 2. Electric vehicle batteries, rechargeable industrial batteries with a capacity greater than 2 kWh and LMT batteries shall bear a conspicuous, clearly legible and indelible label indicating the carbon footprint of the battery referred to in paragraph 1, first subparagraph, point (d) and declaring the carbon footprint performance class to which the relevant battery model per manufacturing plant corresponds. + Further specified in Annex XIII (1) (c) and refers to Article 7 (1): + [...] The Commission shall, by 18 February 2024 for electric vehicle batteries, 18 February 2025 for rechargeable industrial batteries, except those with external storage, 18 February 2027 for LMT batteries and 18 February 2029 for industrial batteries with external storage, adopt: + (a) a delegated act in accordance with Article 89 to supplement this Regulation by establishing the methodology for the calculation and verification of the carbon footprint of the battery referred to in the first subparagraph, point (d), in accordance with the essential elements set out in Annex II; + These parameters are defined by Article 3: + (21) "carbon footprint" means the sum of greenhouse gas emissions and greenhouse gas removals in a product system, expressed as carbon dioxide equivalents and based on a Product Environmental Footprint (PEF) study using the single impact category of climate change; + and defined by Annex II (2): + (e) "life cycle" means the consecutive and interlinked stages of a product system, from raw material acquisition or generation from natural resources to final disposal (ISO 14040:2006 or an equivalent standard). + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_FootprintList' + status: + description: |- + The status of the product (original, repurposed, re-used, remanufactured or waste) to indicated, whether it is a used product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Annex I: + (j) incorporation of used components. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_StateEnumeration' + required: + - documents + - carbonFootprint + - status + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PercentageTrait: + type: number + description: Range constraint for a positive percentage value. + maximum: 100.0 + exclusiveMaximum: false + minimum: 0.0 + exclusiveMinimum: false + 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.battery.battery_pass_6.0.0_MaterialActive: + description: Characteristic to describe the active material. + type: object + properties: + location: + description: |- + The location of the substances of concern within the product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7: + (5) (b) the location of the substances of concern within the product. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + recycled: + description: |- + The share of the material, which is recovered recycled content from the product. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I: + (h) use or content of recycled materials and recovery of materials, including critical raw materials; + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PercentageTrait' + documentation: + description: Documentation accompanying the material. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentList' + critical: + description: |- + A flag, if the material is a critical raw material. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I: + (h) use or content of recycled materials and recovery of materials, including critical raw materials; + In Annex II of the connected proposal Act of Critical Raw Materials, a list of critical raw materials can be found. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Boolean' + required: + - location + - recycled + - documentation + - critical + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_ConcentrationEnumeration: + type: string + description: "Enumeration of possible units of concentration with percent, volume\ + \ percent, parts per thousand, parts per million, parts per billion and parts\ + \ per trillion." + enum: + - unit:partPerMillion + - unit:percent + - unit:percentVolume + - unit:partPerThousand + - unit:partPerTrillionUs + - unit:partPerBillionUs + urn_samm_io.catenax.battery.battery_pass_6.0.0_LeadCharacteristic: + description: Characteristic for specific hazardous/active lead information. + type: object + properties: + impactOfSubstances: + description: |- + An accumulation of documents that refer to the impact, especially hazardous substances, on the battery. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1) (s), refers to Article 74: + 1. In addition to the information referred to in Article 8a(2) of Directive 2008/98/EC, producers or, where appointed in accordance with Article 57(1), producer responsibility organisations shall make available to end-users and distributors the following information regarding the prevention and management of waste batteries with regard to the categories of batteries that they supply within the territory of a Member State: + [...] + (f) the impact of substances, in particular hazardous substances, present in batteries on the environment and on human health or the safety of persons, including the impact due to inappropriate discarding of waste batteries, such as littering or discarding as unsorted municipal waste. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentList' + critical: + description: |- + A flag, if the material is a critical raw material. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I: + (h) use or content of recycled materials and recovery of materials, including critical raw materials; + In Annex II of the connected proposal Act of Critical Raw Materials, a list of critical raw materials can be found. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Boolean' + documentation: + description: Documentation accompanying the material. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentList' + recycled: + description: |- + The share of the material, which is recovered recycled content from the product. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I: + (h) use or content of recycled materials and recovery of materials, including critical raw materials; + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PercentageTrait' + location: + description: |- + The location of the substances of concern within the product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7: + (5) (b) the location of the substances of concern within the product. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + concentration: + description: | + Concentration of the material at the level of the product. This attribute is specially mentioned for substances of concern mentioned in the ESPR proposal from March 30th, 2022 Article 7: + (5) (c) the concentration, maximum concentration or concentration range of the substances of concern, at the level of the product [...]. + Other substances are mentioned for the purpose of recycling in the ESPR provisional agreement from January 9th, 2024 Annex I: + (d) design for recycling, ease and quality of recycling as expressed through: use of easily recyclable materials, safe, easy and non-destructive access to recyclable components and materials or components and materials containing hazardous substances and material composition and homogeneity, possibility for high-purity sorting, number of materials and components used, use of standard components, use of component and material coding standards for the identification of components and materials, number and complexity of processes and tools needed, ease of nondestructive disassembly and re-assembly, conditions for access to product data, conditions for access to or use of hardware and software needed. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PositiveTrait' + materialUnit: + description: "The unit of concentration chosen from an enumeration: mass\ + \ percent, volume percent, parts per thousand, parts per million, parts\ + \ per billion and parts per trillion." + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_ConcentrationEnumeration' + required: + - impactOfSubstances + - critical + - documentation + - recycled + - location + - concentration + - materialUnit + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_ListTypeEnumerationId: + type: string + description: Enumeration of different systems and organizations related to the + identification and classification of chemical substances in the field of chemistry. + The enumeration values are EC or CAS. + enum: + - CAS + - EC + - IUPAC + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_MaterialIdEntity: + description: "Id Entity with identifier, name and list type." + type: object + properties: + id: + description: "The substance identification, in accordance with the specification\ + \ in the attribute for the list type." + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_IdentifierCharacteristic' + type: + description: "The type of standard used for the identification of the substances.\ + \ Selected can be for example CAS, IUPAC or EC." + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_ListTypeEnumerationId' + name: + description: The name of the material which is present in the product. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + required: + - id + - type + - name + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_MaterialIdList: + description: List of ids for the identification. + type: array + items: + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_MaterialIdEntity' + urn_samm_io.catenax.battery.battery_pass_6.0.0_OtherActiveMaterialsEntity: + description: Entity for other active materials. + type: object + properties: + location: + description: |- + The location of the substances of concern within the product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7: + (5) (b) the location of the substances of concern within the product. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + recycled: + description: |- + The share of the material, which is recovered recycled content from the product. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I: + (h) use or content of recycled materials and recovery of materials, including critical raw materials; + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PercentageTrait' + documentation: + description: Documentation accompanying the material. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentList' + critical: + description: |- + A flag, if the material is a critical raw material. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I: + (h) use or content of recycled materials and recovery of materials, including critical raw materials; + In Annex II of the connected proposal Act of Critical Raw Materials, a list of critical raw materials can be found. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Boolean' + materialIdentification: + description: "The chemical material name and identification, in accordance\ + \ with the specification in the attribute for the list type. Preference\ + \ is given to the IUPAC name. This attribute is mentioned in the ESPR\ + \ provisional agreement from January 9th, 2024 Article 7:\n(5) (a) the\ + \ name of the substances of concern present in the product, as follows:\n\ + \ - name(s) in the International Union of Pure and Applied Chemistry (IUPAC)\ + \ nomenclature, or another international name when IUPAC name is not available;\ + \ \n- other names (usual name, trade name, abbreviation);\n- European\ + \ Community (EC) number, as indicated in the European Inventory of Existing\ + \ Commercial Chemical Substances (EINECS), the European List of Notified\ + \ Chemical Substances (ELINCS) or the No Longer Polymer (NLP) list or\ + \ assigned by the European Chemicals Agency (ECHA), if available;\n- the\ + \ Chemical Abstract Service (CAS) name(s) and number(s), if available;\ + \ ." + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_MaterialIdList' + required: + - location + - recycled + - documentation + - critical + - materialIdentification + urn_samm_io.catenax.battery.battery_pass_6.0.0_OtherActiveMaterialsList: + description: List of other active materials. + type: array + items: + $ref: '#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_OtherActiveMaterialsEntity' + urn_samm_io.catenax.battery.battery_pass_6.0.0_ActiveMaterialsCharacteristic: + description: Characteristic for the active materials. + type: object + properties: + nickel: + description: |- + Information about the percentage of recovered nickel from waste. These attribute are mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1)(e) refers to Article 8: + 1. From 18 August 2028 or 24 months after the date of entry into force of the delegated act referred to in the third subparagraph, whichever is the latest, industrial batteries with a capacity greater than 2 kWh, except those with exclusively external storage, electric vehicle batteries and SLI batteries that contain cobalt, lead, lithium or nickel in active materials, shall be accompanied by documentation containing information about the percentage share of cobalt, lithium or nickel that is present in active materials and that has been recovered from battery manufacturing waste or post-consumer waste, and the percentage share of lead that is present in the battery and that has been recovered from waste, for each battery model per year and per manufacturing plant. + $ref: '#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_MaterialActive' + lithium: + description: |- + Information about the percentage of recovered lithium from waste. These attribute are mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1)(e) refers to Article 8: + 1. From 18 August 2028 or 24 months after the date of entry into force of the delegated act referred to in the third subparagraph, whichever is the latest, industrial batteries with a capacity greater than 2 kWh, except those with exclusively external storage, electric vehicle batteries and SLI batteries that contain cobalt, lead, lithium or nickel in active materials, shall be accompanied by documentation containing information about the percentage share of cobalt, lithium or nickel that is present in active materials and that has been recovered from battery manufacturing waste or post-consumer waste, and the percentage share of lead that is present in the battery and that has been recovered from waste, for each battery model per year and per manufacturing plant. + $ref: '#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_MaterialActive' + cobalt: + description: |- + Information about the percentage of recovered cobalt from waste. These attribute are mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1)(e) refers to Article 8: + 1. From 18 August 2028 or 24 months after the date of entry into force of the delegated act referred to in the third subparagraph, whichever is the latest, industrial batteries with a capacity greater than 2 kWh, except those with exclusively external storage, electric vehicle batteries and SLI batteries that contain cobalt, lead, lithium or nickel in active materials, shall be accompanied by documentation containing information about the percentage share of cobalt, lithium or nickel that is present in active materials and that has been recovered from battery manufacturing waste or post-consumer waste, and the percentage share of lead that is present in the battery and that has been recovered from waste, for each battery model per year and per manufacturing plant. + $ref: '#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_MaterialActive' + lead: + description: "Information about the lead in the battery. As this is an active\ + \ and hazardous material, all properties for hazardous as well as active\ + \ materials are required. These attribute are mentioned in the Battery\ + \ regulation 2023/1542 from 12 July 2023 in Annex XIII (1)(e) refers to\ + \ Article 8:\n1. From 18 August 2028 or 24 months after the date of entry\ + \ into force of the delegated act referred to in the third subparagraph,\ + \ whichever is the latest, industrial batteries with a capacity greater\ + \ than 2 kWh, except those with exclusively external storage, electric\ + \ vehicle batteries and SLI batteries that contain cobalt, lead, lithium\ + \ or nickel in active materials, shall be accompanied by documentation\ + \ containing information about the percentage share of cobalt, lithium\ + \ or nickel that is present in active materials and that has been recovered\ + \ from battery manufacturing waste or post-consumer waste, and the percentage\ + \ share of lead that is present in the battery and that has been recovered\ + \ from waste, for each battery model per year and per manufacturing plant.\n\ + And for hazardous materials this is mentioned in the Battery regulation\ + \ 2023/1542 from 12 July 2023 in Annex XIII (1) (a) refers to Annex VI\ + \ Part A: \n8. the hazardous substances present in the battery, other\ + \ than mercury, cadmium or lead;\nAdditionally in Article 13:\n5. All\ + \ batteries containing more than 0,002 % cadmium or more than 0,004 %\ + \ lead, shall be marked with the chemical symbol for the metal concerned:\ + \ Cd or Pb.\nDefined in Article 3:\n(52) \"hazardous substance\" means\ + \ a substance classified as hazardous pursuant to Article 3 of Regulation\ + \ (EC) No 1272/2008." + $ref: '#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_LeadCharacteristic' + other: + description: Other active materials in the battery. + $ref: '#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_OtherActiveMaterialsList' + required: + - nickel + - lithium + - cobalt + - lead + urn_samm_io.catenax.battery.battery_pass_6.0.0_HazardousCharacteristic: + description: Material attributes for hazardous materials. + type: object + properties: + impactOfSubstances: + description: |- + An accumulation of documents that refer to the impact, especially hazardous substances, on the battery. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1) (s), refers to Article 74: + 1. In addition to the information referred to in Article 8a(2) of Directive 2008/98/EC, producers or, where appointed in accordance with Article 57(1), producer responsibility organisations shall make available to end-users and distributors the following information regarding the prevention and management of waste batteries with regard to the categories of batteries that they supply within the territory of a Member State: + [...] + (f) the impact of substances, in particular hazardous substances, present in batteries on the environment and on human health or the safety of persons, including the impact due to inappropriate discarding of waste batteries, such as littering or discarding as unsorted municipal waste. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentList' + concentration: + description: | + Concentration of the material at the level of the product. This attribute is specially mentioned for substances of concern mentioned in the ESPR proposal from March 30th, 2022 Article 7: + (5) (c) the concentration, maximum concentration or concentration range of the substances of concern, at the level of the product [...]. + Other substances are mentioned for the purpose of recycling in the ESPR provisional agreement from January 9th, 2024 Annex I: + (d) design for recycling, ease and quality of recycling as expressed through: use of easily recyclable materials, safe, easy and non-destructive access to recyclable components and materials or components and materials containing hazardous substances and material composition and homogeneity, possibility for high-purity sorting, number of materials and components used, use of standard components, use of component and material coding standards for the identification of components and materials, number and complexity of processes and tools needed, ease of nondestructive disassembly and re-assembly, conditions for access to product data, conditions for access to or use of hardware and software needed. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PositiveTrait' + location: + description: |- + The location of the substances of concern within the product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7: + (5) (b) the location of the substances of concern within the product. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + materialUnit: + description: "The unit of concentration chosen from an enumeration: mass\ + \ percent, volume percent, parts per thousand, parts per million, parts\ + \ per billion and parts per trillion." + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_ConcentrationEnumeration' + critical: + description: |- + A flag, if the material is a critical raw material. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I: + (h) use or content of recycled materials and recovery of materials, including critical raw materials; + In Annex II of the connected proposal Act of Critical Raw Materials, a list of critical raw materials can be found. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Boolean' + documentation: + description: Documentation accompanying the material. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentList' + required: + - impactOfSubstances + - concentration + - location + - materialUnit + - critical + - documentation + urn_samm_io.catenax.battery.battery_pass_6.0.0_OtherHazardousMaterialEntity: + description: Entity for other hazardous materials. + type: object + properties: + impactOfSubstances: + description: |- + An accumulation of documents that refer to the impact, especially hazardous substances, on the battery. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1) (s), refers to Article 74: + 1. In addition to the information referred to in Article 8a(2) of Directive 2008/98/EC, producers or, where appointed in accordance with Article 57(1), producer responsibility organisations shall make available to end-users and distributors the following information regarding the prevention and management of waste batteries with regard to the categories of batteries that they supply within the territory of a Member State: + [...] + (f) the impact of substances, in particular hazardous substances, present in batteries on the environment and on human health or the safety of persons, including the impact due to inappropriate discarding of waste batteries, such as littering or discarding as unsorted municipal waste. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentList' + materialUnit: + description: "The unit of concentration chosen from an enumeration: mass\ + \ percent, volume percent, parts per thousand, parts per million, parts\ + \ per billion and parts per trillion." + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_ConcentrationEnumeration' + concentration: + description: | + Concentration of the material at the level of the product. This attribute is specially mentioned for substances of concern mentioned in the ESPR proposal from March 30th, 2022 Article 7: + (5) (c) the concentration, maximum concentration or concentration range of the substances of concern, at the level of the product [...]. + Other substances are mentioned for the purpose of recycling in the ESPR provisional agreement from January 9th, 2024 Annex I: + (d) design for recycling, ease and quality of recycling as expressed through: use of easily recyclable materials, safe, easy and non-destructive access to recyclable components and materials or components and materials containing hazardous substances and material composition and homogeneity, possibility for high-purity sorting, number of materials and components used, use of standard components, use of component and material coding standards for the identification of components and materials, number and complexity of processes and tools needed, ease of nondestructive disassembly and re-assembly, conditions for access to product data, conditions for access to or use of hardware and software needed. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PositiveTrait' + materialIdentification: + description: "The chemical material name and identification, in accordance\ + \ with the specification in the attribute for the list type. Preference\ + \ is given to the IUPAC name. This attribute is mentioned in the ESPR\ + \ provisional agreement from January 9th, 2024 Article 7:\n(5) (a) the\ + \ name of the substances of concern present in the product, as follows:\n\ + \ - name(s) in the International Union of Pure and Applied Chemistry (IUPAC)\ + \ nomenclature, or another international name when IUPAC name is not available;\ + \ \n- other names (usual name, trade name, abbreviation);\n- European\ + \ Community (EC) number, as indicated in the European Inventory of Existing\ + \ Commercial Chemical Substances (EINECS), the European List of Notified\ + \ Chemical Substances (ELINCS) or the No Longer Polymer (NLP) list or\ + \ assigned by the European Chemicals Agency (ECHA), if available;\n- the\ + \ Chemical Abstract Service (CAS) name(s) and number(s), if available;\ + \ ." + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_MaterialIdList' + documentation: + description: Documentation accompanying the material. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentList' + critical: + description: |- + A flag, if the material is a critical raw material. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I: + (h) use or content of recycled materials and recovery of materials, including critical raw materials; + In Annex II of the connected proposal Act of Critical Raw Materials, a list of critical raw materials can be found. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Boolean' + location: + description: |- + The location of the substances of concern within the product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7: + (5) (b) the location of the substances of concern within the product. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + required: + - impactOfSubstances + - materialUnit + - concentration + - materialIdentification + - documentation + - critical + - location + urn_samm_io.catenax.battery.battery_pass_6.0.0_OtherHazardousMaterialList: + description: List of other hazardous materials. + type: array + items: + $ref: '#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_OtherHazardousMaterialEntity' + urn_samm_io.catenax.battery.battery_pass_6.0.0_HazardousSubstanceCharacteristic: + description: Hazardous Substance Characteristic for the battery chemical materials. + type: object + properties: + cadmium: + description: "Information about the presence of cadmium in the battery.\ + \ Therefore, a concentration and the location within the battery has to\ + \ be given. This is mentioned in the Battery regulation 2023/1542 from\ + \ 12 July 2023 in Annex XIII (1) (a) refers to Annex VI Part A: \n8. the\ + \ hazardous substances present in the battery, other than mercury, cadmium\ + \ or lead;\nDefined in Article 3:\n(52) \"hazardous substance\" means\ + \ a substance classified as hazardous pursuant to Article 3 of Regulation\ + \ (EC) No 1272/2008.\nAdditionally in Article 13:\n5. All batteries containing\ + \ more than 0,002 % cadmium or more than 0,004 % lead, shall be marked\ + \ with the chemical symbol for the metal concerned: Cd or Pb." + $ref: '#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_HazardousCharacteristic' + mercury: + description: "Information about the presence of mercury in the battery.\ + \ Therefore, a concentration and the location within the battery has to\ + \ be given. This is mentioned in the Battery regulation 2023/1542 from\ + \ 12 July 2023 in Annex XIII (1) (a) refers to Annex VI Part A: \n8. the\ + \ hazardous substances present in the battery, other than mercury, cadmium\ + \ or lead;\nDefined in Article 3:\n(52) \"hazardous substance\" means\ + \ a substance classified as hazardous pursuant to Article 3 of Regulation\ + \ (EC) No 1272/2008." + $ref: '#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_HazardousCharacteristic' + other: + description: Other hazardous materials. + $ref: '#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_OtherHazardousMaterialList' + lead: + description: "Information about the lead in the battery. As this is an active\ + \ and hazardous material, all properties for hazardous as well as active\ + \ materials are required. These attribute are mentioned in the Battery\ + \ regulation 2023/1542 from 12 July 2023 in Annex XIII (1)(e) refers to\ + \ Article 8:\n1. From 18 August 2028 or 24 months after the date of entry\ + \ into force of the delegated act referred to in the third subparagraph,\ + \ whichever is the latest, industrial batteries with a capacity greater\ + \ than 2 kWh, except those with exclusively external storage, electric\ + \ vehicle batteries and SLI batteries that contain cobalt, lead, lithium\ + \ or nickel in active materials, shall be accompanied by documentation\ + \ containing information about the percentage share of cobalt, lithium\ + \ or nickel that is present in active materials and that has been recovered\ + \ from battery manufacturing waste or post-consumer waste, and the percentage\ + \ share of lead that is present in the battery and that has been recovered\ + \ from waste, for each battery model per year and per manufacturing plant.\n\ + And for hazardous materials this is mentioned in the Battery regulation\ + \ 2023/1542 from 12 July 2023 in Annex XIII (1) (a) refers to Annex VI\ + \ Part A: \n8. the hazardous substances present in the battery, other\ + \ than mercury, cadmium or lead;\nAdditionally in Article 13:\n5. All\ + \ batteries containing more than 0,002 % cadmium or more than 0,004 %\ + \ lead, shall be marked with the chemical symbol for the metal concerned:\ + \ Cd or Pb.\nDefined in Article 3:\n(52) \"hazardous substance\" means\ + \ a substance classified as hazardous pursuant to Article 3 of Regulation\ + \ (EC) No 1272/2008." + $ref: '#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_LeadCharacteristic' + required: + - cadmium + - mercury + - lead + urn_samm_io.catenax.battery.battery_pass_6.0.0_MaterialCompositionEntity: + description: Entity for the material composition. + type: object + properties: + id: + description: "The chemical material name and identification, in accordance\ + \ with the specification in the attribute for the list type. Preference\ + \ is given to the IUPAC name. This attribute is mentioned in the ESPR\ + \ provisional agreement from January 9th, 2024 Article 7:\n(5) (a) the\ + \ name of the substances of concern present in the product, as follows:\n\ + \ - name(s) in the International Union of Pure and Applied Chemistry (IUPAC)\ + \ nomenclature, or another international name when IUPAC name is not available;\ + \ \n- other names (usual name, trade name, abbreviation);\n- European\ + \ Community (EC) number, as indicated in the European Inventory of Existing\ + \ Commercial Chemical Substances (EINECS), the European List of Notified\ + \ Chemical Substances (ELINCS) or the No Longer Polymer (NLP) list or\ + \ assigned by the European Chemicals Agency (ECHA), if available;\n- the\ + \ Chemical Abstract Service (CAS) name(s) and number(s), if available;\ + \ ." + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_MaterialIdList' + concentration: + description: | + Concentration of the material at the level of the product. This attribute is specially mentioned for substances of concern mentioned in the ESPR proposal from March 30th, 2022 Article 7: + (5) (c) the concentration, maximum concentration or concentration range of the substances of concern, at the level of the product [...]. + Other substances are mentioned for the purpose of recycling in the ESPR provisional agreement from January 9th, 2024 Annex I: + (d) design for recycling, ease and quality of recycling as expressed through: use of easily recyclable materials, safe, easy and non-destructive access to recyclable components and materials or components and materials containing hazardous substances and material composition and homogeneity, possibility for high-purity sorting, number of materials and components used, use of standard components, use of component and material coding standards for the identification of components and materials, number and complexity of processes and tools needed, ease of nondestructive disassembly and re-assembly, conditions for access to product data, conditions for access to or use of hardware and software needed. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PositiveTrait' + unit: + description: "The unit of concentration chosen from an enumeration: mass\ + \ percent, volume percent, parts per thousand, parts per million, parts\ + \ per billion and parts per trillion." + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_ConcentrationEnumeration' + critical: + description: |- + A flag, if the material is a critical raw material. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I: + (h) use or content of recycled materials and recovery of materials, including critical raw materials; + In Annex II of the connected proposal Act of Critical Raw Materials, a list of critical raw materials can be found. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Boolean' + documentation: + description: Documentation accompanying the material. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentList' + recycled: + description: |- + The share of the material, which is recovered recycled content from the product. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I: + (h) use or content of recycled materials and recovery of materials, including critical raw materials; + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PercentageTrait' + location: + description: |- + The location of the substances of concern within the product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7: + (5) (b) the location of the substances of concern within the product. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + renewable: + description: | + The share of the material, which is from a renewable resource that can be replenished. Renewable resources are those that can be reproduced by physical, chemical, or mechanical processes. These are the kind of resources that can be regenerated throughout time. Forest wood, for example, can be grown through reforestation. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I: + (ha) use or content of sustainable renewable materials; + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PercentageTrait' + required: + - id + - concentration + - unit + - critical + - documentation + - recycled + - location + - renewable + urn_samm_io.catenax.battery.battery_pass_6.0.0_MaterialCompositionList: + description: List for the material composition. + type: array + items: + $ref: '#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_MaterialCompositionEntity' + urn_samm_io.catenax.battery.battery_pass_6.0.0_ChemicalMaterialCharacteristic: + description: Chemical Material Characteristic for the battery. + type: object + properties: + active: + description: |- + The active materials included in the battery. Mandatory are nickel, lithium, cobalt and lead. Others are optional. Defined by the Battery regulation 2023/1542 from 12 July 2023 in Article 3 Definitions: + (5) ‘active material’ means a material which reacts chemically to produce electric energy when the battery cell discharges or to store electric energy when the battery is being charged. + $ref: '#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_ActiveMaterialsCharacteristic' + hazardous: + description: "Hazardous substances like lead, cadmium and mercury." + $ref: '#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_HazardousSubstanceCharacteristic' + composition: + description: "The materials which are necessary to describe the material\ + \ composition, especially if they are active, critical or hazardous. This\ + \ can be redundant to the specifically mentioned active or hazardous materials.\ + \ This is mentioned in the Battery regulation 2023/1542 from 12 July 2023\ + \ in Annex XIII (1):\n(b) the material composition of the battery, including\ + \ its chemistry, hazardous substances present in the battery, other than\ + \ mercury, cadmium or lead, and critical raw materials present in the\ + \ battery; \n(f) the share of renewable content.\nand in Annex XIII (2):\n\ + (a) detailed composition, including materials used in the cathode, anode\ + \ and electrolyte;\nDefinition from Article 3:\n(52) \"hazardous substance\"\ + \ means a substance classified as hazardous pursuant to Article 3 of Regulation\ + \ (EC) No 1272/2008:\nA substance or a mixture fulfilling the criteria\ + \ relating to physical hazards, health hazards or environmental hazards,\ + \ laid down in Parts 2 to 5 of Annex I is hazardous and shall be classified\ + \ in relation to the respective hazard classes provided for in that Annex.\n\ + Where, in Annex I, hazard classes are differentiated on the basis of the\ + \ route of exposure or the nature of the effects, the substance or mixture\ + \ shall be classified in accordance with such differentiation.\nDefined\ + \ in Article 2 of Regulation (EC) No 1272/2008:\n1. hazard class\" means\ + \ the nature of the physical, health or environmental hazard." + $ref: '#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_MaterialCompositionList' + required: + - active + - hazardous + - composition + urn_samm_io.catenax.battery.battery_pass_6.0.0_VoltMeasurement: + type: number + description: Measurement for volt as a double. + urn_samm_io.catenax.battery.battery_pass_6.0.0_DegreeMeasurement: + type: number + description: Degree measurement in celsius. + urn_samm_io.catenax.battery.battery_pass_6.0.0_VoltageCharacteristic: + description: Characteristic for voltage values. + type: object + properties: + min: + description: |- + Minimum voltage refers to the lowest voltage the battery is able to reach. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1): + (h) minimal, nominal and maximum voltage, with temperature ranges when relevant. + $ref: '#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_VoltMeasurement' + max: + description: |- + Maximum voltage refers to the highest voltage the battery is able to reach. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1): + (h) minimal, nominal and maximum voltage, with temperature ranges when relevant. + $ref: '#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_VoltMeasurement' + nominal: + description: |- + Nominal voltage is a standardized or average voltage value assigned to the battery. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1): + (h) minimal, nominal and maximum voltage, with temperature ranges when relevant. + $ref: '#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_VoltMeasurement' + temperature: + description: Temperature refers to the temperature of the battery during + it's cycle-life testing or as boundary condition for other rated values + in celsius. + $ref: '#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_DegreeMeasurement' + required: + - min + - max + - nominal + urn_samm_io.catenax.battery.battery_pass_6.0.0_PercentMeasurement: + type: number + description: Measurement in percent as double. + urn_samm_io.catenax.battery.battery_pass_6.0.0_RatedRoundTripEfficiencyCharacteristic: + description: Characteristic for the rated round trip efficiency. + type: object + properties: + depthOfDischarge: + description: |- + Depth of discharge is a measure used to quantify the extent to which the battery has been discharged relative to its maximum capacity during its cycle-life testing. It represents the percentage of the total available capacity that has been drained or used during a particular discharge cycle. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (4) (a) refers to Article 10 (1), refers to Annex IV Part B: + 3. Depth of discharge in the cycle-life test. + $ref: '#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_PercentMeasurement' + initial: + description: |- + The efficiency value of a battery refers to the ratio of useful output energy to the input energy, expressed as a percentage. It quantifies how effectively a battery can convert and deliver stored energy during the discharge process relative to the energy input during charging. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1): + (n) initial round trip energy efficiency and at 50 % of cycle-life. + $ref: '#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_PercentMeasurement' + "50PercentLife": + description: |- + The round trip efficiency at 50 percent refers to the efficiency of a rechargeable battery's energy storage and retrieval process when the battery has undergone approximately half of its expected number of charge-discharge cycles. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1): + (n) initial round trip energy efficiency and at 50 % of cycle-life. + $ref: '#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_PercentMeasurement' + temperature: + description: Temperature refers to the temperature of the battery during + it's cycle-life testing or as boundary condition for other rated values + in celsius. + $ref: '#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_DegreeMeasurement' + required: + - depthOfDischarge + - initial + - 50PercentLife + urn_samm_io.catenax.battery.battery_pass_6.0.0_KilowattHourMeasurement: + type: number + description: Measurement for the energy expressed in kilowatt hours as double. + urn_samm_io.catenax.battery.battery_pass_6.0.0_RatedEnergyCharacteristic: + description: Characteristic for the rated energy. + type: object + properties: + value: + description: "Value describing the energy in a specific measurement period,\ + \ expressed in kilowatt-hours." + $ref: '#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_KilowattHourMeasurement' + temperature: + description: Temperature refers to the temperature of the battery during + it's cycle-life testing or as boundary condition for other rated values + in celsius. + $ref: '#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_DegreeMeasurement' + required: + - value + urn_samm_io.catenax.battery.battery_pass_6.0.0_OhmMeasurement: + type: number + description: Measurement in ohms as double. + urn_samm_io.catenax.battery.battery_pass_6.0.0_RatedResistanceCharacteristic: + description: Characteristic for rated resistance values of the battery on different + levels. + type: object + properties: + cell: + description: |- + Cell resistance refers to the internal resistance of an individual battery cell in ohms. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1): + (o) internal battery cell and pack resistance; + Definition from Annex IV: + (5) "Internal resistance" means the opposition to the flow of current within a cell or a battery under reference conditions, that is, the sum of electronic resistance and ionic resistance to the contribution to total effective resistance including inductive/capacitive properties. + $ref: '#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_OhmMeasurement' + module: + description: "The module resistance in ohms includes the internal resistance\ + \ of each cell within the module as well as the resistance introduced\ + \ by interconnecting components such as busbars, connectors, and thermal\ + \ management systems." + $ref: '#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_OhmMeasurement' + pack: + description: |- + Pack resistance refers to the overall electrical resistance within a battery pack in ohms. This resistance is a combination of the individual resistances in various components within the pack, including the electrodes, connectors, and other conductive elements. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1): + (o) internal battery cell and pack resistance; + Definition from Annex IV: + (5) "Internal resistance" means the opposition to the flow of current within a cell or a battery under reference conditions, that is, the sum of electronic resistance and ionic resistance to the contribution to total effective resistance including inductive/capacitive properties. + $ref: '#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_OhmMeasurement' + temperature: + description: Temperature refers to the temperature of the battery during + it's cycle-life testing or as boundary condition for other rated values + in celsius. + $ref: '#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_DegreeMeasurement' + required: + - cell + - pack + urn_samm_io.catenax.battery.battery_pass_6.0.0_WattMeasurement: + type: number + description: Measurement in watt as double. + urn_samm_io.catenax.battery.battery_pass_6.0.0_RatedPowerCharacteristic: + description: Characteristic for rated power values. + type: object + properties: + value: + description: "Value describing the power in a specific measurement period,\ + \ expressed in watt." + $ref: '#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_WattMeasurement' + at20SoC: + description: "Capability at 20% SoC refers to the battery's capability at\ + \ 80% State of Charge. This measurement is indicative of the immediate\ + \ available energy in the battery. This attribute is mentioned in the\ + \ Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (4)(a)\ + \ refers to Article 10 (1), refers to Annex IV Part B:\t\n4. Power capability\ + \ at 80 % and 20 % state of charge." + $ref: '#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_WattMeasurement' + at80SoC: + description: "Capability at 80% SoC refers to the battery's capability at\ + \ 80% State of Charge. This measurement is indicative of the immediate\ + \ available energy in the battery. This attribute is mentioned in the\ + \ Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (4)(a)\ + \ refers to Article 10 (1), refers to Annex IV Part B:\t\n4. Power capability\ + \ at 80 % and 20 % state of charge" + $ref: '#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_WattMeasurement' + temperature: + description: Temperature refers to the temperature of the battery during + it's cycle-life testing or as boundary condition for other rated values + in celsius. + $ref: '#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_DegreeMeasurement' + required: + - value + - at20SoC + - at80SoC + urn_samm_io.catenax.battery.battery_pass_6.0.0_AmpereHourMeasurement: + type: number + description: Measurement for the capacity expressed in ampere hours as double. + urn_samm_io.catenax.battery.battery_pass_6.0.0_RatedCapacityCharacteristic: + description: Characteristic for rated capacity values. + type: object + properties: + value: + description: "Value describing the capacity in a specific measurement period,\ + \ expressed in ampere-hours." + $ref: '#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_AmpereHourMeasurement' + thresholdExhaustion: + description: |- + Capacity threshold exhaustion refers to the condition where a battery's capacity diminishes to a level that is considered unacceptable for its intended use. The capacity threshold is a predetermined level below which the battery is considered to be no longer effective or reliable for the specific application. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1): + (k) capacity threshold for exhaustion (only for electric vehicle batteries). + $ref: '#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_PercentMeasurement' + temperature: + description: Temperature refers to the temperature of the battery during + it's cycle-life testing or as boundary condition for other rated values + in celsius. + $ref: '#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_DegreeMeasurement' + required: + - value + - thresholdExhaustion + urn_samm_io.catenax.battery.battery_pass_6.0.0_PerformanceTemperatureCharacteristic: + description: Characteristic for temperature values. + type: object + properties: + lower: + description: |- + The lower temperature boundary (in Celsius) refers to the minimum temperature at which a battery can effectively operate. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1): + (l) temperature range the battery can withstand when not in use (reference test). + $ref: '#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_DegreeMeasurement' + upper: + description: |- + The upper temperature boundary (in Celsius) refers to the minimum temperature at which a battery can effectively operate. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1): + (l) temperature range the battery can withstand when not in use (reference test). + $ref: '#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_DegreeMeasurement' + required: + - lower + - upper + urn_samm_io.catenax.battery.battery_pass_6.0.0_IntegerCharacteristic: + type: number + description: Characteristic for an integer value. + urn_samm_io.catenax.battery.battery_pass_6.0.0_CRateCharacteristic: + type: number + description: "The C-rate, also known as the charge/discharge rate, quantifies\ + \ how quickly a battery is charged or discharged in relation to its capacity.\ + \ It is dimensionless." + urn_samm_io.catenax.battery.battery_pass_6.0.0_CycleLifeCharacteristic: + description: Cycle Life Characteristic for the battery lifetime testing. + type: object + properties: + temperature: + description: Temperature refers to the temperature of the battery during + it's cycle-life testing or as boundary condition for other rated values + in celsius. + $ref: '#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_DegreeMeasurement' + cycles: + description: Cycle refers to one complete charging and discharging sequence. + Either during the battery's cycle-life testing or as full equivalent while + in use. + $ref: '#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_IntegerCharacteristic' + depthOfDischarge: + description: |- + Depth of discharge is a measure used to quantify the extent to which the battery has been discharged relative to its maximum capacity during its cycle-life testing. It represents the percentage of the total available capacity that has been drained or used during a particular discharge cycle. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (4) (a) refers to Article 10 (1), refers to Annex IV Part B: + 3. Depth of discharge in the cycle-life test. + $ref: '#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_PercentMeasurement' + appliedChargeRate: + description: |- + The applied charge rate (c rate) refers to the rate at which a battery is charged. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1): + (p) c-rate of relevant cycle-life test; + and Annex XIII (4)(a) refers to Article 10(1) refers to Annex IV Part B: + 1. Applied discharge rate and charge rate. + $ref: '#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_CRateCharacteristic' + appliedDischargeRate: + description: |- + The applied discharge rate (c rate) refers to the rate at which a battery is discharged. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1): + (p) c-rate of relevant cycle-life test; + and Annex XIII (4)(a) refers to Article 10(1) refers to Annex IV Part B: + 1. Applied discharge rate and charge rate. + $ref: '#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_CRateCharacteristic' + required: + - temperature + - cycles + - depthOfDischarge + - appliedChargeRate + - appliedDischargeRate + urn_samm_io.catenax.battery.battery_pass_6.0.0_LifeCycleCharacteristic: + description: Life Cycle Characteristic with attributes for the lifetime evaluation + of a battery. + type: object + properties: + expectedYears: + description: "The expected years refer to the expected life-time of the\ + \ battery before it starts heavily degrading in its capacity and c-rate\ + \ in calendar years. This attribute is mentioned in the Battery regulation\ + \ 2023/1542 from 12 July 2023 in Annex XIII (4) (a) refers to the Article\ + \ 10 (1) refers to Annex IV Part A: \n5. The expected life-time of the\ + \ battery under the reference conditions for which it has been designed,\ + \ in terms of cycles, except for non-cycle applications, and calendar\ + \ years." + $ref: '#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_IntegerCharacteristic' + report: + description: |- + The test reports refer to the testing conducted during the determination of the rated values of the battery. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (3): + [...] results of test reports proving compliance with the requirements laid down in this Regulation or any delegated or implementing act adopted pursuant to this Regulation. + And Annex XIII (4)(a) refers to Article 10(1) and refer to Annex IV Part B: + 5. Any calculations performed with the measured parameters, if applicable. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentList' + cycleLifeTesting: + description: The cycle life testing of the battery. + $ref: '#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_CycleLifeCharacteristic' + required: + - expectedYears + - report + - cycleLifeTesting + urn_samm_io.catenax.battery.battery_pass_6.0.0_RatedPerformanceCharacteristic: + description: Characteristic for rated performance values of the battery. + type: object + properties: + voltage: + description: |- + Voltage values are mandatory for the battery, with the option to include temperature values voluntarily. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1): + (h) minimal, nominal and maximum voltage, with temperature ranges when relevant. + $ref: '#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_VoltageCharacteristic' + roundTripEfficiency: + description: "The efficiency value of a battery refers to the ratio of useful\ + \ output energy to the input energy, expressed as a percentage. With the\ + \ option to include temperature values voluntarily." + $ref: '#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_RatedRoundTripEfficiencyCharacteristic' + energy: + description: Representation of the total amount of energy that the battery + can store and subsequently deliver during its discharge cycle. It is necessary + to calculate the SOCE. + $ref: '#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_RatedEnergyCharacteristic' + resistance: + description: "Rated resistance of the battery on the level of the pack,\ + \ module (optional) and cell." + $ref: '#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_RatedResistanceCharacteristic' + power: + description: "The power value is the rate at which energy is delivered or\ + \ consumed. It is measured in watts (W) and represents how quickly energy\ + \ is transferred. This attribute is mentioned in the Battery regulation\ + \ 2023/1542 from 12 July 2023 in Annex XIII (4)(a) refers to Article 10(1),\ + \ refers to Annex IV Part A: \t\n2. Power (in W) and power fade (in %).\n\ + Definition from Annex IV:\n(3) \"Power\" means the amount of energy that\ + \ a battery is capable of providing over a given period under reference\ + \ conditions." + $ref: '#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_RatedPowerCharacteristic' + capacity: + description: "Capacity value refers to the amount of electric charge that\ + \ a battery can store and subsequently deliver when needed. It is a fundamental\ + \ characteristic of a battery and is expressed in ampere-hours. This attribute\ + \ is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in\ + \ Annex XIII (1):\n(g) rated capacity (in Ah);\nand in Annex XIII (4)(a)\ + \ referring to Article 10 (1) and referring to Annex IV Part A:\n1. Rated\ + \ capacity (in Ah) and capacity fade (in %). \nAnd in Annex XIII (1)(a)\ + \ referring to Annex VI Part A:\n6. the capacity;\nDefinition from Annex\ + \ IV:\n(1) \"Rated capacity\" means the total number of ampere-hours (Ah)\ + \ that can be withdrawn from a fully charged battery under reference conditions." + $ref: '#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_RatedCapacityCharacteristic' + performanceDocument: + description: |- + The performance document lists information regarding the performance of the battery. This can be an overview about several rated performance attributes. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (3): + [...] results of test reports proving compliance with the requirements laid down in this Regulation or any delegated or implementing act adopted pursuant to this Regulation. + And Annex XIII (4)(a) refers to Article 10(1) and refer to Annex IV Part B: + 5. Any calculations performed with the measured parameters, if applicable. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentList' + temperature: + description: |- + The battery temperatures. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1): + (l) temperature range the battery can withstand when not in use (reference test). + $ref: '#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_PerformanceTemperatureCharacteristic' + selfDischargingRate: + description: |- + The self-discharge rate of a battery refers to the rate at which the battery loses its stored energy when not in use. It's the discharge of the battery that occurs internally without any external load recorded in percentage for every month. This attribute is mentioned in the Battery Regulation 2023/1542 from 12 July 2023 in Annex XIII (4) (b) refers to Article 14, refers to Annex VII Part A: + 4. the evolution of self-discharging rates. + $ref: '#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_PercentMeasurement' + testReport: + description: |- + The test reports refer to the testing conducted during the determination of the rated values of the battery. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (3): + [...] results of test reports proving compliance with the requirements laid down in this Regulation or any delegated or implementing act adopted pursuant to this Regulation. + And Annex XIII (4)(a) refers to Article 10(1) and refer to Annex IV Part B: + 5. Any calculations performed with the measured parameters, if applicable. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentList' + lifetime: + description: Attributes for the lifetime evaluation of a battery. + $ref: '#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_LifeCycleCharacteristic' + required: + - voltage + - roundTripEfficiency + - resistance + - power + - capacity + - temperature + - selfDischargingRate + - lifetime + 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.battery.battery_pass_6.0.0_RecordCharacteristic: + description: Characteristic for a dynamic record with a value and timestamp. + type: object + properties: + value: + description: A value as a percentage in the form of a double. + $ref: '#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_PercentMeasurement' + time: + description: |- + The entry date and time corresponding to when a specific parameter was measured. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (4): + (d) information and data resulting from its use, including the number of charging and discharging cycles and negative events, such as accidents, as well as periodically recorded information on the operating environmental conditions, including temperature, and on the state of charge. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Timestamp' + required: + - value + - time + urn_samm_io.catenax.battery.battery_pass_6.0.0_FullCycleCharacteristic: + description: Characteristic for dynamic cycle values. + type: object + properties: + time: + description: |- + The entry date and time corresponding to when a specific parameter was measured. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (4): + (d) information and data resulting from its use, including the number of charging and discharging cycles and negative events, such as accidents, as well as periodically recorded information on the operating environmental conditions, including temperature, and on the state of charge. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Timestamp' + value: + description: Cycle refers to one complete charging and discharging sequence. + Either during the battery's cycle-life testing or as full equivalent while + in use. + $ref: '#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_IntegerCharacteristic' + required: + - time + - value + urn_samm_io.catenax.battery.battery_pass_6.0.0_RemainingPowerCharacteristic: + description: Characteristic for the remaining power. + type: object + properties: + time: + description: |- + The entry date and time corresponding to when a specific parameter was measured. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (4): + (d) information and data resulting from its use, including the number of charging and discharging cycles and negative events, such as accidents, as well as periodically recorded information on the operating environmental conditions, including temperature, and on the state of charge. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Timestamp' + value: + description: "Value describing the power in a specific measurement period,\ + \ expressed in watt." + $ref: '#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_WattMeasurement' + required: + - time + - value + urn_samm_io.catenax.battery.battery_pass_6.0.0_DynamicPowerCharacteristic: + description: Characteristic for dynamic power values. + type: object + properties: + fade: + description: "Power fade refers to a reduction in the power of the battery\ + \ system over time expressed as a percentage in reference to the initial\ + \ value. This attribute is mentioned in the Battery regulation 2023/1542\ + \ from 12 July 2023 in Annex XIII (4)(a) refers to Article 10 (1), refers\ + \ to Annex IV Part A: \t\n2. Power (in W) and power fade (in %).\nDefinition\ + \ from Annex IV:\n(4) \"Power fade\" means the decrease over time and\ + \ upon usage in the amount of power that a battery can deliver at the\ + \ rated voltage." + $ref: '#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_RecordCharacteristic' + remaining: + description: |- + The remaining power capability in the battery expressed in watt. This attribute is mentioned in the Battery Regulation 2023/1542 from 12 July 2023 in Annex XIII (4) (b) refers to Article 14, refers to Annex VII Part A: + 2. where possible, the remaining power capability; + Definition from Annex IV: + (3) "Power" means the amount of energy that a battery is capable of providing over a given period under reference + conditions. + $ref: '#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_RemainingPowerCharacteristic' + required: + - fade + - remaining + urn_samm_io.catenax.battery.battery_pass_6.0.0_CapacityCharacteristic: + description: Characteristic for dynamic capacity values such as the throughput + and the remaining capacity. + type: object + properties: + time: + description: |- + The entry date and time corresponding to when a specific parameter was measured. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (4): + (d) information and data resulting from its use, including the number of charging and discharging cycles and negative events, such as accidents, as well as periodically recorded information on the operating environmental conditions, including temperature, and on the state of charge. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Timestamp' + value: + description: "Value describing the capacity in a specific measurement period,\ + \ expressed in ampere-hours." + $ref: '#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_AmpereHourMeasurement' + required: + - time + - value + urn_samm_io.catenax.battery.battery_pass_6.0.0_DynamicCapacityCharacteristic: + description: Characteristic for dynamic capacity values. + type: object + properties: + fade: + description: "Capacity fade refers to a reduction in the capacity of the\ + \ battery system over time expressed as a percentage in reference to the\ + \ initial value. This attribute is mentioned in the Battery regulation\ + \ 2023/1542 from 12 July 2023 in Annex XIII (4)(a) refers to Article 10(1)\ + \ and refer to Annex IV Part A: \n1. Rated capacity (in Ah) and capacity\ + \ fade (in %).\nDefinition from Annex IV:\n(2) \"Capacity fade\" means\ + \ the decrease over time and upon usage in the amount of charge that a\ + \ battery can deliver at the rated voltage, with respect to the original\ + \ rated capacity." + $ref: '#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_RecordCharacteristic' + throughput: + description: "Capacity throughput refers to the total amount of energy that\ + \ a battery has delivered over its lifetime. It represents the cumulative\ + \ energy discharge and recharge cycles a battery has undergone. Capacity\ + \ throughput is expressed in ampere-hours. This attribute is mentioned\ + \ in the Battery regulation 2023/1542 from 12 July 2023 in Annex VII Part\ + \ B: \n3. the capacity throughput." + $ref: '#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_CapacityCharacteristic' + capacity: + description: | + The remaining capacity in the battery expressed in ampere hours. This attribute is mentioned in the Battery Regulation 2023/1542 from 12 July 2023 in Annex XIII (4) (b) refers to Article 14, refers to Annex VII Part A: + 1. the remaining capacity. + $ref: '#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_CapacityCharacteristic' + required: + - fade + - throughput + - capacity + urn_samm_io.catenax.battery.battery_pass_6.0.0_DynamicRoundTripEfficiencyCharacteristic: + description: Characteristic for dynamic round trip efficiency values. + type: object + properties: + fade: + description: "Round trip efficiency fade refers to a reduction in the round\ + \ trip efficiency of the battery system over time expressed as a percentage\ + \ in reference to the initial value. This attribute is mentioned in the\ + \ Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (4)(a)\ + \ refers to Article 10(1) and refers to Annex IV: \n4. Where applicable,\ + \ energy round trip efficiency and its fade (in %).\nDefinition from Annex\ + \ IV:\n(6) \"Energy round trip efficiency\" means the ratio of the net\ + \ energy delivered by a battery during a discharge test to the total energy\ + \ required to restore the initial state of charge by a standard charge." + $ref: '#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_RecordCharacteristic' + remaining: + description: |- + The remaining round trip efficiency in the battery expressed as percentage. This attribute is mentioned in the Battery Regulation 2023/1542 from 12 July 2023 in Annex XIII (4) (b) refers to Article 14, refers to Annex VII Part A: + 3. where possible, the remaining round trip efficiency. + Definition from Annex IV: + (6) "Energy round trip efficiency" means the ratio of the net energy delivered by a battery during a discharge test to the total energy required to restore the initial state of charge by a standard charge. + $ref: '#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_RecordCharacteristic' + required: + - fade + - remaining + urn_samm_io.catenax.battery.battery_pass_6.0.0_ResistanceIncreaseCharacteristic: + description: Characteristic for the increase of the battery resistance. + type: object + properties: + pack: + description: "Pack resistance increase refers to the overall electrical\ + \ resistance within a battery pack. This resistance is a combination of\ + \ the individual resistances in various components within the pack, including\ + \ the electrodes, connectors, and other conductive elements. The rise\ + \ in the pack resistance is expressed as a percentage in reference to\ + \ the initial value.\nThis attribute is mentioned in the Battery regulation\ + \ 2023/1542 from 12 July 2023 in Annex XIII (4)(a) refers to Article 10(1)\ + \ and refers to Annex IV Part A: \n3. Internal resistance (in \") and\ + \ internal resistance increase (in %).\nDefinition from Annex IV:\n(5)\ + \ \"Internal resistance\" means the opposition to the flow of current\ + \ within a cell or a battery under reference conditions, that is, the\ + \ sum of electronic resistance and ionic resistance to the contribution\ + \ to total effective resistance including inductive/capacitive properties." + $ref: '#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_RecordCharacteristic' + module: + description: "The module resistance increase includes the internal resistance\ + \ of each cell within the module as well as the resistance introduced\ + \ by interconnecting components such as busbars, connectors, and thermal\ + \ management systems. The rise in the module resistance is expressed as\ + \ a percentage in reference to the initial value." + $ref: '#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_RecordCharacteristic' + cell: + description: "Cell resistance increase refers to the internal resistance\ + \ of an individual battery cell. The rise in the cell resistance is expressed\ + \ as a percentage in reference to the initial value. This attribute is\ + \ mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex\ + \ XIII (4)(a) refers to Article 10(1) and refers to Annex IV Part A: \n\ + 3. Internal resistance (in ohms) and internal resistance increase (in\ + \ %).\nDefinition from Annex IV:\n(5) \"Internal resistance\" means the\ + \ opposition to the flow of current within a cell or a battery under reference\ + \ conditions, that is, the sum of electronic resistance and ionic resistance\ + \ to the contribution to total effective resistance including inductive/capacitive\ + \ properties." + $ref: '#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_RecordCharacteristic' + required: + - pack + - cell + urn_samm_io.catenax.battery.battery_pass_6.0.0_OhmsMeasurement: + type: number + description: Measurement for ohm as double. + urn_samm_io.catenax.battery.battery_pass_6.0.0_RemainingResistanceCharacteristicRecord: + description: Characteristic for the remaining battery resistance. + type: object + properties: + time: + description: |- + The entry date and time corresponding to when a specific parameter was measured. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (4): + (d) information and data resulting from its use, including the number of charging and discharging cycles and negative events, such as accidents, as well as periodically recorded information on the operating environmental conditions, including temperature, and on the state of charge. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Timestamp' + value: + description: The remaining resistance value expressed in ohms. + $ref: '#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_OhmsMeasurement' + required: + - time + - value + urn_samm_io.catenax.battery.battery_pass_6.0.0_RemainingResistanceCharacteristic: + description: Characteristic for the remaining battery resistance. + type: object + properties: + pack: + description: |- + Pack resistance refers to the overall electrical resistance within a battery pack. This resistance is a combination of the individual resistances in various components within the pack, including the electrodes, connectors, and other conductive elements. This attribute is mentioned in the Battery Regulation 2023/1542 from 12 July 2023 in Annex XIII (4) (b) refers to Article 14, refers to Annex VII Part A: + 5. where possible, the ohmic resistance. + $ref: '#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_RemainingResistanceCharacteristicRecord' + module: + description: "Module resistance in ohms includes the internal resistance\ + \ of each cell within the module as well as the resistance introduced\ + \ by interconnecting components such as busbars, connectors, and thermal\ + \ management systems." + $ref: '#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_RemainingResistanceCharacteristicRecord' + cell: + description: |- + Cell resistance refers to the internal resistance of an individual battery cell expressed in ohms. This attribute is mentioned in the Battery Regulation 2023/1542 from 12 July 2023 in Annex XIII (4) (b) refers to Article 14, refers to Annex VII Part A: + 5. where possible, the ohmic resistance. + $ref: '#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_RemainingResistanceCharacteristicRecord' + required: + - pack + - cell + urn_samm_io.catenax.battery.battery_pass_6.0.0_DynamicInternalResistanceCharacteristic: + description: Characteristic for dynamic internal resistance values. + type: object + properties: + increase: + description: "The increase as percentage in the battery resistance on the\ + \ level of the pack, module (optional) and cell." + $ref: '#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_ResistanceIncreaseCharacteristic' + remaining: + description: "The remaining resistance in ohms in the battery on the level\ + \ of the pack, module (optional) and cell." + $ref: '#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_RemainingResistanceCharacteristic' + required: + - increase + - remaining + urn_samm_io.catenax.battery.battery_pass_6.0.0_EnergyCharacteristic: + description: Characteristic for energy values expressed in a timestamp and a + kilowatt-hours value. + type: object + properties: + time: + description: |- + The entry date and time corresponding to when a specific parameter was measured. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (4): + (d) information and data resulting from its use, including the number of charging and discharging cycles and negative events, such as accidents, as well as periodically recorded information on the operating environmental conditions, including temperature, and on the state of charge. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Timestamp' + value: + description: "Value describing the energy in a specific measurement period,\ + \ expressed in kilowatt-hours." + $ref: '#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_KilowattHourMeasurement' + required: + - time + - value + urn_samm_io.catenax.battery.battery_pass_6.0.0_DynamicEnergyCharacteristic: + description: Characteristic for dynamic energy values. + type: object + properties: + soce: + description: "The state of certified energy (SOCE) refers to the current\ + \ measured or on-board usable battery energy (UBE) performance expressed\ + \ as a percentage. This attribute is mentioned in the Battery regulation\ + \ 2023/1542 from 12 July 2023 in Annex XIII (4)(b) refers to Article 14)\ + \ and refers to Annex VII Part A: \nstate of certified energy (SOCE)." + $ref: '#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_RecordCharacteristic' + remaining: + description: The remaining energy in the battery expressed in kilowatt-hours. + $ref: '#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_EnergyCharacteristic' + throughput: + description: "Energy throughput refers to the total amount of energy that\ + \ passes through a system over a specific period. This measure encompasses\ + \ both the energy input (during charging) and the energy output (during\ + \ discharging). Energy throughput is expressed in kilowatt-hours. This\ + \ attribute is mentioned in the Battery regulation 2023/1542 from 12 July\ + \ 2023 in Annex VII Part B: \n2. the energy throughput." + $ref: '#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_EnergyCharacteristic' + required: + - soce + - remaining + urn_samm_io.catenax.battery.battery_pass_6.0.0_DynamicPerformanceCharacteristic: + description: Characteristic for dynamic performance values of the battery. + type: object + properties: + stateOfCharge: + description: |- + State of Charge (SOC) refers to the amount of energy remaining in a battery at a given point in time, expressed as a percentage of the total capacity. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (4): + (d) information and data resulting from its use, including the number of charging and discharging cycles and negative events, such as accidents, as well as periodically recorded information on the operating environmental conditions, including temperature, and on the state of charge. + $ref: '#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_RecordCharacteristic' + fullCycles: + description: |- + Full cycles include the cumulative and equivalent count of complete charge and discharge cycles experienced by the battery over its entire life. This attribute is mentioned in the Battery Regulation 2023/1542 from 12 July 2023 in Annex XIII (4) (d) information and data resulting from its use, including the number of charging and discharging cycles and negative events, such as accidents, as well as periodically recorded information on the operating environmental conditions, including temperature, and on the state of charge. + And in AnnexVII Part B: + 5. the number of full equivalent charge-discharge cycles. + $ref: '#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_FullCycleCharacteristic' + performanceDocument: + description: |- + The performance document lists information regarding the performance of the battery. This can be an overview about several rated performance attributes. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (3): + [...] results of test reports proving compliance with the requirements laid down in this Regulation or any delegated or implementing act adopted pursuant to this Regulation. + And Annex XIII (4)(a) refers to Article 10(1) and refer to Annex IV Part B: + 5. Any calculations performed with the measured parameters, if applicable. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentList' + selfDischargingRate: + description: |- + The self-discharge rate of a battery refers to the rate at which the battery loses its stored energy when not in use. It's the discharge of the battery that occurs internally without any external load recorded in percentage for every month. This attribute is mentioned in the Battery Regulation 2023/1542 from 12 July 2023 in Annex XIII (4) (b) refers to Article 14, refers to Annex VII Part A: + 4. the evolution of self-discharging rates. + $ref: '#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_PercentMeasurement' + power: + description: Values that describe dynamically captured power values. + $ref: '#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_DynamicPowerCharacteristic' + capacity: + description: Values that describe dynamically captured capacity values. + $ref: '#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_DynamicCapacityCharacteristic' + roundTripEfficiency: + description: Dynamic round trip efficiency values. + $ref: '#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_DynamicRoundTripEfficiencyCharacteristic' + resistance: + description: Values that describe dynamically captured internal resistance + values. + $ref: '#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_DynamicInternalResistanceCharacteristic' + energy: + description: Values that describe dynamically captured energy values. + $ref: '#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_DynamicEnergyCharacteristic' + negativeEvents: + description: |- + Mandatory if applicable. Negative events refers to several possible events influencing the battery's condition and lifetime such as extreme temperatures. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (4): + (d) information and data resulting from its use, including the number of charging and discharging cycles and negative events, such as accidents, as well as periodically recorded information on the operating environmental conditions, including temperature, and on the state of charge. + And Annex VII Part B: + 4. the tracking of harmful events, such as the number of deep discharge events, time spent in extreme temperatures, time spent charging in extreme temperatures. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentList' + operatingEnvironment: + description: |- + Mandatory if applicable. The operating environment refers to the conditions in which the battery is designed to function optimally. The environment includes factors such as temperature, humidity, pressure, and other external conditions that can impact the performance, safety, and lifespan of the battery. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (4): + (d) information and data resulting from its use, including the number of charging and discharging cycles and negative events, such as accidents, as well as periodically recorded information on the operating environmental conditions, including temperature, and on the state of charge. + And Annex VII Part B: + 4. the tracking of harmful events, such as the number of deep discharge events, time spent in extreme temperatures, time spent charging in extreme temperatures. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentList' + required: + - stateOfCharge + - fullCycles + - selfDischargingRate + - power + - capacity + - roundTripEfficiency + - resistance + - energy + urn_samm_io.catenax.battery.battery_pass_6.0.0_PerformanceCharacteristic: + description: Performance Characteristic for the battery. + type: object + properties: + rated: + description: "Rated performance values of the battery such as voltage, round\ + \ trip efficiency, energy, resistance, power, capacity, temperature ranges\ + \ and self-discharging rate." + $ref: '#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_RatedPerformanceCharacteristic' + dynamic: + description: Dynamic performance values of the battery. + $ref: '#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_DynamicPerformanceCharacteristic' + required: + - rated + - dynamic + urn_samm_io.catenax.battery.battery_pass_6.0.0_ConformityCharacteristic: + description: Characteristic for conformity documents. + type: object + properties: + declarationOfConformityId: + description: |- + Identification number of the EU declaration of conformity. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1): + (r) the EU declaration of conformity referred to in Article 18. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_IdentifierCharacteristic' + declarationOfConformity: + description: |- + The EU Declaration of Conformity is a document in which the manufacturer or their authorized representative declares that the battery complies with all relevant European Union product safety directives and regulations. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1): + (r) the EU declaration of conformity referred to in Article 18. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentList' + resultOfTestReport: + description: |- + The result of tests reports refers to the results of various tests conducted with the battery, testing its life cycle, life span, c-rate and various other aspects. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1): + (l) temperature range the battery can withstand when not in use (reference test); + and Annex XIII (3): + results of test reports proving compliance with the requirements laid down in this Regulation or any delegated or implementing act adopted pursuant to this Regulation. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentList' + thirdPartyAssurance: + description: |- + A summary report from third-parties, covering the verifications. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1) (d) refers to the Article 52: + 3. The economic operator referred to in Article 48(1) shall on an annual basis review and make publicly available, including on the internet, a report on its battery due diligence policy. [...], as well as a summary report of the third-party verifications carried out in accordance with Article 51, including the name of the notified body, with due regard for business confidentiality and other competitive concerns. That report shall also cover, where relevant, access to information, public participation in decision-making and access to justice in environmental matters in relation to the sourcing, processing and trading of the raw materials present in batteries. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentList' + dueDiligencePolicy: + description: |- + A report containing the information concerning the due diligence policy, a set of procedures and guidelines the organization follows to thoroughly assess and evaluate the various aspects of the battery. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1) (d) refers to the Article 52: + 3. The economic operator referred to in Article 48(1) shall on an annual basis review and make publicly available, including on the internet, a report on its battery due diligence policy. That report shall contain, in a manner that is easily comprehensible for end-users and clearly identifies the batteries concerned, the data and information on steps taken by that economic operator to comply with the requirements laid down in Articles 49 and 50, including findings of significant adverse impacts in the risk categories listed in point 2 of Annex X, and how they have been addressed, as well as a summary report of the third-party verifications carried out in accordance with Article 51, including the name of the notified body, with due regard for business confidentiality and other competitive concerns. That report shall also cover, where relevant, access to information, public participation in decision-making and access to justice in environmental matters in relation to the sourcing, processing and trading of the raw materials present in batteries. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentList' + required: + - declarationOfConformity + - resultOfTestReport + - thirdPartyAssurance + - dueDiligencePolicy + urn_samm_io.catenax.battery.battery_pass_6.0.0_ExtinguishAgentEntity: + description: Entity for the extinguish agents. + type: object + properties: + document: + description: Documentation about the extinguishing agent. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentList' + media: + description: |- + The agent used to extinguish a fire, based on the fire class. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1)(a) and refers to Annex VI Part A: + 9. usable extinguishing agent. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + fireClass: + description: "Safety classification based on the chemistry and construction\ + \ of the battery. It determines the means of handling a fire caused by\ + \ the battery. Possible values are A, B and C and a combination of these." + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + required: + - media + - fireClass + urn_samm_io.catenax.battery.battery_pass_6.0.0_ExtinguishAgentList: + description: List of extinguish agents. + type: array + items: + $ref: '#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_ExtinguishAgentEntity' + urn_samm_io.catenax.battery.battery_pass_6.0.0_SafetyCharacteristic: + description: Safety Characteristic for mostly safety documents. + type: object + properties: + usableExtinguishAgent: + description: |- + The usable extinguish agents for the battery in case of a fire. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1)(a) and refers to Annex VI Part A + 9. usable extinguishing agent. + $ref: '#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_ExtinguishAgentList' + safetyMeasures: + description: |- + Safety instruction in the form of a documentation. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (2): + (d) safety measures. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentList' + meaningOfLabels: + description: |- + Documentation on the meaning of labels on a battery which provide information to help users understand the various symbols, markings, and information present on the battery's label. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1)(s) and refers to Article 74 (1): + (e) the meaning of the labels and symbols on batteries in accordance with Article 13 or printed on their packaging or in the documents accompanying batteries [...]. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentList' + safeDischarging: + description: "Safe discharging documentation explaining for example the\ + \ setting of a minimum voltage threshold for the battery. Discharging\ + \ a battery below this threshold can lead to damage, reduced capacity,\ + \ and safety hazards." + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentList' + dismantling: + description: |- + Dismantling refers to the proper way of dismantling the battery itself. It refers to the process of taking apart the battery for various purposes, such as recycling, disposal, or examination of its components. This attribute is mentioned in the Battery Regulation 2023/1542 from 12 July 2023 in Annex XIII (2) (c) dismantling information, including at least: + - exploded diagrams of the battery system/pack showing the location of battery cells, + - disassembly sequences, + - type and number of fastening techniques to be unlocked, + - tools required for disassembly, + - warnings if risk of damaging parts exist, + - amount of cells used and layout. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentList' + removalFromAppliance: + description: "Removal refers to the proper process of disassembling a battery\ + \ from an appliance, typically for purposes such as repairs, replacements,\ + \ or disposal." + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentList' + required: + - usableExtinguishAgent + - safetyMeasures + - meaningOfLabels + - dismantling + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_SourceCategoryEnumeration: + type: string + description: The types of sources that can be linked in a digital product passport + can vary depending on the nature of the product and the information that needs + to be included. This is an enumeration of possible sources. + enum: + - Product Specifications + - Manufacturer Information + - User Manuals and Guides + - Certifications and Compliance + - Product Images and Videos + - Warranty Information + - Reviews and Ratings + - Product Variations + - Supply Chain Information + - Environmental Impact + - Compatibility and Accessories + - FAQs and Support + - Purchase and Retail Information + - Privacy and Data Handling + - Third-Party Integrations + - Legal Information + - Safety Information + - Repair and Installation + - Waste Generation and Prevention + - Specific Voluntary Labels + - Product Packaging + - Return and Disposal + - End of Life + - Material and Substance Information + - Technical Documentation + - Treatment facilities + - Other + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentEntity: + description: "Document entity with header, content, category and type." + type: object + properties: + content: + description: The content of the document e.g a link. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + category: + description: |- + The category in which the document can be sorted. These are mentioned in the ESPR proposal from March 30th, 2022 ANNEX III: + (e) compliance documentation and information required under this Regulation or other Union law applicable to the product, such as the declaration of conformity, technical documentation or conformity certificates; + ANNEX IV states additional information regarding the content of the technical documentation + Further information on documents are mentioned in the proposal from March 30th, 2022 ANNEX III: + (f) user manuals, instructions, warnings or safety information, as required by other Union legislation applicable to the product. + Additionally requirements are mentioned in Article 21: + (7) Manufacturers shall ensure that that a product covered by a delegated act adopted pursuant to Article 4 is accompanied by instructions that enable consumers and other end-users to safely assemble, install, operate, store, maintain, repair and dispose of the product in a language that can be easily understood by consumers and other end-users, as determined by the Member State concerned. Such instructions shall be clear, understandable and legible and include at least the information specified in the delegated acts adopted pursuant to Article 4 and pursuant to Article 7(2)(b), point (ii). + Article 7 states additionally: + (2) (b) (ii) information for consumers and other end-users on how to install, use, maintain and repair the product in order to minimize its impact on the environment and to ensure optimum durability, as well as on how to return or dispose of the product at end-of-life; + (2) (b) (iii) information for treatment facilities on disassembly, recycling, or disposal at end-of-life; + (2) (b) (iv) other information that may influence the way the product is handled by parties other than the manufacturer in order to improve performance in relation to product parameters referred to in Annex I. + (5) (d) relevant instructions for the safe use of the product. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_SourceCategoryEnumeration' + type: + description: "The type of content which can be expected in the \"content\"\ + \ property. Examples are a link, restricted link, pdf, excel, etc." + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + header: + description: The header as a short description of the document with a maximum + of 100 characters. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_HeaderTrait' + required: + - content + - category + - type + - header + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_SourceList: + description: A list of documents. + type: array + items: + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentEntity' + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_StatusEnumeration: + type: string + description: "The current status of the product passport declared through either:\ + \ draft, approved, invalid or expired." + enum: + - draft + - approved + - invalid + - expired + 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_io.catenax.generic.digital_product_passport_5.0.0_MetadataCharacteristic: + description: Characteristic for the passport metadata of the digital product + passport. + type: object + properties: + version: + description: |- + The current version of the product passport. The possibility of modification/ updating the product passport needs to include versioning of the dataset. This attribute is an internal versioning from the passport issuer. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Article 8: + (1) [...] The information in the product passport shall be accurate, complete, and up to date. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + status: + description: "The current status of the product passport declared through\ + \ either: draft, approved, invalid or expired." + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_StatusEnumeration' + expirationDate: + description: |- + The timestamp in the format (yyyy-mm-dd) for the product passport until when it is available or a comment describing this period. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Article 8: + (2) (h) the period during which the product passport is to remain available, which shall correspond to at least the expected lifetime of a specific product. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DateTrait' + issueDate: + description: The timestamp in the format (yyyy-mm-dd) since when the product + passport is available. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DateTrait' + economicOperatorId: + description: |- + The identification of the owner/economic operator of the passport. Proposed, according to ISO 15459, is the CIN (company identification code). Other identification numbers like the tax identification number, value added tax identification number, commercial register number and the like are also valid entries. In the Catena-X network, the BPNL is used for the identification of companies and the information stored like contact information and addresses. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Annex III: + (k) the [...] unique operator identifier code of the economic operator established in the Union responsible for carrying out the tasks set out in Article 4 of Regulation (EU) 2019/1020, or Article 15 of Regulation (EU) on general product safety, or similar tasks pursuant to other EU legislation applicable to the product. + $ref: '#/components/schemas/urn_samm_io.catenax.shared.business_partner_number_2.0.0_BpnlTrait' + passportIdentifier: + description: "The identifier of the product passport, which is an uuidv4." + $ref: '#/components/schemas/urn_samm_io.catenax.shared.uuid_2.0.0_UuidV4Trait' + predecessor: + description: |- + Identification of the preceding product passport. If there is no preceding passport, input a dummy value. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Article 8: + (2)(g) [...] Any new product passport shall be linked to the product passport or passports of the original product whenever appropriate. + $ref: '#/components/schemas/urn_samm_io.catenax.shared.uuid_2.0.0_UuidV4Trait' + backupReference: + description: |- + A reference to the data backup of the passport. This mandatory attribute will be further defined in the future. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex III: + (kb) the reference of the certified independent third-party product passport service provider hosting the back-up copy of the product passport. + Article 10 also mentions: + (c) the data included in the product passport shall be stored by the economic operator responsible for its creation or by certified independent third-party product passport service providers authorised to act on their behalf. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + registrationIdentifier: + description: |- + Identifier in the respective registry. This will be further defined in the future. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 in Article 12: + By [2 years from entering into force of this Regulation], the Commission shall set up and manage a digital registry ("the registry") storing in a secure manner at least the unique product identifier, the unique operator identifier, the unique facility identifiers. In case of products intended to be placed under the customs procedure 'release for free circulation', the registry shall also store the product commodity code. The registry shall also store the batteries' unique identifiers referred to in Article 77(3) of Regulation (EU) 2023/1542. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_IdentifierCharacteristic' + lastModification: + description: Date of the latest modification. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DateTrait' + required: + - version + - expirationDate + - issueDate + - economicOperatorId + - passportIdentifier + - predecessor + - backupReference + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_StringList: + description: List of strings. + type: array + items: + type: string + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_CommercialCharacteristic: + description: Commercial information of the product. + type: object + properties: + placedOnMarket: + description: The timestamp in the format (yyyy-mm-dd) with or without time + zone when the product was put in the market. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DateTrait' + purpose: + description: "One or more intended industry/industries of the product described\ + \ by the digital product passport. If exchanged via Catena-X, 'automotive\ + \ ' is a must choice included in the list." + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_StringList' + required: + - purpose + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_SourcesEntity: + description: Entity for a possible spare part sources. + type: object + properties: + id: + description: "The identifier of a spare part producer of the product. In\ + \ the Catena-X network, the BPNL is used for the identification of companies\ + \ and the information stored for this like contact information and addresses." + $ref: '#/components/schemas/urn_samm_io.catenax.shared.business_partner_number_2.0.0_BpnlTrait' + required: + - id + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_SourcesList: + description: List of possible spare part sources. + type: array + items: + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_SourcesEntity' + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PartsEntity: + description: Possible spare parts of the product with identifiers and names. + type: object + properties: + manufacturerPartId: + description: Part ID as assigned by the manufacturer of the part. The part + ID identifies the part in the manufacturer`s dataspace. The part ID references + a specific version of a part. The version number must be included in the + part ID if it is available. The part ID does not reference a specific + instance of a part and must not be confused with the serial number. + $ref: '#/components/schemas/urn_samm_io.catenax.part_type_information_1.0.0_PartIdCharacteristic' + nameAtManufacturer: + description: Name of the part as assigned by the manufacturer. + $ref: '#/components/schemas/urn_samm_io.catenax.part_type_information_1.0.0_PartNameCharacteristic' + required: + - manufacturerPartId + - nameAtManufacturer + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PartList: + description: A list of possible spare parts of the product. + type: array + items: + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PartsEntity' + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_SparePart: + description: Characteristic describing sources and spare parts. + type: object + properties: + producer: + description: Sources of possible spare parts. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_SourcesList' + sparePart: + description: Possible spare parts of the product. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PartList' + required: + - producer + - sparePart + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_HandlingCharacteristic: + description: Characteristic to describe aspects which are connected with the + handling of the product. + type: object + properties: + content: + description: The list of spare parts available for the product from various + suppliers. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_SparePart' + applicable: + description: "Check whether the connected attributes are applicable to the\ + \ product. If it is not applicable (false), dummy data can be delivered." + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Boolean' + required: + - content + - applicable + BatteryPass: + description: |- + The battery pass describes information collected during the lifecycle of a battery. The battery passport is heavily based on the Regulation (EU) 2023/1542 of the European Parliament and of the Council of 12 July 2023 concerning batteries and waste batteries, amending Directive 2008/98/EC and Regulation (EU) 2019/1020 and repealing Directive 2006/66/EC. + Additionally attributes come from the Proposal for Ecodesign for Sustainable Products Regulation. + type: object + properties: + identification: + description: |- + Battery identification involves specific battery identifiers, including those assigned locally by the manufacturer. This attribute is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in Annex XIII (1)(a) refers to AnnexVi PartA (2) refers to Article 38 (6): + battery batch number or serial number or product number or another element allowing their identification. + $ref: '#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_IdentificationCharacteristic' + operation: + description: "General operation information includes details such as the\ + \ manufacturer's identification and the date of production. This attribute\ + \ is mentioned in the Battery regulation 2023/1542 from 12 July 2023 in\ + \ Annex XIII (1) (a) and refers to ANNEX VI Part A which refers to Article\ + \ 38:\n7. Manufacturers shall indicate on the battery their name, registered\ + \ trade name or registered trade mark, their postal address, indicating\ + \ a single contact point, and, if available, web and e-mail address. \n\ + From Annex XIII (1) (a) and found in ANNEX VI Part A :\n3. the place of\ + \ manufacture (geographical location of a battery manufacturing plant).\n\ + 4. the date of manufacture (month and year)." + $ref: '#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_OperationCharacteristic' + characteristics: + description: "Characteristics of the battery, such as the warranty and the\ + \ physical dimensions." + $ref: '#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_CharacteristicsElement' + sustainability: + description: "Sustainability includes information on the carbon footprint,\ + \ sustainability documents and the status of the battery." + $ref: '#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_SustainabilityCharacteristic' + materials: + description: "Chemical materials relevant for the composition of the battery.\ + \ These include active, hazardous and critical materials." + $ref: '#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_ChemicalMaterialCharacteristic' + performance: + description: Performance attributes of the battery including rated and dynamic + values. + $ref: '#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_PerformanceCharacteristic' + conformity: + description: Conformity documents for the battery passport. + $ref: '#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_ConformityCharacteristic' + safety: + description: "Safety information on the battery. Included are the attributes\ + \ safety measurements, meaning of labels, safe discharging and dismantling.\ + \ These are all documents. Additionally information about usable extinguish\ + \ agent can be provided." + $ref: '#/components/schemas/urn_samm_io.catenax.battery.battery_pass_6.0.0_SafetyCharacteristic' + sources: + description: Consider additional available sources to enhance the content + of the battery passport. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_SourceList' + metadata: + description: "Metadata of the product passport. These are mentioned in the\ + \ ESPR proposal from March 30th, 2022 and some changed by the provisional\ + \ agreement from January 9th, 2024." + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_MetadataCharacteristic' + commercial: + description: Commercial information of the product. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_CommercialCharacteristic' + handling: + description: Properties connected with the handling of the product. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_HandlingCharacteristic' + required: + - identification + - operation + - characteristics + - sustainability + - materials + - performance + - conformity + - safety + - metadata + - commercial + - handling + 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' + BatteryPass: + content: + application/json: + schema: + $ref: '#/components/schemas/PagingSchema' + description: The request was successful. + requestBodies: + BatteryPass: + content: + application/json: + schema: + $ref: '#/components/schemas/BatteryPass' diff --git a/io.catenax.battery.battery_pass/6.0.0/metadata.json b/io.catenax.battery.battery_pass/6.0.0/metadata.json new file mode 100644 index 000000000..eb94ac1ea --- /dev/null +++ b/io.catenax.battery.battery_pass/6.0.0/metadata.json @@ -0,0 +1 @@ +{ "status" : "release"} diff --git a/io.catenax.battery.battery_pass/RELEASE_NOTES.md b/io.catenax.battery.battery_pass/RELEASE_NOTES.md index 2384118a9..dc164903d 100644 --- a/io.catenax.battery.battery_pass/RELEASE_NOTES.md +++ b/io.catenax.battery.battery_pass/RELEASE_NOTES.md @@ -2,6 +2,17 @@ All notable changes to this model will be documented in this file. ## [Unreleased] +## [6.0.0] - 2024-05-21 +### Changed +- connection update to @prefix ext-passport: +- declarationOfConformityId is a string instead of a document list +- example values for doubles are now doubles and not integers +- corrected description texts with typos + +### Added +- added commercial from ext-passport + + ## [5.0.0] - 2024-03-04 ### Changed - import of the new samm:io.catenax.generic.digital_product_passport:4.0.0 diff --git a/io.catenax.bom_as_specified/2.0.0/SingleLevelBomAsSpecified.ttl b/io.catenax.bom_as_specified/2.0.0/SingleLevelBomAsSpecified.ttl deleted file mode 100644 index be893720e..000000000 --- a/io.catenax.bom_as_specified/2.0.0/SingleLevelBomAsSpecified.ttl +++ /dev/null @@ -1,190 +0,0 @@ -####################################################################### -# Copyright (c) 2022 T-Systems International GmbH -# Copyright (c) 2023 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) -# Copyright (c) 2022 Volkswagen AG -# Copyright (c) 2022 Robert Bosch GmbH -# Copyright (c) 2022 ZF Friedrichshafen AG -# Copyright (c) 2022 Contributors to the Eclipse Foundation -# -# 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 bamm: . -@prefix bamm-c: . -@prefix bamm-e: . -@prefix unit: . -@prefix rdf: . -@prefix rdfs: . -@prefix xsd: . -@prefix : . - -:catenaXId a bamm:Property; - bamm:preferredName "Catena-X ID"@en; - bamm:description "A unique reference within Catena-X of this items"@en; - bamm:characteristic :CatenaXIdTrait; - bamm:exampleValue "urn:uuid:055c1128-0375-47c8-98de-7cf802c3241d". -:CatenaXIdTrait a bamm-c:Trait; - bamm-c:baseCharacteristic bamm-c:Text; - bamm-c:constraint :Uuidv4RegularExpression. -:Uuidv4RegularExpression a bamm-c:RegularExpressionConstraint; - bamm:preferredName "Catena-X ID Regular Expression"@en; - bamm: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)."@en; - bamm:value "(^[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}$)". -:childParts a bamm:Property; - bamm:preferredName "Child Parts"@en; - bamm:description "The child part of the observed parent item"@en; - bamm:characteristic :ChildPartsCharacteristic. -:ChildPartsCharacteristic a bamm-c:Set; - bamm:preferredName "Child Parts Characteristic"@en; - bamm:description "The characteristic of the child part property"@en; - bamm:dataType :ChildPartsEntity. -:ChildPartsEntity a bamm:Entity; - bamm:preferredName "Child Parts Entity"@en; - bamm:description "Encapsulates the properties describing the child part item"@en; - bamm:properties (:childPartsCategory :part :childPartsCategory :part :childCatenaXId). -:childPartsCategory a bamm:Property; - bamm:preferredName "Child Parts Category"@en; - bamm:description "The BomAsSpecified defines the view of the OEM or producer of the whole product, e.g. the OEM of a vehicle. It is free of any supplier-related information and specifies the promised and guaranteed content of the whole product to the end customer. This “top-down” view is in contrast to the “bottom-up” view of the SingleLevelBoMAsPlanned, though several sub-aspects are shared. The BomAsSpecified is merely one aspect, which is attached to the twin of the whole product and itself does neither introduce further twins nor reference them. Instead it merely comprises all functional information required by dismantlers, workshops or requestors for used parts to search for and to make a match on the market place."@en; - bamm:characteristic bamm-c:Text; - bamm:exampleValue "e.g. vehicle, winter wheels, bicycle rack". -:part a bamm:Property; - bamm:preferredName "Part"@en; - bamm:description "The description of the part in the primary language of the production facility of the product owner."@en; - bamm:characteristic :PartCharacteristic. -:childCatenaXId a bamm:Property; - bamm:preferredName "Child CatenaXId"@en; - bamm:description "Describes the Catena-X ID of the child part"@en; - bamm:characteristic bamm-c:Text; - bamm:exampleValue "urn:uuid:218b26f4-4a0b-4a7f-b2c1-d248927718bf ". -:PartCharacteristic a bamm-c:Set; - bamm:preferredName "Part Characteristic"@en; - bamm:description "Characteristic of the part."@en; - bamm:dataType :PartEntity. -:PartEntity a bamm:Entity; - bamm:preferredName "Part Entity"@en; - bamm:description "Entity encapsulating the properies describing a part"@en; - bamm:properties (:ownerPartId [ - bamm:property :partVersion; - bamm:optional "true"^^xsd:boolean -] [ - bamm:property :partQuantity; - bamm:optional "true"^^xsd:boolean -] [ - bamm:property :partDescription; - bamm:optional "true"^^xsd:boolean -] [ - bamm:property :partClassification; - bamm:optional "true"^^xsd:boolean -] [ - bamm:property :lastModifiedOn; - bamm:optional "true"^^xsd:boolean -] [ - bamm:property :createdOn; - bamm:optional "true"^^xsd:boolean -] :ownerPartId [ - bamm:property :partVersion; - bamm:optional "true"^^xsd:boolean -] [ - bamm:property :partQuantity; - bamm:optional "true"^^xsd:boolean -] [ - bamm:property :partDescription; - bamm:optional "true"^^xsd:boolean -] [ - bamm:property :partClassification; - bamm:optional "true"^^xsd:boolean -] [ - bamm:property :lastModifiedOn; - bamm:optional "true"^^xsd:boolean -] [ - bamm:property :createdOn; - bamm:optional "true"^^xsd:boolean -]). -:ownerPartId a bamm:Property; - bamm:preferredName "Owner Part ID"@en; - bamm:description "This is the key field of the component which usually keeps the part numbers used in after-sales, e.g. when repairing broken parts and searching for a replacement. This ownerPartId itself isn't usually bound to one part version, with the assumption that all part versions with the same ownerPartId are mutually interchangeable."@en; - bamm:characteristic :CatenaXIdTrait; - bamm:exampleValue "uuid!". -:partVersion a bamm:Property; - bamm:preferredName "Part Version"@en; - bamm:description "This is the version of the part. The engineering will at times supercede an older part version by a newer one, which might have different material aspects, physical dimensions etc., still maintaining compatibility."@en; - bamm:characteristic bamm-c:Text; - bamm:exampleValue "05". -:partQuantity a bamm:Property; - bamm:preferredName "Part Quantity"@en; - bamm:description "This is the quantity how often this part is in the item."@en; - bamm:characteristic :PartQuantityCharacteristic. -:partDescription a bamm:Property; - bamm:preferredName "Part Description"@en; - bamm:description "The description of the part in the primary language of the production facility of the product owner."@en; - bamm:characteristic bamm-c:Text; - bamm:exampleValue "The steering wheel is nice and round". -:partClassification a bamm:Property; - bamm:preferredName "Part Classification"@en; - bamm:description "The part classification."@en; - bamm:characteristic :PartClassificationCharacteristic. -:lastModifiedOn a bamm:Property; - bamm:preferredName "Last Modified On"@en; - bamm:description "The time the item was modified the last time"@en; - bamm:characteristic bamm-c:Timestamp; - bamm:exampleValue "2022-02-03T14:48:54.709Z"^^xsd:dateTime. -:createdOn a bamm:Property; - bamm:preferredName "Created On"@en; - bamm:description "The time the item was created on"@en; - bamm:characteristic bamm-c:Timestamp; - bamm:exampleValue "2022-02-03T14:48:54.709Z"^^xsd:dateTime. -:PartQuantityCharacteristic a bamm:Characteristic; - bamm:preferredName "Part Quantity Characteristic"@en; - bamm:description "The characteristic of the part quantity."@en; - bamm:dataType :PartQuantityEntity. -:PartClassificationCharacteristic a bamm-c:Set; - bamm:preferredName "Part Classification Characteristic"@en; - bamm:description "The characteristic of the part classification."@en; - bamm:dataType :PartClassificationEntity. -:PartQuantityEntity a bamm:Entity; - bamm:preferredName "Part Quantity Entity"@en; - bamm:description "The entity encapsulating the properties describing the quantity of a part."@en; - bamm:properties (:measurementUnit :quantityNumber :measurementUnit :quantityNumber). -:PartClassificationEntity a bamm:Entity; - bamm:preferredName "Part Classification Entity"@en; - bamm:description "The entity encapsulating the properties of the part classification."@en; - bamm:properties (:key :value :key :value). -:measurementUnit a bamm:Property; - bamm:preferredName "Measurement Unit"@en; - bamm:description "Unit of measurement for the quantity of serialized objects."@en; - bamm:characteristic bamm-c:UnitReference; - bamm:exampleValue "kW"^^bamm:curie. -:quantityNumber a bamm:Property; - bamm:preferredName "Quantity Number"@en; - bamm:description "The number of objects related to the measurement unit."@en; - bamm:characteristic :NumberOfObjects; - bamm:exampleValue "350"^^xsd:double. -:key a bamm:Property; - bamm:preferredName "Key"@en; - bamm:description "Key within the classification."@en; - bamm:characteristic bamm-c:Text; - bamm:exampleValue "BMW:PartFamily". -:value a bamm:Property; - bamm:preferredName "Value"@en; - bamm:description "Value within the classification."@en; - bamm:characteristic bamm-c:Text; - bamm:exampleValue "STEEWHL". -:NumberOfObjects a bamm:Characteristic; - bamm:preferredName "Number of Objects"@en; - bamm:description "Quantifiable number of objects in reference to the measurementUnit."@en; - bamm:dataType xsd:double. -:SingleLevelBomAsSpecified a bamm:Aspect; - bamm:preferredName "Single Level BOM as Specified"@en; - bamm:description "The SingleLevelBomAsSpecified defines the view of the OEM or producer of the whole product, e.g. the OEM of a vehicle. It is free of any supplier-related information and specifies the promised and guaranteed content of the whole product to the end customer. This “top-down” view is in contrast to the “bottom-up” view of the SingleLevelBoMAsPlanned, though several sub-aspects are shared. The BomAsSpecified is merely one aspect, which is attached to the twin of the whole product and itself does neither introduce further twins nor reference them. Instead it merely comprises all functional information required by dismantlers, workshops or requestors for used parts to search for and to make a match on the market place."@en; - bamm:properties (:catenaXId :childParts :catenaXId :childParts); - bamm:operations (); - bamm:events (). - diff --git a/io.catenax.bom_as_specified/2.0.0/gen/SingleLevelBomAsSpecified-aas.xml b/io.catenax.bom_as_specified/2.0.0/gen/SingleLevelBomAsSpecified-aas.xml deleted file mode 100644 index 72bb02905..000000000 --- a/io.catenax.bom_as_specified/2.0.0/gen/SingleLevelBomAsSpecified-aas.xml +++ /dev/null @@ -1,9153 +0,0 @@ - - - - - defaultAdminShell - - - en - defaultAdminShell - - - - urn:samm:io.catenax.bom_as_specified:2.0.0#SingleLevelBomAsSpecified - - Type - - - - ModelReference - - - Submodel - urn:samm:io.catenax.bom_as_specified:2.0.0#SingleLevelBomAsSpecified/submodel - - - - - - - - - SingleLevelBomAsSpecified - - - en - The SingleLevelBomAsSpecified defines the view of the OEM or producer of the whole product, e.g. the OEM of a vehicle. It is free of any supplier-related information and specifies the promised and guaranteed content of the whole product to the end customer. This ?top-down? view is in contrast to the ?bottom-up? view of the SingleLevelBoMAsPlanned, though several sub-aspects are shared. The BomAsSpecified is merely one aspect, which is attached to the twin of the whole product and itself does neither introduce further twins nor reference them. Instead it merely comprises all functional information required by dismantlers, workshops or requestors for used parts to search for and to make a match on the market place. - - - - urn:samm:io.catenax.bom_as_specified:2.0.0#SingleLevelBomAsSpecified/submodel - Template - - ModelReference - - - ConceptDescription - urn:samm:io.catenax.bom_as_specified:2.0.0#SingleLevelBomAsSpecified - - - - - - catenaXId - - - en - Catena-X ID - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.bom_as_specified:2.0.0#catenaXId - - - - xs:string - - - - childParts - - - en - Child Parts - - - - - en - The child part of the observed parent item - - - true - DataElement - - - ChildPartsEntity - - - en - Child Parts Entity - - - - - en - Encapsulates the properties describing the child part item - - - - - childPartsCategory - - - en - Child Parts Category - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.bom_as_specified:2.0.0#childPartsCategory - - - - xs:string - - - - part - - - en - Part - - - - - en - The description of the part in the primary language of the production facility of the product owner. - - - true - DataElement - - - PartEntity - - - en - Part Entity - - - - - en - Entity encapsulating the properies describing a part - - - - - ownerPartId - - - en - Owner Part ID - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.bom_as_specified:2.0.0#ownerPartId - - - - xs:string - - - - partVersion - - - en - Part Version - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.bom_as_specified:2.0.0#partVersion - - - - xs:string - - - - PartQuantityEntity - - - en - Part Quantity Entity - - - - - en - The entity encapsulating the properties describing the quantity of a part. - - - - - measurementUnit - - - en - Measurement Unit - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.bom_as_specified:2.0.0#measurementUnit - - - - xs:string - - - - quantityNumber - - - en - Quantity Number - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.bom_as_specified:2.0.0#quantityNumber - - - - xs:double - - - - measurementUnit - - - en - Measurement Unit - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.bom_as_specified:2.0.0#measurementUnit - - - - xs:string - - - - quantityNumber - - - en - Quantity Number - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.bom_as_specified:2.0.0#quantityNumber - - - - xs:double - - - - - - partDescription - - - en - Part Description - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.bom_as_specified:2.0.0#partDescription - - - - xs:string - - - - partClassification - - - en - Part Classification - - - - - en - The part classification. - - - true - DataElement - - - PartClassificationEntity - - - en - Part Classification Entity - - - - - en - The entity encapsulating the properties of the part classification. - - - - - key - - - en - Key - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.bom_as_specified:2.0.0#key - - - - xs:string - - - - value - - - en - Value - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.bom_as_specified:2.0.0#value - - - - xs:string - - - - key - - - en - Key - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.bom_as_specified:2.0.0#key - - - - xs:string - - - - value - - - en - Value - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.bom_as_specified:2.0.0#value - - - - xs:string - - - - - - - - lastModifiedOn - - - en - Last Modified On - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.bom_as_specified:2.0.0#lastModifiedOn - - - - xs:dateTime - - - - createdOn - - - en - Created On - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.bom_as_specified:2.0.0#createdOn - - - - xs:dateTime - - - - ownerPartId - - - en - Owner Part ID - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.bom_as_specified:2.0.0#ownerPartId - - - - xs:string - - - - partVersion - - - en - Part Version - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.bom_as_specified:2.0.0#partVersion - - - - xs:string - - - - PartQuantityEntity - - - en - Part Quantity Entity - - - - - en - The entity encapsulating the properties describing the quantity of a part. - - - - - measurementUnit - - - en - Measurement Unit - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.bom_as_specified:2.0.0#measurementUnit - - - - xs:string - - - - quantityNumber - - - en - Quantity Number - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.bom_as_specified:2.0.0#quantityNumber - - - - xs:double - - - - measurementUnit - - - en - Measurement Unit - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.bom_as_specified:2.0.0#measurementUnit - - - - xs:string - - - - quantityNumber - - - en - Quantity Number - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.bom_as_specified:2.0.0#quantityNumber - - - - xs:double - - - - - - partDescription - - - en - Part Description - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.bom_as_specified:2.0.0#partDescription - - - - xs:string - - - - partClassification - - - en - Part Classification - - - - - en - The part classification. - - - true - DataElement - - - PartClassificationEntity - - - en - Part Classification Entity - - - - - en - The entity encapsulating the properties of the part classification. - - - - - key - - - en - Key - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.bom_as_specified:2.0.0#key - - - - xs:string - - - - value - - - en - Value - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.bom_as_specified:2.0.0#value - - - - xs:string - - - - key - - - en - Key - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.bom_as_specified:2.0.0#key - - - - xs:string - - - - value - - - en - Value - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.bom_as_specified:2.0.0#value - - - - xs:string - - - - - - - - lastModifiedOn - - - en - Last Modified On - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.bom_as_specified:2.0.0#lastModifiedOn - - - - xs:dateTime - - - - createdOn - - - en - Created On - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.bom_as_specified:2.0.0#createdOn - - - - xs:dateTime - - - - - - - - childPartsCategory - - - en - Child Parts Category - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.bom_as_specified:2.0.0#childPartsCategory - - - - xs:string - - - - part - - - en - Part - - - - - en - The description of the part in the primary language of the production facility of the product owner. - - - true - DataElement - - - PartEntity - - - en - Part Entity - - - - - en - Entity encapsulating the properies describing a part - - - - - ownerPartId - - - en - Owner Part ID - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.bom_as_specified:2.0.0#ownerPartId - - - - xs:string - - - - partVersion - - - en - Part Version - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.bom_as_specified:2.0.0#partVersion - - - - xs:string - - - - PartQuantityEntity - - - en - Part Quantity Entity - - - - - en - The entity encapsulating the properties describing the quantity of a part. - - - - - measurementUnit - - - en - Measurement Unit - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.bom_as_specified:2.0.0#measurementUnit - - - - xs:string - - - - quantityNumber - - - en - Quantity Number - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.bom_as_specified:2.0.0#quantityNumber - - - - xs:double - - - - measurementUnit - - - en - Measurement Unit - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.bom_as_specified:2.0.0#measurementUnit - - - - xs:string - - - - quantityNumber - - - en - Quantity Number - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.bom_as_specified:2.0.0#quantityNumber - - - - xs:double - - - - - - partDescription - - - en - Part Description - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.bom_as_specified:2.0.0#partDescription - - - - xs:string - - - - partClassification - - - en - Part Classification - - - - - en - The part classification. - - - true - DataElement - - - PartClassificationEntity - - - en - Part Classification Entity - - - - - en - The entity encapsulating the properties of the part classification. - - - - - key - - - en - Key - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.bom_as_specified:2.0.0#key - - - - xs:string - - - - value - - - en - Value - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.bom_as_specified:2.0.0#value - - - - xs:string - - - - key - - - en - Key - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.bom_as_specified:2.0.0#key - - - - xs:string - - - - value - - - en - Value - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.bom_as_specified:2.0.0#value - - - - xs:string - - - - - - - - lastModifiedOn - - - en - Last Modified On - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.bom_as_specified:2.0.0#lastModifiedOn - - - - xs:dateTime - - - - createdOn - - - en - Created On - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.bom_as_specified:2.0.0#createdOn - - - - xs:dateTime - - - - ownerPartId - - - en - Owner Part ID - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.bom_as_specified:2.0.0#ownerPartId - - - - xs:string - - - - partVersion - - - en - Part Version - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.bom_as_specified:2.0.0#partVersion - - - - xs:string - - - - PartQuantityEntity - - - en - Part Quantity Entity - - - - - en - The entity encapsulating the properties describing the quantity of a part. - - - - - measurementUnit - - - en - Measurement Unit - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.bom_as_specified:2.0.0#measurementUnit - - - - xs:string - - - - quantityNumber - - - en - Quantity Number - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.bom_as_specified:2.0.0#quantityNumber - - - - xs:double - - - - measurementUnit - - - en - Measurement Unit - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.bom_as_specified:2.0.0#measurementUnit - - - - xs:string - - - - quantityNumber - - - en - Quantity Number - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.bom_as_specified:2.0.0#quantityNumber - - - - xs:double - - - - - - partDescription - - - en - Part Description - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.bom_as_specified:2.0.0#partDescription - - - - xs:string - - - - partClassification - - - en - Part Classification - - - - - en - The part classification. - - - true - DataElement - - - PartClassificationEntity - - - en - Part Classification Entity - - - - - en - The entity encapsulating the properties of the part classification. - - - - - key - - - en - Key - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.bom_as_specified:2.0.0#key - - - - xs:string - - - - value - - - en - Value - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.bom_as_specified:2.0.0#value - - - - xs:string - - - - key - - - en - Key - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.bom_as_specified:2.0.0#key - - - - xs:string - - - - value - - - en - Value - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.bom_as_specified:2.0.0#value - - - - xs:string - - - - - - - - lastModifiedOn - - - en - Last Modified On - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.bom_as_specified:2.0.0#lastModifiedOn - - - - xs:dateTime - - - - createdOn - - - en - Created On - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.bom_as_specified:2.0.0#createdOn - - - - xs:dateTime - - - - - - - - childCatenaXId - - - en - Child CatenaXId - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.bom_as_specified:2.0.0#childCatenaXId - - - - xs:string - - - - - - - - catenaXId - - - en - Catena-X ID - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.bom_as_specified:2.0.0#catenaXId - - - - xs:string - - - - childParts - - - en - Child Parts - - - - - en - The child part of the observed parent item - - - true - DataElement - - - ChildPartsEntity - - - en - Child Parts Entity - - - - - en - Encapsulates the properties describing the child part item - - - - - childPartsCategory - - - en - Child Parts Category - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.bom_as_specified:2.0.0#childPartsCategory - - - - xs:string - - - - part - - - en - Part - - - - - en - The description of the part in the primary language of the production facility of the product owner. - - - true - DataElement - - - PartEntity - - - en - Part Entity - - - - - en - Entity encapsulating the properies describing a part - - - - - ownerPartId - - - en - Owner Part ID - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.bom_as_specified:2.0.0#ownerPartId - - - - xs:string - - - - partVersion - - - en - Part Version - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.bom_as_specified:2.0.0#partVersion - - - - xs:string - - - - PartQuantityEntity - - - en - Part Quantity Entity - - - - - en - The entity encapsulating the properties describing the quantity of a part. - - - - - measurementUnit - - - en - Measurement Unit - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.bom_as_specified:2.0.0#measurementUnit - - - - xs:string - - - - quantityNumber - - - en - Quantity Number - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.bom_as_specified:2.0.0#quantityNumber - - - - xs:double - - - - measurementUnit - - - en - Measurement Unit - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.bom_as_specified:2.0.0#measurementUnit - - - - xs:string - - - - quantityNumber - - - en - Quantity Number - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.bom_as_specified:2.0.0#quantityNumber - - - - xs:double - - - - - - partDescription - - - en - Part Description - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.bom_as_specified:2.0.0#partDescription - - - - xs:string - - - - partClassification - - - en - Part Classification - - - - - en - The part classification. - - - true - DataElement - - - PartClassificationEntity - - - en - Part Classification Entity - - - - - en - The entity encapsulating the properties of the part classification. - - - - - key - - - en - Key - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.bom_as_specified:2.0.0#key - - - - xs:string - - - - value - - - en - Value - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.bom_as_specified:2.0.0#value - - - - xs:string - - - - key - - - en - Key - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.bom_as_specified:2.0.0#key - - - - xs:string - - - - value - - - en - Value - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.bom_as_specified:2.0.0#value - - - - xs:string - - - - - - - - lastModifiedOn - - - en - Last Modified On - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.bom_as_specified:2.0.0#lastModifiedOn - - - - xs:dateTime - - - - createdOn - - - en - Created On - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.bom_as_specified:2.0.0#createdOn - - - - xs:dateTime - - - - ownerPartId - - - en - Owner Part ID - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.bom_as_specified:2.0.0#ownerPartId - - - - xs:string - - - - partVersion - - - en - Part Version - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.bom_as_specified:2.0.0#partVersion - - - - xs:string - - - - PartQuantityEntity - - - en - Part Quantity Entity - - - - - en - The entity encapsulating the properties describing the quantity of a part. - - - - - measurementUnit - - - en - Measurement Unit - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.bom_as_specified:2.0.0#measurementUnit - - - - xs:string - - - - quantityNumber - - - en - Quantity Number - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.bom_as_specified:2.0.0#quantityNumber - - - - xs:double - - - - measurementUnit - - - en - Measurement Unit - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.bom_as_specified:2.0.0#measurementUnit - - - - xs:string - - - - quantityNumber - - - en - Quantity Number - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.bom_as_specified:2.0.0#quantityNumber - - - - xs:double - - - - - - partDescription - - - en - Part Description - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.bom_as_specified:2.0.0#partDescription - - - - xs:string - - - - partClassification - - - en - Part Classification - - - - - en - The part classification. - - - true - DataElement - - - PartClassificationEntity - - - en - Part Classification Entity - - - - - en - The entity encapsulating the properties of the part classification. - - - - - key - - - en - Key - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.bom_as_specified:2.0.0#key - - - - xs:string - - - - value - - - en - Value - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.bom_as_specified:2.0.0#value - - - - xs:string - - - - key - - - en - Key - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.bom_as_specified:2.0.0#key - - - - xs:string - - - - value - - - en - Value - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.bom_as_specified:2.0.0#value - - - - xs:string - - - - - - - - lastModifiedOn - - - en - Last Modified On - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.bom_as_specified:2.0.0#lastModifiedOn - - - - xs:dateTime - - - - createdOn - - - en - Created On - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.bom_as_specified:2.0.0#createdOn - - - - xs:dateTime - - - - - - - - childPartsCategory - - - en - Child Parts Category - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.bom_as_specified:2.0.0#childPartsCategory - - - - xs:string - - - - part - - - en - Part - - - - - en - The description of the part in the primary language of the production facility of the product owner. - - - true - DataElement - - - PartEntity - - - en - Part Entity - - - - - en - Entity encapsulating the properies describing a part - - - - - ownerPartId - - - en - Owner Part ID - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.bom_as_specified:2.0.0#ownerPartId - - - - xs:string - - - - partVersion - - - en - Part Version - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.bom_as_specified:2.0.0#partVersion - - - - xs:string - - - - PartQuantityEntity - - - en - Part Quantity Entity - - - - - en - The entity encapsulating the properties describing the quantity of a part. - - - - - measurementUnit - - - en - Measurement Unit - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.bom_as_specified:2.0.0#measurementUnit - - - - xs:string - - - - quantityNumber - - - en - Quantity Number - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.bom_as_specified:2.0.0#quantityNumber - - - - xs:double - - - - measurementUnit - - - en - Measurement Unit - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.bom_as_specified:2.0.0#measurementUnit - - - - xs:string - - - - quantityNumber - - - en - Quantity Number - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.bom_as_specified:2.0.0#quantityNumber - - - - xs:double - - - - - - partDescription - - - en - Part Description - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.bom_as_specified:2.0.0#partDescription - - - - xs:string - - - - partClassification - - - en - Part Classification - - - - - en - The part classification. - - - true - DataElement - - - PartClassificationEntity - - - en - Part Classification Entity - - - - - en - The entity encapsulating the properties of the part classification. - - - - - key - - - en - Key - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.bom_as_specified:2.0.0#key - - - - xs:string - - - - value - - - en - Value - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.bom_as_specified:2.0.0#value - - - - xs:string - - - - key - - - en - Key - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.bom_as_specified:2.0.0#key - - - - xs:string - - - - value - - - en - Value - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.bom_as_specified:2.0.0#value - - - - xs:string - - - - - - - - lastModifiedOn - - - en - Last Modified On - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.bom_as_specified:2.0.0#lastModifiedOn - - - - xs:dateTime - - - - createdOn - - - en - Created On - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.bom_as_specified:2.0.0#createdOn - - - - xs:dateTime - - - - ownerPartId - - - en - Owner Part ID - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.bom_as_specified:2.0.0#ownerPartId - - - - xs:string - - - - partVersion - - - en - Part Version - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.bom_as_specified:2.0.0#partVersion - - - - xs:string - - - - PartQuantityEntity - - - en - Part Quantity Entity - - - - - en - The entity encapsulating the properties describing the quantity of a part. - - - - - measurementUnit - - - en - Measurement Unit - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.bom_as_specified:2.0.0#measurementUnit - - - - xs:string - - - - quantityNumber - - - en - Quantity Number - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.bom_as_specified:2.0.0#quantityNumber - - - - xs:double - - - - measurementUnit - - - en - Measurement Unit - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.bom_as_specified:2.0.0#measurementUnit - - - - xs:string - - - - quantityNumber - - - en - Quantity Number - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.bom_as_specified:2.0.0#quantityNumber - - - - xs:double - - - - - - partDescription - - - en - Part Description - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.bom_as_specified:2.0.0#partDescription - - - - xs:string - - - - partClassification - - - en - Part Classification - - - - - en - The part classification. - - - true - DataElement - - - PartClassificationEntity - - - en - Part Classification Entity - - - - - en - The entity encapsulating the properties of the part classification. - - - - - key - - - en - Key - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.bom_as_specified:2.0.0#key - - - - xs:string - - - - value - - - en - Value - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.bom_as_specified:2.0.0#value - - - - xs:string - - - - key - - - en - Key - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.bom_as_specified:2.0.0#key - - - - xs:string - - - - value - - - en - Value - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.bom_as_specified:2.0.0#value - - - - xs:string - - - - - - - - lastModifiedOn - - - en - Last Modified On - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.bom_as_specified:2.0.0#lastModifiedOn - - - - xs:dateTime - - - - createdOn - - - en - Created On - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.bom_as_specified:2.0.0#createdOn - - - - xs:dateTime - - - - - - - - childCatenaXId - - - en - Child CatenaXId - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.bom_as_specified:2.0.0#childCatenaXId - - - - xs:string - - - - - - - - - - - - APPLICATION_CLASS - SingleLevelBomAsSpecified - - - en - Single Level BOM as Specified - - - - - en - The SingleLevelBomAsSpecified defines the view of the OEM or producer of the whole product, e.g. the OEM of a vehicle. It is free of any supplier-related information and specifies the promised and guaranteed content of the whole product to the end customer. This ?top-down? view is in contrast to the ?bottom-up? view of the SingleLevelBoMAsPlanned, though several sub-aspects are shared. The BomAsSpecified is merely one aspect, which is attached to the twin of the whole product and itself does neither introduce further twins nor reference them. Instead it merely comprises all functional information required by dismantlers, workshops or requestors for used parts to search for and to make a match on the market place. - - - urn:samm:io.catenax.bom_as_specified:2.0.0#SingleLevelBomAsSpecified - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Single Level BOM as Specified - - - - - en - SingleLevelBomAsSpecified - - - - - en - The SingleLevelBomAsSpecified defines the view of the OEM or producer of the whole product, e.g. the OEM of a vehicle. It is free of any supplier-related information and specifies the promised and guaranteed content of the whole product to the end customer. This ?top-down? view is in contrast to the ?bottom-up? view of the SingleLevelBoMAsPlanned, though several sub-aspects are shared. The BomAsSpecified is merely one aspect, which is attached to the twin of the whole product and itself does neither introduce further twins nor reference them. Instead it merely comprises all functional information required by dismantlers, workshops or requestors for used parts to search for and to make a match on the market place. - - - - - - - - - catenaXId - - - en - Catena-X ID - - - urn:samm:io.catenax.bom_as_specified:2.0.0#catenaXId - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Catena-X ID - - - - - en - catenaXId - - - STRING - - - en - A unique reference within Catena-X of this items - - - - - - - - - childPartsCategory - - - en - Child Parts Category - - - urn:samm:io.catenax.bom_as_specified:2.0.0#childPartsCategory - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Child Parts Category - - - - - en - childPartsCategory - - - STRING - - - en - The BomAsSpecified defines the view of the OEM or producer of the whole product, e.g. the OEM of a vehicle. It is free of any supplier-related information and specifies the promised and guaranteed content of the whole product to the end customer. This ?top-down? view is in contrast to the ?bottom-up? view of the SingleLevelBoMAsPlanned, though several sub-aspects are shared. The BomAsSpecified is merely one aspect, which is attached to the twin of the whole product and itself does neither introduce further twins nor reference them. Instead it merely comprises all functional information required by dismantlers, workshops or requestors for used parts to search for and to make a match on the market place. - - - - - - - - - ownerPartId - - - en - Owner Part ID - - - urn:samm:io.catenax.bom_as_specified:2.0.0#ownerPartId - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Owner Part ID - - - - - en - ownerPartId - - - STRING - - - en - This is the key field of the component which usually keeps the part numbers used in after-sales, e.g. when repairing broken parts and searching for a replacement. This ownerPartId itself isn't usually bound to one part version, with the assumption that all part versions with the same ownerPartId are mutually interchangeable. - - - - - - - - - partVersion - - - en - Part Version - - - urn:samm:io.catenax.bom_as_specified:2.0.0#partVersion - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Part Version - - - - - en - partVersion - - - STRING - - - en - This is the version of the part. The engineering will at times supercede an older part version by a newer one, which might have different material aspects, physical dimensions etc., still maintaining compatibility. - - - - - - - - - measurementUnit - - - en - Measurement Unit - - - urn:samm:io.catenax.bom_as_specified:2.0.0#measurementUnit - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Measurement Unit - - - - - en - measurementUnit - - - STRING - - - en - Unit of measurement for the quantity of serialized objects. - - - - - - - - - quantityNumber - - - en - Quantity Number - - - urn:samm:io.catenax.bom_as_specified:2.0.0#quantityNumber - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Quantity Number - - - - - en - quantityNumber - - - REAL_MEASURE - - - en - The number of objects related to the measurement unit. - - - - - - - - - measurementUnit - - - en - Measurement Unit - - - urn:samm:io.catenax.bom_as_specified:2.0.0#measurementUnit - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Measurement Unit - - - - - en - measurementUnit - - - STRING - - - en - Unit of measurement for the quantity of serialized objects. - - - - - - - - - quantityNumber - - - en - Quantity Number - - - urn:samm:io.catenax.bom_as_specified:2.0.0#quantityNumber - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Quantity Number - - - - - en - quantityNumber - - - REAL_MEASURE - - - en - The number of objects related to the measurement unit. - - - - - - - - - partQuantity - - - en - Part Quantity - - - urn:samm:io.catenax.bom_as_specified:2.0.0#partQuantity - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Part Quantity - - - - - en - partQuantity - - - STRING - - - en - This is the quantity how often this part is in the item. - - - - - - - - - partDescription - - - en - Part Description - - - urn:samm:io.catenax.bom_as_specified:2.0.0#partDescription - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Part Description - - - - - en - partDescription - - - STRING - - - en - The description of the part in the primary language of the production facility of the product owner. - - - - - - - - - key - - - en - Key - - - urn:samm:io.catenax.bom_as_specified:2.0.0#key - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Key - - - - - en - key - - - STRING - - - en - Key within the classification. - - - - - - - - - value - - - en - Value - - - urn:samm:io.catenax.bom_as_specified:2.0.0#value - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Value - - - - - en - value - - - STRING - - - en - Value within the classification. - - - - - - - - - key - - - en - Key - - - urn:samm:io.catenax.bom_as_specified:2.0.0#key - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Key - - - - - en - key - - - STRING - - - en - Key within the classification. - - - - - - - - - value - - - en - Value - - - urn:samm:io.catenax.bom_as_specified:2.0.0#value - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Value - - - - - en - value - - - STRING - - - en - Value within the classification. - - - - - - - - - partClassification - - - en - Part Classification - - - urn:samm:io.catenax.bom_as_specified:2.0.0#partClassification - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Part Classification - - - - - en - partClassification - - - STRING - - - en - The part classification. - - - - - - - - - lastModifiedOn - - - en - Last Modified On - - - urn:samm:io.catenax.bom_as_specified:2.0.0#lastModifiedOn - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Last Modified On - - - - - en - lastModifiedOn - - - STRING - - - en - The time the item was modified the last time - - - - - - - - - createdOn - - - en - Created On - - - urn:samm:io.catenax.bom_as_specified:2.0.0#createdOn - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Created On - - - - - en - createdOn - - - STRING - - - en - The time the item was created on - - - - - - - - - ownerPartId - - - en - Owner Part ID - - - urn:samm:io.catenax.bom_as_specified:2.0.0#ownerPartId - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Owner Part ID - - - - - en - ownerPartId - - - STRING - - - en - This is the key field of the component which usually keeps the part numbers used in after-sales, e.g. when repairing broken parts and searching for a replacement. This ownerPartId itself isn't usually bound to one part version, with the assumption that all part versions with the same ownerPartId are mutually interchangeable. - - - - - - - - - partVersion - - - en - Part Version - - - urn:samm:io.catenax.bom_as_specified:2.0.0#partVersion - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Part Version - - - - - en - partVersion - - - STRING - - - en - This is the version of the part. The engineering will at times supercede an older part version by a newer one, which might have different material aspects, physical dimensions etc., still maintaining compatibility. - - - - - - - - - measurementUnit - - - en - Measurement Unit - - - urn:samm:io.catenax.bom_as_specified:2.0.0#measurementUnit - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Measurement Unit - - - - - en - measurementUnit - - - STRING - - - en - Unit of measurement for the quantity of serialized objects. - - - - - - - - - quantityNumber - - - en - Quantity Number - - - urn:samm:io.catenax.bom_as_specified:2.0.0#quantityNumber - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Quantity Number - - - - - en - quantityNumber - - - REAL_MEASURE - - - en - The number of objects related to the measurement unit. - - - - - - - - - measurementUnit - - - en - Measurement Unit - - - urn:samm:io.catenax.bom_as_specified:2.0.0#measurementUnit - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Measurement Unit - - - - - en - measurementUnit - - - STRING - - - en - Unit of measurement for the quantity of serialized objects. - - - - - - - - - quantityNumber - - - en - Quantity Number - - - urn:samm:io.catenax.bom_as_specified:2.0.0#quantityNumber - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Quantity Number - - - - - en - quantityNumber - - - REAL_MEASURE - - - en - The number of objects related to the measurement unit. - - - - - - - - - partQuantity - - - en - Part Quantity - - - urn:samm:io.catenax.bom_as_specified:2.0.0#partQuantity - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Part Quantity - - - - - en - partQuantity - - - STRING - - - en - This is the quantity how often this part is in the item. - - - - - - - - - partDescription - - - en - Part Description - - - urn:samm:io.catenax.bom_as_specified:2.0.0#partDescription - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Part Description - - - - - en - partDescription - - - STRING - - - en - The description of the part in the primary language of the production facility of the product owner. - - - - - - - - - key - - - en - Key - - - urn:samm:io.catenax.bom_as_specified:2.0.0#key - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Key - - - - - en - key - - - STRING - - - en - Key within the classification. - - - - - - - - - value - - - en - Value - - - urn:samm:io.catenax.bom_as_specified:2.0.0#value - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Value - - - - - en - value - - - STRING - - - en - Value within the classification. - - - - - - - - - key - - - en - Key - - - urn:samm:io.catenax.bom_as_specified:2.0.0#key - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Key - - - - - en - key - - - STRING - - - en - Key within the classification. - - - - - - - - - value - - - en - Value - - - urn:samm:io.catenax.bom_as_specified:2.0.0#value - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Value - - - - - en - value - - - STRING - - - en - Value within the classification. - - - - - - - - - partClassification - - - en - Part Classification - - - urn:samm:io.catenax.bom_as_specified:2.0.0#partClassification - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Part Classification - - - - - en - partClassification - - - STRING - - - en - The part classification. - - - - - - - - - lastModifiedOn - - - en - Last Modified On - - - urn:samm:io.catenax.bom_as_specified:2.0.0#lastModifiedOn - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Last Modified On - - - - - en - lastModifiedOn - - - STRING - - - en - The time the item was modified the last time - - - - - - - - - createdOn - - - en - Created On - - - urn:samm:io.catenax.bom_as_specified:2.0.0#createdOn - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Created On - - - - - en - createdOn - - - STRING - - - en - The time the item was created on - - - - - - - - - part - - - en - Part - - - urn:samm:io.catenax.bom_as_specified:2.0.0#part - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Part - - - - - en - part - - - STRING - - - en - The description of the part in the primary language of the production facility of the product owner. - - - - - - - - - childPartsCategory - - - en - Child Parts Category - - - urn:samm:io.catenax.bom_as_specified:2.0.0#childPartsCategory - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Child Parts Category - - - - - en - childPartsCategory - - - STRING - - - en - The BomAsSpecified defines the view of the OEM or producer of the whole product, e.g. the OEM of a vehicle. It is free of any supplier-related information and specifies the promised and guaranteed content of the whole product to the end customer. This ?top-down? view is in contrast to the ?bottom-up? view of the SingleLevelBoMAsPlanned, though several sub-aspects are shared. The BomAsSpecified is merely one aspect, which is attached to the twin of the whole product and itself does neither introduce further twins nor reference them. Instead it merely comprises all functional information required by dismantlers, workshops or requestors for used parts to search for and to make a match on the market place. - - - - - - - - - ownerPartId - - - en - Owner Part ID - - - urn:samm:io.catenax.bom_as_specified:2.0.0#ownerPartId - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Owner Part ID - - - - - en - ownerPartId - - - STRING - - - en - This is the key field of the component which usually keeps the part numbers used in after-sales, e.g. when repairing broken parts and searching for a replacement. This ownerPartId itself isn't usually bound to one part version, with the assumption that all part versions with the same ownerPartId are mutually interchangeable. - - - - - - - - - partVersion - - - en - Part Version - - - urn:samm:io.catenax.bom_as_specified:2.0.0#partVersion - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Part Version - - - - - en - partVersion - - - STRING - - - en - This is the version of the part. The engineering will at times supercede an older part version by a newer one, which might have different material aspects, physical dimensions etc., still maintaining compatibility. - - - - - - - - - measurementUnit - - - en - Measurement Unit - - - urn:samm:io.catenax.bom_as_specified:2.0.0#measurementUnit - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Measurement Unit - - - - - en - measurementUnit - - - STRING - - - en - Unit of measurement for the quantity of serialized objects. - - - - - - - - - quantityNumber - - - en - Quantity Number - - - urn:samm:io.catenax.bom_as_specified:2.0.0#quantityNumber - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Quantity Number - - - - - en - quantityNumber - - - REAL_MEASURE - - - en - The number of objects related to the measurement unit. - - - - - - - - - measurementUnit - - - en - Measurement Unit - - - urn:samm:io.catenax.bom_as_specified:2.0.0#measurementUnit - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Measurement Unit - - - - - en - measurementUnit - - - STRING - - - en - Unit of measurement for the quantity of serialized objects. - - - - - - - - - quantityNumber - - - en - Quantity Number - - - urn:samm:io.catenax.bom_as_specified:2.0.0#quantityNumber - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Quantity Number - - - - - en - quantityNumber - - - REAL_MEASURE - - - en - The number of objects related to the measurement unit. - - - - - - - - - partQuantity - - - en - Part Quantity - - - urn:samm:io.catenax.bom_as_specified:2.0.0#partQuantity - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Part Quantity - - - - - en - partQuantity - - - STRING - - - en - This is the quantity how often this part is in the item. - - - - - - - - - partDescription - - - en - Part Description - - - urn:samm:io.catenax.bom_as_specified:2.0.0#partDescription - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Part Description - - - - - en - partDescription - - - STRING - - - en - The description of the part in the primary language of the production facility of the product owner. - - - - - - - - - key - - - en - Key - - - urn:samm:io.catenax.bom_as_specified:2.0.0#key - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Key - - - - - en - key - - - STRING - - - en - Key within the classification. - - - - - - - - - value - - - en - Value - - - urn:samm:io.catenax.bom_as_specified:2.0.0#value - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Value - - - - - en - value - - - STRING - - - en - Value within the classification. - - - - - - - - - key - - - en - Key - - - urn:samm:io.catenax.bom_as_specified:2.0.0#key - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Key - - - - - en - key - - - STRING - - - en - Key within the classification. - - - - - - - - - value - - - en - Value - - - urn:samm:io.catenax.bom_as_specified:2.0.0#value - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Value - - - - - en - value - - - STRING - - - en - Value within the classification. - - - - - - - - - partClassification - - - en - Part Classification - - - urn:samm:io.catenax.bom_as_specified:2.0.0#partClassification - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Part Classification - - - - - en - partClassification - - - STRING - - - en - The part classification. - - - - - - - - - lastModifiedOn - - - en - Last Modified On - - - urn:samm:io.catenax.bom_as_specified:2.0.0#lastModifiedOn - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Last Modified On - - - - - en - lastModifiedOn - - - STRING - - - en - The time the item was modified the last time - - - - - - - - - createdOn - - - en - Created On - - - urn:samm:io.catenax.bom_as_specified:2.0.0#createdOn - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Created On - - - - - en - createdOn - - - STRING - - - en - The time the item was created on - - - - - - - - - ownerPartId - - - en - Owner Part ID - - - urn:samm:io.catenax.bom_as_specified:2.0.0#ownerPartId - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Owner Part ID - - - - - en - ownerPartId - - - STRING - - - en - This is the key field of the component which usually keeps the part numbers used in after-sales, e.g. when repairing broken parts and searching for a replacement. This ownerPartId itself isn't usually bound to one part version, with the assumption that all part versions with the same ownerPartId are mutually interchangeable. - - - - - - - - - partVersion - - - en - Part Version - - - urn:samm:io.catenax.bom_as_specified:2.0.0#partVersion - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Part Version - - - - - en - partVersion - - - STRING - - - en - This is the version of the part. The engineering will at times supercede an older part version by a newer one, which might have different material aspects, physical dimensions etc., still maintaining compatibility. - - - - - - - - - measurementUnit - - - en - Measurement Unit - - - urn:samm:io.catenax.bom_as_specified:2.0.0#measurementUnit - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Measurement Unit - - - - - en - measurementUnit - - - STRING - - - en - Unit of measurement for the quantity of serialized objects. - - - - - - - - - quantityNumber - - - en - Quantity Number - - - urn:samm:io.catenax.bom_as_specified:2.0.0#quantityNumber - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Quantity Number - - - - - en - quantityNumber - - - REAL_MEASURE - - - en - The number of objects related to the measurement unit. - - - - - - - - - measurementUnit - - - en - Measurement Unit - - - urn:samm:io.catenax.bom_as_specified:2.0.0#measurementUnit - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Measurement Unit - - - - - en - measurementUnit - - - STRING - - - en - Unit of measurement for the quantity of serialized objects. - - - - - - - - - quantityNumber - - - en - Quantity Number - - - urn:samm:io.catenax.bom_as_specified:2.0.0#quantityNumber - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Quantity Number - - - - - en - quantityNumber - - - REAL_MEASURE - - - en - The number of objects related to the measurement unit. - - - - - - - - - partQuantity - - - en - Part Quantity - - - urn:samm:io.catenax.bom_as_specified:2.0.0#partQuantity - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Part Quantity - - - - - en - partQuantity - - - STRING - - - en - This is the quantity how often this part is in the item. - - - - - - - - - partDescription - - - en - Part Description - - - urn:samm:io.catenax.bom_as_specified:2.0.0#partDescription - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Part Description - - - - - en - partDescription - - - STRING - - - en - The description of the part in the primary language of the production facility of the product owner. - - - - - - - - - key - - - en - Key - - - urn:samm:io.catenax.bom_as_specified:2.0.0#key - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Key - - - - - en - key - - - STRING - - - en - Key within the classification. - - - - - - - - - value - - - en - Value - - - urn:samm:io.catenax.bom_as_specified:2.0.0#value - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Value - - - - - en - value - - - STRING - - - en - Value within the classification. - - - - - - - - - key - - - en - Key - - - urn:samm:io.catenax.bom_as_specified:2.0.0#key - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Key - - - - - en - key - - - STRING - - - en - Key within the classification. - - - - - - - - - value - - - en - Value - - - urn:samm:io.catenax.bom_as_specified:2.0.0#value - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Value - - - - - en - value - - - STRING - - - en - Value within the classification. - - - - - - - - - partClassification - - - en - Part Classification - - - urn:samm:io.catenax.bom_as_specified:2.0.0#partClassification - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Part Classification - - - - - en - partClassification - - - STRING - - - en - The part classification. - - - - - - - - - lastModifiedOn - - - en - Last Modified On - - - urn:samm:io.catenax.bom_as_specified:2.0.0#lastModifiedOn - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Last Modified On - - - - - en - lastModifiedOn - - - STRING - - - en - The time the item was modified the last time - - - - - - - - - createdOn - - - en - Created On - - - urn:samm:io.catenax.bom_as_specified:2.0.0#createdOn - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Created On - - - - - en - createdOn - - - STRING - - - en - The time the item was created on - - - - - - - - - part - - - en - Part - - - urn:samm:io.catenax.bom_as_specified:2.0.0#part - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Part - - - - - en - part - - - STRING - - - en - The description of the part in the primary language of the production facility of the product owner. - - - - - - - - - childCatenaXId - - - en - Child CatenaXId - - - urn:samm:io.catenax.bom_as_specified:2.0.0#childCatenaXId - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Child CatenaXId - - - - - en - childCatenaXId - - - STRING - - - en - Describes the Catena-X ID of the child part - - - - - - - - - childParts - - - en - Child Parts - - - urn:samm:io.catenax.bom_as_specified:2.0.0#childParts - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Child Parts - - - - - en - childParts - - - STRING - - - en - The child part of the observed parent item - - - - - - - - - catenaXId - - - en - Catena-X ID - - - urn:samm:io.catenax.bom_as_specified:2.0.0#catenaXId - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Catena-X ID - - - - - en - catenaXId - - - STRING - - - en - A unique reference within Catena-X of this items - - - - - - - - - childPartsCategory - - - en - Child Parts Category - - - urn:samm:io.catenax.bom_as_specified:2.0.0#childPartsCategory - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Child Parts Category - - - - - en - childPartsCategory - - - STRING - - - en - The BomAsSpecified defines the view of the OEM or producer of the whole product, e.g. the OEM of a vehicle. It is free of any supplier-related information and specifies the promised and guaranteed content of the whole product to the end customer. This ?top-down? view is in contrast to the ?bottom-up? view of the SingleLevelBoMAsPlanned, though several sub-aspects are shared. The BomAsSpecified is merely one aspect, which is attached to the twin of the whole product and itself does neither introduce further twins nor reference them. Instead it merely comprises all functional information required by dismantlers, workshops or requestors for used parts to search for and to make a match on the market place. - - - - - - - - - ownerPartId - - - en - Owner Part ID - - - urn:samm:io.catenax.bom_as_specified:2.0.0#ownerPartId - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Owner Part ID - - - - - en - ownerPartId - - - STRING - - - en - This is the key field of the component which usually keeps the part numbers used in after-sales, e.g. when repairing broken parts and searching for a replacement. This ownerPartId itself isn't usually bound to one part version, with the assumption that all part versions with the same ownerPartId are mutually interchangeable. - - - - - - - - - partVersion - - - en - Part Version - - - urn:samm:io.catenax.bom_as_specified:2.0.0#partVersion - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Part Version - - - - - en - partVersion - - - STRING - - - en - This is the version of the part. The engineering will at times supercede an older part version by a newer one, which might have different material aspects, physical dimensions etc., still maintaining compatibility. - - - - - - - - - measurementUnit - - - en - Measurement Unit - - - urn:samm:io.catenax.bom_as_specified:2.0.0#measurementUnit - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Measurement Unit - - - - - en - measurementUnit - - - STRING - - - en - Unit of measurement for the quantity of serialized objects. - - - - - - - - - quantityNumber - - - en - Quantity Number - - - urn:samm:io.catenax.bom_as_specified:2.0.0#quantityNumber - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Quantity Number - - - - - en - quantityNumber - - - REAL_MEASURE - - - en - The number of objects related to the measurement unit. - - - - - - - - - measurementUnit - - - en - Measurement Unit - - - urn:samm:io.catenax.bom_as_specified:2.0.0#measurementUnit - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Measurement Unit - - - - - en - measurementUnit - - - STRING - - - en - Unit of measurement for the quantity of serialized objects. - - - - - - - - - quantityNumber - - - en - Quantity Number - - - urn:samm:io.catenax.bom_as_specified:2.0.0#quantityNumber - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Quantity Number - - - - - en - quantityNumber - - - REAL_MEASURE - - - en - The number of objects related to the measurement unit. - - - - - - - - - partQuantity - - - en - Part Quantity - - - urn:samm:io.catenax.bom_as_specified:2.0.0#partQuantity - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Part Quantity - - - - - en - partQuantity - - - STRING - - - en - This is the quantity how often this part is in the item. - - - - - - - - - partDescription - - - en - Part Description - - - urn:samm:io.catenax.bom_as_specified:2.0.0#partDescription - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Part Description - - - - - en - partDescription - - - STRING - - - en - The description of the part in the primary language of the production facility of the product owner. - - - - - - - - - key - - - en - Key - - - urn:samm:io.catenax.bom_as_specified:2.0.0#key - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Key - - - - - en - key - - - STRING - - - en - Key within the classification. - - - - - - - - - value - - - en - Value - - - urn:samm:io.catenax.bom_as_specified:2.0.0#value - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Value - - - - - en - value - - - STRING - - - en - Value within the classification. - - - - - - - - - key - - - en - Key - - - urn:samm:io.catenax.bom_as_specified:2.0.0#key - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Key - - - - - en - key - - - STRING - - - en - Key within the classification. - - - - - - - - - value - - - en - Value - - - urn:samm:io.catenax.bom_as_specified:2.0.0#value - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Value - - - - - en - value - - - STRING - - - en - Value within the classification. - - - - - - - - - partClassification - - - en - Part Classification - - - urn:samm:io.catenax.bom_as_specified:2.0.0#partClassification - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Part Classification - - - - - en - partClassification - - - STRING - - - en - The part classification. - - - - - - - - - lastModifiedOn - - - en - Last Modified On - - - urn:samm:io.catenax.bom_as_specified:2.0.0#lastModifiedOn - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Last Modified On - - - - - en - lastModifiedOn - - - STRING - - - en - The time the item was modified the last time - - - - - - - - - createdOn - - - en - Created On - - - urn:samm:io.catenax.bom_as_specified:2.0.0#createdOn - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Created On - - - - - en - createdOn - - - STRING - - - en - The time the item was created on - - - - - - - - - ownerPartId - - - en - Owner Part ID - - - urn:samm:io.catenax.bom_as_specified:2.0.0#ownerPartId - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Owner Part ID - - - - - en - ownerPartId - - - STRING - - - en - This is the key field of the component which usually keeps the part numbers used in after-sales, e.g. when repairing broken parts and searching for a replacement. This ownerPartId itself isn't usually bound to one part version, with the assumption that all part versions with the same ownerPartId are mutually interchangeable. - - - - - - - - - partVersion - - - en - Part Version - - - urn:samm:io.catenax.bom_as_specified:2.0.0#partVersion - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Part Version - - - - - en - partVersion - - - STRING - - - en - This is the version of the part. The engineering will at times supercede an older part version by a newer one, which might have different material aspects, physical dimensions etc., still maintaining compatibility. - - - - - - - - - measurementUnit - - - en - Measurement Unit - - - urn:samm:io.catenax.bom_as_specified:2.0.0#measurementUnit - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Measurement Unit - - - - - en - measurementUnit - - - STRING - - - en - Unit of measurement for the quantity of serialized objects. - - - - - - - - - quantityNumber - - - en - Quantity Number - - - urn:samm:io.catenax.bom_as_specified:2.0.0#quantityNumber - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Quantity Number - - - - - en - quantityNumber - - - REAL_MEASURE - - - en - The number of objects related to the measurement unit. - - - - - - - - - measurementUnit - - - en - Measurement Unit - - - urn:samm:io.catenax.bom_as_specified:2.0.0#measurementUnit - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Measurement Unit - - - - - en - measurementUnit - - - STRING - - - en - Unit of measurement for the quantity of serialized objects. - - - - - - - - - quantityNumber - - - en - Quantity Number - - - urn:samm:io.catenax.bom_as_specified:2.0.0#quantityNumber - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Quantity Number - - - - - en - quantityNumber - - - REAL_MEASURE - - - en - The number of objects related to the measurement unit. - - - - - - - - - partQuantity - - - en - Part Quantity - - - urn:samm:io.catenax.bom_as_specified:2.0.0#partQuantity - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Part Quantity - - - - - en - partQuantity - - - STRING - - - en - This is the quantity how often this part is in the item. - - - - - - - - - partDescription - - - en - Part Description - - - urn:samm:io.catenax.bom_as_specified:2.0.0#partDescription - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Part Description - - - - - en - partDescription - - - STRING - - - en - The description of the part in the primary language of the production facility of the product owner. - - - - - - - - - key - - - en - Key - - - urn:samm:io.catenax.bom_as_specified:2.0.0#key - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Key - - - - - en - key - - - STRING - - - en - Key within the classification. - - - - - - - - - value - - - en - Value - - - urn:samm:io.catenax.bom_as_specified:2.0.0#value - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Value - - - - - en - value - - - STRING - - - en - Value within the classification. - - - - - - - - - key - - - en - Key - - - urn:samm:io.catenax.bom_as_specified:2.0.0#key - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Key - - - - - en - key - - - STRING - - - en - Key within the classification. - - - - - - - - - value - - - en - Value - - - urn:samm:io.catenax.bom_as_specified:2.0.0#value - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Value - - - - - en - value - - - STRING - - - en - Value within the classification. - - - - - - - - - partClassification - - - en - Part Classification - - - urn:samm:io.catenax.bom_as_specified:2.0.0#partClassification - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Part Classification - - - - - en - partClassification - - - STRING - - - en - The part classification. - - - - - - - - - lastModifiedOn - - - en - Last Modified On - - - urn:samm:io.catenax.bom_as_specified:2.0.0#lastModifiedOn - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Last Modified On - - - - - en - lastModifiedOn - - - STRING - - - en - The time the item was modified the last time - - - - - - - - - createdOn - - - en - Created On - - - urn:samm:io.catenax.bom_as_specified:2.0.0#createdOn - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Created On - - - - - en - createdOn - - - STRING - - - en - The time the item was created on - - - - - - - - - part - - - en - Part - - - urn:samm:io.catenax.bom_as_specified:2.0.0#part - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Part - - - - - en - part - - - STRING - - - en - The description of the part in the primary language of the production facility of the product owner. - - - - - - - - - childPartsCategory - - - en - Child Parts Category - - - urn:samm:io.catenax.bom_as_specified:2.0.0#childPartsCategory - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Child Parts Category - - - - - en - childPartsCategory - - - STRING - - - en - The BomAsSpecified defines the view of the OEM or producer of the whole product, e.g. the OEM of a vehicle. It is free of any supplier-related information and specifies the promised and guaranteed content of the whole product to the end customer. This ?top-down? view is in contrast to the ?bottom-up? view of the SingleLevelBoMAsPlanned, though several sub-aspects are shared. The BomAsSpecified is merely one aspect, which is attached to the twin of the whole product and itself does neither introduce further twins nor reference them. Instead it merely comprises all functional information required by dismantlers, workshops or requestors for used parts to search for and to make a match on the market place. - - - - - - - - - ownerPartId - - - en - Owner Part ID - - - urn:samm:io.catenax.bom_as_specified:2.0.0#ownerPartId - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Owner Part ID - - - - - en - ownerPartId - - - STRING - - - en - This is the key field of the component which usually keeps the part numbers used in after-sales, e.g. when repairing broken parts and searching for a replacement. This ownerPartId itself isn't usually bound to one part version, with the assumption that all part versions with the same ownerPartId are mutually interchangeable. - - - - - - - - - partVersion - - - en - Part Version - - - urn:samm:io.catenax.bom_as_specified:2.0.0#partVersion - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Part Version - - - - - en - partVersion - - - STRING - - - en - This is the version of the part. The engineering will at times supercede an older part version by a newer one, which might have different material aspects, physical dimensions etc., still maintaining compatibility. - - - - - - - - - measurementUnit - - - en - Measurement Unit - - - urn:samm:io.catenax.bom_as_specified:2.0.0#measurementUnit - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Measurement Unit - - - - - en - measurementUnit - - - STRING - - - en - Unit of measurement for the quantity of serialized objects. - - - - - - - - - quantityNumber - - - en - Quantity Number - - - urn:samm:io.catenax.bom_as_specified:2.0.0#quantityNumber - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Quantity Number - - - - - en - quantityNumber - - - REAL_MEASURE - - - en - The number of objects related to the measurement unit. - - - - - - - - - measurementUnit - - - en - Measurement Unit - - - urn:samm:io.catenax.bom_as_specified:2.0.0#measurementUnit - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Measurement Unit - - - - - en - measurementUnit - - - STRING - - - en - Unit of measurement for the quantity of serialized objects. - - - - - - - - - quantityNumber - - - en - Quantity Number - - - urn:samm:io.catenax.bom_as_specified:2.0.0#quantityNumber - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Quantity Number - - - - - en - quantityNumber - - - REAL_MEASURE - - - en - The number of objects related to the measurement unit. - - - - - - - - - partQuantity - - - en - Part Quantity - - - urn:samm:io.catenax.bom_as_specified:2.0.0#partQuantity - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Part Quantity - - - - - en - partQuantity - - - STRING - - - en - This is the quantity how often this part is in the item. - - - - - - - - - partDescription - - - en - Part Description - - - urn:samm:io.catenax.bom_as_specified:2.0.0#partDescription - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Part Description - - - - - en - partDescription - - - STRING - - - en - The description of the part in the primary language of the production facility of the product owner. - - - - - - - - - key - - - en - Key - - - urn:samm:io.catenax.bom_as_specified:2.0.0#key - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Key - - - - - en - key - - - STRING - - - en - Key within the classification. - - - - - - - - - value - - - en - Value - - - urn:samm:io.catenax.bom_as_specified:2.0.0#value - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Value - - - - - en - value - - - STRING - - - en - Value within the classification. - - - - - - - - - key - - - en - Key - - - urn:samm:io.catenax.bom_as_specified:2.0.0#key - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Key - - - - - en - key - - - STRING - - - en - Key within the classification. - - - - - - - - - value - - - en - Value - - - urn:samm:io.catenax.bom_as_specified:2.0.0#value - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Value - - - - - en - value - - - STRING - - - en - Value within the classification. - - - - - - - - - partClassification - - - en - Part Classification - - - urn:samm:io.catenax.bom_as_specified:2.0.0#partClassification - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Part Classification - - - - - en - partClassification - - - STRING - - - en - The part classification. - - - - - - - - - lastModifiedOn - - - en - Last Modified On - - - urn:samm:io.catenax.bom_as_specified:2.0.0#lastModifiedOn - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Last Modified On - - - - - en - lastModifiedOn - - - STRING - - - en - The time the item was modified the last time - - - - - - - - - createdOn - - - en - Created On - - - urn:samm:io.catenax.bom_as_specified:2.0.0#createdOn - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Created On - - - - - en - createdOn - - - STRING - - - en - The time the item was created on - - - - - - - - - ownerPartId - - - en - Owner Part ID - - - urn:samm:io.catenax.bom_as_specified:2.0.0#ownerPartId - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Owner Part ID - - - - - en - ownerPartId - - - STRING - - - en - This is the key field of the component which usually keeps the part numbers used in after-sales, e.g. when repairing broken parts and searching for a replacement. This ownerPartId itself isn't usually bound to one part version, with the assumption that all part versions with the same ownerPartId are mutually interchangeable. - - - - - - - - - partVersion - - - en - Part Version - - - urn:samm:io.catenax.bom_as_specified:2.0.0#partVersion - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Part Version - - - - - en - partVersion - - - STRING - - - en - This is the version of the part. The engineering will at times supercede an older part version by a newer one, which might have different material aspects, physical dimensions etc., still maintaining compatibility. - - - - - - - - - measurementUnit - - - en - Measurement Unit - - - urn:samm:io.catenax.bom_as_specified:2.0.0#measurementUnit - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Measurement Unit - - - - - en - measurementUnit - - - STRING - - - en - Unit of measurement for the quantity of serialized objects. - - - - - - - - - quantityNumber - - - en - Quantity Number - - - urn:samm:io.catenax.bom_as_specified:2.0.0#quantityNumber - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Quantity Number - - - - - en - quantityNumber - - - REAL_MEASURE - - - en - The number of objects related to the measurement unit. - - - - - - - - - measurementUnit - - - en - Measurement Unit - - - urn:samm:io.catenax.bom_as_specified:2.0.0#measurementUnit - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Measurement Unit - - - - - en - measurementUnit - - - STRING - - - en - Unit of measurement for the quantity of serialized objects. - - - - - - - - - quantityNumber - - - en - Quantity Number - - - urn:samm:io.catenax.bom_as_specified:2.0.0#quantityNumber - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Quantity Number - - - - - en - quantityNumber - - - REAL_MEASURE - - - en - The number of objects related to the measurement unit. - - - - - - - - - partQuantity - - - en - Part Quantity - - - urn:samm:io.catenax.bom_as_specified:2.0.0#partQuantity - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Part Quantity - - - - - en - partQuantity - - - STRING - - - en - This is the quantity how often this part is in the item. - - - - - - - - - partDescription - - - en - Part Description - - - urn:samm:io.catenax.bom_as_specified:2.0.0#partDescription - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Part Description - - - - - en - partDescription - - - STRING - - - en - The description of the part in the primary language of the production facility of the product owner. - - - - - - - - - key - - - en - Key - - - urn:samm:io.catenax.bom_as_specified:2.0.0#key - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Key - - - - - en - key - - - STRING - - - en - Key within the classification. - - - - - - - - - value - - - en - Value - - - urn:samm:io.catenax.bom_as_specified:2.0.0#value - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Value - - - - - en - value - - - STRING - - - en - Value within the classification. - - - - - - - - - key - - - en - Key - - - urn:samm:io.catenax.bom_as_specified:2.0.0#key - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Key - - - - - en - key - - - STRING - - - en - Key within the classification. - - - - - - - - - value - - - en - Value - - - urn:samm:io.catenax.bom_as_specified:2.0.0#value - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Value - - - - - en - value - - - STRING - - - en - Value within the classification. - - - - - - - - - partClassification - - - en - Part Classification - - - urn:samm:io.catenax.bom_as_specified:2.0.0#partClassification - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Part Classification - - - - - en - partClassification - - - STRING - - - en - The part classification. - - - - - - - - - lastModifiedOn - - - en - Last Modified On - - - urn:samm:io.catenax.bom_as_specified:2.0.0#lastModifiedOn - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Last Modified On - - - - - en - lastModifiedOn - - - STRING - - - en - The time the item was modified the last time - - - - - - - - - createdOn - - - en - Created On - - - urn:samm:io.catenax.bom_as_specified:2.0.0#createdOn - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Created On - - - - - en - createdOn - - - STRING - - - en - The time the item was created on - - - - - - - - - part - - - en - Part - - - urn:samm:io.catenax.bom_as_specified:2.0.0#part - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Part - - - - - en - part - - - STRING - - - en - The description of the part in the primary language of the production facility of the product owner. - - - - - - - - - childCatenaXId - - - en - Child CatenaXId - - - urn:samm:io.catenax.bom_as_specified:2.0.0#childCatenaXId - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Child CatenaXId - - - - - en - childCatenaXId - - - STRING - - - en - Describes the Catena-X ID of the child part - - - - - - - - - childParts - - - en - Child Parts - - - urn:samm:io.catenax.bom_as_specified:2.0.0#childParts - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Child Parts - - - - - en - childParts - - - STRING - - - en - The child part of the observed parent item - - - - - - - - - diff --git a/io.catenax.bom_as_specified/2.0.0/gen/SingleLevelBomAsSpecified-schema.json b/io.catenax.bom_as_specified/2.0.0/gen/SingleLevelBomAsSpecified-schema.json deleted file mode 100644 index 64485b662..000000000 --- a/io.catenax.bom_as_specified/2.0.0/gen/SingleLevelBomAsSpecified-schema.json +++ /dev/null @@ -1,151 +0,0 @@ -{ - "$schema" : "http://json-schema.org/draft-04/schema", - "description" : "The SingleLevelBomAsSpecified defines the view of the OEM or producer of the whole product, e.g. the OEM of a vehicle. It is free of any supplier-related information and specifies the promised and guaranteed content of the whole product to the end customer. This “top-down” view is in contrast to the “bottom-up” view of the SingleLevelBoMAsPlanned, though several sub-aspects are shared. The BomAsSpecified is merely one aspect, which is attached to the twin of the whole product and itself does neither introduce further twins nor reference them. Instead it merely comprises all functional information required by dismantlers, workshops or requestors for used parts to search for and to make a match on the market place.", - "type" : "object", - "components" : { - "schemas" : { - "urn_bamm_io.catenax.bom_as_specified_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).", - "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_bamm_io.openmanufacturing_characteristic_2.0.0_Text" : { - "type" : "string", - "description" : "Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc." - }, - "urn_bamm_io.openmanufacturing_characteristic_2.0.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_bamm_io.catenax.bom_as_specified_2.0.0_NumberOfObjects" : { - "type" : "number", - "description" : "Quantifiable number of objects in reference to the measurementUnit." - }, - "urn_bamm_io.catenax.bom_as_specified_2.0.0_PartQuantityCharacteristic" : { - "description" : "The characteristic of the part quantity.", - "type" : "object", - "properties" : { - "measurementUnit" : { - "description" : "Unit of measurement for the quantity of serialized objects.", - "$ref" : "#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_UnitReference" - }, - "quantityNumber" : { - "description" : "The number of objects related to the measurement unit.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.bom_as_specified_2.0.0_NumberOfObjects" - } - }, - "required" : [ "measurementUnit", "quantityNumber", "measurementUnit", "quantityNumber" ] - }, - "urn_bamm_io.catenax.bom_as_specified_2.0.0_PartClassificationEntity" : { - "description" : "The entity encapsulating the properties of the part classification.", - "type" : "object", - "properties" : { - "key" : { - "description" : "Key within the classification.", - "$ref" : "#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text" - }, - "value" : { - "description" : "Value within the classification.", - "$ref" : "#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text" - } - }, - "required" : [ "key", "value", "key", "value" ] - }, - "urn_bamm_io.catenax.bom_as_specified_2.0.0_PartClassificationCharacteristic" : { - "description" : "The characteristic of the part classification.", - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/urn_bamm_io.catenax.bom_as_specified_2.0.0_PartClassificationEntity" - }, - "uniqueItems" : true - }, - "urn_bamm_io.openmanufacturing_characteristic_2.0.0_Timestamp" : { - "type" : "string", - "pattern" : "-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T(([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](\\.[0-9]+)?|(24:00:00(\\.0+)?))(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?", - "description" : "Describes a Property which contains the date and time with an optional timezone." - }, - "urn_bamm_io.catenax.bom_as_specified_2.0.0_PartEntity" : { - "description" : "Entity encapsulating the properies describing a part", - "type" : "object", - "properties" : { - "ownerPartId" : { - "description" : "This is the key field of the component which usually keeps the part numbers used in after-sales, e.g. when repairing broken parts and searching for a replacement. This ownerPartId itself isn't usually bound to one part version, with the assumption that all part versions with the same ownerPartId are mutually interchangeable.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.bom_as_specified_2.0.0_CatenaXIdTrait" - }, - "partVersion" : { - "description" : "This is the version of the part. The engineering will at times supercede an older part version by a newer one, which might have different material aspects, physical dimensions etc., still maintaining compatibility.", - "$ref" : "#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text" - }, - "partQuantity" : { - "description" : "This is the quantity how often this part is in the item.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.bom_as_specified_2.0.0_PartQuantityCharacteristic" - }, - "partDescription" : { - "description" : "The description of the part in the primary language of the production facility of the product owner.", - "$ref" : "#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text" - }, - "partClassification" : { - "description" : "The part classification.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.bom_as_specified_2.0.0_PartClassificationCharacteristic" - }, - "lastModifiedOn" : { - "description" : "The time the item was modified the last time", - "$ref" : "#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Timestamp" - }, - "createdOn" : { - "description" : "The time the item was created on", - "$ref" : "#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Timestamp" - } - }, - "required" : [ "ownerPartId", "ownerPartId" ] - }, - "urn_bamm_io.catenax.bom_as_specified_2.0.0_PartCharacteristic" : { - "description" : "Characteristic of the part.", - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/urn_bamm_io.catenax.bom_as_specified_2.0.0_PartEntity" - }, - "uniqueItems" : true - }, - "urn_bamm_io.catenax.bom_as_specified_2.0.0_ChildPartsEntity" : { - "description" : "Encapsulates the properties describing the child part item", - "type" : "object", - "properties" : { - "childPartsCategory" : { - "description" : "The BomAsSpecified defines the view of the OEM or producer of the whole product, e.g. the OEM of a vehicle. It is free of any supplier-related information and specifies the promised and guaranteed content of the whole product to the end customer. This “top-down” view is in contrast to the “bottom-up” view of the SingleLevelBoMAsPlanned, though several sub-aspects are shared. The BomAsSpecified is merely one aspect, which is attached to the twin of the whole product and itself does neither introduce further twins nor reference them. Instead it merely comprises all functional information required by dismantlers, workshops or requestors for used parts to search for and to make a match on the market place.", - "$ref" : "#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text" - }, - "part" : { - "description" : "The description of the part in the primary language of the production facility of the product owner.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.bom_as_specified_2.0.0_PartCharacteristic" - }, - "childCatenaXId" : { - "description" : "Describes the Catena-X ID of the child part", - "$ref" : "#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text" - } - }, - "required" : [ "childPartsCategory", "part", "childPartsCategory", "part", "childCatenaXId" ] - }, - "urn_bamm_io.catenax.bom_as_specified_2.0.0_ChildPartsCharacteristic" : { - "description" : "The characteristic of the child part property", - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/urn_bamm_io.catenax.bom_as_specified_2.0.0_ChildPartsEntity" - }, - "uniqueItems" : true - } - } - }, - "properties" : { - "catenaXId" : { - "description" : "A unique reference within Catena-X of this items", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.bom_as_specified_2.0.0_CatenaXIdTrait" - }, - "childParts" : { - "description" : "The child part of the observed parent item", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.bom_as_specified_2.0.0_ChildPartsCharacteristic" - } - }, - "required" : [ "catenaXId", "childParts", "catenaXId", "childParts" ] -} \ No newline at end of file diff --git a/io.catenax.bom_as_specified/2.0.0/gen/SingleLevelBomAsSpecified.aasx b/io.catenax.bom_as_specified/2.0.0/gen/SingleLevelBomAsSpecified.aasx deleted file mode 100644 index 2acc4cd69..000000000 Binary files a/io.catenax.bom_as_specified/2.0.0/gen/SingleLevelBomAsSpecified.aasx and /dev/null differ diff --git a/io.catenax.bom_as_specified/2.0.0/gen/SingleLevelBomAsSpecified.html b/io.catenax.bom_as_specified/2.0.0/gen/SingleLevelBomAsSpecified.html deleted file mode 100644 index dd7d58d43..000000000 --- a/io.catenax.bom_as_specified/2.0.0/gen/SingleLevelBomAsSpecified.html +++ /dev/null @@ -1,2181 +0,0 @@ - - - - - - - - - - - - - - Dokumentation Single Level BOM as Specified - - -
-
-
-
-

Aspect Model Single Level BOM as Specified

-
urn:bamm:io.catenax.bom_as_specified:2.0.0#SingleLevelBomAsSpecified
-
-
-
-
-
-
-
- -
- - -
- The SingleLevelBomAsSpecified defines the view of the OEM or producer of the whole product, e.g. the OEM of a vehicle. It is free of any supplier-related information and specifies the promised and guaranteed content of the whole product to the end customer. This “top-down” view is in contrast to the “bottom-up” view of the SingleLevelBoMAsPlanned, though several sub-aspects are shared. The BomAsSpecified is merely one aspect, which is attached to the twin of the whole product and itself does neither introduce further twins nor reference them. Instead it merely comprises all functional information required by dismantlers, workshops or requestors for used parts to search for and to make a match on the market place. -
- - -
-

Übersicht

-
-
-
-
- Aspect Model Diagram -
-
-
- - -
-
-

Properties

-
- -
- -
-

Catena-X ID

-
- -A unique reference within Catena-X of this items - -
-
Name
-
catenaXId
-
- - - -
-
Characteristic
-
-
-
-
Trait
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Beispiel
-
urn:uuid:055c1128-0375-47c8-98de-7cf802c3241d
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
catenaXId
-
- - -
-
Bedingungen
-
-
    -
  • -
    - -
    - Catena-X ID Regular Expression -
    - -
    -
    Beschreibung
    -
    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).
    -
    - - -
    -
    Regulärer Ausdruck
    -
    (^[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}$)
    -
    - -
    • -
-
-
-
-
- -
-

Catena-X ID

-
- -A unique reference within Catena-X of this items - -
-
Name
-
catenaXId
-
- - - -
-
Characteristic
-
-
-
-
Trait
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Beispiel
-
urn:uuid:055c1128-0375-47c8-98de-7cf802c3241d
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
catenaXId
-
- - -
-
Bedingungen
-
-
    -
  • -
    - -
    - Catena-X ID Regular Expression -
    - -
    -
    Beschreibung
    -
    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).
    -
    - - -
    -
    Regulärer Ausdruck
    -
    (^[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}$)
    -
    - -
    • -
-
-
-
-
- -
-

Child Parts

-
- -The child part of the observed parent item - -
-
Name
-
childParts
-
- - - -
-
Characteristic
-
-
-
-
Set
-
-
-
Has no order
-
-
-
Duplicates not allowed
-
-
-
- Typ urn:bamm:io.catenax.bom_as_specified:2.0.0#ChildPartsEntity - -
-
-
-
-
- - -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
childParts
-
- - -
-
- -
-

Child Parts

-
- -The child part of the observed parent item - -
-
Name
-
childParts
-
- - - -
-
Characteristic
-
-
-
-
Set
-
-
-
Has no order
-
-
-
Duplicates not allowed
-
-
-
- Typ urn:bamm:io.catenax.bom_as_specified:2.0.0#ChildPartsEntity - -
-
-
-
-
- - -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
childParts
-
- - -
-
- - - -
-
-

Objekt

-
- -
-
-

Child Parts Entity

-
-
- Encapsulates the properties describing the child part item -
- -
-

Properties

-
-
- -
-
Child Parts Category
-
- -The BomAsSpecified defines the view of the OEM or producer of the whole product, e.g. the OEM of a vehicle. It is free of any supplier-related information and specifies the promised and guaranteed content of the whole product to the end customer. This “top-down” view is in contrast to the “bottom-up” view of the SingleLevelBoMAsPlanned, though several sub-aspects are shared. The BomAsSpecified is merely one aspect, which is attached to the twin of the whole product and itself does neither introduce further twins nor reference them. Instead it merely comprises all functional information required by dismantlers, workshops or requestors for used parts to search for and to make a match on the market place. - -
-
Name
-
childPartsCategory
-
- - - -
-
Characteristic
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Beispiel
-
e.g. vehicle, winter wheels, bicycle rack
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
childPartsCategory
-
- - -
-
- -
-
Part
-
- -The description of the part in the primary language of the production facility of the product owner. - -
-
Name
-
part
-
- - - -
-
Characteristic
-
-
-
-
Set
-
-
-
Has no order
-
-
-
Duplicates not allowed
-
-
-
- Typ urn:bamm:io.catenax.bom_as_specified:2.0.0#PartEntity - -
-
-
-
-
- - -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
part
-
- - -
-
- -
-
Child Parts Category
-
- -The BomAsSpecified defines the view of the OEM or producer of the whole product, e.g. the OEM of a vehicle. It is free of any supplier-related information and specifies the promised and guaranteed content of the whole product to the end customer. This “top-down” view is in contrast to the “bottom-up” view of the SingleLevelBoMAsPlanned, though several sub-aspects are shared. The BomAsSpecified is merely one aspect, which is attached to the twin of the whole product and itself does neither introduce further twins nor reference them. Instead it merely comprises all functional information required by dismantlers, workshops or requestors for used parts to search for and to make a match on the market place. - -
-
Name
-
childPartsCategory
-
- - - -
-
Characteristic
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Beispiel
-
e.g. vehicle, winter wheels, bicycle rack
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
childPartsCategory
-
- - -
-
- -
-
Part
-
- -The description of the part in the primary language of the production facility of the product owner. - -
-
Name
-
part
-
- - - -
-
Characteristic
-
-
-
-
Set
-
-
-
Has no order
-
-
-
Duplicates not allowed
-
-
-
- Typ urn:bamm:io.catenax.bom_as_specified:2.0.0#PartEntity - -
-
-
-
-
- - -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
part
-
- - -
-
- -
-
Child CatenaXId
-
- -Describes the Catena-X ID of the child part - -
-
Name
-
childCatenaXId
-
- - - -
-
Characteristic
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Beispiel
-
urn:uuid:218b26f4-4a0b-4a7f-b2c1-d248927718bf
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
childCatenaXId
-
- - -
-
-
-
-

Part Classification Entity

-
-
- The entity encapsulating the properties of the part classification. -
- -
-

Properties

-
-
- -
-
Key
-
- -Key within the classification. - -
-
Name
-
key
-
- - - -
-
Characteristic
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Beispiel
-
BMW:PartFamily
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
key
-
- - -
-
- -
-
Value
-
- -Value within the classification. - -
-
Name
-
value
-
- - - -
-
Characteristic
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Beispiel
-
STEEWHL
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
value
-
- - -
-
- -
-
Key
-
- -Key within the classification. - -
-
Name
-
key
-
- - - -
-
Characteristic
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Beispiel
-
BMW:PartFamily
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
key
-
- - -
-
- -
-
Value
-
- -Value within the classification. - -
-
Name
-
value
-
- - - -
-
Characteristic
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Beispiel
-
STEEWHL
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
value
-
- - -
-
-
-
-

Part Entity

-
-
- Entity encapsulating the properies describing a part -
- -
-

Properties

-
-
- -
-
Owner Part ID
-
- -This is the key field of the component which usually keeps the part numbers used in after-sales, e.g. when repairing broken parts and searching for a replacement. This ownerPartId itself isn't usually bound to one part version, with the assumption that all part versions with the same ownerPartId are mutually interchangeable. - -
-
Name
-
ownerPartId
-
- - - -
-
Characteristic
-
-
-
-
Trait
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Beispiel
-
uuid!
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
ownerPartId
-
- - -
-
Bedingungen
-
-
    -
  • -
    - -
    - Catena-X ID Regular Expression -
    - -
    -
    Beschreibung
    -
    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).
    -
    - - -
    -
    Regulärer Ausdruck
    -
    (^[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}$)
    -
    - -
    • -
-
-
-
-
- -
-
Part Version
-
- -This is the version of the part. The engineering will at times supercede an older part version by a newer one, which might have different material aspects, physical dimensions etc., still maintaining compatibility. - -
-
Name
-
partVersion
-
- - - -
-
Characteristic
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Beispiel
-
05
-
- -
-
Optional
-
- Ja
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
partVersion
-
- - -
-
- -
-
Part Quantity
-
- -This is the quantity how often this part is in the item. - -
-
Name
-
partQuantity
-
- - - -
-
Characteristic
-
-
-
-
SingleEntity
-
-
-
- Typ urn:bamm:io.catenax.bom_as_specified:2.0.0#PartQuantityEntity - -
-
-
-
-
- - -
-
Optional
-
- Ja
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
partQuantity
-
- - -
-
- -
-
Part Description
-
- -The description of the part in the primary language of the production facility of the product owner. - -
-
Name
-
partDescription
-
- - - -
-
Characteristic
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Beispiel
-
The steering wheel is nice and round
-
- -
-
Optional
-
- Ja
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
partDescription
-
- - -
-
- -
-
Part Classification
-
- -The part classification. - -
-
Name
-
partClassification
-
- - - -
-
Characteristic
-
-
-
-
Set
-
-
-
Has no order
-
-
-
Duplicates not allowed
-
-
-
- Typ urn:bamm:io.catenax.bom_as_specified:2.0.0#PartClassificationEntity - -
-
-
-
-
- - -
-
Optional
-
- Ja
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
partClassification
-
- - -
-
- -
-
Last Modified On
-
- -The time the item was modified the last time - -
-
Name
-
lastModifiedOn
-
- - - -
-
Characteristic
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#dateTime - -
-
-
-
-
- -
-
Beispiel
-
2022-02-03T14:48:54.709Z
-
- -
-
Optional
-
- Ja
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
lastModifiedOn
-
- - -
-
- -
-
Created On
-
- -The time the item was created on - -
-
Name
-
createdOn
-
- - - -
-
Characteristic
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#dateTime - -
-
-
-
-
- -
-
Beispiel
-
2022-02-03T14:48:54.709Z
-
- -
-
Optional
-
- Ja
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
createdOn
-
- - -
-
- -
-
Owner Part ID
-
- -This is the key field of the component which usually keeps the part numbers used in after-sales, e.g. when repairing broken parts and searching for a replacement. This ownerPartId itself isn't usually bound to one part version, with the assumption that all part versions with the same ownerPartId are mutually interchangeable. - -
-
Name
-
ownerPartId
-
- - - -
-
Characteristic
-
-
-
-
Trait
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Beispiel
-
uuid!
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
ownerPartId
-
- - -
-
Bedingungen
-
-
    -
  • -
    - -
    - Catena-X ID Regular Expression -
    - -
    -
    Beschreibung
    -
    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).
    -
    - - -
    -
    Regulärer Ausdruck
    -
    (^[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}$)
    -
    - -
    • -
-
-
-
-
- -
-
Part Version
-
- -This is the version of the part. The engineering will at times supercede an older part version by a newer one, which might have different material aspects, physical dimensions etc., still maintaining compatibility. - -
-
Name
-
partVersion
-
- - - -
-
Characteristic
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Beispiel
-
05
-
- -
-
Optional
-
- Ja
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
partVersion
-
- - -
-
- -
-
Part Quantity
-
- -This is the quantity how often this part is in the item. - -
-
Name
-
partQuantity
-
- - - -
-
Characteristic
-
-
-
-
SingleEntity
-
-
-
- Typ urn:bamm:io.catenax.bom_as_specified:2.0.0#PartQuantityEntity - -
-
-
-
-
- - -
-
Optional
-
- Ja
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
partQuantity
-
- - -
-
- -
-
Part Description
-
- -The description of the part in the primary language of the production facility of the product owner. - -
-
Name
-
partDescription
-
- - - -
-
Characteristic
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Beispiel
-
The steering wheel is nice and round
-
- -
-
Optional
-
- Ja
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
partDescription
-
- - -
-
- -
-
Part Classification
-
- -The part classification. - -
-
Name
-
partClassification
-
- - - -
-
Characteristic
-
-
-
-
Set
-
-
-
Has no order
-
-
-
Duplicates not allowed
-
-
-
- Typ urn:bamm:io.catenax.bom_as_specified:2.0.0#PartClassificationEntity - -
-
-
-
-
- - -
-
Optional
-
- Ja
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
partClassification
-
- - -
-
- -
-
Last Modified On
-
- -The time the item was modified the last time - -
-
Name
-
lastModifiedOn
-
- - - -
-
Characteristic
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#dateTime - -
-
-
-
-
- -
-
Beispiel
-
2022-02-03T14:48:54.709Z
-
- -
-
Optional
-
- Ja
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
lastModifiedOn
-
- - -
-
- -
-
Created On
-
- -The time the item was created on - -
-
Name
-
createdOn
-
- - - -
-
Characteristic
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#dateTime - -
-
-
-
-
- -
-
Beispiel
-
2022-02-03T14:48:54.709Z
-
- -
-
Optional
-
- Ja
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
createdOn
-
- - -
-
-
-
-

Part Quantity Entity

-
-
- The entity encapsulating the properties describing the quantity of a part. -
- -
-

Properties

-
-
- -
-
Measurement Unit
-
- -Unit of measurement for the quantity of serialized objects. - -
-
Name
-
measurementUnit
-
- - - -
-
Characteristic
-
-
-
-
- Typ urn:bamm:io.openmanufacturing:meta-model:2.0.0#curie - -
-
-
-
-
- -
-
Beispiel
-
kW
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
measurementUnit
-
- - -
-
- -
-
Quantity Number
-
- -The number of objects related to the measurement unit. - -
-
Name
-
quantityNumber
-
- - - -
-
Characteristic
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#double - -
-
-
-
-
- -
-
Beispiel
-
350.0
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
quantityNumber
-
- - -
-
- -
-
Measurement Unit
-
- -Unit of measurement for the quantity of serialized objects. - -
-
Name
-
measurementUnit
-
- - - -
-
Characteristic
-
-
-
-
- Typ urn:bamm:io.openmanufacturing:meta-model:2.0.0#curie - -
-
-
-
-
- -
-
Beispiel
-
kW
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
measurementUnit
-
- - -
-
- -
-
Quantity Number
-
- -The number of objects related to the measurement unit. - -
-
Name
-
quantityNumber
-
- - - -
-
Characteristic
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#double - -
-
-
-
-
- -
-
Beispiel
-
350.0
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
quantityNumber
-
- - -
-
-
- -
- Third party licenses - -
- -
- - -
- - - \ No newline at end of file diff --git a/io.catenax.bom_as_specified/2.0.0/gen/SingleLevelBomAsSpecified.json b/io.catenax.bom_as_specified/2.0.0/gen/SingleLevelBomAsSpecified.json deleted file mode 100644 index feacf80a5..000000000 --- a/io.catenax.bom_as_specified/2.0.0/gen/SingleLevelBomAsSpecified.json +++ /dev/null @@ -1,22 +0,0 @@ -{ - "catenaXId" : "urn:uuid:055c1128-0375-47c8-98de-7cf802c3241d", - "childParts" : [ { - "childPartsCategory" : "e.g. vehicle, winter wheels, bicycle rack", - "part" : [ { - "ownerPartId" : "uuid!", - "partVersion" : "05", - "partQuantity" : { - "quantityNumber" : 350.0, - "measurementUnit" : "kW" - }, - "partDescription" : "The steering wheel is nice and round", - "partClassification" : [ { - "value" : "STEEWHL", - "key" : "BMW:PartFamily" - } ], - "createdOn" : "2022-02-03T14:48:54.709Z", - "lastModifiedOn" : "2022-02-03T14:48:54.709Z" - } ], - "childCatenaXId" : "urn:uuid:218b26f4-4a0b-4a7f-b2c1-d248927718bf " - } ] -} \ No newline at end of file diff --git a/io.catenax.bom_as_specified/2.0.0/gen/SingleLevelBomAsSpecified.yml b/io.catenax.bom_as_specified/2.0.0/gen/SingleLevelBomAsSpecified.yml deleted file mode 100644 index 7da41fdb6..000000000 --- a/io.catenax.bom_as_specified/2.0.0/gen/SingleLevelBomAsSpecified.yml +++ /dev/null @@ -1,284 +0,0 @@ ---- -openapi: 3.0.3 -info: - title: Single Level BOM as Specified - version: v2 -servers: -- url: catenax.io/api/v2 - variables: - api-version: - default: v2 -paths: - /{tenant-id}/single-level-bom-as-specified: - get: - tags: - - SingleLevelBomAsSpecified - operationId: getSingleLevelBomAsSpecified - 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/SingleLevelBomAsSpecified' - "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/SingleLevelBomAsSpecified' - totalItems: - type: number - totalPages: - type: number - pageSize: - type: number - currentPage: - type: number - urn_bamm_io.catenax.bom_as_specified_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)." - 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_bamm_io.openmanufacturing_characteristic_2.0.0_Text: - type: string - description: "Describes a Property which contains plain text. This is intended\ - \ exclusively for human readable strings, not for identifiers, measurement\ - \ values, etc." - urn_bamm_io.openmanufacturing_characteristic_2.0.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_bamm_io.catenax.bom_as_specified_2.0.0_NumberOfObjects: - type: number - description: Quantifiable number of objects in reference to the measurementUnit. - urn_bamm_io.catenax.bom_as_specified_2.0.0_PartQuantityCharacteristic: - description: The characteristic of the part quantity. - type: object - properties: - measurementUnit: - description: Unit of measurement for the quantity of serialized objects. - $ref: '#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_UnitReference' - quantityNumber: - description: The number of objects related to the measurement unit. - $ref: '#/components/schemas/urn_bamm_io.catenax.bom_as_specified_2.0.0_NumberOfObjects' - required: - - measurementUnit - - quantityNumber - - measurementUnit - - quantityNumber - urn_bamm_io.catenax.bom_as_specified_2.0.0_PartClassificationEntity: - description: The entity encapsulating the properties of the part classification. - type: object - properties: - key: - description: Key within the classification. - $ref: '#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text' - value: - description: Value within the classification. - $ref: '#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text' - required: - - key - - value - - key - - value - urn_bamm_io.catenax.bom_as_specified_2.0.0_PartClassificationCharacteristic: - description: The characteristic of the part classification. - type: array - items: - $ref: '#/components/schemas/urn_bamm_io.catenax.bom_as_specified_2.0.0_PartClassificationEntity' - uniqueItems: true - urn_bamm_io.openmanufacturing_characteristic_2.0.0_Timestamp: - type: string - pattern: "-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T(([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](\\\ - .[0-9]+)?|(24:00:00(\\.0+)?))(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?" - description: Describes a Property which contains the date and time with an optional - timezone. - urn_bamm_io.catenax.bom_as_specified_2.0.0_PartEntity: - description: Entity encapsulating the properies describing a part - type: object - properties: - ownerPartId: - description: "This is the key field of the component which usually keeps\ - \ the part numbers used in after-sales, e.g. when repairing broken parts\ - \ and searching for a replacement. This ownerPartId itself isn't usually\ - \ bound to one part version, with the assumption that all part versions\ - \ with the same ownerPartId are mutually interchangeable." - $ref: '#/components/schemas/urn_bamm_io.catenax.bom_as_specified_2.0.0_CatenaXIdTrait' - partVersion: - description: "This is the version of the part. The engineering will at times\ - \ supercede an older part version by a newer one, which might have different\ - \ material aspects, physical dimensions etc., still maintaining compatibility." - $ref: '#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text' - partQuantity: - description: This is the quantity how often this part is in the item. - $ref: '#/components/schemas/urn_bamm_io.catenax.bom_as_specified_2.0.0_PartQuantityCharacteristic' - partDescription: - description: The description of the part in the primary language of the - production facility of the product owner. - $ref: '#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text' - partClassification: - description: The part classification. - $ref: '#/components/schemas/urn_bamm_io.catenax.bom_as_specified_2.0.0_PartClassificationCharacteristic' - lastModifiedOn: - description: The time the item was modified the last time - $ref: '#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Timestamp' - createdOn: - description: The time the item was created on - $ref: '#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Timestamp' - required: - - ownerPartId - - ownerPartId - urn_bamm_io.catenax.bom_as_specified_2.0.0_PartCharacteristic: - description: Characteristic of the part. - type: array - items: - $ref: '#/components/schemas/urn_bamm_io.catenax.bom_as_specified_2.0.0_PartEntity' - uniqueItems: true - urn_bamm_io.catenax.bom_as_specified_2.0.0_ChildPartsEntity: - description: Encapsulates the properties describing the child part item - type: object - properties: - childPartsCategory: - description: "The BomAsSpecified defines the view of the OEM or producer\ - \ of the whole product, e.g. the OEM of a vehicle. It is free of any supplier-related\ - \ information and specifies the promised and guaranteed content of the\ - \ whole product to the end customer. This “top-down” view is in contrast\ - \ to the “bottom-up” view of the SingleLevelBoMAsPlanned, though several\ - \ sub-aspects are shared. The BomAsSpecified is merely one aspect, which\ - \ is attached to the twin of the whole product and itself does neither\ - \ introduce further twins nor reference them. Instead it merely comprises\ - \ all functional information required by dismantlers, workshops or requestors\ - \ for used parts to search for and to make a match on the market place." - $ref: '#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text' - part: - description: The description of the part in the primary language of the - production facility of the product owner. - $ref: '#/components/schemas/urn_bamm_io.catenax.bom_as_specified_2.0.0_PartCharacteristic' - childCatenaXId: - description: Describes the Catena-X ID of the child part - $ref: '#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text' - required: - - childPartsCategory - - part - - childPartsCategory - - part - - childCatenaXId - urn_bamm_io.catenax.bom_as_specified_2.0.0_ChildPartsCharacteristic: - description: The characteristic of the child part property - type: array - items: - $ref: '#/components/schemas/urn_bamm_io.catenax.bom_as_specified_2.0.0_ChildPartsEntity' - uniqueItems: true - SingleLevelBomAsSpecified: - description: "The SingleLevelBomAsSpecified defines the view of the OEM or producer\ - \ of the whole product, e.g. the OEM of a vehicle. It is free of any supplier-related\ - \ information and specifies the promised and guaranteed content of the whole\ - \ product to the end customer. This “top-down” view is in contrast to the\ - \ “bottom-up” view of the SingleLevelBoMAsPlanned, though several sub-aspects\ - \ are shared. The BomAsSpecified is merely one aspect, which is attached to\ - \ the twin of the whole product and itself does neither introduce further\ - \ twins nor reference them. Instead it merely comprises all functional information\ - \ required by dismantlers, workshops or requestors for used parts to search\ - \ for and to make a match on the market place." - type: object - properties: - catenaXId: - description: A unique reference within Catena-X of this items - $ref: '#/components/schemas/urn_bamm_io.catenax.bom_as_specified_2.0.0_CatenaXIdTrait' - childParts: - description: The child part of the observed parent item - $ref: '#/components/schemas/urn_bamm_io.catenax.bom_as_specified_2.0.0_ChildPartsCharacteristic' - required: - - catenaXId - - childParts - - catenaXId - - childParts - 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' - SingleLevelBomAsSpecified: - content: - application/json: - schema: - $ref: '#/components/schemas/PagingSchema' - description: The request was successful. - requestBodies: - SingleLevelBomAsSpecified: - content: - application/json: - schema: - $ref: '#/components/schemas/SingleLevelBomAsSpecified' diff --git a/io.catenax.bom_as_specified/2.0.0/metadata.json b/io.catenax.bom_as_specified/2.0.0/metadata.json deleted file mode 100644 index 970dbd818..000000000 --- a/io.catenax.bom_as_specified/2.0.0/metadata.json +++ /dev/null @@ -1 +0,0 @@ -{ "status" : "deprecate"} \ No newline at end of file diff --git a/io.catenax.electric_drive.electric_drive_passport/2.0.0/ElectricDrivePassport.ttl b/io.catenax.electric_drive.electric_drive_passport/2.0.0/ElectricDrivePassport.ttl new file mode 100644 index 000000000..6f989d61e --- /dev/null +++ b/io.catenax.electric_drive.electric_drive_passport/2.0.0/ElectricDrivePassport.ttl @@ -0,0 +1,531 @@ +####################################################################### +# Copyright (c) 2024 BASF SE +# Copyright (c) 2024 BMW AG +# Copyright (c) 2024 CGI Deutschland B.V. & Co. KG +# Copyright (c) 2024 Henkel AG & Co. KGaA +# Copyright (c) 2024 T-Systems International GmbH +# Copyright (c) 2024 ZF Friedrichshafen AG +# Copyright (c) 2024 Contributors to the Eclipse Foundation +# +# 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-pass: . +@prefix ext-passport: . +@prefix ext-quantity: . + +:ElectricDrivePassport a samm:Aspect ; + samm:preferredName "Electric Drive Passport"@en ; + samm:description "The E-Drive Passport is a data record that summarizes the components, materials and chemical substances or information on repairability, spare parts or professional disposal for an E-Drive. The data comes from all phases of the product life cycle and can be used for various purposes in all these phases (design, production, use, disposal). Structuring environmental data in a standardized, comparable format enables all actors in the value and supply chain to work together towards a circular economy. This data model is based on the new proposed Ecodesign Regulation (ESPR-2022) and the product specific requirements collected from different manufacturers and users of the product."@en ; + samm:properties ( [ samm:property :productSpecificParameters; samm:payloadName "specific" ] [ samm:property :productGenericParameters; samm:payloadName "generic" ] ) ; + samm:operations ( ) ; + samm:events ( ) . + +:productSpecificParameters a samm:Property ; + samm:preferredName "Product Specific Parameters"@en ; + samm:description "Product specific parameters of the electric drive."@en ; + samm:characteristic :SpecificCharacteristic . + +:productGenericParameters a samm:Property ; + samm:preferredName "Product Generic Parameters"@en ; + samm:description "The product generic parameters. These are defined by the Digital Product Passport proposal from the ESPR. The main basis is provided by the document \"Proposal for a REGULATION OF THE EUROPEAN PARLIAMENT AND OF THE COUNCIL establishing a framework for setting ecodesign requirements for sustainable products and repealing Directive 2009/125/EC\" from March 30th, 2022. The latest version of the document was the provisional agreement between the EU Council and the Parliament from January 9th, 2024."@en ; + samm:characteristic :GenericCharacteristic . + +:SpecificCharacteristic a samm:Characteristic ; + samm:preferredName "Specific Characteristic"@en ; + samm:description "The Characteristic to describe product specific parameters of the electric drive."@en ; + samm:dataType :SpecificEntity . + +:GenericCharacteristic a samm:Characteristic ; + samm:preferredName "Generic Characteristic"@en ; + samm:description "Characteristic for the product generic parameters."@en ; + samm:dataType :GenericEntity . + +:SpecificEntity a samm:Entity ; + samm:preferredName "Specific Entity"@en ; + samm:description "The Entity for product specific parameters of the electric drive."@en ; + samm:properties ( :generalInformation :eMachine :coolingAndLubricants :inverter :systemAndPerformance :transmission :electricDriveDocuments ) . + +:GenericEntity a samm:Entity ; + samm:preferredName "Generic Entity"@en ; + samm:description "Entity for the product generic parameters."@en ; + samm:properties ( ext-passport:metadata ext-passport:identification ext-passport:operation ext-passport:handling ext-passport:characteristics ext-passport:commercial ext-passport:materials ext-passport:sustainability ext-passport:sources ) . + +:generalInformation a samm:Property ; + samm:preferredName "General Information"@en ; + samm:description "General information to the eDrive system, including additional information in comparison to the identification category such as the service history and compatible vehicle types."@en ; + samm:characteristic :GeneralCharacteristic . + +:eMachine a samm:Property ; + samm:preferredName "E-Machine"@en ; + samm:description "Data of the e-Machine built into the eDrive, including information E-Machine model and technology (type), and the permanent magnet types / materials."@en ; + samm:characteristic :EMachineCharacteristic . + +:coolingAndLubricants a samm:Property ; + samm:preferredName "Cooling and Lubricants"@en ; + samm:description "Information about the used lubricants and coolants, including liquid specifications and built-in technical lubricant systems."@en ; + samm:characteristic :LiquidsCharacteristic . + +:inverter a samm:Property ; + samm:preferredName "Inverter"@en ; + samm:description "Inverter related data, that could be used in case of replacing or updating an inverter."@en ; + samm:characteristic :InverterCharacteristic . + +:systemAndPerformance a samm:Property ; + samm:preferredName "System and Performance"@en ; + samm:description "System and Performance information of the entire eDrive system."@en ; + samm:characteristic :SystemCharacteristic . + +:transmission a samm:Property ; + samm:preferredName "Transmission"@en ; + samm:description "Information about the transmission built into the eDrive, including technical data."@en ; + samm:characteristic :TransmissionCharacteristic . + +:electricDriveDocuments a samm:Property ; + samm:preferredName "Electric Drive Documents"@en ; + samm:description "Documents pertaining to the removal, replacement, disassembly or dismantling of the entire eDrive."@en ; + samm:characteristic :ElectricDriveDocumentsCharacteristic . + +:GeneralCharacteristic a samm:Characteristic ; + samm:preferredName "General Characteristic"@en ; + samm:description "Characteristic for general information."@en ; + samm:dataType :GeneralEntity . + +:EMachineCharacteristic a samm:Characteristic ; + samm:preferredName "E-Machine Characteristic"@en ; + samm:description "Characteristic for e-machine values."@en ; + samm:dataType :EMachineEntity . + +:LiquidsCharacteristic a samm:Characteristic ; + samm:preferredName "Liquids Characteristic"@en ; + samm:description "Entity for cooling and lubricants."@en ; + samm:dataType :LiquidsEntity . + +:InverterCharacteristic a samm:Characteristic ; + samm:preferredName "Inverter Characteristic"@en ; + samm:description "Characteristic for inverter values."@en ; + samm:dataType :InverterEntity . + +:SystemCharacteristic a samm:Characteristic ; + samm:preferredName "System Characteristic"@en ; + samm:description "Characteristic for performance and system values."@en ; + samm:dataType :SystemEntity . + +:TransmissionCharacteristic a samm:Characteristic ; + samm:preferredName "Transmission Characteristic"@en ; + samm:description "Characteristic for transmission values."@en ; + samm:dataType :TransmissionEntity . + +:ElectricDriveDocumentsCharacteristic a samm:Characteristic ; + samm:preferredName "Electric Drive Documents Characteristic"@en ; + samm:description "Characteristic for specific documents of the electric drive."@en ; + samm:dataType :ElectricDriveDocumentsEntity . + +:GeneralEntity a samm:Entity ; + samm:preferredName "General Entity"@en ; + samm:description "Entity for general information."@en ; + samm:properties ( :compatibleVehicleTypes [ samm:property :service; samm:optional true ] ) . + +:EMachineEntity a samm:Entity ; + samm:preferredName "E-Machine Entity"@en ; + samm:description "Entity for e-machine values."@en ; + samm:properties ( [ samm:property :eMachineId; samm:payloadName "id" ] :permanentMagnetType :ratedSpeed :statorDiameter [ samm:property :eMachineTechnology; samm:payloadName "technology" ] [ samm:property :eMachineWeight; samm:payloadName "weight" ] ) . + +:LiquidsEntity a samm:Entity ; + samm:preferredName "Liquids Entity"@en ; + samm:description "Entity for cooling and lubricants."@en ; + samm:properties ( :coolingTopology :oilCapacityEdrive :oilTypeEdrive [ samm:property :minimumOilPressure; samm:optional true ] [ samm:property :maximumOilPressure; samm:optional true ] :oilModule :maximumOilTemperature ) . + +:InverterEntity a samm:Entity ; + samm:preferredName "Inverter Entity"@en ; + samm:description "Entity for inverter values."@en ; + samm:properties ( :inverterCurrent [ samm:property :maximumPhaseCurrent; samm:optional true ] :softwareVersion ) . + +:SystemEntity a samm:Entity ; + samm:preferredName "System Entity"@en ; + samm:description "Entity for performance and system values."@en ; + samm:properties ( [ samm:property :systemVoltage; samm:payloadName "voltage" ] :power :torque :gearRatio ) . + +:TransmissionEntity a samm:Entity ; + samm:preferredName "Transmission Entity"@en ; + samm:description "Entity for transmission values."@en ; + samm:properties ( :transmissionId :gearboxStructure ext-pass:oil ) . + +:ElectricDriveDocumentsEntity a samm:Entity ; + samm:preferredName "Electric Drive Documents Entity"@en ; + samm:description "Entity for specific documents of the electric drive."@en ; + samm:properties ( :technicalDismantlingInstructions :requiredToolsForDismantling ) . + +:compatibleVehicleTypes a samm:Property ; + samm:preferredName "Compatible Vehicle Types"@en ; + samm:description "The vehicle types, in which the eDrive of this passport can be used. Possible selections are \"battery-electric vehicle\", \"hybrid-electric vehicle\", \"fuel-cell-electric vehicle\"."@en ; + samm:characteristic :CompatibleVehicleTypesTrait ; + samm:exampleValue "battery-electric vehicle" . + +:service a samm:Property ; + samm:preferredName "Service"@en ; + samm:description "The eDrive service history."@en ; + samm:characteristic :ServiceCharacteristic . + +:eMachineId a samm:Property ; + samm:preferredName "E-Machine Id"@en ; + samm:description "The unique serial ID of the e-Machine built into the eDrive of this passport; defined and provided by the owner/economic operator of the passport."@en ; + samm:characteristic :IdentifierCharacteristic ; + samm:exampleValue "1785030A72B5752" . + +:permanentMagnetType a samm:Property ; + samm:preferredName "Permanent Magnet Type"@en ; + samm:description "The permanent magnet type describes the material composition of the permanent magnet in use. In case of SSM e-Motors, no permanent magnets are used, requiring the input of a default value. Possible selections:\n- No permanent magnets used (SSM motor): \"None\"\n- AlNiCo: \"Aluminum-Nickel-Cobalt\"\n- Ceramic: \"Ceramic\"\n- Ferrite: \"Ferrite\"\n- Flexible: \"Flexible Rubber\"\n- SmCo: \"Samarium Cobalt\"\n- NdFeB: \"Neodymium Iron Boron\""@en ; + samm:characteristic samm-c:Text ; + samm:exampleValue "Ceramic" . + +:ratedSpeed a samm:Property ; + samm:preferredName "Rated Speed"@en ; + samm:description "Rated speed determined by the electronics and measured in RPM, limited through software or physical limits (e.g. maximum power)."@en ; + samm:characteristic :RevolutionsMeasurement ; + samm:exampleValue "8000.0"^^xsd:float . + +:statorDiameter a samm:Property ; + samm:preferredName "Stator Diameter"@en ; + samm:description "Diameter of the E-Machine stator, measured in millimetres."@en ; + samm:characteristic :MillimetreMeasurement ; + samm:exampleValue "450.0"^^xsd:float . + +:eMachineTechnology a samm:Property ; + samm:preferredName "E-Machine Technology"@en ; + samm:description "The type of the e-machine built into the eDrive. Possible values are \"ASM\" (Asynchronous motor), \"PSM\" (Permanently excited synchronous motor) and \"ESM\" (Electrically-excited synchronous motor). This should not be confused with an electrical machine integrated in a transmission."@en ; + samm:characteristic :TechnologyEnumeration ; + samm:exampleValue "ASM" . + +:eMachineWeight a samm:Property ; + samm:preferredName "E-Machine Weight"@en ; + samm:description "Net weight, component weight without packaging, of the electrical machine, which is built into the eDrive."@en ; + samm:characteristic ext-quantity:MassCharacteristic . + +:coolingTopology a samm:Property ; + samm:preferredName "Cooling Topology"@en ; + samm:description "General cooling topology, which can be either one of the types: \"air-cooled\", \"water-cooled\" or \"oil-cooled\"."@en ; + samm:characteristic :CoolingEnumeration ; + samm:exampleValue "water-cooled" . + +:oilCapacityEdrive a samm:Property ; + samm:preferredName "Oil Capacity eDrive"@en ; + samm:description "The defined oil volume in the eDrive, measured in cubic decimetres. In case of a combined oil circuit for both the eDrive and the built-in transmission, the value must be identical to the oil capacity value of the transmission."@en ; + samm:characteristic ext-pass:Capacity ; + samm:exampleValue "50.0"^^xsd:float . + +:oilTypeEdrive a samm:Property ; + samm:preferredName "Oil Type eDrive"@en ; + samm:description "The type of the oil for the eDrive defined by the manufacturer. In case of a combined oil circuit for both the eDrive and the built-in transmission, the value must be identical to the oil type value of the transmission."@en ; + samm:characteristic samm-c:Text ; + samm:exampleValue "5W-30" . + +:minimumOilPressure a samm:Property ; + samm:preferredName "Minimum Oil Pressure"@en ; + samm:description "Minimum operational oil pressure value defined by the manufacturer of the E-Drive measured in bar."@en ; + samm:characteristic :BarMeasurement ; + samm:exampleValue "2.068427188"^^xsd:float . + +:maximumOilPressure a samm:Property ; + samm:preferredName "Maximum Oil Pressure"@en ; + samm:description "Maximum operational oil pressure value defined by the manufacturer of the E-Drive measured in bar."@en ; + samm:characteristic :BarMeasurement ; + samm:exampleValue "4.8263301052"^^xsd:float . + +:oilModule a samm:Property ; + samm:preferredName "Oil Module"@en ; + samm:description "Flag indicating the availability or absence of an oil module. An oil module is an umbrella term for devices that are manipulating the oil flow and the temperature in the product and incorporate cooler, pump, valves (pressure regulation valve)."@en ; + samm:characteristic samm-c:Boolean ; + samm:exampleValue true . + +:maximumOilTemperature a samm:Property ; + samm:preferredName "Maximum Oil Temperature"@en ; + samm:description "The maximum oil temperature to safely operate the eDrive, measured in celsius on the oil temperature sensor. Please note the oil temperature can vary in other positions within the lubrication circuit."@en ; + samm:characteristic :CelsiusMeasurement ; + samm:exampleValue "80.5"^^xsd:float . + +:inverterCurrent a samm:Property ; + samm:preferredName "Inverter Current"@en ; + samm:description "Electric current flowing through the inverter, measured in ampere."@en ; + samm:characteristic :AmpereMeasurement ; + samm:exampleValue "500.0"^^xsd:float . + +:maximumPhaseCurrent a samm:Property ; + samm:preferredName "Maximum Phase Current"@en ; + samm:description "The maximum allowable current to pass through the phases, measured in ampere."@en ; + samm:characteristic :AmpereMeasurement ; + samm:exampleValue "700.0"^^xsd:float . + +:softwareVersion a samm:Property ; + samm:preferredName "Software Version"@en ; + samm:description "Indicates the software version of the inverter."@en ; + samm:characteristic samm-c:Text ; + samm:exampleValue "2.525.b" . + +:systemVoltage a samm:Property ; + samm:preferredName "System Voltage"@en ; + samm:description "The characterizing voltage level in the vehicle in volts, to which the battery and electric drive are adjusted to."@en ; + samm:characteristic :VoltMeasurement ; + samm:exampleValue "400.0"^^xsd:float . + +:power a samm:Property ; + samm:preferredName "Power"@en ; + samm:description "Technical power figures in kilowatt."@en ; + samm:characteristic :PowerCharacteristic . + +:torque a samm:Property ; + samm:preferredName "Torque"@en ; + samm:description "Technical torque figures."@en ; + samm:characteristic :TorqueCharacteristic . + +:gearRatio a samm:Property ; + samm:preferredName "Gear Ratio"@en ; + samm:description "Gear ratio calculated by dividing the angular or rotational speed of the output shaft by the angular speed of the input shaft. It can also be calculated by dividing the total driving gear’s teeth by the total driven gear’s teeth."@en ; + samm:characteristic :RevolutionsMeasurement ; + samm:exampleValue "4.1567"^^xsd:float . + +:transmissionId a samm:Property ; + samm:preferredName "Transmission Id"@en ; + samm:description "Transmission ID of the transmission i.e. serial number allowing for unequivocal identification of the transmission."@en ; + samm:characteristic :IdentifierCharacteristic ; + samm:exampleValue "384502A54FC9" . + +:gearboxStructure a samm:Property ; + samm:preferredName "Gearbox Structure"@en ; + samm:description "Short description of the gearbox design, e.g. layshaft or planetary, depending on the technical design of the car."@en ; + samm:characteristic samm-c:Text ; + samm:exampleValue "Planetary" . + +:technicalDismantlingInstructions a samm:Property ; + samm:preferredName "Technical Dismantling Instructions"@en ; + samm:description "Document containing information and instructions, including steps, diagrams and illustrations of removing or replacing the eDrive or dismantling it."@en ; + samm:characteristic ext-passport:DocumentList . + +:requiredToolsForDismantling a samm:Property ; + samm:preferredName "Required Tools For Dismantling"@en ; + samm:description "Document containing information and instructions for required tools or technologies pertaining to the removal, replacement or dismantling of the eDrive."@en ; + samm:characteristic ext-passport:DocumentList . + +:CompatibleVehicleTypesTrait a samm-c:Trait ; + samm:preferredName "Compatible Vehicle Types Trait"@en ; + samm:description "Trait to restrict values."@en ; + samm-c:baseCharacteristic :StringList ; + samm-c:constraint :VehicleTypesConstraint . + +:ServiceCharacteristic a samm:Characteristic ; + samm:preferredName "Service Characteristic"@en ; + samm:description "Characteristic for the service dates."@en ; + samm:dataType :ServiceEntity . + +:IdentifierCharacteristic a samm:Characteristic ; + samm:preferredName "Identifier Characteristic"@en ; + samm:description "Characteristic for identifiers of components in the electrical drive."@en ; + samm:dataType xsd:string . + +:RevolutionsMeasurement a samm-c:Measurement ; + samm:preferredName "Revolutions Measurement"@en ; + samm:description "Measurement of revolutions per minute as float value."@en ; + samm:dataType xsd:float ; + samm-c:unit unit:revolutionPerMinute . + +:MillimetreMeasurement a samm-c:Measurement ; + samm:preferredName "Millimetre Measurement"@en ; + samm:description "Measurement of millimetre as float value."@en ; + samm:dataType xsd:float ; + samm-c:unit unit:millimetre . + +:TechnologyEnumeration a samm-c:Enumeration ; + samm:preferredName "Technology Enumeration"@en ; + samm:description "Enumeration for the e-machine technology."@en ; + samm:dataType xsd:string ; + samm-c:values ( "ESM" "ASM" "PSM" ) . + +:CoolingEnumeration a samm-c:Enumeration ; + samm:preferredName "Cooling Enumeration"@en ; + samm:description "Enumeration of cooling technology."@en ; + samm:dataType xsd:string ; + samm-c:values ( "air-cooled" "water-cooled" "oil-cooled" ) . + +:BarMeasurement a samm-c:Measurement ; + samm:preferredName "Bar Measurement"@en ; + samm:description "Measurement of the pressure in bar as float value."@en ; + samm:dataType xsd:float ; + samm-c:unit unit:barUnitOfPressure . + +:CelsiusMeasurement a samm-c:Measurement ; + samm:preferredName "Celsius Measurement"@en ; + samm:description "Measurement in celsius as float value."@en ; + samm:dataType xsd:float ; + samm-c:unit unit:degreeCelsius . + +:AmpereMeasurement a samm-c:Measurement ; + samm:preferredName "Ampere Measurement"@en ; + samm:description "Measurement of ampere as float value."@en ; + samm:dataType xsd:float ; + samm-c:unit unit:ampere . + +:VoltMeasurement a samm-c:Measurement ; + samm:preferredName "Volt Measurement"@en ; + samm:description "Measurement in volt as float value."@en ; + samm:dataType xsd:float ; + samm-c:unit unit:volt . + +:PowerCharacteristic a samm:Characteristic ; + samm:preferredName "Power Characteristic"@en ; + samm:description "Characteristic for power values."@en ; + samm:dataType :PowerEntity . + +:TorqueCharacteristic a samm:Characteristic ; + samm:preferredName "Torque Characteristic"@en ; + samm:description "Entity for torque values."@en ; + samm:dataType :TorqueEntity . + +:StringList a samm-c:List ; + samm:preferredName "String List"@en ; + samm:description "A list of values in the data type string."@en ; + samm:dataType xsd:string . + +:VehicleTypesConstraint a samm-c:RegularExpressionConstraint ; + samm:preferredName "Vehicle Types Constraint"@en ; + samm:description "Constraint for the three possible vehicle types. A selection of multiple is possible."@en ; + samm:value "battery-electric vehicle|hybrid-electric vehicle|fuel-cell-electric vehicle|(?:battery-electric vehicle, |hybrid-electric vehicle, |fuel-cell-electric vehicle, )*battery-electric vehicle|hybrid-electric vehicle|fuel-cell-electric vehicle" . + +:ServiceEntity a samm:Entity ; + samm:preferredName "Service Entity"@en ; + samm:description "Entity for the service dates."@en ; + samm:properties ( [ samm:property :serviceHistory; samm:payloadName "history" ] :lastServiceDate ) . + +:PowerEntity a samm:Entity ; + samm:preferredName "Power Entity"@en ; + samm:description "Entity for power values."@en ; + samm:properties ( [ samm:property :maximumPower; samm:payloadName "maximum" ] [ samm:property :continuousRegeneratedPower; samm:payloadName "continuousRegenerated" ] [ samm:property :maximumRegeneratedPower; samm:payloadName "maxRegenerated" ] [ samm:property ext-pass:continuousPower; samm:payloadName "continuous" ] ) . + +:TorqueEntity a samm:Entity ; + samm:preferredName "Torque Entity"@en ; + samm:description "Entity for torque values."@en ; + samm:properties ( [ samm:property :maximumTorque; samm:payloadName "maximum" ] [ samm:property :maximumAxleTorque; samm:payloadName "maxAxle" ] [ samm:property ext-pass:continuousTorque; samm:payloadName "continuous" ] ) . + +:serviceHistory a samm:Property ; + samm:preferredName "Service History"@en ; + samm:description "The dates of putting the eDrive into service."@en ; + samm:characteristic :DateList ; + samm:exampleValue "2020-02-15"^^xsd:date . + +:lastServiceDate a samm:Property ; + samm:preferredName "Last Service Date"@en ; + samm:description "The date of the last service."@en ; + samm:characteristic :DateCharacteristic ; + samm:exampleValue "2022-03-03"^^xsd:date . + +:maximumPower a samm:Property ; + samm:preferredName "Maximum Power"@en ; + samm:description "The maximum output power in kilowatts for a specified time period."@en ; + samm:characteristic :MaximumPowerCharacteristic . + +:continuousRegeneratedPower a samm:Property ; + samm:preferredName "Continuous Regenerated Power"@en ; + samm:description "The amount of power, which can be regenerated continuously, within the bounds of normal operation, in kilowatts."@en ; + samm:characteristic :KilowattMeasurement ; + samm:exampleValue "5.0"^^xsd:float . + +:maximumRegeneratedPower a samm:Property ; + samm:preferredName "Maximum Regenerated Power"@en ; + samm:description "The maximum possible value that can be regenerated at a given time in kilowatts."@en ; + samm:characteristic :MaximumRegeneratedPowerCharacteristic . + +:maximumTorque a samm:Property ; + samm:preferredName "Maximum Torque"@en ; + samm:description "The maximum torque the system delivers over a specific measurement time period."@en ; + samm:characteristic :MaximumTorqueCharacteristic . + +:maximumAxleTorque a samm:Property ; + samm:preferredName "Maximum Axle Torque"@en ; + samm:description "Maximum motor torque multiplied by the gear ratio."@en ; + samm:characteristic :MaximumTorqueCharacteristic . + +:DateList a samm-c:List ; + samm:preferredName "Date List"@en ; + samm:description "A list of values in the data type date."@en ; + samm:dataType xsd:date . + +:DateCharacteristic a samm:Characteristic ; + samm:preferredName "Date Characteristic"@en ; + samm:description "Characteristic for values in the data type date."@en ; + samm:dataType xsd:date . + +:MaximumPowerCharacteristic a samm:Characteristic ; + samm:preferredName "Maximum Power Characteristic"@en ; + samm:description "Characteristic with maximum power values."@en ; + samm:dataType :MaximumPowerEntity . + +:KilowattMeasurement a samm-c:Measurement ; + samm:preferredName "Kilowatt Measurement"@en ; + samm:description "Measurement in kilowatt as float value."@en ; + samm:dataType xsd:float ; + samm-c:unit unit:kilowatt . + +:MaximumRegeneratedPowerCharacteristic a samm:Characteristic ; + samm:preferredName "Maximum Regenerated Power Characteristic"@en ; + samm:description "Characteristic for maximum regenerated power values."@en ; + samm:dataType :MaximumRegeneratedPowerEntity . + +:MaximumTorqueCharacteristic a samm:Characteristic ; + samm:preferredName "Maximum Torque Characteristic"@en ; + samm:description "Characteristic for maximum torque values."@en ; + samm:dataType :MaximumTorqueEntity . + +:MaximumPowerEntity a samm:Entity ; + samm:preferredName "Maximum Power Entity"@en ; + samm:description "Entity with maximum power values."@en ; + samm:properties ( [ samm:property :maxValue; samm:payloadName "value" ] [ samm:property :maxPowerECER85; samm:optional true; samm:payloadName "ECER85" ] ext-pass:maximumAvailability ) . + +:MaximumRegeneratedPowerEntity a samm:Entity ; + samm:preferredName "Maximum Regenerated Power Entity"@en ; + samm:description "Entity for maximum regenerated power values."@en ; + samm:properties ( :maxValue ext-pass:maximumAvailability ) . + +:MaximumTorqueEntity a samm:Entity ; + samm:preferredName "Maximum Torque Entity"@en ; + samm:description "Entity for maximum torque values."@en ; + samm:properties ( [ samm:property :torqueValue; samm:payloadName "value" ] ext-pass:maximumAvailability ) . + +:maxValue a samm:Property ; + samm:preferredName "Max Value"@en ; + samm:description "The maximum value in kilowatts for a specified time period."@en ; + samm:characteristic :KilowattMeasurement ; + samm:exampleValue "200.0"^^xsd:float . + +:maxPowerECER85 a samm:Property ; + samm:preferredName "Max Power ECER85"@en ; + samm:description "Maximum power in kilowatts, measured according to the ECER85 regulatory requirements."@en ; + samm:characteristic :KilowattMeasurement ; + samm:exampleValue "195.0"^^xsd:float . + +:torqueValue a samm:Property ; + samm:preferredName "Torque Value"@en ; + samm:description "Measured torque value in newton metre."@en ; + samm:characteristic :NewtonMetreMeasurement ; + samm:exampleValue "300.0"^^xsd:decimal . + +:NewtonMetreMeasurement a samm-c:Measurement ; + samm:preferredName "Newton Metre Measurement"@en ; + samm:description "Measurement in newton metre as decimal value."@en ; + samm:dataType xsd:decimal ; + samm-c:unit unit:newtonMetre . + diff --git a/io.catenax.electric_drive.electric_drive_passport/2.0.0/gen/ElectricDrivePassport-aas.xml b/io.catenax.electric_drive.electric_drive_passport/2.0.0/gen/ElectricDrivePassport-aas.xml new file mode 100644 index 000000000..b94fa8ecb --- /dev/null +++ b/io.catenax.electric_drive.electric_drive_passport/2.0.0/gen/ElectricDrivePassport-aas.xml @@ -0,0 +1,18717 @@ + + + + + defaultAdminShell + + + en + defaultAdminShell + + + + urn:samm:io.catenax.electric_drive.electric_drive_passport:2.0.0#ElectricDrivePassport + + Type + + + + ModelReference + + + Submodel + urn:samm:io.catenax.electric_drive.electric_drive_passport:2.0.0#ElectricDrivePassport/submodel + + + + + + + + + ElectricDrivePassport + + + en + The E-Drive Passport is a data record that summarizes the components, materials and chemical substances or information on repairability, spare parts or professional disposal for an E-Drive. The data comes from all phases of the product life cycle and can be used for various purposes in all these phases (design, production, use, disposal). Structuring environmental data in a standardized, comparable format enables all actors in the value and supply chain to work together towards a circular economy. This data model is based on the new proposed Ecodesign Regulation (ESPR-2022) and the product specific requirements collected from different manufacturers and users of the product. + + + + urn:samm:io.catenax.electric_drive.electric_drive_passport:2.0.0#ElectricDrivePassport/submodel + Template + + ModelReference + + + ConceptDescription + urn:samm:io.catenax.electric_drive.electric_drive_passport:2.0.0#ElectricDrivePassport + + + + + + SpecificEntity + + + en + Specific Entity + + + + + en + The Entity for product specific parameters of the electric drive. + + + + + GeneralEntity + + + en + General Entity + + + + + en + Entity for general information. + + + + + compatibleVehicleTypes + + + en + Compatible Vehicle Types + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.electric_drive.electric_drive_passport:2.0.0#compatibleVehicleTypes + + + + xs:string + + + + ServiceEntity + + + en + Service Entity + + + + + en + Entity for the service dates. + + + + + serviceHistory + + + en + Service History + + + + + en + The dates of putting the eDrive into service. + + + true + DataElement + + + serviceHistory + + + en + Service History + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.electric_drive.electric_drive_passport:2.0.0#serviceHistory + + + + xs:date + + + + + + lastServiceDate + + + en + Last Service Date + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.electric_drive.electric_drive_passport:2.0.0#lastServiceDate + + + + xs:date + + + + + + + + EMachineEntity + + + en + E-Machine Entity + + + + + en + Entity for e-machine values. + + + + + eMachineId + + + en + E-Machine Id + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.electric_drive.electric_drive_passport:2.0.0#eMachineId + + + + xs:string + + + + permanentMagnetType + + + en + Permanent Magnet Type + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.electric_drive.electric_drive_passport:2.0.0#permanentMagnetType + + + + xs:string + + + + ratedSpeed + + + en + Rated Speed + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.electric_drive.electric_drive_passport:2.0.0#ratedSpeed + + + + xs:float + + + + statorDiameter + + + en + Stator Diameter + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.electric_drive.electric_drive_passport:2.0.0#statorDiameter + + + + xs:float + + + + eMachineTechnology + + + en + E-Machine Technology + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.electric_drive.electric_drive_passport:2.0.0#eMachineTechnology + + + + xs:string + + + + MassEntity + + + en + Mass Entity + + + + + en + Entity for mass measurements of an item with an unit and value. + + + + + quantityValue + + + en + Quantity Value + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.shared.quantity:2.0.0#quantityValue + + + + xs:float + + + + massUnit + + + en + Mass Unit + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.shared.quantity:2.0.0#massUnit + + + + + + ExternalReference + + + GlobalReference + https://eclipse-esmf.github.io/samm-specification/2.1.0/index.html + + + + + xs:string + + + + + + + + LiquidsEntity + + + en + Liquids Entity + + + + + en + Entity for cooling and lubricants. + + + + + coolingTopology + + + en + Cooling Topology + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.electric_drive.electric_drive_passport:2.0.0#coolingTopology + + + + xs:string + + + + oilCapacityEdrive + + + en + Oil Capacity eDrive + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.electric_drive.electric_drive_passport:2.0.0#oilCapacityEdrive + + + + xs:float + + + + oilTypeEdrive + + + en + Oil Type eDrive + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.electric_drive.electric_drive_passport:2.0.0#oilTypeEdrive + + + + xs:string + + + + minimumOilPressure + + + en + Minimum Oil Pressure + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.electric_drive.electric_drive_passport:2.0.0#minimumOilPressure + + + + xs:float + + + + maximumOilPressure + + + en + Maximum Oil Pressure + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.electric_drive.electric_drive_passport:2.0.0#maximumOilPressure + + + + xs:float + + + + oilModule + + + en + Oil Module + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.electric_drive.electric_drive_passport:2.0.0#oilModule + + + + xs:boolean + + + + maximumOilTemperature + + + en + Maximum Oil Temperature + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.electric_drive.electric_drive_passport:2.0.0#maximumOilTemperature + + + + xs:float + + + + + + InverterEntity + + + en + Inverter Entity + + + + + en + Entity for inverter values. + + + + + inverterCurrent + + + en + Inverter Current + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.electric_drive.electric_drive_passport:2.0.0#inverterCurrent + + + + xs:float + + + + maximumPhaseCurrent + + + en + Maximum Phase Current + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.electric_drive.electric_drive_passport:2.0.0#maximumPhaseCurrent + + + + xs:float + + + + softwareVersion + + + en + Software Version + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.electric_drive.electric_drive_passport:2.0.0#softwareVersion + + + + xs:string + + + + + + SystemEntity + + + en + System Entity + + + + + en + Entity for performance and system values. + + + + + systemVoltage + + + en + System Voltage + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.electric_drive.electric_drive_passport:2.0.0#systemVoltage + + + + xs:float + + + + PowerEntity + + + en + Power Entity + + + + + en + Entity for power values. + + + + + MaximumPowerEntity + + + en + Maximum Power Entity + + + + + en + Entity with maximum power values. + + + + + maxValue + + + en + Max Value + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.electric_drive.electric_drive_passport:2.0.0#maxValue + + + + xs:float + + + + maxPowerECER85 + + + en + Max Power ECER85 + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.electric_drive.electric_drive_passport:2.0.0#maxPowerECER85 + + + + xs:float + + + + maximumAvailability + + + en + Maximum Availability + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.transmission.transmission_pass:3.0.0#maximumAvailability + + + + xs:nonNegativeInteger + + + + + + continuousRegeneratedPower + + + en + Continuous Regenerated Power + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.electric_drive.electric_drive_passport:2.0.0#continuousRegeneratedPower + + + + xs:float + + + + MaximumRegeneratedPowerEntity + + + en + Maximum Regenerated Power Entity + + + + + en + Entity for maximum regenerated power values. + + + + + maxValue + + + en + Max Value + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.electric_drive.electric_drive_passport:2.0.0#maxValue + + + + xs:float + + + + maximumAvailability + + + en + Maximum Availability + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.transmission.transmission_pass:3.0.0#maximumAvailability + + + + xs:nonNegativeInteger + + + + + + continuousPower + + + en + Continuous Power + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.transmission.transmission_pass:3.0.0#continuousPower + + + + xs:nonNegativeInteger + + + + + + TorqueEntity + + + en + Torque Entity + + + + + en + Entity for torque values. + + + + + MaximumTorqueEntity + + + en + Maximum Torque Entity + + + + + en + Entity for maximum torque values. + + + + + torqueValue + + + en + Torque Value + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.electric_drive.electric_drive_passport:2.0.0#torqueValue + + + + xs:decimal + + + + maximumAvailability + + + en + Maximum Availability + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.transmission.transmission_pass:3.0.0#maximumAvailability + + + + xs:nonNegativeInteger + + + + + + MaximumTorqueEntity + + + en + Maximum Torque Entity + + + + + en + Entity for maximum torque values. + + + + + torqueValue + + + en + Torque Value + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.electric_drive.electric_drive_passport:2.0.0#torqueValue + + + + xs:decimal + + + + maximumAvailability + + + en + Maximum Availability + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.transmission.transmission_pass:3.0.0#maximumAvailability + + + + xs:nonNegativeInteger + + + + + + continuousTorque + + + en + Continuous Torque + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.transmission.transmission_pass:3.0.0#continuousTorque + + + + xs:nonNegativeInteger + + + + + + gearRatio + + + en + Gear Ratio + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.electric_drive.electric_drive_passport:2.0.0#gearRatio + + + + xs:float + + + + + + TransmissionEntity + + + en + Transmission Entity + + + + + en + Entity for transmission values. + + + + + transmissionId + + + en + Transmission Id + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.electric_drive.electric_drive_passport:2.0.0#transmissionId + + + + xs:string + + + + gearboxStructure + + + en + Gearbox Structure + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.electric_drive.electric_drive_passport:2.0.0#gearboxStructure + + + + xs:string + + + + OilEntity + + + en + Oil Entity + + + + + en + Entity for the oil capacity and type. + + + + + oilCapacity + + + en + Oil Capacity + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.transmission.transmission_pass:3.0.0#oilCapacity + + + + xs:float + + + + oilType + + + en + Oil Type + + + + + en + The type of the oil for the transmission defined by the manufacturer of the transmission. + + + true + DataElement + + + oilType + + + en + Oil Type + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.transmission.transmission_pass:3.0.0#oilType + + + + xs:string + + + + + + + + + + ElectricDriveDocumentsEntity + + + en + Electric Drive Documents Entity + + + + + en + Entity for specific documents of the electric drive. + + + + + technicalDismantlingInstructions + + + en + Technical Dismantling Instructions + + + + + en + Document containing information and instructions, including steps, diagrams and illustrations of removing or replacing the eDrive or dismantling it. + + + true + DataElement + + + DocumentationEntity + + + en + Documentation Entity + + + + + en + Entity for a document with a header, type and content. + + + + + content + + + en + Content + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + xs:string + + + + contentType + + + en + Content Type + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + xs:string + + + + header + + + en + Header + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + xs:string + + + + + + + + requiredToolsForDismantling + + + en + Required Tools For Dismantling + + + + + en + Document containing information and instructions for required tools or technologies pertaining to the removal, replacement or dismantling of the eDrive. + + + true + DataElement + + + DocumentationEntity + + + en + Documentation Entity + + + + + en + Entity for a document with a header, type and content. + + + + + content + + + en + Content + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + xs:string + + + + contentType + + + en + Content Type + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + xs:string + + + + header + + + en + Header + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + xs:string + + + + + + + + + + + + GenericEntity + + + en + Generic Entity + + + + + en + Entity for the product generic parameters. + + + + + MetadataEntity + + + en + Metadata Entity + + + + + en + Passport Entity to describe version, status, end and issue date. + + + + + version + + + en + Version + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#version + + + + xs:string + + + + status + + + en + Status + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#status + + + + xs:string + + + + expirationDate + + + en + Expiration Date + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#expirationDate + + + + xs:string + + + + issueDate + + + en + Issue Date + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#issueDate + + + + xs:string + + + + economicOperatorId + + + en + Economic Operator Id + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#economicOperatorId + + + + xs:string + + + + passportIdentifier + + + en + Passport Identifier + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#passportIdentifier + + + + xs:string + + + + predecessor + + + en + Predecessor + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#predecessor + + + + xs:string + + + + backupReference + + + en + Backup Reference + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#backupReference + + + + xs:string + + + + registrationIdentifier + + + en + Registration Identifier + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#registrationIdentifier + + + + xs:string + + + + lastModification + + + en + Last Modification + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#lastModification + + + + xs:string + + + + + + IdentificationEntity + + + en + Identification Entity + + + + + en + Entity with identification information of the product with part type information, local identifiers, other codes and the data carrier. + + + + + serialInformation + + + en + Serial Information + + + + + en + Identifier for a serial part if available. This is mentioned in the ESPR provisional agreement from January 9th, 2024 Recital (27): +[...] an 'item' usually means a single unit of a model. + + + true + DataElement + + + KeyValueList + + + en + Key Value List + + + + + en + A list of key value pairs for local identifiers, which are composed of a key and a corresponding value. + + + + + key + + + en + Identifier Key + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.serial_part:3.0.0#key + + + + xs:string + + + + value + + + en + Identifier Value + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.serial_part:3.0.0#value + + + + xs:string + + + + + + + + batchInformation + + + en + Batch Information + + + + + en + Identifier for a batch part if available. Identifier for a serial part if available. This is mentioned in the ESPR provisional agreement from January 9th, 2024 Recital (27): +[...] a 'batch' usually means a subset of a specific model composed of all products produced in a specific manufacturing plant at a specific moment in time [...]. + + + true + DataElement + + + KeyValueList + + + en + Key Value List + + + + + en + A list of key value pairs for local identifiers, which are composed of a key and a corresponding value. + + + + + key + + + en + Identifier Key + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.batch:3.0.0#key + + + + xs:string + + + + value + + + en + Identifier Value + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.batch:3.0.0#value + + + + xs:string + + + + + + + + PartTypeEntity + + + en + Part Type Entity + + + + + en + Entity for the part type with manufacturer id and name. + + + + + manufacturerPartId + + + en + Manufacturer Part ID + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.part_type_information:1.0.0#manufacturerPartId + + + + xs:string + + + + nameAtManufacturer + + + en + Name at manufacturer + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.part_type_information:1.0.0#nameAtManufacturer + + + + xs:string + + + + + + codes + + + en + Codes + + + + + en + Codes for identification. + + + true + DataElement + + + CodeEntity + + + en + Code Entity + + + + + en + Code entity with code key and value. + + + + + codeKey + + + en + Code Key + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#codeKey + + + + xs:string + + + + codeValue + + + en + Code Value + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#codeValue + + + + xs:string + + + + + + + + DataCarrierEntity + + + en + Data Carrier Entity + + + + + en + Data Carrier Entity with type and layout of the data carrier. + + + + + carrierType + + + en + Carrier Type + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#carrierType + + + + xs:string + + + + carrierLayout + + + en + Carrier Layout + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#carrierLayout + + + + xs:string + + + + + + partClassification + + + en + Part Classification + + + + + en + Property describing the classification of a part. + + + true + DataElement + + + ClassificationEntity + + + en + ClassificationEntity + + + + + en + Encapsulates data related to the classification of the part. + + + + + classificationStandard + + + en + Classification Standard + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.shared.part_classification:1.0.0#classificationStandard + + + + xs:string + + + + classificationID + + + en + Classification ID + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.shared.part_classification:1.0.0#classificationID + + + + xs:string + + + + classificationDescription + + + en + Classification Description + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.shared.part_classification:1.0.0#classificationDescription + + + + xs:string + + + + + + + + + + OperationEntity + + + en + Operation Entity + + + + + en + Operational information of the product such as the owner, manufacturer and importer. + + + + + ManufacturerEntity + + + en + Manufacturer Entity + + + + + en + Manufacturing Entity with the identification of the main manufacturer and the facility location as well as the manufacturing date. + + + + + facilityIdentification + + + en + Facility Identification + + + + + en + The identifier used for a location. In the CATENA-X use case, the BPNA can be stated. This attribute is mentioned in the ESPR provisional agreement from January 9th 2024 Annex III: +(i) unique facility identifiers; +Article 2 Definitions: (33) 'unique facility identifier' means a unique string of characters for the identification of locations or buildings involved in the value chain of a product or used by actors involved in the value chain of a product. + + + true + DataElement + + + FacilityEntity + + + en + Facility Entity + + + + + en + The entity for a facility with the BPNA identifier. + + + + + facility + + + en + Facility + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#facility + + + + xs:string + + + + + + + + manufacturerIdentification + + + en + Manufacturer Identification + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#manufacturerIdentification + + + + xs:string + + + + manufacturingDate + + + en + Manufacturing Date + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#manufacturingDate + + + + xs:string + + + + + + ImportEntity + + + en + Import Entity + + + + + en + Import entity with attributes if applicable to the product. + + + + + ImporterEntity + + + en + Importer Entity + + + + + en + Entity with information regarding the importer such as the identification and the EORI. + + + + + eori + + + en + EORI + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#eori + + + + + + ExternalReference + + + GlobalReference + https://taxation-customs.ec.europa.eu/customs-4/customs-procedures-import-and-export-0/customs-procedures/economic-operators-registration-and-identification-number-eori_en + + + + + xs:string + + + + importerIdentification + + + en + Importer Identification + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#importerIdentification + + + + xs:string + + + + + + applicable + + + en + Applicable + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#applicable + + + + xs:boolean + + + + + + OperatorEntity + + + en + Operator Entity + + + + + en + Operator with role and identification. + + + + + otherOperatorId + + + en + Other Operator Id + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#otherOperatorId + + + + xs:string + + + + otherOperatorRole + + + en + Other Operator Role + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#otherOperatorRole + + + + xs:string + + + + + + + + HandlingEntity + + + en + Handling Entity + + + + + en + Entity to describe different aspects in relation with the handling of the product with attributes if applicable to the product. + + + + + SparePartEntity + + + en + Spare Part Entity + + + + + en + Information regarding possible spare parts. This is mentioned in the ESPR proposal from March 30th, 2022 Annex I: +(b) ease of repair and maintenance as expressed through: characteristics, availability and delivery time of spare parts, modularity, compatibility with commonly available spare parts, availability of repair and maintenance instructions, number of materials and components used, use of standard components, use of component and material coding standards for the identification of components and materials, number and complexity of processes and tools needed, ease of non-destructive disassembly and re-assembly, conditions for access to product data, conditions for access to or use of hardware and software needed; +(c) the Global Trade Identification Number as provided for in standard ISO/IEC 15459-6 or equivalent of products or their parts. + + + + + sparePartSources + + + en + Spare Part Sources + + + + + en + Sources of possible spare parts. + + + true + DataElement + + + SourcesEntity + + + en + Sources Entity + + + + + en + Entity for a possible spare part sources. + + + + + sourcesIdentification + + + en + Sources Identification + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#sourcesIdentification + + + + xs:string + + + + + + + + sparePart + + + en + Spare Part + + + + + en + Possible spare parts of the product. + + + true + DataElement + + + PartsEntity + + + en + Parts Entity + + + + + en + Possible spare parts of the product with identifiers and names. + + + + + manufacturerPartId + + + en + Manufacturer Part ID + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.part_type_information:1.0.0#manufacturerPartId + + + + xs:string + + + + nameAtManufacturer + + + en + Name at manufacturer + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.part_type_information:1.0.0#nameAtManufacturer + + + + xs:string + + + + + + + + + + applicable + + + en + Applicable + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#applicable + + + + xs:boolean + + + + + + CharacteristicsEntity + + + en + Characteristics Entity + + + + + en + Entity which defines specific characteristics of a product such as different life spans and physical dimensions. + + + + + lifespan + + + en + Lifespan + + + + + en + The type of lifespan represented with the values guaranteed lifetime, technical lifetime and mean time between failures. Both can be described through the attributes: type, which defines the type such as guaranteed lifetime or technical lifetime, the unit for the lifetime, and the value represented by an integer. These attributes are mentioned in the ESPR proposal from March 30th, 2022 ANNEX I: +(a) durability and reliability of the product or its components as expressed through the products guaranteed lifetime, technical lifetime [or] mean time between failures [...]. + + + true + DataElement + + + LifespanEntity + + + en + Lifespan Entity + + + + + en + Entity for the lifespan of a product with type, unit and value. + + + + + lifeUnit + + + en + Life Unit + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#lifeUnit + + + + + + ExternalReference + + + GlobalReference + https://eclipse-esmf.github.io/samm-specification/2.1.0/index.html + + + + + xs:string + + + + lifeValue + + + en + Life Value + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#lifeValue + + + + xs:integer + + + + lifeType + + + en + Life Type + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#lifeType + + + + xs:string + + + + + + + + PhysicalDimensionEntity + + + en + Physical Dimension Entity + + + + + en + Entity for physical dimensions with linear, mass and capacity attributes. Either weight or volume is mandatory. + + + + + LinearEntity + + + en + Linear Entity + + + + + en + Entity for linear measurements of an item with an unit and value. + + + + + quantityValue + + + en + Quantity Value + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.shared.quantity:2.0.0#quantityValue + + + + xs:float + + + + linearUnit + + + en + Linear Unit + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.shared.quantity:2.0.0#linearUnit + + + + + + ExternalReference + + + GlobalReference + https://eclipse-esmf.github.io/samm-specification/2.1.0/index.html + + + + + xs:string + + + + + + LinearEntity + + + en + Linear Entity + + + + + en + Entity for linear measurements of an item with an unit and value. + + + + + quantityValue + + + en + Quantity Value + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.shared.quantity:2.0.0#quantityValue + + + + xs:float + + + + linearUnit + + + en + Linear Unit + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.shared.quantity:2.0.0#linearUnit + + + + + + ExternalReference + + + GlobalReference + https://eclipse-esmf.github.io/samm-specification/2.1.0/index.html + + + + + xs:string + + + + + + LinearEntity + + + en + Linear Entity + + + + + en + Entity for linear measurements of an item with an unit and value. + + + + + quantityValue + + + en + Quantity Value + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.shared.quantity:2.0.0#quantityValue + + + + xs:float + + + + linearUnit + + + en + Linear Unit + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.shared.quantity:2.0.0#linearUnit + + + + + + ExternalReference + + + GlobalReference + https://eclipse-esmf.github.io/samm-specification/2.1.0/index.html + + + + + xs:string + + + + + + LinearEntity + + + en + Linear Entity + + + + + en + Entity for linear measurements of an item with an unit and value. + + + + + quantityValue + + + en + Quantity Value + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.shared.quantity:2.0.0#quantityValue + + + + xs:float + + + + linearUnit + + + en + Linear Unit + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.shared.quantity:2.0.0#linearUnit + + + + + + ExternalReference + + + GlobalReference + https://eclipse-esmf.github.io/samm-specification/2.1.0/index.html + + + + + xs:string + + + + + + MassEntity + + + en + Mass Entity + + + + + en + Entity for mass measurements of an item with an unit and value. + + + + + quantityValue + + + en + Quantity Value + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.shared.quantity:2.0.0#quantityValue + + + + xs:float + + + + massUnit + + + en + Mass Unit + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.shared.quantity:2.0.0#massUnit + + + + + + ExternalReference + + + GlobalReference + https://eclipse-esmf.github.io/samm-specification/2.1.0/index.html + + + + + xs:string + + + + + + VolumeEntity + + + en + Volume Entity + + + + + en + Entity for volume measurements of an item with an unit and value. + + + + + quantityValue + + + en + Quantity Value + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.shared.quantity:2.0.0#quantityValue + + + + xs:float + + + + volumeUnit + + + en + Volume Unit + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.shared.quantity:2.0.0#volumeUnit + + + + + + ExternalReference + + + GlobalReference + https://eclipse-esmf.github.io/samm-specification/2.1.0/index.html + + + + + xs:string + + + + + + MassEntity + + + en + Mass Entity + + + + + en + Entity for mass measurements of an item with an unit and value. + + + + + quantityValue + + + en + Quantity Value + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.shared.quantity:2.0.0#quantityValue + + + + xs:float + + + + massUnit + + + en + Mass Unit + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.shared.quantity:2.0.0#massUnit + + + + + + ExternalReference + + + GlobalReference + https://eclipse-esmf.github.io/samm-specification/2.1.0/index.html + + + + + xs:string + + + + + + VolumeEntity + + + en + Volume Entity + + + + + en + Entity for volume measurements of an item with an unit and value. + + + + + quantityValue + + + en + Quantity Value + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.shared.quantity:2.0.0#quantityValue + + + + xs:float + + + + volumeUnit + + + en + Volume Unit + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.shared.quantity:2.0.0#volumeUnit + + + + + + ExternalReference + + + GlobalReference + https://eclipse-esmf.github.io/samm-specification/2.1.0/index.html + + + + + xs:string + + + + + + + + physicalState + + + en + Physical State + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#physicalState + + + + xs:string + + + + generalPerformanceClass + + + en + General Performance Class + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#generalPerformanceClass + + + + xs:string + + + + + + CommercialEntity + + + en + Commercial Entity + + + + + en + Commercial information. + + + + + placedOnMarket + + + en + Placed on Market + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#placedOnMarket + + + + xs:string + + + + purpose + + + en + Purpose + + + + + en + One or more intended industry/industries of the product described by the digital product passport. If exchanged via Catena-X, 'automotive ' is a must choice included in the list. + + + true + DataElement + + + purpose + + + en + Purpose + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#purpose + + + + xs:string + + + + + + + + MaterialsEntity + + + en + Materials Entity + + + + + en + Entity with materials on the level of the product. + + + + + SubstanceOfConcernEntity + + + en + Substance Of Concern Entity + + + + + en + Substance of Concern entity with attributes if applicable to the product. + + + + + applicable + + + en + Applicable + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#applicable + + + + xs:boolean + + + + substanceOfConcern + + + en + Substance of Concern + + + + + en + Information regarding substances of concern in the product. Attributes are among others substance names, ids, concentration, location and hazard class. This is mentioned in the ESPR provisional agreement from January 9th, 2024 Article 7: +(5) (a) the name of the substances of concern present in the product, as follows: +- name(s) in the International Union of Pure and Applied Chemistry (IUPAC) nomenclature, or another international name when IUPAC name is not available; +- other names (usual name, trade name, abbreviation); +- European Community (EC) number, as indicated in the European Inventory of Existing Commercial Chemical Substances (EINECS), the European List of Notified Chemical Substances (ELINCS) or the No Longer Polymer (NLP) list or assigned by the European Chemicals Agency (ECHA), if available; +- the Chemical Abstract Service (CAS) name(s) and number(s), if available; +(5) (b) the location of the substances of concern within the product. +(5) (c) the concentration, maximum concentration or concentration range of the substances of concern, at the level of the product its relevant components, or spare parts; +(d) relevant instructions for the safe use of the product; +(e) information relevant for disassembly, preparation for reuse, reuse, recycling and the environmentally sound management of the product at the end of its life. +And in the next paragraph: +(c) provide duly justified exemptions for substances of concern or information elements from the information requirements referred to in the first subparagraph. + + + true + DataElement + + + SubstanceEntity + + + en + Substance Entity + + + + + en + Information regarding substances of concern in the product. + + + + + location + + + en + Location + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#location + + + + xs:string + + + + materialUnit + + + en + Material Unit + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#materialUnit + + + + + + ExternalReference + + + GlobalReference + https://eclipse-esmf.github.io/samm-specification/2.1.0/index.html + + + + + xs:string + + + + concentration + + + en + Concentration + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#concentration + + + + xs:float + + + + exemption + + + en + Exemption + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#exemption + + + + xs:string + + + + HazardEntity + + + en + Hazard Entity + + + + + en + Entity for the hazardous classification. + + + + + ExternalReference + + + GlobalReference + https://eur-lex.europa.eu/legal-content/EN/TXT/?uri=CELEX:02008R1272-20231201 + + + + + + + hazardCategory + + + en + Hazard Category + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#hazardCategory + + + + + + ExternalReference + + + GlobalReference + https://eur-lex.europa.eu/legal-content/EN/TXT/?uri=CELEX:02008R1272-20231201 + + + + + xs:string + + + + hazardClass + + + en + Hazard Class + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#hazardClass + + + + + + ExternalReference + + + GlobalReference + https://eur-lex.europa.eu/legal-content/EN/TXT/?uri=CELEX:02008R1272-20231201 + + + + + xs:string + + + + hazardStatement + + + en + Hazard Statement + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#hazardStatement + + + + + + ExternalReference + + + GlobalReference + https://eur-lex.europa.eu/legal-content/EN/TXT/?uri=CELEX:02008R1272-20231201 + + + + + xs:string + + + + + + concentrationRange + + + en + Concentration Range + + + + + en + The concentration range for the substance of concern. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7: +(5) (c) [...] concentration range of the substances of concern, at the level of the product [...]. + + + true + DataElement + + + RangeEntity + + + en + Range Entity + + + + + en + Entity for the concentration range with two values, the highest and the lowest of the concentration range. + + + + + minConcentration + + + en + Minimum Concentration + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#minConcentration + + + + xs:float + + + + maxConcentration + + + en + Maximum Concentration + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#maxConcentration + + + + xs:float + + + + + + + + materialIdentification + + + en + Material Identification + + + + + en + The chemical material name and identification, in accordance with the specification in the attribute for the list type. Preference is given to the IUPAC name. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Article 7: +(5) (a) the name of the substances of concern present in the product, as follows: + - name(s) in the International Union of Pure and Applied Chemistry (IUPAC) nomenclature, or another international name when IUPAC name is not available; +- other names (usual name, trade name, abbreviation); +- European Community (EC) number, as indicated in the European Inventory of Existing Commercial Chemical Substances (EINECS), the European List of Notified Chemical Substances (ELINCS) or the No Longer Polymer (NLP) list or assigned by the European Chemicals Agency (ECHA), if available; +- the Chemical Abstract Service (CAS) name(s) and number(s), if available; . + + + true + DataElement + + + MaterialIdEntity + + + en + Material Id Entity + + + + + en + Id Entity with identifier, name and list type. + + + + + chemicalId + + + en + Chemical Id + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#chemicalId + + + + xs:string + + + + listTypeId + + + en + List Type Id + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#listTypeId + + + + xs:string + + + + chemicalName + + + en + Chemical Name + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#chemicalName + + + + xs:string + + + + + + + + documentation + + + en + Documentation + + + + + en + Documentation accompanying the material. + + + true + DataElement + + + DocumentationEntity + + + en + Documentation Entity + + + + + en + Entity for a document with a header, type and content. + + + + + content + + + en + Content + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + xs:string + + + + contentType + + + en + Content Type + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + xs:string + + + + header + + + en + Header + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + xs:string + + + + + + + + + + + + + + ChemicalMaterialEntity + + + en + Chemical Material Entity + + + + + en + Material entity with attributes if applicable to the product. + + + + + applicable + + + en + Applicable + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#applicable + + + + xs:boolean + + + + chemicalMaterial + + + en + Material + + + + + en + Information on different materials in the product. + + + true + DataElement + + + MaterialEntity + + + en + Material Entity + + + + + en + Information regarding recycled and/or renewable materials in the product. + + + + + recycled + + + en + Recycled + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#recycled + + + + xs:float + + + + renewable + + + en + Renewable + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#renewable + + + + xs:float + + + + materialUnit + + + en + Material Unit + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#materialUnit + + + + + + ExternalReference + + + GlobalReference + https://eclipse-esmf.github.io/samm-specification/2.1.0/index.html + + + + + xs:string + + + + materialIdentification + + + en + Material Identification + + + + + en + The chemical material name and identification, in accordance with the specification in the attribute for the list type. Preference is given to the IUPAC name. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Article 7: +(5) (a) the name of the substances of concern present in the product, as follows: + - name(s) in the International Union of Pure and Applied Chemistry (IUPAC) nomenclature, or another international name when IUPAC name is not available; +- other names (usual name, trade name, abbreviation); +- European Community (EC) number, as indicated in the European Inventory of Existing Commercial Chemical Substances (EINECS), the European List of Notified Chemical Substances (ELINCS) or the No Longer Polymer (NLP) list or assigned by the European Chemicals Agency (ECHA), if available; +- the Chemical Abstract Service (CAS) name(s) and number(s), if available; . + + + true + DataElement + + + MaterialIdEntity + + + en + Material Id Entity + + + + + en + Id Entity with identifier, name and list type. + + + + + chemicalId + + + en + Chemical Id + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#chemicalId + + + + xs:string + + + + listTypeId + + + en + List Type Id + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#listTypeId + + + + xs:string + + + + chemicalName + + + en + Chemical Name + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#chemicalName + + + + xs:string + + + + + + + + critical + + + en + Critical + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#critical + + + + + + ExternalReference + + + GlobalReference + https://eur-lex.europa.eu/legal-content/EN/TXT/?uri=COM:2023:0160:FIN + + + + + xs:boolean + + + + concentration + + + en + Concentration + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#concentration + + + + xs:float + + + + documentation + + + en + Documentation + + + + + en + Documentation accompanying the material. + + + true + DataElement + + + DocumentationEntity + + + en + Documentation Entity + + + + + en + Entity for a document with a header, type and content. + + + + + content + + + en + Content + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + xs:string + + + + contentType + + + en + Content Type + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + xs:string + + + + header + + + en + Header + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + xs:string + + + + + + + + + + + + + + + + SustainabilityEntity + + + en + Sustainability Entity + + + + + en + Entity with the properties regarding the sustainability of the product. + + + + + state + + + en + State + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#state + + + + xs:string + + + + ProductFootprintEntity + + + en + Product Footprint Entity + + + + + en + The Product Footprint Entity with sustainability information such as the different environmental footprint types, the carbon and material footprint explicitly, applicable rules and lifecycle stages. + + + + + environmentalFootprint + + + en + Environmental Footprint + + + + + en + The environmental footprint of the product. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I: +The following parameters shall, as appropriate, and where necessary supplemented by others, be used, individually or combined, as a basis for improving the product aspects referred to in Article 5(1): +(l) the environmental footprint of the product, expressed as a quantification, in accordance with the applicable delegated act, of a product's life cycle environmental impacts, whether in relation to one or more environmental impact categories or an aggregated set of impact categories. +and Article 7: +(2)(b)(i) information on the performance of the product in relation to one or more of the product parameters referred to in Annex I, including a scoring of reparability or durability, carbon footprint or environmental footprint; +and defined by Article 2: +(23) 'environmental footprint' means a quantification of product environmental impacts throughout its life cycle, whether in relation to a single environmental impact category or an aggregated set of impact categories based on the Product Environmental Footprint method or other scientific methods developed by international organisations and widely tested in collaboration with different industry sectors and adopted or implemented by the Commission in other Union legislation; +(24) 'Product Environmental Footprint method' means the life cycle assessment method to quantify the environmental impacts of products established by Recommendation (EU) 2021/2279. + + + true + DataElement + + + FootprintEntity + + + en + Footprint Entity + + + + + en + Footprint Entity for the carbon and environmental footprint with the total value, unit, impact category type, lifecycle, rulebook, declaration, performance class and the facility. + + + + + footprintValue + + + en + Footprint Value + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#footprintValue + + + + xs:float + + + + footprintRulebook + + + en + Footprint Rulebook + + + + + en + The applied rulebook for the environmental footprint of the product. + + + true + DataElement + + + DocumentationEntity + + + en + Documentation Entity + + + + + en + Entity for a document with a header, type and content. + + + + + content + + + en + Content + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + xs:string + + + + contentType + + + en + Content Type + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + xs:string + + + + header + + + en + Header + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + xs:string + + + + + + + + footprintLifecycle + + + en + Footprint Lifecycle + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#footprintLifecycle + + + + xs:string + + + + footprintUnit + + + en + Footprint Unit + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#footprintUnit + + + + xs:string + + + + footprintType + + + en + Footprint Type + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#footprintType + + + + xs:string + + + + performanceClass + + + en + Performance Class + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#performanceClass + + + + xs:string + + + + manufacturingPlant + + + en + Manufacturing Plant + + + + + en + The manufacturing plant of the footprint in the specific lifecycle phase. + + + true + DataElement + + + FacilityEntity + + + en + Facility Entity + + + + + en + The entity for a facility with the BPNA identifier. + + + + + facility + + + en + Facility + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#facility + + + + xs:string + + + + + + + + declaration + + + en + Declaration + + + + + en + The footprint declaration in the format of a link + + + true + DataElement + + + DocumentationEntity + + + en + Documentation Entity + + + + + en + Entity for a document with a header, type and content. + + + + + content + + + en + Content + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + xs:string + + + + contentType + + + en + Content Type + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + xs:string + + + + header + + + en + Header + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + xs:string + + + + + + + + + + + + carbonFootprint + + + en + Carbon Footprint + + + + + en + The carbon footprint of the product. This is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I: +The following parameters shall, as appropriate, and where necessary supplemented by others, be used, individually or combined, as a basis for improving the product aspects referred to in Article 5(1): +(m) the carbon footprint of the product; +and Article 7: +(2)(b)(i) information on the performance of the product in relation to one or more of the product parameters referred to in Annex I, including a scoring of reparability or durability, carbon footprint or environmental footprint; +and defined by Article 2: +(25) 'carbon footprint' means the sum of greenhouse gas (GHG) emissions and GHG removals in a product system, expressed as CO2 equivalents and based on a life cycle assessment using the single impact category of climate change. + + + true + DataElement + + + FootprintEntity + + + en + Footprint Entity + + + + + en + Footprint Entity for the carbon and environmental footprint with the total value, unit, impact category type, lifecycle, rulebook, declaration, performance class and the facility. + + + + + footprintValue + + + en + Footprint Value + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#footprintValue + + + + xs:float + + + + footprintRulebook + + + en + Footprint Rulebook + + + + + en + The applied rulebook for the environmental footprint of the product. + + + true + DataElement + + + DocumentationEntity + + + en + Documentation Entity + + + + + en + Entity for a document with a header, type and content. + + + + + content + + + en + Content + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + xs:string + + + + contentType + + + en + Content Type + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + xs:string + + + + header + + + en + Header + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + xs:string + + + + + + + + footprintLifecycle + + + en + Footprint Lifecycle + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#footprintLifecycle + + + + xs:string + + + + footprintUnit + + + en + Footprint Unit + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#footprintUnit + + + + xs:string + + + + footprintType + + + en + Footprint Type + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#footprintType + + + + xs:string + + + + performanceClass + + + en + Performance Class + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#performanceClass + + + + xs:string + + + + manufacturingPlant + + + en + Manufacturing Plant + + + + + en + The manufacturing plant of the footprint in the specific lifecycle phase. + + + true + DataElement + + + FacilityEntity + + + en + Facility Entity + + + + + en + The entity for a facility with the BPNA identifier. + + + + + facility + + + en + Facility + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#facility + + + + xs:string + + + + + + + + declaration + + + en + Declaration + + + + + en + The footprint declaration in the format of a link + + + true + DataElement + + + DocumentationEntity + + + en + Documentation Entity + + + + + en + Entity for a document with a header, type and content. + + + + + content + + + en + Content + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + xs:string + + + + contentType + + + en + Content Type + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + xs:string + + + + header + + + en + Header + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + xs:string + + + + + + + + + + + + materialFootprint + + + en + Material Footprint + + + + + en + The material footprint of the product. This is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I: +(ma) the material footprint of the product; +and defined by Article 2: +(25a) 'material footprint' refers to the total amount of raw materials extracted to meet final consumption demands. + + + true + DataElement + + + FootprintEntity + + + en + Footprint Entity + + + + + en + Footprint Entity for the carbon and environmental footprint with the total value, unit, impact category type, lifecycle, rulebook, declaration, performance class and the facility. + + + + + footprintValue + + + en + Footprint Value + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#footprintValue + + + + xs:float + + + + footprintRulebook + + + en + Footprint Rulebook + + + + + en + The applied rulebook for the environmental footprint of the product. + + + true + DataElement + + + DocumentationEntity + + + en + Documentation Entity + + + + + en + Entity for a document with a header, type and content. + + + + + content + + + en + Content + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + xs:string + + + + contentType + + + en + Content Type + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + xs:string + + + + header + + + en + Header + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + xs:string + + + + + + + + footprintLifecycle + + + en + Footprint Lifecycle + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#footprintLifecycle + + + + xs:string + + + + footprintUnit + + + en + Footprint Unit + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#footprintUnit + + + + xs:string + + + + footprintType + + + en + Footprint Type + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#footprintType + + + + xs:string + + + + performanceClass + + + en + Performance Class + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#performanceClass + + + + xs:string + + + + manufacturingPlant + + + en + Manufacturing Plant + + + + + en + The manufacturing plant of the footprint in the specific lifecycle phase. + + + true + DataElement + + + FacilityEntity + + + en + Facility Entity + + + + + en + The entity for a facility with the BPNA identifier. + + + + + facility + + + en + Facility + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#facility + + + + xs:string + + + + + + + + declaration + + + en + Declaration + + + + + en + The footprint declaration in the format of a link + + + true + DataElement + + + DocumentationEntity + + + en + Documentation Entity + + + + + en + Entity for a document with a header, type and content. + + + + + content + + + en + Content + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + xs:string + + + + contentType + + + en + Content Type + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + xs:string + + + + header + + + en + Header + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + xs:string + + + + + + + + + + + + + + reparabilityScore + + + en + Reparability Score + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#reparabilityScore + + + + xs:string + + + + durabilityScore + + + en + Durability Score + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#durabilityScore + + + + xs:string + + + + + + sources + + + en + Sources + + + + + en + Documents that are mandatory if applicable for the product. These are mentioned in the ESPR provisional agreement from January 9th, 2024 ANNEX III: +(e) compliance documentation and information required under this Regulation or other Union law applicable to the product, such as the declaration of conformity, technical documentation or conformity certificates; +(f) user manuals, instructions, warnings or safety information, as required by other Union legislation applicable to the product. +Additionally requirements are mentioned in Article 21: +7. Manufacturers shall ensure that a product covered by a delegated act adopted pursuant to Article 4 is accompanied by instructions in digital format that enable customers and other relevant actors to assemble, install, operate, store, maintain, repair and dispose of the product in a language that can be easily understood, as determined by the Member State concerned. Such instructions shall be clear, understandable and legible and include at least the information set out in Article 7(2), point (b), point (ii) specified in the delegated acts adopted pursuant to Article 4. +Article 7 states additionally: +(ii) information for customers and other actors on how to install, use, maintain and repair the product, in order to minimise its impact on the environment and to ensure optimum durability, on how to install third-party operating systems where relevant, as well as on collection for refurbishment or remanufacture, and on how to return or handle the product at the end of its life; +(2) (b) (iii) information for treatment facilities on disassembly, reuse, refurbishment, recycling, or disposal at end-of-life; +(2) (b) (iv) other information that may influence sustainable product choices for customers and the way the product is handled by parties other than the manufacturer in order to facilitate appropriate use, value retaining operations and correct treatment at end-of-life. +(5) (d) relevant instructions for the safe use of the product. +(5) (e) information relevant for disassembly, preparation for reuse, reuse, recycling and the environmentally sound management of the product at the end of its life. +Annex I: +(b) [...] availability of repair and maintenance instructions, number of materials and components used, use of standard components,[...] number and complexity of processes and whether specialised toolsare needed, ease of non-destructive disassembly and re-assembly, conditions for access to product data, conditions for access to or use of hardware and software needed; +(c) ease of upgrading, re-use, remanufacturing and refurbishment as expressed through: [...] number and complexity of processes and tools needed, ease of non-destructive disassembly and re-assembly, conditions for access to product data, conditions for access to or use of hardware and software needed, conditions of access to test protocols or not commonly available testing equipment, availability of guarantees specific to remanufactured or refurbished products, conditions for access to or use of technologies protected by intellectual property rights, modularity; +(d) design for recycling, ease and quality of recycling as expressed through: use of easily recyclable materials, safe, easy and non-destructive access to recyclable components and materials or components and materials containing hazardous substances and material composition and homogeneity, possibility for high-purity sorting, [...] number and complexity of processes and tools needed, ease of nondestructive disassembly and re-assembly, conditions for access to product data, conditions for access to or use of hardware and software needed; +(q) functional performance and conditions for use including as expressed through ability in performing its intended use, precautions of use, skills required, compatibility with other products or systems. +Additionally to consider are guidelines and instructions regarding the proper management and disposal of packaging materials after use. This can include instructions for separation, reuse, and recycling. + + + true + DataElement + + + DocumentEntity + + + en + Document Entity + + + + + en + Document entity with header, content, category and type. + + + + + content + + + en + Content + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + xs:string + + + + category + + + en + Category + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#category + + + + xs:string + + + + contentType + + + en + Content Type + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + xs:string + + + + header + + + en + Header + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + xs:string + + + + + + + + + + + + + + APPLICATION_CLASS + ElectricDrivePassport + + + en + Electric Drive Passport + + + + + en + The E-Drive Passport is a data record that summarizes the components, materials and chemical substances or information on repairability, spare parts or professional disposal for an E-Drive. The data comes from all phases of the product life cycle and can be used for various purposes in all these phases (design, production, use, disposal). Structuring environmental data in a standardized, comparable format enables all actors in the value and supply chain to work together towards a circular economy. This data model is based on the new proposed Ecodesign Regulation (ESPR-2022) and the product specific requirements collected from different manufacturers and users of the product. + + + urn:samm:io.catenax.electric_drive.electric_drive_passport:2.0.0#ElectricDrivePassport + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Electric Drive Passport + + + + + en + ElectricDrivePassport + + + + + en + The E-Drive Passport is a data record that summarizes the components, materials and chemical substances or information on repairability, spare parts or professional disposal for an E-Drive. The data comes from all phases of the product life cycle and can be used for various purposes in all these phases (design, production, use, disposal). Structuring environmental data in a standardized, comparable format enables all actors in the value and supply chain to work together towards a circular economy. This data model is based on the new proposed Ecodesign Regulation (ESPR-2022) and the product specific requirements collected from different manufacturers and users of the product. + + + + + + + + + compatibleVehicleTypes + + + en + Compatible Vehicle Types + + + urn:samm:io.catenax.electric_drive.electric_drive_passport:2.0.0#compatibleVehicleTypes + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Compatible Vehicle Types + + + + + en + compatibleVehicleTypes + + + STRING + + + en + The vehicle types, in which the eDrive of this passport can be used. Possible selections are "battery-electric vehicle", "hybrid-electric vehicle", "fuel-cell-electric vehicle". + + + + + + + + + serviceHistory + + + en + Service History + + + urn:samm:io.catenax.electric_drive.electric_drive_passport:2.0.0#serviceHistory + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Service History + + + + + en + serviceHistory + + + STRING + + + en + The dates of putting the eDrive into service. + + + + + + + + + lastServiceDate + + + en + Last Service Date + + + urn:samm:io.catenax.electric_drive.electric_drive_passport:2.0.0#lastServiceDate + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Last Service Date + + + + + en + lastServiceDate + + + STRING + + + en + The date of the last service. + + + + + + + + + service + + + en + Service + + + urn:samm:io.catenax.electric_drive.electric_drive_passport:2.0.0#service + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Service + + + + + en + service + + + STRING + + + en + The eDrive service history. + + + + + + + + + generalInformation + + + en + General Information + + + urn:samm:io.catenax.electric_drive.electric_drive_passport:2.0.0#generalInformation + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + General Information + + + + + en + generalInformation + + + STRING + + + en + General information to the eDrive system, including additional information in comparison to the identification category such as the service history and compatible vehicle types. + + + + + + + + + eMachineId + + + en + E-Machine Id + + + urn:samm:io.catenax.electric_drive.electric_drive_passport:2.0.0#eMachineId + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + E-Machine Id + + + + + en + eMachineId + + + STRING + + + en + The unique serial ID of the e-Machine built into the eDrive of this passport; defined and provided by the owner/economic operator of the passport. + + + + + + + + + permanentMagnetType + + + en + Permanent Magnet Type + + + urn:samm:io.catenax.electric_drive.electric_drive_passport:2.0.0#permanentMagnetType + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Permanent Magnet Type + + + + + en + permanentMagnetType + + + STRING + + + en + The permanent magnet type describes the material composition of the permanent magnet in use. In case of SSM e-Motors, no permanent magnets are used, requiring the input of a default value. Possible selections: +- No permanent magnets used (SSM motor): "None" +- AlNiCo: "Aluminum-Nickel-Cobalt" +- Ceramic: "Ceramic" +- Ferrite: "Ferrite" +- Flexible: "Flexible Rubber" +- SmCo: "Samarium Cobalt" +- NdFeB: "Neodymium Iron Boron" + + + + + + + + + ratedSpeed + + + en + Rated Speed + + + urn:samm:io.catenax.electric_drive.electric_drive_passport:2.0.0#ratedSpeed + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Rated Speed + + + + + en + ratedSpeed + + + revolutionPerMinute + REAL_MEASURE + + + en + Rated speed determined by the electronics and measured in RPM, limited through software or physical limits (e.g. maximum power). + + + + + + + + + statorDiameter + + + en + Stator Diameter + + + urn:samm:io.catenax.electric_drive.electric_drive_passport:2.0.0#statorDiameter + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Stator Diameter + + + + + en + statorDiameter + + + millimetre + REAL_MEASURE + + + en + Diameter of the E-Machine stator, measured in millimetres. + + + + + + + + + eMachineTechnology + + + en + E-Machine Technology + + + urn:samm:io.catenax.electric_drive.electric_drive_passport:2.0.0#eMachineTechnology + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + E-Machine Technology + + + + + en + eMachineTechnology + + + STRING + + + en + The type of the e-machine built into the eDrive. Possible values are "ASM" (Asynchronous motor), "PSM" (Permanently excited synchronous motor) and "ESM" (Electrically-excited synchronous motor). This should not be confused with an electrical machine integrated in a transmission. + + + + + + ESM + + ModelReference + + + DataElement + urn:samm:io.catenax.electric_drive.electric_drive_passport:2.0.0#TechnologyEnumeration:ESM + + + + + + ASM + + ModelReference + + + DataElement + urn:samm:io.catenax.electric_drive.electric_drive_passport:2.0.0#TechnologyEnumeration:ASM + + + + + + PSM + + ModelReference + + + DataElement + urn:samm:io.catenax.electric_drive.electric_drive_passport:2.0.0#TechnologyEnumeration:PSM + + + + + + + + + + + + + quantityValue + + + en + Quantity Value + + + urn:samm:io.catenax.shared.quantity:2.0.0#quantityValue + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Quantity Value + + + + + en + quantityValue + + + REAL_MEASURE + + + en + The quantity value associated with the unit. + + + + + + + + + massUnit + + + en + Mass Unit + + + urn:samm:io.catenax.shared.quantity:2.0.0#massUnit + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Mass Unit + + + + + en + massUnit + + + STRING + + + en + The unit of a mass related attribute. + + + + + + unit:gram + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#MassUnitEnumeration:unit:gram + + + + + + unit:kilogram + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#MassUnitEnumeration:unit:kilogram + + + + + + unit:tonneMetricTon + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#MassUnitEnumeration:unit:tonneMetricTon + + + + + + unit:tonUsOrShortTonUkorus + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#MassUnitEnumeration:unit:tonUsOrShortTonUkorus + + + + + + unit:ounceAvoirdupois + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#MassUnitEnumeration:unit:ounceAvoirdupois + + + + + + unit:pound + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#MassUnitEnumeration:unit:pound + + + + + + + + + + + + + eMachineWeight + + + en + E-Machine Weight + + + urn:samm:io.catenax.electric_drive.electric_drive_passport:2.0.0#eMachineWeight + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + E-Machine Weight + + + + + en + eMachineWeight + + + STRING + + + en + Net weight, component weight without packaging, of the electrical machine, which is built into the eDrive. + + + + + + + + + eMachine + + + en + E-Machine + + + urn:samm:io.catenax.electric_drive.electric_drive_passport:2.0.0#eMachine + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + E-Machine + + + + + en + eMachine + + + STRING + + + en + Data of the e-Machine built into the eDrive, including information E-Machine model and technology (type), and the permanent magnet types / materials. + + + + + + + + + coolingTopology + + + en + Cooling Topology + + + urn:samm:io.catenax.electric_drive.electric_drive_passport:2.0.0#coolingTopology + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Cooling Topology + + + + + en + coolingTopology + + + STRING + + + en + General cooling topology, which can be either one of the types: "air-cooled", "water-cooled" or "oil-cooled". + + + + + + air-cooled + + ModelReference + + + DataElement + urn:samm:io.catenax.electric_drive.electric_drive_passport:2.0.0#CoolingEnumeration:air-cooled + + + + + + water-cooled + + ModelReference + + + DataElement + urn:samm:io.catenax.electric_drive.electric_drive_passport:2.0.0#CoolingEnumeration:water-cooled + + + + + + oil-cooled + + ModelReference + + + DataElement + urn:samm:io.catenax.electric_drive.electric_drive_passport:2.0.0#CoolingEnumeration:oil-cooled + + + + + + + + + + + + + oilCapacityEdrive + + + en + Oil Capacity eDrive + + + urn:samm:io.catenax.electric_drive.electric_drive_passport:2.0.0#oilCapacityEdrive + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Oil Capacity eDrive + + + + + en + oilCapacityEdrive + + + cubicDecimetre + REAL_MEASURE + + + en + The defined oil volume in the eDrive, measured in cubic decimetres. In case of a combined oil circuit for both the eDrive and the built-in transmission, the value must be identical to the oil capacity value of the transmission. + + + + + + + + + oilTypeEdrive + + + en + Oil Type eDrive + + + urn:samm:io.catenax.electric_drive.electric_drive_passport:2.0.0#oilTypeEdrive + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Oil Type eDrive + + + + + en + oilTypeEdrive + + + STRING + + + en + The type of the oil for the eDrive defined by the manufacturer. In case of a combined oil circuit for both the eDrive and the built-in transmission, the value must be identical to the oil type value of the transmission. + + + + + + + + + minimumOilPressure + + + en + Minimum Oil Pressure + + + urn:samm:io.catenax.electric_drive.electric_drive_passport:2.0.0#minimumOilPressure + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Minimum Oil Pressure + + + + + en + minimumOilPressure + + + barUnitOfPressure + REAL_MEASURE + + + en + Minimum operational oil pressure value defined by the manufacturer of the E-Drive measured in bar. + + + + + + + + + maximumOilPressure + + + en + Maximum Oil Pressure + + + urn:samm:io.catenax.electric_drive.electric_drive_passport:2.0.0#maximumOilPressure + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Maximum Oil Pressure + + + + + en + maximumOilPressure + + + barUnitOfPressure + REAL_MEASURE + + + en + Maximum operational oil pressure value defined by the manufacturer of the E-Drive measured in bar. + + + + + + + + + oilModule + + + en + Oil Module + + + urn:samm:io.catenax.electric_drive.electric_drive_passport:2.0.0#oilModule + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Oil Module + + + + + en + oilModule + + + BOOLEAN + + + en + Flag indicating the availability or absence of an oil module. An oil module is an umbrella term for devices that are manipulating the oil flow and the temperature in the product and incorporate cooler, pump, valves (pressure regulation valve). + + + + + + + + + maximumOilTemperature + + + en + Maximum Oil Temperature + + + urn:samm:io.catenax.electric_drive.electric_drive_passport:2.0.0#maximumOilTemperature + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Maximum Oil Temperature + + + + + en + maximumOilTemperature + + + degreeCelsius + REAL_MEASURE + + + en + The maximum oil temperature to safely operate the eDrive, measured in celsius on the oil temperature sensor. Please note the oil temperature can vary in other positions within the lubrication circuit. + + + + + + + + + coolingAndLubricants + + + en + Cooling and Lubricants + + + urn:samm:io.catenax.electric_drive.electric_drive_passport:2.0.0#coolingAndLubricants + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Cooling and Lubricants + + + + + en + coolingAndLubricants + + + STRING + + + en + Information about the used lubricants and coolants, including liquid specifications and built-in technical lubricant systems. + + + + + + + + + inverterCurrent + + + en + Inverter Current + + + urn:samm:io.catenax.electric_drive.electric_drive_passport:2.0.0#inverterCurrent + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Inverter Current + + + + + en + inverterCurrent + + + ampere + REAL_MEASURE + + + en + Electric current flowing through the inverter, measured in ampere. + + + + + + + + + maximumPhaseCurrent + + + en + Maximum Phase Current + + + urn:samm:io.catenax.electric_drive.electric_drive_passport:2.0.0#maximumPhaseCurrent + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Maximum Phase Current + + + + + en + maximumPhaseCurrent + + + ampere + REAL_MEASURE + + + en + The maximum allowable current to pass through the phases, measured in ampere. + + + + + + + + + softwareVersion + + + en + Software Version + + + urn:samm:io.catenax.electric_drive.electric_drive_passport:2.0.0#softwareVersion + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Software Version + + + + + en + softwareVersion + + + STRING + + + en + Indicates the software version of the inverter. + + + + + + + + + inverter + + + en + Inverter + + + urn:samm:io.catenax.electric_drive.electric_drive_passport:2.0.0#inverter + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Inverter + + + + + en + inverter + + + STRING + + + en + Inverter related data, that could be used in case of replacing or updating an inverter. + + + + + + + + + systemVoltage + + + en + System Voltage + + + urn:samm:io.catenax.electric_drive.electric_drive_passport:2.0.0#systemVoltage + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + System Voltage + + + + + en + systemVoltage + + + volt + REAL_MEASURE + + + en + The characterizing voltage level in the vehicle in volts, to which the battery and electric drive are adjusted to. + + + + + + + + + maxValue + + + en + Max Value + + + urn:samm:io.catenax.electric_drive.electric_drive_passport:2.0.0#maxValue + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Max Value + + + + + en + maxValue + + + kilowatt + REAL_MEASURE + + + en + The maximum value in kilowatts for a specified time period. + + + + + + + + + maxPowerECER85 + + + en + Max Power ECER85 + + + urn:samm:io.catenax.electric_drive.electric_drive_passport:2.0.0#maxPowerECER85 + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Max Power ECER85 + + + + + en + maxPowerECER85 + + + kilowatt + REAL_MEASURE + + + en + Maximum power in kilowatts, measured according to the ECER85 regulatory requirements. + + + + + + + + + maximumAvailability + + + en + Maximum Availability + + + urn:samm:io.catenax.transmission.transmission_pass:3.0.0#maximumAvailability + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Maximum Availability + + + + + en + maximumAvailability + + + secondUnitOfTime + INTEGER_COUNT + + + en + Specified time period for the peak measurement in seconds. + + + + + + + + + maximumPower + + + en + Maximum Power + + + urn:samm:io.catenax.electric_drive.electric_drive_passport:2.0.0#maximumPower + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Maximum Power + + + + + en + maximumPower + + + STRING + + + en + The maximum output power in kilowatts for a specified time period. + + + + + + + + + continuousRegeneratedPower + + + en + Continuous Regenerated Power + + + urn:samm:io.catenax.electric_drive.electric_drive_passport:2.0.0#continuousRegeneratedPower + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Continuous Regenerated Power + + + + + en + continuousRegeneratedPower + + + kilowatt + REAL_MEASURE + + + en + The amount of power, which can be regenerated continuously, within the bounds of normal operation, in kilowatts. + + + + + + + + + maxValue + + + en + Max Value + + + urn:samm:io.catenax.electric_drive.electric_drive_passport:2.0.0#maxValue + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Max Value + + + + + en + maxValue + + + REAL_MEASURE + + + en + The maximum value in kilowatts for a specified time period. + + + + + + + + + maximumAvailability + + + en + Maximum Availability + + + urn:samm:io.catenax.transmission.transmission_pass:3.0.0#maximumAvailability + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Maximum Availability + + + + + en + maximumAvailability + + + INTEGER_COUNT + + + en + Specified time period for the peak measurement in seconds. + + + + + + + + + maximumRegeneratedPower + + + en + Maximum Regenerated Power + + + urn:samm:io.catenax.electric_drive.electric_drive_passport:2.0.0#maximumRegeneratedPower + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Maximum Regenerated Power + + + + + en + maximumRegeneratedPower + + + STRING + + + en + The maximum possible value that can be regenerated at a given time in kilowatts. + + + + + + + + + continuousPower + + + en + Continuous Power + + + urn:samm:io.catenax.transmission.transmission_pass:3.0.0#continuousPower + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Continuous Power + + + + + en + continuousPower + + + kilowatt + INTEGER_COUNT + + + en + The power that can be delivered without time limit. + + + + + + + + + power + + + en + Power + + + urn:samm:io.catenax.electric_drive.electric_drive_passport:2.0.0#power + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Power + + + + + en + power + + + STRING + + + en + Technical power figures in kilowatt. + + + + + + + + + torqueValue + + + en + Torque Value + + + urn:samm:io.catenax.electric_drive.electric_drive_passport:2.0.0#torqueValue + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Torque Value + + + + + en + torqueValue + + + newtonMetre + INTEGER_MEASURE + + + en + Measured torque value in newton metre. + + + + + + + + + maximumAvailability + + + en + Maximum Availability + + + urn:samm:io.catenax.transmission.transmission_pass:3.0.0#maximumAvailability + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Maximum Availability + + + + + en + maximumAvailability + + + INTEGER_COUNT + + + en + Specified time period for the peak measurement in seconds. + + + + + + + + + maximumTorque + + + en + Maximum Torque + + + urn:samm:io.catenax.electric_drive.electric_drive_passport:2.0.0#maximumTorque + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Maximum Torque + + + + + en + maximumTorque + + + STRING + + + en + The maximum torque the system delivers over a specific measurement time period. + + + + + + + + + torqueValue + + + en + Torque Value + + + urn:samm:io.catenax.electric_drive.electric_drive_passport:2.0.0#torqueValue + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Torque Value + + + + + en + torqueValue + + + INTEGER_MEASURE + + + en + Measured torque value in newton metre. + + + + + + + + + maximumAvailability + + + en + Maximum Availability + + + urn:samm:io.catenax.transmission.transmission_pass:3.0.0#maximumAvailability + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Maximum Availability + + + + + en + maximumAvailability + + + INTEGER_COUNT + + + en + Specified time period for the peak measurement in seconds. + + + + + + + + + maximumAxleTorque + + + en + Maximum Axle Torque + + + urn:samm:io.catenax.electric_drive.electric_drive_passport:2.0.0#maximumAxleTorque + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Maximum Axle Torque + + + + + en + maximumAxleTorque + + + STRING + + + en + Maximum motor torque multiplied by the gear ratio. + + + + + + + + + continuousTorque + + + en + Continuous Torque + + + urn:samm:io.catenax.transmission.transmission_pass:3.0.0#continuousTorque + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Continuous Torque + + + + + en + continuousTorque + + + newtonMetre + INTEGER_COUNT + + + en + The torque that can be delivered without time limit in newton meters. + + + + + + + + + torque + + + en + Torque + + + urn:samm:io.catenax.electric_drive.electric_drive_passport:2.0.0#torque + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Torque + + + + + en + torque + + + STRING + + + en + Technical torque figures. + + + + + + + + + gearRatio + + + en + Gear Ratio + + + urn:samm:io.catenax.electric_drive.electric_drive_passport:2.0.0#gearRatio + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Gear Ratio + + + + + en + gearRatio + + + revolutionPerMinute + REAL_MEASURE + + + en + Gear ratio calculated by dividing the angular or rotational speed of the output shaft by the angular speed of the input shaft. It can also be calculated by dividing the total driving gear’s teeth by the total driven gear’s teeth. + + + + + + + + + systemAndPerformance + + + en + System and Performance + + + urn:samm:io.catenax.electric_drive.electric_drive_passport:2.0.0#systemAndPerformance + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + System and Performance + + + + + en + systemAndPerformance + + + STRING + + + en + System and Performance information of the entire eDrive system. + + + + + + + + + transmissionId + + + en + Transmission Id + + + urn:samm:io.catenax.electric_drive.electric_drive_passport:2.0.0#transmissionId + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Transmission Id + + + + + en + transmissionId + + + STRING + + + en + Transmission ID of the transmission i.e. serial number allowing for unequivocal identification of the transmission. + + + + + + + + + gearboxStructure + + + en + Gearbox Structure + + + urn:samm:io.catenax.electric_drive.electric_drive_passport:2.0.0#gearboxStructure + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Gearbox Structure + + + + + en + gearboxStructure + + + STRING + + + en + Short description of the gearbox design, e.g. layshaft or planetary, depending on the technical design of the car. + + + + + + + + + oilCapacity + + + en + Oil Capacity + + + urn:samm:io.catenax.transmission.transmission_pass:3.0.0#oilCapacity + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Oil Capacity + + + + + en + oilCapacity + + + cubicDecimetre + REAL_MEASURE + + + en + The defined oil volume in the transmission in cubic decimeters. + + + + + + + + + oilType + + + en + Oil Type + + + urn:samm:io.catenax.transmission.transmission_pass:3.0.0#oilType + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Oil Type + + + + + en + oilType + + + STRING + + + en + The type of the oil for the transmission defined by the manufacturer of the transmission. + + + + + + + + + oil + + + en + Oil + + + urn:samm:io.catenax.transmission.transmission_pass:3.0.0#oil + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Oil + + + + + en + oil + + + STRING + + + en + The oil used for the transmission. + + + + + + + + + transmission + + + en + Transmission + + + urn:samm:io.catenax.electric_drive.electric_drive_passport:2.0.0#transmission + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Transmission + + + + + en + transmission + + + STRING + + + en + Information about the transmission built into the eDrive, including technical data. + + + + + + + + + content + + + en + Content + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Content + + + + + en + content + + + STRING + + + en + The content of the document e.g a link. + + + + + + + + + contentType + + + en + Content Type + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Content Type + + + + + en + contentType + + + STRING + + + en + The type of content which can be expected in the "content" property. Examples are a link, restricted link, pdf, excel, etc. + + + + + + + + + header + + + en + Header + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Header + + + + + en + header + + + STRING + + + en + The header as a short description of the document with a maximum of 100 characters. + + + + + + + + + technicalDismantlingInstructions + + + en + Technical Dismantling Instructions + + + urn:samm:io.catenax.electric_drive.electric_drive_passport:2.0.0#technicalDismantlingInstructions + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Technical Dismantling Instructions + + + + + en + technicalDismantlingInstructions + + + STRING + + + en + Document containing information and instructions, including steps, diagrams and illustrations of removing or replacing the eDrive or dismantling it. + + + + + + + + + content + + + en + Content + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Content + + + + + en + content + + + STRING + + + en + The content of the document e.g a link. + + + + + + + + + contentType + + + en + Content Type + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Content Type + + + + + en + contentType + + + STRING + + + en + The type of content which can be expected in the "content" property. Examples are a link, restricted link, pdf, excel, etc. + + + + + + + + + header + + + en + Header + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Header + + + + + en + header + + + STRING + + + en + The header as a short description of the document with a maximum of 100 characters. + + + + + + + + + requiredToolsForDismantling + + + en + Required Tools For Dismantling + + + urn:samm:io.catenax.electric_drive.electric_drive_passport:2.0.0#requiredToolsForDismantling + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Required Tools For Dismantling + + + + + en + requiredToolsForDismantling + + + STRING + + + en + Document containing information and instructions for required tools or technologies pertaining to the removal, replacement or dismantling of the eDrive. + + + + + + + + + electricDriveDocuments + + + en + Electric Drive Documents + + + urn:samm:io.catenax.electric_drive.electric_drive_passport:2.0.0#electricDriveDocuments + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Electric Drive Documents + + + + + en + electricDriveDocuments + + + STRING + + + en + Documents pertaining to the removal, replacement, disassembly or dismantling of the entire eDrive. + + + + + + + + + productSpecificParameters + + + en + Product Specific Parameters + + + urn:samm:io.catenax.electric_drive.electric_drive_passport:2.0.0#productSpecificParameters + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Product Specific Parameters + + + + + en + productSpecificParameters + + + STRING + + + en + Product specific parameters of the electric drive. + + + + + + + + + version + + + en + Version + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#version + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Version + + + + + en + version + + + STRING + + + en + The current version of the product passport. The possibility of modification/ updating the product passport needs to include versioning of the dataset. This attribute is an internal versioning from the passport issuer. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Article 8: +(1) [...] The information in the product passport shall be accurate, complete, and up to date. + + + + + + + + + status + + + en + Status + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#status + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Status + + + + + en + status + + + STRING + + + en + The current status of the product passport declared through either: draft, approved, invalid or expired. + + + + + + draft + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#StatusEnumeration:draft + + + + + + approved + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#StatusEnumeration:approved + + + + + + invalid + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#StatusEnumeration:invalid + + + + + + expired + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#StatusEnumeration:expired + + + + + + + + + + + + + expirationDate + + + en + Expiration Date + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#expirationDate + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Expiration Date + + + + + en + expirationDate + + + STRING + + + en + The timestamp in the format (yyyy-mm-dd) for the product passport until when it is available or a comment describing this period. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Article 8: +(2) (h) the period during which the product passport is to remain available, which shall correspond to at least the expected lifetime of a specific product. + + + + + + + + + issueDate + + + en + Issue Date + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#issueDate + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Issue Date + + + + + en + issueDate + + + STRING + + + en + The timestamp in the format (yyyy-mm-dd) since when the product passport is available. + + + + + + + + + economicOperatorId + + + en + Economic Operator Id + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#economicOperatorId + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Economic Operator Id + + + + + en + economicOperatorId + + + STRING + + + en + The identification of the owner/economic operator of the passport. Proposed, according to ISO 15459, is the CIN (company identification code). Other identification numbers like the tax identification number, value added tax identification number, commercial register number and the like are also valid entries. In the Catena-X network, the BPNL is used for the identification of companies and the information stored like contact information and addresses. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Annex III: +(k) the [...] unique operator identifier code of the economic operator established in the Union responsible for carrying out the tasks set out in Article 4 of Regulation (EU) 2019/1020, or Article 15 of Regulation (EU) on general product safety, or similar tasks pursuant to other EU legislation applicable to the product. + + + + + + + + + passportIdentifier + + + en + Passport Identifier + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#passportIdentifier + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Passport Identifier + + + + + en + passportIdentifier + + + STRING + + + en + The identifier of the product passport, which is an uuidv4. + + + + + + + + + predecessor + + + en + Predecessor + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#predecessor + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Predecessor + + + + + en + predecessor + + + STRING + + + en + Identification of the preceding product passport. If there is no preceding passport, input a dummy value. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Article 8: +(2)(g) [...] Any new product passport shall be linked to the product passport or passports of the original product whenever appropriate. + + + + + + + + + backupReference + + + en + Backup Reference + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#backupReference + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Backup Reference + + + + + en + backupReference + + + STRING + + + en + A reference to the data backup of the passport. This mandatory attribute will be further defined in the future. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex III: +(kb) the reference of the certified independent third-party product passport service provider hosting the back-up copy of the product passport. +Article 10 also mentions: +(c) the data included in the product passport shall be stored by the economic operator responsible for its creation or by certified independent third-party product passport service providers authorised to act on their behalf. + + + + + + + + + registrationIdentifier + + + en + Registration Identifier + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#registrationIdentifier + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Registration Identifier + + + + + en + registrationIdentifier + + + STRING + + + en + Identifier in the respective registry. This will be further defined in the future. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 in Article 12: +By [2 years from entering into force of this Regulation], the Commission shall set up and manage a digital registry ("the registry") storing in a secure manner at least the unique product identifier, the unique operator identifier, the unique facility identifiers. In case of products intended to be placed under the customs procedure 'release for free circulation', the registry shall also store the product commodity code. The registry shall also store the batteries' unique identifiers referred to in Article 77(3) of Regulation (EU) 2023/1542. + + + + + + + + + lastModification + + + en + Last Modification + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#lastModification + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Last Modification + + + + + en + lastModification + + + STRING + + + en + Date of the latest modification. + + + + + + + + + metadata + + + en + Metadata + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#metadata + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Metadata + + + + + en + metadata + + + STRING + + + en + Metadata of the product passport. These are mentioned in the ESPR proposal from March 30th, 2022 and some changed by the provisional agreement from January 9th, 2024. + + + + + + + + + key + + + en + Identifier Key + + + urn:samm:io.catenax.serial_part:3.0.0#key + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Identifier Key + + + + + en + key + + + STRING + + + en + The key of a local identifier. + + + + + + + + + value + + + en + Identifier Value + + + urn:samm:io.catenax.serial_part:3.0.0#value + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Identifier Value + + + + + en + value + + + STRING + + + en + The value of an identifier. + + + + + + + + + serialInformation + + + en + Serial Information + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#serialInformation + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Serial Information + + + + + en + serialInformation + + + STRING + + + en + Identifier for a serial part if available. This is mentioned in the ESPR provisional agreement from January 9th, 2024 Recital (27): +[...] an 'item' usually means a single unit of a model. + + + + + + + + + key + + + en + Identifier Key + + + urn:samm:io.catenax.batch:3.0.0#key + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Identifier Key + + + + + en + key + + + STRING + + + en + The key of a local identifier. + + + + + + + + + value + + + en + Identifier Value + + + urn:samm:io.catenax.batch:3.0.0#value + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Identifier Value + + + + + en + value + + + STRING + + + en + The value of an identifier. + + + + + + + + + batchInformation + + + en + Batch Information + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#batchInformation + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Batch Information + + + + + en + batchInformation + + + STRING + + + en + Identifier for a batch part if available. Identifier for a serial part if available. This is mentioned in the ESPR provisional agreement from January 9th, 2024 Recital (27): +[...] a 'batch' usually means a subset of a specific model composed of all products produced in a specific manufacturing plant at a specific moment in time [...]. + + + + + + + + + manufacturerPartId + + + en + Manufacturer Part ID + + + urn:samm:io.catenax.part_type_information:1.0.0#manufacturerPartId + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Manufacturer Part ID + + + + + en + manufacturerPartId + + + STRING + + + en + Part ID as assigned by the manufacturer of the part. The part ID identifies the part in the manufacturer`s dataspace. The part ID references a specific version of a part. The version number must be included in the part ID if it is available. The part ID does not reference a specific instance of a part and must not be confused with the serial number. + + + + + + + + + nameAtManufacturer + + + en + Name at manufacturer + + + urn:samm:io.catenax.part_type_information:1.0.0#nameAtManufacturer + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Name at manufacturer + + + + + en + nameAtManufacturer + + + STRING + + + en + Name of the part as assigned by the manufacturer. + + + + + + + + + partTypeInformation + + + en + Part Type Information + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#partTypeInformation + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Part Type Information + + + + + en + partTypeInformation + + + STRING + + + en + Identifier on the level of a part model or type. Identifier for a serial part if available. This is mentioned in the ESPR provisional agreement from January 9th, 2024 Recital (27): +[...] A 'model' usually means a version of a product of which all units share the same technical characteristics relevant for the ecodesign requirements and the same model identifier [...]. + + + + + + + + + codeKey + + + en + Code Key + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#codeKey + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Code Key + + + + + en + codeKey + + + STRING + + + en + The code key for the identification of the product. Examples are GTIN, hash, DID, ISBN, TARIC. This attribute is mentioned in the ESPR proposal from March 30th, 2022 ANNEX III: +(b) the unique product identifier at the level indicated in the applicable delegated act adopted pursuant to Article 4; +(c) the Global Trade Identification Number as provided for in standard ISO/IEC 15459-6 or equivalent of products or their parts; +(d) relevant commodity codes, such as a TARIC code as defined in Council Regulation (EEC) No 2658/87. + + + + + + + + + codeValue + + + en + Code Value + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#codeValue + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Code Value + + + + + en + codeValue + + + STRING + + + en + The code value for the identification of the product in regard to the chosen code name. + + + + + + + + + codes + + + en + Codes + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#codes + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Codes + + + + + en + codes + + + STRING + + + en + Codes for identification. + + + + + + + + + carrierType + + + en + Carrier Type + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#carrierType + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Carrier Type + + + + + en + carrierType + + + STRING + + + en + The type of data carrier such as a QR code on the product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 8: +(2) (b) the types of data carrier to be used. + + + + + + + + + carrierLayout + + + en + Carrier Layout + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#carrierLayout + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Carrier Layout + + + + + en + carrierLayout + + + STRING + + + en + The positioning of data carrier on the product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 8: +(2) (c) the layout in which the data carrier shall be presented and its positioning. + + + + + + + + + dataCarrier + + + en + Data Carrier + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#dataCarrier + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Data Carrier + + + + + en + dataCarrier + + + STRING + + + en + The type and layout of the data carrier on the product. These are mentioned in the ESPR proposal from March 30th, 2022 Article 8: +(b) the types of data carrier to be used; +(c) the layout in which the data carrier shall be presented and its positioning; +Article 2 defines: +(30) 'data carrier' means a linear bar code symbol, a two-dimensional symbol or other automatic identification data capture medium that can be read by a device. + + + + + + + + + classificationStandard + + + en + Classification Standard + + + urn:samm:io.catenax.shared.part_classification:1.0.0#classificationStandard + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Classification Standard + + + + + en + classificationStandard + + + STRING + + + en + Identified classification standards that align to the Catena-X needs. + + + + + + + + + classificationID + + + en + Classification ID + + + urn:samm:io.catenax.shared.part_classification:1.0.0#classificationID + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Classification ID + + + + + en + classificationID + + + STRING + + + en + The classification ID of the part type according to the corresponding standard definition mentioned in the key value pair. + + + + + + + + + classificationDescription + + + en + Classification Description + + + urn:samm:io.catenax.shared.part_classification:1.0.0#classificationDescription + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Classification Description + + + + + en + classificationDescription + + + STRING + + + en + Optional property describing the classification standard. + + + + + + + + + partClassification + + + en + Part Classification + + + urn:samm:io.catenax.shared.part_classification:1.0.0#partClassification + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Part Classification + + + + + en + partClassification + + + STRING + + + en + Property describing the classification of a part. + + + + + + + + + identification + + + en + Identification + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#identification + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Identification + + + + + en + identification + + + STRING + + + en + Identification information of the product, especially identifiers and codes. These are mentioned in the ESPR provisional agreement from January 9th, 2024 ANNEX III: +(b) the unique product identifier at the level indicated in the applicable delegated act adopted pursuant to Article 4. +Additionally in Article 9 regarding general requirements for the product passport is stated that: +A product passport shall meet the following conditions: +(a) it shall be connected through a data carrier to a persistent unique product identifier; +(e) the information included in the product passport shall refer to the product model, batch, or item as specified in the delegated act adopted pursuant to Article 4. +Article 2 Definitions: +(31) 'unique product identifier' means a unique string of characters for the identification of products that also enables a web link to the product passport; +Recital (27): A 'model' usually means a version of a product of which all units share the same technical characteristics relevant for the ecodesign requirements and the same model identifier, a 'batch' usually means a subset of a specific model composed of all products produced in a specific manufacturing plant at a specific moment in time and an 'item' usually means a single unit of a model. + + + + + + + + + facility + + + en + Facility + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#facility + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Facility + + + + + en + facility + + + STRING + + + en + The identifier used for a location. This attribute is mentioned in the ESPR provisional agreement from January 9th 2024 Annex III: +(i) unique facility identifiers; +Article 2 Definitions: (33) 'unique facility identifier' means a unique string of characters for the identification of locations or buildings involved in the value chain of a product or used by actors involved in the value chain of a product. + + + + + + + + + facilityIdentification + + + en + Facility Identification + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#facilityIdentification + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Facility Identification + + + + + en + facilityIdentification + + + STRING + + + en + The identifier used for a location. In the CATENA-X use case, the BPNA can be stated. This attribute is mentioned in the ESPR provisional agreement from January 9th 2024 Annex III: +(i) unique facility identifiers; +Article 2 Definitions: (33) 'unique facility identifier' means a unique string of characters for the identification of locations or buildings involved in the value chain of a product or used by actors involved in the value chain of a product. + + + + + + + + + manufacturerIdentification + + + en + Manufacturer Identification + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#manufacturerIdentification + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Manufacturer Identification + + + + + en + manufacturerIdentification + + + STRING + + + en + The main manufacturer, if different from the passport owner, represented by an identification number. In the Catena-X use case, the BPNL can be stated. This attribute is mentioned in the ESPR provisional agreement from January 9th 2024 Annex III: +(h) unique operator identifiers other than that of the manufacturer; +(k) the name, contact details and unique operator identifier code of the economic operator established in the Union responsible for carrying out the tasks set out in Article 4 of Regulation (EU) 2019/1020, or Article 15 of Regulation (EU) [.../...] on general product safety, or similar tasks pursuant to other EU legislation applicable to the product. + + + + + + + + + manufacturingDate + + + en + Manufacturing Date + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#manufacturingDate + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Manufacturing Date + + + + + en + manufacturingDate + + + STRING + + + en + The timestamp in the format (yyyy-mm-dd) of the manufacturing date as the final step in production process (e.g. final quality check, ready-for-shipment event). + + + + + + + + + manufacturer + + + en + Manufacturer + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#manufacturer + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Manufacturer + + + + + en + manufacturer + + + STRING + + + en + Manufacturing information of the product. In the CATENA-X use case, the BPNL and BPNA can be stated. These attributes are mentioned in the ESPR provisional agreement from January 9th 2024 Annex III: +(h) unique operator identifiers other than that of the manufacturer; +(k) the name, contact details and unique operator identifier code of the economic operator established in the Union responsible for carrying out the tasks set out in Article 4 of Regulation (EU) 2019/1020, or Article 15 of Regulation (EU) [.../...] on general product safety, or similar tasks pursuant to other EU legislation applicable to the product. + + + + + + + + + eori + + + en + EORI + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#eori + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + EORI + + + + + en + eori + + + STRING + + + en + An economic operator established in the customs territory of the Union needs, for customs purposes, an EORI number. EORI stands for economic operators registration and identification number. In this case, the importer's EORI must be provided. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Annex III: +(j) information related to the importer, including the information referred to in Article 23(3) and its EORI number. + + + + + + + + + importerIdentification + + + en + Importer Identification + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#importerIdentification + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Importer Identification + + + + + en + importerIdentification + + + STRING + + + en + The importer of the product, if different from the owner of the passport. In the Catena-X network, the BPNL is used for the identification of companies and the information stored for this like contact information and addresses. +This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex III: +(j) information related to the importer, including the information referred to in Article 23(3) and its EORI number; +Article 23 states: +(3) Importers shall, for products covered by a delegated act adopted pursuant to Article 4, indicate their name, registered trade name or registered trade mark and the postal address and electronic means of communication, where they can be contacted: (a) on the public part of the product passport, when applicable, and +(b) on the product or, where this is not possible, on the packaging, or in a document accompanying the product. + + + + + + + + + importer + + + en + Importer + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#importer + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Importer + + + + + en + importer + + + STRING + + + en + Information regarding the importer of the product, if different from the owner of the passport. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex III: +(j) information related to the importer, including the information referred to in Article 23(3) and its EORI number; +Article 23 states: +(3) Importers shall, for products covered by a delegated act adopted pursuant to Article 4, indicate their name, registered trade name or registered trade mark and the postal address and electronic means of communication, where they can be contacted: (a) on the public part of the product passport, when applicable, and +(b) on the product or, where this is not possible, on the packaging, or in a document accompanying the product. + + + + + + + + + applicable + + + en + Applicable + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#applicable + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Applicable + + + + + en + applicable + + + BOOLEAN + + + en + Check whether the connected attributes are applicable to the product. If it is not applicable (false), dummy data can be delivered. + + + + + + + + + import + + + en + Import + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#import + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Import + + + + + en + import + + + STRING + + + en + Importer details such as the identification. + + + + + + + + + otherOperatorId + + + en + Other Operator Id + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#otherOperatorId + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Other Operator Id + + + + + en + otherOperatorId + + + STRING + + + en + Identifier of the other operator. This can be a BPN. + + + + + + + + + otherOperatorRole + + + en + Other Operator Role + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#otherOperatorRole + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Other Operator Role + + + + + en + otherOperatorRole + + + STRING + + + en + Role of the other operator. + + + + + + + + + otherOperators + + + en + Other Operators + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#otherOperators + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Other Operators + + + + + en + otherOperators + + + STRING + + + en + Other operators relevant for the product. + + + + + + + + + operation + + + en + Operation + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#operation + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Operation + + + + + en + operation + + + STRING + + + en + Operational information of the product. + + + + + + + + + sourcesIdentification + + + en + Sources Identification + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#sourcesIdentification + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Sources Identification + + + + + en + sourcesIdentification + + + STRING + + + en + The identifier of a spare part producer of the product. In the Catena-X network, the BPNL is used for the identification of companies and the information stored for this like contact information and addresses. + + + + + + + + + sparePartSources + + + en + Spare Part Sources + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#sparePartSources + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Spare Part Sources + + + + + en + sparePartSources + + + STRING + + + en + Sources of possible spare parts. + + + + + + + + + manufacturerPartId + + + en + Manufacturer Part ID + + + urn:samm:io.catenax.part_type_information:1.0.0#manufacturerPartId + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Manufacturer Part ID + + + + + en + manufacturerPartId + + + STRING + + + en + Part ID as assigned by the manufacturer of the part. The part ID identifies the part in the manufacturer`s dataspace. The part ID references a specific version of a part. The version number must be included in the part ID if it is available. The part ID does not reference a specific instance of a part and must not be confused with the serial number. + + + + + + + + + nameAtManufacturer + + + en + Name at manufacturer + + + urn:samm:io.catenax.part_type_information:1.0.0#nameAtManufacturer + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Name at manufacturer + + + + + en + nameAtManufacturer + + + STRING + + + en + Name of the part as assigned by the manufacturer. + + + + + + + + + sparePart + + + en + Spare Part + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#sparePart + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Spare Part + + + + + en + sparePart + + + STRING + + + en + Possible spare parts of the product. + + + + + + + + + spareParts + + + en + spareParts + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#spareParts + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + spareParts + + + + + en + spareParts + + + STRING + + + en + The list of spare parts available for the product from various suppliers. + + + + + + + + + applicable + + + en + Applicable + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#applicable + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Applicable + + + + + en + applicable + + + BOOLEAN + + + en + Check whether the connected attributes are applicable to the product. If it is not applicable (false), dummy data can be delivered. + + + + + + + + + handling + + + en + handling + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#handling + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + handling + + + + + en + handling + + + STRING + + + en + Properties connected with the handling of the product. + + + + + + + + + lifeUnit + + + en + Life Unit + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#lifeUnit + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Life Unit + + + + + en + lifeUnit + + + STRING + + + en + The unit of the respective lifespan expressed through the possible units day, month, cycle, year and runningOrOperatingHour. + + + + + + unit:day + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#LifeEnumeration:unit:day + + + + + + unit:month + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#LifeEnumeration:unit:month + + + + + + unit:year + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#LifeEnumeration:unit:year + + + + + + unit:cycle + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#LifeEnumeration:unit:cycle + + + + + + unit:runningOrOperatingHour + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#LifeEnumeration:unit:runningOrOperatingHour + + + + + + + + + + + + + lifeValue + + + en + Life Value + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#lifeValue + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Life Value + + + + + en + lifeValue + + + INTEGER_MEASURE + + + en + The value as an integer for the respective lifespan. + + + + + + + + + lifeType + + + en + Life Type + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#lifeType + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Life Type + + + + + en + lifeType + + + STRING + + + en + The type of lifespan represented with the values guaranteed lifetime, technical lifetime and mean time between failures. This attribute is mentioned in the ESPR proposal from March 30th, 2022 ANNEX I: +(a) durability and reliability of the product or its components as expressed through the product's guaranteed lifetime, technical lifetime [or] mean time between failures [...]. + + + + + + guaranteed lifetime + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#LifeTypeEnumeration:guaranteed lifetime + + + + + + technical lifetime + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#LifeTypeEnumeration:technical lifetime + + + + + + mean time between failures + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#LifeTypeEnumeration:mean time between failures + + + + + + + + + + + + + lifespan + + + en + Lifespan + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#lifespan + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Lifespan + + + + + en + lifespan + + + STRING + + + en + The type of lifespan represented with the values guaranteed lifetime, technical lifetime and mean time between failures. Both can be described through the attributes: type, which defines the type such as guaranteed lifetime or technical lifetime, the unit for the lifetime, and the value represented by an integer. These attributes are mentioned in the ESPR proposal from March 30th, 2022 ANNEX I: +(a) durability and reliability of the product or its components as expressed through the products guaranteed lifetime, technical lifetime [or] mean time between failures [...]. + + + + + + + + + quantityValue + + + en + Quantity Value + + + urn:samm:io.catenax.shared.quantity:2.0.0#quantityValue + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Quantity Value + + + + + en + quantityValue + + + REAL_MEASURE + + + en + The quantity value associated with the unit. + + + + + + + + + linearUnit + + + en + Linear Unit + + + urn:samm:io.catenax.shared.quantity:2.0.0#linearUnit + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Linear Unit + + + + + en + linearUnit + + + STRING + + + en + The unit of a linear attribute. + + + + + + unit:millimetre + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#LinearUnitEnumeration:unit:millimetre + + + + + + unit:centimetre + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#LinearUnitEnumeration:unit:centimetre + + + + + + unit:metre + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#LinearUnitEnumeration:unit:metre + + + + + + unit:kilometre + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#LinearUnitEnumeration:unit:kilometre + + + + + + unit:inch + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#LinearUnitEnumeration:unit:inch + + + + + + unit:foot + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#LinearUnitEnumeration:unit:foot + + + + + + unit:yard + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#LinearUnitEnumeration:unit:yard + + + + + + + + + + + + + width + + + en + Width + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#width + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Width + + + + + en + width + + + STRING + + + en + The width of the item measured in a specific linear unit which can be declared in the corresponding unit attribute. + + + + + + + + + quantityValue + + + en + Quantity Value + + + urn:samm:io.catenax.shared.quantity:2.0.0#quantityValue + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Quantity Value + + + + + en + quantityValue + + + REAL_MEASURE + + + en + The quantity value associated with the unit. + + + + + + + + + linearUnit + + + en + Linear Unit + + + urn:samm:io.catenax.shared.quantity:2.0.0#linearUnit + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Linear Unit + + + + + en + linearUnit + + + STRING + + + en + The unit of a linear attribute. + + + + + + + + + length + + + en + Length + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#length + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Length + + + + + en + length + + + STRING + + + en + The length of the item measured in a specific linear unit which can be declared in the corresponding unit attribute. + + + + + + + + + quantityValue + + + en + Quantity Value + + + urn:samm:io.catenax.shared.quantity:2.0.0#quantityValue + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Quantity Value + + + + + en + quantityValue + + + REAL_MEASURE + + + en + The quantity value associated with the unit. + + + + + + + + + linearUnit + + + en + Linear Unit + + + urn:samm:io.catenax.shared.quantity:2.0.0#linearUnit + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Linear Unit + + + + + en + linearUnit + + + STRING + + + en + The unit of a linear attribute. + + + + + + + + + diameter + + + en + Diameter + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#diameter + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Diameter + + + + + en + diameter + + + STRING + + + en + The diameter of the item, if applicable, measured in a specific linear unit which can be declared in the corresponding unit attribute. + + + + + + + + + quantityValue + + + en + Quantity Value + + + urn:samm:io.catenax.shared.quantity:2.0.0#quantityValue + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Quantity Value + + + + + en + quantityValue + + + REAL_MEASURE + + + en + The quantity value associated with the unit. + + + + + + + + + linearUnit + + + en + Linear Unit + + + urn:samm:io.catenax.shared.quantity:2.0.0#linearUnit + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Linear Unit + + + + + en + linearUnit + + + STRING + + + en + The unit of a linear attribute. + + + + + + + + + height + + + en + Height + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#height + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Height + + + + + en + height + + + STRING + + + en + The height of the item measured in a specific linear unit which can be declared in the corresponding unit attribute. + + + + + + + + + quantityValue + + + en + Quantity Value + + + urn:samm:io.catenax.shared.quantity:2.0.0#quantityValue + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Quantity Value + + + + + en + quantityValue + + + REAL_MEASURE + + + en + The quantity value associated with the unit. + + + + + + + + + massUnit + + + en + Mass Unit + + + urn:samm:io.catenax.shared.quantity:2.0.0#massUnit + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Mass Unit + + + + + en + massUnit + + + STRING + + + en + The unit of a mass related attribute. + + + + + + + + + grossWeight + + + en + Gross Weight + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#grossWeight + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Gross Weight + + + + + en + grossWeight + + + STRING + + + en + The gross weight of the item measured in a specific mass unit which can be declared in the corresponding unit attribute. Gross weight refers to the total weight of a product, including the weight of the packaging. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7: +(2) (b) (i) information on the performance of the product in relation to the product parameters referred to in Annex I; +Annex I (i) weight and volume of the product and its packaging, and the product-to-packaging ratio. + + + + + + + + + quantityValue + + + en + Quantity Value + + + urn:samm:io.catenax.shared.quantity:2.0.0#quantityValue + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Quantity Value + + + + + en + quantityValue + + + REAL_MEASURE + + + en + The quantity value associated with the unit. + + + + + + + + + volumeUnit + + + en + Volume Unit + + + urn:samm:io.catenax.shared.quantity:2.0.0#volumeUnit + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Volume Unit + + + + + en + volumeUnit + + + STRING + + + en + The unit of a volume related attribute. + + + + + + unit:cubicMetre + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#VolumeUnitEnumeration:unit:cubicMetre + + + + + + unit:litre + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#VolumeUnitEnumeration:unit:litre + + + + + + unit:millilitre + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#VolumeUnitEnumeration:unit:millilitre + + + + + + unit:cubicCentimetre + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#VolumeUnitEnumeration:unit:cubicCentimetre + + + + + + unit:cubicInch + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#VolumeUnitEnumeration:unit:cubicInch + + + + + + unit:cubicFoot + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#VolumeUnitEnumeration:unit:cubicFoot + + + + + + unit:cubicYard + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#VolumeUnitEnumeration:unit:cubicYard + + + + + + unit:hectolitre + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#VolumeUnitEnumeration:unit:hectolitre + + + + + + + + + + + + + grossVolume + + + en + Gross Volume + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#grossVolume + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Gross Volume + + + + + en + grossVolume + + + STRING + + + en + The gross volume of the item, if possible, measured in a specific capacity unit which can be declared in the corresponding unit attribute. If there is no separate packing, the volume of the product shall be given. Gross volume refers to the total volume of a product, including the volume of the packaging. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7: +(2) (b) (i) information on the performance of the product in relation to the product parameters referred to in Annex I; +Annex I (i) weight and volume of the product and its packaging, and the product-to-packaging ratio. + + + + + + + + + quantityValue + + + en + Quantity Value + + + urn:samm:io.catenax.shared.quantity:2.0.0#quantityValue + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Quantity Value + + + + + en + quantityValue + + + REAL_MEASURE + + + en + The quantity value associated with the unit. + + + + + + + + + massUnit + + + en + Mass Unit + + + urn:samm:io.catenax.shared.quantity:2.0.0#massUnit + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Mass Unit + + + + + en + massUnit + + + STRING + + + en + The unit of a mass related attribute. + + + + + + + + + weight + + + en + Weight + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#weight + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Weight + + + + + en + weight + + + STRING + + + en + Weight of the product measured in a specific mass unit which can be declared in the corresponding unit attribute. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7: +(2) (b) (i) information on the performance of the product in relation to the product parameters referred to in Annex I; +Annex I (i) weight and volume of the product [...]. + + + + + + + + + quantityValue + + + en + Quantity Value + + + urn:samm:io.catenax.shared.quantity:2.0.0#quantityValue + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Quantity Value + + + + + en + quantityValue + + + REAL_MEASURE + + + en + The quantity value associated with the unit. + + + + + + + + + volumeUnit + + + en + Volume Unit + + + urn:samm:io.catenax.shared.quantity:2.0.0#volumeUnit + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Volume Unit + + + + + en + volumeUnit + + + STRING + + + en + The unit of a volume related attribute. + + + + + + + + + volume + + + en + Volume + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#volume + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Volume + + + + + en + volume + + + STRING + + + en + Volume of the product, if possible, measured in a specific capacity unit which can be declared in the corresponding unit attribute. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7: +(2) (b) (i) information on the performance of the product in relation to the product parameters referred to in Annex I; +Annex I (i) weight and volume of the product [...]. + + + + + + + + + physicalDimension + + + en + Physical Dimension + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#physicalDimension + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Physical Dimension + + + + + en + physicalDimension + + + STRING + + + en + Physical dimensions are properties associated with physical quantities for purposes of classification or differentiation. These attributes are mentioned in the ESPR provisional agreement from January 9th, Article 7: +(2) (b) (i) information on the performance of the product in relation to one or more of the product parameters referred to in Annex I; +Annex I (i) weight and volume of the product and its packaging, and the product-to-packaging ratio. + + + + + + + + + physicalState + + + en + Physical State + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#physicalState + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Physical State + + + + + en + physicalState + + + STRING + + + en + The physical state of the item. There are four states of matter solid, liquid, gas and plasma which can be chosen from an enumeration. + + + + + + solid + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#PhysicalStateEnumeration:solid + + + + + + liquid + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#PhysicalStateEnumeration:liquid + + + + + + gas + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#PhysicalStateEnumeration:gas + + + + + + plasma + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#PhysicalStateEnumeration:plasma + + + + + + + + + + + + + generalPerformanceClass + + + en + General Performance Class + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#generalPerformanceClass + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + General Performance Class + + + + + en + generalPerformanceClass + + + STRING + + + en + The performance class of the product. This attribute is mentioned ESPR provisional agreement from January 9th, 2024 Article 7: +4. When establishing the information requirements referred to in paragraph 2, point (b), point (i), the Commission shall, as appropriate in view of the specificity of the product group, determine classes of performance. Classes of performance may be based on single parameters, on aggregated scores, in absolute terms or in any other form that enables potential customers to choose the best performing products. Those classes of performance shall correspond to significant improvements in performance levels. Where classes of performance are based on parameters in relation to which performance requirements are established, they shall use as the minimum level the minimum performance required at the time when the classes of performance start to apply. +Definition: +'class of performance': means a range of performance levels in relation to one or more product parameters referred to in Annex I, based on a common methodology for the product or product group, ordered into successive steps to allow for product differentiation. + + + + + + + + + characteristics + + + en + Characteristics + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#characteristics + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Characteristics + + + + + en + characteristics + + + STRING + + + en + Defines specific characteristics of a product. + + + + + + + + + placedOnMarket + + + en + Placed on Market + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#placedOnMarket + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Placed on Market + + + + + en + placedOnMarket + + + STRING + + + en + The timestamp in the format (yyyy-mm-dd) with or without time zone when the product was put in the market. + + + + + + + + + purpose + + + en + Purpose + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#purpose + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Purpose + + + + + en + purpose + + + STRING + + + en + One or more intended industry/industries of the product described by the digital product passport. If exchanged via Catena-X, 'automotive ' is a must choice included in the list. + + + + + + + + + commercial + + + en + Commercial + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#commercial + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Commercial + + + + + en + commercial + + + STRING + + + en + Commercial information of the product. + + + + + + + + + applicable + + + en + Applicable + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#applicable + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Applicable + + + + + en + applicable + + + BOOLEAN + + + en + Check whether the connected attributes are applicable to the product. If it is not applicable (false), dummy data can be delivered. + + + + + + + + + location + + + en + Location + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#location + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Location + + + + + en + location + + + STRING + + + en + The location of the substances of concern within the product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7: +(5) (b) the location of the substances of concern within the product. + + + + + + + + + materialUnit + + + en + Material Unit + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#materialUnit + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Material Unit + + + + + en + materialUnit + + + STRING + + + en + The unit of concentration chosen from an enumeration: mass percent, volume percent, parts per thousand, parts per million, parts per billion and parts per trillion. + + + + + + unit:partPerMillion + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#ConcentrationEnumeration:unit:partPerMillion + + + + + + unit:percent + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#ConcentrationEnumeration:unit:percent + + + + + + unit:percentVolume + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#ConcentrationEnumeration:unit:percentVolume + + + + + + unit:partPerThousand + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#ConcentrationEnumeration:unit:partPerThousand + + + + + + unit:partPerTrillionUs + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#ConcentrationEnumeration:unit:partPerTrillionUs + + + + + + unit:partPerBillionUs + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#ConcentrationEnumeration:unit:partPerBillionUs + + + + + + + + + + + + + concentration + + + en + Concentration + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#concentration + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Concentration + + + + + en + concentration + + + REAL_MEASURE + + + en + Concentration of the material at the level of the product. This attribute is specially mentioned for substances of concern mentioned in the ESPR proposal from March 30th, 2022 Article 7: +(5) (c) the concentration, maximum concentration or concentration range of the substances of concern, at the level of the product [...]. +Other substances are mentioned for the purpose of recycling in the ESPR provisional agreement from January 9th, 2024 Annex I: +(d) design for recycling, ease and quality of recycling as expressed through: use of easily recyclable materials, safe, easy and non-destructive access to recyclable components and materials or components and materials containing hazardous substances and material composition and homogeneity, possibility for high-purity sorting, number of materials and components used, use of standard components, use of component and material coding standards for the identification of components and materials, number and complexity of processes and tools needed, ease of nondestructive disassembly and re-assembly, conditions for access to product data, conditions for access to or use of hardware and software needed. + + + + + + + + + + exemption + + + en + Exemption + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#exemption + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Exemption + + + + + en + exemption + + + STRING + + + en + Exemptions to the substance of concern. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Article 7: +(5) (c) provide duly justified exemptions for substances of concern or information elements from the information requirements referred to in the first subparagraph based on the technical feasibility or relevance of tracking substances of concern, the existence of analytical methods to detect and quantify them, the need to protect confidential business information or in other duly justified cases. Substances of concern within the meaning of Article 2(28), point a), shall not be exempted if they are present in products, their relevant components or spare parts in a concentration above 0,1 % weight by weight. + + + + + + + + + hazardCategory + + + en + Hazard Category + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#hazardCategory + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Hazard Category + + + + + en + hazardCategory + + + STRING + + + en + The hazard category of the substance of concern. Defined in Article 2 of Regulation (EC) No 1272/2008 of the European Parliament and of the Council of 16 December 2008 on classification, labelling and packaging of substances and mixtures, amending and repealing Directives 67/548/EEC and 1999/45/EC, and amending Regulation (EC) No 1907/2006: +2. 'hazard category' means the division of criteria within each hazard class, specifying hazard severity. + + + + + + + + + hazardClass + + + en + Hazard Class + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#hazardClass + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Hazard Class + + + + + en + hazardClass + + + STRING + + + en + The hazard class of the substance of concern. Defined in Article 2 of Regulation (EC) No 1272/2008 of the European Parliament and of the Council of 16 December 2008 on classification, labelling and packaging of substances and mixtures, amending and repealing Directives 67/548/EEC and 1999/45/EC, and amending Regulation (EC) No 1907/2006: +1. 'hazard class' means the nature of the physical, health or environmental hazard. + + + + + + + + + hazardStatement + + + en + Hazard Statement + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#hazardStatement + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Hazard Statement + + + + + en + hazardStatement + + + STRING + + + en + The hazard statement of the substance of concern. Defined in Article 2 of Regulation (EC) No 1272/2008 of the European Parliament and of the Council of 16 December 2008 on classification, labelling and packaging of substances and mixtures, amending and repealing Directives 67/548/EEC and 1999/45/EC, and amending Regulation (EC) No 1907/2006: +5. 'hazard statement' means a phrase assigned to a hazard class and category that describes the nature of the hazards of a hazardous substance or mixture, including, where appropriate, the degree of hazard. + + + + + + + + + hazardClassification + + + en + Hazard Classification + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#hazardClassification + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Hazard Classification + + + + + en + hazardClassification + + + STRING + + + en + The specification of the hazard class. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I: +(f) use of substances, and in particular the use of substances of concern, on their own, as constituents of substances or in mixtures, during the production process of products, or leading to their presence in products, including once these products become waste, and their impacts on human health and the environment; +Further defined is this by Regulation (EC) No 1272/2008 of the European Parliament and of the Council of 16 December 2008 on classification, labelling and packaging of substances and mixtures, amending and repealing Directives 67/548/EEC and 1999/45/EC, and amending Regulation (EC) No 1907/2006. +Defined in Article 2: +1. 'hazard class' means the nature of the physical, health or environmental hazard; +2. 'hazard category' means the division of criteria within each hazard class, specifying hazard severity; +5. 'hazard statement' means a phrase assigned to a hazard class and category that describes the nature of the hazards of a hazardous substance or mixture, including, where appropriate, the degree of hazard; + + + + + + + + + minConcentration + + + en + Minimum Concentration + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#minConcentration + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Minimum Concentration + + + + + en + minConcentration + + + REAL_MEASURE + + + en + The minimum concentration of the substance of concern at the level of the product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7: +(5) (c) [...] concentration range of the substances of concern, at the level of the product [...]. + + + + + + + + + maxConcentration + + + en + Maximum Concentration + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#maxConcentration + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Maximum Concentration + + + + + en + maxConcentration + + + REAL_MEASURE + + + en + The maximum concentration of the substance of concern at the level of the product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7: +(5) (c) the concentration, maximum concentration or concentration range of the substances of concern, at the level of the product [...]. + + + + + + + + + concentrationRange + + + en + Concentration Range + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#concentrationRange + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Concentration Range + + + + + en + concentrationRange + + + STRING + + + en + The concentration range for the substance of concern. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7: +(5) (c) [...] concentration range of the substances of concern, at the level of the product [...]. + + + + + + + + + chemicalId + + + en + Chemical Id + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#chemicalId + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Chemical Id + + + + + en + chemicalId + + + STRING + + + en + The substance identification, in accordance with the specification in the attribute for the list type. + + + + + + + + + listTypeId + + + en + List Type Id + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#listTypeId + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + List Type Id + + + + + en + listTypeId + + + STRING + + + en + The type of standard used for the identification of the substances. Selected can be for example CAS, IUPAC or EC. + + + + + + CAS + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#ListTypeEnumerationId:CAS + + + + + + EC + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#ListTypeEnumerationId:EC + + + + + + IUPAC + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#ListTypeEnumerationId:IUPAC + + + + + + + + + + + + + chemicalName + + + en + Chemical Name + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#chemicalName + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Chemical Name + + + + + en + chemicalName + + + STRING + + + en + The name of the material which is present in the product. + + + + + + + + + materialIdentification + + + en + Material Identification + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#materialIdentification + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Material Identification + + + + + en + materialIdentification + + + STRING + + + en + The chemical material name and identification, in accordance with the specification in the attribute for the list type. Preference is given to the IUPAC name. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Article 7: +(5) (a) the name of the substances of concern present in the product, as follows: + - name(s) in the International Union of Pure and Applied Chemistry (IUPAC) nomenclature, or another international name when IUPAC name is not available; +- other names (usual name, trade name, abbreviation); +- European Community (EC) number, as indicated in the European Inventory of Existing Commercial Chemical Substances (EINECS), the European List of Notified Chemical Substances (ELINCS) or the No Longer Polymer (NLP) list or assigned by the European Chemicals Agency (ECHA), if available; +- the Chemical Abstract Service (CAS) name(s) and number(s), if available; . + + + + + + + + + content + + + en + Content + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Content + + + + + en + content + + + STRING + + + en + The content of the document e.g a link. + + + + + + + + + contentType + + + en + Content Type + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Content Type + + + + + en + contentType + + + STRING + + + en + The type of content which can be expected in the "content" property. Examples are a link, restricted link, pdf, excel, etc. + + + + + + + + + header + + + en + Header + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Header + + + + + en + header + + + STRING + + + en + The header as a short description of the document with a maximum of 100 characters. + + + + + + + + + documentation + + + en + Documentation + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#documentation + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Documentation + + + + + en + documentation + + + STRING + + + en + Documentation accompanying the material. + + + + + + + + + substanceOfConcern + + + en + Substance of Concern + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#substanceOfConcern + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Substance of Concern + + + + + en + substanceOfConcern + + + STRING + + + en + Information regarding substances of concern in the product. Attributes are among others substance names, ids, concentration, location and hazard class. This is mentioned in the ESPR provisional agreement from January 9th, 2024 Article 7: +(5) (a) the name of the substances of concern present in the product, as follows: +- name(s) in the International Union of Pure and Applied Chemistry (IUPAC) nomenclature, or another international name when IUPAC name is not available; +- other names (usual name, trade name, abbreviation); +- European Community (EC) number, as indicated in the European Inventory of Existing Commercial Chemical Substances (EINECS), the European List of Notified Chemical Substances (ELINCS) or the No Longer Polymer (NLP) list or assigned by the European Chemicals Agency (ECHA), if available; +- the Chemical Abstract Service (CAS) name(s) and number(s), if available; +(5) (b) the location of the substances of concern within the product. +(5) (c) the concentration, maximum concentration or concentration range of the substances of concern, at the level of the product its relevant components, or spare parts; +(d) relevant instructions for the safe use of the product; +(e) information relevant for disassembly, preparation for reuse, reuse, recycling and the environmentally sound management of the product at the end of its life. +And in the next paragraph: +(c) provide duly justified exemptions for substances of concern or information elements from the information requirements referred to in the first subparagraph. + + + + + + + + + substancesOfConcern + + + en + Substances of Concern + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#substancesOfConcern + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Substances of Concern + + + + + en + substancesOfConcern + + + STRING + + + en + Information regarding substances of concern in the product. The ESPR provisional agreement from January 9th, 2024 defines: +(52) 'hazardous substance' means a substance classified as hazardous pursuant to Article 3 of Regulation (EC) No 1272/2008. + + + + + + + + + applicable + + + en + Applicable + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#applicable + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Applicable + + + + + en + applicable + + + BOOLEAN + + + en + Check whether the connected attributes are applicable to the product. If it is not applicable (false), dummy data can be delivered. + + + + + + + + + recycled + + + en + Recycled + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#recycled + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Recycled + + + + + en + recycled + + + REAL_MEASURE + + + en + The share of the material, which is recovered recycled content from the product. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I: +(h) use or content of recycled materials and recovery of materials, including critical raw materials; + + + + + + + + + renewable + + + en + Renewable + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#renewable + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Renewable + + + + + en + renewable + + + REAL_MEASURE + + + en + The share of the material, which is from a renewable resource that can be replenished. Renewable resources are those that can be reproduced by physical, chemical, or mechanical processes. These are the kind of resources that can be regenerated throughout time. Forest wood, for example, can be grown through reforestation. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I: +(ha) use or content of sustainable renewable materials; + + + + + + + + + + materialUnit + + + en + Material Unit + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#materialUnit + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Material Unit + + + + + en + materialUnit + + + STRING + + + en + The unit of concentration chosen from an enumeration: mass percent, volume percent, parts per thousand, parts per million, parts per billion and parts per trillion. + + + + + + + + + chemicalId + + + en + Chemical Id + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#chemicalId + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Chemical Id + + + + + en + chemicalId + + + STRING + + + en + The substance identification, in accordance with the specification in the attribute for the list type. + + + + + + + + + listTypeId + + + en + List Type Id + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#listTypeId + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + List Type Id + + + + + en + listTypeId + + + STRING + + + en + The type of standard used for the identification of the substances. Selected can be for example CAS, IUPAC or EC. + + + + + + + + + chemicalName + + + en + Chemical Name + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#chemicalName + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Chemical Name + + + + + en + chemicalName + + + STRING + + + en + The name of the material which is present in the product. + + + + + + + + + materialIdentification + + + en + Material Identification + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#materialIdentification + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Material Identification + + + + + en + materialIdentification + + + STRING + + + en + The chemical material name and identification, in accordance with the specification in the attribute for the list type. Preference is given to the IUPAC name. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Article 7: +(5) (a) the name of the substances of concern present in the product, as follows: + - name(s) in the International Union of Pure and Applied Chemistry (IUPAC) nomenclature, or another international name when IUPAC name is not available; +- other names (usual name, trade name, abbreviation); +- European Community (EC) number, as indicated in the European Inventory of Existing Commercial Chemical Substances (EINECS), the European List of Notified Chemical Substances (ELINCS) or the No Longer Polymer (NLP) list or assigned by the European Chemicals Agency (ECHA), if available; +- the Chemical Abstract Service (CAS) name(s) and number(s), if available; . + + + + + + + + + critical + + + en + Critical + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#critical + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Critical + + + + + en + critical + + + BOOLEAN + + + en + A flag, if the material is a critical raw material. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I: +(h) use or content of recycled materials and recovery of materials, including critical raw materials; +In Annex II of the connected proposal Act of Critical Raw Materials, a list of critical raw materials can be found. + + + + + + + + + concentration + + + en + Concentration + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#concentration + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Concentration + + + + + en + concentration + + + REAL_MEASURE + + + en + Concentration of the material at the level of the product. This attribute is specially mentioned for substances of concern mentioned in the ESPR proposal from March 30th, 2022 Article 7: +(5) (c) the concentration, maximum concentration or concentration range of the substances of concern, at the level of the product [...]. +Other substances are mentioned for the purpose of recycling in the ESPR provisional agreement from January 9th, 2024 Annex I: +(d) design for recycling, ease and quality of recycling as expressed through: use of easily recyclable materials, safe, easy and non-destructive access to recyclable components and materials or components and materials containing hazardous substances and material composition and homogeneity, possibility for high-purity sorting, number of materials and components used, use of standard components, use of component and material coding standards for the identification of components and materials, number and complexity of processes and tools needed, ease of nondestructive disassembly and re-assembly, conditions for access to product data, conditions for access to or use of hardware and software needed. + + + + + + + + + + content + + + en + Content + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Content + + + + + en + content + + + STRING + + + en + The content of the document e.g a link. + + + + + + + + + contentType + + + en + Content Type + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Content Type + + + + + en + contentType + + + STRING + + + en + The type of content which can be expected in the "content" property. Examples are a link, restricted link, pdf, excel, etc. + + + + + + + + + header + + + en + Header + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Header + + + + + en + header + + + STRING + + + en + The header as a short description of the document with a maximum of 100 characters. + + + + + + + + + documentation + + + en + Documentation + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#documentation + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Documentation + + + + + en + documentation + + + STRING + + + en + Documentation accompanying the material. + + + + + + + + + chemicalMaterial + + + en + Material + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#chemicalMaterial + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Material + + + + + en + chemicalMaterial + + + STRING + + + en + Information on different materials in the product. + + + + + + + + + materialComposition + + + en + Material Composition + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#materialComposition + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Material Composition + + + + + en + materialComposition + + + STRING + + + en + Material composition of the product with information on recycled and renewable materials. + + + + + + + + + materials + + + en + Materials + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#materials + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Materials + + + + + en + materials + + + STRING + + + en + Properties which are relevant for the materials of the product. + + + + + + + + + state + + + en + State + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#state + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + State + + + + + en + state + + + STRING + + + en + The status of the product (original, repurposed, re-used, remanufactured or waste) to indicated, whether it is a used product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Annex I: +(j) incorporation of used components. + + + + + + original + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#StateEnumeration:original + + + + + + repurposed + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#StateEnumeration:repurposed + + + + + + re-used + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#StateEnumeration:re-used + + + + + + remanufactured + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#StateEnumeration:remanufactured + + + + + + waste + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#StateEnumeration:waste + + + + + + + + + + + + + footprintValue + + + en + Footprint Value + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#footprintValue + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Footprint Value + + + + + en + footprintValue + + + REAL_MEASURE + + + en + The value of the footprint of the product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Annex I: +(l) the environmental footprint of the product, expressed as a quantification, in accordance with the applicable delegated act, of a product's life cycle environmental impacts, whether in relation to one or more environmental impact categories or an aggregated set of impact categories; +(m) the carbon footprint of the product; +(ma) the material footprint of the product. + + + + + + + + + + content + + + en + Content + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Content + + + + + en + content + + + STRING + + + en + The content of the document e.g a link. + + + + + + + + + contentType + + + en + Content Type + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Content Type + + + + + en + contentType + + + STRING + + + en + The type of content which can be expected in the "content" property. Examples are a link, restricted link, pdf, excel, etc. + + + + + + + + + header + + + en + Header + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Header + + + + + en + header + + + STRING + + + en + The header as a short description of the document with a maximum of 100 characters. + + + + + + + + + footprintRulebook + + + en + Footprint Rulebook + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#footprintRulebook + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Footprint Rulebook + + + + + en + footprintRulebook + + + STRING + + + en + The applied rulebook for the environmental footprint of the product. + + + + + + + + + footprintLifecycle + + + en + Footprint Lifecycle + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#footprintLifecycle + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Footprint Lifecycle + + + + + en + footprintLifecycle + + + STRING + + + en + The lifecycle stage, to which the environmental footprint corresponds. These could be for example "raw material acquisition and pre-processing", "main product production", "distribution" or "end of life and recycling". + + + + + + + + + footprintUnit + + + en + Footprint Unit + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#footprintUnit + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Footprint Unit + + + + + en + footprintUnit + + + STRING + + + en + The unit of measurement of the environmental impact category. For each impact category a specific unit is used. If an aggregation is used, utilize the normalization and weighting methods used in the referenced rulebook. + + + + + + + + + footprintType + + + en + Footprint Type + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#footprintType + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Footprint Type + + + + + en + footprintType + + + STRING + + + en + The type of the environmental footprint of the product. This could be one of the environmental impact categories. This attribute is mentioned in the ESPR provisional agreement from January 9th 2024 Article 7: +(2)(b)(i) information on the performance of the product in relation to one or more of the product parameters referred to in Annex I, including a scoring of reparability or durability, carbon footprint or environmental footprint; +Annex I: +(l) the environmental footprint of the product, expressed as a quantification, in accordance with the applicable delegated act, of a product's life cycle environmental impacts, whether in relation to one or more environmental impact categories or an aggregated set of impact categories. +(m) the carbon footprint of the product; +(ma) the material footprint of the product. + + + + + + Climate Change Total + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#CategoryEnumeration:Climate Change Total + + + + + + Climate Change Fossil + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#CategoryEnumeration:Climate Change Fossil + + + + + + Climate Change Biogenic Removals and Emissions + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#CategoryEnumeration:Climate Change Biogenic Removals and Emissions + + + + + + Climate Change Land Use and Land Use Change + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#CategoryEnumeration:Climate Change Land Use and Land Use Change + + + + + + Ozone Depletion + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#CategoryEnumeration:Ozone Depletion + + + + + + Acidification + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#CategoryEnumeration:Acidification + + + + + + Eutrophication Aquatic Freshwater + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#CategoryEnumeration:Eutrophication Aquatic Freshwater + + + + + + Eutrophication Fresh Marine + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#CategoryEnumeration:Eutrophication Fresh Marine + + + + + + Eutrophication Terrestrial + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#CategoryEnumeration:Eutrophication Terrestrial + + + + + + Photochemical Ozone Formation + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#CategoryEnumeration:Photochemical Ozone Formation + + + + + + Abiotic Depletion- Minerals and Metals + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#CategoryEnumeration:Abiotic Depletion- Minerals and Metals + + + + + + Fossil Fuels + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#CategoryEnumeration:Fossil Fuels + + + + + + Water Use + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#CategoryEnumeration:Water Use + + + + + + Particulate Matter Emissions + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#CategoryEnumeration:Particulate Matter Emissions + + + + + + Ionizing Radiation, Human Health + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#CategoryEnumeration:Ionizing Radiation, Human Health + + + + + + Eco-Toxicity + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#CategoryEnumeration:Eco-Toxicity + + + + + + Human Toxicity, Cancer Effects + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#CategoryEnumeration:Human Toxicity, Cancer Effects + + + + + + Human Toxicity, Non-Cancer Effects + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#CategoryEnumeration:Human Toxicity, Non-Cancer Effects + + + + + + Land Use Related Impacts/Soil Quality + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#CategoryEnumeration:Land Use Related Impacts/Soil Quality + + + + + + + + + + + + + performanceClass + + + en + Performance Class + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#performanceClass + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Performance Class + + + + + en + performanceClass + + + STRING + + + en + The performance classification of the footprint. + + + + + + + + + facility + + + en + Facility + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#facility + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Facility + + + + + en + facility + + + STRING + + + en + The identifier used for a location. This attribute is mentioned in the ESPR provisional agreement from January 9th 2024 Annex III: +(i) unique facility identifiers; +Article 2 Definitions: (33) 'unique facility identifier' means a unique string of characters for the identification of locations or buildings involved in the value chain of a product or used by actors involved in the value chain of a product. + + + + + + + + + manufacturingPlant + + + en + Manufacturing Plant + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#manufacturingPlant + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Manufacturing Plant + + + + + en + manufacturingPlant + + + STRING + + + en + The manufacturing plant of the footprint in the specific lifecycle phase. + + + + + + + + + content + + + en + Content + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Content + + + + + en + content + + + STRING + + + en + The content of the document e.g a link. + + + + + + + + + contentType + + + en + Content Type + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Content Type + + + + + en + contentType + + + STRING + + + en + The type of content which can be expected in the "content" property. Examples are a link, restricted link, pdf, excel, etc. + + + + + + + + + header + + + en + Header + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Header + + + + + en + header + + + STRING + + + en + The header as a short description of the document with a maximum of 100 characters. + + + + + + + + + declaration + + + en + Declaration + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#declaration + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Declaration + + + + + en + declaration + + + STRING + + + en + The footprint declaration in the format of a link + + + + + + + + + environmentalFootprint + + + en + Environmental Footprint + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#environmentalFootprint + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Environmental Footprint + + + + + en + environmentalFootprint + + + STRING + + + en + The environmental footprint of the product. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I: +The following parameters shall, as appropriate, and where necessary supplemented by others, be used, individually or combined, as a basis for improving the product aspects referred to in Article 5(1): +(l) the environmental footprint of the product, expressed as a quantification, in accordance with the applicable delegated act, of a product's life cycle environmental impacts, whether in relation to one or more environmental impact categories or an aggregated set of impact categories. +and Article 7: +(2)(b)(i) information on the performance of the product in relation to one or more of the product parameters referred to in Annex I, including a scoring of reparability or durability, carbon footprint or environmental footprint; +and defined by Article 2: +(23) 'environmental footprint' means a quantification of product environmental impacts throughout its life cycle, whether in relation to a single environmental impact category or an aggregated set of impact categories based on the Product Environmental Footprint method or other scientific methods developed by international organisations and widely tested in collaboration with different industry sectors and adopted or implemented by the Commission in other Union legislation; +(24) 'Product Environmental Footprint method' means the life cycle assessment method to quantify the environmental impacts of products established by Recommendation (EU) 2021/2279. + + + + + + + + + footprintValue + + + en + Footprint Value + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#footprintValue + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Footprint Value + + + + + en + footprintValue + + + REAL_MEASURE + + + en + The value of the footprint of the product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Annex I: +(l) the environmental footprint of the product, expressed as a quantification, in accordance with the applicable delegated act, of a product's life cycle environmental impacts, whether in relation to one or more environmental impact categories or an aggregated set of impact categories; +(m) the carbon footprint of the product; +(ma) the material footprint of the product. + + + + + + + + + + content + + + en + Content + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Content + + + + + en + content + + + STRING + + + en + The content of the document e.g a link. + + + + + + + + + contentType + + + en + Content Type + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Content Type + + + + + en + contentType + + + STRING + + + en + The type of content which can be expected in the "content" property. Examples are a link, restricted link, pdf, excel, etc. + + + + + + + + + header + + + en + Header + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Header + + + + + en + header + + + STRING + + + en + The header as a short description of the document with a maximum of 100 characters. + + + + + + + + + footprintRulebook + + + en + Footprint Rulebook + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#footprintRulebook + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Footprint Rulebook + + + + + en + footprintRulebook + + + STRING + + + en + The applied rulebook for the environmental footprint of the product. + + + + + + + + + footprintLifecycle + + + en + Footprint Lifecycle + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#footprintLifecycle + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Footprint Lifecycle + + + + + en + footprintLifecycle + + + STRING + + + en + The lifecycle stage, to which the environmental footprint corresponds. These could be for example "raw material acquisition and pre-processing", "main product production", "distribution" or "end of life and recycling". + + + + + + + + + footprintUnit + + + en + Footprint Unit + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#footprintUnit + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Footprint Unit + + + + + en + footprintUnit + + + STRING + + + en + The unit of measurement of the environmental impact category. For each impact category a specific unit is used. If an aggregation is used, utilize the normalization and weighting methods used in the referenced rulebook. + + + + + + + + + footprintType + + + en + Footprint Type + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#footprintType + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Footprint Type + + + + + en + footprintType + + + STRING + + + en + The type of the environmental footprint of the product. This could be one of the environmental impact categories. This attribute is mentioned in the ESPR provisional agreement from January 9th 2024 Article 7: +(2)(b)(i) information on the performance of the product in relation to one or more of the product parameters referred to in Annex I, including a scoring of reparability or durability, carbon footprint or environmental footprint; +Annex I: +(l) the environmental footprint of the product, expressed as a quantification, in accordance with the applicable delegated act, of a product's life cycle environmental impacts, whether in relation to one or more environmental impact categories or an aggregated set of impact categories. +(m) the carbon footprint of the product; +(ma) the material footprint of the product. + + + + + + + + + performanceClass + + + en + Performance Class + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#performanceClass + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Performance Class + + + + + en + performanceClass + + + STRING + + + en + The performance classification of the footprint. + + + + + + + + + facility + + + en + Facility + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#facility + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Facility + + + + + en + facility + + + STRING + + + en + The identifier used for a location. This attribute is mentioned in the ESPR provisional agreement from January 9th 2024 Annex III: +(i) unique facility identifiers; +Article 2 Definitions: (33) 'unique facility identifier' means a unique string of characters for the identification of locations or buildings involved in the value chain of a product or used by actors involved in the value chain of a product. + + + + + + + + + manufacturingPlant + + + en + Manufacturing Plant + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#manufacturingPlant + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Manufacturing Plant + + + + + en + manufacturingPlant + + + STRING + + + en + The manufacturing plant of the footprint in the specific lifecycle phase. + + + + + + + + + content + + + en + Content + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Content + + + + + en + content + + + STRING + + + en + The content of the document e.g a link. + + + + + + + + + contentType + + + en + Content Type + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Content Type + + + + + en + contentType + + + STRING + + + en + The type of content which can be expected in the "content" property. Examples are a link, restricted link, pdf, excel, etc. + + + + + + + + + header + + + en + Header + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Header + + + + + en + header + + + STRING + + + en + The header as a short description of the document with a maximum of 100 characters. + + + + + + + + + declaration + + + en + Declaration + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#declaration + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Declaration + + + + + en + declaration + + + STRING + + + en + The footprint declaration in the format of a link + + + + + + + + + carbonFootprint + + + en + Carbon Footprint + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#carbonFootprint + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Carbon Footprint + + + + + en + carbonFootprint + + + STRING + + + en + The carbon footprint of the product. This is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I: +The following parameters shall, as appropriate, and where necessary supplemented by others, be used, individually or combined, as a basis for improving the product aspects referred to in Article 5(1): +(m) the carbon footprint of the product; +and Article 7: +(2)(b)(i) information on the performance of the product in relation to one or more of the product parameters referred to in Annex I, including a scoring of reparability or durability, carbon footprint or environmental footprint; +and defined by Article 2: +(25) 'carbon footprint' means the sum of greenhouse gas (GHG) emissions and GHG removals in a product system, expressed as CO2 equivalents and based on a life cycle assessment using the single impact category of climate change. + + + + + + + + + footprintValue + + + en + Footprint Value + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#footprintValue + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Footprint Value + + + + + en + footprintValue + + + REAL_MEASURE + + + en + The value of the footprint of the product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Annex I: +(l) the environmental footprint of the product, expressed as a quantification, in accordance with the applicable delegated act, of a product's life cycle environmental impacts, whether in relation to one or more environmental impact categories or an aggregated set of impact categories; +(m) the carbon footprint of the product; +(ma) the material footprint of the product. + + + + + + + + + + content + + + en + Content + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Content + + + + + en + content + + + STRING + + + en + The content of the document e.g a link. + + + + + + + + + contentType + + + en + Content Type + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Content Type + + + + + en + contentType + + + STRING + + + en + The type of content which can be expected in the "content" property. Examples are a link, restricted link, pdf, excel, etc. + + + + + + + + + header + + + en + Header + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Header + + + + + en + header + + + STRING + + + en + The header as a short description of the document with a maximum of 100 characters. + + + + + + + + + footprintRulebook + + + en + Footprint Rulebook + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#footprintRulebook + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Footprint Rulebook + + + + + en + footprintRulebook + + + STRING + + + en + The applied rulebook for the environmental footprint of the product. + + + + + + + + + footprintLifecycle + + + en + Footprint Lifecycle + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#footprintLifecycle + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Footprint Lifecycle + + + + + en + footprintLifecycle + + + STRING + + + en + The lifecycle stage, to which the environmental footprint corresponds. These could be for example "raw material acquisition and pre-processing", "main product production", "distribution" or "end of life and recycling". + + + + + + + + + footprintUnit + + + en + Footprint Unit + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#footprintUnit + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Footprint Unit + + + + + en + footprintUnit + + + STRING + + + en + The unit of measurement of the environmental impact category. For each impact category a specific unit is used. If an aggregation is used, utilize the normalization and weighting methods used in the referenced rulebook. + + + + + + + + + footprintType + + + en + Footprint Type + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#footprintType + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Footprint Type + + + + + en + footprintType + + + STRING + + + en + The type of the environmental footprint of the product. This could be one of the environmental impact categories. This attribute is mentioned in the ESPR provisional agreement from January 9th 2024 Article 7: +(2)(b)(i) information on the performance of the product in relation to one or more of the product parameters referred to in Annex I, including a scoring of reparability or durability, carbon footprint or environmental footprint; +Annex I: +(l) the environmental footprint of the product, expressed as a quantification, in accordance with the applicable delegated act, of a product's life cycle environmental impacts, whether in relation to one or more environmental impact categories or an aggregated set of impact categories. +(m) the carbon footprint of the product; +(ma) the material footprint of the product. + + + + + + + + + performanceClass + + + en + Performance Class + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#performanceClass + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Performance Class + + + + + en + performanceClass + + + STRING + + + en + The performance classification of the footprint. + + + + + + + + + facility + + + en + Facility + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#facility + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Facility + + + + + en + facility + + + STRING + + + en + The identifier used for a location. This attribute is mentioned in the ESPR provisional agreement from January 9th 2024 Annex III: +(i) unique facility identifiers; +Article 2 Definitions: (33) 'unique facility identifier' means a unique string of characters for the identification of locations or buildings involved in the value chain of a product or used by actors involved in the value chain of a product. + + + + + + + + + manufacturingPlant + + + en + Manufacturing Plant + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#manufacturingPlant + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Manufacturing Plant + + + + + en + manufacturingPlant + + + STRING + + + en + The manufacturing plant of the footprint in the specific lifecycle phase. + + + + + + + + + content + + + en + Content + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Content + + + + + en + content + + + STRING + + + en + The content of the document e.g a link. + + + + + + + + + contentType + + + en + Content Type + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Content Type + + + + + en + contentType + + + STRING + + + en + The type of content which can be expected in the "content" property. Examples are a link, restricted link, pdf, excel, etc. + + + + + + + + + header + + + en + Header + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Header + + + + + en + header + + + STRING + + + en + The header as a short description of the document with a maximum of 100 characters. + + + + + + + + + declaration + + + en + Declaration + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#declaration + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Declaration + + + + + en + declaration + + + STRING + + + en + The footprint declaration in the format of a link + + + + + + + + + materialFootprint + + + en + Material Footprint + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#materialFootprint + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Material Footprint + + + + + en + materialFootprint + + + STRING + + + en + The material footprint of the product. This is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I: +(ma) the material footprint of the product; +and defined by Article 2: +(25a) 'material footprint' refers to the total amount of raw materials extracted to meet final consumption demands. + + + + + + + + + productFootprint + + + en + Product Footprint + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#productFootprint + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Product Footprint + + + + + en + productFootprint + + + STRING + + + en + The carbon and environmental footprint or material footprint of the product. These attributes are mentioned in the ESPR provisional agreement from January 9th 2024 Annex I: +(l) the environmental footprint of the product, expressed as a quantification, in accordance with the applicable delegated act, of a product's life cycle environmental impacts, whether in relation to one or more environmental impact categories or an aggregated set of impact categories; +(m) the carbon footprint of the product; +(ma) the material footprint of the product; +All are defined by Article 2: +(23) 'environmental footprint' means a quantification of product environmental impacts throughout its life cycle, whether in relation to a single environmental impact category or an aggregated set of impact categories based on the Product Environmental Footprint method or other scientific methods developed by international organisations and widely tested in collaboration with different industry sectors and adopted or implemented by the Commission in other Union +legislation; +(25) 'carbon footprint' means the sum of greenhouse gas (GHG) emissions and GHG removals in a product system, expressed as CO2 equivalents and based on a life cycle assessment using the single impact category of climate change. +(25a) 'material footprint' refers to the total amount of raw materials extracted to meet final consumption demands; + + + + + + + + + reparabilityScore + + + en + Reparability Score + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#reparabilityScore + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Reparability Score + + + + + en + reparabilityScore + + + STRING + + + en + The reparability score. This attribute is mentioned ESPR provisional agreement from January 9th, 2024 Article 7: +(b) as appropriate, also require products to be accompanied by: +(i) information on the performance of the product in relation to one or more of the product parameters referred to in Annex I, including a scoring of reparability or durability [...]. + + + + + + + + + durabilityScore + + + en + Durability Score + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#durabilityScore + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Durability Score + + + + + en + durabilityScore + + + STRING + + + en + The durability score. This attribute is mentioned ESPR provisional agreement from January 9th, 2024 Article 7: +(b) as appropriate, also require products to be accompanied by: +(i) information on the performance of the product in relation to one or more of the product parameters referred to in Annex I, including a scoring of reparability or durability [...]. + + + + + + + + + sustainability + + + en + Sustainability + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#sustainability + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Sustainability + + + + + en + sustainability + + + STRING + + + en + Sustainability related attributes. + + + + + + + + + content + + + en + Content + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Content + + + + + en + content + + + STRING + + + en + The content of the document e.g a link. + + + + + + + + + category + + + en + Category + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#category + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Category + + + + + en + category + + + STRING + + + en + The category in which the document can be sorted. These are mentioned in the ESPR proposal from March 30th, 2022 ANNEX III: +(e) compliance documentation and information required under this Regulation or other Union law applicable to the product, such as the declaration of conformity, technical documentation or conformity certificates; +ANNEX IV states additional information regarding the content of the technical documentation +Further information on documents are mentioned in the proposal from March 30th, 2022 ANNEX III: +(f) user manuals, instructions, warnings or safety information, as required by other Union legislation applicable to the product. +Additionally requirements are mentioned in Article 21: +(7) Manufacturers shall ensure that that a product covered by a delegated act adopted pursuant to Article 4 is accompanied by instructions that enable consumers and other end-users to safely assemble, install, operate, store, maintain, repair and dispose of the product in a language that can be easily understood by consumers and other end-users, as determined by the Member State concerned. Such instructions shall be clear, understandable and legible and include at least the information specified in the delegated acts adopted pursuant to Article 4 and pursuant to Article 7(2)(b), point (ii). +Article 7 states additionally: +(2) (b) (ii) information for consumers and other end-users on how to install, use, maintain and repair the product in order to minimize its impact on the environment and to ensure optimum durability, as well as on how to return or dispose of the product at end-of-life; +(2) (b) (iii) information for treatment facilities on disassembly, recycling, or disposal at end-of-life; +(2) (b) (iv) other information that may influence the way the product is handled by parties other than the manufacturer in order to improve performance in relation to product parameters referred to in Annex I. +(5) (d) relevant instructions for the safe use of the product. + + + + + + Product Specifications + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#SourceCategoryEnumeration:Product Specifications + + + + + + Manufacturer Information + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#SourceCategoryEnumeration:Manufacturer Information + + + + + + User Manuals and Guides + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#SourceCategoryEnumeration:User Manuals and Guides + + + + + + Certifications and Compliance + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#SourceCategoryEnumeration:Certifications and Compliance + + + + + + Product Images and Videos + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#SourceCategoryEnumeration:Product Images and Videos + + + + + + Warranty Information + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#SourceCategoryEnumeration:Warranty Information + + + + + + Reviews and Ratings + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#SourceCategoryEnumeration:Reviews and Ratings + + + + + + Product Variations + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#SourceCategoryEnumeration:Product Variations + + + + + + Supply Chain Information + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#SourceCategoryEnumeration:Supply Chain Information + + + + + + Environmental Impact + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#SourceCategoryEnumeration:Environmental Impact + + + + + + Compatibility and Accessories + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#SourceCategoryEnumeration:Compatibility and Accessories + + + + + + FAQs and Support + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#SourceCategoryEnumeration:FAQs and Support + + + + + + Purchase and Retail Information + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#SourceCategoryEnumeration:Purchase and Retail Information + + + + + + Privacy and Data Handling + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#SourceCategoryEnumeration:Privacy and Data Handling + + + + + + Third-Party Integrations + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#SourceCategoryEnumeration:Third-Party Integrations + + + + + + Legal Information + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#SourceCategoryEnumeration:Legal Information + + + + + + Safety Information + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#SourceCategoryEnumeration:Safety Information + + + + + + Repair and Installation + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#SourceCategoryEnumeration:Repair and Installation + + + + + + Waste Generation and Prevention + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#SourceCategoryEnumeration:Waste Generation and Prevention + + + + + + Specific Voluntary Labels + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#SourceCategoryEnumeration:Specific Voluntary Labels + + + + + + Product Packaging + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#SourceCategoryEnumeration:Product Packaging + + + + + + Return and Disposal + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#SourceCategoryEnumeration:Return and Disposal + + + + + + End of Life + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#SourceCategoryEnumeration:End of Life + + + + + + Material and Substance Information + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#SourceCategoryEnumeration:Material and Substance Information + + + + + + Technical Documentation + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#SourceCategoryEnumeration:Technical Documentation + + + + + + Treatment facilities + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#SourceCategoryEnumeration:Treatment facilities + + + + + + Other + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#SourceCategoryEnumeration:Other + + + + + + + + + + + + + contentType + + + en + Content Type + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Content Type + + + + + en + contentType + + + STRING + + + en + The type of content which can be expected in the "content" property. Examples are a link, restricted link, pdf, excel, etc. + + + + + + + + + header + + + en + Header + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Header + + + + + en + header + + + STRING + + + en + The header as a short description of the document with a maximum of 100 characters. + + + + + + + + + sources + + + en + Sources + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#sources + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Sources + + + + + en + sources + + + STRING + + + en + Documents that are mandatory if applicable for the product. These are mentioned in the ESPR provisional agreement from January 9th, 2024 ANNEX III: +(e) compliance documentation and information required under this Regulation or other Union law applicable to the product, such as the declaration of conformity, technical documentation or conformity certificates; +(f) user manuals, instructions, warnings or safety information, as required by other Union legislation applicable to the product. +Additionally requirements are mentioned in Article 21: +7. Manufacturers shall ensure that a product covered by a delegated act adopted pursuant to Article 4 is accompanied by instructions in digital format that enable customers and other relevant actors to assemble, install, operate, store, maintain, repair and dispose of the product in a language that can be easily understood, as determined by the Member State concerned. Such instructions shall be clear, understandable and legible and include at least the information set out in Article 7(2), point (b), point (ii) specified in the delegated acts adopted pursuant to Article 4. +Article 7 states additionally: +(ii) information for customers and other actors on how to install, use, maintain and repair the product, in order to minimise its impact on the environment and to ensure optimum durability, on how to install third-party operating systems where relevant, as well as on collection for refurbishment or remanufacture, and on how to return or handle the product at the end of its life; +(2) (b) (iii) information for treatment facilities on disassembly, reuse, refurbishment, recycling, or disposal at end-of-life; +(2) (b) (iv) other information that may influence sustainable product choices for customers and the way the product is handled by parties other than the manufacturer in order to facilitate appropriate use, value retaining operations and correct treatment at end-of-life. +(5) (d) relevant instructions for the safe use of the product. +(5) (e) information relevant for disassembly, preparation for reuse, reuse, recycling and the environmentally sound management of the product at the end of its life. +Annex I: +(b) [...] availability of repair and maintenance instructions, number of materials and components used, use of standard components,[...] number and complexity of processes and whether specialised toolsare needed, ease of non-destructive disassembly and re-assembly, conditions for access to product data, conditions for access to or use of hardware and software needed; +(c) ease of upgrading, re-use, remanufacturing and refurbishment as expressed through: [...] number and complexity of processes and tools needed, ease of non-destructive disassembly and re-assembly, conditions for access to product data, conditions for access to or use of hardware and software needed, conditions of access to test protocols or not commonly available testing equipment, availability of guarantees specific to remanufactured or refurbished products, conditions for access to or use of technologies protected by intellectual property rights, modularity; +(d) design for recycling, ease and quality of recycling as expressed through: use of easily recyclable materials, safe, easy and non-destructive access to recyclable components and materials or components and materials containing hazardous substances and material composition and homogeneity, possibility for high-purity sorting, [...] number and complexity of processes and tools needed, ease of nondestructive disassembly and re-assembly, conditions for access to product data, conditions for access to or use of hardware and software needed; +(q) functional performance and conditions for use including as expressed through ability in performing its intended use, precautions of use, skills required, compatibility with other products or systems. +Additionally to consider are guidelines and instructions regarding the proper management and disposal of packaging materials after use. This can include instructions for separation, reuse, and recycling. + + + + + + + + + productGenericParameters + + + en + Product Generic Parameters + + + urn:samm:io.catenax.electric_drive.electric_drive_passport:2.0.0#productGenericParameters + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Product Generic Parameters + + + + + en + productGenericParameters + + + STRING + + + en + The product generic parameters. These are defined by the Digital Product Passport proposal from the ESPR. The main basis is provided by the document "Proposal for a REGULATION OF THE EUROPEAN PARLIAMENT AND OF THE COUNCIL establishing a framework for setting ecodesign requirements for sustainable products and repealing Directive 2009/125/EC" from March 30th, 2022. The latest version of the document was the provisional agreement between the EU Council and the Parliament from January 9th, 2024. + + + + + + + + + diff --git a/io.catenax.electric_drive.electric_drive_passport/2.0.0/gen/ElectricDrivePassport-schema.json b/io.catenax.electric_drive.electric_drive_passport/2.0.0/gen/ElectricDrivePassport-schema.json new file mode 100644 index 000000000..2e226e901 --- /dev/null +++ b/io.catenax.electric_drive.electric_drive_passport/2.0.0/gen/ElectricDrivePassport-schema.json @@ -0,0 +1,1503 @@ +{ + "$schema" : "http://json-schema.org/draft-04/schema", + "description" : "The E-Drive Passport is a data record that summarizes the components, materials and chemical substances or information on repairability, spare parts or professional disposal for an E-Drive. The data comes from all phases of the product life cycle and can be used for various purposes in all these phases (design, production, use, disposal). Structuring environmental data in a standardized, comparable format enables all actors in the value and supply chain to work together towards a circular economy. This data model is based on the new proposed Ecodesign Regulation (ESPR-2022) and the product specific requirements collected from different manufacturers and users of the product.", + "type" : "object", + "components" : { + "schemas" : { + "urn_samm_io.catenax.electric_drive.electric_drive_passport_2.0.0_CompatibleVehicleTypesTrait" : { + "description" : "Constraint for the three possible vehicle types. A selection of multiple is possible.", + "type" : "array", + "items" : { + "type" : "string" + }, + "pattern" : "battery-electric vehicle|hybrid-electric vehicle|fuel-cell-electric vehicle|(?:battery-electric vehicle, |hybrid-electric vehicle, |fuel-cell-electric vehicle, )*battery-electric vehicle|hybrid-electric vehicle|fuel-cell-electric vehicle" + }, + "urn_samm_io.catenax.electric_drive.electric_drive_passport_2.0.0_DateList" : { + "description" : "A list of values in the data type date.", + "type" : "array", + "items" : { + "type" : "string", + "format" : "date" + } + }, + "urn_samm_io.catenax.electric_drive.electric_drive_passport_2.0.0_DateCharacteristic" : { + "type" : "string", + "format" : "date", + "description" : "Characteristic for values in the data type date." + }, + "urn_samm_io.catenax.electric_drive.electric_drive_passport_2.0.0_ServiceCharacteristic" : { + "description" : "Characteristic for the service dates.", + "type" : "object", + "properties" : { + "history" : { + "description" : "The dates of putting the eDrive into service.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.electric_drive.electric_drive_passport_2.0.0_DateList" + }, + "lastServiceDate" : { + "description" : "The date of the last service.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.electric_drive.electric_drive_passport_2.0.0_DateCharacteristic" + } + }, + "required" : [ "history", "lastServiceDate" ] + }, + "urn_samm_io.catenax.electric_drive.electric_drive_passport_2.0.0_GeneralCharacteristic" : { + "description" : "Characteristic for general information.", + "type" : "object", + "properties" : { + "compatibleVehicleTypes" : { + "description" : "The vehicle types, in which the eDrive of this passport can be used. Possible selections are \"battery-electric vehicle\", \"hybrid-electric vehicle\", \"fuel-cell-electric vehicle\".", + "$ref" : "#/components/schemas/urn_samm_io.catenax.electric_drive.electric_drive_passport_2.0.0_CompatibleVehicleTypesTrait" + }, + "service" : { + "description" : "The eDrive service history.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.electric_drive.electric_drive_passport_2.0.0_ServiceCharacteristic" + } + }, + "required" : [ "compatibleVehicleTypes" ] + }, + "urn_samm_io.catenax.electric_drive.electric_drive_passport_2.0.0_IdentifierCharacteristic" : { + "type" : "string", + "description" : "Characteristic for identifiers of components in the electrical drive." + }, + "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.electric_drive.electric_drive_passport_2.0.0_RevolutionsMeasurement" : { + "type" : "number", + "description" : "Measurement of revolutions per minute as float value." + }, + "urn_samm_io.catenax.electric_drive.electric_drive_passport_2.0.0_MillimetreMeasurement" : { + "type" : "number", + "description" : "Measurement of millimetre as float value." + }, + "urn_samm_io.catenax.electric_drive.electric_drive_passport_2.0.0_TechnologyEnumeration" : { + "type" : "string", + "description" : "Enumeration for the e-machine technology.", + "enum" : [ "ESM", "ASM", "PSM" ] + }, + "urn_samm_io.catenax.shared.quantity_2.0.0_QuantityValueCharacteristic" : { + "type" : "number", + "description" : "The quantity value associated with the unit expressed as float." + }, + "urn_samm_io.catenax.shared.quantity_2.0.0_MassUnitEnumeration" : { + "type" : "string", + "pattern" : "[a-zA-Z]*:[a-zA-Z]+", + "description" : "Enumeration for mass units.", + "enum" : [ "unit:gram", "unit:kilogram", "unit:tonneMetricTon", "unit:tonUsOrShortTonUkorus", "unit:ounceAvoirdupois", "unit:pound" ] + }, + "urn_samm_io.catenax.shared.quantity_2.0.0_MassCharacteristic" : { + "description" : "Characteristic for mass measurements of an item.", + "type" : "object", + "properties" : { + "value" : { + "description" : "The quantity value associated with the unit.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.quantity_2.0.0_QuantityValueCharacteristic" + }, + "unit" : { + "description" : "The unit of a mass related attribute.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.quantity_2.0.0_MassUnitEnumeration" + } + }, + "required" : [ "value", "unit" ] + }, + "urn_samm_io.catenax.electric_drive.electric_drive_passport_2.0.0_EMachineCharacteristic" : { + "description" : "Characteristic for e-machine values.", + "type" : "object", + "properties" : { + "id" : { + "description" : "The unique serial ID of the e-Machine built into the eDrive of this passport; defined and provided by the owner/economic operator of the passport.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.electric_drive.electric_drive_passport_2.0.0_IdentifierCharacteristic" + }, + "permanentMagnetType" : { + "description" : "The permanent magnet type describes the material composition of the permanent magnet in use. In case of SSM e-Motors, no permanent magnets are used, requiring the input of a default value. Possible selections:\n- No permanent magnets used (SSM motor): \"None\"\n- AlNiCo: \"Aluminum-Nickel-Cobalt\"\n- Ceramic: \"Ceramic\"\n- Ferrite: \"Ferrite\"\n- Flexible: \"Flexible Rubber\"\n- SmCo: \"Samarium Cobalt\"\n- NdFeB: \"Neodymium Iron Boron\"", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "ratedSpeed" : { + "description" : "Rated speed determined by the electronics and measured in RPM, limited through software or physical limits (e.g. maximum power).", + "$ref" : "#/components/schemas/urn_samm_io.catenax.electric_drive.electric_drive_passport_2.0.0_RevolutionsMeasurement" + }, + "statorDiameter" : { + "description" : "Diameter of the E-Machine stator, measured in millimetres.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.electric_drive.electric_drive_passport_2.0.0_MillimetreMeasurement" + }, + "technology" : { + "description" : "The type of the e-machine built into the eDrive. Possible values are \"ASM\" (Asynchronous motor), \"PSM\" (Permanently excited synchronous motor) and \"ESM\" (Electrically-excited synchronous motor). This should not be confused with an electrical machine integrated in a transmission.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.electric_drive.electric_drive_passport_2.0.0_TechnologyEnumeration" + }, + "weight" : { + "description" : "Net weight, component weight without packaging, of the electrical machine, which is built into the eDrive.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.quantity_2.0.0_MassCharacteristic" + } + }, + "required" : [ "id", "permanentMagnetType", "ratedSpeed", "statorDiameter", "technology", "weight" ] + }, + "urn_samm_io.catenax.electric_drive.electric_drive_passport_2.0.0_CoolingEnumeration" : { + "type" : "string", + "description" : "Enumeration of cooling technology.", + "enum" : [ "air-cooled", "water-cooled", "oil-cooled" ] + }, + "urn_samm_io.catenax.transmission.transmission_pass_3.0.0_Capacity" : { + "type" : "number", + "description" : "The oil capacity in dm³." + }, + "urn_samm_io.catenax.electric_drive.electric_drive_passport_2.0.0_BarMeasurement" : { + "type" : "number", + "description" : "Measurement of the pressure in bar as float value." + }, + "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.electric_drive.electric_drive_passport_2.0.0_CelsiusMeasurement" : { + "type" : "number", + "description" : "Measurement in celsius as float value." + }, + "urn_samm_io.catenax.electric_drive.electric_drive_passport_2.0.0_LiquidsCharacteristic" : { + "description" : "Entity for cooling and lubricants.", + "type" : "object", + "properties" : { + "coolingTopology" : { + "description" : "General cooling topology, which can be either one of the types: \"air-cooled\", \"water-cooled\" or \"oil-cooled\".", + "$ref" : "#/components/schemas/urn_samm_io.catenax.electric_drive.electric_drive_passport_2.0.0_CoolingEnumeration" + }, + "oilCapacityEdrive" : { + "description" : "The defined oil volume in the eDrive, measured in cubic decimetres. In case of a combined oil circuit for both the eDrive and the built-in transmission, the value must be identical to the oil capacity value of the transmission.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.transmission.transmission_pass_3.0.0_Capacity" + }, + "oilTypeEdrive" : { + "description" : "The type of the oil for the eDrive defined by the manufacturer. In case of a combined oil circuit for both the eDrive and the built-in transmission, the value must be identical to the oil type value of the transmission.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "minimumOilPressure" : { + "description" : "Minimum operational oil pressure value defined by the manufacturer of the E-Drive measured in bar.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.electric_drive.electric_drive_passport_2.0.0_BarMeasurement" + }, + "maximumOilPressure" : { + "description" : "Maximum operational oil pressure value defined by the manufacturer of the E-Drive measured in bar.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.electric_drive.electric_drive_passport_2.0.0_BarMeasurement" + }, + "oilModule" : { + "description" : "Flag indicating the availability or absence of an oil module. An oil module is an umbrella term for devices that are manipulating the oil flow and the temperature in the product and incorporate cooler, pump, valves (pressure regulation valve).", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Boolean" + }, + "maximumOilTemperature" : { + "description" : "The maximum oil temperature to safely operate the eDrive, measured in celsius on the oil temperature sensor. Please note the oil temperature can vary in other positions within the lubrication circuit.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.electric_drive.electric_drive_passport_2.0.0_CelsiusMeasurement" + } + }, + "required" : [ "coolingTopology", "oilCapacityEdrive", "oilTypeEdrive", "oilModule", "maximumOilTemperature" ] + }, + "urn_samm_io.catenax.electric_drive.electric_drive_passport_2.0.0_AmpereMeasurement" : { + "type" : "number", + "description" : "Measurement of ampere as float value." + }, + "urn_samm_io.catenax.electric_drive.electric_drive_passport_2.0.0_InverterCharacteristic" : { + "description" : "Characteristic for inverter values.", + "type" : "object", + "properties" : { + "inverterCurrent" : { + "description" : "Electric current flowing through the inverter, measured in ampere.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.electric_drive.electric_drive_passport_2.0.0_AmpereMeasurement" + }, + "maximumPhaseCurrent" : { + "description" : "The maximum allowable current to pass through the phases, measured in ampere.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.electric_drive.electric_drive_passport_2.0.0_AmpereMeasurement" + }, + "softwareVersion" : { + "description" : "Indicates the software version of the inverter.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + } + }, + "required" : [ "inverterCurrent", "softwareVersion" ] + }, + "urn_samm_io.catenax.electric_drive.electric_drive_passport_2.0.0_VoltMeasurement" : { + "type" : "number", + "description" : "Measurement in volt as float value." + }, + "urn_samm_io.catenax.electric_drive.electric_drive_passport_2.0.0_KilowattMeasurement" : { + "type" : "number", + "description" : "Measurement in kilowatt as float value." + }, + "urn_samm_io.catenax.transmission.transmission_pass_3.0.0_TimeMeasurement" : { + "type" : "number", + "minimum" : 0, + "description" : "Time in seconds." + }, + "urn_samm_io.catenax.electric_drive.electric_drive_passport_2.0.0_MaximumPowerCharacteristic" : { + "description" : "Characteristic with maximum power values.", + "type" : "object", + "properties" : { + "value" : { + "description" : "The maximum value in kilowatts for a specified time period.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.electric_drive.electric_drive_passport_2.0.0_KilowattMeasurement" + }, + "ECER85" : { + "description" : "Maximum power in kilowatts, measured according to the ECER85 regulatory requirements.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.electric_drive.electric_drive_passport_2.0.0_KilowattMeasurement" + }, + "maximumAvailability" : { + "description" : "Specified time period for the peak measurement in seconds.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.transmission.transmission_pass_3.0.0_TimeMeasurement" + } + }, + "required" : [ "value", "maximumAvailability" ] + }, + "urn_samm_io.catenax.electric_drive.electric_drive_passport_2.0.0_MaximumRegeneratedPowerCharacteristic" : { + "description" : "Characteristic for maximum regenerated power values.", + "type" : "object", + "properties" : { + "maxValue" : { + "description" : "The maximum value in kilowatts for a specified time period.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.electric_drive.electric_drive_passport_2.0.0_KilowattMeasurement" + }, + "maximumAvailability" : { + "description" : "Specified time period for the peak measurement in seconds.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.transmission.transmission_pass_3.0.0_TimeMeasurement" + } + }, + "required" : [ "maxValue", "maximumAvailability" ] + }, + "urn_samm_io.catenax.transmission.transmission_pass_3.0.0_KilowattMeasurement" : { + "type" : "number", + "minimum" : 0, + "description" : "The performance power in kilowatt as non-negative integer." + }, + "urn_samm_io.catenax.electric_drive.electric_drive_passport_2.0.0_PowerCharacteristic" : { + "description" : "Characteristic for power values.", + "type" : "object", + "properties" : { + "maximum" : { + "description" : "The maximum output power in kilowatts for a specified time period.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.electric_drive.electric_drive_passport_2.0.0_MaximumPowerCharacteristic" + }, + "continuousRegenerated" : { + "description" : "The amount of power, which can be regenerated continuously, within the bounds of normal operation, in kilowatts.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.electric_drive.electric_drive_passport_2.0.0_KilowattMeasurement" + }, + "maxRegenerated" : { + "description" : "The maximum possible value that can be regenerated at a given time in kilowatts.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.electric_drive.electric_drive_passport_2.0.0_MaximumRegeneratedPowerCharacteristic" + }, + "continuous" : { + "description" : "The power that can be delivered without time limit.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.transmission.transmission_pass_3.0.0_KilowattMeasurement" + } + }, + "required" : [ "maximum", "continuousRegenerated", "maxRegenerated", "continuous" ] + }, + "urn_samm_io.catenax.electric_drive.electric_drive_passport_2.0.0_NewtonMetreMeasurement" : { + "type" : "number", + "description" : "Measurement in newton metre as decimal value." + }, + "urn_samm_io.catenax.electric_drive.electric_drive_passport_2.0.0_MaximumTorqueCharacteristic" : { + "description" : "Characteristic for maximum torque values.", + "type" : "object", + "properties" : { + "value" : { + "description" : "Measured torque value in newton metre.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.electric_drive.electric_drive_passport_2.0.0_NewtonMetreMeasurement" + }, + "maximumAvailability" : { + "description" : "Specified time period for the peak measurement in seconds.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.transmission.transmission_pass_3.0.0_TimeMeasurement" + } + }, + "required" : [ "value", "maximumAvailability" ] + }, + "urn_samm_io.catenax.transmission.transmission_pass_3.0.0_TorqueNewtonMetre" : { + "type" : "number", + "minimum" : 0, + "description" : "Characteristic to describe torque in newton meters." + }, + "urn_samm_io.catenax.electric_drive.electric_drive_passport_2.0.0_TorqueCharacteristic" : { + "description" : "Entity for torque values.", + "type" : "object", + "properties" : { + "maximum" : { + "description" : "The maximum torque the system delivers over a specific measurement time period.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.electric_drive.electric_drive_passport_2.0.0_MaximumTorqueCharacteristic" + }, + "maxAxle" : { + "description" : "Maximum motor torque multiplied by the gear ratio.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.electric_drive.electric_drive_passport_2.0.0_MaximumTorqueCharacteristic" + }, + "continuous" : { + "description" : "The torque that can be delivered without time limit in newton meters.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.transmission.transmission_pass_3.0.0_TorqueNewtonMetre" + } + }, + "required" : [ "maximum", "maxAxle", "continuous" ] + }, + "urn_samm_io.catenax.electric_drive.electric_drive_passport_2.0.0_SystemCharacteristic" : { + "description" : "Characteristic for performance and system values.", + "type" : "object", + "properties" : { + "voltage" : { + "description" : "The characterizing voltage level in the vehicle in volts, to which the battery and electric drive are adjusted to.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.electric_drive.electric_drive_passport_2.0.0_VoltMeasurement" + }, + "power" : { + "description" : "Technical power figures in kilowatt.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.electric_drive.electric_drive_passport_2.0.0_PowerCharacteristic" + }, + "torque" : { + "description" : "Technical torque figures.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.electric_drive.electric_drive_passport_2.0.0_TorqueCharacteristic" + }, + "gearRatio" : { + "description" : "Gear ratio calculated by dividing the angular or rotational speed of the output shaft by the angular speed of the input shaft. It can also be calculated by dividing the total driving gear’s teeth by the total driven gear’s teeth.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.electric_drive.electric_drive_passport_2.0.0_RevolutionsMeasurement" + } + }, + "required" : [ "voltage", "power", "torque", "gearRatio" ] + }, + "urn_samm_io.catenax.transmission.transmission_pass_3.0.0_StringList" : { + "description" : "A list with the data types string.", + "type" : "array", + "items" : { + "type" : "string" + } + }, + "urn_samm_io.catenax.transmission.transmission_pass_3.0.0_OilCharacteristic" : { + "description" : "Characteristic for the oil.", + "type" : "object", + "properties" : { + "oilCapacity" : { + "description" : "The defined oil volume in the transmission in cubic decimeters.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.transmission.transmission_pass_3.0.0_Capacity" + }, + "oilType" : { + "description" : "The type of the oil for the transmission defined by the manufacturer of the transmission.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.transmission.transmission_pass_3.0.0_StringList" + } + }, + "required" : [ "oilCapacity", "oilType" ] + }, + "urn_samm_io.catenax.electric_drive.electric_drive_passport_2.0.0_TransmissionCharacteristic" : { + "description" : "Characteristic for transmission values.", + "type" : "object", + "properties" : { + "transmissionId" : { + "description" : "Transmission ID of the transmission i.e. serial number allowing for unequivocal identification of the transmission.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.electric_drive.electric_drive_passport_2.0.0_IdentifierCharacteristic" + }, + "gearboxStructure" : { + "description" : "Short description of the gearbox design, e.g. layshaft or planetary, depending on the technical design of the car.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "oil" : { + "description" : "The oil used for the transmission.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.transmission.transmission_pass_3.0.0_OilCharacteristic" + } + }, + "required" : [ "transmissionId", "gearboxStructure", "oil" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_HeaderTrait" : { + "type" : "string", + "description" : "Constraint for a maximum of 100 characters.", + "maxLength" : 100 + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentationEntity" : { + "description" : "Entity for a document with a header, type and content.", + "type" : "object", + "properties" : { + "content" : { + "description" : "The content of the document e.g a link.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "contentType" : { + "description" : "The type of content which can be expected in the \"content\" property. Examples are a link, restricted link, pdf, excel, etc.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "header" : { + "description" : "The header as a short description of the document with a maximum of 100 characters.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_HeaderTrait" + } + }, + "required" : [ "content", "contentType", "header" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentList" : { + "description" : "List of documents.", + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentationEntity" + } + }, + "urn_samm_io.catenax.electric_drive.electric_drive_passport_2.0.0_ElectricDriveDocumentsCharacteristic" : { + "description" : "Characteristic for specific documents of the electric drive.", + "type" : "object", + "properties" : { + "technicalDismantlingInstructions" : { + "description" : "Document containing information and instructions, including steps, diagrams and illustrations of removing or replacing the eDrive or dismantling it.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentList" + }, + "requiredToolsForDismantling" : { + "description" : "Document containing information and instructions for required tools or technologies pertaining to the removal, replacement or dismantling of the eDrive.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentList" + } + }, + "required" : [ "technicalDismantlingInstructions", "requiredToolsForDismantling" ] + }, + "urn_samm_io.catenax.electric_drive.electric_drive_passport_2.0.0_SpecificCharacteristic" : { + "description" : "The Characteristic to describe product specific parameters of the electric drive.", + "type" : "object", + "properties" : { + "generalInformation" : { + "description" : "General information to the eDrive system, including additional information in comparison to the identification category such as the service history and compatible vehicle types.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.electric_drive.electric_drive_passport_2.0.0_GeneralCharacteristic" + }, + "eMachine" : { + "description" : "Data of the e-Machine built into the eDrive, including information E-Machine model and technology (type), and the permanent magnet types / materials.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.electric_drive.electric_drive_passport_2.0.0_EMachineCharacteristic" + }, + "coolingAndLubricants" : { + "description" : "Information about the used lubricants and coolants, including liquid specifications and built-in technical lubricant systems.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.electric_drive.electric_drive_passport_2.0.0_LiquidsCharacteristic" + }, + "inverter" : { + "description" : "Inverter related data, that could be used in case of replacing or updating an inverter.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.electric_drive.electric_drive_passport_2.0.0_InverterCharacteristic" + }, + "systemAndPerformance" : { + "description" : "System and Performance information of the entire eDrive system.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.electric_drive.electric_drive_passport_2.0.0_SystemCharacteristic" + }, + "transmission" : { + "description" : "Information about the transmission built into the eDrive, including technical data.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.electric_drive.electric_drive_passport_2.0.0_TransmissionCharacteristic" + }, + "electricDriveDocuments" : { + "description" : "Documents pertaining to the removal, replacement, disassembly or dismantling of the entire eDrive.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.electric_drive.electric_drive_passport_2.0.0_ElectricDriveDocumentsCharacteristic" + } + }, + "required" : [ "generalInformation", "eMachine", "coolingAndLubricants", "inverter", "systemAndPerformance", "transmission", "electricDriveDocuments" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_StatusEnumeration" : { + "type" : "string", + "description" : "The current status of the product passport declared through either: draft, approved, invalid or expired.", + "enum" : [ "draft", "approved", "invalid", "expired" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DateTrait" : { + "type" : "string", + "description" : "Constraint fo a timestamp in the format (yyyy-mm-dd).", + "pattern" : "^\\d{4}-\\d{2}-\\d{2}$" + }, + "urn_samm_io.catenax.shared.business_partner_number_2.0.0_BpnlTrait" : { + "type" : "string", + "description" : "The provided regular expression ensures that the BPNL is composed of prefix 'BPNL', 10 digits and two alphanumeric letters.", + "pattern" : "^BPNL[a-zA-Z0-9]{12}$" + }, + "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_io.catenax.generic.digital_product_passport_5.0.0_IdentifierCharacteristic" : { + "type" : "string", + "description" : "Characteristic for Identifiers." + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_MetadataCharacteristic" : { + "description" : "Characteristic for the passport metadata of the digital product passport.", + "type" : "object", + "properties" : { + "version" : { + "description" : "The current version of the product passport. The possibility of modification/ updating the product passport needs to include versioning of the dataset. This attribute is an internal versioning from the passport issuer. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Article 8:\n(1) [...] The information in the product passport shall be accurate, complete, and up to date.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "status" : { + "description" : "The current status of the product passport declared through either: draft, approved, invalid or expired.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_StatusEnumeration" + }, + "expirationDate" : { + "description" : "The timestamp in the format (yyyy-mm-dd) for the product passport until when it is available or a comment describing this period. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Article 8:\n(2) (h) the period during which the product passport is to remain available, which shall correspond to at least the expected lifetime of a specific product.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DateTrait" + }, + "issueDate" : { + "description" : "The timestamp in the format (yyyy-mm-dd) since when the product passport is available.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DateTrait" + }, + "economicOperatorId" : { + "description" : "The identification of the owner/economic operator of the passport. Proposed, according to ISO 15459, is the CIN (company identification code). Other identification numbers like the tax identification number, value added tax identification number, commercial register number and the like are also valid entries. In the Catena-X network, the BPNL is used for the identification of companies and the information stored like contact information and addresses. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Annex III:\n(k) the [...] unique operator identifier code of the economic operator established in the Union responsible for carrying out the tasks set out in Article 4 of Regulation (EU) 2019/1020, or Article 15 of Regulation (EU) on general product safety, or similar tasks pursuant to other EU legislation applicable to the product.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.business_partner_number_2.0.0_BpnlTrait" + }, + "passportIdentifier" : { + "description" : "The identifier of the product passport, which is an uuidv4.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.uuid_2.0.0_UuidV4Trait" + }, + "predecessor" : { + "description" : "Identification of the preceding product passport. If there is no preceding passport, input a dummy value. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Article 8:\n(2)(g) [...] Any new product passport shall be linked to the product passport or passports of the original product whenever appropriate.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.uuid_2.0.0_UuidV4Trait" + }, + "backupReference" : { + "description" : "A reference to the data backup of the passport. This mandatory attribute will be further defined in the future. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex III:\n(kb) the reference of the certified independent third-party product passport service provider hosting the back-up copy of the product passport.\nArticle 10 also mentions:\n(c) the data included in the product passport shall be stored by the economic operator responsible for its creation or by certified independent third-party product passport service providers authorised to act on their behalf.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "registrationIdentifier" : { + "description" : "Identifier in the respective registry. This will be further defined in the future. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 in Article 12:\nBy [2 years from entering into force of this Regulation], the Commission shall set up and manage a digital registry (\"the registry\") storing in a secure manner at least the unique product identifier, the unique operator identifier, the unique facility identifiers. In case of products intended to be placed under the customs procedure 'release for free circulation', the registry shall also store the product commodity code. The registry shall also store the batteries' unique identifiers referred to in Article 77(3) of Regulation (EU) 2023/1542.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_IdentifierCharacteristic" + }, + "lastModification" : { + "description" : "Date of the latest modification.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DateTrait" + } + }, + "required" : [ "version", "expirationDate", "issueDate", "economicOperatorId", "passportIdentifier", "predecessor", "backupReference" ] + }, + "urn_samm_io.catenax.serial_part_3.0.0_KeyTrait" : { + "type" : "string", + "description" : "Constraint that ensures that the standard keys and custom key prefixes can be used.", + "pattern" : "^(manufacturerId|partInstanceId|batchId|van|customKey:\\w+)$" + }, + "urn_samm_io.catenax.serial_part_3.0.0_ValueCharacteristic" : { + "type" : "string", + "description" : "The value of an identifier." + }, + "urn_samm_io.catenax.serial_part_3.0.0_KeyValueList" : { + "description" : "A list of key value pairs for local identifiers, which are composed of a key and a corresponding value.", + "type" : "object", + "properties" : { + "key" : { + "description" : "The key of a local identifier. ", + "$ref" : "#/components/schemas/urn_samm_io.catenax.serial_part_3.0.0_KeyTrait" + }, + "value" : { + "description" : "The value of an identifier.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.serial_part_3.0.0_ValueCharacteristic" + } + }, + "required" : [ "key", "value" ] + }, + "urn_samm_io.catenax.serial_part_3.0.0_LocalIdentifierCharacteristic" : { + "description" : "A single serialized part may have multiple attributes, that uniquely identify a that part in a specific dataspace (e.g. the manufacturer`s dataspace)", + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/urn_samm_io.catenax.serial_part_3.0.0_KeyValueList" + }, + "uniqueItems" : true + }, + "urn_samm_io.catenax.batch_3.0.0_KeyTrait" : { + "type" : "string", + "description" : "Constraint that ensures that the predefined keys are used.", + "pattern" : "^(manufacturerId|batchId|customKey:\\w+)$" + }, + "urn_samm_io.catenax.batch_3.0.0_ValueCharacteristic" : { + "type" : "string", + "description" : "The value of an identifier." + }, + "urn_samm_io.catenax.batch_3.0.0_KeyValueList" : { + "description" : "A list of key value pairs for local identifiers, which are composed of a key and a corresponding value.", + "type" : "object", + "properties" : { + "key" : { + "description" : "The key of a local identifier.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.batch_3.0.0_KeyTrait" + }, + "value" : { + "description" : "The value of an identifier.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.batch_3.0.0_ValueCharacteristic" + } + }, + "required" : [ "key", "value" ] + }, + "urn_samm_io.catenax.batch_3.0.0_LocalIdentifierCharacteristic" : { + "description" : "A batch may have multiple attributes, which uniquely identify that batch in a specific dataspace(e.g. the manufacturer`s dataspace)", + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/urn_samm_io.catenax.batch_3.0.0_KeyValueList" + }, + "uniqueItems" : true + }, + "urn_samm_io.catenax.part_type_information_1.0.0_PartIdCharacteristic" : { + "type" : "string", + "description" : "The part ID is a multi-character string, usually assigned by an ERP system." + }, + "urn_samm_io.catenax.part_type_information_1.0.0_PartNameCharacteristic" : { + "type" : "string", + "description" : "Part name in string format from the respective system in the value chain." + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PartTypeCharacteristic" : { + "description" : "Characteristic for the part type.", + "type" : "object", + "properties" : { + "manufacturerPartId" : { + "description" : "Part ID as assigned by the manufacturer of the part. The part ID identifies the part in the manufacturer`s dataspace. The part ID references a specific version of a part. The version number must be included in the part ID if it is available. The part ID does not reference a specific instance of a part and must not be confused with the serial number.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.part_type_information_1.0.0_PartIdCharacteristic" + }, + "nameAtManufacturer" : { + "description" : "Name of the part as assigned by the manufacturer.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.part_type_information_1.0.0_PartNameCharacteristic" + } + }, + "required" : [ "manufacturerPartId", "nameAtManufacturer" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_CodeEntity" : { + "description" : "Code entity with code key and value.", + "type" : "object", + "properties" : { + "key" : { + "description" : "The code key for the identification of the product. Examples are GTIN, hash, DID, ISBN, TARIC. This attribute is mentioned in the ESPR proposal from March 30th, 2022 ANNEX III:\n(b) the unique product identifier at the level indicated in the applicable delegated act adopted pursuant to Article 4;\n(c) the Global Trade Identification Number as provided for in standard ISO/IEC 15459-6 or equivalent of products or their parts;\n(d) relevant commodity codes, such as a TARIC code as defined in Council Regulation (EEC) No 2658/87.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_IdentifierCharacteristic" + }, + "value" : { + "description" : "The code value for the identification of the product in regard to the chosen code name.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_IdentifierCharacteristic" + } + }, + "required" : [ "key", "value" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_CodeList" : { + "description" : "A list of additional codes.", + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_CodeEntity" + } + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DataCarrierCharacteristic" : { + "description" : "Data Carrier Characteristic for the product.", + "type" : "object", + "properties" : { + "carrierType" : { + "description" : "The type of data carrier such as a QR code on the product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 8:\n(2) (b) the types of data carrier to be used.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "carrierLayout" : { + "description" : "The positioning of data carrier on the product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 8:\n(2) (c) the layout in which the data carrier shall be presented and its positioning.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + } + }, + "required" : [ "carrierType", "carrierLayout" ] + }, + "urn_samm_io.catenax.shared.part_classification_1.0.0_ClassificationStandardCharacteristic" : { + "type" : "string", + "description" : "Identified classification standards that align to the Catena-X needs." + }, + "urn_samm_io.catenax.shared.part_classification_1.0.0_ClassificationIDCharacteristic" : { + "type" : "string", + "description" : "It can be numeric or a string, depending on the chosen classification standard." + }, + "urn_samm_io.catenax.shared.part_classification_1.0.0_ClassificationEntity" : { + "description" : "Encapsulates data related to the classification of the part.", + "type" : "object", + "properties" : { + "classificationStandard" : { + "description" : "Identified classification standards that align to the Catena-X needs.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.part_classification_1.0.0_ClassificationStandardCharacteristic" + }, + "classificationID" : { + "description" : "The classification ID of the part type according to the corresponding standard definition mentioned in the key value pair.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.part_classification_1.0.0_ClassificationIDCharacteristic" + }, + "classificationDescription" : { + "description" : "Optional property describing the classification standard.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + } + }, + "required" : [ "classificationStandard", "classificationID" ] + }, + "urn_samm_io.catenax.shared.part_classification_1.0.0_ClassificationCharacteristic" : { + "description" : "Classification characteristic enabling a set of further properties.", + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.part_classification_1.0.0_ClassificationEntity" + }, + "uniqueItems" : true + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_IdentificationCharacteristic" : { + "description" : "Identification information of the product.", + "type" : "object", + "properties" : { + "serial" : { + "description" : "Identifier for a serial part if available. This is mentioned in the ESPR provisional agreement from January 9th, 2024 Recital (27):\n[...] an 'item' usually means a single unit of a model.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.serial_part_3.0.0_LocalIdentifierCharacteristic" + }, + "batch" : { + "description" : "Identifier for a batch part if available. Identifier for a serial part if available. This is mentioned in the ESPR provisional agreement from January 9th, 2024 Recital (27):\n[...] a 'batch' usually means a subset of a specific model composed of all products produced in a specific manufacturing plant at a specific moment in time [...].", + "$ref" : "#/components/schemas/urn_samm_io.catenax.batch_3.0.0_LocalIdentifierCharacteristic" + }, + "type" : { + "description" : "Identifier on the level of a part model or type. Identifier for a serial part if available. This is mentioned in the ESPR provisional agreement from January 9th, 2024 Recital (27):\n[...] A 'model' usually means a version of a product of which all units share the same technical characteristics relevant for the ecodesign requirements and the same model identifier [...].", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PartTypeCharacteristic" + }, + "codes" : { + "description" : "Codes for identification.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_CodeList" + }, + "dataCarrier" : { + "description" : "The type and layout of the data carrier on the product. These are mentioned in the ESPR proposal from March 30th, 2022 Article 8:\n(b) the types of data carrier to be used;\n(c) the layout in which the data carrier shall be presented and its positioning;\nArticle 2 defines:\n(30) 'data carrier' means a linear bar code symbol, a two-dimensional symbol or other automatic identification data capture medium that can be read by a device.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DataCarrierCharacteristic" + }, + "classification" : { + "description" : "Property describing the classification of a part.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.part_classification_1.0.0_ClassificationCharacteristic" + } + }, + "required" : [ "type", "codes", "dataCarrier", "classification" ] + }, + "urn_samm_io.catenax.shared.business_partner_number_2.0.0_BpnaTrait" : { + "type" : "string", + "description" : "The provided regular expression ensures that the BPNA is composed of prefix 'BPNA', 10 digits and two alphanumeric letters.", + "pattern" : "^BPNA[a-zA-Z0-9]{12}$" + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_FacilityEntity" : { + "description" : "The entity for a facility with the BPNA identifier.", + "type" : "object", + "properties" : { + "facility" : { + "description" : "The identifier used for a location. This attribute is mentioned in the ESPR provisional agreement from January 9th 2024 Annex III:\n(i) unique facility identifiers;\nArticle 2 Definitions: (33) 'unique facility identifier' means a unique string of characters for the identification of locations or buildings involved in the value chain of a product or used by actors involved in the value chain of a product.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.business_partner_number_2.0.0_BpnaTrait" + } + }, + "required" : [ "facility" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_FacilityList" : { + "description" : "List of facilities.", + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_FacilityEntity" + } + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_ManufacturerCharacteristic" : { + "description" : "Manufacturing information.", + "type" : "object", + "properties" : { + "facility" : { + "description" : "The identifier used for a location. In the CATENA-X use case, the BPNA can be stated. This attribute is mentioned in the ESPR provisional agreement from January 9th 2024 Annex III:\n(i) unique facility identifiers;\nArticle 2 Definitions: (33) 'unique facility identifier' means a unique string of characters for the identification of locations or buildings involved in the value chain of a product or used by actors involved in the value chain of a product.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_FacilityList" + }, + "manufacturer" : { + "description" : "The main manufacturer, if different from the passport owner, represented by an identification number. In the Catena-X use case, the BPNL can be stated. This attribute is mentioned in the ESPR provisional agreement from January 9th 2024 Annex III:\n(h) unique operator identifiers other than that of the manufacturer;\n(k) the name, contact details and unique operator identifier code of the economic operator established in the Union responsible for carrying out the tasks set out in Article 4 of Regulation (EU) 2019/1020, or Article 15 of Regulation (EU) [.../...] on general product safety, or similar tasks pursuant to other EU legislation applicable to the product.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.business_partner_number_2.0.0_BpnlTrait" + }, + "manufacturingDate" : { + "description" : "The timestamp in the format (yyyy-mm-dd) of the manufacturing date as the final step in production process (e.g. final quality check, ready-for-shipment event).", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DateTrait" + } + }, + "required" : [ "facility", "manufacturer" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_EoriTrait" : { + "type" : "string", + "description" : "Constraint with a pattern which ensures that the EORI number starts with two alphanumeric characters, followed by two alphabetic characters, and ends with 2 to 15 alphanumeric characters.", + "pattern" : "^[A-Z]{2}[A-Z0-9]{1,18}$" + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_ImporterCharacteristic" : { + "description" : "Characteristic with information regarding the importer.", + "type" : "object", + "properties" : { + "eori" : { + "description" : "An economic operator established in the customs territory of the Union needs, for customs purposes, an EORI number. EORI stands for economic operators registration and identification number. In this case, the importer's EORI must be provided. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Annex III:\n(j) information related to the importer, including the information referred to in Article 23(3) and its EORI number.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_EoriTrait" + }, + "id" : { + "description" : "The importer of the product, if different from the owner of the passport. In the Catena-X network, the BPNL is used for the identification of companies and the information stored for this like contact information and addresses.\nThis attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex III:\n(j) information related to the importer, including the information referred to in Article 23(3) and its EORI number;\nArticle 23 states:\n(3) Importers shall, for products covered by a delegated act adopted pursuant to Article 4, indicate their name, registered trade name or registered trade mark and the postal address and electronic means of communication, where they can be contacted: (a) on the public part of the product passport, when applicable, and\n(b) on the product or, where this is not possible, on the packaging, or in a document accompanying the product.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.business_partner_number_2.0.0_BpnlTrait" + } + }, + "required" : [ "eori", "id" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_ImportCharacteristic" : { + "description" : "Import Characteristic for the product.", + "type" : "object", + "properties" : { + "content" : { + "description" : "Information regarding the importer of the product, if different from the owner of the passport. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex III:\n(j) information related to the importer, including the information referred to in Article 23(3) and its EORI number;\nArticle 23 states:\n(3) Importers shall, for products covered by a delegated act adopted pursuant to Article 4, indicate their name, registered trade name or registered trade mark and the postal address and electronic means of communication, where they can be contacted: (a) on the public part of the product passport, when applicable, and\n(b) on the product or, where this is not possible, on the packaging, or in a document accompanying the product.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_ImporterCharacteristic" + }, + "applicable" : { + "description" : "Check whether the connected attributes are applicable to the product. If it is not applicable (false), dummy data can be delivered.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Boolean" + } + }, + "required" : [ "content", "applicable" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_OperatorCharacteristic" : { + "description" : "Other operators characteristic.", + "type" : "object", + "properties" : { + "id" : { + "description" : "Identifier of the other operator. This can be a BPN.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "role" : { + "description" : "Role of the other operator.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + } + }, + "required" : [ "id", "role" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_OperationCharacteristic" : { + "description" : "Operational information of the product.", + "type" : "object", + "properties" : { + "manufacturer" : { + "description" : "Manufacturing information of the product. In the CATENA-X use case, the BPNL and BPNA can be stated. These attributes are mentioned in the ESPR provisional agreement from January 9th 2024 Annex III:\n(h) unique operator identifiers other than that of the manufacturer;\n(k) the name, contact details and unique operator identifier code of the economic operator established in the Union responsible for carrying out the tasks set out in Article 4 of Regulation (EU) 2019/1020, or Article 15 of Regulation (EU) [.../...] on general product safety, or similar tasks pursuant to other EU legislation applicable to the product.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_ManufacturerCharacteristic" + }, + "import" : { + "description" : "Importer details such as the identification.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_ImportCharacteristic" + }, + "other" : { + "description" : "Other operators relevant for the product.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_OperatorCharacteristic" + } + }, + "required" : [ "manufacturer", "import" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_SourcesEntity" : { + "description" : "Entity for a possible spare part sources.", + "type" : "object", + "properties" : { + "id" : { + "description" : "The identifier of a spare part producer of the product. In the Catena-X network, the BPNL is used for the identification of companies and the information stored for this like contact information and addresses.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.business_partner_number_2.0.0_BpnlTrait" + } + }, + "required" : [ "id" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_SourcesList" : { + "description" : "List of possible spare part sources.", + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_SourcesEntity" + } + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PartsEntity" : { + "description" : "Possible spare parts of the product with identifiers and names.", + "type" : "object", + "properties" : { + "manufacturerPartId" : { + "description" : "Part ID as assigned by the manufacturer of the part. The part ID identifies the part in the manufacturer`s dataspace. The part ID references a specific version of a part. The version number must be included in the part ID if it is available. The part ID does not reference a specific instance of a part and must not be confused with the serial number.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.part_type_information_1.0.0_PartIdCharacteristic" + }, + "nameAtManufacturer" : { + "description" : "Name of the part as assigned by the manufacturer.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.part_type_information_1.0.0_PartNameCharacteristic" + } + }, + "required" : [ "manufacturerPartId", "nameAtManufacturer" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PartList" : { + "description" : "A list of possible spare parts of the product.", + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PartsEntity" + } + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_SparePart" : { + "description" : "Characteristic describing sources and spare parts.", + "type" : "object", + "properties" : { + "producer" : { + "description" : "Sources of possible spare parts.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_SourcesList" + }, + "sparePart" : { + "description" : "Possible spare parts of the product.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PartList" + } + }, + "required" : [ "producer", "sparePart" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_HandlingCharacteristic" : { + "description" : "Characteristic to describe aspects which are connected with the handling of the product.", + "type" : "object", + "properties" : { + "content" : { + "description" : "The list of spare parts available for the product from various suppliers.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_SparePart" + }, + "applicable" : { + "description" : "Check whether the connected attributes are applicable to the product. If it is not applicable (false), dummy data can be delivered.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Boolean" + } + }, + "required" : [ "content", "applicable" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_LifeEnumeration" : { + "type" : "string", + "description" : "Enumeration with the possible units day, month, cycle, year and runningOrOperatingHour.", + "enum" : [ "unit:day", "unit:month", "unit:year", "unit:cycle", "unit:runningOrOperatingHour" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_LifeValueCharacteristic" : { + "type" : "number", + "description" : "Characteristic for the life span value as an integer." + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_LifeTypeEnumeration" : { + "type" : "string", + "description" : "Enumeration with the values guaranteed lifetime, technical lifetime and mean time between failures.", + "enum" : [ "guaranteed lifetime", "technical lifetime", "mean time between failures" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_LifespanEntity" : { + "description" : "Entity for the lifespan of a product with type, unit and value.", + "type" : "object", + "properties" : { + "unit" : { + "description" : "The unit of the respective lifespan expressed through the possible units day, month, cycle, year and runningOrOperatingHour.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_LifeEnumeration" + }, + "value" : { + "description" : "The value as an integer for the respective lifespan.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_LifeValueCharacteristic" + }, + "key" : { + "description" : "The type of lifespan represented with the values guaranteed lifetime, technical lifetime and mean time between failures. This attribute is mentioned in the ESPR proposal from March 30th, 2022 ANNEX I:\n(a) durability and reliability of the product or its components as expressed through the product's guaranteed lifetime, technical lifetime [or] mean time between failures [...].", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_LifeTypeEnumeration" + } + }, + "required" : [ "unit", "value", "key" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_LifespanList" : { + "description" : "List of different life spans of a product.", + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_LifespanEntity" + } + }, + "urn_samm_io.catenax.shared.quantity_2.0.0_LinearUnitEnumeration" : { + "type" : "string", + "pattern" : "[a-zA-Z]*:[a-zA-Z]+", + "description" : "The unit of a linear attribute that may be used for height, width, length and diameter.", + "enum" : [ "unit:millimetre", "unit:centimetre", "unit:metre", "unit:kilometre", "unit:inch", "unit:foot", "unit:yard" ] + }, + "urn_samm_io.catenax.shared.quantity_2.0.0_LinearCharacteristic" : { + "description" : "Characteristic for linear measurements of an item.", + "type" : "object", + "properties" : { + "value" : { + "description" : "The quantity value associated with the unit.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.quantity_2.0.0_QuantityValueCharacteristic" + }, + "unit" : { + "description" : "The unit of a linear attribute.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.quantity_2.0.0_LinearUnitEnumeration" + } + }, + "required" : [ "value", "unit" ] + }, + "urn_samm_io.catenax.shared.quantity_2.0.0_VolumeUnitEnumeration" : { + "type" : "string", + "pattern" : "[a-zA-Z]*:[a-zA-Z]+", + "description" : "Enumeration for volume units.", + "enum" : [ "unit:cubicMetre", "unit:litre", "unit:millilitre", "unit:cubicCentimetre", "unit:cubicInch", "unit:cubicFoot", "unit:cubicYard", "unit:hectolitre" ] + }, + "urn_samm_io.catenax.shared.quantity_2.0.0_VolumeCharacteristic" : { + "description" : "Characteristic for volume measurements of an item.", + "type" : "object", + "properties" : { + "value" : { + "description" : "The quantity value associated with the unit.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.quantity_2.0.0_QuantityValueCharacteristic" + }, + "unit" : { + "description" : "The unit of a volume related attribute.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.quantity_2.0.0_VolumeUnitEnumeration" + } + }, + "required" : [ "value", "unit" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PhysicalDimensionCharacteristic" : { + "description" : "Characteristic for physical dimensions with linear, mass and capacity attributes.", + "type" : "object", + "properties" : { + "width" : { + "description" : "The width of the item measured in a specific linear unit which can be declared in the corresponding unit attribute.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.quantity_2.0.0_LinearCharacteristic" + }, + "length" : { + "description" : "The length of the item measured in a specific linear unit which can be declared in the corresponding unit attribute.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.quantity_2.0.0_LinearCharacteristic" + }, + "diameter" : { + "description" : "The diameter of the item, if applicable, measured in a specific linear unit which can be declared in the corresponding unit attribute.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.quantity_2.0.0_LinearCharacteristic" + }, + "height" : { + "description" : "The height of the item measured in a specific linear unit which can be declared in the corresponding unit attribute.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.quantity_2.0.0_LinearCharacteristic" + }, + "grossWeight" : { + "description" : "The gross weight of the item measured in a specific mass unit which can be declared in the corresponding unit attribute. Gross weight refers to the total weight of a product, including the weight of the packaging. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7:\n(2) (b) (i) information on the performance of the product in relation to the product parameters referred to in Annex I;\nAnnex I (i) weight and volume of the product and its packaging, and the product-to-packaging ratio.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.quantity_2.0.0_MassCharacteristic" + }, + "grossVolume" : { + "description" : "The gross volume of the item, if possible, measured in a specific capacity unit which can be declared in the corresponding unit attribute. If there is no separate packing, the volume of the product shall be given. Gross volume refers to the total volume of a product, including the volume of the packaging. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7:\n(2) (b) (i) information on the performance of the product in relation to the product parameters referred to in Annex I;\nAnnex I (i) weight and volume of the product and its packaging, and the product-to-packaging ratio.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.quantity_2.0.0_VolumeCharacteristic" + }, + "weight" : { + "description" : "Weight of the product measured in a specific mass unit which can be declared in the corresponding unit attribute. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7:\n(2) (b) (i) information on the performance of the product in relation to the product parameters referred to in Annex I;\nAnnex I (i) weight and volume of the product [...].", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.quantity_2.0.0_MassCharacteristic" + }, + "volume" : { + "description" : "Volume of the product, if possible, measured in a specific capacity unit which can be declared in the corresponding unit attribute. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7:\n(2) (b) (i) information on the performance of the product in relation to the product parameters referred to in Annex I;\nAnnex I (i) weight and volume of the product [...].", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.quantity_2.0.0_VolumeCharacteristic" + } + }, + "required" : [ "grossWeight", "grossVolume", "weight", "volume" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PhysicalStateEnumeration" : { + "type" : "string", + "description" : "Enumeration with the values solid, liquid, gas and plasma.", + "enum" : [ "solid", "liquid", "gas", "plasma" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_ProductCharacteristics" : { + "description" : "Defines a set of specific characteristics of a product.", + "type" : "object", + "properties" : { + "lifespan" : { + "description" : "The type of lifespan represented with the values guaranteed lifetime, technical lifetime and mean time between failures. Both can be described through the attributes: type, which defines the type such as guaranteed lifetime or technical lifetime, the unit for the lifetime, and the value represented by an integer. These attributes are mentioned in the ESPR proposal from March 30th, 2022 ANNEX I:\n(a) durability and reliability of the product or its components as expressed through the products guaranteed lifetime, technical lifetime [or] mean time between failures [...].", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_LifespanList" + }, + "physicalDimension" : { + "description" : "Physical dimensions are properties associated with physical quantities for purposes of classification or differentiation. These attributes are mentioned in the ESPR provisional agreement from January 9th, Article 7:\n(2) (b) (i) information on the performance of the product in relation to one or more of the product parameters referred to in Annex I;\nAnnex I (i) weight and volume of the product and its packaging, and the product-to-packaging ratio.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PhysicalDimensionCharacteristic" + }, + "physicalState" : { + "description" : "The physical state of the item. There are four states of matter solid, liquid, gas and plasma which can be chosen from an enumeration.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PhysicalStateEnumeration" + }, + "generalPerformanceClass" : { + "description" : "The performance class of the product. This attribute is mentioned ESPR provisional agreement from January 9th, 2024 Article 7:\n4. When establishing the information requirements referred to in paragraph 2, point (b), point (i), the Commission shall, as appropriate in view of the specificity of the product group, determine classes of performance. Classes of performance may be based on single parameters, on aggregated scores, in absolute terms or in any other form that enables potential customers to choose the best performing products. Those classes of performance shall correspond to significant improvements in performance levels. Where classes of performance are based on parameters in relation to which performance requirements are established, they shall use as the minimum level the minimum performance required at the time when the classes of performance start to apply.\nDefinition:\n'class of performance': means a range of performance levels in relation to one or more product parameters referred to in Annex I, based on a common methodology for the product or product group, ordered into successive steps to allow for product differentiation.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + } + }, + "required" : [ "lifespan", "physicalDimension" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_StringList" : { + "description" : "List of strings.", + "type" : "array", + "items" : { + "type" : "string" + } + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_CommercialCharacteristic" : { + "description" : "Commercial information of the product.", + "type" : "object", + "properties" : { + "placedOnMarket" : { + "description" : "The timestamp in the format (yyyy-mm-dd) with or without time zone when the product was put in the market.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DateTrait" + }, + "purpose" : { + "description" : "One or more intended industry/industries of the product described by the digital product passport. If exchanged via Catena-X, 'automotive ' is a must choice included in the list.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_StringList" + } + }, + "required" : [ "purpose" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_ConcentrationEnumeration" : { + "type" : "string", + "description" : "Enumeration of possible units of concentration with percent, volume percent, parts per thousand, parts per million, parts per billion and parts per trillion.", + "enum" : [ "unit:partPerMillion", "unit:percent", "unit:percentVolume", "unit:partPerThousand", "unit:partPerTrillionUs", "unit:partPerBillionUs" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PositiveTrait" : { + "type" : "number", + "description" : "Constraint for only positive values.", + "minimum" : 0.0, + "exclusiveMinimum" : false + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_HazardCharacteristic" : { + "description" : "Characteristic for the hazardous classification.", + "type" : "object", + "properties" : { + "category" : { + "description" : "The hazard category of the substance of concern. Defined in Article 2 of Regulation (EC) No 1272/2008 of the European Parliament and of the Council of 16 December 2008 on classification, labelling and packaging of substances and mixtures, amending and repealing Directives 67/548/EEC and 1999/45/EC, and amending Regulation (EC) No 1907/2006:\n2. 'hazard category' means the division of criteria within each hazard class, specifying hazard severity.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "class" : { + "description" : "The hazard class of the substance of concern. Defined in Article 2 of Regulation (EC) No 1272/2008 of the European Parliament and of the Council of 16 December 2008 on classification, labelling and packaging of substances and mixtures, amending and repealing Directives 67/548/EEC and 1999/45/EC, and amending Regulation (EC) No 1907/2006:\n1. 'hazard class' means the nature of the physical, health or environmental hazard.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "statement" : { + "description" : "The hazard statement of the substance of concern. Defined in Article 2 of Regulation (EC) No 1272/2008 of the European Parliament and of the Council of 16 December 2008 on classification, labelling and packaging of substances and mixtures, amending and repealing Directives 67/548/EEC and 1999/45/EC, and amending Regulation (EC) No 1907/2006:\n5. 'hazard statement' means a phrase assigned to a hazard class and category that describes the nature of the hazards of a hazardous substance or mixture, including, where appropriate, the degree of hazard.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + } + }, + "required" : [ "category", "class", "statement" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_RangeEntity" : { + "description" : "Entity for the concentration range with two values, the highest and the lowest of the concentration range.", + "type" : "object", + "properties" : { + "min" : { + "description" : "The minimum concentration of the substance of concern at the level of the product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7:\n(5) (c) [...] concentration range of the substances of concern, at the level of the product [...].", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PositiveTrait" + }, + "max" : { + "description" : "The maximum concentration of the substance of concern at the level of the product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7:\n(5) (c) the concentration, maximum concentration or concentration range of the substances of concern, at the level of the product [...].", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PositiveTrait" + } + }, + "required" : [ "max" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_RangeCharacteristic" : { + "description" : "Range characteristic with two values, the highest and the lowest of the concentration range. Only providing the maximum range is also possible.", + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_RangeEntity" + } + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_ListTypeEnumerationId" : { + "type" : "string", + "description" : "Enumeration of different systems and organizations related to the identification and classification of chemical substances in the field of chemistry. The enumeration values are EC or CAS.", + "enum" : [ "CAS", "EC", "IUPAC" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_MaterialIdEntity" : { + "description" : "Id Entity with identifier, name and list type.", + "type" : "object", + "properties" : { + "id" : { + "description" : "The substance identification, in accordance with the specification in the attribute for the list type.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_IdentifierCharacteristic" + }, + "type" : { + "description" : "The type of standard used for the identification of the substances. Selected can be for example CAS, IUPAC or EC.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_ListTypeEnumerationId" + }, + "name" : { + "description" : "The name of the material which is present in the product.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + } + }, + "required" : [ "id", "type", "name" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_MaterialIdList" : { + "description" : "List of ids for the identification.", + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_MaterialIdEntity" + } + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_SubstanceEntity" : { + "description" : "Information regarding substances of concern in the product.", + "type" : "object", + "properties" : { + "location" : { + "description" : "The location of the substances of concern within the product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7:\n(5) (b) the location of the substances of concern within the product.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "unit" : { + "description" : "The unit of concentration chosen from an enumeration: mass percent, volume percent, parts per thousand, parts per million, parts per billion and parts per trillion.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_ConcentrationEnumeration" + }, + "concentration" : { + "description" : "Concentration of the material at the level of the product. This attribute is specially mentioned for substances of concern mentioned in the ESPR proposal from March 30th, 2022 Article 7:\n(5) (c) the concentration, maximum concentration or concentration range of the substances of concern, at the level of the product [...].\nOther substances are mentioned for the purpose of recycling in the ESPR provisional agreement from January 9th, 2024 Annex I:\n(d) design for recycling, ease and quality of recycling as expressed through: use of easily recyclable materials, safe, easy and non-destructive access to recyclable components and materials or components and materials containing hazardous substances and material composition and homogeneity, possibility for high-purity sorting, number of materials and components used, use of standard components, use of component and material coding standards for the identification of components and materials, number and complexity of processes and tools needed, ease of nondestructive disassembly and re-assembly, conditions for access to product data, conditions for access to or use of hardware and software needed.\n", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PositiveTrait" + }, + "exemption" : { + "description" : "Exemptions to the substance of concern. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Article 7:\n(5) (c) provide duly justified exemptions for substances of concern or information elements from the information requirements referred to in the first subparagraph based on the technical feasibility or relevance of tracking substances of concern, the existence of analytical methods to detect and quantify them, the need to protect confidential business information or in other duly justified cases. Substances of concern within the meaning of Article 2(28), point a), shall not be exempted if they are present in products, their relevant components or spare parts in a concentration above 0,1 % weight by weight.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "hazardClassification" : { + "description" : "The specification of the hazard class. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I:\n(f) use of substances, and in particular the use of substances of concern, on their own, as constituents of substances or in mixtures, during the production process of products, or leading to their presence in products, including once these products become waste, and their impacts on human health and the environment;\nFurther defined is this by Regulation (EC) No 1272/2008 of the European Parliament and of the Council of 16 December 2008 on classification, labelling and packaging of substances and mixtures, amending and repealing Directives 67/548/EEC and 1999/45/EC, and amending Regulation (EC) No 1907/2006.\nDefined in Article 2:\n1. 'hazard class' means the nature of the physical, health or environmental hazard;\n2. 'hazard category' means the division of criteria within each hazard class, specifying hazard severity;\n5. 'hazard statement' means a phrase assigned to a hazard class and category that describes the nature of the hazards of a hazardous substance or mixture, including, where appropriate, the degree of hazard;", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_HazardCharacteristic" + }, + "concentrationRange" : { + "description" : "The concentration range for the substance of concern. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7:\n(5) (c) [...] concentration range of the substances of concern, at the level of the product [...].", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_RangeCharacteristic" + }, + "id" : { + "description" : "The chemical material name and identification, in accordance with the specification in the attribute for the list type. Preference is given to the IUPAC name. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Article 7:\n(5) (a) the name of the substances of concern present in the product, as follows:\n - name(s) in the International Union of Pure and Applied Chemistry (IUPAC) nomenclature, or another international name when IUPAC name is not available; \n- other names (usual name, trade name, abbreviation);\n- European Community (EC) number, as indicated in the European Inventory of Existing Commercial Chemical Substances (EINECS), the European List of Notified Chemical Substances (ELINCS) or the No Longer Polymer (NLP) list or assigned by the European Chemicals Agency (ECHA), if available;\n- the Chemical Abstract Service (CAS) name(s) and number(s), if available; .", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_MaterialIdList" + }, + "documentation" : { + "description" : "Documentation accompanying the material.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentList" + } + }, + "required" : [ "location", "unit", "concentration", "exemption", "hazardClassification", "concentrationRange", "id", "documentation" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_SubstanceList" : { + "description" : "Characteristic for a list of substances of concern.", + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_SubstanceEntity" + } + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_SubstanceOfConcernCharacteristic" : { + "description" : "Substance of concern Characteristic of the product.", + "type" : "object", + "properties" : { + "applicable" : { + "description" : "Check whether the connected attributes are applicable to the product. If it is not applicable (false), dummy data can be delivered.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Boolean" + }, + "content" : { + "description" : "Information regarding substances of concern in the product. Attributes are among others substance names, ids, concentration, location and hazard class. This is mentioned in the ESPR provisional agreement from January 9th, 2024 Article 7:\n(5) (a) the name of the substances of concern present in the product, as follows:\n- name(s) in the International Union of Pure and Applied Chemistry (IUPAC) nomenclature, or another international name when IUPAC name is not available; \n- other names (usual name, trade name, abbreviation);\n- European Community (EC) number, as indicated in the European Inventory of Existing Commercial Chemical Substances (EINECS), the European List of Notified Chemical Substances (ELINCS) or the No Longer Polymer (NLP) list or assigned by the European Chemicals Agency (ECHA), if available;\n- the Chemical Abstract Service (CAS) name(s) and number(s), if available;\n(5) (b) the location of the substances of concern within the product.\n(5) (c) the concentration, maximum concentration or concentration range of the substances of concern, at the level of the product its relevant components, or spare parts;\n(d) relevant instructions for the safe use of the product;\n(e) information relevant for disassembly, preparation for reuse, reuse, recycling and the environmentally sound management of the product at the end of its life.\nAnd in the next paragraph:\n(c) provide duly justified exemptions for substances of concern or information elements from the information requirements referred to in the first subparagraph.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_SubstanceList" + } + }, + "required" : [ "applicable", "content" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PercentageTrait" : { + "type" : "number", + "description" : "Range constraint for a positive percentage value.", + "maximum" : 100.0, + "exclusiveMaximum" : false, + "minimum" : 0.0, + "exclusiveMinimum" : false + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_MaterialEntity" : { + "description" : "Information regarding recycled and/or renewable materials in the product.", + "type" : "object", + "properties" : { + "recycled" : { + "description" : "The share of the material, which is recovered recycled content from the product. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I:\n(h) use or content of recycled materials and recovery of materials, including critical raw materials;", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PercentageTrait" + }, + "renewable" : { + "description" : "The share of the material, which is from a renewable resource that can be replenished. Renewable resources are those that can be reproduced by physical, chemical, or mechanical processes. These are the kind of resources that can be regenerated throughout time. Forest wood, for example, can be grown through reforestation. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I:\n(ha) use or content of sustainable renewable materials;\n", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PercentageTrait" + }, + "unit" : { + "description" : "The unit of concentration chosen from an enumeration: mass percent, volume percent, parts per thousand, parts per million, parts per billion and parts per trillion.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_ConcentrationEnumeration" + }, + "id" : { + "description" : "The chemical material name and identification, in accordance with the specification in the attribute for the list type. Preference is given to the IUPAC name. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Article 7:\n(5) (a) the name of the substances of concern present in the product, as follows:\n - name(s) in the International Union of Pure and Applied Chemistry (IUPAC) nomenclature, or another international name when IUPAC name is not available; \n- other names (usual name, trade name, abbreviation);\n- European Community (EC) number, as indicated in the European Inventory of Existing Commercial Chemical Substances (EINECS), the European List of Notified Chemical Substances (ELINCS) or the No Longer Polymer (NLP) list or assigned by the European Chemicals Agency (ECHA), if available;\n- the Chemical Abstract Service (CAS) name(s) and number(s), if available; .", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_MaterialIdList" + }, + "critical" : { + "description" : "A flag, if the material is a critical raw material. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I:\n(h) use or content of recycled materials and recovery of materials, including critical raw materials;\nIn Annex II of the connected proposal Act of Critical Raw Materials, a list of critical raw materials can be found.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Boolean" + }, + "concentration" : { + "description" : "Concentration of the material at the level of the product. This attribute is specially mentioned for substances of concern mentioned in the ESPR proposal from March 30th, 2022 Article 7:\n(5) (c) the concentration, maximum concentration or concentration range of the substances of concern, at the level of the product [...].\nOther substances are mentioned for the purpose of recycling in the ESPR provisional agreement from January 9th, 2024 Annex I:\n(d) design for recycling, ease and quality of recycling as expressed through: use of easily recyclable materials, safe, easy and non-destructive access to recyclable components and materials or components and materials containing hazardous substances and material composition and homogeneity, possibility for high-purity sorting, number of materials and components used, use of standard components, use of component and material coding standards for the identification of components and materials, number and complexity of processes and tools needed, ease of nondestructive disassembly and re-assembly, conditions for access to product data, conditions for access to or use of hardware and software needed.\n", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PositiveTrait" + }, + "documentation" : { + "description" : "Documentation accompanying the material.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentList" + } + }, + "required" : [ "recycled", "renewable", "unit", "id", "critical", "concentration", "documentation" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_MaterialList" : { + "description" : "A list of different materials in the product.", + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_MaterialEntity" + } + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_MaterialCharacteristic" : { + "description" : "Material Characteristic with information on the materials.", + "type" : "object", + "properties" : { + "applicable" : { + "description" : "Check whether the connected attributes are applicable to the product. If it is not applicable (false), dummy data can be delivered.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Boolean" + }, + "content" : { + "description" : "Information on different materials in the product.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_MaterialList" + } + }, + "required" : [ "applicable", "content" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_MaterialsCharacteristic" : { + "description" : "Materials Characteristic on product level.", + "type" : "object", + "properties" : { + "substancesOfConcern" : { + "description" : "Information regarding substances of concern in the product. The ESPR provisional agreement from January 9th, 2024 defines:\n(52) 'hazardous substance' means a substance classified as hazardous pursuant to Article 3 of Regulation (EC) No 1272/2008.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_SubstanceOfConcernCharacteristic" + }, + "materialComposition" : { + "description" : "Material composition of the product with information on recycled and renewable materials.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_MaterialCharacteristic" + } + }, + "required" : [ "substancesOfConcern", "materialComposition" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_StateEnumeration" : { + "type" : "string", + "description" : "Enumeration defined as original, repurposed, re-used, remanufactured or waste.", + "enum" : [ "original", "repurposed", "re-used", "remanufactured", "waste" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_CategoryEnumeration" : { + "type" : "string", + "description" : "Enumeration of the 19 impact categories in accordance to EN15804+A2.", + "enum" : [ "Climate Change Total", "Climate Change Fossil", "Climate Change Biogenic Removals and Emissions", "Climate Change Land Use and Land Use Change", "Ozone Depletion", "Acidification", "Eutrophication Aquatic Freshwater", "Eutrophication Fresh Marine", "Eutrophication Terrestrial", "Photochemical Ozone Formation", "Abiotic Depletion- Minerals and Metals", "Fossil Fuels", "Water Use", "Particulate Matter Emissions", "Ionizing Radiation, Human Health", "Eco-Toxicity", "Human Toxicity, Cancer Effects", "Human Toxicity, Non-Cancer Effects", "Land Use Related Impacts/Soil Quality" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_FootprintEntity" : { + "description" : "Footprint Entity for the carbon and environmental footprint with the total value, unit, impact category type, lifecycle, rulebook, declaration, performance class and the facility.", + "type" : "object", + "properties" : { + "value" : { + "description" : "The value of the footprint of the product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Annex I:\n(l) the environmental footprint of the product, expressed as a quantification, in accordance with the applicable delegated act, of a product's life cycle environmental impacts, whether in relation to one or more environmental impact categories or an aggregated set of impact categories;\n(m) the carbon footprint of the product;\n(ma) the material footprint of the product.\n", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PositiveTrait" + }, + "rulebook" : { + "description" : "The applied rulebook for the environmental footprint of the product.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentList" + }, + "lifecycle" : { + "description" : "The lifecycle stage, to which the environmental footprint corresponds. These could be for example \"raw material acquisition and pre-processing\", \"main product production\", \"distribution\" or \"end of life and recycling\".", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "unit" : { + "description" : "The unit of measurement of the environmental impact category. For each impact category a specific unit is used. If an aggregation is used, utilize the normalization and weighting methods used in the referenced rulebook.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "type" : { + "description" : "The type of the environmental footprint of the product. This could be one of the environmental impact categories. This attribute is mentioned in the ESPR provisional agreement from January 9th 2024 Article 7:\n(2)(b)(i) information on the performance of the product in relation to one or more of the product parameters referred to in Annex I, including a scoring of reparability or durability, carbon footprint or environmental footprint;\nAnnex I:\n(l) the environmental footprint of the product, expressed as a quantification, in accordance with the applicable delegated act, of a product's life cycle environmental impacts, whether in relation to one or more environmental impact categories or an aggregated set of impact categories.\n(m) the carbon footprint of the product;\n(ma) the material footprint of the product.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_CategoryEnumeration" + }, + "performanceClass" : { + "description" : "The performance classification of the footprint.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "manufacturingPlant" : { + "description" : "The manufacturing plant of the footprint in the specific lifecycle phase.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_FacilityList" + }, + "declaration" : { + "description" : "The footprint declaration in the format of a link ", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentList" + } + }, + "required" : [ "value", "rulebook", "lifecycle", "unit", "type", "manufacturingPlant", "declaration" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_FootprintList" : { + "description" : "Footprint List for the environmental footprint.", + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_FootprintEntity" + } + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_ProductFootprintCharacteristic" : { + "description" : "The Product Footprint Characteristic with sustainability information.", + "type" : "object", + "properties" : { + "environmental" : { + "description" : "The environmental footprint of the product. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I:\nThe following parameters shall, as appropriate, and where necessary supplemented by others, be used, individually or combined, as a basis for improving the product aspects referred to in Article 5(1):\n(l) the environmental footprint of the product, expressed as a quantification, in accordance with the applicable delegated act, of a product's life cycle environmental impacts, whether in relation to one or more environmental impact categories or an aggregated set of impact categories.\nand Article 7:\n(2)(b)(i) information on the performance of the product in relation to one or more of the product parameters referred to in Annex I, including a scoring of reparability or durability, carbon footprint or environmental footprint;\nand defined by Article 2:\n(23) 'environmental footprint' means a quantification of product environmental impacts throughout its life cycle, whether in relation to a single environmental impact category or an aggregated set of impact categories based on the Product Environmental Footprint method or other scientific methods developed by international organisations and widely tested in collaboration with different industry sectors and adopted or implemented by the Commission in other Union legislation;\n(24) 'Product Environmental Footprint method' means the life cycle assessment method to quantify the environmental impacts of products established by Recommendation (EU) 2021/2279.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_FootprintList" + }, + "carbon" : { + "description" : "The carbon footprint of the product. This is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I:\nThe following parameters shall, as appropriate, and where necessary supplemented by others, be used, individually or combined, as a basis for improving the product aspects referred to in Article 5(1):\n(m) the carbon footprint of the product;\nand Article 7:\n(2)(b)(i) information on the performance of the product in relation to one or more of the product parameters referred to in Annex I, including a scoring of reparability or durability, carbon footprint or environmental footprint;\nand defined by Article 2:\n(25) 'carbon footprint' means the sum of greenhouse gas (GHG) emissions and GHG removals in a product system, expressed as CO2 equivalents and based on a life cycle assessment using the single impact category of climate change.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_FootprintList" + }, + "material" : { + "description" : "The material footprint of the product. This is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I:\n(ma) the material footprint of the product;\nand defined by Article 2:\n(25a) 'material footprint' refers to the total amount of raw materials extracted to meet final consumption demands.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_FootprintList" + } + }, + "required" : [ "carbon" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_SustainabilityCharacteristic" : { + "description" : "Characteristic which describes relevant information for the sustainability of the product.", + "type" : "object", + "properties" : { + "status" : { + "description" : "The status of the product (original, repurposed, re-used, remanufactured or waste) to indicated, whether it is a used product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Annex I:\n(j) incorporation of used components.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_StateEnumeration" + }, + "productFootprint" : { + "description" : "The carbon and environmental footprint or material footprint of the product. These attributes are mentioned in the ESPR provisional agreement from January 9th 2024 Annex I:\n(l) the environmental footprint of the product, expressed as a quantification, in accordance with the applicable delegated act, of a product's life cycle environmental impacts, whether in relation to one or more environmental impact categories or an aggregated set of impact categories;\n(m) the carbon footprint of the product;\n(ma) the material footprint of the product;\nAll are defined by Article 2:\n(23) 'environmental footprint' means a quantification of product environmental impacts throughout its life cycle, whether in relation to a single environmental impact category or an aggregated set of impact categories based on the Product Environmental Footprint method or other scientific methods developed by international organisations and widely tested in collaboration with different industry sectors and adopted or implemented by the Commission in other Union \nlegislation;\n(25) 'carbon footprint' means the sum of greenhouse gas (GHG) emissions and GHG removals in a product system, expressed as CO2 equivalents and based on a life cycle assessment using the single impact category of climate change.\n(25a) 'material footprint' refers to the total amount of raw materials extracted to meet final consumption demands;", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_ProductFootprintCharacteristic" + }, + "reparabilityScore" : { + "description" : "The reparability score. This attribute is mentioned ESPR provisional agreement from January 9th, 2024 Article 7:\n(b) as appropriate, also require products to be accompanied by:\n(i) information on the performance of the product in relation to one or more of the product parameters referred to in Annex I, including a scoring of reparability or durability [...].", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "durabilityScore" : { + "description" : "The durability score. This attribute is mentioned ESPR provisional agreement from January 9th, 2024 Article 7:\n(b) as appropriate, also require products to be accompanied by:\n(i) information on the performance of the product in relation to one or more of the product parameters referred to in Annex I, including a scoring of reparability or durability [...].", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + } + }, + "required" : [ "status", "productFootprint" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_SourceCategoryEnumeration" : { + "type" : "string", + "description" : "The types of sources that can be linked in a digital product passport can vary depending on the nature of the product and the information that needs to be included. This is an enumeration of possible sources.", + "enum" : [ "Product Specifications", "Manufacturer Information", "User Manuals and Guides", "Certifications and Compliance", "Product Images and Videos", "Warranty Information", "Reviews and Ratings", "Product Variations", "Supply Chain Information", "Environmental Impact", "Compatibility and Accessories", "FAQs and Support", "Purchase and Retail Information", "Privacy and Data Handling", "Third-Party Integrations", "Legal Information", "Safety Information", "Repair and Installation", "Waste Generation and Prevention", "Specific Voluntary Labels", "Product Packaging", "Return and Disposal", "End of Life", "Material and Substance Information", "Technical Documentation", "Treatment facilities", "Other" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentEntity" : { + "description" : "Document entity with header, content, category and type.", + "type" : "object", + "properties" : { + "content" : { + "description" : "The content of the document e.g a link.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "category" : { + "description" : "The category in which the document can be sorted. These are mentioned in the ESPR proposal from March 30th, 2022 ANNEX III:\n(e) compliance documentation and information required under this Regulation or other Union law applicable to the product, such as the declaration of conformity, technical documentation or conformity certificates;\nANNEX IV states additional information regarding the content of the technical documentation\nFurther information on documents are mentioned in the proposal from March 30th, 2022 ANNEX III:\n(f) user manuals, instructions, warnings or safety information, as required by other Union legislation applicable to the product.\nAdditionally requirements are mentioned in Article 21:\n(7) Manufacturers shall ensure that that a product covered by a delegated act adopted pursuant to Article 4 is accompanied by instructions that enable consumers and other end-users to safely assemble, install, operate, store, maintain, repair and dispose of the product in a language that can be easily understood by consumers and other end-users, as determined by the Member State concerned. Such instructions shall be clear, understandable and legible and include at least the information specified in the delegated acts adopted pursuant to Article 4 and pursuant to Article 7(2)(b), point (ii).\nArticle 7 states additionally:\n(2) (b) (ii) information for consumers and other end-users on how to install, use, maintain and repair the product in order to minimize its impact on the environment and to ensure optimum durability, as well as on how to return or dispose of the product at end-of-life;\n(2) (b) (iii) information for treatment facilities on disassembly, recycling, or disposal at end-of-life;\n(2) (b) (iv) other information that may influence the way the product is handled by parties other than the manufacturer in order to improve performance in relation to product parameters referred to in Annex I.\n(5) (d) relevant instructions for the safe use of the product.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_SourceCategoryEnumeration" + }, + "type" : { + "description" : "The type of content which can be expected in the \"content\" property. Examples are a link, restricted link, pdf, excel, etc.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "header" : { + "description" : "The header as a short description of the document with a maximum of 100 characters.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_HeaderTrait" + } + }, + "required" : [ "content", "category", "type", "header" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_SourceList" : { + "description" : "A list of documents.", + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentEntity" + } + }, + "urn_samm_io.catenax.electric_drive.electric_drive_passport_2.0.0_GenericCharacteristic" : { + "description" : "Characteristic for the product generic parameters.", + "type" : "object", + "properties" : { + "metadata" : { + "description" : "Metadata of the product passport. These are mentioned in the ESPR proposal from March 30th, 2022 and some changed by the provisional agreement from January 9th, 2024.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_MetadataCharacteristic" + }, + "identification" : { + "description" : "Identification information of the product, especially identifiers and codes. These are mentioned in the ESPR provisional agreement from January 9th, 2024 ANNEX III:\n(b) the unique product identifier at the level indicated in the applicable delegated act adopted pursuant to Article 4.\nAdditionally in Article 9 regarding general requirements for the product passport is stated that:\nA product passport shall meet the following conditions:\n(a) it shall be connected through a data carrier to a persistent unique product identifier;\n(e) the information included in the product passport shall refer to the product model, batch, or item as specified in the delegated act adopted pursuant to Article 4.\nArticle 2 Definitions: \n(31) 'unique product identifier' means a unique string of characters for the identification of products that also enables a web link to the product passport;\nRecital (27): A 'model' usually means a version of a product of which all units share the same technical characteristics relevant for the ecodesign requirements and the same model identifier, a 'batch' usually means a subset of a specific model composed of all products produced in a specific manufacturing plant at a specific moment in time and an 'item' usually means a single unit of a model.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_IdentificationCharacteristic" + }, + "operation" : { + "description" : "Operational information of the product.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_OperationCharacteristic" + }, + "handling" : { + "description" : "Properties connected with the handling of the product.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_HandlingCharacteristic" + }, + "characteristics" : { + "description" : "Defines specific characteristics of a product.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_ProductCharacteristics" + }, + "commercial" : { + "description" : "Commercial information of the product.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_CommercialCharacteristic" + }, + "materials" : { + "description" : "Properties which are relevant for the materials of the product.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_MaterialsCharacteristic" + }, + "sustainability" : { + "description" : "Sustainability related attributes.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_SustainabilityCharacteristic" + }, + "sources" : { + "description" : "Documents that are mandatory if applicable for the product. These are mentioned in the ESPR provisional agreement from January 9th, 2024 ANNEX III:\n(e) compliance documentation and information required under this Regulation or other Union law applicable to the product, such as the declaration of conformity, technical documentation or conformity certificates;\n(f) user manuals, instructions, warnings or safety information, as required by other Union legislation applicable to the product.\nAdditionally requirements are mentioned in Article 21:\n7. Manufacturers shall ensure that a product covered by a delegated act adopted pursuant to Article 4 is accompanied by instructions in digital format that enable customers and other relevant actors to assemble, install, operate, store, maintain, repair and dispose of the product in a language that can be easily understood, as determined by the Member State concerned. Such instructions shall be clear, understandable and legible and include at least the information set out in Article 7(2), point (b), point (ii) specified in the delegated acts adopted pursuant to Article 4.\nArticle 7 states additionally:\n(ii) information for customers and other actors on how to install, use, maintain and repair the product, in order to minimise its impact on the environment and to ensure optimum durability, on how to install third-party operating systems where relevant, as well as on collection for refurbishment or remanufacture, and on how to return or handle the product at the end of its life;\n(2) (b) (iii) information for treatment facilities on disassembly, reuse, refurbishment, recycling, or disposal at end-of-life;\n(2) (b) (iv) other information that may influence sustainable product choices for customers and the way the product is handled by parties other than the manufacturer in order to facilitate appropriate use, value retaining operations and correct treatment at end-of-life.\n(5) (d) relevant instructions for the safe use of the product.\n(5) (e) information relevant for disassembly, preparation for reuse, reuse, recycling and the environmentally sound management of the product at the end of its life.\nAnnex I:\n(b) [...] availability of repair and maintenance instructions, number of materials and components used, use of standard components,[...] number and complexity of processes and whether specialised toolsare needed, ease of non-destructive disassembly and re-assembly, conditions for access to product data, conditions for access to or use of hardware and software needed;\n(c) ease of upgrading, re-use, remanufacturing and refurbishment as expressed through: [...] number and complexity of processes and tools needed, ease of non-destructive disassembly and re-assembly, conditions for access to product data, conditions for access to or use of hardware and software needed, conditions of access to test protocols or not commonly available testing equipment, availability of guarantees specific to remanufactured or refurbished products, conditions for access to or use of technologies protected by intellectual property rights, modularity;\n(d) design for recycling, ease and quality of recycling as expressed through: use of easily recyclable materials, safe, easy and non-destructive access to recyclable components and materials or components and materials containing hazardous substances and material composition and homogeneity, possibility for high-purity sorting, [...] number and complexity of processes and tools needed, ease of nondestructive disassembly and re-assembly, conditions for access to product data, conditions for access to or use of hardware and software needed;\n(q) functional performance and conditions for use including as expressed through ability in performing its intended use, precautions of use, skills required, compatibility with other products or systems.\nAdditionally to consider are guidelines and instructions regarding the proper management and disposal of packaging materials after use. This can include instructions for separation, reuse, and recycling.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_SourceList" + } + }, + "required" : [ "metadata", "identification", "operation", "handling", "characteristics", "commercial", "materials", "sustainability", "sources" ] + } + } + }, + "properties" : { + "specific" : { + "description" : "Product specific parameters of the electric drive.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.electric_drive.electric_drive_passport_2.0.0_SpecificCharacteristic" + }, + "generic" : { + "description" : "The product generic parameters. These are defined by the Digital Product Passport proposal from the ESPR. The main basis is provided by the document \"Proposal for a REGULATION OF THE EUROPEAN PARLIAMENT AND OF THE COUNCIL establishing a framework for setting ecodesign requirements for sustainable products and repealing Directive 2009/125/EC\" from March 30th, 2022. The latest version of the document was the provisional agreement between the EU Council and the Parliament from January 9th, 2024.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.electric_drive.electric_drive_passport_2.0.0_GenericCharacteristic" + } + }, + "required" : [ "specific", "generic" ] +} \ No newline at end of file diff --git a/io.catenax.electric_drive.electric_drive_passport/2.0.0/gen/ElectricDrivePassport.aasx b/io.catenax.electric_drive.electric_drive_passport/2.0.0/gen/ElectricDrivePassport.aasx new file mode 100644 index 000000000..23b2c2956 Binary files /dev/null and b/io.catenax.electric_drive.electric_drive_passport/2.0.0/gen/ElectricDrivePassport.aasx differ diff --git a/io.catenax.electric_drive.electric_drive_passport/2.0.0/gen/ElectricDrivePassport.html b/io.catenax.electric_drive.electric_drive_passport/2.0.0/gen/ElectricDrivePassport.html new file mode 100644 index 000000000..970d766f9 --- /dev/null +++ b/io.catenax.electric_drive.electric_drive_passport/2.0.0/gen/ElectricDrivePassport.html @@ -0,0 +1,13340 @@ + + + + + + + + + + + + + + Documentation Electric Drive Passport + + +
+
+
+
+

Aspect Model Electric Drive Passport

+
urn:samm:io.catenax.electric_drive.electric_drive_passport:2.0.0#ElectricDrivePassport
+
+
+
+
+
+
+
+ +
+ + +
+ The E-Drive Passport is a data record that summarizes the components, materials and chemical substances or information on repairability, spare parts or professional disposal for an E-Drive. The data comes from all phases of the product life cycle and can be used for various purposes in all these phases (design, production, use, disposal). Structuring environmental data in a standardized, comparable format enables all actors in the value and supply chain to work together towards a circular economy. This data model is based on the new proposed Ecodesign Regulation (ESPR-2022) and the product specific requirements collected from different manufacturers and users of the product. +
+ + +
+

Overview

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

Properties

+
+ +
+ +
+

Product Generic Parameters

+
+ +The product generic parameters. These are defined by the Digital Product Passport proposal from the ESPR. The main basis is provided by the document "Proposal for a REGULATION OF THE EUROPEAN PARLIAMENT AND OF THE COUNCIL establishing a framework for setting ecodesign requirements for sustainable products and repealing Directive 2009/125/EC" from March 30th, 2022. The latest version of the document was the provisional agreement between the EU Council and the Parliament from January 9th, 2024. + +
+
Name
+
productGenericParameters
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.electric_drive.electric_drive_passport:2.0.0#GenericEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
generic
+
+ + +
+
+ +
+

Product Specific Parameters

+
+ +Product specific parameters of the electric drive. + +
+
Name
+
productSpecificParameters
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.electric_drive.electric_drive_passport:2.0.0#SpecificEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
specific
+
+ + +
+
+ + + +
+
+

Entities

+
+ +
+
+

Characteristics Entity

+
+
+ Entity which defines specific characteristics of a product such as different life spans and physical dimensions. +
+ +
+

Properties

+
+
+ +
+
Lifespan
+
+ +The type of lifespan represented with the values guaranteed lifetime, technical lifetime and mean time between failures. Both can be described through the attributes: type, which defines the type such as guaranteed lifetime or technical lifetime, the unit for the lifetime, and the value represented by an integer. These attributes are mentioned in the ESPR proposal from March 30th, 2022 ANNEX I: +(a) durability and reliability of the product or its components as expressed through the products guaranteed lifetime, technical lifetime [or] mean time between failures [...]. + +
+
Name
+
lifespan
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#LifespanEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
lifespan
+
+ + +
+
+ +
+
Physical Dimension
+
+ +Physical dimensions are properties associated with physical quantities for purposes of classification or differentiation. These attributes are mentioned in the ESPR provisional agreement from January 9th, Article 7: +(2) (b) (i) information on the performance of the product in relation to one or more of the product parameters referred to in Annex I; +Annex I (i) weight and volume of the product and its packaging, and the product-to-packaging ratio. + +
+
Name
+
physicalDimension
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#PhysicalDimensionEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
physicalDimension
+
+ + +
+
+ +
+
Physical State
+
+ +The physical state of the item. There are four states of matter solid, liquid, gas and plasma which can be chosen from an enumeration. + +
+
Name
+
physicalState
+
+ + + +
+
Characteristic
+
+
+
+
Enumeration
+
+
+
Values
+
+
+
+
    +
  • solid
    • +
  • liquid
    • +
  • gas
    • +
  • plasma
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
solid
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
physicalState
+
+ + +
+
+ +
+
General Performance Class
+
+ +The performance class of the product. This attribute is mentioned ESPR provisional agreement from January 9th, 2024 Article 7: +4. When establishing the information requirements referred to in paragraph 2, point (b), point (i), the Commission shall, as appropriate in view of the specificity of the product group, determine classes of performance. Classes of performance may be based on single parameters, on aggregated scores, in absolute terms or in any other form that enables potential customers to choose the best performing products. Those classes of performance shall correspond to significant improvements in performance levels. Where classes of performance are based on parameters in relation to which performance requirements are established, they shall use as the minimum level the minimum performance required at the time when the classes of performance start to apply. +Definition: +'class of performance': means a range of performance levels in relation to one or more product parameters referred to in Annex I, based on a common methodology for the product or product group, ordered into successive steps to allow for product differentiation. + +
+
Name
+
generalPerformanceClass
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
A
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
generalPerformanceClass
+
+ + +
+
+
+
+

Chemical Material Entity

+
+
+ Material entity with attributes if applicable to the product. +
+ +
+

Properties

+
+
+ +
+
Applicable
+
+ +Check whether the connected attributes are applicable to the product. If it is not applicable (false), dummy data can be delivered. + +
+
Name
+
applicable
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#boolean + +
+
+
+
+
+ +
+
Example
+
true
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
applicable
+
+ + +
+
+ +
+
Material
+
+ +Information on different materials in the product. + +
+
Name
+
chemicalMaterial
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#MaterialEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
content
+
+ + +
+
+
+
+

ClassificationEntity

+
+
+ Encapsulates data related to the classification of the part. +
+ +
+

Properties

+
+
+ +
+
Classification Standard
+
+ +Identified classification standards that align to the Catena-X needs. + +
+
Name
+
classificationStandard
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
GIN 20510-21513
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
classificationStandard
+
+ + +
+
+ +
+
Classification ID
+
+ +The classification ID of the part type according to the corresponding standard definition mentioned in the key value pair. + +
+
Name
+
classificationID
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
1004712
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
classificationID
+
+ + +
+
+ +
+
Classification Description
+
+ +Optional property describing the classification standard. + +
+
Name
+
classificationDescription
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Generic standard for classification of parts in the automotive industry.
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
classificationDescription
+
+ + +
+
+
+
+

Code Entity

+
+
+ Code entity with code key and value. +
+ +
+

Properties

+
+
+ +
+
Code Key
+
+ +The code key for the identification of the product. Examples are GTIN, hash, DID, ISBN, TARIC. This attribute is mentioned in the ESPR proposal from March 30th, 2022 ANNEX III: +(b) the unique product identifier at the level indicated in the applicable delegated act adopted pursuant to Article 4; +(c) the Global Trade Identification Number as provided for in standard ISO/IEC 15459-6 or equivalent of products or their parts; +(d) relevant commodity codes, such as a TARIC code as defined in Council Regulation (EEC) No 2658/87. + +
+
Name
+
codeKey
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
TARIC
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
key
+
+ + +
+
+ +
+
Code Value
+
+ +The code value for the identification of the product in regard to the chosen code name. + +
+
Name
+
codeValue
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
8703 24 10 00
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
value
+
+ + +
+
+
+
+

Commercial Entity

+
+
+ Commercial information. +
+ +
+

Properties

+
+
+ +
+
Placed on Market
+
+ +The timestamp in the format (yyyy-mm-dd) with or without time zone when the product was put in the market. + +
+
Name
+
placedOnMarket
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
2000-01-01
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
placedOnMarket
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + Date Constraint +
    + +
    +
    Description
    +
    Constraint fo a timestamp in the format (yyyy-mm-dd).
    +
    + + +
    +
    Regular expression
    +
    ^\d{4}-\d{2}-\d{2}$
    +
    + +
    • +
+
+
+
+
+ +
+
Purpose
+
+ +One or more intended industry/industries of the product described by the digital product passport. If exchanged via Catena-X, 'automotive ' is a must choice included in the list. + +
+
Name
+
purpose
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
automotive
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
purpose
+
+ + +
+
+
+
+

Data Carrier Entity

+
+
+ Data Carrier Entity with type and layout of the data carrier. +
+ +
+

Properties

+
+
+ +
+
Carrier Type
+
+ +The type of data carrier such as a QR code on the product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 8: +(2) (b) the types of data carrier to be used. + +
+
Name
+
carrierType
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
QR
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
carrierType
+
+ + +
+
+ +
+
Carrier Layout
+
+ +The positioning of data carrier on the product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 8: +(2) (c) the layout in which the data carrier shall be presented and its positioning. + +
+
Name
+
carrierLayout
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
upper-left side
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
carrierLayout
+
+ + +
+
+
+
+

Document Entity

+
+
+ Document entity with header, content, category and type. +
+ +
+

Properties

+
+
+ +
+
Content
+
+ +The content of the document e.g a link. + +
+
Name
+
content
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
https://dummy.link
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
content
+
+ + +
+
+ +
+
Category
+
+ +The category in which the document can be sorted. These are mentioned in the ESPR proposal from March 30th, 2022 ANNEX III: +(e) compliance documentation and information required under this Regulation or other Union law applicable to the product, such as the declaration of conformity, technical documentation or conformity certificates; +ANNEX IV states additional information regarding the content of the technical documentation +Further information on documents are mentioned in the proposal from March 30th, 2022 ANNEX III: +(f) user manuals, instructions, warnings or safety information, as required by other Union legislation applicable to the product. +Additionally requirements are mentioned in Article 21: +(7) Manufacturers shall ensure that that a product covered by a delegated act adopted pursuant to Article 4 is accompanied by instructions that enable consumers and other end-users to safely assemble, install, operate, store, maintain, repair and dispose of the product in a language that can be easily understood by consumers and other end-users, as determined by the Member State concerned. Such instructions shall be clear, understandable and legible and include at least the information specified in the delegated acts adopted pursuant to Article 4 and pursuant to Article 7(2)(b), point (ii). +Article 7 states additionally: +(2) (b) (ii) information for consumers and other end-users on how to install, use, maintain and repair the product in order to minimize its impact on the environment and to ensure optimum durability, as well as on how to return or dispose of the product at end-of-life; +(2) (b) (iii) information for treatment facilities on disassembly, recycling, or disposal at end-of-life; +(2) (b) (iv) other information that may influence the way the product is handled by parties other than the manufacturer in order to improve performance in relation to product parameters referred to in Annex I. +(5) (d) relevant instructions for the safe use of the product. + +
+
Name
+
category
+
+ + + +
+
Characteristic
+
+
+
+
Enumeration
+
+
+
Values
+
+
+
+
    +
  • Product Specifications
    • +
  • Manufacturer Information
    • +
  • User Manuals and Guides
    • +
  • Certifications and Compliance
    • +
  • Product Images and Videos
    • +
  • Warranty Information
    • +
  • Reviews and Ratings
    • +
  • Product Variations
    • +
  • Supply Chain Information
    • +
  • Environmental Impact
    • +
  • Compatibility and Accessories
    • +
  • FAQs and Support
    • +
  • Purchase and Retail Information
    • +
  • Privacy and Data Handling
    • +
  • Third-Party Integrations
    • +
  • Legal Information
    • +
  • Safety Information
    • +
  • Repair and Installation
    • +
  • Waste Generation and Prevention
    • +
  • Specific Voluntary Labels
    • +
  • Product Packaging
    • +
  • Return and Disposal
    • +
  • End of Life
    • +
  • Material and Substance Information
    • +
  • Technical Documentation
    • +
  • Treatment facilities
    • +
  • Other
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Legal Information
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
category
+
+ + +
+
+ +
+
Content Type
+
+ +The type of content which can be expected in the "content" property. Examples are a link, restricted link, pdf, excel, etc. + +
+
Name
+
contentType
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
URL
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
type
+
+ + +
+
+ +
+
Header
+
+ +The header as a short description of the document with a maximum of 100 characters. + +
+
Name
+
header
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Example Document XYZ
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
header
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + Header Constraint +
    + +
    +
    Description
    +
    Constraint for a maximum of 100 characters.
    +
    + + +
    +
    Max. length
    +
    100
    +
    + +
    • +
+
+
+
+
+
+
+

Documentation Entity

+
+
+ Entity for a document with a header, type and content. +
+ +
+

Properties

+
+
+ +
+
Content
+
+ +The content of the document e.g a link. + +
+
Name
+
content
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
https://dummy.link
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
content
+
+ + +
+
+ +
+
Content Type
+
+ +The type of content which can be expected in the "content" property. Examples are a link, restricted link, pdf, excel, etc. + +
+
Name
+
contentType
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
URL
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
contentType
+
+ + +
+
+ +
+
Header
+
+ +The header as a short description of the document with a maximum of 100 characters. + +
+
Name
+
header
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Example Document XYZ
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
header
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + Header Constraint +
    + +
    +
    Description
    +
    Constraint for a maximum of 100 characters.
    +
    + + +
    +
    Max. length
    +
    100
    +
    + +
    • +
+
+
+
+
+
+
+

E-Machine Entity

+
+
+ Entity for e-machine values. +
+ +
+

Properties

+
+
+ +
+
E-Machine Id
+
+ +The unique serial ID of the e-Machine built into the eDrive of this passport; defined and provided by the owner/economic operator of the passport. + +
+
Name
+
eMachineId
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
1785030A72B5752
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
id
+
+ + +
+
+ +
+
Permanent Magnet Type
+
+ +The permanent magnet type describes the material composition of the permanent magnet in use. In case of SSM e-Motors, no permanent magnets are used, requiring the input of a default value. Possible selections: +- No permanent magnets used (SSM motor): "None" +- AlNiCo: "Aluminum-Nickel-Cobalt" +- Ceramic: "Ceramic" +- Ferrite: "Ferrite" +- Flexible: "Flexible Rubber" +- SmCo: "Samarium Cobalt" +- NdFeB: "Neodymium Iron Boron" + +
+
Name
+
permanentMagnetType
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Ceramic
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
permanentMagnetType
+
+ + +
+
+ +
+
Rated Speed
+
+ +Rated speed determined by the electronics and measured in RPM, limited through software or physical limits (e.g. maximum power). + +
+
Name
+
ratedSpeed
+
+ + + +
+
Characteristic
+
+
+
+
Measurement
+
+
+
Measurement of revolutions per minute as float value.
+
+
+
Unit
+
+
+
+
    +
  • + revolution per minute +
    • +
  • + Symbol r/min +
    • +
  • + Code M46 +
    • +
  • + Conversion factor 0.1047198 rad/s +
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#float + +
+
+
+
+
+ +
+
Example
+
8000.0
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
ratedSpeed
+
+ + +
+
+ +
+
Stator Diameter
+
+ +Diameter of the E-Machine stator, measured in millimetres. + +
+
Name
+
statorDiameter
+
+ + + +
+
Characteristic
+
+
+
+
Measurement
+
+
+
Measurement of millimetre as float value.
+
+
+
Unit
+
+
+
+
    +
  • + millimetre +
    • +
  • + Symbol mm +
    • +
  • + Code MMT +
    • +
  • + Conversion factor 10⁻³ m +
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#float + +
+
+
+
+
+ +
+
Example
+
450.0
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
statorDiameter
+
+ + +
+
+ +
+
E-Machine Technology
+
+ +The type of the e-machine built into the eDrive. Possible values are "ASM" (Asynchronous motor), "PSM" (Permanently excited synchronous motor) and "ESM" (Electrically-excited synchronous motor). This should not be confused with an electrical machine integrated in a transmission. + +
+
Name
+
eMachineTechnology
+
+ + + +
+
Characteristic
+
+
+
+
Enumeration
+
+
+
Values
+
+
+
+
    +
  • ESM
    • +
  • ASM
    • +
  • PSM
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
ASM
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
technology
+
+ + +
+
+ +
+
E-Machine Weight
+
+ +Net weight, component weight without packaging, of the electrical machine, which is built into the eDrive. + +
+
Name
+
eMachineWeight
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.shared.quantity:2.0.0#MassEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
weight
+
+ + +
+
+
+
+

Electric Drive Documents Entity

+
+
+ Entity for specific documents of the electric drive. +
+ +
+

Properties

+
+
+ +
+
Technical Dismantling Instructions
+
+ +Document containing information and instructions, including steps, diagrams and illustrations of removing or replacing the eDrive or dismantling it. + +
+
Name
+
technicalDismantlingInstructions
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#DocumentationEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
technicalDismantlingInstructions
+
+ + +
+
+ +
+
Required Tools For Dismantling
+
+ +Document containing information and instructions for required tools or technologies pertaining to the removal, replacement or dismantling of the eDrive. + +
+
Name
+
requiredToolsForDismantling
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#DocumentationEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
requiredToolsForDismantling
+
+ + +
+
+
+
+

Facility Entity

+
+
+ The entity for a facility with the BPNA identifier. +
+ +
+

Properties

+
+
+ +
+
Facility
+
+ +The identifier used for a location. This attribute is mentioned in the ESPR provisional agreement from January 9th 2024 Annex III: +(i) unique facility identifiers; +Article 2 Definitions: (33) 'unique facility identifier' means a unique string of characters for the identification of locations or buildings involved in the value chain of a product or used by actors involved in the value chain of a product. + +
+
Name
+
facility
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
    +
  • https://catena-x.net/fileadmin/user_upload/Standard-Bibliothek/Update_PDF_Maerz/5_BPDM/CX_-_0010_BUSINESS_PARTNER_NUMBER_PlatformCapabilityBPDM_v_1.0.1.pdf
    • +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
BPNA1234567890AA
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
facility
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + BPNA Regular Expression +
    + +
    +
    Description
    +
    The provided regular expression ensures that the BPNA is composed of prefix 'BPNA', 10 digits and two alphanumeric letters.
    +
    + + +
    +
    Regular expression
    +
    ^BPNA[a-zA-Z0-9]{12}$
    +
    + +
    • +
+
+
+
+
+
+
+

Footprint Entity

+
+
+ Footprint Entity for the carbon and environmental footprint with the total value, unit, impact category type, lifecycle, rulebook, declaration, performance class and the facility. +
+ +
+

Properties

+
+
+ +
+
Footprint Value
+
+ +The value of the footprint of the product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Annex I: +(l) the environmental footprint of the product, expressed as a quantification, in accordance with the applicable delegated act, of a product's life cycle environmental impacts, whether in relation to one or more environmental impact categories or an aggregated set of impact categories; +(m) the carbon footprint of the product; +(ma) the material footprint of the product. + + +
+
Name
+
footprintValue
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#float + +
+
+
+
+
+ +
+
Example
+
12.678
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
value
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + Positive Range Constraint +
    + +
    +
    Description
    +
    Constraint for only positive values.
    +
    + + +
    +
    +>= +
    + DefaultScalarValue[value=0.0, typeUri='DefaultScalar[metaModelVersion=SAMM_2_1_0, urn='http://www.w3.org/2001/XMLSchema#float']'] +
    +
    + +
    • +
+
+
+
+
+ +
+
Footprint Rulebook
+
+ +The applied rulebook for the environmental footprint of the product. + +
+
Name
+
footprintRulebook
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#DocumentationEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
rulebook
+
+ + +
+
+ +
+
Footprint Lifecycle
+
+ +The lifecycle stage, to which the environmental footprint corresponds. These could be for example "raw material acquisition and pre-processing", "main product production", "distribution" or "end of life and recycling". + +
+
Name
+
footprintLifecycle
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
main product production
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
lifecycle
+
+ + +
+
+ +
+
Footprint Unit
+
+ +The unit of measurement of the environmental impact category. For each impact category a specific unit is used. If an aggregation is used, utilize the normalization and weighting methods used in the referenced rulebook. + +
+
Name
+
footprintUnit
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
kg CO2 / kWh
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
unit
+
+ + +
+
+ +
+
Footprint Type
+
+ +The type of the environmental footprint of the product. This could be one of the environmental impact categories. This attribute is mentioned in the ESPR provisional agreement from January 9th 2024 Article 7: +(2)(b)(i) information on the performance of the product in relation to one or more of the product parameters referred to in Annex I, including a scoring of reparability or durability, carbon footprint or environmental footprint; +Annex I: +(l) the environmental footprint of the product, expressed as a quantification, in accordance with the applicable delegated act, of a product's life cycle environmental impacts, whether in relation to one or more environmental impact categories or an aggregated set of impact categories. +(m) the carbon footprint of the product; +(ma) the material footprint of the product. + +
+
Name
+
footprintType
+
+ + + +
+
Characteristic
+
+
+
+
Enumeration
+
+
+
Values
+
+
+
+
    +
  • Climate Change Total
    • +
  • Climate Change Fossil
    • +
  • Climate Change Biogenic Removals and Emissions
    • +
  • Climate Change Land Use and Land Use Change
    • +
  • Ozone Depletion
    • +
  • Acidification
    • +
  • Eutrophication Aquatic Freshwater
    • +
  • Eutrophication Fresh Marine
    • +
  • Eutrophication Terrestrial
    • +
  • Photochemical Ozone Formation
    • +
  • Abiotic Depletion- Minerals and Metals
    • +
  • Fossil Fuels
    • +
  • Water Use
    • +
  • Particulate Matter Emissions
    • +
  • Ionizing Radiation, Human Health
    • +
  • Eco-Toxicity
    • +
  • Human Toxicity, Cancer Effects
    • +
  • Human Toxicity, Non-Cancer Effects
    • +
  • Land Use Related Impacts/Soil Quality
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Climate Change
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
type
+
+ + +
+
+ +
+
Performance Class
+
+ +The performance classification of the footprint. + +
+
Name
+
performanceClass
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
A
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
performanceClass
+
+ + +
+
+ +
+
Manufacturing Plant
+
+ +The manufacturing plant of the footprint in the specific lifecycle phase. + +
+
Name
+
manufacturingPlant
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#FacilityEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
manufacturingPlant
+
+ + +
+
+ +
+
Declaration
+
+ +The footprint declaration in the format of a link + +
+
Name
+
declaration
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#DocumentationEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
declaration
+
+ + +
+
+
+
+

General Entity

+
+
+ Entity for general information. +
+ +
+

Properties

+
+
+ +
+
Compatible Vehicle Types
+
+ +The vehicle types, in which the eDrive of this passport can be used. Possible selections are "battery-electric vehicle", "hybrid-electric vehicle", "fuel-cell-electric vehicle". + +
+
Name
+
compatibleVehicleTypes
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
battery-electric vehicle
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
compatibleVehicleTypes
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + Vehicle Types Constraint +
    + +
    +
    Description
    +
    Constraint for the three possible vehicle types. A selection of multiple is possible.
    +
    + + +
    +
    Regular expression
    +
    battery-electric vehicle|hybrid-electric vehicle|fuel-cell-electric vehicle|(?:battery-electric vehicle, |hybrid-electric vehicle, |fuel-cell-electric vehicle, )*battery-electric vehicle|hybrid-electric vehicle|fuel-cell-electric vehicle
    +
    + +
    • +
+
+
+
+
+ +
+
Service
+
+ +The eDrive service history. + +
+
Name
+
service
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.electric_drive.electric_drive_passport:2.0.0#ServiceEntity + +
+
+
+
+
+ + +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
service
+
+ + +
+
+
+
+

Generic Entity

+
+
+ Entity for the product generic parameters. +
+ +
+

Properties

+
+
+ +
+
Metadata
+
+ +Metadata of the product passport. These are mentioned in the ESPR proposal from March 30th, 2022 and some changed by the provisional agreement from January 9th, 2024. + +
+
Name
+
metadata
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#MetadataEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
metadata
+
+ + +
+
+ +
+
Identification
+
+ +Identification information of the product, especially identifiers and codes. These are mentioned in the ESPR provisional agreement from January 9th, 2024 ANNEX III: +(b) the unique product identifier at the level indicated in the applicable delegated act adopted pursuant to Article 4. +Additionally in Article 9 regarding general requirements for the product passport is stated that: +A product passport shall meet the following conditions: +(a) it shall be connected through a data carrier to a persistent unique product identifier; +(e) the information included in the product passport shall refer to the product model, batch, or item as specified in the delegated act adopted pursuant to Article 4. +Article 2 Definitions: +(31) 'unique product identifier' means a unique string of characters for the identification of products that also enables a web link to the product passport; +Recital (27): A 'model' usually means a version of a product of which all units share the same technical characteristics relevant for the ecodesign requirements and the same model identifier, a 'batch' usually means a subset of a specific model composed of all products produced in a specific manufacturing plant at a specific moment in time and an 'item' usually means a single unit of a model. + +
+
Name
+
identification
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#IdentificationEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
identification
+
+ + +
+
+ +
+
Operation
+
+ +Operational information of the product. + +
+
Name
+
operation
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#OperationEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
operation
+
+ + +
+
+ +
+
handling
+
+ +Properties connected with the handling of the product. + +
+
Name
+
handling
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#HandlingEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
handling
+
+ + +
+
+ +
+
Characteristics
+
+ +Defines specific characteristics of a product. + +
+
Name
+
characteristics
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#CharacteristicsEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
characteristics
+
+ + +
+
+ +
+
Commercial
+
+ +Commercial information of the product. + +
+
Name
+
commercial
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#CommercialEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
commercial
+
+ + +
+
+ +
+
Materials
+
+ +Properties which are relevant for the materials of the product. + +
+
Name
+
materials
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#MaterialsEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
materials
+
+ + +
+
+ +
+
Sustainability
+
+ +Sustainability related attributes. + +
+
Name
+
sustainability
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#SustainabilityEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
sustainability
+
+ + +
+
+ +
+
Sources
+
+ +Documents that are mandatory if applicable for the product. These are mentioned in the ESPR provisional agreement from January 9th, 2024 ANNEX III: +(e) compliance documentation and information required under this Regulation or other Union law applicable to the product, such as the declaration of conformity, technical documentation or conformity certificates; +(f) user manuals, instructions, warnings or safety information, as required by other Union legislation applicable to the product. +Additionally requirements are mentioned in Article 21: +7. Manufacturers shall ensure that a product covered by a delegated act adopted pursuant to Article 4 is accompanied by instructions in digital format that enable customers and other relevant actors to assemble, install, operate, store, maintain, repair and dispose of the product in a language that can be easily understood, as determined by the Member State concerned. Such instructions shall be clear, understandable and legible and include at least the information set out in Article 7(2), point (b), point (ii) specified in the delegated acts adopted pursuant to Article 4. +Article 7 states additionally: +(ii) information for customers and other actors on how to install, use, maintain and repair the product, in order to minimise its impact on the environment and to ensure optimum durability, on how to install third-party operating systems where relevant, as well as on collection for refurbishment or remanufacture, and on how to return or handle the product at the end of its life; +(2) (b) (iii) information for treatment facilities on disassembly, reuse, refurbishment, recycling, or disposal at end-of-life; +(2) (b) (iv) other information that may influence sustainable product choices for customers and the way the product is handled by parties other than the manufacturer in order to facilitate appropriate use, value retaining operations and correct treatment at end-of-life. +(5) (d) relevant instructions for the safe use of the product. +(5) (e) information relevant for disassembly, preparation for reuse, reuse, recycling and the environmentally sound management of the product at the end of its life. +Annex I: +(b) [...] availability of repair and maintenance instructions, number of materials and components used, use of standard components,[...] number and complexity of processes and whether specialised toolsare needed, ease of non-destructive disassembly and re-assembly, conditions for access to product data, conditions for access to or use of hardware and software needed; +(c) ease of upgrading, re-use, remanufacturing and refurbishment as expressed through: [...] number and complexity of processes and tools needed, ease of non-destructive disassembly and re-assembly, conditions for access to product data, conditions for access to or use of hardware and software needed, conditions of access to test protocols or not commonly available testing equipment, availability of guarantees specific to remanufactured or refurbished products, conditions for access to or use of technologies protected by intellectual property rights, modularity; +(d) design for recycling, ease and quality of recycling as expressed through: use of easily recyclable materials, safe, easy and non-destructive access to recyclable components and materials or components and materials containing hazardous substances and material composition and homogeneity, possibility for high-purity sorting, [...] number and complexity of processes and tools needed, ease of nondestructive disassembly and re-assembly, conditions for access to product data, conditions for access to or use of hardware and software needed; +(q) functional performance and conditions for use including as expressed through ability in performing its intended use, precautions of use, skills required, compatibility with other products or systems. +Additionally to consider are guidelines and instructions regarding the proper management and disposal of packaging materials after use. This can include instructions for separation, reuse, and recycling. + +
+
Name
+
sources
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#DocumentEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
sources
+
+ + +
+
+
+
+

Handling Entity

+
+
+ Entity to describe different aspects in relation with the handling of the product with attributes if applicable to the product. +
+ +
+

Properties

+
+
+ +
+
spareParts
+
+ +The list of spare parts available for the product from various suppliers. + +
+
Name
+
spareParts
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#SparePartEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
content
+
+ + +
+
+ +
+
Applicable
+
+ +Check whether the connected attributes are applicable to the product. If it is not applicable (false), dummy data can be delivered. + +
+
Name
+
applicable
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#boolean + +
+
+
+
+
+ +
+
Example
+
true
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
applicable
+
+ + +
+
+
+
+

Hazard Entity

+
+
+ Entity for the hazardous classification. +
+ +
+

Properties

+
+
+ +
+
Hazard Category
+
+ +The hazard category of the substance of concern. Defined in Article 2 of Regulation (EC) No 1272/2008 of the European Parliament and of the Council of 16 December 2008 on classification, labelling and packaging of substances and mixtures, amending and repealing Directives 67/548/EEC and 1999/45/EC, and amending Regulation (EC) No 1907/2006: +2. 'hazard category' means the division of criteria within each hazard class, specifying hazard severity. + +
+
Name
+
hazardCategory
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
category 1A
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
category
+
+ +
+
Reference
+
+
    +
  • https://eur-lex.europa.eu/legal-content/EN/TXT/?uri=CELEX:02008R1272-20231201
    • +
+
+
+ +
+
+ +
+
Hazard Class
+
+ +The hazard class of the substance of concern. Defined in Article 2 of Regulation (EC) No 1272/2008 of the European Parliament and of the Council of 16 December 2008 on classification, labelling and packaging of substances and mixtures, amending and repealing Directives 67/548/EEC and 1999/45/EC, and amending Regulation (EC) No 1907/2006: +1. 'hazard class' means the nature of the physical, health or environmental hazard. + +
+
Name
+
hazardClass
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Skin corrosion
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
class
+
+ +
+
Reference
+
+
    +
  • https://eur-lex.europa.eu/legal-content/EN/TXT/?uri=CELEX:02008R1272-20231201
    • +
+
+
+ +
+
+ +
+
Hazard Statement
+
+ +The hazard statement of the substance of concern. Defined in Article 2 of Regulation (EC) No 1272/2008 of the European Parliament and of the Council of 16 December 2008 on classification, labelling and packaging of substances and mixtures, amending and repealing Directives 67/548/EEC and 1999/45/EC, and amending Regulation (EC) No 1907/2006: +5. 'hazard statement' means a phrase assigned to a hazard class and category that describes the nature of the hazards of a hazardous substance or mixture, including, where appropriate, the degree of hazard. + +
+
Name
+
hazardStatement
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Causes severe skin burns and eye damage.
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
statement
+
+ +
+
Reference
+
+
    +
  • https://eur-lex.europa.eu/legal-content/EN/TXT/?uri=CELEX:02008R1272-20231201
    • +
+
+
+ +
+
+
+
+

Identification Entity

+
+
+ Entity with identification information of the product with part type information, local identifiers, other codes and the data carrier. +
+ +
+

Properties

+
+
+ +
+
Serial Information
+
+ +Identifier for a serial part if available. This is mentioned in the ESPR provisional agreement from January 9th, 2024 Recital (27): +[...] an 'item' usually means a single unit of a model. + +
+
Name
+
serialInformation
+
+ + + +
+
Characteristic
+
+
+
+
Set
+
+
+
Has no order
+
+
+
Duplicates not allowed
+
+
+
+ Type urn:samm:io.catenax.serial_part:3.0.0#KeyValueList + +
+
+
+
+
+ + +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
serial
+
+ + +
+
+ +
+
Batch Information
+
+ +Identifier for a batch part if available. Identifier for a serial part if available. This is mentioned in the ESPR provisional agreement from January 9th, 2024 Recital (27): +[...] a 'batch' usually means a subset of a specific model composed of all products produced in a specific manufacturing plant at a specific moment in time [...]. + +
+
Name
+
batchInformation
+
+ + + +
+
Characteristic
+
+
+
+
Set
+
+
+
Has no order
+
+
+
Duplicates not allowed
+
+
+
+ Type urn:samm:io.catenax.batch:3.0.0#KeyValueList + +
+
+
+
+
+ + +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
batch
+
+ + +
+
+ +
+
Part Type Information
+
+ +Identifier on the level of a part model or type. Identifier for a serial part if available. This is mentioned in the ESPR provisional agreement from January 9th, 2024 Recital (27): +[...] A 'model' usually means a version of a product of which all units share the same technical characteristics relevant for the ecodesign requirements and the same model identifier [...]. + +
+
Name
+
partTypeInformation
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#PartTypeEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
type
+
+ + +
+
+ +
+
Codes
+
+ +Codes for identification. + +
+
Name
+
codes
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#CodeEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
codes
+
+ + +
+
+ +
+
Data Carrier
+
+ +The type and layout of the data carrier on the product. These are mentioned in the ESPR proposal from March 30th, 2022 Article 8: +(b) the types of data carrier to be used; +(c) the layout in which the data carrier shall be presented and its positioning; +Article 2 defines: +(30) 'data carrier' means a linear bar code symbol, a two-dimensional symbol or other automatic identification data capture medium that can be read by a device. + +
+
Name
+
dataCarrier
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#DataCarrierEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
dataCarrier
+
+ + +
+
+ +
+
Part Classification
+
+ +Property describing the classification of a part. + +
+
Name
+
partClassification
+
+ + + +
+
Characteristic
+
+
+
+
SortedSet
+
+
+
Has a certain order
+
+
+
Duplicates not allowed
+
+
+
+ Type urn:samm:io.catenax.shared.part_classification:1.0.0#ClassificationEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
classification
+
+ + +
+
+
+
+

Import Entity

+
+
+ Import entity with attributes if applicable to the product. +
+ +
+

Properties

+
+
+ +
+
Importer
+
+ +Information regarding the importer of the product, if different from the owner of the passport. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex III: +(j) information related to the importer, including the information referred to in Article 23(3) and its EORI number; +Article 23 states: +(3) Importers shall, for products covered by a delegated act adopted pursuant to Article 4, indicate their name, registered trade name or registered trade mark and the postal address and electronic means of communication, where they can be contacted: (a) on the public part of the product passport, when applicable, and +(b) on the product or, where this is not possible, on the packaging, or in a document accompanying the product. + +
+
Name
+
importer
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#ImporterEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
content
+
+ + +
+
+ +
+
Applicable
+
+ +Check whether the connected attributes are applicable to the product. If it is not applicable (false), dummy data can be delivered. + +
+
Name
+
applicable
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#boolean + +
+
+
+
+
+ +
+
Example
+
true
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
applicable
+
+ + +
+
+
+
+

Importer Entity

+
+
+ Entity with information regarding the importer such as the identification and the EORI. +
+ +
+

Properties

+
+
+ +
+
EORI
+
+ +An economic operator established in the customs territory of the Union needs, for customs purposes, an EORI number. EORI stands for economic operators registration and identification number. In this case, the importer's EORI must be provided. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Annex III: +(j) information related to the importer, including the information referred to in Article 23(3) and its EORI number. + +
+
Name
+
eori
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
GB123456789000
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
eori
+
+ +
+
Reference
+
+
    +
  • https://taxation-customs.ec.europa.eu/customs-4/customs-procedures-import-and-export-0/customs-procedures/economic-operators-registration-and-identification-number-eori_en
    • +
+
+
+ +
+
Constraints
+
+
    +
  • +
    + +
    + EORI Constraint +
    + +
    +
    Description
    +
    Constraint with a pattern which ensures that the EORI number starts with two alphanumeric characters, followed by two alphabetic characters, and ends with 2 to 15 alphanumeric characters.
    +
    + + +
    +
    Regular expression
    +
    ^[A-Z]{2}[A-Z0-9]{1,18}$
    +
    + +
    • +
+
+
+
+
+ +
+
Importer Identification
+
+ +The importer of the product, if different from the owner of the passport. In the Catena-X network, the BPNL is used for the identification of companies and the information stored for this like contact information and addresses. +This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex III: +(j) information related to the importer, including the information referred to in Article 23(3) and its EORI number; +Article 23 states: +(3) Importers shall, for products covered by a delegated act adopted pursuant to Article 4, indicate their name, registered trade name or registered trade mark and the postal address and electronic means of communication, where they can be contacted: (a) on the public part of the product passport, when applicable, and +(b) on the product or, where this is not possible, on the packaging, or in a document accompanying the product. + +
+
Name
+
importerIdentification
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
    +
  • https://catena-x.net/fileadmin/user_upload/Standard-Bibliothek/Update_PDF_Maerz/5_BPDM/CX_-_0010_BUSINESS_PARTNER_NUMBER_PlatformCapabilityBPDM_v_1.0.1.pdf
    • +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
BPNL0123456789ZZ
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
id
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + BPNL Regular Expression +
    + +
    +
    Description
    +
    The provided regular expression ensures that the BPNL is composed of prefix 'BPNL', 10 digits and two alphanumeric letters.
    +
    + + +
    +
    Regular expression
    +
    ^BPNL[a-zA-Z0-9]{12}$
    +
    + +
    • +
+
+
+
+
+
+
+

Inverter Entity

+
+
+ Entity for inverter values. +
+ +
+

Properties

+
+
+ +
+
Inverter Current
+
+ +Electric current flowing through the inverter, measured in ampere. + +
+
Name
+
inverterCurrent
+
+ + + +
+
Characteristic
+
+
+
+
Measurement
+
+
+
Measurement of ampere as float value.
+
+
+
Unit
+
+
+
+
    +
  • + ampere +
    • +
  • + Symbol A +
    • +
  • + Code AMP +
    • +
  • + Conversion factor A +
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#float + +
+
+
+
+
+ +
+
Example
+
500.0
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
inverterCurrent
+
+ + +
+
+ +
+
Maximum Phase Current
+
+ +The maximum allowable current to pass through the phases, measured in ampere. + +
+
Name
+
maximumPhaseCurrent
+
+ + + +
+
Characteristic
+
+
+
+
Measurement
+
+
+
Measurement of ampere as float value.
+
+
+
Unit
+
+
+
+
    +
  • + ampere +
    • +
  • + Symbol A +
    • +
  • + Code AMP +
    • +
  • + Conversion factor A +
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#float + +
+
+
+
+
+ +
+
Example
+
700.0
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
maximumPhaseCurrent
+
+ + +
+
+ +
+
Software Version
+
+ +Indicates the software version of the inverter. + +
+
Name
+
softwareVersion
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
2.525.b
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
softwareVersion
+
+ + +
+
+
+
+

Key Value List

+
+
+ A list of key value pairs for local identifiers, which are composed of a key and a corresponding value. +
+ +
+

Properties

+
+
+ +
+
Identifier Key
+
+ +The key of a local identifier. + +
+
Name
+
key
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
partInstanceId
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
key
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + Key Regular Expression +
    + +
    +
    Description
    +
    Constraint that ensures that the standard keys and custom key prefixes can be used.
    +
    + + +
    +
    Regular expression
    +
    ^(manufacturerId|partInstanceId|batchId|van|customKey:\w+)$
    +
    + +
    • +
+
+
+
+
+ +
+
Identifier Value
+
+ +The value of an identifier. + +
+
Name
+
value
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
SN12345678
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
value
+
+ + +
+
+
+
+

Key Value List

+
+
+ A list of key value pairs for local identifiers, which are composed of a key and a corresponding value. +
+ +
+

Properties

+
+
+ +
+
Identifier Key
+
+ +The key of a local identifier. + +
+
Name
+
key
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
batchId
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
key
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + Key Regular Expression +
    + +
    +
    Description
    +
    Constraint that ensures that the predefined keys are used.
    +
    + + +
    +
    Regular expression
    +
    ^(manufacturerId|batchId|customKey:\w+)$
    +
    + +
    • +
+
+
+
+
+ +
+
Identifier Value
+
+ +The value of an identifier. + +
+
Name
+
value
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
BID12345678
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
value
+
+ + +
+
+
+
+

Lifespan Entity

+
+
+ Entity for the lifespan of a product with type, unit and value. +
+ +
+

Properties

+
+
+ +
+
Life Unit
+
+ +The unit of the respective lifespan expressed through the possible units day, month, cycle, year and runningOrOperatingHour. + +
+
Name
+
lifeUnit
+
+ + + +
+
Characteristic
+
+
+
+
Enumeration
+
+
+
Values
+
+
+
+
    +
  • unit:day
    • +
  • unit:month
    • +
  • unit:year
    • +
  • unit:cycle
    • +
  • unit:runningOrOperatingHour
    • +
+
+
+
+
+ Reference +
+
    +
  • https://eclipse-esmf.github.io/samm-specification/2.1.0/index.html
    • +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
unit:month
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
unit
+
+ +
+
Reference
+
+
    +
  • https://eclipse-esmf.github.io/samm-specification/2.1.0/index.html
    • +
+
+
+ +
+
+ +
+
Life Value
+
+ +The value as an integer for the respective lifespan. + +
+
Name
+
lifeValue
+
+ + + +
+
Characteristic
+
+
+
+
Quantifiable
+
+
+
Duration
+
+
+
Characteristic for the life span value as an integer.
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#integer + +
+
+
+
+
+ +
+
Example
+
36
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
value
+
+ + +
+
+ +
+
Life Type
+
+ +The type of lifespan represented with the values guaranteed lifetime, technical lifetime and mean time between failures. This attribute is mentioned in the ESPR proposal from March 30th, 2022 ANNEX I: +(a) durability and reliability of the product or its components as expressed through the product's guaranteed lifetime, technical lifetime [or] mean time between failures [...]. + +
+
Name
+
lifeType
+
+ + + +
+
Characteristic
+
+
+
+
Enumeration
+
+
+
Values
+
+
+
+
    +
  • guaranteed lifetime
    • +
  • technical lifetime
    • +
  • mean time between failures
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
guaranteed lifetime
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
key
+
+ + +
+
+
+
+

Linear Entity

+
+
+ Entity for linear measurements of an item with an unit and value. +
+ +
+

Properties

+
+
+ +
+
Quantity Value
+
+ +The quantity value associated with the unit. + +
+
Name
+
quantityValue
+
+ + + +
+
Characteristic
+
+
+
+
Quantifiable
+
+
+
Duration
+
+
+
The quantity value associated with the unit expressed as float.
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#float + +
+
+
+
+
+ +
+
Example
+
20.0
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
value
+
+ + +
+
+ +
+
Linear Unit
+
+ +The unit of a linear attribute. + +
+
Name
+
linearUnit
+
+ + + +
+
Characteristic
+
+
+
+
Enumeration
+
+
+
Values
+
+
+
+
    +
  • unit:millimetre
    • +
  • unit:centimetre
    • +
  • unit:metre
    • +
  • unit:kilometre
    • +
  • unit:inch
    • +
  • unit:foot
    • +
  • unit:yard
    • +
+
+
+
+
+ Reference +
+
    +
  • https://eclipse-esmf.github.io/samm-specification/2.1.0/index.html
    • +
+
+
+
+
+
+ Type urn:samm:org.eclipse.esmf.samm:meta-model:2.1.0#curie + +
+
+
+
+
+ +
+
Example
+
unit:millimetre
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
unit
+
+ +
+
Reference
+
+
    +
  • https://eclipse-esmf.github.io/samm-specification/2.1.0/index.html
    • +
+
+
+ +
+
+
+
+

Liquids Entity

+
+
+ Entity for cooling and lubricants. +
+ +
+

Properties

+
+
+ +
+
Cooling Topology
+
+ +General cooling topology, which can be either one of the types: "air-cooled", "water-cooled" or "oil-cooled". + +
+
Name
+
coolingTopology
+
+ + + +
+
Characteristic
+
+
+
+
Enumeration
+
+
+
Values
+
+
+
+
    +
  • air-cooled
    • +
  • water-cooled
    • +
  • oil-cooled
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
water-cooled
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
coolingTopology
+
+ + +
+
+ +
+
Oil Capacity eDrive
+
+ +The defined oil volume in the eDrive, measured in cubic decimetres. In case of a combined oil circuit for both the eDrive and the built-in transmission, the value must be identical to the oil capacity value of the transmission. + +
+
Name
+
oilCapacityEdrive
+
+ + + +
+
Characteristic
+
+
+
+
Quantifiable
+
+
+
Duration
+
+
+
The oil capacity in dm³.
+
+
+
Unit
+
+
+
+
    +
  • + cubic decimetre +
    • +
  • + Symbol dm³ +
    • +
  • + Code DMQ +
    • +
  • + Conversion factor 10⁻³ m³ +
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#float + +
+
+
+
+
+ +
+
Example
+
50.0
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
oilCapacityEdrive
+
+ + +
+
+ +
+
Oil Type eDrive
+
+ +The type of the oil for the eDrive defined by the manufacturer. In case of a combined oil circuit for both the eDrive and the built-in transmission, the value must be identical to the oil type value of the transmission. + +
+
Name
+
oilTypeEdrive
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
5W-30
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
oilTypeEdrive
+
+ + +
+
+ +
+
Minimum Oil Pressure
+
+ +Minimum operational oil pressure value defined by the manufacturer of the E-Drive measured in bar. + +
+
Name
+
minimumOilPressure
+
+ + + +
+
Characteristic
+
+
+
+
Measurement
+
+
+
Measurement of the pressure in bar as float value.
+
+
+
Unit
+
+
+
+
    +
  • + bar [unit of pressure] +
    • +
  • + Symbol bar +
    • +
  • + Code BAR +
    • +
  • + Conversion factor 10⁵ Pa +
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#float + +
+
+
+
+
+ +
+
Example
+
2.068427
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
minimumOilPressure
+
+ + +
+
+ +
+
Maximum Oil Pressure
+
+ +Maximum operational oil pressure value defined by the manufacturer of the E-Drive measured in bar. + +
+
Name
+
maximumOilPressure
+
+ + + +
+
Characteristic
+
+
+
+
Measurement
+
+
+
Measurement of the pressure in bar as float value.
+
+
+
Unit
+
+
+
+
    +
  • + bar [unit of pressure] +
    • +
  • + Symbol bar +
    • +
  • + Code BAR +
    • +
  • + Conversion factor 10⁵ Pa +
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#float + +
+
+
+
+
+ +
+
Example
+
4.82633
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
maximumOilPressure
+
+ + +
+
+ +
+
Oil Module
+
+ +Flag indicating the availability or absence of an oil module. An oil module is an umbrella term for devices that are manipulating the oil flow and the temperature in the product and incorporate cooler, pump, valves (pressure regulation valve). + +
+
Name
+
oilModule
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#boolean + +
+
+
+
+
+ +
+
Example
+
true
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
oilModule
+
+ + +
+
+ +
+
Maximum Oil Temperature
+
+ +The maximum oil temperature to safely operate the eDrive, measured in celsius on the oil temperature sensor. Please note the oil temperature can vary in other positions within the lubrication circuit. + +
+
Name
+
maximumOilTemperature
+
+ + + +
+
Characteristic
+
+
+
+
Measurement
+
+
+
Measurement in celsius as float value.
+
+
+
Unit
+
+
+
+
    +
  • + degree Celsius +
    • +
  • + Symbol °C +
    • +
  • + Code CEL +
    • +
  • + Conversion factor 1 × K +
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#float + +
+
+
+
+
+ +
+
Example
+
80.5
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
maximumOilTemperature
+
+ + +
+
+
+
+

Manufacturer Entity

+
+
+ Manufacturing Entity with the identification of the main manufacturer and the facility location as well as the manufacturing date. +
+ +
+

Properties

+
+
+ +
+
Facility Identification
+
+ +The identifier used for a location. In the CATENA-X use case, the BPNA can be stated. This attribute is mentioned in the ESPR provisional agreement from January 9th 2024 Annex III: +(i) unique facility identifiers; +Article 2 Definitions: (33) 'unique facility identifier' means a unique string of characters for the identification of locations or buildings involved in the value chain of a product or used by actors involved in the value chain of a product. + +
+
Name
+
facilityIdentification
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#FacilityEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
facility
+
+ + +
+
+ +
+
Manufacturer Identification
+
+ +The main manufacturer, if different from the passport owner, represented by an identification number. In the Catena-X use case, the BPNL can be stated. This attribute is mentioned in the ESPR provisional agreement from January 9th 2024 Annex III: +(h) unique operator identifiers other than that of the manufacturer; +(k) the name, contact details and unique operator identifier code of the economic operator established in the Union responsible for carrying out the tasks set out in Article 4 of Regulation (EU) 2019/1020, or Article 15 of Regulation (EU) [.../...] on general product safety, or similar tasks pursuant to other EU legislation applicable to the product. + +
+
Name
+
manufacturerIdentification
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
    +
  • https://catena-x.net/fileadmin/user_upload/Standard-Bibliothek/Update_PDF_Maerz/5_BPDM/CX_-_0010_BUSINESS_PARTNER_NUMBER_PlatformCapabilityBPDM_v_1.0.1.pdf
    • +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
manufacturer
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + BPNL Regular Expression +
    + +
    +
    Description
    +
    The provided regular expression ensures that the BPNL is composed of prefix 'BPNL', 10 digits and two alphanumeric letters.
    +
    + + +
    +
    Regular expression
    +
    ^BPNL[a-zA-Z0-9]{12}$
    +
    + +
    • +
+
+
+
+
+ +
+
Manufacturing Date
+
+ +The timestamp in the format (yyyy-mm-dd) of the manufacturing date as the final step in production process (e.g. final quality check, ready-for-shipment event). + +
+
Name
+
manufacturingDate
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
2000-01-31
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
manufacturingDate
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + Date Constraint +
    + +
    +
    Description
    +
    Constraint fo a timestamp in the format (yyyy-mm-dd).
    +
    + + +
    +
    Regular expression
    +
    ^\d{4}-\d{2}-\d{2}$
    +
    + +
    • +
+
+
+
+
+
+
+

Mass Entity

+
+
+ Entity for mass measurements of an item with an unit and value. +
+ +
+

Properties

+
+
+ +
+
Quantity Value
+
+ +The quantity value associated with the unit. + +
+
Name
+
quantityValue
+
+ + + +
+
Characteristic
+
+
+
+
Quantifiable
+
+
+
Duration
+
+
+
The quantity value associated with the unit expressed as float.
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#float + +
+
+
+
+
+ +
+
Example
+
20.0
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
value
+
+ + +
+
+ +
+
Mass Unit
+
+ +The unit of a mass related attribute. + +
+
Name
+
massUnit
+
+ + + +
+
Characteristic
+
+
+
+
Enumeration
+
+
+
Values
+
+
+
+
    +
  • unit:gram
    • +
  • unit:kilogram
    • +
  • unit:tonneMetricTon
    • +
  • unit:tonUsOrShortTonUkorus
    • +
  • unit:ounceAvoirdupois
    • +
  • unit:pound
    • +
+
+
+
+
+ Reference +
+
    +
  • https://eclipse-esmf.github.io/samm-specification/2.1.0/index.html
    • +
+
+
+
+
+
+ Type urn:samm:org.eclipse.esmf.samm:meta-model:2.1.0#curie + +
+
+
+
+
+ +
+
Example
+
unit:kilogram
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
unit
+
+ +
+
Reference
+
+
    +
  • https://eclipse-esmf.github.io/samm-specification/2.1.0/index.html
    • +
+
+
+ +
+
+
+
+

Material Entity

+
+
+ Information regarding recycled and/or renewable materials in the product. +
+ +
+

Properties

+
+
+ +
+
Recycled
+
+ +The share of the material, which is recovered recycled content from the product. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I: +(h) use or content of recycled materials and recovery of materials, including critical raw materials; + +
+
Name
+
recycled
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#float + +
+
+
+
+
+ +
+
Example
+
12.5
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
recycled
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + Percentage Constraint +
    + +
    +
    Description
    +
    Range constraint for a positive percentage value.
    +
    + + +
    +
    +>= +
    + DefaultScalarValue[value=0.0, typeUri='DefaultScalar[metaModelVersion=SAMM_2_1_0, urn='http://www.w3.org/2001/XMLSchema#float']'] +
    +
    ...
    +
    +< + DefaultScalarValue[value=100.0, typeUri='DefaultScalar[metaModelVersion=SAMM_2_1_0, urn='http://www.w3.org/2001/XMLSchema#float']'] +
    + +
    • +
+
+
+
+
+ +
+
Renewable
+
+ +The share of the material, which is from a renewable resource that can be replenished. Renewable resources are those that can be reproduced by physical, chemical, or mechanical processes. These are the kind of resources that can be regenerated throughout time. Forest wood, for example, can be grown through reforestation. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I: +(ha) use or content of sustainable renewable materials; + + +
+
Name
+
renewable
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#float + +
+
+
+
+
+ +
+
Example
+
23.5
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
renewable
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + Percentage Constraint +
    + +
    +
    Description
    +
    Range constraint for a positive percentage value.
    +
    + + +
    +
    +>= +
    + DefaultScalarValue[value=0.0, typeUri='DefaultScalar[metaModelVersion=SAMM_2_1_0, urn='http://www.w3.org/2001/XMLSchema#float']'] +
    +
    ...
    +
    +< + DefaultScalarValue[value=100.0, typeUri='DefaultScalar[metaModelVersion=SAMM_2_1_0, urn='http://www.w3.org/2001/XMLSchema#float']'] +
    + +
    • +
+
+
+
+
+ +
+
Material Unit
+
+ +The unit of concentration chosen from an enumeration: mass percent, volume percent, parts per thousand, parts per million, parts per billion and parts per trillion. + +
+
Name
+
materialUnit
+
+ + + +
+
Characteristic
+
+
+
+
Enumeration
+
+
+
Values
+
+
+
+
    +
  • unit:partPerMillion
    • +
  • unit:percent
    • +
  • unit:percentVolume
    • +
  • unit:partPerThousand
    • +
  • unit:partPerTrillionUs
    • +
  • unit:partPerBillionUs
    • +
+
+
+
+
+ Reference +
+
    +
  • https://eclipse-esmf.github.io/samm-specification/2.1.0/index.html
    • +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
unit:percent
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
unit
+
+ +
+
Reference
+
+
    +
  • https://eclipse-esmf.github.io/samm-specification/2.1.0/index.html
    • +
+
+
+ +
+
+ +
+
Material Identification
+
+ +The chemical material name and identification, in accordance with the specification in the attribute for the list type. Preference is given to the IUPAC name. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Article 7: +(5) (a) the name of the substances of concern present in the product, as follows: + - name(s) in the International Union of Pure and Applied Chemistry (IUPAC) nomenclature, or another international name when IUPAC name is not available; +- other names (usual name, trade name, abbreviation); +- European Community (EC) number, as indicated in the European Inventory of Existing Commercial Chemical Substances (EINECS), the European List of Notified Chemical Substances (ELINCS) or the No Longer Polymer (NLP) list or assigned by the European Chemicals Agency (ECHA), if available; +- the Chemical Abstract Service (CAS) name(s) and number(s), if available; . + +
+
Name
+
materialIdentification
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#MaterialIdEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
id
+
+ + +
+
+ +
+
Critical
+
+ +A flag, if the material is a critical raw material. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I: +(h) use or content of recycled materials and recovery of materials, including critical raw materials; +In Annex II of the connected proposal Act of Critical Raw Materials, a list of critical raw materials can be found. + +
+
Name
+
critical
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#boolean + +
+
+
+
+
+ +
+
Example
+
true
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
critical
+
+ +
+
Reference
+
+
    +
  • https://eur-lex.europa.eu/legal-content/EN/TXT/?uri=COM:2023:0160:FIN
    • +
+
+
+ +
+
+ +
+
Concentration
+
+ +Concentration of the material at the level of the product. This attribute is specially mentioned for substances of concern mentioned in the ESPR proposal from March 30th, 2022 Article 7: +(5) (c) the concentration, maximum concentration or concentration range of the substances of concern, at the level of the product [...]. +Other substances are mentioned for the purpose of recycling in the ESPR provisional agreement from January 9th, 2024 Annex I: +(d) design for recycling, ease and quality of recycling as expressed through: use of easily recyclable materials, safe, easy and non-destructive access to recyclable components and materials or components and materials containing hazardous substances and material composition and homogeneity, possibility for high-purity sorting, number of materials and components used, use of standard components, use of component and material coding standards for the identification of components and materials, number and complexity of processes and tools needed, ease of nondestructive disassembly and re-assembly, conditions for access to product data, conditions for access to or use of hardware and software needed. + + +
+
Name
+
concentration
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#float + +
+
+
+
+
+ +
+
Example
+
5.3
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
concentration
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + Positive Range Constraint +
    + +
    +
    Description
    +
    Constraint for only positive values.
    +
    + + +
    +
    +>= +
    + DefaultScalarValue[value=0.0, typeUri='DefaultScalar[metaModelVersion=SAMM_2_1_0, urn='http://www.w3.org/2001/XMLSchema#float']'] +
    +
    + +
    • +
+
+
+
+
+ +
+
Documentation
+
+ +Documentation accompanying the material. + +
+
Name
+
documentation
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#DocumentationEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
documentation
+
+ + +
+
+
+
+

Material Id Entity

+
+
+ Id Entity with identifier, name and list type. +
+ +
+

Properties

+
+
+ +
+
Chemical Id
+
+ +The substance identification, in accordance with the specification in the attribute for the list type. + +
+
Name
+
chemicalId
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
201-004-7
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
id
+
+ + +
+
+ +
+
List Type Id
+
+ +The type of standard used for the identification of the substances. Selected can be for example CAS, IUPAC or EC. + +
+
Name
+
listTypeId
+
+ + + +
+
Characteristic
+
+
+
+
Enumeration
+
+
+
Values
+
+
+
+
    +
  • CAS
    • +
  • EC
    • +
  • IUPAC
    • +
+
+
+
+
+ Reference +
+
    +
  • https://www.cas.org/cas-data/cas-registry
    • +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
CAS
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
type
+
+ + +
+
+ +
+
Chemical Name
+
+ +The name of the material which is present in the product. + +
+
Name
+
chemicalName
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
phenolphthalein
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
name
+
+ + +
+
+
+
+

Materials Entity

+
+
+ Entity with materials on the level of the product. +
+ +
+

Properties

+
+
+ +
+
Substances of Concern
+
+ +Information regarding substances of concern in the product. The ESPR provisional agreement from January 9th, 2024 defines: +(52) 'hazardous substance' means a substance classified as hazardous pursuant to Article 3 of Regulation (EC) No 1272/2008. + +
+
Name
+
substancesOfConcern
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#SubstanceOfConcernEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
substancesOfConcern
+
+ + +
+
+ +
+
Material Composition
+
+ +Material composition of the product with information on recycled and renewable materials. + +
+
Name
+
materialComposition
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#ChemicalMaterialEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
materialComposition
+
+ + +
+
+
+
+

Maximum Power Entity

+
+
+ Entity with maximum power values. +
+ +
+

Properties

+
+
+ +
+
Max Value
+
+ +The maximum value in kilowatts for a specified time period. + +
+
Name
+
maxValue
+
+ + + +
+
Characteristic
+
+
+
+
Measurement
+
+
+
Measurement in kilowatt as float value.
+
+
+
Unit
+
+
+
+
    +
  • + kilowatt +
    • +
  • + Symbol kW +
    • +
  • + Code KWT +
    • +
  • + Conversion factor 10³ W +
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#float + +
+
+
+
+
+ +
+
Example
+
200.0
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
value
+
+ + +
+
+ +
+
Max Power ECER85
+
+ +Maximum power in kilowatts, measured according to the ECER85 regulatory requirements. + +
+
Name
+
maxPowerECER85
+
+ + + +
+
Characteristic
+
+
+
+
Measurement
+
+
+
Measurement in kilowatt as float value.
+
+
+
Unit
+
+
+
+
    +
  • + kilowatt +
    • +
  • + Symbol kW +
    • +
  • + Code KWT +
    • +
  • + Conversion factor 10³ W +
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#float + +
+
+
+
+
+ +
+
Example
+
195.0
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
ECER85
+
+ + +
+
+ +
+
Maximum Availability
+
+ +Specified time period for the peak measurement in seconds. + +
+
Name
+
maximumAvailability
+
+ + + +
+
Characteristic
+
+
+
+
Measurement
+
+
+
Time in seconds.
+
+
+
Unit
+
+
+
+
    +
  • + second [unit of time] +
    • +
  • + Symbol s +
    • +
  • + Code SEC +
    • +
  • + Conversion factor s +
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#nonNegativeInteger + +
+
+
+
+
+ +
+
Example
+
10
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
maximumAvailability
+
+ + +
+
+
+
+

Maximum Regenerated Power Entity

+
+
+ Entity for maximum regenerated power values. +
+ +
+

Properties

+
+
+ +
+
Max Value
+
+ +The maximum value in kilowatts for a specified time period. + +
+
Name
+
maxValue
+
+ + + +
+
Characteristic
+
+
+
+
Measurement
+
+
+
Measurement in kilowatt as float value.
+
+
+
Unit
+
+
+
+
    +
  • + kilowatt +
    • +
  • + Symbol kW +
    • +
  • + Code KWT +
    • +
  • + Conversion factor 10³ W +
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#float + +
+
+
+
+
+ +
+
Example
+
200.0
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
maxValue
+
+ + +
+
+ +
+
Maximum Availability
+
+ +Specified time period for the peak measurement in seconds. + +
+
Name
+
maximumAvailability
+
+ + + +
+
Characteristic
+
+
+
+
Measurement
+
+
+
Time in seconds.
+
+
+
Unit
+
+
+
+
    +
  • + second [unit of time] +
    • +
  • + Symbol s +
    • +
  • + Code SEC +
    • +
  • + Conversion factor s +
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#nonNegativeInteger + +
+
+
+
+
+ +
+
Example
+
10
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
maximumAvailability
+
+ + +
+
+
+
+

Maximum Torque Entity

+
+
+ Entity for maximum torque values. +
+ +
+

Properties

+
+
+ +
+
Torque Value
+
+ +Measured torque value in newton metre. + +
+
Name
+
torqueValue
+
+ + + +
+
Characteristic
+
+
+
+
Measurement
+
+
+
Measurement in newton metre as decimal value.
+
+
+
Unit
+
+
+
+
    +
  • + newton metre +
    • +
  • + Symbol N·m +
    • +
  • + Code NU +
    • +
  • + Conversion factor N × m +
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#decimal + +
+
+
+
+
+ +
+
Example
+
300.0
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
value
+
+ + +
+
+ +
+
Maximum Availability
+
+ +Specified time period for the peak measurement in seconds. + +
+
Name
+
maximumAvailability
+
+ + + +
+
Characteristic
+
+
+
+
Measurement
+
+
+
Time in seconds.
+
+
+
Unit
+
+
+
+
    +
  • + second [unit of time] +
    • +
  • + Symbol s +
    • +
  • + Code SEC +
    • +
  • + Conversion factor s +
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#nonNegativeInteger + +
+
+
+
+
+ +
+
Example
+
10
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
maximumAvailability
+
+ + +
+
+
+
+

Metadata Entity

+
+
+ Passport Entity to describe version, status, end and issue date. +
+ +
+

Properties

+
+
+ +
+
Version
+
+ +The current version of the product passport. The possibility of modification/ updating the product passport needs to include versioning of the dataset. This attribute is an internal versioning from the passport issuer. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Article 8: +(1) [...] The information in the product passport shall be accurate, complete, and up to date. + +
+
Name
+
version
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
1.0.0
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
version
+
+ + +
+
+ +
+
Status
+
+ +The current status of the product passport declared through either: draft, approved, invalid or expired. + +
+
Name
+
status
+
+ + + +
+
Characteristic
+
+
+
+
Enumeration
+
+
+
Values
+
+
+
+
    +
  • draft
    • +
  • approved
    • +
  • invalid
    • +
  • expired
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
draft
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
status
+
+ + +
+
+ +
+
Expiration Date
+
+ +The timestamp in the format (yyyy-mm-dd) for the product passport until when it is available or a comment describing this period. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Article 8: +(2) (h) the period during which the product passport is to remain available, which shall correspond to at least the expected lifetime of a specific product. + +
+
Name
+
expirationDate
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
2030-01-01
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
expirationDate
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + Date Constraint +
    + +
    +
    Description
    +
    Constraint fo a timestamp in the format (yyyy-mm-dd).
    +
    + + +
    +
    Regular expression
    +
    ^\d{4}-\d{2}-\d{2}$
    +
    + +
    • +
+
+
+
+
+ +
+
Issue Date
+
+ +The timestamp in the format (yyyy-mm-dd) since when the product passport is available. + +
+
Name
+
issueDate
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
2000-01-01
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
issueDate
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + Date Constraint +
    + +
    +
    Description
    +
    Constraint fo a timestamp in the format (yyyy-mm-dd).
    +
    + + +
    +
    Regular expression
    +
    ^\d{4}-\d{2}-\d{2}$
    +
    + +
    • +
+
+
+
+
+ +
+
Economic Operator Id
+
+ +The identification of the owner/economic operator of the passport. Proposed, according to ISO 15459, is the CIN (company identification code). Other identification numbers like the tax identification number, value added tax identification number, commercial register number and the like are also valid entries. In the Catena-X network, the BPNL is used for the identification of companies and the information stored like contact information and addresses. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Annex III: +(k) the [...] unique operator identifier code of the economic operator established in the Union responsible for carrying out the tasks set out in Article 4 of Regulation (EU) 2019/1020, or Article 15 of Regulation (EU) on general product safety, or similar tasks pursuant to other EU legislation applicable to the product. + +
+
Name
+
economicOperatorId
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
    +
  • https://catena-x.net/fileadmin/user_upload/Standard-Bibliothek/Update_PDF_Maerz/5_BPDM/CX_-_0010_BUSINESS_PARTNER_NUMBER_PlatformCapabilityBPDM_v_1.0.1.pdf
    • +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
BPNL0123456789ZZ
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
economicOperatorId
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + BPNL Regular Expression +
    + +
    +
    Description
    +
    The provided regular expression ensures that the BPNL is composed of prefix 'BPNL', 10 digits and two alphanumeric letters.
    +
    + + +
    +
    Regular expression
    +
    ^BPNL[a-zA-Z0-9]{12}$
    +
    + +
    • +
+
+
+
+
+ +
+
Passport Identifier
+
+ +The identifier of the product passport, which is an uuidv4. + +
+
Name
+
passportIdentifier
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
    +
  • https://tools.ietf.org/html/rfc4122
    • +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
urn:uuid:550e8400-e29b-41d4-a716-446655440000
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
passportIdentifier
+
+ + +
+
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
    +
    (^[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}$)
    +
    + +
    • +
+
+
+
+
+ +
+
Predecessor
+
+ +Identification of the preceding product passport. If there is no preceding passport, input a dummy value. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Article 8: +(2)(g) [...] Any new product passport shall be linked to the product passport or passports of the original product whenever appropriate. + +
+
Name
+
predecessor
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
    +
  • https://tools.ietf.org/html/rfc4122
    • +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
urn:uuid:00000000-0000-0000-0000-000000000000
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
predecessor
+
+ + +
+
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
    +
    (^[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}$)
    +
    + +
    • +
+
+
+
+
+ +
+
Backup Reference
+
+ +A reference to the data backup of the passport. This mandatory attribute will be further defined in the future. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex III: +(kb) the reference of the certified independent third-party product passport service provider hosting the back-up copy of the product passport. +Article 10 also mentions: +(c) the data included in the product passport shall be stored by the economic operator responsible for its creation or by certified independent third-party product passport service providers authorised to act on their behalf. + +
+
Name
+
backupReference
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
https://dummy.link
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
backupReference
+
+ + +
+
+ +
+
Registration Identifier
+
+ +Identifier in the respective registry. This will be further defined in the future. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 in Article 12: +By [2 years from entering into force of this Regulation], the Commission shall set up and manage a digital registry ("the registry") storing in a secure manner at least the unique product identifier, the unique operator identifier, the unique facility identifiers. In case of products intended to be placed under the customs procedure 'release for free circulation', the registry shall also store the product commodity code. The registry shall also store the batteries' unique identifiers referred to in Article 77(3) of Regulation (EU) 2023/1542. + +
+
Name
+
registrationIdentifier
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
https://dummy.link/ID8283746239078
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
registrationIdentifier
+
+ + +
+
+ +
+
Last Modification
+
+ +Date of the latest modification. + +
+
Name
+
lastModification
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
2000-01-01
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
lastModification
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + Date Constraint +
    + +
    +
    Description
    +
    Constraint fo a timestamp in the format (yyyy-mm-dd).
    +
    + + +
    +
    Regular expression
    +
    ^\d{4}-\d{2}-\d{2}$
    +
    + +
    • +
+
+
+
+
+
+
+

Oil Entity

+
+
+ Entity for the oil capacity and type. +
+ +
+

Properties

+
+
+ +
+
Oil Capacity
+
+ +The defined oil volume in the transmission in cubic decimeters. + +
+
Name
+
oilCapacity
+
+ + + +
+
Characteristic
+
+
+
+
Quantifiable
+
+
+
Duration
+
+
+
The oil capacity in dm³.
+
+
+
Unit
+
+
+
+
    +
  • + cubic decimetre +
    • +
  • + Symbol dm³ +
    • +
  • + Code DMQ +
    • +
  • + Conversion factor 10⁻³ m³ +
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#float + +
+
+
+
+
+ +
+
Example
+
8.9
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
oilCapacity
+
+ + +
+
+ +
+
Oil Type
+
+ +The type of the oil for the transmission defined by the manufacturer of the transmission. + +
+
Name
+
oilType
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Transmission Oil XY
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
oilType
+
+ + +
+
+
+
+

Operation Entity

+
+
+ Operational information of the product such as the owner, manufacturer and importer. +
+ +
+

Properties

+
+
+ +
+
Manufacturer
+
+ +Manufacturing information of the product. In the CATENA-X use case, the BPNL and BPNA can be stated. These attributes are mentioned in the ESPR provisional agreement from January 9th 2024 Annex III: +(h) unique operator identifiers other than that of the manufacturer; +(k) the name, contact details and unique operator identifier code of the economic operator established in the Union responsible for carrying out the tasks set out in Article 4 of Regulation (EU) 2019/1020, or Article 15 of Regulation (EU) [.../...] on general product safety, or similar tasks pursuant to other EU legislation applicable to the product. + +
+
Name
+
manufacturer
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#ManufacturerEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
manufacturer
+
+ + +
+
+ +
+
Import
+
+ +Importer details such as the identification. + +
+
Name
+
import
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#ImportEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
import
+
+ + +
+
+ +
+
Other Operators
+
+ +Other operators relevant for the product. + +
+
Name
+
otherOperators
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#OperatorEntity + +
+
+
+
+
+ + +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
other
+
+ + +
+
+
+
+

Operator Entity

+
+
+ Operator with role and identification. +
+ +
+

Properties

+
+
+ +
+
Other Operator Id
+
+ +Identifier of the other operator. This can be a BPN. + +
+
Name
+
otherOperatorId
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
BPNL0123456789XX
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
id
+
+ + +
+
+ +
+
Other Operator Role
+
+ +Role of the other operator. + +
+
Name
+
otherOperatorRole
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
distributor
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
role
+
+ + +
+
+
+
+

Part Type Entity

+
+
+ Entity for the part type with manufacturer id and name. +
+ +
+

Properties

+
+
+ +
+
Manufacturer Part ID
+
+ +Part ID as assigned by the manufacturer of the part. The part ID identifies the part in the manufacturer`s dataspace. The part ID references a specific version of a part. The version number must be included in the part ID if it is available. The part ID does not reference a specific instance of a part and must not be confused with the serial number. + +
+
Name
+
manufacturerPartId
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
123-0.740-3434-A
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
manufacturerPartId
+
+ + +
+
+ +
+
Name at manufacturer
+
+ +Name of the part as assigned by the manufacturer. + +
+
Name
+
nameAtManufacturer
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Mirror left
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
nameAtManufacturer
+
+ + +
+
+
+
+

Parts Entity

+
+
+ Possible spare parts of the product with identifiers and names. +
+ +
+

Properties

+
+
+ +
+
Manufacturer Part ID
+
+ +Part ID as assigned by the manufacturer of the part. The part ID identifies the part in the manufacturer`s dataspace. The part ID references a specific version of a part. The version number must be included in the part ID if it is available. The part ID does not reference a specific instance of a part and must not be confused with the serial number. + +
+
Name
+
manufacturerPartId
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
123-0.740-3434-A
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
manufacturerPartId
+
+ + +
+
+ +
+
Name at manufacturer
+
+ +Name of the part as assigned by the manufacturer. + +
+
Name
+
nameAtManufacturer
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Mirror left
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
nameAtManufacturer
+
+ + +
+
+
+
+

Physical Dimension Entity

+
+
+ Entity for physical dimensions with linear, mass and capacity attributes. Either weight or volume is mandatory. +
+ +
+

Properties

+
+
+ +
+
Width
+
+ +The width of the item measured in a specific linear unit which can be declared in the corresponding unit attribute. + +
+
Name
+
width
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.shared.quantity:2.0.0#LinearEntity + +
+
+
+
+
+ + +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
width
+
+ + +
+
+ +
+
Length
+
+ +The length of the item measured in a specific linear unit which can be declared in the corresponding unit attribute. + +
+
Name
+
length
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.shared.quantity:2.0.0#LinearEntity + +
+
+
+
+
+ + +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
length
+
+ + +
+
+ +
+
Diameter
+
+ +The diameter of the item, if applicable, measured in a specific linear unit which can be declared in the corresponding unit attribute. + +
+
Name
+
diameter
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.shared.quantity:2.0.0#LinearEntity + +
+
+
+
+
+ + +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
diameter
+
+ + +
+
+ +
+
Height
+
+ +The height of the item measured in a specific linear unit which can be declared in the corresponding unit attribute. + +
+
Name
+
height
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.shared.quantity:2.0.0#LinearEntity + +
+
+
+
+
+ + +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
height
+
+ + +
+
+ +
+
Gross Weight
+
+ +The gross weight of the item measured in a specific mass unit which can be declared in the corresponding unit attribute. Gross weight refers to the total weight of a product, including the weight of the packaging. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7: +(2) (b) (i) information on the performance of the product in relation to the product parameters referred to in Annex I; +Annex I (i) weight and volume of the product and its packaging, and the product-to-packaging ratio. + +
+
Name
+
grossWeight
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.shared.quantity:2.0.0#MassEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
grossWeight
+
+ + +
+
+ +
+
Gross Volume
+
+ +The gross volume of the item, if possible, measured in a specific capacity unit which can be declared in the corresponding unit attribute. If there is no separate packing, the volume of the product shall be given. Gross volume refers to the total volume of a product, including the volume of the packaging. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7: +(2) (b) (i) information on the performance of the product in relation to the product parameters referred to in Annex I; +Annex I (i) weight and volume of the product and its packaging, and the product-to-packaging ratio. + +
+
Name
+
grossVolume
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.shared.quantity:2.0.0#VolumeEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
grossVolume
+
+ + +
+
+ +
+
Weight
+
+ +Weight of the product measured in a specific mass unit which can be declared in the corresponding unit attribute. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7: +(2) (b) (i) information on the performance of the product in relation to the product parameters referred to in Annex I; +Annex I (i) weight and volume of the product [...]. + +
+
Name
+
weight
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.shared.quantity:2.0.0#MassEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
weight
+
+ + +
+
+ +
+
Volume
+
+ +Volume of the product, if possible, measured in a specific capacity unit which can be declared in the corresponding unit attribute. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7: +(2) (b) (i) information on the performance of the product in relation to the product parameters referred to in Annex I; +Annex I (i) weight and volume of the product [...]. + +
+
Name
+
volume
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.shared.quantity:2.0.0#VolumeEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
volume
+
+ + +
+
+
+
+

Power Entity

+
+
+ Entity for power values. +
+ +
+

Properties

+
+
+ +
+
Maximum Power
+
+ +The maximum output power in kilowatts for a specified time period. + +
+
Name
+
maximumPower
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.electric_drive.electric_drive_passport:2.0.0#MaximumPowerEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
maximum
+
+ + +
+
+ +
+
Continuous Regenerated Power
+
+ +The amount of power, which can be regenerated continuously, within the bounds of normal operation, in kilowatts. + +
+
Name
+
continuousRegeneratedPower
+
+ + + +
+
Characteristic
+
+
+
+
Measurement
+
+
+
Measurement in kilowatt as float value.
+
+
+
Unit
+
+
+
+
    +
  • + kilowatt +
    • +
  • + Symbol kW +
    • +
  • + Code KWT +
    • +
  • + Conversion factor 10³ W +
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#float + +
+
+
+
+
+ +
+
Example
+
5.0
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
continuousRegenerated
+
+ + +
+
+ +
+
Maximum Regenerated Power
+
+ +The maximum possible value that can be regenerated at a given time in kilowatts. + +
+
Name
+
maximumRegeneratedPower
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.electric_drive.electric_drive_passport:2.0.0#MaximumRegeneratedPowerEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
maxRegenerated
+
+ + +
+
+ +
+
Continuous Power
+
+ +The power that can be delivered without time limit. + +
+
Name
+
continuousPower
+
+ + + +
+
Characteristic
+
+
+
+
Measurement
+
+
+
The performance power in kilowatt as non-negative integer.
+
+
+
Unit
+
+
+
+
    +
  • + kilowatt +
    • +
  • + Symbol kW +
    • +
  • + Code KWT +
    • +
  • + Conversion factor 10³ W +
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#nonNegativeInteger + +
+
+
+
+
+ +
+
Example
+
16
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
continuous
+
+ + +
+
+
+
+

Product Footprint Entity

+
+
+ The Product Footprint Entity with sustainability information such as the different environmental footprint types, the carbon and material footprint explicitly, applicable rules and lifecycle stages. +
+ +
+

Properties

+
+
+ +
+
Environmental Footprint
+
+ +The environmental footprint of the product. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I: +The following parameters shall, as appropriate, and where necessary supplemented by others, be used, individually or combined, as a basis for improving the product aspects referred to in Article 5(1): +(l) the environmental footprint of the product, expressed as a quantification, in accordance with the applicable delegated act, of a product's life cycle environmental impacts, whether in relation to one or more environmental impact categories or an aggregated set of impact categories. +and Article 7: +(2)(b)(i) information on the performance of the product in relation to one or more of the product parameters referred to in Annex I, including a scoring of reparability or durability, carbon footprint or environmental footprint; +and defined by Article 2: +(23) 'environmental footprint' means a quantification of product environmental impacts throughout its life cycle, whether in relation to a single environmental impact category or an aggregated set of impact categories based on the Product Environmental Footprint method or other scientific methods developed by international organisations and widely tested in collaboration with different industry sectors and adopted or implemented by the Commission in other Union legislation; +(24) 'Product Environmental Footprint method' means the life cycle assessment method to quantify the environmental impacts of products established by Recommendation (EU) 2021/2279. + +
+
Name
+
environmentalFootprint
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#FootprintEntity + +
+
+
+
+
+ + +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
environmental
+
+ + +
+
+ +
+
Carbon Footprint
+
+ +The carbon footprint of the product. This is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I: +The following parameters shall, as appropriate, and where necessary supplemented by others, be used, individually or combined, as a basis for improving the product aspects referred to in Article 5(1): +(m) the carbon footprint of the product; +and Article 7: +(2)(b)(i) information on the performance of the product in relation to one or more of the product parameters referred to in Annex I, including a scoring of reparability or durability, carbon footprint or environmental footprint; +and defined by Article 2: +(25) 'carbon footprint' means the sum of greenhouse gas (GHG) emissions and GHG removals in a product system, expressed as CO2 equivalents and based on a life cycle assessment using the single impact category of climate change. + +
+
Name
+
carbonFootprint
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#FootprintEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
carbon
+
+ + +
+
+ +
+
Material Footprint
+
+ +The material footprint of the product. This is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I: +(ma) the material footprint of the product; +and defined by Article 2: +(25a) 'material footprint' refers to the total amount of raw materials extracted to meet final consumption demands. + +
+
Name
+
materialFootprint
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#FootprintEntity + +
+
+
+
+
+ + +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
material
+
+ + +
+
+
+
+

Range Entity

+
+
+ Entity for the concentration range with two values, the highest and the lowest of the concentration range. +
+ +
+

Properties

+
+
+ +
+
Minimum Concentration
+
+ +The minimum concentration of the substance of concern at the level of the product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7: +(5) (c) [...] concentration range of the substances of concern, at the level of the product [...]. + +
+
Name
+
minConcentration
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#float + +
+
+
+
+
+ +
+
Example
+
2.1
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
min
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + Positive Range Constraint +
    + +
    +
    Description
    +
    Constraint for only positive values.
    +
    + + +
    +
    +>= +
    + DefaultScalarValue[value=0.0, typeUri='DefaultScalar[metaModelVersion=SAMM_2_1_0, urn='http://www.w3.org/2001/XMLSchema#float']'] +
    +
    + +
    • +
+
+
+
+
+ +
+
Maximum Concentration
+
+ +The maximum concentration of the substance of concern at the level of the product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7: +(5) (c) the concentration, maximum concentration or concentration range of the substances of concern, at the level of the product [...]. + +
+
Name
+
maxConcentration
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#float + +
+
+
+
+
+ +
+
Example
+
2.6
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
max
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + Positive Range Constraint +
    + +
    +
    Description
    +
    Constraint for only positive values.
    +
    + + +
    +
    +>= +
    + DefaultScalarValue[value=0.0, typeUri='DefaultScalar[metaModelVersion=SAMM_2_1_0, urn='http://www.w3.org/2001/XMLSchema#float']'] +
    +
    + +
    • +
+
+
+
+
+
+
+

Service Entity

+
+
+ Entity for the service dates. +
+ +
+

Properties

+
+
+ +
+
Service History
+
+ +The dates of putting the eDrive into service. + +
+
Name
+
serviceHistory
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#date + +
+
+
+
+
+ +
+
Example
+
2020-02-15
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
history
+
+ + +
+
+ +
+
Last Service Date
+
+ +The date of the last service. + +
+
Name
+
lastServiceDate
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#date + +
+
+
+
+
+ +
+
Example
+
2022-03-03
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
lastServiceDate
+
+ + +
+
+
+
+

Sources Entity

+
+
+ Entity for a possible spare part sources. +
+ +
+

Properties

+
+
+ +
+
Sources Identification
+
+ +The identifier of a spare part producer of the product. In the Catena-X network, the BPNL is used for the identification of companies and the information stored for this like contact information and addresses. + +
+
Name
+
sourcesIdentification
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
    +
  • https://catena-x.net/fileadmin/user_upload/Standard-Bibliothek/Update_PDF_Maerz/5_BPDM/CX_-_0010_BUSINESS_PARTNER_NUMBER_PlatformCapabilityBPDM_v_1.0.1.pdf
    • +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
BPNL0123456789ZZ
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
id
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + BPNL Regular Expression +
    + +
    +
    Description
    +
    The provided regular expression ensures that the BPNL is composed of prefix 'BPNL', 10 digits and two alphanumeric letters.
    +
    + + +
    +
    Regular expression
    +
    ^BPNL[a-zA-Z0-9]{12}$
    +
    + +
    • +
+
+
+
+
+
+
+

Spare Part Entity

+
+
+ Information regarding possible spare parts. This is mentioned in the ESPR proposal from March 30th, 2022 Annex I: +(b) ease of repair and maintenance as expressed through: characteristics, availability and delivery time of spare parts, modularity, compatibility with commonly available spare parts, availability of repair and maintenance instructions, number of materials and components used, use of standard components, use of component and material coding standards for the identification of components and materials, number and complexity of processes and tools needed, ease of non-destructive disassembly and re-assembly, conditions for access to product data, conditions for access to or use of hardware and software needed; +(c) the Global Trade Identification Number as provided for in standard ISO/IEC 15459-6 or equivalent of products or their parts. +
+ +
+

Properties

+
+
+ +
+
Spare Part Sources
+
+ +Sources of possible spare parts. + +
+
Name
+
sparePartSources
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#SourcesEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
producer
+
+ + +
+
+ +
+
Spare Part
+
+ +Possible spare parts of the product. + +
+
Name
+
sparePart
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#PartsEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
sparePart
+
+ + +
+
+
+
+

Specific Entity

+
+
+ The Entity for product specific parameters of the electric drive. +
+ +
+

Properties

+
+
+ +
+
General Information
+
+ +General information to the eDrive system, including additional information in comparison to the identification category such as the service history and compatible vehicle types. + +
+
Name
+
generalInformation
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.electric_drive.electric_drive_passport:2.0.0#GeneralEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
generalInformation
+
+ + +
+
+ +
+
E-Machine
+
+ +Data of the e-Machine built into the eDrive, including information E-Machine model and technology (type), and the permanent magnet types / materials. + +
+
Name
+
eMachine
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.electric_drive.electric_drive_passport:2.0.0#EMachineEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
eMachine
+
+ + +
+
+ +
+
Cooling and Lubricants
+
+ +Information about the used lubricants and coolants, including liquid specifications and built-in technical lubricant systems. + +
+
Name
+
coolingAndLubricants
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.electric_drive.electric_drive_passport:2.0.0#LiquidsEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
coolingAndLubricants
+
+ + +
+
+ +
+
Inverter
+
+ +Inverter related data, that could be used in case of replacing or updating an inverter. + +
+
Name
+
inverter
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.electric_drive.electric_drive_passport:2.0.0#InverterEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
inverter
+
+ + +
+
+ +
+
System and Performance
+
+ +System and Performance information of the entire eDrive system. + +
+
Name
+
systemAndPerformance
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.electric_drive.electric_drive_passport:2.0.0#SystemEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
systemAndPerformance
+
+ + +
+
+ +
+
Transmission
+
+ +Information about the transmission built into the eDrive, including technical data. + +
+
Name
+
transmission
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.electric_drive.electric_drive_passport:2.0.0#TransmissionEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
transmission
+
+ + +
+
+ +
+
Electric Drive Documents
+
+ +Documents pertaining to the removal, replacement, disassembly or dismantling of the entire eDrive. + +
+
Name
+
electricDriveDocuments
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.electric_drive.electric_drive_passport:2.0.0#ElectricDriveDocumentsEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
electricDriveDocuments
+
+ + +
+
+
+
+

Substance Entity

+
+
+ Information regarding substances of concern in the product. +
+ +
+

Properties

+
+
+ +
+
Location
+
+ +The location of the substances of concern within the product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7: +(5) (b) the location of the substances of concern within the product. + +
+
Name
+
location
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Housing
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
location
+
+ + +
+
+ +
+
Material Unit
+
+ +The unit of concentration chosen from an enumeration: mass percent, volume percent, parts per thousand, parts per million, parts per billion and parts per trillion. + +
+
Name
+
materialUnit
+
+ + + +
+
Characteristic
+
+
+
+
Enumeration
+
+
+
Values
+
+
+
+
    +
  • unit:partPerMillion
    • +
  • unit:percent
    • +
  • unit:percentVolume
    • +
  • unit:partPerThousand
    • +
  • unit:partPerTrillionUs
    • +
  • unit:partPerBillionUs
    • +
+
+
+
+
+ Reference +
+
    +
  • https://eclipse-esmf.github.io/samm-specification/2.1.0/index.html
    • +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
unit:percent
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
unit
+
+ +
+
Reference
+
+
    +
  • https://eclipse-esmf.github.io/samm-specification/2.1.0/index.html
    • +
+
+
+ +
+
+ +
+
Concentration
+
+ +Concentration of the material at the level of the product. This attribute is specially mentioned for substances of concern mentioned in the ESPR proposal from March 30th, 2022 Article 7: +(5) (c) the concentration, maximum concentration or concentration range of the substances of concern, at the level of the product [...]. +Other substances are mentioned for the purpose of recycling in the ESPR provisional agreement from January 9th, 2024 Annex I: +(d) design for recycling, ease and quality of recycling as expressed through: use of easily recyclable materials, safe, easy and non-destructive access to recyclable components and materials or components and materials containing hazardous substances and material composition and homogeneity, possibility for high-purity sorting, number of materials and components used, use of standard components, use of component and material coding standards for the identification of components and materials, number and complexity of processes and tools needed, ease of nondestructive disassembly and re-assembly, conditions for access to product data, conditions for access to or use of hardware and software needed. + + +
+
Name
+
concentration
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#float + +
+
+
+
+
+ +
+
Example
+
5.3
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
concentration
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + Positive Range Constraint +
    + +
    +
    Description
    +
    Constraint for only positive values.
    +
    + + +
    +
    +>= +
    + DefaultScalarValue[value=0.0, typeUri='DefaultScalar[metaModelVersion=SAMM_2_1_0, urn='http://www.w3.org/2001/XMLSchema#float']'] +
    +
    + +
    • +
+
+
+
+
+ +
+
Exemption
+
+ +Exemptions to the substance of concern. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Article 7: +(5) (c) provide duly justified exemptions for substances of concern or information elements from the information requirements referred to in the first subparagraph based on the technical feasibility or relevance of tracking substances of concern, the existence of analytical methods to detect and quantify them, the need to protect confidential business information or in other duly justified cases. Substances of concern within the meaning of Article 2(28), point a), shall not be exempted if they are present in products, their relevant components or spare parts in a concentration above 0,1 % weight by weight. + +
+
Name
+
exemption
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
shall not apply to product x containing not more than 1,5 ml of liquid
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
exemption
+
+ + +
+
+ +
+
Hazard Classification
+
+ +The specification of the hazard class. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I: +(f) use of substances, and in particular the use of substances of concern, on their own, as constituents of substances or in mixtures, during the production process of products, or leading to their presence in products, including once these products become waste, and their impacts on human health and the environment; +Further defined is this by Regulation (EC) No 1272/2008 of the European Parliament and of the Council of 16 December 2008 on classification, labelling and packaging of substances and mixtures, amending and repealing Directives 67/548/EEC and 1999/45/EC, and amending Regulation (EC) No 1907/2006. +Defined in Article 2: +1. 'hazard class' means the nature of the physical, health or environmental hazard; +2. 'hazard category' means the division of criteria within each hazard class, specifying hazard severity; +5. 'hazard statement' means a phrase assigned to a hazard class and category that describes the nature of the hazards of a hazardous substance or mixture, including, where appropriate, the degree of hazard; + +
+
Name
+
hazardClassification
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#HazardEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
hazardClassification
+
+ +
+
Reference
+
+
    +
  • https://eur-lex.europa.eu/legal-content/EN/TXT/?uri=CELEX:02008R1272-20231201
    • +
+
+
+ +
+
+ +
+
Concentration Range
+
+ +The concentration range for the substance of concern. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7: +(5) (c) [...] concentration range of the substances of concern, at the level of the product [...]. + +
+
Name
+
concentrationRange
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#RangeEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
concentrationRange
+
+ + +
+
+ +
+
Material Identification
+
+ +The chemical material name and identification, in accordance with the specification in the attribute for the list type. Preference is given to the IUPAC name. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Article 7: +(5) (a) the name of the substances of concern present in the product, as follows: + - name(s) in the International Union of Pure and Applied Chemistry (IUPAC) nomenclature, or another international name when IUPAC name is not available; +- other names (usual name, trade name, abbreviation); +- European Community (EC) number, as indicated in the European Inventory of Existing Commercial Chemical Substances (EINECS), the European List of Notified Chemical Substances (ELINCS) or the No Longer Polymer (NLP) list or assigned by the European Chemicals Agency (ECHA), if available; +- the Chemical Abstract Service (CAS) name(s) and number(s), if available; . + +
+
Name
+
materialIdentification
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#MaterialIdEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
id
+
+ + +
+
+ +
+
Documentation
+
+ +Documentation accompanying the material. + +
+
Name
+
documentation
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#DocumentationEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
documentation
+
+ + +
+
+
+
+

Substance Of Concern Entity

+
+
+ Substance of Concern entity with attributes if applicable to the product. +
+ +
+

Properties

+
+
+ +
+
Applicable
+
+ +Check whether the connected attributes are applicable to the product. If it is not applicable (false), dummy data can be delivered. + +
+
Name
+
applicable
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#boolean + +
+
+
+
+
+ +
+
Example
+
true
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
applicable
+
+ + +
+
+ +
+
Substance of Concern
+
+ +Information regarding substances of concern in the product. Attributes are among others substance names, ids, concentration, location and hazard class. This is mentioned in the ESPR provisional agreement from January 9th, 2024 Article 7: +(5) (a) the name of the substances of concern present in the product, as follows: +- name(s) in the International Union of Pure and Applied Chemistry (IUPAC) nomenclature, or another international name when IUPAC name is not available; +- other names (usual name, trade name, abbreviation); +- European Community (EC) number, as indicated in the European Inventory of Existing Commercial Chemical Substances (EINECS), the European List of Notified Chemical Substances (ELINCS) or the No Longer Polymer (NLP) list or assigned by the European Chemicals Agency (ECHA), if available; +- the Chemical Abstract Service (CAS) name(s) and number(s), if available; +(5) (b) the location of the substances of concern within the product. +(5) (c) the concentration, maximum concentration or concentration range of the substances of concern, at the level of the product its relevant components, or spare parts; +(d) relevant instructions for the safe use of the product; +(e) information relevant for disassembly, preparation for reuse, reuse, recycling and the environmentally sound management of the product at the end of its life. +And in the next paragraph: +(c) provide duly justified exemptions for substances of concern or information elements from the information requirements referred to in the first subparagraph. + +
+
Name
+
substanceOfConcern
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#SubstanceEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
content
+
+ + +
+
+
+
+

Sustainability Entity

+
+
+ Entity with the properties regarding the sustainability of the product. +
+ +
+

Properties

+
+
+ +
+
State
+
+ +The status of the product (original, repurposed, re-used, remanufactured or waste) to indicated, whether it is a used product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Annex I: +(j) incorporation of used components. + +
+
Name
+
state
+
+ + + +
+
Characteristic
+
+
+
+
Enumeration
+
+
+
Values
+
+
+
+
    +
  • original
    • +
  • repurposed
    • +
  • re-used
    • +
  • remanufactured
    • +
  • waste
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
original
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
status
+
+ + +
+
+ +
+
Product Footprint
+
+ +The carbon and environmental footprint or material footprint of the product. These attributes are mentioned in the ESPR provisional agreement from January 9th 2024 Annex I: +(l) the environmental footprint of the product, expressed as a quantification, in accordance with the applicable delegated act, of a product's life cycle environmental impacts, whether in relation to one or more environmental impact categories or an aggregated set of impact categories; +(m) the carbon footprint of the product; +(ma) the material footprint of the product; +All are defined by Article 2: +(23) 'environmental footprint' means a quantification of product environmental impacts throughout its life cycle, whether in relation to a single environmental impact category or an aggregated set of impact categories based on the Product Environmental Footprint method or other scientific methods developed by international organisations and widely tested in collaboration with different industry sectors and adopted or implemented by the Commission in other Union +legislation; +(25) 'carbon footprint' means the sum of greenhouse gas (GHG) emissions and GHG removals in a product system, expressed as CO2 equivalents and based on a life cycle assessment using the single impact category of climate change. +(25a) 'material footprint' refers to the total amount of raw materials extracted to meet final consumption demands; + +
+
Name
+
productFootprint
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#ProductFootprintEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
productFootprint
+
+ + +
+
+ +
+
Reparability Score
+
+ +The reparability score. This attribute is mentioned ESPR provisional agreement from January 9th, 2024 Article 7: +(b) as appropriate, also require products to be accompanied by: +(i) information on the performance of the product in relation to one or more of the product parameters referred to in Annex I, including a scoring of reparability or durability [...]. + +
+
Name
+
reparabilityScore
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
B
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
reparabilityScore
+
+ + +
+
+ +
+
Durability Score
+
+ +The durability score. This attribute is mentioned ESPR provisional agreement from January 9th, 2024 Article 7: +(b) as appropriate, also require products to be accompanied by: +(i) information on the performance of the product in relation to one or more of the product parameters referred to in Annex I, including a scoring of reparability or durability [...]. + +
+
Name
+
durabilityScore
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
A
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
durabilityScore
+
+ + +
+
+
+
+

System Entity

+
+
+ Entity for performance and system values. +
+ +
+

Properties

+
+
+ +
+
System Voltage
+
+ +The characterizing voltage level in the vehicle in volts, to which the battery and electric drive are adjusted to. + +
+
Name
+
systemVoltage
+
+ + + +
+
Characteristic
+
+
+
+
Measurement
+
+
+
Measurement in volt as float value.
+
+
+
Unit
+
+
+
+
    +
  • + volt +
    • +
  • + Symbol V +
    • +
  • + Code VLT +
    • +
  • + Conversion factor V +
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#float + +
+
+
+
+
+ +
+
Example
+
400.0
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
voltage
+
+ + +
+
+ +
+
Power
+
+ +Technical power figures in kilowatt. + +
+
Name
+
power
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.electric_drive.electric_drive_passport:2.0.0#PowerEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
power
+
+ + +
+
+ +
+
Torque
+
+ +Technical torque figures. + +
+
Name
+
torque
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.electric_drive.electric_drive_passport:2.0.0#TorqueEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
torque
+
+ + +
+
+ +
+
Gear Ratio
+
+ +Gear ratio calculated by dividing the angular or rotational speed of the output shaft by the angular speed of the input shaft. It can also be calculated by dividing the total driving gear’s teeth by the total driven gear’s teeth. + +
+
Name
+
gearRatio
+
+ + + +
+
Characteristic
+
+
+
+
Measurement
+
+
+
Measurement of revolutions per minute as float value.
+
+
+
Unit
+
+
+
+
    +
  • + revolution per minute +
    • +
  • + Symbol r/min +
    • +
  • + Code M46 +
    • +
  • + Conversion factor 0.1047198 rad/s +
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#float + +
+
+
+
+
+ +
+
Example
+
4.1567
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
gearRatio
+
+ + +
+
+
+
+

Torque Entity

+
+
+ Entity for torque values. +
+ +
+

Properties

+
+
+ +
+
Maximum Torque
+
+ +The maximum torque the system delivers over a specific measurement time period. + +
+
Name
+
maximumTorque
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.electric_drive.electric_drive_passport:2.0.0#MaximumTorqueEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
maximum
+
+ + +
+
+ +
+
Maximum Axle Torque
+
+ +Maximum motor torque multiplied by the gear ratio. + +
+
Name
+
maximumAxleTorque
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.electric_drive.electric_drive_passport:2.0.0#MaximumTorqueEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
maxAxle
+
+ + +
+
+ +
+
Continuous Torque
+
+ +The torque that can be delivered without time limit in newton meters. + +
+
Name
+
continuousTorque
+
+ + + +
+
Characteristic
+
+
+
+
Measurement
+
+
+
Characteristic to describe torque in newton meters.
+
+
+
Unit
+
+
+
+
    +
  • + newton metre +
    • +
  • + Symbol N·m +
    • +
  • + Code NU +
    • +
  • + Conversion factor N × m +
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#nonNegativeInteger + +
+
+
+
+
+ +
+
Example
+
178
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
continuous
+
+ + +
+
+
+
+

Transmission Entity

+
+
+ Entity for transmission values. +
+ +
+

Properties

+
+
+ +
+
Transmission Id
+
+ +Transmission ID of the transmission i.e. serial number allowing for unequivocal identification of the transmission. + +
+
Name
+
transmissionId
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
384502A54FC9
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
transmissionId
+
+ + +
+
+ +
+
Gearbox Structure
+
+ +Short description of the gearbox design, e.g. layshaft or planetary, depending on the technical design of the car. + +
+
Name
+
gearboxStructure
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Planetary
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
gearboxStructure
+
+ + +
+
+ +
+
Oil
+
+ +The oil used for the transmission. + +
+
Name
+
oil
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.transmission.transmission_pass:3.0.0#OilEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
oil
+
+ + +
+
+
+
+

Volume Entity

+
+
+ Entity for volume measurements of an item with an unit and value. +
+ +
+

Properties

+
+
+ +
+
Quantity Value
+
+ +The quantity value associated with the unit. + +
+
Name
+
quantityValue
+
+ + + +
+
Characteristic
+
+
+
+
Quantifiable
+
+
+
Duration
+
+
+
The quantity value associated with the unit expressed as float.
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#float + +
+
+
+
+
+ +
+
Example
+
20.0
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
value
+
+ + +
+
+ +
+
Volume Unit
+
+ +The unit of a volume related attribute. + +
+
Name
+
volumeUnit
+
+ + + +
+
Characteristic
+
+
+
+
Enumeration
+
+
+
Values
+
+
+
+
    +
  • unit:cubicMetre
    • +
  • unit:litre
    • +
  • unit:millilitre
    • +
  • unit:cubicCentimetre
    • +
  • unit:cubicInch
    • +
  • unit:cubicFoot
    • +
  • unit:cubicYard
    • +
  • unit:hectolitre
    • +
+
+
+
+
+ Reference +
+
    +
  • https://eclipse-esmf.github.io/samm-specification/2.1.0/index.html
    • +
+
+
+
+
+
+ Type urn:samm:org.eclipse.esmf.samm:meta-model:2.1.0#curie + +
+
+
+
+
+ +
+
Example
+
unit:litre
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
unit
+
+ +
+
Reference
+
+
    +
  • https://eclipse-esmf.github.io/samm-specification/2.1.0/index.html
    • +
+
+
+ +
+
+
+ +
+ Third party licenses + +
+ +
+ + +
+ + + \ No newline at end of file diff --git a/io.catenax.electric_drive.electric_drive_passport/2.0.0/gen/ElectricDrivePassport.json b/io.catenax.electric_drive.electric_drive_passport/2.0.0/gen/ElectricDrivePassport.json new file mode 100644 index 000000000..bd6ffb791 --- /dev/null +++ b/io.catenax.electric_drive.electric_drive_passport/2.0.0/gen/ElectricDrivePassport.json @@ -0,0 +1,327 @@ +{ + "specific" : { + "eMachine" : { + "ratedSpeed" : 8000.0, + "weight" : { + "value" : 20.0, + "unit" : "unit:gram" + }, + "permanentMagnetType" : "Ceramic", + "statorDiameter" : 450.0, + "id" : "1785030A72B5752", + "technology" : "ESM" + }, + "transmission" : { + "transmissionId" : "384502A54FC9", + "gearboxStructure" : "Planetary", + "oil" : { + "oilType" : [ "Transmission Oil XY" ], + "oilCapacity" : 8.9 + } + }, + "inverter" : { + "maximumPhaseCurrent" : 700.0, + "inverterCurrent" : 500.0, + "softwareVersion" : "2.525.b" + }, + "generalInformation" : { + "compatibleVehicleTypes" : [ "battery-electric vehicle" ], + "service" : { + "history" : [ "2020-02-15" ], + "lastServiceDate" : "2022-03-03" + } + }, + "systemAndPerformance" : { + "torque" : { + "maximum" : { + "value" : 300.0, + "maximumAvailability" : 10 + }, + "maxAxle" : { + "value" : 300.0, + "maximumAvailability" : 10 + }, + "continuous" : 178 + }, + "gearRatio" : 4.1567, + "power" : { + "maximum" : { + "value" : 200.0, + "ECER85" : 195.0, + "maximumAvailability" : 10 + }, + "continuousRegenerated" : 5.0, + "maxRegenerated" : { + "maxValue" : 200.0, + "maximumAvailability" : 10 + }, + "continuous" : 16 + }, + "voltage" : 400.0 + }, + "electricDriveDocuments" : { + "requiredToolsForDismantling" : [ { + "contentType" : "URL", + "header" : "Example Document XYZ", + "content" : "https://dummy.link" + } ], + "technicalDismantlingInstructions" : [ { + "contentType" : "URL", + "header" : "Example Document XYZ", + "content" : "https://dummy.link" + } ] + }, + "coolingAndLubricants" : { + "maximumOilPressure" : 4.82633, + "oilCapacityEdrive" : 50.0, + "maximumOilTemperature" : 80.5, + "coolingTopology" : "air-cooled", + "oilTypeEdrive" : "5W-30", + "oilModule" : true, + "minimumOilPressure" : 2.068427 + } + }, + "generic" : { + "metadata" : { + "backupReference" : "https://dummy.link", + "registrationIdentifier" : "https://dummy.link/ID8283746239078", + "economicOperatorId" : "BPNL0123456789ZZ", + "lastModification" : "2000-01-01", + "predecessor" : "urn:uuid:00000000-0000-0000-0000-000000000000", + "issueDate" : "2000-01-01", + "version" : "1.0.0", + "passportIdentifier" : "urn:uuid:550e8400-e29b-41d4-a716-446655440000", + "status" : "draft", + "expirationDate" : "2030-01-01" + }, + "characteristics" : { + "generalPerformanceClass" : "A", + "physicalState" : "solid", + "physicalDimension" : { + "volume" : { + "value" : 20.0, + "unit" : "unit:cubicMetre" + }, + "grossWeight" : { + "value" : 20.0, + "unit" : "unit:gram" + }, + "diameter" : { + "value" : 20.0, + "unit" : "unit:millimetre" + }, + "grossVolume" : { + "value" : 20.0, + "unit" : "unit:cubicMetre" + }, + "width" : { + "value" : 20.0, + "unit" : "unit:millimetre" + }, + "length" : { + "value" : 20.0, + "unit" : "unit:millimetre" + }, + "weight" : { + "value" : 20.0, + "unit" : "unit:gram" + }, + "height" : { + "value" : 20.0, + "unit" : "unit:millimetre" + } + }, + "lifespan" : [ { + "value" : 36, + "unit" : "unit:day", + "key" : "guaranteed lifetime" + } ] + }, + "commercial" : { + "placedOnMarket" : "2000-01-01", + "purpose" : [ "automotive" ] + }, + "identification" : { + "batch" : [ { + "value" : "BID12345678", + "key" : "batchId" + } ], + "codes" : [ { + "value" : "8703 24 10 00", + "key" : "TARIC" + } ], + "type" : { + "manufacturerPartId" : "123-0.740-3434-A", + "nameAtManufacturer" : "Mirror left" + }, + "classification" : [ { + "classificationStandard" : "GIN 20510-21513", + "classificationID" : "1004712", + "classificationDescription" : "Generic standard for classification of parts in the automotive industry." + } ], + "serial" : [ { + "value" : "SN12345678", + "key" : "partInstanceId" + } ], + "dataCarrier" : { + "carrierType" : "QR", + "carrierLayout" : "upper-left side" + } + }, + "sources" : [ { + "header" : "Example Document XYZ", + "category" : "Product Specifications", + "type" : "URL", + "content" : "https://dummy.link" + } ], + "materials" : { + "substancesOfConcern" : { + "applicable" : true, + "content" : [ { + "unit" : "unit:partPerMillion", + "hazardClassification" : { + "category" : "category 1A", + "statement" : "Causes severe skin burns and eye damage.", + "class" : "Skin corrosion" + }, + "documentation" : [ { + "contentType" : "URL", + "header" : "Example Document XYZ", + "content" : "https://dummy.link" + } ], + "concentrationRange" : [ { + "max" : 2.6, + "min" : 2.1 + } ], + "location" : "Housing", + "concentration" : 5.3, + "exemption" : "shall not apply to product x containing not more than 1,5 ml of liquid", + "id" : [ { + "type" : "CAS", + "name" : "phenolphthalein", + "id" : "201-004-7" + } ] + } ] + }, + "materialComposition" : { + "applicable" : true, + "content" : [ { + "unit" : "unit:partPerMillion", + "recycled" : 12.5, + "critical" : true, + "renewable" : 23.5, + "documentation" : [ { + "contentType" : "URL", + "header" : "Example Document XYZ", + "content" : "https://dummy.link" + } ], + "concentration" : 5.3, + "id" : [ { + "type" : "CAS", + "name" : "phenolphthalein", + "id" : "201-004-7" + } ] + } ] + } + }, + "handling" : { + "applicable" : true, + "content" : { + "producer" : [ { + "id" : "BPNL0123456789ZZ" + } ], + "sparePart" : [ { + "manufacturerPartId" : "123-0.740-3434-A", + "nameAtManufacturer" : "Mirror left" + } ] + } + }, + "operation" : { + "import" : { + "applicable" : true, + "content" : { + "eori" : "GB123456789000", + "id" : "BPNL0123456789ZZ" + } + }, + "other" : { + "id" : "BPNL0123456789XX", + "role" : "distributor" + }, + "manufacturer" : { + "facility" : [ { + "facility" : "BPNA1234567890AA" + } ], + "manufacturingDate" : "2000-01-31", + "manufacturer" : "BPNLBfN4ucXtBZdg" + } + }, + "sustainability" : { + "reparabilityScore" : "B", + "productFootprint" : { + "material" : [ { + "lifecycle" : "main product production", + "rulebook" : [ { + "contentType" : "URL", + "header" : "Example Document XYZ", + "content" : "https://dummy.link" + } ], + "unit" : "kg CO2 / kWh", + "performanceClass" : "A", + "manufacturingPlant" : [ { + "facility" : "BPNA1234567890AA" + } ], + "type" : "Climate Change Total", + "value" : 12.678, + "declaration" : [ { + "contentType" : "URL", + "header" : "Example Document XYZ", + "content" : "https://dummy.link" + } ] + } ], + "carbon" : [ { + "lifecycle" : "main product production", + "rulebook" : [ { + "contentType" : "URL", + "header" : "Example Document XYZ", + "content" : "https://dummy.link" + } ], + "unit" : "kg CO2 / kWh", + "performanceClass" : "A", + "manufacturingPlant" : [ { + "facility" : "BPNA1234567890AA" + } ], + "type" : "Climate Change Total", + "value" : 12.678, + "declaration" : [ { + "contentType" : "URL", + "header" : "Example Document XYZ", + "content" : "https://dummy.link" + } ] + } ], + "environmental" : [ { + "lifecycle" : "main product production", + "rulebook" : [ { + "contentType" : "URL", + "header" : "Example Document XYZ", + "content" : "https://dummy.link" + } ], + "unit" : "kg CO2 / kWh", + "performanceClass" : "A", + "manufacturingPlant" : [ { + "facility" : "BPNA1234567890AA" + } ], + "type" : "Climate Change Total", + "value" : 12.678, + "declaration" : [ { + "contentType" : "URL", + "header" : "Example Document XYZ", + "content" : "https://dummy.link" + } ] + } ] + }, + "status" : "original", + "durabilityScore" : "A" + } + } +} \ No newline at end of file diff --git a/io.catenax.electric_drive.electric_drive_passport/2.0.0/gen/ElectricDrivePassport.yml b/io.catenax.electric_drive.electric_drive_passport/2.0.0/gen/ElectricDrivePassport.yml new file mode 100644 index 000000000..962064098 --- /dev/null +++ b/io.catenax.electric_drive.electric_drive_passport/2.0.0/gen/ElectricDrivePassport.yml @@ -0,0 +1,1910 @@ +--- +openapi: 3.0.3 +info: + title: Electric Drive Passport + version: v2 +servers: +- url: catenax.io/api/v2 + variables: + api-version: + default: v2 +paths: + /{tenant-id}/electric-drive-passport: + get: + tags: + - ElectricDrivePassport + operationId: getElectricDrivePassport + 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/ElectricDrivePassport' + "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.electric_drive.electric_drive_passport_2.0.0_CompatibleVehicleTypesTrait: + description: Constraint for the three possible vehicle types. A selection of + multiple is possible. + type: array + items: + type: string + pattern: "battery-electric vehicle|hybrid-electric vehicle|fuel-cell-electric\ + \ vehicle|(?:battery-electric vehicle, |hybrid-electric vehicle, |fuel-cell-electric\ + \ vehicle, )*battery-electric vehicle|hybrid-electric vehicle|fuel-cell-electric\ + \ vehicle" + urn_samm_io.catenax.electric_drive.electric_drive_passport_2.0.0_DateList: + description: A list of values in the data type date. + type: array + items: + type: string + format: date + urn_samm_io.catenax.electric_drive.electric_drive_passport_2.0.0_DateCharacteristic: + type: string + format: date + description: Characteristic for values in the data type date. + urn_samm_io.catenax.electric_drive.electric_drive_passport_2.0.0_ServiceCharacteristic: + description: Characteristic for the service dates. + type: object + properties: + history: + description: The dates of putting the eDrive into service. + $ref: '#/components/schemas/urn_samm_io.catenax.electric_drive.electric_drive_passport_2.0.0_DateList' + lastServiceDate: + description: The date of the last service. + $ref: '#/components/schemas/urn_samm_io.catenax.electric_drive.electric_drive_passport_2.0.0_DateCharacteristic' + required: + - history + - lastServiceDate + urn_samm_io.catenax.electric_drive.electric_drive_passport_2.0.0_GeneralCharacteristic: + description: Characteristic for general information. + type: object + properties: + compatibleVehicleTypes: + description: "The vehicle types, in which the eDrive of this passport can\ + \ be used. Possible selections are \"battery-electric vehicle\", \"hybrid-electric\ + \ vehicle\", \"fuel-cell-electric vehicle\"." + $ref: '#/components/schemas/urn_samm_io.catenax.electric_drive.electric_drive_passport_2.0.0_CompatibleVehicleTypesTrait' + service: + description: The eDrive service history. + $ref: '#/components/schemas/urn_samm_io.catenax.electric_drive.electric_drive_passport_2.0.0_ServiceCharacteristic' + required: + - compatibleVehicleTypes + urn_samm_io.catenax.electric_drive.electric_drive_passport_2.0.0_IdentifierCharacteristic: + type: string + description: Characteristic for identifiers of components in the electrical + drive. + 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.electric_drive.electric_drive_passport_2.0.0_RevolutionsMeasurement: + type: number + description: Measurement of revolutions per minute as float value. + urn_samm_io.catenax.electric_drive.electric_drive_passport_2.0.0_MillimetreMeasurement: + type: number + description: Measurement of millimetre as float value. + urn_samm_io.catenax.electric_drive.electric_drive_passport_2.0.0_TechnologyEnumeration: + type: string + description: Enumeration for the e-machine technology. + enum: + - ESM + - ASM + - PSM + urn_samm_io.catenax.shared.quantity_2.0.0_QuantityValueCharacteristic: + type: number + description: The quantity value associated with the unit expressed as float. + urn_samm_io.catenax.shared.quantity_2.0.0_MassUnitEnumeration: + type: string + pattern: "[a-zA-Z]*:[a-zA-Z]+" + description: Enumeration for mass units. + enum: + - unit:gram + - unit:kilogram + - unit:tonneMetricTon + - unit:tonUsOrShortTonUkorus + - unit:ounceAvoirdupois + - unit:pound + urn_samm_io.catenax.shared.quantity_2.0.0_MassCharacteristic: + description: Characteristic for mass measurements of an item. + type: object + properties: + value: + description: The quantity value associated with the unit. + $ref: '#/components/schemas/urn_samm_io.catenax.shared.quantity_2.0.0_QuantityValueCharacteristic' + unit: + description: The unit of a mass related attribute. + $ref: '#/components/schemas/urn_samm_io.catenax.shared.quantity_2.0.0_MassUnitEnumeration' + required: + - value + - unit + urn_samm_io.catenax.electric_drive.electric_drive_passport_2.0.0_EMachineCharacteristic: + description: Characteristic for e-machine values. + type: object + properties: + id: + description: The unique serial ID of the e-Machine built into the eDrive + of this passport; defined and provided by the owner/economic operator + of the passport. + $ref: '#/components/schemas/urn_samm_io.catenax.electric_drive.electric_drive_passport_2.0.0_IdentifierCharacteristic' + permanentMagnetType: + description: |- + The permanent magnet type describes the material composition of the permanent magnet in use. In case of SSM e-Motors, no permanent magnets are used, requiring the input of a default value. Possible selections: + - No permanent magnets used (SSM motor): "None" + - AlNiCo: "Aluminum-Nickel-Cobalt" + - Ceramic: "Ceramic" + - Ferrite: "Ferrite" + - Flexible: "Flexible Rubber" + - SmCo: "Samarium Cobalt" + - NdFeB: "Neodymium Iron Boron" + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + ratedSpeed: + description: "Rated speed determined by the electronics and measured in\ + \ RPM, limited through software or physical limits (e.g. maximum power)." + $ref: '#/components/schemas/urn_samm_io.catenax.electric_drive.electric_drive_passport_2.0.0_RevolutionsMeasurement' + statorDiameter: + description: "Diameter of the E-Machine stator, measured in millimetres." + $ref: '#/components/schemas/urn_samm_io.catenax.electric_drive.electric_drive_passport_2.0.0_MillimetreMeasurement' + technology: + description: "The type of the e-machine built into the eDrive. Possible\ + \ values are \"ASM\" (Asynchronous motor), \"PSM\" (Permanently excited\ + \ synchronous motor) and \"ESM\" (Electrically-excited synchronous motor).\ + \ This should not be confused with an electrical machine integrated in\ + \ a transmission." + $ref: '#/components/schemas/urn_samm_io.catenax.electric_drive.electric_drive_passport_2.0.0_TechnologyEnumeration' + weight: + description: "Net weight, component weight without packaging, of the electrical\ + \ machine, which is built into the eDrive." + $ref: '#/components/schemas/urn_samm_io.catenax.shared.quantity_2.0.0_MassCharacteristic' + required: + - id + - permanentMagnetType + - ratedSpeed + - statorDiameter + - technology + - weight + urn_samm_io.catenax.electric_drive.electric_drive_passport_2.0.0_CoolingEnumeration: + type: string + description: Enumeration of cooling technology. + enum: + - air-cooled + - water-cooled + - oil-cooled + urn_samm_io.catenax.transmission.transmission_pass_3.0.0_Capacity: + type: number + description: The oil capacity in dm³. + urn_samm_io.catenax.electric_drive.electric_drive_passport_2.0.0_BarMeasurement: + type: number + description: Measurement of the pressure in bar as float value. + 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.electric_drive.electric_drive_passport_2.0.0_CelsiusMeasurement: + type: number + description: Measurement in celsius as float value. + urn_samm_io.catenax.electric_drive.electric_drive_passport_2.0.0_LiquidsCharacteristic: + description: Entity for cooling and lubricants. + type: object + properties: + coolingTopology: + description: "General cooling topology, which can be either one of the types:\ + \ \"air-cooled\", \"water-cooled\" or \"oil-cooled\"." + $ref: '#/components/schemas/urn_samm_io.catenax.electric_drive.electric_drive_passport_2.0.0_CoolingEnumeration' + oilCapacityEdrive: + description: "The defined oil volume in the eDrive, measured in cubic decimetres.\ + \ In case of a combined oil circuit for both the eDrive and the built-in\ + \ transmission, the value must be identical to the oil capacity value\ + \ of the transmission." + $ref: '#/components/schemas/urn_samm_io.catenax.transmission.transmission_pass_3.0.0_Capacity' + oilTypeEdrive: + description: "The type of the oil for the eDrive defined by the manufacturer.\ + \ In case of a combined oil circuit for both the eDrive and the built-in\ + \ transmission, the value must be identical to the oil type value of the\ + \ transmission." + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + minimumOilPressure: + description: Minimum operational oil pressure value defined by the manufacturer + of the E-Drive measured in bar. + $ref: '#/components/schemas/urn_samm_io.catenax.electric_drive.electric_drive_passport_2.0.0_BarMeasurement' + maximumOilPressure: + description: Maximum operational oil pressure value defined by the manufacturer + of the E-Drive measured in bar. + $ref: '#/components/schemas/urn_samm_io.catenax.electric_drive.electric_drive_passport_2.0.0_BarMeasurement' + oilModule: + description: "Flag indicating the availability or absence of an oil module.\ + \ An oil module is an umbrella term for devices that are manipulating\ + \ the oil flow and the temperature in the product and incorporate cooler,\ + \ pump, valves (pressure regulation valve)." + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Boolean' + maximumOilTemperature: + description: "The maximum oil temperature to safely operate the eDrive,\ + \ measured in celsius on the oil temperature sensor. Please note the oil\ + \ temperature can vary in other positions within the lubrication circuit." + $ref: '#/components/schemas/urn_samm_io.catenax.electric_drive.electric_drive_passport_2.0.0_CelsiusMeasurement' + required: + - coolingTopology + - oilCapacityEdrive + - oilTypeEdrive + - oilModule + - maximumOilTemperature + urn_samm_io.catenax.electric_drive.electric_drive_passport_2.0.0_AmpereMeasurement: + type: number + description: Measurement of ampere as float value. + urn_samm_io.catenax.electric_drive.electric_drive_passport_2.0.0_InverterCharacteristic: + description: Characteristic for inverter values. + type: object + properties: + inverterCurrent: + description: "Electric current flowing through the inverter, measured in\ + \ ampere." + $ref: '#/components/schemas/urn_samm_io.catenax.electric_drive.electric_drive_passport_2.0.0_AmpereMeasurement' + maximumPhaseCurrent: + description: "The maximum allowable current to pass through the phases,\ + \ measured in ampere." + $ref: '#/components/schemas/urn_samm_io.catenax.electric_drive.electric_drive_passport_2.0.0_AmpereMeasurement' + softwareVersion: + description: Indicates the software version of the inverter. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + required: + - inverterCurrent + - softwareVersion + urn_samm_io.catenax.electric_drive.electric_drive_passport_2.0.0_VoltMeasurement: + type: number + description: Measurement in volt as float value. + urn_samm_io.catenax.electric_drive.electric_drive_passport_2.0.0_KilowattMeasurement: + type: number + description: Measurement in kilowatt as float value. + urn_samm_io.catenax.transmission.transmission_pass_3.0.0_TimeMeasurement: + type: number + minimum: 0 + description: Time in seconds. + urn_samm_io.catenax.electric_drive.electric_drive_passport_2.0.0_MaximumPowerCharacteristic: + description: Characteristic with maximum power values. + type: object + properties: + value: + description: The maximum value in kilowatts for a specified time period. + $ref: '#/components/schemas/urn_samm_io.catenax.electric_drive.electric_drive_passport_2.0.0_KilowattMeasurement' + ECER85: + description: "Maximum power in kilowatts, measured according to the ECER85\ + \ regulatory requirements." + $ref: '#/components/schemas/urn_samm_io.catenax.electric_drive.electric_drive_passport_2.0.0_KilowattMeasurement' + maximumAvailability: + description: Specified time period for the peak measurement in seconds. + $ref: '#/components/schemas/urn_samm_io.catenax.transmission.transmission_pass_3.0.0_TimeMeasurement' + required: + - value + - maximumAvailability + urn_samm_io.catenax.electric_drive.electric_drive_passport_2.0.0_MaximumRegeneratedPowerCharacteristic: + description: Characteristic for maximum regenerated power values. + type: object + properties: + maxValue: + description: The maximum value in kilowatts for a specified time period. + $ref: '#/components/schemas/urn_samm_io.catenax.electric_drive.electric_drive_passport_2.0.0_KilowattMeasurement' + maximumAvailability: + description: Specified time period for the peak measurement in seconds. + $ref: '#/components/schemas/urn_samm_io.catenax.transmission.transmission_pass_3.0.0_TimeMeasurement' + required: + - maxValue + - maximumAvailability + urn_samm_io.catenax.transmission.transmission_pass_3.0.0_KilowattMeasurement: + type: number + minimum: 0 + description: The performance power in kilowatt as non-negative integer. + urn_samm_io.catenax.electric_drive.electric_drive_passport_2.0.0_PowerCharacteristic: + description: Characteristic for power values. + type: object + properties: + maximum: + description: The maximum output power in kilowatts for a specified time + period. + $ref: '#/components/schemas/urn_samm_io.catenax.electric_drive.electric_drive_passport_2.0.0_MaximumPowerCharacteristic' + continuousRegenerated: + description: "The amount of power, which can be regenerated continuously,\ + \ within the bounds of normal operation, in kilowatts." + $ref: '#/components/schemas/urn_samm_io.catenax.electric_drive.electric_drive_passport_2.0.0_KilowattMeasurement' + maxRegenerated: + description: The maximum possible value that can be regenerated at a given + time in kilowatts. + $ref: '#/components/schemas/urn_samm_io.catenax.electric_drive.electric_drive_passport_2.0.0_MaximumRegeneratedPowerCharacteristic' + continuous: + description: The power that can be delivered without time limit. + $ref: '#/components/schemas/urn_samm_io.catenax.transmission.transmission_pass_3.0.0_KilowattMeasurement' + required: + - maximum + - continuousRegenerated + - maxRegenerated + - continuous + urn_samm_io.catenax.electric_drive.electric_drive_passport_2.0.0_NewtonMetreMeasurement: + type: number + description: Measurement in newton metre as decimal value. + urn_samm_io.catenax.electric_drive.electric_drive_passport_2.0.0_MaximumTorqueCharacteristic: + description: Characteristic for maximum torque values. + type: object + properties: + value: + description: Measured torque value in newton metre. + $ref: '#/components/schemas/urn_samm_io.catenax.electric_drive.electric_drive_passport_2.0.0_NewtonMetreMeasurement' + maximumAvailability: + description: Specified time period for the peak measurement in seconds. + $ref: '#/components/schemas/urn_samm_io.catenax.transmission.transmission_pass_3.0.0_TimeMeasurement' + required: + - value + - maximumAvailability + urn_samm_io.catenax.transmission.transmission_pass_3.0.0_TorqueNewtonMetre: + type: number + minimum: 0 + description: Characteristic to describe torque in newton meters. + urn_samm_io.catenax.electric_drive.electric_drive_passport_2.0.0_TorqueCharacteristic: + description: Entity for torque values. + type: object + properties: + maximum: + description: The maximum torque the system delivers over a specific measurement + time period. + $ref: '#/components/schemas/urn_samm_io.catenax.electric_drive.electric_drive_passport_2.0.0_MaximumTorqueCharacteristic' + maxAxle: + description: Maximum motor torque multiplied by the gear ratio. + $ref: '#/components/schemas/urn_samm_io.catenax.electric_drive.electric_drive_passport_2.0.0_MaximumTorqueCharacteristic' + continuous: + description: The torque that can be delivered without time limit in newton + meters. + $ref: '#/components/schemas/urn_samm_io.catenax.transmission.transmission_pass_3.0.0_TorqueNewtonMetre' + required: + - maximum + - maxAxle + - continuous + urn_samm_io.catenax.electric_drive.electric_drive_passport_2.0.0_SystemCharacteristic: + description: Characteristic for performance and system values. + type: object + properties: + voltage: + description: "The characterizing voltage level in the vehicle in volts,\ + \ to which the battery and electric drive are adjusted to." + $ref: '#/components/schemas/urn_samm_io.catenax.electric_drive.electric_drive_passport_2.0.0_VoltMeasurement' + power: + description: Technical power figures in kilowatt. + $ref: '#/components/schemas/urn_samm_io.catenax.electric_drive.electric_drive_passport_2.0.0_PowerCharacteristic' + torque: + description: Technical torque figures. + $ref: '#/components/schemas/urn_samm_io.catenax.electric_drive.electric_drive_passport_2.0.0_TorqueCharacteristic' + gearRatio: + description: Gear ratio calculated by dividing the angular or rotational + speed of the output shaft by the angular speed of the input shaft. It + can also be calculated by dividing the total driving gear’s teeth by the + total driven gear’s teeth. + $ref: '#/components/schemas/urn_samm_io.catenax.electric_drive.electric_drive_passport_2.0.0_RevolutionsMeasurement' + required: + - voltage + - power + - torque + - gearRatio + urn_samm_io.catenax.transmission.transmission_pass_3.0.0_StringList: + description: A list with the data types string. + type: array + items: + type: string + urn_samm_io.catenax.transmission.transmission_pass_3.0.0_OilCharacteristic: + description: Characteristic for the oil. + type: object + properties: + oilCapacity: + description: The defined oil volume in the transmission in cubic decimeters. + $ref: '#/components/schemas/urn_samm_io.catenax.transmission.transmission_pass_3.0.0_Capacity' + oilType: + description: The type of the oil for the transmission defined by the manufacturer + of the transmission. + $ref: '#/components/schemas/urn_samm_io.catenax.transmission.transmission_pass_3.0.0_StringList' + required: + - oilCapacity + - oilType + urn_samm_io.catenax.electric_drive.electric_drive_passport_2.0.0_TransmissionCharacteristic: + description: Characteristic for transmission values. + type: object + properties: + transmissionId: + description: Transmission ID of the transmission i.e. serial number allowing + for unequivocal identification of the transmission. + $ref: '#/components/schemas/urn_samm_io.catenax.electric_drive.electric_drive_passport_2.0.0_IdentifierCharacteristic' + gearboxStructure: + description: "Short description of the gearbox design, e.g. layshaft or\ + \ planetary, depending on the technical design of the car." + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + oil: + description: The oil used for the transmission. + $ref: '#/components/schemas/urn_samm_io.catenax.transmission.transmission_pass_3.0.0_OilCharacteristic' + required: + - transmissionId + - gearboxStructure + - oil + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_HeaderTrait: + type: string + description: Constraint for a maximum of 100 characters. + maxLength: 100 + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentationEntity: + description: "Entity for a document with a header, type and content." + type: object + properties: + content: + description: The content of the document e.g a link. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + contentType: + description: "The type of content which can be expected in the \"content\"\ + \ property. Examples are a link, restricted link, pdf, excel, etc." + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + header: + description: The header as a short description of the document with a maximum + of 100 characters. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_HeaderTrait' + required: + - content + - contentType + - header + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentList: + description: List of documents. + type: array + items: + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentationEntity' + urn_samm_io.catenax.electric_drive.electric_drive_passport_2.0.0_ElectricDriveDocumentsCharacteristic: + description: Characteristic for specific documents of the electric drive. + type: object + properties: + technicalDismantlingInstructions: + description: "Document containing information and instructions, including\ + \ steps, diagrams and illustrations of removing or replacing the eDrive\ + \ or dismantling it." + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentList' + requiredToolsForDismantling: + description: "Document containing information and instructions for required\ + \ tools or technologies pertaining to the removal, replacement or dismantling\ + \ of the eDrive." + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentList' + required: + - technicalDismantlingInstructions + - requiredToolsForDismantling + urn_samm_io.catenax.electric_drive.electric_drive_passport_2.0.0_SpecificCharacteristic: + description: The Characteristic to describe product specific parameters of the + electric drive. + type: object + properties: + generalInformation: + description: "General information to the eDrive system, including additional\ + \ information in comparison to the identification category such as the\ + \ service history and compatible vehicle types." + $ref: '#/components/schemas/urn_samm_io.catenax.electric_drive.electric_drive_passport_2.0.0_GeneralCharacteristic' + eMachine: + description: "Data of the e-Machine built into the eDrive, including information\ + \ E-Machine model and technology (type), and the permanent magnet types\ + \ / materials." + $ref: '#/components/schemas/urn_samm_io.catenax.electric_drive.electric_drive_passport_2.0.0_EMachineCharacteristic' + coolingAndLubricants: + description: "Information about the used lubricants and coolants, including\ + \ liquid specifications and built-in technical lubricant systems." + $ref: '#/components/schemas/urn_samm_io.catenax.electric_drive.electric_drive_passport_2.0.0_LiquidsCharacteristic' + inverter: + description: "Inverter related data, that could be used in case of replacing\ + \ or updating an inverter." + $ref: '#/components/schemas/urn_samm_io.catenax.electric_drive.electric_drive_passport_2.0.0_InverterCharacteristic' + systemAndPerformance: + description: System and Performance information of the entire eDrive system. + $ref: '#/components/schemas/urn_samm_io.catenax.electric_drive.electric_drive_passport_2.0.0_SystemCharacteristic' + transmission: + description: "Information about the transmission built into the eDrive,\ + \ including technical data." + $ref: '#/components/schemas/urn_samm_io.catenax.electric_drive.electric_drive_passport_2.0.0_TransmissionCharacteristic' + electricDriveDocuments: + description: "Documents pertaining to the removal, replacement, disassembly\ + \ or dismantling of the entire eDrive." + $ref: '#/components/schemas/urn_samm_io.catenax.electric_drive.electric_drive_passport_2.0.0_ElectricDriveDocumentsCharacteristic' + required: + - generalInformation + - eMachine + - coolingAndLubricants + - inverter + - systemAndPerformance + - transmission + - electricDriveDocuments + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_StatusEnumeration: + type: string + description: "The current status of the product passport declared through either:\ + \ draft, approved, invalid or expired." + enum: + - draft + - approved + - invalid + - expired + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DateTrait: + type: string + description: Constraint fo a timestamp in the format (yyyy-mm-dd). + pattern: "^\\d{4}-\\d{2}-\\d{2}$" + urn_samm_io.catenax.shared.business_partner_number_2.0.0_BpnlTrait: + type: string + description: "The provided regular expression ensures that the BPNL is composed\ + \ of prefix 'BPNL', 10 digits and two alphanumeric letters." + pattern: "^BPNL[a-zA-Z0-9]{12}$" + 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_io.catenax.generic.digital_product_passport_5.0.0_IdentifierCharacteristic: + type: string + description: Characteristic for Identifiers. + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_MetadataCharacteristic: + description: Characteristic for the passport metadata of the digital product + passport. + type: object + properties: + version: + description: |- + The current version of the product passport. The possibility of modification/ updating the product passport needs to include versioning of the dataset. This attribute is an internal versioning from the passport issuer. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Article 8: + (1) [...] The information in the product passport shall be accurate, complete, and up to date. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + status: + description: "The current status of the product passport declared through\ + \ either: draft, approved, invalid or expired." + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_StatusEnumeration' + expirationDate: + description: |- + The timestamp in the format (yyyy-mm-dd) for the product passport until when it is available or a comment describing this period. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Article 8: + (2) (h) the period during which the product passport is to remain available, which shall correspond to at least the expected lifetime of a specific product. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DateTrait' + issueDate: + description: The timestamp in the format (yyyy-mm-dd) since when the product + passport is available. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DateTrait' + economicOperatorId: + description: |- + The identification of the owner/economic operator of the passport. Proposed, according to ISO 15459, is the CIN (company identification code). Other identification numbers like the tax identification number, value added tax identification number, commercial register number and the like are also valid entries. In the Catena-X network, the BPNL is used for the identification of companies and the information stored like contact information and addresses. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Annex III: + (k) the [...] unique operator identifier code of the economic operator established in the Union responsible for carrying out the tasks set out in Article 4 of Regulation (EU) 2019/1020, or Article 15 of Regulation (EU) on general product safety, or similar tasks pursuant to other EU legislation applicable to the product. + $ref: '#/components/schemas/urn_samm_io.catenax.shared.business_partner_number_2.0.0_BpnlTrait' + passportIdentifier: + description: "The identifier of the product passport, which is an uuidv4." + $ref: '#/components/schemas/urn_samm_io.catenax.shared.uuid_2.0.0_UuidV4Trait' + predecessor: + description: |- + Identification of the preceding product passport. If there is no preceding passport, input a dummy value. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Article 8: + (2)(g) [...] Any new product passport shall be linked to the product passport or passports of the original product whenever appropriate. + $ref: '#/components/schemas/urn_samm_io.catenax.shared.uuid_2.0.0_UuidV4Trait' + backupReference: + description: |- + A reference to the data backup of the passport. This mandatory attribute will be further defined in the future. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex III: + (kb) the reference of the certified independent third-party product passport service provider hosting the back-up copy of the product passport. + Article 10 also mentions: + (c) the data included in the product passport shall be stored by the economic operator responsible for its creation or by certified independent third-party product passport service providers authorised to act on their behalf. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + registrationIdentifier: + description: |- + Identifier in the respective registry. This will be further defined in the future. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 in Article 12: + By [2 years from entering into force of this Regulation], the Commission shall set up and manage a digital registry ("the registry") storing in a secure manner at least the unique product identifier, the unique operator identifier, the unique facility identifiers. In case of products intended to be placed under the customs procedure 'release for free circulation', the registry shall also store the product commodity code. The registry shall also store the batteries' unique identifiers referred to in Article 77(3) of Regulation (EU) 2023/1542. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_IdentifierCharacteristic' + lastModification: + description: Date of the latest modification. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DateTrait' + required: + - version + - expirationDate + - issueDate + - economicOperatorId + - passportIdentifier + - predecessor + - backupReference + urn_samm_io.catenax.serial_part_3.0.0_KeyTrait: + type: string + description: Constraint that ensures that the standard keys and custom key prefixes + can be used. + pattern: ^(manufacturerId|partInstanceId|batchId|van|customKey:\w+)$ + urn_samm_io.catenax.serial_part_3.0.0_ValueCharacteristic: + type: string + description: The value of an identifier. + urn_samm_io.catenax.serial_part_3.0.0_KeyValueList: + description: "A list of key value pairs for local identifiers, which are composed\ + \ of a key and a corresponding value." + type: object + properties: + key: + description: 'The key of a local identifier. ' + $ref: '#/components/schemas/urn_samm_io.catenax.serial_part_3.0.0_KeyTrait' + value: + description: The value of an identifier. + $ref: '#/components/schemas/urn_samm_io.catenax.serial_part_3.0.0_ValueCharacteristic' + required: + - key + - value + urn_samm_io.catenax.serial_part_3.0.0_LocalIdentifierCharacteristic: + description: "A single serialized part may have multiple attributes, that uniquely\ + \ identify a that part in a specific dataspace (e.g. the manufacturer`s dataspace)" + type: array + items: + $ref: '#/components/schemas/urn_samm_io.catenax.serial_part_3.0.0_KeyValueList' + uniqueItems: true + urn_samm_io.catenax.batch_3.0.0_KeyTrait: + type: string + description: Constraint that ensures that the predefined keys are used. + pattern: ^(manufacturerId|batchId|customKey:\w+)$ + urn_samm_io.catenax.batch_3.0.0_ValueCharacteristic: + type: string + description: The value of an identifier. + urn_samm_io.catenax.batch_3.0.0_KeyValueList: + description: "A list of key value pairs for local identifiers, which are composed\ + \ of a key and a corresponding value." + type: object + properties: + key: + description: The key of a local identifier. + $ref: '#/components/schemas/urn_samm_io.catenax.batch_3.0.0_KeyTrait' + value: + description: The value of an identifier. + $ref: '#/components/schemas/urn_samm_io.catenax.batch_3.0.0_ValueCharacteristic' + required: + - key + - value + urn_samm_io.catenax.batch_3.0.0_LocalIdentifierCharacteristic: + description: "A batch may have multiple attributes, which uniquely identify\ + \ that batch in a specific dataspace(e.g. the manufacturer`s dataspace)" + type: array + items: + $ref: '#/components/schemas/urn_samm_io.catenax.batch_3.0.0_KeyValueList' + uniqueItems: true + urn_samm_io.catenax.part_type_information_1.0.0_PartIdCharacteristic: + type: string + description: "The part ID is a multi-character string, usually assigned by an\ + \ ERP system." + urn_samm_io.catenax.part_type_information_1.0.0_PartNameCharacteristic: + type: string + description: Part name in string format from the respective system in the value + chain. + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PartTypeCharacteristic: + description: Characteristic for the part type. + type: object + properties: + manufacturerPartId: + description: Part ID as assigned by the manufacturer of the part. The part + ID identifies the part in the manufacturer`s dataspace. The part ID references + a specific version of a part. The version number must be included in the + part ID if it is available. The part ID does not reference a specific + instance of a part and must not be confused with the serial number. + $ref: '#/components/schemas/urn_samm_io.catenax.part_type_information_1.0.0_PartIdCharacteristic' + nameAtManufacturer: + description: Name of the part as assigned by the manufacturer. + $ref: '#/components/schemas/urn_samm_io.catenax.part_type_information_1.0.0_PartNameCharacteristic' + required: + - manufacturerPartId + - nameAtManufacturer + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_CodeEntity: + description: Code entity with code key and value. + type: object + properties: + key: + description: |- + The code key for the identification of the product. Examples are GTIN, hash, DID, ISBN, TARIC. This attribute is mentioned in the ESPR proposal from March 30th, 2022 ANNEX III: + (b) the unique product identifier at the level indicated in the applicable delegated act adopted pursuant to Article 4; + (c) the Global Trade Identification Number as provided for in standard ISO/IEC 15459-6 or equivalent of products or their parts; + (d) relevant commodity codes, such as a TARIC code as defined in Council Regulation (EEC) No 2658/87. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_IdentifierCharacteristic' + value: + description: The code value for the identification of the product in regard + to the chosen code name. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_IdentifierCharacteristic' + required: + - key + - value + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_CodeList: + description: A list of additional codes. + type: array + items: + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_CodeEntity' + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DataCarrierCharacteristic: + description: Data Carrier Characteristic for the product. + type: object + properties: + carrierType: + description: |- + The type of data carrier such as a QR code on the product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 8: + (2) (b) the types of data carrier to be used. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + carrierLayout: + description: |- + The positioning of data carrier on the product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 8: + (2) (c) the layout in which the data carrier shall be presented and its positioning. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + required: + - carrierType + - carrierLayout + urn_samm_io.catenax.shared.part_classification_1.0.0_ClassificationStandardCharacteristic: + type: string + description: Identified classification standards that align to the Catena-X + needs. + urn_samm_io.catenax.shared.part_classification_1.0.0_ClassificationIDCharacteristic: + type: string + description: "It can be numeric or a string, depending on the chosen classification\ + \ standard." + urn_samm_io.catenax.shared.part_classification_1.0.0_ClassificationEntity: + description: Encapsulates data related to the classification of the part. + type: object + properties: + classificationStandard: + description: Identified classification standards that align to the Catena-X + needs. + $ref: '#/components/schemas/urn_samm_io.catenax.shared.part_classification_1.0.0_ClassificationStandardCharacteristic' + classificationID: + description: The classification ID of the part type according to the corresponding + standard definition mentioned in the key value pair. + $ref: '#/components/schemas/urn_samm_io.catenax.shared.part_classification_1.0.0_ClassificationIDCharacteristic' + classificationDescription: + description: Optional property describing the classification standard. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + required: + - classificationStandard + - classificationID + urn_samm_io.catenax.shared.part_classification_1.0.0_ClassificationCharacteristic: + description: Classification characteristic enabling a set of further properties. + type: array + items: + $ref: '#/components/schemas/urn_samm_io.catenax.shared.part_classification_1.0.0_ClassificationEntity' + uniqueItems: true + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_IdentificationCharacteristic: + description: Identification information of the product. + type: object + properties: + serial: + description: |- + Identifier for a serial part if available. This is mentioned in the ESPR provisional agreement from January 9th, 2024 Recital (27): + [...] an 'item' usually means a single unit of a model. + $ref: '#/components/schemas/urn_samm_io.catenax.serial_part_3.0.0_LocalIdentifierCharacteristic' + batch: + description: |- + Identifier for a batch part if available. Identifier for a serial part if available. This is mentioned in the ESPR provisional agreement from January 9th, 2024 Recital (27): + [...] a 'batch' usually means a subset of a specific model composed of all products produced in a specific manufacturing plant at a specific moment in time [...]. + $ref: '#/components/schemas/urn_samm_io.catenax.batch_3.0.0_LocalIdentifierCharacteristic' + type: + description: |- + Identifier on the level of a part model or type. Identifier for a serial part if available. This is mentioned in the ESPR provisional agreement from January 9th, 2024 Recital (27): + [...] A 'model' usually means a version of a product of which all units share the same technical characteristics relevant for the ecodesign requirements and the same model identifier [...]. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PartTypeCharacteristic' + codes: + description: Codes for identification. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_CodeList' + dataCarrier: + description: |- + The type and layout of the data carrier on the product. These are mentioned in the ESPR proposal from March 30th, 2022 Article 8: + (b) the types of data carrier to be used; + (c) the layout in which the data carrier shall be presented and its positioning; + Article 2 defines: + (30) 'data carrier' means a linear bar code symbol, a two-dimensional symbol or other automatic identification data capture medium that can be read by a device. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DataCarrierCharacteristic' + classification: + description: Property describing the classification of a part. + $ref: '#/components/schemas/urn_samm_io.catenax.shared.part_classification_1.0.0_ClassificationCharacteristic' + required: + - type + - codes + - dataCarrier + - classification + urn_samm_io.catenax.shared.business_partner_number_2.0.0_BpnaTrait: + type: string + description: "The provided regular expression ensures that the BPNA is composed\ + \ of prefix 'BPNA', 10 digits and two alphanumeric letters." + pattern: "^BPNA[a-zA-Z0-9]{12}$" + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_FacilityEntity: + description: The entity for a facility with the BPNA identifier. + type: object + properties: + facility: + description: |- + The identifier used for a location. This attribute is mentioned in the ESPR provisional agreement from January 9th 2024 Annex III: + (i) unique facility identifiers; + Article 2 Definitions: (33) 'unique facility identifier' means a unique string of characters for the identification of locations or buildings involved in the value chain of a product or used by actors involved in the value chain of a product. + $ref: '#/components/schemas/urn_samm_io.catenax.shared.business_partner_number_2.0.0_BpnaTrait' + required: + - facility + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_FacilityList: + description: List of facilities. + type: array + items: + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_FacilityEntity' + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_ManufacturerCharacteristic: + description: Manufacturing information. + type: object + properties: + facility: + description: |- + The identifier used for a location. In the CATENA-X use case, the BPNA can be stated. This attribute is mentioned in the ESPR provisional agreement from January 9th 2024 Annex III: + (i) unique facility identifiers; + Article 2 Definitions: (33) 'unique facility identifier' means a unique string of characters for the identification of locations or buildings involved in the value chain of a product or used by actors involved in the value chain of a product. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_FacilityList' + manufacturer: + description: |- + The main manufacturer, if different from the passport owner, represented by an identification number. In the Catena-X use case, the BPNL can be stated. This attribute is mentioned in the ESPR provisional agreement from January 9th 2024 Annex III: + (h) unique operator identifiers other than that of the manufacturer; + (k) the name, contact details and unique operator identifier code of the economic operator established in the Union responsible for carrying out the tasks set out in Article 4 of Regulation (EU) 2019/1020, or Article 15 of Regulation (EU) [.../...] on general product safety, or similar tasks pursuant to other EU legislation applicable to the product. + $ref: '#/components/schemas/urn_samm_io.catenax.shared.business_partner_number_2.0.0_BpnlTrait' + manufacturingDate: + description: "The timestamp in the format (yyyy-mm-dd) of the manufacturing\ + \ date as the final step in production process (e.g. final quality check,\ + \ ready-for-shipment event)." + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DateTrait' + required: + - facility + - manufacturer + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_EoriTrait: + type: string + description: "Constraint with a pattern which ensures that the EORI number starts\ + \ with two alphanumeric characters, followed by two alphabetic characters,\ + \ and ends with 2 to 15 alphanumeric characters." + pattern: "^[A-Z]{2}[A-Z0-9]{1,18}$" + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_ImporterCharacteristic: + description: Characteristic with information regarding the importer. + type: object + properties: + eori: + description: |- + An economic operator established in the customs territory of the Union needs, for customs purposes, an EORI number. EORI stands for economic operators registration and identification number. In this case, the importer's EORI must be provided. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Annex III: + (j) information related to the importer, including the information referred to in Article 23(3) and its EORI number. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_EoriTrait' + id: + description: |- + The importer of the product, if different from the owner of the passport. In the Catena-X network, the BPNL is used for the identification of companies and the information stored for this like contact information and addresses. + This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex III: + (j) information related to the importer, including the information referred to in Article 23(3) and its EORI number; + Article 23 states: + (3) Importers shall, for products covered by a delegated act adopted pursuant to Article 4, indicate their name, registered trade name or registered trade mark and the postal address and electronic means of communication, where they can be contacted: (a) on the public part of the product passport, when applicable, and + (b) on the product or, where this is not possible, on the packaging, or in a document accompanying the product. + $ref: '#/components/schemas/urn_samm_io.catenax.shared.business_partner_number_2.0.0_BpnlTrait' + required: + - eori + - id + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_ImportCharacteristic: + description: Import Characteristic for the product. + type: object + properties: + content: + description: |- + Information regarding the importer of the product, if different from the owner of the passport. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex III: + (j) information related to the importer, including the information referred to in Article 23(3) and its EORI number; + Article 23 states: + (3) Importers shall, for products covered by a delegated act adopted pursuant to Article 4, indicate their name, registered trade name or registered trade mark and the postal address and electronic means of communication, where they can be contacted: (a) on the public part of the product passport, when applicable, and + (b) on the product or, where this is not possible, on the packaging, or in a document accompanying the product. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_ImporterCharacteristic' + applicable: + description: "Check whether the connected attributes are applicable to the\ + \ product. If it is not applicable (false), dummy data can be delivered." + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Boolean' + required: + - content + - applicable + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_OperatorCharacteristic: + description: Other operators characteristic. + type: object + properties: + id: + description: Identifier of the other operator. This can be a BPN. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + role: + description: Role of the other operator. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + required: + - id + - role + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_OperationCharacteristic: + description: Operational information of the product. + type: object + properties: + manufacturer: + description: |- + Manufacturing information of the product. In the CATENA-X use case, the BPNL and BPNA can be stated. These attributes are mentioned in the ESPR provisional agreement from January 9th 2024 Annex III: + (h) unique operator identifiers other than that of the manufacturer; + (k) the name, contact details and unique operator identifier code of the economic operator established in the Union responsible for carrying out the tasks set out in Article 4 of Regulation (EU) 2019/1020, or Article 15 of Regulation (EU) [.../...] on general product safety, or similar tasks pursuant to other EU legislation applicable to the product. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_ManufacturerCharacteristic' + import: + description: Importer details such as the identification. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_ImportCharacteristic' + other: + description: Other operators relevant for the product. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_OperatorCharacteristic' + required: + - manufacturer + - import + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_SourcesEntity: + description: Entity for a possible spare part sources. + type: object + properties: + id: + description: "The identifier of a spare part producer of the product. In\ + \ the Catena-X network, the BPNL is used for the identification of companies\ + \ and the information stored for this like contact information and addresses." + $ref: '#/components/schemas/urn_samm_io.catenax.shared.business_partner_number_2.0.0_BpnlTrait' + required: + - id + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_SourcesList: + description: List of possible spare part sources. + type: array + items: + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_SourcesEntity' + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PartsEntity: + description: Possible spare parts of the product with identifiers and names. + type: object + properties: + manufacturerPartId: + description: Part ID as assigned by the manufacturer of the part. The part + ID identifies the part in the manufacturer`s dataspace. The part ID references + a specific version of a part. The version number must be included in the + part ID if it is available. The part ID does not reference a specific + instance of a part and must not be confused with the serial number. + $ref: '#/components/schemas/urn_samm_io.catenax.part_type_information_1.0.0_PartIdCharacteristic' + nameAtManufacturer: + description: Name of the part as assigned by the manufacturer. + $ref: '#/components/schemas/urn_samm_io.catenax.part_type_information_1.0.0_PartNameCharacteristic' + required: + - manufacturerPartId + - nameAtManufacturer + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PartList: + description: A list of possible spare parts of the product. + type: array + items: + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PartsEntity' + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_SparePart: + description: Characteristic describing sources and spare parts. + type: object + properties: + producer: + description: Sources of possible spare parts. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_SourcesList' + sparePart: + description: Possible spare parts of the product. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PartList' + required: + - producer + - sparePart + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_HandlingCharacteristic: + description: Characteristic to describe aspects which are connected with the + handling of the product. + type: object + properties: + content: + description: The list of spare parts available for the product from various + suppliers. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_SparePart' + applicable: + description: "Check whether the connected attributes are applicable to the\ + \ product. If it is not applicable (false), dummy data can be delivered." + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Boolean' + required: + - content + - applicable + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_LifeEnumeration: + type: string + description: "Enumeration with the possible units day, month, cycle, year and\ + \ runningOrOperatingHour." + enum: + - unit:day + - unit:month + - unit:year + - unit:cycle + - unit:runningOrOperatingHour + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_LifeValueCharacteristic: + type: number + description: Characteristic for the life span value as an integer. + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_LifeTypeEnumeration: + type: string + description: "Enumeration with the values guaranteed lifetime, technical lifetime\ + \ and mean time between failures." + enum: + - guaranteed lifetime + - technical lifetime + - mean time between failures + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_LifespanEntity: + description: "Entity for the lifespan of a product with type, unit and value." + type: object + properties: + unit: + description: "The unit of the respective lifespan expressed through the\ + \ possible units day, month, cycle, year and runningOrOperatingHour." + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_LifeEnumeration' + value: + description: The value as an integer for the respective lifespan. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_LifeValueCharacteristic' + key: + description: |- + The type of lifespan represented with the values guaranteed lifetime, technical lifetime and mean time between failures. This attribute is mentioned in the ESPR proposal from March 30th, 2022 ANNEX I: + (a) durability and reliability of the product or its components as expressed through the product's guaranteed lifetime, technical lifetime [or] mean time between failures [...]. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_LifeTypeEnumeration' + required: + - unit + - value + - key + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_LifespanList: + description: List of different life spans of a product. + type: array + items: + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_LifespanEntity' + urn_samm_io.catenax.shared.quantity_2.0.0_LinearUnitEnumeration: + type: string + pattern: "[a-zA-Z]*:[a-zA-Z]+" + description: "The unit of a linear attribute that may be used for height, width,\ + \ length and diameter." + enum: + - unit:millimetre + - unit:centimetre + - unit:metre + - unit:kilometre + - unit:inch + - unit:foot + - unit:yard + urn_samm_io.catenax.shared.quantity_2.0.0_LinearCharacteristic: + description: Characteristic for linear measurements of an item. + type: object + properties: + value: + description: The quantity value associated with the unit. + $ref: '#/components/schemas/urn_samm_io.catenax.shared.quantity_2.0.0_QuantityValueCharacteristic' + unit: + description: The unit of a linear attribute. + $ref: '#/components/schemas/urn_samm_io.catenax.shared.quantity_2.0.0_LinearUnitEnumeration' + required: + - value + - unit + urn_samm_io.catenax.shared.quantity_2.0.0_VolumeUnitEnumeration: + type: string + pattern: "[a-zA-Z]*:[a-zA-Z]+" + description: Enumeration for volume units. + enum: + - unit:cubicMetre + - unit:litre + - unit:millilitre + - unit:cubicCentimetre + - unit:cubicInch + - unit:cubicFoot + - unit:cubicYard + - unit:hectolitre + urn_samm_io.catenax.shared.quantity_2.0.0_VolumeCharacteristic: + description: Characteristic for volume measurements of an item. + type: object + properties: + value: + description: The quantity value associated with the unit. + $ref: '#/components/schemas/urn_samm_io.catenax.shared.quantity_2.0.0_QuantityValueCharacteristic' + unit: + description: The unit of a volume related attribute. + $ref: '#/components/schemas/urn_samm_io.catenax.shared.quantity_2.0.0_VolumeUnitEnumeration' + required: + - value + - unit + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PhysicalDimensionCharacteristic: + description: "Characteristic for physical dimensions with linear, mass and capacity\ + \ attributes." + type: object + properties: + width: + description: The width of the item measured in a specific linear unit which + can be declared in the corresponding unit attribute. + $ref: '#/components/schemas/urn_samm_io.catenax.shared.quantity_2.0.0_LinearCharacteristic' + length: + description: The length of the item measured in a specific linear unit which + can be declared in the corresponding unit attribute. + $ref: '#/components/schemas/urn_samm_io.catenax.shared.quantity_2.0.0_LinearCharacteristic' + diameter: + description: "The diameter of the item, if applicable, measured in a specific\ + \ linear unit which can be declared in the corresponding unit attribute." + $ref: '#/components/schemas/urn_samm_io.catenax.shared.quantity_2.0.0_LinearCharacteristic' + height: + description: The height of the item measured in a specific linear unit which + can be declared in the corresponding unit attribute. + $ref: '#/components/schemas/urn_samm_io.catenax.shared.quantity_2.0.0_LinearCharacteristic' + grossWeight: + description: |- + The gross weight of the item measured in a specific mass unit which can be declared in the corresponding unit attribute. Gross weight refers to the total weight of a product, including the weight of the packaging. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7: + (2) (b) (i) information on the performance of the product in relation to the product parameters referred to in Annex I; + Annex I (i) weight and volume of the product and its packaging, and the product-to-packaging ratio. + $ref: '#/components/schemas/urn_samm_io.catenax.shared.quantity_2.0.0_MassCharacteristic' + grossVolume: + description: |- + The gross volume of the item, if possible, measured in a specific capacity unit which can be declared in the corresponding unit attribute. If there is no separate packing, the volume of the product shall be given. Gross volume refers to the total volume of a product, including the volume of the packaging. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7: + (2) (b) (i) information on the performance of the product in relation to the product parameters referred to in Annex I; + Annex I (i) weight and volume of the product and its packaging, and the product-to-packaging ratio. + $ref: '#/components/schemas/urn_samm_io.catenax.shared.quantity_2.0.0_VolumeCharacteristic' + weight: + description: |- + Weight of the product measured in a specific mass unit which can be declared in the corresponding unit attribute. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7: + (2) (b) (i) information on the performance of the product in relation to the product parameters referred to in Annex I; + Annex I (i) weight and volume of the product [...]. + $ref: '#/components/schemas/urn_samm_io.catenax.shared.quantity_2.0.0_MassCharacteristic' + volume: + description: |- + Volume of the product, if possible, measured in a specific capacity unit which can be declared in the corresponding unit attribute. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7: + (2) (b) (i) information on the performance of the product in relation to the product parameters referred to in Annex I; + Annex I (i) weight and volume of the product [...]. + $ref: '#/components/schemas/urn_samm_io.catenax.shared.quantity_2.0.0_VolumeCharacteristic' + required: + - grossWeight + - grossVolume + - weight + - volume + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PhysicalStateEnumeration: + type: string + description: "Enumeration with the values solid, liquid, gas and plasma." + enum: + - solid + - liquid + - gas + - plasma + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_ProductCharacteristics: + description: Defines a set of specific characteristics of a product. + type: object + properties: + lifespan: + description: |- + The type of lifespan represented with the values guaranteed lifetime, technical lifetime and mean time between failures. Both can be described through the attributes: type, which defines the type such as guaranteed lifetime or technical lifetime, the unit for the lifetime, and the value represented by an integer. These attributes are mentioned in the ESPR proposal from March 30th, 2022 ANNEX I: + (a) durability and reliability of the product or its components as expressed through the products guaranteed lifetime, technical lifetime [or] mean time between failures [...]. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_LifespanList' + physicalDimension: + description: |- + Physical dimensions are properties associated with physical quantities for purposes of classification or differentiation. These attributes are mentioned in the ESPR provisional agreement from January 9th, Article 7: + (2) (b) (i) information on the performance of the product in relation to one or more of the product parameters referred to in Annex I; + Annex I (i) weight and volume of the product and its packaging, and the product-to-packaging ratio. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PhysicalDimensionCharacteristic' + physicalState: + description: "The physical state of the item. There are four states of matter\ + \ solid, liquid, gas and plasma which can be chosen from an enumeration." + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PhysicalStateEnumeration' + generalPerformanceClass: + description: |- + The performance class of the product. This attribute is mentioned ESPR provisional agreement from January 9th, 2024 Article 7: + 4. When establishing the information requirements referred to in paragraph 2, point (b), point (i), the Commission shall, as appropriate in view of the specificity of the product group, determine classes of performance. Classes of performance may be based on single parameters, on aggregated scores, in absolute terms or in any other form that enables potential customers to choose the best performing products. Those classes of performance shall correspond to significant improvements in performance levels. Where classes of performance are based on parameters in relation to which performance requirements are established, they shall use as the minimum level the minimum performance required at the time when the classes of performance start to apply. + Definition: + 'class of performance': means a range of performance levels in relation to one or more product parameters referred to in Annex I, based on a common methodology for the product or product group, ordered into successive steps to allow for product differentiation. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + required: + - lifespan + - physicalDimension + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_StringList: + description: List of strings. + type: array + items: + type: string + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_CommercialCharacteristic: + description: Commercial information of the product. + type: object + properties: + placedOnMarket: + description: The timestamp in the format (yyyy-mm-dd) with or without time + zone when the product was put in the market. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DateTrait' + purpose: + description: "One or more intended industry/industries of the product described\ + \ by the digital product passport. If exchanged via Catena-X, 'automotive\ + \ ' is a must choice included in the list." + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_StringList' + required: + - purpose + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_ConcentrationEnumeration: + type: string + description: "Enumeration of possible units of concentration with percent, volume\ + \ percent, parts per thousand, parts per million, parts per billion and parts\ + \ per trillion." + enum: + - unit:partPerMillion + - unit:percent + - unit:percentVolume + - unit:partPerThousand + - unit:partPerTrillionUs + - unit:partPerBillionUs + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PositiveTrait: + type: number + description: Constraint for only positive values. + minimum: 0.0 + exclusiveMinimum: false + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_HazardCharacteristic: + description: Characteristic for the hazardous classification. + type: object + properties: + category: + description: |- + The hazard category of the substance of concern. Defined in Article 2 of Regulation (EC) No 1272/2008 of the European Parliament and of the Council of 16 December 2008 on classification, labelling and packaging of substances and mixtures, amending and repealing Directives 67/548/EEC and 1999/45/EC, and amending Regulation (EC) No 1907/2006: + 2. 'hazard category' means the division of criteria within each hazard class, specifying hazard severity. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + class: + description: |- + The hazard class of the substance of concern. Defined in Article 2 of Regulation (EC) No 1272/2008 of the European Parliament and of the Council of 16 December 2008 on classification, labelling and packaging of substances and mixtures, amending and repealing Directives 67/548/EEC and 1999/45/EC, and amending Regulation (EC) No 1907/2006: + 1. 'hazard class' means the nature of the physical, health or environmental hazard. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + statement: + description: |- + The hazard statement of the substance of concern. Defined in Article 2 of Regulation (EC) No 1272/2008 of the European Parliament and of the Council of 16 December 2008 on classification, labelling and packaging of substances and mixtures, amending and repealing Directives 67/548/EEC and 1999/45/EC, and amending Regulation (EC) No 1907/2006: + 5. 'hazard statement' means a phrase assigned to a hazard class and category that describes the nature of the hazards of a hazardous substance or mixture, including, where appropriate, the degree of hazard. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + required: + - category + - class + - statement + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_RangeEntity: + description: "Entity for the concentration range with two values, the highest\ + \ and the lowest of the concentration range." + type: object + properties: + min: + description: |- + The minimum concentration of the substance of concern at the level of the product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7: + (5) (c) [...] concentration range of the substances of concern, at the level of the product [...]. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PositiveTrait' + max: + description: |- + The maximum concentration of the substance of concern at the level of the product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7: + (5) (c) the concentration, maximum concentration or concentration range of the substances of concern, at the level of the product [...]. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PositiveTrait' + required: + - max + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_RangeCharacteristic: + description: "Range characteristic with two values, the highest and the lowest\ + \ of the concentration range. Only providing the maximum range is also possible." + type: array + items: + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_RangeEntity' + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_ListTypeEnumerationId: + type: string + description: Enumeration of different systems and organizations related to the + identification and classification of chemical substances in the field of chemistry. + The enumeration values are EC or CAS. + enum: + - CAS + - EC + - IUPAC + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_MaterialIdEntity: + description: "Id Entity with identifier, name and list type." + type: object + properties: + id: + description: "The substance identification, in accordance with the specification\ + \ in the attribute for the list type." + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_IdentifierCharacteristic' + type: + description: "The type of standard used for the identification of the substances.\ + \ Selected can be for example CAS, IUPAC or EC." + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_ListTypeEnumerationId' + name: + description: The name of the material which is present in the product. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + required: + - id + - type + - name + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_MaterialIdList: + description: List of ids for the identification. + type: array + items: + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_MaterialIdEntity' + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_SubstanceEntity: + description: Information regarding substances of concern in the product. + type: object + properties: + location: + description: |- + The location of the substances of concern within the product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7: + (5) (b) the location of the substances of concern within the product. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + unit: + description: "The unit of concentration chosen from an enumeration: mass\ + \ percent, volume percent, parts per thousand, parts per million, parts\ + \ per billion and parts per trillion." + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_ConcentrationEnumeration' + concentration: + description: | + Concentration of the material at the level of the product. This attribute is specially mentioned for substances of concern mentioned in the ESPR proposal from March 30th, 2022 Article 7: + (5) (c) the concentration, maximum concentration or concentration range of the substances of concern, at the level of the product [...]. + Other substances are mentioned for the purpose of recycling in the ESPR provisional agreement from January 9th, 2024 Annex I: + (d) design for recycling, ease and quality of recycling as expressed through: use of easily recyclable materials, safe, easy and non-destructive access to recyclable components and materials or components and materials containing hazardous substances and material composition and homogeneity, possibility for high-purity sorting, number of materials and components used, use of standard components, use of component and material coding standards for the identification of components and materials, number and complexity of processes and tools needed, ease of nondestructive disassembly and re-assembly, conditions for access to product data, conditions for access to or use of hardware and software needed. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PositiveTrait' + exemption: + description: |- + Exemptions to the substance of concern. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Article 7: + (5) (c) provide duly justified exemptions for substances of concern or information elements from the information requirements referred to in the first subparagraph based on the technical feasibility or relevance of tracking substances of concern, the existence of analytical methods to detect and quantify them, the need to protect confidential business information or in other duly justified cases. Substances of concern within the meaning of Article 2(28), point a), shall not be exempted if they are present in products, their relevant components or spare parts in a concentration above 0,1 % weight by weight. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + hazardClassification: + description: |- + The specification of the hazard class. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I: + (f) use of substances, and in particular the use of substances of concern, on their own, as constituents of substances or in mixtures, during the production process of products, or leading to their presence in products, including once these products become waste, and their impacts on human health and the environment; + Further defined is this by Regulation (EC) No 1272/2008 of the European Parliament and of the Council of 16 December 2008 on classification, labelling and packaging of substances and mixtures, amending and repealing Directives 67/548/EEC and 1999/45/EC, and amending Regulation (EC) No 1907/2006. + Defined in Article 2: + 1. 'hazard class' means the nature of the physical, health or environmental hazard; + 2. 'hazard category' means the division of criteria within each hazard class, specifying hazard severity; + 5. 'hazard statement' means a phrase assigned to a hazard class and category that describes the nature of the hazards of a hazardous substance or mixture, including, where appropriate, the degree of hazard; + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_HazardCharacteristic' + concentrationRange: + description: |- + The concentration range for the substance of concern. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7: + (5) (c) [...] concentration range of the substances of concern, at the level of the product [...]. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_RangeCharacteristic' + id: + description: "The chemical material name and identification, in accordance\ + \ with the specification in the attribute for the list type. Preference\ + \ is given to the IUPAC name. This attribute is mentioned in the ESPR\ + \ provisional agreement from January 9th, 2024 Article 7:\n(5) (a) the\ + \ name of the substances of concern present in the product, as follows:\n\ + \ - name(s) in the International Union of Pure and Applied Chemistry (IUPAC)\ + \ nomenclature, or another international name when IUPAC name is not available;\ + \ \n- other names (usual name, trade name, abbreviation);\n- European\ + \ Community (EC) number, as indicated in the European Inventory of Existing\ + \ Commercial Chemical Substances (EINECS), the European List of Notified\ + \ Chemical Substances (ELINCS) or the No Longer Polymer (NLP) list or\ + \ assigned by the European Chemicals Agency (ECHA), if available;\n- the\ + \ Chemical Abstract Service (CAS) name(s) and number(s), if available;\ + \ ." + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_MaterialIdList' + documentation: + description: Documentation accompanying the material. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentList' + required: + - location + - unit + - concentration + - exemption + - hazardClassification + - concentrationRange + - id + - documentation + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_SubstanceList: + description: Characteristic for a list of substances of concern. + type: array + items: + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_SubstanceEntity' + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_SubstanceOfConcernCharacteristic: + description: Substance of concern Characteristic of the product. + type: object + properties: + applicable: + description: "Check whether the connected attributes are applicable to the\ + \ product. If it is not applicable (false), dummy data can be delivered." + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Boolean' + content: + description: "Information regarding substances of concern in the product.\ + \ Attributes are among others substance names, ids, concentration, location\ + \ and hazard class. This is mentioned in the ESPR provisional agreement\ + \ from January 9th, 2024 Article 7:\n(5) (a) the name of the substances\ + \ of concern present in the product, as follows:\n- name(s) in the International\ + \ Union of Pure and Applied Chemistry (IUPAC) nomenclature, or another\ + \ international name when IUPAC name is not available; \n- other names\ + \ (usual name, trade name, abbreviation);\n- European Community (EC) number,\ + \ as indicated in the European Inventory of Existing Commercial Chemical\ + \ Substances (EINECS), the European List of Notified Chemical Substances\ + \ (ELINCS) or the No Longer Polymer (NLP) list or assigned by the European\ + \ Chemicals Agency (ECHA), if available;\n- the Chemical Abstract Service\ + \ (CAS) name(s) and number(s), if available;\n(5) (b) the location of\ + \ the substances of concern within the product.\n(5) (c) the concentration,\ + \ maximum concentration or concentration range of the substances of concern,\ + \ at the level of the product its relevant components, or spare parts;\n\ + (d) relevant instructions for the safe use of the product;\n(e) information\ + \ relevant for disassembly, preparation for reuse, reuse, recycling and\ + \ the environmentally sound management of the product at the end of its\ + \ life.\nAnd in the next paragraph:\n(c) provide duly justified exemptions\ + \ for substances of concern or information elements from the information\ + \ requirements referred to in the first subparagraph." + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_SubstanceList' + required: + - applicable + - content + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PercentageTrait: + type: number + description: Range constraint for a positive percentage value. + maximum: 100.0 + exclusiveMaximum: false + minimum: 0.0 + exclusiveMinimum: false + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_MaterialEntity: + description: Information regarding recycled and/or renewable materials in the + product. + type: object + properties: + recycled: + description: |- + The share of the material, which is recovered recycled content from the product. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I: + (h) use or content of recycled materials and recovery of materials, including critical raw materials; + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PercentageTrait' + renewable: + description: | + The share of the material, which is from a renewable resource that can be replenished. Renewable resources are those that can be reproduced by physical, chemical, or mechanical processes. These are the kind of resources that can be regenerated throughout time. Forest wood, for example, can be grown through reforestation. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I: + (ha) use or content of sustainable renewable materials; + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PercentageTrait' + unit: + description: "The unit of concentration chosen from an enumeration: mass\ + \ percent, volume percent, parts per thousand, parts per million, parts\ + \ per billion and parts per trillion." + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_ConcentrationEnumeration' + id: + description: "The chemical material name and identification, in accordance\ + \ with the specification in the attribute for the list type. Preference\ + \ is given to the IUPAC name. This attribute is mentioned in the ESPR\ + \ provisional agreement from January 9th, 2024 Article 7:\n(5) (a) the\ + \ name of the substances of concern present in the product, as follows:\n\ + \ - name(s) in the International Union of Pure and Applied Chemistry (IUPAC)\ + \ nomenclature, or another international name when IUPAC name is not available;\ + \ \n- other names (usual name, trade name, abbreviation);\n- European\ + \ Community (EC) number, as indicated in the European Inventory of Existing\ + \ Commercial Chemical Substances (EINECS), the European List of Notified\ + \ Chemical Substances (ELINCS) or the No Longer Polymer (NLP) list or\ + \ assigned by the European Chemicals Agency (ECHA), if available;\n- the\ + \ Chemical Abstract Service (CAS) name(s) and number(s), if available;\ + \ ." + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_MaterialIdList' + critical: + description: |- + A flag, if the material is a critical raw material. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I: + (h) use or content of recycled materials and recovery of materials, including critical raw materials; + In Annex II of the connected proposal Act of Critical Raw Materials, a list of critical raw materials can be found. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Boolean' + concentration: + description: | + Concentration of the material at the level of the product. This attribute is specially mentioned for substances of concern mentioned in the ESPR proposal from March 30th, 2022 Article 7: + (5) (c) the concentration, maximum concentration or concentration range of the substances of concern, at the level of the product [...]. + Other substances are mentioned for the purpose of recycling in the ESPR provisional agreement from January 9th, 2024 Annex I: + (d) design for recycling, ease and quality of recycling as expressed through: use of easily recyclable materials, safe, easy and non-destructive access to recyclable components and materials or components and materials containing hazardous substances and material composition and homogeneity, possibility for high-purity sorting, number of materials and components used, use of standard components, use of component and material coding standards for the identification of components and materials, number and complexity of processes and tools needed, ease of nondestructive disassembly and re-assembly, conditions for access to product data, conditions for access to or use of hardware and software needed. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PositiveTrait' + documentation: + description: Documentation accompanying the material. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentList' + required: + - recycled + - renewable + - unit + - id + - critical + - concentration + - documentation + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_MaterialList: + description: A list of different materials in the product. + type: array + items: + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_MaterialEntity' + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_MaterialCharacteristic: + description: Material Characteristic with information on the materials. + type: object + properties: + applicable: + description: "Check whether the connected attributes are applicable to the\ + \ product. If it is not applicable (false), dummy data can be delivered." + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Boolean' + content: + description: Information on different materials in the product. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_MaterialList' + required: + - applicable + - content + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_MaterialsCharacteristic: + description: Materials Characteristic on product level. + type: object + properties: + substancesOfConcern: + description: |- + Information regarding substances of concern in the product. The ESPR provisional agreement from January 9th, 2024 defines: + (52) 'hazardous substance' means a substance classified as hazardous pursuant to Article 3 of Regulation (EC) No 1272/2008. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_SubstanceOfConcernCharacteristic' + materialComposition: + description: Material composition of the product with information on recycled + and renewable materials. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_MaterialCharacteristic' + required: + - substancesOfConcern + - materialComposition + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_StateEnumeration: + type: string + description: "Enumeration defined as original, repurposed, re-used, remanufactured\ + \ or waste." + enum: + - original + - repurposed + - re-used + - remanufactured + - waste + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_CategoryEnumeration: + type: string + description: Enumeration of the 19 impact categories in accordance to EN15804+A2. + enum: + - Climate Change Total + - Climate Change Fossil + - Climate Change Biogenic Removals and Emissions + - Climate Change Land Use and Land Use Change + - Ozone Depletion + - Acidification + - Eutrophication Aquatic Freshwater + - Eutrophication Fresh Marine + - Eutrophication Terrestrial + - Photochemical Ozone Formation + - Abiotic Depletion- Minerals and Metals + - Fossil Fuels + - Water Use + - Particulate Matter Emissions + - "Ionizing Radiation, Human Health" + - Eco-Toxicity + - "Human Toxicity, Cancer Effects" + - "Human Toxicity, Non-Cancer Effects" + - Land Use Related Impacts/Soil Quality + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_FootprintEntity: + description: "Footprint Entity for the carbon and environmental footprint with\ + \ the total value, unit, impact category type, lifecycle, rulebook, declaration,\ + \ performance class and the facility." + type: object + properties: + value: + description: | + The value of the footprint of the product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Annex I: + (l) the environmental footprint of the product, expressed as a quantification, in accordance with the applicable delegated act, of a product's life cycle environmental impacts, whether in relation to one or more environmental impact categories or an aggregated set of impact categories; + (m) the carbon footprint of the product; + (ma) the material footprint of the product. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PositiveTrait' + rulebook: + description: The applied rulebook for the environmental footprint of the + product. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentList' + lifecycle: + description: "The lifecycle stage, to which the environmental footprint\ + \ corresponds. These could be for example \"raw material acquisition and\ + \ pre-processing\", \"main product production\", \"distribution\" or \"\ + end of life and recycling\"." + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + unit: + description: "The unit of measurement of the environmental impact category.\ + \ For each impact category a specific unit is used. If an aggregation\ + \ is used, utilize the normalization and weighting methods used in the\ + \ referenced rulebook." + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + type: + description: |- + The type of the environmental footprint of the product. This could be one of the environmental impact categories. This attribute is mentioned in the ESPR provisional agreement from January 9th 2024 Article 7: + (2)(b)(i) information on the performance of the product in relation to one or more of the product parameters referred to in Annex I, including a scoring of reparability or durability, carbon footprint or environmental footprint; + Annex I: + (l) the environmental footprint of the product, expressed as a quantification, in accordance with the applicable delegated act, of a product's life cycle environmental impacts, whether in relation to one or more environmental impact categories or an aggregated set of impact categories. + (m) the carbon footprint of the product; + (ma) the material footprint of the product. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_CategoryEnumeration' + performanceClass: + description: The performance classification of the footprint. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + manufacturingPlant: + description: The manufacturing plant of the footprint in the specific lifecycle + phase. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_FacilityList' + declaration: + description: 'The footprint declaration in the format of a link ' + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentList' + required: + - value + - rulebook + - lifecycle + - unit + - type + - manufacturingPlant + - declaration + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_FootprintList: + description: Footprint List for the environmental footprint. + type: array + items: + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_FootprintEntity' + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_ProductFootprintCharacteristic: + description: The Product Footprint Characteristic with sustainability information. + type: object + properties: + environmental: + description: |- + The environmental footprint of the product. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I: + The following parameters shall, as appropriate, and where necessary supplemented by others, be used, individually or combined, as a basis for improving the product aspects referred to in Article 5(1): + (l) the environmental footprint of the product, expressed as a quantification, in accordance with the applicable delegated act, of a product's life cycle environmental impacts, whether in relation to one or more environmental impact categories or an aggregated set of impact categories. + and Article 7: + (2)(b)(i) information on the performance of the product in relation to one or more of the product parameters referred to in Annex I, including a scoring of reparability or durability, carbon footprint or environmental footprint; + and defined by Article 2: + (23) 'environmental footprint' means a quantification of product environmental impacts throughout its life cycle, whether in relation to a single environmental impact category or an aggregated set of impact categories based on the Product Environmental Footprint method or other scientific methods developed by international organisations and widely tested in collaboration with different industry sectors and adopted or implemented by the Commission in other Union legislation; + (24) 'Product Environmental Footprint method' means the life cycle assessment method to quantify the environmental impacts of products established by Recommendation (EU) 2021/2279. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_FootprintList' + carbon: + description: |- + The carbon footprint of the product. This is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I: + The following parameters shall, as appropriate, and where necessary supplemented by others, be used, individually or combined, as a basis for improving the product aspects referred to in Article 5(1): + (m) the carbon footprint of the product; + and Article 7: + (2)(b)(i) information on the performance of the product in relation to one or more of the product parameters referred to in Annex I, including a scoring of reparability or durability, carbon footprint or environmental footprint; + and defined by Article 2: + (25) 'carbon footprint' means the sum of greenhouse gas (GHG) emissions and GHG removals in a product system, expressed as CO2 equivalents and based on a life cycle assessment using the single impact category of climate change. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_FootprintList' + material: + description: |- + The material footprint of the product. This is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I: + (ma) the material footprint of the product; + and defined by Article 2: + (25a) 'material footprint' refers to the total amount of raw materials extracted to meet final consumption demands. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_FootprintList' + required: + - carbon + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_SustainabilityCharacteristic: + description: Characteristic which describes relevant information for the sustainability + of the product. + type: object + properties: + status: + description: |- + The status of the product (original, repurposed, re-used, remanufactured or waste) to indicated, whether it is a used product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Annex I: + (j) incorporation of used components. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_StateEnumeration' + productFootprint: + description: "The carbon and environmental footprint or material footprint\ + \ of the product. These attributes are mentioned in the ESPR provisional\ + \ agreement from January 9th 2024 Annex I:\n(l) the environmental footprint\ + \ of the product, expressed as a quantification, in accordance with the\ + \ applicable delegated act, of a product's life cycle environmental impacts,\ + \ whether in relation to one or more environmental impact categories or\ + \ an aggregated set of impact categories;\n(m) the carbon footprint of\ + \ the product;\n(ma) the material footprint of the product;\nAll are defined\ + \ by Article 2:\n(23) 'environmental footprint' means a quantification\ + \ of product environmental impacts throughout its life cycle, whether\ + \ in relation to a single environmental impact category or an aggregated\ + \ set of impact categories based on the Product Environmental Footprint\ + \ method or other scientific methods developed by international organisations\ + \ and widely tested in collaboration with different industry sectors and\ + \ adopted or implemented by the Commission in other Union \nlegislation;\n\ + (25) 'carbon footprint' means the sum of greenhouse gas (GHG) emissions\ + \ and GHG removals in a product system, expressed as CO2 equivalents and\ + \ based on a life cycle assessment using the single impact category of\ + \ climate change.\n(25a) 'material footprint' refers to the total amount\ + \ of raw materials extracted to meet final consumption demands;" + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_ProductFootprintCharacteristic' + reparabilityScore: + description: |- + The reparability score. This attribute is mentioned ESPR provisional agreement from January 9th, 2024 Article 7: + (b) as appropriate, also require products to be accompanied by: + (i) information on the performance of the product in relation to one or more of the product parameters referred to in Annex I, including a scoring of reparability or durability [...]. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + durabilityScore: + description: |- + The durability score. This attribute is mentioned ESPR provisional agreement from January 9th, 2024 Article 7: + (b) as appropriate, also require products to be accompanied by: + (i) information on the performance of the product in relation to one or more of the product parameters referred to in Annex I, including a scoring of reparability or durability [...]. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + required: + - status + - productFootprint + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_SourceCategoryEnumeration: + type: string + description: The types of sources that can be linked in a digital product passport + can vary depending on the nature of the product and the information that needs + to be included. This is an enumeration of possible sources. + enum: + - Product Specifications + - Manufacturer Information + - User Manuals and Guides + - Certifications and Compliance + - Product Images and Videos + - Warranty Information + - Reviews and Ratings + - Product Variations + - Supply Chain Information + - Environmental Impact + - Compatibility and Accessories + - FAQs and Support + - Purchase and Retail Information + - Privacy and Data Handling + - Third-Party Integrations + - Legal Information + - Safety Information + - Repair and Installation + - Waste Generation and Prevention + - Specific Voluntary Labels + - Product Packaging + - Return and Disposal + - End of Life + - Material and Substance Information + - Technical Documentation + - Treatment facilities + - Other + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentEntity: + description: "Document entity with header, content, category and type." + type: object + properties: + content: + description: The content of the document e.g a link. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + category: + description: |- + The category in which the document can be sorted. These are mentioned in the ESPR proposal from March 30th, 2022 ANNEX III: + (e) compliance documentation and information required under this Regulation or other Union law applicable to the product, such as the declaration of conformity, technical documentation or conformity certificates; + ANNEX IV states additional information regarding the content of the technical documentation + Further information on documents are mentioned in the proposal from March 30th, 2022 ANNEX III: + (f) user manuals, instructions, warnings or safety information, as required by other Union legislation applicable to the product. + Additionally requirements are mentioned in Article 21: + (7) Manufacturers shall ensure that that a product covered by a delegated act adopted pursuant to Article 4 is accompanied by instructions that enable consumers and other end-users to safely assemble, install, operate, store, maintain, repair and dispose of the product in a language that can be easily understood by consumers and other end-users, as determined by the Member State concerned. Such instructions shall be clear, understandable and legible and include at least the information specified in the delegated acts adopted pursuant to Article 4 and pursuant to Article 7(2)(b), point (ii). + Article 7 states additionally: + (2) (b) (ii) information for consumers and other end-users on how to install, use, maintain and repair the product in order to minimize its impact on the environment and to ensure optimum durability, as well as on how to return or dispose of the product at end-of-life; + (2) (b) (iii) information for treatment facilities on disassembly, recycling, or disposal at end-of-life; + (2) (b) (iv) other information that may influence the way the product is handled by parties other than the manufacturer in order to improve performance in relation to product parameters referred to in Annex I. + (5) (d) relevant instructions for the safe use of the product. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_SourceCategoryEnumeration' + type: + description: "The type of content which can be expected in the \"content\"\ + \ property. Examples are a link, restricted link, pdf, excel, etc." + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + header: + description: The header as a short description of the document with a maximum + of 100 characters. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_HeaderTrait' + required: + - content + - category + - type + - header + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_SourceList: + description: A list of documents. + type: array + items: + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentEntity' + urn_samm_io.catenax.electric_drive.electric_drive_passport_2.0.0_GenericCharacteristic: + description: Characteristic for the product generic parameters. + type: object + properties: + metadata: + description: "Metadata of the product passport. These are mentioned in the\ + \ ESPR proposal from March 30th, 2022 and some changed by the provisional\ + \ agreement from January 9th, 2024." + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_MetadataCharacteristic' + identification: + description: "Identification information of the product, especially identifiers\ + \ and codes. These are mentioned in the ESPR provisional agreement from\ + \ January 9th, 2024 ANNEX III:\n(b) the unique product identifier at the\ + \ level indicated in the applicable delegated act adopted pursuant to\ + \ Article 4.\nAdditionally in Article 9 regarding general requirements\ + \ for the product passport is stated that:\nA product passport shall meet\ + \ the following conditions:\n(a) it shall be connected through a data\ + \ carrier to a persistent unique product identifier;\n(e) the information\ + \ included in the product passport shall refer to the product model, batch,\ + \ or item as specified in the delegated act adopted pursuant to Article\ + \ 4.\nArticle 2 Definitions: \n(31) 'unique product identifier' means\ + \ a unique string of characters for the identification of products that\ + \ also enables a web link to the product passport;\nRecital (27): A 'model'\ + \ usually means a version of a product of which all units share the same\ + \ technical characteristics relevant for the ecodesign requirements and\ + \ the same model identifier, a 'batch' usually means a subset of a specific\ + \ model composed of all products produced in a specific manufacturing\ + \ plant at a specific moment in time and an 'item' usually means a single\ + \ unit of a model." + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_IdentificationCharacteristic' + operation: + description: Operational information of the product. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_OperationCharacteristic' + handling: + description: Properties connected with the handling of the product. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_HandlingCharacteristic' + characteristics: + description: Defines specific characteristics of a product. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_ProductCharacteristics' + commercial: + description: Commercial information of the product. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_CommercialCharacteristic' + materials: + description: Properties which are relevant for the materials of the product. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_MaterialsCharacteristic' + sustainability: + description: Sustainability related attributes. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_SustainabilityCharacteristic' + sources: + description: |- + Documents that are mandatory if applicable for the product. These are mentioned in the ESPR provisional agreement from January 9th, 2024 ANNEX III: + (e) compliance documentation and information required under this Regulation or other Union law applicable to the product, such as the declaration of conformity, technical documentation or conformity certificates; + (f) user manuals, instructions, warnings or safety information, as required by other Union legislation applicable to the product. + Additionally requirements are mentioned in Article 21: + 7. Manufacturers shall ensure that a product covered by a delegated act adopted pursuant to Article 4 is accompanied by instructions in digital format that enable customers and other relevant actors to assemble, install, operate, store, maintain, repair and dispose of the product in a language that can be easily understood, as determined by the Member State concerned. Such instructions shall be clear, understandable and legible and include at least the information set out in Article 7(2), point (b), point (ii) specified in the delegated acts adopted pursuant to Article 4. + Article 7 states additionally: + (ii) information for customers and other actors on how to install, use, maintain and repair the product, in order to minimise its impact on the environment and to ensure optimum durability, on how to install third-party operating systems where relevant, as well as on collection for refurbishment or remanufacture, and on how to return or handle the product at the end of its life; + (2) (b) (iii) information for treatment facilities on disassembly, reuse, refurbishment, recycling, or disposal at end-of-life; + (2) (b) (iv) other information that may influence sustainable product choices for customers and the way the product is handled by parties other than the manufacturer in order to facilitate appropriate use, value retaining operations and correct treatment at end-of-life. + (5) (d) relevant instructions for the safe use of the product. + (5) (e) information relevant for disassembly, preparation for reuse, reuse, recycling and the environmentally sound management of the product at the end of its life. + Annex I: + (b) [...] availability of repair and maintenance instructions, number of materials and components used, use of standard components,[...] number and complexity of processes and whether specialised toolsare needed, ease of non-destructive disassembly and re-assembly, conditions for access to product data, conditions for access to or use of hardware and software needed; + (c) ease of upgrading, re-use, remanufacturing and refurbishment as expressed through: [...] number and complexity of processes and tools needed, ease of non-destructive disassembly and re-assembly, conditions for access to product data, conditions for access to or use of hardware and software needed, conditions of access to test protocols or not commonly available testing equipment, availability of guarantees specific to remanufactured or refurbished products, conditions for access to or use of technologies protected by intellectual property rights, modularity; + (d) design for recycling, ease and quality of recycling as expressed through: use of easily recyclable materials, safe, easy and non-destructive access to recyclable components and materials or components and materials containing hazardous substances and material composition and homogeneity, possibility for high-purity sorting, [...] number and complexity of processes and tools needed, ease of nondestructive disassembly and re-assembly, conditions for access to product data, conditions for access to or use of hardware and software needed; + (q) functional performance and conditions for use including as expressed through ability in performing its intended use, precautions of use, skills required, compatibility with other products or systems. + Additionally to consider are guidelines and instructions regarding the proper management and disposal of packaging materials after use. This can include instructions for separation, reuse, and recycling. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_SourceList' + required: + - metadata + - identification + - operation + - handling + - characteristics + - commercial + - materials + - sustainability + - sources + ElectricDrivePassport: + description: "The E-Drive Passport is a data record that summarizes the components,\ + \ materials and chemical substances or information on repairability, spare\ + \ parts or professional disposal for an E-Drive. The data comes from all phases\ + \ of the product life cycle and can be used for various purposes in all these\ + \ phases (design, production, use, disposal). Structuring environmental data\ + \ in a standardized, comparable format enables all actors in the value and\ + \ supply chain to work together towards a circular economy. This data model\ + \ is based on the new proposed Ecodesign Regulation (ESPR-2022) and the product\ + \ specific requirements collected from different manufacturers and users of\ + \ the product." + type: object + properties: + specific: + description: Product specific parameters of the electric drive. + $ref: '#/components/schemas/urn_samm_io.catenax.electric_drive.electric_drive_passport_2.0.0_SpecificCharacteristic' + generic: + description: "The product generic parameters. These are defined by the Digital\ + \ Product Passport proposal from the ESPR. The main basis is provided\ + \ by the document \"Proposal for a REGULATION OF THE EUROPEAN PARLIAMENT\ + \ AND OF THE COUNCIL establishing a framework for setting ecodesign requirements\ + \ for sustainable products and repealing Directive 2009/125/EC\" from\ + \ March 30th, 2022. The latest version of the document was the provisional\ + \ agreement between the EU Council and the Parliament from January 9th,\ + \ 2024." + $ref: '#/components/schemas/urn_samm_io.catenax.electric_drive.electric_drive_passport_2.0.0_GenericCharacteristic' + required: + - specific + - generic + 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' + ElectricDrivePassport: + content: + application/json: + schema: + $ref: '#/components/schemas/ElectricDrivePassport' + description: The request was successful. + requestBodies: + ElectricDrivePassport: + content: + application/json: + schema: + $ref: '#/components/schemas/ElectricDrivePassport' diff --git a/io.catenax.electric_drive.electric_drive_passport/2.0.0/metadata.json b/io.catenax.electric_drive.electric_drive_passport/2.0.0/metadata.json new file mode 100644 index 000000000..eb94ac1ea --- /dev/null +++ b/io.catenax.electric_drive.electric_drive_passport/2.0.0/metadata.json @@ -0,0 +1 @@ +{ "status" : "release"} diff --git a/io.catenax.electric_drive.electric_drive_passport/RELEASE_NOTES.md b/io.catenax.electric_drive.electric_drive_passport/RELEASE_NOTES.md index 891fef044..8ad7c3d68 100644 --- a/io.catenax.electric_drive.electric_drive_passport/RELEASE_NOTES.md +++ b/io.catenax.electric_drive.electric_drive_passport/RELEASE_NOTES.md @@ -3,6 +3,14 @@ All notable changes to this model will be documented in this file. ## [Unreleased] +## [2.0.0] - 2024-05-21 +### Changed +- connection update to @prefix ext-passport: +- connection update to @prefix ext-pass: +- changed payload name from unspecific to generic on highest level +- min and maxOilPressure are dynamic and will be changed to rated - structure changed below +- added connections to transmission_pass:3.0.0 in "power" and "torque" to have more similarities + ## [1.0.0] - 2024-03-25 ### Added - initial model in SAMM 2.1.0 @@ -11,4 +19,4 @@ All notable changes to this model will be documented in this file. n/a ### Removed -n/a \ No newline at end of file +n/a diff --git a/io.catenax.esr_certificates.esr_certificate/1.0.1/EsrCertificate.ttl b/io.catenax.esr_certificates.esr_certificate/1.0.1/EsrCertificate.ttl deleted file mode 100644 index 09bc9655e..000000000 --- a/io.catenax.esr_certificates.esr_certificate/1.0.1/EsrCertificate.ttl +++ /dev/null @@ -1,180 +0,0 @@ -####################################################################### -# Copyright (c) 2022 SupplyOn AG -# Copyright (c) Bayerische Motoren Werke Aktiengesellschaft (BMW AG) -# Copyright (c) 2022 Contributors to the Eclipse Foundation -# -# 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 bamm: . -@prefix bamm-c: . -@prefix bamm-e: . -@prefix unit: . -@prefix rdf: . -@prefix rdfs: . -@prefix xsd: . -@prefix : . - -:certificateState a bamm:Property; - bamm:name "certificateState"; - bamm:preferredName "State of the Certificate"@en; - bamm:description "The Environmental and Social Responsibility (ESR) certificate state is reported as valid if the query day is within the validity period of the certificate"@en; - bamm:characteristic :CertificateState; - bamm:exampleValue "valid". -:CertificateState a bamm-c:Enumeration; - bamm:name "CertificateState"; - bamm:dataType xsd:string; - bamm-c:values ("valid" "invalid" "unknown"). -:certificateData a bamm:Property; - bamm:name "certificateData"; - bamm:preferredName "Certificate Data"@en; - bamm:description "An Environmental and Social Responsibility (ESR) certificate is described by a unique set of data for a given certificate type"@en; - bamm:characteristic :CertificateDataCharacteristic. -:CertificateDataCharacteristic a bamm:Characteristic; - bamm:name "CertificateDataCharacteristic"; - bamm:dataType :CertificateDataEntity. -:CertificateDataEntity a bamm:Entity; - bamm:name "CertificateDataEntity"; - bamm:properties (:catenaxBpn :businessPartnerName :businessPartnerStreet :businessPartnerZip :businessPartnerCity :businessPartnerRegion :businessPartnerCountryCode :certificateVersion :certificateRegistrationNumber :certificateAreaOfApplication :certificateRemark :additionalCertificateRegistrationNumber :certificationAgencyRegistrationNumber :certificationAgencyName :certificateValidFrom :certificateValidUntil :certificateName). -:catenaxBpn a bamm:Property; - bamm:name "catenaxBpn"; - bamm:preferredName "Catena-X BPN"@en; - bamm:description "Catena-X BPN"@en; - bamm:characteristic :CantenaxBpn; - bamm:exampleValue "BPNL00000003AYRE". -:businessPartnerName a bamm:Property; - bamm:name "businessPartnerName"; - bamm:preferredName "Business Partner Name"@en; - bamm:description "Company Name as listed by the Service Provider and to which the BP assigend the certificate"@en; - bamm:characteristic :StringValue; - bamm:exampleValue "Example GmbH". -:businessPartnerStreet a bamm:Property; - bamm:name "businessPartnerStreet"; - bamm:preferredName "Business Partner Street"@en; - bamm:description "Company Street as listed by the Service Provider and to which the BP assigend the certificate"@en; - bamm:characteristic :StringValue; - bamm:exampleValue "Balduin-Helmann-Str 215". -:businessPartnerZip a bamm:Property; - bamm:name "businessPartnerZip"; - bamm:preferredName "Business Partner Zip"@en; - bamm:description "Company ZIP code as listed by the Service Provider and to which the BP assigend the certificate"@en; - bamm:characteristic :StringValue; - bamm:exampleValue "82256". -:businessPartnerCity a bamm:Property; - bamm:name "businessPartnerCity"; - bamm:preferredName "Business Partner City"@en; - bamm:description "Company city as listed by the Service Provider and to which the BP assigend the certificate"@en; - bamm:characteristic :StringValue; - bamm:exampleValue "Fürstenfeldbruck". -:businessPartnerRegion a bamm:Property; - bamm:name "businessPartnerRegion"; - bamm:preferredName "Business Partner Region"@en; - bamm:description "Company region as listed by the Service Provider and to which the BP assigned the certificate. Mandatory in some countries like USA"@en; - bamm:characteristic :StringValue; - bamm:exampleValue "Bavaria". -:businessPartnerCountryCode a bamm:Property; - bamm:name "businessPartnerCountryCode"; - bamm:preferredName "Business Partner Country Code"@en; - bamm:description "ISO 3166-2 company country code as listed by the Service Provider and to which the BP assigend the certificate"@en; - bamm:characteristic :CountryCodes; - bamm:exampleValue "DE". -:certificateVersion a bamm:Property; - bamm:name "certificateVersion"; - bamm:preferredName "Certificate Version"@en; - bamm:description "Version of the certificate as in the certification document"@en; - bamm:characteristic :StringValue; - bamm:exampleValue "2015". -:certificateRegistrationNumber a bamm:Property; - bamm:name "certificateRegistrationNumber"; - bamm:preferredName "Certificate Registration Number"@en; - bamm:description "Registration number of the certificate as in the certification document"@en; - bamm:characteristic :StringValue; - bamm:exampleValue "12 198 54182 TMS". -:certificateAreaOfApplication a bamm:Property; - bamm:name "certificateAreaOfApplication"; - bamm:preferredName "Certificate Registration Number"@en; - bamm:description "Registration number of the certificate as in the certification document"@en; - bamm:characteristic :StringValue; - bamm:exampleValue "Manufacture of turbo engines for goldfish racing tournaments". -:certificateRemark a bamm:Property; - bamm:name "certificateRemark"; - bamm:preferredName "Certificate Registration Number"@en; - bamm:description "Registration number of the certificate as in the certification document"@en; - bamm:characteristic :StringValue; - bamm:exampleValue "Only valid in combination with Certificate 1945934 TMS". -:additionalCertificateRegistrationNumber a bamm:Property; - bamm:name "additionalCertificateRegistrationNumber"; - bamm:preferredName "Additional Certificate Registration Number"@en; - bamm:description "Additional certificate registration number"@en; - bamm:characteristic :StringValue; - bamm:exampleValue "20002". -:certificationAgencyRegistrationNumber a bamm:Property; - bamm:name "certificationAgencyRegistrationNumber"; - bamm:preferredName "Certification Agency Registration Number"@en; - bamm:description "Certification agency registration number"@en; - bamm:characteristic :StringValue; - bamm:exampleValue "A-99-2269". -:certificationAgencyName a bamm:Property; - bamm:name "certificationAgencyName"; - bamm:preferredName "Certificate Agency Name"@en; - bamm:description "Certification agency name as in the certification document"@en; - bamm:characteristic :StringValue; - bamm:exampleValue "Certfication Example Agency AG". -:certificateValidFrom a bamm:Property; - bamm:name "certificateValidFrom"; - bamm:preferredName "Certificate Valid From"@en; - bamm:description "Certificate valid from as in the certification document"@en; - bamm:characteristic :DateValue; - bamm:exampleValue "2021-06-04"^^xsd:date. -:certificateValidUntil a bamm:Property; - bamm:name "certificateValidUntil"; - bamm:preferredName "Certificate Valid Until"@en; - bamm:description "Certificate valid until as in the certification document"@en; - bamm:characteristic :DateValue; - bamm:exampleValue "2024-09-28"^^xsd:date. -:certificateName a bamm:Property; - bamm:name "certificateName"; - bamm:preferredName "Certificate Name"@en; - bamm:description "Certificate name as in the certification document"@en; - bamm:characteristic :CertificateNameEnumeration; - bamm:exampleValue "ISO 14001". -:CantenaxBpn a bamm-c:Trait; - bamm:name "CantenaxBpn"; - bamm-c:baseCharacteristic :StringValue; - bamm-c:constraint :CatenaxBpnRegEx. -:StringValue a bamm:Characteristic; - bamm:name "StringValue"; - bamm:description "String field value, no language tags"@en; - bamm:dataType xsd:string. -:CountryCodes a bamm-c:Enumeration; - bamm:name "CountryCodes"; - bamm:description "ISO 3166-2 ALPHA-2 letter country list"@en; - bamm:dataType xsd:string; - bamm-c:values ("AF" "AX" "AL" "DZ" "AS" "AD" "AO" "AI" "AQ" "AG" "AR" "AM" "AW" "AU" "AT" "AZ" "BS" "BH" "BD" "BB" "BY" "BE" "BZ" "BJ" "BM" "BT" "BO" "BQ" "BA" "BW" "BV" "BR" "IO" "BN" "BG" "BF" "BI" "KH" "CM" "CA" "CV" "KY" "CF" "TD" "CL" "CN" "CX" "CC" "CO" "KM" "CG" "CD" "CK" "CR" "CI" "HR" "CU" "CW" "CY" "CZ" "DK" "DJ" "DM" "DO" "EC" "EG" "SV" "GQ" "ER" "EE" "ET" "FK" "FO" "FJ" "FI" "FR" "GF" "PF" "TF" "GA" "GM" "GE" "DE" "GH" "GI" "GR" "GL" "GD" "GP" "GU" "GT" "GG" "GN" "GW" "GY" "HT" "HM" "VA" "HN" "HK" "HU" "IS" "IN" "ID" "IR" "IQ" "IE" "IM" "IL" "IT" "JM" "JP" "JE" "JO" "KZ" "KE" "KI" "KP" "KR" "KW" "KG" "LA" "LV" "LB" "LS" "LR" "LY" "LI" "LT" "LU" "MO" "MK" "MG" "MW" "MY" "MV" "ML" "MT" "MH" "MQ" "MR" "MU" "YT" "MX" "FM" "MD" "MC" "MN" "ME" "MS" "MA" "MZ" "MM" "NA" "NR" "NP" "NL" "NC" "NZ" "NI" "NE" "NG" "NU" "NF" "MP" "NO" "OM" "PK" "PW" "PS" "PA" "PG" "PY" "PE" "PH" "PN" "PL" "PT" "PR" "QA" "RE" "RO" "RU" "RW" "BL" "SH" "KN" "LC" "MF" "PM" "VC" "WS" "SM" "ST" "SA" "SN" "RS" "SC" "SL" "SG" "SX" "SK" "SI" "SB" "SO" "ZA" "GS" "SS" "ES" "LK" "SD" "SR" "SJ" "SZ" "SE" "CH" "SY" "TW" "TJ" "TZ" "TH" "TL" "TG" "TK" "TO" "TT" "TN" "TR" "TM" "TC" "TV" "UG" "UA" "AE" "GB" "US" "UM" "UY" "UZ" "VU" "VE" "VN" "VG" "VI" "WF" "EH" "YE" "ZM" "ZW"); - bamm:see . -:DateValue a bamm:Characteristic; - bamm:name "DateValue"; - bamm:description "ISO 8601 YYYY-MM-DD date without time zone"@en; - bamm:dataType xsd:date. -:CatenaxBpnRegEx a bamm-c:RegularExpressionConstraint; - bamm:name "CatenaxBpnRegEx"; - bamm:value "^(BPN)(L|S|A)(\\d{8})([a-zA-Z0-9]{4})$". -:EsrCertificate a bamm:Aspect; - bamm:name "EsrCertificate"; - bamm:preferredName "ESR Certificate"@en; - bamm:description "Environmental and Social Responsibility (ESR) certificate of the Business Partner (e.g. Supplier)"@en; - bamm:properties (:certificateState :certificateData); - bamm:operations (); - bamm:events (). -:CertificateNameEnumeration a bamm-c:Enumeration; - bamm:name "CertificateNameEnumeration"; - bamm:dataType xsd:string; - bamm-c:values ("IS0 14001"). diff --git a/io.catenax.esr_certificates.esr_certificate/1.0.1/gen/EsrCertificate-aas.xml b/io.catenax.esr_certificates.esr_certificate/1.0.1/gen/EsrCertificate-aas.xml deleted file mode 100644 index 123ebcd6a..000000000 --- a/io.catenax.esr_certificates.esr_certificate/1.0.1/gen/EsrCertificate-aas.xml +++ /dev/null @@ -1,4396 +0,0 @@ - - - - - defaultAdminShell - - - en - defaultAdminShell - - - - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#EsrCertificate - - Type - - - - ModelReference - - - Submodel - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#EsrCertificate/submodel - - - - - - - - - EsrCertificate - - - en - Environmental and Social Responsibility (ESR) certificate of the Business Partner (e.g. Supplier) - - - - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#EsrCertificate/submodel - Template - - ModelReference - - - ConceptDescription - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#EsrCertificate - - - - - - certificateState - - - en - State of the Certificate - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#certificateState - - - - xs:string - - - - CertificateDataEntity - - - catenaxBpn - - - en - Catena-X BPN - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#catenaxBpn - - - - xs:string - - - - businessPartnerName - - - en - Business Partner Name - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#businessPartnerName - - - - xs:string - - - - businessPartnerStreet - - - en - Business Partner Street - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#businessPartnerStreet - - - - xs:string - - - - businessPartnerZip - - - en - Business Partner Zip - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#businessPartnerZip - - - - xs:string - - - - businessPartnerCity - - - en - Business Partner City - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#businessPartnerCity - - - - xs:string - - - - businessPartnerRegion - - - en - Business Partner Region - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#businessPartnerRegion - - - - xs:string - - - - businessPartnerCountryCode - - - en - Business Partner Country Code - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#businessPartnerCountryCode - - - - xs:string - - - - certificateVersion - - - en - Certificate Version - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#certificateVersion - - - - xs:string - - - - certificateRegistrationNumber - - - en - Certificate Registration Number - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#certificateRegistrationNumber - - - - xs:string - - - - certificateAreaOfApplication - - - en - Certificate Registration Number - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#certificateAreaOfApplication - - - - xs:string - - - - certificateRemark - - - en - Certificate Registration Number - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#certificateRemark - - - - xs:string - - - - additionalCertificateRegistrationNumber - - - en - Additional Certificate Registration Number - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#additionalCertificateRegistrationNumber - - - - xs:string - - - - certificationAgencyRegistrationNumber - - - en - Certification Agency Registration Number - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#certificationAgencyRegistrationNumber - - - - xs:string - - - - certificationAgencyName - - - en - Certificate Agency Name - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#certificationAgencyName - - - - xs:string - - - - certificateValidFrom - - - en - Certificate Valid From - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#certificateValidFrom - - - - xs:date - - - - certificateValidUntil - - - en - Certificate Valid Until - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#certificateValidUntil - - - - xs:date - - - - certificateName - - - en - Certificate Name - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#certificateName - - - - xs:string - - - - - - - - - - APPLICATION_CLASS - EsrCertificate - - - en - ESR Certificate - - - - - en - Environmental and Social Responsibility (ESR) certificate of the Business Partner (e.g. Supplier) - - - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#EsrCertificate - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - ESR Certificate - - - - - en - EsrCertificate - - - - - en - Environmental and Social Responsibility (ESR) certificate of the Business Partner (e.g. Supplier) - - - - - - - - - certificateState - - - en - State of the Certificate - - - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#certificateState - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - State of the Certificate - - - - - en - certificateState - - - STRING - - - en - The Environmental and Social Responsibility (ESR) certificate state is reported as valid if the query day is within the validity period of the certificate - - - - - - valid - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CertificateState:valid - - - - - - invalid - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CertificateState:invalid - - - - - - unknown - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CertificateState:unknown - - - - - - - - - - - - - catenaxBpn - - - en - Catena-X BPN - - - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#catenaxBpn - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Catena-X BPN - - - - - en - catenaxBpn - - - STRING - - - en - Catena-X BPN - - - - - - - - - businessPartnerName - - - en - Business Partner Name - - - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#businessPartnerName - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Business Partner Name - - - - - en - businessPartnerName - - - STRING - - - en - Company Name as listed by the Service Provider and to which the BP assigend the certificate - - - - - - - - - businessPartnerStreet - - - en - Business Partner Street - - - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#businessPartnerStreet - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Business Partner Street - - - - - en - businessPartnerStreet - - - STRING - - - en - Company Street as listed by the Service Provider and to which the BP assigend the certificate - - - - - - - - - businessPartnerZip - - - en - Business Partner Zip - - - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#businessPartnerZip - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Business Partner Zip - - - - - en - businessPartnerZip - - - STRING - - - en - Company ZIP code as listed by the Service Provider and to which the BP assigend the certificate - - - - - - - - - businessPartnerCity - - - en - Business Partner City - - - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#businessPartnerCity - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Business Partner City - - - - - en - businessPartnerCity - - - STRING - - - en - Company city as listed by the Service Provider and to which the BP assigend the certificate - - - - - - - - - businessPartnerRegion - - - en - Business Partner Region - - - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#businessPartnerRegion - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Business Partner Region - - - - - en - businessPartnerRegion - - - STRING - - - en - Company region as listed by the Service Provider and to which the BP assigned the certificate. Mandatory in some countries like USA - - - - - - - - - businessPartnerCountryCode - - - en - Business Partner Country Code - - - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#businessPartnerCountryCode - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Business Partner Country Code - - - - - en - businessPartnerCountryCode - - - STRING - - - en - ISO 3166-2 company country code as listed by the Service Provider and to which the BP assigend the certificate - - - - - - AF - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:AF - - - - - - AX - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:AX - - - - - - AL - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:AL - - - - - - DZ - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:DZ - - - - - - AS - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:AS - - - - - - AD - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:AD - - - - - - AO - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:AO - - - - - - AI - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:AI - - - - - - AQ - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:AQ - - - - - - AG - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:AG - - - - - - AR - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:AR - - - - - - AM - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:AM - - - - - - AW - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:AW - - - - - - AU - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:AU - - - - - - AT - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:AT - - - - - - AZ - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:AZ - - - - - - BS - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:BS - - - - - - BH - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:BH - - - - - - BD - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:BD - - - - - - BB - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:BB - - - - - - BY - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:BY - - - - - - BE - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:BE - - - - - - BZ - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:BZ - - - - - - BJ - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:BJ - - - - - - BM - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:BM - - - - - - BT - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:BT - - - - - - BO - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:BO - - - - - - BQ - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:BQ - - - - - - BA - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:BA - - - - - - BW - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:BW - - - - - - BV - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:BV - - - - - - BR - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:BR - - - - - - IO - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:IO - - - - - - BN - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:BN - - - - - - BG - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:BG - - - - - - BF - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:BF - - - - - - BI - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:BI - - - - - - KH - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:KH - - - - - - CM - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:CM - - - - - - CA - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:CA - - - - - - CV - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:CV - - - - - - KY - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:KY - - - - - - CF - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:CF - - - - - - TD - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:TD - - - - - - CL - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:CL - - - - - - CN - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:CN - - - - - - CX - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:CX - - - - - - CC - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:CC - - - - - - CO - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:CO - - - - - - KM - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:KM - - - - - - CG - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:CG - - - - - - CD - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:CD - - - - - - CK - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:CK - - - - - - CR - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:CR - - - - - - CI - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:CI - - - - - - HR - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:HR - - - - - - CU - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:CU - - - - - - CW - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:CW - - - - - - CY - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:CY - - - - - - CZ - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:CZ - - - - - - DK - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:DK - - - - - - DJ - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:DJ - - - - - - DM - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:DM - - - - - - DO - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:DO - - - - - - EC - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:EC - - - - - - EG - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:EG - - - - - - SV - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:SV - - - - - - GQ - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:GQ - - - - - - ER - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:ER - - - - - - EE - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:EE - - - - - - ET - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:ET - - - - - - FK - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:FK - - - - - - FO - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:FO - - - - - - FJ - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:FJ - - - - - - FI - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:FI - - - - - - FR - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:FR - - - - - - GF - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:GF - - - - - - PF - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:PF - - - - - - TF - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:TF - - - - - - GA - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:GA - - - - - - GM - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:GM - - - - - - GE - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:GE - - - - - - DE - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:DE - - - - - - GH - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:GH - - - - - - GI - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:GI - - - - - - GR - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:GR - - - - - - GL - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:GL - - - - - - GD - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:GD - - - - - - GP - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:GP - - - - - - GU - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:GU - - - - - - GT - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:GT - - - - - - GG - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:GG - - - - - - GN - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:GN - - - - - - GW - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:GW - - - - - - GY - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:GY - - - - - - HT - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:HT - - - - - - HM - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:HM - - - - - - VA - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:VA - - - - - - HN - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:HN - - - - - - HK - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:HK - - - - - - HU - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:HU - - - - - - IS - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:IS - - - - - - IN - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:IN - - - - - - ID - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:ID - - - - - - IR - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:IR - - - - - - IQ - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:IQ - - - - - - IE - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:IE - - - - - - IM - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:IM - - - - - - IL - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:IL - - - - - - IT - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:IT - - - - - - JM - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:JM - - - - - - JP - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:JP - - - - - - JE - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:JE - - - - - - JO - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:JO - - - - - - KZ - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:KZ - - - - - - KE - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:KE - - - - - - KI - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:KI - - - - - - KP - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:KP - - - - - - KR - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:KR - - - - - - KW - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:KW - - - - - - KG - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:KG - - - - - - LA - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:LA - - - - - - LV - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:LV - - - - - - LB - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:LB - - - - - - LS - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:LS - - - - - - LR - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:LR - - - - - - LY - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:LY - - - - - - LI - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:LI - - - - - - LT - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:LT - - - - - - LU - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:LU - - - - - - MO - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:MO - - - - - - MK - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:MK - - - - - - MG - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:MG - - - - - - MW - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:MW - - - - - - MY - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:MY - - - - - - MV - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:MV - - - - - - ML - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:ML - - - - - - MT - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:MT - - - - - - MH - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:MH - - - - - - MQ - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:MQ - - - - - - MR - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:MR - - - - - - MU - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:MU - - - - - - YT - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:YT - - - - - - MX - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:MX - - - - - - FM - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:FM - - - - - - MD - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:MD - - - - - - MC - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:MC - - - - - - MN - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:MN - - - - - - ME - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:ME - - - - - - MS - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:MS - - - - - - MA - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:MA - - - - - - MZ - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:MZ - - - - - - MM - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:MM - - - - - - NA - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:NA - - - - - - NR - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:NR - - - - - - NP - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:NP - - - - - - NL - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:NL - - - - - - NC - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:NC - - - - - - NZ - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:NZ - - - - - - NI - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:NI - - - - - - NE - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:NE - - - - - - NG - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:NG - - - - - - NU - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:NU - - - - - - NF - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:NF - - - - - - MP - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:MP - - - - - - NO - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:NO - - - - - - OM - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:OM - - - - - - PK - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:PK - - - - - - PW - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:PW - - - - - - PS - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:PS - - - - - - PA - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:PA - - - - - - PG - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:PG - - - - - - PY - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:PY - - - - - - PE - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:PE - - - - - - PH - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:PH - - - - - - PN - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:PN - - - - - - PL - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:PL - - - - - - PT - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:PT - - - - - - PR - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:PR - - - - - - QA - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:QA - - - - - - RE - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:RE - - - - - - RO - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:RO - - - - - - RU - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:RU - - - - - - RW - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:RW - - - - - - BL - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:BL - - - - - - SH - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:SH - - - - - - KN - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:KN - - - - - - LC - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:LC - - - - - - MF - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:MF - - - - - - PM - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:PM - - - - - - VC - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:VC - - - - - - WS - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:WS - - - - - - SM - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:SM - - - - - - ST - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:ST - - - - - - SA - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:SA - - - - - - SN - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:SN - - - - - - RS - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:RS - - - - - - SC - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:SC - - - - - - SL - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:SL - - - - - - SG - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:SG - - - - - - SX - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:SX - - - - - - SK - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:SK - - - - - - SI - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:SI - - - - - - SB - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:SB - - - - - - SO - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:SO - - - - - - ZA - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:ZA - - - - - - GS - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:GS - - - - - - SS - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:SS - - - - - - ES - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:ES - - - - - - LK - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:LK - - - - - - SD - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:SD - - - - - - SR - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:SR - - - - - - SJ - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:SJ - - - - - - SZ - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:SZ - - - - - - SE - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:SE - - - - - - CH - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:CH - - - - - - SY - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:SY - - - - - - TW - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:TW - - - - - - TJ - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:TJ - - - - - - TZ - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:TZ - - - - - - TH - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:TH - - - - - - TL - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:TL - - - - - - TG - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:TG - - - - - - TK - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:TK - - - - - - TO - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:TO - - - - - - TT - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:TT - - - - - - TN - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:TN - - - - - - TR - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:TR - - - - - - TM - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:TM - - - - - - TC - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:TC - - - - - - TV - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:TV - - - - - - UG - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:UG - - - - - - UA - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:UA - - - - - - AE - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:AE - - - - - - GB - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:GB - - - - - - US - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:US - - - - - - UM - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:UM - - - - - - UY - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:UY - - - - - - UZ - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:UZ - - - - - - VU - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:VU - - - - - - VE - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:VE - - - - - - VN - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:VN - - - - - - VG - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:VG - - - - - - VI - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:VI - - - - - - WF - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:WF - - - - - - EH - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:EH - - - - - - YE - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:YE - - - - - - ZM - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:ZM - - - - - - ZW - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CountryCodes:ZW - - - - - - - - - - - - - certificateVersion - - - en - Certificate Version - - - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#certificateVersion - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Certificate Version - - - - - en - certificateVersion - - - STRING - - - en - Version of the certificate as in the certification document - - - - - - - - - certificateRegistrationNumber - - - en - Certificate Registration Number - - - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#certificateRegistrationNumber - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Certificate Registration Number - - - - - en - certificateRegistrationNumber - - - STRING - - - en - Registration number of the certificate as in the certification document - - - - - - - - - certificateAreaOfApplication - - - en - Certificate Registration Number - - - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#certificateAreaOfApplication - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Certificate Registration Number - - - - - en - certificateAreaOfApplication - - - STRING - - - en - Registration number of the certificate as in the certification document - - - - - - - - - certificateRemark - - - en - Certificate Registration Number - - - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#certificateRemark - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Certificate Registration Number - - - - - en - certificateRemark - - - STRING - - - en - Registration number of the certificate as in the certification document - - - - - - - - - additionalCertificateRegistrationNumber - - - en - Additional Certificate Registration Number - - - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#additionalCertificateRegistrationNumber - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Additional Certificate Registration Number - - - - - en - additionalCertificateRegistrationNumber - - - STRING - - - en - Additional certificate registration number - - - - - - - - - certificationAgencyRegistrationNumber - - - en - Certification Agency Registration Number - - - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#certificationAgencyRegistrationNumber - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Certification Agency Registration Number - - - - - en - certificationAgencyRegistrationNumber - - - STRING - - - en - Certification agency registration number - - - - - - - - - certificationAgencyName - - - en - Certificate Agency Name - - - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#certificationAgencyName - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Certificate Agency Name - - - - - en - certificationAgencyName - - - STRING - - - en - Certification agency name as in the certification document - - - - - - - - - certificateValidFrom - - - en - Certificate Valid From - - - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#certificateValidFrom - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Certificate Valid From - - - - - en - certificateValidFrom - - - STRING - - - en - Certificate valid from as in the certification document - - - - - - - - - certificateValidUntil - - - en - Certificate Valid Until - - - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#certificateValidUntil - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Certificate Valid Until - - - - - en - certificateValidUntil - - - STRING - - - en - Certificate valid until as in the certification document - - - - - - - - - certificateName - - - en - Certificate Name - - - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#certificateName - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Certificate Name - - - - - en - certificateName - - - STRING - - - en - Certificate name as in the certification document - - - - - - IS0 14001 - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#CertificateNameEnumeration:IS0 14001 - - - - - - - - - - - - - certificateData - - - en - Certificate Data - - - urn:samm:io.catenax.esr_certificates.esr_certificate:1.0.1#certificateData - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Certificate Data - - - - - en - certificateData - - - STRING - - - en - An Environmental and Social Responsibility (ESR) certificate is described by a unique set of data for a given certificate type - - - - - - - - - diff --git a/io.catenax.esr_certificates.esr_certificate/1.0.1/gen/EsrCertificate-schema.json b/io.catenax.esr_certificates.esr_certificate/1.0.1/gen/EsrCertificate-schema.json deleted file mode 100644 index 1e408c4d6..000000000 --- a/io.catenax.esr_certificates.esr_certificate/1.0.1/gen/EsrCertificate-schema.json +++ /dev/null @@ -1,121 +0,0 @@ -{ - "$schema" : "http://json-schema.org/draft-04/schema", - "description" : "Environmental and Social Responsibility (ESR) certificate of the Business Partner (e.g. Supplier)", - "type" : "object", - "components" : { - "schemas" : { - "urn_bamm_io.catenax.esr_certificates.esr_certificate_1.0.1_CertificateState" : { - "type" : "string", - "enum" : [ "valid", "invalid", "unknown" ] - }, - "urn_bamm_io.catenax.esr_certificates.esr_certificate_1.0.1_CantenaxBpn" : { - "type" : "string", - "description" : "String field value, no language tags", - "pattern" : "^(BPN)(L|S|A)(\\d{8})([a-zA-Z0-9]{4})$" - }, - "urn_bamm_io.catenax.esr_certificates.esr_certificate_1.0.1_StringValue" : { - "type" : "string", - "description" : "String field value, no language tags" - }, - "urn_bamm_io.catenax.esr_certificates.esr_certificate_1.0.1_CountryCodes" : { - "type" : "string", - "description" : "ISO 3166-2 ALPHA-2 letter country list", - "enum" : [ "AF", "AX", "AL", "DZ", "AS", "AD", "AO", "AI", "AQ", "AG", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BY", "BE", "BZ", "BJ", "BM", "BT", "BO", "BQ", "BA", "BW", "BV", "BR", "IO", "BN", "BG", "BF", "BI", "KH", "CM", "CA", "CV", "KY", "CF", "TD", "CL", "CN", "CX", "CC", "CO", "KM", "CG", "CD", "CK", "CR", "CI", "HR", "CU", "CW", "CY", "CZ", "DK", "DJ", "DM", "DO", "EC", "EG", "SV", "GQ", "ER", "EE", "ET", "FK", "FO", "FJ", "FI", "FR", "GF", "PF", "TF", "GA", "GM", "GE", "DE", "GH", "GI", "GR", "GL", "GD", "GP", "GU", "GT", "GG", "GN", "GW", "GY", "HT", "HM", "VA", "HN", "HK", "HU", "IS", "IN", "ID", "IR", "IQ", "IE", "IM", "IL", "IT", "JM", "JP", "JE", "JO", "KZ", "KE", "KI", "KP", "KR", "KW", "KG", "LA", "LV", "LB", "LS", "LR", "LY", "LI", "LT", "LU", "MO", "MK", "MG", "MW", "MY", "MV", "ML", "MT", "MH", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MA", "MZ", "MM", "NA", "NR", "NP", "NL", "NC", "NZ", "NI", "NE", "NG", "NU", "NF", "MP", "NO", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PH", "PN", "PL", "PT", "PR", "QA", "RE", "RO", "RU", "RW", "BL", "SH", "KN", "LC", "MF", "PM", "VC", "WS", "SM", "ST", "SA", "SN", "RS", "SC", "SL", "SG", "SX", "SK", "SI", "SB", "SO", "ZA", "GS", "SS", "ES", "LK", "SD", "SR", "SJ", "SZ", "SE", "CH", "SY", "TW", "TJ", "TZ", "TH", "TL", "TG", "TK", "TO", "TT", "TN", "TR", "TM", "TC", "TV", "UG", "UA", "AE", "GB", "US", "UM", "UY", "UZ", "VU", "VE", "VN", "VG", "VI", "WF", "EH", "YE", "ZM", "ZW" ] - }, - "urn_bamm_io.catenax.esr_certificates.esr_certificate_1.0.1_DateValue" : { - "type" : "string", - "format" : "date", - "description" : "ISO 8601 YYYY-MM-DD date without time zone" - }, - "urn_bamm_io.catenax.esr_certificates.esr_certificate_1.0.1_CertificateNameEnumeration" : { - "type" : "string", - "enum" : [ "IS0 14001" ] - }, - "urn_bamm_io.catenax.esr_certificates.esr_certificate_1.0.1_CertificateDataCharacteristic" : { - "type" : "object", - "properties" : { - "catenaxBpn" : { - "description" : "Catena-X BPN", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.esr_certificates.esr_certificate_1.0.1_CantenaxBpn" - }, - "businessPartnerName" : { - "description" : "Company Name as listed by the Service Provider and to which the BP assigend the certificate", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.esr_certificates.esr_certificate_1.0.1_StringValue" - }, - "businessPartnerStreet" : { - "description" : "Company Street as listed by the Service Provider and to which the BP assigend the certificate", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.esr_certificates.esr_certificate_1.0.1_StringValue" - }, - "businessPartnerZip" : { - "description" : "Company ZIP code as listed by the Service Provider and to which the BP assigend the certificate", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.esr_certificates.esr_certificate_1.0.1_StringValue" - }, - "businessPartnerCity" : { - "description" : "Company city as listed by the Service Provider and to which the BP assigend the certificate", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.esr_certificates.esr_certificate_1.0.1_StringValue" - }, - "businessPartnerRegion" : { - "description" : "Company region as listed by the Service Provider and to which the BP assigned the certificate. Mandatory in some countries like USA", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.esr_certificates.esr_certificate_1.0.1_StringValue" - }, - "businessPartnerCountryCode" : { - "description" : "ISO 3166-2 company country code as listed by the Service Provider and to which the BP assigend the certificate", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.esr_certificates.esr_certificate_1.0.1_CountryCodes" - }, - "certificateVersion" : { - "description" : "Version of the certificate as in the certification document", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.esr_certificates.esr_certificate_1.0.1_StringValue" - }, - "certificateRegistrationNumber" : { - "description" : "Registration number of the certificate as in the certification document", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.esr_certificates.esr_certificate_1.0.1_StringValue" - }, - "certificateAreaOfApplication" : { - "description" : "Registration number of the certificate as in the certification document", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.esr_certificates.esr_certificate_1.0.1_StringValue" - }, - "certificateRemark" : { - "description" : "Registration number of the certificate as in the certification document", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.esr_certificates.esr_certificate_1.0.1_StringValue" - }, - "additionalCertificateRegistrationNumber" : { - "description" : "Additional certificate registration number", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.esr_certificates.esr_certificate_1.0.1_StringValue" - }, - "certificationAgencyRegistrationNumber" : { - "description" : "Certification agency registration number", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.esr_certificates.esr_certificate_1.0.1_StringValue" - }, - "certificationAgencyName" : { - "description" : "Certification agency name as in the certification document", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.esr_certificates.esr_certificate_1.0.1_StringValue" - }, - "certificateValidFrom" : { - "description" : "Certificate valid from as in the certification document", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.esr_certificates.esr_certificate_1.0.1_DateValue" - }, - "certificateValidUntil" : { - "description" : "Certificate valid until as in the certification document", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.esr_certificates.esr_certificate_1.0.1_DateValue" - }, - "certificateName" : { - "description" : "Certificate name as in the certification document", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.esr_certificates.esr_certificate_1.0.1_CertificateNameEnumeration" - } - }, - "required" : [ "catenaxBpn", "businessPartnerName", "businessPartnerStreet", "businessPartnerZip", "businessPartnerCity", "businessPartnerRegion", "businessPartnerCountryCode", "certificateVersion", "certificateRegistrationNumber", "certificateAreaOfApplication", "certificateRemark", "additionalCertificateRegistrationNumber", "certificationAgencyRegistrationNumber", "certificationAgencyName", "certificateValidFrom", "certificateValidUntil", "certificateName" ] - } - } - }, - "properties" : { - "certificateState" : { - "description" : "The Environmental and Social Responsibility (ESR) certificate state is reported as valid if the query day is within the validity period of the certificate", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.esr_certificates.esr_certificate_1.0.1_CertificateState" - }, - "certificateData" : { - "description" : "An Environmental and Social Responsibility (ESR) certificate is described by a unique set of data for a given certificate type", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.esr_certificates.esr_certificate_1.0.1_CertificateDataCharacteristic" - } - }, - "required" : [ "certificateState", "certificateData" ] -} \ No newline at end of file diff --git a/io.catenax.esr_certificates.esr_certificate/1.0.1/gen/EsrCertificate.aasx b/io.catenax.esr_certificates.esr_certificate/1.0.1/gen/EsrCertificate.aasx deleted file mode 100644 index 9886cbad8..000000000 Binary files a/io.catenax.esr_certificates.esr_certificate/1.0.1/gen/EsrCertificate.aasx and /dev/null differ diff --git a/io.catenax.esr_certificates.esr_certificate/1.0.1/gen/EsrCertificate.html b/io.catenax.esr_certificates.esr_certificate/1.0.1/gen/EsrCertificate.html deleted file mode 100644 index e69660231..000000000 --- a/io.catenax.esr_certificates.esr_certificate/1.0.1/gen/EsrCertificate.html +++ /dev/null @@ -1,1676 +0,0 @@ - - - - - - - - - - - - - - Dokumentation ESR Certificate - - -
-
-
-
-

Aspect Model ESR Certificate

-
urn:bamm:io.catenax.esr_certificates.esr_certificate:1.0.1#EsrCertificate
-
-
-
-
-
-
-
- -
- - -
- Environmental and Social Responsibility (ESR) certificate of the Business Partner (e.g. Supplier) -
- - -
-

Übersicht

-
-
-
-
- Aspect Model Diagram -
-
-
- - -
-
-

Properties

-
- -
- -
-

Certificate Data

-
- -An Environmental and Social Responsibility (ESR) certificate is described by a unique set of data for a given certificate type - -
-
Name
-
certificateData
-
- - - -
-
Characteristic
-
-
-
-
SingleEntity
-
-
-
- Typ urn:bamm:io.catenax.esr_certificates.esr_certificate:1.0.1#CertificateDataEntity - -
-
-
-
-
- - -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
certificateData
-
- - -
-
- -
-

State of the Certificate

-
- -The Environmental and Social Responsibility (ESR) certificate state is reported as valid if the query day is within the validity period of the certificate - -
-
Name
-
certificateState
-
- - - -
-
Characteristic
-
-
-
-
Enumeration
-
-
-
Werte
-
-
-
-
    -
  • valid
    • -
  • invalid
    • -
  • unknown
    • -
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Beispiel
-
valid
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
certificateState
-
- - -
-
- - - -
-
-

Objekt

-
- -
-
-

CertificateDataEntity

-
-
- -
- -
-

Properties

-
-
- -
-
Catena-X BPN
-
- -Catena-X BPN - -
-
Name
-
catenaxBpn
-
- - - -
-
Characteristic
-
-
-
-
Trait
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Beispiel
-
BPNL00000003AYRE
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
catenaxBpn
-
- - -
-
Bedingungen
-
-
    -
  • -
    - -
    - CatenaxBpnRegEx -
    - - - -
    -
    Regulärer Ausdruck
    -
    ^(BPN)(L|S|A)(\d{8})([a-zA-Z0-9]{4})$
    -
    - -
    • -
-
-
-
-
- -
-
Business Partner Name
-
- -Company Name as listed by the Service Provider and to which the BP assigend the certificate - -
-
Name
-
businessPartnerName
-
- - - -
-
Characteristic
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Beispiel
-
Example GmbH
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
businessPartnerName
-
- - -
-
- -
-
Business Partner Street
-
- -Company Street as listed by the Service Provider and to which the BP assigend the certificate - -
-
Name
-
businessPartnerStreet
-
- - - -
-
Characteristic
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Beispiel
-
Balduin-Helmann-Str 215
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
businessPartnerStreet
-
- - -
-
- -
-
Business Partner Zip
-
- -Company ZIP code as listed by the Service Provider and to which the BP assigend the certificate - -
-
Name
-
businessPartnerZip
-
- - - -
-
Characteristic
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Beispiel
-
82256
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
businessPartnerZip
-
- - -
-
- -
-
Business Partner City
-
- -Company city as listed by the Service Provider and to which the BP assigend the certificate - -
-
Name
-
businessPartnerCity
-
- - - -
-
Characteristic
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Beispiel
-
Fürstenfeldbruck
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
businessPartnerCity
-
- - -
-
- -
-
Business Partner Region
-
- -Company region as listed by the Service Provider and to which the BP assigned the certificate. Mandatory in some countries like USA - -
-
Name
-
businessPartnerRegion
-
- - - -
-
Characteristic
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Beispiel
-
Bavaria
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
businessPartnerRegion
-
- - -
-
- -
-
Business Partner Country Code
-
- -ISO 3166-2 company country code as listed by the Service Provider and to which the BP assigend the certificate - -
-
Name
-
businessPartnerCountryCode
-
- - - -
-
Characteristic
-
-
-
-
Enumeration
-
-
-
Werte
-
-
-
-
    -
  • AF
    • -
  • AX
    • -
  • AL
    • -
  • DZ
    • -
  • AS
    • -
  • AD
    • -
  • AO
    • -
  • AI
    • -
  • AQ
    • -
  • AG
    • -
  • AR
    • -
  • AM
    • -
  • AW
    • -
  • AU
    • -
  • AT
    • -
  • AZ
    • -
  • BS
    • -
  • BH
    • -
  • BD
    • -
  • BB
    • -
  • BY
    • -
  • BE
    • -
  • BZ
    • -
  • BJ
    • -
  • BM
    • -
  • BT
    • -
  • BO
    • -
  • BQ
    • -
  • BA
    • -
  • BW
    • -
  • BV
    • -
  • BR
    • -
  • IO
    • -
  • BN
    • -
  • BG
    • -
  • BF
    • -
  • BI
    • -
  • KH
    • -
  • CM
    • -
  • CA
    • -
  • CV
    • -
  • KY
    • -
  • CF
    • -
  • TD
    • -
  • CL
    • -
  • CN
    • -
  • CX
    • -
  • CC
    • -
  • CO
    • -
  • KM
    • -
  • CG
    • -
  • CD
    • -
  • CK
    • -
  • CR
    • -
  • CI
    • -
  • HR
    • -
  • CU
    • -
  • CW
    • -
  • CY
    • -
  • CZ
    • -
  • DK
    • -
  • DJ
    • -
  • DM
    • -
  • DO
    • -
  • EC
    • -
  • EG
    • -
  • SV
    • -
  • GQ
    • -
  • ER
    • -
  • EE
    • -
  • ET
    • -
  • FK
    • -
  • FO
    • -
  • FJ
    • -
  • FI
    • -
  • FR
    • -
  • GF
    • -
  • PF
    • -
  • TF
    • -
  • GA
    • -
  • GM
    • -
  • GE
    • -
  • DE
    • -
  • GH
    • -
  • GI
    • -
  • GR
    • -
  • GL
    • -
  • GD
    • -
  • GP
    • -
  • GU
    • -
  • GT
    • -
  • GG
    • -
  • GN
    • -
  • GW
    • -
  • GY
    • -
  • HT
    • -
  • HM
    • -
  • VA
    • -
  • HN
    • -
  • HK
    • -
  • HU
    • -
  • IS
    • -
  • IN
    • -
  • ID
    • -
  • IR
    • -
  • IQ
    • -
  • IE
    • -
  • IM
    • -
  • IL
    • -
  • IT
    • -
  • JM
    • -
  • JP
    • -
  • JE
    • -
  • JO
    • -
  • KZ
    • -
  • KE
    • -
  • KI
    • -
  • KP
    • -
  • KR
    • -
  • KW
    • -
  • KG
    • -
  • LA
    • -
  • LV
    • -
  • LB
    • -
  • LS
    • -
  • LR
    • -
  • LY
    • -
  • LI
    • -
  • LT
    • -
  • LU
    • -
  • MO
    • -
  • MK
    • -
  • MG
    • -
  • MW
    • -
  • MY
    • -
  • MV
    • -
  • ML
    • -
  • MT
    • -
  • MH
    • -
  • MQ
    • -
  • MR
    • -
  • MU
    • -
  • YT
    • -
  • MX
    • -
  • FM
    • -
  • MD
    • -
  • MC
    • -
  • MN
    • -
  • ME
    • -
  • MS
    • -
  • MA
    • -
  • MZ
    • -
  • MM
    • -
  • NA
    • -
  • NR
    • -
  • NP
    • -
  • NL
    • -
  • NC
    • -
  • NZ
    • -
  • NI
    • -
  • NE
    • -
  • NG
    • -
  • NU
    • -
  • NF
    • -
  • MP
    • -
  • NO
    • -
  • OM
    • -
  • PK
    • -
  • PW
    • -
  • PS
    • -
  • PA
    • -
  • PG
    • -
  • PY
    • -
  • PE
    • -
  • PH
    • -
  • PN
    • -
  • PL
    • -
  • PT
    • -
  • PR
    • -
  • QA
    • -
  • RE
    • -
  • RO
    • -
  • RU
    • -
  • RW
    • -
  • BL
    • -
  • SH
    • -
  • KN
    • -
  • LC
    • -
  • MF
    • -
  • PM
    • -
  • VC
    • -
  • WS
    • -
  • SM
    • -
  • ST
    • -
  • SA
    • -
  • SN
    • -
  • RS
    • -
  • SC
    • -
  • SL
    • -
  • SG
    • -
  • SX
    • -
  • SK
    • -
  • SI
    • -
  • SB
    • -
  • SO
    • -
  • ZA
    • -
  • GS
    • -
  • SS
    • -
  • ES
    • -
  • LK
    • -
  • SD
    • -
  • SR
    • -
  • SJ
    • -
  • SZ
    • -
  • SE
    • -
  • CH
    • -
  • SY
    • -
  • TW
    • -
  • TJ
    • -
  • TZ
    • -
  • TH
    • -
  • TL
    • -
  • TG
    • -
  • TK
    • -
  • TO
    • -
  • TT
    • -
  • TN
    • -
  • TR
    • -
  • TM
    • -
  • TC
    • -
  • TV
    • -
  • UG
    • -
  • UA
    • -
  • AE
    • -
  • GB
    • -
  • US
    • -
  • UM
    • -
  • UY
    • -
  • UZ
    • -
  • VU
    • -
  • VE
    • -
  • VN
    • -
  • VG
    • -
  • VI
    • -
  • WF
    • -
  • EH
    • -
  • YE
    • -
  • ZM
    • -
  • ZW
    • -
-
-
-
-
- Referenz -
-
    -
  • file:///Users/johannes/Projects/sldt-semantic-models/https%25253A%25252F%25252Fwww.iban.com%25252Fcountry-codes
    • -
-
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Beispiel
-
DE
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
businessPartnerCountryCode
-
- - -
-
- -
-
Certificate Version
-
- -Version of the certificate as in the certification document - -
-
Name
-
certificateVersion
-
- - - -
-
Characteristic
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Beispiel
-
2015
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
certificateVersion
-
- - -
-
- -
-
Certificate Registration Number
-
- -Registration number of the certificate as in the certification document - -
-
Name
-
certificateRegistrationNumber
-
- - - -
-
Characteristic
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Beispiel
-
12 198 54182 TMS
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
certificateRegistrationNumber
-
- - -
-
- -
-
Certificate Registration Number
-
- -Registration number of the certificate as in the certification document - -
-
Name
-
certificateAreaOfApplication
-
- - - -
-
Characteristic
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Beispiel
-
Manufacture of turbo engines for goldfish racing tournaments
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
certificateAreaOfApplication
-
- - -
-
- -
-
Certificate Registration Number
-
- -Registration number of the certificate as in the certification document - -
-
Name
-
certificateRemark
-
- - - -
-
Characteristic
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Beispiel
-
Only valid in combination with Certificate 1945934 TMS
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
certificateRemark
-
- - -
-
- -
-
Additional Certificate Registration Number
-
- -Additional certificate registration number - -
-
Name
-
additionalCertificateRegistrationNumber
-
- - - -
-
Characteristic
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Beispiel
-
20002
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
additionalCertificateRegistrationNumber
-
- - -
-
- -
-
Certification Agency Registration Number
-
- -Certification agency registration number - -
-
Name
-
certificationAgencyRegistrationNumber
-
- - - -
-
Characteristic
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Beispiel
-
A-99-2269
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
certificationAgencyRegistrationNumber
-
- - -
-
- -
-
Certificate Agency Name
-
- -Certification agency name as in the certification document - -
-
Name
-
certificationAgencyName
-
- - - -
-
Characteristic
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Beispiel
-
Certfication Example Agency AG
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
certificationAgencyName
-
- - -
-
- -
-
Certificate Valid From
-
- -Certificate valid from as in the certification document - -
-
Name
-
certificateValidFrom
-
- - - -
-
Characteristic
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#date - -
-
-
-
-
- -
-
Beispiel
-
2021-06-04
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
certificateValidFrom
-
- - -
-
- -
-
Certificate Valid Until
-
- -Certificate valid until as in the certification document - -
-
Name
-
certificateValidUntil
-
- - - -
-
Characteristic
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#date - -
-
-
-
-
- -
-
Beispiel
-
2024-09-28
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
certificateValidUntil
-
- - -
-
- -
-
Certificate Name
-
- -Certificate name as in the certification document - -
-
Name
-
certificateName
-
- - - -
-
Characteristic
-
-
-
-
Enumeration
-
-
-
Werte
-
-
-
-
    -
  • IS0 14001
    • -
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Beispiel
-
ISO 14001
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
certificateName
-
- - -
-
-
- -
- Third party licenses - -
- -
- - -
- - - \ No newline at end of file diff --git a/io.catenax.esr_certificates.esr_certificate/1.0.1/gen/EsrCertificate.json b/io.catenax.esr_certificates.esr_certificate/1.0.1/gen/EsrCertificate.json deleted file mode 100644 index a3ad62ef7..000000000 --- a/io.catenax.esr_certificates.esr_certificate/1.0.1/gen/EsrCertificate.json +++ /dev/null @@ -1,22 +0,0 @@ -{ - "certificateState" : "valid", - "certificateData" : { - "businessPartnerZip" : "82256", - "certificateValidFrom" : "2021-06-04", - "certificateVersion" : "2015", - "businessPartnerCity" : "Fürstenfeldbruck", - "certificateName" : "IS0 14001", - "businessPartnerName" : "Example GmbH", - "businessPartnerStreet" : "Balduin-Helmann-Str 215", - "certificateValidUntil" : "2024-09-28", - "additionalCertificateRegistrationNumber" : "20002", - "businessPartnerRegion" : "Bavaria", - "certificateRemark" : "Only valid in combination with Certificate 1945934 TMS", - "businessPartnerCountryCode" : "AF", - "certificateRegistrationNumber" : "12 198 54182 TMS", - "certificateAreaOfApplication" : "Manufacture of turbo engines for goldfish racing tournaments", - "catenaxBpn" : "BPNL00000003AYRE", - "certificationAgencyRegistrationNumber" : "A-99-2269", - "certificationAgencyName" : "Certfication Example Agency AG" - } -} \ No newline at end of file diff --git a/io.catenax.esr_certificates.esr_certificate/1.0.1/gen/EsrCertificate.yml b/io.catenax.esr_certificates.esr_certificate/1.0.1/gen/EsrCertificate.yml deleted file mode 100644 index ca054260d..000000000 --- a/io.catenax.esr_certificates.esr_certificate/1.0.1/gen/EsrCertificate.yml +++ /dev/null @@ -1,462 +0,0 @@ ---- -openapi: 3.0.3 -info: - title: ESR Certificate - version: v1 -servers: -- url: catenax.io/api/v1 - variables: - api-version: - default: v1 -paths: - /{tenant-id}/esr-certificate: - get: - tags: - - EsrCertificate - operationId: getEsrCertificate - 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/EsrCertificate' - "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_bamm_io.catenax.esr_certificates.esr_certificate_1.0.1_CertificateState: - type: string - enum: - - valid - - invalid - - unknown - urn_bamm_io.catenax.esr_certificates.esr_certificate_1.0.1_CantenaxBpn: - type: string - description: "String field value, no language tags" - pattern: "^(BPN)(L|S|A)(\\d{8})([a-zA-Z0-9]{4})$" - urn_bamm_io.catenax.esr_certificates.esr_certificate_1.0.1_StringValue: - type: string - description: "String field value, no language tags" - urn_bamm_io.catenax.esr_certificates.esr_certificate_1.0.1_CountryCodes: - type: string - description: ISO 3166-2 ALPHA-2 letter country list - enum: - - AF - - AX - - AL - - DZ - - AS - - AD - - AO - - AI - - AQ - - AG - - AR - - AM - - AW - - AU - - AT - - AZ - - BS - - BH - - BD - - BB - - BY - - BE - - BZ - - BJ - - BM - - BT - - BO - - BQ - - BA - - BW - - BV - - BR - - IO - - BN - - BG - - BF - - BI - - KH - - CM - - CA - - CV - - KY - - CF - - TD - - CL - - CN - - CX - - CC - - CO - - KM - - CG - - CD - - CK - - CR - - CI - - HR - - CU - - CW - - CY - - CZ - - DK - - DJ - - DM - - DO - - EC - - EG - - SV - - GQ - - ER - - EE - - ET - - FK - - FO - - FJ - - FI - - FR - - GF - - PF - - TF - - GA - - GM - - GE - - DE - - GH - - GI - - GR - - GL - - GD - - GP - - GU - - GT - - GG - - GN - - GW - - GY - - HT - - HM - - VA - - HN - - HK - - HU - - IS - - IN - - ID - - IR - - IQ - - IE - - IM - - IL - - IT - - JM - - JP - - JE - - JO - - KZ - - KE - - KI - - KP - - KR - - KW - - KG - - LA - - LV - - LB - - LS - - LR - - LY - - LI - - LT - - LU - - MO - - MK - - MG - - MW - - MY - - MV - - ML - - MT - - MH - - MQ - - MR - - MU - - YT - - MX - - FM - - MD - - MC - - MN - - ME - - MS - - MA - - MZ - - MM - - NA - - NR - - NP - - NL - - NC - - NZ - - NI - - NE - - NG - - NU - - NF - - MP - - "NO" - - OM - - PK - - PW - - PS - - PA - - PG - - PY - - PE - - PH - - PN - - PL - - PT - - PR - - QA - - RE - - RO - - RU - - RW - - BL - - SH - - KN - - LC - - MF - - PM - - VC - - WS - - SM - - ST - - SA - - SN - - RS - - SC - - SL - - SG - - SX - - SK - - SI - - SB - - SO - - ZA - - GS - - SS - - ES - - LK - - SD - - SR - - SJ - - SZ - - SE - - CH - - SY - - TW - - TJ - - TZ - - TH - - TL - - TG - - TK - - TO - - TT - - TN - - TR - - TM - - TC - - TV - - UG - - UA - - AE - - GB - - US - - UM - - UY - - UZ - - VU - - VE - - VN - - VG - - VI - - WF - - EH - - YE - - ZM - - ZW - urn_bamm_io.catenax.esr_certificates.esr_certificate_1.0.1_DateValue: - type: string - format: date - description: ISO 8601 YYYY-MM-DD date without time zone - urn_bamm_io.catenax.esr_certificates.esr_certificate_1.0.1_CertificateNameEnumeration: - type: string - enum: - - IS0 14001 - urn_bamm_io.catenax.esr_certificates.esr_certificate_1.0.1_CertificateDataCharacteristic: - type: object - properties: - catenaxBpn: - description: Catena-X BPN - $ref: '#/components/schemas/urn_bamm_io.catenax.esr_certificates.esr_certificate_1.0.1_CantenaxBpn' - businessPartnerName: - description: Company Name as listed by the Service Provider and to which - the BP assigend the certificate - $ref: '#/components/schemas/urn_bamm_io.catenax.esr_certificates.esr_certificate_1.0.1_StringValue' - businessPartnerStreet: - description: Company Street as listed by the Service Provider and to which - the BP assigend the certificate - $ref: '#/components/schemas/urn_bamm_io.catenax.esr_certificates.esr_certificate_1.0.1_StringValue' - businessPartnerZip: - description: Company ZIP code as listed by the Service Provider and to which - the BP assigend the certificate - $ref: '#/components/schemas/urn_bamm_io.catenax.esr_certificates.esr_certificate_1.0.1_StringValue' - businessPartnerCity: - description: Company city as listed by the Service Provider and to which - the BP assigend the certificate - $ref: '#/components/schemas/urn_bamm_io.catenax.esr_certificates.esr_certificate_1.0.1_StringValue' - businessPartnerRegion: - description: Company region as listed by the Service Provider and to which - the BP assigned the certificate. Mandatory in some countries like USA - $ref: '#/components/schemas/urn_bamm_io.catenax.esr_certificates.esr_certificate_1.0.1_StringValue' - businessPartnerCountryCode: - description: ISO 3166-2 company country code as listed by the Service Provider - and to which the BP assigend the certificate - $ref: '#/components/schemas/urn_bamm_io.catenax.esr_certificates.esr_certificate_1.0.1_CountryCodes' - certificateVersion: - description: Version of the certificate as in the certification document - $ref: '#/components/schemas/urn_bamm_io.catenax.esr_certificates.esr_certificate_1.0.1_StringValue' - certificateRegistrationNumber: - description: Registration number of the certificate as in the certification - document - $ref: '#/components/schemas/urn_bamm_io.catenax.esr_certificates.esr_certificate_1.0.1_StringValue' - certificateAreaOfApplication: - description: Registration number of the certificate as in the certification - document - $ref: '#/components/schemas/urn_bamm_io.catenax.esr_certificates.esr_certificate_1.0.1_StringValue' - certificateRemark: - description: Registration number of the certificate as in the certification - document - $ref: '#/components/schemas/urn_bamm_io.catenax.esr_certificates.esr_certificate_1.0.1_StringValue' - additionalCertificateRegistrationNumber: - description: Additional certificate registration number - $ref: '#/components/schemas/urn_bamm_io.catenax.esr_certificates.esr_certificate_1.0.1_StringValue' - certificationAgencyRegistrationNumber: - description: Certification agency registration number - $ref: '#/components/schemas/urn_bamm_io.catenax.esr_certificates.esr_certificate_1.0.1_StringValue' - certificationAgencyName: - description: Certification agency name as in the certification document - $ref: '#/components/schemas/urn_bamm_io.catenax.esr_certificates.esr_certificate_1.0.1_StringValue' - certificateValidFrom: - description: Certificate valid from as in the certification document - $ref: '#/components/schemas/urn_bamm_io.catenax.esr_certificates.esr_certificate_1.0.1_DateValue' - certificateValidUntil: - description: Certificate valid until as in the certification document - $ref: '#/components/schemas/urn_bamm_io.catenax.esr_certificates.esr_certificate_1.0.1_DateValue' - certificateName: - description: Certificate name as in the certification document - $ref: '#/components/schemas/urn_bamm_io.catenax.esr_certificates.esr_certificate_1.0.1_CertificateNameEnumeration' - required: - - catenaxBpn - - businessPartnerName - - businessPartnerStreet - - businessPartnerZip - - businessPartnerCity - - businessPartnerRegion - - businessPartnerCountryCode - - certificateVersion - - certificateRegistrationNumber - - certificateAreaOfApplication - - certificateRemark - - additionalCertificateRegistrationNumber - - certificationAgencyRegistrationNumber - - certificationAgencyName - - certificateValidFrom - - certificateValidUntil - - certificateName - EsrCertificate: - description: Environmental and Social Responsibility (ESR) certificate of the - Business Partner (e.g. Supplier) - type: object - properties: - certificateState: - description: The Environmental and Social Responsibility (ESR) certificate - state is reported as valid if the query day is within the validity period - of the certificate - $ref: '#/components/schemas/urn_bamm_io.catenax.esr_certificates.esr_certificate_1.0.1_CertificateState' - certificateData: - description: An Environmental and Social Responsibility (ESR) certificate - is described by a unique set of data for a given certificate type - $ref: '#/components/schemas/urn_bamm_io.catenax.esr_certificates.esr_certificate_1.0.1_CertificateDataCharacteristic' - required: - - certificateState - - certificateData - 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' - EsrCertificate: - content: - application/json: - schema: - $ref: '#/components/schemas/EsrCertificate' - description: The request was successful. - requestBodies: - EsrCertificate: - content: - application/json: - schema: - $ref: '#/components/schemas/EsrCertificate' diff --git a/io.catenax.esr_certificates.esr_certificate/1.0.1/metadata.json b/io.catenax.esr_certificates.esr_certificate/1.0.1/metadata.json deleted file mode 100644 index 9e759dfb1..000000000 --- a/io.catenax.esr_certificates.esr_certificate/1.0.1/metadata.json +++ /dev/null @@ -1 +0,0 @@ -{ "status" : "deprecate"} diff --git a/io.catenax.esr_certificates.esr_certificate_state_statistic/1.0.1/EsrCertificateStateStatistic.ttl b/io.catenax.esr_certificates.esr_certificate_state_statistic/1.0.1/EsrCertificateStateStatistic.ttl deleted file mode 100644 index d3c9b518b..000000000 --- a/io.catenax.esr_certificates.esr_certificate_state_statistic/1.0.1/EsrCertificateStateStatistic.ttl +++ /dev/null @@ -1,81 +0,0 @@ -####################################################################### -# Copyright (c) 2022 SupplyOn AG -# Copyright (c) Bayerische Motoren Werke Aktiengesellschaft (BMW AG) -# Copyright (c) 2022 Contributors to the Eclipse Foundation -# -# 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 bamm: . -@prefix bamm-c: . -@prefix bamm-e: . -@prefix unit: . -@prefix rdf: . -@prefix rdfs: . -@prefix xsd: . -@prefix : . - -:certificateName a bamm:Property; - bamm:name "certificateName"; - bamm:preferredName "Certificate Name"@en; - bamm:description "Name of the Environmental and Social Responsibility (ESR) certificate"@en; - bamm:characteristic :CertficateName; - bamm:exampleValue "ISO 14001". -:CertficateName a bamm-c:Enumeration; - bamm:name "CertficateName"; - bamm:description "String without language tags"@en; - bamm:dataType xsd:string; - bamm-c:values ("ISO 14001"). -:certificateStateStatistic a bamm:Property; - bamm:name "certificateStateStatistic"; - bamm:preferredName "Certificate State Statistic"@en; - bamm:description "Environmental and Social Responsibility (ESR) certificate state statistic"@en; - bamm:characteristic :CertificateStateStatistic. -:CertificateStateStatistic a bamm:Characteristic; - bamm:name "CertificateStateStatistic"; - bamm:dataType :CertificateStateStatisticEntity. -:CertificateStateStatisticEntity a bamm:Entity; - bamm:name "CertificateStateStatisticEntity"; - bamm:properties (:certificatesWithStateValid :certificatesWithStateInvalid :certificatesWithStateUnknown :certificatesWithStateExceptional). -:certificatesWithStateValid a bamm:Property; - bamm:name "certificatesWithStateValid"; - bamm:preferredName "Certificates With State Valid"@en; - bamm:description "Number of certificates with state valid"@en; - bamm:characteristic :CertificatesWithStateValue; - bamm:exampleValue "10"^^xsd:nonNegativeInteger. -:certificatesWithStateInvalid a bamm:Property; - bamm:name "certificatesWithStateInvalid"; - bamm:preferredName "Certificates With State Invalid"@en; - bamm:description "Number of certificates with state invalid"@en; - bamm:characteristic :CertificatesWithStateValue; - bamm:exampleValue "11"^^xsd:nonNegativeInteger. -:certificatesWithStateUnknown a bamm:Property; - bamm:name "certificatesWithStateUnknown"; - bamm:preferredName " Certificates With State Unknown"@en; - bamm:description "Number of certificates with state unknown"@en; - bamm:characteristic :CertificatesWithStateValue; - bamm:exampleValue "3"^^xsd:nonNegativeInteger. -:certificatesWithStateExceptional a bamm:Property; - bamm:name "certificatesWithStateExceptional"; - bamm:preferredName "Certificates With State Exceptional"@en; - bamm:description "Number of certificates with state exceptional"@en; - bamm:characteristic :CertificatesWithStateValue; - bamm:exampleValue "1"^^xsd:nonNegativeInteger. -:CertificatesWithStateValue a bamm:Characteristic; - bamm:name "CertificatesWithStateValue"; - bamm:dataType xsd:nonNegativeInteger. -:EsrCertificateStateStatistic a bamm:Aspect; - bamm:name "EsrCertificateStateStatistic"; - bamm:preferredName "ESR Certificate StateS tatistic"@en; - bamm:description "State statistic for an Environmental and Social Responsibility (ESR) certificate"@en; - bamm:properties (:certificateName :certificateStateStatistic); - bamm:operations (); - bamm:events (). diff --git a/io.catenax.esr_certificates.esr_certificate_state_statistic/1.0.1/gen/EsrCertificateStateStatistic-aas.xml b/io.catenax.esr_certificates.esr_certificate_state_statistic/1.0.1/gen/EsrCertificateStateStatistic-aas.xml deleted file mode 100644 index ea2d8dff1..000000000 --- a/io.catenax.esr_certificates.esr_certificate_state_statistic/1.0.1/gen/EsrCertificateStateStatistic-aas.xml +++ /dev/null @@ -1,506 +0,0 @@ - - - - - defaultAdminShell - - - en - defaultAdminShell - - - - urn:samm:io.catenax.esr_certificates.esr_certificate_state_statistic:1.0.1#EsrCertificateStateStatistic - - Type - - - - ModelReference - - - Submodel - urn:samm:io.catenax.esr_certificates.esr_certificate_state_statistic:1.0.1#EsrCertificateStateStatistic/submodel - - - - - - - - - EsrCertificateStateStatistic - - - en - State statistic for an Environmental and Social Responsibility (ESR) certificate - - - - urn:samm:io.catenax.esr_certificates.esr_certificate_state_statistic:1.0.1#EsrCertificateStateStatistic/submodel - Template - - ModelReference - - - ConceptDescription - urn:samm:io.catenax.esr_certificates.esr_certificate_state_statistic:1.0.1#EsrCertificateStateStatistic - - - - - - certificateName - - - en - Certificate Name - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.esr_certificates.esr_certificate_state_statistic:1.0.1#certificateName - - - - xs:string - - - - CertificateStateStatisticEntity - - - certificatesWithStateValid - - - en - Certificates With State Valid - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.esr_certificates.esr_certificate_state_statistic:1.0.1#certificatesWithStateValid - - - - xs:nonNegativeInteger - - - - certificatesWithStateInvalid - - - en - Certificates With State Invalid - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.esr_certificates.esr_certificate_state_statistic:1.0.1#certificatesWithStateInvalid - - - - xs:nonNegativeInteger - - - - certificatesWithStateUnknown - - - en - Certificates With State Unknown - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.esr_certificates.esr_certificate_state_statistic:1.0.1#certificatesWithStateUnknown - - - - xs:nonNegativeInteger - - - - certificatesWithStateExceptional - - - en - Certificates With State Exceptional - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.esr_certificates.esr_certificate_state_statistic:1.0.1#certificatesWithStateExceptional - - - - xs:nonNegativeInteger - - - - - - - - - - APPLICATION_CLASS - EsrCertificateStateStatistic - - - en - ESR Certificate StateS tatistic - - - - - en - State statistic for an Environmental and Social Responsibility (ESR) certificate - - - urn:samm:io.catenax.esr_certificates.esr_certificate_state_statistic:1.0.1#EsrCertificateStateStatistic - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - ESR Certificate StateS tatistic - - - - - en - EsrCertificateStateStatistic - - - - - en - State statistic for an Environmental and Social Responsibility (ESR) certificate - - - - - - - - - certificateName - - - en - Certificate Name - - - urn:samm:io.catenax.esr_certificates.esr_certificate_state_statistic:1.0.1#certificateName - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Certificate Name - - - - - en - certificateName - - - STRING - - - en - Name of the Environmental and Social Responsibility (ESR) certificate - - - - - - ISO 14001 - - ModelReference - - - DataElement - urn:samm:io.catenax.esr_certificates.esr_certificate_state_statistic:1.0.1#CertficateName:ISO 14001 - - - - - - - - - - - - - certificatesWithStateValid - - - en - Certificates With State Valid - - - urn:samm:io.catenax.esr_certificates.esr_certificate_state_statistic:1.0.1#certificatesWithStateValid - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Certificates With State Valid - - - - - en - certificatesWithStateValid - - - INTEGER_COUNT - - - en - Number of certificates with state valid - - - - - - - - - certificatesWithStateInvalid - - - en - Certificates With State Invalid - - - urn:samm:io.catenax.esr_certificates.esr_certificate_state_statistic:1.0.1#certificatesWithStateInvalid - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Certificates With State Invalid - - - - - en - certificatesWithStateInvalid - - - INTEGER_COUNT - - - en - Number of certificates with state invalid - - - - - - - - - certificatesWithStateUnknown - - - en - Certificates With State Unknown - - - urn:samm:io.catenax.esr_certificates.esr_certificate_state_statistic:1.0.1#certificatesWithStateUnknown - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Certificates With State Unknown - - - - - en - certificatesWithStateUnknown - - - INTEGER_COUNT - - - en - Number of certificates with state unknown - - - - - - - - - certificatesWithStateExceptional - - - en - Certificates With State Exceptional - - - urn:samm:io.catenax.esr_certificates.esr_certificate_state_statistic:1.0.1#certificatesWithStateExceptional - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Certificates With State Exceptional - - - - - en - certificatesWithStateExceptional - - - INTEGER_COUNT - - - en - Number of certificates with state exceptional - - - - - - - - - certificateStateStatistic - - - en - Certificate State Statistic - - - urn:samm:io.catenax.esr_certificates.esr_certificate_state_statistic:1.0.1#certificateStateStatistic - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Certificate State Statistic - - - - - en - certificateStateStatistic - - - STRING - - - en - Environmental and Social Responsibility (ESR) certificate state statistic - - - - - - - - - diff --git a/io.catenax.esr_certificates.esr_certificate_state_statistic/1.0.1/gen/EsrCertificateStateStatistic-schema.json b/io.catenax.esr_certificates.esr_certificate_state_statistic/1.0.1/gen/EsrCertificateStateStatistic-schema.json deleted file mode 100644 index bc34e5b3e..000000000 --- a/io.catenax.esr_certificates.esr_certificate_state_statistic/1.0.1/gen/EsrCertificateStateStatistic-schema.json +++ /dev/null @@ -1,51 +0,0 @@ -{ - "$schema" : "http://json-schema.org/draft-04/schema", - "description" : "State statistic for an Environmental and Social Responsibility (ESR) certificate", - "type" : "object", - "components" : { - "schemas" : { - "urn_bamm_io.catenax.esr_certificates.esr_certificate_state_statistic_1.0.1_CertficateName" : { - "type" : "string", - "description" : "String without language tags", - "enum" : [ "ISO 14001" ] - }, - "urn_bamm_io.catenax.esr_certificates.esr_certificate_state_statistic_1.0.1_CertificatesWithStateValue" : { - "type" : "number", - "minimum" : 0 - }, - "urn_bamm_io.catenax.esr_certificates.esr_certificate_state_statistic_1.0.1_CertificateStateStatistic" : { - "type" : "object", - "properties" : { - "certificatesWithStateValid" : { - "description" : "Number of certificates with state valid", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.esr_certificates.esr_certificate_state_statistic_1.0.1_CertificatesWithStateValue" - }, - "certificatesWithStateInvalid" : { - "description" : "Number of certificates with state invalid", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.esr_certificates.esr_certificate_state_statistic_1.0.1_CertificatesWithStateValue" - }, - "certificatesWithStateUnknown" : { - "description" : "Number of certificates with state unknown", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.esr_certificates.esr_certificate_state_statistic_1.0.1_CertificatesWithStateValue" - }, - "certificatesWithStateExceptional" : { - "description" : "Number of certificates with state exceptional", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.esr_certificates.esr_certificate_state_statistic_1.0.1_CertificatesWithStateValue" - } - }, - "required" : [ "certificatesWithStateValid", "certificatesWithStateInvalid", "certificatesWithStateUnknown", "certificatesWithStateExceptional" ] - } - } - }, - "properties" : { - "certificateName" : { - "description" : "Name of the Environmental and Social Responsibility (ESR) certificate", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.esr_certificates.esr_certificate_state_statistic_1.0.1_CertficateName" - }, - "certificateStateStatistic" : { - "description" : "Environmental and Social Responsibility (ESR) certificate state statistic", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.esr_certificates.esr_certificate_state_statistic_1.0.1_CertificateStateStatistic" - } - }, - "required" : [ "certificateName", "certificateStateStatistic" ] -} \ No newline at end of file diff --git a/io.catenax.esr_certificates.esr_certificate_state_statistic/1.0.1/gen/EsrCertificateStateStatistic.aasx b/io.catenax.esr_certificates.esr_certificate_state_statistic/1.0.1/gen/EsrCertificateStateStatistic.aasx deleted file mode 100644 index a6de32aa4..000000000 Binary files a/io.catenax.esr_certificates.esr_certificate_state_statistic/1.0.1/gen/EsrCertificateStateStatistic.aasx and /dev/null differ diff --git a/io.catenax.esr_certificates.esr_certificate_state_statistic/1.0.1/gen/EsrCertificateStateStatistic.html b/io.catenax.esr_certificates.esr_certificate_state_statistic/1.0.1/gen/EsrCertificateStateStatistic.html deleted file mode 100644 index 4c10ec86f..000000000 --- a/io.catenax.esr_certificates.esr_certificate_state_statistic/1.0.1/gen/EsrCertificateStateStatistic.html +++ /dev/null @@ -1,663 +0,0 @@ - - - - - - - - - - - - - - Dokumentation ESR Certificate StateS tatistic - - -
-
-
-
-

Aspect Model ESR Certificate StateS tatistic

-
urn:bamm:io.catenax.esr_certificates.esr_certificate_state_statistic:1.0.1#EsrCertificateStateStatistic
-
-
-
-
-
-
-
- -
- - -
- State statistic for an Environmental and Social Responsibility (ESR) certificate -
- - -
-

Übersicht

-
-
-
-
- Aspect Model Diagram -
-
-
- - -
-
-

Properties

-
- -
- -
-

Certificate Name

-
- -Name of the Environmental and Social Responsibility (ESR) certificate - -
-
Name
-
certificateName
-
- - - -
-
Characteristic
-
-
-
-
Enumeration
-
-
-
Werte
-
-
-
-
    -
  • ISO 14001
    • -
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Beispiel
-
ISO 14001
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
certificateName
-
- - -
-
- -
-

Certificate State Statistic

-
- -Environmental and Social Responsibility (ESR) certificate state statistic - -
-
Name
-
certificateStateStatistic
-
- - - -
-
Characteristic
-
-
-
-
SingleEntity
-
-
-
- Typ urn:bamm:io.catenax.esr_certificates.esr_certificate_state_statistic:1.0.1#CertificateStateStatisticEntity - -
-
-
-
-
- - -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
certificateStateStatistic
-
- - -
-
- - - -
-
-

Objekt

-
- -
-
-

CertificateStateStatisticEntity

-
-
- -
- -
-

Properties

-
-
- -
-
Certificates With State Valid
-
- -Number of certificates with state valid - -
-
Name
-
certificatesWithStateValid
-
- - - -
-
Characteristic
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#nonNegativeInteger - -
-
-
-
-
- -
-
Beispiel
-
10
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
certificatesWithStateValid
-
- - -
-
- -
-
Certificates With State Invalid
-
- -Number of certificates with state invalid - -
-
Name
-
certificatesWithStateInvalid
-
- - - -
-
Characteristic
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#nonNegativeInteger - -
-
-
-
-
- -
-
Beispiel
-
11
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
certificatesWithStateInvalid
-
- - -
-
- -
-
Certificates With State Unknown
-
- -Number of certificates with state unknown - -
-
Name
-
certificatesWithStateUnknown
-
- - - -
-
Characteristic
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#nonNegativeInteger - -
-
-
-
-
- -
-
Beispiel
-
3
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
certificatesWithStateUnknown
-
- - -
-
- -
-
Certificates With State Exceptional
-
- -Number of certificates with state exceptional - -
-
Name
-
certificatesWithStateExceptional
-
- - - -
-
Characteristic
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#nonNegativeInteger - -
-
-
-
-
- -
-
Beispiel
-
1
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
certificatesWithStateExceptional
-
- - -
-
-
- -
- Third party licenses - -
- -
- - -
- - - \ No newline at end of file diff --git a/io.catenax.esr_certificates.esr_certificate_state_statistic/1.0.1/gen/EsrCertificateStateStatistic.json b/io.catenax.esr_certificates.esr_certificate_state_statistic/1.0.1/gen/EsrCertificateStateStatistic.json deleted file mode 100644 index 66442ab84..000000000 --- a/io.catenax.esr_certificates.esr_certificate_state_statistic/1.0.1/gen/EsrCertificateStateStatistic.json +++ /dev/null @@ -1,9 +0,0 @@ -{ - "certificateName" : "ISO 14001", - "certificateStateStatistic" : { - "certificatesWithStateValid" : 10, - "certificatesWithStateUnknown" : 3, - "certificatesWithStateExceptional" : 1, - "certificatesWithStateInvalid" : 11 - } -} \ No newline at end of file diff --git a/io.catenax.esr_certificates.esr_certificate_state_statistic/1.0.1/gen/EsrCertificateStateStatistic.yml b/io.catenax.esr_certificates.esr_certificate_state_statistic/1.0.1/gen/EsrCertificateStateStatistic.yml deleted file mode 100644 index 6a61aeb78..000000000 --- a/io.catenax.esr_certificates.esr_certificate_state_statistic/1.0.1/gen/EsrCertificateStateStatistic.yml +++ /dev/null @@ -1,133 +0,0 @@ ---- -openapi: 3.0.3 -info: - title: ESR Certificate StateS tatistic - version: v1 -servers: -- url: catenax.io/api/v1 - variables: - api-version: - default: v1 -paths: - /{tenant-id}/esr-certificate-state-statistic: - get: - tags: - - EsrCertificateStateStatistic - operationId: getEsrCertificateStateStatistic - 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/EsrCertificateStateStatistic' - "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_bamm_io.catenax.esr_certificates.esr_certificate_state_statistic_1.0.1_CertficateName: - type: string - description: String without language tags - enum: - - ISO 14001 - urn_bamm_io.catenax.esr_certificates.esr_certificate_state_statistic_1.0.1_CertificatesWithStateValue: - type: number - minimum: 0 - urn_bamm_io.catenax.esr_certificates.esr_certificate_state_statistic_1.0.1_CertificateStateStatistic: - type: object - properties: - certificatesWithStateValid: - description: Number of certificates with state valid - $ref: '#/components/schemas/urn_bamm_io.catenax.esr_certificates.esr_certificate_state_statistic_1.0.1_CertificatesWithStateValue' - certificatesWithStateInvalid: - description: Number of certificates with state invalid - $ref: '#/components/schemas/urn_bamm_io.catenax.esr_certificates.esr_certificate_state_statistic_1.0.1_CertificatesWithStateValue' - certificatesWithStateUnknown: - description: Number of certificates with state unknown - $ref: '#/components/schemas/urn_bamm_io.catenax.esr_certificates.esr_certificate_state_statistic_1.0.1_CertificatesWithStateValue' - certificatesWithStateExceptional: - description: Number of certificates with state exceptional - $ref: '#/components/schemas/urn_bamm_io.catenax.esr_certificates.esr_certificate_state_statistic_1.0.1_CertificatesWithStateValue' - required: - - certificatesWithStateValid - - certificatesWithStateInvalid - - certificatesWithStateUnknown - - certificatesWithStateExceptional - EsrCertificateStateStatistic: - description: State statistic for an Environmental and Social Responsibility - (ESR) certificate - type: object - properties: - certificateName: - description: Name of the Environmental and Social Responsibility (ESR) certificate - $ref: '#/components/schemas/urn_bamm_io.catenax.esr_certificates.esr_certificate_state_statistic_1.0.1_CertficateName' - certificateStateStatistic: - description: Environmental and Social Responsibility (ESR) certificate state - statistic - $ref: '#/components/schemas/urn_bamm_io.catenax.esr_certificates.esr_certificate_state_statistic_1.0.1_CertificateStateStatistic' - required: - - certificateName - - certificateStateStatistic - 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' - EsrCertificateStateStatistic: - content: - application/json: - schema: - $ref: '#/components/schemas/EsrCertificateStateStatistic' - description: The request was successful. - requestBodies: - EsrCertificateStateStatistic: - content: - application/json: - schema: - $ref: '#/components/schemas/EsrCertificateStateStatistic' diff --git a/io.catenax.esr_certificates.esr_certificate_state_statistic/1.0.1/metadata.json b/io.catenax.esr_certificates.esr_certificate_state_statistic/1.0.1/metadata.json deleted file mode 100644 index 9e759dfb1..000000000 --- a/io.catenax.esr_certificates.esr_certificate_state_statistic/1.0.1/metadata.json +++ /dev/null @@ -1 +0,0 @@ -{ "status" : "deprecate"} diff --git a/io.catenax.essincident/1.0.0/EssIncident.ttl b/io.catenax.essincident/1.0.0/EssIncident.ttl deleted file mode 100644 index 1801ee31e..000000000 --- a/io.catenax.essincident/1.0.0/EssIncident.ttl +++ /dev/null @@ -1,567 +0,0 @@ -####################################################################### -# Copyright (c) 2022 ZF Friedrichshafen AG -# Copyright (c) 2022 T-Systems International GmbH -# Copyright (c) 2022 Robert Bosch Manufacturing Solutions GmbH -# Copyright (c) 2022 Contributors to the Eclipse Foundation -# -# 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 bamm: . -@prefix bamm-c: . -@prefix bamm-e: . -@prefix unit: . -@prefix rdf: . -@prefix rdfs: . -@prefix xsd: . -@prefix : . - -:EssIncident a bamm:Aspect; - bamm:name "EssIncident"; - bamm:properties (:essIncidentInformation :essProductInformation :essCompanyInformation [ - bamm:property :essContactInformation; - bamm:optional "true"^^xsd:boolean -]); - bamm:operations (); - bamm:events (); - bamm:preferredName "ESS Incident"@en; - bamm:description "Aspect for defining an incident in context of Environmental and Social Standards as specified by the Catena-X Sustainability team."@en. -:essIncidentInformation a bamm:Property; - bamm:name "essIncidentInformation"; - bamm:preferredName "ESS Incident Information"@en; - bamm:description "Core information about an incident in context of ESS (Environmental and Social Standards)."@en; - bamm:characteristic :EssIncidentCharacteristic. -:essProductInformation a bamm:Property; - bamm:name "essProductInformation"; - bamm:preferredName "ESS Product Information"@en; - bamm:description "Information about a product/ part/ component which refers to an incident in context of ESS (Environmental and Social Standards)."@en; - bamm:characteristic :EssProductInformationCharacteristic. -:essCompanyInformation a bamm:Property; - bamm:name "essCompanyInformation"; - bamm:preferredName "ESS Company Information"@en; - bamm:description "Information about an originating company of an incident in context of ESS (Environmental and Social Standards)."@en; - bamm:characteristic :EssCompanyInformationCharacteristic. -:essContactInformation a bamm:Property; - bamm:name "essContactInformation"; - bamm:preferredName "ESS Contact Information"@en; - bamm:description "Information about a contact who issued an incident in the context of ESS (Environmental and Social Standards)"@en; - bamm:characteristic :EssContactInformationCharacteristic. -:EssIncidentCharacteristic a bamm-c:SingleEntity; - bamm:name "EssIncidentCharacteristic"; - bamm:preferredName "ESS Incident Characteristic"@en; - bamm:description "Characteristic for defining an incident in context of ESS (Environmental and Social Standards)."@en; - bamm:dataType :EssIncidentInformationEntity. -:EssProductInformationCharacteristic a bamm-c:SingleEntity; - bamm:name "EssProductInformationCharacteristic"; - bamm:preferredName "ESS Product Information Characteristic"@en; - bamm:description "Characteristic for defining the product related information about an incident in context of ESS (Environmental and Social Standards)."@en; - bamm:dataType :EssProductInformationEntity. -:EssCompanyInformationCharacteristic a bamm-c:SingleEntity; - bamm:name "EssCompanyInformationCharacteristic"; - bamm:preferredName "ESS Company Information Characteristic"@en; - bamm:description "Characteristic for defining the originating company information of an incident in context of ESS (Environmental and Social Standards)."@en; - bamm:dataType :EssCompanyInformationEntity. -:EssContactInformationCharacteristic a bamm-c:SingleEntity; - bamm:name "EssContactInformationCharacteristic"; - bamm:preferredName "ESS Contact Information Characteristic"@en; - bamm:description "Characteristic for defining the information about a contact who issued an incident in the context of ESS (Environmental and Social Standards)"@en; - bamm:dataType :EssContactInformationEntity. -:EssIncidentInformationEntity a bamm:Entity; - bamm:name "EssIncidentInformationEntity"; - bamm:properties (:incidentCategory [ - bamm:property :incidentDescription; - bamm:optional "true"^^xsd:boolean -] [ - bamm:property :incidentAttachment; - bamm:optional "true"^^xsd:boolean -] :systemDate [ - bamm:property :incidentDate; - bamm:optional "true"^^xsd:boolean -] [ - bamm:property :incidentDuration; - bamm:optional "true"^^xsd:boolean -] :incidentId :incidentSubcategory [ - bamm:property :incidentHeadline; - bamm:optional "true"^^xsd:boolean -]); - bamm:preferredName "ESS Incident Information Entity"@en; - bamm:description "ESS Incident Information Entity"@en. -:EssProductInformationEntity a bamm:Entity; - bamm:name "EssProductInformationEntity"; - bamm:properties ([ - bamm:property :productCommodity; - bamm:optional "true"^^xsd:boolean -] [ - bamm:property :uniquePartNumber; - bamm:optional "true"^^xsd:boolean -] :productDescription [ - bamm:property :partNumber; - bamm:optional "true"^^xsd:boolean -] [ - bamm:property :batchNumber; - bamm:optional "true"^^xsd:boolean -] [ - bamm:property :rawMaterial; - bamm:optional "true"^^xsd:boolean -] [ - bamm:property :industry; - bamm:optional "true"^^xsd:boolean -]); - bamm:preferredName "ESS Product Information Entity"@en; - bamm:description "ESS Product Information Entity"@en. -:EssCompanyInformationEntity a bamm:Entity; - bamm:name "EssCompanyInformationEntity"; - bamm:properties (:essOriginatorCountry :essOriginatorRegion [ - bamm:property :essOriginatorCoordinates; - bamm:optional "true"^^xsd:boolean -] [ - bamm:property :essOriginatorCompanyName; - bamm:optional "true"^^xsd:boolean -] [ - bamm:property :address; - bamm:optional "true"^^xsd:boolean -] [ - bamm:property :essOriginatorBpnL; - bamm:optional "true"^^xsd:boolean -] [ - bamm:property :essOriginatorCxMember; - bamm:optional "true"^^xsd:boolean -] [ - bamm:property :essOriginatorBpnAvailable; - bamm:optional "true"^^xsd:boolean -] [ - bamm:property :essOriginatorBpnS; - bamm:optional "true"^^xsd:boolean -] [ - bamm:property :essOriginatorBpnA; - bamm:optional "true"^^xsd:boolean -]); - bamm:preferredName "ESS Company Information Entity"@en; - bamm:description "ESS Company Information Entity"@en. -:EssContactInformationEntity a bamm:Entity; - bamm:name "EssContactInformationEntity"; - bamm:properties ([ - bamm:property :contactName; - bamm:optional "true"^^xsd:boolean -] [ - bamm:property :contactMail; - bamm:optional "true"^^xsd:boolean -] [ - bamm:property :contactPhone; - bamm:optional "true"^^xsd:boolean -] [ - bamm:property :address; - bamm:optional "true"^^xsd:boolean -] [ - bamm:property :essIncidentIssuerCompanyName; - bamm:optional "true"^^xsd:boolean -] :issuerId :flagAnonymous); - bamm:preferredName "ESS Contact Information Entity"@en; - bamm:description "ESS Contact Information Entity"@en. -:incidentCategory a bamm:Property; - bamm:name "incidentCategory"; - bamm:preferredName "Incident Category"@en; - bamm:description "Environmental and social standards related incident category according to Supply Chain Due Diligence Act"@en; - bamm:characteristic :IncidentCategoryCharacteristic; - bamm:see ; - bamm:exampleValue "Social". -:incidentDescription a bamm:Property; - bamm:name "incidentDescription"; - bamm:preferredName "Incident Description"@en; - bamm:description "Full text description of an incident in the context of ESS (Environmental and Social Standards)"@en; - bamm:characteristic bamm-c:Text; - bamm:exampleValue "Child labour at production site of the rubber producer in Brazil". -:incidentAttachment a bamm:Property; - bamm:name "incidentAttachment"; - bamm:preferredName "Incident Attachment"@en; - bamm:description "Picture(s) about the reported incident in the context of ESS (Environmental and Social Standards)"@en; - bamm:characteristic bamm-c:ResourcePath. -:systemDate a bamm:Property; - bamm:name "systemDate"; - bamm:preferredName "System Date"@en; - bamm:description "System created time stamp when the incident in the context of ESS (Environmental and Social Standards) was issued and saved"@en; - bamm:characteristic bamm-c:Timestamp; - bamm:exampleValue "2022-08-31T23:22:12Z"^^xsd:dateTime. -:incidentDate a bamm:Property; - bamm:name "incidentDate"; - bamm:preferredName "Date of Incident"@en; - bamm:description "Date and time information about when an incident in the context of ESS (Environmental and Social Standards) occurred"@en; - bamm:characteristic bamm-c:Timestamp; - bamm:exampleValue "2022-08-31T00:00:00Z"^^xsd:dateTime. -:incidentDuration a bamm:Property; - bamm:name "incidentDuration"; - bamm:preferredName "Duration of Incident"@en; - bamm:description "Information about how long an incident in the context of ESS (Environmental and Social Standards) occurred"@en; - bamm:characteristic :IncidentDurationCharacteristic; - bamm:exampleValue "> 1 month". -:incidentId a bamm:Property; - bamm:name "incidentId"; - bamm:preferredName "Incident ID"@en; - bamm:description "Unique identifier for an incident in the context of ESS (Environmental and Social Standards)"@en; - bamm:characteristic :UUIDv4; - bamm:exampleValue "9f47b3c8-b6d4-44f1-99ba-6bdb33916cac". -:incidentSubcategory a bamm:Property; - bamm:name "incidentSubcategory"; - bamm:preferredName "Incident Subcategory"@en; - bamm:description "Incident Subcategory"@en; - bamm:characteristic :IncidentSubcategorySingleEntity. -:incidentHeadline a bamm:Property; - bamm:name "incidentHeadline"; - bamm:preferredName "Incident Headline"@en; - bamm:description "Title/ subject of an incident in the context of ESS (Environmental and Social Standards)"@en; - bamm:characteristic bamm-c:Text; - bamm:exampleValue "Child labour on a rubber producer". -:productCommodity a bamm:Property; - bamm:name "productCommodity"; - bamm:preferredName "Product Commodity"@en; - bamm:description "Free-text description for commodity of a product affected by an incident in the context of ESS (Environmental and Social Standards)"@en; - bamm:characteristic bamm-c:Text; - bamm:exampleValue "Tire". -:uniquePartNumber a bamm:Property; - bamm:name "uniquePartNumber"; - bamm:preferredName "Unique Part Number"@en; - bamm:description "Serial product/ part/ component number as defined by a unique identifier in Catena-X that is affected by an incident in the context of ESS (Environmental and Social Standards)"@en; - bamm:characteristic :CatenaXIdTrait; - bamm:exampleValue "580d3adf-1981-44a0-a214-13d6ceed9379". -:productDescription a bamm:Property; - bamm:name "productDescription"; - bamm:preferredName "Product Description"@en; - bamm:description "Description of product or component affected by an incident in the context of ESS (Environmental and Social Standards) "@en; - bamm:characteristic bamm-c:Text; - bamm:exampleValue "Natural Rubber". -:partNumber a bamm:Property; - bamm:name "partNumber"; - bamm:preferredName "Part Number"@en; - bamm:description "Part number that is affected by an incident in the context of ESS (Environmental and Social Standards) "@en; - bamm:characteristic bamm-c:Text; - bamm:exampleValue "EX123M234". -:batchNumber a bamm:Property; - bamm:name "batchNumber"; - bamm:preferredName "Batch Number"@en; - bamm:description "Batch number that is affected by an incident in the context of ESS (Environmental and Social Standards)"@en; - bamm:characteristic bamm-c:Text; - bamm:exampleValue "CH122535MXD". -:rawMaterial a bamm:Property; - bamm:name "rawMaterial"; - bamm:preferredName "Raw Material"@en; - bamm:description "Raw material that causes an incident in the context of ESS (Environmental and Social Standards)"@en; - bamm:characteristic bamm-c:Text; - bamm:exampleValue "Natural Rubber". -:industry a bamm:Property; - bamm:name "industry"; - bamm:preferredName "Industry / Branch"@en; - bamm:description "Industry / Branch that causes the incident"@en; - bamm:characteristic :IndustryCharacteristic; - bamm:exampleValue "Extraction of raw material". -:essOriginatorCountry a bamm:Property; - bamm:name "essOriginatorCountry"; - bamm:preferredName "ESS Originator Country"@en; - bamm:description "Country to which an incident in the context of ESS (Environmental and Social Standards) belongs"@en; - bamm:characteristic :EssOriginatorCountryTrait; - bamm:exampleValue "BR". -:essOriginatorRegion a bamm:Property; - bamm:name "essOriginatorRegion"; - bamm:preferredName "ESS Originator Region"@en; - bamm:description "Region within a country to which an incident in the context of ESS (Environmental and Social Standards) belongs"@en; - bamm:characteristic :EssOriginatorRegionTrait; - bamm:exampleValue "BR-AM". -:essOriginatorCoordinates a bamm:Property; - bamm:name "essOriginatorCoordinates"; - bamm:preferredName "ESS Originator Geographic data / Coordinates"@en; - bamm:description "Exact geographic position of an incident in the context of ESS (Environmental and Social Standards)"@en; - bamm:characteristic :EssOriginatorCoordinatesCharacteristic. -:essOriginatorCompanyName a bamm:Property; - bamm:name "essOriginatorCompanyName"; - bamm:preferredName "ESS Originator Company Name"@en; - bamm:description "Name of a company/ an organisation that is the originator of an incident in the context of ESS (Environmental and Social Standards)"@en; - bamm:characteristic bamm-c:Text; - bamm:exampleValue "Rubbery Ltd.". -:address a bamm:Property; - bamm:name "address"; - bamm:preferredName "Address"@en; - bamm:description "Simple form of an address which can belong to a person, organisation, company etc."@en; - bamm:characteristic :AddressCharacteristic. -:essOriginatorBpnL a bamm:Property; - bamm:name "essOriginatorBpnL"; - bamm:preferredName "ESS Originator BPN-L"@en; - bamm:description "BPN-L ID of the company headquarter that causes the incident"@en; - bamm:characteristic :EssOriginatorBpnCharacteristic. -:essOriginatorCxMember a bamm:Property; - bamm:name "essOriginatorCxMember"; - bamm:preferredName "ESS Originator CX Member"@en; - bamm:description "Return flag (y/n) that company that causes the ESS incident is a CX member (or not)"@en; - bamm:characteristic bamm-c:Boolean; - bamm:exampleValue "true"^^xsd:boolean. -:essOriginatorBpnAvailable a bamm:Property; - bamm:name "essOriginatorBpnAvailable"; - bamm:preferredName "ESs Originator BPN available"@en; - bamm:description "Return flag (y/n) that company that causes the ESS incident has a BPN-L/-S/-A in CX (but no CX membership)"@en; - bamm:characteristic bamm-c:Boolean; - bamm:exampleValue "true"^^xsd:boolean. -:essOriginatorBpnS a bamm:Property; - bamm:name "essOriginatorBpnS"; - bamm:preferredName "ESS Originator BPN-S"@en; - bamm:description "BPN-S ID of the company headquarter that causes the incident"@en; - bamm:characteristic :EssOriginatorBpnCharacteristic. -:essOriginatorBpnA a bamm:Property; - bamm:name "essOriginatorBpnA"; - bamm:preferredName "ESS Originator BPN A"@en; - bamm:description "BPN-A ID of the company headquarter that causes the incident"@en; - bamm:characteristic :EssOriginatorBpnCharacteristic. -:contactName a bamm:Property; - bamm:name "contactName"; - bamm:preferredName "Contact Name"@en; - bamm:description "Name of a contact."@en; - bamm:characteristic bamm-c:Text; - bamm:exampleValue "Testuser". -:contactMail a bamm:Property; - bamm:name "contactMail"; - bamm:preferredName "Contact Mail"@en; - bamm:description "Mail address of a contact"@en; - bamm:characteristic :ContactMailTrait; - bamm:exampleValue "test@example.com". -:contactPhone a bamm:Property; - bamm:name "contactPhone"; - bamm:preferredName "Contact Phone"@en; - bamm:description "Phone number of a contact."@en; - bamm:characteristic bamm-c:Text; - bamm:exampleValue "+49-123-456789". -:essIncidentIssuerCompanyName a bamm:Property; - bamm:name "essIncidentIssuerCompanyName"; - bamm:preferredName "ESS Incident Issuer Company Name"@en; - bamm:description "Company name of incident issuer"@en; - bamm:characteristic bamm-c:Text; - bamm:exampleValue "UNICEF". -:IncidentCategoryCharacteristic a bamm-c:Enumeration; - bamm:name "IncidentCategoryCharacteristic"; - bamm:preferredName "Incident Category Characteristic"@en; - bamm:description "Characteristic for defining an incident category in the context of ESS (Environmental and Social Standards)."@en; - bamm:dataType xsd:string; - bamm-c:values ("Environmental" "Social"). -:IncidentDurationCharacteristic a bamm-c:Enumeration; - bamm:name "IncidentDurationCharacteristic"; - bamm:preferredName "Incident Duration Characteristic"@en; - bamm:description "Characteristic for defining the duration of an incident in context of ESS (Environmental and Social Standards)."@en; - bamm:dataType xsd:string; - bamm-c:values ("1 week" "> 1 month" "> 6 months" "> 1 year"). -:UUIDv4 a bamm:Characteristic; - bamm:name "UUIDv4"; - bamm:preferredName "UUIDv4"@en; - bamm:description "A version 4 UUID is a universally unique identifier generated using random 32 hexadecimal characters."@en; - bamm:dataType xsd:string. -:IncidentSubcategorySingleEntity a bamm-c:SingleEntity; - bamm:name "IncidentSubcategorySingleEntity"; - bamm:preferredName "Incident Subcategory Single Entity"@en; - bamm:description "Incident Subcategory Single Entity"@en; - bamm:dataType :IncidentSubcategoryEntity. -:CatenaXIdTrait a bamm-c:Trait; - bamm:name "CatenaXIdTrait"; - bamm:preferredName "CatenaXIdTrait"@en; - bamm:description "Trait to ensure data format for Catena-X ID."@en; - bamm-c:baseCharacteristic :UUIDv4; - bamm-c:constraint :UUIDv4RegularExpression. -:IndustryCharacteristic a bamm-c:Enumeration; - bamm:name "IndustryCharacteristic"; - bamm:preferredName "Industry characteristic"@en; - bamm:description "Industry Characteristic"@en; - bamm:dataType xsd:string; - bamm-c:values ("Extraction of raw materials" "Manufacture of components / intermediates" "Manufacture of final products" "Distribution / Trade" "Waste treatment / recycling" "Services" "Lending / financing / insurance" "Other"). -:EssOriginatorCountryTrait a bamm-c:Trait; - bamm:name "EssOriginatorCountryTrait"; - bamm:preferredName "ESS Originator Country Trait"@en; - bamm:description "Trait for defining a country as specified by ISO 3166CC."@en; - bamm-c:baseCharacteristic :EssOriginatorCountryCharacteristic; - bamm-c:constraint :EssOriginatorCountryConstraint. -:EssOriginatorRegionTrait a bamm-c:Trait; - bamm:name "EssOriginatorRegionTrait"; - bamm:preferredName "ESS Originator Region Trait"@en; - bamm:description "Trait for a region within a country as defined in ISO 3166-2."@en; - bamm-c:baseCharacteristic :EssOriginatorRegionCharacteristic; - bamm-c:constraint :EssOriginatorRegionConstraint. -:EssOriginatorCoordinatesCharacteristic a bamm-c:SingleEntity; - bamm:name "EssOriginatorCoordinatesCharacteristic"; - bamm:preferredName "ESS Originator Coordinates Characteristic"@en; - bamm:description "Characteristic for defining geographic coordinates (longitude and latitude) of an incident originator in context of ESS (Environmental and Social Standards)."@en; - bamm:dataType :EssOriginatorCoordinatesEntity. -:AddressCharacteristic a bamm-c:SingleEntity; - bamm:name "AddressCharacteristic"; - bamm:preferredName "Address Characteristic"@en; - bamm:description "Characteristic for defining an address which can belong to a person, an orginisation a company or any other."@en; - bamm:dataType :AddressEntity. -:EssOriginatorBpnCharacteristic a bamm-c:SingleEntity; - bamm:name "EssOriginatorBpnCharacteristic"; - bamm:preferredName "Ess Originator BPN Characteristic"@en; - bamm:description "Ess Originator BPN Characteristic"@en; - bamm:dataType :BpnEntity. -:ContactMailTrait a bamm-c:Trait; - bamm:name "ContactMailTrait"; - bamm:preferredName "Contact Mail Trait"@en; - bamm:description "Trait for a contact mail address."@en; - bamm-c:baseCharacteristic bamm-c:Text; - bamm-c:constraint :ContactMailConstraint. -:IncidentSubcategoryEntity a bamm:Entity; - bamm:name "IncidentSubcategoryEntity"; - bamm:properties (:incidentSubcategoryProperty); - bamm:preferredName "Incident Subcategory Entity"@en; - bamm:description "Incident Subcategory Entity"@en. -:UUIDv4RegularExpression a bamm-c:RegularExpressionConstraint; - bamm:name "UUIDv4RegularExpression"; - bamm:preferredName "UUIDv4RegularExpression"@en; - bamm: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)."@en; - bamm:value "^[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}$". -:EssOriginatorCountryCharacteristic a bamm:Characteristic; - bamm:name "EssOriginatorCountryCharacteristic"; - bamm:preferredName "ESS Originator Country Characteristic"@en; - bamm:description "Characteristic for defining a country to which an incident in context of ESS (Environmental and Social Standards) belongs."@en; - bamm:dataType xsd:string. -:EssOriginatorCountryConstraint a bamm-c:RegularExpressionConstraint; - bamm:name "EssOriginatorCountryConstraint"; - bamm:preferredName "ESS Originator Country Constraint"@en; - bamm:description "Constraint for defining a geography country conform to ISO 3166CC."@en; - bamm:value "([A-Z]{2})". -:EssOriginatorRegionCharacteristic a bamm:Characteristic; - bamm:name "EssOriginatorRegionCharacteristic"; - bamm:preferredName "ESS Originator Region Characteristic"@en; - bamm:description "Characteristic for defining a region within a country for an originator of an incident in context of ESS (Environmental and Social Standards)."@en; - bamm:dataType xsd:string. -:EssOriginatorRegionConstraint a bamm-c:RegularExpressionConstraint; - bamm:name "EssOriginatorRegionConstraint"; - bamm:preferredName "ESS Originator Region Constraint"@en; - bamm:description "Constraint for defining a region within a country in compliance to ISO 3166-2."@en; - bamm:value "([A-Z]{2}-[A-Z0-9]{1,3}|)". -:EssOriginatorCoordinatesEntity a bamm:Entity; - bamm:name "EssOriginatorCoordinatesEntity"; - bamm:properties (:longitude :latitude); - bamm:preferredName "ESS Originator Coordinates Entity"@en; - bamm:description "Entity for geographic coordinates including a longitude and a latitude value."@en. -:AddressEntity a bamm:Entity; - bamm:name "AddressEntity"; - bamm:properties (:street :zip :city); - bamm:preferredName "Address Entity"@en; - bamm:description "Entity for defining an address in a simple form."@en. -:BpnEntity a bamm:Entity; - bamm:name "BpnEntity"; - bamm:properties (:bpnProperty); - bamm:preferredName "BPN (Business Partner Number) Entity"@en; - bamm:description "Internal or external juristic, a company that is having a business relation with another Business Partner"@en. -:ContactMailConstraint a bamm-c:RegularExpressionConstraint; - bamm:name "ContactMailConstraint"; - bamm:preferredName "Contact Mail Constraint"@en; - bamm:description "Regular expression for a contact mail address."@en; - bamm:value "^[a-zA-Z0-9.!#$%&’*+\\\\/=?^_`{|}~-]+@[a-zA-Z0-9-]+(?:\\\\.[a-zA-Z0-9-]+)*$". -:incidentSubcategoryProperty a bamm:Property; - bamm:name "incidentSubcategoryProperty"; - bamm:preferredName "Incident Subcategory Property"@en; - bamm:description "Incident Subcategory Property"@en; - bamm:characteristic :IncidentSubcategories; - bamm:exampleValue "Child labour". -:longitude a bamm:Property; - bamm:name "longitude"; - bamm:preferredName "Longitude"@en; - bamm:description "Longitude information for geographic coordinates."@en; - bamm:characteristic :LongitudeTrait; - bamm:exampleValue "-79.517415". -:latitude a bamm:Property; - bamm:name "latitude"; - bamm:preferredName "Latitude"@en; - bamm:description "Latitude information for geographic coordinates."@en; - bamm:characteristic :LatitudeTrait; - bamm:exampleValue "-5.4220777". -:street a bamm:Property; - bamm:name "street"; - bamm:preferredName "Street"@en; - bamm:description "Street name (and number) belonging to an address"@en; - bamm:characteristic bamm-c:Text; - bamm:exampleValue "Main Road 1". -:zip a bamm:Property; - bamm:name "zip"; - bamm:preferredName "Zip"@en; - bamm:description "Zip code belonging to an address"@en; - bamm:characteristic bamm-c:Text; - bamm:exampleValue "12345". -:city a bamm:Property; - bamm:name "city"; - bamm:preferredName "City"@en; - bamm:description "Name of a city belonging to an address."@en; - bamm:characteristic bamm-c:Text; - bamm:exampleValue "Model City". -:bpnProperty a bamm:Property; - bamm:name "bpnProperty"; - bamm:preferredName "BPN Property"@en; - bamm:description "BPN Property"@en; - bamm:characteristic :BPN; - bamm:exampleValue "BPNL1234567890ZZ". -:IncidentSubcategories a bamm-c:Enumeration; - bamm:name "IncidentSubcategories"; - bamm:preferredName "Incident Subcategories"@en; - bamm:description "Characteristic for defining subcategories of an incident in the context of ESS (Environmental and Social Standards)."@en; - bamm:dataType xsd:string; - bamm-c:values ("Child labour" "Forced labour" "Slavery" "Work safety" "Freedom of association" "Discrimination" "Minimum wage" "Environmental pollution" "Forced eviction" "Force by state security" "Usage of Mercury" "Usage of harmful chemicals" "Non-environmental friendly handling of waste" "Import and export of hazardous waste"). -:LongitudeTrait a bamm-c:Trait; - bamm:name "LongitudeTrait"; - bamm:preferredName "Longitude Trait"@en; - bamm:description "Trait for longitude information belonging to geographic coordinates."@en; - bamm-c:baseCharacteristic :LongitudeCharacteristic; - bamm-c:constraint :LongitudeConstraint. -:LatitudeTrait a bamm-c:Trait; - bamm:name "LatitudeTrait"; - bamm:preferredName "Latitude Trait"@en; - bamm:description "Trait for latitude information belonging to geographic coordinates."@en; - bamm-c:baseCharacteristic :LatitudeCharacteristic; - bamm-c:constraint :LatitudeConstraint. -:LongitudeCharacteristic a bamm:Characteristic; - bamm:name "LongitudeCharacteristic"; - bamm:preferredName "Longitude Characteristic"@en; - bamm:description "Characteristic for longitude information of geographic coordinates."@en; - bamm:dataType xsd:string. -:LongitudeConstraint a bamm-c:RegularExpressionConstraint; - bamm:name "LongitudeConstraint"; - bamm:preferredName "Longitude Constraint"@en; - bamm:description "Regular expression for longitude information."@en; - bamm:value "^(\\+|-)?(?:180(?:(?:\\.0{1,6})?)|(?:[0-9]|[1-9][0-9]|1[0-7][0-9])(?:(?:\\.[0-9]{1,6})?))$". -:LatitudeCharacteristic a bamm:Characteristic; - bamm:name "LatitudeCharacteristic"; - bamm:preferredName "Latitude Characteristic"@en; - bamm:description "Characteristic for latitude information of geographic coordinates."@en; - bamm:dataType xsd:string. -:LatitudeConstraint a bamm-c:RegularExpressionConstraint; - bamm:name "LatitudeConstraint"; - bamm:preferredName "Latitude Constraint"@en; - bamm:description "Regular expression for latitude information of geographic coordinates."@en; - bamm:value "^(\\+|-)?(?:90(?:(?:\\.0{1,6})?)|(?:[0-9]|[1-8][0-9])(?:(?:\\.[0-9]{1,6})?))$". -:BPN a bamm-c:Trait; - bamm:name "BPN"; - bamm:preferredName "BPN Business Partner Number"@en; - bamm:description "BPN Business Partner Number"@en; - bamm-c:baseCharacteristic :BpnCharacteristic; - bamm-c:constraint :BpnConstraint. -:BpnCharacteristic a bamm:Characteristic; - bamm:name "BpnCharacteristic"; - bamm:preferredName "BPN Characteristic"@en; - bamm:description "BPN Characteristic"@en; - bamm:dataType xsd:string. -:BpnConstraint a bamm-c:RegularExpressionConstraint; - bamm:name "BpnConstraint"; - bamm:preferredName "BPN Constraint"@en; - bamm:description "Business Partner Number Contraint"@en; - bamm:value "^(BPN)(L|S|A)(\\\\d{8})([a-zA-Z0-9]{4})$". -:issuerId a bamm:Property; - bamm:name "issuerId"; - bamm:preferredName "Issuer ID"@en; - bamm:description "System generated unique identifier of incident issuer"@en; - bamm:characteristic :UUIDv4; - bamm:exampleValue "9a47b3c8-b6d4-44f1-99ba-6bdb33916cac". -:flagAnonymous a bamm:Property; - bamm:name "flagAnonymous"; - bamm:preferredName "Flag anonymous"@en; - bamm:description "Flag that Incident issuer wants to be anonymous"@en; - bamm:characteristic bamm-c:Boolean; - bamm:exampleValue "false"^^xsd:boolean. diff --git a/io.catenax.essincident/1.0.0/gen/EssIncident-aas.xml b/io.catenax.essincident/1.0.0/gen/EssIncident-aas.xml deleted file mode 100644 index ee83f95c1..000000000 --- a/io.catenax.essincident/1.0.0/gen/EssIncident-aas.xml +++ /dev/null @@ -1,3673 +0,0 @@ - - - - - defaultAdminShell - - - en - defaultAdminShell - - - - urn:samm:io.catenax.essincident:1.0.0#EssIncident - - Type - - - - ModelReference - - - Submodel - urn:samm:io.catenax.essincident:1.0.0#EssIncident/submodel - - - - - - - - - EssIncident - - - en - Aspect for defining an incident in context of Environmental and Social Standards as specified by the Catena-X Sustainability team. - - - - urn:samm:io.catenax.essincident:1.0.0#EssIncident/submodel - Template - - ModelReference - - - ConceptDescription - urn:samm:io.catenax.essincident:1.0.0#EssIncident - - - - - - EssIncidentInformationEntity - - - en - ESS Incident Information Entity - - - - - en - ESS Incident Information Entity - - - - - incidentCategory - - - en - Incident Category - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.essincident:1.0.0#incidentCategory - - - - - - ExternalReference - - - GlobalReference - https://www.gesetze-im-internet.de/lksg/ - - - - - xs:string - - - - incidentDescription - - - en - Incident Description - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.essincident:1.0.0#incidentDescription - - - - xs:string - - - - incidentAttachment - - - en - Incident Attachment - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.essincident:1.0.0#incidentAttachment - - - - xs:anyURI - - - - systemDate - - - en - System Date - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.essincident:1.0.0#systemDate - - - - xs:dateTime - - - - incidentDate - - - en - Date of Incident - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.essincident:1.0.0#incidentDate - - - - xs:dateTime - - - - incidentDuration - - - en - Duration of Incident - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.essincident:1.0.0#incidentDuration - - - - xs:string - - - - incidentId - - - en - Incident ID - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.essincident:1.0.0#incidentId - - - - xs:string - - - - IncidentSubcategoryEntity - - - en - Incident Subcategory Entity - - - - - en - Incident Subcategory Entity - - - - - incidentSubcategoryProperty - - - en - Incident Subcategory Property - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.essincident:1.0.0#incidentSubcategoryProperty - - - - xs:string - - - - - - incidentHeadline - - - en - Incident Headline - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.essincident:1.0.0#incidentHeadline - - - - xs:string - - - - - - EssProductInformationEntity - - - en - ESS Product Information Entity - - - - - en - ESS Product Information Entity - - - - - productCommodity - - - en - Product Commodity - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.essincident:1.0.0#productCommodity - - - - xs:string - - - - uniquePartNumber - - - en - Unique Part Number - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.essincident:1.0.0#uniquePartNumber - - - - xs:string - - - - productDescription - - - en - Product Description - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.essincident:1.0.0#productDescription - - - - xs:string - - - - partNumber - - - en - Part Number - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.essincident:1.0.0#partNumber - - - - xs:string - - - - batchNumber - - - en - Batch Number - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.essincident:1.0.0#batchNumber - - - - xs:string - - - - rawMaterial - - - en - Raw Material - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.essincident:1.0.0#rawMaterial - - - - xs:string - - - - industry - - - en - Industry / Branch - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.essincident:1.0.0#industry - - - - xs:string - - - - - - EssCompanyInformationEntity - - - en - ESS Company Information Entity - - - - - en - ESS Company Information Entity - - - - - essOriginatorCountry - - - en - ESS Originator Country - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.essincident:1.0.0#essOriginatorCountry - - - - xs:string - - - - essOriginatorRegion - - - en - ESS Originator Region - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.essincident:1.0.0#essOriginatorRegion - - - - xs:string - - - - EssOriginatorCoordinatesEntity - - - en - ESS Originator Coordinates Entity - - - - - en - Entity for geographic coordinates including a longitude and a latitude value. - - - - - longitude - - - en - Longitude - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.essincident:1.0.0#longitude - - - - xs:string - - - - latitude - - - en - Latitude - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.essincident:1.0.0#latitude - - - - xs:string - - - - - - essOriginatorCompanyName - - - en - ESS Originator Company Name - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.essincident:1.0.0#essOriginatorCompanyName - - - - xs:string - - - - AddressEntity - - - en - Address Entity - - - - - en - Entity for defining an address in a simple form. - - - - - street - - - en - Street - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.essincident:1.0.0#street - - - - xs:string - - - - zip - - - en - Zip - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.essincident:1.0.0#zip - - - - xs:string - - - - city - - - en - City - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.essincident:1.0.0#city - - - - xs:string - - - - - - BpnEntity - - - en - BPN (Business Partner Number) Entity - - - - - en - Internal or external juristic, a company that is having a business relation with another Business Partner - - - - - bpnProperty - - - en - BPN Property - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.essincident:1.0.0#bpnProperty - - - - xs:string - - - - - - essOriginatorCxMember - - - en - ESS Originator CX Member - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.essincident:1.0.0#essOriginatorCxMember - - - - xs:boolean - - - - essOriginatorBpnAvailable - - - en - ESs Originator BPN available - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.essincident:1.0.0#essOriginatorBpnAvailable - - - - xs:boolean - - - - BpnEntity - - - en - BPN (Business Partner Number) Entity - - - - - en - Internal or external juristic, a company that is having a business relation with another Business Partner - - - - - bpnProperty - - - en - BPN Property - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.essincident:1.0.0#bpnProperty - - - - xs:string - - - - - - BpnEntity - - - en - BPN (Business Partner Number) Entity - - - - - en - Internal or external juristic, a company that is having a business relation with another Business Partner - - - - - bpnProperty - - - en - BPN Property - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.essincident:1.0.0#bpnProperty - - - - xs:string - - - - - - - - EssContactInformationEntity - - - en - ESS Contact Information Entity - - - - - en - ESS Contact Information Entity - - - - - contactName - - - en - Contact Name - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.essincident:1.0.0#contactName - - - - xs:string - - - - contactMail - - - en - Contact Mail - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.essincident:1.0.0#contactMail - - - - xs:string - - - - contactPhone - - - en - Contact Phone - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.essincident:1.0.0#contactPhone - - - - xs:string - - - - AddressEntity - - - en - Address Entity - - - - - en - Entity for defining an address in a simple form. - - - - - street - - - en - Street - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.essincident:1.0.0#street - - - - xs:string - - - - zip - - - en - Zip - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.essincident:1.0.0#zip - - - - xs:string - - - - city - - - en - City - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.essincident:1.0.0#city - - - - xs:string - - - - - - essIncidentIssuerCompanyName - - - en - ESS Incident Issuer Company Name - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.essincident:1.0.0#essIncidentIssuerCompanyName - - - - xs:string - - - - issuerId - - - en - Issuer ID - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.essincident:1.0.0#issuerId - - - - xs:string - - - - flagAnonymous - - - en - Flag anonymous - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.essincident:1.0.0#flagAnonymous - - - - xs:boolean - - - - - - - - - - APPLICATION_CLASS - EssIncident - - - en - ESS Incident - - - - - en - Aspect for defining an incident in context of Environmental and Social Standards as specified by the Catena-X Sustainability team. - - - urn:samm:io.catenax.essincident:1.0.0#EssIncident - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - ESS Incident - - - - - en - EssIncident - - - - - en - Aspect for defining an incident in context of Environmental and Social Standards as specified by the Catena-X Sustainability team. - - - - - - - - - incidentCategory - - - en - Incident Category - - - urn:samm:io.catenax.essincident:1.0.0#incidentCategory - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Incident Category - - - - - en - incidentCategory - - - STRING - - - en - Environmental and social standards related incident category according to Supply Chain Due Diligence Act - - - - - - Environmental - - ModelReference - - - DataElement - urn:samm:io.catenax.essincident:1.0.0#IncidentCategoryCharacteristic:Environmental - - - - - - Social - - ModelReference - - - DataElement - urn:samm:io.catenax.essincident:1.0.0#IncidentCategoryCharacteristic:Social - - - - - - - - - - - - - incidentDescription - - - en - Incident Description - - - urn:samm:io.catenax.essincident:1.0.0#incidentDescription - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Incident Description - - - - - en - incidentDescription - - - STRING - - - en - Full text description of an incident in the context of ESS (Environmental and Social Standards) - - - - - - - - - incidentAttachment - - - en - Incident Attachment - - - urn:samm:io.catenax.essincident:1.0.0#incidentAttachment - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Incident Attachment - - - - - en - incidentAttachment - - - STRING - - - en - Picture(s) about the reported incident in the context of ESS (Environmental and Social Standards) - - - - - - - - - systemDate - - - en - System Date - - - urn:samm:io.catenax.essincident:1.0.0#systemDate - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - System Date - - - - - en - systemDate - - - STRING - - - en - System created time stamp when the incident in the context of ESS (Environmental and Social Standards) was issued and saved - - - - - - - - - incidentDate - - - en - Date of Incident - - - urn:samm:io.catenax.essincident:1.0.0#incidentDate - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Date of Incident - - - - - en - incidentDate - - - STRING - - - en - Date and time information about when an incident in the context of ESS (Environmental and Social Standards) occurred - - - - - - - - - incidentDuration - - - en - Duration of Incident - - - urn:samm:io.catenax.essincident:1.0.0#incidentDuration - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Duration of Incident - - - - - en - incidentDuration - - - STRING - - - en - Information about how long an incident in the context of ESS (Environmental and Social Standards) occurred - - - - - - 1 week - - ModelReference - - - DataElement - urn:samm:io.catenax.essincident:1.0.0#IncidentDurationCharacteristic:1 week - - - - - - > 1 month - - ModelReference - - - DataElement - urn:samm:io.catenax.essincident:1.0.0#IncidentDurationCharacteristic:> 1 month - - - - - - > 6 months - - ModelReference - - - DataElement - urn:samm:io.catenax.essincident:1.0.0#IncidentDurationCharacteristic:> 6 months - - - - - - > 1 year - - ModelReference - - - DataElement - urn:samm:io.catenax.essincident:1.0.0#IncidentDurationCharacteristic:> 1 year - - - - - - - - - - - - - incidentId - - - en - Incident ID - - - urn:samm:io.catenax.essincident:1.0.0#incidentId - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Incident ID - - - - - en - incidentId - - - STRING - - - en - Unique identifier for an incident in the context of ESS (Environmental and Social Standards) - - - - - - - - - incidentSubcategoryProperty - - - en - Incident Subcategory Property - - - urn:samm:io.catenax.essincident:1.0.0#incidentSubcategoryProperty - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Incident Subcategory Property - - - - - en - incidentSubcategoryProperty - - - STRING - - - en - Incident Subcategory Property - - - - - - Child labour - - ModelReference - - - DataElement - urn:samm:io.catenax.essincident:1.0.0#IncidentSubcategories:Child labour - - - - - - Forced labour - - ModelReference - - - DataElement - urn:samm:io.catenax.essincident:1.0.0#IncidentSubcategories:Forced labour - - - - - - Slavery - - ModelReference - - - DataElement - urn:samm:io.catenax.essincident:1.0.0#IncidentSubcategories:Slavery - - - - - - Work safety - - ModelReference - - - DataElement - urn:samm:io.catenax.essincident:1.0.0#IncidentSubcategories:Work safety - - - - - - Freedom of association - - ModelReference - - - DataElement - urn:samm:io.catenax.essincident:1.0.0#IncidentSubcategories:Freedom of association - - - - - - Discrimination - - ModelReference - - - DataElement - urn:samm:io.catenax.essincident:1.0.0#IncidentSubcategories:Discrimination - - - - - - Minimum wage - - ModelReference - - - DataElement - urn:samm:io.catenax.essincident:1.0.0#IncidentSubcategories:Minimum wage - - - - - - Environmental pollution - - ModelReference - - - DataElement - urn:samm:io.catenax.essincident:1.0.0#IncidentSubcategories:Environmental pollution - - - - - - Forced eviction - - ModelReference - - - DataElement - urn:samm:io.catenax.essincident:1.0.0#IncidentSubcategories:Forced eviction - - - - - - Force by state security - - ModelReference - - - DataElement - urn:samm:io.catenax.essincident:1.0.0#IncidentSubcategories:Force by state security - - - - - - Usage of Mercury - - ModelReference - - - DataElement - urn:samm:io.catenax.essincident:1.0.0#IncidentSubcategories:Usage of Mercury - - - - - - Usage of harmful chemicals - - ModelReference - - - DataElement - urn:samm:io.catenax.essincident:1.0.0#IncidentSubcategories:Usage of harmful chemicals - - - - - - Non-environmental friendly handling of waste - - ModelReference - - - DataElement - urn:samm:io.catenax.essincident:1.0.0#IncidentSubcategories:Non-environmental friendly handling of waste - - - - - - Import and export of hazardous waste - - ModelReference - - - DataElement - urn:samm:io.catenax.essincident:1.0.0#IncidentSubcategories:Import and export of hazardous waste - - - - - - - - - - - - - incidentSubcategory - - - en - Incident Subcategory - - - urn:samm:io.catenax.essincident:1.0.0#incidentSubcategory - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Incident Subcategory - - - - - en - incidentSubcategory - - - STRING - - - en - Incident Subcategory - - - - - - - - - incidentHeadline - - - en - Incident Headline - - - urn:samm:io.catenax.essincident:1.0.0#incidentHeadline - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Incident Headline - - - - - en - incidentHeadline - - - STRING - - - en - Title/ subject of an incident in the context of ESS (Environmental and Social Standards) - - - - - - - - - essIncidentInformation - - - en - ESS Incident Information - - - urn:samm:io.catenax.essincident:1.0.0#essIncidentInformation - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - ESS Incident Information - - - - - en - essIncidentInformation - - - STRING - - - en - Core information about an incident in context of ESS (Environmental and Social Standards). - - - - - - - - - productCommodity - - - en - Product Commodity - - - urn:samm:io.catenax.essincident:1.0.0#productCommodity - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Product Commodity - - - - - en - productCommodity - - - STRING - - - en - Free-text description for commodity of a product affected by an incident in the context of ESS (Environmental and Social Standards) - - - - - - - - - uniquePartNumber - - - en - Unique Part Number - - - urn:samm:io.catenax.essincident:1.0.0#uniquePartNumber - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Unique Part Number - - - - - en - uniquePartNumber - - - STRING - - - en - Serial product/ part/ component number as defined by a unique identifier in Catena-X that is affected by an incident in the context of ESS (Environmental and Social Standards) - - - - - - - - - productDescription - - - en - Product Description - - - urn:samm:io.catenax.essincident:1.0.0#productDescription - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Product Description - - - - - en - productDescription - - - STRING - - - en - Description of product or component affected by an incident in the context of ESS (Environmental and Social Standards) - - - - - - - - - partNumber - - - en - Part Number - - - urn:samm:io.catenax.essincident:1.0.0#partNumber - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Part Number - - - - - en - partNumber - - - STRING - - - en - Part number that is affected by an incident in the context of ESS (Environmental and Social Standards) - - - - - - - - - batchNumber - - - en - Batch Number - - - urn:samm:io.catenax.essincident:1.0.0#batchNumber - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Batch Number - - - - - en - batchNumber - - - STRING - - - en - Batch number that is affected by an incident in the context of ESS (Environmental and Social Standards) - - - - - - - - - rawMaterial - - - en - Raw Material - - - urn:samm:io.catenax.essincident:1.0.0#rawMaterial - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Raw Material - - - - - en - rawMaterial - - - STRING - - - en - Raw material that causes an incident in the context of ESS (Environmental and Social Standards) - - - - - - - - - industry - - - en - Industry / Branch - - - urn:samm:io.catenax.essincident:1.0.0#industry - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Industry / Branch - - - - - en - industry - - - STRING - - - en - Industry / Branch that causes the incident - - - - - - Extraction of raw materials - - ModelReference - - - DataElement - urn:samm:io.catenax.essincident:1.0.0#IndustryCharacteristic:Extraction of raw materials - - - - - - Manufacture of components / intermediates - - ModelReference - - - DataElement - urn:samm:io.catenax.essincident:1.0.0#IndustryCharacteristic:Manufacture of components / intermediates - - - - - - Manufacture of final products - - ModelReference - - - DataElement - urn:samm:io.catenax.essincident:1.0.0#IndustryCharacteristic:Manufacture of final products - - - - - - Distribution / Trade - - ModelReference - - - DataElement - urn:samm:io.catenax.essincident:1.0.0#IndustryCharacteristic:Distribution / Trade - - - - - - Waste treatment / recycling - - ModelReference - - - DataElement - urn:samm:io.catenax.essincident:1.0.0#IndustryCharacteristic:Waste treatment / recycling - - - - - - Services - - ModelReference - - - DataElement - urn:samm:io.catenax.essincident:1.0.0#IndustryCharacteristic:Services - - - - - - Lending / financing / insurance - - ModelReference - - - DataElement - urn:samm:io.catenax.essincident:1.0.0#IndustryCharacteristic:Lending / financing / insurance - - - - - - Other - - ModelReference - - - DataElement - urn:samm:io.catenax.essincident:1.0.0#IndustryCharacteristic:Other - - - - - - - - - - - - - essProductInformation - - - en - ESS Product Information - - - urn:samm:io.catenax.essincident:1.0.0#essProductInformation - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - ESS Product Information - - - - - en - essProductInformation - - - STRING - - - en - Information about a product/ part/ component which refers to an incident in context of ESS (Environmental and Social Standards). - - - - - - - - - essOriginatorCountry - - - en - ESS Originator Country - - - urn:samm:io.catenax.essincident:1.0.0#essOriginatorCountry - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - ESS Originator Country - - - - - en - essOriginatorCountry - - - STRING - - - en - Country to which an incident in the context of ESS (Environmental and Social Standards) belongs - - - - - - - - - essOriginatorRegion - - - en - ESS Originator Region - - - urn:samm:io.catenax.essincident:1.0.0#essOriginatorRegion - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - ESS Originator Region - - - - - en - essOriginatorRegion - - - STRING - - - en - Region within a country to which an incident in the context of ESS (Environmental and Social Standards) belongs - - - - - - - - - longitude - - - en - Longitude - - - urn:samm:io.catenax.essincident:1.0.0#longitude - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Longitude - - - - - en - longitude - - - STRING - - - en - Longitude information for geographic coordinates. - - - - - - - - - latitude - - - en - Latitude - - - urn:samm:io.catenax.essincident:1.0.0#latitude - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Latitude - - - - - en - latitude - - - STRING - - - en - Latitude information for geographic coordinates. - - - - - - - - - essOriginatorCoordinates - - - en - ESS Originator Geographic data / Coordinates - - - urn:samm:io.catenax.essincident:1.0.0#essOriginatorCoordinates - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - ESS Originator Geographic data / Coordinates - - - - - en - essOriginatorCoordinates - - - STRING - - - en - Exact geographic position of an incident in the context of ESS (Environmental and Social Standards) - - - - - - - - - essOriginatorCompanyName - - - en - ESS Originator Company Name - - - urn:samm:io.catenax.essincident:1.0.0#essOriginatorCompanyName - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - ESS Originator Company Name - - - - - en - essOriginatorCompanyName - - - STRING - - - en - Name of a company/ an organisation that is the originator of an incident in the context of ESS (Environmental and Social Standards) - - - - - - - - - street - - - en - Street - - - urn:samm:io.catenax.essincident:1.0.0#street - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Street - - - - - en - street - - - STRING - - - en - Street name (and number) belonging to an address - - - - - - - - - zip - - - en - Zip - - - urn:samm:io.catenax.essincident:1.0.0#zip - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Zip - - - - - en - zip - - - STRING - - - en - Zip code belonging to an address - - - - - - - - - city - - - en - City - - - urn:samm:io.catenax.essincident:1.0.0#city - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - City - - - - - en - city - - - STRING - - - en - Name of a city belonging to an address. - - - - - - - - - address - - - en - Address - - - urn:samm:io.catenax.essincident:1.0.0#address - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Address - - - - - en - address - - - STRING - - - en - Simple form of an address which can belong to a person, organisation, company etc. - - - - - - - - - bpnProperty - - - en - BPN Property - - - urn:samm:io.catenax.essincident:1.0.0#bpnProperty - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - BPN Property - - - - - en - bpnProperty - - - STRING - - - en - BPN Property - - - - - - - - - essOriginatorBpnL - - - en - ESS Originator BPN-L - - - urn:samm:io.catenax.essincident:1.0.0#essOriginatorBpnL - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - ESS Originator BPN-L - - - - - en - essOriginatorBpnL - - - STRING - - - en - BPN-L ID of the company headquarter that causes the incident - - - - - - - - - essOriginatorCxMember - - - en - ESS Originator CX Member - - - urn:samm:io.catenax.essincident:1.0.0#essOriginatorCxMember - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - ESS Originator CX Member - - - - - en - essOriginatorCxMember - - - BOOLEAN - - - en - Return flag (y/n) that company that causes the ESS incident is a CX member (or not) - - - - - - - - - essOriginatorBpnAvailable - - - en - ESs Originator BPN available - - - urn:samm:io.catenax.essincident:1.0.0#essOriginatorBpnAvailable - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - ESs Originator BPN available - - - - - en - essOriginatorBpnAvailable - - - BOOLEAN - - - en - Return flag (y/n) that company that causes the ESS incident has a BPN-L/-S/-A in CX (but no CX membership) - - - - - - - - - bpnProperty - - - en - BPN Property - - - urn:samm:io.catenax.essincident:1.0.0#bpnProperty - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - BPN Property - - - - - en - bpnProperty - - - STRING - - - en - BPN Property - - - - - - - - - essOriginatorBpnS - - - en - ESS Originator BPN-S - - - urn:samm:io.catenax.essincident:1.0.0#essOriginatorBpnS - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - ESS Originator BPN-S - - - - - en - essOriginatorBpnS - - - STRING - - - en - BPN-S ID of the company headquarter that causes the incident - - - - - - - - - bpnProperty - - - en - BPN Property - - - urn:samm:io.catenax.essincident:1.0.0#bpnProperty - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - BPN Property - - - - - en - bpnProperty - - - STRING - - - en - BPN Property - - - - - - - - - essOriginatorBpnA - - - en - ESS Originator BPN A - - - urn:samm:io.catenax.essincident:1.0.0#essOriginatorBpnA - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - ESS Originator BPN A - - - - - en - essOriginatorBpnA - - - STRING - - - en - BPN-A ID of the company headquarter that causes the incident - - - - - - - - - essCompanyInformation - - - en - ESS Company Information - - - urn:samm:io.catenax.essincident:1.0.0#essCompanyInformation - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - ESS Company Information - - - - - en - essCompanyInformation - - - STRING - - - en - Information about an originating company of an incident in context of ESS (Environmental and Social Standards). - - - - - - - - - contactName - - - en - Contact Name - - - urn:samm:io.catenax.essincident:1.0.0#contactName - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Contact Name - - - - - en - contactName - - - STRING - - - en - Name of a contact. - - - - - - - - - contactMail - - - en - Contact Mail - - - urn:samm:io.catenax.essincident:1.0.0#contactMail - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Contact Mail - - - - - en - contactMail - - - STRING - - - en - Mail address of a contact - - - - - - - - - contactPhone - - - en - Contact Phone - - - urn:samm:io.catenax.essincident:1.0.0#contactPhone - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Contact Phone - - - - - en - contactPhone - - - STRING - - - en - Phone number of a contact. - - - - - - - - - street - - - en - Street - - - urn:samm:io.catenax.essincident:1.0.0#street - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Street - - - - - en - street - - - STRING - - - en - Street name (and number) belonging to an address - - - - - - - - - zip - - - en - Zip - - - urn:samm:io.catenax.essincident:1.0.0#zip - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Zip - - - - - en - zip - - - STRING - - - en - Zip code belonging to an address - - - - - - - - - city - - - en - City - - - urn:samm:io.catenax.essincident:1.0.0#city - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - City - - - - - en - city - - - STRING - - - en - Name of a city belonging to an address. - - - - - - - - - address - - - en - Address - - - urn:samm:io.catenax.essincident:1.0.0#address - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Address - - - - - en - address - - - STRING - - - en - Simple form of an address which can belong to a person, organisation, company etc. - - - - - - - - - essIncidentIssuerCompanyName - - - en - ESS Incident Issuer Company Name - - - urn:samm:io.catenax.essincident:1.0.0#essIncidentIssuerCompanyName - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - ESS Incident Issuer Company Name - - - - - en - essIncidentIssuerCompanyName - - - STRING - - - en - Company name of incident issuer - - - - - - - - - issuerId - - - en - Issuer ID - - - urn:samm:io.catenax.essincident:1.0.0#issuerId - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Issuer ID - - - - - en - issuerId - - - STRING - - - en - System generated unique identifier of incident issuer - - - - - - - - - flagAnonymous - - - en - Flag anonymous - - - urn:samm:io.catenax.essincident:1.0.0#flagAnonymous - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Flag anonymous - - - - - en - flagAnonymous - - - BOOLEAN - - - en - Flag that Incident issuer wants to be anonymous - - - - - - - - - essContactInformation - - - en - ESS Contact Information - - - urn:samm:io.catenax.essincident:1.0.0#essContactInformation - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - ESS Contact Information - - - - - en - essContactInformation - - - STRING - - - en - Information about a contact who issued an incident in the context of ESS (Environmental and Social Standards) - - - - - - - - - diff --git a/io.catenax.essincident/1.0.0/gen/EssIncident-schema.json b/io.catenax.essincident/1.0.0/gen/EssIncident-schema.json deleted file mode 100644 index 120fb3167..000000000 --- a/io.catenax.essincident/1.0.0/gen/EssIncident-schema.json +++ /dev/null @@ -1,321 +0,0 @@ -{ - "$schema" : "http://json-schema.org/draft-04/schema", - "description" : "Aspect for defining an incident in context of Environmental and Social Standards as specified by the Catena-X Sustainability team.", - "type" : "object", - "components" : { - "schemas" : { - "urn_bamm_io.catenax.essincident_1.0.0_IncidentCategoryCharacteristic" : { - "type" : "string", - "description" : "Characteristic for defining an incident category in the context of ESS (Environmental and Social Standards).", - "enum" : [ "Environmental", "Social" ] - }, - "urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text" : { - "type" : "string", - "description" : "Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc." - }, - "urn_bamm_io.openmanufacturing_characteristic_2.0.0_ResourcePath" : { - "type" : "string", - "format" : "uri", - "description" : "The path of a resource." - }, - "urn_bamm_io.openmanufacturing_characteristic_2.0.0_Timestamp" : { - "type" : "string", - "pattern" : "-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T(([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](\\.[0-9]+)?|(24:00:00(\\.0+)?))(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?", - "description" : "Describes a Property which contains the date and time with an optional timezone." - }, - "urn_bamm_io.catenax.essincident_1.0.0_IncidentDurationCharacteristic" : { - "type" : "string", - "description" : "Characteristic for defining the duration of an incident in context of ESS (Environmental and Social Standards).", - "enum" : [ "1 week", "> 1 month", "> 6 months", "> 1 year" ] - }, - "urn_bamm_io.catenax.essincident_1.0.0_UUIDv4" : { - "type" : "string", - "description" : "A version 4 UUID is a universally unique identifier generated using random 32 hexadecimal characters." - }, - "urn_bamm_io.catenax.essincident_1.0.0_IncidentSubcategories" : { - "type" : "string", - "description" : "Characteristic for defining subcategories of an incident in the context of ESS (Environmental and Social Standards).", - "enum" : [ "Child labour", "Forced labour", "Slavery", "Work safety", "Freedom of association", "Discrimination", "Minimum wage", "Environmental pollution", "Forced eviction", "Force by state security", "Usage of Mercury", "Usage of harmful chemicals", "Non-environmental friendly handling of waste", "Import and export of hazardous waste" ] - }, - "urn_bamm_io.catenax.essincident_1.0.0_IncidentSubcategoryEntity" : { - "description" : "Incident Subcategory Single Entity", - "type" : "object", - "properties" : { - "incidentSubcategoryProperty" : { - "description" : "Incident Subcategory Property", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.essincident_1.0.0_IncidentSubcategories" - } - }, - "required" : [ "incidentSubcategoryProperty" ] - }, - "urn_bamm_io.catenax.essincident_1.0.0_EssIncidentInformationEntity" : { - "description" : "Characteristic for defining an incident in context of ESS (Environmental and Social Standards).", - "type" : "object", - "properties" : { - "incidentCategory" : { - "description" : "Environmental and social standards related incident category according to Supply Chain Due Diligence Act", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.essincident_1.0.0_IncidentCategoryCharacteristic" - }, - "incidentDescription" : { - "description" : "Full text description of an incident in the context of ESS (Environmental and Social Standards)", - "$ref" : "#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text" - }, - "incidentAttachment" : { - "description" : "Picture(s) about the reported incident in the context of ESS (Environmental and Social Standards)", - "$ref" : "#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_ResourcePath" - }, - "systemDate" : { - "description" : "System created time stamp when the incident in the context of ESS (Environmental and Social Standards) was issued and saved", - "$ref" : "#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Timestamp" - }, - "incidentDate" : { - "description" : "Date and time information about when an incident in the context of ESS (Environmental and Social Standards) occurred", - "$ref" : "#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Timestamp" - }, - "incidentDuration" : { - "description" : "Information about how long an incident in the context of ESS (Environmental and Social Standards) occurred", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.essincident_1.0.0_IncidentDurationCharacteristic" - }, - "incidentId" : { - "description" : "Unique identifier for an incident in the context of ESS (Environmental and Social Standards)", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.essincident_1.0.0_UUIDv4" - }, - "incidentSubcategory" : { - "description" : "Incident Subcategory", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.essincident_1.0.0_IncidentSubcategoryEntity" - }, - "incidentHeadline" : { - "description" : "Title/ subject of an incident in the context of ESS (Environmental and Social Standards)", - "$ref" : "#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text" - } - }, - "required" : [ "incidentCategory", "systemDate", "incidentId", "incidentSubcategory" ] - }, - "urn_bamm_io.catenax.essincident_1.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).", - "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_bamm_io.catenax.essincident_1.0.0_IndustryCharacteristic" : { - "type" : "string", - "description" : "Industry Characteristic", - "enum" : [ "Extraction of raw materials", "Manufacture of components / intermediates", "Manufacture of final products", "Distribution / Trade", "Waste treatment / recycling", "Services", "Lending / financing / insurance", "Other" ] - }, - "urn_bamm_io.catenax.essincident_1.0.0_EssProductInformationEntity" : { - "description" : "Characteristic for defining the product related information about an incident in context of ESS (Environmental and Social Standards).", - "type" : "object", - "properties" : { - "productCommodity" : { - "description" : "Free-text description for commodity of a product affected by an incident in the context of ESS (Environmental and Social Standards)", - "$ref" : "#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text" - }, - "uniquePartNumber" : { - "description" : "Serial product/ part/ component number as defined by a unique identifier in Catena-X that is affected by an incident in the context of ESS (Environmental and Social Standards)", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.essincident_1.0.0_CatenaXIdTrait" - }, - "productDescription" : { - "description" : "Description of product or component affected by an incident in the context of ESS (Environmental and Social Standards) ", - "$ref" : "#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text" - }, - "partNumber" : { - "description" : "Part number that is affected by an incident in the context of ESS (Environmental and Social Standards) ", - "$ref" : "#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text" - }, - "batchNumber" : { - "description" : "Batch number that is affected by an incident in the context of ESS (Environmental and Social Standards)", - "$ref" : "#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text" - }, - "rawMaterial" : { - "description" : "Raw material that causes an incident in the context of ESS (Environmental and Social Standards)", - "$ref" : "#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text" - }, - "industry" : { - "description" : "Industry / Branch that causes the incident", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.essincident_1.0.0_IndustryCharacteristic" - } - }, - "required" : [ "productDescription" ] - }, - "urn_bamm_io.catenax.essincident_1.0.0_EssOriginatorCountryTrait" : { - "type" : "string", - "description" : "Constraint for defining a geography country conform to ISO 3166CC.", - "pattern" : "([A-Z]{2})" - }, - "urn_bamm_io.catenax.essincident_1.0.0_EssOriginatorRegionTrait" : { - "type" : "string", - "description" : "Constraint for defining a region within a country in compliance to ISO 3166-2.", - "pattern" : "([A-Z]{2}-[A-Z0-9]{1,3}|)" - }, - "urn_bamm_io.catenax.essincident_1.0.0_LongitudeTrait" : { - "type" : "string", - "description" : "Regular expression for longitude information.", - "pattern" : "^(\\+|-)?(?:180(?:(?:\\.0{1,6})?)|(?:[0-9]|[1-9][0-9]|1[0-7][0-9])(?:(?:\\.[0-9]{1,6})?))$" - }, - "urn_bamm_io.catenax.essincident_1.0.0_LatitudeTrait" : { - "type" : "string", - "description" : "Regular expression for latitude information of geographic coordinates.", - "pattern" : "^(\\+|-)?(?:90(?:(?:\\.0{1,6})?)|(?:[0-9]|[1-8][0-9])(?:(?:\\.[0-9]{1,6})?))$" - }, - "urn_bamm_io.catenax.essincident_1.0.0_EssOriginatorCoordinatesEntity" : { - "description" : "Characteristic for defining geographic coordinates (longitude and latitude) of an incident originator in context of ESS (Environmental and Social Standards).", - "type" : "object", - "properties" : { - "longitude" : { - "description" : "Longitude information for geographic coordinates.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.essincident_1.0.0_LongitudeTrait" - }, - "latitude" : { - "description" : "Latitude information for geographic coordinates.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.essincident_1.0.0_LatitudeTrait" - } - }, - "required" : [ "longitude", "latitude" ] - }, - "urn_bamm_io.catenax.essincident_1.0.0_AddressEntity" : { - "description" : "Characteristic for defining an address which can belong to a person, an orginisation a company or any other.", - "type" : "object", - "properties" : { - "street" : { - "description" : "Street name (and number) belonging to an address", - "$ref" : "#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text" - }, - "zip" : { - "description" : "Zip code belonging to an address", - "$ref" : "#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text" - }, - "city" : { - "description" : "Name of a city belonging to an address.", - "$ref" : "#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text" - } - }, - "required" : [ "street", "zip", "city" ] - }, - "urn_bamm_io.catenax.essincident_1.0.0_BPN" : { - "type" : "string", - "description" : "Business Partner Number Contraint", - "pattern" : "^(BPN)(L|S|A)(\\\\d{8})([a-zA-Z0-9]{4})$" - }, - "urn_bamm_io.catenax.essincident_1.0.0_BpnEntity" : { - "description" : "Ess Originator BPN Characteristic", - "type" : "object", - "properties" : { - "bpnProperty" : { - "description" : "BPN Property", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.essincident_1.0.0_BPN" - } - }, - "required" : [ "bpnProperty" ] - }, - "urn_bamm_io.openmanufacturing_characteristic_2.0.0_Boolean" : { - "type" : "boolean", - "description" : "Represents a boolean value (i.e. a \"flag\")." - }, - "urn_bamm_io.catenax.essincident_1.0.0_EssCompanyInformationEntity" : { - "description" : "Characteristic for defining the originating company information of an incident in context of ESS (Environmental and Social Standards).", - "type" : "object", - "properties" : { - "essOriginatorCountry" : { - "description" : "Country to which an incident in the context of ESS (Environmental and Social Standards) belongs", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.essincident_1.0.0_EssOriginatorCountryTrait" - }, - "essOriginatorRegion" : { - "description" : "Region within a country to which an incident in the context of ESS (Environmental and Social Standards) belongs", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.essincident_1.0.0_EssOriginatorRegionTrait" - }, - "essOriginatorCoordinates" : { - "description" : "Exact geographic position of an incident in the context of ESS (Environmental and Social Standards)", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.essincident_1.0.0_EssOriginatorCoordinatesEntity" - }, - "essOriginatorCompanyName" : { - "description" : "Name of a company/ an organisation that is the originator of an incident in the context of ESS (Environmental and Social Standards)", - "$ref" : "#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text" - }, - "address" : { - "description" : "Simple form of an address which can belong to a person, organisation, company etc.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.essincident_1.0.0_AddressEntity" - }, - "essOriginatorBpnL" : { - "description" : "BPN-L ID of the company headquarter that causes the incident", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.essincident_1.0.0_BpnEntity" - }, - "essOriginatorCxMember" : { - "description" : "Return flag (y/n) that company that causes the ESS incident is a CX member (or not)", - "$ref" : "#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Boolean" - }, - "essOriginatorBpnAvailable" : { - "description" : "Return flag (y/n) that company that causes the ESS incident has a BPN-L/-S/-A in CX (but no CX membership)", - "$ref" : "#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Boolean" - }, - "essOriginatorBpnS" : { - "description" : "BPN-S ID of the company headquarter that causes the incident", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.essincident_1.0.0_BpnEntity" - }, - "essOriginatorBpnA" : { - "description" : "BPN-A ID of the company headquarter that causes the incident", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.essincident_1.0.0_BpnEntity" - } - }, - "required" : [ "essOriginatorCountry", "essOriginatorRegion" ] - }, - "urn_bamm_io.catenax.essincident_1.0.0_ContactMailTrait" : { - "type" : "string", - "description" : "Regular expression for a contact mail address.", - "pattern" : "^[a-zA-Z0-9.!#$%&’*+\\\\/=?^_`{|}~-]+@[a-zA-Z0-9-]+(?:\\\\.[a-zA-Z0-9-]+)*$" - }, - "urn_bamm_io.catenax.essincident_1.0.0_EssContactInformationEntity" : { - "description" : "Characteristic for defining the information about a contact who issued an incident in the context of ESS (Environmental and Social Standards)", - "type" : "object", - "properties" : { - "contactName" : { - "description" : "Name of a contact.", - "$ref" : "#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text" - }, - "contactMail" : { - "description" : "Mail address of a contact", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.essincident_1.0.0_ContactMailTrait" - }, - "contactPhone" : { - "description" : "Phone number of a contact.", - "$ref" : "#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text" - }, - "address" : { - "description" : "Simple form of an address which can belong to a person, organisation, company etc.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.essincident_1.0.0_AddressEntity" - }, - "essIncidentIssuerCompanyName" : { - "description" : "Company name of incident issuer", - "$ref" : "#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text" - }, - "issuerId" : { - "description" : "System generated unique identifier of incident issuer", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.essincident_1.0.0_UUIDv4" - }, - "flagAnonymous" : { - "description" : "Flag that Incident issuer wants to be anonymous", - "$ref" : "#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Boolean" - } - }, - "required" : [ "issuerId", "flagAnonymous" ] - } - } - }, - "properties" : { - "essIncidentInformation" : { - "description" : "Core information about an incident in context of ESS (Environmental and Social Standards).", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.essincident_1.0.0_EssIncidentInformationEntity" - }, - "essProductInformation" : { - "description" : "Information about a product/ part/ component which refers to an incident in context of ESS (Environmental and Social Standards).", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.essincident_1.0.0_EssProductInformationEntity" - }, - "essCompanyInformation" : { - "description" : "Information about an originating company of an incident in context of ESS (Environmental and Social Standards).", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.essincident_1.0.0_EssCompanyInformationEntity" - }, - "essContactInformation" : { - "description" : "Information about a contact who issued an incident in the context of ESS (Environmental and Social Standards)", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.essincident_1.0.0_EssContactInformationEntity" - } - }, - "required" : [ "essIncidentInformation", "essProductInformation", "essCompanyInformation" ] -} \ No newline at end of file diff --git a/io.catenax.essincident/1.0.0/gen/EssIncident.aasx b/io.catenax.essincident/1.0.0/gen/EssIncident.aasx deleted file mode 100644 index d0d08a761..000000000 Binary files a/io.catenax.essincident/1.0.0/gen/EssIncident.aasx and /dev/null differ diff --git a/io.catenax.essincident/1.0.0/gen/EssIncident.html b/io.catenax.essincident/1.0.0/gen/EssIncident.html deleted file mode 100644 index 3d5e11a42..000000000 --- a/io.catenax.essincident/1.0.0/gen/EssIncident.html +++ /dev/null @@ -1,3059 +0,0 @@ - - - - - - - - - - - - - - Dokumentation ESS Incident - - -
-
-
-
-

Aspect Model ESS Incident

-
urn:bamm:io.catenax.essincident:1.0.0#EssIncident
-
-
-
-
-
-
-
- -
- - -
- Aspect for defining an incident in context of Environmental and Social Standards as specified by the Catena-X Sustainability team. -
- - -
-

Übersicht

-
-
-
-
- Aspect Model Diagram -
-
-
- - -
-
-

Properties

-
- -
- -
-

ESS Company Information

-
- -Information about an originating company of an incident in context of ESS (Environmental and Social Standards). - -
-
Name
-
essCompanyInformation
-
- - - -
-
Characteristic
-
-
-
-
SingleEntity
-
-
-
- Typ urn:bamm:io.catenax.essincident:1.0.0#EssCompanyInformationEntity - -
-
-
-
-
- - -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
essCompanyInformation
-
- - -
-
- -
-

ESS Contact Information

-
- -Information about a contact who issued an incident in the context of ESS (Environmental and Social Standards) - -
-
Name
-
essContactInformation
-
- - - -
-
Characteristic
-
-
-
-
SingleEntity
-
-
-
- Typ urn:bamm:io.catenax.essincident:1.0.0#EssContactInformationEntity - -
-
-
-
-
- - -
-
Optional
-
- Ja
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
essContactInformation
-
- - -
-
- -
-

ESS Incident Information

-
- -Core information about an incident in context of ESS (Environmental and Social Standards). - -
-
Name
-
essIncidentInformation
-
- - - -
-
Characteristic
-
-
-
-
SingleEntity
-
-
-
- Typ urn:bamm:io.catenax.essincident:1.0.0#EssIncidentInformationEntity - -
-
-
-
-
- - -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
essIncidentInformation
-
- - -
-
- -
-

ESS Product Information

-
- -Information about a product/ part/ component which refers to an incident in context of ESS (Environmental and Social Standards). - -
-
Name
-
essProductInformation
-
- - - -
-
Characteristic
-
-
-
-
SingleEntity
-
-
-
- Typ urn:bamm:io.catenax.essincident:1.0.0#EssProductInformationEntity - -
-
-
-
-
- - -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
essProductInformation
-
- - -
-
- - - -
-
-

Objekt

-
- -
-
-

Address Entity

-
-
- Entity for defining an address in a simple form. -
- -
-

Properties

-
-
- -
-
Street
-
- -Street name (and number) belonging to an address - -
-
Name
-
street
-
- - - -
-
Characteristic
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Beispiel
-
Main Road 1
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
street
-
- - -
-
- -
-
Zip
-
- -Zip code belonging to an address - -
-
Name
-
zip
-
- - - -
-
Characteristic
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Beispiel
-
12345
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
zip
-
- - -
-
- -
-
City
-
- -Name of a city belonging to an address. - -
-
Name
-
city
-
- - - -
-
Characteristic
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Beispiel
-
Model City
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
city
-
- - -
-
-
-
-

BPN (Business Partner Number) Entity

-
-
- Internal or external juristic, a company that is having a business relation with another Business Partner -
- -
-

Properties

-
-
- -
-
BPN Property
-
- -BPN Property - -
-
Name
-
bpnProperty
-
- - - -
-
Characteristic
-
-
-
-
Trait
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Beispiel
-
BPNL1234567890ZZ
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
bpnProperty
-
- - -
-
Bedingungen
-
-
    -
  • -
    - -
    - BPN Constraint -
    - -
    -
    Beschreibung
    -
    Business Partner Number Contraint
    -
    - - -
    -
    Regulärer Ausdruck
    -
    ^(BPN)(L|S|A)(\\d{8})([a-zA-Z0-9]{4})$
    -
    - -
    • -
-
-
-
-
-
-
-

ESS Company Information Entity

-
-
- ESS Company Information Entity -
- -
-

Properties

-
-
- -
-
ESS Originator Country
-
- -Country to which an incident in the context of ESS (Environmental and Social Standards) belongs - -
-
Name
-
essOriginatorCountry
-
- - - -
-
Characteristic
-
-
-
-
Trait
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Beispiel
-
BR
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
essOriginatorCountry
-
- - -
-
Bedingungen
-
-
    -
  • -
    - -
    - ESS Originator Country Constraint -
    - -
    -
    Beschreibung
    -
    Constraint for defining a geography country conform to ISO 3166CC.
    -
    - - -
    -
    Regulärer Ausdruck
    -
    ([A-Z]{2})
    -
    - -
    • -
-
-
-
-
- -
-
ESS Originator Region
-
- -Region within a country to which an incident in the context of ESS (Environmental and Social Standards) belongs - -
-
Name
-
essOriginatorRegion
-
- - - -
-
Characteristic
-
-
-
-
Trait
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Beispiel
-
BR-AM
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
essOriginatorRegion
-
- - -
-
Bedingungen
-
-
    -
  • -
    - -
    - ESS Originator Region Constraint -
    - -
    -
    Beschreibung
    -
    Constraint for defining a region within a country in compliance to ISO 3166-2.
    -
    - - -
    -
    Regulärer Ausdruck
    -
    ([A-Z]{2}-[A-Z0-9]{1,3}|)
    -
    - -
    • -
-
-
-
-
- -
-
ESS Originator Geographic data / Coordinates
-
- -Exact geographic position of an incident in the context of ESS (Environmental and Social Standards) - -
-
Name
-
essOriginatorCoordinates
-
- - - -
-
Characteristic
-
-
-
-
SingleEntity
-
-
-
- Typ urn:bamm:io.catenax.essincident:1.0.0#EssOriginatorCoordinatesEntity - -
-
-
-
-
- - -
-
Optional
-
- Ja
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
essOriginatorCoordinates
-
- - -
-
- -
-
ESS Originator Company Name
-
- -Name of a company/ an organisation that is the originator of an incident in the context of ESS (Environmental and Social Standards) - -
-
Name
-
essOriginatorCompanyName
-
- - - -
-
Characteristic
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Beispiel
-
Rubbery Ltd.
-
- -
-
Optional
-
- Ja
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
essOriginatorCompanyName
-
- - -
-
- -
-
Address
-
- -Simple form of an address which can belong to a person, organisation, company etc. - -
-
Name
-
address
-
- - - -
-
Characteristic
-
-
-
-
SingleEntity
-
-
-
- Typ urn:bamm:io.catenax.essincident:1.0.0#AddressEntity - -
-
-
-
-
- - -
-
Optional
-
- Ja
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
address
-
- - -
-
- -
-
ESS Originator BPN-L
-
- -BPN-L ID of the company headquarter that causes the incident - -
-
Name
-
essOriginatorBpnL
-
- - - -
-
Characteristic
-
-
-
-
SingleEntity
-
-
-
- Typ urn:bamm:io.catenax.essincident:1.0.0#BpnEntity - -
-
-
-
-
- - -
-
Optional
-
- Ja
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
essOriginatorBpnL
-
- - -
-
- -
-
ESS Originator CX Member
-
- -Return flag (y/n) that company that causes the ESS incident is a CX member (or not) - -
-
Name
-
essOriginatorCxMember
-
- - - -
-
Characteristic
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#boolean - -
-
-
-
-
- -
-
Beispiel
-
true
-
- -
-
Optional
-
- Ja
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
essOriginatorCxMember
-
- - -
-
- -
-
ESs Originator BPN available
-
- -Return flag (y/n) that company that causes the ESS incident has a BPN-L/-S/-A in CX (but no CX membership) - -
-
Name
-
essOriginatorBpnAvailable
-
- - - -
-
Characteristic
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#boolean - -
-
-
-
-
- -
-
Beispiel
-
true
-
- -
-
Optional
-
- Ja
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
essOriginatorBpnAvailable
-
- - -
-
- -
-
ESS Originator BPN-S
-
- -BPN-S ID of the company headquarter that causes the incident - -
-
Name
-
essOriginatorBpnS
-
- - - -
-
Characteristic
-
-
-
-
SingleEntity
-
-
-
- Typ urn:bamm:io.catenax.essincident:1.0.0#BpnEntity - -
-
-
-
-
- - -
-
Optional
-
- Ja
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
essOriginatorBpnS
-
- - -
-
- -
-
ESS Originator BPN A
-
- -BPN-A ID of the company headquarter that causes the incident - -
-
Name
-
essOriginatorBpnA
-
- - - -
-
Characteristic
-
-
-
-
SingleEntity
-
-
-
- Typ urn:bamm:io.catenax.essincident:1.0.0#BpnEntity - -
-
-
-
-
- - -
-
Optional
-
- Ja
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
essOriginatorBpnA
-
- - -
-
-
-
-

ESS Contact Information Entity

-
-
- ESS Contact Information Entity -
- -
-

Properties

-
-
- -
-
Contact Name
-
- -Name of a contact. - -
-
Name
-
contactName
-
- - - -
-
Characteristic
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Beispiel
-
Testuser
-
- -
-
Optional
-
- Ja
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
contactName
-
- - -
-
- -
-
Contact Mail
-
- -Mail address of a contact - -
-
Name
-
contactMail
-
- - - -
-
Characteristic
-
-
-
-
Trait
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Beispiel
-
test@example.com
-
- -
-
Optional
-
- Ja
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
contactMail
-
- - -
-
Bedingungen
-
-
    -
  • -
    - -
    - Contact Mail Constraint -
    - -
    -
    Beschreibung
    -
    Regular expression for a contact mail address.
    -
    - - -
    -
    Regulärer Ausdruck
    -
    ^[a-zA-Z0-9.!#$%&’*+\\/=?^_`{|}~-]+@[a-zA-Z0-9-]+(?:\\.[a-zA-Z0-9-]+)*$
    -
    - -
    • -
-
-
-
-
- -
-
Contact Phone
-
- -Phone number of a contact. - -
-
Name
-
contactPhone
-
- - - -
-
Characteristic
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Beispiel
-
+49-123-456789
-
- -
-
Optional
-
- Ja
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
contactPhone
-
- - -
-
- -
-
Address
-
- -Simple form of an address which can belong to a person, organisation, company etc. - -
-
Name
-
address
-
- - - -
-
Characteristic
-
-
-
-
SingleEntity
-
-
-
- Typ urn:bamm:io.catenax.essincident:1.0.0#AddressEntity - -
-
-
-
-
- - -
-
Optional
-
- Ja
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
address
-
- - -
-
- -
-
ESS Incident Issuer Company Name
-
- -Company name of incident issuer - -
-
Name
-
essIncidentIssuerCompanyName
-
- - - -
-
Characteristic
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Beispiel
-
UNICEF
-
- -
-
Optional
-
- Ja
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
essIncidentIssuerCompanyName
-
- - -
-
- -
-
Issuer ID
-
- -System generated unique identifier of incident issuer - -
-
Name
-
issuerId
-
- - - -
-
Characteristic
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Beispiel
-
9a47b3c8-b6d4-44f1-99ba-6bdb33916cac
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
issuerId
-
- - -
-
- -
-
Flag anonymous
-
- -Flag that Incident issuer wants to be anonymous - -
-
Name
-
flagAnonymous
-
- - - -
-
Characteristic
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#boolean - -
-
-
-
-
- -
-
Beispiel
-
false
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
flagAnonymous
-
- - -
-
-
-
-

ESS Incident Information Entity

-
-
- ESS Incident Information Entity -
- -
-

Properties

-
-
- -
-
Incident Category
-
- -Environmental and social standards related incident category according to Supply Chain Due Diligence Act - -
-
Name
-
incidentCategory
-
- - - -
-
Characteristic
-
-
-
-
Enumeration
-
-
-
Werte
-
-
-
-
    -
  • Environmental
    • -
  • Social
    • -
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Beispiel
-
Social
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
incidentCategory
-
- -
-
Referenz
-
-
    -
  • https://www.gesetze-im-internet.de/lksg/
    • -
-
-
- -
-
- -
-
Incident Description
-
- -Full text description of an incident in the context of ESS (Environmental and Social Standards) - -
-
Name
-
incidentDescription
-
- - - -
-
Characteristic
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Beispiel
-
Child labour at production site of the rubber producer in Brazil
-
- -
-
Optional
-
- Ja
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
incidentDescription
-
- - -
-
- -
-
Incident Attachment
-
- -Picture(s) about the reported incident in the context of ESS (Environmental and Social Standards) - -
-
Name
-
incidentAttachment
-
- - - -
-
Characteristic
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#anyURI - -
-
-
-
-
- - -
-
Optional
-
- Ja
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
incidentAttachment
-
- - -
-
- -
-
System Date
-
- -System created time stamp when the incident in the context of ESS (Environmental and Social Standards) was issued and saved - -
-
Name
-
systemDate
-
- - - -
-
Characteristic
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#dateTime - -
-
-
-
-
- -
-
Beispiel
-
2022-08-31T23:22:12Z
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
systemDate
-
- - -
-
- -
-
Date of Incident
-
- -Date and time information about when an incident in the context of ESS (Environmental and Social Standards) occurred - -
-
Name
-
incidentDate
-
- - - -
-
Characteristic
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#dateTime - -
-
-
-
-
- -
-
Beispiel
-
2022-08-31T00:00:00Z
-
- -
-
Optional
-
- Ja
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
incidentDate
-
- - -
-
- -
-
Duration of Incident
-
- -Information about how long an incident in the context of ESS (Environmental and Social Standards) occurred - -
-
Name
-
incidentDuration
-
- - - -
-
Characteristic
-
-
-
-
Enumeration
-
-
-
Werte
-
-
-
-
    -
  • 1 week
    • -
  • > 1 month
    • -
  • > 6 months
    • -
  • > 1 year
    • -
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Beispiel
-
> 1 month
-
- -
-
Optional
-
- Ja
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
incidentDuration
-
- - -
-
- -
-
Incident ID
-
- -Unique identifier for an incident in the context of ESS (Environmental and Social Standards) - -
-
Name
-
incidentId
-
- - - -
-
Characteristic
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Beispiel
-
9f47b3c8-b6d4-44f1-99ba-6bdb33916cac
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
incidentId
-
- - -
-
- -
-
Incident Subcategory
-
- -Incident Subcategory - -
-
Name
-
incidentSubcategory
-
- - - -
-
Characteristic
-
-
-
-
SingleEntity
-
-
-
- Typ urn:bamm:io.catenax.essincident:1.0.0#IncidentSubcategoryEntity - -
-
-
-
-
- - -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
incidentSubcategory
-
- - -
-
- -
-
Incident Headline
-
- -Title/ subject of an incident in the context of ESS (Environmental and Social Standards) - -
-
Name
-
incidentHeadline
-
- - - -
-
Characteristic
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Beispiel
-
Child labour on a rubber producer
-
- -
-
Optional
-
- Ja
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
incidentHeadline
-
- - -
-
-
-
-

ESS Originator Coordinates Entity

-
-
- Entity for geographic coordinates including a longitude and a latitude value. -
- -
-

Properties

-
-
- -
-
Longitude
-
- -Longitude information for geographic coordinates. - -
-
Name
-
longitude
-
- - - -
-
Characteristic
-
-
-
-
Trait
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Beispiel
-
-79.517415
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
longitude
-
- - -
-
Bedingungen
-
-
    -
  • -
    - -
    - Longitude Constraint -
    - -
    -
    Beschreibung
    -
    Regular expression for longitude information.
    -
    - - -
    -
    Regulärer Ausdruck
    -
    ^(\+|-)?(?:180(?:(?:\.0{1,6})?)|(?:[0-9]|[1-9][0-9]|1[0-7][0-9])(?:(?:\.[0-9]{1,6})?))$
    -
    - -
    • -
-
-
-
-
- -
-
Latitude
-
- -Latitude information for geographic coordinates. - -
-
Name
-
latitude
-
- - - -
-
Characteristic
-
-
-
-
Trait
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Beispiel
-
-5.4220777
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
latitude
-
- - -
-
Bedingungen
-
-
    -
  • -
    - -
    - Latitude Constraint -
    - -
    -
    Beschreibung
    -
    Regular expression for latitude information of geographic coordinates.
    -
    - - -
    -
    Regulärer Ausdruck
    -
    ^(\+|-)?(?:90(?:(?:\.0{1,6})?)|(?:[0-9]|[1-8][0-9])(?:(?:\.[0-9]{1,6})?))$
    -
    - -
    • -
-
-
-
-
-
-
-

ESS Product Information Entity

-
-
- ESS Product Information Entity -
- -
-

Properties

-
-
- -
-
Product Commodity
-
- -Free-text description for commodity of a product affected by an incident in the context of ESS (Environmental and Social Standards) - -
-
Name
-
productCommodity
-
- - - -
-
Characteristic
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Beispiel
-
Tire
-
- -
-
Optional
-
- Ja
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
productCommodity
-
- - -
-
- -
-
Unique Part Number
-
- -Serial product/ part/ component number as defined by a unique identifier in Catena-X that is affected by an incident in the context of ESS (Environmental and Social Standards) - -
-
Name
-
uniquePartNumber
-
- - - -
-
Characteristic
-
-
-
-
Trait
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Beispiel
-
580d3adf-1981-44a0-a214-13d6ceed9379
-
- -
-
Optional
-
- Ja
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
uniquePartNumber
-
- - -
-
Bedingungen
-
-
    -
  • -
    - -
    - UUIDv4RegularExpression -
    - -
    -
    Beschreibung
    -
    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).
    -
    - - -
    -
    Regulärer Ausdruck
    -
    ^[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}$
    -
    - -
    • -
-
-
-
-
- -
-
Product Description
-
- -Description of product or component affected by an incident in the context of ESS (Environmental and Social Standards) - -
-
Name
-
productDescription
-
- - - -
-
Characteristic
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Beispiel
-
Natural Rubber
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
productDescription
-
- - -
-
- -
-
Part Number
-
- -Part number that is affected by an incident in the context of ESS (Environmental and Social Standards) - -
-
Name
-
partNumber
-
- - - -
-
Characteristic
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Beispiel
-
EX123M234
-
- -
-
Optional
-
- Ja
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
partNumber
-
- - -
-
- -
-
Batch Number
-
- -Batch number that is affected by an incident in the context of ESS (Environmental and Social Standards) - -
-
Name
-
batchNumber
-
- - - -
-
Characteristic
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Beispiel
-
CH122535MXD
-
- -
-
Optional
-
- Ja
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
batchNumber
-
- - -
-
- -
-
Raw Material
-
- -Raw material that causes an incident in the context of ESS (Environmental and Social Standards) - -
-
Name
-
rawMaterial
-
- - - -
-
Characteristic
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Beispiel
-
Natural Rubber
-
- -
-
Optional
-
- Ja
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
rawMaterial
-
- - -
-
- -
-
Industry / Branch
-
- -Industry / Branch that causes the incident - -
-
Name
-
industry
-
- - - -
-
Characteristic
-
-
-
-
Enumeration
-
-
-
Werte
-
-
-
-
    -
  • Extraction of raw materials
    • -
  • Manufacture of components / intermediates
    • -
  • Manufacture of final products
    • -
  • Distribution / Trade
    • -
  • Waste treatment / recycling
    • -
  • Services
    • -
  • Lending / financing / insurance
    • -
  • Other
    • -
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Beispiel
-
Extraction of raw material
-
- -
-
Optional
-
- Ja
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
industry
-
- - -
-
-
-
-

Incident Subcategory Entity

-
-
- Incident Subcategory Entity -
- -
-

Properties

-
-
- -
-
Incident Subcategory Property
-
- -Incident Subcategory Property - -
-
Name
-
incidentSubcategoryProperty
-
- - - -
-
Characteristic
-
-
-
-
Enumeration
-
-
-
Werte
-
-
-
-
    -
  • Child labour
    • -
  • Forced labour
    • -
  • Slavery
    • -
  • Work safety
    • -
  • Freedom of association
    • -
  • Discrimination
    • -
  • Minimum wage
    • -
  • Environmental pollution
    • -
  • Forced eviction
    • -
  • Force by state security
    • -
  • Usage of Mercury
    • -
  • Usage of harmful chemicals
    • -
  • Non-environmental friendly handling of waste
    • -
  • Import and export of hazardous waste
    • -
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Beispiel
-
Child labour
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
incidentSubcategoryProperty
-
- - -
-
-
- -
- Third party licenses - -
- -
- - -
- - - \ No newline at end of file diff --git a/io.catenax.essincident/1.0.0/gen/EssIncident.json b/io.catenax.essincident/1.0.0/gen/EssIncident.json deleted file mode 100644 index e16095c35..000000000 --- a/io.catenax.essincident/1.0.0/gen/EssIncident.json +++ /dev/null @@ -1,62 +0,0 @@ -{ - "essContactInformation" : { - "flagAnonymous" : false, - "issuerId" : "9a47b3c8-b6d4-44f1-99ba-6bdb33916cac", - "address" : { - "zip" : "12345", - "city" : "Model City", - "street" : "Main Road 1" - }, - "contactName" : "Testuser", - "essIncidentIssuerCompanyName" : "UNICEF", - "contactMail" : "test@example.com", - "contactPhone" : "+49-123-456789" - }, - "essIncidentInformation" : { - "incidentHeadline" : "Child labour on a rubber producer", - "systemDate" : "2022-08-31T23:22:12Z", - "incidentCategory" : "Environmental", - "incidentAttachment" : "telnet://192.0.2.16:80/", - "incidentDuration" : "1 week", - "incidentDate" : "2022-08-31T00:00:00Z", - "incidentId" : "9f47b3c8-b6d4-44f1-99ba-6bdb33916cac", - "incidentDescription" : "Child labour at production site of the rubber producer in Brazil", - "incidentSubcategory" : { - "incidentSubcategoryProperty" : "Child labour" - } - }, - "essProductInformation" : { - "rawMaterial" : "Natural Rubber", - "productCommodity" : "Tire", - "partNumber" : "EX123M234", - "industry" : "Extraction of raw materials", - "productDescription" : "Natural Rubber", - "uniquePartNumber" : "580d3adf-1981-44a0-a214-13d6ceed9379", - "batchNumber" : "CH122535MXD" - }, - "essCompanyInformation" : { - "essOriginatorRegion" : "BR-AM", - "essOriginatorBpnA" : { - "bpnProperty" : "BPNL1234567890ZZ" - }, - "address" : { - "zip" : "12345", - "city" : "Model City", - "street" : "Main Road 1" - }, - "essOriginatorCxMember" : true, - "essOriginatorBpnAvailable" : true, - "essOriginatorCompanyName" : "Rubbery Ltd.", - "essOriginatorBpnS" : { - "bpnProperty" : "BPNL1234567890ZZ" - }, - "essOriginatorCountry" : "BR", - "essOriginatorCoordinates" : { - "longitude" : "-79.517415", - "latitude" : "-5.4220777" - }, - "essOriginatorBpnL" : { - "bpnProperty" : "BPNL1234567890ZZ" - } - } -} \ No newline at end of file diff --git a/io.catenax.essincident/1.0.0/gen/EssIncident.yml b/io.catenax.essincident/1.0.0/gen/EssIncident.yml deleted file mode 100644 index 8e4bec138..000000000 --- a/io.catenax.essincident/1.0.0/gen/EssIncident.yml +++ /dev/null @@ -1,422 +0,0 @@ ---- -openapi: 3.0.3 -info: - title: ESS Incident - version: v1 -servers: -- url: catenax.io/api/v1 - variables: - api-version: - default: v1 -paths: - /{tenant-id}/ess-incident: - get: - tags: - - EssIncident - operationId: getEssIncident - 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/EssIncident' - "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_bamm_io.catenax.essincident_1.0.0_IncidentCategoryCharacteristic: - type: string - description: Characteristic for defining an incident category in the context - of ESS (Environmental and Social Standards). - enum: - - Environmental - - Social - urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text: - type: string - description: "Describes a Property which contains plain text. This is intended\ - \ exclusively for human readable strings, not for identifiers, measurement\ - \ values, etc." - urn_bamm_io.openmanufacturing_characteristic_2.0.0_ResourcePath: - type: string - format: uri - description: The path of a resource. - urn_bamm_io.openmanufacturing_characteristic_2.0.0_Timestamp: - type: string - pattern: "-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T(([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](\\\ - .[0-9]+)?|(24:00:00(\\.0+)?))(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?" - description: Describes a Property which contains the date and time with an optional - timezone. - urn_bamm_io.catenax.essincident_1.0.0_IncidentDurationCharacteristic: - type: string - description: Characteristic for defining the duration of an incident in context - of ESS (Environmental and Social Standards). - enum: - - 1 week - - '> 1 month' - - '> 6 months' - - '> 1 year' - urn_bamm_io.catenax.essincident_1.0.0_UUIDv4: - type: string - description: A version 4 UUID is a universally unique identifier generated using - random 32 hexadecimal characters. - urn_bamm_io.catenax.essincident_1.0.0_IncidentSubcategories: - type: string - description: Characteristic for defining subcategories of an incident in the - context of ESS (Environmental and Social Standards). - enum: - - Child labour - - Forced labour - - Slavery - - Work safety - - Freedom of association - - Discrimination - - Minimum wage - - Environmental pollution - - Forced eviction - - Force by state security - - Usage of Mercury - - Usage of harmful chemicals - - Non-environmental friendly handling of waste - - Import and export of hazardous waste - urn_bamm_io.catenax.essincident_1.0.0_IncidentSubcategoryEntity: - description: Incident Subcategory Single Entity - type: object - properties: - incidentSubcategoryProperty: - description: Incident Subcategory Property - $ref: '#/components/schemas/urn_bamm_io.catenax.essincident_1.0.0_IncidentSubcategories' - required: - - incidentSubcategoryProperty - urn_bamm_io.catenax.essincident_1.0.0_EssIncidentInformationEntity: - description: Characteristic for defining an incident in context of ESS (Environmental - and Social Standards). - type: object - properties: - incidentCategory: - description: Environmental and social standards related incident category - according to Supply Chain Due Diligence Act - $ref: '#/components/schemas/urn_bamm_io.catenax.essincident_1.0.0_IncidentCategoryCharacteristic' - incidentDescription: - description: Full text description of an incident in the context of ESS - (Environmental and Social Standards) - $ref: '#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text' - incidentAttachment: - description: Picture(s) about the reported incident in the context of ESS - (Environmental and Social Standards) - $ref: '#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_ResourcePath' - systemDate: - description: System created time stamp when the incident in the context - of ESS (Environmental and Social Standards) was issued and saved - $ref: '#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Timestamp' - incidentDate: - description: Date and time information about when an incident in the context - of ESS (Environmental and Social Standards) occurred - $ref: '#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Timestamp' - incidentDuration: - description: Information about how long an incident in the context of ESS - (Environmental and Social Standards) occurred - $ref: '#/components/schemas/urn_bamm_io.catenax.essincident_1.0.0_IncidentDurationCharacteristic' - incidentId: - description: Unique identifier for an incident in the context of ESS (Environmental - and Social Standards) - $ref: '#/components/schemas/urn_bamm_io.catenax.essincident_1.0.0_UUIDv4' - incidentSubcategory: - description: Incident Subcategory - $ref: '#/components/schemas/urn_bamm_io.catenax.essincident_1.0.0_IncidentSubcategoryEntity' - incidentHeadline: - description: Title/ subject of an incident in the context of ESS (Environmental - and Social Standards) - $ref: '#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text' - required: - - incidentCategory - - systemDate - - incidentId - - incidentSubcategory - urn_bamm_io.catenax.essincident_1.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)." - 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_bamm_io.catenax.essincident_1.0.0_IndustryCharacteristic: - type: string - description: Industry Characteristic - enum: - - Extraction of raw materials - - Manufacture of components / intermediates - - Manufacture of final products - - Distribution / Trade - - Waste treatment / recycling - - Services - - Lending / financing / insurance - - Other - urn_bamm_io.catenax.essincident_1.0.0_EssProductInformationEntity: - description: Characteristic for defining the product related information about - an incident in context of ESS (Environmental and Social Standards). - type: object - properties: - productCommodity: - description: Free-text description for commodity of a product affected by - an incident in the context of ESS (Environmental and Social Standards) - $ref: '#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text' - uniquePartNumber: - description: Serial product/ part/ component number as defined by a unique - identifier in Catena-X that is affected by an incident in the context - of ESS (Environmental and Social Standards) - $ref: '#/components/schemas/urn_bamm_io.catenax.essincident_1.0.0_CatenaXIdTrait' - productDescription: - description: 'Description of product or component affected by an incident - in the context of ESS (Environmental and Social Standards) ' - $ref: '#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text' - partNumber: - description: 'Part number that is affected by an incident in the context - of ESS (Environmental and Social Standards) ' - $ref: '#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text' - batchNumber: - description: Batch number that is affected by an incident in the context - of ESS (Environmental and Social Standards) - $ref: '#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text' - rawMaterial: - description: Raw material that causes an incident in the context of ESS - (Environmental and Social Standards) - $ref: '#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text' - industry: - description: Industry / Branch that causes the incident - $ref: '#/components/schemas/urn_bamm_io.catenax.essincident_1.0.0_IndustryCharacteristic' - required: - - productDescription - urn_bamm_io.catenax.essincident_1.0.0_EssOriginatorCountryTrait: - type: string - description: Constraint for defining a geography country conform to ISO 3166CC. - pattern: "([A-Z]{2})" - urn_bamm_io.catenax.essincident_1.0.0_EssOriginatorRegionTrait: - type: string - description: Constraint for defining a region within a country in compliance - to ISO 3166-2. - pattern: "([A-Z]{2}-[A-Z0-9]{1,3}|)" - urn_bamm_io.catenax.essincident_1.0.0_LongitudeTrait: - type: string - description: Regular expression for longitude information. - pattern: "^(\\+|-)?(?:180(?:(?:\\.0{1,6})?)|(?:[0-9]|[1-9][0-9]|1[0-7][0-9])(?:(?:\\\ - .[0-9]{1,6})?))$" - urn_bamm_io.catenax.essincident_1.0.0_LatitudeTrait: - type: string - description: Regular expression for latitude information of geographic coordinates. - pattern: "^(\\+|-)?(?:90(?:(?:\\.0{1,6})?)|(?:[0-9]|[1-8][0-9])(?:(?:\\.[0-9]{1,6})?))$" - urn_bamm_io.catenax.essincident_1.0.0_EssOriginatorCoordinatesEntity: - description: Characteristic for defining geographic coordinates (longitude and - latitude) of an incident originator in context of ESS (Environmental and Social - Standards). - type: object - properties: - longitude: - description: Longitude information for geographic coordinates. - $ref: '#/components/schemas/urn_bamm_io.catenax.essincident_1.0.0_LongitudeTrait' - latitude: - description: Latitude information for geographic coordinates. - $ref: '#/components/schemas/urn_bamm_io.catenax.essincident_1.0.0_LatitudeTrait' - required: - - longitude - - latitude - urn_bamm_io.catenax.essincident_1.0.0_AddressEntity: - description: "Characteristic for defining an address which can belong to a person,\ - \ an orginisation a company or any other." - type: object - properties: - street: - description: Street name (and number) belonging to an address - $ref: '#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text' - zip: - description: Zip code belonging to an address - $ref: '#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text' - city: - description: Name of a city belonging to an address. - $ref: '#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text' - required: - - street - - zip - - city - urn_bamm_io.catenax.essincident_1.0.0_BPN: - type: string - description: Business Partner Number Contraint - pattern: "^(BPN)(L|S|A)(\\\\d{8})([a-zA-Z0-9]{4})$" - urn_bamm_io.catenax.essincident_1.0.0_BpnEntity: - description: Ess Originator BPN Characteristic - type: object - properties: - bpnProperty: - description: BPN Property - $ref: '#/components/schemas/urn_bamm_io.catenax.essincident_1.0.0_BPN' - required: - - bpnProperty - urn_bamm_io.openmanufacturing_characteristic_2.0.0_Boolean: - type: boolean - description: Represents a boolean value (i.e. a "flag"). - urn_bamm_io.catenax.essincident_1.0.0_EssCompanyInformationEntity: - description: Characteristic for defining the originating company information - of an incident in context of ESS (Environmental and Social Standards). - type: object - properties: - essOriginatorCountry: - description: Country to which an incident in the context of ESS (Environmental - and Social Standards) belongs - $ref: '#/components/schemas/urn_bamm_io.catenax.essincident_1.0.0_EssOriginatorCountryTrait' - essOriginatorRegion: - description: Region within a country to which an incident in the context - of ESS (Environmental and Social Standards) belongs - $ref: '#/components/schemas/urn_bamm_io.catenax.essincident_1.0.0_EssOriginatorRegionTrait' - essOriginatorCoordinates: - description: Exact geographic position of an incident in the context of - ESS (Environmental and Social Standards) - $ref: '#/components/schemas/urn_bamm_io.catenax.essincident_1.0.0_EssOriginatorCoordinatesEntity' - essOriginatorCompanyName: - description: Name of a company/ an organisation that is the originator of - an incident in the context of ESS (Environmental and Social Standards) - $ref: '#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text' - address: - description: "Simple form of an address which can belong to a person, organisation,\ - \ company etc." - $ref: '#/components/schemas/urn_bamm_io.catenax.essincident_1.0.0_AddressEntity' - essOriginatorBpnL: - description: BPN-L ID of the company headquarter that causes the incident - $ref: '#/components/schemas/urn_bamm_io.catenax.essincident_1.0.0_BpnEntity' - essOriginatorCxMember: - description: Return flag (y/n) that company that causes the ESS incident - is a CX member (or not) - $ref: '#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Boolean' - essOriginatorBpnAvailable: - description: Return flag (y/n) that company that causes the ESS incident - has a BPN-L/-S/-A in CX (but no CX membership) - $ref: '#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Boolean' - essOriginatorBpnS: - description: BPN-S ID of the company headquarter that causes the incident - $ref: '#/components/schemas/urn_bamm_io.catenax.essincident_1.0.0_BpnEntity' - essOriginatorBpnA: - description: BPN-A ID of the company headquarter that causes the incident - $ref: '#/components/schemas/urn_bamm_io.catenax.essincident_1.0.0_BpnEntity' - required: - - essOriginatorCountry - - essOriginatorRegion - urn_bamm_io.catenax.essincident_1.0.0_ContactMailTrait: - type: string - description: Regular expression for a contact mail address. - pattern: "^[a-zA-Z0-9.!#$%&’*+\\\\/=?^_`{|}~-]+@[a-zA-Z0-9-]+(?:\\\\.[a-zA-Z0-9-]+)*$" - urn_bamm_io.catenax.essincident_1.0.0_EssContactInformationEntity: - description: Characteristic for defining the information about a contact who - issued an incident in the context of ESS (Environmental and Social Standards) - type: object - properties: - contactName: - description: Name of a contact. - $ref: '#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text' - contactMail: - description: Mail address of a contact - $ref: '#/components/schemas/urn_bamm_io.catenax.essincident_1.0.0_ContactMailTrait' - contactPhone: - description: Phone number of a contact. - $ref: '#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text' - address: - description: "Simple form of an address which can belong to a person, organisation,\ - \ company etc." - $ref: '#/components/schemas/urn_bamm_io.catenax.essincident_1.0.0_AddressEntity' - essIncidentIssuerCompanyName: - description: Company name of incident issuer - $ref: '#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text' - issuerId: - description: System generated unique identifier of incident issuer - $ref: '#/components/schemas/urn_bamm_io.catenax.essincident_1.0.0_UUIDv4' - flagAnonymous: - description: Flag that Incident issuer wants to be anonymous - $ref: '#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Boolean' - required: - - issuerId - - flagAnonymous - EssIncident: - description: Aspect for defining an incident in context of Environmental and - Social Standards as specified by the Catena-X Sustainability team. - type: object - properties: - essIncidentInformation: - description: Core information about an incident in context of ESS (Environmental - and Social Standards). - $ref: '#/components/schemas/urn_bamm_io.catenax.essincident_1.0.0_EssIncidentInformationEntity' - essProductInformation: - description: Information about a product/ part/ component which refers to - an incident in context of ESS (Environmental and Social Standards). - $ref: '#/components/schemas/urn_bamm_io.catenax.essincident_1.0.0_EssProductInformationEntity' - essCompanyInformation: - description: Information about an originating company of an incident in - context of ESS (Environmental and Social Standards). - $ref: '#/components/schemas/urn_bamm_io.catenax.essincident_1.0.0_EssCompanyInformationEntity' - essContactInformation: - description: Information about a contact who issued an incident in the context - of ESS (Environmental and Social Standards) - $ref: '#/components/schemas/urn_bamm_io.catenax.essincident_1.0.0_EssContactInformationEntity' - required: - - essIncidentInformation - - essProductInformation - - essCompanyInformation - 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' - EssIncident: - content: - application/json: - schema: - $ref: '#/components/schemas/EssIncident' - description: The request was successful. - requestBodies: - EssIncident: - content: - application/json: - schema: - $ref: '#/components/schemas/EssIncident' diff --git a/io.catenax.essincident/1.0.0/metadata.json b/io.catenax.essincident/1.0.0/metadata.json deleted file mode 100644 index bf40b864e..000000000 --- a/io.catenax.essincident/1.0.0/metadata.json +++ /dev/null @@ -1 +0,0 @@ -{ "status" : "deprecate"} diff --git a/io.catenax.essincident/2.0.0/metadata.json b/io.catenax.essincident/2.0.0/metadata.json index c22749aed..bf40b864e 100644 --- a/io.catenax.essincident/2.0.0/metadata.json +++ b/io.catenax.essincident/2.0.0/metadata.json @@ -1 +1 @@ -{ "status" : "release"} +{ "status" : "deprecate"} diff --git a/io.catenax.essincident/4.0.0/EssIncident.ttl b/io.catenax.essincident/4.0.0/EssIncident.ttl new file mode 100644 index 000000000..0744b934b --- /dev/null +++ b/io.catenax.essincident/4.0.0/EssIncident.ttl @@ -0,0 +1,352 @@ +####################################################################### +# Copyright (c) 2022, 2023, 2024 ZF Friedrichshafen AG +# Copyright (c) 2022, 2023, 2024 T-Systems International GmbH +# Copyright (c) 2022, 2023, 2024 Robert Bosch Manufacturing Solutions GmbH +# Copyright (c) 2023, 2024 SAP AG +# Copyright (c) 2023, 2024 Capgemini +# Copyright (c) 2022, 2023, 2024 Contributors to the Eclipse Foundation +# +# 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-characteristic: . +@prefix ext-number: . +@prefix ext-uuid: . + +:EssIncident a samm:Aspect ; + samm:preferredName "ESS Incident"@en ; + samm:description "Aspect for defining an incident in context of Environmental and Social Standards as specified by the Catena-X Sustainability team."@en ; + samm:properties ( [ samm:property :productCommodity; samm:optional true ] :productDescription [ samm:property :rawMaterial; samm:optional true ] [ samm:property :industry; samm:optional true ] :incidentCategory :incidentSubcategory [ samm:property :incidentSubject; samm:optional true ] [ samm:property :incidentExternalSubject; samm:optional true ] :incidentDescription [ samm:property :incidentExternalNotes; samm:optional true ] [ samm:property :incidentAttachment; samm:optional true ] :systemDate :incidentDate :incidentId [ samm:property :masterOpCoId; samm:optional true ] [ samm:property :incidentDisplayId; samm:optional true ] :incidentStatusInformation [ samm:property :incidentShareFlag; samm:optional true ] [ samm:property :subCaseOpCoIds; samm:optional true ] [ samm:property :incidentSystemId; samm:optional true ] [ samm:property :essOriginatorCompanyName; samm:optional true ] [ samm:property :essOriginatorAddress; samm:optional true ] [ samm:property :essOriginatorBpnL; samm:optional true ] [ samm:property :essOriginatorBpnS; samm:optional true ] [ samm:property :essOriginatorBpnA; samm:optional true ] [ samm:property :essOriginatorCoordinates; samm:optional true ] [ samm:property :essIncidentIssuerFirstName; samm:optional true ] [ samm:property :essIncidentIssuerEmailAddress; samm:optional true ] [ samm:property :essIncidentIssuerPhoneNo; samm:optional true ] [ samm:property :flagAnonymous; samm:optional true ] [ samm:property :essIncidentIssuerId; samm:optional true ] [ samm:property :essIncidentIssuerAddress; samm:optional true ] [ samm:property :essIncidentIssuerLastName; samm:optional true ] [ samm:property :essOriginatorCountrySubdivision; samm:optional true ] [ samm:property :essIncidentIssuerCountrySubdivision; samm:optional true ] [ samm:property :essIncidentModerator; samm:optional true ] ) ; + samm:operations ( ) ; + samm:events ( ) . + +:productCommodity a samm:Property ; + samm:preferredName "Product Commodity"@en ; + samm:description "Free-text description for commodity of a product affected by an incident in the context of ESS (Environmental and Social Standards)"@en ; + samm:characteristic samm-c:Text ; + samm:exampleValue "Tire" . + +:productDescription a samm:Property ; + samm:preferredName "Product Description"@en ; + samm:description "Description of product or component affected by an incident in the context of ESS (Environmental and Social Standards) "@en ; + samm:characteristic samm-c:Text ; + samm:exampleValue "Natural Rubber" . + +:rawMaterial a samm:Property ; + samm:preferredName "Raw Material"@en ; + samm:description "Raw material that causes an incident in the context of ESS (Environmental and Social Standards)"@en ; + samm:characteristic samm-c:Text ; + samm:exampleValue "Natural Rubber" . + +:industry a samm:Property ; + samm:preferredName "Industry / Branch"@en ; + samm:description "Industry / Branch that causes the incident"@en ; + samm:characteristic :IndustryCharacteristic ; + samm:exampleValue "Extraction of raw material" . + +:incidentCategory a samm:Property ; + samm:preferredName "Incident Category"@en ; + samm:description "Environmental and social standards related incident category according to Supply Chain Due Diligence Act"@en ; + samm:see ; + samm:characteristic :IncidentCategoryCharacteristic ; + samm:exampleValue "Social" . + +:incidentSubcategory a samm:Property ; + samm:preferredName "Incident Subcategory"@en ; + samm:description "Subcategory of an incident Category"@en ; + samm:characteristic :IncidentSubcategories ; + samm:exampleValue "Child labour" . + +:incidentSubject a samm:Property ; + samm:preferredName "Incident Subject"@en ; + samm:description "Title/ subject of an incident in the context of ESS (Environmental and Social Standards)"@en ; + samm:characteristic samm-c:Text ; + samm:exampleValue "Child labour on rubber producer Farm A" . + +:incidentExternalSubject a samm:Property ; + samm:preferredName "External Subject"@en ; + samm:description "Replaces Incident Subject for external communication"@en ; + samm:characteristic samm-c:Text ; + samm:exampleValue "Child labour on a rubber producer farm" . + +:incidentDescription a samm:Property ; + samm:preferredName "Incident Description"@en ; + samm:description "Full text description of an incident in the context of ESS (Environmental and Social Standards)"@en ; + samm:characteristic samm-c:Text ; + samm:exampleValue "Child labour at production site of the rubber producer Farm A in Brazil" . + +:incidentExternalNotes a samm:Property ; + samm:preferredName "External Notes"@en ; + samm:description "Incident description for external communication"@en ; + samm:characteristic samm-c:Text ; + samm:exampleValue "Child labour at production site of a rubber producer in Brazil" . + +:incidentAttachment a samm:Property ; + samm:preferredName "Incident Attachment"@en ; + samm:description "Picture(s) about the reported incident in the context of ESS (Environmental and Social Standards)"@en ; + samm:characteristic samm-c:ResourcePath . + +:systemDate a samm:Property ; + samm:preferredName "System Date"@en ; + samm:description "System created timestamp when the incident in the context of ESS (Environmental and Social Standards) was issued and saved"@en ; + samm:characteristic samm-c:Timestamp ; + samm:exampleValue "2022-08-31T23:22:12Z"^^xsd:dateTime . + +:incidentDate a samm:Property ; + samm:preferredName "Date of Incident"@en ; + samm:description "Date and time information when an incident in the context of ESS (Environmental and Social Standards) occurred"@en ; + samm:characteristic samm-c:Timestamp ; + samm:exampleValue "2022-08-31T00:00:00Z"^^xsd:dateTime . + +:incidentId a samm:Property ; + samm:preferredName "Incident ID"@en ; + samm:description "Unique identifier for an incident in the context of ESS (Environmental and Social Standards)"@en ; + samm:characteristic ext-uuid:UuidV4Trait ; + samm:exampleValue "9f47b3c8-b6d4-44f1-99ba-6bdb33916cac" . + +:masterOpCoId a samm:Property ; + samm:preferredName "Master Operating Company Incident ID"@en ; + samm:description "Incident ID that has been checked and validated. In case of duplicates the \"parent\" incident ID will be used as Master Operating Company Incident ID."@en ; + samm:characteristic ext-uuid:UuidV4Trait ; + samm:exampleValue "9f47b3c8-b6d4-44f1-99ba-6bdb33916cac" . + +:incidentDisplayId a samm:Property ; + samm:preferredName "Display ID"@en ; + samm:description "Human readable format of Incident ID"@en ; + samm:characteristic samm-c:Text ; + samm:exampleValue "123456789101" . + +:incidentStatusInformation a samm:Property ; + samm:preferredName "Incident Status"@en ; + samm:description "Status of incident progress, default value = new"@en ; + samm:characteristic :IncidentStatusCharacteristic ; + samm:exampleValue "new" . + +:incidentShareFlag a samm:Property ; + samm:preferredName "Incident Share Flag"@en ; + samm:description "Flag, that can be set to true in order to request to publish the incident, default value is false"@en ; + samm:characteristic samm-c:Boolean ; + samm:exampleValue false . + +:subCaseOpCoIds a samm:Property ; + samm:preferredName "Sub Case Operating Company Incident Ids"@en ; + samm:description "Incident Ids that belong to a Master Operating Company Incident Id"@en ; + samm:characteristic samm-c:Text ; + samm:exampleValue "9f47b3c8-b6d4-44f1-99ba-6bdb33916cac, 9f47b3c8-b6d4-44f1-99ba-6bdb33916cad" . + +:incidentSystemId a samm:Property ; + samm:preferredName "Incident System Id"@en ; + samm:description "System Id that defines the tenant"@en ; + samm:characteristic samm-c:Text ; + samm:exampleValue "123456789" . + +:essOriginatorCompanyName a samm:Property ; + samm:preferredName "ESS Originator Company Name"@en ; + samm:description "Name of a company / an organisation that is the originator of an incident in the context of ESS (Environmental and Social Standards)"@en ; + samm:characteristic samm-c:Text ; + samm:exampleValue "Rubbery Ltd." . + +:essOriginatorAddress a samm:Property ; + samm:preferredName "Ess Originator Address"@en ; + samm:description "Address of ESS Originator "@en ; + samm:characteristic ext-characteristic:PostalAddress . + +:essOriginatorBpnL a samm:Property ; + samm:preferredName "ESS Originator BPN-L"@en ; + samm:description "BPN-L ID of the company that causes the incident"@en ; + samm:characteristic ext-number:BpnlCharacteristic ; + samm:exampleValue "BPNL1234567890ZZ" . + +:essOriginatorBpnS a samm:Property ; + samm:preferredName "ESS Originator BPN-S"@en ; + samm:description "BPN-S ID of the company that causes the incident"@en ; + samm:characteristic ext-number:BpnsCharacteristic ; + samm:exampleValue "BPNS1234567890ZZ" . + +:essOriginatorBpnA a samm:Property ; + samm:preferredName "ESS Originator BPN A"@en ; + samm:description "BPN-A ID of the company that causes the incident"@en ; + samm:characteristic ext-number:BpnaCharacteristic ; + samm:exampleValue "BPNA1234567890ZZ" . + +:essOriginatorCoordinates a samm:Property ; + samm:preferredName "ESS Originator Geographic data / Coordinates"@en ; + samm:description "Exact geographic position of an incident in the context of ESS (Environmental and Social Standards)"@en ; + samm:characteristic :EssOriginatorCoordinatesCharacteristic . + +:essIncidentIssuerFirstName a samm:Property ; + samm:preferredName "ESS Incident Issuer First Name"@en ; + samm:description "First name of ESS incident issuer"@en ; + samm:characteristic samm-c:Text ; + samm:exampleValue "Testuser First name" . + +:essIncidentIssuerEmailAddress a samm:Property ; + samm:preferredName "ESS Incident Issuer Email Address"@en ; + samm:description "Email address of ESS incident issuer"@en ; + samm:characteristic :ContactMailTrait ; + samm:exampleValue "test@example.com" . + +:essIncidentIssuerPhoneNo a samm:Property ; + samm:preferredName "ESS Incident Issuer Phone No"@en ; + samm:description "Phone number of ESS incident issuer"@en ; + samm:characteristic samm-c:Text ; + samm:exampleValue "+49-123-456789" . + +:flagAnonymous a samm:Property ; + samm:preferredName "Flag anonymous"@en ; + samm:description "Flag that Incident issuer wants to be anonymous"@en ; + samm:characteristic samm-c:Boolean ; + samm:exampleValue false . + +:essIncidentIssuerId a samm:Property ; + samm:preferredName "Issuer ID"@en ; + samm:description "System generated unique identifier of incident issuer"@en ; + samm:characteristic ext-uuid:UuidV4Trait ; + samm:exampleValue "9a47b3c8-b6d4-44f1-99ba-6bdb33916cac" . + +:essIncidentIssuerAddress a samm:Property ; + samm:preferredName "Ess Incident Issuer Address"@en ; + samm:description "Simple form of an address which can belong to a person, organisation, company etc."@en ; + samm:characteristic ext-characteristic:PostalAddress . + +:essIncidentIssuerLastName a samm:Property ; + samm:preferredName "ESS Incident Issuer Last Name"@en ; + samm:description "Last name of ESS incident Issuer"@en ; + samm:characteristic samm-c:Text ; + samm:exampleValue "Testuser Last name" . + +:essOriginatorCountrySubdivision a samm:Property ; + samm:preferredName "ESS Originator Country Subdivision"@en ; + samm:description "Region within a country of ESS Originator"@en ; + samm:characteristic samm-c:Text ; + samm:exampleValue "BR-SP" . + +:essIncidentIssuerCountrySubdivision a samm:Property ; + samm:preferredName "ESS Incident Issuer Country Subdivision"@en ; + samm:description "Region within a country of ESS Incident Issuer"@en ; + samm:characteristic samm-c:Text ; + samm:exampleValue "IN-AP" . + +:essIncidentModerator a samm:Property ; + samm:preferredName "Incident Moderator"@en ; + samm:description "Business Partner who moderates the clearing of an ESS incident"@en ; + samm:characteristic :EssIncidentModeratorCharacteristic ; + samm:exampleValue "BPNL1234567890YY" . + +:IndustryCharacteristic a samm-c:Enumeration ; + samm:preferredName "Industry characteristic"@en ; + samm:description "Industry Characteristic"@en ; + samm:dataType xsd:string ; + samm-c:values ( "Extraction of raw materials" "Manufacture of components / intermediates" "Manufacture of final products" "Distribution / Trade" "Waste treatment / recycling" "Services" "Lending / financing / insurance" "Other" ) . + +:IncidentCategoryCharacteristic a samm-c:Enumeration ; + samm:preferredName "Incident Category Characteristic"@en ; + samm:description "Characteristic for defining an incident category in the context of ESS (Environmental and Social Standards)."@en ; + samm:dataType xsd:string ; + samm-c:values ( "Environmental" "Social" ) . + +:IncidentSubcategories a samm-c:Enumeration ; + samm:preferredName "Incident Subcategories"@en ; + samm:description "Characteristic for defining subcategories of an incident in the context of ESS (Environmental and Social Standards)."@en ; + samm:dataType xsd:string ; + samm-c:values ( "Child labour" "Forced labour" "Slavery" "Work safety" "Freedom of association" "Discrimination" "Minimum wage" "Environmental pollution" "Forced eviction" "Force by state security" "Usage of Mercury" "Usage of harmful chemicals" "Non-environmental friendly handling of waste" "Import and export of hazardous waste" ) . + +:IncidentStatusCharacteristic a samm-c:Enumeration ; + samm:preferredName "Incident Status"@en ; + samm:description "Incident status as defined in a list, default value = new"@en ; + samm:dataType xsd:string ; + samm-c:values ( "new" "in cleansing" "in process" "completed" "closed" ) . + +:EssOriginatorCoordinatesCharacteristic a samm-c:SingleEntity ; + samm:preferredName "ESS Originator Coordinates Characteristic"@en ; + samm:description "Characteristic for defining geographic coordinates (longitude and latitude) of an incident originator in context of ESS (Environmental and Social Standards)."@en ; + samm:dataType :EssOriginatorCoordinatesEntity . + +:ContactMailTrait a samm-c:Trait ; + samm:preferredName "Contact Mail Trait"@en ; + samm:description "Trait for a contact mail address."@en ; + samm-c:baseCharacteristic samm-c:Text ; + samm-c:constraint :ContactMailConstraint . + +:EssIncidentModeratorCharacteristic a samm-c:Set ; + samm:preferredName "Ess Incident Moderator Characteristic"@en ; + samm:description "Business Partner(s) who moderate(s) the clearing of an ESS incident"@en ; + samm:dataType xsd:string ; + samm-c:elementCharacteristic :BPNLTrait . + +:EssOriginatorCoordinatesEntity a samm:Entity ; + samm:preferredName "ESS Originator Coordinates Entity"@en ; + samm:description "Entity for geographic coordinates including a longitude and a latitude value."@en ; + samm:properties ( :longitude :latitude ) . + +:ContactMailConstraint a samm-c:RegularExpressionConstraint ; + samm:preferredName "Contact Mail Constraint"@en ; + samm:description "Regular expression for a contact mail address."@en ; + samm:value "^[a-zA-Z0-9.!#$%&?*+\\/=?^_`{|}~-]+@[a-zA-Z0-9-]+(?:\\.[a-zA-Z0-9-]+)*$" . + +:BPNLTrait a samm-c:Trait ; + samm:preferredName "BPNL Trait"@en ; + samm:description "Trait to ensure data format for BPNL."@en ; + samm-c:baseCharacteristic ext-number:BpnlCharacteristic ; + samm-c:constraint ext-number:BpnlRegularExpression . + +:longitude a samm:Property ; + samm:preferredName "Longitude"@en ; + samm:description "Longitude information for geographic coordinates."@en ; + samm:characteristic :LongitudeTrait ; + samm:exampleValue "-79.517415" . + +:latitude a samm:Property ; + samm:preferredName "Latitude"@en ; + samm:description "Latitude information for geographic coordinates."@en ; + samm:characteristic :LatitudeTrait ; + samm:exampleValue "-5.422077" . + +:LongitudeTrait a samm-c:Trait ; + samm:preferredName "Longitude Trait"@en ; + samm:description "Trait for longitude information belonging to geographic coordinates."@en ; + samm-c:baseCharacteristic :LongitudeCharacteristic ; + samm-c:constraint :LongitudeConstraint . + +:LatitudeTrait a samm-c:Trait ; + samm:preferredName "Latitude Trait"@en ; + samm:description "Trait for latitude information belonging to geographic coordinates."@en ; + samm-c:baseCharacteristic :LatitudeCharacteristic ; + samm-c:constraint :LatitudeConstraint . + +:LongitudeCharacteristic a samm:Characteristic ; + samm:preferredName "Longitude Characteristic"@en ; + samm:description "Characteristic for longitude information of geographic coordinates."@en ; + samm:dataType xsd:string . + +:LongitudeConstraint a samm-c:RegularExpressionConstraint ; + samm:preferredName "Longitude Constraint"@en ; + samm:description "Regular expression for longitude information."@en ; + samm:value "^(\\+|-)?(?:180(?:(?:\\.0{1,6})?)|(?:[0-9]|[1-9][0-9]|1[0-7][0-9])(?:(?:\\.[0-9]{1,6})?))$" . + +:LatitudeCharacteristic a samm:Characteristic ; + samm:preferredName "Latitude Characteristic"@en ; + samm:description "Characteristic for latitude information of geographic coordinates."@en ; + samm:dataType xsd:string . + +:LatitudeConstraint a samm-c:RegularExpressionConstraint ; + samm:preferredName "Latitude Constraint"@en ; + samm:description "Regular expression for latitude information of geographic coordinates."@en ; + samm:value "^(\\+|-)?(?:90(?:(?:\\.0{1,6})?)|(?:[0-9]|[1-8][0-9])(?:(?:\\.[0-9]{1,6})?))$" . + diff --git a/io.catenax.essincident/4.0.0/gen/EssIncident-aas.xml b/io.catenax.essincident/4.0.0/gen/EssIncident-aas.xml new file mode 100644 index 000000000..2f89c0f0f --- /dev/null +++ b/io.catenax.essincident/4.0.0/gen/EssIncident-aas.xml @@ -0,0 +1,5710 @@ + + + + + defaultAdminShell + + + en + defaultAdminShell + + + + urn:samm:io.catenax.essincident:4.0.0#EssIncident + + Type + + + + ModelReference + + + Submodel + urn:samm:io.catenax.essincident:4.0.0#EssIncident/submodel + + + + + + + + + EssIncident + + + en + Aspect for defining an incident in context of Environmental and Social Standards as specified by the Catena-X Sustainability team. + + + + urn:samm:io.catenax.essincident:4.0.0#EssIncident/submodel + Template + + ModelReference + + + ConceptDescription + urn:samm:io.catenax.essincident:4.0.0#EssIncident + + + + + + productCommodity + + + en + Product Commodity + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.essincident:4.0.0#productCommodity + + + + xs:string + + + + productDescription + + + en + Product Description + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.essincident:4.0.0#productDescription + + + + xs:string + + + + rawMaterial + + + en + Raw Material + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.essincident:4.0.0#rawMaterial + + + + xs:string + + + + industry + + + en + Industry / Branch + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.essincident:4.0.0#industry + + + + xs:string + + + + incidentCategory + + + en + Incident Category + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.essincident:4.0.0#incidentCategory + + + + + + ExternalReference + + + GlobalReference + https://www.gesetze-im-internet.de/lksg/ + + + + + xs:string + + + + incidentSubcategory + + + en + Incident Subcategory + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.essincident:4.0.0#incidentSubcategory + + + + xs:string + + + + incidentSubject + + + en + Incident Subject + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.essincident:4.0.0#incidentSubject + + + + xs:string + + + + incidentExternalSubject + + + en + External Subject + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.essincident:4.0.0#incidentExternalSubject + + + + xs:string + + + + incidentDescription + + + en + Incident Description + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.essincident:4.0.0#incidentDescription + + + + xs:string + + + + incidentExternalNotes + + + en + External Notes + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.essincident:4.0.0#incidentExternalNotes + + + + xs:string + + + + incidentAttachment + + + en + Incident Attachment + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.essincident:4.0.0#incidentAttachment + + + + xs:anyURI + + + + systemDate + + + en + System Date + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.essincident:4.0.0#systemDate + + + + xs:dateTime + + + + incidentDate + + + en + Date of Incident + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.essincident:4.0.0#incidentDate + + + + xs:dateTime + + + + incidentId + + + en + Incident ID + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.essincident:4.0.0#incidentId + + + + xs:string + + + + masterOpCoId + + + en + Master Operating Company Incident ID + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.essincident:4.0.0#masterOpCoId + + + + xs:string + + + + incidentDisplayId + + + en + Display ID + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.essincident:4.0.0#incidentDisplayId + + + + xs:string + + + + incidentStatusInformation + + + en + Incident Status + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.essincident:4.0.0#incidentStatusInformation + + + + xs:string + + + + incidentShareFlag + + + en + Incident Share Flag + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.essincident:4.0.0#incidentShareFlag + + + + xs:boolean + + + + subCaseOpCoIds + + + en + Sub Case Operating Company Incident Ids + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.essincident:4.0.0#subCaseOpCoIds + + + + xs:string + + + + incidentSystemId + + + en + Incident System Id + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.essincident:4.0.0#incidentSystemId + + + + xs:string + + + + essOriginatorCompanyName + + + en + ESS Originator Company Name + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.essincident:4.0.0#essOriginatorCompanyName + + + + xs:string + + + + AddressEntity + + + en + Address Entity + + + + + en + Entity of an address. Model follows specification of BPDM (Business Partner Data Management). + + + + + ThoroughfareEntity + + + en + Thoroughfare Entity + + + + + en + Entity for a thoroughfare which consists of a type, value and number. + + + + + thoroughfareTechnicalKey + + + en + Thoroughfare Technical Key + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.shared.address_characteristic:4.0.0#thoroughfareTechnicalKey + + + + xs:string + + + + thoroughfareValue + + + en + Value Thoroughfare + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.shared.address_characteristic:4.0.0#thoroughfareValue + + + + xs:string + + + + thoroughfareNumber + + + en + Thoroughfare Number + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.shared.address_characteristic:4.0.0#thoroughfareNumber + + + + xs:string + + + + + + LocalityEntity + + + en + Locality Entity + + + + + en + Entity for a locality which consists of a key and a value. + + + + + localityTechnicalKey + + + en + Locality Technical Key + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.shared.address_characteristic:4.0.0#localityTechnicalKey + + + + xs:string + + + + localityValue + + + en + Locality Value + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.shared.address_characteristic:4.0.0#localityValue + + + + xs:string + + + + + + PremiseEntity + + + en + Premise Entity + + + + + en + Entity for a premise which consists of a type (technical key) and a value. + + + + + premiseTechnicalKey + + + en + Premise Technical Key + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.shared.address_characteristic:4.0.0#premiseTechnicalKey + + + + xs:string + + + + premiseValue + + + en + Premise Value + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.shared.address_characteristic:4.0.0#premiseValue + + + + xs:string + + + + + + PostalDeliveryPointEntity + + + en + Postal Delivery Point Entity + + + + + en + Entity for a postal delivery point which consists of a technical key and a value. + + + + + postalDeliveryPointTechnicalKey + + + en + Postal Delivery Point Technical Key + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.shared.address_characteristic:4.0.0#postalDeliveryPointTechnicalKey + + + + xs:string + + + + postalDeliveryPointValue + + + en + Postal Delivery Point Value + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.shared.address_characteristic:4.0.0#postalDeliveryPointValue + + + + xs:string + + + + + + CountryEntity + + + en + Country Entity + + + + + en + Entity definition for a country. + + + + + countryShortName + + + en + Country Short Name + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.shared.address_characteristic:4.0.0#countryShortName + + + + xs:string + + + + + + PostCodeEntity + + + en + PostCode Entity + + + + + en + Entity for a postcode which consists of a type plus a value. + + + + + postCodeValue + + + en + Post Code Value + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.shared.address_characteristic:4.0.0#postCodeValue + + + + xs:string + + + + postCodeTechnicalKey + + + en + Post Code Technical Key + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.shared.address_characteristic:4.0.0#postCodeTechnicalKey + + + + xs:string + + + + + + + + essOriginatorBpnL + + + en + ESS Originator BPN-L + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.essincident:4.0.0#essOriginatorBpnL + + + + xs:string + + + + essOriginatorBpnS + + + en + ESS Originator BPN-S + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.essincident:4.0.0#essOriginatorBpnS + + + + xs:string + + + + essOriginatorBpnA + + + en + ESS Originator BPN A + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.essincident:4.0.0#essOriginatorBpnA + + + + xs:string + + + + EssOriginatorCoordinatesEntity + + + en + ESS Originator Coordinates Entity + + + + + en + Entity for geographic coordinates including a longitude and a latitude value. + + + + + longitude + + + en + Longitude + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.essincident:4.0.0#longitude + + + + xs:string + + + + latitude + + + en + Latitude + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.essincident:4.0.0#latitude + + + + xs:string + + + + + + essIncidentIssuerFirstName + + + en + ESS Incident Issuer First Name + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.essincident:4.0.0#essIncidentIssuerFirstName + + + + xs:string + + + + essIncidentIssuerEmailAddress + + + en + ESS Incident Issuer Email Address + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.essincident:4.0.0#essIncidentIssuerEmailAddress + + + + xs:string + + + + essIncidentIssuerPhoneNo + + + en + ESS Incident Issuer Phone No + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.essincident:4.0.0#essIncidentIssuerPhoneNo + + + + xs:string + + + + flagAnonymous + + + en + Flag anonymous + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.essincident:4.0.0#flagAnonymous + + + + xs:boolean + + + + essIncidentIssuerId + + + en + Issuer ID + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.essincident:4.0.0#essIncidentIssuerId + + + + xs:string + + + + AddressEntity + + + en + Address Entity + + + + + en + Entity of an address. Model follows specification of BPDM (Business Partner Data Management). + + + + + ThoroughfareEntity + + + en + Thoroughfare Entity + + + + + en + Entity for a thoroughfare which consists of a type, value and number. + + + + + thoroughfareTechnicalKey + + + en + Thoroughfare Technical Key + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.shared.address_characteristic:4.0.0#thoroughfareTechnicalKey + + + + xs:string + + + + thoroughfareValue + + + en + Value Thoroughfare + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.shared.address_characteristic:4.0.0#thoroughfareValue + + + + xs:string + + + + thoroughfareNumber + + + en + Thoroughfare Number + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.shared.address_characteristic:4.0.0#thoroughfareNumber + + + + xs:string + + + + + + LocalityEntity + + + en + Locality Entity + + + + + en + Entity for a locality which consists of a key and a value. + + + + + localityTechnicalKey + + + en + Locality Technical Key + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.shared.address_characteristic:4.0.0#localityTechnicalKey + + + + xs:string + + + + localityValue + + + en + Locality Value + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.shared.address_characteristic:4.0.0#localityValue + + + + xs:string + + + + + + PremiseEntity + + + en + Premise Entity + + + + + en + Entity for a premise which consists of a type (technical key) and a value. + + + + + premiseTechnicalKey + + + en + Premise Technical Key + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.shared.address_characteristic:4.0.0#premiseTechnicalKey + + + + xs:string + + + + premiseValue + + + en + Premise Value + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.shared.address_characteristic:4.0.0#premiseValue + + + + xs:string + + + + + + PostalDeliveryPointEntity + + + en + Postal Delivery Point Entity + + + + + en + Entity for a postal delivery point which consists of a technical key and a value. + + + + + postalDeliveryPointTechnicalKey + + + en + Postal Delivery Point Technical Key + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.shared.address_characteristic:4.0.0#postalDeliveryPointTechnicalKey + + + + xs:string + + + + postalDeliveryPointValue + + + en + Postal Delivery Point Value + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.shared.address_characteristic:4.0.0#postalDeliveryPointValue + + + + xs:string + + + + + + CountryEntity + + + en + Country Entity + + + + + en + Entity definition for a country. + + + + + countryShortName + + + en + Country Short Name + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.shared.address_characteristic:4.0.0#countryShortName + + + + xs:string + + + + + + PostCodeEntity + + + en + PostCode Entity + + + + + en + Entity for a postcode which consists of a type plus a value. + + + + + postCodeValue + + + en + Post Code Value + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.shared.address_characteristic:4.0.0#postCodeValue + + + + xs:string + + + + postCodeTechnicalKey + + + en + Post Code Technical Key + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.shared.address_characteristic:4.0.0#postCodeTechnicalKey + + + + xs:string + + + + + + + + essIncidentIssuerLastName + + + en + ESS Incident Issuer Last Name + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.essincident:4.0.0#essIncidentIssuerLastName + + + + xs:string + + + + essOriginatorCountrySubdivision + + + en + ESS Originator Country Subdivision + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.essincident:4.0.0#essOriginatorCountrySubdivision + + + + xs:string + + + + essIncidentIssuerCountrySubdivision + + + en + ESS Incident Issuer Country Subdivision + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.essincident:4.0.0#essIncidentIssuerCountrySubdivision + + + + xs:string + + + + essIncidentModerator + + + en + Incident Moderator + + + + + en + Business Partner who moderates the clearing of an ESS incident + + + true + DataElement + + + essIncidentModerator + + + en + Incident Moderator + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.essincident:4.0.0#essIncidentModerator + + + + xs:string + + + + + + + + + + APPLICATION_CLASS + EssIncident + + + en + ESS Incident + + + + + en + Aspect for defining an incident in context of Environmental and Social Standards as specified by the Catena-X Sustainability team. + + + urn:samm:io.catenax.essincident:4.0.0#EssIncident + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + ESS Incident + + + + + en + EssIncident + + + + + en + Aspect for defining an incident in context of Environmental and Social Standards as specified by the Catena-X Sustainability team. + + + + + + + + + productCommodity + + + en + Product Commodity + + + urn:samm:io.catenax.essincident:4.0.0#productCommodity + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Product Commodity + + + + + en + productCommodity + + + STRING + + + en + Free-text description for commodity of a product affected by an incident in the context of ESS (Environmental and Social Standards) + + + + + + + + + productDescription + + + en + Product Description + + + urn:samm:io.catenax.essincident:4.0.0#productDescription + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Product Description + + + + + en + productDescription + + + STRING + + + en + Description of product or component affected by an incident in the context of ESS (Environmental and Social Standards) + + + + + + + + + rawMaterial + + + en + Raw Material + + + urn:samm:io.catenax.essincident:4.0.0#rawMaterial + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Raw Material + + + + + en + rawMaterial + + + STRING + + + en + Raw material that causes an incident in the context of ESS (Environmental and Social Standards) + + + + + + + + + industry + + + en + Industry / Branch + + + urn:samm:io.catenax.essincident:4.0.0#industry + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Industry / Branch + + + + + en + industry + + + STRING + + + en + Industry / Branch that causes the incident + + + + + + Extraction of raw materials + + ModelReference + + + DataElement + urn:samm:io.catenax.essincident:4.0.0#IndustryCharacteristic:Extraction of raw materials + + + + + + Manufacture of components / intermediates + + ModelReference + + + DataElement + urn:samm:io.catenax.essincident:4.0.0#IndustryCharacteristic:Manufacture of components / intermediates + + + + + + Manufacture of final products + + ModelReference + + + DataElement + urn:samm:io.catenax.essincident:4.0.0#IndustryCharacteristic:Manufacture of final products + + + + + + Distribution / Trade + + ModelReference + + + DataElement + urn:samm:io.catenax.essincident:4.0.0#IndustryCharacteristic:Distribution / Trade + + + + + + Waste treatment / recycling + + ModelReference + + + DataElement + urn:samm:io.catenax.essincident:4.0.0#IndustryCharacteristic:Waste treatment / recycling + + + + + + Services + + ModelReference + + + DataElement + urn:samm:io.catenax.essincident:4.0.0#IndustryCharacteristic:Services + + + + + + Lending / financing / insurance + + ModelReference + + + DataElement + urn:samm:io.catenax.essincident:4.0.0#IndustryCharacteristic:Lending / financing / insurance + + + + + + Other + + ModelReference + + + DataElement + urn:samm:io.catenax.essincident:4.0.0#IndustryCharacteristic:Other + + + + + + + + + + + + + incidentCategory + + + en + Incident Category + + + urn:samm:io.catenax.essincident:4.0.0#incidentCategory + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Incident Category + + + + + en + incidentCategory + + + STRING + + + en + Environmental and social standards related incident category according to Supply Chain Due Diligence Act + + + + + + Environmental + + ModelReference + + + DataElement + urn:samm:io.catenax.essincident:4.0.0#IncidentCategoryCharacteristic:Environmental + + + + + + Social + + ModelReference + + + DataElement + urn:samm:io.catenax.essincident:4.0.0#IncidentCategoryCharacteristic:Social + + + + + + + + + + + + + incidentSubcategory + + + en + Incident Subcategory + + + urn:samm:io.catenax.essincident:4.0.0#incidentSubcategory + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Incident Subcategory + + + + + en + incidentSubcategory + + + STRING + + + en + Subcategory of an incident Category + + + + + + Child labour + + ModelReference + + + DataElement + urn:samm:io.catenax.essincident:4.0.0#IncidentSubcategories:Child labour + + + + + + Forced labour + + ModelReference + + + DataElement + urn:samm:io.catenax.essincident:4.0.0#IncidentSubcategories:Forced labour + + + + + + Slavery + + ModelReference + + + DataElement + urn:samm:io.catenax.essincident:4.0.0#IncidentSubcategories:Slavery + + + + + + Work safety + + ModelReference + + + DataElement + urn:samm:io.catenax.essincident:4.0.0#IncidentSubcategories:Work safety + + + + + + Freedom of association + + ModelReference + + + DataElement + urn:samm:io.catenax.essincident:4.0.0#IncidentSubcategories:Freedom of association + + + + + + Discrimination + + ModelReference + + + DataElement + urn:samm:io.catenax.essincident:4.0.0#IncidentSubcategories:Discrimination + + + + + + Minimum wage + + ModelReference + + + DataElement + urn:samm:io.catenax.essincident:4.0.0#IncidentSubcategories:Minimum wage + + + + + + Environmental pollution + + ModelReference + + + DataElement + urn:samm:io.catenax.essincident:4.0.0#IncidentSubcategories:Environmental pollution + + + + + + Forced eviction + + ModelReference + + + DataElement + urn:samm:io.catenax.essincident:4.0.0#IncidentSubcategories:Forced eviction + + + + + + Force by state security + + ModelReference + + + DataElement + urn:samm:io.catenax.essincident:4.0.0#IncidentSubcategories:Force by state security + + + + + + Usage of Mercury + + ModelReference + + + DataElement + urn:samm:io.catenax.essincident:4.0.0#IncidentSubcategories:Usage of Mercury + + + + + + Usage of harmful chemicals + + ModelReference + + + DataElement + urn:samm:io.catenax.essincident:4.0.0#IncidentSubcategories:Usage of harmful chemicals + + + + + + Non-environmental friendly handling of waste + + ModelReference + + + DataElement + urn:samm:io.catenax.essincident:4.0.0#IncidentSubcategories:Non-environmental friendly handling of waste + + + + + + Import and export of hazardous waste + + ModelReference + + + DataElement + urn:samm:io.catenax.essincident:4.0.0#IncidentSubcategories:Import and export of hazardous waste + + + + + + + + + + + + + incidentSubject + + + en + Incident Subject + + + urn:samm:io.catenax.essincident:4.0.0#incidentSubject + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Incident Subject + + + + + en + incidentSubject + + + STRING + + + en + Title/ subject of an incident in the context of ESS (Environmental and Social Standards) + + + + + + + + + incidentExternalSubject + + + en + External Subject + + + urn:samm:io.catenax.essincident:4.0.0#incidentExternalSubject + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + External Subject + + + + + en + incidentExternalSubject + + + STRING + + + en + Replaces Incident Subject for external communication + + + + + + + + + incidentDescription + + + en + Incident Description + + + urn:samm:io.catenax.essincident:4.0.0#incidentDescription + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Incident Description + + + + + en + incidentDescription + + + STRING + + + en + Full text description of an incident in the context of ESS (Environmental and Social Standards) + + + + + + + + + incidentExternalNotes + + + en + External Notes + + + urn:samm:io.catenax.essincident:4.0.0#incidentExternalNotes + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + External Notes + + + + + en + incidentExternalNotes + + + STRING + + + en + Incident description for external communication + + + + + + + + + incidentAttachment + + + en + Incident Attachment + + + urn:samm:io.catenax.essincident:4.0.0#incidentAttachment + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Incident Attachment + + + + + en + incidentAttachment + + + STRING + + + en + Picture(s) about the reported incident in the context of ESS (Environmental and Social Standards) + + + + + + + + + systemDate + + + en + System Date + + + urn:samm:io.catenax.essincident:4.0.0#systemDate + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + System Date + + + + + en + systemDate + + + STRING + + + en + System created timestamp when the incident in the context of ESS (Environmental and Social Standards) was issued and saved + + + + + + + + + incidentDate + + + en + Date of Incident + + + urn:samm:io.catenax.essincident:4.0.0#incidentDate + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Date of Incident + + + + + en + incidentDate + + + STRING + + + en + Date and time information when an incident in the context of ESS (Environmental and Social Standards) occurred + + + + + + + + + incidentId + + + en + Incident ID + + + urn:samm:io.catenax.essincident:4.0.0#incidentId + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Incident ID + + + + + en + incidentId + + + STRING + + + en + Unique identifier for an incident in the context of ESS (Environmental and Social Standards) + + + + + + + + + masterOpCoId + + + en + Master Operating Company Incident ID + + + urn:samm:io.catenax.essincident:4.0.0#masterOpCoId + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Master Operating Company Incident ID + + + + + en + masterOpCoId + + + STRING + + + en + Incident ID that has been checked and validated. In case of duplicates the "parent" incident ID will be used as Master Operating Company Incident ID. + + + + + + + + + incidentDisplayId + + + en + Display ID + + + urn:samm:io.catenax.essincident:4.0.0#incidentDisplayId + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Display ID + + + + + en + incidentDisplayId + + + STRING + + + en + Human readable format of Incident ID + + + + + + + + + incidentStatusInformation + + + en + Incident Status + + + urn:samm:io.catenax.essincident:4.0.0#incidentStatusInformation + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Incident Status + + + + + en + incidentStatusInformation + + + STRING + + + en + Status of incident progress, default value = new + + + + + + new + + ModelReference + + + DataElement + urn:samm:io.catenax.essincident:4.0.0#IncidentStatusCharacteristic:new + + + + + + in cleansing + + ModelReference + + + DataElement + urn:samm:io.catenax.essincident:4.0.0#IncidentStatusCharacteristic:in cleansing + + + + + + in process + + ModelReference + + + DataElement + urn:samm:io.catenax.essincident:4.0.0#IncidentStatusCharacteristic:in process + + + + + + completed + + ModelReference + + + DataElement + urn:samm:io.catenax.essincident:4.0.0#IncidentStatusCharacteristic:completed + + + + + + closed + + ModelReference + + + DataElement + urn:samm:io.catenax.essincident:4.0.0#IncidentStatusCharacteristic:closed + + + + + + + + + + + + + incidentShareFlag + + + en + Incident Share Flag + + + urn:samm:io.catenax.essincident:4.0.0#incidentShareFlag + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Incident Share Flag + + + + + en + incidentShareFlag + + + BOOLEAN + + + en + Flag, that can be set to true in order to request to publish the incident, default value is false + + + + + + + + + subCaseOpCoIds + + + en + Sub Case Operating Company Incident Ids + + + urn:samm:io.catenax.essincident:4.0.0#subCaseOpCoIds + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Sub Case Operating Company Incident Ids + + + + + en + subCaseOpCoIds + + + STRING + + + en + Incident Ids that belong to a Master Operating Company Incident Id + + + + + + + + + incidentSystemId + + + en + Incident System Id + + + urn:samm:io.catenax.essincident:4.0.0#incidentSystemId + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Incident System Id + + + + + en + incidentSystemId + + + STRING + + + en + System Id that defines the tenant + + + + + + + + + essOriginatorCompanyName + + + en + ESS Originator Company Name + + + urn:samm:io.catenax.essincident:4.0.0#essOriginatorCompanyName + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + ESS Originator Company Name + + + + + en + essOriginatorCompanyName + + + STRING + + + en + Name of a company / an organisation that is the originator of an incident in the context of ESS (Environmental and Social Standards) + + + + + + + + + thoroughfareTechnicalKey + + + en + Thoroughfare Technical Key + + + urn:samm:io.catenax.shared.address_characteristic:4.0.0#thoroughfareTechnicalKey + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Thoroughfare Technical Key + + + + + en + thoroughfareTechnicalKey + + + STRING + + + en + Technical key of a thoroughfare. As specified by BPDM, this can be a "STREET" or a different type. + + + + + + STREET + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.address_characteristic:4.0.0#ThoroughfareTechnicalKeyCharacteristic:STREET + + + + + + INDUSTRIAL_ZONE + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.address_characteristic:4.0.0#ThoroughfareTechnicalKeyCharacteristic:INDUSTRIAL_ZONE + + + + + + OTHER + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.address_characteristic:4.0.0#ThoroughfareTechnicalKeyCharacteristic:OTHER + + + + + + RIVER + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.address_characteristic:4.0.0#ThoroughfareTechnicalKeyCharacteristic:RIVER + + + + + + SQUARE + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.address_characteristic:4.0.0#ThoroughfareTechnicalKeyCharacteristic:SQUARE + + + + + + + + + + + + + thoroughfareValue + + + en + Value Thoroughfare + + + urn:samm:io.catenax.shared.address_characteristic:4.0.0#thoroughfareValue + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Value Thoroughfare + + + + + en + thoroughfareValue + + + STRING + + + en + Value of a thoroughfare, e.g. name of a street. + + + + + + + + + thoroughfareNumber + + + en + Thoroughfare Number + + + urn:samm:io.catenax.shared.address_characteristic:4.0.0#thoroughfareNumber + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Thoroughfare Number + + + + + en + thoroughfareNumber + + + STRING + + + en + Number of a thoroughfare. As used differently in international context, this number can contain both numerical and alphanumerical values. + + + + + + + + + thoroughfare + + + en + Thoroughfare + + + urn:samm:io.catenax.shared.address_characteristic:4.0.0#thoroughfare + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Thoroughfare + + + + + en + thoroughfare + + + STRING + + + en + Street or thorough road name. + + + + + + + + + localityTechnicalKey + + + en + Locality Technical Key + + + urn:samm:io.catenax.shared.address_characteristic:4.0.0#localityTechnicalKey + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Locality Technical Key + + + + + en + localityTechnicalKey + + + STRING + + + en + Technical key of a locality. + + + + + + BLOCK + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.address_characteristic:4.0.0#LocalityTechnicalKeyCharacteristic:BLOCK + + + + + + CITY + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.address_characteristic:4.0.0#LocalityTechnicalKeyCharacteristic:CITY + + + + + + DISTRICT + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.address_characteristic:4.0.0#LocalityTechnicalKeyCharacteristic:DISTRICT + + + + + + OTHER + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.address_characteristic:4.0.0#LocalityTechnicalKeyCharacteristic:OTHER + + + + + + POST_OFFICE_CITY + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.address_characteristic:4.0.0#LocalityTechnicalKeyCharacteristic:POST_OFFICE_CITY + + + + + + QUARTER + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.address_characteristic:4.0.0#LocalityTechnicalKeyCharacteristic:QUARTER + + + + + + + + + + + + + localityValue + + + en + Locality Value + + + urn:samm:io.catenax.shared.address_characteristic:4.0.0#localityValue + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Locality Value + + + + + en + localityValue + + + STRING + + + en + Value of a locality, e.g. name of a city ("Mannheim"). + + + + + + + + + locality + + + en + Locality + + + urn:samm:io.catenax.shared.address_characteristic:4.0.0#locality + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Locality + + + + + en + locality + + + STRING + + + en + Locality belonging to an address. + + + + + + + + + premiseTechnicalKey + + + en + Premise Technical Key + + + urn:samm:io.catenax.shared.address_characteristic:4.0.0#premiseTechnicalKey + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Premise Technical Key + + + + + en + premiseTechnicalKey + + + STRING + + + en + Technical key of a premise. + + + + + + BUILDING + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.address_characteristic:4.0.0#PremiseTechnicalKeyCharacteristic:BUILDING + + + + + + HARBOUR + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.address_characteristic:4.0.0#PremiseTechnicalKeyCharacteristic:HARBOUR + + + + + + LEVEL + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.address_characteristic:4.0.0#PremiseTechnicalKeyCharacteristic:LEVEL + + + + + + OTHER + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.address_characteristic:4.0.0#PremiseTechnicalKeyCharacteristic:OTHER + + + + + + ROOM + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.address_characteristic:4.0.0#PremiseTechnicalKeyCharacteristic:ROOM + + + + + + SUITE + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.address_characteristic:4.0.0#PremiseTechnicalKeyCharacteristic:SUITE + + + + + + UNIT + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.address_characteristic:4.0.0#PremiseTechnicalKeyCharacteristic:UNIT + + + + + + WAREHOUSE + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.address_characteristic:4.0.0#PremiseTechnicalKeyCharacteristic:WAREHOUSE + + + + + + + + + + + + + premiseValue + + + en + Premise Value + + + urn:samm:io.catenax.shared.address_characteristic:4.0.0#premiseValue + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Premise Value + + + + + en + premiseValue + + + STRING + + + en + Value of a premise, e.g. name or designation of a particular site. + + + + + + + + + premise + + + en + Premise + + + urn:samm:io.catenax.shared.address_characteristic:4.0.0#premise + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Premise + + + + + en + premise + + + STRING + + + en + Premise of an address, e.g. a specific "BUILDING" but can also be used for naming a particular site. + + + + + + + + + postalDeliveryPointTechnicalKey + + + en + Postal Delivery Point Technical Key + + + urn:samm:io.catenax.shared.address_characteristic:4.0.0#postalDeliveryPointTechnicalKey + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Postal Delivery Point Technical Key + + + + + en + postalDeliveryPointTechnicalKey + + + STRING + + + en + Technical key of a postal delivery point. + + + + + + INTERURBAN_DELIVERY_POINT + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.address_characteristic:4.0.0#PostalDeliveryPointTechnicalKeyCharacteristic:INTERURBAN_DELIVERY_POINT + + + + + + MAIL_STATION + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.address_characteristic:4.0.0#PostalDeliveryPointTechnicalKeyCharacteristic:MAIL_STATION + + + + + + MAILBOX + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.address_characteristic:4.0.0#PostalDeliveryPointTechnicalKeyCharacteristic:MAILBOX + + + + + + OTHER + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.address_characteristic:4.0.0#PostalDeliveryPointTechnicalKeyCharacteristic:OTHER + + + + + + POST_OFFICE_BOX + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.address_characteristic:4.0.0#PostalDeliveryPointTechnicalKeyCharacteristic:POST_OFFICE_BOX + + + + + + + + + + + + + postalDeliveryPointValue + + + en + Postal Delivery Point Value + + + urn:samm:io.catenax.shared.address_characteristic:4.0.0#postalDeliveryPointValue + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Postal Delivery Point Value + + + + + en + postalDeliveryPointValue + + + STRING + + + en + Value of a postal delivery point, e.g. designation of a gate. + + + + + + + + + postalDeliveryPoint + + + en + Postal Delivery Point + + + urn:samm:io.catenax.shared.address_characteristic:4.0.0#postalDeliveryPoint + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Postal Delivery Point + + + + + en + postalDeliveryPoint + + + STRING + + + en + Delivery point, e.g. designation of a gate. + + + + + + + + + countryShortName + + + en + Country Short Name + + + urn:samm:io.catenax.shared.address_characteristic:4.0.0#countryShortName + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Country Short Name + + + + + en + countryShortName + + + STRING + + + en + The short variation of the name of the country. + + + + + + + + + country + + + en + Country + + + urn:samm:io.catenax.shared.address_characteristic:4.0.0#country + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Country + + + + + en + country + + + STRING + + + en + Country of an address. + + + + + + + + + postCodeValue + + + en + Post Code Value + + + urn:samm:io.catenax.shared.address_characteristic:4.0.0#postCodeValue + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Post Code Value + + + + + en + postCodeValue + + + STRING + + + en + The value of a post code. + + + + + + + + + postCodeTechnicalKey + + + en + Post Code Technical Key + + + urn:samm:io.catenax.shared.address_characteristic:4.0.0#postCodeTechnicalKey + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Post Code Technical Key + + + + + en + postCodeTechnicalKey + + + STRING + + + en + The technical key of a post code. + + + + + + CEDEX + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.address_characteristic:4.0.0#PostCodeTechnicalKeyCharacteristic:CEDEX + + + + + + LARGE_MAIL_USER + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.address_characteristic:4.0.0#PostCodeTechnicalKeyCharacteristic:LARGE_MAIL_USER + + + + + + OTHER + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.address_characteristic:4.0.0#PostCodeTechnicalKeyCharacteristic:OTHER + + + + + + POST_BOX + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.address_characteristic:4.0.0#PostCodeTechnicalKeyCharacteristic:POST_BOX + + + + + + REGULAR + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.address_characteristic:4.0.0#PostCodeTechnicalKeyCharacteristic:REGULAR + + + + + + + + + + + + + postCode + + + en + Post Code + + + urn:samm:io.catenax.shared.address_characteristic:4.0.0#postCode + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Post Code + + + + + en + postCode + + + STRING + + + en + Postal code of the address. + + + + + + + + + essOriginatorAddress + + + en + Ess Originator Address + + + urn:samm:io.catenax.essincident:4.0.0#essOriginatorAddress + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Ess Originator Address + + + + + en + essOriginatorAddress + + + STRING + + + en + Address of ESS Originator + + + + + + + + + essOriginatorBpnL + + + en + ESS Originator BPN-L + + + urn:samm:io.catenax.essincident:4.0.0#essOriginatorBpnL + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + ESS Originator BPN-L + + + + + en + essOriginatorBpnL + + + STRING + + + en + BPN-L ID of the company that causes the incident + + + + + + + + + essOriginatorBpnS + + + en + ESS Originator BPN-S + + + urn:samm:io.catenax.essincident:4.0.0#essOriginatorBpnS + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + ESS Originator BPN-S + + + + + en + essOriginatorBpnS + + + STRING + + + en + BPN-S ID of the company that causes the incident + + + + + + + + + essOriginatorBpnA + + + en + ESS Originator BPN A + + + urn:samm:io.catenax.essincident:4.0.0#essOriginatorBpnA + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + ESS Originator BPN A + + + + + en + essOriginatorBpnA + + + STRING + + + en + BPN-A ID of the company that causes the incident + + + + + + + + + longitude + + + en + Longitude + + + urn:samm:io.catenax.essincident:4.0.0#longitude + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Longitude + + + + + en + longitude + + + STRING + + + en + Longitude information for geographic coordinates. + + + + + + + + + latitude + + + en + Latitude + + + urn:samm:io.catenax.essincident:4.0.0#latitude + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Latitude + + + + + en + latitude + + + STRING + + + en + Latitude information for geographic coordinates. + + + + + + + + + essOriginatorCoordinates + + + en + ESS Originator Geographic data / Coordinates + + + urn:samm:io.catenax.essincident:4.0.0#essOriginatorCoordinates + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + ESS Originator Geographic data / Coordinates + + + + + en + essOriginatorCoordinates + + + STRING + + + en + Exact geographic position of an incident in the context of ESS (Environmental and Social Standards) + + + + + + + + + essIncidentIssuerFirstName + + + en + ESS Incident Issuer First Name + + + urn:samm:io.catenax.essincident:4.0.0#essIncidentIssuerFirstName + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + ESS Incident Issuer First Name + + + + + en + essIncidentIssuerFirstName + + + STRING + + + en + First name of ESS incident issuer + + + + + + + + + essIncidentIssuerEmailAddress + + + en + ESS Incident Issuer Email Address + + + urn:samm:io.catenax.essincident:4.0.0#essIncidentIssuerEmailAddress + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + ESS Incident Issuer Email Address + + + + + en + essIncidentIssuerEmailAddress + + + STRING + + + en + Email address of ESS incident issuer + + + + + + + + + essIncidentIssuerPhoneNo + + + en + ESS Incident Issuer Phone No + + + urn:samm:io.catenax.essincident:4.0.0#essIncidentIssuerPhoneNo + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + ESS Incident Issuer Phone No + + + + + en + essIncidentIssuerPhoneNo + + + STRING + + + en + Phone number of ESS incident issuer + + + + + + + + + flagAnonymous + + + en + Flag anonymous + + + urn:samm:io.catenax.essincident:4.0.0#flagAnonymous + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Flag anonymous + + + + + en + flagAnonymous + + + BOOLEAN + + + en + Flag that Incident issuer wants to be anonymous + + + + + + + + + essIncidentIssuerId + + + en + Issuer ID + + + urn:samm:io.catenax.essincident:4.0.0#essIncidentIssuerId + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Issuer ID + + + + + en + essIncidentIssuerId + + + STRING + + + en + System generated unique identifier of incident issuer + + + + + + + + + thoroughfareTechnicalKey + + + en + Thoroughfare Technical Key + + + urn:samm:io.catenax.shared.address_characteristic:4.0.0#thoroughfareTechnicalKey + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Thoroughfare Technical Key + + + + + en + thoroughfareTechnicalKey + + + STRING + + + en + Technical key of a thoroughfare. As specified by BPDM, this can be a "STREET" or a different type. + + + + + + + + + thoroughfareValue + + + en + Value Thoroughfare + + + urn:samm:io.catenax.shared.address_characteristic:4.0.0#thoroughfareValue + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Value Thoroughfare + + + + + en + thoroughfareValue + + + STRING + + + en + Value of a thoroughfare, e.g. name of a street. + + + + + + + + + thoroughfareNumber + + + en + Thoroughfare Number + + + urn:samm:io.catenax.shared.address_characteristic:4.0.0#thoroughfareNumber + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Thoroughfare Number + + + + + en + thoroughfareNumber + + + STRING + + + en + Number of a thoroughfare. As used differently in international context, this number can contain both numerical and alphanumerical values. + + + + + + + + + thoroughfare + + + en + Thoroughfare + + + urn:samm:io.catenax.shared.address_characteristic:4.0.0#thoroughfare + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Thoroughfare + + + + + en + thoroughfare + + + STRING + + + en + Street or thorough road name. + + + + + + + + + localityTechnicalKey + + + en + Locality Technical Key + + + urn:samm:io.catenax.shared.address_characteristic:4.0.0#localityTechnicalKey + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Locality Technical Key + + + + + en + localityTechnicalKey + + + STRING + + + en + Technical key of a locality. + + + + + + + + + localityValue + + + en + Locality Value + + + urn:samm:io.catenax.shared.address_characteristic:4.0.0#localityValue + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Locality Value + + + + + en + localityValue + + + STRING + + + en + Value of a locality, e.g. name of a city ("Mannheim"). + + + + + + + + + locality + + + en + Locality + + + urn:samm:io.catenax.shared.address_characteristic:4.0.0#locality + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Locality + + + + + en + locality + + + STRING + + + en + Locality belonging to an address. + + + + + + + + + premiseTechnicalKey + + + en + Premise Technical Key + + + urn:samm:io.catenax.shared.address_characteristic:4.0.0#premiseTechnicalKey + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Premise Technical Key + + + + + en + premiseTechnicalKey + + + STRING + + + en + Technical key of a premise. + + + + + + + + + premiseValue + + + en + Premise Value + + + urn:samm:io.catenax.shared.address_characteristic:4.0.0#premiseValue + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Premise Value + + + + + en + premiseValue + + + STRING + + + en + Value of a premise, e.g. name or designation of a particular site. + + + + + + + + + premise + + + en + Premise + + + urn:samm:io.catenax.shared.address_characteristic:4.0.0#premise + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Premise + + + + + en + premise + + + STRING + + + en + Premise of an address, e.g. a specific "BUILDING" but can also be used for naming a particular site. + + + + + + + + + postalDeliveryPointTechnicalKey + + + en + Postal Delivery Point Technical Key + + + urn:samm:io.catenax.shared.address_characteristic:4.0.0#postalDeliveryPointTechnicalKey + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Postal Delivery Point Technical Key + + + + + en + postalDeliveryPointTechnicalKey + + + STRING + + + en + Technical key of a postal delivery point. + + + + + + + + + postalDeliveryPointValue + + + en + Postal Delivery Point Value + + + urn:samm:io.catenax.shared.address_characteristic:4.0.0#postalDeliveryPointValue + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Postal Delivery Point Value + + + + + en + postalDeliveryPointValue + + + STRING + + + en + Value of a postal delivery point, e.g. designation of a gate. + + + + + + + + + postalDeliveryPoint + + + en + Postal Delivery Point + + + urn:samm:io.catenax.shared.address_characteristic:4.0.0#postalDeliveryPoint + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Postal Delivery Point + + + + + en + postalDeliveryPoint + + + STRING + + + en + Delivery point, e.g. designation of a gate. + + + + + + + + + countryShortName + + + en + Country Short Name + + + urn:samm:io.catenax.shared.address_characteristic:4.0.0#countryShortName + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Country Short Name + + + + + en + countryShortName + + + STRING + + + en + The short variation of the name of the country. + + + + + + + + + country + + + en + Country + + + urn:samm:io.catenax.shared.address_characteristic:4.0.0#country + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Country + + + + + en + country + + + STRING + + + en + Country of an address. + + + + + + + + + postCodeValue + + + en + Post Code Value + + + urn:samm:io.catenax.shared.address_characteristic:4.0.0#postCodeValue + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Post Code Value + + + + + en + postCodeValue + + + STRING + + + en + The value of a post code. + + + + + + + + + postCodeTechnicalKey + + + en + Post Code Technical Key + + + urn:samm:io.catenax.shared.address_characteristic:4.0.0#postCodeTechnicalKey + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Post Code Technical Key + + + + + en + postCodeTechnicalKey + + + STRING + + + en + The technical key of a post code. + + + + + + + + + postCode + + + en + Post Code + + + urn:samm:io.catenax.shared.address_characteristic:4.0.0#postCode + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Post Code + + + + + en + postCode + + + STRING + + + en + Postal code of the address. + + + + + + + + + essIncidentIssuerAddress + + + en + Ess Incident Issuer Address + + + urn:samm:io.catenax.essincident:4.0.0#essIncidentIssuerAddress + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Ess Incident Issuer Address + + + + + en + essIncidentIssuerAddress + + + STRING + + + en + Simple form of an address which can belong to a person, organisation, company etc. + + + + + + + + + essIncidentIssuerLastName + + + en + ESS Incident Issuer Last Name + + + urn:samm:io.catenax.essincident:4.0.0#essIncidentIssuerLastName + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + ESS Incident Issuer Last Name + + + + + en + essIncidentIssuerLastName + + + STRING + + + en + Last name of ESS incident Issuer + + + + + + + + + essOriginatorCountrySubdivision + + + en + ESS Originator Country Subdivision + + + urn:samm:io.catenax.essincident:4.0.0#essOriginatorCountrySubdivision + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + ESS Originator Country Subdivision + + + + + en + essOriginatorCountrySubdivision + + + STRING + + + en + Region within a country of ESS Originator + + + + + + + + + essIncidentIssuerCountrySubdivision + + + en + ESS Incident Issuer Country Subdivision + + + urn:samm:io.catenax.essincident:4.0.0#essIncidentIssuerCountrySubdivision + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + ESS Incident Issuer Country Subdivision + + + + + en + essIncidentIssuerCountrySubdivision + + + STRING + + + en + Region within a country of ESS Incident Issuer + + + + + + + + + essIncidentModerator + + + en + Incident Moderator + + + urn:samm:io.catenax.essincident:4.0.0#essIncidentModerator + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Incident Moderator + + + + + en + essIncidentModerator + + + STRING + + + en + Business Partner who moderates the clearing of an ESS incident + + + + + + + + + diff --git a/io.catenax.essincident/4.0.0/gen/EssIncident-schema.json b/io.catenax.essincident/4.0.0/gen/EssIncident-schema.json new file mode 100644 index 000000000..904c3ec10 --- /dev/null +++ b/io.catenax.essincident/4.0.0/gen/EssIncident-schema.json @@ -0,0 +1,407 @@ +{ + "$schema" : "http://json-schema.org/draft-04/schema", + "description" : "Aspect for defining an incident in context of Environmental and Social Standards as specified by the Catena-X Sustainability team.", + "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.essincident_4.0.0_IndustryCharacteristic" : { + "type" : "string", + "description" : "Industry Characteristic", + "enum" : [ "Extraction of raw materials", "Manufacture of components / intermediates", "Manufacture of final products", "Distribution / Trade", "Waste treatment / recycling", "Services", "Lending / financing / insurance", "Other" ] + }, + "urn_samm_io.catenax.essincident_4.0.0_IncidentCategoryCharacteristic" : { + "type" : "string", + "description" : "Characteristic for defining an incident category in the context of ESS (Environmental and Social Standards).", + "enum" : [ "Environmental", "Social" ] + }, + "urn_samm_io.catenax.essincident_4.0.0_IncidentSubcategories" : { + "type" : "string", + "description" : "Characteristic for defining subcategories of an incident in the context of ESS (Environmental and Social Standards).", + "enum" : [ "Child labour", "Forced labour", "Slavery", "Work safety", "Freedom of association", "Discrimination", "Minimum wage", "Environmental pollution", "Forced eviction", "Force by state security", "Usage of Mercury", "Usage of harmful chemicals", "Non-environmental friendly handling of waste", "Import and export of hazardous waste" ] + }, + "urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_ResourcePath" : { + "type" : "string", + "format" : "uri", + "description" : "The path of a resource." + }, + "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.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_io.catenax.essincident_4.0.0_IncidentStatusCharacteristic" : { + "type" : "string", + "description" : "Incident status as defined in a list, default value = new", + "enum" : [ "new", "in cleansing", "in process", "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.shared.address_characteristic_4.0.0_ThoroughfareTechnicalKeyCharacteristic" : { + "type" : "string", + "description" : "Characteristic of the technical key of a thoroughfare.", + "enum" : [ "STREET", "INDUSTRIAL_ZONE", "OTHER", "RIVER", "SQUARE" ] + }, + "urn_samm_io.catenax.shared.address_characteristic_4.0.0_ThoroughfareEntity" : { + "description" : "Characteristic for defining a thoroughfare which can consist of a type (e.g. \"STREET\"), value (e.g. \"Bernstra?e\") and number (e.g. \"45\"). Model follows the specification of BPDM.", + "type" : "object", + "properties" : { + "technicalKey" : { + "description" : "Technical key of a thoroughfare. As specified by BPDM, this can be a \"STREET\" or a different type.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.address_characteristic_4.0.0_ThoroughfareTechnicalKeyCharacteristic" + }, + "value" : { + "description" : "Value of a thoroughfare, e.g. name of a street.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "number" : { + "description" : "Number of a thoroughfare. As used differently in international context, this number can contain both numerical and alphanumerical values.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + } + }, + "required" : [ "technicalKey", "value", "number" ] + }, + "urn_samm_io.catenax.shared.address_characteristic_4.0.0_LocalityTechnicalKeyCharacteristic" : { + "type" : "string", + "description" : "Characteristic of the technical key of a locality", + "enum" : [ "BLOCK", "CITY", "DISTRICT", "OTHER", "POST_OFFICE_CITY", "QUARTER" ] + }, + "urn_samm_io.catenax.shared.address_characteristic_4.0.0_LocalityEntity" : { + "description" : "Characteristic for defining a locality which belongs to an address and which consists of a type (e.g. \"CITY\") and value (e.g. \"Mannheim\"). Model follows the specification of BPDM.", + "type" : "object", + "properties" : { + "technicalKey" : { + "description" : "Technical key of a locality.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.address_characteristic_4.0.0_LocalityTechnicalKeyCharacteristic" + }, + "value" : { + "description" : "Value of a locality, e.g. name of a city (\"Mannheim\").", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + } + }, + "required" : [ "technicalKey", "value" ] + }, + "urn_samm_io.catenax.shared.address_characteristic_4.0.0_PremiseTechnicalKeyCharacteristic" : { + "type" : "string", + "description" : "Characteristic of the technical key of a premise.", + "enum" : [ "BUILDING", "HARBOUR", "LEVEL", "OTHER", "ROOM", "SUITE", "UNIT", "WAREHOUSE" ] + }, + "urn_samm_io.catenax.shared.address_characteristic_4.0.0_PremiseEntity" : { + "description" : "Characteristic for defining a premise which consists of a technical key (e.g. \"BUILDING\" or \"OTHER\") and a value (e.g. \"Werk 1\").", + "type" : "object", + "properties" : { + "technicalKey" : { + "description" : "Technical key of a premise.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.address_characteristic_4.0.0_PremiseTechnicalKeyCharacteristic" + }, + "value" : { + "description" : "Value of a premise, e.g. name or designation of a particular site.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + } + }, + "required" : [ "technicalKey", "value" ] + }, + "urn_samm_io.catenax.shared.address_characteristic_4.0.0_PostalDeliveryPointTechnicalKeyCharacteristic" : { + "type" : "string", + "description" : "Characteristic of the technical key of a postal delivery point.", + "enum" : [ "INTERURBAN_DELIVERY_POINT", "MAIL_STATION", "MAILBOX", "OTHER", "POST_OFFICE_BOX" ] + }, + "urn_samm_io.catenax.shared.address_characteristic_4.0.0_PostalDeliveryPointEntity" : { + "description" : "Characteristic for defining a postal delivery point which consists of a technical key (e.g. \"MAILBOX\" or \"OTHER\") and a value. Model follows the specification of BPDM.", + "type" : "object", + "properties" : { + "technicalKey" : { + "description" : "Technical key of a postal delivery point.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.address_characteristic_4.0.0_PostalDeliveryPointTechnicalKeyCharacteristic" + }, + "value" : { + "description" : "Value of a postal delivery point, e.g. designation of a gate.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + } + }, + "required" : [ "technicalKey", "value" ] + }, + "urn_samm_io.catenax.shared.address_characteristic_4.0.0_CountryTrait" : { + "type" : "string", + "description" : "Regular expression for designation of a short name of a country as defined in ISO 3166-2.", + "pattern" : "([A-Z]{2}-[A-Z0-9]{1,3}|)" + }, + "urn_samm_io.catenax.shared.address_characteristic_4.0.0_CountryEntity" : { + "description" : "Characteristic of a country belonging to an address", + "type" : "object", + "properties" : { + "shortName" : { + "description" : "The short variation of the name of the country.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.address_characteristic_4.0.0_CountryTrait" + } + }, + "required" : [ "shortName" ] + }, + "urn_samm_io.catenax.shared.address_characteristic_4.0.0_PostCodeTrait" : { + "type" : "string", + "description" : "Regular expression for post codes.", + "pattern" : "^[a-z0-9][a-z0-9\\- ]{0,10}$" + }, + "urn_samm_io.catenax.shared.address_characteristic_4.0.0_PostCodeTechnicalKeyCharacteristic" : { + "type" : "string", + "description" : "Characteristic for the technical key of a post code.", + "enum" : [ "CEDEX", "LARGE_MAIL_USER", "OTHER", "POST_BOX", "REGULAR" ] + }, + "urn_samm_io.catenax.shared.address_characteristic_4.0.0_PostCodeEntity" : { + "description" : "Characteristic for defining a postcode which can consist of a type (e.g. \"REGULAR\" for zip codes) and a value (e.g. \"98765-4321\"). Model follows the specification of BPDM.", + "type" : "object", + "properties" : { + "value" : { + "description" : "The value of a post code.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.address_characteristic_4.0.0_PostCodeTrait" + }, + "technicalKey" : { + "description" : "The technical key of a post code.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.address_characteristic_4.0.0_PostCodeTechnicalKeyCharacteristic" + } + }, + "required" : [ "value", "technicalKey" ] + }, + "urn_samm_io.catenax.shared.address_characteristic_4.0.0_PostalAddress" : { + "description" : "A characteristic to express the postal address and which is intended to be referenced by other aspects.", + "type" : "object", + "properties" : { + "thoroughfare" : { + "description" : "Street or thorough road name.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.address_characteristic_4.0.0_ThoroughfareEntity" + }, + "locality" : { + "description" : "Locality belonging to an address.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.address_characteristic_4.0.0_LocalityEntity" + }, + "premise" : { + "description" : "Premise of an address, e.g. a specific \"BUILDING\" but can also be used for naming a particular site.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.address_characteristic_4.0.0_PremiseEntity" + }, + "postalDeliveryPoint" : { + "description" : "Delivery point, e.g. designation of a gate.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.address_characteristic_4.0.0_PostalDeliveryPointEntity" + }, + "country" : { + "description" : "Country of an address.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.address_characteristic_4.0.0_CountryEntity" + }, + "postCode" : { + "description" : "Postal code of the address.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.address_characteristic_4.0.0_PostCodeEntity" + } + }, + "required" : [ "thoroughfare", "locality", "country", "postCode" ] + }, + "urn_samm_io.catenax.shared.business_partner_number_2.0.0_BpnlCharacteristic" : { + "type" : "string", + "description" : "BPNL (Business Partner Number Legal Entity) represents the legal entity of an organization (e.g. enterprise, university, association, …) and contains its legal name (incl. legal form, if registered), registered address and tax number. The registered address is the official, legal correspondence address which has to be supplied to governmental and tax authorities and is the address which is used in any legal or court documents. BPNL is on corporate level and is unique for this legal entity." + }, + "urn_samm_io.catenax.shared.business_partner_number_2.0.0_BpnsCharacteristic" : { + "type" : "string", + "description" : "BPNS (Business Partner Number Site) represents a site which can be a production plant. A site can also be e.g. an office or a warehouse. An information related to a site is e.g. needed for reporting issues (How many sites does e.g. Beispiel AG have?), status of operation (out of operations due to environmental disaster), for certificates on site level (e.g. environment certificates) or for internal regulations on site level, (e.g. security topics, Corona rules,...). Several addresses (= BPNA with different streets and different gates) can belong to one site. A BPNS should be always linked to one BPNL via relationship 'belongs to legal entity'." + }, + "urn_samm_io.catenax.shared.business_partner_number_2.0.0_BpnaCharacteristic" : { + "type" : "string", + "description" : "BPNA (Business Partner Number Address) contains the legal name (incl. legal form, if registered) and additional organization information about site, e.g. Plant xxx, Branch office yyy of an organization with its corresponding, most commonly physical, address. A BPNA is always linked to a BPNL via relationship 'belongs to legal entity' and should be linked to a BPNS via relationship 'belongs to site'.The BPNA is on operational level (e.g. shipping or pick-up address)." + }, + "urn_samm_io.catenax.essincident_4.0.0_LongitudeTrait" : { + "type" : "string", + "description" : "Regular expression for longitude information.", + "pattern" : "^(\\+|-)?(?:180(?:(?:\\.0{1,6})?)|(?:[0-9]|[1-9][0-9]|1[0-7][0-9])(?:(?:\\.[0-9]{1,6})?))$" + }, + "urn_samm_io.catenax.essincident_4.0.0_LatitudeTrait" : { + "type" : "string", + "description" : "Regular expression for latitude information of geographic coordinates.", + "pattern" : "^(\\+|-)?(?:90(?:(?:\\.0{1,6})?)|(?:[0-9]|[1-8][0-9])(?:(?:\\.[0-9]{1,6})?))$" + }, + "urn_samm_io.catenax.essincident_4.0.0_EssOriginatorCoordinatesEntity" : { + "description" : "Characteristic for defining geographic coordinates (longitude and latitude) of an incident originator in context of ESS (Environmental and Social Standards).", + "type" : "object", + "properties" : { + "longitude" : { + "description" : "Longitude information for geographic coordinates.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.essincident_4.0.0_LongitudeTrait" + }, + "latitude" : { + "description" : "Latitude information for geographic coordinates.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.essincident_4.0.0_LatitudeTrait" + } + }, + "required" : [ "longitude", "latitude" ] + }, + "urn_samm_io.catenax.essincident_4.0.0_ContactMailTrait" : { + "type" : "string", + "description" : "Regular expression for a contact mail address.", + "pattern" : "^[a-zA-Z0-9.!#$%&?*+\\/=?^_`{|}~-]+@[a-zA-Z0-9-]+(?:\\.[a-zA-Z0-9-]+)*$" + }, + "urn_samm_io.catenax.essincident_4.0.0_EssIncidentModeratorCharacteristic" : { + "description" : "Business Partner(s) who moderate(s) the clearing of an ESS incident", + "type" : "array", + "items" : { + "type" : "string", + "description" : "The provided regular expression ensures that the BPNL is composed of prefix 'BPNL', 10 digits and two alphanumeric letters.", + "pattern" : "^BPNL[a-zA-Z0-9]{12}$" + }, + "uniqueItems" : true + } + } + }, + "properties" : { + "productCommodity" : { + "description" : "Free-text description for commodity of a product affected by an incident in the context of ESS (Environmental and Social Standards)", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "productDescription" : { + "description" : "Description of product or component affected by an incident in the context of ESS (Environmental and Social Standards) ", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "rawMaterial" : { + "description" : "Raw material that causes an incident in the context of ESS (Environmental and Social Standards)", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "industry" : { + "description" : "Industry / Branch that causes the incident", + "$ref" : "#/components/schemas/urn_samm_io.catenax.essincident_4.0.0_IndustryCharacteristic" + }, + "incidentCategory" : { + "description" : "Environmental and social standards related incident category according to Supply Chain Due Diligence Act", + "$ref" : "#/components/schemas/urn_samm_io.catenax.essincident_4.0.0_IncidentCategoryCharacteristic" + }, + "incidentSubcategory" : { + "description" : "Subcategory of an incident Category", + "$ref" : "#/components/schemas/urn_samm_io.catenax.essincident_4.0.0_IncidentSubcategories" + }, + "incidentSubject" : { + "description" : "Title/ subject of an incident in the context of ESS (Environmental and Social Standards)", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "incidentExternalSubject" : { + "description" : "Replaces Incident Subject for external communication", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "incidentDescription" : { + "description" : "Full text description of an incident in the context of ESS (Environmental and Social Standards)", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "incidentExternalNotes" : { + "description" : "Incident description for external communication", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "incidentAttachment" : { + "description" : "Picture(s) about the reported incident in the context of ESS (Environmental and Social Standards)", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_ResourcePath" + }, + "systemDate" : { + "description" : "System created timestamp when the incident in the context of ESS (Environmental and Social Standards) was issued and saved", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Timestamp" + }, + "incidentDate" : { + "description" : "Date and time information when an incident in the context of ESS (Environmental and Social Standards) occurred", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Timestamp" + }, + "incidentId" : { + "description" : "Unique identifier for an incident in the context of ESS (Environmental and Social Standards)", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.uuid_2.0.0_UuidV4Trait" + }, + "masterOpCoId" : { + "description" : "Incident ID that has been checked and validated. In case of duplicates the \"parent\" incident ID will be used as Master Operating Company Incident ID.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.uuid_2.0.0_UuidV4Trait" + }, + "incidentDisplayId" : { + "description" : "Human readable format of Incident ID", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "incidentStatusInformation" : { + "description" : "Status of incident progress, default value = new", + "$ref" : "#/components/schemas/urn_samm_io.catenax.essincident_4.0.0_IncidentStatusCharacteristic" + }, + "incidentShareFlag" : { + "description" : "Flag, that can be set to true in order to request to publish the incident, default value is false", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Boolean" + }, + "subCaseOpCoIds" : { + "description" : "Incident Ids that belong to a Master Operating Company Incident Id", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "incidentSystemId" : { + "description" : "System Id that defines the tenant", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "essOriginatorCompanyName" : { + "description" : "Name of a company / an organisation that is the originator of an incident in the context of ESS (Environmental and Social Standards)", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "essOriginatorAddress" : { + "description" : "Address of ESS Originator ", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.address_characteristic_4.0.0_PostalAddress" + }, + "essOriginatorBpnL" : { + "description" : "BPN-L ID of the company that causes the incident", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.business_partner_number_2.0.0_BpnlCharacteristic" + }, + "essOriginatorBpnS" : { + "description" : "BPN-S ID of the company that causes the incident", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.business_partner_number_2.0.0_BpnsCharacteristic" + }, + "essOriginatorBpnA" : { + "description" : "BPN-A ID of the company that causes the incident", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.business_partner_number_2.0.0_BpnaCharacteristic" + }, + "essOriginatorCoordinates" : { + "description" : "Exact geographic position of an incident in the context of ESS (Environmental and Social Standards)", + "$ref" : "#/components/schemas/urn_samm_io.catenax.essincident_4.0.0_EssOriginatorCoordinatesEntity" + }, + "essIncidentIssuerFirstName" : { + "description" : "First name of ESS incident issuer", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "essIncidentIssuerEmailAddress" : { + "description" : "Email address of ESS incident issuer", + "$ref" : "#/components/schemas/urn_samm_io.catenax.essincident_4.0.0_ContactMailTrait" + }, + "essIncidentIssuerPhoneNo" : { + "description" : "Phone number of ESS incident issuer", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "flagAnonymous" : { + "description" : "Flag that Incident issuer wants to be anonymous", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Boolean" + }, + "essIncidentIssuerId" : { + "description" : "System generated unique identifier of incident issuer", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.uuid_2.0.0_UuidV4Trait" + }, + "essIncidentIssuerAddress" : { + "description" : "Simple form of an address which can belong to a person, organisation, company etc.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.address_characteristic_4.0.0_PostalAddress" + }, + "essIncidentIssuerLastName" : { + "description" : "Last name of ESS incident Issuer", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "essOriginatorCountrySubdivision" : { + "description" : "Region within a country of ESS Originator", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "essIncidentIssuerCountrySubdivision" : { + "description" : "Region within a country of ESS Incident Issuer", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "essIncidentModerator" : { + "description" : "Business Partner who moderates the clearing of an ESS incident", + "$ref" : "#/components/schemas/urn_samm_io.catenax.essincident_4.0.0_EssIncidentModeratorCharacteristic" + } + }, + "required" : [ "productDescription", "incidentCategory", "incidentSubcategory", "incidentDescription", "systemDate", "incidentDate", "incidentId", "incidentStatusInformation" ] +} \ No newline at end of file diff --git a/io.catenax.essincident/4.0.0/gen/EssIncident.aasx b/io.catenax.essincident/4.0.0/gen/EssIncident.aasx new file mode 100644 index 000000000..0b32e8593 Binary files /dev/null and b/io.catenax.essincident/4.0.0/gen/EssIncident.aasx differ diff --git a/io.catenax.essincident/4.0.0/gen/EssIncident.html b/io.catenax.essincident/4.0.0/gen/EssIncident.html new file mode 100644 index 000000000..6e6d8cbb4 --- /dev/null +++ b/io.catenax.essincident/4.0.0/gen/EssIncident.html @@ -0,0 +1,3972 @@ + + + + + + + + + + + + + + Documentation ESS Incident + + +
+
+
+
+

Aspect Model ESS Incident

+
urn:samm:io.catenax.essincident:4.0.0#EssIncident
+
+
+
+
+
+
+
+ +
+ + +
+ Aspect for defining an incident in context of Environmental and Social Standards as specified by the Catena-X Sustainability team. +
+ + +
+

Overview

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

Properties

+
+ +
+ +
+

Date of Incident

+
+ +Date and time information when an incident in the context of ESS (Environmental and Social Standards) occurred + +
+
Name
+
incidentDate
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#dateTime + +
+
+
+
+
+ +
+
Example
+
2022-08-31T00:00:00Z
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
incidentDate
+
+ + +
+
+ +
+

Display ID

+
+ +Human readable format of Incident ID + +
+
Name
+
incidentDisplayId
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
123456789101
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
incidentDisplayId
+
+ + +
+
+ +
+

ESS Incident Issuer Country Subdivision

+
+ +Region within a country of ESS Incident Issuer + +
+
Name
+
essIncidentIssuerCountrySubdivision
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
IN-AP
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
essIncidentIssuerCountrySubdivision
+
+ + +
+
+ +
+

ESS Incident Issuer Email Address

+
+ +Email address of ESS incident issuer + +
+
Name
+
essIncidentIssuerEmailAddress
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
test@example.com
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
essIncidentIssuerEmailAddress
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + Contact Mail Constraint +
    + +
    +
    Description
    +
    Regular expression for a contact mail address.
    +
    + + +
    +
    Regular expression
    +
    ^[a-zA-Z0-9.!#$%&?*+\/=?^_`{|}~-]+@[a-zA-Z0-9-]+(?:\.[a-zA-Z0-9-]+)*$
    +
    + +
    • +
+
+
+
+
+ +
+

ESS Incident Issuer First Name

+
+ +First name of ESS incident issuer + +
+
Name
+
essIncidentIssuerFirstName
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Testuser First name
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
essIncidentIssuerFirstName
+
+ + +
+
+ +
+

ESS Incident Issuer Last Name

+
+ +Last name of ESS incident Issuer + +
+
Name
+
essIncidentIssuerLastName
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Testuser Last name
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
essIncidentIssuerLastName
+
+ + +
+
+ +
+

ESS Incident Issuer Phone No

+
+ +Phone number of ESS incident issuer + +
+
Name
+
essIncidentIssuerPhoneNo
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
+49-123-456789
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
essIncidentIssuerPhoneNo
+
+ + +
+
+ +
+

ESS Originator BPN A

+
+ +BPN-A ID of the company that causes the incident + +
+
Name
+
essOriginatorBpnA
+
+ + + +
+
Characteristic
+
+
+
+
+ Reference +
+
    +
  • https://catena-x.net/fileadmin/user_upload/Standard-Bibliothek/Update_PDF_Maerz/5_BPDM/CX_-_0010_BUSINESS_PARTNER_NUMBER_PlatformCapabilityBPDM_v_1.0.1.pdf
    • +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
BPNA1234567890ZZ
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
essOriginatorBpnA
+
+ + +
+
+ +
+

ESS Originator BPN-L

+
+ +BPN-L ID of the company that causes the incident + +
+
Name
+
essOriginatorBpnL
+
+ + + +
+
Characteristic
+
+
+
+
+ Reference +
+
    +
  • https://catena-x.net/fileadmin/user_upload/Standard-Bibliothek/Update_PDF_Maerz/5_BPDM/CX_-_0010_BUSINESS_PARTNER_NUMBER_PlatformCapabilityBPDM_v_1.0.1.pdf
    • +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
BPNL1234567890ZZ
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
essOriginatorBpnL
+
+ + +
+
+ +
+

ESS Originator BPN-S

+
+ +BPN-S ID of the company that causes the incident + +
+
Name
+
essOriginatorBpnS
+
+ + + +
+
Characteristic
+
+
+
+
+ Reference +
+
    +
  • https://catena-x.net/fileadmin/user_upload/Standard-Bibliothek/Update_PDF_Maerz/5_BPDM/CX_-_0010_BUSINESS_PARTNER_NUMBER_PlatformCapabilityBPDM_v_1.0.1.pdf
    • +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
BPNS1234567890ZZ
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
essOriginatorBpnS
+
+ + +
+
+ +
+

ESS Originator Company Name

+
+ +Name of a company / an organisation that is the originator of an incident in the context of ESS (Environmental and Social Standards) + +
+
Name
+
essOriginatorCompanyName
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Rubbery Ltd.
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
essOriginatorCompanyName
+
+ + +
+
+ +
+

ESS Originator Country Subdivision

+
+ +Region within a country of ESS Originator + +
+
Name
+
essOriginatorCountrySubdivision
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
BR-SP
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
essOriginatorCountrySubdivision
+
+ + +
+
+ +
+

ESS Originator Geographic data / Coordinates

+
+ +Exact geographic position of an incident in the context of ESS (Environmental and Social Standards) + +
+
Name
+
essOriginatorCoordinates
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.essincident:4.0.0#EssOriginatorCoordinatesEntity + +
+
+
+
+
+ + +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
essOriginatorCoordinates
+
+ + +
+
+ +
+

Ess Incident Issuer Address

+
+ +Simple form of an address which can belong to a person, organisation, company etc. + +
+
Name
+
essIncidentIssuerAddress
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.shared.address_characteristic:4.0.0#AddressEntity + +
+
+
+
+
+ + +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
essIncidentIssuerAddress
+
+ + +
+
+ +
+

Ess Originator Address

+
+ +Address of ESS Originator + +
+
Name
+
essOriginatorAddress
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.shared.address_characteristic:4.0.0#AddressEntity + +
+
+
+
+
+ + +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
essOriginatorAddress
+
+ + +
+
+ +
+

External Notes

+
+ +Incident description for external communication + +
+
Name
+
incidentExternalNotes
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Child labour at production site of a rubber producer in Brazil
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
incidentExternalNotes
+
+ + +
+
+ +
+

External Subject

+
+ +Replaces Incident Subject for external communication + +
+
Name
+
incidentExternalSubject
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Child labour on a rubber producer farm
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
incidentExternalSubject
+
+ + +
+
+ +
+

Flag anonymous

+
+ +Flag that Incident issuer wants to be anonymous + +
+
Name
+
flagAnonymous
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#boolean + +
+
+
+
+
+ +
+
Example
+
false
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
flagAnonymous
+
+ + +
+
+ +
+

Incident Attachment

+
+ +Picture(s) about the reported incident in the context of ESS (Environmental and Social Standards) + +
+
Name
+
incidentAttachment
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#anyURI + +
+
+
+
+
+ + +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
incidentAttachment
+
+ + +
+
+ +
+

Incident Category

+
+ +Environmental and social standards related incident category according to Supply Chain Due Diligence Act + +
+
Name
+
incidentCategory
+
+ + + +
+
Characteristic
+
+
+
+
Enumeration
+
+
+
Values
+
+
+
+
    +
  • Environmental
    • +
  • Social
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Social
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
incidentCategory
+
+ +
+
Reference
+
+
    +
  • https://www.gesetze-im-internet.de/lksg/
    • +
+
+
+ +
+
+ +
+

Incident Description

+
+ +Full text description of an incident in the context of ESS (Environmental and Social Standards) + +
+
Name
+
incidentDescription
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Child labour at production site of the rubber producer Farm A in Brazil
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
incidentDescription
+
+ + +
+
+ +
+

Incident ID

+
+ +Unique identifier for an incident in the context of ESS (Environmental and Social Standards) + +
+
Name
+
incidentId
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
    +
  • https://tools.ietf.org/html/rfc4122
    • +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
9f47b3c8-b6d4-44f1-99ba-6bdb33916cac
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
incidentId
+
+ + +
+
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
    +
    (^[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}$)
    +
    + +
    • +
+
+
+
+
+ +
+

Incident Moderator

+
+ +Business Partner who moderates the clearing of an ESS incident + +
+
Name
+
essIncidentModerator
+
+ + + +
+
Characteristic
+
+
+
+
Set
+
+
+
Has no order
+
+
+
Duplicates not allowed
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
BPNL1234567890YY
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
essIncidentModerator
+
+ + +
+
+ +
+

Incident Share Flag

+
+ +Flag, that can be set to true in order to request to publish the incident, default value is false + +
+
Name
+
incidentShareFlag
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#boolean + +
+
+
+
+
+ +
+
Example
+
false
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
incidentShareFlag
+
+ + +
+
+ +
+

Incident Status

+
+ +Status of incident progress, default value = new + +
+
Name
+
incidentStatusInformation
+
+ + + +
+
Characteristic
+
+
+
+
Enumeration
+
+
+
Values
+
+
+
+
    +
  • new
    • +
  • in cleansing
    • +
  • in process
    • +
  • completed
    • +
  • closed
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
new
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
incidentStatusInformation
+
+ + +
+
+ +
+

Incident Subcategory

+
+ +Subcategory of an incident Category + +
+
Name
+
incidentSubcategory
+
+ + + +
+
Characteristic
+
+
+
+
Enumeration
+
+
+
Values
+
+
+
+
    +
  • Child labour
    • +
  • Forced labour
    • +
  • Slavery
    • +
  • Work safety
    • +
  • Freedom of association
    • +
  • Discrimination
    • +
  • Minimum wage
    • +
  • Environmental pollution
    • +
  • Forced eviction
    • +
  • Force by state security
    • +
  • Usage of Mercury
    • +
  • Usage of harmful chemicals
    • +
  • Non-environmental friendly handling of waste
    • +
  • Import and export of hazardous waste
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Child labour
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
incidentSubcategory
+
+ + +
+
+ +
+

Incident Subject

+
+ +Title/ subject of an incident in the context of ESS (Environmental and Social Standards) + +
+
Name
+
incidentSubject
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Child labour on rubber producer Farm A
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
incidentSubject
+
+ + +
+
+ +
+

Incident System Id

+
+ +System Id that defines the tenant + +
+
Name
+
incidentSystemId
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
123456789
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
incidentSystemId
+
+ + +
+
+ +
+

Industry / Branch

+
+ +Industry / Branch that causes the incident + +
+
Name
+
industry
+
+ + + +
+
Characteristic
+
+
+
+
Enumeration
+
+
+
Values
+
+
+
+
    +
  • Extraction of raw materials
    • +
  • Manufacture of components / intermediates
    • +
  • Manufacture of final products
    • +
  • Distribution / Trade
    • +
  • Waste treatment / recycling
    • +
  • Services
    • +
  • Lending / financing / insurance
    • +
  • Other
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Extraction of raw material
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
industry
+
+ + +
+
+ +
+

Issuer ID

+
+ +System generated unique identifier of incident issuer + +
+
Name
+
essIncidentIssuerId
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
    +
  • https://tools.ietf.org/html/rfc4122
    • +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
9a47b3c8-b6d4-44f1-99ba-6bdb33916cac
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
essIncidentIssuerId
+
+ + +
+
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
    +
    (^[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}$)
    +
    + +
    • +
+
+
+
+
+ +
+

Master Operating Company Incident ID

+
+ +Incident ID that has been checked and validated. In case of duplicates the "parent" incident ID will be used as Master Operating Company Incident ID. + +
+
Name
+
masterOpCoId
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
    +
  • https://tools.ietf.org/html/rfc4122
    • +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
9f47b3c8-b6d4-44f1-99ba-6bdb33916cac
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
masterOpCoId
+
+ + +
+
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
    +
    (^[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}$)
    +
    + +
    • +
+
+
+
+
+ +
+

Product Commodity

+
+ +Free-text description for commodity of a product affected by an incident in the context of ESS (Environmental and Social Standards) + +
+
Name
+
productCommodity
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Tire
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
productCommodity
+
+ + +
+
+ +
+

Product Description

+
+ +Description of product or component affected by an incident in the context of ESS (Environmental and Social Standards) + +
+
Name
+
productDescription
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Natural Rubber
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
productDescription
+
+ + +
+
+ +
+

Raw Material

+
+ +Raw material that causes an incident in the context of ESS (Environmental and Social Standards) + +
+
Name
+
rawMaterial
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Natural Rubber
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
rawMaterial
+
+ + +
+
+ +
+

Sub Case Operating Company Incident Ids

+
+ +Incident Ids that belong to a Master Operating Company Incident Id + +
+
Name
+
subCaseOpCoIds
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
9f47b3c8-b6d4-44f1-99ba-6bdb33916cac, 9f47b3c8-b6d4-44f1-99ba-6bdb33916cad
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
subCaseOpCoIds
+
+ + +
+
+ +
+

System Date

+
+ +System created timestamp when the incident in the context of ESS (Environmental and Social Standards) was issued and saved + +
+
Name
+
systemDate
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#dateTime + +
+
+
+
+
+ +
+
Example
+
2022-08-31T23:22:12Z
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
systemDate
+
+ + +
+
+ + + +
+
+

Entities

+
+ +
+
+

Address Entity

+
+
+ Entity of an address. Model follows specification of BPDM (Business Partner Data Management). +
+ +
+

Properties

+
+
+ +
+
Thoroughfare
+
+ +Street or thorough road name. + +
+
Name
+
thoroughfare
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.shared.address_characteristic:4.0.0#ThoroughfareEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
thoroughfare
+
+ + +
+
+ +
+
Locality
+
+ +Locality belonging to an address. + +
+
Name
+
locality
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.shared.address_characteristic:4.0.0#LocalityEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
locality
+
+ + +
+
+ +
+
Premise
+
+ +Premise of an address, e.g. a specific "BUILDING" but can also be used for naming a particular site. + +
+
Name
+
premise
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.shared.address_characteristic:4.0.0#PremiseEntity + +
+
+
+
+
+ + +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
premise
+
+ + +
+
+ +
+
Postal Delivery Point
+
+ +Delivery point, e.g. designation of a gate. + +
+
Name
+
postalDeliveryPoint
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.shared.address_characteristic:4.0.0#PostalDeliveryPointEntity + +
+
+
+
+
+ + +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
postalDeliveryPoint
+
+ + +
+
+ +
+
Country
+
+ +Country of an address. + +
+
Name
+
country
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.shared.address_characteristic:4.0.0#CountryEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
country
+
+ + +
+
+ +
+
Post Code
+
+ +Postal code of the address. + +
+
Name
+
postCode
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.shared.address_characteristic:4.0.0#PostCodeEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
postCode
+
+ + +
+
+
+
+

Country Entity

+
+
+ Entity definition for a country. +
+ +
+

Properties

+
+
+ +
+
Country Short Name
+
+ +The short variation of the name of the country. + +
+
Name
+
countryShortName
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
shortName
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + CountryShortNameConstraint +
    + +
    +
    Description
    +
    Regular expression for designation of a short name of a country as defined in ISO 3166-2.
    +
    + + +
    +
    Regular expression
    +
    ([A-Z]{2}-[A-Z0-9]{1,3}|)
    +
    + +
    • +
+
+
+
+
+
+
+

ESS Originator Coordinates Entity

+
+
+ Entity for geographic coordinates including a longitude and a latitude value. +
+ +
+

Properties

+
+
+ +
+
Longitude
+
+ +Longitude information for geographic coordinates. + +
+
Name
+
longitude
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
-79.517415
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
longitude
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + Longitude Constraint +
    + +
    +
    Description
    +
    Regular expression for longitude information.
    +
    + + +
    +
    Regular expression
    +
    ^(\+|-)?(?:180(?:(?:\.0{1,6})?)|(?:[0-9]|[1-9][0-9]|1[0-7][0-9])(?:(?:\.[0-9]{1,6})?))$
    +
    + +
    • +
+
+
+
+
+ +
+
Latitude
+
+ +Latitude information for geographic coordinates. + +
+
Name
+
latitude
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
-5.422077
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
latitude
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + Latitude Constraint +
    + +
    +
    Description
    +
    Regular expression for latitude information of geographic coordinates.
    +
    + + +
    +
    Regular expression
    +
    ^(\+|-)?(?:90(?:(?:\.0{1,6})?)|(?:[0-9]|[1-8][0-9])(?:(?:\.[0-9]{1,6})?))$
    +
    + +
    • +
+
+
+
+
+
+
+

Locality Entity

+
+
+ Entity for a locality which consists of a key and a value. +
+ +
+

Properties

+
+
+ +
+
Locality Technical Key
+
+ +Technical key of a locality. + +
+
Name
+
localityTechnicalKey
+
+ + + +
+
Characteristic
+
+
+
+
Enumeration
+
+
+
Values
+
+
+
+
    +
  • BLOCK
    • +
  • CITY
    • +
  • DISTRICT
    • +
  • OTHER
    • +
  • POST_OFFICE_CITY
    • +
  • QUARTER
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
CITY
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
technicalKey
+
+ + +
+
+ +
+
Locality Value
+
+ +Value of a locality, e.g. name of a city ("Mannheim"). + +
+
Name
+
localityValue
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Mannheim
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
value
+
+ + +
+
+
+
+

PostCode Entity

+
+
+ Entity for a postcode which consists of a type plus a value. +
+ +
+

Properties

+
+
+ +
+
Post Code Value
+
+ +The value of a post code. + +
+
Name
+
postCodeValue
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
98765-4321
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
value
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + Post Code Constraint +
    + +
    +
    Description
    +
    Regular expression for post codes.
    +
    + + +
    +
    Regular expression
    +
    ^[a-z0-9][a-z0-9\- ]{0,10}$
    +
    + +
    • +
+
+
+
+
+ +
+
Post Code Technical Key
+
+ +The technical key of a post code. + +
+
Name
+
postCodeTechnicalKey
+
+ + + +
+
Characteristic
+
+
+
+
Enumeration
+
+
+
Values
+
+
+
+
    +
  • CEDEX
    • +
  • LARGE_MAIL_USER
    • +
  • OTHER
    • +
  • POST_BOX
    • +
  • REGULAR
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
technicalKey
+
+ + +
+
+
+
+

Postal Delivery Point Entity

+
+
+ Entity for a postal delivery point which consists of a technical key and a value. +
+ +
+

Properties

+
+
+ +
+
Postal Delivery Point Technical Key
+
+ +Technical key of a postal delivery point. + +
+
Name
+
postalDeliveryPointTechnicalKey
+
+ + + +
+
Characteristic
+
+
+
+
Enumeration
+
+
+
Values
+
+
+
+
    +
  • INTERURBAN_DELIVERY_POINT
    • +
  • MAIL_STATION
    • +
  • MAILBOX
    • +
  • OTHER
    • +
  • POST_OFFICE_BOX
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
OTHER
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
technicalKey
+
+ + +
+
+ +
+
Postal Delivery Point Value
+
+ +Value of a postal delivery point, e.g. designation of a gate. + +
+
Name
+
postalDeliveryPointValue
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Tor 1
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
value
+
+ + +
+
+
+
+

Premise Entity

+
+
+ Entity for a premise which consists of a type (technical key) and a value. +
+ +
+

Properties

+
+
+ +
+
Premise Technical Key
+
+ +Technical key of a premise. + +
+
Name
+
premiseTechnicalKey
+
+ + + +
+
Characteristic
+
+
+
+
Enumeration
+
+
+
Values
+
+
+
+
    +
  • BUILDING
    • +
  • HARBOUR
    • +
  • LEVEL
    • +
  • OTHER
    • +
  • ROOM
    • +
  • SUITE
    • +
  • UNIT
    • +
  • WAREHOUSE
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
OTHER
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
technicalKey
+
+ + +
+
+ +
+
Premise Value
+
+ +Value of a premise, e.g. name or designation of a particular site. + +
+
Name
+
premiseValue
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Werk 1
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
value
+
+ + +
+
+
+
+

Thoroughfare Entity

+
+
+ Entity for a thoroughfare which consists of a type, value and number. +
+ +
+

Properties

+
+
+ +
+
Thoroughfare Technical Key
+
+ +Technical key of a thoroughfare. As specified by BPDM, this can be a "STREET" or a different type. + +
+
Name
+
thoroughfareTechnicalKey
+
+ + + +
+
Characteristic
+
+
+
+
Enumeration
+
+
+
Values
+
+
+
+
    +
  • STREET
    • +
  • INDUSTRIAL_ZONE
    • +
  • OTHER
    • +
  • RIVER
    • +
  • SQUARE
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
STREET
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
technicalKey
+
+ + +
+
+ +
+
Value Thoroughfare
+
+ +Value of a thoroughfare, e.g. name of a street. + +
+
Name
+
thoroughfareValue
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Bernstrasse
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
value
+
+ + +
+
+ +
+
Thoroughfare Number
+
+ +Number of a thoroughfare. As used differently in international context, this number can contain both numerical and alphanumerical values. + +
+
Name
+
thoroughfareNumber
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
45
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
number
+
+ + +
+
+
+ +
+ Third party licenses + +
+ +
+ + +
+ + + \ No newline at end of file diff --git a/io.catenax.essincident/4.0.0/gen/EssIncident.json b/io.catenax.essincident/4.0.0/gen/EssIncident.json new file mode 100644 index 000000000..62633199c --- /dev/null +++ b/io.catenax.essincident/4.0.0/gen/EssIncident.json @@ -0,0 +1,91 @@ +{ + "flagAnonymous" : false, + "incidentStatusInformation" : "new", + "essIncidentIssuerLastName" : "Testuser Last name", + "rawMaterial" : "Natural Rubber", + "industry" : "Extraction of raw materials", + "subCaseOpCoIds" : "9f47b3c8-b6d4-44f1-99ba-6bdb33916cac, 9f47b3c8-b6d4-44f1-99ba-6bdb33916cad", + "incidentSubcategory" : "Child labour", + "incidentSubject" : "Child labour on rubber producer Farm A", + "essIncidentIssuerAddress" : { + "locality" : { + "value" : "Mannheim", + "technicalKey" : "BLOCK" + }, + "country" : { + "shortName" : "" + }, + "postCode" : { + "value" : "98765-4321", + "technicalKey" : "CEDEX" + }, + "thoroughfare" : { + "value" : "Bernstrasse", + "number" : "45", + "technicalKey" : "STREET" + }, + "premise" : { + "value" : "Werk 1", + "technicalKey" : "BUILDING" + }, + "postalDeliveryPoint" : { + "value" : "Tor 1", + "technicalKey" : "INTERURBAN_DELIVERY_POINT" + } + }, + "essOriginatorCompanyName" : "Rubbery Ltd.", + "essOriginatorCountrySubdivision" : "BR-SP", + "productCommodity" : "Tire", + "essOriginatorAddress" : { + "locality" : { + "value" : "Mannheim", + "technicalKey" : "BLOCK" + }, + "country" : { + "shortName" : "AE-U" + }, + "postCode" : { + "value" : "98765-4321", + "technicalKey" : "CEDEX" + }, + "thoroughfare" : { + "value" : "Bernstrasse", + "number" : "45", + "technicalKey" : "STREET" + }, + "premise" : { + "value" : "Werk 1", + "technicalKey" : "BUILDING" + }, + "postalDeliveryPoint" : { + "value" : "Tor 1", + "technicalKey" : "INTERURBAN_DELIVERY_POINT" + } + }, + "incidentCategory" : "Environmental", + "incidentAttachment" : "telnet://192.0.2.16:80/", + "productDescription" : "Natural Rubber", + "essOriginatorBpnA" : "BPNA1234567890ZZ", + "essIncidentIssuerPhoneNo" : "+49-123-456789", + "incidentExternalSubject" : "Child labour on a rubber producer farm", + "incidentShareFlag" : false, + "incidentExternalNotes" : "Child labour at production site of a rubber producer in Brazil", + "essIncidentIssuerFirstName" : "Testuser First name", + "essIncidentIssuerId" : "9a47b3c8-b6d4-44f1-99ba-6bdb33916cac", + "masterOpCoId" : "9f47b3c8-b6d4-44f1-99ba-6bdb33916cac", + "incidentSystemId" : "123456789", + "essOriginatorBpnL" : "BPNL1234567890ZZ", + "essOriginatorCoordinates" : { + "longitude" : "-79.517415", + "latitude" : "-5.422077" + }, + "essIncidentModerator" : [ "BPNL1234567890YY" ], + "essIncidentIssuerCountrySubdivision" : "IN-AP", + "essIncidentIssuerEmailAddress" : "test@example.com", + "essOriginatorBpnS" : "BPNS1234567890ZZ", + "systemDate" : "2022-08-31T23:22:12Z", + "incidentDisplayId" : "123456789101", + "incidentDate" : "2022-08-31T00:00:00Z", + "incidentId" : "9f47b3c8-b6d4-44f1-99ba-6bdb33916cac", + "incidentDescription" : "Child labour at production site of the rubber producer Farm A in Brazil" +} \ No newline at end of file diff --git a/io.catenax.essincident/4.0.0/gen/EssIncident.yml b/io.catenax.essincident/4.0.0/gen/EssIncident.yml new file mode 100644 index 000000000..bcc3c5b20 --- /dev/null +++ b/io.catenax.essincident/4.0.0/gen/EssIncident.yml @@ -0,0 +1,577 @@ +--- +openapi: 3.0.3 +info: + title: ESS Incident + version: v4 +servers: +- url: catenax.io/api/v4 + variables: + api-version: + default: v4 +paths: + /{tenant-id}/ess-incident: + get: + tags: + - EssIncident + operationId: getEssIncident + 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/EssIncident' + "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/EssIncident' + 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.essincident_4.0.0_IndustryCharacteristic: + type: string + description: Industry Characteristic + enum: + - Extraction of raw materials + - Manufacture of components / intermediates + - Manufacture of final products + - Distribution / Trade + - Waste treatment / recycling + - Services + - Lending / financing / insurance + - Other + urn_samm_io.catenax.essincident_4.0.0_IncidentCategoryCharacteristic: + type: string + description: Characteristic for defining an incident category in the context + of ESS (Environmental and Social Standards). + enum: + - Environmental + - Social + urn_samm_io.catenax.essincident_4.0.0_IncidentSubcategories: + type: string + description: Characteristic for defining subcategories of an incident in the + context of ESS (Environmental and Social Standards). + enum: + - Child labour + - Forced labour + - Slavery + - Work safety + - Freedom of association + - Discrimination + - Minimum wage + - Environmental pollution + - Forced eviction + - Force by state security + - Usage of Mercury + - Usage of harmful chemicals + - Non-environmental friendly handling of waste + - Import and export of hazardous waste + urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_ResourcePath: + type: string + format: uri + description: The path of a resource. + 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.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_io.catenax.essincident_4.0.0_IncidentStatusCharacteristic: + type: string + description: "Incident status as defined in a list, default value = new" + enum: + - new + - in cleansing + - in process + - 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.shared.address_characteristic_4.0.0_ThoroughfareTechnicalKeyCharacteristic: + type: string + description: Characteristic of the technical key of a thoroughfare. + enum: + - STREET + - INDUSTRIAL_ZONE + - OTHER + - RIVER + - SQUARE + urn_samm_io.catenax.shared.address_characteristic_4.0.0_ThoroughfareEntity: + description: "Characteristic for defining a thoroughfare which can consist of\ + \ a type (e.g. \"STREET\"), value (e.g. \"Bernstra?e\") and number (e.g. \"\ + 45\"). Model follows the specification of BPDM." + type: object + properties: + technicalKey: + description: "Technical key of a thoroughfare. As specified by BPDM, this\ + \ can be a \"STREET\" or a different type." + $ref: '#/components/schemas/urn_samm_io.catenax.shared.address_characteristic_4.0.0_ThoroughfareTechnicalKeyCharacteristic' + value: + description: "Value of a thoroughfare, e.g. name of a street." + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + number: + description: "Number of a thoroughfare. As used differently in international\ + \ context, this number can contain both numerical and alphanumerical values." + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + required: + - technicalKey + - value + - number + urn_samm_io.catenax.shared.address_characteristic_4.0.0_LocalityTechnicalKeyCharacteristic: + type: string + description: Characteristic of the technical key of a locality + enum: + - BLOCK + - CITY + - DISTRICT + - OTHER + - POST_OFFICE_CITY + - QUARTER + urn_samm_io.catenax.shared.address_characteristic_4.0.0_LocalityEntity: + description: Characteristic for defining a locality which belongs to an address + and which consists of a type (e.g. "CITY") and value (e.g. "Mannheim"). Model + follows the specification of BPDM. + type: object + properties: + technicalKey: + description: Technical key of a locality. + $ref: '#/components/schemas/urn_samm_io.catenax.shared.address_characteristic_4.0.0_LocalityTechnicalKeyCharacteristic' + value: + description: "Value of a locality, e.g. name of a city (\"Mannheim\")." + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + required: + - technicalKey + - value + urn_samm_io.catenax.shared.address_characteristic_4.0.0_PremiseTechnicalKeyCharacteristic: + type: string + description: Characteristic of the technical key of a premise. + enum: + - BUILDING + - HARBOUR + - LEVEL + - OTHER + - ROOM + - SUITE + - UNIT + - WAREHOUSE + urn_samm_io.catenax.shared.address_characteristic_4.0.0_PremiseEntity: + description: Characteristic for defining a premise which consists of a technical + key (e.g. "BUILDING" or "OTHER") and a value (e.g. "Werk 1"). + type: object + properties: + technicalKey: + description: Technical key of a premise. + $ref: '#/components/schemas/urn_samm_io.catenax.shared.address_characteristic_4.0.0_PremiseTechnicalKeyCharacteristic' + value: + description: "Value of a premise, e.g. name or designation of a particular\ + \ site." + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + required: + - technicalKey + - value + urn_samm_io.catenax.shared.address_characteristic_4.0.0_PostalDeliveryPointTechnicalKeyCharacteristic: + type: string + description: Characteristic of the technical key of a postal delivery point. + enum: + - INTERURBAN_DELIVERY_POINT + - MAIL_STATION + - MAILBOX + - OTHER + - POST_OFFICE_BOX + urn_samm_io.catenax.shared.address_characteristic_4.0.0_PostalDeliveryPointEntity: + description: Characteristic for defining a postal delivery point which consists + of a technical key (e.g. "MAILBOX" or "OTHER") and a value. Model follows + the specification of BPDM. + type: object + properties: + technicalKey: + description: Technical key of a postal delivery point. + $ref: '#/components/schemas/urn_samm_io.catenax.shared.address_characteristic_4.0.0_PostalDeliveryPointTechnicalKeyCharacteristic' + value: + description: "Value of a postal delivery point, e.g. designation of a gate." + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + required: + - technicalKey + - value + urn_samm_io.catenax.shared.address_characteristic_4.0.0_CountryTrait: + type: string + description: Regular expression for designation of a short name of a country + as defined in ISO 3166-2. + pattern: "([A-Z]{2}-[A-Z0-9]{1,3}|)" + urn_samm_io.catenax.shared.address_characteristic_4.0.0_CountryEntity: + description: Characteristic of a country belonging to an address + type: object + properties: + shortName: + description: The short variation of the name of the country. + $ref: '#/components/schemas/urn_samm_io.catenax.shared.address_characteristic_4.0.0_CountryTrait' + required: + - shortName + urn_samm_io.catenax.shared.address_characteristic_4.0.0_PostCodeTrait: + type: string + description: Regular expression for post codes. + pattern: "^[a-z0-9][a-z0-9\\- ]{0,10}$" + urn_samm_io.catenax.shared.address_characteristic_4.0.0_PostCodeTechnicalKeyCharacteristic: + type: string + description: Characteristic for the technical key of a post code. + enum: + - CEDEX + - LARGE_MAIL_USER + - OTHER + - POST_BOX + - REGULAR + urn_samm_io.catenax.shared.address_characteristic_4.0.0_PostCodeEntity: + description: Characteristic for defining a postcode which can consist of a type + (e.g. "REGULAR" for zip codes) and a value (e.g. "98765-4321"). Model follows + the specification of BPDM. + type: object + properties: + value: + description: The value of a post code. + $ref: '#/components/schemas/urn_samm_io.catenax.shared.address_characteristic_4.0.0_PostCodeTrait' + technicalKey: + description: The technical key of a post code. + $ref: '#/components/schemas/urn_samm_io.catenax.shared.address_characteristic_4.0.0_PostCodeTechnicalKeyCharacteristic' + required: + - value + - technicalKey + urn_samm_io.catenax.shared.address_characteristic_4.0.0_PostalAddress: + description: A characteristic to express the postal address and which is intended + to be referenced by other aspects. + type: object + properties: + thoroughfare: + description: Street or thorough road name. + $ref: '#/components/schemas/urn_samm_io.catenax.shared.address_characteristic_4.0.0_ThoroughfareEntity' + locality: + description: Locality belonging to an address. + $ref: '#/components/schemas/urn_samm_io.catenax.shared.address_characteristic_4.0.0_LocalityEntity' + premise: + description: "Premise of an address, e.g. a specific \"BUILDING\" but can\ + \ also be used for naming a particular site." + $ref: '#/components/schemas/urn_samm_io.catenax.shared.address_characteristic_4.0.0_PremiseEntity' + postalDeliveryPoint: + description: "Delivery point, e.g. designation of a gate." + $ref: '#/components/schemas/urn_samm_io.catenax.shared.address_characteristic_4.0.0_PostalDeliveryPointEntity' + country: + description: Country of an address. + $ref: '#/components/schemas/urn_samm_io.catenax.shared.address_characteristic_4.0.0_CountryEntity' + postCode: + description: Postal code of the address. + $ref: '#/components/schemas/urn_samm_io.catenax.shared.address_characteristic_4.0.0_PostCodeEntity' + required: + - thoroughfare + - locality + - country + - postCode + urn_samm_io.catenax.shared.business_partner_number_2.0.0_BpnlCharacteristic: + type: string + description: "BPNL (Business Partner Number Legal Entity) represents the legal\ + \ entity of an organization (e.g. enterprise, university, association, …)\ + \ and contains its legal name (incl. legal form, if registered), registered\ + \ address and tax number. The registered address is the official, legal correspondence\ + \ address which has to be supplied to governmental and tax authorities and\ + \ is the address which is used in any legal or court documents. BPNL is on\ + \ corporate level and is unique for this legal entity." + urn_samm_io.catenax.shared.business_partner_number_2.0.0_BpnsCharacteristic: + type: string + description: "BPNS (Business Partner Number Site) represents a site which can\ + \ be a production plant. A site can also be e.g. an office or a warehouse.\ + \ An information related to a site is e.g. needed for reporting issues (How\ + \ many sites does e.g. Beispiel AG have?), status of operation (out of operations\ + \ due to environmental disaster), for certificates on site level (e.g. environment\ + \ certificates) or for internal regulations on site level, (e.g. security\ + \ topics, Corona rules,...). Several addresses (= BPNA with different streets\ + \ and different gates) can belong to one site. A BPNS should be always linked\ + \ to one BPNL via relationship 'belongs to legal entity'." + urn_samm_io.catenax.shared.business_partner_number_2.0.0_BpnaCharacteristic: + type: string + description: "BPNA (Business Partner Number Address) contains the legal name\ + \ (incl. legal form, if registered) and additional organization information\ + \ about site, e.g. Plant xxx, Branch office yyy of an organization with its\ + \ corresponding, most commonly physical, address. A BPNA is always linked\ + \ to a BPNL via relationship 'belongs to legal entity' and should be linked\ + \ to a BPNS via relationship 'belongs to site'.The BPNA is on operational\ + \ level (e.g. shipping or pick-up address)." + urn_samm_io.catenax.essincident_4.0.0_LongitudeTrait: + type: string + description: Regular expression for longitude information. + pattern: "^(\\+|-)?(?:180(?:(?:\\.0{1,6})?)|(?:[0-9]|[1-9][0-9]|1[0-7][0-9])(?:(?:\\\ + .[0-9]{1,6})?))$" + urn_samm_io.catenax.essincident_4.0.0_LatitudeTrait: + type: string + description: Regular expression for latitude information of geographic coordinates. + pattern: "^(\\+|-)?(?:90(?:(?:\\.0{1,6})?)|(?:[0-9]|[1-8][0-9])(?:(?:\\.[0-9]{1,6})?))$" + urn_samm_io.catenax.essincident_4.0.0_EssOriginatorCoordinatesEntity: + description: Characteristic for defining geographic coordinates (longitude and + latitude) of an incident originator in context of ESS (Environmental and Social + Standards). + type: object + properties: + longitude: + description: Longitude information for geographic coordinates. + $ref: '#/components/schemas/urn_samm_io.catenax.essincident_4.0.0_LongitudeTrait' + latitude: + description: Latitude information for geographic coordinates. + $ref: '#/components/schemas/urn_samm_io.catenax.essincident_4.0.0_LatitudeTrait' + required: + - longitude + - latitude + urn_samm_io.catenax.essincident_4.0.0_ContactMailTrait: + type: string + description: Regular expression for a contact mail address. + pattern: "^[a-zA-Z0-9.!#$%&?*+\\/=?^_`{|}~-]+@[a-zA-Z0-9-]+(?:\\.[a-zA-Z0-9-]+)*$" + urn_samm_io.catenax.essincident_4.0.0_EssIncidentModeratorCharacteristic: + description: Business Partner(s) who moderate(s) the clearing of an ESS incident + type: array + items: + type: string + description: "The provided regular expression ensures that the BPNL is composed\ + \ of prefix 'BPNL', 10 digits and two alphanumeric letters." + pattern: "^BPNL[a-zA-Z0-9]{12}$" + uniqueItems: true + EssIncident: + description: Aspect for defining an incident in context of Environmental and + Social Standards as specified by the Catena-X Sustainability team. + type: object + properties: + productCommodity: + description: Free-text description for commodity of a product affected by + an incident in the context of ESS (Environmental and Social Standards) + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + productDescription: + description: 'Description of product or component affected by an incident + in the context of ESS (Environmental and Social Standards) ' + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + rawMaterial: + description: Raw material that causes an incident in the context of ESS + (Environmental and Social Standards) + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + industry: + description: Industry / Branch that causes the incident + $ref: '#/components/schemas/urn_samm_io.catenax.essincident_4.0.0_IndustryCharacteristic' + incidentCategory: + description: Environmental and social standards related incident category + according to Supply Chain Due Diligence Act + $ref: '#/components/schemas/urn_samm_io.catenax.essincident_4.0.0_IncidentCategoryCharacteristic' + incidentSubcategory: + description: Subcategory of an incident Category + $ref: '#/components/schemas/urn_samm_io.catenax.essincident_4.0.0_IncidentSubcategories' + incidentSubject: + description: Title/ subject of an incident in the context of ESS (Environmental + and Social Standards) + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + incidentExternalSubject: + description: Replaces Incident Subject for external communication + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + incidentDescription: + description: Full text description of an incident in the context of ESS + (Environmental and Social Standards) + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + incidentExternalNotes: + description: Incident description for external communication + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + incidentAttachment: + description: Picture(s) about the reported incident in the context of ESS + (Environmental and Social Standards) + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_ResourcePath' + systemDate: + description: System created timestamp when the incident in the context of + ESS (Environmental and Social Standards) was issued and saved + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Timestamp' + incidentDate: + description: Date and time information when an incident in the context of + ESS (Environmental and Social Standards) occurred + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Timestamp' + incidentId: + description: Unique identifier for an incident in the context of ESS (Environmental + and Social Standards) + $ref: '#/components/schemas/urn_samm_io.catenax.shared.uuid_2.0.0_UuidV4Trait' + masterOpCoId: + description: Incident ID that has been checked and validated. In case of + duplicates the "parent" incident ID will be used as Master Operating Company + Incident ID. + $ref: '#/components/schemas/urn_samm_io.catenax.shared.uuid_2.0.0_UuidV4Trait' + incidentDisplayId: + description: Human readable format of Incident ID + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + incidentStatusInformation: + description: "Status of incident progress, default value = new" + $ref: '#/components/schemas/urn_samm_io.catenax.essincident_4.0.0_IncidentStatusCharacteristic' + incidentShareFlag: + description: "Flag, that can be set to true in order to request to publish\ + \ the incident, default value is false" + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Boolean' + subCaseOpCoIds: + description: Incident Ids that belong to a Master Operating Company Incident + Id + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + incidentSystemId: + description: System Id that defines the tenant + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + essOriginatorCompanyName: + description: Name of a company / an organisation that is the originator + of an incident in the context of ESS (Environmental and Social Standards) + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + essOriginatorAddress: + description: 'Address of ESS Originator ' + $ref: '#/components/schemas/urn_samm_io.catenax.shared.address_characteristic_4.0.0_PostalAddress' + essOriginatorBpnL: + description: BPN-L ID of the company that causes the incident + $ref: '#/components/schemas/urn_samm_io.catenax.shared.business_partner_number_2.0.0_BpnlCharacteristic' + essOriginatorBpnS: + description: BPN-S ID of the company that causes the incident + $ref: '#/components/schemas/urn_samm_io.catenax.shared.business_partner_number_2.0.0_BpnsCharacteristic' + essOriginatorBpnA: + description: BPN-A ID of the company that causes the incident + $ref: '#/components/schemas/urn_samm_io.catenax.shared.business_partner_number_2.0.0_BpnaCharacteristic' + essOriginatorCoordinates: + description: Exact geographic position of an incident in the context of + ESS (Environmental and Social Standards) + $ref: '#/components/schemas/urn_samm_io.catenax.essincident_4.0.0_EssOriginatorCoordinatesEntity' + essIncidentIssuerFirstName: + description: First name of ESS incident issuer + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + essIncidentIssuerEmailAddress: + description: Email address of ESS incident issuer + $ref: '#/components/schemas/urn_samm_io.catenax.essincident_4.0.0_ContactMailTrait' + essIncidentIssuerPhoneNo: + description: Phone number of ESS incident issuer + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + flagAnonymous: + description: Flag that Incident issuer wants to be anonymous + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Boolean' + essIncidentIssuerId: + description: System generated unique identifier of incident issuer + $ref: '#/components/schemas/urn_samm_io.catenax.shared.uuid_2.0.0_UuidV4Trait' + essIncidentIssuerAddress: + description: "Simple form of an address which can belong to a person, organisation,\ + \ company etc." + $ref: '#/components/schemas/urn_samm_io.catenax.shared.address_characteristic_4.0.0_PostalAddress' + essIncidentIssuerLastName: + description: Last name of ESS incident Issuer + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + essOriginatorCountrySubdivision: + description: Region within a country of ESS Originator + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + essIncidentIssuerCountrySubdivision: + description: Region within a country of ESS Incident Issuer + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + essIncidentModerator: + description: Business Partner who moderates the clearing of an ESS incident + $ref: '#/components/schemas/urn_samm_io.catenax.essincident_4.0.0_EssIncidentModeratorCharacteristic' + required: + - productDescription + - incidentCategory + - incidentSubcategory + - incidentDescription + - systemDate + - incidentDate + - incidentId + - incidentStatusInformation + 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' + EssIncident: + content: + application/json: + schema: + $ref: '#/components/schemas/PagingSchema' + description: The request was successful. + requestBodies: + EssIncident: + content: + application/json: + schema: + $ref: '#/components/schemas/EssIncident' diff --git a/io.catenax.essincident/4.0.0/metadata.json b/io.catenax.essincident/4.0.0/metadata.json new file mode 100644 index 000000000..699ff37d5 --- /dev/null +++ b/io.catenax.essincident/4.0.0/metadata.json @@ -0,0 +1 @@ +{ "status" : "release"} diff --git a/io.catenax.essincident/RELEASE_NOTES.md b/io.catenax.essincident/RELEASE_NOTES.md index dc15dd719..c687d202f 100644 --- a/io.catenax.essincident/RELEASE_NOTES.md +++ b/io.catenax.essincident/RELEASE_NOTES.md @@ -3,6 +3,16 @@ All notable changes to this model will be documented in this file. ## [Unreleased] +## [4.0.0] - 2024-05-27 +### Changed +- add field essIncidentModerator with trait BPNL +- set fields to optional: +- incidentDisplayId +- incidentShareFlag +- essIncidentIssuerId +- flagAnonymous + + ## [3.0.0] - 2024-02-19 ### Changed - updated version of model diff --git a/io.catenax.fleet.claim_data/1.0.0/metadata.json b/io.catenax.fleet.claim_data/1.0.0/metadata.json index a182c7b85..970dbd818 100644 --- a/io.catenax.fleet.claim_data/1.0.0/metadata.json +++ b/io.catenax.fleet.claim_data/1.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.claim_data/RELEASE_NOTES.md b/io.catenax.fleet.claim_data/RELEASE_NOTES.md index 643cc5687..33901b0ce 100644 --- a/io.catenax.fleet.claim_data/RELEASE_NOTES.md +++ b/io.catenax.fleet.claim_data/RELEASE_NOTES.md @@ -17,7 +17,7 @@ All notable changes to this model will be documented in this file. ### Removed - Vehicle entity -> all properties are now located on claim entity -## [1.0.0] - 2022-12-13 +## [1.0.0] - 2022-12-13 -> deprecated ### Added - initial version of this model diff --git a/io.catenax.fleet.diagnostic_data/1.0.0/metadata.json b/io.catenax.fleet.diagnostic_data/1.0.0/metadata.json index a182c7b85..970dbd818 100644 --- a/io.catenax.fleet.diagnostic_data/1.0.0/metadata.json +++ b/io.catenax.fleet.diagnostic_data/1.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.diagnostic_data/RELEASE_NOTES.md b/io.catenax.fleet.diagnostic_data/RELEASE_NOTES.md index 30615e3bb..6479e4476 100644 --- a/io.catenax.fleet.diagnostic_data/RELEASE_NOTES.md +++ b/io.catenax.fleet.diagnostic_data/RELEASE_NOTES.md @@ -20,7 +20,7 @@ All notable changes to this model will be documented in this file. - vehicle entity: Properties now located one level up on DiagnosticSession - eventList: Removed completely - instead procedures list was introduced -## [1.0.0] - 2022-12-13 +## [1.0.0] - 2022-12-13 -> deprecated ### Added - initial version of this model diff --git a/io.catenax.fleet.vehicles/1.0.0/metadata.json b/io.catenax.fleet.vehicles/1.0.0/metadata.json index a182c7b85..970dbd818 100644 --- a/io.catenax.fleet.vehicles/1.0.0/metadata.json +++ b/io.catenax.fleet.vehicles/1.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/metadata.json b/io.catenax.fleet.vehicles/2.1.0/metadata.json index a182c7b85..970dbd818 100644 --- a/io.catenax.fleet.vehicles/2.1.0/metadata.json +++ b/io.catenax.fleet.vehicles/2.1.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/RELEASE_NOTES.md b/io.catenax.fleet.vehicles/RELEASE_NOTES.md index fd8c238ef..0c84eab0e 100644 --- a/io.catenax.fleet.vehicles/RELEASE_NOTES.md +++ b/io.catenax.fleet.vehicles/RELEASE_NOTES.md @@ -13,7 +13,7 @@ All notable changes to this model will be documented in this file. ### Removed -## [2.1.0] - 2024-02-19 +## [2.1.0] - 2024-02-19 -> deprecated ### Added ### Changed @@ -22,7 +22,7 @@ All notable changes to this model will be documented in this file. ### Removed -## [2.0.0] - 2024-01-22 +## [2.0.0] - 2024-01-22 -> deprecated ### Added - metaInformation added to root entity: Gives data consumer necessary information how data provider created this data set - integration of shared UUID characteristic and RegEx for the vehicle Catena-X identifier @@ -45,7 +45,7 @@ Streamlining of aspect model: - remove of sale entity: Properties now located on vehicle level - remove of production entity: Properties now located on vehicle level -## [1.0.0] - 2023-05-15 +## [1.0.0] - 2023-05-15 -> deprecated ### Added - initial version of this model diff --git a/io.catenax.generic.digital_product_passport/1.0.0/DigitalProductPassport.ttl b/io.catenax.generic.digital_product_passport/1.0.0/DigitalProductPassport.ttl deleted file mode 100644 index 873551e77..000000000 --- a/io.catenax.generic.digital_product_passport/1.0.0/DigitalProductPassport.ttl +++ /dev/null @@ -1,876 +0,0 @@ -####################################################################### -# Copyright (c) 2023 ZF Friedrichshafen AG -# Copyright (c) 2023 BMW AG -# Copyright (c) 2023 BASF Coatings GmbH -# Copyright (c) 2023 Henkel AG & Co. KGaA -# Copyright (c) 2023 CGI Deutschland B.V. & Co. KG -# Copyright (c) 2023 SAP Deutschland SE & Co.KG -# Copyright (c) 2023 iPoint-systems GmbH -# Copyright (c) 2023 T-Systems International GmbH -# Copyright (c) 2023 Contributors to the Eclipse Foundation -# -# 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 bamm: . -@prefix bamm-c: . -@prefix bamm-e: . -@prefix unit: . -@prefix rdf: . -@prefix rdfs: . -@prefix xsd: . -@prefix : . -@prefix ext-dimension: . -@prefix ext-part: . -@prefix ext-pcf: . - -:DigitalProductPassport a bamm:Aspect; - bamm:preferredName "Digital Product Passport"@en; - bamm:description "The Digital Product Passport is a data record that summarizes the components, materials and chemical substances or information on repairability, spare parts or professional disposal for a product. The data comes from all phases of the product life cycle and can be used for various purposes in all these phases (design, production, use, disposal). Structuring environmental data in a standardized, comparable format enables all actors in the value and supply chain to work together towards a circular economy. This data model is based on the new proposed Ecodesign Regulation (ESPR-2022) and is continuously adapted to the basic conditions over time."@en; - bamm:see ; - bamm:properties (:metadata :typology :handling :sustainability :characteristics :commercial :operation :identification :serialization :sources [ - bamm:property :additionalData; - bamm:optional "true"^^xsd:boolean -] ); - bamm:operations (); - bamm:events (). -:typology a bamm:Property; - bamm:preferredName "Typology"@en; - bamm:description "Properties further describing the product type."@en; - bamm:characteristic :TypologyCharacteristic. -:handling a bamm:Property; - bamm:preferredName "handling"@en; - bamm:description "Properties connected with the handling of the product."@en; - bamm:characteristic :HandlingCharacteristic. -:sustainability a bamm:Property; - bamm:preferredName "sustainability"@en; - bamm:description "Properties which are relevant for the sustainability of the product."@en; - bamm:characteristic :SustainabilityCharacteristic. -:characteristics a bamm:Property; - bamm:preferredName "Characteristics"@en; - bamm:description "Defines specific characteristics of a product."@en; - bamm:characteristic :Characteristics. -:commercial a bamm:Property; - bamm:preferredName "Commercial"@en; - bamm:description "Commercial information of the product."@en; - bamm:characteristic :CommercialCharacteristic. -:operation a bamm:Property; - bamm:preferredName "Operation"@en; - bamm:description "Operational information of the product."@en; - bamm:characteristic :OperationCharacteristic. -:identification a bamm:Property; - bamm:preferredName "Identification"@en; - bamm:description "Identification information of the product, especially identifiers and codes."@en; - bamm:characteristic :IdentificationCharacteristic. -:serialization a bamm:Property; - bamm:preferredName "Serialization"@en; - bamm:description "Serialization information on the product."@en; - bamm:characteristic :SerializationCharacteristic. -:additionalData a bamm:Property; - bamm:preferredName "Additional Data"@en; - bamm:description "Data in form of open fields which need to be transferred in addition."@en; - bamm:characteristic :AdditionalDataList. -:TypologyCharacteristic a bamm:Characteristic; - bamm:preferredName "Typology Characteristic"@en; - bamm:description "Characteristic to further describe product."@en; - bamm:dataType :TypologyEntity. -:HandlingCharacteristic a bamm:Characteristic; - bamm:preferredName "Handling Characteristic"@en; - bamm:description "Characteristic to describe aspects which are connected with the handling of the product."@en; - bamm:dataType :HandlingEntity. -:SustainabilityCharacteristic a bamm:Characteristic; - bamm:preferredName "Sustainability Characteristic"@en; - bamm:description "Characteristic which describes relevant information for the sustainability of the product."@en; - bamm:dataType :SustainabilityEntity. -:Characteristics a bamm:Characteristic; - bamm:preferredName "Characteristics"@en; - bamm:description "Defines a set of specific characteristics of a product."@en; - bamm:dataType :CharacteristicsEntity. -:CommercialCharacteristic a bamm:Characteristic; - bamm:preferredName "Commercial Characteristic"@en; - bamm:description "Commercial information of the product."@en; - bamm:dataType :CommercialEntity. -:OperationCharacteristic a bamm:Characteristic; - bamm:preferredName "Operation Characteristic"@en; - bamm:description "Operational information of the product."@en; - bamm:dataType :OperationEntity. -:IdentificationCharacteristic a bamm:Characteristic; - bamm:preferredName "Identification Characteristic"@en; - bamm:description "Identification information of the product."@en; - bamm:dataType :IdentificationEntity. -:SerializationCharacteristic a bamm:Characteristic; - bamm:preferredName "Serialization Characteristic"@en; - bamm:description "Characteristic for serialization information."@en; - bamm:dataType :SerializationEntity. -:AdditionalDataList a bamm-c:List; - bamm:preferredName "Additional Data List"@en; - bamm:description "List of additional data."@en; - bamm:dataType :AdditionalDataEntity. -:TypologyEntity a bamm:Entity; - bamm:preferredName "Typology Entity"@en; - bamm:description "Entity describing attributes such as the product description, class and different names."@en; - bamm:properties ([ - bamm:property :productDescription; - bamm:optional "true"^^xsd:boolean; - bamm:payloadName "description" -] [ - bamm:property :class; - bamm:optional "true"^^xsd:boolean -] :name ext-part:nameAtManufacturer ext-part:nameAtCustomer). -:HandlingEntity a bamm:Entity; - bamm:preferredName "Handling Entity"@en; - bamm:description "Entity to describe different aspects in relation with the handling of the product. Properties are the maintenance history spare parts, substances of concern and reusable packaging."@en; - bamm:properties (:maintenanceHistory [ - bamm:property :spareParts; - bamm:optional "true"^^xsd:boolean -] :substanceOfConcern [ - bamm:property :reusablePackaging; - bamm:optional "true"^^xsd:boolean -]). -:SustainabilityEntity a bamm:Entity; - bamm:preferredName "Sustainability Entity"@en; - bamm:description "Entity with the properties state, al list of different materials, a list of critical materials and the product carbon footprint."@en; - bamm:properties (:state :material :critical :carbonFootprint). -:CharacteristicsEntity a bamm:Entity; - bamm:preferredName "Characteristics Entity"@en; - bamm:description "Entity which defines specific characteristics of a product such as the lifespan and the physical dimensions."@en; - bamm:properties (:lifespan [ - bamm:property ext-dimension:physicalDimensionsProperty; - bamm:optional "true"^^xsd:boolean -]). -:CommercialEntity a bamm:Entity; - bamm:preferredName "Commercial Entity"@en; - bamm:description "Commercial information such as placed on market and the warranty."@en; - bamm:properties ([ - bamm:property :placedOnMarket; - bamm:optional "true"^^xsd:boolean -] :warranty). -:OperationEntity a bamm:Entity; - bamm:preferredName "Operation Entity"@en; - bamm:description "Operational information of the product such as the owner, manufacturer and importer."@en; - bamm:properties (:importer :manufacturer). -:IdentificationEntity a bamm:Entity; - bamm:preferredName "Identification Entity"@en; - bamm:description "Entity with identification information of the product with local identifiers, gtin, commodity code and other codes."@en; - bamm:properties ([ - bamm:property :gtin; - bamm:optional "true"^^xsd:boolean -] [ - bamm:property :additionalCode; - bamm:optional "true"^^xsd:boolean -] ext-part:localIdentifiers). -:SerializationEntity a bamm:Entity; - bamm:preferredName "Serialization Entity"@en; - bamm:description "Entity for serialization information such as the quantity, the registration ids and the manufacturing date."@en; - bamm:properties (:quantity :registration ext-part:manufacturingInformation). -:AdditionalDataEntity a bamm:Entity; - bamm:preferredName "Additional Data Entity"@en; - bamm:description "Entity with additional data. Properties are label, description, type, data and children. Either the fields data or children filled. Children constructs a hierarchy with the same attributes. Data is filled as the end of an path/leaf."@en; - bamm:properties (:label :description :type [ - bamm:property :data; - bamm:optional "true"^^xsd:boolean -] [ - bamm:property :children; - bamm:optional "true"^^xsd:boolean -]). -:version a bamm:Property; - bamm:preferredName "Version"@en; - bamm:description "The current version of the product passport."@en; - bamm:characteristic bamm-c:Text; - bamm:exampleValue "1.0.0". -:status a bamm:Property; - bamm:preferredName "Status"@en; - bamm:description "The current status of the product passport declared through either: draft, approved, invalid or expired."@en; - bamm:characteristic :StatusEnumeration; - bamm:exampleValue "Draft". -:validityDate a bamm:Property; - bamm:preferredName "Validity Date"@en; - bamm:description "The timestamp for the product passport until when it is available."@en; - bamm:characteristic :TimeStamp; - bamm:exampleValue "2000-01-01"^^xsd:date. -:issueDate a bamm:Property; - bamm:preferredName "Issue Date"@en; - bamm:description "The timestamp for the product passport since when it is available."@en; - bamm:characteristic :TimeStamp; - bamm:exampleValue "2000-01-01"^^xsd:date. -:productDescription a bamm:Property; - bamm:preferredName "Product Description"@en; - bamm:description "A general short product description."@en; - bamm:characteristic bamm-c:Text; - bamm:exampleValue "Product Description long text". -:class a bamm:Property; - bamm:preferredName "Class"@en; - bamm:description "The associated product category according to ECLASS. The ECLASS is the worldwide reference data standard for classifying and clearly describing products and services."@en; - bamm:see ; - bamm:characteristic :ClassCharacteristic. -:name a bamm:Property; - bamm:preferredName "name"@en; - bamm:description "The name of the product type."@en; - bamm:characteristic bamm-c:Text; - bamm:exampleValue "Transmission Type 8HP60". -:maintenanceHistory a bamm:Property; - bamm:preferredName "Maintenance History"@en; - bamm:description "The maintenance history of the product with dates, titles and descriptions."@en; - bamm:characteristic :MaintenanceHistoryList. -:spareParts a bamm:Property; - bamm:preferredName "Spare Parts"@en; - bamm:description "The list of spare parts available for the product from a supplier."@en; - bamm:characteristic :PartList. -:substanceOfConcern a bamm:Property; - bamm:preferredName "Concerning Substance"@en; - bamm:description "Details to the substance of concern."@en; - bamm:characteristic :SubstanceList. -:reusablePackaging a bamm:Property; - bamm:preferredName "Reusable Packaging"@en; - bamm:description "Definition of whether the product uses a reuse system. The values true or false are allowed."@en; - bamm:characteristic bamm-c:Boolean; - bamm:exampleValue "true"^^xsd:boolean. -:StatusEnumeration a bamm-c:Enumeration; - bamm:preferredName "Status Enumeration"@en; - bamm:description "Enumeration with draft, approved, invalid or expired."@en; - bamm:dataType xsd:string; - bamm-c:values ("Draft" "Approved" "Invalid" "Expired"). -:TimeStamp a bamm:Characteristic; - bamm:preferredName "Time Stamp"@en; - bamm:description "A time stamp in the format (yyyy-mm-dd) with or without time zone."@en; - bamm:dataType xsd:date. -:ClassCharacteristic a bamm:Characteristic; - bamm:preferredName "Class Characteristic"@en; - bamm:description "Characteristic to describe the ECLASS typology of a product."@en; - bamm:dataType :ClassEntity. -:MaintenanceHistoryList a bamm-c:List; - bamm:preferredName "Maintenance History List"@en; - bamm:description "A list of entries of the service history."@en; - bamm:dataType :MaintenanceHistoryEntity. -:PartList a bamm-c:List; - bamm:preferredName "Part List"@en; - bamm:description "The list of spare parts with different identifiers."@en; - bamm:dataType :PartEntity. -:SubstanceList a bamm-c:List; - bamm:preferredName "Substance List"@en; - bamm:description "Characteristic for a list of substances of concern."@en; - bamm:dataType :SubstanceEntity. -:content a bamm:Property; - bamm:preferredName "Content"@en; - bamm:description "The content of the document e.g a link."@en; - bamm:characteristic bamm-c:Text; - bamm:exampleValue "www.alink.pdf". -:category a bamm:Property; - bamm:preferredName "Category"@en; - bamm:description "The category in which the document can be sorted."@en; - bamm:characteristic :CategoryEnumeration; - bamm:exampleValue "Sustainability". -:CategoryEnumeration a bamm-c:Enumeration; - bamm:preferredName "Category Enumeration"@en; - bamm:dataType xsd:string; - bamm-c:values ("Safety" "Sustainability" "Compliance" "Passport" "SubstanceOfConcern"). -:contentType a bamm:Property; - bamm:preferredName "Content Type"@en; - bamm:description "The type of content which can be expected in the \"content\" property. Examples are a link, pdf, excel, etc."@en; - bamm:characteristic bamm-c:Text; - bamm:exampleValue "link". -:header a bamm:Property; - bamm:preferredName "Header"@en; - bamm:description "The header as a short description of the document with a maximum of 100 characters."@en; - bamm:characteristic :TitleTrait; - bamm:exampleValue "Sustainability Document Material XY". -:TitleTrait a bamm-c:Trait; - bamm:preferredName "Title Trait"@en; - bamm:description "A trait for the title."@en; - bamm-c:baseCharacteristic bamm-c:Text; - bamm-c:constraint :TitleConstraint. -:state a bamm:Property; - bamm:preferredName "State"@en; - bamm:description "Status of the product (first life or second life)."@en; - bamm:characteristic :StateEnumeration. -:StateEnumeration a bamm-c:Enumeration; - bamm:preferredName "State Enumeration"@en; - bamm:description "Enumeration with the values first life and second life."@en; - bamm:dataType xsd:string; - bamm-c:values ("first life" "second life"). -:material a bamm:Property; - bamm:preferredName "Material"@en; - bamm:description "Information on different materials in the product."@en; - bamm:characteristic :MaterialList. -:MaterialList a bamm-c:List; - bamm:preferredName "Material List"@en; - bamm:description "A list of different materials in the product."@en; - bamm:dataType :MaterialEntity. -:MaterialEntity a bamm:Entity; - bamm:preferredName "Material Entity"@en; - bamm:description "Entity with properties materialName, percentage and flags for the possibility to recycle and renew the material."@en; - bamm:properties ([ - bamm:property :materialName; - bamm:payloadName "name" -] :recycled [ - bamm:property :renewable; - bamm:optional "true"^^xsd:boolean -] :percentage). -:critical a bamm:Property; - bamm:preferredName "Critical"@en; - bamm:description "The list of critical raw materials in the product (CRM) which is specified by EU."@en; - bamm:characteristic :CriticalList. -:CriticalList a bamm-c:List; - bamm:preferredName "Critical List"@en; - bamm:description "The list of critical raw materials in the product (CRM) which is specified by EU."@en; - bamm:dataType xsd:string. -:carbonFootprint a bamm:Property; - bamm:preferredName "Carbon Footprint"@en; - bamm:description "Carbon Footprint property with sustainability information."@en; - bamm:characteristic :CarbonFootprintCharacteristic. -:CarbonFootprintCharacteristic a bamm:Characteristic; - bamm:preferredName "Carbon Footprint Characteristic"@en; - bamm:description "Carbon Footprint Characteristic with sustainability information."@en; - bamm:dataType :CarbonFootprintEntity. -:CarbonFootprintEntity a bamm:Entity; - bamm:preferredName "CarbonFootprintEntity"@en; - bamm:description "Carbon Footprint Characteristic with sustainability information such as the carbon footprint total, rules and standards."@en; - bamm:properties (ext-pcf:carbonContentTotal ext-pcf:productOrSectorSpecificRules ext-pcf:crossSectoralStandard). -:lifespan a bamm:Property; - bamm:preferredName "Lifespan"@en; - bamm:description "The expected product lifetime (lifespan)."@en; - bamm:characteristic :LifespanCharacteristic. -:LifespanCharacteristic a bamm:Characteristic; - bamm:preferredName "Lifespan Characteristic"@en; - bamm:description "Characteristic for the expected product lifetime (lifespan)."@en; - bamm:dataType :LifespanEntity. -:LifespanEntity a bamm:Entity; - bamm:preferredName "Lifespan Entity"@en; - bamm:description "Entity for the lifespan of a product with unit and value."@en; - bamm:properties ([ - bamm:property :lifeUnit; - bamm:payloadName "unit" -] [ - bamm:property :lifeValue; - bamm:payloadName "value" -]). -:placedOnMarket a bamm:Property; - bamm:preferredName "Placed on Market"@en; - bamm:description "Date on when the product is put in the market."@en; - bamm:characteristic :TimeStamp; - bamm:exampleValue "2000-01-01"^^xsd:date. -:warranty a bamm:Property; - bamm:preferredName "Warranty"@en; - bamm:description "Commercial warranty period of the product (coupled to the Vehicle) in months. Durability and reliability of the product or its components as expressed through the product’s guaranteed lifetime, technical lifetime, mean time between failures, indication of real use information on the product, resistance to stresses or aging mechanisms."@en; - bamm:characteristic :WarrantyCharacteristic; - bamm:exampleValue "36"^^xsd:decimal. -:WarrantyCharacteristic a bamm-c:Measurement; - bamm:preferredName "Warranty Characteristic"@en; - bamm:dataType xsd:decimal; - bamm-c:unit unit:month. -:manufacturerId a bamm:Property; - bamm:preferredName "Manufacturer Id"@en; - bamm:description "The main manufacturer, if different from the passport owner."@en; - bamm:characteristic :CompanyIdentification; - bamm:exampleValue "BPN1234567890ZZ". -:CompanyIdentification a bamm:Characteristic; - bamm:preferredName "Company Identification"@en; - bamm:description "Identification of the company or location of the company. In the CATENA-X network the BPN/L identification is needed."@en; - bamm:dataType xsd:string. -:importer a bamm:Property; - bamm:preferredName "Importer"@en; - bamm:description "The importer of the product, if different from the owner of the passport."@en; - bamm:characteristic :CompanyIdentification; - bamm:exampleValue "BPNL1234567890ZZ". -:gtin a bamm:Property; - bamm:preferredName "GTIN"@en; - bamm:description "GTIN stands for Global Trade Item Number. It is a unique and internationally recognized identifier used to identify products in the global marketplace. GTINs are typically encoded in barcodes and are used by retailers, manufacturers, and suppliers to track and manage their products throughout the supply chain. Valid inputs are all GTIN versions (GTIN-8, GTIN-12, GTIN-13, and GTIN-14)."@en; - bamm:characteristic :GtinTrait; - bamm:exampleValue "12345678". -:GtinTrait a bamm-c:Trait; - bamm-c:baseCharacteristic bamm-c:Text; - bamm-c:constraint :GtinConstraint. -:GtinConstraint a bamm-c:RegularExpressionConstraint; - bamm:preferredName "GTIN Constraint"@en; - bamm:description "This pattern allows for matching any GTIN version by specifying the required number of digits for each version."@en; - bamm:value "^(?:\\d{8}|\\d{12}|\\d{13}|\\d{14})$". -:additionalCode a bamm:Property; - bamm:preferredName "Additional Code"@en; - bamm:description "Codes for identification can be for example commodity codes. In Europe, two commonly used codes for goods classification are the Harmonized System (HS) code and the Combined Nomenclature (CN). Other codes can also be given."@en; - bamm:characteristic :CodeList. -:CodeList a bamm-c:List; - bamm:preferredName "Code List"@en; - bamm:description "A list of additional codes."@en; - bamm:dataType :CodeEntity. -:CodeEntity a bamm:Entity; - bamm:preferredName "Code Entity"@en; - bamm:description "Code entity with code name and value."@en; - bamm:properties ([ - bamm:property :codeName; - bamm:payloadName "name" -] [ - bamm:property :codeValue; - bamm:payloadName "value" -]). -:quantity a bamm:Property; - bamm:preferredName "Quantity"@en; - bamm:description "Quantity refers to the number of units or items of a product being bought, sold, manufactured, or stored. It is an important factor in inventory management, supply chain logistics, and pricing calculations."@en; - bamm:characteristic :QuantityCharacteristic. -:QuantityCharacteristic a bamm:Characteristic; - bamm:preferredName "Quantity Characteristic"@en; - bamm:description "Quantity of the product."@en; - bamm:dataType :QuantityEntity. -:QuantityEntity a bamm:Entity; - bamm:preferredName "Quantity Entity"@en; - bamm:description "Quantity of the product with value and unit."@en; - bamm:properties ([ - bamm:property :quantityUnit; - bamm:payloadName "unit" -] [ - bamm:property :quantityValue; - bamm:payloadName "value" -]). -:facilityId a bamm:Property; - bamm:preferredName "Facility Id"@en; - bamm:description "The facility Identification, where the main manufacturing took place."@en; - bamm:characteristic :CompanyIdentification; - bamm:exampleValue "BPNL1234567890ZZ". -:registration a bamm:Property; - bamm:preferredName "Registration"@en; - bamm:description "Registration information such as the identification at the customer and the manufacturer."@en; - bamm:characteristic :RegistrationCharacteristic. -:RegistrationCharacteristic a bamm:Characteristic; - bamm:preferredName "Registration Characteristic"@en; - bamm:description "Characteristic for registration information such as the identification at the customer and the manufacturer."@en; - bamm:dataType :RegistrationEntity. -:RegistrationEntity a bamm:Entity; - bamm:preferredName "Registration Entity"@en; - bamm:description "Entity for registration information such as the identification at the customer and the manufacturer."@en; - bamm:properties (ext-part:customerPartId ext-part:manufacturerPartId). -:label a bamm:Property; - bamm:preferredName "Label"@en; - bamm:description "The human readable name of the attribute."@en; - bamm:characteristic bamm-c:Text; - bamm:exampleValue "Maximum permitted battery power". -:description a bamm:Property; - bamm:preferredName "Description"@en; - bamm:description "The description of the attribute context."@en; - bamm:characteristic bamm-c:Text; - bamm:exampleValue "Description of an attribute". -:type a bamm:Property; - bamm:preferredName "Type"@en; - bamm:description "The complex description of the type."@en; - bamm:characteristic :TypeCharacteristic. -:TypeCharacteristic a bamm:Characteristic; - bamm:preferredName "Type Characteristic"@en; - bamm:description "Characteristic for the data type."@en; - bamm:dataType :TypeEntity. -:TypeEntity a bamm:Entity; - bamm:preferredName "Type Entity"@en; - bamm:description "Entity for type with unit and data type."@en; - bamm:properties ([ - bamm:property :typeUnit; - bamm:optional "true"^^xsd:boolean -] :dataType). -:data a bamm:Property; - bamm:preferredName "Data"@en; - bamm:description "The content from the attribute which is a depended of the data type and typeUnit."@en; - bamm:characteristic bamm-c:Text; - bamm:exampleValue "23". -:children a bamm:Property; - bamm:preferredName "children"@en; - bamm:description "Children of the hierarchy."@en; - bamm:characteristic :AdditionalDataList. -:materialName a bamm:Property; - bamm:preferredName "Material Name"@en; - bamm:description "The material name which is part of the product."@en; - bamm:characteristic bamm-c:Text; - bamm:exampleValue "Aluminium". -:recycled a bamm:Property; - bamm:preferredName "Recycled"@en; - bamm:description "A flag if the material is recovered recyclate content from the product."@en; - bamm:characteristic bamm-c:Boolean; - bamm:exampleValue "false"^^xsd:boolean. -:renewable a bamm:Property; - bamm:preferredName "Renewable"@en; - bamm:description "Flag if the material is made of natural resources that can be replenished. Renewable resources are those that can be reproduced by physical, chemical, or mechanical processes. These are the kind of resources that can be regenerated throughout time. Forest wood, for example, can be grown through reforestation."@en; - bamm:characteristic bamm-c:Boolean; - bamm:exampleValue "true"^^xsd:boolean. -:percentage a bamm:Property; - bamm:preferredName "Percentage"@en; - bamm:description "Percentage of the material."@en; - bamm:characteristic :Percent; - bamm:exampleValue "5.0"^^xsd:float. -:ClassEntity a bamm:Entity; - bamm:preferredName "Class Entity"@en; - bamm:description "Entity to describe the associated product category according to ECLASS. The ECLASS is the worldwide reference data standard for classifying and clearly describing products and services. Properties separated into the code and name."@en; - bamm:properties (:code :definition). -:code a bamm:Property; - bamm:preferredName "Code"@en; - bamm:description "The associated product category CODE according to ECLASS."@en; - bamm:see ; - bamm:characteristic :CodeTrait; - bamm:exampleValue "44-09-02-02". -:definition a bamm:Property; - bamm:preferredName "Definition"@en; - bamm:description "The associated product category NAME according to ECLASS."@en; - bamm:see ; - bamm:characteristic bamm-c:Text; - bamm:exampleValue "Manual transmission (motor vehicle)". -:CodeTrait a bamm-c:Trait; - bamm:preferredName "Code Trait"@en; - bamm:description "Trait to limit the input to the specified format (00-00-00-00)."@en; - bamm-c:baseCharacteristic bamm-c:Text; - bamm-c:constraint :CodeConstraint. -:MaintenanceHistoryEntity a bamm:Entity; - bamm:preferredName "Maintenance History Entity"@en; - bamm:description "Entity describing a list of entries of the service history with title, text, activities and dates."@en; - bamm:properties (:title [ - bamm:property :maintenanceDescription; - bamm:payloadName "description" -] [ - bamm:property :maintenanceDate; - bamm:payloadName "date" -] :activity). -:title a bamm:Property; - bamm:preferredName "Title"@en; - bamm:description "The title of the data object with a maximum of 100 characters."@en; - bamm:characteristic :TitleTrait; - bamm:exampleValue "Check-up". -:maintenanceDate a bamm:Property; - bamm:preferredName "Maintenance Date"@en; - bamm:description "The dates when the product was put into service, repair etc."@en; - bamm:characteristic :TimeStamp; - bamm:exampleValue "2000-01-01"^^xsd:date. -:activity a bamm:Property; - bamm:preferredName "Activity"@en; - bamm:description "The activities of putting the product into service in form of an enumeration with the values Inspection, Maintenance, Repair, Preventive Maintenance, Accident and Other."@en; - bamm:characteristic :ActivityEnumeration; - bamm:exampleValue "Maintenance". -:ActivityEnumeration a bamm-c:Enumeration; - bamm:preferredName "Activity Enumeration"@en; - bamm:description "The activities of putting the product into service in form of an enumeration with the values Inspection, Maintenance, Repair, Preventive Maintenance, Accident and Other."@en; - bamm:dataType xsd:string; - bamm-c:values ("Inspection" "Maintenance" "Repair" "Preventive Maintenance" "Accident" "Other"). -:PartEntity a bamm:Entity; - bamm:preferredName "Part Entity"@en; - bamm:description "Entity with the attributes partId, producerId and partName to describe a list of spare parts."@en; - bamm:properties (:partId :producerId [ - bamm:property :partName; - bamm:payloadName "name" -]). -:partId a bamm:Property; - bamm:preferredName "Part Id"@en; - bamm:description "The identification of spare parts available for the product."@en; - bamm:characteristic bamm-c:Text; - bamm:exampleValue "Aluminum Housing 952/C". -:producerId a bamm:Property; - bamm:preferredName "Producer Id"@en; - bamm:description "The identifier of the producer. In the CATENA-X network the BPN identification of the spare part producer is needed."@en; - bamm:characteristic :CompanyIdentification; - bamm:exampleValue "BPNL1234567890ZZ". -:partName a bamm:Property; - bamm:preferredName "Part Name"@en; - bamm:description "The name of the spare part."@en; - bamm:characteristic bamm-c:Text; - bamm:exampleValue "Aluminum Housing". -:SubstanceEntity a bamm:Entity; - bamm:preferredName "Substance Entity"@en; - bamm:description "Entity to describe a list of properties regarding a substance of concern such as the substance name, location, unit and concentration."@en; - bamm:properties ([ - bamm:property :substanceName; - bamm:payloadName "name" -] :location [ - bamm:property :substanceUnit; - bamm:payloadName "unit" -] :concentration [ - bamm:property :substanceId; - bamm:payloadName "id" -]). -:substanceName a bamm:Property; - bamm:preferredName "Substance Name"@en; - bamm:description "In accordance with the ESPR specification the name of the substances of concern which is present in the product have to be declared."@en; - bamm:characteristic bamm-c:Text; - bamm:exampleValue "Lead". -:location a bamm:Property; - bamm:preferredName "Location"@en; - bamm:description "The location of the substances of concern within the product."@en; - bamm:characteristic bamm-c:Text; - bamm:exampleValue "Housing". -:substanceUnit a bamm:Property; - bamm:preferredName "Substance Unit"@en; - bamm:description "Units of concentration are percent, volume percent, parts per thousand, parts per million, parts per billion and parts per trillion."@en; - bamm:see ; - bamm:characteristic :ConcentrationEnumeration; - bamm:exampleValue "unit:percent". -:concentration a bamm:Property; - bamm:preferredName "Concentration"@en; - bamm:description "Concentration of substances of concern at the level of the product."@en; - bamm:characteristic :Either; - bamm:exampleValue "13.6". -:ConcentrationEnumeration a bamm-c:Enumeration; - bamm:preferredName "Concentration Enumeration"@en; - bamm:description "Enumeration of possible units of concentration with percent, volume percent, parts per thousand, parts per million, parts per billion and parts per trillion."@en; - bamm:see ; - bamm:dataType xsd:string; - bamm-c:values ("unit:partPerMillion" "unit:percent" "unit:percentVolume" "unit:partPerThousand" "unit:partPerTrillionUs" "unit:partPerBillionUs"). -:Either a bamm-c:Either; - bamm:preferredName "Either"@en; - bamm:description "Characteristic with two possible values."@en; - bamm-c:left :RangeCharacteristic; - bamm-c:right :ConcentrationCharacteristic. -:TitleConstraint a bamm-c:LengthConstraint; - bamm:preferredName "Title Constraint"@en; - bamm:description "A constraint that limits the title to 100 characters."@en; - bamm-c:minValue "3"^^xsd:nonNegativeInteger; - bamm-c:maxValue "100"^^xsd:nonNegativeInteger. -:RangeCharacteristic a bamm-c:List; - bamm:preferredName "Range Characteristic"@en; - bamm:description "Input should be two values, the highest and te lowest of the range."@en; - bamm:dataType xsd:float. -:ConcentrationCharacteristic a bamm:Characteristic; - bamm:preferredName "Concentration Characteristic"@en; - bamm:description "Concentration of substances of concern at the level of the product."@en; - bamm:dataType xsd:float. -:Percent a bamm-c:Measurement; - bamm:preferredName "Percent"@en; - bamm:dataType xsd:float; - bamm-c:unit unit:percent. -:lifeUnit a bamm:Property; - bamm:preferredName "Life Unit"@en; - bamm:description "The unit of the expected lifetime of a product from the unit catalog."@en; - bamm:see ; - bamm:characteristic :LifespanEnumeration; - bamm:exampleValue "unit:month". -:LifespanEnumeration a bamm-c:Enumeration; - bamm:preferredName "Lifespan Enumeration"@en; - bamm:see ; - bamm:dataType xsd:string; - bamm-c:values ("unit:day" "unit:month" "unit:cycle" "unit:year" "unit:kilometre" "unit:runningOrOperatingHour"). -:lifeValue a bamm:Property; - bamm:preferredName "Life Value"@en; - bamm:description "The value of the expected lifetime of a product."@en; - bamm:characteristic :LifeValueCharacteristic; - bamm:exampleValue "36"^^xsd:integer. -:LifeValueCharacteristic a bamm-c:Quantifiable; - bamm:preferredName "Life Value Characteristic"@en; - bamm:dataType xsd:integer. -:eori a bamm:Property; - bamm:preferredName "EORI"@en; - bamm:description "Any economic operator established in the customs territory of the Union needs, for customs purposes, an EORI number. EORI stands for economic operators registration and identification number."@en; - bamm:characteristic :EoriTrait; - bamm:exampleValue "GB123456789000". -:EoriTrait a bamm-c:Trait; - bamm-c:baseCharacteristic bamm-c:Text; - bamm-c:constraint :EoriConstraint. -:EoriConstraint a bamm-c:RegularExpressionConstraint; - bamm:preferredName "EORI Constraint"@en; - bamm:description "Constraint with a pattern which ensures that the EORI number starts with two alphanumeric characters, followed by two alphabetic characters, and ends with 2 to 15 alphanumeric characters."@en; - bamm:value "^[A-Z]{2}[A-Z0-9]{1,18}$". -:codeName a bamm:Property; - bamm:preferredName "Code Name"@en; - bamm:description "Title of the code."@en; - bamm:characteristic bamm-c:Text; - bamm:exampleValue "TARIC". -:codeValue a bamm:Property; - bamm:preferredName "Code Value"@en; - bamm:description "The code value of the specific code."@en; - bamm:characteristic bamm-c:Text; - bamm:exampleValue "8703 24 10 00". -:typeUnit a bamm:Property; - bamm:preferredName "Type Unit"@en; - bamm:description "Choose a unit type from the unit catalog, or if the property \"children\" is filled, leave empty."@en; - bamm:characteristic :UnitCatalog; - bamm:exampleValue "unit:volume". -:UnitCatalog a bamm:Characteristic; - bamm:preferredName "Unit Catalog"@en; - bamm:description "Link to the unit catalog with all possible units in the format \"unit:xxx\"."@en; - bamm:see ; - bamm:dataType xsd:string. -:dataType a bamm:Property; - bamm:preferredName "Data Type"@en; - bamm:description "Data type that describe the content of the attributes children and data. In case \"object\" is selected in the enumeration, the children field will be used in the AdditionalDataEntity instead of the \"data\" property. If it is an other type, the content will be specified in \"data\" as a string."@en; - bamm:characteristic :DataTypeEnumeration; - bamm:exampleValue "xsd:integer". -:DataTypeEnumeration a bamm-c:Enumeration; - bamm:preferredName "Data Type Enumeration"@en; - bamm:description "Data type that describe the content of the attributes children and data. In case \"object\" is selected in the enumeration, the children field will be used in the AdditionalDataEntity instead of the \"data\" property. If it is an other type, the content will be specified in \"data\" as a string."@en; - bamm:see ; - bamm:dataType xsd:string; - bamm-c:values ("array" "object" "xsd:string" "xsd:integer" "xsd:boolean" "xsd:double" "xsd:float" "xsd:byte"). -:CodeConstraint a bamm-c:RegularExpressionConstraint; - bamm:preferredName "Code Constraint"@en; - bamm:description "Constraint to limit the input to a valid ECLASS number. The constraint ensures that each pair of digits is followed by a hyphen, resulting in a pattern like \"00-00-00-00\" where the zeros can be replaced by any digit."@en; - bamm:value "^\\d{2}-\\d{2}-\\d{2}-\\d{2}$". -:manufacturer a bamm:Property; - bamm:preferredName "Manufacturer"@en; - bamm:description "Manufacturing identification of the product."@en; - bamm:characteristic :ManufacturerCharacteristic. -:ManufacturerCharacteristic a bamm:Characteristic; - bamm:preferredName "Manufacturer Characteristic"@en; - bamm:description "Manufacturing information."@en; - bamm:dataType :ManufacturerEntity. -:ManufacturerEntity a bamm:Entity; - bamm:preferredName "Manufacturer Entity"@en; - bamm:description "Manufacturing Entity with the identification of the main manufacturer and the facility location."@en; - bamm:properties (:facilityId [ - bamm:property :manufacturerId; - bamm:optional "true"^^xsd:boolean -]). -:quantityUnit a bamm:Property; - bamm:preferredName "Quantity Unit"@en; - bamm:description "Quantity refers to the number of units or items of a product being bought, sold, manufactured, or stored as a batch.If the product is a single item choose the unit \"unit:piece\". All possible units are pieces, gram, kilogram, millilitres, litres, cubic meters, meters or square meters."@en; - bamm:see ; - bamm:characteristic :QuantityEnumeration; - bamm:exampleValue "unit:piece". -:QuantityEnumeration a bamm-c:Enumeration; - bamm:preferredName "Quantity Enumeration"@en; - bamm:description "Enumeration of possible quantities in a batch."@en; - bamm:see ; - bamm:dataType xsd:string; - bamm-c:values ("unit:piece" "unit:gram" "unit:kilogram" "unit:metre" "unit:litre" "unit:cubicMetre" "unit:squareMetre"). -:quantityValue a bamm:Property; - bamm:preferredName "Quantity Value"@en; - bamm:description "Quantity refers to the number of units or items of a product being bought, sold, manufactured, or stored. If the product is not a batch, choose the unit piece and value 1.0."@en; - bamm:characteristic :QuantityValueCharacteristic; - bamm:exampleValue "1.0"^^xsd:float. -:optionalSources a bamm:Property; - bamm:preferredName "Optional Sources"@en; - bamm:description "Optional sources for the product. Optional sources can be a document regarding tool and process, assembly and disassembly, repair and installation, user manual, End of Life, return and disposal, expected waste generation, product packaging, positioning, waste prevention or sustainability information."@en; - bamm:characteristic :SourceListCharacteristic. -:mandatorySources a bamm:Property; - bamm:preferredName "Mandatory Sources"@en; - bamm:description "Mandatory document and sources of the product."@en; - bamm:characteristic :MandatorySourcesCharacteristic. -:QuantityValueCharacteristic a bamm:Characteristic; - bamm:preferredName "Quantity Value Characteristic"@en; - bamm:description "The value of the quantity."@en; - bamm:dataType xsd:float. -:declarationOfConformity a bamm:Property; - bamm:preferredName "declarationOfConformity"@en; - bamm:description "Compliance documentation and information required under this Regulation or other Union law applicable to the product, such as the declaration of conformity, technical documentation or conformity certificates."@en; - bamm:characteristic :SourceListCharacteristic. -:SourcesEntity a bamm:Entity; - bamm:preferredName "Sources Entity"@en; - bamm:description "Entity with optional and mandatory sources. Mandatory sources are documents regarding the substance of concern and compliance."@en; - bamm:properties ([ - bamm:property :optionalSources; - bamm:optional "true"^^xsd:boolean; - bamm:payloadName "optional" -] [ - bamm:property :mandatorySources; - bamm:payloadName "mandatory" -]). -:DocumentCharacteristic a bamm:Characteristic; - bamm:preferredName "Document Characteristic"@en; - bamm:description "Characteristic for different documents."@en; - bamm:dataType :DocumentEntity. -:DocumentEntity a bamm:Entity; - bamm:preferredName "Document Entity"@en; - bamm:description "Document entity with header, content, category and type."@en; - bamm:properties (:content :category [ - bamm:property :contentType; - bamm:payloadName "type" -] :header). -:substanceOfConcernInstruction a bamm:Property; - bamm:preferredName "Substance of Concern Instruction"@en; - bamm:description "Instructions regarding the substances of concern."@en; - bamm:characteristic :DocumentCharacteristic. -:substanceOfConcernDisassembly a bamm:Property; - bamm:preferredName "Substance of Concern Disassembly"@en; - bamm:description "Document regarding the disassembly processes for the substances of concern."@en; - bamm:characteristic :DocumentCharacteristic. -:safetyTransportation a bamm:Property; - bamm:preferredName "Substance of Concern Transportation"@en; - bamm:description "Document regarding the safe transportation of the product."@en; - bamm:characteristic :DocumentCharacteristic. -:safetyPackaging a bamm:Property; - bamm:preferredName "Safety Packaging"@en; - bamm:description "Document regarding the packaging of the product."@en; - bamm:characteristic :DocumentCharacteristic. -:sourceName a bamm:Property; - bamm:preferredName "Source Name"@en; - bamm:description "The source name as an enumeration."@en; - bamm:characteristic :SourceNameEnumeration. -:SourceNameEnumeration a bamm-c:Enumeration; - bamm:preferredName "Source Name Enumeration"@en; - bamm:description "Enumeration of different source names."@en; - bamm:dataType xsd:string; - bamm-c:values ("other" "tool and process" "assembly and disassembly" "repair and installation" "user manual" "end of life" "return and disposal" "expected waste generation" "product packaging" "positioning" "waste prevention" "sustainability"). -:documentProperty a bamm:Property; - bamm:preferredName "Document Property"@en; - bamm:description "Property for the document."@en; - bamm:characteristic :DocumentCharacteristic. -:SourceEntity a bamm:Entity; - bamm:preferredName "Source Entity"@en; - bamm:description "Entity for document sources of a product."@en; - bamm:properties ([ - bamm:property :sourceName; - bamm:payloadName "name" -] [ - bamm:property :documentProperty; - bamm:payloadName "document" -]). -:economicOperator a bamm:Property; - bamm:preferredName "Economic Operator"@en; - bamm:description "The economic operator of the passport."@en; - bamm:characteristic :EconomicOperatorCharacteristic. -:EconomicOperatorCharacteristic a bamm:Characteristic; - bamm:preferredName "Economic Operator Characteristic"@en; - bamm:description "Economic operator of the passport."@en; - bamm:dataType :EconomicOperatorEntity. -:EconomicOperatorEntity a bamm:Entity; - bamm:preferredName "Economic Operator Entity"@en; - bamm:description "Economic operator entity with identification and EORI."@en; - bamm:properties ([ - bamm:property :economicOperatorId; - bamm:payloadName "id" -] [ - bamm:property :eori; - bamm:optional "true"^^xsd:boolean -]). -:economicOperatorId a bamm:Property; - bamm:preferredName "Economic Operator Id"@en; - bamm:description "The identification of the economic operator of the passport."@en; - bamm:characteristic :CompanyIdentification; - bamm:exampleValue "BPNL1234567890ZZ". -:metadata a bamm:Property; - bamm:preferredName "Metadata"@en; - bamm:description "The passport metadata of the digital product passport such as status and validity."@en; - bamm:characteristic :MetadataCharacteristic. -:MetadataCharacteristic a bamm:Characteristic; - bamm:preferredName "Metadata Characteristic"@en; - bamm:description "Characteristic for the passport metadata of the digital product passport."@en; - bamm:dataType :MetadataEntity. -:MetadataEntity a bamm:Entity; - bamm:preferredName "Metadata Entity"@en; - bamm:description "Passport Entity to describe version, status, validity and issue date."@en; - bamm:properties (:version :status :validityDate :issueDate :economicOperator). -:sources a bamm:Property; - bamm:preferredName "Sources"@en; - bamm:description "Different sources in relation to the product."@en; - bamm:characteristic :SourcesCharacteristic. -:SourcesCharacteristic a bamm:Characteristic; - bamm:preferredName "Sources Characteristic"@en; - bamm:description "The sources of the product."@en; - bamm:dataType :SourcesEntity. -:MandatorySourcesCharacteristic a bamm:Characteristic; - bamm:preferredName "Mandatory Sources Characteristic"@en; - bamm:description "Characteristic for the different mandatory sources."@en; - bamm:dataType :MandatorySourcesEntity. -:MandatorySourcesEntity a bamm:Entity; - bamm:preferredName "Mandatory Sources Entity"@en; - bamm:description "Entity for document sources of a product."@en; - bamm:properties (:safetyPackaging :safetyTransportation :substanceOfConcernDisassembly :declarationOfConformity :substanceOfConcernInstruction). -:SourceListCharacteristic a bamm-c:List; - bamm:preferredName "Source List Characteristic"@en; - bamm:description "A list of documents."@en; - bamm:dataType :SourceEntity. -:maintenanceDescription a bamm:Property; - bamm:preferredName "Maintenance Description"@en; - bamm:description "A short description of the maintenance content."@en; - bamm:characteristic bamm-c:Text; - bamm:exampleValue "Check tire pressure and rotate tires". -:substanceId a bamm:Property; - bamm:preferredName "Substance Id"@en; - bamm:description "The substance identification."@en; - bamm:characteristic bamm-c:Text; - bamm:exampleValue "RC0402". diff --git a/io.catenax.generic.digital_product_passport/1.0.0/gen/DigitalProductPassport-aas.xml b/io.catenax.generic.digital_product_passport/1.0.0/gen/DigitalProductPassport-aas.xml deleted file mode 100644 index 5287a8edb..000000000 --- a/io.catenax.generic.digital_product_passport/1.0.0/gen/DigitalProductPassport-aas.xml +++ /dev/null @@ -1,10069 +0,0 @@ - - - - - defaultAdminShell - - - en - defaultAdminShell - - - - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#DigitalProductPassport - - Type - - - - ModelReference - - - Submodel - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#DigitalProductPassport/submodel - - - - - - - - - DigitalProductPassport - - - en - The Digital Product Passport is a data record that summarizes the components, materials and chemical substances or information on repairability, spare parts or professional disposal for a product. The data comes from all phases of the product life cycle and can be used for various purposes in all these phases (design, production, use, disposal). Structuring environmental data in a standardized, comparable format enables all actors in the value and supply chain to work together towards a circular economy. This data model is based on the new proposed Ecodesign Regulation (ESPR-2022) and is continuously adapted to the basic conditions over time. - - - - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#DigitalProductPassport/submodel - Template - - ModelReference - - - ConceptDescription - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#DigitalProductPassport - - - - - - ExternalReference - - - GlobalReference - https://commission.europa.eu/energy-climate-change-environment/standards-tools-and-labels/products-labelling-rules-and-requirements/sustainable-products/ecodesign-sustainable-products_en - - - - - - - MetadataEntity - - - en - Metadata Entity - - - - - en - Passport Entity to describe version, status, validity and issue date. - - - - - version - - - en - Version - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#version - - - - xs:string - - - - status - - - en - Status - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#status - - - - xs:string - - - - validityDate - - - en - Validity Date - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#validityDate - - - - xs:date - - - - issueDate - - - en - Issue Date - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#issueDate - - - - xs:date - - - - EconomicOperatorEntity - - - en - Economic Operator Entity - - - - - en - Economic operator entity with identification and EORI. - - - - - economicOperatorId - - - en - Economic Operator Id - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#economicOperatorId - - - - xs:string - - - - eori - - - en - EORI - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#eori - - - - xs:string - - - - - - - - TypologyEntity - - - en - Typology Entity - - - - - en - Entity describing attributes such as the product description, class and different names. - - - - - productDescription - - - en - Product Description - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#productDescription - - - - xs:string - - - - ClassEntity - - - en - Class Entity - - - - - en - Entity to describe the associated product category according to ECLASS. The ECLASS is the worldwide reference data standard for classifying and clearly describing products and services. Properties separated into the code and name. - - - - - ExternalReference - - - GlobalReference - https://eclass.eu/en/eclass-standard/search-content/show?tx_eclasssearch_ecsearch%5Bdischarge%5D=0&tx_eclasssearch_ecsearch%5Bid%5D=44000000&tx_eclasssearch_ecsearch%5Blanguage%5D=1&tx_eclasssearch_ecsearch%5Bversion%5D=13.0&cHash=10abd2696c4c5c526da4e3367e78c592 - - - - - - - code - - - en - Code - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#code - - - - - - ExternalReference - - - GlobalReference - https://eclass.eu/en/eclass-standard/search-content/show?tx_eclasssearch_ecsearch[discharge]=0&tx_eclasssearch_ecsearch[id]=44000000&tx_eclasssearch_ecsearch[language]=1&tx_eclasssearch_ecsearch[version]=13.0&cHash=10abd2696c4c5c526da4e3367e78c592 - - - - - xs:string - - - - definition - - - en - Definition - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#definition - - - - - - ExternalReference - - - GlobalReference - https://eclass.eu/en/eclass-standard/search-content/show?tx_eclasssearch_ecsearch[discharge]=0&tx_eclasssearch_ecsearch[id]=44000000&tx_eclasssearch_ecsearch[language]=1&tx_eclasssearch_ecsearch[version]=13.0&cHash=10abd2696c4c5c526da4e3367e78c592 - - - - - xs:string - - - - - - name - - - en - name - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#name - - - - xs:string - - - - nameAtManufacturer - - - en - Name at Manufacturer - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.serial_part:1.0.0#nameAtManufacturer - - - - xs:string - - - - nameAtCustomer - - - en - Name at Customer - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.serial_part:1.0.0#nameAtCustomer - - - - xs:string - - - - - - HandlingEntity - - - en - Handling Entity - - - - - en - Entity to describe different aspects in relation with the handling of the product. Properties are the maintenance history spare parts, substances of concern and reusable packaging. - - - - - maintenanceHistory - - - en - Maintenance History - - - - - en - The maintenance history of the product with dates, titles and descriptions. - - - true - DataElement - - - MaintenanceHistoryEntity - - - en - Maintenance History Entity - - - - - en - Entity describing a list of entries of the service history with title, text, activities and dates. - - - - - title - - - en - Title - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#title - - - - xs:string - - - - maintenanceDescription - - - en - Maintenance Description - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#maintenanceDescription - - - - xs:string - - - - maintenanceDate - - - en - Maintenance Date - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#maintenanceDate - - - - xs:date - - - - activity - - - en - Activity - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#activity - - - - xs:string - - - - - - - - spareParts - - - en - Spare Parts - - - - - en - The list of spare parts available for the product from a supplier. - - - true - DataElement - - - PartEntity - - - en - Part Entity - - - - - en - Entity with the attributes partId, producerId and partName to describe a list of spare parts. - - - - - partId - - - en - Part Id - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#partId - - - - xs:string - - - - producerId - - - en - Producer Id - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#producerId - - - - xs:string - - - - partName - - - en - Part Name - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#partName - - - - xs:string - - - - - - - - substanceOfConcern - - - en - Concerning Substance - - - - - en - Details to the substance of concern. - - - true - DataElement - - - SubstanceEntity - - - en - Substance Entity - - - - - en - Entity to describe a list of properties regarding a substance of concern such as the substance name, location, unit and concentration. - - - - - substanceName - - - en - Substance Name - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#substanceName - - - - xs:string - - - - location - - - en - Location - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#location - - - - xs:string - - - - substanceUnit - - - en - Substance Unit - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#substanceUnit - - - - - - ExternalReference - - - GlobalReference - https://eclipse-esmf.github.io/samm-specification/snapshot/appendix/unitcatalog.html - - - - - xs:string - - - - Either - - - en - Either - - - - - en - Characteristic with two possible values. - - - true - DataElement - - - concentration - - - en - Concentration - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#concentration - - - - xs:float - - - - concentration - - - en - Concentration - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#concentration - - - - xs:float - - - - - - substanceId - - - en - Substance Id - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#substanceId - - - - xs:string - - - - - - - - reusablePackaging - - - en - Reusable Packaging - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#reusablePackaging - - - - xs:boolean - - - - - - SustainabilityEntity - - - en - Sustainability Entity - - - - - en - Entity with the properties state, al list of different materials, a list of critical materials and the product carbon footprint. - - - - - state - - - en - State - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#state - - - - xs:string - - - - material - - - en - Material - - - - - en - Information on different materials in the product. - - - true - DataElement - - - MaterialEntity - - - en - Material Entity - - - - - en - Entity with properties materialName, percentage and flags for the possibility to recycle and renew the material. - - - - - materialName - - - en - Material Name - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#materialName - - - - xs:string - - - - recycled - - - en - Recycled - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#recycled - - - - xs:boolean - - - - renewable - - - en - Renewable - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#renewable - - - - xs:boolean - - - - percentage - - - en - Percentage - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#percentage - - - - xs:float - - - - - - - - critical - - - en - Critical - - - - - en - The list of critical raw materials in the product (CRM) which is specified by EU. - - - true - DataElement - - - critical - - - en - Critical - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#critical - - - - xs:string - - - - - - CarbonFootprintEntity - - - en - CarbonFootprintEntity - - - - - en - Carbon Footprint Characteristic with sustainability information such as the carbon footprint total, rules and standards. - - - - - carbonContentTotal - - - en - Carbon Content Total - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.pcf:4.0.0#carbonContentTotal - - - - xs:decimal - - - - productOrSectorSpecificRules - - - en - Product or Sector Specific Rules - - - - - en - Product or sector specific rules applied for calculating or allocating GHG (Greenhouse Gas) emissions, e.g. PCRs (Product Category Rules), including operators or pubishers and according rule names as specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. - - - - - ExternalReference - - - GlobalReference - https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/ - - - - - true - DataElement - - - ProductOrSectorSpecificRule - - - en - Product Or Sector Specific Rule - - - - - en - Entity for defining a product or sector specific rule of a product carbon footprint as specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. - - - - - ExternalReference - - - GlobalReference - https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/ - - - - - - - operator - - - en - Operator or Publisher of Sector Specific Rules - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.pcf:4.0.0#operator - - - - - - ExternalReference - - - GlobalReference - https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/ - - - - - xs:string - - - - RuleName - - - en - Rule Name - - - - - en - Name of a rule applied by a specified operator as specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. - - - - - ExternalReference - - - GlobalReference - https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/ - - - - - - - ruleName - - - en - Rule Name - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.pcf:4.0.0#ruleName - - - - - - ExternalReference - - - GlobalReference - https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/ - - - - - xs:string - - - - - - otherOperatorName - - - en - Other Operator Name - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.pcf:4.0.0#otherOperatorName - - - - - - ExternalReference - - - GlobalReference - https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/ - - - - - xs:string - - - - - - - - crossSectoralStandard - - - en - Cross Sectoral Standard - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.pcf:4.0.0#crossSectoralStandard - - - - - - ExternalReference - - - GlobalReference - https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/ - - - - - xs:string - - - - - - - - CharacteristicsEntity - - - en - Characteristics Entity - - - - - en - Entity which defines specific characteristics of a product such as the lifespan and the physical dimensions. - - - - - LifespanEntity - - - en - Lifespan Entity - - - - - en - Entity for the lifespan of a product with unit and value. - - - - - lifeUnit - - - en - Life Unit - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#lifeUnit - - - - - - ExternalReference - - - GlobalReference - https://eclipse-esmf.github.io/samm-specification/snapshot/appendix/unitcatalog.html - - - - - xs:string - - - - lifeValue - - - en - Life Value - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#lifeValue - - - - xs:integer - - - - - - PhysicalDimensionsEntity - - - en - physical dimensions - - - - - en - Entity encapsulating the physical dimensions of an object. - - - - - weight - - - en - weight - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.shared.physical_dimension:2.0.0#weight - - - - xs:double - - - - diameter - - - en - diameter - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.shared.physical_dimension:2.0.0#diameter - - - - xs:double - - - - height - - - en - height - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.shared.physical_dimension:2.0.0#height - - - - xs:double - - - - width - - - en - width - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.shared.physical_dimension:2.0.0#width - - - - xs:double - - - - length - - - en - length - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.shared.physical_dimension:2.0.0#length - - - - xs:double - - - - - - - - CommercialEntity - - - en - Commercial Entity - - - - - en - Commercial information such as placed on market and the warranty. - - - - - placedOnMarket - - - en - Placed on Market - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#placedOnMarket - - - - xs:date - - - - warranty - - - en - Warranty - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#warranty - - - - xs:decimal - - - - - - OperationEntity - - - en - Operation Entity - - - - - en - Operational information of the product such as the owner, manufacturer and importer. - - - - - importer - - - en - Importer - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#importer - - - - xs:string - - - - ManufacturerEntity - - - en - Manufacturer Entity - - - - - en - Manufacturing Entity with the identification of the main manufacturer and the facility location. - - - - - facilityId - - - en - Facility Id - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#facilityId - - - - xs:string - - - - manufacturerId - - - en - Manufacturer Id - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#manufacturerId - - - - xs:string - - - - - - - - IdentificationEntity - - - en - Identification Entity - - - - - en - Entity with identification information of the product with local identifiers, gtin, commodity code and other codes. - - - - - gtin - - - en - GTIN - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#gtin - - - - xs:string - - - - additionalCode - - - en - Additional Code - - - - - en - Codes for identification can be for example commodity codes. In Europe, two commonly used codes for goods classification are the Harmonized System (HS) code and the Combined Nomenclature (CN). Other codes can also be given. - - - true - DataElement - - - CodeEntity - - - en - Code Entity - - - - - en - Code entity with code name and value. - - - - - codeName - - - en - Code Name - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#codeName - - - - xs:string - - - - codeValue - - - en - Code Value - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#codeValue - - - - xs:string - - - - - - - - localIdentifiers - - - en - Local Identifiers - - - - - en - A local identifier enables identification of a part in a specific dataspace, but is not unique in Catena-X dataspace. Multiple local identifiers may exist. - - - true - DataElement - - - KeyValueList - - - en - Key Value List - - - - - en - A list of key value pairs for local identifiers, which are composed of a key and a corresponding value. - - - - - key - - - en - Identifier Key - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.serial_part:1.0.0#key - - - - xs:string - - - - value - - - en - Identifier Value - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.serial_part:1.0.0#value - - - - xs:string - - - - - - - - - - SerializationEntity - - - en - Serialization Entity - - - - - en - Entity for serialization information such as the quantity, the registration ids and the manufacturing date. - - - - - QuantityEntity - - - en - Quantity Entity - - - - - en - Quantity of the product with value and unit. - - - - - quantityUnit - - - en - Quantity Unit - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#quantityUnit - - - - - - ExternalReference - - - GlobalReference - https://eclipse-esmf.github.io/samm-specification/snapshot/appendix/unitcatalog.html - - - - - xs:string - - - - quantityValue - - - en - Quantity Value - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#quantityValue - - - - xs:float - - - - - - RegistrationEntity - - - en - Registration Entity - - - - - en - Entity for registration information such as the identification at the customer and the manufacturer. - - - - - customerPartId - - - en - Customer Part ID - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.serial_part:1.0.0#customerPartId - - - - xs:string - - - - manufacturerPartId - - - en - Manufacturer Part ID - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.serial_part:1.0.0#manufacturerPartId - - - - xs:string - - - - - - ManufacturingEntity - - - en - Manufacturing Entity - - - - - en - Encapsulates the manufacturing relevant attributes - - - - - date - - - en - Production Date - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.serial_part:1.0.0#date - - - - xs:dateTime - - - - country - - - en - Country code - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.serial_part:1.0.0#country - - - - xs:string - - - - - - - - SourcesEntity - - - en - Sources Entity - - - - - en - Entity with optional and mandatory sources. Mandatory sources are documents regarding the substance of concern and compliance. - - - - - optionalSources - - - en - Optional Sources - - - - - en - Optional sources for the product. Optional sources can be a document regarding tool and process, assembly and disassembly, repair and installation, user manual, End of Life, return and disposal, expected waste generation, product packaging, positioning, waste prevention or sustainability information. - - - true - DataElement - - - SourceEntity - - - en - Source Entity - - - - - en - Entity for document sources of a product. - - - - - sourceName - - - en - Source Name - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#sourceName - - - - xs:string - - - - DocumentEntity - - - en - Document Entity - - - - - en - Document entity with header, content, category and type. - - - - - content - - - en - Content - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#content - - - - xs:string - - - - category - - - en - Category - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#category - - - - xs:string - - - - contentType - - - en - Content Type - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#contentType - - - - xs:string - - - - header - - - en - Header - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#header - - - - xs:string - - - - - - - - - - MandatorySourcesEntity - - - en - Mandatory Sources Entity - - - - - en - Entity for document sources of a product. - - - - - DocumentEntity - - - en - Document Entity - - - - - en - Document entity with header, content, category and type. - - - - - content - - - en - Content - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#content - - - - xs:string - - - - category - - - en - Category - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#category - - - - xs:string - - - - contentType - - - en - Content Type - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#contentType - - - - xs:string - - - - header - - - en - Header - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#header - - - - xs:string - - - - - - DocumentEntity - - - en - Document Entity - - - - - en - Document entity with header, content, category and type. - - - - - content - - - en - Content - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#content - - - - xs:string - - - - category - - - en - Category - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#category - - - - xs:string - - - - contentType - - - en - Content Type - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#contentType - - - - xs:string - - - - header - - - en - Header - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#header - - - - xs:string - - - - - - DocumentEntity - - - en - Document Entity - - - - - en - Document entity with header, content, category and type. - - - - - content - - - en - Content - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#content - - - - xs:string - - - - category - - - en - Category - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#category - - - - xs:string - - - - contentType - - - en - Content Type - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#contentType - - - - xs:string - - - - header - - - en - Header - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#header - - - - xs:string - - - - - - declarationOfConformity - - - en - declarationOfConformity - - - - - en - Compliance documentation and information required under this Regulation or other Union law applicable to the product, such as the declaration of conformity, technical documentation or conformity certificates. - - - true - DataElement - - - SourceEntity - - - en - Source Entity - - - - - en - Entity for document sources of a product. - - - - - sourceName - - - en - Source Name - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#sourceName - - - - xs:string - - - - DocumentEntity - - - en - Document Entity - - - - - en - Document entity with header, content, category and type. - - - - - content - - - en - Content - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#content - - - - xs:string - - - - category - - - en - Category - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#category - - - - xs:string - - - - contentType - - - en - Content Type - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#contentType - - - - xs:string - - - - header - - - en - Header - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#header - - - - xs:string - - - - - - - - - - DocumentEntity - - - en - Document Entity - - - - - en - Document entity with header, content, category and type. - - - - - content - - - en - Content - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#content - - - - xs:string - - - - category - - - en - Category - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#category - - - - xs:string - - - - contentType - - - en - Content Type - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#contentType - - - - xs:string - - - - header - - - en - Header - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#header - - - - xs:string - - - - - - - - - - additionalData - - - en - Additional Data - - - - - en - Data in form of open fields which need to be transferred in addition. - - - true - DataElement - - - AdditionalDataEntity - - - en - Additional Data Entity - - - - - en - Entity with additional data. Properties are label, description, type, data and children. Either the fields data or children filled. Children constructs a hierarchy with the same attributes. Data is filled as the end of an path/leaf. - - - - - label - - - en - Label - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#label - - - - xs:string - - - - description - - - en - Description - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#description - - - - xs:string - - - - TypeEntity - - - en - Type Entity - - - - - en - Entity for type with unit and data type. - - - - - typeUnit - - - en - Type Unit - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#typeUnit - - - - xs:string - - - - dataType - - - en - Data Type - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#dataType - - - - xs:string - - - - - - data - - - en - Data - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#data - - - - xs:string - - - - children - - - en - children - - - - - en - Children of the hierarchy. - - - true - DataElement - - - AdditionalDataEntity - - - en - Additional Data Entity - - - - - en - Entity with additional data. Properties are label, description, type, data and children. Either the fields data or children filled. Children constructs a hierarchy with the same attributes. Data is filled as the end of an path/leaf. - - - - - label - - - en - Label - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#label - - - - xs:string - - - - description - - - en - Description - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#description - - - - xs:string - - - - TypeEntity - - - en - Type Entity - - - - - en - Entity for type with unit and data type. - - - - - typeUnit - - - en - Type Unit - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#typeUnit - - - - xs:string - - - - dataType - - - en - Data Type - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#dataType - - - - xs:string - - - - - - data - - - en - Data - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#data - - - - xs:string - - - - - - - - - - - - - - - - APPLICATION_CLASS - DigitalProductPassport - - - en - Digital Product Passport - - - - - en - The Digital Product Passport is a data record that summarizes the components, materials and chemical substances or information on repairability, spare parts or professional disposal for a product. The data comes from all phases of the product life cycle and can be used for various purposes in all these phases (design, production, use, disposal). Structuring environmental data in a standardized, comparable format enables all actors in the value and supply chain to work together towards a circular economy. This data model is based on the new proposed Ecodesign Regulation (ESPR-2022) and is continuously adapted to the basic conditions over time. - - - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#DigitalProductPassport - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Digital Product Passport - - - - - en - DigitalProductPassport - - - - - en - The Digital Product Passport is a data record that summarizes the components, materials and chemical substances or information on repairability, spare parts or professional disposal for a product. The data comes from all phases of the product life cycle and can be used for various purposes in all these phases (design, production, use, disposal). Structuring environmental data in a standardized, comparable format enables all actors in the value and supply chain to work together towards a circular economy. This data model is based on the new proposed Ecodesign Regulation (ESPR-2022) and is continuously adapted to the basic conditions over time. - - - - - - - - - version - - - en - Version - - - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#version - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Version - - - - - en - version - - - STRING - - - en - The current version of the product passport. - - - - - - - - - status - - - en - Status - - - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#status - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Status - - - - - en - status - - - STRING - - - en - The current status of the product passport declared through either: draft, approved, invalid or expired. - - - - - - Draft - - ModelReference - - - DataElement - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#StatusEnumeration:Draft - - - - - - Approved - - ModelReference - - - DataElement - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#StatusEnumeration:Approved - - - - - - Invalid - - ModelReference - - - DataElement - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#StatusEnumeration:Invalid - - - - - - Expired - - ModelReference - - - DataElement - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#StatusEnumeration:Expired - - - - - - - - - - - - - validityDate - - - en - Validity Date - - - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#validityDate - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Validity Date - - - - - en - validityDate - - - STRING - - - en - The timestamp for the product passport until when it is available. - - - - - - - - - issueDate - - - en - Issue Date - - - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#issueDate - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Issue Date - - - - - en - issueDate - - - STRING - - - en - The timestamp for the product passport since when it is available. - - - - - - - - - economicOperatorId - - - en - Economic Operator Id - - - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#economicOperatorId - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Economic Operator Id - - - - - en - economicOperatorId - - - STRING - - - en - The identification of the economic operator of the passport. - - - - - - - - - eori - - - en - EORI - - - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#eori - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - EORI - - - - - en - eori - - - STRING - - - en - Any economic operator established in the customs territory of the Union needs, for customs purposes, an EORI number. EORI stands for economic operators registration and identification number. - - - - - - - - - economicOperator - - - en - Economic Operator - - - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#economicOperator - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Economic Operator - - - - - en - economicOperator - - - STRING - - - en - The economic operator of the passport. - - - - - - - - - metadata - - - en - Metadata - - - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#metadata - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Metadata - - - - - en - metadata - - - STRING - - - en - The passport metadata of the digital product passport such as status and validity. - - - - - - - - - productDescription - - - en - Product Description - - - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#productDescription - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Product Description - - - - - en - productDescription - - - STRING - - - en - A general short product description. - - - - - - - - - code - - - en - Code - - - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#code - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Code - - - - - en - code - - - STRING - - - en - The associated product category CODE according to ECLASS. - - - - - - - - - definition - - - en - Definition - - - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#definition - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Definition - - - - - en - definition - - - STRING - - - en - The associated product category NAME according to ECLASS. - - - - - - - - - class - - - en - Class - - - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#class - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Class - - - - - en - class - - - STRING - - - en - The associated product category according to ECLASS. The ECLASS is the worldwide reference data standard for classifying and clearly describing products and services. - - - - - - - - - name - - - en - name - - - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#name - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - name - - - - - en - name - - - STRING - - - en - The name of the product type. - - - - - - - - - nameAtManufacturer - - - en - Name at Manufacturer - - - urn:samm:io.catenax.serial_part:1.0.0#nameAtManufacturer - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Name at Manufacturer - - - - - en - nameAtManufacturer - - - STRING - - - en - Name of the part as assigned by the manufacturer - - - - - - - - - nameAtCustomer - - - en - Name at Customer - - - urn:samm:io.catenax.serial_part:1.0.0#nameAtCustomer - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Name at Customer - - - - - en - nameAtCustomer - - - STRING - - - en - Name of the part as assigned by the customer - - - - - - - - - typology - - - en - Typology - - - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#typology - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Typology - - - - - en - typology - - - STRING - - - en - Properties further describing the product type. - - - - - - - - - title - - - en - Title - - - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#title - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Title - - - - - en - title - - - STRING - - - en - The title of the data object with a maximum of 100 characters. - - - - - - - - - maintenanceDescription - - - en - Maintenance Description - - - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#maintenanceDescription - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Maintenance Description - - - - - en - maintenanceDescription - - - STRING - - - en - A short description of the maintenance content. - - - - - - - - - maintenanceDate - - - en - Maintenance Date - - - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#maintenanceDate - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Maintenance Date - - - - - en - maintenanceDate - - - STRING - - - en - The dates when the product was put into service, repair etc. - - - - - - - - - activity - - - en - Activity - - - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#activity - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Activity - - - - - en - activity - - - STRING - - - en - The activities of putting the product into service in form of an enumeration with the values Inspection, Maintenance, Repair, Preventive Maintenance, Accident and Other. - - - - - - Inspection - - ModelReference - - - DataElement - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#ActivityEnumeration:Inspection - - - - - - Maintenance - - ModelReference - - - DataElement - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#ActivityEnumeration:Maintenance - - - - - - Repair - - ModelReference - - - DataElement - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#ActivityEnumeration:Repair - - - - - - Preventive Maintenance - - ModelReference - - - DataElement - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#ActivityEnumeration:Preventive Maintenance - - - - - - Accident - - ModelReference - - - DataElement - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#ActivityEnumeration:Accident - - - - - - Other - - ModelReference - - - DataElement - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#ActivityEnumeration:Other - - - - - - - - - - - - - maintenanceHistory - - - en - Maintenance History - - - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#maintenanceHistory - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Maintenance History - - - - - en - maintenanceHistory - - - STRING - - - en - The maintenance history of the product with dates, titles and descriptions. - - - - - - - - - partId - - - en - Part Id - - - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#partId - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Part Id - - - - - en - partId - - - STRING - - - en - The identification of spare parts available for the product. - - - - - - - - - producerId - - - en - Producer Id - - - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#producerId - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Producer Id - - - - - en - producerId - - - STRING - - - en - The identifier of the producer. In the CATENA-X network the BPN identification of the spare part producer is needed. - - - - - - - - - partName - - - en - Part Name - - - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#partName - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Part Name - - - - - en - partName - - - STRING - - - en - The name of the spare part. - - - - - - - - - spareParts - - - en - Spare Parts - - - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#spareParts - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Spare Parts - - - - - en - spareParts - - - STRING - - - en - The list of spare parts available for the product from a supplier. - - - - - - - - - substanceName - - - en - Substance Name - - - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#substanceName - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Substance Name - - - - - en - substanceName - - - STRING - - - en - In accordance with the ESPR specification the name of the substances of concern which is present in the product have to be declared. - - - - - - - - - location - - - en - Location - - - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#location - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Location - - - - - en - location - - - STRING - - - en - The location of the substances of concern within the product. - - - - - - - - - substanceUnit - - - en - Substance Unit - - - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#substanceUnit - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Substance Unit - - - - - en - substanceUnit - - - STRING - - - en - Units of concentration are percent, volume percent, parts per thousand, parts per million, parts per billion and parts per trillion. - - - - - - unit:partPerMillion - - ModelReference - - - DataElement - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#ConcentrationEnumeration:unit:partPerMillion - - - - - - unit:percent - - ModelReference - - - DataElement - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#ConcentrationEnumeration:unit:percent - - - - - - unit:percentVolume - - ModelReference - - - DataElement - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#ConcentrationEnumeration:unit:percentVolume - - - - - - unit:partPerThousand - - ModelReference - - - DataElement - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#ConcentrationEnumeration:unit:partPerThousand - - - - - - unit:partPerTrillionUs - - ModelReference - - - DataElement - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#ConcentrationEnumeration:unit:partPerTrillionUs - - - - - - unit:partPerBillionUs - - ModelReference - - - DataElement - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#ConcentrationEnumeration:unit:partPerBillionUs - - - - - - - - - - - - - substanceId - - - en - Substance Id - - - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#substanceId - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Substance Id - - - - - en - substanceId - - - STRING - - - en - The substance identification. - - - - - - - - - substanceOfConcern - - - en - Concerning Substance - - - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#substanceOfConcern - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Concerning Substance - - - - - en - substanceOfConcern - - - STRING - - - en - Details to the substance of concern. - - - - - - - - - reusablePackaging - - - en - Reusable Packaging - - - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#reusablePackaging - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Reusable Packaging - - - - - en - reusablePackaging - - - BOOLEAN - - - en - Definition of whether the product uses a reuse system. The values true or false are allowed. - - - - - - - - - handling - - - en - handling - - - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#handling - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - handling - - - - - en - handling - - - STRING - - - en - Properties connected with the handling of the product. - - - - - - - - - state - - - en - State - - - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#state - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - State - - - - - en - state - - - STRING - - - en - Status of the product (first life or second life). - - - - - - first life - - ModelReference - - - DataElement - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#StateEnumeration:first life - - - - - - second life - - ModelReference - - - DataElement - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#StateEnumeration:second life - - - - - - - - - - - - - materialName - - - en - Material Name - - - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#materialName - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Material Name - - - - - en - materialName - - - STRING - - - en - The material name which is part of the product. - - - - - - - - - recycled - - - en - Recycled - - - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#recycled - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Recycled - - - - - en - recycled - - - BOOLEAN - - - en - A flag if the material is recovered recyclate content from the product. - - - - - - - - - renewable - - - en - Renewable - - - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#renewable - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Renewable - - - - - en - renewable - - - BOOLEAN - - - en - Flag if the material is made of natural resources that can be replenished. Renewable resources are those that can be reproduced by physical, chemical, or mechanical processes. These are the kind of resources that can be regenerated throughout time. Forest wood, for example, can be grown through reforestation. - - - - - - - - - percentage - - - en - Percentage - - - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#percentage - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Percentage - - - - - en - percentage - - - percent - REAL_MEASURE - - - en - Percentage of the material. - - - - - - - - - material - - - en - Material - - - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#material - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Material - - - - - en - material - - - STRING - - - en - Information on different materials in the product. - - - - - - - - - critical - - - en - Critical - - - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#critical - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Critical - - - - - en - critical - - - STRING - - - en - The list of critical raw materials in the product (CRM) which is specified by EU. - - - - - - - - - carbonContentTotal - - - en - Carbon Content Total - - - urn:samm:io.catenax.pcf:4.0.0#carbonContentTotal - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Carbon Content Total - - - - - en - carbonContentTotal - - - INTEGER_MEASURE - - - en - Total carbon content per declared unit in context of a product carbon footprint as specified in the Catena-X PCF Rulebook. - - - - - - - - - operator - - - en - Operator or Publisher of Sector Specific Rules - - - urn:samm:io.catenax.pcf:4.0.0#operator - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Operator or Publisher of Sector Specific Rules - - - - - en - operator - - - STRING - - - en - Operator of PCR (Product Category Rule)/ PSR (Product Specific Rule) as specified in the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. WBCSD specific extension, in Catena-X for example must always be "Other". - - - - - - PEF - - ModelReference - - - DataElement - urn:samm:io.catenax.pcf:4.0.0#ProductOrSectorSpecificRuleOperator:PEF - - - - - - EPD International - - ModelReference - - - DataElement - urn:samm:io.catenax.pcf:4.0.0#ProductOrSectorSpecificRuleOperator:EPD International - - - - - - Other - - ModelReference - - - DataElement - urn:samm:io.catenax.pcf:4.0.0#ProductOrSectorSpecificRuleOperator:Other - - - - - - - - - - - - - ruleName - - - en - Rule Name - - - urn:samm:io.catenax.pcf:4.0.0#ruleName - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Rule Name - - - - - en - ruleName - - - STRING - - - en - Name of a rule applied by a specific operator as specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. - - - - - - - - - ruleNames - - - en - Product or Sector Specific Rule Names - - - urn:samm:io.catenax.pcf:4.0.0#ruleNames - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Product or Sector Specific Rule Names - - - - - en - ruleNames - - - STRING - - - en - Product-specific or sector-specific set of rules used for calculating or allocating GHG (Greenhouse Gas) emissions applied from the specified operator as specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. - - - - - - - - - otherOperatorName - - - en - Other Operator Name - - - urn:samm:io.catenax.pcf:4.0.0#otherOperatorName - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Other Operator Name - - - - - en - otherOperatorName - - - STRING - - - en - Other operator of PCR (Product Category Rule)/ PSR (Product Specific Rule) as specified in the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. WBCSD specific extension, in Catena-X for example specified by a default value. - - - - - - - - - productOrSectorSpecificRules - - - en - Product or Sector Specific Rules - - - urn:samm:io.catenax.pcf:4.0.0#productOrSectorSpecificRules - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Product or Sector Specific Rules - - - - - en - productOrSectorSpecificRules - - - STRING - - - en - Product or sector specific rules applied for calculating or allocating GHG (Greenhouse Gas) emissions, e.g. PCRs (Product Category Rules), including operators or pubishers and according rule names as specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. - - - - - - - - - crossSectoralStandard - - - en - Cross Sectoral Standard - - - urn:samm:io.catenax.pcf:4.0.0#crossSectoralStandard - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Cross Sectoral Standard - - - - - en - crossSectoralStandard - - - STRING - - - en - Discloses a cross-sectoral standard applied for calculating or allocating GHG (Greenhouse Gas) emissions as specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. - - - - - - GHG Protocol Product standard - - ModelReference - - - DataElement - urn:samm:io.catenax.pcf:4.0.0#CrossSectoralStandardsUsedEnumerationCharacteristic:GHG Protocol Product standard - - - - - - ISO Standard 14067 - - ModelReference - - - DataElement - urn:samm:io.catenax.pcf:4.0.0#CrossSectoralStandardsUsedEnumerationCharacteristic:ISO Standard 14067 - - - - - - ISO Standard 14044 - - ModelReference - - - DataElement - urn:samm:io.catenax.pcf:4.0.0#CrossSectoralStandardsUsedEnumerationCharacteristic:ISO Standard 14044 - - - - - - - - - - - - - carbonFootprint - - - en - Carbon Footprint - - - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#carbonFootprint - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Carbon Footprint - - - - - en - carbonFootprint - - - STRING - - - en - Carbon Footprint property with sustainability information. - - - - - - - - - sustainability - - - en - sustainability - - - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#sustainability - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - sustainability - - - - - en - sustainability - - - STRING - - - en - Properties which are relevant for the sustainability of the product. - - - - - - - - - lifeUnit - - - en - Life Unit - - - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#lifeUnit - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Life Unit - - - - - en - lifeUnit - - - STRING - - - en - The unit of the expected lifetime of a product from the unit catalog. - - - - - - unit:day - - ModelReference - - - DataElement - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#LifespanEnumeration:unit:day - - - - - - unit:month - - ModelReference - - - DataElement - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#LifespanEnumeration:unit:month - - - - - - unit:cycle - - ModelReference - - - DataElement - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#LifespanEnumeration:unit:cycle - - - - - - unit:year - - ModelReference - - - DataElement - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#LifespanEnumeration:unit:year - - - - - - unit:kilometre - - ModelReference - - - DataElement - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#LifespanEnumeration:unit:kilometre - - - - - - unit:runningOrOperatingHour - - ModelReference - - - DataElement - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#LifespanEnumeration:unit:runningOrOperatingHour - - - - - - - - - - - - - lifeValue - - - en - Life Value - - - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#lifeValue - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Life Value - - - - - en - lifeValue - - - INTEGER_MEASURE - - - en - The value of the expected lifetime of a product. - - - - - - - - - lifespan - - - en - Lifespan - - - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#lifespan - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Lifespan - - - - - en - lifespan - - - STRING - - - en - The expected product lifetime (lifespan). - - - - - - - - - weight - - - en - weight - - - urn:samm:io.catenax.shared.physical_dimension:2.0.0#weight - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - weight - - - - - en - weight - - - kilogram - REAL_MEASURE - - - en - Weight of the item - - - - - - - - - diameter - - - en - diameter - - - urn:samm:io.catenax.shared.physical_dimension:2.0.0#diameter - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - diameter - - - - - en - diameter - - - millimetre - REAL_MEASURE - - - en - Diameter of the item. - - - - - - - - - height - - - en - height - - - urn:samm:io.catenax.shared.physical_dimension:2.0.0#height - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - height - - - - - en - height - - - millimetre - REAL_MEASURE - - - en - Height of the item. - - - - - - - - - width - - - en - width - - - urn:samm:io.catenax.shared.physical_dimension:2.0.0#width - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - width - - - - - en - width - - - millimetre - REAL_MEASURE - - - en - Width of the item. - - - - - - - - - length - - - en - length - - - urn:samm:io.catenax.shared.physical_dimension:2.0.0#length - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - length - - - - - en - length - - - millimetre - REAL_MEASURE - - - en - Length of the item. - - - - - - - - - physicalDimensionsProperty - - - en - physical dimensions - - - urn:samm:io.catenax.shared.physical_dimension:2.0.0#physicalDimensionsProperty - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - physical dimensions - - - - - en - physicalDimensionsProperty - - - STRING - - - en - Describes the physical dimensions of then entity. - - - - - - - - - characteristics - - - en - Characteristics - - - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#characteristics - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Characteristics - - - - - en - characteristics - - - STRING - - - en - Defines specific characteristics of a product. - - - - - - - - - placedOnMarket - - - en - Placed on Market - - - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#placedOnMarket - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Placed on Market - - - - - en - placedOnMarket - - - STRING - - - en - Date on when the product is put in the market. - - - - - - - - - warranty - - - en - Warranty - - - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#warranty - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Warranty - - - - - en - warranty - - - month - INTEGER_MEASURE - - - en - Commercial warranty period of the product (coupled to the Vehicle) in months. Durability and reliability of the product or its components as expressed through the product?s guaranteed lifetime, technical lifetime, mean time between failures, indication of real use information on the product, resistance to stresses or aging mechanisms. - - - - - - - - - commercial - - - en - Commercial - - - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#commercial - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Commercial - - - - - en - commercial - - - STRING - - - en - Commercial information of the product. - - - - - - - - - importer - - - en - Importer - - - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#importer - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Importer - - - - - en - importer - - - STRING - - - en - The importer of the product, if different from the owner of the passport. - - - - - - - - - facilityId - - - en - Facility Id - - - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#facilityId - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Facility Id - - - - - en - facilityId - - - STRING - - - en - The facility Identification, where the main manufacturing took place. - - - - - - - - - manufacturerId - - - en - Manufacturer Id - - - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#manufacturerId - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Manufacturer Id - - - - - en - manufacturerId - - - STRING - - - en - The main manufacturer, if different from the passport owner. - - - - - - - - - manufacturer - - - en - Manufacturer - - - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#manufacturer - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Manufacturer - - - - - en - manufacturer - - - STRING - - - en - Manufacturing identification of the product. - - - - - - - - - operation - - - en - Operation - - - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#operation - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Operation - - - - - en - operation - - - STRING - - - en - Operational information of the product. - - - - - - - - - gtin - - - en - GTIN - - - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#gtin - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - GTIN - - - - - en - gtin - - - STRING - - - en - GTIN stands for Global Trade Item Number. It is a unique and internationally recognized identifier used to identify products in the global marketplace. GTINs are typically encoded in barcodes and are used by retailers, manufacturers, and suppliers to track and manage their products throughout the supply chain. Valid inputs are all GTIN versions (GTIN-8, GTIN-12, GTIN-13, and GTIN-14). - - - - - - - - - codeName - - - en - Code Name - - - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#codeName - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Code Name - - - - - en - codeName - - - STRING - - - en - Title of the code. - - - - - - - - - codeValue - - - en - Code Value - - - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#codeValue - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Code Value - - - - - en - codeValue - - - STRING - - - en - The code value of the specific code. - - - - - - - - - additionalCode - - - en - Additional Code - - - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#additionalCode - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Additional Code - - - - - en - additionalCode - - - STRING - - - en - Codes for identification can be for example commodity codes. In Europe, two commonly used codes for goods classification are the Harmonized System (HS) code and the Combined Nomenclature (CN). Other codes can also be given. - - - - - - - - - key - - - en - Identifier Key - - - urn:samm:io.catenax.serial_part:1.0.0#key - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Identifier Key - - - - - en - key - - - STRING - - - en - The key of a local identifier. - - - - - - - - - value - - - en - Identifier Value - - - urn:samm:io.catenax.serial_part:1.0.0#value - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Identifier Value - - - - - en - value - - - STRING - - - en - The value of an identifier. - - - - - - - - - localIdentifiers - - - en - Local Identifiers - - - urn:samm:io.catenax.serial_part:1.0.0#localIdentifiers - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Local Identifiers - - - - - en - localIdentifiers - - - STRING - - - en - A local identifier enables identification of a part in a specific dataspace, but is not unique in Catena-X dataspace. Multiple local identifiers may exist. - - - - - - - - - identification - - - en - Identification - - - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#identification - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Identification - - - - - en - identification - - - STRING - - - en - Identification information of the product, especially identifiers and codes. - - - - - - - - - quantityUnit - - - en - Quantity Unit - - - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#quantityUnit - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Quantity Unit - - - - - en - quantityUnit - - - STRING - - - en - Quantity refers to the number of units or items of a product being bought, sold, manufactured, or stored as a batch.If the product is a single item choose the unit "unit:piece". All possible units are pieces, gram, kilogram, millilitres, litres, cubic meters, meters or square meters. - - - - - - unit:piece - - ModelReference - - - DataElement - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#QuantityEnumeration:unit:piece - - - - - - unit:gram - - ModelReference - - - DataElement - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#QuantityEnumeration:unit:gram - - - - - - unit:kilogram - - ModelReference - - - DataElement - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#QuantityEnumeration:unit:kilogram - - - - - - unit:metre - - ModelReference - - - DataElement - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#QuantityEnumeration:unit:metre - - - - - - unit:litre - - ModelReference - - - DataElement - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#QuantityEnumeration:unit:litre - - - - - - unit:cubicMetre - - ModelReference - - - DataElement - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#QuantityEnumeration:unit:cubicMetre - - - - - - unit:squareMetre - - ModelReference - - - DataElement - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#QuantityEnumeration:unit:squareMetre - - - - - - - - - - - - - quantityValue - - - en - Quantity Value - - - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#quantityValue - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Quantity Value - - - - - en - quantityValue - - - REAL_MEASURE - - - en - Quantity refers to the number of units or items of a product being bought, sold, manufactured, or stored. If the product is not a batch, choose the unit piece and value 1.0. - - - - - - - - - quantity - - - en - Quantity - - - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#quantity - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Quantity - - - - - en - quantity - - - STRING - - - en - Quantity refers to the number of units or items of a product being bought, sold, manufactured, or stored. It is an important factor in inventory management, supply chain logistics, and pricing calculations. - - - - - - - - - customerPartId - - - en - Customer Part ID - - - urn:samm:io.catenax.serial_part:1.0.0#customerPartId - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Customer Part ID - - - - - en - customerPartId - - - STRING - - - en - Part ID as assigned by the manufacturer of the part. The Part ID identifies the part (as designed) in the customer`s dataspace. The Part ID does not reference a specific instance of a part and thus should not be confused with the serial number. - - - - - - - - - manufacturerPartId - - - en - Manufacturer Part ID - - - urn:samm:io.catenax.serial_part:1.0.0#manufacturerPartId - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Manufacturer Part ID - - - - - en - manufacturerPartId - - - STRING - - - en - Part ID as assigned by the manufacturer of the part. The Part ID identifies the part (as designed) in the manufacturer`s dataspace. The Part ID does not reference a specific instance of a part and thus should not be confused with the serial number. - - - - - - - - - registration - - - en - Registration - - - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#registration - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Registration - - - - - en - registration - - - STRING - - - en - Registration information such as the identification at the customer and the manufacturer. - - - - - - - - - date - - - en - Production Date - - - urn:samm:io.catenax.serial_part:1.0.0#date - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Production Date - - - - - en - date - - - STRING - - - en - Timestamp of the manufacturing date as the final step in production process (e.g. final quality check, ready-for-shipment event) - - - - - - - - - country - - - en - Country code - - - urn:samm:io.catenax.serial_part:1.0.0#country - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Country code - - - - - en - country - - - STRING - - - en - Country code where the part was manufactured - - - - - - - - - manufacturingInformation - - - en - Manufacturing Information - - - urn:samm:io.catenax.serial_part:1.0.0#manufacturingInformation - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Manufacturing Information - - - - - en - manufacturingInformation - - - STRING - - - en - Information from manufacturing process, such as manufacturing date and manufacturing country - - - - - - - - - serialization - - - en - Serialization - - - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#serialization - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Serialization - - - - - en - serialization - - - STRING - - - en - Serialization information on the product. - - - - - - - - - sourceName - - - en - Source Name - - - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#sourceName - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Source Name - - - - - en - sourceName - - - STRING - - - en - The source name as an enumeration. - - - - - - other - - ModelReference - - - DataElement - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#SourceNameEnumeration:other - - - - - - tool and process - - ModelReference - - - DataElement - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#SourceNameEnumeration:tool and process - - - - - - assembly and disassembly - - ModelReference - - - DataElement - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#SourceNameEnumeration:assembly and disassembly - - - - - - repair and installation - - ModelReference - - - DataElement - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#SourceNameEnumeration:repair and installation - - - - - - user manual - - ModelReference - - - DataElement - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#SourceNameEnumeration:user manual - - - - - - end of life - - ModelReference - - - DataElement - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#SourceNameEnumeration:end of life - - - - - - return and disposal - - ModelReference - - - DataElement - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#SourceNameEnumeration:return and disposal - - - - - - expected waste generation - - ModelReference - - - DataElement - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#SourceNameEnumeration:expected waste generation - - - - - - product packaging - - ModelReference - - - DataElement - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#SourceNameEnumeration:product packaging - - - - - - positioning - - ModelReference - - - DataElement - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#SourceNameEnumeration:positioning - - - - - - waste prevention - - ModelReference - - - DataElement - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#SourceNameEnumeration:waste prevention - - - - - - sustainability - - ModelReference - - - DataElement - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#SourceNameEnumeration:sustainability - - - - - - - - - - - - - content - - - en - Content - - - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#content - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Content - - - - - en - content - - - STRING - - - en - The content of the document e.g a link. - - - - - - - - - category - - - en - Category - - - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#category - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Category - - - - - en - category - - - STRING - - - en - The category in which the document can be sorted. - - - - - - Safety - - ModelReference - - - DataElement - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#CategoryEnumeration:Safety - - - - - - Sustainability - - ModelReference - - - DataElement - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#CategoryEnumeration:Sustainability - - - - - - Compliance - - ModelReference - - - DataElement - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#CategoryEnumeration:Compliance - - - - - - Passport - - ModelReference - - - DataElement - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#CategoryEnumeration:Passport - - - - - - SubstanceOfConcern - - ModelReference - - - DataElement - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#CategoryEnumeration:SubstanceOfConcern - - - - - - - - - - - - - contentType - - - en - Content Type - - - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#contentType - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Content Type - - - - - en - contentType - - - STRING - - - en - The type of content which can be expected in the "content" property. Examples are a link, pdf, excel, etc. - - - - - - - - - header - - - en - Header - - - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#header - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Header - - - - - en - header - - - STRING - - - en - The header as a short description of the document with a maximum of 100 characters. - - - - - - - - - documentProperty - - - en - Document Property - - - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#documentProperty - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Document Property - - - - - en - documentProperty - - - STRING - - - en - Property for the document. - - - - - - - - - optionalSources - - - en - Optional Sources - - - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#optionalSources - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Optional Sources - - - - - en - optionalSources - - - STRING - - - en - Optional sources for the product. Optional sources can be a document regarding tool and process, assembly and disassembly, repair and installation, user manual, End of Life, return and disposal, expected waste generation, product packaging, positioning, waste prevention or sustainability information. - - - - - - - - - content - - - en - Content - - - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#content - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Content - - - - - en - content - - - STRING - - - en - The content of the document e.g a link. - - - - - - - - - category - - - en - Category - - - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#category - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Category - - - - - en - category - - - STRING - - - en - The category in which the document can be sorted. - - - - - - - - - contentType - - - en - Content Type - - - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#contentType - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Content Type - - - - - en - contentType - - - STRING - - - en - The type of content which can be expected in the "content" property. Examples are a link, pdf, excel, etc. - - - - - - - - - header - - - en - Header - - - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#header - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Header - - - - - en - header - - - STRING - - - en - The header as a short description of the document with a maximum of 100 characters. - - - - - - - - - safetyPackaging - - - en - Safety Packaging - - - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#safetyPackaging - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Safety Packaging - - - - - en - safetyPackaging - - - STRING - - - en - Document regarding the packaging of the product. - - - - - - - - - content - - - en - Content - - - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#content - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Content - - - - - en - content - - - STRING - - - en - The content of the document e.g a link. - - - - - - - - - category - - - en - Category - - - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#category - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Category - - - - - en - category - - - STRING - - - en - The category in which the document can be sorted. - - - - - - - - - contentType - - - en - Content Type - - - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#contentType - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Content Type - - - - - en - contentType - - - STRING - - - en - The type of content which can be expected in the "content" property. Examples are a link, pdf, excel, etc. - - - - - - - - - header - - - en - Header - - - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#header - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Header - - - - - en - header - - - STRING - - - en - The header as a short description of the document with a maximum of 100 characters. - - - - - - - - - safetyTransportation - - - en - Substance of Concern Transportation - - - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#safetyTransportation - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Substance of Concern Transportation - - - - - en - safetyTransportation - - - STRING - - - en - Document regarding the safe transportation of the product. - - - - - - - - - content - - - en - Content - - - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#content - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Content - - - - - en - content - - - STRING - - - en - The content of the document e.g a link. - - - - - - - - - category - - - en - Category - - - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#category - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Category - - - - - en - category - - - STRING - - - en - The category in which the document can be sorted. - - - - - - - - - contentType - - - en - Content Type - - - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#contentType - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Content Type - - - - - en - contentType - - - STRING - - - en - The type of content which can be expected in the "content" property. Examples are a link, pdf, excel, etc. - - - - - - - - - header - - - en - Header - - - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#header - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Header - - - - - en - header - - - STRING - - - en - The header as a short description of the document with a maximum of 100 characters. - - - - - - - - - substanceOfConcernDisassembly - - - en - Substance of Concern Disassembly - - - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#substanceOfConcernDisassembly - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Substance of Concern Disassembly - - - - - en - substanceOfConcernDisassembly - - - STRING - - - en - Document regarding the disassembly processes for the substances of concern. - - - - - - - - - sourceName - - - en - Source Name - - - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#sourceName - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Source Name - - - - - en - sourceName - - - STRING - - - en - The source name as an enumeration. - - - - - - - - - content - - - en - Content - - - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#content - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Content - - - - - en - content - - - STRING - - - en - The content of the document e.g a link. - - - - - - - - - category - - - en - Category - - - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#category - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Category - - - - - en - category - - - STRING - - - en - The category in which the document can be sorted. - - - - - - - - - contentType - - - en - Content Type - - - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#contentType - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Content Type - - - - - en - contentType - - - STRING - - - en - The type of content which can be expected in the "content" property. Examples are a link, pdf, excel, etc. - - - - - - - - - header - - - en - Header - - - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#header - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Header - - - - - en - header - - - STRING - - - en - The header as a short description of the document with a maximum of 100 characters. - - - - - - - - - documentProperty - - - en - Document Property - - - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#documentProperty - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Document Property - - - - - en - documentProperty - - - STRING - - - en - Property for the document. - - - - - - - - - declarationOfConformity - - - en - declarationOfConformity - - - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#declarationOfConformity - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - declarationOfConformity - - - - - en - declarationOfConformity - - - STRING - - - en - Compliance documentation and information required under this Regulation or other Union law applicable to the product, such as the declaration of conformity, technical documentation or conformity certificates. - - - - - - - - - content - - - en - Content - - - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#content - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Content - - - - - en - content - - - STRING - - - en - The content of the document e.g a link. - - - - - - - - - category - - - en - Category - - - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#category - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Category - - - - - en - category - - - STRING - - - en - The category in which the document can be sorted. - - - - - - - - - contentType - - - en - Content Type - - - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#contentType - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Content Type - - - - - en - contentType - - - STRING - - - en - The type of content which can be expected in the "content" property. Examples are a link, pdf, excel, etc. - - - - - - - - - header - - - en - Header - - - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#header - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Header - - - - - en - header - - - STRING - - - en - The header as a short description of the document with a maximum of 100 characters. - - - - - - - - - substanceOfConcernInstruction - - - en - Substance of Concern Instruction - - - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#substanceOfConcernInstruction - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Substance of Concern Instruction - - - - - en - substanceOfConcernInstruction - - - STRING - - - en - Instructions regarding the substances of concern. - - - - - - - - - mandatorySources - - - en - Mandatory Sources - - - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#mandatorySources - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Mandatory Sources - - - - - en - mandatorySources - - - STRING - - - en - Mandatory document and sources of the product. - - - - - - - - - sources - - - en - Sources - - - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#sources - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Sources - - - - - en - sources - - - STRING - - - en - Different sources in relation to the product. - - - - - - - - - label - - - en - Label - - - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#label - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Label - - - - - en - label - - - STRING - - - en - The human readable name of the attribute. - - - - - - - - - description - - - en - Description - - - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#description - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Description - - - - - en - description - - - STRING - - - en - The description of the attribute context. - - - - - - - - - typeUnit - - - en - Type Unit - - - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#typeUnit - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Type Unit - - - - - en - typeUnit - - - STRING - - - en - Choose a unit type from the unit catalog, or if the property "children" is filled, leave empty. - - - - - - - - - dataType - - - en - Data Type - - - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#dataType - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Data Type - - - - - en - dataType - - - STRING - - - en - Data type that describe the content of the attributes children and data. In case "object" is selected in the enumeration, the children field will be used in the AdditionalDataEntity instead of the "data" property. If it is an other type, the content will be specified in "data" as a string. - - - - - - array - - ModelReference - - - DataElement - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#DataTypeEnumeration:array - - - - - - object - - ModelReference - - - DataElement - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#DataTypeEnumeration:object - - - - - - xsd:string - - ModelReference - - - DataElement - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#DataTypeEnumeration:xsd:string - - - - - - xsd:integer - - ModelReference - - - DataElement - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#DataTypeEnumeration:xsd:integer - - - - - - xsd:boolean - - ModelReference - - - DataElement - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#DataTypeEnumeration:xsd:boolean - - - - - - xsd:double - - ModelReference - - - DataElement - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#DataTypeEnumeration:xsd:double - - - - - - xsd:float - - ModelReference - - - DataElement - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#DataTypeEnumeration:xsd:float - - - - - - xsd:byte - - ModelReference - - - DataElement - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#DataTypeEnumeration:xsd:byte - - - - - - - - - - - - - type - - - en - Type - - - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#type - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Type - - - - - en - type - - - STRING - - - en - The complex description of the type. - - - - - - - - - data - - - en - Data - - - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#data - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Data - - - - - en - data - - - STRING - - - en - The content from the attribute which is a depended of the data type and typeUnit. - - - - - - - - - label - - - en - Label - - - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#label - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Label - - - - - en - label - - - STRING - - - en - The human readable name of the attribute. - - - - - - - - - description - - - en - Description - - - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#description - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Description - - - - - en - description - - - STRING - - - en - The description of the attribute context. - - - - - - - - - typeUnit - - - en - Type Unit - - - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#typeUnit - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Type Unit - - - - - en - typeUnit - - - STRING - - - en - Choose a unit type from the unit catalog, or if the property "children" is filled, leave empty. - - - - - - - - - dataType - - - en - Data Type - - - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#dataType - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Data Type - - - - - en - dataType - - - STRING - - - en - Data type that describe the content of the attributes children and data. In case "object" is selected in the enumeration, the children field will be used in the AdditionalDataEntity instead of the "data" property. If it is an other type, the content will be specified in "data" as a string. - - - - - - - - - type - - - en - Type - - - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#type - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Type - - - - - en - type - - - STRING - - - en - The complex description of the type. - - - - - - - - - data - - - en - Data - - - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#data - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Data - - - - - en - data - - - STRING - - - en - The content from the attribute which is a depended of the data type and typeUnit. - - - - - - - - - children - - - en - children - - - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#children - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - children - - - - - en - children - - - STRING - - - en - Children of the hierarchy. - - - - - - - - - additionalData - - - en - Additional Data - - - urn:samm:io.catenax.generic.digital_product_passport:1.0.0#additionalData - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Additional Data - - - - - en - additionalData - - - STRING - - - en - Data in form of open fields which need to be transferred in addition. - - - - - - - - - diff --git a/io.catenax.generic.digital_product_passport/1.0.0/gen/DigitalProductPassport-schema.json b/io.catenax.generic.digital_product_passport/1.0.0/gen/DigitalProductPassport-schema.json deleted file mode 100644 index 0a23184d3..000000000 --- a/io.catenax.generic.digital_product_passport/1.0.0/gen/DigitalProductPassport-schema.json +++ /dev/null @@ -1,919 +0,0 @@ -{ - "$schema" : "http://json-schema.org/draft-04/schema", - "description" : "The Digital Product Passport is a data record that summarizes the components, materials and chemical substances or information on repairability, spare parts or professional disposal for a product. The data comes from all phases of the product life cycle and can be used for various purposes in all these phases (design, production, use, disposal). Structuring environmental data in a standardized, comparable format enables all actors in the value and supply chain to work together towards a circular economy. This data model is based on the new proposed Ecodesign Regulation (ESPR-2022) and is continuously adapted to the basic conditions over time.", - "type" : "object", - "components" : { - "schemas" : { - "urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text" : { - "type" : "string", - "description" : "Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc." - }, - "urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_StatusEnumeration" : { - "type" : "string", - "description" : "Enumeration with draft, approved, invalid or expired.", - "enum" : [ "Draft", "Approved", "Invalid", "Expired" ] - }, - "urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_TimeStamp" : { - "type" : "string", - "format" : "date", - "description" : "A time stamp in the format (yyyy-mm-dd) with or without time zone." - }, - "urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_CompanyIdentification" : { - "type" : "string", - "description" : "Identification of the company or location of the company. In the CATENA-X network the BPN/L identification is needed." - }, - "urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_EoriTrait" : { - "type" : "string", - "description" : "Constraint with a pattern which ensures that the EORI number starts with two alphanumeric characters, followed by two alphabetic characters, and ends with 2 to 15 alphanumeric characters.", - "pattern" : "^[A-Z]{2}[A-Z0-9]{1,18}$" - }, - "urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_EconomicOperatorCharacteristic" : { - "description" : "Economic operator of the passport.", - "type" : "object", - "properties" : { - "id" : { - "description" : "The identification of the economic operator of the passport.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_CompanyIdentification" - }, - "eori" : { - "description" : "Any economic operator established in the customs territory of the Union needs, for customs purposes, an EORI number. EORI stands for economic operators registration and identification number.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_EoriTrait" - } - }, - "required" : [ "id" ] - }, - "urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_MetadataCharacteristic" : { - "description" : "Characteristic for the passport metadata of the digital product passport.", - "type" : "object", - "properties" : { - "version" : { - "description" : "The current version of the product passport.", - "$ref" : "#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text" - }, - "status" : { - "description" : "The current status of the product passport declared through either: draft, approved, invalid or expired.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_StatusEnumeration" - }, - "validityDate" : { - "description" : "The timestamp for the product passport until when it is available.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_TimeStamp" - }, - "issueDate" : { - "description" : "The timestamp for the product passport since when it is available.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_TimeStamp" - }, - "economicOperator" : { - "description" : "The economic operator of the passport.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_EconomicOperatorCharacteristic" - } - }, - "required" : [ "version", "status", "validityDate", "issueDate", "economicOperator" ] - }, - "urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_CodeTrait" : { - "type" : "string", - "description" : "Constraint to limit the input to a valid ECLASS number. The constraint ensures that each pair of digits is followed by a hyphen, resulting in a pattern like \"00-00-00-00\" where the zeros can be replaced by any digit.", - "pattern" : "^\\d{2}-\\d{2}-\\d{2}-\\d{2}$" - }, - "urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_ClassCharacteristic" : { - "description" : "Characteristic to describe the ECLASS typology of a product.", - "type" : "object", - "properties" : { - "code" : { - "description" : "The associated product category CODE according to ECLASS.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_CodeTrait" - }, - "definition" : { - "description" : "The associated product category NAME according to ECLASS.", - "$ref" : "#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text" - } - }, - "required" : [ "code", "definition" ] - }, - "urn_bamm_io.catenax.serial_part_1.0.0_PartNameCharacteristic" : { - "type" : "string", - "description" : "Part Name in string format from the respective system in the value chain" - }, - "urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_TypologyCharacteristic" : { - "description" : "Characteristic to further describe product.", - "type" : "object", - "properties" : { - "description" : { - "description" : "A general short product description.", - "$ref" : "#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text" - }, - "class" : { - "description" : "The associated product category according to ECLASS. The ECLASS is the worldwide reference data standard for classifying and clearly describing products and services.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_ClassCharacteristic" - }, - "name" : { - "description" : "The name of the product type.", - "$ref" : "#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text" - }, - "nameAtManufacturer" : { - "description" : "Name of the part as assigned by the manufacturer", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.serial_part_1.0.0_PartNameCharacteristic" - }, - "nameAtCustomer" : { - "description" : "Name of the part as assigned by the customer", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.serial_part_1.0.0_PartNameCharacteristic" - } - }, - "required" : [ "name", "nameAtManufacturer", "nameAtCustomer" ] - }, - "urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_TitleTrait" : { - "type" : "string", - "description" : "A constraint that limits the title to 100 characters.", - "maxLength" : 100, - "minLength" : 3 - }, - "urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_ActivityEnumeration" : { - "type" : "string", - "description" : "The activities of putting the product into service in form of an enumeration with the values Inspection, Maintenance, Repair, Preventive Maintenance, Accident and Other.", - "enum" : [ "Inspection", "Maintenance", "Repair", "Preventive Maintenance", "Accident", "Other" ] - }, - "urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_MaintenanceHistoryEntity" : { - "description" : "Entity describing a list of entries of the service history with title, text, activities and dates.", - "type" : "object", - "properties" : { - "title" : { - "description" : "The title of the data object with a maximum of 100 characters.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_TitleTrait" - }, - "description" : { - "description" : "A short description of the maintenance content.", - "$ref" : "#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text" - }, - "date" : { - "description" : "The dates when the product was put into service, repair etc.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_TimeStamp" - }, - "activity" : { - "description" : "The activities of putting the product into service in form of an enumeration with the values Inspection, Maintenance, Repair, Preventive Maintenance, Accident and Other.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_ActivityEnumeration" - } - }, - "required" : [ "title", "description", "date", "activity" ] - }, - "urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_MaintenanceHistoryList" : { - "description" : "A list of entries of the service history.", - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_MaintenanceHistoryEntity" - } - }, - "urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_PartEntity" : { - "description" : "Entity with the attributes partId, producerId and partName to describe a list of spare parts.", - "type" : "object", - "properties" : { - "partId" : { - "description" : "The identification of spare parts available for the product.", - "$ref" : "#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text" - }, - "producerId" : { - "description" : "The identifier of the producer. In the CATENA-X network the BPN identification of the spare part producer is needed.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_CompanyIdentification" - }, - "name" : { - "description" : "The name of the spare part.", - "$ref" : "#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text" - } - }, - "required" : [ "partId", "producerId", "name" ] - }, - "urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_PartList" : { - "description" : "The list of spare parts with different identifiers.", - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_PartEntity" - } - }, - "urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_ConcentrationEnumeration" : { - "type" : "string", - "description" : "Enumeration of possible units of concentration with percent, volume percent, parts per thousand, parts per million, parts per billion and parts per trillion.", - "enum" : [ "unit:partPerMillion", "unit:percent", "unit:percentVolume", "unit:partPerThousand", "unit:partPerTrillionUs", "unit:partPerBillionUs" ] - }, - "urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_Either" : { - "description" : "Characteristic with two possible values.", - "additionalProperties" : false, - "properties" : { - "left" : { - "description" : "Input should be two values, the highest and te lowest of the range.", - "type" : "array", - "items" : { - "type" : "number" - } - }, - "right" : { - "type" : "number", - "description" : "Concentration of substances of concern at the level of the product." - } - }, - "oneOf" : [ { - "required" : [ "left" ] - }, { - "required" : [ "right" ] - } ] - }, - "urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_SubstanceEntity" : { - "description" : "Entity to describe a list of properties regarding a substance of concern such as the substance name, location, unit and concentration.", - "type" : "object", - "properties" : { - "name" : { - "description" : "In accordance with the ESPR specification the name of the substances of concern which is present in the product have to be declared.", - "$ref" : "#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text" - }, - "location" : { - "description" : "The location of the substances of concern within the product.", - "$ref" : "#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text" - }, - "unit" : { - "description" : "Units of concentration are percent, volume percent, parts per thousand, parts per million, parts per billion and parts per trillion.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_ConcentrationEnumeration" - }, - "concentration" : { - "description" : "Concentration of substances of concern at the level of the product.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_Either" - }, - "id" : { - "description" : "The substance identification.", - "$ref" : "#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text" - } - }, - "required" : [ "name", "location", "unit", "concentration", "id" ] - }, - "urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_SubstanceList" : { - "description" : "Characteristic for a list of substances of concern.", - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_SubstanceEntity" - } - }, - "urn_bamm_io.openmanufacturing_characteristic_2.0.0_Boolean" : { - "type" : "boolean", - "description" : "Represents a boolean value (i.e. a \"flag\")." - }, - "urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_HandlingCharacteristic" : { - "description" : "Characteristic to describe aspects which are connected with the handling of the product.", - "type" : "object", - "properties" : { - "maintenanceHistory" : { - "description" : "The maintenance history of the product with dates, titles and descriptions.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_MaintenanceHistoryList" - }, - "spareParts" : { - "description" : "The list of spare parts available for the product from a supplier.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_PartList" - }, - "substanceOfConcern" : { - "description" : "Details to the substance of concern.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_SubstanceList" - }, - "reusablePackaging" : { - "description" : "Definition of whether the product uses a reuse system. The values true or false are allowed.", - "$ref" : "#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Boolean" - } - }, - "required" : [ "maintenanceHistory", "substanceOfConcern" ] - }, - "urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_StateEnumeration" : { - "type" : "string", - "description" : "Enumeration with the values first life and second life.", - "enum" : [ "first life", "second life" ] - }, - "urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_Percent" : { - "type" : "number" - }, - "urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_MaterialEntity" : { - "description" : "Entity with properties materialName, percentage and flags for the possibility to recycle and renew the material.", - "type" : "object", - "properties" : { - "name" : { - "description" : "The material name which is part of the product.", - "$ref" : "#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text" - }, - "recycled" : { - "description" : "A flag if the material is recovered recyclate content from the product.", - "$ref" : "#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Boolean" - }, - "renewable" : { - "description" : "Flag if the material is made of natural resources that can be replenished. Renewable resources are those that can be reproduced by physical, chemical, or mechanical processes. These are the kind of resources that can be regenerated throughout time. Forest wood, for example, can be grown through reforestation.", - "$ref" : "#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Boolean" - }, - "percentage" : { - "description" : "Percentage of the material.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_Percent" - } - }, - "required" : [ "name", "recycled", "percentage" ] - }, - "urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_MaterialList" : { - "description" : "A list of different materials in the product.", - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_MaterialEntity" - } - }, - "urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_CriticalList" : { - "description" : "The list of critical raw materials in the product (CRM) which is specified by EU.", - "type" : "array", - "items" : { - "type" : "string" - } - }, - "urn_bamm_io.catenax.pcf_4.0.0_PositiveEmissionsTrait" : { - "type" : "number", - "description" : "Only positive emission values (>0) are valid ", - "minimum" : 0, - "exclusiveMinimum" : false - }, - "urn_bamm_io.catenax.pcf_4.0.0_ProductOrSectorSpecificRuleOperator" : { - "type" : "string", - "description" : "Enumeration of PCR (Product Category Rule) operators as specified in the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. WBCSD specific extension for example in Catena-X.", - "enum" : [ "PEF", "EPD International", "Other" ] - }, - "urn_bamm_io.catenax.pcf_4.0.0_NonEmptyStringTrait" : { - "type" : "string", - "description" : "Constraint for ensuring that a string has at least one character.", - "minLength" : 1 - }, - "urn_bamm_io.catenax.pcf_4.0.0_RuleName" : { - "description" : "Name of a rule applied by a specified operator as specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.", - "type" : "object", - "properties" : { - "ruleName" : { - "description" : "Name of a rule applied by a specific operator as specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.pcf_4.0.0_NonEmptyStringTrait" - } - }, - "required" : [ "ruleName" ] - }, - "urn_bamm_io.catenax.pcf_4.0.0_RuleNamesTrait" : { - "description" : "Constraint for defining a non-empty set of rule names as specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.", - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/urn_bamm_io.catenax.pcf_4.0.0_RuleName" - }, - "uniqueItems" : true, - "minItems" : 1 - }, - "urn_bamm_io.catenax.pcf_4.0.0_ProductOrSectorSpecificRule" : { - "description" : "Entity for defining a product or sector specific rule of a product carbon footprint as specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.", - "type" : "object", - "properties" : { - "extWBCSD_operator" : { - "description" : "Operator of PCR (Product Category Rule)/ PSR (Product Specific Rule) as specified in the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. WBCSD specific extension, in Catena-X for example must always be \"Other\".", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.pcf_4.0.0_ProductOrSectorSpecificRuleOperator" - }, - "productOrSectorSpecificRules" : { - "description" : "Product-specific or sector-specific set of rules used for calculating or allocating GHG (Greenhouse Gas) emissions applied from the specified operator as specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.pcf_4.0.0_RuleNamesTrait" - }, - "extWBCSD_otherOperatorName" : { - "description" : "Other operator of PCR (Product Category Rule)/ PSR (Product Specific Rule) as specified in the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. WBCSD specific extension, in Catena-X for example specified by a default value.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.pcf_4.0.0_NonEmptyStringTrait" - } - }, - "required" : [ "extWBCSD_operator", "productOrSectorSpecificRules" ] - }, - "urn_bamm_io.catenax.pcf_4.0.0_ProductOrSectorSpecificRuleSet" : { - "description" : "Characteristic for defining the set of product or sector specific rules of a product carbon footprint as specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.", - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/urn_bamm_io.catenax.pcf_4.0.0_ProductOrSectorSpecificRule" - }, - "uniqueItems" : true - }, - "urn_bamm_io.catenax.pcf_4.0.0_CrossSectoralStandardsUsedEnumerationCharacteristic" : { - "type" : "string", - "description" : "Characteristic for defining the enumeration of valid accounting standards used for product carbon footprint calculation as specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.", - "enum" : [ "GHG Protocol Product standard", "ISO Standard 14067", "ISO Standard 14044" ] - }, - "urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_CarbonFootprintCharacteristic" : { - "description" : "Carbon Footprint Characteristic with sustainability information.", - "type" : "object", - "properties" : { - "carbonContentTotal" : { - "description" : "Total carbon content per declared unit in context of a product carbon footprint as specified in the Catena-X PCF Rulebook.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.pcf_4.0.0_PositiveEmissionsTrait" - }, - "productOrSectorSpecificRules" : { - "description" : "Product or sector specific rules applied for calculating or allocating GHG (Greenhouse Gas) emissions, e.g. PCRs (Product Category Rules), including operators or pubishers and according rule names as specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.pcf_4.0.0_ProductOrSectorSpecificRuleSet" - }, - "crossSectoralStandard" : { - "description" : "Discloses a cross-sectoral standard applied for calculating or allocating GHG (Greenhouse Gas) emissions as specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.pcf_4.0.0_CrossSectoralStandardsUsedEnumerationCharacteristic" - } - }, - "required" : [ "carbonContentTotal", "productOrSectorSpecificRules", "crossSectoralStandard" ] - }, - "urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_SustainabilityCharacteristic" : { - "description" : "Characteristic which describes relevant information for the sustainability of the product.", - "type" : "object", - "properties" : { - "state" : { - "description" : "Status of the product (first life or second life).", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_StateEnumeration" - }, - "material" : { - "description" : "Information on different materials in the product.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_MaterialList" - }, - "critical" : { - "description" : "The list of critical raw materials in the product (CRM) which is specified by EU.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_CriticalList" - }, - "carbonFootprint" : { - "description" : "Carbon Footprint property with sustainability information.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_CarbonFootprintCharacteristic" - } - }, - "required" : [ "state", "material", "critical", "carbonFootprint" ] - }, - "urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_LifespanEnumeration" : { - "type" : "string", - "enum" : [ "unit:day", "unit:month", "unit:cycle", "unit:year", "unit:kilometre", "unit:runningOrOperatingHour" ] - }, - "urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_LifeValueCharacteristic" : { - "type" : "number" - }, - "urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_LifespanCharacteristic" : { - "description" : "Characteristic for the expected product lifetime (lifespan).", - "type" : "object", - "properties" : { - "unit" : { - "description" : "The unit of the expected lifetime of a product from the unit catalog.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_LifespanEnumeration" - }, - "value" : { - "description" : "The value of the expected lifetime of a product.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_LifeValueCharacteristic" - } - }, - "required" : [ "unit", "value" ] - }, - "urn_bamm_io.catenax.shared.physical_dimension_2.0.0_KilogramCharacteristic" : { - "type" : "number", - "description" : "a measurement value given in the unit kilogram" - }, - "urn_bamm_io.catenax.shared.physical_dimension_2.0.0_MillimetreCharacteristic" : { - "type" : "number", - "description" : "a measurement for a lenght given in the unit millimetre" - }, - "urn_bamm_io.catenax.shared.physical_dimension_2.0.0_PhysicalDimensionsCharacteristic" : { - "description" : "Describes the physical dimensions of then entity.", - "type" : "object", - "properties" : { - "weight" : { - "description" : "Weight of the item", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.shared.physical_dimension_2.0.0_KilogramCharacteristic" - }, - "diameter" : { - "description" : "Diameter of the item.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.shared.physical_dimension_2.0.0_MillimetreCharacteristic" - }, - "height" : { - "description" : "Height of the item.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.shared.physical_dimension_2.0.0_MillimetreCharacteristic" - }, - "width" : { - "description" : "Width of the item.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.shared.physical_dimension_2.0.0_MillimetreCharacteristic" - }, - "length" : { - "description" : "Length of the item.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.shared.physical_dimension_2.0.0_MillimetreCharacteristic" - } - } - }, - "urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_Characteristics" : { - "description" : "Defines a set of specific characteristics of a product.", - "type" : "object", - "properties" : { - "lifespan" : { - "description" : "The expected product lifetime (lifespan).", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_LifespanCharacteristic" - }, - "physicalDimensionsProperty" : { - "description" : "Describes the physical dimensions of then entity.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.shared.physical_dimension_2.0.0_PhysicalDimensionsCharacteristic" - } - }, - "required" : [ "lifespan" ] - }, - "urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_WarrantyCharacteristic" : { - "type" : "number" - }, - "urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_CommercialCharacteristic" : { - "description" : "Commercial information of the product.", - "type" : "object", - "properties" : { - "placedOnMarket" : { - "description" : "Date on when the product is put in the market.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_TimeStamp" - }, - "warranty" : { - "description" : "Commercial warranty period of the product (coupled to the Vehicle) in months. Durability and reliability of the product or its components as expressed through the product’s guaranteed lifetime, technical lifetime, mean time between failures, indication of real use information on the product, resistance to stresses or aging mechanisms.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_WarrantyCharacteristic" - } - }, - "required" : [ "warranty" ] - }, - "urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_ManufacturerCharacteristic" : { - "description" : "Manufacturing information.", - "type" : "object", - "properties" : { - "facilityId" : { - "description" : "The facility Identification, where the main manufacturing took place.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_CompanyIdentification" - }, - "manufacturerId" : { - "description" : "The main manufacturer, if different from the passport owner.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_CompanyIdentification" - } - }, - "required" : [ "facilityId" ] - }, - "urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_OperationCharacteristic" : { - "description" : "Operational information of the product.", - "type" : "object", - "properties" : { - "importer" : { - "description" : "The importer of the product, if different from the owner of the passport.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_CompanyIdentification" - }, - "manufacturer" : { - "description" : "Manufacturing identification of the product.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_ManufacturerCharacteristic" - } - }, - "required" : [ "importer", "manufacturer" ] - }, - "urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_GtinTrait" : { - "type" : "string", - "description" : "This pattern allows for matching any GTIN version by specifying the required number of digits for each version.", - "pattern" : "^(?:\\d{8}|\\d{12}|\\d{13}|\\d{14})$" - }, - "urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_CodeEntity" : { - "description" : "Code entity with code name and value.", - "type" : "object", - "properties" : { - "name" : { - "description" : "Title of the code.", - "$ref" : "#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text" - }, - "value" : { - "description" : "The code value of the specific code.", - "$ref" : "#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text" - } - }, - "required" : [ "name", "value" ] - }, - "urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_CodeList" : { - "description" : "A list of additional codes.", - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_CodeEntity" - } - }, - "urn_bamm_io.catenax.serial_part_1.0.0_KeyCharacteristic" : { - "type" : "string", - "description" : "The key characteristic of a local identifier. A specific subset of keys is predefined, but additionally any other custom key is allowed. Predefined keys (to be used when applicable):\n- \"manufacturerId\" - The Business Partner Number (BPN) of the manufacturer. Value: BPN-Nummer\n- \"partInstanceId\" - The identifier of the manufacturer for the serialized instance of the part, e.g. the serial number\n- \"batchId\" - The identifier of the batch, to which the serialzed part belongs\n- \"van\" - The anonymized vehicle identification number (VIN). Value: anonymized VIN according to OEM anonymization rules. Note: If the key \"van\" is available, \"partInstanceId\" must also be available and hold the identical value." - }, - "urn_bamm_io.catenax.serial_part_1.0.0_ValueCharacteristic" : { - "type" : "string", - "description" : "The value of an identifier." - }, - "urn_bamm_io.catenax.serial_part_1.0.0_KeyValueList" : { - "description" : "A list of key value pairs for local identifiers, which are composed of a key and a corresponding value.", - "type" : "object", - "properties" : { - "key" : { - "description" : "The key of a local identifier. ", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.serial_part_1.0.0_KeyCharacteristic" - }, - "value" : { - "description" : "The value of an identifier.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.serial_part_1.0.0_ValueCharacteristic" - } - }, - "required" : [ "key", "value" ] - }, - "urn_bamm_io.catenax.serial_part_1.0.0_LocalIdentifierCharacteristic" : { - "description" : "A single serialized part may have multiple attributes, that uniquely identify a that part in a specific dataspace (e.g. the manufacturer`s dataspace)", - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/urn_bamm_io.catenax.serial_part_1.0.0_KeyValueList" - }, - "uniqueItems" : true - }, - "urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_IdentificationCharacteristic" : { - "description" : "Identification information of the product.", - "type" : "object", - "properties" : { - "gtin" : { - "description" : "GTIN stands for Global Trade Item Number. It is a unique and internationally recognized identifier used to identify products in the global marketplace. GTINs are typically encoded in barcodes and are used by retailers, manufacturers, and suppliers to track and manage their products throughout the supply chain. Valid inputs are all GTIN versions (GTIN-8, GTIN-12, GTIN-13, and GTIN-14).", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_GtinTrait" - }, - "additionalCode" : { - "description" : "Codes for identification can be for example commodity codes. In Europe, two commonly used codes for goods classification are the Harmonized System (HS) code and the Combined Nomenclature (CN). Other codes can also be given.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_CodeList" - }, - "localIdentifiers" : { - "description" : "A local identifier enables identification of a part in a specific dataspace, but is not unique in Catena-X dataspace. Multiple local identifiers may exist.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.serial_part_1.0.0_LocalIdentifierCharacteristic" - } - }, - "required" : [ "localIdentifiers" ] - }, - "urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_QuantityEnumeration" : { - "type" : "string", - "description" : "Enumeration of possible quantities in a batch.", - "enum" : [ "unit:piece", "unit:gram", "unit:kilogram", "unit:metre", "unit:litre", "unit:cubicMetre", "unit:squareMetre" ] - }, - "urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_QuantityValueCharacteristic" : { - "type" : "number", - "description" : "The value of the quantity." - }, - "urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_QuantityCharacteristic" : { - "description" : "Quantity of the product.", - "type" : "object", - "properties" : { - "unit" : { - "description" : "Quantity refers to the number of units or items of a product being bought, sold, manufactured, or stored as a batch.If the product is a single item choose the unit \"unit:piece\". All possible units are pieces, gram, kilogram, millilitres, litres, cubic meters, meters or square meters.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_QuantityEnumeration" - }, - "value" : { - "description" : "Quantity refers to the number of units or items of a product being bought, sold, manufactured, or stored. If the product is not a batch, choose the unit piece and value 1.0.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_QuantityValueCharacteristic" - } - }, - "required" : [ "unit", "value" ] - }, - "urn_bamm_io.catenax.serial_part_1.0.0_PartIdCharacteristic" : { - "type" : "string", - "description" : "The part ID is a multi-character string, ususally assigned by an ERP system" - }, - "urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_RegistrationCharacteristic" : { - "description" : "Characteristic for registration information such as the identification at the customer and the manufacturer.", - "type" : "object", - "properties" : { - "customerPartId" : { - "description" : "Part ID as assigned by the manufacturer of the part. The Part ID identifies the part (as designed) in the customer`s dataspace. The Part ID does not reference a specific instance of a part and thus should not be confused with the serial number.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.serial_part_1.0.0_PartIdCharacteristic" - }, - "manufacturerPartId" : { - "description" : "Part ID as assigned by the manufacturer of the part. The Part ID identifies the part (as designed) in the manufacturer`s dataspace. The Part ID does not reference a specific instance of a part and thus should not be confused with the serial number.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.serial_part_1.0.0_PartIdCharacteristic" - } - }, - "required" : [ "customerPartId", "manufacturerPartId" ] - }, - "urn_bamm_io.openmanufacturing_characteristic_2.0.0_Timestamp" : { - "type" : "string", - "pattern" : "-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T(([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](\\.[0-9]+)?|(24:00:00(\\.0+)?))(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?", - "description" : "Describes a Property which contains the date and time with an optional timezone." - }, - "urn_bamm_io.catenax.serial_part_1.0.0_ProductionCountryCodeTrait" : { - "type" : "string", - "description" : "Regular Expression that ensures a three-letter code ", - "pattern" : "^[A-Z][A-Z][A-Z]$" - }, - "urn_bamm_io.catenax.serial_part_1.0.0_ManufacturingCharacteristic" : { - "description" : "Characteristic to describe manufacturing related data", - "type" : "object", - "properties" : { - "date" : { - "description" : "Timestamp of the manufacturing date as the final step in production process (e.g. final quality check, ready-for-shipment event)", - "$ref" : "#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Timestamp" - }, - "country" : { - "description" : "Country code where the part was manufactured", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.serial_part_1.0.0_ProductionCountryCodeTrait" - } - }, - "required" : [ "date" ] - }, - "urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_SerializationCharacteristic" : { - "description" : "Characteristic for serialization information.", - "type" : "object", - "properties" : { - "quantity" : { - "description" : "Quantity refers to the number of units or items of a product being bought, sold, manufactured, or stored. It is an important factor in inventory management, supply chain logistics, and pricing calculations.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_QuantityCharacteristic" - }, - "registration" : { - "description" : "Registration information such as the identification at the customer and the manufacturer.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_RegistrationCharacteristic" - }, - "manufacturingInformation" : { - "description" : "Information from manufacturing process, such as manufacturing date and manufacturing country", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.serial_part_1.0.0_ManufacturingCharacteristic" - } - }, - "required" : [ "quantity", "registration", "manufacturingInformation" ] - }, - "urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_SourceNameEnumeration" : { - "type" : "string", - "description" : "Enumeration of different source names.", - "enum" : [ "other", "tool and process", "assembly and disassembly", "repair and installation", "user manual", "end of life", "return and disposal", "expected waste generation", "product packaging", "positioning", "waste prevention", "sustainability" ] - }, - "urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_CategoryEnumeration" : { - "type" : "string", - "enum" : [ "Safety", "Sustainability", "Compliance", "Passport", "SubstanceOfConcern" ] - }, - "urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_DocumentCharacteristic" : { - "description" : "Characteristic for different documents.", - "type" : "object", - "properties" : { - "content" : { - "description" : "The content of the document e.g a link.", - "$ref" : "#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text" - }, - "category" : { - "description" : "The category in which the document can be sorted.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_CategoryEnumeration" - }, - "type" : { - "description" : "The type of content which can be expected in the \"content\" property. Examples are a link, pdf, excel, etc.", - "$ref" : "#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text" - }, - "header" : { - "description" : "The header as a short description of the document with a maximum of 100 characters.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_TitleTrait" - } - }, - "required" : [ "content", "category", "type", "header" ] - }, - "urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_SourceEntity" : { - "description" : "Entity for document sources of a product.", - "type" : "object", - "properties" : { - "name" : { - "description" : "The source name as an enumeration.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_SourceNameEnumeration" - }, - "document" : { - "description" : "Property for the document.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_DocumentCharacteristic" - } - }, - "required" : [ "name", "document" ] - }, - "urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_SourceListCharacteristic" : { - "description" : "A list of documents.", - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_SourceEntity" - } - }, - "urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_MandatorySourcesCharacteristic" : { - "description" : "Characteristic for the different mandatory sources.", - "type" : "object", - "properties" : { - "safetyPackaging" : { - "description" : "Document regarding the packaging of the product.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_DocumentCharacteristic" - }, - "safetyTransportation" : { - "description" : "Document regarding the safe transportation of the product.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_DocumentCharacteristic" - }, - "substanceOfConcernDisassembly" : { - "description" : "Document regarding the disassembly processes for the substances of concern.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_DocumentCharacteristic" - }, - "declarationOfConformity" : { - "description" : "Compliance documentation and information required under this Regulation or other Union law applicable to the product, such as the declaration of conformity, technical documentation or conformity certificates.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_SourceListCharacteristic" - }, - "substanceOfConcernInstruction" : { - "description" : "Instructions regarding the substances of concern.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_DocumentCharacteristic" - } - }, - "required" : [ "safetyPackaging", "safetyTransportation", "substanceOfConcernDisassembly", "declarationOfConformity", "substanceOfConcernInstruction" ] - }, - "urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_SourcesCharacteristic" : { - "description" : "The sources of the product.", - "type" : "object", - "properties" : { - "optional" : { - "description" : "Optional sources for the product. Optional sources can be a document regarding tool and process, assembly and disassembly, repair and installation, user manual, End of Life, return and disposal, expected waste generation, product packaging, positioning, waste prevention or sustainability information.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_SourceListCharacteristic" - }, - "mandatory" : { - "description" : "Mandatory document and sources of the product.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_MandatorySourcesCharacteristic" - } - }, - "required" : [ "mandatory" ] - }, - "urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_UnitCatalog" : { - "type" : "string", - "description" : "Link to the unit catalog with all possible units in the format \"unit:xxx\"." - }, - "urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_DataTypeEnumeration" : { - "type" : "string", - "description" : "Data type that describe the content of the attributes children and data. In case \"object\" is selected in the enumeration, the children field will be used in the AdditionalDataEntity instead of the \"data\" property. If it is an other type, the content will be specified in \"data\" as a string.", - "enum" : [ "array", "object", "xsd:string", "xsd:integer", "xsd:boolean", "xsd:double", "xsd:float", "xsd:byte" ] - }, - "urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_TypeCharacteristic" : { - "description" : "Characteristic for the data type.", - "type" : "object", - "properties" : { - "typeUnit" : { - "description" : "Choose a unit type from the unit catalog, or if the property \"children\" is filled, leave empty.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_UnitCatalog" - }, - "dataType" : { - "description" : "Data type that describe the content of the attributes children and data. In case \"object\" is selected in the enumeration, the children field will be used in the AdditionalDataEntity instead of the \"data\" property. If it is an other type, the content will be specified in \"data\" as a string.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_DataTypeEnumeration" - } - }, - "required" : [ "dataType" ] - }, - "urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_AdditionalDataEntity" : { - "description" : "Entity with additional data. Properties are label, description, type, data and children. Either the fields data or children filled. Children constructs a hierarchy with the same attributes. Data is filled as the end of an path/leaf.", - "type" : "object", - "properties" : { - "label" : { - "description" : "The human readable name of the attribute.", - "$ref" : "#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text" - }, - "description" : { - "description" : "The description of the attribute context.", - "$ref" : "#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text" - }, - "type" : { - "description" : "The complex description of the type.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_TypeCharacteristic" - }, - "data" : { - "description" : "The content from the attribute which is a depended of the data type and typeUnit.", - "$ref" : "#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text" - }, - "children" : { - "description" : "Children of the hierarchy.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_AdditionalDataList" - } - }, - "required" : [ "label", "description", "type" ] - }, - "urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_AdditionalDataList" : { - "description" : "List of additional data.", - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_AdditionalDataEntity" - } - } - } - }, - "properties" : { - "metadata" : { - "description" : "The passport metadata of the digital product passport such as status and validity.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_MetadataCharacteristic" - }, - "typology" : { - "description" : "Properties further describing the product type.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_TypologyCharacteristic" - }, - "handling" : { - "description" : "Properties connected with the handling of the product.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_HandlingCharacteristic" - }, - "sustainability" : { - "description" : "Properties which are relevant for the sustainability of the product.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_SustainabilityCharacteristic" - }, - "characteristics" : { - "description" : "Defines specific characteristics of a product.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_Characteristics" - }, - "commercial" : { - "description" : "Commercial information of the product.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_CommercialCharacteristic" - }, - "operation" : { - "description" : "Operational information of the product.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_OperationCharacteristic" - }, - "identification" : { - "description" : "Identification information of the product, especially identifiers and codes.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_IdentificationCharacteristic" - }, - "serialization" : { - "description" : "Serialization information on the product.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_SerializationCharacteristic" - }, - "sources" : { - "description" : "Different sources in relation to the product.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_SourcesCharacteristic" - }, - "additionalData" : { - "description" : "Data in form of open fields which need to be transferred in addition.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_AdditionalDataList" - } - }, - "required" : [ "metadata", "typology", "handling", "sustainability", "characteristics", "commercial", "operation", "identification", "serialization", "sources" ] -} \ No newline at end of file diff --git a/io.catenax.generic.digital_product_passport/1.0.0/gen/DigitalProductPassport.aasx b/io.catenax.generic.digital_product_passport/1.0.0/gen/DigitalProductPassport.aasx deleted file mode 100644 index 3fcc2d010..000000000 Binary files a/io.catenax.generic.digital_product_passport/1.0.0/gen/DigitalProductPassport.aasx and /dev/null differ diff --git a/io.catenax.generic.digital_product_passport/1.0.0/gen/DigitalProductPassport.html b/io.catenax.generic.digital_product_passport/1.0.0/gen/DigitalProductPassport.html deleted file mode 100644 index a9f48329d..000000000 --- a/io.catenax.generic.digital_product_passport/1.0.0/gen/DigitalProductPassport.html +++ /dev/null @@ -1,7446 +0,0 @@ - - - - - - - - - - - - - - Documentation Digital Product Passport - - -
-
-
-
-

Aspect Model Digital Product Passport

-
urn:bamm:io.catenax.generic.digital_product_passport:1.0.0#DigitalProductPassport
-
-
-
-
-
-
-
- -
- - -
- The Digital Product Passport is a data record that summarizes the components, materials and chemical substances or information on repairability, spare parts or professional disposal for a product. The data comes from all phases of the product life cycle and can be used for various purposes in all these phases (design, production, use, disposal). Structuring environmental data in a standardized, comparable format enables all actors in the value and supply chain to work together towards a circular economy. This data model is based on the new proposed Ecodesign Regulation (ESPR-2022) and is continuously adapted to the basic conditions over time. -
- - -
-

Overview

-
-
-
-
- Aspect Model Diagram -
-
-
- - -
-
-

Properties

-
- -
- -
-

Additional Data

-
- -Data in form of open fields which need to be transferred in addition. - -
-
Name
-
additionalData
-
- - - -
-
Characteristic
-
-
-
-
List
-
-
-
Has a certain order
-
-
-
Duplicates allowed
-
-
-
- Type urn:bamm:io.catenax.generic.digital_product_passport:1.0.0#AdditionalDataEntity - -
-
-
-
-
- - -
-
Optional
-
- Yes
-
- -
-
In payload
-
- Yes
-
- -
-
Payload key
-
additionalData
-
- - -
-
- -
-

Characteristics

-
- -Defines specific characteristics of a product. - -
-
Name
-
characteristics
-
- - - -
-
Characteristic
-
-
-
-
SingleEntity
-
-
-
- Type urn:bamm:io.catenax.generic.digital_product_passport:1.0.0#CharacteristicsEntity - -
-
-
-
-
- - -
-
Optional
-
- No
-
- -
-
In payload
-
- Yes
-
- -
-
Payload key
-
characteristics
-
- - -
-
- -
-

Commercial

-
- -Commercial information of the product. - -
-
Name
-
commercial
-
- - - -
-
Characteristic
-
-
-
-
SingleEntity
-
-
-
- Type urn:bamm:io.catenax.generic.digital_product_passport:1.0.0#CommercialEntity - -
-
-
-
-
- - -
-
Optional
-
- No
-
- -
-
In payload
-
- Yes
-
- -
-
Payload key
-
commercial
-
- - -
-
- -
-

Identification

-
- -Identification information of the product, especially identifiers and codes. - -
-
Name
-
identification
-
- - - -
-
Characteristic
-
-
-
-
SingleEntity
-
-
-
- Type urn:bamm:io.catenax.generic.digital_product_passport:1.0.0#IdentificationEntity - -
-
-
-
-
- - -
-
Optional
-
- No
-
- -
-
In payload
-
- Yes
-
- -
-
Payload key
-
identification
-
- - -
-
- -
-

Metadata

-
- -The passport metadata of the digital product passport such as status and validity. - -
-
Name
-
metadata
-
- - - -
-
Characteristic
-
-
-
-
SingleEntity
-
-
-
- Type urn:bamm:io.catenax.generic.digital_product_passport:1.0.0#MetadataEntity - -
-
-
-
-
- - -
-
Optional
-
- No
-
- -
-
In payload
-
- Yes
-
- -
-
Payload key
-
metadata
-
- - -
-
- -
-

Operation

-
- -Operational information of the product. - -
-
Name
-
operation
-
- - - -
-
Characteristic
-
-
-
-
SingleEntity
-
-
-
- Type urn:bamm:io.catenax.generic.digital_product_passport:1.0.0#OperationEntity - -
-
-
-
-
- - -
-
Optional
-
- No
-
- -
-
In payload
-
- Yes
-
- -
-
Payload key
-
operation
-
- - -
-
- -
-

Serialization

-
- -Serialization information on the product. - -
-
Name
-
serialization
-
- - - -
-
Characteristic
-
-
-
-
SingleEntity
-
-
-
- Type urn:bamm:io.catenax.generic.digital_product_passport:1.0.0#SerializationEntity - -
-
-
-
-
- - -
-
Optional
-
- No
-
- -
-
In payload
-
- Yes
-
- -
-
Payload key
-
serialization
-
- - -
-
- -
-

Sources

-
- -Different sources in relation to the product. - -
-
Name
-
sources
-
- - - -
-
Characteristic
-
-
-
-
SingleEntity
-
-
-
- Type urn:bamm:io.catenax.generic.digital_product_passport:1.0.0#SourcesEntity - -
-
-
-
-
- - -
-
Optional
-
- No
-
- -
-
In payload
-
- Yes
-
- -
-
Payload key
-
sources
-
- - -
-
- -
-

Typology

-
- -Properties further describing the product type. - -
-
Name
-
typology
-
- - - -
-
Characteristic
-
-
-
-
SingleEntity
-
-
-
- Type urn:bamm:io.catenax.generic.digital_product_passport:1.0.0#TypologyEntity - -
-
-
-
-
- - -
-
Optional
-
- No
-
- -
-
In payload
-
- Yes
-
- -
-
Payload key
-
typology
-
- - -
-
- -
-

handling

-
- -Properties connected with the handling of the product. - -
-
Name
-
handling
-
- - - -
-
Characteristic
-
-
-
-
SingleEntity
-
-
-
- Type urn:bamm:io.catenax.generic.digital_product_passport:1.0.0#HandlingEntity - -
-
-
-
-
- - -
-
Optional
-
- No
-
- -
-
In payload
-
- Yes
-
- -
-
Payload key
-
handling
-
- - -
-
- -
-

sustainability

-
- -Properties which are relevant for the sustainability of the product. - -
-
Name
-
sustainability
-
- - - -
-
Characteristic
-
-
-
-
SingleEntity
-
-
-
- Type urn:bamm:io.catenax.generic.digital_product_passport:1.0.0#SustainabilityEntity - -
-
-
-
-
- - -
-
Optional
-
- No
-
- -
-
In payload
-
- Yes
-
- -
-
Payload key
-
sustainability
-
- - -
-
- - - -
-
-

Entities

-
- -
-
-

Additional Data Entity

-
-
- Entity with additional data. Properties are label, description, type, data and children. Either the fields data or children filled. Children constructs a hierarchy with the same attributes. Data is filled as the end of an path/leaf. -
- -
-

Properties

-
-
- -
-
Label
-
- -The human readable name of the attribute. - -
-
Name
-
label
-
- - - -
-
Characteristic
-
-
-
-
- Type http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Example
-
Maximum permitted battery power
-
- -
-
Optional
-
- No
-
- -
-
In payload
-
- Yes
-
- -
-
Payload key
-
label
-
- - -
-
- -
-
Description
-
- -The description of the attribute context. - -
-
Name
-
description
-
- - - -
-
Characteristic
-
-
-
-
- Type http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Example
-
Description of an attribute
-
- -
-
Optional
-
- No
-
- -
-
In payload
-
- Yes
-
- -
-
Payload key
-
description
-
- - -
-
- -
-
Type
-
- -The complex description of the type. - -
-
Name
-
type
-
- - - -
-
Characteristic
-
-
-
-
SingleEntity
-
-
-
- Type urn:bamm:io.catenax.generic.digital_product_passport:1.0.0#TypeEntity - -
-
-
-
-
- - -
-
Optional
-
- No
-
- -
-
In payload
-
- Yes
-
- -
-
Payload key
-
type
-
- - -
-
- -
-
Data
-
- -The content from the attribute which is a depended of the data type and typeUnit. - -
-
Name
-
data
-
- - - -
-
Characteristic
-
-
-
-
- Type http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Example
-
23
-
- -
-
Optional
-
- Yes
-
- -
-
In payload
-
- Yes
-
- -
-
Payload key
-
data
-
- - -
-
- -
-
children
-
- -Children of the hierarchy. - -
-
Name
-
children
-
- - - -
-
Characteristic
-
-
-
-
List
-
-
-
Has a certain order
-
-
-
Duplicates allowed
-
-
-
- Type urn:bamm:io.catenax.generic.digital_product_passport:1.0.0#AdditionalDataEntity - -
-
-
-
-
- - -
-
Optional
-
- Yes
-
- -
-
In payload
-
- Yes
-
- -
-
Payload key
-
children
-
- - -
-
-
-
-

CarbonFootprintEntity

-
-
- Carbon Footprint Characteristic with sustainability information such as the carbon footprint total, rules and standards. -
- -
-

Properties

-
-
- -
-
Carbon Content Total
-
- -Total carbon content per declared unit in context of a product carbon footprint as specified in the Catena-X PCF Rulebook. - -
-
Name
-
carbonContentTotal
-
- - - -
-
Characteristic
-
-
-
-
Trait
-
-
-
- Type http://www.w3.org/2001/XMLSchema#decimal - -
-
-
-
-
- -
-
Example
-
2.5
-
- -
-
Optional
-
- No
-
- -
-
In payload
-
- Yes
-
- -
-
Payload key
-
carbonContentTotal
-
- - -
-
Constraints
-
-
    -
  • -
    - -
    - PositiveEmissionConstraint -
    - -
    -
    Description
    -
    Only positive emission values (>0) are valid
    -
    - - -
    -
    ->= -
    - DefaultScalarValue[value=0.0, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#decimal']'] -
    -
    - -
    • -
-
-
-
-
- -
-
Product or Sector Specific Rules
-
- -Product or sector specific rules applied for calculating or allocating GHG (Greenhouse Gas) emissions, e.g. PCRs (Product Category Rules), including operators or pubishers and according rule names as specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. - -
-
Name
-
productOrSectorSpecificRules
-
- - - -
-
Characteristic
-
-
-
-
Set
-
-
-
Has no order
-
-
-
Duplicates not allowed
-
-
-
- Reference -
-
    -
  • https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/
    • -
-
-
-
-
-
- Type urn:bamm:io.catenax.pcf:4.0.0#ProductOrSectorSpecificRule - -
-
-
-
-
- - -
-
Optional
-
- No
-
- -
-
In payload
-
- Yes
-
- -
-
Payload key
-
productOrSectorSpecificRules
-
- -
-
Reference
-
-
    -
  • https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/
    • -
-
-
- -
-
- -
-
Cross Sectoral Standard
-
- -Discloses a cross-sectoral standard applied for calculating or allocating GHG (Greenhouse Gas) emissions as specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. - -
-
Name
-
crossSectoralStandard
-
- - - -
-
Characteristic
-
-
-
-
Enumeration
-
-
-
Values
-
-
-
-
    -
  • GHG Protocol Product standard
    • -
  • ISO Standard 14067
    • -
  • ISO Standard 14044
    • -
-
-
-
-
- Reference -
-
    -
  • https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/
    • -
-
-
-
-
-
- Type http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Example
-
ISO Standard 14044
-
- -
-
Optional
-
- No
-
- -
-
In payload
-
- Yes
-
- -
-
Payload key
-
crossSectoralStandard
-
- -
-
Reference
-
-
    -
  • https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/
    • -
-
-
- -
-
-
-
-

Characteristics Entity

-
-
- Entity which defines specific characteristics of a product such as the lifespan and the physical dimensions. -
- -
-

Properties

-
-
- -
-
Lifespan
-
- -The expected product lifetime (lifespan). - -
-
Name
-
lifespan
-
- - - -
-
Characteristic
-
-
-
-
SingleEntity
-
-
-
- Type urn:bamm:io.catenax.generic.digital_product_passport:1.0.0#LifespanEntity - -
-
-
-
-
- - -
-
Optional
-
- No
-
- -
-
In payload
-
- Yes
-
- -
-
Payload key
-
lifespan
-
- - -
-
- -
-
physical dimensions
-
- -Describes the physical dimensions of then entity. - -
-
Name
-
physicalDimensionsProperty
-
- - - -
-
Characteristic
-
-
-
-
SingleEntity
-
-
-
- Type urn:bamm:io.catenax.shared.physical_dimension:2.0.0#PhysicalDimensionsEntity - -
-
-
-
-
- - -
-
Optional
-
- Yes
-
- -
-
In payload
-
- Yes
-
- -
-
Payload key
-
physicalDimensionsProperty
-
- - -
-
-
-
-

Class Entity

-
-
- Entity to describe the associated product category according to ECLASS. The ECLASS is the worldwide reference data standard for classifying and clearly describing products and services. Properties separated into the code and name. -
- -
-

Properties

-
-
- -
-
Code
-
- -The associated product category CODE according to ECLASS. - -
-
Name
-
code
-
- - - -
-
Characteristic
-
-
-
-
Trait
-
-
-
- Type http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Example
-
44-09-02-02
-
- -
-
Optional
-
- No
-
- -
-
In payload
-
- Yes
-
- -
-
Payload key
-
code
-
- -
-
Reference
-
-
    -
  • https://eclass.eu/en/eclass-standard/search-content/show?tx_eclasssearch_ecsearch[discharge]=0&tx_eclasssearch_ecsearch[id]=44000000&tx_eclasssearch_ecsearch[language]=1&tx_eclasssearch_ecsearch[version]=13.0&cHash=10abd2696c4c5c526da4e3367e78c592
    • -
-
-
- -
-
Constraints
-
-
    -
  • -
    - -
    - Code Constraint -
    - -
    -
    Description
    -
    Constraint to limit the input to a valid ECLASS number. The constraint ensures that each pair of digits is followed by a hyphen, resulting in a pattern like "00-00-00-00" where the zeros can be replaced by any digit.
    -
    - - -
    -
    Regular expression
    -
    ^\d{2}-\d{2}-\d{2}-\d{2}$
    -
    - -
    • -
-
-
-
-
- -
-
Definition
-
- -The associated product category NAME according to ECLASS. - -
-
Name
-
definition
-
- - - -
-
Characteristic
-
-
-
-
- Type http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Example
-
Manual transmission (motor vehicle)
-
- -
-
Optional
-
- No
-
- -
-
In payload
-
- Yes
-
- -
-
Payload key
-
definition
-
- -
-
Reference
-
-
    -
  • https://eclass.eu/en/eclass-standard/search-content/show?tx_eclasssearch_ecsearch[discharge]=0&tx_eclasssearch_ecsearch[id]=44000000&tx_eclasssearch_ecsearch[language]=1&tx_eclasssearch_ecsearch[version]=13.0&cHash=10abd2696c4c5c526da4e3367e78c592
    • -
-
-
- -
-
-
-
-

Code Entity

-
-
- Code entity with code name and value. -
- -
-

Properties

-
-
- -
-
Code Name
-
- -Title of the code. - -
-
Name
-
codeName
-
- - - -
-
Characteristic
-
-
-
-
- Type http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Example
-
TARIC
-
- -
-
Optional
-
- No
-
- -
-
In payload
-
- Yes
-
- -
-
Payload key
-
name
-
- - -
-
- -
-
Code Value
-
- -The code value of the specific code. - -
-
Name
-
codeValue
-
- - - -
-
Characteristic
-
-
-
-
- Type http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Example
-
8703 24 10 00
-
- -
-
Optional
-
- No
-
- -
-
In payload
-
- Yes
-
- -
-
Payload key
-
value
-
- - -
-
-
-
-

Commercial Entity

-
-
- Commercial information such as placed on market and the warranty. -
- -
-

Properties

-
-
- -
-
Placed on Market
-
- -Date on when the product is put in the market. - -
-
Name
-
placedOnMarket
-
- - - -
-
Characteristic
-
-
-
-
- Type http://www.w3.org/2001/XMLSchema#date - -
-
-
-
-
- -
-
Example
-
2000-01-01
-
- -
-
Optional
-
- Yes
-
- -
-
In payload
-
- Yes
-
- -
-
Payload key
-
placedOnMarket
-
- - -
-
- -
-
Warranty
-
- -Commercial warranty period of the product (coupled to the Vehicle) in months. Durability and reliability of the product or its components as expressed through the product’s guaranteed lifetime, technical lifetime, mean time between failures, indication of real use information on the product, resistance to stresses or aging mechanisms. - -
-
Name
-
warranty
-
- - - -
-
Characteristic
-
-
-
-
Measurement
-
-
-
-
-
-
Unit
-
-
-
-
    -
  • - month -
    • -
  • - Symbol mo -
    • -
  • - Code MON -
    • -
  • - Conversion factor 2.629800 × 10⁶ s -
    • -
-
-
-
-
- Type http://www.w3.org/2001/XMLSchema#decimal - -
-
-
-
-
- -
-
Example
-
36
-
- -
-
Optional
-
- No
-
- -
-
In payload
-
- Yes
-
- -
-
Payload key
-
warranty
-
- - -
-
-
-
-

Document Entity

-
-
- Document entity with header, content, category and type. -
- -
-

Properties

-
-
- -
-
Content
-
- -The content of the document e.g a link. - -
-
Name
-
content
-
- - - -
-
Characteristic
-
-
-
-
- Type http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Example
-
www.alink.pdf
-
- -
-
Optional
-
- No
-
- -
-
In payload
-
- Yes
-
- -
-
Payload key
-
content
-
- - -
-
- -
-
Category
-
- -The category in which the document can be sorted. - -
-
Name
-
category
-
- - - -
-
Characteristic
-
-
-
-
Enumeration
-
-
-
Values
-
-
-
-
    -
  • Safety
    • -
  • Sustainability
    • -
  • Compliance
    • -
  • Passport
    • -
  • SubstanceOfConcern
    • -
-
-
-
-
- Type http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Example
-
Sustainability
-
- -
-
Optional
-
- No
-
- -
-
In payload
-
- Yes
-
- -
-
Payload key
-
category
-
- - -
-
- -
-
Content Type
-
- -The type of content which can be expected in the "content" property. Examples are a link, pdf, excel, etc. - -
-
Name
-
contentType
-
- - - -
-
Characteristic
-
-
-
-
- Type http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Example
-
link
-
- -
-
Optional
-
- No
-
- -
-
In payload
-
- Yes
-
- -
-
Payload key
-
type
-
- - -
-
- -
-
Header
-
- -The header as a short description of the document with a maximum of 100 characters. - -
-
Name
-
header
-
- - - -
-
Characteristic
-
-
-
-
Trait
-
-
-
- Type http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Example
-
Sustainability Document Material XY
-
- -
-
Optional
-
- No
-
- -
-
In payload
-
- Yes
-
- -
-
Payload key
-
header
-
- - -
-
Constraints
-
-
    -
  • -
    - -
    - Title Constraint -
    - -
    -
    Description
    -
    A constraint that limits the title to 100 characters.
    -
    - - -
    -
    Min. Length
    -
    3
    -
    -
    -
    Max. length
    -
    100
    -
    - -
    • -
-
-
-
-
-
-
-

Economic Operator Entity

-
-
- Economic operator entity with identification and EORI. -
- -
-

Properties

-
-
- -
-
Economic Operator Id
-
- -The identification of the economic operator of the passport. - -
-
Name
-
economicOperatorId
-
- - - -
-
Characteristic
-
-
-
-
- Type http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Example
-
BPNL1234567890ZZ
-
- -
-
Optional
-
- No
-
- -
-
In payload
-
- Yes
-
- -
-
Payload key
-
id
-
- - -
-
- -
-
EORI
-
- -Any economic operator established in the customs territory of the Union needs, for customs purposes, an EORI number. EORI stands for economic operators registration and identification number. - -
-
Name
-
eori
-
- - - -
-
Characteristic
-
-
-
-
Trait
-
-
-
- Type http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Example
-
GB123456789000
-
- -
-
Optional
-
- Yes
-
- -
-
In payload
-
- Yes
-
- -
-
Payload key
-
eori
-
- - -
-
Constraints
-
-
    -
  • -
    - -
    - EORI Constraint -
    - -
    -
    Description
    -
    Constraint with a pattern which ensures that the EORI number starts with two alphanumeric characters, followed by two alphabetic characters, and ends with 2 to 15 alphanumeric characters.
    -
    - - -
    -
    Regular expression
    -
    ^[A-Z]{2}[A-Z0-9]{1,18}$
    -
    - -
    • -
-
-
-
-
-
-
-

Handling Entity

-
-
- Entity to describe different aspects in relation with the handling of the product. Properties are the maintenance history spare parts, substances of concern and reusable packaging. -
- -
-

Properties

-
-
- -
-
Maintenance History
-
- -The maintenance history of the product with dates, titles and descriptions. - -
-
Name
-
maintenanceHistory
-
- - - -
-
Characteristic
-
-
-
-
List
-
-
-
Has a certain order
-
-
-
Duplicates allowed
-
-
-
- Type urn:bamm:io.catenax.generic.digital_product_passport:1.0.0#MaintenanceHistoryEntity - -
-
-
-
-
- - -
-
Optional
-
- No
-
- -
-
In payload
-
- Yes
-
- -
-
Payload key
-
maintenanceHistory
-
- - -
-
- -
-
Spare Parts
-
- -The list of spare parts available for the product from a supplier. - -
-
Name
-
spareParts
-
- - - -
-
Characteristic
-
-
-
-
List
-
-
-
Has a certain order
-
-
-
Duplicates allowed
-
-
-
- Type urn:bamm:io.catenax.generic.digital_product_passport:1.0.0#PartEntity - -
-
-
-
-
- - -
-
Optional
-
- Yes
-
- -
-
In payload
-
- Yes
-
- -
-
Payload key
-
spareParts
-
- - -
-
- -
-
Concerning Substance
-
- -Details to the substance of concern. - -
-
Name
-
substanceOfConcern
-
- - - -
-
Characteristic
-
-
-
-
List
-
-
-
Has a certain order
-
-
-
Duplicates allowed
-
-
-
- Type urn:bamm:io.catenax.generic.digital_product_passport:1.0.0#SubstanceEntity - -
-
-
-
-
- - -
-
Optional
-
- No
-
- -
-
In payload
-
- Yes
-
- -
-
Payload key
-
substanceOfConcern
-
- - -
-
- -
-
Reusable Packaging
-
- -Definition of whether the product uses a reuse system. The values true or false are allowed. - -
-
Name
-
reusablePackaging
-
- - - -
-
Characteristic
-
-
-
-
- Type http://www.w3.org/2001/XMLSchema#boolean - -
-
-
-
-
- -
-
Example
-
true
-
- -
-
Optional
-
- Yes
-
- -
-
In payload
-
- Yes
-
- -
-
Payload key
-
reusablePackaging
-
- - -
-
-
-
-

Identification Entity

-
-
- Entity with identification information of the product with local identifiers, gtin, commodity code and other codes. -
- -
-

Properties

-
-
- -
-
GTIN
-
- -GTIN stands for Global Trade Item Number. It is a unique and internationally recognized identifier used to identify products in the global marketplace. GTINs are typically encoded in barcodes and are used by retailers, manufacturers, and suppliers to track and manage their products throughout the supply chain. Valid inputs are all GTIN versions (GTIN-8, GTIN-12, GTIN-13, and GTIN-14). - -
-
Name
-
gtin
-
- - - -
-
Characteristic
-
-
-
-
Trait
-
-
-
- Type http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Example
-
12345678
-
- -
-
Optional
-
- Yes
-
- -
-
In payload
-
- Yes
-
- -
-
Payload key
-
gtin
-
- - -
-
Constraints
-
-
    -
  • -
    - -
    - GTIN Constraint -
    - -
    -
    Description
    -
    This pattern allows for matching any GTIN version by specifying the required number of digits for each version.
    -
    - - -
    -
    Regular expression
    -
    ^(?:\d{8}|\d{12}|\d{13}|\d{14})$
    -
    - -
    • -
-
-
-
-
- -
-
Additional Code
-
- -Codes for identification can be for example commodity codes. In Europe, two commonly used codes for goods classification are the Harmonized System (HS) code and the Combined Nomenclature (CN). Other codes can also be given. - -
-
Name
-
additionalCode
-
- - - -
-
Characteristic
-
-
-
-
List
-
-
-
Has a certain order
-
-
-
Duplicates allowed
-
-
-
- Type urn:bamm:io.catenax.generic.digital_product_passport:1.0.0#CodeEntity - -
-
-
-
-
- - -
-
Optional
-
- Yes
-
- -
-
In payload
-
- Yes
-
- -
-
Payload key
-
additionalCode
-
- - -
-
- -
-
Local Identifiers
-
- -A local identifier enables identification of a part in a specific dataspace, but is not unique in Catena-X dataspace. Multiple local identifiers may exist. - -
-
Name
-
localIdentifiers
-
- - - -
-
Characteristic
-
-
-
-
Set
-
-
-
Has no order
-
-
-
Duplicates not allowed
-
-
-
- Type urn:bamm:io.catenax.serial_part:1.0.0#KeyValueList - -
-
-
-
-
- - -
-
Optional
-
- No
-
- -
-
In payload
-
- Yes
-
- -
-
Payload key
-
localIdentifiers
-
- - -
-
-
-
-

Key Value List

-
-
- A list of key value pairs for local identifiers, which are composed of a key and a corresponding value. -
- -
-

Properties

-
-
- -
-
Identifier Key
-
- -The key of a local identifier. - -
-
Name
-
key
-
- - - -
-
Characteristic
-
-
-
-
- Type http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Example
-
PartInstanceID
-
- -
-
Optional
-
- No
-
- -
-
In payload
-
- Yes
-
- -
-
Payload key
-
key
-
- - -
-
- -
-
Identifier Value
-
- -The value of an identifier. - -
-
Name
-
value
-
- - - -
-
Characteristic
-
-
-
-
- Type http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Example
-
SN12345678
-
- -
-
Optional
-
- No
-
- -
-
In payload
-
- Yes
-
- -
-
Payload key
-
value
-
- - -
-
-
-
-

Lifespan Entity

-
-
- Entity for the lifespan of a product with unit and value. -
- -
-

Properties

-
-
- -
-
Life Unit
-
- -The unit of the expected lifetime of a product from the unit catalog. - -
-
Name
-
lifeUnit
-
- - - -
-
Characteristic
-
-
-
-
Enumeration
-
-
-
Values
-
-
-
-
    -
  • unit:day
    • -
  • unit:month
    • -
  • unit:cycle
    • -
  • unit:year
    • -
  • unit:kilometre
    • -
  • unit:runningOrOperatingHour
    • -
-
-
-
-
- Reference -
-
    -
  • https://eclipse-esmf.github.io/samm-specification/snapshot/appendix/unitcatalog.html
    • -
-
-
-
-
-
- Type http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Example
-
unit:month
-
- -
-
Optional
-
- No
-
- -
-
In payload
-
- Yes
-
- -
-
Payload key
-
unit
-
- -
-
Reference
-
-
    -
  • https://eclipse-esmf.github.io/samm-specification/snapshot/appendix/unitcatalog.html
    • -
-
-
- -
-
- -
-
Life Value
-
- -The value of the expected lifetime of a product. - -
-
Name
-
lifeValue
-
- - - -
-
Characteristic
-
-
-
-
Quantifiable
-
-
-
Duration
-
-
-
- Type http://www.w3.org/2001/XMLSchema#integer - -
-
-
-
-
- -
-
Example
-
36
-
- -
-
Optional
-
- No
-
- -
-
In payload
-
- Yes
-
- -
-
Payload key
-
value
-
- - -
-
-
-
-

Maintenance History Entity

-
-
- Entity describing a list of entries of the service history with title, text, activities and dates. -
- -
-

Properties

-
-
- -
-
Title
-
- -The title of the data object with a maximum of 100 characters. - -
-
Name
-
title
-
- - - -
-
Characteristic
-
-
-
-
Trait
-
-
-
- Type http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Example
-
Check-up
-
- -
-
Optional
-
- No
-
- -
-
In payload
-
- Yes
-
- -
-
Payload key
-
title
-
- - -
-
Constraints
-
-
    -
  • -
    - -
    - Title Constraint -
    - -
    -
    Description
    -
    A constraint that limits the title to 100 characters.
    -
    - - -
    -
    Min. Length
    -
    3
    -
    -
    -
    Max. length
    -
    100
    -
    - -
    • -
-
-
-
-
- -
-
Maintenance Description
-
- -A short description of the maintenance content. - -
-
Name
-
maintenanceDescription
-
- - - -
-
Characteristic
-
-
-
-
- Type http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Example
-
Check tire pressure and rotate tires
-
- -
-
Optional
-
- No
-
- -
-
In payload
-
- Yes
-
- -
-
Payload key
-
description
-
- - -
-
- -
-
Maintenance Date
-
- -The dates when the product was put into service, repair etc. - -
-
Name
-
maintenanceDate
-
- - - -
-
Characteristic
-
-
-
-
- Type http://www.w3.org/2001/XMLSchema#date - -
-
-
-
-
- -
-
Example
-
2000-01-01
-
- -
-
Optional
-
- No
-
- -
-
In payload
-
- Yes
-
- -
-
Payload key
-
date
-
- - -
-
- -
-
Activity
-
- -The activities of putting the product into service in form of an enumeration with the values Inspection, Maintenance, Repair, Preventive Maintenance, Accident and Other. - -
-
Name
-
activity
-
- - - -
-
Characteristic
-
-
-
-
Enumeration
-
-
-
Values
-
-
-
-
    -
  • Inspection
    • -
  • Maintenance
    • -
  • Repair
    • -
  • Preventive Maintenance
    • -
  • Accident
    • -
  • Other
    • -
-
-
-
-
- Type http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Example
-
Maintenance
-
- -
-
Optional
-
- No
-
- -
-
In payload
-
- Yes
-
- -
-
Payload key
-
activity
-
- - -
-
-
-
-

Mandatory Sources Entity

-
-
- Entity for document sources of a product. -
- -
-

Properties

-
-
- -
-
Safety Packaging
-
- -Document regarding the packaging of the product. - -
-
Name
-
safetyPackaging
-
- - - -
-
Characteristic
-
-
-
-
SingleEntity
-
-
-
- Type urn:bamm:io.catenax.generic.digital_product_passport:1.0.0#DocumentEntity - -
-
-
-
-
- - -
-
Optional
-
- No
-
- -
-
In payload
-
- Yes
-
- -
-
Payload key
-
safetyPackaging
-
- - -
-
- -
-
Substance of Concern Transportation
-
- -Document regarding the safe transportation of the product. - -
-
Name
-
safetyTransportation
-
- - - -
-
Characteristic
-
-
-
-
SingleEntity
-
-
-
- Type urn:bamm:io.catenax.generic.digital_product_passport:1.0.0#DocumentEntity - -
-
-
-
-
- - -
-
Optional
-
- No
-
- -
-
In payload
-
- Yes
-
- -
-
Payload key
-
safetyTransportation
-
- - -
-
- -
-
Substance of Concern Disassembly
-
- -Document regarding the disassembly processes for the substances of concern. - -
-
Name
-
substanceOfConcernDisassembly
-
- - - -
-
Characteristic
-
-
-
-
SingleEntity
-
-
-
- Type urn:bamm:io.catenax.generic.digital_product_passport:1.0.0#DocumentEntity - -
-
-
-
-
- - -
-
Optional
-
- No
-
- -
-
In payload
-
- Yes
-
- -
-
Payload key
-
substanceOfConcernDisassembly
-
- - -
-
- -
-
declarationOfConformity
-
- -Compliance documentation and information required under this Regulation or other Union law applicable to the product, such as the declaration of conformity, technical documentation or conformity certificates. - -
-
Name
-
declarationOfConformity
-
- - - -
-
Characteristic
-
-
-
-
List
-
-
-
Has a certain order
-
-
-
Duplicates allowed
-
-
-
- Type urn:bamm:io.catenax.generic.digital_product_passport:1.0.0#SourceEntity - -
-
-
-
-
- - -
-
Optional
-
- No
-
- -
-
In payload
-
- Yes
-
- -
-
Payload key
-
declarationOfConformity
-
- - -
-
- -
-
Substance of Concern Instruction
-
- -Instructions regarding the substances of concern. - -
-
Name
-
substanceOfConcernInstruction
-
- - - -
-
Characteristic
-
-
-
-
SingleEntity
-
-
-
- Type urn:bamm:io.catenax.generic.digital_product_passport:1.0.0#DocumentEntity - -
-
-
-
-
- - -
-
Optional
-
- No
-
- -
-
In payload
-
- Yes
-
- -
-
Payload key
-
substanceOfConcernInstruction
-
- - -
-
-
-
-

Manufacturer Entity

-
-
- Manufacturing Entity with the identification of the main manufacturer and the facility location. -
- -
-

Properties

-
-
- -
-
Facility Id
-
- -The facility Identification, where the main manufacturing took place. - -
-
Name
-
facilityId
-
- - - -
-
Characteristic
-
-
-
-
- Type http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Example
-
BPNL1234567890ZZ
-
- -
-
Optional
-
- No
-
- -
-
In payload
-
- Yes
-
- -
-
Payload key
-
facilityId
-
- - -
-
- -
-
Manufacturer Id
-
- -The main manufacturer, if different from the passport owner. - -
-
Name
-
manufacturerId
-
- - - -
-
Characteristic
-
-
-
-
- Type http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Example
-
BPN1234567890ZZ
-
- -
-
Optional
-
- Yes
-
- -
-
In payload
-
- Yes
-
- -
-
Payload key
-
manufacturerId
-
- - -
-
-
-
-

Manufacturing Entity

-
-
- Encapsulates the manufacturing relevant attributes -
- -
-

Properties

-
-
- -
-
Production Date
-
- -Timestamp of the manufacturing date as the final step in production process (e.g. final quality check, ready-for-shipment event) - -
-
Name
-
date
-
- - - -
-
Characteristic
-
-
-
-
- Type http://www.w3.org/2001/XMLSchema#dateTime - -
-
-
-
-
- -
-
Example
-
2022-02-04T14:48:54
-
- -
-
Optional
-
- No
-
- -
-
In payload
-
- Yes
-
- -
-
Payload key
-
date
-
- - -
-
- -
-
Country code
-
- -Country code where the part was manufactured - -
-
Name
-
country
-
- - - -
-
Characteristic
-
-
-
-
Trait
-
-
-
- Type http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Example
-
HUR
-
- -
-
Optional
-
- Yes
-
- -
-
In payload
-
- Yes
-
- -
-
Payload key
-
country
-
- - -
-
Constraints
-
-
    -
  • -
    - -
    - Country Code Regular Expression -
    - -
    -
    Description
    -
    Regular Expression that ensures a three-letter code
    -
    - - -
    -
    Regular expression
    -
    ^[A-Z][A-Z][A-Z]$
    -
    - -
    • -
-
-
-
-
-
-
-

Material Entity

-
-
- Entity with properties materialName, percentage and flags for the possibility to recycle and renew the material. -
- -
-

Properties

-
-
- -
-
Material Name
-
- -The material name which is part of the product. - -
-
Name
-
materialName
-
- - - -
-
Characteristic
-
-
-
-
- Type http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Example
-
Aluminium
-
- -
-
Optional
-
- No
-
- -
-
In payload
-
- Yes
-
- -
-
Payload key
-
name
-
- - -
-
- -
-
Recycled
-
- -A flag if the material is recovered recyclate content from the product. - -
-
Name
-
recycled
-
- - - -
-
Characteristic
-
-
-
-
- Type http://www.w3.org/2001/XMLSchema#boolean - -
-
-
-
-
- -
-
Example
-
false
-
- -
-
Optional
-
- No
-
- -
-
In payload
-
- Yes
-
- -
-
Payload key
-
recycled
-
- - -
-
- -
-
Renewable
-
- -Flag if the material is made of natural resources that can be replenished. Renewable resources are those that can be reproduced by physical, chemical, or mechanical processes. These are the kind of resources that can be regenerated throughout time. Forest wood, for example, can be grown through reforestation. - -
-
Name
-
renewable
-
- - - -
-
Characteristic
-
-
-
-
- Type http://www.w3.org/2001/XMLSchema#boolean - -
-
-
-
-
- -
-
Example
-
true
-
- -
-
Optional
-
- Yes
-
- -
-
In payload
-
- Yes
-
- -
-
Payload key
-
renewable
-
- - -
-
- -
-
Percentage
-
- -Percentage of the material. - -
-
Name
-
percentage
-
- - - -
-
Characteristic
-
-
-
-
Measurement
-
-
-
-
-
-
Unit
-
-
-
-
    -
  • - percent -
    • -
  • - Symbol % -
    • -
  • - Code P1 -
    • -
-
-
-
-
- Type http://www.w3.org/2001/XMLSchema#float - -
-
-
-
-
- -
-
Example
-
5.0
-
- -
-
Optional
-
- No
-
- -
-
In payload
-
- Yes
-
- -
-
Payload key
-
percentage
-
- - -
-
-
-
-

Metadata Entity

-
-
- Passport Entity to describe version, status, validity and issue date. -
- -
-

Properties

-
-
- -
-
Version
-
- -The current version of the product passport. - -
-
Name
-
version
-
- - - -
-
Characteristic
-
-
-
-
- Type http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Example
-
1.0.0
-
- -
-
Optional
-
- No
-
- -
-
In payload
-
- Yes
-
- -
-
Payload key
-
version
-
- - -
-
- -
-
Status
-
- -The current status of the product passport declared through either: draft, approved, invalid or expired. - -
-
Name
-
status
-
- - - -
-
Characteristic
-
-
-
-
Enumeration
-
-
-
Values
-
-
-
-
    -
  • Draft
    • -
  • Approved
    • -
  • Invalid
    • -
  • Expired
    • -
-
-
-
-
- Type http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Example
-
Draft
-
- -
-
Optional
-
- No
-
- -
-
In payload
-
- Yes
-
- -
-
Payload key
-
status
-
- - -
-
- -
-
Validity Date
-
- -The timestamp for the product passport until when it is available. - -
-
Name
-
validityDate
-
- - - -
-
Characteristic
-
-
-
-
- Type http://www.w3.org/2001/XMLSchema#date - -
-
-
-
-
- -
-
Example
-
2000-01-01
-
- -
-
Optional
-
- No
-
- -
-
In payload
-
- Yes
-
- -
-
Payload key
-
validityDate
-
- - -
-
- -
-
Issue Date
-
- -The timestamp for the product passport since when it is available. - -
-
Name
-
issueDate
-
- - - -
-
Characteristic
-
-
-
-
- Type http://www.w3.org/2001/XMLSchema#date - -
-
-
-
-
- -
-
Example
-
2000-01-01
-
- -
-
Optional
-
- No
-
- -
-
In payload
-
- Yes
-
- -
-
Payload key
-
issueDate
-
- - -
-
- -
-
Economic Operator
-
- -The economic operator of the passport. - -
-
Name
-
economicOperator
-
- - - -
-
Characteristic
-
-
-
-
SingleEntity
-
-
-
- Type urn:bamm:io.catenax.generic.digital_product_passport:1.0.0#EconomicOperatorEntity - -
-
-
-
-
- - -
-
Optional
-
- No
-
- -
-
In payload
-
- Yes
-
- -
-
Payload key
-
economicOperator
-
- - -
-
-
-
-

Operation Entity

-
-
- Operational information of the product such as the owner, manufacturer and importer. -
- -
-

Properties

-
-
- -
-
Importer
-
- -The importer of the product, if different from the owner of the passport. - -
-
Name
-
importer
-
- - - -
-
Characteristic
-
-
-
-
- Type http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Example
-
BPNL1234567890ZZ
-
- -
-
Optional
-
- No
-
- -
-
In payload
-
- Yes
-
- -
-
Payload key
-
importer
-
- - -
-
- -
-
Manufacturer
-
- -Manufacturing identification of the product. - -
-
Name
-
manufacturer
-
- - - -
-
Characteristic
-
-
-
-
SingleEntity
-
-
-
- Type urn:bamm:io.catenax.generic.digital_product_passport:1.0.0#ManufacturerEntity - -
-
-
-
-
- - -
-
Optional
-
- No
-
- -
-
In payload
-
- Yes
-
- -
-
Payload key
-
manufacturer
-
- - -
-
-
-
-

Part Entity

-
-
- Entity with the attributes partId, producerId and partName to describe a list of spare parts. -
- -
-

Properties

-
-
- -
-
Part Id
-
- -The identification of spare parts available for the product. - -
-
Name
-
partId
-
- - - -
-
Characteristic
-
-
-
-
- Type http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Example
-
Aluminum Housing 952/C
-
- -
-
Optional
-
- No
-
- -
-
In payload
-
- Yes
-
- -
-
Payload key
-
partId
-
- - -
-
- -
-
Producer Id
-
- -The identifier of the producer. In the CATENA-X network the BPN identification of the spare part producer is needed. - -
-
Name
-
producerId
-
- - - -
-
Characteristic
-
-
-
-
- Type http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Example
-
BPNL1234567890ZZ
-
- -
-
Optional
-
- No
-
- -
-
In payload
-
- Yes
-
- -
-
Payload key
-
producerId
-
- - -
-
- -
-
Part Name
-
- -The name of the spare part. - -
-
Name
-
partName
-
- - - -
-
Characteristic
-
-
-
-
- Type http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Example
-
Aluminum Housing
-
- -
-
Optional
-
- No
-
- -
-
In payload
-
- Yes
-
- -
-
Payload key
-
name
-
- - -
-
-
-
-

Product Or Sector Specific Rule

-
-
- Entity for defining a product or sector specific rule of a product carbon footprint as specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. -
-
- Reference -
-
    -
  • https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/
    • -
-
-
- -
-

Properties

-
-
- -
-
Operator or Publisher of Sector Specific Rules
-
- -Operator of PCR (Product Category Rule)/ PSR (Product Specific Rule) as specified in the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. WBCSD specific extension, in Catena-X for example must always be "Other". - -
-
Name
-
operator
-
- - - -
-
Characteristic
-
-
-
-
Enumeration
-
-
-
Values
-
-
-
-
    -
  • PEF
    • -
  • EPD International
    • -
  • Other
    • -
-
-
-
-
- Reference -
-
    -
  • https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/
    • -
-
-
-
-
-
- Type http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Example
-
Other
-
- -
-
Optional
-
- No
-
- -
-
In payload
-
- Yes
-
- -
-
Payload key
-
extWBCSD_operator
-
- -
-
Reference
-
-
    -
  • https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/
    • -
-
-
- -
-
- -
-
Product or Sector Specific Rule Names
-
- -Product-specific or sector-specific set of rules used for calculating or allocating GHG (Greenhouse Gas) emissions applied from the specified operator as specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. - -
-
Name
-
ruleNames
-
- - - -
-
Characteristic
-
-
-
-
Trait
-
-
-
- Type urn:bamm:io.catenax.pcf:4.0.0#RuleName - -
-
-
-
-
- - -
-
Optional
-
- No
-
- -
-
In payload
-
- Yes
-
- -
-
Payload key
-
productOrSectorSpecificRules
-
- -
-
Reference
-
-
    -
  • https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/
    • -
-
-
- -
-
Constraints
-
-
    -
  • -
    - -
    - Rule Names Constraint -
    - -
    -
    Description
    -
    Constraint for defining a non-empty set of rule names as specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.
    -
    - -
    -
    Reference
    -
    -
    -
      -
    • https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/
      • -
    -
    -
    -
    - -
    -
    Min. Length
    -
    1
    -
    - -
    • -
-
-
-
-
- -
-
Other Operator Name
-
- -Other operator of PCR (Product Category Rule)/ PSR (Product Specific Rule) as specified in the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. WBCSD specific extension, in Catena-X for example specified by a default value. - -
-
Name
-
otherOperatorName
-
- - - -
-
Characteristic
-
-
-
-
Trait
-
-
-
- Type http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Example
-
NSF
-
- -
-
Optional
-
- Yes
-
- -
-
In payload
-
- Yes
-
- -
-
Payload key
-
extWBCSD_otherOperatorName
-
- -
-
Reference
-
-
    -
  • https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/
    • -
-
-
- -
-
Constraints
-
-
    -
  • -
    - -
    - Non Empty String Constraint -
    - -
    -
    Description
    -
    Constraint for ensuring that a string has at least one character.
    -
    - - -
    -
    Min. Length
    -
    1
    -
    - -
    • -
-
-
-
-
-
-
-

Quantity Entity

-
-
- Quantity of the product with value and unit. -
- -
-

Properties

-
-
- -
-
Quantity Unit
-
- -Quantity refers to the number of units or items of a product being bought, sold, manufactured, or stored as a batch.If the product is a single item choose the unit "unit:piece". All possible units are pieces, gram, kilogram, millilitres, litres, cubic meters, meters or square meters. - -
-
Name
-
quantityUnit
-
- - - -
-
Characteristic
-
-
-
-
Enumeration
-
-
-
Values
-
-
-
-
    -
  • unit:piece
    • -
  • unit:gram
    • -
  • unit:kilogram
    • -
  • unit:metre
    • -
  • unit:litre
    • -
  • unit:cubicMetre
    • -
  • unit:squareMetre
    • -
-
-
-
-
- Reference -
-
    -
  • https://eclipse-esmf.github.io/samm-specification/snapshot/appendix/unitcatalog.html
    • -
-
-
-
-
-
- Type http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Example
-
unit:piece
-
- -
-
Optional
-
- No
-
- -
-
In payload
-
- Yes
-
- -
-
Payload key
-
unit
-
- -
-
Reference
-
-
    -
  • https://eclipse-esmf.github.io/samm-specification/snapshot/appendix/unitcatalog.html
    • -
-
-
- -
-
- -
-
Quantity Value
-
- -Quantity refers to the number of units or items of a product being bought, sold, manufactured, or stored. If the product is not a batch, choose the unit piece and value 1.0. - -
-
Name
-
quantityValue
-
- - - -
-
Characteristic
-
-
-
-
- Type http://www.w3.org/2001/XMLSchema#float - -
-
-
-
-
- -
-
Example
-
1.0
-
- -
-
Optional
-
- No
-
- -
-
In payload
-
- Yes
-
- -
-
Payload key
-
value
-
- - -
-
-
-
-

Registration Entity

-
-
- Entity for registration information such as the identification at the customer and the manufacturer. -
- -
-

Properties

-
-
- -
-
Customer Part ID
-
- -Part ID as assigned by the manufacturer of the part. The Part ID identifies the part (as designed) in the customer`s dataspace. The Part ID does not reference a specific instance of a part and thus should not be confused with the serial number. - -
-
Name
-
customerPartId
-
- - - -
-
Characteristic
-
-
-
-
- Type http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Example
-
PRT-12345
-
- -
-
Optional
-
- No
-
- -
-
In payload
-
- Yes
-
- -
-
Payload key
-
customerPartId
-
- - -
-
- -
-
Manufacturer Part ID
-
- -Part ID as assigned by the manufacturer of the part. The Part ID identifies the part (as designed) in the manufacturer`s dataspace. The Part ID does not reference a specific instance of a part and thus should not be confused with the serial number. - -
-
Name
-
manufacturerPartId
-
- - - -
-
Characteristic
-
-
-
-
- Type http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Example
-
123-0.740-3434-A
-
- -
-
Optional
-
- No
-
- -
-
In payload
-
- Yes
-
- -
-
Payload key
-
manufacturerPartId
-
- - -
-
-
-
-

Rule Name

-
-
- Name of a rule applied by a specified operator as specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. -
-
- Reference -
-
    -
  • https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/
    • -
-
-
- -
-

Properties

-
-
- -
-
Rule Name
-
- -Name of a rule applied by a specific operator as specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. - -
-
Name
-
ruleName
-
- - - -
-
Characteristic
-
-
-
-
Trait
-
-
-
- Type http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Example
-
urn:tfs-initiative.com:PCR:The Product Carbon Footprint Guideline for the Chemical Industry:version:v2.0
-
- -
-
Optional
-
- No
-
- -
-
In payload
-
- Yes
-
- -
-
Payload key
-
ruleName
-
- -
-
Reference
-
-
    -
  • https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/
    • -
-
-
- -
-
Constraints
-
-
    -
  • -
    - -
    - Non Empty String Constraint -
    - -
    -
    Description
    -
    Constraint for ensuring that a string has at least one character.
    -
    - - -
    -
    Min. Length
    -
    1
    -
    - -
    • -
-
-
-
-
-
-
-

Serialization Entity

-
-
- Entity for serialization information such as the quantity, the registration ids and the manufacturing date. -
- -
-

Properties

-
-
- -
-
Quantity
-
- -Quantity refers to the number of units or items of a product being bought, sold, manufactured, or stored. It is an important factor in inventory management, supply chain logistics, and pricing calculations. - -
-
Name
-
quantity
-
- - - -
-
Characteristic
-
-
-
-
SingleEntity
-
-
-
- Type urn:bamm:io.catenax.generic.digital_product_passport:1.0.0#QuantityEntity - -
-
-
-
-
- - -
-
Optional
-
- No
-
- -
-
In payload
-
- Yes
-
- -
-
Payload key
-
quantity
-
- - -
-
- -
-
Registration
-
- -Registration information such as the identification at the customer and the manufacturer. - -
-
Name
-
registration
-
- - - -
-
Characteristic
-
-
-
-
SingleEntity
-
-
-
- Type urn:bamm:io.catenax.generic.digital_product_passport:1.0.0#RegistrationEntity - -
-
-
-
-
- - -
-
Optional
-
- No
-
- -
-
In payload
-
- Yes
-
- -
-
Payload key
-
registration
-
- - -
-
- -
-
Manufacturing Information
-
- -Information from manufacturing process, such as manufacturing date and manufacturing country - -
-
Name
-
manufacturingInformation
-
- - - -
-
Characteristic
-
-
-
-
SingleEntity
-
-
-
- Type urn:bamm:io.catenax.serial_part:1.0.0#ManufacturingEntity - -
-
-
-
-
- - -
-
Optional
-
- No
-
- -
-
In payload
-
- Yes
-
- -
-
Payload key
-
manufacturingInformation
-
- - -
-
-
-
-

Source Entity

-
-
- Entity for document sources of a product. -
- -
-

Properties

-
-
- -
-
Source Name
-
- -The source name as an enumeration. - -
-
Name
-
sourceName
-
- - - -
-
Characteristic
-
-
-
-
Enumeration
-
-
-
Values
-
-
-
-
    -
  • other
    • -
  • tool and process
    • -
  • assembly and disassembly
    • -
  • repair and installation
    • -
  • user manual
    • -
  • end of life
    • -
  • return and disposal
    • -
  • expected waste generation
    • -
  • product packaging
    • -
  • positioning
    • -
  • waste prevention
    • -
  • sustainability
    • -
-
-
-
-
- Type http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- - -
-
Optional
-
- No
-
- -
-
In payload
-
- Yes
-
- -
-
Payload key
-
name
-
- - -
-
- -
-
Document Property
-
- -Property for the document. - -
-
Name
-
documentProperty
-
- - - -
-
Characteristic
-
-
-
-
SingleEntity
-
-
-
- Type urn:bamm:io.catenax.generic.digital_product_passport:1.0.0#DocumentEntity - -
-
-
-
-
- - -
-
Optional
-
- No
-
- -
-
In payload
-
- Yes
-
- -
-
Payload key
-
document
-
- - -
-
-
-
-

Sources Entity

-
-
- Entity with optional and mandatory sources. Mandatory sources are documents regarding the substance of concern and compliance. -
- -
-

Properties

-
-
- -
-
Optional Sources
-
- -Optional sources for the product. Optional sources can be a document regarding tool and process, assembly and disassembly, repair and installation, user manual, End of Life, return and disposal, expected waste generation, product packaging, positioning, waste prevention or sustainability information. - -
-
Name
-
optionalSources
-
- - - -
-
Characteristic
-
-
-
-
List
-
-
-
Has a certain order
-
-
-
Duplicates allowed
-
-
-
- Type urn:bamm:io.catenax.generic.digital_product_passport:1.0.0#SourceEntity - -
-
-
-
-
- - -
-
Optional
-
- Yes
-
- -
-
In payload
-
- Yes
-
- -
-
Payload key
-
optional
-
- - -
-
- -
-
Mandatory Sources
-
- -Mandatory document and sources of the product. - -
-
Name
-
mandatorySources
-
- - - -
-
Characteristic
-
-
-
-
SingleEntity
-
-
-
- Type urn:bamm:io.catenax.generic.digital_product_passport:1.0.0#MandatorySourcesEntity - -
-
-
-
-
- - -
-
Optional
-
- No
-
- -
-
In payload
-
- Yes
-
- -
-
Payload key
-
mandatory
-
- - -
-
-
-
-

Substance Entity

-
-
- Entity to describe a list of properties regarding a substance of concern such as the substance name, location, unit and concentration. -
- -
-

Properties

-
-
- -
-
Substance Name
-
- -In accordance with the ESPR specification the name of the substances of concern which is present in the product have to be declared. - -
-
Name
-
substanceName
-
- - - -
-
Characteristic
-
-
-
-
- Type http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Example
-
Lead
-
- -
-
Optional
-
- No
-
- -
-
In payload
-
- Yes
-
- -
-
Payload key
-
name
-
- - -
-
- -
-
Location
-
- -The location of the substances of concern within the product. - -
-
Name
-
location
-
- - - -
-
Characteristic
-
-
-
-
- Type http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Example
-
Housing
-
- -
-
Optional
-
- No
-
- -
-
In payload
-
- Yes
-
- -
-
Payload key
-
location
-
- - -
-
- -
-
Substance Unit
-
- -Units of concentration are percent, volume percent, parts per thousand, parts per million, parts per billion and parts per trillion. - -
-
Name
-
substanceUnit
-
- - - -
-
Characteristic
-
-
-
-
Enumeration
-
-
-
Values
-
-
-
-
    -
  • unit:partPerMillion
    • -
  • unit:percent
    • -
  • unit:percentVolume
    • -
  • unit:partPerThousand
    • -
  • unit:partPerTrillionUs
    • -
  • unit:partPerBillionUs
    • -
-
-
-
-
- Reference -
-
    -
  • https://eclipse-esmf.github.io/samm-specification/snapshot/appendix/unitcatalog.html
    • -
-
-
-
-
-
- Type http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Example
-
unit:percent
-
- -
-
Optional
-
- No
-
- -
-
In payload
-
- Yes
-
- -
-
Payload key
-
unit
-
- -
-
Reference
-
-
    -
  • https://eclipse-esmf.github.io/samm-specification/snapshot/appendix/unitcatalog.html
    • -
-
-
- -
-
- -
-
Concentration
-
- -Concentration of substances of concern at the level of the product. - -
-
Name
-
concentration
-
- - - -
-
Characteristic
-
-
-
-
Either
-
-
-
Characteristic with two possible values. -
-
-
-
- -
-
-
-
-
- - -
-
Optional
-
- No
-
- -
-
In payload
-
- Yes
-
- -
-
Payload key
-
concentration
-
- - -
-
- -
-
Substance Id
-
- -The substance identification. - -
-
Name
-
substanceId
-
- - - -
-
Characteristic
-
-
-
-
- Type http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Example
-
RC0402
-
- -
-
Optional
-
- No
-
- -
-
In payload
-
- Yes
-
- -
-
Payload key
-
id
-
- - -
-
-
-
-

Sustainability Entity

-
-
- Entity with the properties state, al list of different materials, a list of critical materials and the product carbon footprint. -
- -
-

Properties

-
-
- -
-
State
-
- -Status of the product (first life or second life). - -
-
Name
-
state
-
- - - -
-
Characteristic
-
-
-
-
Enumeration
-
-
-
Values
-
-
-
-
    -
  • first life
    • -
  • second life
    • -
-
-
-
-
- Type http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- - -
-
Optional
-
- No
-
- -
-
In payload
-
- Yes
-
- -
-
Payload key
-
state
-
- - -
-
- -
-
Material
-
- -Information on different materials in the product. - -
-
Name
-
material
-
- - - -
-
Characteristic
-
-
-
-
List
-
-
-
Has a certain order
-
-
-
Duplicates allowed
-
-
-
- Type urn:bamm:io.catenax.generic.digital_product_passport:1.0.0#MaterialEntity - -
-
-
-
-
- - -
-
Optional
-
- No
-
- -
-
In payload
-
- Yes
-
- -
-
Payload key
-
material
-
- - -
-
- -
-
Critical
-
- -The list of critical raw materials in the product (CRM) which is specified by EU. - -
-
Name
-
critical
-
- - - -
-
Characteristic
-
-
-
-
List
-
-
-
Has a certain order
-
-
-
Duplicates allowed
-
-
-
- Type http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- - -
-
Optional
-
- No
-
- -
-
In payload
-
- Yes
-
- -
-
Payload key
-
critical
-
- - -
-
- -
-
Carbon Footprint
-
- -Carbon Footprint property with sustainability information. - -
-
Name
-
carbonFootprint
-
- - - -
-
Characteristic
-
-
-
-
SingleEntity
-
-
-
- Type urn:bamm:io.catenax.generic.digital_product_passport:1.0.0#CarbonFootprintEntity - -
-
-
-
-
- - -
-
Optional
-
- No
-
- -
-
In payload
-
- Yes
-
- -
-
Payload key
-
carbonFootprint
-
- - -
-
-
-
-

Type Entity

-
-
- Entity for type with unit and data type. -
- -
-

Properties

-
-
- -
-
Type Unit
-
- -Choose a unit type from the unit catalog, or if the property "children" is filled, leave empty. - -
-
Name
-
typeUnit
-
- - - -
-
Characteristic
-
-
-
-
- Reference -
-
    -
  • https://openmanufacturingplatform.github.io/sds-documentation/bamm-specification/v1.0.0/appendix/unitcatalog.html
    • -
-
-
-
-
-
- Type http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Example
-
unit:volume
-
- -
-
Optional
-
- Yes
-
- -
-
In payload
-
- Yes
-
- -
-
Payload key
-
typeUnit
-
- - -
-
- -
-
Data Type
-
- -Data type that describe the content of the attributes children and data. In case "object" is selected in the enumeration, the children field will be used in the AdditionalDataEntity instead of the "data" property. If it is an other type, the content will be specified in "data" as a string. - -
-
Name
-
dataType
-
- - - -
-
Characteristic
-
-
-
-
Enumeration
-
-
-
Values
-
-
-
-
    -
  • array
    • -
  • object
    • -
  • xsd:string
    • -
  • xsd:integer
    • -
  • xsd:boolean
    • -
  • xsd:double
    • -
  • xsd:float
    • -
  • xsd:byte
    • -
-
-
-
-
- Reference -
-
    -
  • https://openmanufacturingplatform.github.io/sds-documentation/bamm-specification/v1.0.0/datatypes.html
    • -
-
-
-
-
-
- Type http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Example
-
xsd:integer
-
- -
-
Optional
-
- No
-
- -
-
In payload
-
- Yes
-
- -
-
Payload key
-
dataType
-
- - -
-
-
-
-

Typology Entity

-
-
- Entity describing attributes such as the product description, class and different names. -
- -
-

Properties

-
-
- -
-
Product Description
-
- -A general short product description. - -
-
Name
-
productDescription
-
- - - -
-
Characteristic
-
-
-
-
- Type http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Example
-
Product Description long text
-
- -
-
Optional
-
- Yes
-
- -
-
In payload
-
- Yes
-
- -
-
Payload key
-
description
-
- - -
-
- -
-
Class
-
- -The associated product category according to ECLASS. The ECLASS is the worldwide reference data standard for classifying and clearly describing products and services. - -
-
Name
-
class
-
- - - -
-
Characteristic
-
-
-
-
SingleEntity
-
-
-
- Type urn:bamm:io.catenax.generic.digital_product_passport:1.0.0#ClassEntity - -
-
-
-
-
- - -
-
Optional
-
- Yes
-
- -
-
In payload
-
- Yes
-
- -
-
Payload key
-
class
-
- -
-
Reference
-
-
    -
  • https://eclass.eu/en/eclass-standard/search-content/show?tx_eclasssearch_ecsearch%5Bdischarge%5D=0&tx_eclasssearch_ecsearch%5Bid%5D=44000000&tx_eclasssearch_ecsearch%5Blanguage%5D=1&tx_eclasssearch_ecsearch%5Bversion%5D=13.0&cHash=10abd2696c4c5c526da4e3367e78c592
    • -
-
-
- -
-
- -
-
name
-
- -The name of the product type. - -
-
Name
-
name
-
- - - -
-
Characteristic
-
-
-
-
- Type http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Example
-
Transmission Type 8HP60
-
- -
-
Optional
-
- No
-
- -
-
In payload
-
- Yes
-
- -
-
Payload key
-
name
-
- - -
-
- -
-
Name at Manufacturer
-
- -Name of the part as assigned by the manufacturer - -
-
Name
-
nameAtManufacturer
-
- - - -
-
Characteristic
-
-
-
-
- Type http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Example
-
Mirror left
-
- -
-
Optional
-
- No
-
- -
-
In payload
-
- Yes
-
- -
-
Payload key
-
nameAtManufacturer
-
- - -
-
- -
-
Name at Customer
-
- -Name of the part as assigned by the customer - -
-
Name
-
nameAtCustomer
-
- - - -
-
Characteristic
-
-
-
-
- Type http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Example
-
side element A
-
- -
-
Optional
-
- No
-
- -
-
In payload
-
- Yes
-
- -
-
Payload key
-
nameAtCustomer
-
- - -
-
-
-
-

physical dimensions

-
-
- Entity encapsulating the physical dimensions of an object. -
- -
-

Properties

-
-
- -
-
weight
-
- -Weight of the item - -
-
Name
-
weight
-
- - - -
-
Characteristic
-
-
-
-
Measurement
-
-
-
a measurement value given in the unit kilogram
-
-
-
Unit
-
-
-
-
    -
  • - kilogram -
    • -
  • - Symbol kg -
    • -
  • - Code KGM -
    • -
-
-
-
-
- Type http://www.w3.org/2001/XMLSchema#double - -
-
-
-
-
- -
-
Example
-
100.7
-
- -
-
Optional
-
- Yes
-
- -
-
In payload
-
- Yes
-
- -
-
Payload key
-
weight
-
- - -
-
- -
-
diameter
-
- -Diameter of the item. - -
-
Name
-
diameter
-
- - - -
-
Characteristic
-
-
-
-
Measurement
-
-
-
a measurement for a lenght given in the unit millimetre
-
-
-
Unit
-
-
-
-
    -
  • - millimetre -
    • -
  • - Symbol mm -
    • -
  • - Code MMT -
    • -
  • - Conversion factor 10⁻³ m -
    • -
-
-
-
-
- Type http://www.w3.org/2001/XMLSchema#double - -
-
-
-
-
- -
-
Example
-
0.03
-
- -
-
Optional
-
- Yes
-
- -
-
In payload
-
- Yes
-
- -
-
Payload key
-
diameter
-
- - -
-
- -
-
height
-
- -Height of the item. - -
-
Name
-
height
-
- - - -
-
Characteristic
-
-
-
-
Measurement
-
-
-
a measurement for a lenght given in the unit millimetre
-
-
-
Unit
-
-
-
-
    -
  • - millimetre -
    • -
  • - Symbol mm -
    • -
  • - Code MMT -
    • -
  • - Conversion factor 10⁻³ m -
    • -
-
-
-
-
- Type http://www.w3.org/2001/XMLSchema#double - -
-
-
-
-
- -
-
Example
-
0.1
-
- -
-
Optional
-
- Yes
-
- -
-
In payload
-
- Yes
-
- -
-
Payload key
-
height
-
- - -
-
- -
-
width
-
- -Width of the item. - -
-
Name
-
width
-
- - - -
-
Characteristic
-
-
-
-
Measurement
-
-
-
a measurement for a lenght given in the unit millimetre
-
-
-
Unit
-
-
-
-
    -
  • - millimetre -
    • -
  • - Symbol mm -
    • -
  • - Code MMT -
    • -
  • - Conversion factor 10⁻³ m -
    • -
-
-
-
-
- Type http://www.w3.org/2001/XMLSchema#double - -
-
-
-
-
- -
-
Example
-
1000.0
-
- -
-
Optional
-
- Yes
-
- -
-
In payload
-
- Yes
-
- -
-
Payload key
-
width
-
- - -
-
- -
-
length
-
- -Length of the item. - -
-
Name
-
length
-
- - - -
-
Characteristic
-
-
-
-
Measurement
-
-
-
a measurement for a lenght given in the unit millimetre
-
-
-
Unit
-
-
-
-
    -
  • - millimetre -
    • -
  • - Symbol mm -
    • -
  • - Code MMT -
    • -
  • - Conversion factor 10⁻³ m -
    • -
-
-
-
-
- Type http://www.w3.org/2001/XMLSchema#double - -
-
-
-
-
- -
-
Example
-
20000.1
-
- -
-
Optional
-
- Yes
-
- -
-
In payload
-
- Yes
-
- -
-
Payload key
-
length
-
- - -
-
-
- -
- Third party licenses - -
- -
- - -
- - - \ No newline at end of file diff --git a/io.catenax.generic.digital_product_passport/1.0.0/gen/DigitalProductPassport.json b/io.catenax.generic.digital_product_passport/1.0.0/gen/DigitalProductPassport.json deleted file mode 100644 index 7222465f7..000000000 --- a/io.catenax.generic.digital_product_passport/1.0.0/gen/DigitalProductPassport.json +++ /dev/null @@ -1,179 +0,0 @@ -{ - "serialization" : { - "manufacturingInformation" : { - "date" : "2022-02-04T14:48:54", - "country" : "HUR" - }, - "registration" : { - "customerPartId" : "PRT-12345", - "manufacturerPartId" : "123-0.740-3434-A" - }, - "quantity" : { - "value" : 1.0, - "unit" : "unit:piece" - } - }, - "typology" : { - "name" : "Transmission Type 8HP60", - "description" : "Product Description long text", - "class" : { - "definition" : "Manual transmission (motor vehicle)", - "code" : "44-09-02-02" - }, - "nameAtManufacturer" : "Mirror left", - "nameAtCustomer" : "side element A" - }, - "metadata" : { - "issueDate" : "2000-01-01", - "version" : "1.0.0", - "validityDate" : "2000-01-01", - "economicOperator" : { - "eori" : "GB123456789000", - "id" : "BPNL1234567890ZZ" - }, - "status" : "Draft" - }, - "characteristics" : { - "physicalDimensionsProperty" : { - "width" : 1000.0, - "length" : 20000.1, - "weight" : 100.7, - "diameter" : 0.03, - "height" : 0.1 - }, - "lifespan" : { - "value" : 36, - "unit" : "unit:day" - } - }, - "commercial" : { - "placedOnMarket" : "2000-01-01", - "warranty" : 36 - }, - "identification" : { - "localIdentifiers" : [ { - "value" : "SN12345678", - "key" : "PartInstanceID" - } ], - "gtin" : "12345678", - "additionalCode" : [ { - "name" : "TARIC", - "value" : "8703 24 10 00" - } ] - }, - "sources" : { - "mandatory" : { - "safetyTransportation" : { - "header" : "Sustainability Document Material XY", - "category" : "Safety", - "type" : "link", - "content" : "www.alink.pdf" - }, - "substanceOfConcernDisassembly" : { - "header" : "Sustainability Document Material XY", - "category" : "Safety", - "type" : "link", - "content" : "www.alink.pdf" - }, - "substanceOfConcernInstruction" : { - "header" : "Sustainability Document Material XY", - "category" : "Safety", - "type" : "link", - "content" : "www.alink.pdf" - }, - "safetyPackaging" : { - "header" : "Sustainability Document Material XY", - "category" : "Safety", - "type" : "link", - "content" : "www.alink.pdf" - }, - "declarationOfConformity" : [ { - "name" : "other", - "document" : { - "header" : "Sustainability Document Material XY", - "category" : "Safety", - "type" : "link", - "content" : "www.alink.pdf" - } - } ] - }, - "optional" : [ { - "name" : "other", - "document" : { - "header" : "Sustainability Document Material XY", - "category" : "Safety", - "type" : "link", - "content" : "www.alink.pdf" - } - } ] - }, - "handling" : { - "maintenanceHistory" : [ { - "date" : "2000-01-01", - "description" : "Check tire pressure and rotate tires", - "title" : "Check-up", - "activity" : "Inspection" - } ], - "reusablePackaging" : true, - "spareParts" : [ { - "name" : "Aluminum Housing", - "partId" : "Aluminum Housing 952/C", - "producerId" : "BPNL1234567890ZZ" - } ], - "substanceOfConcern" : [ { - "name" : "Lead", - "location" : "Housing", - "unit" : "unit:partPerMillion", - "concentration" : { - "left" : [ 3.592682E37 ] - }, - "id" : "RC0402" - } ] - }, - "additionalData" : [ { - "description" : "Description of an attribute", - "label" : "Maximum permitted battery power", - "type" : { - "typeUnit" : "unit:volume", - "dataType" : "array" - }, - "data" : "23", - "children" : [ { - "description" : "Description of an attribute", - "label" : "Maximum permitted battery power", - "type" : { - "typeUnit" : "unit:volume", - "dataType" : "array" - }, - "data" : "23" - } ] - } ], - "sustainability" : { - "state" : "first life", - "material" : [ { - "name" : "Aluminium", - "recycled" : false, - "renewable" : true, - "percentage" : 5.0 - } ], - "critical" : [ "eOMtThyhVNLWUZNRcBaQKxI" ], - "carbonFootprint" : { - "carbonContentTotal" : 2.5, - "crossSectoralStandard" : "GHG Protocol Product standard", - "productOrSectorSpecificRules" : [ { - "extWBCSD_operator" : "PEF", - "productOrSectorSpecificRules" : { - "ruleName" : "urn:tfs-initiative.com:PCR:The Product Carbon Footprint Guideline for the Chemical Industry:version:v2.0" - }, - "extWBCSD_otherOperatorName" : "NSF" - } ] - } - }, - "operation" : { - "importer" : "BPNL1234567890ZZ", - "manufacturer" : { - "manufacturerId" : "BPN1234567890ZZ", - "facilityId" : "BPNL1234567890ZZ" - } - } -} \ No newline at end of file diff --git a/io.catenax.generic.digital_product_passport/1.0.0/gen/DigitalProductPassport.yml b/io.catenax.generic.digital_product_passport/1.0.0/gen/DigitalProductPassport.yml deleted file mode 100644 index 2d1277737..000000000 --- a/io.catenax.generic.digital_product_passport/1.0.0/gen/DigitalProductPassport.yml +++ /dev/null @@ -1,1115 +0,0 @@ ---- -openapi: 3.0.3 -info: - title: Digital Product Passport - version: v1 -servers: -- url: catenax.io/api/v1 - variables: - api-version: - default: v1 -paths: - /{tenant-id}/digital-product-passport: - get: - tags: - - DigitalProductPassport - operationId: getDigitalProductPassport - 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/DigitalProductPassport' - "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/DigitalProductPassport' - totalItems: - type: number - totalPages: - type: number - pageSize: - type: number - currentPage: - type: number - urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text: - type: string - description: "Describes a Property which contains plain text. This is intended\ - \ exclusively for human readable strings, not for identifiers, measurement\ - \ values, etc." - urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_StatusEnumeration: - type: string - description: "Enumeration with draft, approved, invalid or expired." - enum: - - Draft - - Approved - - Invalid - - Expired - urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_TimeStamp: - type: string - format: date - description: A time stamp in the format (yyyy-mm-dd) with or without time zone. - urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_CompanyIdentification: - type: string - description: Identification of the company or location of the company. In the - CATENA-X network the BPN/L identification is needed. - urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_EoriTrait: - type: string - description: "Constraint with a pattern which ensures that the EORI number starts\ - \ with two alphanumeric characters, followed by two alphabetic characters,\ - \ and ends with 2 to 15 alphanumeric characters." - pattern: "^[A-Z]{2}[A-Z0-9]{1,18}$" - urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_EconomicOperatorCharacteristic: - description: Economic operator of the passport. - type: object - properties: - id: - description: The identification of the economic operator of the passport. - $ref: '#/components/schemas/urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_CompanyIdentification' - eori: - description: "Any economic operator established in the customs territory\ - \ of the Union needs, for customs purposes, an EORI number. EORI stands\ - \ for economic operators registration and identification number." - $ref: '#/components/schemas/urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_EoriTrait' - required: - - id - urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_MetadataCharacteristic: - description: Characteristic for the passport metadata of the digital product - passport. - type: object - properties: - version: - description: The current version of the product passport. - $ref: '#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text' - status: - description: "The current status of the product passport declared through\ - \ either: draft, approved, invalid or expired." - $ref: '#/components/schemas/urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_StatusEnumeration' - validityDate: - description: The timestamp for the product passport until when it is available. - $ref: '#/components/schemas/urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_TimeStamp' - issueDate: - description: The timestamp for the product passport since when it is available. - $ref: '#/components/schemas/urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_TimeStamp' - economicOperator: - description: The economic operator of the passport. - $ref: '#/components/schemas/urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_EconomicOperatorCharacteristic' - required: - - version - - status - - validityDate - - issueDate - - economicOperator - urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_CodeTrait: - type: string - description: "Constraint to limit the input to a valid ECLASS number. The constraint\ - \ ensures that each pair of digits is followed by a hyphen, resulting in a\ - \ pattern like \"00-00-00-00\" where the zeros can be replaced by any digit." - pattern: "^\\d{2}-\\d{2}-\\d{2}-\\d{2}$" - urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_ClassCharacteristic: - description: Characteristic to describe the ECLASS typology of a product. - type: object - properties: - code: - description: The associated product category CODE according to ECLASS. - $ref: '#/components/schemas/urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_CodeTrait' - definition: - description: The associated product category NAME according to ECLASS. - $ref: '#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text' - required: - - code - - definition - urn_bamm_io.catenax.serial_part_1.0.0_PartNameCharacteristic: - type: string - description: Part Name in string format from the respective system in the value - chain - urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_TypologyCharacteristic: - description: Characteristic to further describe product. - type: object - properties: - description: - description: A general short product description. - $ref: '#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text' - class: - description: The associated product category according to ECLASS. The ECLASS - is the worldwide reference data standard for classifying and clearly describing - products and services. - $ref: '#/components/schemas/urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_ClassCharacteristic' - name: - description: The name of the product type. - $ref: '#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text' - nameAtManufacturer: - description: Name of the part as assigned by the manufacturer - $ref: '#/components/schemas/urn_bamm_io.catenax.serial_part_1.0.0_PartNameCharacteristic' - nameAtCustomer: - description: Name of the part as assigned by the customer - $ref: '#/components/schemas/urn_bamm_io.catenax.serial_part_1.0.0_PartNameCharacteristic' - required: - - name - - nameAtManufacturer - - nameAtCustomer - urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_TitleTrait: - type: string - description: A constraint that limits the title to 100 characters. - maxLength: 100 - minLength: 3 - urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_ActivityEnumeration: - type: string - description: "The activities of putting the product into service in form of\ - \ an enumeration with the values Inspection, Maintenance, Repair, Preventive\ - \ Maintenance, Accident and Other." - enum: - - Inspection - - Maintenance - - Repair - - Preventive Maintenance - - Accident - - Other - urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_MaintenanceHistoryEntity: - description: "Entity describing a list of entries of the service history with\ - \ title, text, activities and dates." - type: object - properties: - title: - description: The title of the data object with a maximum of 100 characters. - $ref: '#/components/schemas/urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_TitleTrait' - description: - description: A short description of the maintenance content. - $ref: '#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text' - date: - description: "The dates when the product was put into service, repair etc." - $ref: '#/components/schemas/urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_TimeStamp' - activity: - description: "The activities of putting the product into service in form\ - \ of an enumeration with the values Inspection, Maintenance, Repair, Preventive\ - \ Maintenance, Accident and Other." - $ref: '#/components/schemas/urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_ActivityEnumeration' - required: - - title - - description - - date - - activity - urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_MaintenanceHistoryList: - description: A list of entries of the service history. - type: array - items: - $ref: '#/components/schemas/urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_MaintenanceHistoryEntity' - urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_PartEntity: - description: "Entity with the attributes partId, producerId and partName to\ - \ describe a list of spare parts." - type: object - properties: - partId: - description: The identification of spare parts available for the product. - $ref: '#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text' - producerId: - description: The identifier of the producer. In the CATENA-X network the - BPN identification of the spare part producer is needed. - $ref: '#/components/schemas/urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_CompanyIdentification' - name: - description: The name of the spare part. - $ref: '#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text' - required: - - partId - - producerId - - name - urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_PartList: - description: The list of spare parts with different identifiers. - type: array - items: - $ref: '#/components/schemas/urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_PartEntity' - urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_ConcentrationEnumeration: - type: string - description: "Enumeration of possible units of concentration with percent, volume\ - \ percent, parts per thousand, parts per million, parts per billion and parts\ - \ per trillion." - enum: - - unit:partPerMillion - - unit:percent - - unit:percentVolume - - unit:partPerThousand - - unit:partPerTrillionUs - - unit:partPerBillionUs - urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_Either: - description: Characteristic with two possible values. - additionalProperties: false - properties: - left: - description: "Input should be two values, the highest and te lowest of the\ - \ range." - type: array - items: - type: number - right: - type: number - description: Concentration of substances of concern at the level of the - product. - oneOf: - - required: - - left - - required: - - right - urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_SubstanceEntity: - description: "Entity to describe a list of properties regarding a substance\ - \ of concern such as the substance name, location, unit and concentration." - type: object - properties: - name: - description: In accordance with the ESPR specification the name of the substances - of concern which is present in the product have to be declared. - $ref: '#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text' - location: - description: The location of the substances of concern within the product. - $ref: '#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text' - unit: - description: "Units of concentration are percent, volume percent, parts\ - \ per thousand, parts per million, parts per billion and parts per trillion." - $ref: '#/components/schemas/urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_ConcentrationEnumeration' - concentration: - description: Concentration of substances of concern at the level of the - product. - $ref: '#/components/schemas/urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_Either' - id: - description: The substance identification. - $ref: '#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text' - required: - - name - - location - - unit - - concentration - - id - urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_SubstanceList: - description: Characteristic for a list of substances of concern. - type: array - items: - $ref: '#/components/schemas/urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_SubstanceEntity' - urn_bamm_io.openmanufacturing_characteristic_2.0.0_Boolean: - type: boolean - description: Represents a boolean value (i.e. a "flag"). - urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_HandlingCharacteristic: - description: Characteristic to describe aspects which are connected with the - handling of the product. - type: object - properties: - maintenanceHistory: - description: "The maintenance history of the product with dates, titles\ - \ and descriptions." - $ref: '#/components/schemas/urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_MaintenanceHistoryList' - spareParts: - description: The list of spare parts available for the product from a supplier. - $ref: '#/components/schemas/urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_PartList' - substanceOfConcern: - description: Details to the substance of concern. - $ref: '#/components/schemas/urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_SubstanceList' - reusablePackaging: - description: Definition of whether the product uses a reuse system. The - values true or false are allowed. - $ref: '#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Boolean' - required: - - maintenanceHistory - - substanceOfConcern - urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_StateEnumeration: - type: string - description: Enumeration with the values first life and second life. - enum: - - first life - - second life - urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_Percent: - type: number - urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_MaterialEntity: - description: "Entity with properties materialName, percentage and flags for\ - \ the possibility to recycle and renew the material." - type: object - properties: - name: - description: The material name which is part of the product. - $ref: '#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text' - recycled: - description: A flag if the material is recovered recyclate content from - the product. - $ref: '#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Boolean' - renewable: - description: "Flag if the material is made of natural resources that can\ - \ be replenished. Renewable resources are those that can be reproduced\ - \ by physical, chemical, or mechanical processes. These are the kind of\ - \ resources that can be regenerated throughout time. Forest wood, for\ - \ example, can be grown through reforestation." - $ref: '#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Boolean' - percentage: - description: Percentage of the material. - $ref: '#/components/schemas/urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_Percent' - required: - - name - - recycled - - percentage - urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_MaterialList: - description: A list of different materials in the product. - type: array - items: - $ref: '#/components/schemas/urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_MaterialEntity' - urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_CriticalList: - description: The list of critical raw materials in the product (CRM) which is - specified by EU. - type: array - items: - type: string - urn_bamm_io.catenax.pcf_4.0.0_PositiveEmissionsTrait: - type: number - description: 'Only positive emission values (>0) are valid ' - minimum: 0 - exclusiveMinimum: false - urn_bamm_io.catenax.pcf_4.0.0_ProductOrSectorSpecificRuleOperator: - type: string - description: Enumeration of PCR (Product Category Rule) operators as specified - in the technical specifications for PCF Data Exchange (Version 2.0.0) from - the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. - WBCSD specific extension for example in Catena-X. - enum: - - PEF - - EPD International - - Other - urn_bamm_io.catenax.pcf_4.0.0_NonEmptyStringTrait: - type: string - description: Constraint for ensuring that a string has at least one character. - minLength: 1 - urn_bamm_io.catenax.pcf_4.0.0_RuleName: - description: Name of a rule applied by a specified operator as specified in - the Catena-X PCF Rulebook in accordance with the technical specifications - for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council - for Sustainable Development)/ PACT initiative. - type: object - properties: - ruleName: - description: Name of a rule applied by a specific operator as specified - in the Catena-X PCF Rulebook in accordance with the technical specifications - for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council - for Sustainable Development)/ PACT initiative. - $ref: '#/components/schemas/urn_bamm_io.catenax.pcf_4.0.0_NonEmptyStringTrait' - required: - - ruleName - urn_bamm_io.catenax.pcf_4.0.0_RuleNamesTrait: - description: Constraint for defining a non-empty set of rule names as specified - in the Catena-X PCF Rulebook in accordance with the technical specifications - for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council - for Sustainable Development)/ PACT initiative. - type: array - items: - $ref: '#/components/schemas/urn_bamm_io.catenax.pcf_4.0.0_RuleName' - uniqueItems: true - minItems: 1 - urn_bamm_io.catenax.pcf_4.0.0_ProductOrSectorSpecificRule: - description: Entity for defining a product or sector specific rule of a product - carbon footprint as specified in the Catena-X PCF Rulebook in accordance with - the technical specifications for PCF Data Exchange (Version 2.0.0) from the - WBCSD (World Business Council for Sustainable Development)/ PACT initiative. - type: object - properties: - extWBCSD_operator: - description: "Operator of PCR (Product Category Rule)/ PSR (Product Specific\ - \ Rule) as specified in the technical specifications for PCF Data Exchange\ - \ (Version 2.0.0) from the WBCSD (World Business Council for Sustainable\ - \ Development)/ PACT initiative. WBCSD specific extension, in Catena-X\ - \ for example must always be \"Other\"." - $ref: '#/components/schemas/urn_bamm_io.catenax.pcf_4.0.0_ProductOrSectorSpecificRuleOperator' - productOrSectorSpecificRules: - description: Product-specific or sector-specific set of rules used for calculating - or allocating GHG (Greenhouse Gas) emissions applied from the specified - operator as specified in the Catena-X PCF Rulebook in accordance with - the technical specifications for PCF Data Exchange (Version 2.0.0) from - the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. - $ref: '#/components/schemas/urn_bamm_io.catenax.pcf_4.0.0_RuleNamesTrait' - extWBCSD_otherOperatorName: - description: "Other operator of PCR (Product Category Rule)/ PSR (Product\ - \ Specific Rule) as specified in the technical specifications for PCF\ - \ Data Exchange (Version 2.0.0) from the WBCSD (World Business Council\ - \ for Sustainable Development)/ PACT initiative. WBCSD specific extension,\ - \ in Catena-X for example specified by a default value." - $ref: '#/components/schemas/urn_bamm_io.catenax.pcf_4.0.0_NonEmptyStringTrait' - required: - - extWBCSD_operator - - productOrSectorSpecificRules - urn_bamm_io.catenax.pcf_4.0.0_ProductOrSectorSpecificRuleSet: - description: Characteristic for defining the set of product or sector specific - rules of a product carbon footprint as specified in the Catena-X PCF Rulebook - in accordance with the technical specifications for PCF Data Exchange (Version - 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ - PACT initiative. - type: array - items: - $ref: '#/components/schemas/urn_bamm_io.catenax.pcf_4.0.0_ProductOrSectorSpecificRule' - uniqueItems: true - urn_bamm_io.catenax.pcf_4.0.0_CrossSectoralStandardsUsedEnumerationCharacteristic: - type: string - description: Characteristic for defining the enumeration of valid accounting - standards used for product carbon footprint calculation as specified in the - Catena-X PCF Rulebook in accordance with the technical specifications for - PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for - Sustainable Development)/ PACT initiative. - enum: - - GHG Protocol Product standard - - ISO Standard 14067 - - ISO Standard 14044 - urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_CarbonFootprintCharacteristic: - description: Carbon Footprint Characteristic with sustainability information. - type: object - properties: - carbonContentTotal: - description: Total carbon content per declared unit in context of a product - carbon footprint as specified in the Catena-X PCF Rulebook. - $ref: '#/components/schemas/urn_bamm_io.catenax.pcf_4.0.0_PositiveEmissionsTrait' - productOrSectorSpecificRules: - description: "Product or sector specific rules applied for calculating or\ - \ allocating GHG (Greenhouse Gas) emissions, e.g. PCRs (Product Category\ - \ Rules), including operators or pubishers and according rule names as\ - \ specified in the Catena-X PCF Rulebook in accordance with the technical\ - \ specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD\ - \ (World Business Council for Sustainable Development)/ PACT initiative." - $ref: '#/components/schemas/urn_bamm_io.catenax.pcf_4.0.0_ProductOrSectorSpecificRuleSet' - crossSectoralStandard: - description: Discloses a cross-sectoral standard applied for calculating - or allocating GHG (Greenhouse Gas) emissions as specified in the Catena-X - PCF Rulebook in accordance with the technical specifications for PCF Data - Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable - Development)/ PACT initiative. - $ref: '#/components/schemas/urn_bamm_io.catenax.pcf_4.0.0_CrossSectoralStandardsUsedEnumerationCharacteristic' - required: - - carbonContentTotal - - productOrSectorSpecificRules - - crossSectoralStandard - urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_SustainabilityCharacteristic: - description: Characteristic which describes relevant information for the sustainability - of the product. - type: object - properties: - state: - description: Status of the product (first life or second life). - $ref: '#/components/schemas/urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_StateEnumeration' - material: - description: Information on different materials in the product. - $ref: '#/components/schemas/urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_MaterialList' - critical: - description: The list of critical raw materials in the product (CRM) which - is specified by EU. - $ref: '#/components/schemas/urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_CriticalList' - carbonFootprint: - description: Carbon Footprint property with sustainability information. - $ref: '#/components/schemas/urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_CarbonFootprintCharacteristic' - required: - - state - - material - - critical - - carbonFootprint - urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_LifespanEnumeration: - type: string - enum: - - unit:day - - unit:month - - unit:cycle - - unit:year - - unit:kilometre - - unit:runningOrOperatingHour - urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_LifeValueCharacteristic: - type: number - urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_LifespanCharacteristic: - description: Characteristic for the expected product lifetime (lifespan). - type: object - properties: - unit: - description: The unit of the expected lifetime of a product from the unit - catalog. - $ref: '#/components/schemas/urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_LifespanEnumeration' - value: - description: The value of the expected lifetime of a product. - $ref: '#/components/schemas/urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_LifeValueCharacteristic' - required: - - unit - - value - urn_bamm_io.catenax.shared.physical_dimension_2.0.0_KilogramCharacteristic: - type: number - description: a measurement value given in the unit kilogram - urn_bamm_io.catenax.shared.physical_dimension_2.0.0_MillimetreCharacteristic: - type: number - description: a measurement for a lenght given in the unit millimetre - urn_bamm_io.catenax.shared.physical_dimension_2.0.0_PhysicalDimensionsCharacteristic: - description: Describes the physical dimensions of then entity. - type: object - properties: - weight: - description: Weight of the item - $ref: '#/components/schemas/urn_bamm_io.catenax.shared.physical_dimension_2.0.0_KilogramCharacteristic' - diameter: - description: Diameter of the item. - $ref: '#/components/schemas/urn_bamm_io.catenax.shared.physical_dimension_2.0.0_MillimetreCharacteristic' - height: - description: Height of the item. - $ref: '#/components/schemas/urn_bamm_io.catenax.shared.physical_dimension_2.0.0_MillimetreCharacteristic' - width: - description: Width of the item. - $ref: '#/components/schemas/urn_bamm_io.catenax.shared.physical_dimension_2.0.0_MillimetreCharacteristic' - length: - description: Length of the item. - $ref: '#/components/schemas/urn_bamm_io.catenax.shared.physical_dimension_2.0.0_MillimetreCharacteristic' - urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_Characteristics: - description: Defines a set of specific characteristics of a product. - type: object - properties: - lifespan: - description: The expected product lifetime (lifespan). - $ref: '#/components/schemas/urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_LifespanCharacteristic' - physicalDimensionsProperty: - description: Describes the physical dimensions of then entity. - $ref: '#/components/schemas/urn_bamm_io.catenax.shared.physical_dimension_2.0.0_PhysicalDimensionsCharacteristic' - required: - - lifespan - urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_WarrantyCharacteristic: - type: number - urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_CommercialCharacteristic: - description: Commercial information of the product. - type: object - properties: - placedOnMarket: - description: Date on when the product is put in the market. - $ref: '#/components/schemas/urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_TimeStamp' - warranty: - description: "Commercial warranty period of the product (coupled to the\ - \ Vehicle) in months. Durability and reliability of the product or its\ - \ components as expressed through the product’s guaranteed lifetime, technical\ - \ lifetime, mean time between failures, indication of real use information\ - \ on the product, resistance to stresses or aging mechanisms." - $ref: '#/components/schemas/urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_WarrantyCharacteristic' - required: - - warranty - urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_ManufacturerCharacteristic: - description: Manufacturing information. - type: object - properties: - facilityId: - description: "The facility Identification, where the main manufacturing\ - \ took place." - $ref: '#/components/schemas/urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_CompanyIdentification' - manufacturerId: - description: "The main manufacturer, if different from the passport owner." - $ref: '#/components/schemas/urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_CompanyIdentification' - required: - - facilityId - urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_OperationCharacteristic: - description: Operational information of the product. - type: object - properties: - importer: - description: "The importer of the product, if different from the owner of\ - \ the passport." - $ref: '#/components/schemas/urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_CompanyIdentification' - manufacturer: - description: Manufacturing identification of the product. - $ref: '#/components/schemas/urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_ManufacturerCharacteristic' - required: - - importer - - manufacturer - urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_GtinTrait: - type: string - description: This pattern allows for matching any GTIN version by specifying - the required number of digits for each version. - pattern: "^(?:\\d{8}|\\d{12}|\\d{13}|\\d{14})$" - urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_CodeEntity: - description: Code entity with code name and value. - type: object - properties: - name: - description: Title of the code. - $ref: '#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text' - value: - description: The code value of the specific code. - $ref: '#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text' - required: - - name - - value - urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_CodeList: - description: A list of additional codes. - type: array - items: - $ref: '#/components/schemas/urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_CodeEntity' - urn_bamm_io.catenax.serial_part_1.0.0_KeyCharacteristic: - type: string - description: |- - The key characteristic of a local identifier. A specific subset of keys is predefined, but additionally any other custom key is allowed. Predefined keys (to be used when applicable): - - "manufacturerId" - The Business Partner Number (BPN) of the manufacturer. Value: BPN-Nummer - - "partInstanceId" - The identifier of the manufacturer for the serialized instance of the part, e.g. the serial number - - "batchId" - The identifier of the batch, to which the serialzed part belongs - - "van" - The anonymized vehicle identification number (VIN). Value: anonymized VIN according to OEM anonymization rules. Note: If the key "van" is available, "partInstanceId" must also be available and hold the identical value. - urn_bamm_io.catenax.serial_part_1.0.0_ValueCharacteristic: - type: string - description: The value of an identifier. - urn_bamm_io.catenax.serial_part_1.0.0_KeyValueList: - description: "A list of key value pairs for local identifiers, which are composed\ - \ of a key and a corresponding value." - type: object - properties: - key: - description: 'The key of a local identifier. ' - $ref: '#/components/schemas/urn_bamm_io.catenax.serial_part_1.0.0_KeyCharacteristic' - value: - description: The value of an identifier. - $ref: '#/components/schemas/urn_bamm_io.catenax.serial_part_1.0.0_ValueCharacteristic' - required: - - key - - value - urn_bamm_io.catenax.serial_part_1.0.0_LocalIdentifierCharacteristic: - description: "A single serialized part may have multiple attributes, that uniquely\ - \ identify a that part in a specific dataspace (e.g. the manufacturer`s dataspace)" - type: array - items: - $ref: '#/components/schemas/urn_bamm_io.catenax.serial_part_1.0.0_KeyValueList' - uniqueItems: true - urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_IdentificationCharacteristic: - description: Identification information of the product. - type: object - properties: - gtin: - description: "GTIN stands for Global Trade Item Number. It is a unique and\ - \ internationally recognized identifier used to identify products in the\ - \ global marketplace. GTINs are typically encoded in barcodes and are\ - \ used by retailers, manufacturers, and suppliers to track and manage\ - \ their products throughout the supply chain. Valid inputs are all GTIN\ - \ versions (GTIN-8, GTIN-12, GTIN-13, and GTIN-14)." - $ref: '#/components/schemas/urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_GtinTrait' - additionalCode: - description: "Codes for identification can be for example commodity codes.\ - \ In Europe, two commonly used codes for goods classification are the\ - \ Harmonized System (HS) code and the Combined Nomenclature (CN). Other\ - \ codes can also be given." - $ref: '#/components/schemas/urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_CodeList' - localIdentifiers: - description: "A local identifier enables identification of a part in a specific\ - \ dataspace, but is not unique in Catena-X dataspace. Multiple local identifiers\ - \ may exist." - $ref: '#/components/schemas/urn_bamm_io.catenax.serial_part_1.0.0_LocalIdentifierCharacteristic' - required: - - localIdentifiers - urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_QuantityEnumeration: - type: string - description: Enumeration of possible quantities in a batch. - enum: - - unit:piece - - unit:gram - - unit:kilogram - - unit:metre - - unit:litre - - unit:cubicMetre - - unit:squareMetre - urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_QuantityValueCharacteristic: - type: number - description: The value of the quantity. - urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_QuantityCharacteristic: - description: Quantity of the product. - type: object - properties: - unit: - description: "Quantity refers to the number of units or items of a product\ - \ being bought, sold, manufactured, or stored as a batch.If the product\ - \ is a single item choose the unit \"unit:piece\". All possible units\ - \ are pieces, gram, kilogram, millilitres, litres, cubic meters, meters\ - \ or square meters." - $ref: '#/components/schemas/urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_QuantityEnumeration' - value: - description: "Quantity refers to the number of units or items of a product\ - \ being bought, sold, manufactured, or stored. If the product is not a\ - \ batch, choose the unit piece and value 1.0." - $ref: '#/components/schemas/urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_QuantityValueCharacteristic' - required: - - unit - - value - urn_bamm_io.catenax.serial_part_1.0.0_PartIdCharacteristic: - type: string - description: "The part ID is a multi-character string, ususally assigned by\ - \ an ERP system" - urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_RegistrationCharacteristic: - description: Characteristic for registration information such as the identification - at the customer and the manufacturer. - type: object - properties: - customerPartId: - description: Part ID as assigned by the manufacturer of the part. The Part - ID identifies the part (as designed) in the customer`s dataspace. The - Part ID does not reference a specific instance of a part and thus should - not be confused with the serial number. - $ref: '#/components/schemas/urn_bamm_io.catenax.serial_part_1.0.0_PartIdCharacteristic' - manufacturerPartId: - description: Part ID as assigned by the manufacturer of the part. The Part - ID identifies the part (as designed) in the manufacturer`s dataspace. - The Part ID does not reference a specific instance of a part and thus - should not be confused with the serial number. - $ref: '#/components/schemas/urn_bamm_io.catenax.serial_part_1.0.0_PartIdCharacteristic' - required: - - customerPartId - - manufacturerPartId - urn_bamm_io.openmanufacturing_characteristic_2.0.0_Timestamp: - type: string - pattern: "-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T(([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](\\\ - .[0-9]+)?|(24:00:00(\\.0+)?))(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?" - description: Describes a Property which contains the date and time with an optional - timezone. - urn_bamm_io.catenax.serial_part_1.0.0_ProductionCountryCodeTrait: - type: string - description: 'Regular Expression that ensures a three-letter code ' - pattern: "^[A-Z][A-Z][A-Z]$" - urn_bamm_io.catenax.serial_part_1.0.0_ManufacturingCharacteristic: - description: Characteristic to describe manufacturing related data - type: object - properties: - date: - description: "Timestamp of the manufacturing date as the final step in production\ - \ process (e.g. final quality check, ready-for-shipment event)" - $ref: '#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Timestamp' - country: - description: Country code where the part was manufactured - $ref: '#/components/schemas/urn_bamm_io.catenax.serial_part_1.0.0_ProductionCountryCodeTrait' - required: - - date - urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_SerializationCharacteristic: - description: Characteristic for serialization information. - type: object - properties: - quantity: - description: "Quantity refers to the number of units or items of a product\ - \ being bought, sold, manufactured, or stored. It is an important factor\ - \ in inventory management, supply chain logistics, and pricing calculations." - $ref: '#/components/schemas/urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_QuantityCharacteristic' - registration: - description: Registration information such as the identification at the - customer and the manufacturer. - $ref: '#/components/schemas/urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_RegistrationCharacteristic' - manufacturingInformation: - description: "Information from manufacturing process, such as manufacturing\ - \ date and manufacturing country" - $ref: '#/components/schemas/urn_bamm_io.catenax.serial_part_1.0.0_ManufacturingCharacteristic' - required: - - quantity - - registration - - manufacturingInformation - urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_SourceNameEnumeration: - type: string - description: Enumeration of different source names. - enum: - - other - - tool and process - - assembly and disassembly - - repair and installation - - user manual - - end of life - - return and disposal - - expected waste generation - - product packaging - - positioning - - waste prevention - - sustainability - urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_CategoryEnumeration: - type: string - enum: - - Safety - - Sustainability - - Compliance - - Passport - - SubstanceOfConcern - urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_DocumentCharacteristic: - description: Characteristic for different documents. - type: object - properties: - content: - description: The content of the document e.g a link. - $ref: '#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text' - category: - description: The category in which the document can be sorted. - $ref: '#/components/schemas/urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_CategoryEnumeration' - type: - description: "The type of content which can be expected in the \"content\"\ - \ property. Examples are a link, pdf, excel, etc." - $ref: '#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text' - header: - description: The header as a short description of the document with a maximum - of 100 characters. - $ref: '#/components/schemas/urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_TitleTrait' - required: - - content - - category - - type - - header - urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_SourceEntity: - description: Entity for document sources of a product. - type: object - properties: - name: - description: The source name as an enumeration. - $ref: '#/components/schemas/urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_SourceNameEnumeration' - document: - description: Property for the document. - $ref: '#/components/schemas/urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_DocumentCharacteristic' - required: - - name - - document - urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_SourceListCharacteristic: - description: A list of documents. - type: array - items: - $ref: '#/components/schemas/urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_SourceEntity' - urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_MandatorySourcesCharacteristic: - description: Characteristic for the different mandatory sources. - type: object - properties: - safetyPackaging: - description: Document regarding the packaging of the product. - $ref: '#/components/schemas/urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_DocumentCharacteristic' - safetyTransportation: - description: Document regarding the safe transportation of the product. - $ref: '#/components/schemas/urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_DocumentCharacteristic' - substanceOfConcernDisassembly: - description: Document regarding the disassembly processes for the substances - of concern. - $ref: '#/components/schemas/urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_DocumentCharacteristic' - declarationOfConformity: - description: "Compliance documentation and information required under this\ - \ Regulation or other Union law applicable to the product, such as the\ - \ declaration of conformity, technical documentation or conformity certificates." - $ref: '#/components/schemas/urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_SourceListCharacteristic' - substanceOfConcernInstruction: - description: Instructions regarding the substances of concern. - $ref: '#/components/schemas/urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_DocumentCharacteristic' - required: - - safetyPackaging - - safetyTransportation - - substanceOfConcernDisassembly - - declarationOfConformity - - substanceOfConcernInstruction - urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_SourcesCharacteristic: - description: The sources of the product. - type: object - properties: - optional: - description: "Optional sources for the product. Optional sources can be\ - \ a document regarding tool and process, assembly and disassembly, repair\ - \ and installation, user manual, End of Life, return and disposal, expected\ - \ waste generation, product packaging, positioning, waste prevention or\ - \ sustainability information." - $ref: '#/components/schemas/urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_SourceListCharacteristic' - mandatory: - description: Mandatory document and sources of the product. - $ref: '#/components/schemas/urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_MandatorySourcesCharacteristic' - required: - - mandatory - urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_UnitCatalog: - type: string - description: Link to the unit catalog with all possible units in the format - "unit:xxx". - urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_DataTypeEnumeration: - type: string - description: "Data type that describe the content of the attributes children\ - \ and data. In case \"object\" is selected in the enumeration, the children\ - \ field will be used in the AdditionalDataEntity instead of the \"data\" property.\ - \ If it is an other type, the content will be specified in \"data\" as a string." - enum: - - array - - object - - xsd:string - - xsd:integer - - xsd:boolean - - xsd:double - - xsd:float - - xsd:byte - urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_TypeCharacteristic: - description: Characteristic for the data type. - type: object - properties: - typeUnit: - description: "Choose a unit type from the unit catalog, or if the property\ - \ \"children\" is filled, leave empty." - $ref: '#/components/schemas/urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_UnitCatalog' - dataType: - description: "Data type that describe the content of the attributes children\ - \ and data. In case \"object\" is selected in the enumeration, the children\ - \ field will be used in the AdditionalDataEntity instead of the \"data\"\ - \ property. If it is an other type, the content will be specified in \"\ - data\" as a string." - $ref: '#/components/schemas/urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_DataTypeEnumeration' - required: - - dataType - urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_AdditionalDataEntity: - description: "Entity with additional data. Properties are label, description,\ - \ type, data and children. Either the fields data or children filled. Children\ - \ constructs a hierarchy with the same attributes. Data is filled as the end\ - \ of an path/leaf." - type: object - properties: - label: - description: The human readable name of the attribute. - $ref: '#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text' - description: - description: The description of the attribute context. - $ref: '#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text' - type: - description: The complex description of the type. - $ref: '#/components/schemas/urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_TypeCharacteristic' - data: - description: The content from the attribute which is a depended of the data - type and typeUnit. - $ref: '#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text' - children: - description: Children of the hierarchy. - $ref: '#/components/schemas/urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_AdditionalDataList' - required: - - label - - description - - type - urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_AdditionalDataList: - description: List of additional data. - type: array - items: - $ref: '#/components/schemas/urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_AdditionalDataEntity' - DigitalProductPassport: - description: "The Digital Product Passport is a data record that summarizes\ - \ the components, materials and chemical substances or information on repairability,\ - \ spare parts or professional disposal for a product. The data comes from\ - \ all phases of the product life cycle and can be used for various purposes\ - \ in all these phases (design, production, use, disposal). Structuring environmental\ - \ data in a standardized, comparable format enables all actors in the value\ - \ and supply chain to work together towards a circular economy. This data\ - \ model is based on the new proposed Ecodesign Regulation (ESPR-2022) and\ - \ is continuously adapted to the basic conditions over time." - type: object - properties: - metadata: - description: The passport metadata of the digital product passport such - as status and validity. - $ref: '#/components/schemas/urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_MetadataCharacteristic' - typology: - description: Properties further describing the product type. - $ref: '#/components/schemas/urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_TypologyCharacteristic' - handling: - description: Properties connected with the handling of the product. - $ref: '#/components/schemas/urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_HandlingCharacteristic' - sustainability: - description: Properties which are relevant for the sustainability of the - product. - $ref: '#/components/schemas/urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_SustainabilityCharacteristic' - characteristics: - description: Defines specific characteristics of a product. - $ref: '#/components/schemas/urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_Characteristics' - commercial: - description: Commercial information of the product. - $ref: '#/components/schemas/urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_CommercialCharacteristic' - operation: - description: Operational information of the product. - $ref: '#/components/schemas/urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_OperationCharacteristic' - identification: - description: "Identification information of the product, especially identifiers\ - \ and codes." - $ref: '#/components/schemas/urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_IdentificationCharacteristic' - serialization: - description: Serialization information on the product. - $ref: '#/components/schemas/urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_SerializationCharacteristic' - sources: - description: Different sources in relation to the product. - $ref: '#/components/schemas/urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_SourcesCharacteristic' - additionalData: - description: Data in form of open fields which need to be transferred in - addition. - $ref: '#/components/schemas/urn_bamm_io.catenax.generic.digital_product_passport_1.0.0_AdditionalDataList' - required: - - metadata - - typology - - handling - - sustainability - - characteristics - - commercial - - operation - - identification - - serialization - - sources - 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' - DigitalProductPassport: - content: - application/json: - schema: - $ref: '#/components/schemas/PagingSchema' - description: The request was successful. - requestBodies: - DigitalProductPassport: - content: - application/json: - schema: - $ref: '#/components/schemas/DigitalProductPassport' diff --git a/io.catenax.generic.digital_product_passport/1.0.0/metadata.json b/io.catenax.generic.digital_product_passport/1.0.0/metadata.json deleted file mode 100644 index 9e759dfb1..000000000 --- a/io.catenax.generic.digital_product_passport/1.0.0/metadata.json +++ /dev/null @@ -1 +0,0 @@ -{ "status" : "deprecate"} diff --git a/io.catenax.generic.digital_product_passport/5.0.0/DigitalProductPassport.ttl b/io.catenax.generic.digital_product_passport/5.0.0/DigitalProductPassport.ttl new file mode 100644 index 000000000..f4b61897a --- /dev/null +++ b/io.catenax.generic.digital_product_passport/5.0.0/DigitalProductPassport.ttl @@ -0,0 +1,1175 @@ +####################################################################### +# Copyright (c) 2023-2024 BASF Coatings GmbH +# Copyright (c) 2023-2024 BMW AG +# Copyright (c) 2023-2024 CGI Deutschland B.V. & Co. KG +# Copyright (c) 2023-2024 Henkel AG & Co. KGaA +# Copyright (c) 2023-2024 SAP Deutschland SE & Co.KG +# Copyright (c) 2023-2024 T-Systems International GmbH +# Copyright (c) 2023-2024 ZF Friedrichshafen AG +# Copyright (c) 2023-2024 Contributors to the Eclipse Foundation +# +# 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-batch: . +@prefix ext-classification: . +@prefix ext-information: . +@prefix ext-number: . +@prefix ext-part: . +@prefix ext-quantity: . +@prefix ext-uuid: . + +:DigitalProductPassport a samm:Aspect ; + samm:preferredName "Digital Product Passport"@en ; + samm:description "The Digital Product Passport (DPP) allows to share process and product-related information amongst supply chain businesses, authorities and consumers. The DPP allows for efficient information flows following best practices; and the possibility of accompanying the measures under this Regulation with mitigating measures so that impacts are expected to remain proportionate for SMEs.This is expected to increase transparency, both for supply chain businesses and for the general public, and increase efficiencies in terms of information transfer to support the data exchange between economic actors in integrating circularity in product design and manufacturing.\nIn particular, it is likely to help facilitate and streamline the monitoring and enforcement of the regulation carried out by EU and Member State authorities. It is also likely to provide a market-intelligence tool that may be used for revising and refining obligations in the future.\nThe DPP includes data about components, materials and chemical substances, information on reparability, spare parts, environmental impact and professional disposal for a product.\nThe data model will be updated, as newer versions of the regulation will be published.\nThe main basis is provided by the document \"Proposal for a REGULATION OF THE EUROPEAN PARLIAMENT AND OF THE COUNCIL establishing a framework for setting ecodesign requirements for sustainable products and repealing Directive 2009/125/EC\" from March 30th, 2022. The latest version of the document was the provisional agreement between the EU Council and the Parliament from January 9th, 2024. The text is informal, but the content of the final regulation was agreed between these two institutions.\nThe Title of Ecodesign Regulation has been changed to: Proposal for a REGULATION OF THE EUROPEAN PARLIAMENT AND OF THE COUNCIL establishing a framework for setting ecodesign requirements for sustainable products, amending Regulation (EU) 2023/1542 and repealing Directive 2009/125/EC."@en ; + samm:see ; + samm:see ; + samm:see ; + samm:see ; + samm:properties ( :metadata :identification :operation :handling :characteristics :commercial :materials :sustainability :sources [ samm:property :additionalData; samm:optional true ] ) ; + samm:operations ( ) ; + samm:events ( ) . + +:metadata a samm:Property ; + samm:preferredName "Metadata"@en ; + samm:description "Metadata of the product passport. These are mentioned in the ESPR proposal from March 30th, 2022 and some changed by the provisional agreement from January 9th, 2024."@en ; + samm:characteristic :MetadataCharacteristic . + +:identification a samm:Property ; + samm:preferredName "Identification"@en ; + samm:description "Identification information of the product, especially identifiers and codes. These are mentioned in the ESPR provisional agreement from January 9th, 2024 ANNEX III:\n(b) the unique product identifier at the level indicated in the applicable delegated act adopted pursuant to Article 4.\nAdditionally in Article 9 regarding general requirements for the product passport is stated that:\nA product passport shall meet the following conditions:\n(a) it shall be connected through a data carrier to a persistent unique product identifier;\n(e) the information included in the product passport shall refer to the product model, batch, or item as specified in the delegated act adopted pursuant to Article 4.\nArticle 2 Definitions: \n(31) 'unique product identifier' means a unique string of characters for the identification of products that also enables a web link to the product passport;\nRecital (27): A 'model' usually means a version of a product of which all units share the same technical characteristics relevant for the ecodesign requirements and the same model identifier, a 'batch' usually means a subset of a specific model composed of all products produced in a specific manufacturing plant at a specific moment in time and an 'item' usually means a single unit of a model."@en ; + samm:characteristic :IdentificationCharacteristic . + +:operation a samm:Property ; + samm:preferredName "Operation"@en ; + samm:description "Operational information of the product."@en ; + samm:characteristic :OperationCharacteristic . + +:handling a samm:Property ; + samm:preferredName "handling"@en ; + samm:description "Properties connected with the handling of the product."@en ; + samm:characteristic :HandlingCharacteristic . + +:characteristics a samm:Property ; + samm:preferredName "Characteristics"@en ; + samm:description "Defines specific characteristics of a product."@en ; + samm:characteristic :ProductCharacteristics . + +:commercial a samm:Property ; + samm:preferredName "Commercial"@en ; + samm:description "Commercial information of the product."@en ; + samm:characteristic :CommercialCharacteristic . + +:materials a samm:Property ; + samm:preferredName "Materials"@en ; + samm:description "Properties which are relevant for the materials of the product."@en ; + samm:characteristic :MaterialsCharacteristic . + +:sustainability a samm:Property ; + samm:preferredName "Sustainability"@en ; + samm:description "Sustainability related attributes."@en ; + samm:characteristic :SustainabilityCharacteristic . + +:sources a samm:Property ; + samm:preferredName "Sources"@en ; + samm:description "Documents that are mandatory if applicable for the product. These are mentioned in the ESPR provisional agreement from January 9th, 2024 ANNEX III:\n(e) compliance documentation and information required under this Regulation or other Union law applicable to the product, such as the declaration of conformity, technical documentation or conformity certificates;\n(f) user manuals, instructions, warnings or safety information, as required by other Union legislation applicable to the product.\nAdditionally requirements are mentioned in Article 21:\n7. Manufacturers shall ensure that a product covered by a delegated act adopted pursuant to Article 4 is accompanied by instructions in digital format that enable customers and other relevant actors to assemble, install, operate, store, maintain, repair and dispose of the product in a language that can be easily understood, as determined by the Member State concerned. Such instructions shall be clear, understandable and legible and include at least the information set out in Article 7(2), point (b), point (ii) specified in the delegated acts adopted pursuant to Article 4.\nArticle 7 states additionally:\n(ii) information for customers and other actors on how to install, use, maintain and repair the product, in order to minimise its impact on the environment and to ensure optimum durability, on how to install third-party operating systems where relevant, as well as on collection for refurbishment or remanufacture, and on how to return or handle the product at the end of its life;\n(2) (b) (iii) information for treatment facilities on disassembly, reuse, refurbishment, recycling, or disposal at end-of-life;\n(2) (b) (iv) other information that may influence sustainable product choices for customers and the way the product is handled by parties other than the manufacturer in order to facilitate appropriate use, value retaining operations and correct treatment at end-of-life.\n(5) (d) relevant instructions for the safe use of the product.\n(5) (e) information relevant for disassembly, preparation for reuse, reuse, recycling and the environmentally sound management of the product at the end of its life.\nAnnex I:\n(b) [...] availability of repair and maintenance instructions, number of materials and components used, use of standard components,[...] number and complexity of processes and whether specialised toolsare needed, ease of non-destructive disassembly and re-assembly, conditions for access to product data, conditions for access to or use of hardware and software needed;\n(c) ease of upgrading, re-use, remanufacturing and refurbishment as expressed through: [...] number and complexity of processes and tools needed, ease of non-destructive disassembly and re-assembly, conditions for access to product data, conditions for access to or use of hardware and software needed, conditions of access to test protocols or not commonly available testing equipment, availability of guarantees specific to remanufactured or refurbished products, conditions for access to or use of technologies protected by intellectual property rights, modularity;\n(d) design for recycling, ease and quality of recycling as expressed through: use of easily recyclable materials, safe, easy and non-destructive access to recyclable components and materials or components and materials containing hazardous substances and material composition and homogeneity, possibility for high-purity sorting, [...] number and complexity of processes and tools needed, ease of nondestructive disassembly and re-assembly, conditions for access to product data, conditions for access to or use of hardware and software needed;\n(q) functional performance and conditions for use including as expressed through ability in performing its intended use, precautions of use, skills required, compatibility with other products or systems.\nAdditionally to consider are guidelines and instructions regarding the proper management and disposal of packaging materials after use. This can include instructions for separation, reuse, and recycling."@en ; + samm:characteristic :SourceList . + +:additionalData a samm:Property ; + samm:preferredName "Additional Data"@en ; + samm:description "Data in form of open fields which need to be transferred in addition. The regulation is still under development and may change in the future. To accommodate this, additional data allows the option to include additional data required by future changes to the regulation. In addition, the DPP can be easily updated and adapted to the new requirements. \nThe ESPR provisional agreement from January 9th, 2024 Article 9 mentions:\n2. Where other Union legislation requires or allows the inclusion of specific information in the product passport, that information may be included in the product passport pursuant to the applicable delegated act adopted pursuant to Article 4."@en ; + samm:characteristic :AdditionalDataList . + +:MetadataCharacteristic a samm:Characteristic ; + samm:preferredName "Metadata Characteristic"@en ; + samm:description "Characteristic for the passport metadata of the digital product passport."@en ; + samm:dataType :MetadataEntity . + +:IdentificationCharacteristic a samm:Characteristic ; + samm:preferredName "Identification Characteristic"@en ; + samm:description "Identification information of the product."@en ; + samm:dataType :IdentificationEntity . + +:OperationCharacteristic a samm:Characteristic ; + samm:preferredName "Operation Characteristic"@en ; + samm:description "Operational information of the product."@en ; + samm:dataType :OperationEntity . + +:HandlingCharacteristic a samm:Characteristic ; + samm:preferredName "Handling Characteristic"@en ; + samm:description "Characteristic to describe aspects which are connected with the handling of the product."@en ; + samm:dataType :HandlingEntity . + +:ProductCharacteristics a samm:Characteristic ; + samm:preferredName "Product Characteristics"@en ; + samm:description "Defines a set of specific characteristics of a product."@en ; + samm:dataType :CharacteristicsEntity . + +:CommercialCharacteristic a samm:Characteristic ; + samm:preferredName "Commercial Characteristic"@en ; + samm:description "Commercial information of the product."@en ; + samm:dataType :CommercialEntity . + +:MaterialsCharacteristic a samm:Characteristic ; + samm:preferredName "Materials Characteristic"@en ; + samm:description "Materials Characteristic on product level."@en ; + samm:dataType :MaterialsEntity . + +:SustainabilityCharacteristic a samm:Characteristic ; + samm:preferredName "Sustainability Characteristic"@en ; + samm:description "Characteristic which describes relevant information for the sustainability of the product."@en ; + samm:dataType :SustainabilityEntity . + +:SourceList a samm-c:List ; + samm:preferredName "Source List"@en ; + samm:description "A list of documents."@en ; + samm:dataType :DocumentEntity . + +:AdditionalDataList a samm-c:List ; + samm:preferredName "Additional Data List"@en ; + samm:description "List of additional data."@en ; + samm:dataType :AdditionalDataEntity . + +:MetadataEntity a samm:Entity ; + samm:preferredName "Metadata Entity"@en ; + samm:description "Passport Entity to describe version, status, end and issue date."@en ; + samm:properties ( :version [ samm:property :status; samm:optional true ] :expirationDate :issueDate :economicOperatorId :passportIdentifier :predecessor :backupReference [ samm:property :registrationIdentifier; samm:optional true ] [ samm:property :lastModification; samm:optional true ] ) . + +:IdentificationEntity a samm:Entity ; + samm:preferredName "Identification Entity"@en ; + samm:description "Entity with identification information of the product with part type information, local identifiers, other codes and the data carrier."@en ; + samm:properties ( [ samm:property :serialInformation; samm:optional true; samm:payloadName "serial" ] [ samm:property :batchInformation; samm:optional true; samm:payloadName "batch" ] [ samm:property :partTypeInformation; samm:payloadName "type" ] :codes :dataCarrier [ samm:property ext-classification:partClassification; samm:payloadName "classification" ] ) . + +:OperationEntity a samm:Entity ; + samm:preferredName "Operation Entity"@en ; + samm:description "Operational information of the product such as the owner, manufacturer and importer."@en ; + samm:properties ( :manufacturer :import [ samm:property :otherOperators; samm:optional true; samm:payloadName "other" ] ) . + +:HandlingEntity a samm:Entity ; + samm:preferredName "Handling Entity"@en ; + samm:description "Entity to describe different aspects in relation with the handling of the product with attributes if applicable to the product."@en ; + samm:properties ( [ samm:property :spareParts; samm:payloadName "content" ] :applicable ) . + +:CharacteristicsEntity a samm:Entity ; + samm:preferredName "Characteristics Entity"@en ; + samm:description "Entity which defines specific characteristics of a product such as different life spans and physical dimensions."@en ; + samm:properties ( :lifespan :physicalDimension [ samm:property :physicalState; samm:optional true ] [ samm:property :generalPerformanceClass; samm:optional true ] ) . + +:CommercialEntity a samm:Entity ; + samm:preferredName "Commercial Entity"@en ; + samm:description "Commercial information."@en ; + samm:properties ( [ samm:property :placedOnMarket; samm:optional true ] :purpose ) . + +:MaterialsEntity a samm:Entity ; + samm:preferredName "Materials Entity"@en ; + samm:description "Entity with materials on the level of the product."@en ; + samm:properties ( :substancesOfConcern :materialComposition ) . + +:SustainabilityEntity a samm:Entity ; + samm:preferredName "Sustainability Entity"@en ; + samm:description "Entity with the properties regarding the sustainability of the product."@en ; + samm:properties ( [ samm:property :state; samm:payloadName "status" ] :productFootprint [ samm:property :reparabilityScore; samm:optional true ] [ samm:property :durabilityScore; samm:optional true ] ) . + +:DocumentEntity a samm:Entity ; + samm:preferredName "Document Entity"@en ; + samm:description "Document entity with header, content, category and type."@en ; + samm:properties ( :content :category [ samm:property :contentType; samm:payloadName "type" ] :header ) . + +:AdditionalDataEntity a samm:Entity ; + samm:preferredName "Additional Data Entity"@en ; + samm:description "Entity with additional data. Properties are label, description, type, data and children. Either the fields data or children filled. Children constructs a hierarchy with the same attributes. Data is filled as the end of an path/leaf."@en ; + samm:properties ( :label :description :type [ samm:property :data; samm:optional true ] [ samm:property :children; samm:optional true ] ) . + +:version a samm:Property ; + samm:preferredName "Version"@en ; + samm:description "The current version of the product passport. The possibility of modification/ updating the product passport needs to include versioning of the dataset. This attribute is an internal versioning from the passport issuer. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Article 8:\n(1) [...] The information in the product passport shall be accurate, complete, and up to date."@en ; + samm:characteristic samm-c:Text ; + samm:exampleValue "1.0.0" . + +:status a samm:Property ; + samm:preferredName "Status"@en ; + samm:description "The current status of the product passport declared through either: draft, approved, invalid or expired."@en ; + samm:characteristic :StatusEnumeration ; + samm:exampleValue "draft" . + +:expirationDate a samm:Property ; + samm:preferredName "Expiration Date"@en ; + samm:description "The timestamp in the format (yyyy-mm-dd) for the product passport until when it is available or a comment describing this period. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Article 8:\n(2) (h) the period during which the product passport is to remain available, which shall correspond to at least the expected lifetime of a specific product."@en ; + samm:characteristic :DateTrait ; + samm:exampleValue "2030-01-01" . + +:issueDate a samm:Property ; + samm:preferredName "Issue Date"@en ; + samm:description "The timestamp in the format (yyyy-mm-dd) since when the product passport is available."@en ; + samm:characteristic :DateTrait ; + samm:exampleValue "2000-01-01" . + +:economicOperatorId a samm:Property ; + samm:preferredName "Economic Operator Id"@en ; + samm:description "The identification of the owner/economic operator of the passport. Proposed, according to ISO 15459, is the CIN (company identification code). Other identification numbers like the tax identification number, value added tax identification number, commercial register number and the like are also valid entries. In the Catena-X network, the BPNL is used for the identification of companies and the information stored like contact information and addresses. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Annex III:\n(k) the [...] unique operator identifier code of the economic operator established in the Union responsible for carrying out the tasks set out in Article 4 of Regulation (EU) 2019/1020, or Article 15 of Regulation (EU) on general product safety, or similar tasks pursuant to other EU legislation applicable to the product."@en ; + samm:characteristic ext-number:BpnlTrait ; + samm:exampleValue "BPNL0123456789ZZ" . + +:passportIdentifier a samm:Property ; + samm:preferredName "Passport Identifier"@en ; + samm:description "The identifier of the product passport, which is an uuidv4."@en ; + samm:characteristic ext-uuid:UuidV4Trait ; + samm:exampleValue "urn:uuid:550e8400-e29b-41d4-a716-446655440000" . + +:predecessor a samm:Property ; + samm:preferredName "Predecessor"@en ; + samm:description "Identification of the preceding product passport. If there is no preceding passport, input a dummy value. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Article 8:\n(2)(g) [...] Any new product passport shall be linked to the product passport or passports of the original product whenever appropriate."@en ; + samm:characteristic ext-uuid:UuidV4Trait ; + samm:exampleValue "urn:uuid:00000000-0000-0000-0000-000000000000" . + +:backupReference a samm:Property ; + samm:preferredName "Backup Reference"@en ; + samm:description "A reference to the data backup of the passport. This mandatory attribute will be further defined in the future. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex III:\n(kb) the reference of the certified independent third-party product passport service provider hosting the back-up copy of the product passport.\nArticle 10 also mentions:\n(c) the data included in the product passport shall be stored by the economic operator responsible for its creation or by certified independent third-party product passport service providers authorised to act on their behalf."@en ; + samm:characteristic samm-c:Text ; + samm:exampleValue "https://dummy.link" . + +:registrationIdentifier a samm:Property ; + samm:preferredName "Registration Identifier"@en ; + samm:description "Identifier in the respective registry. This will be further defined in the future. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 in Article 12:\nBy [2 years from entering into force of this Regulation], the Commission shall set up and manage a digital registry (\"the registry\") storing in a secure manner at least the unique product identifier, the unique operator identifier, the unique facility identifiers. In case of products intended to be placed under the customs procedure 'release for free circulation', the registry shall also store the product commodity code. The registry shall also store the batteries' unique identifiers referred to in Article 77(3) of Regulation (EU) 2023/1542."@en ; + samm:characteristic :IdentifierCharacteristic ; + samm:exampleValue "https://dummy.link/ID8283746239078" . + +:lastModification a samm:Property ; + samm:preferredName "Last Modification"@en ; + samm:description "Date of the latest modification."@en ; + samm:characteristic :DateTrait ; + samm:exampleValue "2000-01-01" . + +:serialInformation a samm:Property ; + samm:preferredName "Serial Information"@en ; + samm:description "Identifier for a serial part if available. This is mentioned in the ESPR provisional agreement from January 9th, 2024 Recital (27):\n[...] an 'item' usually means a single unit of a model."@en ; + samm:characteristic ext-part:LocalIdentifierCharacteristic . + +:batchInformation a samm:Property ; + samm:preferredName "Batch Information"@en ; + samm:description "Identifier for a batch part if available. Identifier for a serial part if available. This is mentioned in the ESPR provisional agreement from January 9th, 2024 Recital (27):\n[...] a 'batch' usually means a subset of a specific model composed of all products produced in a specific manufacturing plant at a specific moment in time [...]."@en ; + samm:characteristic ext-batch:LocalIdentifierCharacteristic . + +:partTypeInformation a samm:Property ; + samm:preferredName "Part Type Information"@en ; + samm:description "Identifier on the level of a part model or type. Identifier for a serial part if available. This is mentioned in the ESPR provisional agreement from January 9th, 2024 Recital (27):\n[...] A 'model' usually means a version of a product of which all units share the same technical characteristics relevant for the ecodesign requirements and the same model identifier [...]."@en ; + samm:characteristic :PartTypeCharacteristic . + +:codes a samm:Property ; + samm:preferredName "Codes"@en ; + samm:description "Codes for identification."@en ; + samm:characteristic :CodeList . + +:dataCarrier a samm:Property ; + samm:preferredName "Data Carrier"@en ; + samm:description "The type and layout of the data carrier on the product. These are mentioned in the ESPR proposal from March 30th, 2022 Article 8:\n(b) the types of data carrier to be used;\n(c) the layout in which the data carrier shall be presented and its positioning;\nArticle 2 defines:\n(30) 'data carrier' means a linear bar code symbol, a two-dimensional symbol or other automatic identification data capture medium that can be read by a device."@en ; + samm:characteristic :DataCarrierCharacteristic . + +:manufacturer a samm:Property ; + samm:preferredName "Manufacturer"@en ; + samm:description "Manufacturing information of the product. In the CATENA-X use case, the BPNL and BPNA can be stated. These attributes are mentioned in the ESPR provisional agreement from January 9th 2024 Annex III:\n(h) unique operator identifiers other than that of the manufacturer;\n(k) the name, contact details and unique operator identifier code of the economic operator established in the Union responsible for carrying out the tasks set out in Article 4 of Regulation (EU) 2019/1020, or Article 15 of Regulation (EU) [.../...] on general product safety, or similar tasks pursuant to other EU legislation applicable to the product."@en ; + samm:characteristic :ManufacturerCharacteristic . + +:import a samm:Property ; + samm:preferredName "Import"@en ; + samm:description "Importer details such as the identification."@en ; + samm:characteristic :ImportCharacteristic . + +:otherOperators a samm:Property ; + samm:preferredName "Other Operators"@en ; + samm:description "Other operators relevant for the product."@en ; + samm:characteristic :OperatorCharacteristic . + +:spareParts a samm:Property ; + samm:preferredName "spareParts"@en ; + samm:description "The list of spare parts available for the product from various suppliers."@en ; + samm:characteristic :SparePart . + +:applicable a samm:Property ; + samm:preferredName "Applicable"@en ; + samm:description "Check whether the connected attributes are applicable to the product. If it is not applicable (false), dummy data can be delivered."@en ; + samm:characteristic samm-c:Boolean ; + samm:exampleValue true . + +:lifespan a samm:Property ; + samm:preferredName "Lifespan"@en ; + samm:description "The type of lifespan represented with the values guaranteed lifetime, technical lifetime and mean time between failures. Both can be described through the attributes: type, which defines the type such as guaranteed lifetime or technical lifetime, the unit for the lifetime, and the value represented by an integer. These attributes are mentioned in the ESPR proposal from March 30th, 2022 ANNEX I:\n(a) durability and reliability of the product or its components as expressed through the products guaranteed lifetime, technical lifetime [or] mean time between failures [...]."@en ; + samm:characteristic :LifespanList . + +:physicalDimension a samm:Property ; + samm:preferredName "Physical Dimension"@en ; + samm:description "Physical dimensions are properties associated with physical quantities for purposes of classification or differentiation. These attributes are mentioned in the ESPR provisional agreement from January 9th, Article 7:\n(2) (b) (i) information on the performance of the product in relation to one or more of the product parameters referred to in Annex I;\nAnnex I (i) weight and volume of the product and its packaging, and the product-to-packaging ratio."@en ; + samm:characteristic :PhysicalDimensionCharacteristic . + +:physicalState a samm:Property ; + samm:preferredName "Physical State"@en ; + samm:description "The physical state of the item. There are four states of matter solid, liquid, gas and plasma which can be chosen from an enumeration."@en ; + samm:characteristic :PhysicalStateEnumeration ; + samm:exampleValue "solid" . + +:generalPerformanceClass a samm:Property ; + samm:preferredName "General Performance Class"@en ; + samm:description "The performance class of the product. This attribute is mentioned ESPR provisional agreement from January 9th, 2024 Article 7:\n4. When establishing the information requirements referred to in paragraph 2, point (b), point (i), the Commission shall, as appropriate in view of the specificity of the product group, determine classes of performance. Classes of performance may be based on single parameters, on aggregated scores, in absolute terms or in any other form that enables potential customers to choose the best performing products. Those classes of performance shall correspond to significant improvements in performance levels. Where classes of performance are based on parameters in relation to which performance requirements are established, they shall use as the minimum level the minimum performance required at the time when the classes of performance start to apply.\nDefinition:\n'class of performance': means a range of performance levels in relation to one or more product parameters referred to in Annex I, based on a common methodology for the product or product group, ordered into successive steps to allow for product differentiation."@en ; + samm:characteristic samm-c:Text ; + samm:exampleValue "A" . + +:placedOnMarket a samm:Property ; + samm:preferredName "Placed on Market"@en ; + samm:description "The timestamp in the format (yyyy-mm-dd) with or without time zone when the product was put in the market."@en ; + samm:characteristic :DateTrait ; + samm:exampleValue "2000-01-01" . + +:purpose a samm:Property ; + samm:preferredName "Purpose"@en ; + samm:description "One or more intended industry/industries of the product described by the digital product passport. If exchanged via Catena-X, 'automotive ' is a must choice included in the list."@en ; + samm:characteristic :StringList ; + samm:exampleValue "automotive" . + +:substancesOfConcern a samm:Property ; + samm:preferredName "Substances of Concern"@en ; + samm:description "Information regarding substances of concern in the product. The ESPR provisional agreement from January 9th, 2024 defines:\n(52) 'hazardous substance' means a substance classified as hazardous pursuant to Article 3 of Regulation (EC) No 1272/2008."@en ; + samm:characteristic :SubstanceOfConcernCharacteristic . + +:materialComposition a samm:Property ; + samm:preferredName "Material Composition"@en ; + samm:description "Material composition of the product with information on recycled and renewable materials."@en ; + samm:characteristic :MaterialCharacteristic . + +:state a samm:Property ; + samm:preferredName "State"@en ; + samm:description "The status of the product (original, repurposed, re-used, remanufactured or waste) to indicated, whether it is a used product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Annex I:\n(j) incorporation of used components."@en ; + samm:characteristic :StateEnumeration ; + samm:exampleValue "original" . + +:productFootprint a samm:Property ; + samm:preferredName "Product Footprint"@en ; + samm:description "The carbon and environmental footprint or material footprint of the product. These attributes are mentioned in the ESPR provisional agreement from January 9th 2024 Annex I:\n(l) the environmental footprint of the product, expressed as a quantification, in accordance with the applicable delegated act, of a product's life cycle environmental impacts, whether in relation to one or more environmental impact categories or an aggregated set of impact categories;\n(m) the carbon footprint of the product;\n(ma) the material footprint of the product;\nAll are defined by Article 2:\n(23) 'environmental footprint' means a quantification of product environmental impacts throughout its life cycle, whether in relation to a single environmental impact category or an aggregated set of impact categories based on the Product Environmental Footprint method or other scientific methods developed by international organisations and widely tested in collaboration with different industry sectors and adopted or implemented by the Commission in other Union \nlegislation;\n(25) 'carbon footprint' means the sum of greenhouse gas (GHG) emissions and GHG removals in a product system, expressed as CO2 equivalents and based on a life cycle assessment using the single impact category of climate change.\n(25a) 'material footprint' refers to the total amount of raw materials extracted to meet final consumption demands;"@en ; + samm:characteristic :ProductFootprintCharacteristic . + +:reparabilityScore a samm:Property ; + samm:preferredName "Reparability Score"@en ; + samm:description "The reparability score. This attribute is mentioned ESPR provisional agreement from January 9th, 2024 Article 7:\n(b) as appropriate, also require products to be accompanied by:\n(i) information on the performance of the product in relation to one or more of the product parameters referred to in Annex I, including a scoring of reparability or durability [...]."@en ; + samm:characteristic samm-c:Text ; + samm:exampleValue "B" . + +:durabilityScore a samm:Property ; + samm:preferredName "Durability Score"@en ; + samm:description "The durability score. This attribute is mentioned ESPR provisional agreement from January 9th, 2024 Article 7:\n(b) as appropriate, also require products to be accompanied by:\n(i) information on the performance of the product in relation to one or more of the product parameters referred to in Annex I, including a scoring of reparability or durability [...]."@en ; + samm:characteristic samm-c:Text ; + samm:exampleValue "A" . + +:content a samm:Property ; + samm:preferredName "Content"@en ; + samm:description "The content of the document e.g a link."@en ; + samm:characteristic samm-c:Text ; + samm:exampleValue "https://dummy.link" . + +:category a samm:Property ; + samm:preferredName "Category"@en ; + samm:description "The category in which the document can be sorted. These are mentioned in the ESPR proposal from March 30th, 2022 ANNEX III:\n(e) compliance documentation and information required under this Regulation or other Union law applicable to the product, such as the declaration of conformity, technical documentation or conformity certificates;\nANNEX IV states additional information regarding the content of the technical documentation\nFurther information on documents are mentioned in the proposal from March 30th, 2022 ANNEX III:\n(f) user manuals, instructions, warnings or safety information, as required by other Union legislation applicable to the product.\nAdditionally requirements are mentioned in Article 21:\n(7) Manufacturers shall ensure that that a product covered by a delegated act adopted pursuant to Article 4 is accompanied by instructions that enable consumers and other end-users to safely assemble, install, operate, store, maintain, repair and dispose of the product in a language that can be easily understood by consumers and other end-users, as determined by the Member State concerned. Such instructions shall be clear, understandable and legible and include at least the information specified in the delegated acts adopted pursuant to Article 4 and pursuant to Article 7(2)(b), point (ii).\nArticle 7 states additionally:\n(2) (b) (ii) information for consumers and other end-users on how to install, use, maintain and repair the product in order to minimize its impact on the environment and to ensure optimum durability, as well as on how to return or dispose of the product at end-of-life;\n(2) (b) (iii) information for treatment facilities on disassembly, recycling, or disposal at end-of-life;\n(2) (b) (iv) other information that may influence the way the product is handled by parties other than the manufacturer in order to improve performance in relation to product parameters referred to in Annex I.\n(5) (d) relevant instructions for the safe use of the product."@en ; + samm:characteristic :SourceCategoryEnumeration ; + samm:exampleValue "Legal Information" . + +:contentType a samm:Property ; + samm:preferredName "Content Type"@en ; + samm:description "The type of content which can be expected in the \"content\" property. Examples are a link, restricted link, pdf, excel, etc."@en ; + samm:characteristic samm-c:Text ; + samm:exampleValue "URL" . + +:header a samm:Property ; + samm:preferredName "Header"@en ; + samm:description "The header as a short description of the document with a maximum of 100 characters."@en ; + samm:characteristic :HeaderTrait ; + samm:exampleValue "Example Document XYZ" . + +:label a samm:Property ; + samm:preferredName "Label"@en ; + samm:description "The human readable name of the attribute."@en ; + samm:characteristic samm-c:Text ; + samm:exampleValue "Maximum permitted battery power" . + +:description a samm:Property ; + samm:preferredName "Description"@en ; + samm:description "The description of the attribute context."@en ; + samm:characteristic samm-c:Text ; + samm:exampleValue "Description of an attribute" . + +:type a samm:Property ; + samm:preferredName "Type"@en ; + samm:description "The complex description of the type."@en ; + samm:characteristic :TypeCharacteristic . + +:data a samm:Property ; + samm:preferredName "Data"@en ; + samm:description "The content from the attribute which is a depended of the data type and typeUnit."@en ; + samm:characteristic samm-c:Text ; + samm:exampleValue "23" . + +:children a samm:Property ; + samm:preferredName "children"@en ; + samm:description "Children of the hierarchy."@en ; + samm:characteristic :AdditionalDataList . + +:StatusEnumeration a samm-c:Enumeration ; + samm:preferredName "Status Enumeration"@en ; + samm:description "The current status of the product passport declared through either: draft, approved, invalid or expired."@en ; + samm:dataType xsd:string ; + samm-c:values ( "draft" "approved" "invalid" "expired" ) . + +:DateTrait a samm-c:Trait ; + samm:preferredName "Date Trait"@en ; + samm:description "Trait for valid traits.."@en ; + samm-c:baseCharacteristic samm-c:Text ; + samm-c:constraint :DateConstraint . + +:IdentifierCharacteristic a samm:Characteristic ; + samm:preferredName "Identifier Characteristic"@en ; + samm:description "Characteristic for Identifiers."@en ; + samm:dataType xsd:string . + +:PartTypeCharacteristic a samm:Characteristic ; + samm:preferredName "Part Type Characteristic"@en ; + samm:description "Characteristic for the part type."@en ; + samm:dataType :PartTypeEntity . + +:CodeList a samm-c:List ; + samm:preferredName "Code List"@en ; + samm:description "A list of additional codes."@en ; + samm:dataType :CodeEntity . + +:DataCarrierCharacteristic a samm:Characteristic ; + samm:preferredName "Data Carrier Characteristic"@en ; + samm:description "Data Carrier Characteristic for the product."@en ; + samm:dataType :DataCarrierEntity . + +:ManufacturerCharacteristic a samm:Characteristic ; + samm:preferredName "Manufacturer Characteristic"@en ; + samm:description "Manufacturing information."@en ; + samm:dataType :ManufacturerEntity . + +:ImportCharacteristic a samm:Characteristic ; + samm:preferredName "Import Characteristic"@en ; + samm:description "Import Characteristic for the product."@en ; + samm:dataType :ImportEntity . + +:OperatorCharacteristic a samm:Characteristic ; + samm:preferredName "Operator Characteristic"@en ; + samm:description "Other operators characteristic."@en ; + samm:dataType :OperatorEntity . + +:SparePart a samm:Characteristic ; + samm:preferredName "Spare Part"@en ; + samm:description "Characteristic describing sources and spare parts."@en ; + samm:dataType :SparePartEntity . + +:LifespanList a samm-c:List ; + samm:preferredName "Lifespan List"@en ; + samm:description "List of different life spans of a product."@en ; + samm:dataType :LifespanEntity . + +:PhysicalDimensionCharacteristic a samm:Characteristic ; + samm:preferredName "Physical Dimension Characteristic"@en ; + samm:description "Characteristic for physical dimensions with linear, mass and capacity attributes."@en ; + samm:dataType :PhysicalDimensionEntity . + +:PhysicalStateEnumeration a samm-c:Enumeration ; + samm:preferredName "Physical State Enumeration"@en ; + samm:description "Enumeration with the values solid, liquid, gas and plasma."@en ; + samm:dataType xsd:string ; + samm-c:values ( "solid" "liquid" "gas" "plasma" ) . + +:StringList a samm-c:List ; + samm:preferredName "String List"@en ; + samm:description "List of strings."@en ; + samm:dataType xsd:string . + +:SubstanceOfConcernCharacteristic a samm:Characteristic ; + samm:preferredName "Substance Of Concern Characteristic"@en ; + samm:description "Substance of concern Characteristic of the product."@en ; + samm:dataType :SubstanceOfConcernEntity . + +:MaterialCharacteristic a samm:Characteristic ; + samm:preferredName "Material Characteristic"@en ; + samm:description "Material Characteristic with information on the materials."@en ; + samm:dataType :ChemicalMaterialEntity . + +:StateEnumeration a samm-c:Enumeration ; + samm:preferredName "State Enumeration"@en ; + samm:description "Enumeration defined as original, repurposed, re-used, remanufactured or waste."@en ; + samm:dataType xsd:string ; + samm-c:values ( "original" "repurposed" "re-used" "remanufactured" "waste" ) . + +:ProductFootprintCharacteristic a samm:Characteristic ; + samm:preferredName "Product Footprint Characteristic"@en ; + samm:description "The Product Footprint Characteristic with sustainability information."@en ; + samm:dataType :ProductFootprintEntity . + +:SourceCategoryEnumeration a samm-c:Enumeration ; + samm:preferredName "Source Category Enumeration"@en ; + samm:description "The types of sources that can be linked in a digital product passport can vary depending on the nature of the product and the information that needs to be included. This is an enumeration of possible sources."@en ; + samm:dataType xsd:string ; + samm-c:values ( "Product Specifications" "Manufacturer Information" "User Manuals and Guides" "Certifications and Compliance" "Product Images and Videos" "Warranty Information" "Reviews and Ratings" "Product Variations" "Supply Chain Information" "Environmental Impact" "Compatibility and Accessories" "FAQs and Support" "Purchase and Retail Information" "Privacy and Data Handling" "Third-Party Integrations" "Legal Information" "Safety Information" "Repair and Installation" "Waste Generation and Prevention" "Specific Voluntary Labels" "Product Packaging" "Return and Disposal" "End of Life" "Material and Substance Information" "Technical Documentation" "Treatment facilities" "Other" ) . + +:HeaderTrait a samm-c:Trait ; + samm:preferredName "Header Trait"@en ; + samm:description "Trait for a restrictive header."@en ; + samm-c:baseCharacteristic samm-c:Text ; + samm-c:constraint :HeaderConstraint . + +:TypeCharacteristic a samm:Characteristic ; + samm:preferredName "Type Characteristic"@en ; + samm:description "Characteristic for the data type."@en ; + samm:dataType :TypeEntity . + +:DateConstraint a samm-c:RegularExpressionConstraint ; + samm:preferredName "Date Constraint"@en ; + samm:description "Constraint fo a timestamp in the format (yyyy-mm-dd)."@en ; + samm:value "^\\d{4}-\\d{2}-\\d{2}$" . + +:PartTypeEntity a samm:Entity ; + samm:preferredName "Part Type Entity"@en ; + samm:description "Entity for the part type with manufacturer id and name."@en ; + samm:properties ( ext-information:manufacturerPartId ext-information:nameAtManufacturer ) . + +:CodeEntity a samm:Entity ; + samm:preferredName "Code Entity"@en ; + samm:description "Code entity with code key and value."@en ; + samm:properties ( [ samm:property :codeKey; samm:payloadName "key" ] [ samm:property :codeValue; samm:payloadName "value" ] ) . + +:DataCarrierEntity a samm:Entity ; + samm:preferredName "Data Carrier Entity"@en ; + samm:description "Data Carrier Entity with type and layout of the data carrier."@en ; + samm:properties ( :carrierType :carrierLayout ) . + +:ManufacturerEntity a samm:Entity ; + samm:preferredName "Manufacturer Entity"@en ; + samm:description "Manufacturing Entity with the identification of the main manufacturer and the facility location as well as the manufacturing date."@en ; + samm:properties ( [ samm:property :facilityIdentification; samm:payloadName "facility" ] [ samm:property :manufacturerIdentification; samm:payloadName "manufacturer" ] [ samm:property :manufacturingDate; samm:optional true ] ) . + +:ImportEntity a samm:Entity ; + samm:preferredName "Import Entity"@en ; + samm:description "Import entity with attributes if applicable to the product."@en ; + samm:properties ( [ samm:property :importer; samm:payloadName "content" ] :applicable ) . + +:OperatorEntity a samm:Entity ; + samm:preferredName "Operator Entity"@en ; + samm:description "Operator with role and identification. "@en ; + samm:properties ( [ samm:property :otherOperatorId; samm:payloadName "id" ] [ samm:property :otherOperatorRole; samm:payloadName "role" ] ) . + +:SparePartEntity a samm:Entity ; + samm:preferredName "Spare Part Entity"@en ; + samm:description "Information regarding possible spare parts. This is mentioned in the ESPR proposal from March 30th, 2022 Annex I:\n(b) ease of repair and maintenance as expressed through: characteristics, availability and delivery time of spare parts, modularity, compatibility with commonly available spare parts, availability of repair and maintenance instructions, number of materials and components used, use of standard components, use of component and material coding standards for the identification of components and materials, number and complexity of processes and tools needed, ease of non-destructive disassembly and re-assembly, conditions for access to product data, conditions for access to or use of hardware and software needed;\n(c) the Global Trade Identification Number as provided for in standard ISO/IEC 15459-6 or equivalent of products or their parts."@en ; + samm:properties ( [ samm:property :sparePartSources; samm:payloadName "producer" ] :sparePart ) . + +:LifespanEntity a samm:Entity ; + samm:preferredName "Lifespan Entity"@en ; + samm:description "Entity for the lifespan of a product with type, unit and value."@en ; + samm:properties ( [ samm:property :lifeUnit; samm:payloadName "unit" ] [ samm:property :lifeValue; samm:payloadName "value" ] [ samm:property :lifeType; samm:payloadName "key" ] ) . + +:PhysicalDimensionEntity a samm:Entity ; + samm:preferredName "Physical Dimension Entity"@en ; + samm:description "Entity for physical dimensions with linear, mass and capacity attributes. Either weight or volume is mandatory."@en ; + samm:properties ( [ samm:property :width; samm:optional true ] [ samm:property :length; samm:optional true ] [ samm:property :diameter; samm:optional true ] [ samm:property :height; samm:optional true ] :grossWeight :grossVolume :weight :volume ) . + +:SubstanceOfConcernEntity a samm:Entity ; + samm:preferredName "Substance Of Concern Entity"@en ; + samm:description "Substance of Concern entity with attributes if applicable to the product."@en ; + samm:properties ( :applicable [ samm:property :substanceOfConcern; samm:payloadName "content" ] ) . + +:ChemicalMaterialEntity a samm:Entity ; + samm:preferredName "Chemical Material Entity"@en ; + samm:description "Material entity with attributes if applicable to the product."@en ; + samm:properties ( :applicable [ samm:property :chemicalMaterial; samm:payloadName "content" ] ) . + +:ProductFootprintEntity a samm:Entity ; + samm:preferredName "Product Footprint Entity"@en ; + samm:description "The Product Footprint Entity with sustainability information such as the different environmental footprint types, the carbon and material footprint explicitly, applicable rules and lifecycle stages."@en ; + samm:properties ( [ samm:property :environmentalFootprint; samm:optional true; samm:payloadName "environmental" ] [ samm:property :carbonFootprint; samm:payloadName "carbon" ] [ samm:property :materialFootprint; samm:optional true; samm:payloadName "material" ] ) . + +:HeaderConstraint a samm-c:LengthConstraint ; + samm:preferredName "Header Constraint"@en ; + samm:description "Constraint for a maximum of 100 characters."@en ; + samm-c:maxValue "100"^^xsd:nonNegativeInteger . + +:TypeEntity a samm:Entity ; + samm:preferredName "Type Entity"@en ; + samm:description "Entity for type with unit and data type."@en ; + samm:properties ( [ samm:property :typeUnit; samm:optional true ] :dataType ) . + +:codeKey a samm:Property ; + samm:preferredName "Code Key"@en ; + samm:description "The code key for the identification of the product. Examples are GTIN, hash, DID, ISBN, TARIC. This attribute is mentioned in the ESPR proposal from March 30th, 2022 ANNEX III:\n(b) the unique product identifier at the level indicated in the applicable delegated act adopted pursuant to Article 4;\n(c) the Global Trade Identification Number as provided for in standard ISO/IEC 15459-6 or equivalent of products or their parts;\n(d) relevant commodity codes, such as a TARIC code as defined in Council Regulation (EEC) No 2658/87."@en ; + samm:characteristic :IdentifierCharacteristic ; + samm:exampleValue "TARIC" . + +:codeValue a samm:Property ; + samm:preferredName "Code Value"@en ; + samm:description "The code value for the identification of the product in regard to the chosen code name."@en ; + samm:characteristic :IdentifierCharacteristic ; + samm:exampleValue "8703 24 10 00" . + +:carrierType a samm:Property ; + samm:preferredName "Carrier Type"@en ; + samm:description "The type of data carrier such as a QR code on the product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 8:\n(2) (b) the types of data carrier to be used."@en ; + samm:characteristic samm-c:Text ; + samm:exampleValue "QR" . + +:carrierLayout a samm:Property ; + samm:preferredName "Carrier Layout"@en ; + samm:description "The positioning of data carrier on the product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 8:\n(2) (c) the layout in which the data carrier shall be presented and its positioning."@en ; + samm:characteristic samm-c:Text ; + samm:exampleValue "upper-left side" . + +:facilityIdentification a samm:Property ; + samm:preferredName "Facility Identification"@en ; + samm:description "The identifier used for a location. In the CATENA-X use case, the BPNA can be stated. This attribute is mentioned in the ESPR provisional agreement from January 9th 2024 Annex III:\n(i) unique facility identifiers;\nArticle 2 Definitions: (33) 'unique facility identifier' means a unique string of characters for the identification of locations or buildings involved in the value chain of a product or used by actors involved in the value chain of a product."@en ; + samm:characteristic :FacilityList . + +:manufacturerIdentification a samm:Property ; + samm:preferredName "Manufacturer Identification"@en ; + samm:description "The main manufacturer, if different from the passport owner, represented by an identification number. In the Catena-X use case, the BPNL can be stated. This attribute is mentioned in the ESPR provisional agreement from January 9th 2024 Annex III:\n(h) unique operator identifiers other than that of the manufacturer;\n(k) the name, contact details and unique operator identifier code of the economic operator established in the Union responsible for carrying out the tasks set out in Article 4 of Regulation (EU) 2019/1020, or Article 15 of Regulation (EU) [.../...] on general product safety, or similar tasks pursuant to other EU legislation applicable to the product."@en ; + samm:characteristic ext-number:BpnlTrait . + +:manufacturingDate a samm:Property ; + samm:preferredName "Manufacturing Date"@en ; + samm:description "The timestamp in the format (yyyy-mm-dd) of the manufacturing date as the final step in production process (e.g. final quality check, ready-for-shipment event)."@en ; + samm:characteristic :DateTrait ; + samm:exampleValue "2000-01-31" . + +:importer a samm:Property ; + samm:preferredName "Importer"@en ; + samm:description "Information regarding the importer of the product, if different from the owner of the passport. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex III:\n(j) information related to the importer, including the information referred to in Article 23(3) and its EORI number;\nArticle 23 states:\n(3) Importers shall, for products covered by a delegated act adopted pursuant to Article 4, indicate their name, registered trade name or registered trade mark and the postal address and electronic means of communication, where they can be contacted: (a) on the public part of the product passport, when applicable, and\n(b) on the product or, where this is not possible, on the packaging, or in a document accompanying the product."@en ; + samm:characteristic :ImporterCharacteristic . + +:otherOperatorId a samm:Property ; + samm:preferredName "Other Operator Id"@en ; + samm:description "Identifier of the other operator. This can be a BPN."@en ; + samm:characteristic samm-c:Text ; + samm:exampleValue "BPNL0123456789XX" . + +:otherOperatorRole a samm:Property ; + samm:preferredName "Other Operator Role"@en ; + samm:description "Role of the other operator."@en ; + samm:characteristic samm-c:Text ; + samm:exampleValue "distributor" . + +:sparePartSources a samm:Property ; + samm:preferredName "Spare Part Sources"@en ; + samm:description "Sources of possible spare parts."@en ; + samm:characteristic :SourcesList . + +:sparePart a samm:Property ; + samm:preferredName "Spare Part"@en ; + samm:description "Possible spare parts of the product."@en ; + samm:characteristic :PartList . + +:lifeUnit a samm:Property ; + samm:preferredName "Life Unit"@en ; + samm:description "The unit of the respective lifespan expressed through the possible units day, month, cycle, year and runningOrOperatingHour."@en ; + samm:see ; + samm:characteristic :LifeEnumeration ; + samm:exampleValue "unit:month" . + +:lifeValue a samm:Property ; + samm:preferredName "Life Value"@en ; + samm:description "The value as an integer for the respective lifespan."@en ; + samm:characteristic :LifeValueCharacteristic ; + samm:exampleValue 36 . + +:lifeType a samm:Property ; + samm:preferredName "Life Type"@en ; + samm:description "The type of lifespan represented with the values guaranteed lifetime, technical lifetime and mean time between failures. This attribute is mentioned in the ESPR proposal from March 30th, 2022 ANNEX I:\n(a) durability and reliability of the product or its components as expressed through the product's guaranteed lifetime, technical lifetime [or] mean time between failures [...]."@en ; + samm:characteristic :LifeTypeEnumeration ; + samm:exampleValue "guaranteed lifetime" . + +:width a samm:Property ; + samm:preferredName "Width"@en ; + samm:description "The width of the item measured in a specific linear unit which can be declared in the corresponding unit attribute."@en ; + samm:characteristic ext-quantity:LinearCharacteristic . + +:length a samm:Property ; + samm:preferredName "Length"@en ; + samm:description "The length of the item measured in a specific linear unit which can be declared in the corresponding unit attribute."@en ; + samm:characteristic ext-quantity:LinearCharacteristic . + +:diameter a samm:Property ; + samm:preferredName "Diameter"@en ; + samm:description "The diameter of the item, if applicable, measured in a specific linear unit which can be declared in the corresponding unit attribute."@en ; + samm:characteristic ext-quantity:LinearCharacteristic . + +:height a samm:Property ; + samm:preferredName "Height"@en ; + samm:description "The height of the item measured in a specific linear unit which can be declared in the corresponding unit attribute."@en ; + samm:characteristic ext-quantity:LinearCharacteristic . + +:grossWeight a samm:Property ; + samm:preferredName "Gross Weight"@en ; + samm:description "The gross weight of the item measured in a specific mass unit which can be declared in the corresponding unit attribute. Gross weight refers to the total weight of a product, including the weight of the packaging. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7:\n(2) (b) (i) information on the performance of the product in relation to the product parameters referred to in Annex I;\nAnnex I (i) weight and volume of the product and its packaging, and the product-to-packaging ratio."@en ; + samm:characteristic ext-quantity:MassCharacteristic . + +:grossVolume a samm:Property ; + samm:preferredName "Gross Volume"@en ; + samm:description "The gross volume of the item, if possible, measured in a specific capacity unit which can be declared in the corresponding unit attribute. If there is no separate packing, the volume of the product shall be given. Gross volume refers to the total volume of a product, including the volume of the packaging. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7:\n(2) (b) (i) information on the performance of the product in relation to the product parameters referred to in Annex I;\nAnnex I (i) weight and volume of the product and its packaging, and the product-to-packaging ratio."@en ; + samm:characteristic ext-quantity:VolumeCharacteristic . + +:weight a samm:Property ; + samm:preferredName "Weight"@en ; + samm:description "Weight of the product measured in a specific mass unit which can be declared in the corresponding unit attribute. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7:\n(2) (b) (i) information on the performance of the product in relation to the product parameters referred to in Annex I;\nAnnex I (i) weight and volume of the product [...]."@en ; + samm:characteristic ext-quantity:MassCharacteristic . + +:volume a samm:Property ; + samm:preferredName "Volume"@en ; + samm:description "Volume of the product, if possible, measured in a specific capacity unit which can be declared in the corresponding unit attribute. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7:\n(2) (b) (i) information on the performance of the product in relation to the product parameters referred to in Annex I;\nAnnex I (i) weight and volume of the product [...]."@en ; + samm:characteristic ext-quantity:VolumeCharacteristic . + +:substanceOfConcern a samm:Property ; + samm:preferredName "Substance of Concern"@en ; + samm:description "Information regarding substances of concern in the product. Attributes are among others substance names, ids, concentration, location and hazard class. This is mentioned in the ESPR provisional agreement from January 9th, 2024 Article 7:\n(5) (a) the name of the substances of concern present in the product, as follows:\n- name(s) in the International Union of Pure and Applied Chemistry (IUPAC) nomenclature, or another international name when IUPAC name is not available; \n- other names (usual name, trade name, abbreviation);\n- European Community (EC) number, as indicated in the European Inventory of Existing Commercial Chemical Substances (EINECS), the European List of Notified Chemical Substances (ELINCS) or the No Longer Polymer (NLP) list or assigned by the European Chemicals Agency (ECHA), if available;\n- the Chemical Abstract Service (CAS) name(s) and number(s), if available;\n(5) (b) the location of the substances of concern within the product.\n(5) (c) the concentration, maximum concentration or concentration range of the substances of concern, at the level of the product its relevant components, or spare parts;\n(d) relevant instructions for the safe use of the product;\n(e) information relevant for disassembly, preparation for reuse, reuse, recycling and the environmentally sound management of the product at the end of its life.\nAnd in the next paragraph:\n(c) provide duly justified exemptions for substances of concern or information elements from the information requirements referred to in the first subparagraph."@en ; + samm:characteristic :SubstanceList . + +:chemicalMaterial a samm:Property ; + samm:preferredName "Material"@en ; + samm:description "Information on different materials in the product."@en ; + samm:characteristic :MaterialList . + +:environmentalFootprint a samm:Property ; + samm:preferredName "Environmental Footprint"@en ; + samm:description "The environmental footprint of the product. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I:\nThe following parameters shall, as appropriate, and where necessary supplemented by others, be used, individually or combined, as a basis for improving the product aspects referred to in Article 5(1):\n(l) the environmental footprint of the product, expressed as a quantification, in accordance with the applicable delegated act, of a product's life cycle environmental impacts, whether in relation to one or more environmental impact categories or an aggregated set of impact categories.\nand Article 7:\n(2)(b)(i) information on the performance of the product in relation to one or more of the product parameters referred to in Annex I, including a scoring of reparability or durability, carbon footprint or environmental footprint;\nand defined by Article 2:\n(23) 'environmental footprint' means a quantification of product environmental impacts throughout its life cycle, whether in relation to a single environmental impact category or an aggregated set of impact categories based on the Product Environmental Footprint method or other scientific methods developed by international organisations and widely tested in collaboration with different industry sectors and adopted or implemented by the Commission in other Union legislation;\n(24) 'Product Environmental Footprint method' means the life cycle assessment method to quantify the environmental impacts of products established by Recommendation (EU) 2021/2279."@en ; + samm:characteristic :FootprintList . + +:carbonFootprint a samm:Property ; + samm:preferredName "Carbon Footprint"@en ; + samm:description "The carbon footprint of the product. This is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I:\nThe following parameters shall, as appropriate, and where necessary supplemented by others, be used, individually or combined, as a basis for improving the product aspects referred to in Article 5(1):\n(m) the carbon footprint of the product;\nand Article 7:\n(2)(b)(i) information on the performance of the product in relation to one or more of the product parameters referred to in Annex I, including a scoring of reparability or durability, carbon footprint or environmental footprint;\nand defined by Article 2:\n(25) 'carbon footprint' means the sum of greenhouse gas (GHG) emissions and GHG removals in a product system, expressed as CO2 equivalents and based on a life cycle assessment using the single impact category of climate change."@en ; + samm:characteristic :FootprintList . + +:materialFootprint a samm:Property ; + samm:preferredName "Material Footprint"@en ; + samm:description "The material footprint of the product. This is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I:\n(ma) the material footprint of the product;\nand defined by Article 2:\n(25a) 'material footprint' refers to the total amount of raw materials extracted to meet final consumption demands."@en ; + samm:characteristic :FootprintList . + +:typeUnit a samm:Property ; + samm:preferredName "Type Unit"@en ; + samm:description "Choose a unit type from the unit catalog, or if the property \"children\" is filled, leave empty."@en ; + samm:characteristic :UnitCatalog ; + samm:exampleValue "unit:volume" . + +:dataType a samm:Property ; + samm:preferredName "Data Type"@en ; + samm:description "Data type that describe the content of the attributes children and data. In case \"object\" is selected in the enumeration, the children field will be used in the AdditionalDataEntity instead of the \"data\" property. If it is an other type, the content will be specified in \"data\" as a string."@en ; + samm:see ; + samm:characteristic :DataTypeEnumeration ; + samm:exampleValue "xsd:integer" . + +:FacilityList a samm-c:List ; + samm:preferredName "Facility List"@en ; + samm:description "List of facilities."@en ; + samm:dataType :FacilityEntity . + +:ImporterCharacteristic a samm:Characteristic ; + samm:preferredName "Importer Characteristic"@en ; + samm:description "Characteristic with information regarding the importer."@en ; + samm:dataType :ImporterEntity . + +:SourcesList a samm-c:List ; + samm:preferredName "Sources List"@en ; + samm:description "List of possible spare part sources."@en ; + samm:dataType :SourcesEntity . + +:PartList a samm-c:List ; + samm:preferredName "Part List"@en ; + samm:description "A list of possible spare parts of the product."@en ; + samm:dataType :PartsEntity . + +:LifeEnumeration a samm-c:Enumeration ; + samm:preferredName "Life Enumeration"@en ; + samm:description "Enumeration with the possible units day, month, cycle, year and runningOrOperatingHour."@en ; + samm:see ; + samm:dataType xsd:string ; + samm-c:values ( "unit:day" "unit:month" "unit:year" "unit:cycle" "unit:runningOrOperatingHour" ) . + +:LifeValueCharacteristic a samm-c:Quantifiable ; + samm:preferredName "Life Value Characteristic"@en ; + samm:description "Characteristic for the life span value as an integer."@en ; + samm:dataType xsd:integer . + +:LifeTypeEnumeration a samm-c:Enumeration ; + samm:preferredName "Life Type Enumeration"@en ; + samm:description "Enumeration with the values guaranteed lifetime, technical lifetime and mean time between failures."@en ; + samm:dataType xsd:string ; + samm-c:values ( "guaranteed lifetime" "technical lifetime" "mean time between failures" ) . + +:SubstanceList a samm-c:List ; + samm:preferredName "Substance List"@en ; + samm:description "Characteristic for a list of substances of concern."@en ; + samm:dataType :SubstanceEntity . + +:MaterialList a samm-c:List ; + samm:preferredName "Material List"@en ; + samm:description "A list of different materials in the product."@en ; + samm:dataType :MaterialEntity . + +:FootprintList a samm-c:List ; + samm:preferredName "Footprint List"@en ; + samm:description "Footprint List for the environmental footprint."@en ; + samm:dataType :FootprintEntity . + +:UnitCatalog a samm:Characteristic ; + samm:preferredName "Unit Catalog"@en ; + samm:description "Link to the unit catalog with all possible units in the format \"unit:xxx\"."@en ; + samm:see ; + samm:dataType xsd:string . + +:DataTypeEnumeration a samm-c:Enumeration ; + samm:preferredName "Data Type Enumeration"@en ; + samm:description "Data type that describe the content of the attributes children and data. In case \"object\" is selected in the enumeration, the children field will be used in the AdditionalDataEntity instead of the \"data\" property. If it is an other type, the content will be specified in \"data\" as a string."@en ; + samm:see ; + samm:see ; + samm:dataType xsd:string ; + samm-c:values ( "array" "object" "xsd:string" "xsd:integer" "xsd:boolean" "xsd:double" "xsd:float" "xsd:byte" ) . + +:FacilityEntity a samm:Entity ; + samm:preferredName "Facility Entity"@en ; + samm:description "The entity for a facility with the BPNA identifier."@en ; + samm:properties ( :facility ) . + +:ImporterEntity a samm:Entity ; + samm:preferredName "Importer Entity"@en ; + samm:description "Entity with information regarding the importer such as the identification and the EORI."@en ; + samm:properties ( :eori [ samm:property :importerIdentification; samm:payloadName "id" ] ) . + +:SourcesEntity a samm:Entity ; + samm:preferredName "Sources Entity"@en ; + samm:description "Entity for a possible spare part sources."@en ; + samm:properties ( [ samm:property :sourcesIdentification; samm:payloadName "id" ] ) . + +:PartsEntity a samm:Entity ; + samm:preferredName "Parts Entity"@en ; + samm:description "Possible spare parts of the product with identifiers and names."@en ; + samm:properties ( ext-information:manufacturerPartId ext-information:nameAtManufacturer ) . + +:SubstanceEntity a samm:Entity ; + samm:preferredName "Substance Entity"@en ; + samm:description "Information regarding substances of concern in the product."@en ; + samm:properties ( :location [ samm:property :materialUnit; samm:payloadName "unit" ] :concentration :exemption :hazardClassification :concentrationRange [ samm:property :materialIdentification; samm:payloadName "id" ] :documentation ) . + +:MaterialEntity a samm:Entity ; + samm:preferredName "Material Entity"@en ; + samm:description "Information regarding recycled and/or renewable materials in the product."@en ; + samm:properties ( :recycled :renewable [ samm:property :materialUnit; samm:payloadName "unit" ] [ samm:property :materialIdentification; samm:payloadName "id" ] :critical :concentration :documentation ) . + +:FootprintEntity a samm:Entity ; + samm:preferredName "Footprint Entity"@en ; + samm:description "Footprint Entity for the carbon and environmental footprint with the total value, unit, impact category type, lifecycle, rulebook, declaration, performance class and the facility."@en ; + samm:properties ( [ samm:property :footprintValue; samm:payloadName "value" ] [ samm:property :footprintRulebook; samm:payloadName "rulebook" ] [ samm:property :footprintLifecycle; samm:payloadName "lifecycle" ] [ samm:property :footprintUnit; samm:payloadName "unit" ] [ samm:property :footprintType; samm:payloadName "type" ] [ samm:property :performanceClass; samm:optional true ] :manufacturingPlant :declaration ) . + +:facility a samm:Property ; + samm:preferredName "Facility"@en ; + samm:description "The identifier used for a location. This attribute is mentioned in the ESPR provisional agreement from January 9th 2024 Annex III:\n(i) unique facility identifiers;\nArticle 2 Definitions: (33) 'unique facility identifier' means a unique string of characters for the identification of locations or buildings involved in the value chain of a product or used by actors involved in the value chain of a product."@en ; + samm:characteristic ext-number:BpnaTrait ; + samm:exampleValue "BPNA1234567890AA" . + +:eori a samm:Property ; + samm:preferredName "EORI"@en ; + samm:description "An economic operator established in the customs territory of the Union needs, for customs purposes, an EORI number. EORI stands for economic operators registration and identification number. In this case, the importer's EORI must be provided. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Annex III:\n(j) information related to the importer, including the information referred to in Article 23(3) and its EORI number."@en ; + samm:see ; + samm:characteristic :EoriTrait ; + samm:exampleValue "GB123456789000" . + +:importerIdentification a samm:Property ; + samm:preferredName "Importer Identification"@en ; + samm:description "The importer of the product, if different from the owner of the passport. In the Catena-X network, the BPNL is used for the identification of companies and the information stored for this like contact information and addresses.\nThis attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex III:\n(j) information related to the importer, including the information referred to in Article 23(3) and its EORI number;\nArticle 23 states:\n(3) Importers shall, for products covered by a delegated act adopted pursuant to Article 4, indicate their name, registered trade name or registered trade mark and the postal address and electronic means of communication, where they can be contacted: (a) on the public part of the product passport, when applicable, and\n(b) on the product or, where this is not possible, on the packaging, or in a document accompanying the product."@en ; + samm:characteristic ext-number:BpnlTrait ; + samm:exampleValue "BPNL0123456789ZZ" . + +:sourcesIdentification a samm:Property ; + samm:preferredName "Sources Identification"@en ; + samm:description "The identifier of a spare part producer of the product. In the Catena-X network, the BPNL is used for the identification of companies and the information stored for this like contact information and addresses."@en ; + samm:characteristic ext-number:BpnlTrait ; + samm:exampleValue "BPNL0123456789ZZ" . + +:location a samm:Property ; + samm:preferredName "Location"@en ; + samm:description "The location of the substances of concern within the product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7:\n(5) (b) the location of the substances of concern within the product."@en ; + samm:characteristic samm-c:Text ; + samm:exampleValue "Housing" . + +:materialUnit a samm:Property ; + samm:preferredName "Material Unit"@en ; + samm:description "The unit of concentration chosen from an enumeration: mass percent, volume percent, parts per thousand, parts per million, parts per billion and parts per trillion."@en ; + samm:see ; + samm:characteristic :ConcentrationEnumeration ; + samm:exampleValue "unit:percent" . + +:concentration a samm:Property ; + samm:preferredName "Concentration"@en ; + samm:description "Concentration of the material at the level of the product. This attribute is specially mentioned for substances of concern mentioned in the ESPR proposal from March 30th, 2022 Article 7:\n(5) (c) the concentration, maximum concentration or concentration range of the substances of concern, at the level of the product [...].\nOther substances are mentioned for the purpose of recycling in the ESPR provisional agreement from January 9th, 2024 Annex I:\n(d) design for recycling, ease and quality of recycling as expressed through: use of easily recyclable materials, safe, easy and non-destructive access to recyclable components and materials or components and materials containing hazardous substances and material composition and homogeneity, possibility for high-purity sorting, number of materials and components used, use of standard components, use of component and material coding standards for the identification of components and materials, number and complexity of processes and tools needed, ease of nondestructive disassembly and re-assembly, conditions for access to product data, conditions for access to or use of hardware and software needed.\n"@en ; + samm:characteristic :PositiveTrait ; + samm:exampleValue "5.3"^^xsd:float . + +:exemption a samm:Property ; + samm:preferredName "Exemption"@en ; + samm:description "Exemptions to the substance of concern. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Article 7:\n(5) (c) provide duly justified exemptions for substances of concern or information elements from the information requirements referred to in the first subparagraph based on the technical feasibility or relevance of tracking substances of concern, the existence of analytical methods to detect and quantify them, the need to protect confidential business information or in other duly justified cases. Substances of concern within the meaning of Article 2(28), point a), shall not be exempted if they are present in products, their relevant components or spare parts in a concentration above 0,1 % weight by weight."@en ; + samm:characteristic samm-c:Text ; + samm:exampleValue "shall not apply to product x containing not more than 1,5 ml of liquid" . + +:hazardClassification a samm:Property ; + samm:preferredName "Hazard Classification"@en ; + samm:description "The specification of the hazard class. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I:\n(f) use of substances, and in particular the use of substances of concern, on their own, as constituents of substances or in mixtures, during the production process of products, or leading to their presence in products, including once these products become waste, and their impacts on human health and the environment;\nFurther defined is this by Regulation (EC) No 1272/2008 of the European Parliament and of the Council of 16 December 2008 on classification, labelling and packaging of substances and mixtures, amending and repealing Directives 67/548/EEC and 1999/45/EC, and amending Regulation (EC) No 1907/2006.\nDefined in Article 2:\n1. 'hazard class' means the nature of the physical, health or environmental hazard;\n2. 'hazard category' means the division of criteria within each hazard class, specifying hazard severity;\n5. 'hazard statement' means a phrase assigned to a hazard class and category that describes the nature of the hazards of a hazardous substance or mixture, including, where appropriate, the degree of hazard;"@en ; + samm:see ; + samm:characteristic :HazardCharacteristic . + +:concentrationRange a samm:Property ; + samm:preferredName "Concentration Range"@en ; + samm:description "The concentration range for the substance of concern. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7:\n(5) (c) [...] concentration range of the substances of concern, at the level of the product [...]."@en ; + samm:characteristic :RangeCharacteristic . + +:materialIdentification a samm:Property ; + samm:preferredName "Material Identification"@en ; + samm:description "The chemical material name and identification, in accordance with the specification in the attribute for the list type. Preference is given to the IUPAC name. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Article 7:\n(5) (a) the name of the substances of concern present in the product, as follows:\n - name(s) in the International Union of Pure and Applied Chemistry (IUPAC) nomenclature, or another international name when IUPAC name is not available; \n- other names (usual name, trade name, abbreviation);\n- European Community (EC) number, as indicated in the European Inventory of Existing Commercial Chemical Substances (EINECS), the European List of Notified Chemical Substances (ELINCS) or the No Longer Polymer (NLP) list or assigned by the European Chemicals Agency (ECHA), if available;\n- the Chemical Abstract Service (CAS) name(s) and number(s), if available; ."@en ; + samm:characteristic :MaterialIdList . + +:documentation a samm:Property ; + samm:preferredName "Documentation"@en ; + samm:description "Documentation accompanying the material."@en ; + samm:characteristic :DocumentList . + +:recycled a samm:Property ; + samm:preferredName "Recycled"@en ; + samm:description "The share of the material, which is recovered recycled content from the product. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I:\n(h) use or content of recycled materials and recovery of materials, including critical raw materials;"@en ; + samm:characteristic :PercentageTrait ; + samm:exampleValue "12.5"^^xsd:float . + +:renewable a samm:Property ; + samm:preferredName "Renewable"@en ; + samm:description "The share of the material, which is from a renewable resource that can be replenished. Renewable resources are those that can be reproduced by physical, chemical, or mechanical processes. These are the kind of resources that can be regenerated throughout time. Forest wood, for example, can be grown through reforestation. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I:\n(ha) use or content of sustainable renewable materials;\n"@en ; + samm:characteristic :PercentageTrait ; + samm:exampleValue "23.5"^^xsd:float . + +:critical a samm:Property ; + samm:preferredName "Critical"@en ; + samm:description "A flag, if the material is a critical raw material. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I:\n(h) use or content of recycled materials and recovery of materials, including critical raw materials;\nIn Annex II of the connected proposal Act of Critical Raw Materials, a list of critical raw materials can be found."@en ; + samm:see ; + samm:characteristic samm-c:Boolean ; + samm:exampleValue true . + +:footprintValue a samm:Property ; + samm:preferredName "Footprint Value"@en ; + samm:description "The value of the footprint of the product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Annex I:\n(l) the environmental footprint of the product, expressed as a quantification, in accordance with the applicable delegated act, of a product's life cycle environmental impacts, whether in relation to one or more environmental impact categories or an aggregated set of impact categories;\n(m) the carbon footprint of the product;\n(ma) the material footprint of the product.\n"@en ; + samm:characteristic :PositiveTrait ; + samm:exampleValue "12.678"^^xsd:float . + +:footprintRulebook a samm:Property ; + samm:preferredName "Footprint Rulebook"@en ; + samm:description "The applied rulebook for the environmental footprint of the product."@en ; + samm:characteristic :DocumentList . + +:footprintLifecycle a samm:Property ; + samm:preferredName "Footprint Lifecycle"@en ; + samm:description "The lifecycle stage, to which the environmental footprint corresponds. These could be for example \"raw material acquisition and pre-processing\", \"main product production\", \"distribution\" or \"end of life and recycling\"."@en ; + samm:characteristic samm-c:Text ; + samm:exampleValue "main product production" . + +:footprintUnit a samm:Property ; + samm:preferredName "Footprint Unit"@en ; + samm:description "The unit of measurement of the environmental impact category. For each impact category a specific unit is used. If an aggregation is used, utilize the normalization and weighting methods used in the referenced rulebook."@en ; + samm:characteristic samm-c:Text ; + samm:exampleValue "kg CO2 / kWh" . + +:footprintType a samm:Property ; + samm:preferredName "Footprint Type"@en ; + samm:description "The type of the environmental footprint of the product. This could be one of the environmental impact categories. This attribute is mentioned in the ESPR provisional agreement from January 9th 2024 Article 7:\n(2)(b)(i) information on the performance of the product in relation to one or more of the product parameters referred to in Annex I, including a scoring of reparability or durability, carbon footprint or environmental footprint;\nAnnex I:\n(l) the environmental footprint of the product, expressed as a quantification, in accordance with the applicable delegated act, of a product's life cycle environmental impacts, whether in relation to one or more environmental impact categories or an aggregated set of impact categories.\n(m) the carbon footprint of the product;\n(ma) the material footprint of the product."@en ; + samm:characteristic :CategoryEnumeration ; + samm:exampleValue "Climate Change" . + +:performanceClass a samm:Property ; + samm:preferredName "Performance Class"@en ; + samm:description "The performance classification of the footprint."@en ; + samm:characteristic samm-c:Text ; + samm:exampleValue "A" . + +:manufacturingPlant a samm:Property ; + samm:preferredName "Manufacturing Plant"@en ; + samm:description "The manufacturing plant of the footprint in the specific lifecycle phase."@en ; + samm:characteristic :FacilityList . + +:declaration a samm:Property ; + samm:preferredName "Declaration"@en ; + samm:description "The footprint declaration in the format of a link "@en ; + samm:characteristic :DocumentList . + +:EoriTrait a samm-c:Trait ; + samm:preferredName "Eori Trait"@en ; + samm:description "Trait to limit the input to the specified format of an eori."@en ; + samm-c:baseCharacteristic :IdentifierCharacteristic ; + samm-c:constraint :EoriConstraint . + +:ConcentrationEnumeration a samm-c:Enumeration ; + samm:preferredName "Concentration Enumeration"@en ; + samm:description "Enumeration of possible units of concentration with percent, volume percent, parts per thousand, parts per million, parts per billion and parts per trillion."@en ; + samm:see ; + samm:dataType xsd:string ; + samm-c:values ( "unit:partPerMillion" "unit:percent" "unit:percentVolume" "unit:partPerThousand" "unit:partPerTrillionUs" "unit:partPerBillionUs" ) . + +:PositiveTrait a samm-c:Trait ; + samm:preferredName "Positive Trait"@en ; + samm:description "Trait for positive values."@en ; + samm-c:baseCharacteristic :FloatValue ; + samm-c:constraint :PositiveRangeConstraint . + +:HazardCharacteristic a samm:Characteristic ; + samm:preferredName "Hazard Characteristic"@en ; + samm:description "Characteristic for the hazardous classification."@en ; + samm:dataType :HazardEntity . + +:RangeCharacteristic a samm-c:List ; + samm:preferredName "Range Characteristic"@en ; + samm:description "Range characteristic with two values, the highest and the lowest of the concentration range. Only providing the maximum range is also possible."@en ; + samm:dataType :RangeEntity . + +:MaterialIdList a samm-c:List ; + samm:preferredName "Material Id List"@en ; + samm:description "List of ids for the identification."@en ; + samm:dataType :MaterialIdEntity . + +:DocumentList a samm-c:List ; + samm:preferredName "Document List"@en ; + samm:description "List of documents."@en ; + samm:dataType :DocumentationEntity . + +:PercentageTrait a samm-c:Trait ; + samm:preferredName "Percentage Trait"@en ; + samm:description "Trait for a positive percentage."@en ; + samm-c:baseCharacteristic :Share ; + samm-c:constraint :PercentageConstraint . + +:CategoryEnumeration a samm-c:Enumeration ; + samm:preferredName "Category Enumeration"@en ; + samm:description "Enumeration of the 19 impact categories in accordance to EN15804+A2."@en ; + samm:dataType xsd:string ; + samm-c:values ( "Climate Change Total" "Climate Change Fossil" "Climate Change Biogenic Removals and Emissions" "Climate Change Land Use and Land Use Change" "Ozone Depletion" "Acidification" "Eutrophication Aquatic Freshwater" "Eutrophication Fresh Marine" "Eutrophication Terrestrial" "Photochemical Ozone Formation" "Abiotic Depletion- Minerals and Metals" "Fossil Fuels" "Water Use" "Particulate Matter Emissions" "Ionizing Radiation, Human Health" "Eco-Toxicity" "Human Toxicity, Cancer Effects" "Human Toxicity, Non-Cancer Effects" "Land Use Related Impacts/Soil Quality" ) . + +:EoriConstraint a samm-c:RegularExpressionConstraint ; + samm:preferredName "EORI Constraint"@en ; + samm:description "Constraint with a pattern which ensures that the EORI number starts with two alphanumeric characters, followed by two alphabetic characters, and ends with 2 to 15 alphanumeric characters."@en ; + samm:value "^[A-Z]{2}[A-Z0-9]{1,18}$" . + +:FloatValue a samm-c:Quantifiable ; + samm:preferredName "Float Value"@en ; + samm:description "Float number representing a positive value."@en ; + samm:dataType xsd:float . + +:PositiveRangeConstraint a samm-c:RangeConstraint ; + samm:preferredName "Positive Range Constraint"@en ; + samm:description "Constraint for only positive values."@en ; + samm-c:minValue "0.0"^^xsd:float ; + samm-c:lowerBoundDefinition samm-c:AT_LEAST ; + samm-c:upperBoundDefinition samm-c:LESS_THAN . + +:HazardEntity a samm:Entity ; + samm:preferredName "Hazard Entity"@en ; + samm:description "Entity for the hazardous classification."@en ; + samm:properties ( [ samm:property :hazardCategory; samm:payloadName "category" ] [ samm:property :hazardClass; samm:payloadName "class" ] [ samm:property :hazardStatement; samm:payloadName "statement" ] ) . + +:RangeEntity a samm:Entity ; + samm:preferredName "Range Entity"@en ; + samm:description "Entity for the concentration range with two values, the highest and the lowest of the concentration range."@en ; + samm:properties ( [ samm:property :minConcentration; samm:optional true; samm:payloadName "min" ] [ samm:property :maxConcentration; samm:payloadName "max" ] ) . + +:MaterialIdEntity a samm:Entity ; + samm:preferredName "Material Id Entity"@en ; + samm:description "Id Entity with identifier, name and list type."@en ; + samm:properties ( [ samm:property :chemicalId; samm:payloadName "id" ] [ samm:property :listTypeId; samm:payloadName "type" ] [ samm:property :chemicalName; samm:payloadName "name" ] ) . + +:DocumentationEntity a samm:Entity ; + samm:preferredName "Documentation Entity"@en ; + samm:description "Entity for a document with a header, type and content."@en ; + samm:properties ( :content :contentType :header ) . + +:Share a samm-c:Measurement ; + samm:preferredName "share"@en ; + samm:description "The share represented in a float number in the unit percent."@en ; + samm:dataType xsd:float ; + samm-c:unit unit:percent . + +:PercentageConstraint a samm-c:RangeConstraint ; + samm:preferredName "Percentage Constraint"@en ; + samm:description "Range constraint for a positive percentage value."@en ; + samm-c:minValue "0.0"^^xsd:float ; + samm-c:maxValue "100.0"^^xsd:float ; + samm-c:lowerBoundDefinition samm-c:AT_LEAST ; + samm-c:upperBoundDefinition samm-c:AT_MOST . + +:hazardCategory a samm:Property ; + samm:preferredName "Hazard Category"@en ; + samm:description "The hazard category of the substance of concern. Defined in Article 2 of Regulation (EC) No 1272/2008 of the European Parliament and of the Council of 16 December 2008 on classification, labelling and packaging of substances and mixtures, amending and repealing Directives 67/548/EEC and 1999/45/EC, and amending Regulation (EC) No 1907/2006:\n2. 'hazard category' means the division of criteria within each hazard class, specifying hazard severity."@en ; + samm:see ; + samm:characteristic samm-c:Text ; + samm:exampleValue "category 1A" . + +:hazardClass a samm:Property ; + samm:preferredName "Hazard Class"@en ; + samm:description "The hazard class of the substance of concern. Defined in Article 2 of Regulation (EC) No 1272/2008 of the European Parliament and of the Council of 16 December 2008 on classification, labelling and packaging of substances and mixtures, amending and repealing Directives 67/548/EEC and 1999/45/EC, and amending Regulation (EC) No 1907/2006:\n1. 'hazard class' means the nature of the physical, health or environmental hazard."@en ; + samm:see ; + samm:characteristic samm-c:Text ; + samm:exampleValue "Skin corrosion" . + +:hazardStatement a samm:Property ; + samm:preferredName "Hazard Statement"@en ; + samm:description "The hazard statement of the substance of concern. Defined in Article 2 of Regulation (EC) No 1272/2008 of the European Parliament and of the Council of 16 December 2008 on classification, labelling and packaging of substances and mixtures, amending and repealing Directives 67/548/EEC and 1999/45/EC, and amending Regulation (EC) No 1907/2006:\n5. 'hazard statement' means a phrase assigned to a hazard class and category that describes the nature of the hazards of a hazardous substance or mixture, including, where appropriate, the degree of hazard."@en ; + samm:see ; + samm:characteristic samm-c:Text ; + samm:exampleValue "Causes severe skin burns and eye damage." . + +:minConcentration a samm:Property ; + samm:preferredName "Minimum Concentration"@en ; + samm:description "The minimum concentration of the substance of concern at the level of the product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7:\n(5) (c) [...] concentration range of the substances of concern, at the level of the product [...]."@en ; + samm:characteristic :PositiveTrait ; + samm:exampleValue "2.1"^^xsd:float . + +:maxConcentration a samm:Property ; + samm:preferredName "Maximum Concentration"@en ; + samm:description "The maximum concentration of the substance of concern at the level of the product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7:\n(5) (c) the concentration, maximum concentration or concentration range of the substances of concern, at the level of the product [...]."@en ; + samm:characteristic :PositiveTrait ; + samm:exampleValue "2.6"^^xsd:float . + +:chemicalId a samm:Property ; + samm:preferredName "Chemical Id"@en ; + samm:description "The substance identification, in accordance with the specification in the attribute for the list type."@en ; + samm:characteristic :IdentifierCharacteristic ; + samm:exampleValue "201-004-7" . + +:listTypeId a samm:Property ; + samm:preferredName "List Type Id"@en ; + samm:description "The type of standard used for the identification of the substances. Selected can be for example CAS, IUPAC or EC."@en ; + samm:characteristic :ListTypeEnumerationId ; + samm:exampleValue "CAS" . + +:chemicalName a samm:Property ; + samm:preferredName "Chemical Name"@en ; + samm:description "The name of the material which is present in the product."@en ; + samm:characteristic samm-c:Text ; + samm:exampleValue "phenolphthalein" . + +:ListTypeEnumerationId a samm-c:Enumeration ; + samm:preferredName "List Type Enumeration Id"@en ; + samm:description "Enumeration of different systems and organizations related to the identification and classification of chemical substances in the field of chemistry. The enumeration values are EC or CAS."@en ; + samm:see ; + samm:dataType xsd:string ; + samm-c:values ( "CAS" "EC" "IUPAC" ) . + diff --git a/io.catenax.battery.battery_pass/2.0.0/gen/BatteryPass-aas.xml b/io.catenax.generic.digital_product_passport/5.0.0/gen/DigitalProductPassport-aas.xml similarity index 53% rename from io.catenax.battery.battery_pass/2.0.0/gen/BatteryPass-aas.xml rename to io.catenax.generic.digital_product_passport/5.0.0/gen/DigitalProductPassport-aas.xml index 9e79c92d0..a7694b0a5 100644 --- a/io.catenax.battery.battery_pass/2.0.0/gen/BatteryPass-aas.xml +++ b/io.catenax.generic.digital_product_passport/5.0.0/gen/DigitalProductPassport-aas.xml @@ -10,7 +10,7 @@ - urn:samm:io.catenax.battery.battery_pass:2.0.0#BatteryPass + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#DigitalProductPassport Type @@ -20,7 +20,7 @@ Submodel - urn:samm:io.catenax.battery.battery_pass:2.0.0#BatteryPass/submodel + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#DigitalProductPassport/submodel @@ -29,22 +29,27 @@ - BatteryPass + DigitalProductPassport en - The battery pass describes information collected during the lifecycle of a battery + The Digital Product Passport (DPP) allows to share process and product-related information amongst supply chain businesses, authorities and consumers. The DPP allows for efficient information flows following best practices; and the possibility of accompanying the measures under this Regulation with mitigating measures so that impacts are expected to remain proportionate for SMEs.This is expected to increase transparency, both for supply chain businesses and for the general public, and increase efficiencies in terms of information transfer to support the data exchange between economic actors in integrating circularity in product design and manufacturing. +In particular, it is likely to help facilitate and streamline the monitoring and enforcement of the regulation carried out by EU and Member State authorities. It is also likely to provide a market-intelligence tool that may be used for revising and refining obligations in the future. +The DPP includes data about components, materials and chemical substances, information on reparability, spare parts, environmental impact and professional disposal for a product. +The data model will be updated, as newer versions of the regulation will be published. +The main basis is provided by the document "Proposal for a REGULATION OF THE EUROPEAN PARLIAMENT AND OF THE COUNCIL establishing a framework for setting ecodesign requirements for sustainable products and repealing Directive 2009/125/EC" from March 30th, 2022. The latest version of the document was the provisional agreement between the EU Council and the Parliament from January 9th, 2024. The text is informal, but the content of the final regulation was agreed between these two institutions. +The Title of Ecodesign Regulation has been changed to: Proposal for a REGULATION OF THE EUROPEAN PARLIAMENT AND OF THE COUNCIL establishing a framework for setting ecodesign requirements for sustainable products, amending Regulation (EU) 2023/1542 and repealing Directive 2009/125/EC. - urn:samm:io.catenax.battery.battery_pass:2.0.0#BatteryPass/submodel + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#DigitalProductPassport/submodel Template ModelReference ConceptDescription - urn:samm:io.catenax.battery.battery_pass:2.0.0#BatteryPass + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#DigitalProductPassport @@ -54,66 +59,310 @@ GlobalReference - https://eur-lex.europa.eu/legal-content/EN/TXT/?uri=CELEX:52020PC0798 + https://commission.europa.eu/energy-climate-change-environment/standards-tools-and-labels/products-labelling-rules-and-requirements/sustainable-products/ecodesign-sustainable-products_en + + + + + ExternalReference + + + GlobalReference + https://data.consilium.europa.eu/doc/document/ST-9014-2023-INIT/en/pdf + + + + + ExternalReference + + + GlobalReference + https://eur-lex.europa.eu/legal-content/EN/TXT/?uri=CELEX:52022PC0142 + + + + + ExternalReference + + + GlobalReference + https://eur-lex.europa.eu/legal-content/EN/TXT/PDF/?uri=CONSIL:ST_5147_2024_INIT - DocumentEntity + MetadataEntity + + + en + Metadata Entity + + + + + en + Passport Entity to describe version, status, end and issue date. + + + + + version + + + en + Version + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#version + + + + xs:string + + + + status + + + en + Status + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#status + + + + xs:string + + + + expirationDate + + + en + Expiration Date + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#expirationDate + + + + xs:string + + + + issueDate + + + en + Issue Date + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#issueDate + + + + xs:string + + + + economicOperatorId + + + en + Economic Operator Id + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#economicOperatorId + + + + xs:string + + + + passportIdentifier + + + en + Passport Identifier + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#passportIdentifier + + + + xs:string + + + + predecessor + + + en + Predecessor + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#predecessor + + + + xs:string + + + + backupReference + + + en + Backup Reference + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#backupReference + + + + xs:string + + + + registrationIdentifier + + + en + Registration Identifier + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#registrationIdentifier + + + + xs:string + + + + lastModification + + + en + Last Modification + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#lastModification + + + + xs:string + + + + + + IdentificationEntity en - document entity + Identification Entity en - Entity encapsulating the details of a attachment for the battery + Entity with identification information of the product with part type information, local identifiers, other codes and the data carrier. - packagingInstructions + serialInformation en - packaging instructions + Serial Information en - Instructions for safely packaging -batteries is describing a business requirement. + Identifier for a serial part if available. This is mentioned in the ESPR provisional agreement from January 9th, 2024 Recital (27): +[...] an 'item' usually means a single unit of a model. true DataElement - AttachmentEntity + KeyValueList en - AttachmentEntity + Key Value List en - Entity encapsulating the details of a attachment for the battery + A list of key value pairs for local identifiers, which are composed of a key and a corresponding value. - fileLocation + key en - file location + Identifier Key @@ -121,19 +370,19 @@ batteries is describing a business requirement. ConceptDescription - urn:samm:io.catenax.battery.battery_pass:2.0.0#fileLocation + urn:samm:io.catenax.serial_part:3.0.0#key - xs:anyURI + xs:string - title + value en - title + Identifier Value @@ -141,7 +390,7 @@ batteries is describing a business requirement. ConceptDescription - urn:samm:io.catenax.battery.battery_pass:2.0.0#title + urn:samm:io.catenax.serial_part:3.0.0#value @@ -153,44 +402,44 @@ batteries is describing a business requirement. - transportationInstructions + batchInformation en - transportation instructions + Batch Information en - Instructions for safely transporting -batteries is describing a business requirement. + Identifier for a batch part if available. Identifier for a serial part if available. This is mentioned in the ESPR provisional agreement from January 9th, 2024 Recital (27): +[...] a 'batch' usually means a subset of a specific model composed of all products produced in a specific manufacturing plant at a specific moment in time [...]. true DataElement - AttachmentEntity + KeyValueList en - AttachmentEntity + Key Value List en - Entity encapsulating the details of a attachment for the battery + A list of key value pairs for local identifiers, which are composed of a key and a corresponding value. - fileLocation + key en - file location + Identifier Key @@ -198,19 +447,19 @@ batteries is describing a business requirement. ConceptDescription - urn:samm:io.catenax.battery.battery_pass:2.0.0#fileLocation + urn:samm:io.catenax.batch:3.0.0#key - xs:anyURI + xs:string - title + value en - title + Identifier Value @@ -218,7 +467,7 @@ batteries is describing a business requirement. ConceptDescription - urn:samm:io.catenax.battery.battery_pass:2.0.0#title + urn:samm:io.catenax.batch:3.0.0#value @@ -229,120 +478,101 @@ batteries is describing a business requirement. - - vehicleDismantlingProcedure + + PartTypeEntity en - vehicle dismantling procedure + Part Type Entity en - Document containing the vehicle dismantling procedure is describing a regulatory requirement. + Entity for the part type with manufacturer id and name. - true - DataElement - - AttachmentEntity + + manufacturerPartId en - AttachmentEntity + Manufacturer Part ID - - + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.part_type_information:1.0.0#manufacturerPartId + + + + xs:string + + + + nameAtManufacturer + + en - Entity encapsulating the details of a attachment for the battery - - - - - fileLocation - - - en - file location - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.battery.battery_pass:2.0.0#fileLocation - - - - xs:anyURI - - - - title - - - en - title - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.battery.battery_pass:2.0.0#title - - - - xs:string - - - - + Name at manufacturer + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.part_type_information:1.0.0#nameAtManufacturer + + + + xs:string + + - + - batteryDismantlingProcedure + codes en - battery dismantling procedure + Codes en - Document containing the battery dismantling procedure is describing a regulatory requirement. + Codes for identification. true DataElement - AttachmentEntity + CodeEntity en - AttachmentEntity + Code Entity en - Entity encapsulating the details of a attachment for the battery + Code entity with code key and value. - fileLocation + codeKey en - file location + Code Key @@ -350,19 +580,19 @@ batteries is describing a business requirement. ConceptDescription - urn:samm:io.catenax.battery.battery_pass:2.0.0#fileLocation + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#codeKey - xs:anyURI + xs:string - title + codeValue en - title + Code Value @@ -370,7 +600,7 @@ batteries is describing a business requirement. ConceptDescription - urn:samm:io.catenax.battery.battery_pass:2.0.0#title + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#codeValue @@ -381,120 +611,121 @@ batteries is describing a business requirement. - - safetyMeasures + + DataCarrierEntity en - safety measures + Data Carrier Entity en - Safety measures document(s) is describing a regulatory requirement. + Data Carrier Entity with type and layout of the data carrier. - true - DataElement - - AttachmentEntity + + carrierType en - AttachmentEntity + Carrier Type - - + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#carrierType + + + + xs:string + + + + carrierLayout + + en - Entity encapsulating the details of a attachment for the battery - - - - - fileLocation - - - en - file location - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.battery.battery_pass:2.0.0#fileLocation - - - - xs:anyURI - - - - title - - - en - title - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.battery.battery_pass:2.0.0#title - - - - xs:string - - - - + Carrier Layout + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#carrierLayout + + + + xs:string + + - + - testReportsResults + partClassification en - test reports results + Part Classification en - Results of test reports which prove that the battery fulfills this regulation and its delegated regulations is describing a regulatory requirement. + Property describing the classification of a part. true DataElement - AttachmentEntity + ClassificationEntity en - AttachmentEntity + ClassificationEntity en - Entity encapsulating the details of a attachment for the battery + Encapsulates data related to the classification of the part. - fileLocation + classificationStandard + + + en + Classification Standard + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.shared.part_classification:1.0.0#classificationStandard + + + + xs:string + + + + classificationID en - file location + Classification ID @@ -502,19 +733,19 @@ batteries is describing a business requirement. ConceptDescription - urn:samm:io.catenax.battery.battery_pass:2.0.0#fileLocation + urn:samm:io.catenax.shared.part_classification:1.0.0#classificationID - xs:anyURI + xs:string - title + classificationDescription en - title + Classification Description @@ -522,7 +753,7 @@ batteries is describing a business requirement. ConceptDescription - urn:samm:io.catenax.battery.battery_pass:2.0.0#title + urn:samm:io.catenax.shared.part_classification:1.0.0#classificationDescription @@ -533,120 +764,174 @@ batteries is describing a business requirement. - - declarationOfConformity + + + + OperationEntity + + + en + Operation Entity + + + + + en + Operational information of the product such as the owner, manufacturer and importer. + + + + + ManufacturerEntity en - declaration of conformity + Manufacturer Entity en - Declaration of conformity (CE) is describing a regulatory requirement. + Manufacturing Entity with the identification of the main manufacturer and the facility location as well as the manufacturing date. - true - DataElement - - AttachmentEntity + + facilityIdentification en - AttachmentEntity + Facility Identification en - Entity encapsulating the details of a attachment for the battery + The identifier used for a location. In the CATENA-X use case, the BPNA can be stated. This attribute is mentioned in the ESPR provisional agreement from January 9th 2024 Annex III: +(i) unique facility identifiers; +Article 2 Definitions: (33) 'unique facility identifier' means a unique string of characters for the identification of locations or buildings involved in the value chain of a product or used by actors involved in the value chain of a product. + true + DataElement - - fileLocation + + FacilityEntity en - file location + Facility Entity - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.battery.battery_pass:2.0.0#fileLocation - - - - xs:anyURI - - - - title - - + + en - title - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.battery.battery_pass:2.0.0#title - - - - xs:string - - + The entity for a facility with the BPNA identifier. + + + + + facility + + + en + Facility + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#facility + + + + xs:string + + + + - + + + manufacturerIdentification + + + en + Manufacturer Identification + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#manufacturerIdentification + + + + xs:string + + + + manufacturingDate + + + en + Manufacturing Date + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#manufacturingDate + + + + xs:string + + - - - responsibleSourcing + + + ImportEntity en - responsible sourcing + Import Entity en - Document/Certificates on organizations compliance to ethical business practices + Import entity with attributes if applicable to the product. - true - DataElement - AttachmentEntity + ImporterEntity en - AttachmentEntity + Importer Entity en - Entity encapsulating the details of a attachment for the battery + Entity with information regarding the importer such as the identification and the EORI. - fileLocation + eori en - file location + EORI @@ -654,19 +939,30 @@ batteries is describing a business requirement. ConceptDescription - urn:samm:io.catenax.battery.battery_pass:2.0.0#fileLocation + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#eori - xs:anyURI + + + ExternalReference + + + GlobalReference + https://taxation-customs.ec.europa.eu/customs-4/customs-procedures-import-and-export-0/customs-procedures/economic-operators-registration-and-identification-number-eori_en + + + + + xs:string - title + importerIdentification en - title + Importer Identification @@ -674,7 +970,7 @@ batteries is describing a business requirement. ConceptDescription - urn:samm:io.catenax.battery.battery_pass:2.0.0#title + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#importerIdentification @@ -683,66 +979,49 @@ batteries is describing a business requirement. + + applicable + + + en + Applicable + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#applicable + + + + xs:boolean + + - - - - - ManufacturerEntity - - - en - manufacturer - - - - - en - Entity encapsulating the details of a manufacturer of goods - - - - - name - - - en - name - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.battery.battery_pass:2.0.0#name - - - - xs:string - - + - ContactEntity + OperatorEntity en - Contact Entity + Operator Entity en - Entity to bundle the properties for the information on how to contact an organization + Operator with role and identification. - website + otherOperatorId en - website + Other Operator Id @@ -750,19 +1029,19 @@ batteries is describing a business requirement. ConceptDescription - urn:samm:io.catenax.shared.contact_information:1.0.0#website + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#otherOperatorId - xs:anyURI + xs:string - phoneNumber + otherOperatorRole en - phone number + Other Operator Role @@ -770,91 +1049,259 @@ batteries is describing a business requirement. ConceptDescription - urn:samm:io.catenax.shared.contact_information:1.0.0#phoneNumber + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#otherOperatorRole xs:string - - email + + + + + + HandlingEntity + + + en + Handling Entity + + + + + en + Entity to describe different aspects in relation with the handling of the product with attributes if applicable to the product. + + + + + SparePartEntity + + + en + Spare Part Entity + + + + + en + Information regarding possible spare parts. This is mentioned in the ESPR proposal from March 30th, 2022 Annex I: +(b) ease of repair and maintenance as expressed through: characteristics, availability and delivery time of spare parts, modularity, compatibility with commonly available spare parts, availability of repair and maintenance instructions, number of materials and components used, use of standard components, use of component and material coding standards for the identification of components and materials, number and complexity of processes and tools needed, ease of non-destructive disassembly and re-assembly, conditions for access to product data, conditions for access to or use of hardware and software needed; +(c) the Global Trade Identification Number as provided for in standard ISO/IEC 15459-6 or equivalent of products or their parts. + + + + + sparePartSources en - email + Spare Part Sources - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.shared.contact_information:1.0.0#email - - - - xs:string - - - - faxNumber + + + en + Sources of possible spare parts. + + + true + DataElement + + + SourcesEntity + + + en + Sources Entity + + + + + en + Entity for a possible spare part sources. + + + + + sourcesIdentification + + + en + Sources Identification + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#sourcesIdentification + + + + xs:string + + + + + + + + sparePart en - faxNumber + Spare Part - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.shared.contact_information:1.0.0#faxNumber - - - - xs:string - - + + + en + Possible spare parts of the product. + + + true + DataElement + + + PartsEntity + + + en + Parts Entity + + + + + en + Possible spare parts of the product with identifiers and names. + + + + + manufacturerPartId + + + en + Manufacturer Part ID + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.part_type_information:1.0.0#manufacturerPartId + + + + xs:string + + + + nameAtManufacturer + + + en + Name at manufacturer + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.part_type_information:1.0.0#nameAtManufacturer + + + + xs:string + + + + + + - - AddressEntity + + applicable + + + en + Applicable + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#applicable + + + + xs:boolean + + + + + + CharacteristicsEntity + + + en + Characteristics Entity + + + + + en + Entity which defines specific characteristics of a product such as different life spans and physical dimensions. + + + + + lifespan en - Address Entity + Lifespan en - Entity of an address. Model follows specification of BPDM (Business Partner Data Management). + The type of lifespan represented with the values guaranteed lifetime, technical lifetime and mean time between failures. Both can be described through the attributes: type, which defines the type such as guaranteed lifetime or technical lifetime, the unit for the lifetime, and the value represented by an integer. These attributes are mentioned in the ESPR proposal from March 30th, 2022 ANNEX I: +(a) durability and reliability of the product or its components as expressed through the products guaranteed lifetime, technical lifetime [or] mean time between failures [...]. + true + DataElement - ThoroughfareEntity + LifespanEntity en - Thoroughfare Entity + Lifespan Entity en - Entity for a thoroughfare which consists of a type, value and number. + Entity for the lifespan of a product with type, unit and value. - thoroughfareTechnicalKey + lifeUnit en - Thoroughfare Technical Key + Life Unit @@ -862,19 +1309,30 @@ batteries is describing a business requirement. ConceptDescription - urn:samm:io.catenax.shared.address_characteristic:1.0.1#thoroughfareTechnicalKey + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#lifeUnit + + + ExternalReference + + + GlobalReference + https://eclipse-esmf.github.io/samm-specification/2.1.0/index.html + + + + xs:string - thoroughfareValue + lifeValue en - Value Thoroughfare + Life Value @@ -882,19 +1340,19 @@ batteries is describing a business requirement. ConceptDescription - urn:samm:io.catenax.shared.address_characteristic:1.0.1#thoroughfareValue + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#lifeValue - xs:string + xs:integer - thoroughfareNumber + lifeType en - Thoroughfare Number + Life Type @@ -902,7 +1360,7 @@ batteries is describing a business requirement. ConceptDescription - urn:samm:io.catenax.shared.address_characteristic:1.0.1#thoroughfareNumber + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#lifeType @@ -911,27 +1369,44 @@ batteries is describing a business requirement. + + + + PhysicalDimensionEntity + + + en + Physical Dimension Entity + + + + + en + Entity for physical dimensions with linear, mass and capacity attributes. Either weight or volume is mandatory. + + + - LocalityEntity + LinearEntity en - Thoroughfare Entity + Linear Entity en - Entity for a thoroughfare which consists of a type, value and number. + Entity for linear measurements of an item with an unit and value. - localityTechnicalKey + quantityValue en - Locality Technical Key + Quantity Value @@ -939,19 +1414,19 @@ batteries is describing a business requirement. ConceptDescription - urn:samm:io.catenax.shared.address_characteristic:1.0.1#localityTechnicalKey + urn:samm:io.catenax.shared.quantity:2.0.0#quantityValue - xs:string + xs:float - localityValue + linearUnit en - Locality Value + Linear Unit @@ -959,36 +1434,47 @@ batteries is describing a business requirement. ConceptDescription - urn:samm:io.catenax.shared.address_characteristic:1.0.1#localityValue + urn:samm:io.catenax.shared.quantity:2.0.0#linearUnit + + + ExternalReference + + + GlobalReference + https://eclipse-esmf.github.io/samm-specification/2.1.0/index.html + + + + xs:string - PremiseEntity + LinearEntity en - Premise Entity + Linear Entity en - Entity for a premise which consists of a type (technical key) and a value + Entity for linear measurements of an item with an unit and value. - premiseTechnicalKey + quantityValue en - Premise Technical Key + Quantity Value @@ -996,19 +1482,19 @@ batteries is describing a business requirement. ConceptDescription - urn:samm:io.catenax.shared.address_characteristic:1.0.1#premiseTechnicalKey + urn:samm:io.catenax.shared.quantity:2.0.0#quantityValue - xs:string + xs:float - premiseValue + linearUnit en - Premise Value + Linear Unit @@ -1016,36 +1502,47 @@ batteries is describing a business requirement. ConceptDescription - urn:samm:io.catenax.shared.address_characteristic:1.0.1#premiseValue + urn:samm:io.catenax.shared.quantity:2.0.0#linearUnit + + + ExternalReference + + + GlobalReference + https://eclipse-esmf.github.io/samm-specification/2.1.0/index.html + + + + xs:string - PostalDeliveryPointEntity + LinearEntity en - Postal Delivery Point Entity + Linear Entity en - Entity for a postal delivery point which consists of a technical key and a value. + Entity for linear measurements of an item with an unit and value. - postalDeliveryPointTechnicalKey + quantityValue en - Postal Delivery Point Technical Key + Quantity Value @@ -1053,19 +1550,19 @@ batteries is describing a business requirement. ConceptDescription - urn:samm:io.catenax.shared.address_characteristic:1.0.1#postalDeliveryPointTechnicalKey + urn:samm:io.catenax.shared.quantity:2.0.0#quantityValue - xs:string + xs:float - postalDeliveryPointValue + linearUnit en - Postal Delivery Point Value + Linear Unit @@ -1073,36 +1570,67 @@ batteries is describing a business requirement. ConceptDescription - urn:samm:io.catenax.shared.address_characteristic:1.0.1#postalDeliveryPointValue + urn:samm:io.catenax.shared.quantity:2.0.0#linearUnit + + + ExternalReference + + + GlobalReference + https://eclipse-esmf.github.io/samm-specification/2.1.0/index.html + + + + xs:string - CountryEntity + LinearEntity en - Country Entity + Linear Entity en - Entity definition for a country + Entity for linear measurements of an item with an unit and value. - countryShortName + quantityValue + + + en + Quantity Value + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.shared.quantity:2.0.0#quantityValue + + + + xs:float + + + + linearUnit en - Country Short Name + Linear Unit @@ -1110,36 +1638,47 @@ batteries is describing a business requirement. ConceptDescription - urn:samm:io.catenax.shared.address_characteristic:1.0.1#countryShortName + urn:samm:io.catenax.shared.quantity:2.0.0#linearUnit + + + ExternalReference + + + GlobalReference + https://eclipse-esmf.github.io/samm-specification/2.1.0/index.html + + + + xs:string - PostCodeEntity + MassEntity en - PostCode Entity + Mass Entity en - Entity for a postcode which consists of a type plus a value + Entity for mass measurements of an item with an unit and value. - postCodeValue + quantityValue en - Post Code Value + Quantity Value @@ -1147,19 +1686,19 @@ batteries is describing a business requirement. ConceptDescription - urn:samm:io.catenax.shared.address_characteristic:1.0.1#postCodeValue + urn:samm:io.catenax.shared.quantity:2.0.0#quantityValue - xs:string + xs:float - postCodeTechnicalKey + massUnit en - Post Code Technical Key + Mass Unit @@ -1167,86 +1706,332 @@ batteries is describing a business requirement. ConceptDescription - urn:samm:io.catenax.shared.address_characteristic:1.0.1#postCodeTechnicalKey + urn:samm:io.catenax.shared.quantity:2.0.0#massUnit + + + ExternalReference + + + GlobalReference + https://eclipse-esmf.github.io/samm-specification/2.1.0/index.html + + + + xs:string - - - - - - ElectrochemicalPropertiesEntity - - - en - electrochemical properties entity - - - - - en - Entity encapsulating the electrochemical details of a battery - - - - - BatteryPowerEntity - - - en - battery power entity - - - - - en - Entity to bundle the power properties of a battery. - - - - - maximumAllowedBatteryPower + + VolumeEntity en - maximum allowed battery power + Volume Entity - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.battery.battery_pass:2.0.0#maximumAllowedBatteryPower - - - - - - ExternalReference - - - GlobalReference - file:///Users/AGG3FE/IdeaProjects/sldt-semantic-models/https%3A%2F%2Feur-lex.europa.eu%2Flegal-content%2FEN%2FTXT%2F%3Furi%3DCELEX%3A52020PC0798 - - - - - xs:float - - - - originalPower - - - en - battery original power + + + en + Entity for volume measurements of an item with an unit and value. + + + + + quantityValue + + + en + Quantity Value + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.shared.quantity:2.0.0#quantityValue + + + + xs:float + + + + volumeUnit + + + en + Volume Unit + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.shared.quantity:2.0.0#volumeUnit + + + + + + ExternalReference + + + GlobalReference + https://eclipse-esmf.github.io/samm-specification/2.1.0/index.html + + + + + xs:string + + + + + + MassEntity + + + en + Mass Entity + + + + + en + Entity for mass measurements of an item with an unit and value. + + + + + quantityValue + + + en + Quantity Value + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.shared.quantity:2.0.0#quantityValue + + + + xs:float + + + + massUnit + + + en + Mass Unit + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.shared.quantity:2.0.0#massUnit + + + + + + ExternalReference + + + GlobalReference + https://eclipse-esmf.github.io/samm-specification/2.1.0/index.html + + + + + xs:string + + + + + + VolumeEntity + + + en + Volume Entity + + + + + en + Entity for volume measurements of an item with an unit and value. + + + + + quantityValue + + + en + Quantity Value + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.shared.quantity:2.0.0#quantityValue + + + + xs:float + + + + volumeUnit + + + en + Volume Unit + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.shared.quantity:2.0.0#volumeUnit + + + + + + ExternalReference + + + GlobalReference + https://eclipse-esmf.github.io/samm-specification/2.1.0/index.html + + + + + xs:string + + + + + + + + physicalState + + + en + Physical State + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#physicalState + + + + xs:string + + + + generalPerformanceClass + + + en + General Performance Class + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#generalPerformanceClass + + + + xs:string + + + + + + CommercialEntity + + + en + Commercial Entity + + + + + en + Commercial information. + + + + + placedOnMarket + + + en + Placed on Market + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#placedOnMarket + + + + xs:string + + + + purpose + + + en + Purpose + + + + + en + One or more intended industry/industries of the product described by the digital product passport. If exchanged via Catena-X, 'automotive ' is a must choice included in the list. + + + true + DataElement + + + purpose + + + en + Purpose @@ -1254,19 +2039,53 @@ batteries is describing a business requirement. ConceptDescription - urn:samm:io.catenax.battery.battery_pass:2.0.0#originalPower + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#purpose - xs:float + xs:string + + + + + + MaterialsEntity + + + en + Materials Entity + + + + + en + Entity with materials on the level of the product. + + + + + SubstanceOfConcernEntity + + + en + Substance Of Concern Entity + + + + + en + Substance of Concern entity with attributes if applicable to the product. + + + - powerFade + applicable en - maximum allowed battery power + Applicable @@ -1274,1820 +2093,1499 @@ batteries is describing a business requirement. ConceptDescription - urn:samm:io.catenax.battery.battery_pass:2.0.0#powerFade + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#applicable - - - ExternalReference - - - GlobalReference - https://eur-lex.europa.eu/legal-content/EN/TXT/?uri=CELEX:52020PC0798 - - - - - xs:float + xs:boolean - - powerCapabilityAt20Charge + + substanceOfConcern en - power capability at 20 charge + Substance of Concern - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.battery.battery_pass:2.0.0#powerCapabilityAt20Charge - - - - xs:float - - - - powerCapabilityAt80Charge - - - en - power capability at 80 charge - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.battery.battery_pass:2.0.0#powerCapabilityAt80Charge - - - - xs:float - - - - originalPowerCapability - - - en - original power capability - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.battery.battery_pass:2.0.0#originalPowerCapability - - - - xs:decimal - - - - originalPowerCapabilityLimits - - - en - original power capability limits - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.battery.battery_pass:2.0.0#originalPowerCapabilityLimits - - - - xs:decimal - - - - - - BatteryVoltageEntity - - - en - battery voltage entity - - - - - en - Entity to bundle the voltage properties of a battery. - - - - - minVoltage - - - en - min voltage - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.battery.battery_pass:2.0.0#minVoltage - - - - xs:float - - - - nominalVoltage - - - en - nominal voltage - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.battery.battery_pass:2.0.0#nominalVoltage - - - - xs:float - - - - maxVoltage - - - en - max voltage - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.battery.battery_pass:2.0.0#maxVoltage - - - - xs:float - - - - - - ratedCapacity - - - en - rated capacity - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.battery.battery_pass:2.0.0#ratedCapacity - - - - xs:decimal - - - - capacityFade - - - en - capacity fade - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.battery.battery_pass:2.0.0#capacityFade - - - - xs:decimal - - - - InternalResistanceEntity - - - en - internal resistance - - - - - en - Entity to bundle the internal resistance properties of a battery. - - - - - cellInternalResistance - - - en - cell internal resistance - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.battery.battery_pass:2.0.0#cellInternalResistance - - - - xs:decimal - - - - packInternalResistance - - - en - pack internal resistance - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.battery.battery_pass:2.0.0#packInternalResistance - - - - xs:decimal - - - - packInternalResistanceIncrease - - - en - pack internal resistanceIncrease - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.battery.battery_pass:2.0.0#packInternalResistanceIncrease - - - - xs:decimal - - - - - - capacityThresholdExhaustion - - - en - internal resistance - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.battery.battery_pass:2.0.0#capacityThresholdExhaustion - - - - xs:decimal - - - - BatteryEnergyEntity - - - en - battery energy entity - - - - - en - Entity to bundle the energy properties of a battery. - - - - - maximumAllowedBatteryEnergy - - + + en - maximum allowed battery energy - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.battery.battery_pass:2.0.0#maximumAllowedBatteryEnergy - - - - - - ExternalReference - - - GlobalReference - file:///Users/AGG3FE/IdeaProjects/sldt-semantic-models/https%3A%2F%2Feur-lex.europa.eu%2Flegal-content%2FEN%2FTXT%2F%3Furi%3DCELEX%3A52020PC0798 - - - - - xs:float - - - - energyRoundtripEfficiency - - - en - energy roundtrip efficiency - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.battery.battery_pass:2.0.0#energyRoundtripEfficiency - - - - xs:decimal - - - - energyRoundtripEfficiencyChange - - - en - energy roundtrip efficiency - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.battery.battery_pass:2.0.0#energyRoundtripEfficiencyChange - - - - xs:decimal - - - - - - ratioMaximumAllowedBatteryPowerAndMaximumAllowedBatteryEnergy - - - en - ratio maximum allowed battery power and maximum allowed battery energy - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.battery.battery_pass:2.0.0#ratioMaximumAllowedBatteryPowerAndMaximumAllowedBatteryEnergy - - - - xs:float - - - - - - PhysicalDimensionsEntity - - - en - physical dimensions entity - - - - - en - Entity to bundle the characterisitics describing the physical dimensions - - - - - length - - - en - length - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.battery.battery_pass:2.0.0#length - - - - xs:integer - - - - width - - - en - width - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.battery.battery_pass:2.0.0#width - - - - xs:integer - - - - height - - - en - height - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.battery.battery_pass:2.0.0#height - - - - xs:integer - - - - diameter - - - en - diameter - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.battery.battery_pass:2.0.0#diameter - - - - xs:integer - - - - weight - - - en - weight - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.battery.battery_pass:2.0.0#weight - - - - xs:integer - - - - - - StateOfBatteryEntity - - - en - state of battery entity - - - - - en - Entity to bundle the characterisitics describing the state of a battery - - - - - stateOfHealth - - - en - state of health - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.battery.battery_pass:2.0.0#stateOfHealth - - - - xs:integer - - - - stateOfCharge - - - en - state of charge - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.battery.battery_pass:2.0.0#stateOfCharge - - - - xs:integer - - - - statusBattery - - - en - status battery - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.battery.battery_pass:2.0.0#statusBattery - - - - xs:string - - - - - - BatteryIdentificationEntity - - - en - battery identification entity - - - - - en - Entity to bundle the characterisitics describing the identification of a battery - - - - - batteryType - - - en - battery type - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.battery.battery_pass:2.0.0#batteryType - - - - xs:string - - - - batteryModel - - - en - battery model - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.battery.battery_pass:2.0.0#batteryModel - - - - xs:string - - - - batteryIDDMCCode - - - en - battery ID DMC code - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.battery.battery_pass:2.0.0#batteryIDDMCCode - - - - xs:string - - - - - - ManufacturingEntity - - - en - manufacturing entity - - - - - en - Entity to bundle the characterisitics describing the manufacturing (place and date of manufacture) - - - - - dateOfManufacturing - - - en - date of manufacturing - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.battery.battery_pass:2.0.0#dateOfManufacturing - - - - xs:date - - - - AddressEntity - - - en - Address Entity - - - - - en - Entity of an address. Model follows specification of BPDM (Business Partner Data Management). - - - - - ThoroughfareEntity - - - en - Thoroughfare Entity - - - - - en - Entity for a thoroughfare which consists of a type, value and number. - - - - - thoroughfareTechnicalKey - - - en - Thoroughfare Technical Key - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.shared.address_characteristic:1.0.1#thoroughfareTechnicalKey - - - - xs:string - - - - thoroughfareValue - - - en - Value Thoroughfare - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.shared.address_characteristic:1.0.1#thoroughfareValue - - - - xs:string - - - - thoroughfareNumber - - - en - Thoroughfare Number - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.shared.address_characteristic:1.0.1#thoroughfareNumber - - - - xs:string - - - - - - LocalityEntity - - - en - Thoroughfare Entity - - - - - en - Entity for a thoroughfare which consists of a type, value and number. - - - - - localityTechnicalKey - - - en - Locality Technical Key - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.shared.address_characteristic:1.0.1#localityTechnicalKey - - - - xs:string - - - - localityValue - - - en - Locality Value - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.shared.address_characteristic:1.0.1#localityValue - - - - xs:string - - - - - - PremiseEntity - - - en - Premise Entity - - - - - en - Entity for a premise which consists of a type (technical key) and a value - - - - - premiseTechnicalKey - - - en - Premise Technical Key - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.shared.address_characteristic:1.0.1#premiseTechnicalKey - - - - xs:string - - - - premiseValue - - - en - Premise Value - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.shared.address_characteristic:1.0.1#premiseValue - - - - xs:string - - - - - - PostalDeliveryPointEntity - - - en - Postal Delivery Point Entity - - - - - en - Entity for a postal delivery point which consists of a technical key and a value. - - - - - postalDeliveryPointTechnicalKey - - - en - Postal Delivery Point Technical Key - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.shared.address_characteristic:1.0.1#postalDeliveryPointTechnicalKey - - - - xs:string - - - - postalDeliveryPointValue - - - en - Postal Delivery Point Value - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.shared.address_characteristic:1.0.1#postalDeliveryPointValue - - - - xs:string - - - - - - CountryEntity - - - en - Country Entity - - - - - en - Entity definition for a country - - - - - countryShortName - - - en - Country Short Name - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.shared.address_characteristic:1.0.1#countryShortName - - - - xs:string - - - - - - PostCodeEntity - - - en - PostCode Entity - - - - - en - Entity for a postcode which consists of a type plus a value - - - - - postCodeValue - - - en - Post Code Value - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.shared.address_characteristic:1.0.1#postCodeValue - - - - xs:string - - - - postCodeTechnicalKey - - - en - Post Code Technical Key - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.shared.address_characteristic:1.0.1#postCodeTechnicalKey - - - - xs:string - - - - - - - - - - datePlacedOnMarket - - - en - date placed on market - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.battery.battery_pass:2.0.0#datePlacedOnMarket - - - - xs:date - - - - CellChemistryEntity - - - en - cell chemistry - - - - - en - Entity to bundle the characterisitics describing a battery's cell chemistry - - - - - cathodeActiveMaterials - - - en - cathode active materials - - - - - en - The total amount of valuable materials contained in CAM material: Nickel, Cobalt, Lithium. - - - true - DataElement - - - MaterialNameAndWeightAndPercentageMassFractionEntity - - - en - material name and weight and percent - - - - - en - Entity to bundle a material's name, weight and percentage of mass. - - - - - matierialPercentageMassFraction - - - en - matierial percentage mass fraction - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.battery.battery_pass:2.0.0#matierialPercentageMassFraction - - - - xs:decimal - - - - matierialWeight - - - en - material weight - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.battery.battery_pass:2.0.0#matierialWeight - - - - xs:decimal - - - - materialName - - - en - material name - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.battery.battery_pass:2.0.0#materialName - - - - xs:string - - - - - - - - recyclateContentActiveMaterials - - - en - recyclate content active materials - - - - - en - List of recovered Recyclate Content in Active Material Recycled is describing a regulatory requirement. The following materials have to be reported on as a minimium: Cobalt, Lithium, Nickel, Lead - - - true - DataElement - - - MaterialNameAndWeightAndPercentageMassFractionEntity - - - en - material name and weight and percent - - - - - en - Entity to bundle a material's name, weight and percentage of mass. - - - - - matierialPercentageMassFraction - - - en - matierial percentage mass fraction - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.battery.battery_pass:2.0.0#matierialPercentageMassFraction - - - - xs:decimal - - - - matierialWeight - - - en - material weight - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.battery.battery_pass:2.0.0#matierialWeight - - - - xs:decimal - - - - materialName - - - en - material name - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.battery.battery_pass:2.0.0#materialName - - - - xs:string - - - - - - - - anodeActiveMaterials - - - en - anode active materials - - - - - en - The total amount of valuable materials contained in Anode: graphite - - - true - DataElement - - - MaterialNameAndWeightAndPercentageMassFractionEntity - - - en - material name and weight and percent - - - - - en - Entity to bundle a material's name, weight and percentage of mass. + Information regarding substances of concern in the product. Attributes are among others substance names, ids, concentration, location and hazard class. This is mentioned in the ESPR provisional agreement from January 9th, 2024 Article 7: +(5) (a) the name of the substances of concern present in the product, as follows: +- name(s) in the International Union of Pure and Applied Chemistry (IUPAC) nomenclature, or another international name when IUPAC name is not available; +- other names (usual name, trade name, abbreviation); +- European Community (EC) number, as indicated in the European Inventory of Existing Commercial Chemical Substances (EINECS), the European List of Notified Chemical Substances (ELINCS) or the No Longer Polymer (NLP) list or assigned by the European Chemicals Agency (ECHA), if available; +- the Chemical Abstract Service (CAS) name(s) and number(s), if available; +(5) (b) the location of the substances of concern within the product. +(5) (c) the concentration, maximum concentration or concentration range of the substances of concern, at the level of the product its relevant components, or spare parts; +(d) relevant instructions for the safe use of the product; +(e) information relevant for disassembly, preparation for reuse, reuse, recycling and the environmentally sound management of the product at the end of its life. +And in the next paragraph: +(c) provide duly justified exemptions for substances of concern or information elements from the information requirements referred to in the first subparagraph. + true + DataElement - - matierialPercentageMassFraction - - - en - matierial percentage mass fraction - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.battery.battery_pass:2.0.0#matierialPercentageMassFraction - - - - xs:decimal - - - - matierialWeight + + SubstanceEntity en - material weight + Substance Entity - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.battery.battery_pass:2.0.0#matierialWeight - - - - xs:decimal - - - - materialName - - + + en - material name - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.battery.battery_pass:2.0.0#materialName - - - - xs:string - - + Information regarding substances of concern in the product. + + + + + location + + + en + Location + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#location + + + + xs:string + + + + materialUnit + + + en + Material Unit + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#materialUnit + + + + + + ExternalReference + + + GlobalReference + https://eclipse-esmf.github.io/samm-specification/2.1.0/index.html + + + + + xs:string + + + + concentration + + + en + Concentration + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#concentration + + + + xs:float + + + + exemption + + + en + Exemption + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#exemption + + + + xs:string + + + + HazardEntity + + + en + Hazard Entity + + + + + en + Entity for the hazardous classification. + + + + + ExternalReference + + + GlobalReference + https://eur-lex.europa.eu/legal-content/EN/TXT/?uri=CELEX:02008R1272-20231201 + + + + + + + hazardCategory + + + en + Hazard Category + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#hazardCategory + + + + + + ExternalReference + + + GlobalReference + https://eur-lex.europa.eu/legal-content/EN/TXT/?uri=CELEX:02008R1272-20231201 + + + + + xs:string + + + + hazardClass + + + en + Hazard Class + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#hazardClass + + + + + + ExternalReference + + + GlobalReference + https://eur-lex.europa.eu/legal-content/EN/TXT/?uri=CELEX:02008R1272-20231201 + + + + + xs:string + + + + hazardStatement + + + en + Hazard Statement + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#hazardStatement + + + + + + ExternalReference + + + GlobalReference + https://eur-lex.europa.eu/legal-content/EN/TXT/?uri=CELEX:02008R1272-20231201 + + + + + xs:string + + + + + + concentrationRange + + + en + Concentration Range + + + + + en + The concentration range for the substance of concern. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7: +(5) (c) [...] concentration range of the substances of concern, at the level of the product [...]. + + + true + DataElement + + + RangeEntity + + + en + Range Entity + + + + + en + Entity for the concentration range with two values, the highest and the lowest of the concentration range. + + + + + minConcentration + + + en + Minimum Concentration + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#minConcentration + + + + xs:float + + + + maxConcentration + + + en + Maximum Concentration + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#maxConcentration + + + + xs:float + + + + + + + + materialIdentification + + + en + Material Identification + + + + + en + The chemical material name and identification, in accordance with the specification in the attribute for the list type. Preference is given to the IUPAC name. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Article 7: +(5) (a) the name of the substances of concern present in the product, as follows: + - name(s) in the International Union of Pure and Applied Chemistry (IUPAC) nomenclature, or another international name when IUPAC name is not available; +- other names (usual name, trade name, abbreviation); +- European Community (EC) number, as indicated in the European Inventory of Existing Commercial Chemical Substances (EINECS), the European List of Notified Chemical Substances (ELINCS) or the No Longer Polymer (NLP) list or assigned by the European Chemicals Agency (ECHA), if available; +- the Chemical Abstract Service (CAS) name(s) and number(s), if available; . + + + true + DataElement + + + MaterialIdEntity + + + en + Material Id Entity + + + + + en + Id Entity with identifier, name and list type. + + + + + chemicalId + + + en + Chemical Id + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#chemicalId + + + + xs:string + + + + listTypeId + + + en + List Type Id + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#listTypeId + + + + xs:string + + + + chemicalName + + + en + Chemical Name + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#chemicalName + + + + xs:string + + + + + + + + documentation + + + en + Documentation + + + + + en + Documentation accompanying the material. + + + true + DataElement + + + DocumentationEntity + + + en + Documentation Entity + + + + + en + Entity for a document with a header, type and content. + + + + + content + + + en + Content + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + xs:string + + + + contentType + + + en + Content Type + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + xs:string + + + + header + + + en + Header + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + xs:string + + + + + + + + - + - - - cathodeCompositionOther + + + ChemicalMaterialEntity en - cathode composition other + Chemical Material Entity en - The composition or materials contained in the Cathode is describing a regulatory requirement. + Material entity with attributes if applicable to the product. - true - DataElement - - MaterialNameAndWeightAndPercentageMassFractionEntity + + applicable en - material name and weight and percent + Applicable - - - en - Entity to bundle a material's name, weight and percentage of mass. - - - - - matierialPercentageMassFraction - - - en - matierial percentage mass fraction - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.battery.battery_pass:2.0.0#matierialPercentageMassFraction - - - - xs:decimal - - - - matierialWeight - - - en - material weight - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.battery.battery_pass:2.0.0#matierialWeight - - - - xs:decimal - - - - materialName - - - en - material name - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.battery.battery_pass:2.0.0#materialName - - - - xs:string - - - - - - - - anodeCompositionOther - - - en - anode composition other - - - - - en - The composition or materials contained in the anode is describing a regulatory requirement. - - - true - DataElement - - - MaterialNameAndWeightAndPercentageMassFractionEntity + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#applicable + + + + xs:boolean + + + + chemicalMaterial en - material name and weight and percent + Material en - Entity to bundle a material's name, weight and percentage of mass. + Information on different materials in the product. + true + DataElement - - matierialPercentageMassFraction - - - en - matierial percentage mass fraction - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.battery.battery_pass:2.0.0#matierialPercentageMassFraction - - - - xs:decimal - - - - matierialWeight + + MaterialEntity en - material weight + Material Entity - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.battery.battery_pass:2.0.0#matierialWeight - - - - xs:decimal - - - - materialName - - + + en - material name - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.battery.battery_pass:2.0.0#materialName - - - - xs:string - - + Information regarding recycled and/or renewable materials in the product. + + + + + recycled + + + en + Recycled + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#recycled + + + + xs:float + + + + renewable + + + en + Renewable + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#renewable + + + + xs:float + + + + materialUnit + + + en + Material Unit + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#materialUnit + + + + + + ExternalReference + + + GlobalReference + https://eclipse-esmf.github.io/samm-specification/2.1.0/index.html + + + + + xs:string + + + + materialIdentification + + + en + Material Identification + + + + + en + The chemical material name and identification, in accordance with the specification in the attribute for the list type. Preference is given to the IUPAC name. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Article 7: +(5) (a) the name of the substances of concern present in the product, as follows: + - name(s) in the International Union of Pure and Applied Chemistry (IUPAC) nomenclature, or another international name when IUPAC name is not available; +- other names (usual name, trade name, abbreviation); +- European Community (EC) number, as indicated in the European Inventory of Existing Commercial Chemical Substances (EINECS), the European List of Notified Chemical Substances (ELINCS) or the No Longer Polymer (NLP) list or assigned by the European Chemicals Agency (ECHA), if available; +- the Chemical Abstract Service (CAS) name(s) and number(s), if available; . + + + true + DataElement + + + MaterialIdEntity + + + en + Material Id Entity + + + + + en + Id Entity with identifier, name and list type. + + + + + chemicalId + + + en + Chemical Id + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#chemicalId + + + + xs:string + + + + listTypeId + + + en + List Type Id + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#listTypeId + + + + xs:string + + + + chemicalName + + + en + Chemical Name + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#chemicalName + + + + xs:string + + + + + + + + critical + + + en + Critical + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#critical + + + + + + ExternalReference + + + GlobalReference + https://eur-lex.europa.eu/legal-content/EN/TXT/?uri=COM:2023:0160:FIN + + + + + xs:boolean + + + + concentration + + + en + Concentration + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#concentration + + + + xs:float + + + + documentation + + + en + Documentation + + + + + en + Documentation accompanying the material. + + + true + DataElement + + + DocumentationEntity + + + en + Documentation Entity + + + + + en + Entity for a document with a header, type and content. + + + + + content + + + en + Content + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + xs:string + + + + contentType + + + en + Content Type + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + xs:string + + + + header + + + en + Header + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + xs:string + + + + + + + + - + - - - electrolyteComposition + + + + + SustainabilityEntity + + + en + Sustainability Entity + + + + + en + Entity with the properties regarding the sustainability of the product. + + + + + state + + + en + State + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#state + + + + xs:string + + + + ProductFootprintEntity en - electrolyte composition + Product Footprint Entity en - List of materials contained in the electrolyte is describing a regulatory requirement. + The Product Footprint Entity with sustainability information such as the different environmental footprint types, the carbon and material footprint explicitly, applicable rules and lifecycle stages. - - - ExternalReference - - - GlobalReference - https://eur-lex.europa.eu/legal-content/EN/TXT/?uri=CELEX:52020DC0474 - - - - - true - DataElement - - MaterialNameAndWeightAndPercentageMassFractionEntity + + environmentalFootprint en - material name and weight and percent + Environmental Footprint en - Entity to bundle a material's name, weight and percentage of mass. + The environmental footprint of the product. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I: +The following parameters shall, as appropriate, and where necessary supplemented by others, be used, individually or combined, as a basis for improving the product aspects referred to in Article 5(1): +(l) the environmental footprint of the product, expressed as a quantification, in accordance with the applicable delegated act, of a product's life cycle environmental impacts, whether in relation to one or more environmental impact categories or an aggregated set of impact categories. +and Article 7: +(2)(b)(i) information on the performance of the product in relation to one or more of the product parameters referred to in Annex I, including a scoring of reparability or durability, carbon footprint or environmental footprint; +and defined by Article 2: +(23) 'environmental footprint' means a quantification of product environmental impacts throughout its life cycle, whether in relation to a single environmental impact category or an aggregated set of impact categories based on the Product Environmental Footprint method or other scientific methods developed by international organisations and widely tested in collaboration with different industry sectors and adopted or implemented by the Commission in other Union legislation; +(24) 'Product Environmental Footprint method' means the life cycle assessment method to quantify the environmental impacts of products established by Recommendation (EU) 2021/2279. + true + DataElement - - matierialPercentageMassFraction - - - en - matierial percentage mass fraction - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.battery.battery_pass:2.0.0#matierialPercentageMassFraction - - - - xs:decimal - - - - matierialWeight + + FootprintEntity en - material weight + Footprint Entity - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.battery.battery_pass:2.0.0#matierialWeight - - - - xs:decimal - - - - materialName - - + + en - material name - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.battery.battery_pass:2.0.0#materialName - - - - xs:string - - + Footprint Entity for the carbon and environmental footprint with the total value, unit, impact category type, lifecycle, rulebook, declaration, performance class and the facility. + + + + + footprintValue + + + en + Footprint Value + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#footprintValue + + + + xs:float + + + + footprintRulebook + + + en + Footprint Rulebook + + + + + en + The applied rulebook for the environmental footprint of the product. + + + true + DataElement + + + DocumentationEntity + + + en + Documentation Entity + + + + + en + Entity for a document with a header, type and content. + + + + + content + + + en + Content + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + xs:string + + + + contentType + + + en + Content Type + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + xs:string + + + + header + + + en + Header + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + xs:string + + + + + + + + footprintLifecycle + + + en + Footprint Lifecycle + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#footprintLifecycle + + + + xs:string + + + + footprintUnit + + + en + Footprint Unit + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#footprintUnit + + + + xs:string + + + + footprintType + + + en + Footprint Type + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#footprintType + + + + xs:string + + + + performanceClass + + + en + Performance Class + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#performanceClass + + + + xs:string + + + + manufacturingPlant + + + en + Manufacturing Plant + + + + + en + The manufacturing plant of the footprint in the specific lifecycle phase. + + + true + DataElement + + + FacilityEntity + + + en + Facility Entity + + + + + en + The entity for a facility with the BPNA identifier. + + + + + facility + + + en + Facility + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#facility + + + + xs:string + + + + + + + + declaration + + + en + Declaration + + + + + en + The footprint declaration in the format of a link + + + true + DataElement + + + DocumentationEntity + + + en + Documentation Entity + + + + + en + Entity for a document with a header, type and content. + + + + + content + + + en + Content + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + xs:string + + + + contentType + + + en + Content Type + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + xs:string + + + + header + + + en + Header + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + xs:string + + + + + + + + - - - - - - - CompositionEntity - - - en - composition - - - - - en - Entity to bundle the characterisitics describing a battery's composition - - - - - CompomenentsEntity - - - en - components - - - - - en - Entity to bundle the components properties of a battery. - - - + - componentsSupplier + carbonFootprint en - components supplier + Carbon Footprint en - Contact details of the suppliers of replacement parts / spare parts is describing a regulatory requirement. Available fields should be like: -Name - Street - Number - ZIP Code - City - State - Country - Phone - Fax - Email - Website + The carbon footprint of the product. This is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I: +The following parameters shall, as appropriate, and where necessary supplemented by others, be used, individually or combined, as a basis for improving the product aspects referred to in Article 5(1): +(m) the carbon footprint of the product; +and Article 7: +(2)(b)(i) information on the performance of the product in relation to one or more of the product parameters referred to in Annex I, including a scoring of reparability or durability, carbon footprint or environmental footprint; +and defined by Article 2: +(25) 'carbon footprint' means the sum of greenhouse gas (GHG) emissions and GHG removals in a product system, expressed as CO2 equivalents and based on a life cycle assessment using the single impact category of climate change. true DataElement - ComponentsSupplierEntity + FootprintEntity en - components supplier + Footprint Entity en - Entity encapsulating the details of a components supplier + Footprint Entity for the carbon and environmental footprint with the total value, unit, impact category type, lifecycle, rulebook, declaration, performance class and the facility. - - AddressEntity + + footprintValue + + + en + Footprint Value + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#footprintValue + + + + xs:float + + + + footprintRulebook en - Address Entity + Footprint Rulebook en - Entity of an address. Model follows specification of BPDM (Business Partner Data Management). + The applied rulebook for the environmental footprint of the product. + true + DataElement - ThoroughfareEntity + DocumentationEntity en - Thoroughfare Entity + Documentation Entity en - Entity for a thoroughfare which consists of a type, value and number. + Entity for a document with a header, type and content. - thoroughfareTechnicalKey + content + + + en + Content + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + xs:string + + + + contentType en - Thoroughfare Technical Key + Content Type @@ -3095,7 +3593,7 @@ Name - Street - Number - ZIP Code - City - State - Country - Phone - Fax - Email ConceptDescription - urn:samm:io.catenax.shared.address_characteristic:1.0.1#thoroughfareTechnicalKey + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType @@ -3103,11 +3601,11 @@ Name - Street - Number - ZIP Code - City - State - Country - Phone - Fax - Email - thoroughfareValue + header en - Value Thoroughfare + Header @@ -3115,19 +3613,135 @@ Name - Street - Number - ZIP Code - City - State - Country - Phone - Fax - Email ConceptDescription - urn:samm:io.catenax.shared.address_characteristic:1.0.1#thoroughfareValue + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header xs:string + + + + + + footprintLifecycle + + + en + Footprint Lifecycle + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#footprintLifecycle + + + + xs:string + + + + footprintUnit + + + en + Footprint Unit + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#footprintUnit + + + + xs:string + + + + footprintType + + + en + Footprint Type + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#footprintType + + + + xs:string + + + + performanceClass + + + en + Performance Class + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#performanceClass + + + + xs:string + + + + manufacturingPlant + + + en + Manufacturing Plant + + + + + en + The manufacturing plant of the footprint in the specific lifecycle phase. + + + true + DataElement + + + FacilityEntity + + + en + Facility Entity + + + + + en + The entity for a facility with the BPNA identifier. + + + - thoroughfareNumber + facility en - Thoroughfare Number + Facility @@ -3135,7 +3749,7 @@ Name - Street - Number - ZIP Code - City - State - Country - Phone - Fax - Email ConceptDescription - urn:samm:io.catenax.shared.address_characteristic:1.0.1#thoroughfareNumber + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#facility @@ -3144,27 +3758,66 @@ Name - Street - Number - ZIP Code - City - State - Country - Phone - Fax - Email + + + + declaration + + + en + Declaration + + + + + en + The footprint declaration in the format of a link + + + true + DataElement + - LocalityEntity + DocumentationEntity en - Thoroughfare Entity + Documentation Entity en - Entity for a thoroughfare which consists of a type, value and number. + Entity for a document with a header, type and content. - localityTechnicalKey + content + + + en + Content + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + xs:string + + + + contentType en - Locality Technical Key + Content Type @@ -3172,7 +3825,7 @@ Name - Street - Number - ZIP Code - City - State - Country - Phone - Fax - Email ConceptDescription - urn:samm:io.catenax.shared.address_characteristic:1.0.1#localityTechnicalKey + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType @@ -3180,11 +3833,11 @@ Name - Street - Number - ZIP Code - City - State - Country - Phone - Fax - Email - localityValue + header en - Locality Value + Header @@ -3192,7 +3845,7 @@ Name - Street - Number - ZIP Code - City - State - Country - Phone - Fax - Email ConceptDescription - urn:samm:io.catenax.shared.address_characteristic:1.0.1#localityValue + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header @@ -3201,27 +3854,125 @@ Name - Street - Number - ZIP Code - City - State - Country - Phone - Fax - Email + + + + + + + + materialFootprint + + + en + Material Footprint + + + + + en + The material footprint of the product. This is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I: +(ma) the material footprint of the product; +and defined by Article 2: +(25a) 'material footprint' refers to the total amount of raw materials extracted to meet final consumption demands. + + + true + DataElement + + + FootprintEntity + + + en + Footprint Entity + + + + + en + Footprint Entity for the carbon and environmental footprint with the total value, unit, impact category type, lifecycle, rulebook, declaration, performance class and the facility. + + + + + footprintValue + + + en + Footprint Value + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#footprintValue + + + + xs:float + + + + footprintRulebook + + + en + Footprint Rulebook + + + + + en + The applied rulebook for the environmental footprint of the product. + + + true + DataElement + - PremiseEntity + DocumentationEntity en - Premise Entity + Documentation Entity en - Entity for a premise which consists of a type (technical key) and a value + Entity for a document with a header, type and content. - premiseTechnicalKey + content + + + en + Content + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + xs:string + + + + contentType en - Premise Technical Key + Content Type @@ -3229,7 +3980,7 @@ Name - Street - Number - ZIP Code - City - State - Country - Phone - Fax - Email ConceptDescription - urn:samm:io.catenax.shared.address_characteristic:1.0.1#premiseTechnicalKey + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType @@ -3237,11 +3988,11 @@ Name - Street - Number - ZIP Code - City - State - Country - Phone - Fax - Email - premiseValue + header en - Premise Value + Header @@ -3249,7 +4000,7 @@ Name - Street - Number - ZIP Code - City - State - Country - Phone - Fax - Email ConceptDescription - urn:samm:io.catenax.shared.address_characteristic:1.0.1#premiseValue + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header @@ -3258,47 +4009,126 @@ Name - Street - Number - ZIP Code - City - State - Country - Phone - Fax - Email + + + + footprintLifecycle + + + en + Footprint Lifecycle + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#footprintLifecycle + + + + xs:string + + + + footprintUnit + + + en + Footprint Unit + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#footprintUnit + + + + xs:string + + + + footprintType + + + en + Footprint Type + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#footprintType + + + + xs:string + + + + performanceClass + + + en + Performance Class + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#performanceClass + + + + xs:string + + + + manufacturingPlant + + + en + Manufacturing Plant + + + + + en + The manufacturing plant of the footprint in the specific lifecycle phase. + + + true + DataElement + - PostalDeliveryPointEntity + FacilityEntity en - Postal Delivery Point Entity + Facility Entity en - Entity for a postal delivery point which consists of a technical key and a value. + The entity for a facility with the BPNA identifier. - postalDeliveryPointTechnicalKey - - - en - Postal Delivery Point Technical Key - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.shared.address_characteristic:1.0.1#postalDeliveryPointTechnicalKey - - - - xs:string - - - - postalDeliveryPointValue + facility en - Postal Delivery Point Value + Facility @@ -3306,7 +4136,7 @@ Name - Street - Number - ZIP Code - City - State - Country - Phone - Fax - Email ConceptDescription - urn:samm:io.catenax.shared.address_characteristic:1.0.1#postalDeliveryPointValue + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#facility @@ -3315,27 +4145,46 @@ Name - Street - Number - ZIP Code - City - State - Country - Phone - Fax - Email + + + + declaration + + + en + Declaration + + + + + en + The footprint declaration in the format of a link + + + true + DataElement + - CountryEntity + DocumentationEntity en - Country Entity + Documentation Entity en - Entity definition for a country + Entity for a document with a header, type and content. - countryShortName + content en - Country Short Name + Content @@ -3343,36 +4192,19 @@ Name - Street - Number - ZIP Code - City - State - Country - Phone - Fax - Email ConceptDescription - urn:samm:io.catenax.shared.address_characteristic:1.0.1#countryShortName + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content xs:string - - - - PostCodeEntity - - - en - PostCode Entity - - - - - en - Entity for a postcode which consists of a type plus a value - - - - postCodeValue + contentType en - Post Code Value + Content Type @@ -3380,7 +4212,7 @@ Name - Street - Number - ZIP Code - City - State - Country - Phone - Fax - Email ConceptDescription - urn:samm:io.catenax.shared.address_characteristic:1.0.1#postCodeValue + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType @@ -3388,11 +4220,11 @@ Name - Street - Number - ZIP Code - City - State - Country - Phone - Fax - Email - postCodeTechnicalKey + header en - Post Code Technical Key + Header @@ -3400,7 +4232,7 @@ Name - Street - Number - ZIP Code - City - State - Country - Phone - Fax - Email ConceptDescription - urn:samm:io.catenax.shared.address_characteristic:1.0.1#postCodeTechnicalKey + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header @@ -3410,68 +4242,442 @@ Name - Street - Number - ZIP Code - City - State - Country - Phone - Fax - Email - + + + + + + + + + reparabilityScore + + + en + Reparability Score + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#reparabilityScore + + + + xs:string + + + + durabilityScore + + + en + Durability Score + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#durabilityScore + + + + xs:string + + + + + + sources + + + en + Sources + + + + + en + Documents that are mandatory if applicable for the product. These are mentioned in the ESPR provisional agreement from January 9th, 2024 ANNEX III: +(e) compliance documentation and information required under this Regulation or other Union law applicable to the product, such as the declaration of conformity, technical documentation or conformity certificates; +(f) user manuals, instructions, warnings or safety information, as required by other Union legislation applicable to the product. +Additionally requirements are mentioned in Article 21: +7. Manufacturers shall ensure that a product covered by a delegated act adopted pursuant to Article 4 is accompanied by instructions in digital format that enable customers and other relevant actors to assemble, install, operate, store, maintain, repair and dispose of the product in a language that can be easily understood, as determined by the Member State concerned. Such instructions shall be clear, understandable and legible and include at least the information set out in Article 7(2), point (b), point (ii) specified in the delegated acts adopted pursuant to Article 4. +Article 7 states additionally: +(ii) information for customers and other actors on how to install, use, maintain and repair the product, in order to minimise its impact on the environment and to ensure optimum durability, on how to install third-party operating systems where relevant, as well as on collection for refurbishment or remanufacture, and on how to return or handle the product at the end of its life; +(2) (b) (iii) information for treatment facilities on disassembly, reuse, refurbishment, recycling, or disposal at end-of-life; +(2) (b) (iv) other information that may influence sustainable product choices for customers and the way the product is handled by parties other than the manufacturer in order to facilitate appropriate use, value retaining operations and correct treatment at end-of-life. +(5) (d) relevant instructions for the safe use of the product. +(5) (e) information relevant for disassembly, preparation for reuse, reuse, recycling and the environmentally sound management of the product at the end of its life. +Annex I: +(b) [...] availability of repair and maintenance instructions, number of materials and components used, use of standard components,[...] number and complexity of processes and whether specialised toolsare needed, ease of non-destructive disassembly and re-assembly, conditions for access to product data, conditions for access to or use of hardware and software needed; +(c) ease of upgrading, re-use, remanufacturing and refurbishment as expressed through: [...] number and complexity of processes and tools needed, ease of non-destructive disassembly and re-assembly, conditions for access to product data, conditions for access to or use of hardware and software needed, conditions of access to test protocols or not commonly available testing equipment, availability of guarantees specific to remanufactured or refurbished products, conditions for access to or use of technologies protected by intellectual property rights, modularity; +(d) design for recycling, ease and quality of recycling as expressed through: use of easily recyclable materials, safe, easy and non-destructive access to recyclable components and materials or components and materials containing hazardous substances and material composition and homogeneity, possibility for high-purity sorting, [...] number and complexity of processes and tools needed, ease of nondestructive disassembly and re-assembly, conditions for access to product data, conditions for access to or use of hardware and software needed; +(q) functional performance and conditions for use including as expressed through ability in performing its intended use, precautions of use, skills required, compatibility with other products or systems. +Additionally to consider are guidelines and instructions regarding the proper management and disposal of packaging materials after use. This can include instructions for separation, reuse, and recycling. + + + true + DataElement + + + DocumentEntity + + + en + Document Entity + + + + + en + Document entity with header, content, category and type. + + + + + content + + + en + Content + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + xs:string + + + + category + + + en + Category + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#category + + + + xs:string + + + + contentType + + + en + Content Type + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + xs:string + + + + header + + + en + Header + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + xs:string + + + + + + + + additionalData + + + en + Additional Data + + + + + en + Data in form of open fields which need to be transferred in addition. The regulation is still under development and may change in the future. To accommodate this, additional data allows the option to include additional data required by future changes to the regulation. In addition, the DPP can be easily updated and adapted to the new requirements. +The ESPR provisional agreement from January 9th, 2024 Article 9 mentions: +2. Where other Union legislation requires or allows the inclusion of specific information in the product passport, that information may be included in the product passport pursuant to the applicable delegated act adopted pursuant to Article 4. + + + true + DataElement + + + AdditionalDataEntity + + + en + Additional Data Entity + + + + + en + Entity with additional data. Properties are label, description, type, data and children. Either the fields data or children filled. Children constructs a hierarchy with the same attributes. Data is filled as the end of an path/leaf. + + + + + label + + + en + Label + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#label + + + + xs:string + + + + description + + + en + Description + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#description + + + + xs:string + + + + TypeEntity + + + en + Type Entity + + + + + en + Entity for type with unit and data type. + + + + + typeUnit + + + en + Type Unit + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#typeUnit + + + + xs:string + + + + dataType + + + en + Data Type + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#dataType + + + + + + ExternalReference + + + GlobalReference + https://eclipse-esmf.github.io/samm-specification/2.1.0/index.html + + + + + xs:string + + + + + + data + + + en + Data + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#data + + + + xs:string + + + + children + + + en + children + + + + + en + Children of the hierarchy. + + + true + DataElement + + + AdditionalDataEntity + + + en + Additional Data Entity + + + + + en + Entity with additional data. Properties are label, description, type, data and children. Either the fields data or children filled. Children constructs a hierarchy with the same attributes. Data is filled as the end of an path/leaf. + + + + + label + + + en + Label + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#label + + + + xs:string + + + + description + + + en + Description + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#description + + + + xs:string + + - ContactEntity + TypeEntity en - Contact Entity + Type Entity en - Entity to bundle the properties for the information on how to contact an organization + Entity for type with unit and data type. - website - - - en - website - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.shared.contact_information:1.0.0#website - - - - xs:anyURI - - - - phoneNumber - - - en - phone number - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.shared.contact_information:1.0.0#phoneNumber - - - - xs:string - - - - email + typeUnit en - email + Type Unit @@ -3479,7 +4685,7 @@ Name - Street - Number - ZIP Code - City - State - Country - Phone - Fax - Email ConceptDescription - urn:samm:io.catenax.shared.contact_information:1.0.0#email + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#typeUnit @@ -3487,11 +4693,11 @@ Name - Street - Number - ZIP Code - City - State - Country - Phone - Fax - Email - faxNumber + dataType en - faxNumber + Data Type @@ -3499,353 +4705,1397 @@ Name - Street - Number - ZIP Code - City - State - Country - Phone - Fax - Email ConceptDescription - urn:samm:io.catenax.shared.contact_information:1.0.0#faxNumber + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#dataType + + + ExternalReference + + + GlobalReference + https://eclipse-esmf.github.io/samm-specification/2.1.0/index.html + + + + xs:string + + data + + + en + Data + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#data + + + + xs:string + + - - componentsPartNumber - - - en - components part number - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.battery.battery_pass:2.0.0#componentsPartNumber - - - - xs:string - - - - compositionOfBattery - - + + + + + + + + APPLICATION_CLASS + DigitalProductPassport + + + en + Digital Product Passport + + + + + en + The Digital Product Passport (DPP) allows to share process and product-related information amongst supply chain businesses, authorities and consumers. The DPP allows for efficient information flows following best practices; and the possibility of accompanying the measures under this Regulation with mitigating measures so that impacts are expected to remain proportionate for SMEs.This is expected to increase transparency, both for supply chain businesses and for the general public, and increase efficiencies in terms of information transfer to support the data exchange between economic actors in integrating circularity in product design and manufacturing. +In particular, it is likely to help facilitate and streamline the monitoring and enforcement of the regulation carried out by EU and Member State authorities. It is also likely to provide a market-intelligence tool that may be used for revising and refining obligations in the future. +The DPP includes data about components, materials and chemical substances, information on reparability, spare parts, environmental impact and professional disposal for a product. +The data model will be updated, as newer versions of the regulation will be published. +The main basis is provided by the document "Proposal for a REGULATION OF THE EUROPEAN PARLIAMENT AND OF THE COUNCIL establishing a framework for setting ecodesign requirements for sustainable products and repealing Directive 2009/125/EC" from March 30th, 2022. The latest version of the document was the provisional agreement between the EU Council and the Parliament from January 9th, 2024. The text is informal, but the content of the final regulation was agreed between these two institutions. +The Title of Ecodesign Regulation has been changed to: Proposal for a REGULATION OF THE EUROPEAN PARLIAMENT AND OF THE COUNCIL establishing a framework for setting ecodesign requirements for sustainable products, amending Regulation (EU) 2023/1542 and repealing Directive 2009/125/EC. + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#DigitalProductPassport + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Digital Product Passport + + + + + en + DigitalProductPassport + + + + + en + The Digital Product Passport (DPP) allows to share process and product-related information amongst supply chain businesses, authorities and consumers. The DPP allows for efficient information flows following best practices; and the possibility of accompanying the measures under this Regulation with mitigating measures so that impacts are expected to remain proportionate for SMEs.This is expected to increase transparency, both for supply chain businesses and for the general public, and increase efficiencies in terms of information transfer to support the data exchange between economic actors in integrating circularity in product design and manufacturing. +In particular, it is likely to help facilitate and streamline the monitoring and enforcement of the regulation carried out by EU and Member State authorities. It is also likely to provide a market-intelligence tool that may be used for revising and refining obligations in the future. +The DPP includes data about components, materials and chemical substances, information on reparability, spare parts, environmental impact and professional disposal for a product. +The data model will be updated, as newer versions of the regulation will be published. +The main basis is provided by the document "Proposal for a REGULATION OF THE EUROPEAN PARLIAMENT AND OF THE COUNCIL establishing a framework for setting ecodesign requirements for sustainable products and repealing Directive 2009/125/EC" from March 30th, 2022. The latest version of the document was the provisional agreement between the EU Council and the Parliament from January 9th, 2024. The text is informal, but the content of the final regulation was agreed between these two institutions. +The Title of Ecodesign Regulation has been changed to: Proposal for a REGULATION OF THE EUROPEAN PARLIAMENT AND OF THE COUNCIL establishing a framework for setting ecodesign requirements for sustainable products, amending Regulation (EU) 2023/1542 and repealing Directive 2009/125/EC. + + + + + + + + + version + + + en + Version + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#version + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Version + + + + + en + version + + + STRING + + + en + The current version of the product passport. The possibility of modification/ updating the product passport needs to include versioning of the dataset. This attribute is an internal versioning from the passport issuer. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Article 8: +(1) [...] The information in the product passport shall be accurate, complete, and up to date. + + + + + + + + + status + + + en + Status + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#status + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Status + + + + + en + status + + + STRING + + + en + The current status of the product passport declared through either: draft, approved, invalid or expired. + + + + + + draft + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#StatusEnumeration:draft + + + + + + approved + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#StatusEnumeration:approved + + + + + + invalid + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#StatusEnumeration:invalid + + + + + + expired + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#StatusEnumeration:expired + + + + + + + + + + + + + expirationDate + + + en + Expiration Date + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#expirationDate + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Expiration Date + + + + + en + expirationDate + + + STRING + + + en + The timestamp in the format (yyyy-mm-dd) for the product passport until when it is available or a comment describing this period. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Article 8: +(2) (h) the period during which the product passport is to remain available, which shall correspond to at least the expected lifetime of a specific product. + + + + + + + + + issueDate + + + en + Issue Date + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#issueDate + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Issue Date + + + + + en + issueDate + + + STRING + + + en + The timestamp in the format (yyyy-mm-dd) since when the product passport is available. + + + + + + + + + economicOperatorId + + + en + Economic Operator Id + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#economicOperatorId + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Economic Operator Id + + + + + en + economicOperatorId + + + STRING + + + en + The identification of the owner/economic operator of the passport. Proposed, according to ISO 15459, is the CIN (company identification code). Other identification numbers like the tax identification number, value added tax identification number, commercial register number and the like are also valid entries. In the Catena-X network, the BPNL is used for the identification of companies and the information stored like contact information and addresses. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Annex III: +(k) the [...] unique operator identifier code of the economic operator established in the Union responsible for carrying out the tasks set out in Article 4 of Regulation (EU) 2019/1020, or Article 15 of Regulation (EU) on general product safety, or similar tasks pursuant to other EU legislation applicable to the product. + + + + + + + + + passportIdentifier + + + en + Passport Identifier + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#passportIdentifier + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Passport Identifier + + + + + en + passportIdentifier + + + STRING + + + en + The identifier of the product passport, which is an uuidv4. + + + + + + + + + predecessor + + + en + Predecessor + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#predecessor + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Predecessor + + + + + en + predecessor + + + STRING + + + en + Identification of the preceding product passport. If there is no preceding passport, input a dummy value. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Article 8: +(2)(g) [...] Any new product passport shall be linked to the product passport or passports of the original product whenever appropriate. + + + + + + + + + backupReference + + + en + Backup Reference + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#backupReference + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Backup Reference + + + + + en + backupReference + + + STRING + + + en + A reference to the data backup of the passport. This mandatory attribute will be further defined in the future. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex III: +(kb) the reference of the certified independent third-party product passport service provider hosting the back-up copy of the product passport. +Article 10 also mentions: +(c) the data included in the product passport shall be stored by the economic operator responsible for its creation or by certified independent third-party product passport service providers authorised to act on their behalf. + + + + + + + + + registrationIdentifier + + + en + Registration Identifier + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#registrationIdentifier + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Registration Identifier + + + + + en + registrationIdentifier + + + STRING + + + en + Identifier in the respective registry. This will be further defined in the future. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 in Article 12: +By [2 years from entering into force of this Regulation], the Commission shall set up and manage a digital registry ("the registry") storing in a secure manner at least the unique product identifier, the unique operator identifier, the unique facility identifiers. In case of products intended to be placed under the customs procedure 'release for free circulation', the registry shall also store the product commodity code. The registry shall also store the batteries' unique identifiers referred to in Article 77(3) of Regulation (EU) 2023/1542. + + + + + + + + + lastModification + + + en + Last Modification + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#lastModification + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Last Modification + + + + + en + lastModification + + + STRING + + + en + Date of the latest modification. + + + + + + + + + metadata + + + en + Metadata + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#metadata + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Metadata + + + + + en + metadata + + + STRING + + + en + Metadata of the product passport. These are mentioned in the ESPR proposal from March 30th, 2022 and some changed by the provisional agreement from January 9th, 2024. + + + + + + + + + key + + + en + Identifier Key + + + urn:samm:io.catenax.serial_part:3.0.0#key + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Identifier Key + + + + + en + key + + + STRING + + + en + The key of a local identifier. + + + + + + + + + value + + + en + Identifier Value + + + urn:samm:io.catenax.serial_part:3.0.0#value + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Identifier Value + + + + + en + value + + + STRING + + + en + The value of an identifier. + + + + + + + + + serialInformation + + + en + Serial Information + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#serialInformation + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Serial Information + + + + + en + serialInformation + + + STRING + + + en + Identifier for a serial part if available. This is mentioned in the ESPR provisional agreement from January 9th, 2024 Recital (27): +[...] an 'item' usually means a single unit of a model. + + + + + + + + + key + + + en + Identifier Key + + + urn:samm:io.catenax.batch:3.0.0#key + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Identifier Key + + + + + en + key + + + STRING + + + en + The key of a local identifier. + + + + + + + + + value + + + en + Identifier Value + + + urn:samm:io.catenax.batch:3.0.0#value + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Identifier Value + + + + + en + value + + + STRING + + + en + The value of an identifier. + + + + + + + + + batchInformation + + + en + Batch Information + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#batchInformation + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Batch Information + + + + + en + batchInformation + + + STRING + + + en + Identifier for a batch part if available. Identifier for a serial part if available. This is mentioned in the ESPR provisional agreement from January 9th, 2024 Recital (27): +[...] a 'batch' usually means a subset of a specific model composed of all products produced in a specific manufacturing plant at a specific moment in time [...]. + + + + + + + + + manufacturerPartId + + + en + Manufacturer Part ID + + + urn:samm:io.catenax.part_type_information:1.0.0#manufacturerPartId + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Manufacturer Part ID + + + + + en + manufacturerPartId + + + STRING + + + en + Part ID as assigned by the manufacturer of the part. The part ID identifies the part in the manufacturer`s dataspace. The part ID references a specific version of a part. The version number must be included in the part ID if it is available. The part ID does not reference a specific instance of a part and must not be confused with the serial number. + + + + + + + + + nameAtManufacturer + + + en + Name at manufacturer + + + urn:samm:io.catenax.part_type_information:1.0.0#nameAtManufacturer + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Name at manufacturer + + + + + en + nameAtManufacturer + + + STRING + + + en + Name of the part as assigned by the manufacturer. + + + + + + + + + partTypeInformation + + + en + Part Type Information + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#partTypeInformation + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Part Type Information + + + + en - composition of battery - - - - + partTypeInformation + + + STRING + + en - Full composition of battery is describing a business requirement. - - - true - DataElement - - - MaterialNameAndWeightAndPercentageMassFractionEntity - - - en - material name and weight and percent - - - - - en - Entity to bundle a material's name, weight and percentage of mass. - - - - - matierialPercentageMassFraction - - - en - matierial percentage mass fraction - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.battery.battery_pass:2.0.0#matierialPercentageMassFraction - - - - xs:decimal - - - - matierialWeight - - - en - material weight - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.battery.battery_pass:2.0.0#matierialWeight - - - - xs:decimal - - - - materialName - - - en - material name - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.battery.battery_pass:2.0.0#materialName - - - - xs:string - - - - - - - - criticalRawMaterials - - + Identifier on the level of a part model or type. Identifier for a serial part if available. This is mentioned in the ESPR provisional agreement from January 9th, 2024 Recital (27): +[...] A 'model' usually means a version of a product of which all units share the same technical characteristics relevant for the ecodesign requirements and the same model identifier [...]. + + + + + + + + + codeKey + + + en + Code Key + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#codeKey + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + en - critical raw materials - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.battery.battery_pass:2.0.0#criticalRawMaterials - - - - xs:string - - - - - - cO2FootprintTotal - - - en - CO2 footprint total - - - + Code Key + + + + + en + codeKey + + + STRING + + + en + The code key for the identification of the product. Examples are GTIN, hash, DID, ISBN, TARIC. This attribute is mentioned in the ESPR proposal from March 30th, 2022 ANNEX III: +(b) the unique product identifier at the level indicated in the applicable delegated act adopted pursuant to Article 4; +(c) the Global Trade Identification Number as provided for in standard ISO/IEC 15459-6 or equivalent of products or their parts; +(d) relevant commodity codes, such as a TARIC code as defined in Council Regulation (EEC) No 2658/87. + + + + + + + + + codeValue + + + en + Code Value + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#codeValue + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Code Value + + + + + en + codeValue + + + STRING + + + en + The code value for the identification of the product in regard to the chosen code name. + + + + + + + + + codes + + + en + Codes + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#codes + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Codes + + + + + en + codes + + + STRING + + + en + Codes for identification. + + + + + + + + + carrierType + + + en + Carrier Type + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#carrierType + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Carrier Type + + + + + en + carrierType + + + STRING + + + en + The type of data carrier such as a QR code on the product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 8: +(2) (b) the types of data carrier to be used. + + + + + + + + + carrierLayout + + + en + Carrier Layout + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#carrierLayout + + + ExternalReference - ConceptDescription - urn:samm:io.catenax.battery.battery_pass:2.0.0#cO2FootprintTotal + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - xs:double - - - - TemperatureRangeIdleStateEntity - - - en - temperature range idle state - - - - - en - Entity to bundle the characterisitics describing the battery's temperature range - - - - - temperatureRangeIdleStateLowerLimit - - + + + + + en - temperature range idle state lower limit - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.battery.battery_pass:2.0.0#temperatureRangeIdleStateLowerLimit - - - - xs:decimal - - - - temperatureRangeIdleStateUpperLimit - - + Carrier Layout + + + + en - temperature rangeIdle state upper limit - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.battery.battery_pass:2.0.0#temperatureRangeIdleStateUpperLimit - - - - xs:decimal - - - - - - warrantyPeriod - - - en - warranty period - - - + carrierLayout + + + STRING + + + en + The positioning of data carrier on the product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 8: +(2) (c) the layout in which the data carrier shall be presented and its positioning. + + + + + + + + + dataCarrier + + + en + Data Carrier + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#dataCarrier + + + ExternalReference - ConceptDescription - urn:samm:io.catenax.battery.battery_pass:2.0.0#warrantyPeriod + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - xs:positiveInteger - - - - BatteryCycleLifeEntity - - - en - battery cycle life entity - - - - - en - Entity to bundle the characterisitics describing the cycle life of a battery - - - - - cycleLifeTestCRate - - + + + + + en - cycle life test c-rate - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.battery.battery_pass:2.0.0#cycleLifeTestCRate - - - - xs:decimal - - - - cycleLifeTestDepthOfDischarge - - + Data Carrier + + + + en - cycle-life test depth of discharge - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.battery.battery_pass:2.0.0#cycleLifeTestDepthOfDischarge - - - - xs:decimal - - - - expectedLifetime - - + dataCarrier + + + STRING + + en - expected lifetime - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.battery.battery_pass:2.0.0#expectedLifetime - - - - xs:decimal - - - - - - - - + The type and layout of the data carrier on the product. These are mentioned in the ESPR proposal from March 30th, 2022 Article 8: +(b) the types of data carrier to be used; +(c) the layout in which the data carrier shall be presented and its positioning; +Article 2 defines: +(30) 'data carrier' means a linear bar code symbol, a two-dimensional symbol or other automatic identification data capture medium that can be read by a device. + + + + + + + - APPLICATION_CLASS - BatteryPass + classificationStandard en - battery pass + Classification Standard - - - en - The battery pass describes information collected during the lifecycle of a battery - - - urn:samm:io.catenax.battery.battery_pass:2.0.0#BatteryPass + urn:samm:io.catenax.shared.part_classification:1.0.0#classificationStandard @@ -3862,19 +6112,20 @@ Name - Street - Number - ZIP Code - City - State - Country - Phone - Fax - Email en - battery pass + Classification Standard en - BatteryPass + classificationStandard + STRING en - The battery pass describes information collected during the lifecycle of a battery + Identified classification standards that align to the Catena-X needs. @@ -3883,14 +6134,14 @@ Name - Street - Number - ZIP Code - City - State - Country - Phone - Fax - Email - fileLocation + classificationID en - file location + Classification ID - urn:samm:io.catenax.battery.battery_pass:2.0.0#fileLocation + urn:samm:io.catenax.shared.part_classification:1.0.0#classificationID @@ -3907,20 +6158,20 @@ Name - Street - Number - ZIP Code - City - State - Country - Phone - Fax - Email en - file location + Classification ID en - fileLocation + classificationID STRING en - Location of the file + The classification ID of the part type according to the corresponding standard definition mentioned in the key value pair. @@ -3929,14 +6180,14 @@ Name - Street - Number - ZIP Code - City - State - Country - Phone - Fax - Email - title + classificationDescription en - title + Classification Description - urn:samm:io.catenax.battery.battery_pass:2.0.0#title + urn:samm:io.catenax.shared.part_classification:1.0.0#classificationDescription @@ -3953,20 +6204,20 @@ Name - Street - Number - ZIP Code - City - State - Country - Phone - Fax - Email en - title + Classification Description en - title + classificationDescription STRING en - Title of the attached file + Optional property describing the classification standard. @@ -3975,14 +6226,14 @@ Name - Street - Number - ZIP Code - City - State - Country - Phone - Fax - Email - packagingInstructions + partClassification en - packaging instructions + Part Classification - urn:samm:io.catenax.battery.battery_pass:2.0.0#packagingInstructions + urn:samm:io.catenax.shared.part_classification:1.0.0#partClassification @@ -3999,21 +6250,20 @@ Name - Street - Number - ZIP Code - City - State - Country - Phone - Fax - Email en - packaging instructions + Part Classification en - packagingInstructions + partClassification STRING en - Instructions for safely packaging -batteries is describing a business requirement. + Property describing the classification of a part. @@ -4022,14 +6272,14 @@ batteries is describing a business requirement. - fileLocation + identification en - file location + Identification - urn:samm:io.catenax.battery.battery_pass:2.0.0#fileLocation + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#identification @@ -4046,20 +6296,28 @@ batteries is describing a business requirement. en - file location + Identification en - fileLocation + identification STRING en - Location of the file + Identification information of the product, especially identifiers and codes. These are mentioned in the ESPR provisional agreement from January 9th, 2024 ANNEX III: +(b) the unique product identifier at the level indicated in the applicable delegated act adopted pursuant to Article 4. +Additionally in Article 9 regarding general requirements for the product passport is stated that: +A product passport shall meet the following conditions: +(a) it shall be connected through a data carrier to a persistent unique product identifier; +(e) the information included in the product passport shall refer to the product model, batch, or item as specified in the delegated act adopted pursuant to Article 4. +Article 2 Definitions: +(31) 'unique product identifier' means a unique string of characters for the identification of products that also enables a web link to the product passport; +Recital (27): A 'model' usually means a version of a product of which all units share the same technical characteristics relevant for the ecodesign requirements and the same model identifier, a 'batch' usually means a subset of a specific model composed of all products produced in a specific manufacturing plant at a specific moment in time and an 'item' usually means a single unit of a model. @@ -4068,14 +6326,14 @@ batteries is describing a business requirement. - title + facility en - title + Facility - urn:samm:io.catenax.battery.battery_pass:2.0.0#title + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#facility @@ -4092,20 +6350,22 @@ batteries is describing a business requirement. en - title + Facility en - title + facility STRING en - Title of the attached file + The identifier used for a location. This attribute is mentioned in the ESPR provisional agreement from January 9th 2024 Annex III: +(i) unique facility identifiers; +Article 2 Definitions: (33) 'unique facility identifier' means a unique string of characters for the identification of locations or buildings involved in the value chain of a product or used by actors involved in the value chain of a product. @@ -4114,14 +6374,14 @@ batteries is describing a business requirement. - transportationInstructions + facilityIdentification en - transportation instructions + Facility Identification - urn:samm:io.catenax.battery.battery_pass:2.0.0#transportationInstructions + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#facilityIdentification @@ -4138,21 +6398,22 @@ batteries is describing a business requirement. en - transportation instructions + Facility Identification en - transportationInstructions + facilityIdentification STRING en - Instructions for safely transporting -batteries is describing a business requirement. + The identifier used for a location. In the CATENA-X use case, the BPNA can be stated. This attribute is mentioned in the ESPR provisional agreement from January 9th 2024 Annex III: +(i) unique facility identifiers; +Article 2 Definitions: (33) 'unique facility identifier' means a unique string of characters for the identification of locations or buildings involved in the value chain of a product or used by actors involved in the value chain of a product. @@ -4161,14 +6422,14 @@ batteries is describing a business requirement. - fileLocation + manufacturerIdentification en - file location + Manufacturer Identification - urn:samm:io.catenax.battery.battery_pass:2.0.0#fileLocation + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#manufacturerIdentification @@ -4185,20 +6446,22 @@ batteries is describing a business requirement. en - file location + Manufacturer Identification en - fileLocation + manufacturerIdentification STRING en - Location of the file + The main manufacturer, if different from the passport owner, represented by an identification number. In the Catena-X use case, the BPNL can be stated. This attribute is mentioned in the ESPR provisional agreement from January 9th 2024 Annex III: +(h) unique operator identifiers other than that of the manufacturer; +(k) the name, contact details and unique operator identifier code of the economic operator established in the Union responsible for carrying out the tasks set out in Article 4 of Regulation (EU) 2019/1020, or Article 15 of Regulation (EU) [.../...] on general product safety, or similar tasks pursuant to other EU legislation applicable to the product. @@ -4207,14 +6470,14 @@ batteries is describing a business requirement. - title + manufacturingDate en - title + Manufacturing Date - urn:samm:io.catenax.battery.battery_pass:2.0.0#title + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#manufacturingDate @@ -4231,20 +6494,20 @@ batteries is describing a business requirement. en - title + Manufacturing Date en - title + manufacturingDate STRING en - Title of the attached file + The timestamp in the format (yyyy-mm-dd) of the manufacturing date as the final step in production process (e.g. final quality check, ready-for-shipment event). @@ -4253,14 +6516,14 @@ batteries is describing a business requirement. - vehicleDismantlingProcedure + manufacturer en - vehicle dismantling procedure + Manufacturer - urn:samm:io.catenax.battery.battery_pass:2.0.0#vehicleDismantlingProcedure + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#manufacturer @@ -4277,20 +6540,22 @@ batteries is describing a business requirement. en - vehicle dismantling procedure + Manufacturer en - vehicleDismantlingProcedure + manufacturer STRING en - Document containing the vehicle dismantling procedure is describing a regulatory requirement. + Manufacturing information of the product. In the CATENA-X use case, the BPNL and BPNA can be stated. These attributes are mentioned in the ESPR provisional agreement from January 9th 2024 Annex III: +(h) unique operator identifiers other than that of the manufacturer; +(k) the name, contact details and unique operator identifier code of the economic operator established in the Union responsible for carrying out the tasks set out in Article 4 of Regulation (EU) 2019/1020, or Article 15 of Regulation (EU) [.../...] on general product safety, or similar tasks pursuant to other EU legislation applicable to the product. @@ -4299,14 +6564,14 @@ batteries is describing a business requirement. - fileLocation + eori en - file location + EORI - urn:samm:io.catenax.battery.battery_pass:2.0.0#fileLocation + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#eori @@ -4323,20 +6588,21 @@ batteries is describing a business requirement. en - file location + EORI en - fileLocation + eori STRING en - Location of the file + An economic operator established in the customs territory of the Union needs, for customs purposes, an EORI number. EORI stands for economic operators registration and identification number. In this case, the importer's EORI must be provided. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Annex III: +(j) information related to the importer, including the information referred to in Article 23(3) and its EORI number. @@ -4345,14 +6611,14 @@ batteries is describing a business requirement. - title + importerIdentification en - title + Importer Identification - urn:samm:io.catenax.battery.battery_pass:2.0.0#title + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#importerIdentification @@ -4369,20 +6635,25 @@ batteries is describing a business requirement. en - title + Importer Identification en - title + importerIdentification STRING en - Title of the attached file + The importer of the product, if different from the owner of the passport. In the Catena-X network, the BPNL is used for the identification of companies and the information stored for this like contact information and addresses. +This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex III: +(j) information related to the importer, including the information referred to in Article 23(3) and its EORI number; +Article 23 states: +(3) Importers shall, for products covered by a delegated act adopted pursuant to Article 4, indicate their name, registered trade name or registered trade mark and the postal address and electronic means of communication, where they can be contacted: (a) on the public part of the product passport, when applicable, and +(b) on the product or, where this is not possible, on the packaging, or in a document accompanying the product. @@ -4391,14 +6662,14 @@ batteries is describing a business requirement. - batteryDismantlingProcedure + importer en - battery dismantling procedure + Importer - urn:samm:io.catenax.battery.battery_pass:2.0.0#batteryDismantlingProcedure + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#importer @@ -4415,20 +6686,24 @@ batteries is describing a business requirement. en - battery dismantling procedure + Importer en - batteryDismantlingProcedure + importer STRING en - Document containing the battery dismantling procedure is describing a regulatory requirement. + Information regarding the importer of the product, if different from the owner of the passport. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex III: +(j) information related to the importer, including the information referred to in Article 23(3) and its EORI number; +Article 23 states: +(3) Importers shall, for products covered by a delegated act adopted pursuant to Article 4, indicate their name, registered trade name or registered trade mark and the postal address and electronic means of communication, where they can be contacted: (a) on the public part of the product passport, when applicable, and +(b) on the product or, where this is not possible, on the packaging, or in a document accompanying the product. @@ -4437,14 +6712,14 @@ batteries is describing a business requirement. - fileLocation + applicable en - file location + Applicable - urn:samm:io.catenax.battery.battery_pass:2.0.0#fileLocation + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#applicable @@ -4461,20 +6736,20 @@ batteries is describing a business requirement. en - file location + Applicable en - fileLocation + applicable - STRING + BOOLEAN en - Location of the file + Check whether the connected attributes are applicable to the product. If it is not applicable (false), dummy data can be delivered. @@ -4483,14 +6758,14 @@ batteries is describing a business requirement. - title + import en - title + Import - urn:samm:io.catenax.battery.battery_pass:2.0.0#title + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#import @@ -4507,20 +6782,20 @@ batteries is describing a business requirement. en - title + Import en - title + import STRING en - Title of the attached file + Importer details such as the identification. @@ -4529,14 +6804,14 @@ batteries is describing a business requirement. - safetyMeasures + otherOperatorId en - safety measures + Other Operator Id - urn:samm:io.catenax.battery.battery_pass:2.0.0#safetyMeasures + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#otherOperatorId @@ -4553,20 +6828,20 @@ batteries is describing a business requirement. en - safety measures + Other Operator Id en - safetyMeasures + otherOperatorId STRING en - Safety measures document(s) is describing a regulatory requirement. + Identifier of the other operator. This can be a BPN. @@ -4575,14 +6850,14 @@ batteries is describing a business requirement. - fileLocation + otherOperatorRole en - file location + Other Operator Role - urn:samm:io.catenax.battery.battery_pass:2.0.0#fileLocation + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#otherOperatorRole @@ -4599,20 +6874,20 @@ batteries is describing a business requirement. en - file location + Other Operator Role en - fileLocation + otherOperatorRole STRING en - Location of the file + Role of the other operator. @@ -4621,14 +6896,14 @@ batteries is describing a business requirement. - title + otherOperators en - title + Other Operators - urn:samm:io.catenax.battery.battery_pass:2.0.0#title + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#otherOperators @@ -4645,20 +6920,20 @@ batteries is describing a business requirement. en - title + Other Operators en - title + otherOperators STRING en - Title of the attached file + Other operators relevant for the product. @@ -4667,14 +6942,14 @@ batteries is describing a business requirement. - testReportsResults + operation en - test reports results + Operation - urn:samm:io.catenax.battery.battery_pass:2.0.0#testReportsResults + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#operation @@ -4691,20 +6966,20 @@ batteries is describing a business requirement. en - test reports results + Operation en - testReportsResults + operation STRING en - Results of test reports which prove that the battery fulfills this regulation and its delegated regulations is describing a regulatory requirement. + Operational information of the product. @@ -4713,14 +6988,14 @@ batteries is describing a business requirement. - fileLocation + sourcesIdentification en - file location + Sources Identification - urn:samm:io.catenax.battery.battery_pass:2.0.0#fileLocation + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#sourcesIdentification @@ -4737,20 +7012,20 @@ batteries is describing a business requirement. en - file location + Sources Identification en - fileLocation + sourcesIdentification STRING en - Location of the file + The identifier of a spare part producer of the product. In the Catena-X network, the BPNL is used for the identification of companies and the information stored for this like contact information and addresses. @@ -4759,14 +7034,14 @@ batteries is describing a business requirement. - title + sparePartSources en - title + Spare Part Sources - urn:samm:io.catenax.battery.battery_pass:2.0.0#title + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#sparePartSources @@ -4783,20 +7058,20 @@ batteries is describing a business requirement. en - title + Spare Part Sources en - title + sparePartSources STRING en - Title of the attached file + Sources of possible spare parts. @@ -4805,14 +7080,14 @@ batteries is describing a business requirement. - declarationOfConformity + manufacturerPartId en - declaration of conformity + Manufacturer Part ID - urn:samm:io.catenax.battery.battery_pass:2.0.0#declarationOfConformity + urn:samm:io.catenax.part_type_information:1.0.0#manufacturerPartId @@ -4829,20 +7104,20 @@ batteries is describing a business requirement. en - declaration of conformity + Manufacturer Part ID en - declarationOfConformity + manufacturerPartId STRING en - Declaration of conformity (CE) is describing a regulatory requirement. + Part ID as assigned by the manufacturer of the part. The part ID identifies the part in the manufacturer`s dataspace. The part ID references a specific version of a part. The version number must be included in the part ID if it is available. The part ID does not reference a specific instance of a part and must not be confused with the serial number. @@ -4851,14 +7126,14 @@ batteries is describing a business requirement. - fileLocation + nameAtManufacturer en - file location + Name at manufacturer - urn:samm:io.catenax.battery.battery_pass:2.0.0#fileLocation + urn:samm:io.catenax.part_type_information:1.0.0#nameAtManufacturer @@ -4875,20 +7150,20 @@ batteries is describing a business requirement. en - file location + Name at manufacturer en - fileLocation + nameAtManufacturer STRING en - Location of the file + Name of the part as assigned by the manufacturer. @@ -4897,14 +7172,14 @@ batteries is describing a business requirement. - title + sparePart en - title + Spare Part - urn:samm:io.catenax.battery.battery_pass:2.0.0#title + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#sparePart @@ -4921,20 +7196,20 @@ batteries is describing a business requirement. en - title + Spare Part en - title + sparePart STRING en - Title of the attached file + Possible spare parts of the product. @@ -4943,14 +7218,14 @@ batteries is describing a business requirement. - responsibleSourcing + spareParts en - responsible sourcing + spareParts - urn:samm:io.catenax.battery.battery_pass:2.0.0#responsibleSourcing + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#spareParts @@ -4967,20 +7242,20 @@ batteries is describing a business requirement. en - responsible sourcing + spareParts en - responsibleSourcing + spareParts STRING en - Document/Certificates on organizations compliance to ethical business practices + The list of spare parts available for the product from various suppliers. @@ -4989,14 +7264,14 @@ batteries is describing a business requirement. - document + applicable en - document + Applicable - urn:samm:io.catenax.battery.battery_pass:2.0.0#document + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#applicable @@ -5013,20 +7288,20 @@ batteries is describing a business requirement. en - document + Applicable en - document + applicable - STRING + BOOLEAN en - Set of documents containing the description of battery components + Check whether the connected attributes are applicable to the product. If it is not applicable (false), dummy data can be delivered. @@ -5035,14 +7310,14 @@ batteries is describing a business requirement. - name + handling en - name + handling - urn:samm:io.catenax.battery.battery_pass:2.0.0#name + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#handling @@ -5059,20 +7334,20 @@ batteries is describing a business requirement. en - name + handling en - name + handling STRING en - Name of the manufacturer is describing a regulatory requirement. + Properties connected with the handling of the product. @@ -5081,14 +7356,14 @@ batteries is describing a business requirement. - website + lifeUnit en - website + Life Unit - urn:samm:io.catenax.shared.contact_information:1.0.0#website + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#lifeUnit @@ -5105,36 +7380,100 @@ batteries is describing a business requirement. en - website + Life Unit en - website + lifeUnit STRING en - Website of the contact. + The unit of the respective lifespan expressed through the possible units day, month, cycle, year and runningOrOperatingHour. + + + + unit:day + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#LifeEnumeration:unit:day + + + + + + unit:month + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#LifeEnumeration:unit:month + + + + + + unit:year + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#LifeEnumeration:unit:year + + + + + + unit:cycle + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#LifeEnumeration:unit:cycle + + + + + + unit:runningOrOperatingHour + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#LifeEnumeration:unit:runningOrOperatingHour + + + + + + - phoneNumber + lifeValue en - phone number + Life Value - urn:samm:io.catenax.shared.contact_information:1.0.0#phoneNumber + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#lifeValue @@ -5151,20 +7490,20 @@ batteries is describing a business requirement. en - phone number + Life Value en - phoneNumber + lifeValue - STRING + INTEGER_MEASURE en - Phone number with country and area code + The value as an integer for the respective lifespan. @@ -5173,14 +7512,14 @@ batteries is describing a business requirement. - email + lifeType en - email + Life Type - urn:samm:io.catenax.shared.contact_information:1.0.0#email + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#lifeType @@ -5197,36 +7536,77 @@ batteries is describing a business requirement. en - email + Life Type en - email + lifeType STRING en - An email address + The type of lifespan represented with the values guaranteed lifetime, technical lifetime and mean time between failures. This attribute is mentioned in the ESPR proposal from March 30th, 2022 ANNEX I: +(a) durability and reliability of the product or its components as expressed through the product's guaranteed lifetime, technical lifetime [or] mean time between failures [...]. + + + + guaranteed lifetime + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#LifeTypeEnumeration:guaranteed lifetime + + + + + + technical lifetime + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#LifeTypeEnumeration:technical lifetime + + + + + + mean time between failures + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#LifeTypeEnumeration:mean time between failures + + + + + + - faxNumber + lifespan en - faxNumber + Lifespan - urn:samm:io.catenax.shared.contact_information:1.0.0#faxNumber + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#lifespan @@ -5243,20 +7623,21 @@ batteries is describing a business requirement. en - faxNumber + Lifespan en - faxNumber + lifespan STRING en - Fax number with country and area code + The type of lifespan represented with the values guaranteed lifetime, technical lifetime and mean time between failures. Both can be described through the attributes: type, which defines the type such as guaranteed lifetime or technical lifetime, the unit for the lifetime, and the value represented by an integer. These attributes are mentioned in the ESPR proposal from March 30th, 2022 ANNEX I: +(a) durability and reliability of the product or its components as expressed through the products guaranteed lifetime, technical lifetime [or] mean time between failures [...]. @@ -5265,14 +7646,14 @@ batteries is describing a business requirement. - contact + quantityValue en - contact + Quantity Value - urn:samm:io.catenax.battery.battery_pass:2.0.0#contact + urn:samm:io.catenax.shared.quantity:2.0.0#quantityValue @@ -5289,20 +7670,20 @@ batteries is describing a business requirement. en - contact + Quantity Value en - contact + quantityValue - STRING + REAL_MEASURE en - Contact details of the manufacturer + The quantity value associated with the unit. @@ -5311,14 +7692,14 @@ batteries is describing a business requirement. - thoroughfareTechnicalKey + linearUnit en - Thoroughfare Technical Key + Linear Unit - urn:samm:io.catenax.shared.address_characteristic:1.0.1#thoroughfareTechnicalKey + urn:samm:io.catenax.shared.quantity:2.0.0#linearUnit @@ -5335,80 +7716,104 @@ batteries is describing a business requirement. en - Thoroughfare Technical Key + Linear Unit en - thoroughfareTechnicalKey + linearUnit STRING en - Technical key of a thoroughfare. As specified by BPDM, this can be a "STREET" or a different type. + The unit of a linear attribute. - STREET + unit:millimetre + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#LinearUnitEnumeration:unit:millimetre + + + + + + unit:centimetre ModelReference DataElement - urn:samm:io.catenax.shared.address_characteristic:1.0.1#ThoroughfareTechnicalKeyCharacteristic:STREET + urn:samm:io.catenax.shared.quantity:2.0.0#LinearUnitEnumeration:unit:centimetre - INDUSTRIAL_ZONE + unit:metre ModelReference DataElement - urn:samm:io.catenax.shared.address_characteristic:1.0.1#ThoroughfareTechnicalKeyCharacteristic:INDUSTRIAL_ZONE + urn:samm:io.catenax.shared.quantity:2.0.0#LinearUnitEnumeration:unit:metre - OTHER + unit:kilometre ModelReference DataElement - urn:samm:io.catenax.shared.address_characteristic:1.0.1#ThoroughfareTechnicalKeyCharacteristic:OTHER + urn:samm:io.catenax.shared.quantity:2.0.0#LinearUnitEnumeration:unit:kilometre - RIVER + unit:inch ModelReference DataElement - urn:samm:io.catenax.shared.address_characteristic:1.0.1#ThoroughfareTechnicalKeyCharacteristic:RIVER + urn:samm:io.catenax.shared.quantity:2.0.0#LinearUnitEnumeration:unit:inch - SQUARE + unit:foot ModelReference DataElement - urn:samm:io.catenax.shared.address_characteristic:1.0.1#ThoroughfareTechnicalKeyCharacteristic:SQUARE + urn:samm:io.catenax.shared.quantity:2.0.0#LinearUnitEnumeration:unit:foot + + + + + + unit:yard + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#LinearUnitEnumeration:unit:yard @@ -5421,60 +7826,14 @@ batteries is describing a business requirement. - thoroughfareValue - - - en - Value Thoroughfare - - - urn:samm:io.catenax.shared.address_characteristic:1.0.1#thoroughfareValue - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Value Thoroughfare - - - - - en - thoroughfareValue - - - STRING - - - en - Value of a thoroughfare, e.g. name of a street. - - - - - - - - - thoroughfareNumber + width en - Thoroughfare Number + Width - urn:samm:io.catenax.shared.address_characteristic:1.0.1#thoroughfareNumber + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#width @@ -5491,20 +7850,20 @@ batteries is describing a business requirement. en - Thoroughfare Number + Width en - thoroughfareNumber + width STRING en - Number of a thoroughfare. As used differently in international context, this number can contain both numerical and alphanumerical values + The width of the item measured in a specific linear unit which can be declared in the corresponding unit attribute. @@ -5513,14 +7872,14 @@ batteries is describing a business requirement. - thoroughfare + quantityValue en - Thoroughfare + Quantity Value - urn:samm:io.catenax.shared.address_characteristic:1.0.1#thoroughfare + urn:samm:io.catenax.shared.quantity:2.0.0#quantityValue @@ -5537,20 +7896,20 @@ batteries is describing a business requirement. en - Thoroughfare + Quantity Value en - thoroughfare + quantityValue - STRING + REAL_MEASURE en - Street or thorough road name + The quantity value associated with the unit. @@ -5559,14 +7918,14 @@ batteries is describing a business requirement. - localityTechnicalKey + linearUnit en - Locality Technical Key + Linear Unit - urn:samm:io.catenax.shared.address_characteristic:1.0.1#localityTechnicalKey + urn:samm:io.catenax.shared.quantity:2.0.0#linearUnit @@ -5583,112 +7942,36 @@ batteries is describing a business requirement. en - Locality Technical Key + Linear Unit en - localityTechnicalKey + linearUnit STRING en - Technical key of a locality + The unit of a linear attribute. - - - - BLOCK - - ModelReference - - - DataElement - urn:samm:io.catenax.shared.address_characteristic:1.0.1#LocalityTechnicalKeyCharacteristic:BLOCK - - - - - - CITY - - ModelReference - - - DataElement - urn:samm:io.catenax.shared.address_characteristic:1.0.1#LocalityTechnicalKeyCharacteristic:CITY - - - - - - DISTRICT - - ModelReference - - - DataElement - urn:samm:io.catenax.shared.address_characteristic:1.0.1#LocalityTechnicalKeyCharacteristic:DISTRICT - - - - - - OTHER - - ModelReference - - - DataElement - urn:samm:io.catenax.shared.address_characteristic:1.0.1#LocalityTechnicalKeyCharacteristic:OTHER - - - - - - POST_OFFICE_CITY - - ModelReference - - - DataElement - urn:samm:io.catenax.shared.address_characteristic:1.0.1#LocalityTechnicalKeyCharacteristic:POST_OFFICE_CITY - - - - - - QUARTER - - ModelReference - - - DataElement - urn:samm:io.catenax.shared.address_characteristic:1.0.1#LocalityTechnicalKeyCharacteristic:QUARTER - - - - - - - localityValue + length en - Locality Value + Length - urn:samm:io.catenax.shared.address_characteristic:1.0.1#localityValue + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#length @@ -5705,20 +7988,20 @@ batteries is describing a business requirement. en - Locality Value + Length en - localityValue + length STRING en - Value of a locality, e.g. name of a city ("Mannheim"). + The length of the item measured in a specific linear unit which can be declared in the corresponding unit attribute. @@ -5727,14 +8010,14 @@ batteries is describing a business requirement. - locality + quantityValue en - Locality + Quantity Value - urn:samm:io.catenax.shared.address_characteristic:1.0.1#locality + urn:samm:io.catenax.shared.quantity:2.0.0#quantityValue @@ -5751,20 +8034,20 @@ batteries is describing a business requirement. en - Locality + Quantity Value en - locality + quantityValue - STRING + REAL_MEASURE en - Locality belonging to an address + The quantity value associated with the unit. @@ -5773,14 +8056,14 @@ batteries is describing a business requirement. - premiseTechnicalKey + linearUnit en - Premise Technical Key + Linear Unit - urn:samm:io.catenax.shared.address_characteristic:1.0.1#premiseTechnicalKey + urn:samm:io.catenax.shared.quantity:2.0.0#linearUnit @@ -5797,136 +8080,36 @@ batteries is describing a business requirement. en - Premise Technical Key + Linear Unit en - premiseTechnicalKey + linearUnit STRING en - Technical key of a premise + The unit of a linear attribute. - - - - BUILDING - - ModelReference - - - DataElement - urn:samm:io.catenax.shared.address_characteristic:1.0.1#PremiseTechnicalKeyCharacteristic:BUILDING - - - - - - HARBOUR - - ModelReference - - - DataElement - urn:samm:io.catenax.shared.address_characteristic:1.0.1#PremiseTechnicalKeyCharacteristic:HARBOUR - - - - - - LEVEL - - ModelReference - - - DataElement - urn:samm:io.catenax.shared.address_characteristic:1.0.1#PremiseTechnicalKeyCharacteristic:LEVEL - - - - - - OTHER - - ModelReference - - - DataElement - urn:samm:io.catenax.shared.address_characteristic:1.0.1#PremiseTechnicalKeyCharacteristic:OTHER - - - - - - ROOM - - ModelReference - - - DataElement - urn:samm:io.catenax.shared.address_characteristic:1.0.1#PremiseTechnicalKeyCharacteristic:ROOM - - - - - - SUITE - - ModelReference - - - DataElement - urn:samm:io.catenax.shared.address_characteristic:1.0.1#PremiseTechnicalKeyCharacteristic:SUITE - - - - - - UNIT - - ModelReference - - - DataElement - urn:samm:io.catenax.shared.address_characteristic:1.0.1#PremiseTechnicalKeyCharacteristic:UNIT - - - - - - WAREHOUSE - - ModelReference - - - DataElement - urn:samm:io.catenax.shared.address_characteristic:1.0.1#PremiseTechnicalKeyCharacteristic:WAREHOUSE - - - - - - - premiseValue + diameter en - Premise Value + Diameter - urn:samm:io.catenax.shared.address_characteristic:1.0.1#premiseValue + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#diameter @@ -5943,20 +8126,20 @@ batteries is describing a business requirement. en - Premise Value + Diameter en - premiseValue + diameter STRING en - Value of a premise, e.g. name or designation of a particular site + The diameter of the item, if applicable, measured in a specific linear unit which can be declared in the corresponding unit attribute. @@ -5965,14 +8148,14 @@ batteries is describing a business requirement. - premise + quantityValue en - Premise + Quantity Value - urn:samm:io.catenax.shared.address_characteristic:1.0.1#premise + urn:samm:io.catenax.shared.quantity:2.0.0#quantityValue @@ -5989,20 +8172,20 @@ batteries is describing a business requirement. en - Premise + Quantity Value en - premise + quantityValue - STRING + REAL_MEASURE en - Premise of an address, e.g. a specific "BUILDING" but can also be used for naming a particular site + The quantity value associated with the unit. @@ -6011,14 +8194,14 @@ batteries is describing a business requirement. - postalDeliveryPointTechnicalKey + linearUnit en - Postal Delivery Point Technical Key + Linear Unit - urn:samm:io.catenax.shared.address_characteristic:1.0.1#postalDeliveryPointTechnicalKey + urn:samm:io.catenax.shared.quantity:2.0.0#linearUnit @@ -6035,100 +8218,36 @@ batteries is describing a business requirement. en - Postal Delivery Point Technical Key + Linear Unit en - postalDeliveryPointTechnicalKey + linearUnit STRING en - Technical key of a postal delivery point + The unit of a linear attribute. - - - - INTERURBAN_DELIVERY_POINT - - ModelReference - - - DataElement - urn:samm:io.catenax.shared.address_characteristic:1.0.1#PostalDeliveryPointTechnicalKeyCharacteristic:INTERURBAN_DELIVERY_POINT - - - - - - MAIL_STATION - - ModelReference - - - DataElement - urn:samm:io.catenax.shared.address_characteristic:1.0.1#PostalDeliveryPointTechnicalKeyCharacteristic:MAIL_STATION - - - - - - MAILBOX - - ModelReference - - - DataElement - urn:samm:io.catenax.shared.address_characteristic:1.0.1#PostalDeliveryPointTechnicalKeyCharacteristic:MAILBOX - - - - - - OTHER - - ModelReference - - - DataElement - urn:samm:io.catenax.shared.address_characteristic:1.0.1#PostalDeliveryPointTechnicalKeyCharacteristic:OTHER - - - - - - POST_OFFICE_BOX - - ModelReference - - - DataElement - urn:samm:io.catenax.shared.address_characteristic:1.0.1#PostalDeliveryPointTechnicalKeyCharacteristic:POST_OFFICE_BOX - - - - - - - postalDeliveryPointValue + height en - Postal Delivery Point Value + Height - urn:samm:io.catenax.shared.address_characteristic:1.0.1#postalDeliveryPointValue + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#height @@ -6145,20 +8264,20 @@ batteries is describing a business requirement. en - Postal Delivery Point Value + Height en - postalDeliveryPointValue + height STRING en - Value of a postal delivery point, e.g. designation of a gate + The height of the item measured in a specific linear unit which can be declared in the corresponding unit attribute. @@ -6167,14 +8286,14 @@ batteries is describing a business requirement. - postalDeliveryPoint + quantityValue en - Postal Delivery Point + Quantity Value - urn:samm:io.catenax.shared.address_characteristic:1.0.1#postalDeliveryPoint + urn:samm:io.catenax.shared.quantity:2.0.0#quantityValue @@ -6191,20 +8310,20 @@ batteries is describing a business requirement. en - Postal Delivery Point + Quantity Value en - postalDeliveryPoint + quantityValue - STRING + REAL_MEASURE en - Delivery point, e.g. designation of a gate + The quantity value associated with the unit. @@ -6213,14 +8332,14 @@ batteries is describing a business requirement. - countryShortName + massUnit en - Country Short Name + Mass Unit - urn:samm:io.catenax.shared.address_characteristic:1.0.1#countryShortName + urn:samm:io.catenax.shared.quantity:2.0.0#massUnit @@ -6237,30 +8356,112 @@ batteries is describing a business requirement. en - Country Short Name + Mass Unit en - countryShortName + massUnit STRING + + + en + The unit of a mass related attribute. + + + + + + unit:gram + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#MassUnitEnumeration:unit:gram + + + + + + unit:kilogram + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#MassUnitEnumeration:unit:kilogram + + + + + + unit:tonneMetricTon + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#MassUnitEnumeration:unit:tonneMetricTon + + + + + + unit:tonUsOrShortTonUkorus + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#MassUnitEnumeration:unit:tonUsOrShortTonUkorus + + + + + + unit:ounceAvoirdupois + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#MassUnitEnumeration:unit:ounceAvoirdupois + + + + + + unit:pound + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#MassUnitEnumeration:unit:pound + + + + + + - country + grossWeight en - Country + Gross Weight - urn:samm:io.catenax.shared.address_characteristic:1.0.1#country + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#grossWeight @@ -6277,20 +8478,22 @@ batteries is describing a business requirement. en - Country + Gross Weight en - country + grossWeight STRING en - Country of an address + The gross weight of the item measured in a specific mass unit which can be declared in the corresponding unit attribute. Gross weight refers to the total weight of a product, including the weight of the packaging. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7: +(2) (b) (i) information on the performance of the product in relation to the product parameters referred to in Annex I; +Annex I (i) weight and volume of the product and its packaging, and the product-to-packaging ratio. @@ -6299,14 +8502,14 @@ batteries is describing a business requirement. - postCodeValue + quantityValue en - Post Code Value + Quantity Value - urn:samm:io.catenax.shared.address_characteristic:1.0.1#postCodeValue + urn:samm:io.catenax.shared.quantity:2.0.0#quantityValue @@ -6323,20 +8526,20 @@ batteries is describing a business requirement. en - Post Code Value + Quantity Value en - postCodeValue + quantityValue - STRING + REAL_MEASURE en - The value of a post code + The quantity value associated with the unit. @@ -6345,14 +8548,14 @@ batteries is describing a business requirement. - postCodeTechnicalKey + volumeUnit en - Post Code Technical Key + Volume Unit - urn:samm:io.catenax.shared.address_characteristic:1.0.1#postCodeTechnicalKey + urn:samm:io.catenax.shared.quantity:2.0.0#volumeUnit @@ -6369,80 +8572,116 @@ batteries is describing a business requirement. en - Post Code Technical Key + Volume Unit en - postCodeTechnicalKey + volumeUnit STRING en - The technical key of a post code + The unit of a volume related attribute. - CEDEX + unit:cubicMetre + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#VolumeUnitEnumeration:unit:cubicMetre + + + + + + unit:litre + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#VolumeUnitEnumeration:unit:litre + + + + + + unit:millilitre + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#VolumeUnitEnumeration:unit:millilitre + + + + + + unit:cubicCentimetre ModelReference DataElement - urn:samm:io.catenax.shared.address_characteristic:1.0.1#PostCodeTechnicalKeyCharacteristic:CEDEX + urn:samm:io.catenax.shared.quantity:2.0.0#VolumeUnitEnumeration:unit:cubicCentimetre - LARGE_MAIL_USER + unit:cubicInch ModelReference DataElement - urn:samm:io.catenax.shared.address_characteristic:1.0.1#PostCodeTechnicalKeyCharacteristic:LARGE_MAIL_USER + urn:samm:io.catenax.shared.quantity:2.0.0#VolumeUnitEnumeration:unit:cubicInch - OTHER + unit:cubicFoot ModelReference DataElement - urn:samm:io.catenax.shared.address_characteristic:1.0.1#PostCodeTechnicalKeyCharacteristic:OTHER + urn:samm:io.catenax.shared.quantity:2.0.0#VolumeUnitEnumeration:unit:cubicFoot - POST_BOX + unit:cubicYard ModelReference DataElement - urn:samm:io.catenax.shared.address_characteristic:1.0.1#PostCodeTechnicalKeyCharacteristic:POST_BOX + urn:samm:io.catenax.shared.quantity:2.0.0#VolumeUnitEnumeration:unit:cubicYard - REGULAR + unit:hectolitre ModelReference DataElement - urn:samm:io.catenax.shared.address_characteristic:1.0.1#PostCodeTechnicalKeyCharacteristic:REGULAR + urn:samm:io.catenax.shared.quantity:2.0.0#VolumeUnitEnumeration:unit:hectolitre @@ -6455,54 +8694,14 @@ batteries is describing a business requirement. - postCode - - - en - Post Code - - - urn:samm:io.catenax.shared.address_characteristic:1.0.1#postCode - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Post Code - - - - - en - postCode - - - STRING - - - - - - - address + grossVolume en - address + Gross Volume - urn:samm:io.catenax.battery.battery_pass:2.0.0#address + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#grossVolume @@ -6519,20 +8718,22 @@ batteries is describing a business requirement. en - address + Gross Volume en - address + grossVolume STRING en - An postal address + The gross volume of the item, if possible, measured in a specific capacity unit which can be declared in the corresponding unit attribute. If there is no separate packing, the volume of the product shall be given. Gross volume refers to the total volume of a product, including the volume of the packaging. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7: +(2) (b) (i) information on the performance of the product in relation to the product parameters referred to in Annex I; +Annex I (i) weight and volume of the product and its packaging, and the product-to-packaging ratio. @@ -6541,14 +8742,14 @@ batteries is describing a business requirement. - manufacturer + quantityValue en - manufacturer + Quantity Value - urn:samm:io.catenax.battery.battery_pass:2.0.0#manufacturer + urn:samm:io.catenax.shared.quantity:2.0.0#quantityValue @@ -6565,20 +8766,20 @@ batteries is describing a business requirement. en - manufacturer + Quantity Value en - manufacturer + quantityValue - STRING + REAL_MEASURE en - Legal entity which sells and invoices the battery + The quantity value associated with the unit. @@ -6587,14 +8788,14 @@ batteries is describing a business requirement. - maximumAllowedBatteryPower + massUnit en - maximum allowed battery power + Mass Unit - urn:samm:io.catenax.battery.battery_pass:2.0.0#maximumAllowedBatteryPower + urn:samm:io.catenax.shared.quantity:2.0.0#massUnit @@ -6611,21 +8812,20 @@ batteries is describing a business requirement. en - maximum allowed battery power + Mass Unit en - maximumAllowedBatteryPower + massUnit - watt - REAL_MEASURE + STRING en - Maximum allowed battery power (W) of the battery is describing a business requirement. + The unit of a mass related attribute. @@ -6634,14 +8834,14 @@ batteries is describing a business requirement. - originalPower + weight en - battery original power + Weight - urn:samm:io.catenax.battery.battery_pass:2.0.0#originalPower + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#weight @@ -6658,21 +8858,22 @@ batteries is describing a business requirement. en - battery original power + Weight en - originalPower + weight - watt - REAL_MEASURE + STRING en - Original power capability in Watts is describing a regulatory requirement. + Weight of the product measured in a specific mass unit which can be declared in the corresponding unit attribute. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7: +(2) (b) (i) information on the performance of the product in relation to the product parameters referred to in Annex I; +Annex I (i) weight and volume of the product [...]. @@ -6681,14 +8882,14 @@ batteries is describing a business requirement. - powerFade + quantityValue en - maximum allowed battery power + Quantity Value - urn:samm:io.catenax.battery.battery_pass:2.0.0#powerFade + urn:samm:io.catenax.shared.quantity:2.0.0#quantityValue @@ -6705,21 +8906,20 @@ batteries is describing a business requirement. en - maximum allowed battery power + Quantity Value en - powerFade + quantityValue - percent REAL_MEASURE en - Maximum allowed battery power (W) of the battery is describing a business requirement. + The quantity value associated with the unit. @@ -6728,14 +8928,14 @@ batteries is describing a business requirement. - powerCapabilityAt20Charge + volumeUnit en - power capability at 20 charge + Volume Unit - urn:samm:io.catenax.battery.battery_pass:2.0.0#powerCapabilityAt20Charge + urn:samm:io.catenax.shared.quantity:2.0.0#volumeUnit @@ -6752,21 +8952,20 @@ batteries is describing a business requirement. en - power capability at 20 charge + Volume Unit en - powerCapabilityAt20Charge + volumeUnit - watt - REAL_MEASURE + STRING en - Power (capability) at 20% state of charge. Description from the Regulation is describing a regulatory requirement. + The unit of a volume related attribute. @@ -6775,14 +8974,14 @@ batteries is describing a business requirement. - powerCapabilityAt80Charge + volume en - power capability at 80 charge + Volume - urn:samm:io.catenax.battery.battery_pass:2.0.0#powerCapabilityAt80Charge + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#volume @@ -6799,21 +8998,22 @@ batteries is describing a business requirement. en - power capability at 80 charge + Volume en - powerCapabilityAt80Charge + volume - watt - REAL_MEASURE + STRING en - Power (capability) at 80% state of charge. Description from the Regulation is describing a regulatory requirement. + Volume of the product, if possible, measured in a specific capacity unit which can be declared in the corresponding unit attribute. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7: +(2) (b) (i) information on the performance of the product in relation to the product parameters referred to in Annex I; +Annex I (i) weight and volume of the product [...]. @@ -6822,14 +9022,14 @@ batteries is describing a business requirement. - originalPowerCapability + physicalDimension en - original power capability + Physical Dimension - urn:samm:io.catenax.battery.battery_pass:2.0.0#originalPowerCapability + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#physicalDimension @@ -6846,21 +9046,22 @@ batteries is describing a business requirement. en - original power capability + Physical Dimension en - originalPowerCapability + physicalDimension - kilowatt - INTEGER_MEASURE + STRING en - Performance ability of the high voltage battery i.e. the amount of energy that a battery is capable to provide over a given period of time is describing a regulatory requirement. + Physical dimensions are properties associated with physical quantities for purposes of classification or differentiation. These attributes are mentioned in the ESPR provisional agreement from January 9th, Article 7: +(2) (b) (i) information on the performance of the product in relation to one or more of the product parameters referred to in Annex I; +Annex I (i) weight and volume of the product and its packaging, and the product-to-packaging ratio. @@ -6869,14 +9070,14 @@ batteries is describing a business requirement. - originalPowerCapabilityLimits + physicalState en - original power capability limits + Physical State - urn:samm:io.catenax.battery.battery_pass:2.0.0#originalPowerCapabilityLimits + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#physicalState @@ -6893,37 +9094,88 @@ batteries is describing a business requirement. en - original power capability limits + Physical State en - originalPowerCapabilityLimits + physicalState - kilowatt - INTEGER_MEASURE + STRING en - Performance ability of the high voltage battery according to limits i.e. how much power it can provide within given limits is describing a regulatory requirement. + The physical state of the item. There are four states of matter solid, liquid, gas and plasma which can be chosen from an enumeration. + + + + solid + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#PhysicalStateEnumeration:solid + + + + + + liquid + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#PhysicalStateEnumeration:liquid + + + + + + gas + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#PhysicalStateEnumeration:gas + + + + + + plasma + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#PhysicalStateEnumeration:plasma + + + + + + - batteryPower + generalPerformanceClass en - attachment + General Performance Class - urn:samm:io.catenax.battery.battery_pass:2.0.0#batteryPower + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#generalPerformanceClass @@ -6940,20 +9192,23 @@ batteries is describing a business requirement. en - attachment + General Performance Class en - batteryPower + generalPerformanceClass STRING en - Characterisitic to describe the power (W) properties of the batterie. + The performance class of the product. This attribute is mentioned ESPR provisional agreement from January 9th, 2024 Article 7: +4. When establishing the information requirements referred to in paragraph 2, point (b), point (i), the Commission shall, as appropriate in view of the specificity of the product group, determine classes of performance. Classes of performance may be based on single parameters, on aggregated scores, in absolute terms or in any other form that enables potential customers to choose the best performing products. Those classes of performance shall correspond to significant improvements in performance levels. Where classes of performance are based on parameters in relation to which performance requirements are established, they shall use as the minimum level the minimum performance required at the time when the classes of performance start to apply. +Definition: +'class of performance': means a range of performance levels in relation to one or more product parameters referred to in Annex I, based on a common methodology for the product or product group, ordered into successive steps to allow for product differentiation. @@ -6962,14 +9217,14 @@ batteries is describing a business requirement. - minVoltage + characteristics en - min voltage + Characteristics - urn:samm:io.catenax.battery.battery_pass:2.0.0#minVoltage + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#characteristics @@ -6986,21 +9241,20 @@ batteries is describing a business requirement. en - min voltage + Characteristics en - minVoltage + characteristics - volt - REAL_MEASURE + STRING en - Value of the minimal voltage the battery is rated for is describing a regulatory requirement. + Defines specific characteristics of a product. @@ -7009,14 +9263,14 @@ batteries is describing a business requirement. - nominalVoltage + placedOnMarket en - nominal voltage + Placed on Market - urn:samm:io.catenax.battery.battery_pass:2.0.0#nominalVoltage + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#placedOnMarket @@ -7033,21 +9287,20 @@ batteries is describing a business requirement. en - nominal voltage + Placed on Market en - nominalVoltage + placedOnMarket - volt - REAL_MEASURE + STRING en - Value of the nominal voltage the battery is rated for is describing a regulatory requirement. + The timestamp in the format (yyyy-mm-dd) with or without time zone when the product was put in the market. @@ -7056,14 +9309,14 @@ batteries is describing a business requirement. - maxVoltage + purpose en - max voltage + Purpose - urn:samm:io.catenax.battery.battery_pass:2.0.0#maxVoltage + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#purpose @@ -7080,21 +9333,20 @@ batteries is describing a business requirement. en - max voltage + Purpose en - maxVoltage + purpose - volt - REAL_MEASURE + STRING en - Value of the maximum voltage the battery is rated for is describing a regulatory requirement. + One or more intended industry/industries of the product described by the digital product passport. If exchanged via Catena-X, 'automotive ' is a must choice included in the list. @@ -7103,14 +9355,14 @@ batteries is describing a business requirement. - batteryVoltage + commercial en - battery voltage + Commercial - urn:samm:io.catenax.battery.battery_pass:2.0.0#batteryVoltage + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#commercial @@ -7127,20 +9379,20 @@ batteries is describing a business requirement. en - battery voltage + Commercial en - batteryVoltage + commercial STRING en - Voltage (V) of the battery. + Commercial information of the product. @@ -7149,14 +9401,14 @@ batteries is describing a business requirement. - ratedCapacity + applicable en - rated capacity + Applicable - urn:samm:io.catenax.battery.battery_pass:2.0.0#ratedCapacity + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#applicable @@ -7173,21 +9425,20 @@ batteries is describing a business requirement. en - rated capacity + Applicable en - ratedCapacity + applicable - ampere - INTEGER_MEASURE + BOOLEAN en - The total number of ampere-hours (Ah) that can be withdrawn from a fully charged battery under specific conditions is describing a regulatory requirement. + Check whether the connected attributes are applicable to the product. If it is not applicable (false), dummy data can be delivered. @@ -7196,14 +9447,14 @@ batteries is describing a business requirement. - capacityFade + location en - capacity fade + Location - urn:samm:io.catenax.battery.battery_pass:2.0.0#capacityFade + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#location @@ -7220,21 +9471,21 @@ batteries is describing a business requirement. en - capacity fade + Location en - capacityFade + location - percent - INTEGER_MEASURE + STRING en - The decrease over time and upon usage in the amount of charge that a battery can deliver at the rated voltage, with respect to the original rated capacity declared by the manufacturer is describing a regulatory requirement. + The location of the substances of concern within the product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7: +(5) (b) the location of the substances of concern within the product. @@ -7243,14 +9494,14 @@ batteries is describing a business requirement. - cellInternalResistance + materialUnit en - cell internal resistance + Material Unit - urn:samm:io.catenax.battery.battery_pass:2.0.0#cellInternalResistance + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#materialUnit @@ -7267,37 +9518,112 @@ batteries is describing a business requirement. en - cell internal resistance + Material Unit en - cellInternalResistance + materialUnit - milliohm - INTEGER_MEASURE + STRING en - The resistance offered by the cell in the flow of the current + The unit of concentration chosen from an enumeration: mass percent, volume percent, parts per thousand, parts per million, parts per billion and parts per trillion. + + + + unit:partPerMillion + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#ConcentrationEnumeration:unit:partPerMillion + + + + + + unit:percent + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#ConcentrationEnumeration:unit:percent + + + + + + unit:percentVolume + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#ConcentrationEnumeration:unit:percentVolume + + + + + + unit:partPerThousand + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#ConcentrationEnumeration:unit:partPerThousand + + + + + + unit:partPerTrillionUs + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#ConcentrationEnumeration:unit:partPerTrillionUs + + + + + + unit:partPerBillionUs + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#ConcentrationEnumeration:unit:partPerBillionUs + + + + + + - packInternalResistance + concentration en - pack internal resistance + Concentration - urn:samm:io.catenax.battery.battery_pass:2.0.0#packInternalResistance + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#concentration @@ -7314,21 +9640,24 @@ batteries is describing a business requirement. en - pack internal resistance + Concentration en - packInternalResistance + concentration - ohm - INTEGER_MEASURE + REAL_MEASURE en - Total internal resistance in a battery pack is describing a regulatory requirement. + Concentration of the material at the level of the product. This attribute is specially mentioned for substances of concern mentioned in the ESPR proposal from March 30th, 2022 Article 7: +(5) (c) the concentration, maximum concentration or concentration range of the substances of concern, at the level of the product [...]. +Other substances are mentioned for the purpose of recycling in the ESPR provisional agreement from January 9th, 2024 Annex I: +(d) design for recycling, ease and quality of recycling as expressed through: use of easily recyclable materials, safe, easy and non-destructive access to recyclable components and materials or components and materials containing hazardous substances and material composition and homogeneity, possibility for high-purity sorting, number of materials and components used, use of standard components, use of component and material coding standards for the identification of components and materials, number and complexity of processes and tools needed, ease of nondestructive disassembly and re-assembly, conditions for access to product data, conditions for access to or use of hardware and software needed. + @@ -7337,14 +9666,14 @@ batteries is describing a business requirement. - packInternalResistanceIncrease + exemption en - pack internal resistanceIncrease + Exemption - urn:samm:io.catenax.battery.battery_pass:2.0.0#packInternalResistanceIncrease + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#exemption @@ -7361,21 +9690,21 @@ batteries is describing a business requirement. en - pack internal resistanceIncrease + Exemption en - packInternalResistanceIncrease + exemption - percent - INTEGER_MEASURE + STRING en - Increase in internal resistance of a battery pack over a period of time is describing a regulatory requirement. + Exemptions to the substance of concern. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Article 7: +(5) (c) provide duly justified exemptions for substances of concern or information elements from the information requirements referred to in the first subparagraph based on the technical feasibility or relevance of tracking substances of concern, the existence of analytical methods to detect and quantify them, the need to protect confidential business information or in other duly justified cases. Substances of concern within the meaning of Article 2(28), point a), shall not be exempted if they are present in products, their relevant components or spare parts in a concentration above 0,1 % weight by weight. @@ -7384,14 +9713,14 @@ batteries is describing a business requirement. - internalResistance + hazardCategory en - internal resistance + Hazard Category - urn:samm:io.catenax.battery.battery_pass:2.0.0#internalResistance + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#hazardCategory @@ -7408,20 +9737,21 @@ batteries is describing a business requirement. en - internal resistance + Hazard Category en - internalResistance + hazardCategory STRING en - Internal resistance in a battery cell or pack is describing a regulatory requirement. + The hazard category of the substance of concern. Defined in Article 2 of Regulation (EC) No 1272/2008 of the European Parliament and of the Council of 16 December 2008 on classification, labelling and packaging of substances and mixtures, amending and repealing Directives 67/548/EEC and 1999/45/EC, and amending Regulation (EC) No 1907/2006: +2. 'hazard category' means the division of criteria within each hazard class, specifying hazard severity. @@ -7430,14 +9760,14 @@ batteries is describing a business requirement. - capacityThresholdExhaustion + hazardClass en - internal resistance + Hazard Class - urn:samm:io.catenax.battery.battery_pass:2.0.0#capacityThresholdExhaustion + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#hazardClass @@ -7454,21 +9784,21 @@ batteries is describing a business requirement. en - internal resistance + Hazard Class en - capacityThresholdExhaustion + hazardClass - percent - INTEGER_MEASURE + STRING en - Capacity threshold for exhaustion as percentage value is describing a regulatory requirement. + The hazard class of the substance of concern. Defined in Article 2 of Regulation (EC) No 1272/2008 of the European Parliament and of the Council of 16 December 2008 on classification, labelling and packaging of substances and mixtures, amending and repealing Directives 67/548/EEC and 1999/45/EC, and amending Regulation (EC) No 1907/2006: +1. 'hazard class' means the nature of the physical, health or environmental hazard. @@ -7477,14 +9807,14 @@ batteries is describing a business requirement. - maximumAllowedBatteryEnergy + hazardStatement en - maximum allowed battery energy + Hazard Statement - urn:samm:io.catenax.battery.battery_pass:2.0.0#maximumAllowedBatteryEnergy + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#hazardStatement @@ -7501,21 +9831,21 @@ batteries is describing a business requirement. en - maximum allowed battery energy + Hazard Statement en - maximumAllowedBatteryEnergy + hazardStatement - wattHour - REAL_MEASURE + STRING en - Maximum allowed battery energy (Wh) of the battery is describing a regulatory requirement. + The hazard statement of the substance of concern. Defined in Article 2 of Regulation (EC) No 1272/2008 of the European Parliament and of the Council of 16 December 2008 on classification, labelling and packaging of substances and mixtures, amending and repealing Directives 67/548/EEC and 1999/45/EC, and amending Regulation (EC) No 1907/2006: +5. 'hazard statement' means a phrase assigned to a hazard class and category that describes the nature of the hazards of a hazardous substance or mixture, including, where appropriate, the degree of hazard. @@ -7524,14 +9854,14 @@ batteries is describing a business requirement. - energyRoundtripEfficiency + hazardClassification en - energy roundtrip efficiency + Hazard Classification - urn:samm:io.catenax.battery.battery_pass:2.0.0#energyRoundtripEfficiency + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#hazardClassification @@ -7548,21 +9878,26 @@ batteries is describing a business requirement. en - energy roundtrip efficiency + Hazard Classification en - energyRoundtripEfficiency + hazardClassification - percent - INTEGER_MEASURE + STRING en - Round-trip efficiency is the percentage of electricity put into storage is describing a regulatory requirement. + The specification of the hazard class. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I: +(f) use of substances, and in particular the use of substances of concern, on their own, as constituents of substances or in mixtures, during the production process of products, or leading to their presence in products, including once these products become waste, and their impacts on human health and the environment; +Further defined is this by Regulation (EC) No 1272/2008 of the European Parliament and of the Council of 16 December 2008 on classification, labelling and packaging of substances and mixtures, amending and repealing Directives 67/548/EEC and 1999/45/EC, and amending Regulation (EC) No 1907/2006. +Defined in Article 2: +1. 'hazard class' means the nature of the physical, health or environmental hazard; +2. 'hazard category' means the division of criteria within each hazard class, specifying hazard severity; +5. 'hazard statement' means a phrase assigned to a hazard class and category that describes the nature of the hazards of a hazardous substance or mixture, including, where appropriate, the degree of hazard; @@ -7571,14 +9906,14 @@ batteries is describing a business requirement. - energyRoundtripEfficiencyChange + minConcentration en - energy roundtrip efficiency + Minimum Concentration - urn:samm:io.catenax.battery.battery_pass:2.0.0#energyRoundtripEfficiencyChange + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#minConcentration @@ -7595,21 +9930,21 @@ batteries is describing a business requirement. en - energy roundtrip efficiency + Minimum Concentration en - energyRoundtripEfficiencyChange + minConcentration - percent - INTEGER_MEASURE + REAL_MEASURE en - Round-trip efficiency is the percentage of electricity put into storage is describing a regulatory requirement. + The minimum concentration of the substance of concern at the level of the product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7: +(5) (c) [...] concentration range of the substances of concern, at the level of the product [...]. @@ -7618,14 +9953,14 @@ batteries is describing a business requirement. - batteryEnergy + maxConcentration en - battery energy + Maximum Concentration - urn:samm:io.catenax.battery.battery_pass:2.0.0#batteryEnergy + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#maxConcentration @@ -7642,20 +9977,21 @@ batteries is describing a business requirement. en - battery energy + Maximum Concentration en - batteryEnergy + maxConcentration - STRING + REAL_MEASURE en - Characterisitic to describe the energy (kWh) properties of the batterie. + The maximum concentration of the substance of concern at the level of the product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7: +(5) (c) the concentration, maximum concentration or concentration range of the substances of concern, at the level of the product [...]. @@ -7664,14 +10000,14 @@ batteries is describing a business requirement. - ratioMaximumAllowedBatteryPowerAndMaximumAllowedBatteryEnergy + concentrationRange en - ratio maximum allowed battery power and maximum allowed battery energy + Concentration Range - urn:samm:io.catenax.battery.battery_pass:2.0.0#ratioMaximumAllowedBatteryPowerAndMaximumAllowedBatteryEnergy + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#concentrationRange @@ -7688,20 +10024,21 @@ batteries is describing a business requirement. en - ratio maximum allowed battery power and maximum allowed battery energy + Concentration Range en - ratioMaximumAllowedBatteryPowerAndMaximumAllowedBatteryEnergy + concentrationRange - REAL_MEASURE + STRING en - Ratio between maximum allowed battery power (W) and battery energy (Wh) is describing a regulatory requirement. + The concentration range for the substance of concern. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7: +(5) (c) [...] concentration range of the substances of concern, at the level of the product [...]. @@ -7710,14 +10047,14 @@ batteries is describing a business requirement. - electrochemicalProperties + chemicalId en - electrochemical properties + Chemical Id - urn:samm:io.catenax.battery.battery_pass:2.0.0#electrochemicalProperties + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#chemicalId @@ -7734,20 +10071,20 @@ batteries is describing a business requirement. en - electrochemical properties + Chemical Id en - electrochemicalProperties + chemicalId STRING en - Electrochemical properties of an electrochemical energy storage + The substance identification, in accordance with the specification in the attribute for the list type. @@ -7756,14 +10093,14 @@ batteries is describing a business requirement. - length + listTypeId en - length + List Type Id - urn:samm:io.catenax.battery.battery_pass:2.0.0#length + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#listTypeId @@ -7780,37 +10117,76 @@ batteries is describing a business requirement. en - length + List Type Id en - length + listTypeId - millimetre - INTEGER_MEASURE + STRING en - Length of the item is describing a business requirement. + The type of standard used for the identification of the substances. Selected can be for example CAS, IUPAC or EC. + + + + CAS + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#ListTypeEnumerationId:CAS + + + + + + EC + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#ListTypeEnumerationId:EC + + + + + + IUPAC + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#ListTypeEnumerationId:IUPAC + + + + + + - width + chemicalName en - width + Chemical Name - urn:samm:io.catenax.battery.battery_pass:2.0.0#width + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#chemicalName @@ -7827,21 +10203,20 @@ batteries is describing a business requirement. en - width + Chemical Name en - width + chemicalName - millimetre - INTEGER_MEASURE + STRING en - Width of the item is describing a business requirement. + The name of the material which is present in the product. @@ -7850,14 +10225,14 @@ batteries is describing a business requirement. - height + materialIdentification en - height + Material Identification - urn:samm:io.catenax.battery.battery_pass:2.0.0#height + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#materialIdentification @@ -7874,21 +10249,25 @@ batteries is describing a business requirement. en - height + Material Identification en - height + materialIdentification - millimetre - INTEGER_MEASURE + STRING en - Height of the item is describing a business requirement. + The chemical material name and identification, in accordance with the specification in the attribute for the list type. Preference is given to the IUPAC name. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Article 7: +(5) (a) the name of the substances of concern present in the product, as follows: + - name(s) in the International Union of Pure and Applied Chemistry (IUPAC) nomenclature, or another international name when IUPAC name is not available; +- other names (usual name, trade name, abbreviation); +- European Community (EC) number, as indicated in the European Inventory of Existing Commercial Chemical Substances (EINECS), the European List of Notified Chemical Substances (ELINCS) or the No Longer Polymer (NLP) list or assigned by the European Chemicals Agency (ECHA), if available; +- the Chemical Abstract Service (CAS) name(s) and number(s), if available; . @@ -7897,14 +10276,14 @@ batteries is describing a business requirement. - diameter + content en - diameter + Content - urn:samm:io.catenax.battery.battery_pass:2.0.0#diameter + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content @@ -7921,21 +10300,20 @@ batteries is describing a business requirement. en - diameter + Content en - diameter + content - millimetre - INTEGER_MEASURE + STRING en - Diameter of the item. + The content of the document e.g a link. @@ -7944,14 +10322,14 @@ batteries is describing a business requirement. - weight + contentType en - weight + Content Type - urn:samm:io.catenax.battery.battery_pass:2.0.0#weight + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType @@ -7968,21 +10346,20 @@ batteries is describing a business requirement. en - weight + Content Type en - weight + contentType - kilogram - INTEGER_MEASURE + STRING en - Weight of the item is describing a regulatory requirement. + The type of content which can be expected in the "content" property. Examples are a link, restricted link, pdf, excel, etc. @@ -7991,14 +10368,14 @@ batteries is describing a business requirement. - physicalDimensions + header en - physical dimensions + Header - urn:samm:io.catenax.battery.battery_pass:2.0.0#physicalDimensions + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header @@ -8015,20 +10392,20 @@ batteries is describing a business requirement. en - physical dimensions + Header en - physicalDimensions + header STRING en - Geometrical properties of the battery + The header as a short description of the document with a maximum of 100 characters. @@ -8037,14 +10414,14 @@ batteries is describing a business requirement. - stateOfHealth + documentation en - state of health + Documentation - urn:samm:io.catenax.battery.battery_pass:2.0.0#stateOfHealth + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#documentation @@ -8061,21 +10438,20 @@ batteries is describing a business requirement. en - state of health + Documentation en - stateOfHealth + documentation - percent - INTEGER_MEASURE + STRING en - Evidence/Certificate of the health evaluation of a battery for its use following repurposing or remanufacturing operations is describing a business requirement. + Documentation accompanying the material. @@ -8084,14 +10460,14 @@ batteries is describing a business requirement. - stateOfCharge + substanceOfConcern en - state of charge + Substance of Concern - urn:samm:io.catenax.battery.battery_pass:2.0.0#stateOfCharge + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#substanceOfConcern @@ -8108,21 +10484,31 @@ batteries is describing a business requirement. en - state of charge + Substance of Concern en - stateOfCharge + substanceOfConcern - percent - INTEGER_MEASURE + STRING en - The value of the state of charge of the battery at the end of life i.e. when entering recycling scheme is describing a business requirement. + Information regarding substances of concern in the product. Attributes are among others substance names, ids, concentration, location and hazard class. This is mentioned in the ESPR provisional agreement from January 9th, 2024 Article 7: +(5) (a) the name of the substances of concern present in the product, as follows: +- name(s) in the International Union of Pure and Applied Chemistry (IUPAC) nomenclature, or another international name when IUPAC name is not available; +- other names (usual name, trade name, abbreviation); +- European Community (EC) number, as indicated in the European Inventory of Existing Commercial Chemical Substances (EINECS), the European List of Notified Chemical Substances (ELINCS) or the No Longer Polymer (NLP) list or assigned by the European Chemicals Agency (ECHA), if available; +- the Chemical Abstract Service (CAS) name(s) and number(s), if available; +(5) (b) the location of the substances of concern within the product. +(5) (c) the concentration, maximum concentration or concentration range of the substances of concern, at the level of the product its relevant components, or spare parts; +(d) relevant instructions for the safe use of the product; +(e) information relevant for disassembly, preparation for reuse, reuse, recycling and the environmentally sound management of the product at the end of its life. +And in the next paragraph: +(c) provide duly justified exemptions for substances of concern or information elements from the information requirements referred to in the first subparagraph. @@ -8131,14 +10517,14 @@ batteries is describing a business requirement. - statusBattery + substancesOfConcern en - status battery + Substances of Concern - urn:samm:io.catenax.battery.battery_pass:2.0.0#statusBattery + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#substancesOfConcern @@ -8155,20 +10541,21 @@ batteries is describing a business requirement. en - status battery + Substances of Concern en - statusBattery + substancesOfConcern STRING en - Status of the battery is describing a regulatory requirement. Value list provided by the regulators. + Information regarding substances of concern in the product. The ESPR provisional agreement from January 9th, 2024 defines: +(52) 'hazardous substance' means a substance classified as hazardous pursuant to Article 3 of Regulation (EC) No 1272/2008. @@ -8177,14 +10564,14 @@ batteries is describing a business requirement. - stateOfBattery + applicable en - state of battery + Applicable - urn:samm:io.catenax.battery.battery_pass:2.0.0#stateOfBattery + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#applicable @@ -8201,20 +10588,20 @@ batteries is describing a business requirement. en - state of battery + Applicable en - stateOfBattery + applicable - STRING + BOOLEAN en - The condition of the battery at the end of life i.e. when entering recycling scheme + Check whether the connected attributes are applicable to the product. If it is not applicable (false), dummy data can be delivered. @@ -8223,14 +10610,14 @@ batteries is describing a business requirement. - batteryType + recycled en - battery type + Recycled - urn:samm:io.catenax.battery.battery_pass:2.0.0#batteryType + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#recycled @@ -8247,20 +10634,21 @@ batteries is describing a business requirement. en - battery type + Recycled en - batteryType + recycled - STRING + REAL_MEASURE en - Battery type as described by the contents of the battery e.g. cell chemistry is describing a regulatory requirement. + The share of the material, which is recovered recycled content from the product. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I: +(h) use or content of recycled materials and recovery of materials, including critical raw materials; @@ -8269,14 +10657,14 @@ batteries is describing a business requirement. - batteryModel + renewable en - battery model + Renewable - urn:samm:io.catenax.battery.battery_pass:2.0.0#batteryModel + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#renewable @@ -8293,20 +10681,22 @@ batteries is describing a business requirement. en - battery model + Renewable en - batteryModel + renewable - STRING + REAL_MEASURE en - Battery type as described by the contents of the battery e.g. cell chemistry is describing a regulatory requirement. + The share of the material, which is from a renewable resource that can be replenished. Renewable resources are those that can be reproduced by physical, chemical, or mechanical processes. These are the kind of resources that can be regenerated throughout time. Forest wood, for example, can be grown through reforestation. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I: +(ha) use or content of sustainable renewable materials; + @@ -8315,14 +10705,14 @@ batteries is describing a business requirement. - batteryIDDMCCode + materialUnit en - battery ID DMC code + Material Unit - urn:samm:io.catenax.battery.battery_pass:2.0.0#batteryIDDMCCode + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#materialUnit @@ -8339,20 +10729,20 @@ batteries is describing a business requirement. en - battery ID DMC code + Material Unit en - batteryIDDMCCode + materialUnit STRING en - Digital Matrix Code (DMC) of the battery i.e. serial number allowing for unequivocal identification of a battery is describing a regulatory requirement. + The unit of concentration chosen from an enumeration: mass percent, volume percent, parts per thousand, parts per million, parts per billion and parts per trillion. @@ -8361,14 +10751,14 @@ batteries is describing a business requirement. - batteryIdentification + chemicalId en - battery identification + Chemical Id - urn:samm:io.catenax.battery.battery_pass:2.0.0#batteryIdentification + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#chemicalId @@ -8385,20 +10775,20 @@ batteries is describing a business requirement. en - battery identification + Chemical Id en - batteryIdentification + chemicalId STRING en - Information to identify a specific battery. + The substance identification, in accordance with the specification in the attribute for the list type. @@ -8407,14 +10797,14 @@ batteries is describing a business requirement. - dateOfManufacturing + listTypeId en - date of manufacturing + List Type Id - urn:samm:io.catenax.battery.battery_pass:2.0.0#dateOfManufacturing + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#listTypeId @@ -8431,20 +10821,20 @@ batteries is describing a business requirement. en - date of manufacturing + List Type Id en - dateOfManufacturing + listTypeId STRING en - Manufacturing date of the battery is describing a regulatory requirement. + The type of standard used for the identification of the substances. Selected can be for example CAS, IUPAC or EC. @@ -8453,14 +10843,14 @@ batteries is describing a business requirement. - thoroughfareTechnicalKey + chemicalName en - Thoroughfare Technical Key + Chemical Name - urn:samm:io.catenax.shared.address_characteristic:1.0.1#thoroughfareTechnicalKey + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#chemicalName @@ -8477,20 +10867,20 @@ batteries is describing a business requirement. en - Thoroughfare Technical Key + Chemical Name en - thoroughfareTechnicalKey + chemicalName STRING en - Technical key of a thoroughfare. As specified by BPDM, this can be a "STREET" or a different type. + The name of the material which is present in the product. @@ -8499,14 +10889,14 @@ batteries is describing a business requirement. - thoroughfareValue + materialIdentification en - Value Thoroughfare + Material Identification - urn:samm:io.catenax.shared.address_characteristic:1.0.1#thoroughfareValue + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#materialIdentification @@ -8523,20 +10913,25 @@ batteries is describing a business requirement. en - Value Thoroughfare + Material Identification en - thoroughfareValue + materialIdentification STRING en - Value of a thoroughfare, e.g. name of a street. + The chemical material name and identification, in accordance with the specification in the attribute for the list type. Preference is given to the IUPAC name. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Article 7: +(5) (a) the name of the substances of concern present in the product, as follows: + - name(s) in the International Union of Pure and Applied Chemistry (IUPAC) nomenclature, or another international name when IUPAC name is not available; +- other names (usual name, trade name, abbreviation); +- European Community (EC) number, as indicated in the European Inventory of Existing Commercial Chemical Substances (EINECS), the European List of Notified Chemical Substances (ELINCS) or the No Longer Polymer (NLP) list or assigned by the European Chemicals Agency (ECHA), if available; +- the Chemical Abstract Service (CAS) name(s) and number(s), if available; . @@ -8545,14 +10940,14 @@ batteries is describing a business requirement. - thoroughfareNumber + critical en - Thoroughfare Number + Critical - urn:samm:io.catenax.shared.address_characteristic:1.0.1#thoroughfareNumber + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#critical @@ -8569,20 +10964,22 @@ batteries is describing a business requirement. en - Thoroughfare Number + Critical en - thoroughfareNumber + critical - STRING + BOOLEAN en - Number of a thoroughfare. As used differently in international context, this number can contain both numerical and alphanumerical values + A flag, if the material is a critical raw material. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I: +(h) use or content of recycled materials and recovery of materials, including critical raw materials; +In Annex II of the connected proposal Act of Critical Raw Materials, a list of critical raw materials can be found. @@ -8591,14 +10988,14 @@ batteries is describing a business requirement. - thoroughfare + concentration en - Thoroughfare + Concentration - urn:samm:io.catenax.shared.address_characteristic:1.0.1#thoroughfare + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#concentration @@ -8615,20 +11012,24 @@ batteries is describing a business requirement. en - Thoroughfare + Concentration en - thoroughfare + concentration - STRING + REAL_MEASURE en - Street or thorough road name + Concentration of the material at the level of the product. This attribute is specially mentioned for substances of concern mentioned in the ESPR proposal from March 30th, 2022 Article 7: +(5) (c) the concentration, maximum concentration or concentration range of the substances of concern, at the level of the product [...]. +Other substances are mentioned for the purpose of recycling in the ESPR provisional agreement from January 9th, 2024 Annex I: +(d) design for recycling, ease and quality of recycling as expressed through: use of easily recyclable materials, safe, easy and non-destructive access to recyclable components and materials or components and materials containing hazardous substances and material composition and homogeneity, possibility for high-purity sorting, number of materials and components used, use of standard components, use of component and material coding standards for the identification of components and materials, number and complexity of processes and tools needed, ease of nondestructive disassembly and re-assembly, conditions for access to product data, conditions for access to or use of hardware and software needed. + @@ -8637,14 +11038,14 @@ batteries is describing a business requirement. - localityTechnicalKey + content en - Locality Technical Key + Content - urn:samm:io.catenax.shared.address_characteristic:1.0.1#localityTechnicalKey + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content @@ -8661,20 +11062,20 @@ batteries is describing a business requirement. en - Locality Technical Key + Content en - localityTechnicalKey + content STRING en - Technical key of a locality + The content of the document e.g a link. @@ -8683,14 +11084,14 @@ batteries is describing a business requirement. - localityValue + contentType en - Locality Value + Content Type - urn:samm:io.catenax.shared.address_characteristic:1.0.1#localityValue + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType @@ -8707,20 +11108,20 @@ batteries is describing a business requirement. en - Locality Value + Content Type en - localityValue + contentType STRING en - Value of a locality, e.g. name of a city ("Mannheim"). + The type of content which can be expected in the "content" property. Examples are a link, restricted link, pdf, excel, etc. @@ -8729,14 +11130,14 @@ batteries is describing a business requirement. - locality + header en - Locality + Header - urn:samm:io.catenax.shared.address_characteristic:1.0.1#locality + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header @@ -8753,20 +11154,20 @@ batteries is describing a business requirement. en - Locality + Header en - locality + header STRING en - Locality belonging to an address + The header as a short description of the document with a maximum of 100 characters. @@ -8775,14 +11176,14 @@ batteries is describing a business requirement. - premiseTechnicalKey + documentation en - Premise Technical Key + Documentation - urn:samm:io.catenax.shared.address_characteristic:1.0.1#premiseTechnicalKey + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#documentation @@ -8799,20 +11200,20 @@ batteries is describing a business requirement. en - Premise Technical Key + Documentation en - premiseTechnicalKey + documentation STRING en - Technical key of a premise + Documentation accompanying the material. @@ -8821,14 +11222,14 @@ batteries is describing a business requirement. - premiseValue + chemicalMaterial en - Premise Value + Material - urn:samm:io.catenax.shared.address_characteristic:1.0.1#premiseValue + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#chemicalMaterial @@ -8845,20 +11246,20 @@ batteries is describing a business requirement. en - Premise Value + Material en - premiseValue + chemicalMaterial STRING en - Value of a premise, e.g. name or designation of a particular site + Information on different materials in the product. @@ -8867,14 +11268,14 @@ batteries is describing a business requirement. - premise + materialComposition en - Premise + Material Composition - urn:samm:io.catenax.shared.address_characteristic:1.0.1#premise + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#materialComposition @@ -8891,20 +11292,20 @@ batteries is describing a business requirement. en - Premise + Material Composition en - premise + materialComposition STRING en - Premise of an address, e.g. a specific "BUILDING" but can also be used for naming a particular site + Material composition of the product with information on recycled and renewable materials. @@ -8913,14 +11314,14 @@ batteries is describing a business requirement. - postalDeliveryPointTechnicalKey + materials en - Postal Delivery Point Technical Key + Materials - urn:samm:io.catenax.shared.address_characteristic:1.0.1#postalDeliveryPointTechnicalKey + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#materials @@ -8937,20 +11338,20 @@ batteries is describing a business requirement. en - Postal Delivery Point Technical Key + Materials en - postalDeliveryPointTechnicalKey + materials STRING en - Technical key of a postal delivery point + Properties which are relevant for the materials of the product. @@ -8959,14 +11360,14 @@ batteries is describing a business requirement. - postalDeliveryPointValue + state en - Postal Delivery Point Value + State - urn:samm:io.catenax.shared.address_characteristic:1.0.1#postalDeliveryPointValue + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#state @@ -8983,36 +11384,101 @@ batteries is describing a business requirement. en - Postal Delivery Point Value + State en - postalDeliveryPointValue + state STRING en - Value of a postal delivery point, e.g. designation of a gate + The status of the product (original, repurposed, re-used, remanufactured or waste) to indicated, whether it is a used product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Annex I: +(j) incorporation of used components. + + + + original + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#StateEnumeration:original + + + + + + repurposed + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#StateEnumeration:repurposed + + + + + + re-used + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#StateEnumeration:re-used + + + + + + remanufactured + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#StateEnumeration:remanufactured + + + + + + waste + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#StateEnumeration:waste + + + + + + - postalDeliveryPoint + footprintValue en - Postal Delivery Point + Footprint Value - urn:samm:io.catenax.shared.address_characteristic:1.0.1#postalDeliveryPoint + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#footprintValue @@ -9029,76 +11495,40 @@ batteries is describing a business requirement. en - Postal Delivery Point + Footprint Value en - postalDeliveryPoint + footprintValue - STRING + REAL_MEASURE - - en - Delivery point, e.g. designation of a gate - - - - - - - - - countryShortName - - - en - Country Short Name - - - urn:samm:io.catenax.shared.address_characteristic:1.0.1#countryShortName - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Country Short Name - - - - + en - countryShortName - - - STRING + The value of the footprint of the product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Annex I: +(l) the environmental footprint of the product, expressed as a quantification, in accordance with the applicable delegated act, of a product's life cycle environmental impacts, whether in relation to one or more environmental impact categories or an aggregated set of impact categories; +(m) the carbon footprint of the product; +(ma) the material footprint of the product. + + + - country + content en - Country + Content - urn:samm:io.catenax.shared.address_characteristic:1.0.1#country + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content @@ -9115,20 +11545,20 @@ batteries is describing a business requirement. en - Country + Content en - country + content STRING en - Country of an address + The content of the document e.g a link. @@ -9137,14 +11567,14 @@ batteries is describing a business requirement. - postCodeValue + contentType en - Post Code Value + Content Type - urn:samm:io.catenax.shared.address_characteristic:1.0.1#postCodeValue + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType @@ -9161,20 +11591,20 @@ batteries is describing a business requirement. en - Post Code Value + Content Type en - postCodeValue + contentType STRING en - The value of a post code + The type of content which can be expected in the "content" property. Examples are a link, restricted link, pdf, excel, etc. @@ -9183,14 +11613,14 @@ batteries is describing a business requirement. - postCodeTechnicalKey + header en - Post Code Technical Key + Header - urn:samm:io.catenax.shared.address_characteristic:1.0.1#postCodeTechnicalKey + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header @@ -9207,20 +11637,20 @@ batteries is describing a business requirement. en - Post Code Technical Key + Header en - postCodeTechnicalKey + header STRING en - The technical key of a post code + The header as a short description of the document with a maximum of 100 characters. @@ -9229,14 +11659,14 @@ batteries is describing a business requirement. - postCode + footprintRulebook en - Post Code + Footprint Rulebook - urn:samm:io.catenax.shared.address_characteristic:1.0.1#postCode + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#footprintRulebook @@ -9253,30 +11683,36 @@ batteries is describing a business requirement. en - Post Code + Footprint Rulebook en - postCode + footprintRulebook STRING + + + en + The applied rulebook for the environmental footprint of the product. + + - address + footprintLifecycle en - address + Footprint Lifecycle - urn:samm:io.catenax.battery.battery_pass:2.0.0#address + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#footprintLifecycle @@ -9293,20 +11729,20 @@ batteries is describing a business requirement. en - address + Footprint Lifecycle en - address + footprintLifecycle STRING en - An postal address + The lifecycle stage, to which the environmental footprint corresponds. These could be for example "raw material acquisition and pre-processing", "main product production", "distribution" or "end of life and recycling". @@ -9315,14 +11751,14 @@ batteries is describing a business requirement. - manufacturing + footprintUnit en - manufacturing + Footprint Unit - urn:samm:io.catenax.battery.battery_pass:2.0.0#manufacturing + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#footprintUnit @@ -9339,20 +11775,20 @@ batteries is describing a business requirement. en - manufacturing + Footprint Unit en - manufacturing + footprintUnit STRING en - Information about the manufacturing process of a battery + The unit of measurement of the environmental impact category. For each impact category a specific unit is used. If an aggregation is used, utilize the normalization and weighting methods used in the referenced rulebook. @@ -9361,14 +11797,14 @@ batteries is describing a business requirement. - datePlacedOnMarket + footprintType en - date placed on market + Footprint Type - urn:samm:io.catenax.battery.battery_pass:2.0.0#datePlacedOnMarket + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#footprintType @@ -9385,36 +11821,273 @@ batteries is describing a business requirement. en - date placed on market + Footprint Type en - datePlacedOnMarket + footprintType STRING en - Date on which vehicle is produced i.e. when battery is put in the market or production date of the vehicle is describing a regulatory requirement. + The type of the environmental footprint of the product. This could be one of the environmental impact categories. This attribute is mentioned in the ESPR provisional agreement from January 9th 2024 Article 7: +(2)(b)(i) information on the performance of the product in relation to one or more of the product parameters referred to in Annex I, including a scoring of reparability or durability, carbon footprint or environmental footprint; +Annex I: +(l) the environmental footprint of the product, expressed as a quantification, in accordance with the applicable delegated act, of a product's life cycle environmental impacts, whether in relation to one or more environmental impact categories or an aggregated set of impact categories. +(m) the carbon footprint of the product; +(ma) the material footprint of the product. + + + + Climate Change Total + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#CategoryEnumeration:Climate Change Total + + + + + + Climate Change Fossil + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#CategoryEnumeration:Climate Change Fossil + + + + + + Climate Change Biogenic Removals and Emissions + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#CategoryEnumeration:Climate Change Biogenic Removals and Emissions + + + + + + Climate Change Land Use and Land Use Change + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#CategoryEnumeration:Climate Change Land Use and Land Use Change + + + + + + Ozone Depletion + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#CategoryEnumeration:Ozone Depletion + + + + + + Acidification + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#CategoryEnumeration:Acidification + + + + + + Eutrophication Aquatic Freshwater + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#CategoryEnumeration:Eutrophication Aquatic Freshwater + + + + + + Eutrophication Fresh Marine + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#CategoryEnumeration:Eutrophication Fresh Marine + + + + + + Eutrophication Terrestrial + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#CategoryEnumeration:Eutrophication Terrestrial + + + + + + Photochemical Ozone Formation + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#CategoryEnumeration:Photochemical Ozone Formation + + + + + + Abiotic Depletion- Minerals and Metals + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#CategoryEnumeration:Abiotic Depletion- Minerals and Metals + + + + + + Fossil Fuels + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#CategoryEnumeration:Fossil Fuels + + + + + + Water Use + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#CategoryEnumeration:Water Use + + + + + + Particulate Matter Emissions + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#CategoryEnumeration:Particulate Matter Emissions + + + + + + Ionizing Radiation, Human Health + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#CategoryEnumeration:Ionizing Radiation, Human Health + + + + + + Eco-Toxicity + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#CategoryEnumeration:Eco-Toxicity + + + + + + Human Toxicity, Cancer Effects + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#CategoryEnumeration:Human Toxicity, Cancer Effects + + + + + + Human Toxicity, Non-Cancer Effects + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#CategoryEnumeration:Human Toxicity, Non-Cancer Effects + + + + + + Land Use Related Impacts/Soil Quality + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#CategoryEnumeration:Land Use Related Impacts/Soil Quality + + + + + + - matierialPercentageMassFraction + performanceClass en - matierial percentage mass fraction + Performance Class - urn:samm:io.catenax.battery.battery_pass:2.0.0#matierialPercentageMassFraction + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#performanceClass @@ -9431,21 +12104,20 @@ batteries is describing a business requirement. en - matierial percentage mass fraction + Performance Class en - matierialPercentageMassFraction + performanceClass - percent - INTEGER_MEASURE + STRING en - Percentage mass fraction of a material. + The performance classification of the footprint. @@ -9454,14 +12126,14 @@ batteries is describing a business requirement. - matierialWeight + facility en - material weight + Facility - urn:samm:io.catenax.battery.battery_pass:2.0.0#matierialWeight + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#facility @@ -9478,21 +12150,22 @@ batteries is describing a business requirement. en - material weight + Facility en - matierialWeight + facility - gram - INTEGER_MEASURE + STRING en - Weight of the material (in gram) + The identifier used for a location. This attribute is mentioned in the ESPR provisional agreement from January 9th 2024 Annex III: +(i) unique facility identifiers; +Article 2 Definitions: (33) 'unique facility identifier' means a unique string of characters for the identification of locations or buildings involved in the value chain of a product or used by actors involved in the value chain of a product. @@ -9501,14 +12174,14 @@ batteries is describing a business requirement. - materialName + manufacturingPlant en - material name + Manufacturing Plant - urn:samm:io.catenax.battery.battery_pass:2.0.0#materialName + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#manufacturingPlant @@ -9525,20 +12198,20 @@ batteries is describing a business requirement. en - material name + Manufacturing Plant en - materialName + manufacturingPlant STRING en - Name of the material + The manufacturing plant of the footprint in the specific lifecycle phase. @@ -9547,14 +12220,14 @@ batteries is describing a business requirement. - cathodeActiveMaterials + content en - cathode active materials + Content - urn:samm:io.catenax.battery.battery_pass:2.0.0#cathodeActiveMaterials + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content @@ -9571,20 +12244,20 @@ batteries is describing a business requirement. en - cathode active materials + Content en - cathodeActiveMaterials + content STRING en - The total amount of valuable materials contained in CAM material: Nickel, Cobalt, Lithium. + The content of the document e.g a link. @@ -9593,14 +12266,14 @@ batteries is describing a business requirement. - matierialPercentageMassFraction + contentType en - matierial percentage mass fraction + Content Type - urn:samm:io.catenax.battery.battery_pass:2.0.0#matierialPercentageMassFraction + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType @@ -9617,20 +12290,20 @@ batteries is describing a business requirement. en - matierial percentage mass fraction + Content Type en - matierialPercentageMassFraction + contentType - INTEGER_MEASURE + STRING en - Percentage mass fraction of a material. + The type of content which can be expected in the "content" property. Examples are a link, restricted link, pdf, excel, etc. @@ -9639,14 +12312,14 @@ batteries is describing a business requirement. - matierialWeight + header en - material weight + Header - urn:samm:io.catenax.battery.battery_pass:2.0.0#matierialWeight + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header @@ -9663,20 +12336,20 @@ batteries is describing a business requirement. en - material weight + Header en - matierialWeight + header - INTEGER_MEASURE + STRING en - Weight of the material (in gram) + The header as a short description of the document with a maximum of 100 characters. @@ -9685,14 +12358,14 @@ batteries is describing a business requirement. - materialName + declaration en - material name + Declaration - urn:samm:io.catenax.battery.battery_pass:2.0.0#materialName + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#declaration @@ -9709,20 +12382,20 @@ batteries is describing a business requirement. en - material name + Declaration en - materialName + declaration STRING en - Name of the material + The footprint declaration in the format of a link @@ -9731,14 +12404,14 @@ batteries is describing a business requirement. - recyclateContentActiveMaterials + environmentalFootprint en - recyclate content active materials + Environmental Footprint - urn:samm:io.catenax.battery.battery_pass:2.0.0#recyclateContentActiveMaterials + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#environmentalFootprint @@ -9755,20 +12428,27 @@ batteries is describing a business requirement. en - recyclate content active materials + Environmental Footprint en - recyclateContentActiveMaterials + environmentalFootprint STRING en - List of recovered Recyclate Content in Active Material Recycled is describing a regulatory requirement. The following materials have to be reported on as a minimium: Cobalt, Lithium, Nickel, Lead + The environmental footprint of the product. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I: +The following parameters shall, as appropriate, and where necessary supplemented by others, be used, individually or combined, as a basis for improving the product aspects referred to in Article 5(1): +(l) the environmental footprint of the product, expressed as a quantification, in accordance with the applicable delegated act, of a product's life cycle environmental impacts, whether in relation to one or more environmental impact categories or an aggregated set of impact categories. +and Article 7: +(2)(b)(i) information on the performance of the product in relation to one or more of the product parameters referred to in Annex I, including a scoring of reparability or durability, carbon footprint or environmental footprint; +and defined by Article 2: +(23) 'environmental footprint' means a quantification of product environmental impacts throughout its life cycle, whether in relation to a single environmental impact category or an aggregated set of impact categories based on the Product Environmental Footprint method or other scientific methods developed by international organisations and widely tested in collaboration with different industry sectors and adopted or implemented by the Commission in other Union legislation; +(24) 'Product Environmental Footprint method' means the life cycle assessment method to quantify the environmental impacts of products established by Recommendation (EU) 2021/2279. @@ -9777,14 +12457,14 @@ batteries is describing a business requirement. - matierialPercentageMassFraction + footprintValue en - matierial percentage mass fraction + Footprint Value - urn:samm:io.catenax.battery.battery_pass:2.0.0#matierialPercentageMassFraction + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#footprintValue @@ -9801,20 +12481,24 @@ batteries is describing a business requirement. en - matierial percentage mass fraction + Footprint Value en - matierialPercentageMassFraction + footprintValue - INTEGER_MEASURE + REAL_MEASURE en - Percentage mass fraction of a material. + The value of the footprint of the product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Annex I: +(l) the environmental footprint of the product, expressed as a quantification, in accordance with the applicable delegated act, of a product's life cycle environmental impacts, whether in relation to one or more environmental impact categories or an aggregated set of impact categories; +(m) the carbon footprint of the product; +(ma) the material footprint of the product. + @@ -9823,14 +12507,14 @@ batteries is describing a business requirement. - matierialWeight + content en - material weight + Content - urn:samm:io.catenax.battery.battery_pass:2.0.0#matierialWeight + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content @@ -9847,20 +12531,20 @@ batteries is describing a business requirement. en - material weight + Content en - matierialWeight + content - INTEGER_MEASURE + STRING en - Weight of the material (in gram) + The content of the document e.g a link. @@ -9869,14 +12553,14 @@ batteries is describing a business requirement. - materialName + contentType en - material name + Content Type - urn:samm:io.catenax.battery.battery_pass:2.0.0#materialName + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType @@ -9893,20 +12577,20 @@ batteries is describing a business requirement. en - material name + Content Type en - materialName + contentType STRING en - Name of the material + The type of content which can be expected in the "content" property. Examples are a link, restricted link, pdf, excel, etc. @@ -9915,14 +12599,14 @@ batteries is describing a business requirement. - anodeActiveMaterials + header en - anode active materials + Header - urn:samm:io.catenax.battery.battery_pass:2.0.0#anodeActiveMaterials + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header @@ -9939,20 +12623,20 @@ batteries is describing a business requirement. en - anode active materials + Header en - anodeActiveMaterials + header STRING en - The total amount of valuable materials contained in Anode: graphite + The header as a short description of the document with a maximum of 100 characters. @@ -9961,14 +12645,14 @@ batteries is describing a business requirement. - matierialPercentageMassFraction + footprintRulebook en - matierial percentage mass fraction + Footprint Rulebook - urn:samm:io.catenax.battery.battery_pass:2.0.0#matierialPercentageMassFraction + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#footprintRulebook @@ -9985,20 +12669,20 @@ batteries is describing a business requirement. en - matierial percentage mass fraction + Footprint Rulebook en - matierialPercentageMassFraction + footprintRulebook - INTEGER_MEASURE + STRING en - Percentage mass fraction of a material. + The applied rulebook for the environmental footprint of the product. @@ -10007,14 +12691,14 @@ batteries is describing a business requirement. - matierialWeight + footprintLifecycle en - material weight + Footprint Lifecycle - urn:samm:io.catenax.battery.battery_pass:2.0.0#matierialWeight + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#footprintLifecycle @@ -10031,20 +12715,20 @@ batteries is describing a business requirement. en - material weight + Footprint Lifecycle en - matierialWeight + footprintLifecycle - INTEGER_MEASURE + STRING en - Weight of the material (in gram) + The lifecycle stage, to which the environmental footprint corresponds. These could be for example "raw material acquisition and pre-processing", "main product production", "distribution" or "end of life and recycling". @@ -10053,14 +12737,14 @@ batteries is describing a business requirement. - materialName + footprintUnit en - material name + Footprint Unit - urn:samm:io.catenax.battery.battery_pass:2.0.0#materialName + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#footprintUnit @@ -10077,20 +12761,20 @@ batteries is describing a business requirement. en - material name + Footprint Unit en - materialName + footprintUnit STRING en - Name of the material + The unit of measurement of the environmental impact category. For each impact category a specific unit is used. If an aggregation is used, utilize the normalization and weighting methods used in the referenced rulebook. @@ -10099,14 +12783,14 @@ batteries is describing a business requirement. - cathodeCompositionOther + footprintType en - cathode composition other + Footprint Type - urn:samm:io.catenax.battery.battery_pass:2.0.0#cathodeCompositionOther + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#footprintType @@ -10123,20 +12807,25 @@ batteries is describing a business requirement. en - cathode composition other + Footprint Type en - cathodeCompositionOther + footprintType STRING en - The composition or materials contained in the Cathode is describing a regulatory requirement. + The type of the environmental footprint of the product. This could be one of the environmental impact categories. This attribute is mentioned in the ESPR provisional agreement from January 9th 2024 Article 7: +(2)(b)(i) information on the performance of the product in relation to one or more of the product parameters referred to in Annex I, including a scoring of reparability or durability, carbon footprint or environmental footprint; +Annex I: +(l) the environmental footprint of the product, expressed as a quantification, in accordance with the applicable delegated act, of a product's life cycle environmental impacts, whether in relation to one or more environmental impact categories or an aggregated set of impact categories. +(m) the carbon footprint of the product; +(ma) the material footprint of the product. @@ -10145,14 +12834,14 @@ batteries is describing a business requirement. - matierialPercentageMassFraction + performanceClass en - matierial percentage mass fraction + Performance Class - urn:samm:io.catenax.battery.battery_pass:2.0.0#matierialPercentageMassFraction + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#performanceClass @@ -10169,20 +12858,20 @@ batteries is describing a business requirement. en - matierial percentage mass fraction + Performance Class en - matierialPercentageMassFraction + performanceClass - INTEGER_MEASURE + STRING en - Percentage mass fraction of a material. + The performance classification of the footprint. @@ -10191,14 +12880,14 @@ batteries is describing a business requirement. - matierialWeight + facility en - material weight + Facility - urn:samm:io.catenax.battery.battery_pass:2.0.0#matierialWeight + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#facility @@ -10215,20 +12904,22 @@ batteries is describing a business requirement. en - material weight + Facility en - matierialWeight + facility - INTEGER_MEASURE + STRING en - Weight of the material (in gram) + The identifier used for a location. This attribute is mentioned in the ESPR provisional agreement from January 9th 2024 Annex III: +(i) unique facility identifiers; +Article 2 Definitions: (33) 'unique facility identifier' means a unique string of characters for the identification of locations or buildings involved in the value chain of a product or used by actors involved in the value chain of a product. @@ -10237,14 +12928,14 @@ batteries is describing a business requirement. - materialName + manufacturingPlant en - material name + Manufacturing Plant - urn:samm:io.catenax.battery.battery_pass:2.0.0#materialName + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#manufacturingPlant @@ -10261,20 +12952,20 @@ batteries is describing a business requirement. en - material name + Manufacturing Plant en - materialName + manufacturingPlant STRING en - Name of the material + The manufacturing plant of the footprint in the specific lifecycle phase. @@ -10283,14 +12974,14 @@ batteries is describing a business requirement. - anodeCompositionOther + content en - anode composition other + Content - urn:samm:io.catenax.battery.battery_pass:2.0.0#anodeCompositionOther + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content @@ -10307,20 +12998,20 @@ batteries is describing a business requirement. en - anode composition other + Content en - anodeCompositionOther + content STRING en - The composition or materials contained in the anode is describing a regulatory requirement. + The content of the document e.g a link. @@ -10329,14 +13020,14 @@ batteries is describing a business requirement. - matierialPercentageMassFraction + contentType en - matierial percentage mass fraction + Content Type - urn:samm:io.catenax.battery.battery_pass:2.0.0#matierialPercentageMassFraction + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType @@ -10353,20 +13044,20 @@ batteries is describing a business requirement. en - matierial percentage mass fraction + Content Type en - matierialPercentageMassFraction + contentType - INTEGER_MEASURE + STRING en - Percentage mass fraction of a material. + The type of content which can be expected in the "content" property. Examples are a link, restricted link, pdf, excel, etc. @@ -10375,14 +13066,14 @@ batteries is describing a business requirement. - matierialWeight + header en - material weight + Header - urn:samm:io.catenax.battery.battery_pass:2.0.0#matierialWeight + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header @@ -10399,20 +13090,20 @@ batteries is describing a business requirement. en - material weight + Header en - matierialWeight + header - INTEGER_MEASURE + STRING en - Weight of the material (in gram) + The header as a short description of the document with a maximum of 100 characters. @@ -10421,14 +13112,14 @@ batteries is describing a business requirement. - materialName + declaration en - material name + Declaration - urn:samm:io.catenax.battery.battery_pass:2.0.0#materialName + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#declaration @@ -10445,20 +13136,20 @@ batteries is describing a business requirement. en - material name + Declaration en - materialName + declaration STRING en - Name of the material + The footprint declaration in the format of a link @@ -10467,14 +13158,14 @@ batteries is describing a business requirement. - electrolyteComposition + carbonFootprint en - electrolyte composition + Carbon Footprint - urn:samm:io.catenax.battery.battery_pass:2.0.0#electrolyteComposition + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#carbonFootprint @@ -10491,20 +13182,26 @@ batteries is describing a business requirement. en - electrolyte composition + Carbon Footprint en - electrolyteComposition + carbonFootprint STRING en - List of materials contained in the electrolyte is describing a regulatory requirement. + The carbon footprint of the product. This is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I: +The following parameters shall, as appropriate, and where necessary supplemented by others, be used, individually or combined, as a basis for improving the product aspects referred to in Article 5(1): +(m) the carbon footprint of the product; +and Article 7: +(2)(b)(i) information on the performance of the product in relation to one or more of the product parameters referred to in Annex I, including a scoring of reparability or durability, carbon footprint or environmental footprint; +and defined by Article 2: +(25) 'carbon footprint' means the sum of greenhouse gas (GHG) emissions and GHG removals in a product system, expressed as CO2 equivalents and based on a life cycle assessment using the single impact category of climate change. @@ -10513,14 +13210,14 @@ batteries is describing a business requirement. - cellChemistry + footprintValue en - cell chemistry + Footprint Value - urn:samm:io.catenax.battery.battery_pass:2.0.0#cellChemistry + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#footprintValue @@ -10537,20 +13234,24 @@ batteries is describing a business requirement. en - cell chemistry + Footprint Value en - cellChemistry + footprintValue - STRING + REAL_MEASURE en - Information about the cell chemistry of a battery cell + The value of the footprint of the product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Annex I: +(l) the environmental footprint of the product, expressed as a quantification, in accordance with the applicable delegated act, of a product's life cycle environmental impacts, whether in relation to one or more environmental impact categories or an aggregated set of impact categories; +(m) the carbon footprint of the product; +(ma) the material footprint of the product. + @@ -10559,14 +13260,14 @@ batteries is describing a business requirement. - thoroughfareTechnicalKey + content en - Thoroughfare Technical Key + Content - urn:samm:io.catenax.shared.address_characteristic:1.0.1#thoroughfareTechnicalKey + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content @@ -10583,20 +13284,20 @@ batteries is describing a business requirement. en - Thoroughfare Technical Key + Content en - thoroughfareTechnicalKey + content STRING en - Technical key of a thoroughfare. As specified by BPDM, this can be a "STREET" or a different type. + The content of the document e.g a link. @@ -10605,14 +13306,14 @@ batteries is describing a business requirement. - thoroughfareValue + contentType en - Value Thoroughfare + Content Type - urn:samm:io.catenax.shared.address_characteristic:1.0.1#thoroughfareValue + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType @@ -10629,20 +13330,20 @@ batteries is describing a business requirement. en - Value Thoroughfare + Content Type en - thoroughfareValue + contentType STRING en - Value of a thoroughfare, e.g. name of a street. + The type of content which can be expected in the "content" property. Examples are a link, restricted link, pdf, excel, etc. @@ -10651,14 +13352,14 @@ batteries is describing a business requirement. - thoroughfareNumber + header en - Thoroughfare Number + Header - urn:samm:io.catenax.shared.address_characteristic:1.0.1#thoroughfareNumber + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header @@ -10675,20 +13376,20 @@ batteries is describing a business requirement. en - Thoroughfare Number + Header en - thoroughfareNumber + header STRING en - Number of a thoroughfare. As used differently in international context, this number can contain both numerical and alphanumerical values + The header as a short description of the document with a maximum of 100 characters. @@ -10697,14 +13398,14 @@ batteries is describing a business requirement. - thoroughfare + footprintRulebook en - Thoroughfare + Footprint Rulebook - urn:samm:io.catenax.shared.address_characteristic:1.0.1#thoroughfare + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#footprintRulebook @@ -10721,20 +13422,20 @@ batteries is describing a business requirement. en - Thoroughfare + Footprint Rulebook en - thoroughfare + footprintRulebook STRING en - Street or thorough road name + The applied rulebook for the environmental footprint of the product. @@ -10743,14 +13444,14 @@ batteries is describing a business requirement. - localityTechnicalKey + footprintLifecycle en - Locality Technical Key + Footprint Lifecycle - urn:samm:io.catenax.shared.address_characteristic:1.0.1#localityTechnicalKey + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#footprintLifecycle @@ -10767,20 +13468,20 @@ batteries is describing a business requirement. en - Locality Technical Key + Footprint Lifecycle en - localityTechnicalKey + footprintLifecycle STRING en - Technical key of a locality + The lifecycle stage, to which the environmental footprint corresponds. These could be for example "raw material acquisition and pre-processing", "main product production", "distribution" or "end of life and recycling". @@ -10789,14 +13490,14 @@ batteries is describing a business requirement. - localityValue + footprintUnit en - Locality Value + Footprint Unit - urn:samm:io.catenax.shared.address_characteristic:1.0.1#localityValue + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#footprintUnit @@ -10813,20 +13514,20 @@ batteries is describing a business requirement. en - Locality Value + Footprint Unit en - localityValue + footprintUnit STRING en - Value of a locality, e.g. name of a city ("Mannheim"). + The unit of measurement of the environmental impact category. For each impact category a specific unit is used. If an aggregation is used, utilize the normalization and weighting methods used in the referenced rulebook. @@ -10835,14 +13536,14 @@ batteries is describing a business requirement. - locality + footprintType en - Locality + Footprint Type - urn:samm:io.catenax.shared.address_characteristic:1.0.1#locality + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#footprintType @@ -10859,20 +13560,25 @@ batteries is describing a business requirement. en - Locality + Footprint Type en - locality + footprintType STRING en - Locality belonging to an address + The type of the environmental footprint of the product. This could be one of the environmental impact categories. This attribute is mentioned in the ESPR provisional agreement from January 9th 2024 Article 7: +(2)(b)(i) information on the performance of the product in relation to one or more of the product parameters referred to in Annex I, including a scoring of reparability or durability, carbon footprint or environmental footprint; +Annex I: +(l) the environmental footprint of the product, expressed as a quantification, in accordance with the applicable delegated act, of a product's life cycle environmental impacts, whether in relation to one or more environmental impact categories or an aggregated set of impact categories. +(m) the carbon footprint of the product; +(ma) the material footprint of the product. @@ -10881,14 +13587,14 @@ batteries is describing a business requirement. - premiseTechnicalKey + performanceClass en - Premise Technical Key + Performance Class - urn:samm:io.catenax.shared.address_characteristic:1.0.1#premiseTechnicalKey + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#performanceClass @@ -10905,20 +13611,20 @@ batteries is describing a business requirement. en - Premise Technical Key + Performance Class en - premiseTechnicalKey + performanceClass STRING en - Technical key of a premise + The performance classification of the footprint. @@ -10927,14 +13633,14 @@ batteries is describing a business requirement. - premiseValue + facility en - Premise Value + Facility - urn:samm:io.catenax.shared.address_characteristic:1.0.1#premiseValue + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#facility @@ -10951,20 +13657,22 @@ batteries is describing a business requirement. en - Premise Value + Facility en - premiseValue + facility STRING en - Value of a premise, e.g. name or designation of a particular site + The identifier used for a location. This attribute is mentioned in the ESPR provisional agreement from January 9th 2024 Annex III: +(i) unique facility identifiers; +Article 2 Definitions: (33) 'unique facility identifier' means a unique string of characters for the identification of locations or buildings involved in the value chain of a product or used by actors involved in the value chain of a product. @@ -10973,14 +13681,14 @@ batteries is describing a business requirement. - premise + manufacturingPlant en - Premise + Manufacturing Plant - urn:samm:io.catenax.shared.address_characteristic:1.0.1#premise + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#manufacturingPlant @@ -10997,20 +13705,20 @@ batteries is describing a business requirement. en - Premise + Manufacturing Plant en - premise + manufacturingPlant STRING en - Premise of an address, e.g. a specific "BUILDING" but can also be used for naming a particular site + The manufacturing plant of the footprint in the specific lifecycle phase. @@ -11019,14 +13727,14 @@ batteries is describing a business requirement. - postalDeliveryPointTechnicalKey + content en - Postal Delivery Point Technical Key + Content - urn:samm:io.catenax.shared.address_characteristic:1.0.1#postalDeliveryPointTechnicalKey + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content @@ -11043,20 +13751,20 @@ batteries is describing a business requirement. en - Postal Delivery Point Technical Key + Content en - postalDeliveryPointTechnicalKey + content STRING en - Technical key of a postal delivery point + The content of the document e.g a link. @@ -11065,14 +13773,14 @@ batteries is describing a business requirement. - postalDeliveryPointValue + contentType en - Postal Delivery Point Value + Content Type - urn:samm:io.catenax.shared.address_characteristic:1.0.1#postalDeliveryPointValue + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType @@ -11089,20 +13797,20 @@ batteries is describing a business requirement. en - Postal Delivery Point Value + Content Type en - postalDeliveryPointValue + contentType STRING en - Value of a postal delivery point, e.g. designation of a gate + The type of content which can be expected in the "content" property. Examples are a link, restricted link, pdf, excel, etc. @@ -11111,14 +13819,14 @@ batteries is describing a business requirement. - postalDeliveryPoint + header en - Postal Delivery Point + Header - urn:samm:io.catenax.shared.address_characteristic:1.0.1#postalDeliveryPoint + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header @@ -11135,20 +13843,20 @@ batteries is describing a business requirement. en - Postal Delivery Point + Header en - postalDeliveryPoint + header STRING en - Delivery point, e.g. designation of a gate + The header as a short description of the document with a maximum of 100 characters. @@ -11157,14 +13865,14 @@ batteries is describing a business requirement. - countryShortName + declaration en - Country Short Name + Declaration - urn:samm:io.catenax.shared.address_characteristic:1.0.1#countryShortName + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#declaration @@ -11181,30 +13889,36 @@ batteries is describing a business requirement. en - Country Short Name + Declaration en - countryShortName + declaration STRING + + + en + The footprint declaration in the format of a link + + - country + materialFootprint en - Country + Material Footprint - urn:samm:io.catenax.shared.address_characteristic:1.0.1#country + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#materialFootprint @@ -11221,20 +13935,23 @@ batteries is describing a business requirement. en - Country + Material Footprint en - country + materialFootprint STRING en - Country of an address + The material footprint of the product. This is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I: +(ma) the material footprint of the product; +and defined by Article 2: +(25a) 'material footprint' refers to the total amount of raw materials extracted to meet final consumption demands. @@ -11243,14 +13960,14 @@ batteries is describing a business requirement. - postCodeValue + productFootprint en - Post Code Value + Product Footprint - urn:samm:io.catenax.shared.address_characteristic:1.0.1#postCodeValue + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#productFootprint @@ -11267,20 +13984,28 @@ batteries is describing a business requirement. en - Post Code Value + Product Footprint en - postCodeValue + productFootprint STRING en - The value of a post code + The carbon and environmental footprint or material footprint of the product. These attributes are mentioned in the ESPR provisional agreement from January 9th 2024 Annex I: +(l) the environmental footprint of the product, expressed as a quantification, in accordance with the applicable delegated act, of a product's life cycle environmental impacts, whether in relation to one or more environmental impact categories or an aggregated set of impact categories; +(m) the carbon footprint of the product; +(ma) the material footprint of the product; +All are defined by Article 2: +(23) 'environmental footprint' means a quantification of product environmental impacts throughout its life cycle, whether in relation to a single environmental impact category or an aggregated set of impact categories based on the Product Environmental Footprint method or other scientific methods developed by international organisations and widely tested in collaboration with different industry sectors and adopted or implemented by the Commission in other Union +legislation; +(25) 'carbon footprint' means the sum of greenhouse gas (GHG) emissions and GHG removals in a product system, expressed as CO2 equivalents and based on a life cycle assessment using the single impact category of climate change. +(25a) 'material footprint' refers to the total amount of raw materials extracted to meet final consumption demands; @@ -11289,14 +14014,14 @@ batteries is describing a business requirement. - postCodeTechnicalKey + reparabilityScore en - Post Code Technical Key + Reparability Score - urn:samm:io.catenax.shared.address_characteristic:1.0.1#postCodeTechnicalKey + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#reparabilityScore @@ -11313,20 +14038,22 @@ batteries is describing a business requirement. en - Post Code Technical Key + Reparability Score en - postCodeTechnicalKey + reparabilityScore STRING en - The technical key of a post code + The reparability score. This attribute is mentioned ESPR provisional agreement from January 9th, 2024 Article 7: +(b) as appropriate, also require products to be accompanied by: +(i) information on the performance of the product in relation to one or more of the product parameters referred to in Annex I, including a scoring of reparability or durability [...]. @@ -11335,14 +14062,14 @@ batteries is describing a business requirement. - postCode + durabilityScore en - Post Code + Durability Score - urn:samm:io.catenax.shared.address_characteristic:1.0.1#postCode + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#durabilityScore @@ -11359,30 +14086,38 @@ batteries is describing a business requirement. en - Post Code + Durability Score en - postCode + durabilityScore STRING + + + en + The durability score. This attribute is mentioned ESPR provisional agreement from January 9th, 2024 Article 7: +(b) as appropriate, also require products to be accompanied by: +(i) information on the performance of the product in relation to one or more of the product parameters referred to in Annex I, including a scoring of reparability or durability [...]. + + - address + sustainability en - address + Sustainability - urn:samm:io.catenax.battery.battery_pass:2.0.0#address + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#sustainability @@ -11399,20 +14134,20 @@ batteries is describing a business requirement. en - address + Sustainability en - address + sustainability STRING en - An postal address + Sustainability related attributes. @@ -11421,14 +14156,14 @@ batteries is describing a business requirement. - website + content en - website + Content - urn:samm:io.catenax.shared.contact_information:1.0.0#website + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content @@ -11445,20 +14180,20 @@ batteries is describing a business requirement. en - website + Content en - website + content STRING en - Website of the contact. + The content of the document e.g a link. @@ -11467,14 +14202,14 @@ batteries is describing a business requirement. - phoneNumber + category en - phone number + Category - urn:samm:io.catenax.shared.contact_information:1.0.0#phoneNumber + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#category @@ -11491,36 +14226,375 @@ batteries is describing a business requirement. en - phone number + Category en - phoneNumber + category STRING en - Phone number with country and area code + The category in which the document can be sorted. These are mentioned in the ESPR proposal from March 30th, 2022 ANNEX III: +(e) compliance documentation and information required under this Regulation or other Union law applicable to the product, such as the declaration of conformity, technical documentation or conformity certificates; +ANNEX IV states additional information regarding the content of the technical documentation +Further information on documents are mentioned in the proposal from March 30th, 2022 ANNEX III: +(f) user manuals, instructions, warnings or safety information, as required by other Union legislation applicable to the product. +Additionally requirements are mentioned in Article 21: +(7) Manufacturers shall ensure that that a product covered by a delegated act adopted pursuant to Article 4 is accompanied by instructions that enable consumers and other end-users to safely assemble, install, operate, store, maintain, repair and dispose of the product in a language that can be easily understood by consumers and other end-users, as determined by the Member State concerned. Such instructions shall be clear, understandable and legible and include at least the information specified in the delegated acts adopted pursuant to Article 4 and pursuant to Article 7(2)(b), point (ii). +Article 7 states additionally: +(2) (b) (ii) information for consumers and other end-users on how to install, use, maintain and repair the product in order to minimize its impact on the environment and to ensure optimum durability, as well as on how to return or dispose of the product at end-of-life; +(2) (b) (iii) information for treatment facilities on disassembly, recycling, or disposal at end-of-life; +(2) (b) (iv) other information that may influence the way the product is handled by parties other than the manufacturer in order to improve performance in relation to product parameters referred to in Annex I. +(5) (d) relevant instructions for the safe use of the product. + + + + Product Specifications + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#SourceCategoryEnumeration:Product Specifications + + + + + + Manufacturer Information + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#SourceCategoryEnumeration:Manufacturer Information + + + + + + User Manuals and Guides + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#SourceCategoryEnumeration:User Manuals and Guides + + + + + + Certifications and Compliance + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#SourceCategoryEnumeration:Certifications and Compliance + + + + + + Product Images and Videos + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#SourceCategoryEnumeration:Product Images and Videos + + + + + + Warranty Information + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#SourceCategoryEnumeration:Warranty Information + + + + + + Reviews and Ratings + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#SourceCategoryEnumeration:Reviews and Ratings + + + + + + Product Variations + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#SourceCategoryEnumeration:Product Variations + + + + + + Supply Chain Information + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#SourceCategoryEnumeration:Supply Chain Information + + + + + + Environmental Impact + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#SourceCategoryEnumeration:Environmental Impact + + + + + + Compatibility and Accessories + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#SourceCategoryEnumeration:Compatibility and Accessories + + + + + + FAQs and Support + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#SourceCategoryEnumeration:FAQs and Support + + + + + + Purchase and Retail Information + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#SourceCategoryEnumeration:Purchase and Retail Information + + + + + + Privacy and Data Handling + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#SourceCategoryEnumeration:Privacy and Data Handling + + + + + + Third-Party Integrations + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#SourceCategoryEnumeration:Third-Party Integrations + + + + + + Legal Information + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#SourceCategoryEnumeration:Legal Information + + + + + + Safety Information + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#SourceCategoryEnumeration:Safety Information + + + + + + Repair and Installation + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#SourceCategoryEnumeration:Repair and Installation + + + + + + Waste Generation and Prevention + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#SourceCategoryEnumeration:Waste Generation and Prevention + + + + + + Specific Voluntary Labels + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#SourceCategoryEnumeration:Specific Voluntary Labels + + + + + + Product Packaging + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#SourceCategoryEnumeration:Product Packaging + + + + + + Return and Disposal + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#SourceCategoryEnumeration:Return and Disposal + + + + + + End of Life + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#SourceCategoryEnumeration:End of Life + + + + + + Material and Substance Information + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#SourceCategoryEnumeration:Material and Substance Information + + + + + + Technical Documentation + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#SourceCategoryEnumeration:Technical Documentation + + + + + + Treatment facilities + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#SourceCategoryEnumeration:Treatment facilities + + + + + + Other + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#SourceCategoryEnumeration:Other + + + + + + - email + contentType en - email + Content Type - urn:samm:io.catenax.shared.contact_information:1.0.0#email + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType @@ -11537,20 +14611,20 @@ batteries is describing a business requirement. en - email + Content Type en - email + contentType STRING en - An email address + The type of content which can be expected in the "content" property. Examples are a link, restricted link, pdf, excel, etc. @@ -11559,14 +14633,14 @@ batteries is describing a business requirement. - faxNumber + header en - faxNumber + Header - urn:samm:io.catenax.shared.contact_information:1.0.0#faxNumber + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header @@ -11583,20 +14657,20 @@ batteries is describing a business requirement. en - faxNumber + Header en - faxNumber + header STRING en - Fax number with country and area code + The header as a short description of the document with a maximum of 100 characters. @@ -11605,14 +14679,14 @@ batteries is describing a business requirement. - contact + sources en - contact + Sources - urn:samm:io.catenax.battery.battery_pass:2.0.0#contact + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#sources @@ -11629,20 +14703,36 @@ batteries is describing a business requirement. en - contact + Sources en - contact + sources STRING en - Contact details of the manufacturer + Documents that are mandatory if applicable for the product. These are mentioned in the ESPR provisional agreement from January 9th, 2024 ANNEX III: +(e) compliance documentation and information required under this Regulation or other Union law applicable to the product, such as the declaration of conformity, technical documentation or conformity certificates; +(f) user manuals, instructions, warnings or safety information, as required by other Union legislation applicable to the product. +Additionally requirements are mentioned in Article 21: +7. Manufacturers shall ensure that a product covered by a delegated act adopted pursuant to Article 4 is accompanied by instructions in digital format that enable customers and other relevant actors to assemble, install, operate, store, maintain, repair and dispose of the product in a language that can be easily understood, as determined by the Member State concerned. Such instructions shall be clear, understandable and legible and include at least the information set out in Article 7(2), point (b), point (ii) specified in the delegated acts adopted pursuant to Article 4. +Article 7 states additionally: +(ii) information for customers and other actors on how to install, use, maintain and repair the product, in order to minimise its impact on the environment and to ensure optimum durability, on how to install third-party operating systems where relevant, as well as on collection for refurbishment or remanufacture, and on how to return or handle the product at the end of its life; +(2) (b) (iii) information for treatment facilities on disassembly, reuse, refurbishment, recycling, or disposal at end-of-life; +(2) (b) (iv) other information that may influence sustainable product choices for customers and the way the product is handled by parties other than the manufacturer in order to facilitate appropriate use, value retaining operations and correct treatment at end-of-life. +(5) (d) relevant instructions for the safe use of the product. +(5) (e) information relevant for disassembly, preparation for reuse, reuse, recycling and the environmentally sound management of the product at the end of its life. +Annex I: +(b) [...] availability of repair and maintenance instructions, number of materials and components used, use of standard components,[...] number and complexity of processes and whether specialised toolsare needed, ease of non-destructive disassembly and re-assembly, conditions for access to product data, conditions for access to or use of hardware and software needed; +(c) ease of upgrading, re-use, remanufacturing and refurbishment as expressed through: [...] number and complexity of processes and tools needed, ease of non-destructive disassembly and re-assembly, conditions for access to product data, conditions for access to or use of hardware and software needed, conditions of access to test protocols or not commonly available testing equipment, availability of guarantees specific to remanufactured or refurbished products, conditions for access to or use of technologies protected by intellectual property rights, modularity; +(d) design for recycling, ease and quality of recycling as expressed through: use of easily recyclable materials, safe, easy and non-destructive access to recyclable components and materials or components and materials containing hazardous substances and material composition and homogeneity, possibility for high-purity sorting, [...] number and complexity of processes and tools needed, ease of nondestructive disassembly and re-assembly, conditions for access to product data, conditions for access to or use of hardware and software needed; +(q) functional performance and conditions for use including as expressed through ability in performing its intended use, precautions of use, skills required, compatibility with other products or systems. +Additionally to consider are guidelines and instructions regarding the proper management and disposal of packaging materials after use. This can include instructions for separation, reuse, and recycling. @@ -11651,14 +14741,14 @@ batteries is describing a business requirement. - componentsSupplier + label en - components supplier + Label - urn:samm:io.catenax.battery.battery_pass:2.0.0#componentsSupplier + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#label @@ -11675,21 +14765,20 @@ batteries is describing a business requirement. en - components supplier + Label en - componentsSupplier + label STRING en - Contact details of the suppliers of replacement parts / spare parts is describing a regulatory requirement. Available fields should be like: -Name - Street - Number - ZIP Code - City - State - Country - Phone - Fax - Email - Website + The human readable name of the attribute. @@ -11698,14 +14787,14 @@ Name - Street - Number - ZIP Code - City - State - Country - Phone - Fax - Email - componentsPartNumber + description en - components part number + Description - urn:samm:io.catenax.battery.battery_pass:2.0.0#componentsPartNumber + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#description @@ -11722,20 +14811,20 @@ Name - Street - Number - ZIP Code - City - State - Country - Phone - Fax - Email en - components part number + Description en - componentsPartNumber + description STRING en - The unique serial numbers of the different parts of a battery is describing a regulatory requirement. + The description of the attribute context. @@ -11744,14 +14833,14 @@ Name - Street - Number - ZIP Code - City - State - Country - Phone - Fax - Email - components + typeUnit en - components + Type Unit - urn:samm:io.catenax.battery.battery_pass:2.0.0#components + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#typeUnit @@ -11768,112 +14857,20 @@ Name - Street - Number - ZIP Code - City - State - Country - Phone - Fax - Email en - components + Type Unit en - components + typeUnit STRING en - Properties of the batterie's comoponents. - - - - - - - - - matierialPercentageMassFraction - - - en - matierial percentage mass fraction - - - urn:samm:io.catenax.battery.battery_pass:2.0.0#matierialPercentageMassFraction - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - matierial percentage mass fraction - - - - - en - matierialPercentageMassFraction - - - INTEGER_MEASURE - - - en - Percentage mass fraction of a material. - - - - - - - - - matierialWeight - - - en - material weight - - - urn:samm:io.catenax.battery.battery_pass:2.0.0#matierialWeight - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - material weight - - - - - en - matierialWeight - - - INTEGER_MEASURE - - - en - Weight of the material (in gram) + Choose a unit type from the unit catalog, or if the property "children" is filled, leave empty. @@ -11882,14 +14879,14 @@ Name - Street - Number - ZIP Code - City - State - Country - Phone - Fax - Email - materialName + dataType en - material name + Data Type - urn:samm:io.catenax.battery.battery_pass:2.0.0#materialName + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#dataType @@ -11906,36 +14903,136 @@ Name - Street - Number - ZIP Code - City - State - Country - Phone - Fax - Email en - material name + Data Type en - materialName + dataType STRING en - Name of the material + Data type that describe the content of the attributes children and data. In case "object" is selected in the enumeration, the children field will be used in the AdditionalDataEntity instead of the "data" property. If it is an other type, the content will be specified in "data" as a string. + + + + array + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#DataTypeEnumeration:array + + + + + + object + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#DataTypeEnumeration:object + + + + + + xsd:string + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#DataTypeEnumeration:xsd:string + + + + + + xsd:integer + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#DataTypeEnumeration:xsd:integer + + + + + + xsd:boolean + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#DataTypeEnumeration:xsd:boolean + + + + + + xsd:double + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#DataTypeEnumeration:xsd:double + + + + + + xsd:float + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#DataTypeEnumeration:xsd:float + + + + + + xsd:byte + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#DataTypeEnumeration:xsd:byte + + + + + + - compositionOfBattery + type en - composition of battery + Type - urn:samm:io.catenax.battery.battery_pass:2.0.0#compositionOfBattery + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#type @@ -11952,20 +15049,20 @@ Name - Street - Number - ZIP Code - City - State - Country - Phone - Fax - Email en - composition of battery + Type en - compositionOfBattery + type STRING en - Full composition of battery is describing a business requirement. + The complex description of the type. @@ -11974,14 +15071,14 @@ Name - Street - Number - ZIP Code - City - State - Country - Phone - Fax - Email - criticalRawMaterials + data en - critical raw materials + Data - urn:samm:io.catenax.battery.battery_pass:2.0.0#criticalRawMaterials + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#data @@ -11998,20 +15095,20 @@ Name - Street - Number - ZIP Code - City - State - Country - Phone - Fax - Email en - critical raw materials + Data en - criticalRawMaterials + data STRING en - List of critical raw materials (CRM) as specified by EU in a battery is describing a regulatory requirement. + The content from the attribute which is a depended of the data type and typeUnit. @@ -12020,14 +15117,14 @@ Name - Street - Number - ZIP Code - City - State - Country - Phone - Fax - Email - composition + label en - composition + Label - urn:samm:io.catenax.battery.battery_pass:2.0.0#composition + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#label @@ -12044,114 +15141,20 @@ Name - Street - Number - ZIP Code - City - State - Country - Phone - Fax - Email en - composition + Label en - composition + label STRING en - Information about the composition of a battery and the combination of materials is describing a business requirement. - - - - - - - - - cO2FootprintTotal - - - en - CO2 footprint total - - - urn:samm:io.catenax.battery.battery_pass:2.0.0#cO2FootprintTotal - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - CO2 footprint total - - - - - en - cO2FootprintTotal - - - kilogram - REAL_MEASURE - - - en - The total carbon footprint of the battery, calculated as kg of carbon dioxide equivalent is describing a regulatory requirement. - - - - - - - - - temperatureRangeIdleStateLowerLimit - - - en - temperature range idle state lower limit - - - urn:samm:io.catenax.battery.battery_pass:2.0.0#temperatureRangeIdleStateLowerLimit - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - temperature range idle state lower limit - - - - - en - temperatureRangeIdleStateLowerLimit - - - degreeCelsius - INTEGER_MEASURE - - - en - The lower range of temperature the battery can withstand when not in use is describing a regulatory requirement. + The human readable name of the attribute. @@ -12160,14 +15163,14 @@ Name - Street - Number - ZIP Code - City - State - Country - Phone - Fax - Email - temperatureRangeIdleStateUpperLimit + description en - temperature rangeIdle state upper limit + Description - urn:samm:io.catenax.battery.battery_pass:2.0.0#temperatureRangeIdleStateUpperLimit + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#description @@ -12184,21 +15187,20 @@ Name - Street - Number - ZIP Code - City - State - Country - Phone - Fax - Email en - temperature rangeIdle state upper limit + Description en - temperatureRangeIdleStateUpperLimit + description - degreeCelsius - INTEGER_MEASURE + STRING en - The upper range of temperature the battery can withstand when not in use is describing a regulatory requirement. + The description of the attribute context. @@ -12207,14 +15209,14 @@ Name - Street - Number - ZIP Code - City - State - Country - Phone - Fax - Email - temperatureRangeIdleState + typeUnit en - temperature range idle state + Type Unit - urn:samm:io.catenax.battery.battery_pass:2.0.0#temperatureRangeIdleState + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#typeUnit @@ -12231,20 +15233,20 @@ Name - Street - Number - ZIP Code - City - State - Country - Phone - Fax - Email en - temperature range idle state + Type Unit en - temperatureRangeIdleState + typeUnit STRING en - The range of temperature the battery can withstand when not in use is describing a regulatory requirement. + Choose a unit type from the unit catalog, or if the property "children" is filled, leave empty. @@ -12253,14 +15255,14 @@ Name - Street - Number - ZIP Code - City - State - Country - Phone - Fax - Email - warrantyPeriod + dataType en - warranty period + Data Type - urn:samm:io.catenax.battery.battery_pass:2.0.0#warrantyPeriod + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#dataType @@ -12277,21 +15279,20 @@ Name - Street - Number - ZIP Code - City - State - Country - Phone - Fax - Email en - warranty period + Data Type en - warrantyPeriod + dataType - month - INTEGER_COUNT + STRING en - Commercial warranty period of the battery is describing a regulatory requirement. + Data type that describe the content of the attributes children and data. In case "object" is selected in the enumeration, the children field will be used in the AdditionalDataEntity instead of the "data" property. If it is an other type, the content will be specified in "data" as a string. @@ -12300,14 +15301,14 @@ Name - Street - Number - ZIP Code - City - State - Country - Phone - Fax - Email - cycleLifeTestCRate + type en - cycle life test c-rate + Type - urn:samm:io.catenax.battery.battery_pass:2.0.0#cycleLifeTestCRate + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#type @@ -12324,20 +15325,20 @@ Name - Street - Number - ZIP Code - City - State - Country - Phone - Fax - Email en - cycle life test c-rate + Type en - cycleLifeTestCRate + type - INTEGER_MEASURE + STRING en - C-rate of Relevant Cycle-life Test is describing a regulatory requirement. + The complex description of the type. @@ -12346,14 +15347,14 @@ Name - Street - Number - ZIP Code - City - State - Country - Phone - Fax - Email - cycleLifeTestDepthOfDischarge + data en - cycle-life test depth of discharge + Data - urn:samm:io.catenax.battery.battery_pass:2.0.0#cycleLifeTestDepthOfDischarge + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#data @@ -12370,21 +15371,20 @@ Name - Street - Number - ZIP Code - City - State - Country - Phone - Fax - Email en - cycle-life test depth of discharge + Data en - cycleLifeTestDepthOfDischarge + data - percent - INTEGER_MEASURE + STRING en - Depth of discharge in the cycle-life test is describing a regulatory requirement. + The content from the attribute which is a depended of the data type and typeUnit. @@ -12393,14 +15393,14 @@ Name - Street - Number - ZIP Code - City - State - Country - Phone - Fax - Email - expectedLifetime + children en - expected lifetime + children - urn:samm:io.catenax.battery.battery_pass:2.0.0#expectedLifetime + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#children @@ -12417,21 +15417,20 @@ Name - Street - Number - ZIP Code - City - State - Country - Phone - Fax - Email en - expected lifetime + children en - expectedLifetime + children - piece - INTEGER_MEASURE + STRING en - Expected battery lifetime expressed in cycles, and reference test used is describing a regulatory requirement. + Children of the hierarchy. @@ -12440,14 +15439,14 @@ Name - Street - Number - ZIP Code - City - State - Country - Phone - Fax - Email - batteryCycleLife + additionalData en - battery cycle life + Additional Data - urn:samm:io.catenax.battery.battery_pass:2.0.0#batteryCycleLife + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#additionalData @@ -12464,20 +15463,22 @@ Name - Street - Number - ZIP Code - City - State - Country - Phone - Fax - Email en - battery cycle life + Additional Data en - batteryCycleLife + additionalData STRING en - Property describing the cycle life of a battery + Data in form of open fields which need to be transferred in addition. The regulation is still under development and may change in the future. To accommodate this, additional data allows the option to include additional data required by future changes to the regulation. In addition, the DPP can be easily updated and adapted to the new requirements. +The ESPR provisional agreement from January 9th, 2024 Article 9 mentions: +2. Where other Union legislation requires or allows the inclusion of specific information in the product passport, that information may be included in the product passport pursuant to the applicable delegated act adopted pursuant to Article 4. diff --git a/io.catenax.generic.digital_product_passport/5.0.0/gen/DigitalProductPassport-schema.json b/io.catenax.generic.digital_product_passport/5.0.0/gen/DigitalProductPassport-schema.json new file mode 100644 index 000000000..b396f754a --- /dev/null +++ b/io.catenax.generic.digital_product_passport/5.0.0/gen/DigitalProductPassport-schema.json @@ -0,0 +1,1144 @@ +{ + "$schema" : "http://json-schema.org/draft-04/schema", + "description" : "The Digital Product Passport (DPP) allows to share process and product-related information amongst supply chain businesses, authorities and consumers. The DPP allows for efficient information flows following best practices; and the possibility of accompanying the measures under this Regulation with mitigating measures so that impacts are expected to remain proportionate for SMEs.This is expected to increase transparency, both for supply chain businesses and for the general public, and increase efficiencies in terms of information transfer to support the data exchange between economic actors in integrating circularity in product design and manufacturing.\nIn particular, it is likely to help facilitate and streamline the monitoring and enforcement of the regulation carried out by EU and Member State authorities. It is also likely to provide a market-intelligence tool that may be used for revising and refining obligations in the future.\nThe DPP includes data about components, materials and chemical substances, information on reparability, spare parts, environmental impact and professional disposal for a product.\nThe data model will be updated, as newer versions of the regulation will be published.\nThe main basis is provided by the document \"Proposal for a REGULATION OF THE EUROPEAN PARLIAMENT AND OF THE COUNCIL establishing a framework for setting ecodesign requirements for sustainable products and repealing Directive 2009/125/EC\" from March 30th, 2022. The latest version of the document was the provisional agreement between the EU Council and the Parliament from January 9th, 2024. The text is informal, but the content of the final regulation was agreed between these two institutions.\nThe Title of Ecodesign Regulation has been changed to: Proposal for a REGULATION OF THE EUROPEAN PARLIAMENT AND OF THE COUNCIL establishing a framework for setting ecodesign requirements for sustainable products, amending Regulation (EU) 2023/1542 and repealing Directive 2009/125/EC.", + "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.generic.digital_product_passport_5.0.0_StatusEnumeration" : { + "type" : "string", + "description" : "The current status of the product passport declared through either: draft, approved, invalid or expired.", + "enum" : [ "draft", "approved", "invalid", "expired" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DateTrait" : { + "type" : "string", + "description" : "Constraint fo a timestamp in the format (yyyy-mm-dd).", + "pattern" : "^\\d{4}-\\d{2}-\\d{2}$" + }, + "urn_samm_io.catenax.shared.business_partner_number_2.0.0_BpnlTrait" : { + "type" : "string", + "description" : "The provided regular expression ensures that the BPNL is composed of prefix 'BPNL', 10 digits and two alphanumeric letters.", + "pattern" : "^BPNL[a-zA-Z0-9]{12}$" + }, + "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_io.catenax.generic.digital_product_passport_5.0.0_IdentifierCharacteristic" : { + "type" : "string", + "description" : "Characteristic for Identifiers." + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_MetadataCharacteristic" : { + "description" : "Characteristic for the passport metadata of the digital product passport.", + "type" : "object", + "properties" : { + "version" : { + "description" : "The current version of the product passport. The possibility of modification/ updating the product passport needs to include versioning of the dataset. This attribute is an internal versioning from the passport issuer. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Article 8:\n(1) [...] The information in the product passport shall be accurate, complete, and up to date.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "status" : { + "description" : "The current status of the product passport declared through either: draft, approved, invalid or expired.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_StatusEnumeration" + }, + "expirationDate" : { + "description" : "The timestamp in the format (yyyy-mm-dd) for the product passport until when it is available or a comment describing this period. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Article 8:\n(2) (h) the period during which the product passport is to remain available, which shall correspond to at least the expected lifetime of a specific product.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DateTrait" + }, + "issueDate" : { + "description" : "The timestamp in the format (yyyy-mm-dd) since when the product passport is available.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DateTrait" + }, + "economicOperatorId" : { + "description" : "The identification of the owner/economic operator of the passport. Proposed, according to ISO 15459, is the CIN (company identification code). Other identification numbers like the tax identification number, value added tax identification number, commercial register number and the like are also valid entries. In the Catena-X network, the BPNL is used for the identification of companies and the information stored like contact information and addresses. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Annex III:\n(k) the [...] unique operator identifier code of the economic operator established in the Union responsible for carrying out the tasks set out in Article 4 of Regulation (EU) 2019/1020, or Article 15 of Regulation (EU) on general product safety, or similar tasks pursuant to other EU legislation applicable to the product.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.business_partner_number_2.0.0_BpnlTrait" + }, + "passportIdentifier" : { + "description" : "The identifier of the product passport, which is an uuidv4.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.uuid_2.0.0_UuidV4Trait" + }, + "predecessor" : { + "description" : "Identification of the preceding product passport. If there is no preceding passport, input a dummy value. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Article 8:\n(2)(g) [...] Any new product passport shall be linked to the product passport or passports of the original product whenever appropriate.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.uuid_2.0.0_UuidV4Trait" + }, + "backupReference" : { + "description" : "A reference to the data backup of the passport. This mandatory attribute will be further defined in the future. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex III:\n(kb) the reference of the certified independent third-party product passport service provider hosting the back-up copy of the product passport.\nArticle 10 also mentions:\n(c) the data included in the product passport shall be stored by the economic operator responsible for its creation or by certified independent third-party product passport service providers authorised to act on their behalf.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "registrationIdentifier" : { + "description" : "Identifier in the respective registry. This will be further defined in the future. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 in Article 12:\nBy [2 years from entering into force of this Regulation], the Commission shall set up and manage a digital registry (\"the registry\") storing in a secure manner at least the unique product identifier, the unique operator identifier, the unique facility identifiers. In case of products intended to be placed under the customs procedure 'release for free circulation', the registry shall also store the product commodity code. The registry shall also store the batteries' unique identifiers referred to in Article 77(3) of Regulation (EU) 2023/1542.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_IdentifierCharacteristic" + }, + "lastModification" : { + "description" : "Date of the latest modification.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DateTrait" + } + }, + "required" : [ "version", "expirationDate", "issueDate", "economicOperatorId", "passportIdentifier", "predecessor", "backupReference" ] + }, + "urn_samm_io.catenax.serial_part_3.0.0_KeyTrait" : { + "type" : "string", + "description" : "Constraint that ensures that the standard keys and custom key prefixes can be used.", + "pattern" : "^(manufacturerId|partInstanceId|batchId|van|customKey:\\w+)$" + }, + "urn_samm_io.catenax.serial_part_3.0.0_ValueCharacteristic" : { + "type" : "string", + "description" : "The value of an identifier." + }, + "urn_samm_io.catenax.serial_part_3.0.0_KeyValueList" : { + "description" : "A list of key value pairs for local identifiers, which are composed of a key and a corresponding value.", + "type" : "object", + "properties" : { + "key" : { + "description" : "The key of a local identifier. ", + "$ref" : "#/components/schemas/urn_samm_io.catenax.serial_part_3.0.0_KeyTrait" + }, + "value" : { + "description" : "The value of an identifier.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.serial_part_3.0.0_ValueCharacteristic" + } + }, + "required" : [ "key", "value" ] + }, + "urn_samm_io.catenax.serial_part_3.0.0_LocalIdentifierCharacteristic" : { + "description" : "A single serialized part may have multiple attributes, that uniquely identify a that part in a specific dataspace (e.g. the manufacturer`s dataspace)", + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/urn_samm_io.catenax.serial_part_3.0.0_KeyValueList" + }, + "uniqueItems" : true + }, + "urn_samm_io.catenax.batch_3.0.0_KeyTrait" : { + "type" : "string", + "description" : "Constraint that ensures that the predefined keys are used.", + "pattern" : "^(manufacturerId|batchId|customKey:\\w+)$" + }, + "urn_samm_io.catenax.batch_3.0.0_ValueCharacteristic" : { + "type" : "string", + "description" : "The value of an identifier." + }, + "urn_samm_io.catenax.batch_3.0.0_KeyValueList" : { + "description" : "A list of key value pairs for local identifiers, which are composed of a key and a corresponding value.", + "type" : "object", + "properties" : { + "key" : { + "description" : "The key of a local identifier.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.batch_3.0.0_KeyTrait" + }, + "value" : { + "description" : "The value of an identifier.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.batch_3.0.0_ValueCharacteristic" + } + }, + "required" : [ "key", "value" ] + }, + "urn_samm_io.catenax.batch_3.0.0_LocalIdentifierCharacteristic" : { + "description" : "A batch may have multiple attributes, which uniquely identify that batch in a specific dataspace(e.g. the manufacturer`s dataspace)", + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/urn_samm_io.catenax.batch_3.0.0_KeyValueList" + }, + "uniqueItems" : true + }, + "urn_samm_io.catenax.part_type_information_1.0.0_PartIdCharacteristic" : { + "type" : "string", + "description" : "The part ID is a multi-character string, usually assigned by an ERP system." + }, + "urn_samm_io.catenax.part_type_information_1.0.0_PartNameCharacteristic" : { + "type" : "string", + "description" : "Part name in string format from the respective system in the value chain." + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PartTypeCharacteristic" : { + "description" : "Characteristic for the part type.", + "type" : "object", + "properties" : { + "manufacturerPartId" : { + "description" : "Part ID as assigned by the manufacturer of the part. The part ID identifies the part in the manufacturer`s dataspace. The part ID references a specific version of a part. The version number must be included in the part ID if it is available. The part ID does not reference a specific instance of a part and must not be confused with the serial number.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.part_type_information_1.0.0_PartIdCharacteristic" + }, + "nameAtManufacturer" : { + "description" : "Name of the part as assigned by the manufacturer.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.part_type_information_1.0.0_PartNameCharacteristic" + } + }, + "required" : [ "manufacturerPartId", "nameAtManufacturer" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_CodeEntity" : { + "description" : "Code entity with code key and value.", + "type" : "object", + "properties" : { + "key" : { + "description" : "The code key for the identification of the product. Examples are GTIN, hash, DID, ISBN, TARIC. This attribute is mentioned in the ESPR proposal from March 30th, 2022 ANNEX III:\n(b) the unique product identifier at the level indicated in the applicable delegated act adopted pursuant to Article 4;\n(c) the Global Trade Identification Number as provided for in standard ISO/IEC 15459-6 or equivalent of products or their parts;\n(d) relevant commodity codes, such as a TARIC code as defined in Council Regulation (EEC) No 2658/87.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_IdentifierCharacteristic" + }, + "value" : { + "description" : "The code value for the identification of the product in regard to the chosen code name.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_IdentifierCharacteristic" + } + }, + "required" : [ "key", "value" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_CodeList" : { + "description" : "A list of additional codes.", + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_CodeEntity" + } + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DataCarrierCharacteristic" : { + "description" : "Data Carrier Characteristic for the product.", + "type" : "object", + "properties" : { + "carrierType" : { + "description" : "The type of data carrier such as a QR code on the product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 8:\n(2) (b) the types of data carrier to be used.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "carrierLayout" : { + "description" : "The positioning of data carrier on the product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 8:\n(2) (c) the layout in which the data carrier shall be presented and its positioning.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + } + }, + "required" : [ "carrierType", "carrierLayout" ] + }, + "urn_samm_io.catenax.shared.part_classification_1.0.0_ClassificationStandardCharacteristic" : { + "type" : "string", + "description" : "Identified classification standards that align to the Catena-X needs." + }, + "urn_samm_io.catenax.shared.part_classification_1.0.0_ClassificationIDCharacteristic" : { + "type" : "string", + "description" : "It can be numeric or a string, depending on the chosen classification standard." + }, + "urn_samm_io.catenax.shared.part_classification_1.0.0_ClassificationEntity" : { + "description" : "Encapsulates data related to the classification of the part.", + "type" : "object", + "properties" : { + "classificationStandard" : { + "description" : "Identified classification standards that align to the Catena-X needs.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.part_classification_1.0.0_ClassificationStandardCharacteristic" + }, + "classificationID" : { + "description" : "The classification ID of the part type according to the corresponding standard definition mentioned in the key value pair.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.part_classification_1.0.0_ClassificationIDCharacteristic" + }, + "classificationDescription" : { + "description" : "Optional property describing the classification standard.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + } + }, + "required" : [ "classificationStandard", "classificationID" ] + }, + "urn_samm_io.catenax.shared.part_classification_1.0.0_ClassificationCharacteristic" : { + "description" : "Classification characteristic enabling a set of further properties.", + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.part_classification_1.0.0_ClassificationEntity" + }, + "uniqueItems" : true + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_IdentificationCharacteristic" : { + "description" : "Identification information of the product.", + "type" : "object", + "properties" : { + "serial" : { + "description" : "Identifier for a serial part if available. This is mentioned in the ESPR provisional agreement from January 9th, 2024 Recital (27):\n[...] an 'item' usually means a single unit of a model.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.serial_part_3.0.0_LocalIdentifierCharacteristic" + }, + "batch" : { + "description" : "Identifier for a batch part if available. Identifier for a serial part if available. This is mentioned in the ESPR provisional agreement from January 9th, 2024 Recital (27):\n[...] a 'batch' usually means a subset of a specific model composed of all products produced in a specific manufacturing plant at a specific moment in time [...].", + "$ref" : "#/components/schemas/urn_samm_io.catenax.batch_3.0.0_LocalIdentifierCharacteristic" + }, + "type" : { + "description" : "Identifier on the level of a part model or type. Identifier for a serial part if available. This is mentioned in the ESPR provisional agreement from January 9th, 2024 Recital (27):\n[...] A 'model' usually means a version of a product of which all units share the same technical characteristics relevant for the ecodesign requirements and the same model identifier [...].", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PartTypeCharacteristic" + }, + "codes" : { + "description" : "Codes for identification.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_CodeList" + }, + "dataCarrier" : { + "description" : "The type and layout of the data carrier on the product. These are mentioned in the ESPR proposal from March 30th, 2022 Article 8:\n(b) the types of data carrier to be used;\n(c) the layout in which the data carrier shall be presented and its positioning;\nArticle 2 defines:\n(30) 'data carrier' means a linear bar code symbol, a two-dimensional symbol or other automatic identification data capture medium that can be read by a device.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DataCarrierCharacteristic" + }, + "classification" : { + "description" : "Property describing the classification of a part.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.part_classification_1.0.0_ClassificationCharacteristic" + } + }, + "required" : [ "type", "codes", "dataCarrier", "classification" ] + }, + "urn_samm_io.catenax.shared.business_partner_number_2.0.0_BpnaTrait" : { + "type" : "string", + "description" : "The provided regular expression ensures that the BPNA is composed of prefix 'BPNA', 10 digits and two alphanumeric letters.", + "pattern" : "^BPNA[a-zA-Z0-9]{12}$" + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_FacilityEntity" : { + "description" : "The entity for a facility with the BPNA identifier.", + "type" : "object", + "properties" : { + "facility" : { + "description" : "The identifier used for a location. This attribute is mentioned in the ESPR provisional agreement from January 9th 2024 Annex III:\n(i) unique facility identifiers;\nArticle 2 Definitions: (33) 'unique facility identifier' means a unique string of characters for the identification of locations or buildings involved in the value chain of a product or used by actors involved in the value chain of a product.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.business_partner_number_2.0.0_BpnaTrait" + } + }, + "required" : [ "facility" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_FacilityList" : { + "description" : "List of facilities.", + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_FacilityEntity" + } + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_ManufacturerCharacteristic" : { + "description" : "Manufacturing information.", + "type" : "object", + "properties" : { + "facility" : { + "description" : "The identifier used for a location. In the CATENA-X use case, the BPNA can be stated. This attribute is mentioned in the ESPR provisional agreement from January 9th 2024 Annex III:\n(i) unique facility identifiers;\nArticle 2 Definitions: (33) 'unique facility identifier' means a unique string of characters for the identification of locations or buildings involved in the value chain of a product or used by actors involved in the value chain of a product.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_FacilityList" + }, + "manufacturer" : { + "description" : "The main manufacturer, if different from the passport owner, represented by an identification number. In the Catena-X use case, the BPNL can be stated. This attribute is mentioned in the ESPR provisional agreement from January 9th 2024 Annex III:\n(h) unique operator identifiers other than that of the manufacturer;\n(k) the name, contact details and unique operator identifier code of the economic operator established in the Union responsible for carrying out the tasks set out in Article 4 of Regulation (EU) 2019/1020, or Article 15 of Regulation (EU) [.../...] on general product safety, or similar tasks pursuant to other EU legislation applicable to the product.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.business_partner_number_2.0.0_BpnlTrait" + }, + "manufacturingDate" : { + "description" : "The timestamp in the format (yyyy-mm-dd) of the manufacturing date as the final step in production process (e.g. final quality check, ready-for-shipment event).", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DateTrait" + } + }, + "required" : [ "facility", "manufacturer" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_EoriTrait" : { + "type" : "string", + "description" : "Constraint with a pattern which ensures that the EORI number starts with two alphanumeric characters, followed by two alphabetic characters, and ends with 2 to 15 alphanumeric characters.", + "pattern" : "^[A-Z]{2}[A-Z0-9]{1,18}$" + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_ImporterCharacteristic" : { + "description" : "Characteristic with information regarding the importer.", + "type" : "object", + "properties" : { + "eori" : { + "description" : "An economic operator established in the customs territory of the Union needs, for customs purposes, an EORI number. EORI stands for economic operators registration and identification number. In this case, the importer's EORI must be provided. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Annex III:\n(j) information related to the importer, including the information referred to in Article 23(3) and its EORI number.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_EoriTrait" + }, + "id" : { + "description" : "The importer of the product, if different from the owner of the passport. In the Catena-X network, the BPNL is used for the identification of companies and the information stored for this like contact information and addresses.\nThis attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex III:\n(j) information related to the importer, including the information referred to in Article 23(3) and its EORI number;\nArticle 23 states:\n(3) Importers shall, for products covered by a delegated act adopted pursuant to Article 4, indicate their name, registered trade name or registered trade mark and the postal address and electronic means of communication, where they can be contacted: (a) on the public part of the product passport, when applicable, and\n(b) on the product or, where this is not possible, on the packaging, or in a document accompanying the product.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.business_partner_number_2.0.0_BpnlTrait" + } + }, + "required" : [ "eori", "id" ] + }, + "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.generic.digital_product_passport_5.0.0_ImportCharacteristic" : { + "description" : "Import Characteristic for the product.", + "type" : "object", + "properties" : { + "content" : { + "description" : "Information regarding the importer of the product, if different from the owner of the passport. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex III:\n(j) information related to the importer, including the information referred to in Article 23(3) and its EORI number;\nArticle 23 states:\n(3) Importers shall, for products covered by a delegated act adopted pursuant to Article 4, indicate their name, registered trade name or registered trade mark and the postal address and electronic means of communication, where they can be contacted: (a) on the public part of the product passport, when applicable, and\n(b) on the product or, where this is not possible, on the packaging, or in a document accompanying the product.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_ImporterCharacteristic" + }, + "applicable" : { + "description" : "Check whether the connected attributes are applicable to the product. If it is not applicable (false), dummy data can be delivered.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Boolean" + } + }, + "required" : [ "content", "applicable" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_OperatorCharacteristic" : { + "description" : "Other operators characteristic.", + "type" : "object", + "properties" : { + "id" : { + "description" : "Identifier of the other operator. This can be a BPN.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "role" : { + "description" : "Role of the other operator.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + } + }, + "required" : [ "id", "role" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_OperationCharacteristic" : { + "description" : "Operational information of the product.", + "type" : "object", + "properties" : { + "manufacturer" : { + "description" : "Manufacturing information of the product. In the CATENA-X use case, the BPNL and BPNA can be stated. These attributes are mentioned in the ESPR provisional agreement from January 9th 2024 Annex III:\n(h) unique operator identifiers other than that of the manufacturer;\n(k) the name, contact details and unique operator identifier code of the economic operator established in the Union responsible for carrying out the tasks set out in Article 4 of Regulation (EU) 2019/1020, or Article 15 of Regulation (EU) [.../...] on general product safety, or similar tasks pursuant to other EU legislation applicable to the product.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_ManufacturerCharacteristic" + }, + "import" : { + "description" : "Importer details such as the identification.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_ImportCharacteristic" + }, + "other" : { + "description" : "Other operators relevant for the product.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_OperatorCharacteristic" + } + }, + "required" : [ "manufacturer", "import" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_SourcesEntity" : { + "description" : "Entity for a possible spare part sources.", + "type" : "object", + "properties" : { + "id" : { + "description" : "The identifier of a spare part producer of the product. In the Catena-X network, the BPNL is used for the identification of companies and the information stored for this like contact information and addresses.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.business_partner_number_2.0.0_BpnlTrait" + } + }, + "required" : [ "id" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_SourcesList" : { + "description" : "List of possible spare part sources.", + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_SourcesEntity" + } + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PartsEntity" : { + "description" : "Possible spare parts of the product with identifiers and names.", + "type" : "object", + "properties" : { + "manufacturerPartId" : { + "description" : "Part ID as assigned by the manufacturer of the part. The part ID identifies the part in the manufacturer`s dataspace. The part ID references a specific version of a part. The version number must be included in the part ID if it is available. The part ID does not reference a specific instance of a part and must not be confused with the serial number.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.part_type_information_1.0.0_PartIdCharacteristic" + }, + "nameAtManufacturer" : { + "description" : "Name of the part as assigned by the manufacturer.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.part_type_information_1.0.0_PartNameCharacteristic" + } + }, + "required" : [ "manufacturerPartId", "nameAtManufacturer" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PartList" : { + "description" : "A list of possible spare parts of the product.", + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PartsEntity" + } + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_SparePart" : { + "description" : "Characteristic describing sources and spare parts.", + "type" : "object", + "properties" : { + "producer" : { + "description" : "Sources of possible spare parts.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_SourcesList" + }, + "sparePart" : { + "description" : "Possible spare parts of the product.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PartList" + } + }, + "required" : [ "producer", "sparePart" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_HandlingCharacteristic" : { + "description" : "Characteristic to describe aspects which are connected with the handling of the product.", + "type" : "object", + "properties" : { + "content" : { + "description" : "The list of spare parts available for the product from various suppliers.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_SparePart" + }, + "applicable" : { + "description" : "Check whether the connected attributes are applicable to the product. If it is not applicable (false), dummy data can be delivered.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Boolean" + } + }, + "required" : [ "content", "applicable" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_LifeEnumeration" : { + "type" : "string", + "description" : "Enumeration with the possible units day, month, cycle, year and runningOrOperatingHour.", + "enum" : [ "unit:day", "unit:month", "unit:year", "unit:cycle", "unit:runningOrOperatingHour" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_LifeValueCharacteristic" : { + "type" : "number", + "description" : "Characteristic for the life span value as an integer." + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_LifeTypeEnumeration" : { + "type" : "string", + "description" : "Enumeration with the values guaranteed lifetime, technical lifetime and mean time between failures.", + "enum" : [ "guaranteed lifetime", "technical lifetime", "mean time between failures" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_LifespanEntity" : { + "description" : "Entity for the lifespan of a product with type, unit and value.", + "type" : "object", + "properties" : { + "unit" : { + "description" : "The unit of the respective lifespan expressed through the possible units day, month, cycle, year and runningOrOperatingHour.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_LifeEnumeration" + }, + "value" : { + "description" : "The value as an integer for the respective lifespan.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_LifeValueCharacteristic" + }, + "key" : { + "description" : "The type of lifespan represented with the values guaranteed lifetime, technical lifetime and mean time between failures. This attribute is mentioned in the ESPR proposal from March 30th, 2022 ANNEX I:\n(a) durability and reliability of the product or its components as expressed through the product's guaranteed lifetime, technical lifetime [or] mean time between failures [...].", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_LifeTypeEnumeration" + } + }, + "required" : [ "unit", "value", "key" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_LifespanList" : { + "description" : "List of different life spans of a product.", + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_LifespanEntity" + } + }, + "urn_samm_io.catenax.shared.quantity_2.0.0_QuantityValueCharacteristic" : { + "type" : "number", + "description" : "The quantity value associated with the unit expressed as float." + }, + "urn_samm_io.catenax.shared.quantity_2.0.0_LinearUnitEnumeration" : { + "type" : "string", + "pattern" : "[a-zA-Z]*:[a-zA-Z]+", + "description" : "The unit of a linear attribute that may be used for height, width, length and diameter.", + "enum" : [ "unit:millimetre", "unit:centimetre", "unit:metre", "unit:kilometre", "unit:inch", "unit:foot", "unit:yard" ] + }, + "urn_samm_io.catenax.shared.quantity_2.0.0_LinearCharacteristic" : { + "description" : "Characteristic for linear measurements of an item.", + "type" : "object", + "properties" : { + "value" : { + "description" : "The quantity value associated with the unit.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.quantity_2.0.0_QuantityValueCharacteristic" + }, + "unit" : { + "description" : "The unit of a linear attribute.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.quantity_2.0.0_LinearUnitEnumeration" + } + }, + "required" : [ "value", "unit" ] + }, + "urn_samm_io.catenax.shared.quantity_2.0.0_MassUnitEnumeration" : { + "type" : "string", + "pattern" : "[a-zA-Z]*:[a-zA-Z]+", + "description" : "Enumeration for mass units.", + "enum" : [ "unit:gram", "unit:kilogram", "unit:tonneMetricTon", "unit:tonUsOrShortTonUkorus", "unit:ounceAvoirdupois", "unit:pound" ] + }, + "urn_samm_io.catenax.shared.quantity_2.0.0_MassCharacteristic" : { + "description" : "Characteristic for mass measurements of an item.", + "type" : "object", + "properties" : { + "value" : { + "description" : "The quantity value associated with the unit.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.quantity_2.0.0_QuantityValueCharacteristic" + }, + "unit" : { + "description" : "The unit of a mass related attribute.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.quantity_2.0.0_MassUnitEnumeration" + } + }, + "required" : [ "value", "unit" ] + }, + "urn_samm_io.catenax.shared.quantity_2.0.0_VolumeUnitEnumeration" : { + "type" : "string", + "pattern" : "[a-zA-Z]*:[a-zA-Z]+", + "description" : "Enumeration for volume units.", + "enum" : [ "unit:cubicMetre", "unit:litre", "unit:millilitre", "unit:cubicCentimetre", "unit:cubicInch", "unit:cubicFoot", "unit:cubicYard", "unit:hectolitre" ] + }, + "urn_samm_io.catenax.shared.quantity_2.0.0_VolumeCharacteristic" : { + "description" : "Characteristic for volume measurements of an item.", + "type" : "object", + "properties" : { + "value" : { + "description" : "The quantity value associated with the unit.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.quantity_2.0.0_QuantityValueCharacteristic" + }, + "unit" : { + "description" : "The unit of a volume related attribute.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.quantity_2.0.0_VolumeUnitEnumeration" + } + }, + "required" : [ "value", "unit" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PhysicalDimensionCharacteristic" : { + "description" : "Characteristic for physical dimensions with linear, mass and capacity attributes.", + "type" : "object", + "properties" : { + "width" : { + "description" : "The width of the item measured in a specific linear unit which can be declared in the corresponding unit attribute.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.quantity_2.0.0_LinearCharacteristic" + }, + "length" : { + "description" : "The length of the item measured in a specific linear unit which can be declared in the corresponding unit attribute.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.quantity_2.0.0_LinearCharacteristic" + }, + "diameter" : { + "description" : "The diameter of the item, if applicable, measured in a specific linear unit which can be declared in the corresponding unit attribute.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.quantity_2.0.0_LinearCharacteristic" + }, + "height" : { + "description" : "The height of the item measured in a specific linear unit which can be declared in the corresponding unit attribute.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.quantity_2.0.0_LinearCharacteristic" + }, + "grossWeight" : { + "description" : "The gross weight of the item measured in a specific mass unit which can be declared in the corresponding unit attribute. Gross weight refers to the total weight of a product, including the weight of the packaging. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7:\n(2) (b) (i) information on the performance of the product in relation to the product parameters referred to in Annex I;\nAnnex I (i) weight and volume of the product and its packaging, and the product-to-packaging ratio.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.quantity_2.0.0_MassCharacteristic" + }, + "grossVolume" : { + "description" : "The gross volume of the item, if possible, measured in a specific capacity unit which can be declared in the corresponding unit attribute. If there is no separate packing, the volume of the product shall be given. Gross volume refers to the total volume of a product, including the volume of the packaging. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7:\n(2) (b) (i) information on the performance of the product in relation to the product parameters referred to in Annex I;\nAnnex I (i) weight and volume of the product and its packaging, and the product-to-packaging ratio.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.quantity_2.0.0_VolumeCharacteristic" + }, + "weight" : { + "description" : "Weight of the product measured in a specific mass unit which can be declared in the corresponding unit attribute. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7:\n(2) (b) (i) information on the performance of the product in relation to the product parameters referred to in Annex I;\nAnnex I (i) weight and volume of the product [...].", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.quantity_2.0.0_MassCharacteristic" + }, + "volume" : { + "description" : "Volume of the product, if possible, measured in a specific capacity unit which can be declared in the corresponding unit attribute. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7:\n(2) (b) (i) information on the performance of the product in relation to the product parameters referred to in Annex I;\nAnnex I (i) weight and volume of the product [...].", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.quantity_2.0.0_VolumeCharacteristic" + } + }, + "required" : [ "grossWeight", "grossVolume", "weight", "volume" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PhysicalStateEnumeration" : { + "type" : "string", + "description" : "Enumeration with the values solid, liquid, gas and plasma.", + "enum" : [ "solid", "liquid", "gas", "plasma" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_ProductCharacteristics" : { + "description" : "Defines a set of specific characteristics of a product.", + "type" : "object", + "properties" : { + "lifespan" : { + "description" : "The type of lifespan represented with the values guaranteed lifetime, technical lifetime and mean time between failures. Both can be described through the attributes: type, which defines the type such as guaranteed lifetime or technical lifetime, the unit for the lifetime, and the value represented by an integer. These attributes are mentioned in the ESPR proposal from March 30th, 2022 ANNEX I:\n(a) durability and reliability of the product or its components as expressed through the products guaranteed lifetime, technical lifetime [or] mean time between failures [...].", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_LifespanList" + }, + "physicalDimension" : { + "description" : "Physical dimensions are properties associated with physical quantities for purposes of classification or differentiation. These attributes are mentioned in the ESPR provisional agreement from January 9th, Article 7:\n(2) (b) (i) information on the performance of the product in relation to one or more of the product parameters referred to in Annex I;\nAnnex I (i) weight and volume of the product and its packaging, and the product-to-packaging ratio.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PhysicalDimensionCharacteristic" + }, + "physicalState" : { + "description" : "The physical state of the item. There are four states of matter solid, liquid, gas and plasma which can be chosen from an enumeration.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PhysicalStateEnumeration" + }, + "generalPerformanceClass" : { + "description" : "The performance class of the product. This attribute is mentioned ESPR provisional agreement from January 9th, 2024 Article 7:\n4. When establishing the information requirements referred to in paragraph 2, point (b), point (i), the Commission shall, as appropriate in view of the specificity of the product group, determine classes of performance. Classes of performance may be based on single parameters, on aggregated scores, in absolute terms or in any other form that enables potential customers to choose the best performing products. Those classes of performance shall correspond to significant improvements in performance levels. Where classes of performance are based on parameters in relation to which performance requirements are established, they shall use as the minimum level the minimum performance required at the time when the classes of performance start to apply.\nDefinition:\n'class of performance': means a range of performance levels in relation to one or more product parameters referred to in Annex I, based on a common methodology for the product or product group, ordered into successive steps to allow for product differentiation.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + } + }, + "required" : [ "lifespan", "physicalDimension" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_StringList" : { + "description" : "List of strings.", + "type" : "array", + "items" : { + "type" : "string" + } + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_CommercialCharacteristic" : { + "description" : "Commercial information of the product.", + "type" : "object", + "properties" : { + "placedOnMarket" : { + "description" : "The timestamp in the format (yyyy-mm-dd) with or without time zone when the product was put in the market.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DateTrait" + }, + "purpose" : { + "description" : "One or more intended industry/industries of the product described by the digital product passport. If exchanged via Catena-X, 'automotive ' is a must choice included in the list.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_StringList" + } + }, + "required" : [ "purpose" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_ConcentrationEnumeration" : { + "type" : "string", + "description" : "Enumeration of possible units of concentration with percent, volume percent, parts per thousand, parts per million, parts per billion and parts per trillion.", + "enum" : [ "unit:partPerMillion", "unit:percent", "unit:percentVolume", "unit:partPerThousand", "unit:partPerTrillionUs", "unit:partPerBillionUs" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PositiveTrait" : { + "type" : "number", + "description" : "Constraint for only positive values.", + "minimum" : 0.0, + "exclusiveMinimum" : false + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_HazardCharacteristic" : { + "description" : "Characteristic for the hazardous classification.", + "type" : "object", + "properties" : { + "category" : { + "description" : "The hazard category of the substance of concern. Defined in Article 2 of Regulation (EC) No 1272/2008 of the European Parliament and of the Council of 16 December 2008 on classification, labelling and packaging of substances and mixtures, amending and repealing Directives 67/548/EEC and 1999/45/EC, and amending Regulation (EC) No 1907/2006:\n2. 'hazard category' means the division of criteria within each hazard class, specifying hazard severity.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "class" : { + "description" : "The hazard class of the substance of concern. Defined in Article 2 of Regulation (EC) No 1272/2008 of the European Parliament and of the Council of 16 December 2008 on classification, labelling and packaging of substances and mixtures, amending and repealing Directives 67/548/EEC and 1999/45/EC, and amending Regulation (EC) No 1907/2006:\n1. 'hazard class' means the nature of the physical, health or environmental hazard.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "statement" : { + "description" : "The hazard statement of the substance of concern. Defined in Article 2 of Regulation (EC) No 1272/2008 of the European Parliament and of the Council of 16 December 2008 on classification, labelling and packaging of substances and mixtures, amending and repealing Directives 67/548/EEC and 1999/45/EC, and amending Regulation (EC) No 1907/2006:\n5. 'hazard statement' means a phrase assigned to a hazard class and category that describes the nature of the hazards of a hazardous substance or mixture, including, where appropriate, the degree of hazard.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + } + }, + "required" : [ "category", "class", "statement" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_RangeEntity" : { + "description" : "Entity for the concentration range with two values, the highest and the lowest of the concentration range.", + "type" : "object", + "properties" : { + "min" : { + "description" : "The minimum concentration of the substance of concern at the level of the product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7:\n(5) (c) [...] concentration range of the substances of concern, at the level of the product [...].", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PositiveTrait" + }, + "max" : { + "description" : "The maximum concentration of the substance of concern at the level of the product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7:\n(5) (c) the concentration, maximum concentration or concentration range of the substances of concern, at the level of the product [...].", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PositiveTrait" + } + }, + "required" : [ "max" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_RangeCharacteristic" : { + "description" : "Range characteristic with two values, the highest and the lowest of the concentration range. Only providing the maximum range is also possible.", + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_RangeEntity" + } + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_ListTypeEnumerationId" : { + "type" : "string", + "description" : "Enumeration of different systems and organizations related to the identification and classification of chemical substances in the field of chemistry. The enumeration values are EC or CAS.", + "enum" : [ "CAS", "EC", "IUPAC" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_MaterialIdEntity" : { + "description" : "Id Entity with identifier, name and list type.", + "type" : "object", + "properties" : { + "id" : { + "description" : "The substance identification, in accordance with the specification in the attribute for the list type.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_IdentifierCharacteristic" + }, + "type" : { + "description" : "The type of standard used for the identification of the substances. Selected can be for example CAS, IUPAC or EC.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_ListTypeEnumerationId" + }, + "name" : { + "description" : "The name of the material which is present in the product.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + } + }, + "required" : [ "id", "type", "name" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_MaterialIdList" : { + "description" : "List of ids for the identification.", + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_MaterialIdEntity" + } + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_HeaderTrait" : { + "type" : "string", + "description" : "Constraint for a maximum of 100 characters.", + "maxLength" : 100 + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentationEntity" : { + "description" : "Entity for a document with a header, type and content.", + "type" : "object", + "properties" : { + "content" : { + "description" : "The content of the document e.g a link.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "contentType" : { + "description" : "The type of content which can be expected in the \"content\" property. Examples are a link, restricted link, pdf, excel, etc.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "header" : { + "description" : "The header as a short description of the document with a maximum of 100 characters.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_HeaderTrait" + } + }, + "required" : [ "content", "contentType", "header" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentList" : { + "description" : "List of documents.", + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentationEntity" + } + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_SubstanceEntity" : { + "description" : "Information regarding substances of concern in the product.", + "type" : "object", + "properties" : { + "location" : { + "description" : "The location of the substances of concern within the product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7:\n(5) (b) the location of the substances of concern within the product.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "unit" : { + "description" : "The unit of concentration chosen from an enumeration: mass percent, volume percent, parts per thousand, parts per million, parts per billion and parts per trillion.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_ConcentrationEnumeration" + }, + "concentration" : { + "description" : "Concentration of the material at the level of the product. This attribute is specially mentioned for substances of concern mentioned in the ESPR proposal from March 30th, 2022 Article 7:\n(5) (c) the concentration, maximum concentration or concentration range of the substances of concern, at the level of the product [...].\nOther substances are mentioned for the purpose of recycling in the ESPR provisional agreement from January 9th, 2024 Annex I:\n(d) design for recycling, ease and quality of recycling as expressed through: use of easily recyclable materials, safe, easy and non-destructive access to recyclable components and materials or components and materials containing hazardous substances and material composition and homogeneity, possibility for high-purity sorting, number of materials and components used, use of standard components, use of component and material coding standards for the identification of components and materials, number and complexity of processes and tools needed, ease of nondestructive disassembly and re-assembly, conditions for access to product data, conditions for access to or use of hardware and software needed.\n", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PositiveTrait" + }, + "exemption" : { + "description" : "Exemptions to the substance of concern. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Article 7:\n(5) (c) provide duly justified exemptions for substances of concern or information elements from the information requirements referred to in the first subparagraph based on the technical feasibility or relevance of tracking substances of concern, the existence of analytical methods to detect and quantify them, the need to protect confidential business information or in other duly justified cases. Substances of concern within the meaning of Article 2(28), point a), shall not be exempted if they are present in products, their relevant components or spare parts in a concentration above 0,1 % weight by weight.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "hazardClassification" : { + "description" : "The specification of the hazard class. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I:\n(f) use of substances, and in particular the use of substances of concern, on their own, as constituents of substances or in mixtures, during the production process of products, or leading to their presence in products, including once these products become waste, and their impacts on human health and the environment;\nFurther defined is this by Regulation (EC) No 1272/2008 of the European Parliament and of the Council of 16 December 2008 on classification, labelling and packaging of substances and mixtures, amending and repealing Directives 67/548/EEC and 1999/45/EC, and amending Regulation (EC) No 1907/2006.\nDefined in Article 2:\n1. 'hazard class' means the nature of the physical, health or environmental hazard;\n2. 'hazard category' means the division of criteria within each hazard class, specifying hazard severity;\n5. 'hazard statement' means a phrase assigned to a hazard class and category that describes the nature of the hazards of a hazardous substance or mixture, including, where appropriate, the degree of hazard;", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_HazardCharacteristic" + }, + "concentrationRange" : { + "description" : "The concentration range for the substance of concern. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7:\n(5) (c) [...] concentration range of the substances of concern, at the level of the product [...].", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_RangeCharacteristic" + }, + "id" : { + "description" : "The chemical material name and identification, in accordance with the specification in the attribute for the list type. Preference is given to the IUPAC name. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Article 7:\n(5) (a) the name of the substances of concern present in the product, as follows:\n - name(s) in the International Union of Pure and Applied Chemistry (IUPAC) nomenclature, or another international name when IUPAC name is not available; \n- other names (usual name, trade name, abbreviation);\n- European Community (EC) number, as indicated in the European Inventory of Existing Commercial Chemical Substances (EINECS), the European List of Notified Chemical Substances (ELINCS) or the No Longer Polymer (NLP) list or assigned by the European Chemicals Agency (ECHA), if available;\n- the Chemical Abstract Service (CAS) name(s) and number(s), if available; .", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_MaterialIdList" + }, + "documentation" : { + "description" : "Documentation accompanying the material.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentList" + } + }, + "required" : [ "location", "unit", "concentration", "exemption", "hazardClassification", "concentrationRange", "id", "documentation" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_SubstanceList" : { + "description" : "Characteristic for a list of substances of concern.", + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_SubstanceEntity" + } + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_SubstanceOfConcernCharacteristic" : { + "description" : "Substance of concern Characteristic of the product.", + "type" : "object", + "properties" : { + "applicable" : { + "description" : "Check whether the connected attributes are applicable to the product. If it is not applicable (false), dummy data can be delivered.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Boolean" + }, + "content" : { + "description" : "Information regarding substances of concern in the product. Attributes are among others substance names, ids, concentration, location and hazard class. This is mentioned in the ESPR provisional agreement from January 9th, 2024 Article 7:\n(5) (a) the name of the substances of concern present in the product, as follows:\n- name(s) in the International Union of Pure and Applied Chemistry (IUPAC) nomenclature, or another international name when IUPAC name is not available; \n- other names (usual name, trade name, abbreviation);\n- European Community (EC) number, as indicated in the European Inventory of Existing Commercial Chemical Substances (EINECS), the European List of Notified Chemical Substances (ELINCS) or the No Longer Polymer (NLP) list or assigned by the European Chemicals Agency (ECHA), if available;\n- the Chemical Abstract Service (CAS) name(s) and number(s), if available;\n(5) (b) the location of the substances of concern within the product.\n(5) (c) the concentration, maximum concentration or concentration range of the substances of concern, at the level of the product its relevant components, or spare parts;\n(d) relevant instructions for the safe use of the product;\n(e) information relevant for disassembly, preparation for reuse, reuse, recycling and the environmentally sound management of the product at the end of its life.\nAnd in the next paragraph:\n(c) provide duly justified exemptions for substances of concern or information elements from the information requirements referred to in the first subparagraph.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_SubstanceList" + } + }, + "required" : [ "applicable", "content" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PercentageTrait" : { + "type" : "number", + "description" : "Range constraint for a positive percentage value.", + "maximum" : 100.0, + "exclusiveMaximum" : false, + "minimum" : 0.0, + "exclusiveMinimum" : false + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_MaterialEntity" : { + "description" : "Information regarding recycled and/or renewable materials in the product.", + "type" : "object", + "properties" : { + "recycled" : { + "description" : "The share of the material, which is recovered recycled content from the product. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I:\n(h) use or content of recycled materials and recovery of materials, including critical raw materials;", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PercentageTrait" + }, + "renewable" : { + "description" : "The share of the material, which is from a renewable resource that can be replenished. Renewable resources are those that can be reproduced by physical, chemical, or mechanical processes. These are the kind of resources that can be regenerated throughout time. Forest wood, for example, can be grown through reforestation. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I:\n(ha) use or content of sustainable renewable materials;\n", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PercentageTrait" + }, + "unit" : { + "description" : "The unit of concentration chosen from an enumeration: mass percent, volume percent, parts per thousand, parts per million, parts per billion and parts per trillion.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_ConcentrationEnumeration" + }, + "id" : { + "description" : "The chemical material name and identification, in accordance with the specification in the attribute for the list type. Preference is given to the IUPAC name. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Article 7:\n(5) (a) the name of the substances of concern present in the product, as follows:\n - name(s) in the International Union of Pure and Applied Chemistry (IUPAC) nomenclature, or another international name when IUPAC name is not available; \n- other names (usual name, trade name, abbreviation);\n- European Community (EC) number, as indicated in the European Inventory of Existing Commercial Chemical Substances (EINECS), the European List of Notified Chemical Substances (ELINCS) or the No Longer Polymer (NLP) list or assigned by the European Chemicals Agency (ECHA), if available;\n- the Chemical Abstract Service (CAS) name(s) and number(s), if available; .", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_MaterialIdList" + }, + "critical" : { + "description" : "A flag, if the material is a critical raw material. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I:\n(h) use or content of recycled materials and recovery of materials, including critical raw materials;\nIn Annex II of the connected proposal Act of Critical Raw Materials, a list of critical raw materials can be found.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Boolean" + }, + "concentration" : { + "description" : "Concentration of the material at the level of the product. This attribute is specially mentioned for substances of concern mentioned in the ESPR proposal from March 30th, 2022 Article 7:\n(5) (c) the concentration, maximum concentration or concentration range of the substances of concern, at the level of the product [...].\nOther substances are mentioned for the purpose of recycling in the ESPR provisional agreement from January 9th, 2024 Annex I:\n(d) design for recycling, ease and quality of recycling as expressed through: use of easily recyclable materials, safe, easy and non-destructive access to recyclable components and materials or components and materials containing hazardous substances and material composition and homogeneity, possibility for high-purity sorting, number of materials and components used, use of standard components, use of component and material coding standards for the identification of components and materials, number and complexity of processes and tools needed, ease of nondestructive disassembly and re-assembly, conditions for access to product data, conditions for access to or use of hardware and software needed.\n", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PositiveTrait" + }, + "documentation" : { + "description" : "Documentation accompanying the material.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentList" + } + }, + "required" : [ "recycled", "renewable", "unit", "id", "critical", "concentration", "documentation" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_MaterialList" : { + "description" : "A list of different materials in the product.", + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_MaterialEntity" + } + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_MaterialCharacteristic" : { + "description" : "Material Characteristic with information on the materials.", + "type" : "object", + "properties" : { + "applicable" : { + "description" : "Check whether the connected attributes are applicable to the product. If it is not applicable (false), dummy data can be delivered.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Boolean" + }, + "content" : { + "description" : "Information on different materials in the product.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_MaterialList" + } + }, + "required" : [ "applicable", "content" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_MaterialsCharacteristic" : { + "description" : "Materials Characteristic on product level.", + "type" : "object", + "properties" : { + "substancesOfConcern" : { + "description" : "Information regarding substances of concern in the product. The ESPR provisional agreement from January 9th, 2024 defines:\n(52) 'hazardous substance' means a substance classified as hazardous pursuant to Article 3 of Regulation (EC) No 1272/2008.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_SubstanceOfConcernCharacteristic" + }, + "materialComposition" : { + "description" : "Material composition of the product with information on recycled and renewable materials.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_MaterialCharacteristic" + } + }, + "required" : [ "substancesOfConcern", "materialComposition" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_StateEnumeration" : { + "type" : "string", + "description" : "Enumeration defined as original, repurposed, re-used, remanufactured or waste.", + "enum" : [ "original", "repurposed", "re-used", "remanufactured", "waste" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_CategoryEnumeration" : { + "type" : "string", + "description" : "Enumeration of the 19 impact categories in accordance to EN15804+A2.", + "enum" : [ "Climate Change Total", "Climate Change Fossil", "Climate Change Biogenic Removals and Emissions", "Climate Change Land Use and Land Use Change", "Ozone Depletion", "Acidification", "Eutrophication Aquatic Freshwater", "Eutrophication Fresh Marine", "Eutrophication Terrestrial", "Photochemical Ozone Formation", "Abiotic Depletion- Minerals and Metals", "Fossil Fuels", "Water Use", "Particulate Matter Emissions", "Ionizing Radiation, Human Health", "Eco-Toxicity", "Human Toxicity, Cancer Effects", "Human Toxicity, Non-Cancer Effects", "Land Use Related Impacts/Soil Quality" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_FootprintEntity" : { + "description" : "Footprint Entity for the carbon and environmental footprint with the total value, unit, impact category type, lifecycle, rulebook, declaration, performance class and the facility.", + "type" : "object", + "properties" : { + "value" : { + "description" : "The value of the footprint of the product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Annex I:\n(l) the environmental footprint of the product, expressed as a quantification, in accordance with the applicable delegated act, of a product's life cycle environmental impacts, whether in relation to one or more environmental impact categories or an aggregated set of impact categories;\n(m) the carbon footprint of the product;\n(ma) the material footprint of the product.\n", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PositiveTrait" + }, + "rulebook" : { + "description" : "The applied rulebook for the environmental footprint of the product.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentList" + }, + "lifecycle" : { + "description" : "The lifecycle stage, to which the environmental footprint corresponds. These could be for example \"raw material acquisition and pre-processing\", \"main product production\", \"distribution\" or \"end of life and recycling\".", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "unit" : { + "description" : "The unit of measurement of the environmental impact category. For each impact category a specific unit is used. If an aggregation is used, utilize the normalization and weighting methods used in the referenced rulebook.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "type" : { + "description" : "The type of the environmental footprint of the product. This could be one of the environmental impact categories. This attribute is mentioned in the ESPR provisional agreement from January 9th 2024 Article 7:\n(2)(b)(i) information on the performance of the product in relation to one or more of the product parameters referred to in Annex I, including a scoring of reparability or durability, carbon footprint or environmental footprint;\nAnnex I:\n(l) the environmental footprint of the product, expressed as a quantification, in accordance with the applicable delegated act, of a product's life cycle environmental impacts, whether in relation to one or more environmental impact categories or an aggregated set of impact categories.\n(m) the carbon footprint of the product;\n(ma) the material footprint of the product.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_CategoryEnumeration" + }, + "performanceClass" : { + "description" : "The performance classification of the footprint.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "manufacturingPlant" : { + "description" : "The manufacturing plant of the footprint in the specific lifecycle phase.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_FacilityList" + }, + "declaration" : { + "description" : "The footprint declaration in the format of a link ", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentList" + } + }, + "required" : [ "value", "rulebook", "lifecycle", "unit", "type", "manufacturingPlant", "declaration" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_FootprintList" : { + "description" : "Footprint List for the environmental footprint.", + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_FootprintEntity" + } + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_ProductFootprintCharacteristic" : { + "description" : "The Product Footprint Characteristic with sustainability information.", + "type" : "object", + "properties" : { + "environmental" : { + "description" : "The environmental footprint of the product. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I:\nThe following parameters shall, as appropriate, and where necessary supplemented by others, be used, individually or combined, as a basis for improving the product aspects referred to in Article 5(1):\n(l) the environmental footprint of the product, expressed as a quantification, in accordance with the applicable delegated act, of a product's life cycle environmental impacts, whether in relation to one or more environmental impact categories or an aggregated set of impact categories.\nand Article 7:\n(2)(b)(i) information on the performance of the product in relation to one or more of the product parameters referred to in Annex I, including a scoring of reparability or durability, carbon footprint or environmental footprint;\nand defined by Article 2:\n(23) 'environmental footprint' means a quantification of product environmental impacts throughout its life cycle, whether in relation to a single environmental impact category or an aggregated set of impact categories based on the Product Environmental Footprint method or other scientific methods developed by international organisations and widely tested in collaboration with different industry sectors and adopted or implemented by the Commission in other Union legislation;\n(24) 'Product Environmental Footprint method' means the life cycle assessment method to quantify the environmental impacts of products established by Recommendation (EU) 2021/2279.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_FootprintList" + }, + "carbon" : { + "description" : "The carbon footprint of the product. This is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I:\nThe following parameters shall, as appropriate, and where necessary supplemented by others, be used, individually or combined, as a basis for improving the product aspects referred to in Article 5(1):\n(m) the carbon footprint of the product;\nand Article 7:\n(2)(b)(i) information on the performance of the product in relation to one or more of the product parameters referred to in Annex I, including a scoring of reparability or durability, carbon footprint or environmental footprint;\nand defined by Article 2:\n(25) 'carbon footprint' means the sum of greenhouse gas (GHG) emissions and GHG removals in a product system, expressed as CO2 equivalents and based on a life cycle assessment using the single impact category of climate change.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_FootprintList" + }, + "material" : { + "description" : "The material footprint of the product. This is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I:\n(ma) the material footprint of the product;\nand defined by Article 2:\n(25a) 'material footprint' refers to the total amount of raw materials extracted to meet final consumption demands.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_FootprintList" + } + }, + "required" : [ "carbon" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_SustainabilityCharacteristic" : { + "description" : "Characteristic which describes relevant information for the sustainability of the product.", + "type" : "object", + "properties" : { + "status" : { + "description" : "The status of the product (original, repurposed, re-used, remanufactured or waste) to indicated, whether it is a used product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Annex I:\n(j) incorporation of used components.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_StateEnumeration" + }, + "productFootprint" : { + "description" : "The carbon and environmental footprint or material footprint of the product. These attributes are mentioned in the ESPR provisional agreement from January 9th 2024 Annex I:\n(l) the environmental footprint of the product, expressed as a quantification, in accordance with the applicable delegated act, of a product's life cycle environmental impacts, whether in relation to one or more environmental impact categories or an aggregated set of impact categories;\n(m) the carbon footprint of the product;\n(ma) the material footprint of the product;\nAll are defined by Article 2:\n(23) 'environmental footprint' means a quantification of product environmental impacts throughout its life cycle, whether in relation to a single environmental impact category or an aggregated set of impact categories based on the Product Environmental Footprint method or other scientific methods developed by international organisations and widely tested in collaboration with different industry sectors and adopted or implemented by the Commission in other Union \nlegislation;\n(25) 'carbon footprint' means the sum of greenhouse gas (GHG) emissions and GHG removals in a product system, expressed as CO2 equivalents and based on a life cycle assessment using the single impact category of climate change.\n(25a) 'material footprint' refers to the total amount of raw materials extracted to meet final consumption demands;", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_ProductFootprintCharacteristic" + }, + "reparabilityScore" : { + "description" : "The reparability score. This attribute is mentioned ESPR provisional agreement from January 9th, 2024 Article 7:\n(b) as appropriate, also require products to be accompanied by:\n(i) information on the performance of the product in relation to one or more of the product parameters referred to in Annex I, including a scoring of reparability or durability [...].", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "durabilityScore" : { + "description" : "The durability score. This attribute is mentioned ESPR provisional agreement from January 9th, 2024 Article 7:\n(b) as appropriate, also require products to be accompanied by:\n(i) information on the performance of the product in relation to one or more of the product parameters referred to in Annex I, including a scoring of reparability or durability [...].", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + } + }, + "required" : [ "status", "productFootprint" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_SourceCategoryEnumeration" : { + "type" : "string", + "description" : "The types of sources that can be linked in a digital product passport can vary depending on the nature of the product and the information that needs to be included. This is an enumeration of possible sources.", + "enum" : [ "Product Specifications", "Manufacturer Information", "User Manuals and Guides", "Certifications and Compliance", "Product Images and Videos", "Warranty Information", "Reviews and Ratings", "Product Variations", "Supply Chain Information", "Environmental Impact", "Compatibility and Accessories", "FAQs and Support", "Purchase and Retail Information", "Privacy and Data Handling", "Third-Party Integrations", "Legal Information", "Safety Information", "Repair and Installation", "Waste Generation and Prevention", "Specific Voluntary Labels", "Product Packaging", "Return and Disposal", "End of Life", "Material and Substance Information", "Technical Documentation", "Treatment facilities", "Other" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentEntity" : { + "description" : "Document entity with header, content, category and type.", + "type" : "object", + "properties" : { + "content" : { + "description" : "The content of the document e.g a link.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "category" : { + "description" : "The category in which the document can be sorted. These are mentioned in the ESPR proposal from March 30th, 2022 ANNEX III:\n(e) compliance documentation and information required under this Regulation or other Union law applicable to the product, such as the declaration of conformity, technical documentation or conformity certificates;\nANNEX IV states additional information regarding the content of the technical documentation\nFurther information on documents are mentioned in the proposal from March 30th, 2022 ANNEX III:\n(f) user manuals, instructions, warnings or safety information, as required by other Union legislation applicable to the product.\nAdditionally requirements are mentioned in Article 21:\n(7) Manufacturers shall ensure that that a product covered by a delegated act adopted pursuant to Article 4 is accompanied by instructions that enable consumers and other end-users to safely assemble, install, operate, store, maintain, repair and dispose of the product in a language that can be easily understood by consumers and other end-users, as determined by the Member State concerned. Such instructions shall be clear, understandable and legible and include at least the information specified in the delegated acts adopted pursuant to Article 4 and pursuant to Article 7(2)(b), point (ii).\nArticle 7 states additionally:\n(2) (b) (ii) information for consumers and other end-users on how to install, use, maintain and repair the product in order to minimize its impact on the environment and to ensure optimum durability, as well as on how to return or dispose of the product at end-of-life;\n(2) (b) (iii) information for treatment facilities on disassembly, recycling, or disposal at end-of-life;\n(2) (b) (iv) other information that may influence the way the product is handled by parties other than the manufacturer in order to improve performance in relation to product parameters referred to in Annex I.\n(5) (d) relevant instructions for the safe use of the product.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_SourceCategoryEnumeration" + }, + "type" : { + "description" : "The type of content which can be expected in the \"content\" property. Examples are a link, restricted link, pdf, excel, etc.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "header" : { + "description" : "The header as a short description of the document with a maximum of 100 characters.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_HeaderTrait" + } + }, + "required" : [ "content", "category", "type", "header" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_SourceList" : { + "description" : "A list of documents.", + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentEntity" + } + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_UnitCatalog" : { + "type" : "string", + "description" : "Link to the unit catalog with all possible units in the format \"unit:xxx\"." + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DataTypeEnumeration" : { + "type" : "string", + "description" : "Data type that describe the content of the attributes children and data. In case \"object\" is selected in the enumeration, the children field will be used in the AdditionalDataEntity instead of the \"data\" property. If it is an other type, the content will be specified in \"data\" as a string.", + "enum" : [ "array", "object", "xsd:string", "xsd:integer", "xsd:boolean", "xsd:double", "xsd:float", "xsd:byte" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_TypeCharacteristic" : { + "description" : "Characteristic for the data type.", + "type" : "object", + "properties" : { + "typeUnit" : { + "description" : "Choose a unit type from the unit catalog, or if the property \"children\" is filled, leave empty.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_UnitCatalog" + }, + "dataType" : { + "description" : "Data type that describe the content of the attributes children and data. In case \"object\" is selected in the enumeration, the children field will be used in the AdditionalDataEntity instead of the \"data\" property. If it is an other type, the content will be specified in \"data\" as a string.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DataTypeEnumeration" + } + }, + "required" : [ "dataType" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_AdditionalDataEntity" : { + "description" : "Entity with additional data. Properties are label, description, type, data and children. Either the fields data or children filled. Children constructs a hierarchy with the same attributes. Data is filled as the end of an path/leaf.", + "type" : "object", + "properties" : { + "label" : { + "description" : "The human readable name of the attribute.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "description" : { + "description" : "The description of the attribute context.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "type" : { + "description" : "The complex description of the type.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_TypeCharacteristic" + }, + "data" : { + "description" : "The content from the attribute which is a depended of the data type and typeUnit.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "children" : { + "description" : "Children of the hierarchy.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_AdditionalDataList" + } + }, + "required" : [ "label", "description", "type" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_AdditionalDataList" : { + "description" : "List of additional data.", + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_AdditionalDataEntity" + } + } + } + }, + "properties" : { + "metadata" : { + "description" : "Metadata of the product passport. These are mentioned in the ESPR proposal from March 30th, 2022 and some changed by the provisional agreement from January 9th, 2024.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_MetadataCharacteristic" + }, + "identification" : { + "description" : "Identification information of the product, especially identifiers and codes. These are mentioned in the ESPR provisional agreement from January 9th, 2024 ANNEX III:\n(b) the unique product identifier at the level indicated in the applicable delegated act adopted pursuant to Article 4.\nAdditionally in Article 9 regarding general requirements for the product passport is stated that:\nA product passport shall meet the following conditions:\n(a) it shall be connected through a data carrier to a persistent unique product identifier;\n(e) the information included in the product passport shall refer to the product model, batch, or item as specified in the delegated act adopted pursuant to Article 4.\nArticle 2 Definitions: \n(31) 'unique product identifier' means a unique string of characters for the identification of products that also enables a web link to the product passport;\nRecital (27): A 'model' usually means a version of a product of which all units share the same technical characteristics relevant for the ecodesign requirements and the same model identifier, a 'batch' usually means a subset of a specific model composed of all products produced in a specific manufacturing plant at a specific moment in time and an 'item' usually means a single unit of a model.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_IdentificationCharacteristic" + }, + "operation" : { + "description" : "Operational information of the product.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_OperationCharacteristic" + }, + "handling" : { + "description" : "Properties connected with the handling of the product.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_HandlingCharacteristic" + }, + "characteristics" : { + "description" : "Defines specific characteristics of a product.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_ProductCharacteristics" + }, + "commercial" : { + "description" : "Commercial information of the product.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_CommercialCharacteristic" + }, + "materials" : { + "description" : "Properties which are relevant for the materials of the product.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_MaterialsCharacteristic" + }, + "sustainability" : { + "description" : "Sustainability related attributes.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_SustainabilityCharacteristic" + }, + "sources" : { + "description" : "Documents that are mandatory if applicable for the product. These are mentioned in the ESPR provisional agreement from January 9th, 2024 ANNEX III:\n(e) compliance documentation and information required under this Regulation or other Union law applicable to the product, such as the declaration of conformity, technical documentation or conformity certificates;\n(f) user manuals, instructions, warnings or safety information, as required by other Union legislation applicable to the product.\nAdditionally requirements are mentioned in Article 21:\n7. Manufacturers shall ensure that a product covered by a delegated act adopted pursuant to Article 4 is accompanied by instructions in digital format that enable customers and other relevant actors to assemble, install, operate, store, maintain, repair and dispose of the product in a language that can be easily understood, as determined by the Member State concerned. Such instructions shall be clear, understandable and legible and include at least the information set out in Article 7(2), point (b), point (ii) specified in the delegated acts adopted pursuant to Article 4.\nArticle 7 states additionally:\n(ii) information for customers and other actors on how to install, use, maintain and repair the product, in order to minimise its impact on the environment and to ensure optimum durability, on how to install third-party operating systems where relevant, as well as on collection for refurbishment or remanufacture, and on how to return or handle the product at the end of its life;\n(2) (b) (iii) information for treatment facilities on disassembly, reuse, refurbishment, recycling, or disposal at end-of-life;\n(2) (b) (iv) other information that may influence sustainable product choices for customers and the way the product is handled by parties other than the manufacturer in order to facilitate appropriate use, value retaining operations and correct treatment at end-of-life.\n(5) (d) relevant instructions for the safe use of the product.\n(5) (e) information relevant for disassembly, preparation for reuse, reuse, recycling and the environmentally sound management of the product at the end of its life.\nAnnex I:\n(b) [...] availability of repair and maintenance instructions, number of materials and components used, use of standard components,[...] number and complexity of processes and whether specialised toolsare needed, ease of non-destructive disassembly and re-assembly, conditions for access to product data, conditions for access to or use of hardware and software needed;\n(c) ease of upgrading, re-use, remanufacturing and refurbishment as expressed through: [...] number and complexity of processes and tools needed, ease of non-destructive disassembly and re-assembly, conditions for access to product data, conditions for access to or use of hardware and software needed, conditions of access to test protocols or not commonly available testing equipment, availability of guarantees specific to remanufactured or refurbished products, conditions for access to or use of technologies protected by intellectual property rights, modularity;\n(d) design for recycling, ease and quality of recycling as expressed through: use of easily recyclable materials, safe, easy and non-destructive access to recyclable components and materials or components and materials containing hazardous substances and material composition and homogeneity, possibility for high-purity sorting, [...] number and complexity of processes and tools needed, ease of nondestructive disassembly and re-assembly, conditions for access to product data, conditions for access to or use of hardware and software needed;\n(q) functional performance and conditions for use including as expressed through ability in performing its intended use, precautions of use, skills required, compatibility with other products or systems.\nAdditionally to consider are guidelines and instructions regarding the proper management and disposal of packaging materials after use. This can include instructions for separation, reuse, and recycling.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_SourceList" + }, + "additionalData" : { + "description" : "Data in form of open fields which need to be transferred in addition. The regulation is still under development and may change in the future. To accommodate this, additional data allows the option to include additional data required by future changes to the regulation. In addition, the DPP can be easily updated and adapted to the new requirements. \nThe ESPR provisional agreement from January 9th, 2024 Article 9 mentions:\n2. Where other Union legislation requires or allows the inclusion of specific information in the product passport, that information may be included in the product passport pursuant to the applicable delegated act adopted pursuant to Article 4.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_AdditionalDataList" + } + }, + "required" : [ "metadata", "identification", "operation", "handling", "characteristics", "commercial", "materials", "sustainability", "sources" ] +} \ No newline at end of file diff --git a/io.catenax.generic.digital_product_passport/5.0.0/gen/DigitalProductPassport.aasx b/io.catenax.generic.digital_product_passport/5.0.0/gen/DigitalProductPassport.aasx new file mode 100644 index 000000000..ca4930ab8 Binary files /dev/null and b/io.catenax.generic.digital_product_passport/5.0.0/gen/DigitalProductPassport.aasx differ diff --git a/io.catenax.generic.digital_product_passport/5.0.0/gen/DigitalProductPassport.html b/io.catenax.generic.digital_product_passport/5.0.0/gen/DigitalProductPassport.html new file mode 100644 index 000000000..7a1ceae97 --- /dev/null +++ b/io.catenax.generic.digital_product_passport/5.0.0/gen/DigitalProductPassport.html @@ -0,0 +1,10099 @@ + + + + + + + + + + + + + + Documentation Digital Product Passport + + +
+
+
+
+

Aspect Model Digital Product Passport

+
urn:samm:io.catenax.generic.digital_product_passport:5.0.0#DigitalProductPassport
+
+
+
+
+
+
+
+ +
+ + +
+ The Digital Product Passport (DPP) allows to share process and product-related information amongst supply chain businesses, authorities and consumers. The DPP allows for efficient information flows following best practices; and the possibility of accompanying the measures under this Regulation with mitigating measures so that impacts are expected to remain proportionate for SMEs.This is expected to increase transparency, both for supply chain businesses and for the general public, and increase efficiencies in terms of information transfer to support the data exchange between economic actors in integrating circularity in product design and manufacturing. +In particular, it is likely to help facilitate and streamline the monitoring and enforcement of the regulation carried out by EU and Member State authorities. It is also likely to provide a market-intelligence tool that may be used for revising and refining obligations in the future. +The DPP includes data about components, materials and chemical substances, information on reparability, spare parts, environmental impact and professional disposal for a product. +The data model will be updated, as newer versions of the regulation will be published. +The main basis is provided by the document "Proposal for a REGULATION OF THE EUROPEAN PARLIAMENT AND OF THE COUNCIL establishing a framework for setting ecodesign requirements for sustainable products and repealing Directive 2009/125/EC" from March 30th, 2022. The latest version of the document was the provisional agreement between the EU Council and the Parliament from January 9th, 2024. The text is informal, but the content of the final regulation was agreed between these two institutions. +The Title of Ecodesign Regulation has been changed to: Proposal for a REGULATION OF THE EUROPEAN PARLIAMENT AND OF THE COUNCIL establishing a framework for setting ecodesign requirements for sustainable products, amending Regulation (EU) 2023/1542 and repealing Directive 2009/125/EC. +
+ + +
+

Overview

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

Properties

+
+ +
+ +
+

Additional Data

+
+ +Data in form of open fields which need to be transferred in addition. The regulation is still under development and may change in the future. To accommodate this, additional data allows the option to include additional data required by future changes to the regulation. In addition, the DPP can be easily updated and adapted to the new requirements. +The ESPR provisional agreement from January 9th, 2024 Article 9 mentions: +2. Where other Union legislation requires or allows the inclusion of specific information in the product passport, that information may be included in the product passport pursuant to the applicable delegated act adopted pursuant to Article 4. + +
+
Name
+
additionalData
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#AdditionalDataEntity + +
+
+
+
+
+ + +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
additionalData
+
+ + +
+
+ +
+

Characteristics

+
+ +Defines specific characteristics of a product. + +
+
Name
+
characteristics
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#CharacteristicsEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
characteristics
+
+ + +
+
+ +
+

Commercial

+
+ +Commercial information of the product. + +
+
Name
+
commercial
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#CommercialEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
commercial
+
+ + +
+
+ +
+

Identification

+
+ +Identification information of the product, especially identifiers and codes. These are mentioned in the ESPR provisional agreement from January 9th, 2024 ANNEX III: +(b) the unique product identifier at the level indicated in the applicable delegated act adopted pursuant to Article 4. +Additionally in Article 9 regarding general requirements for the product passport is stated that: +A product passport shall meet the following conditions: +(a) it shall be connected through a data carrier to a persistent unique product identifier; +(e) the information included in the product passport shall refer to the product model, batch, or item as specified in the delegated act adopted pursuant to Article 4. +Article 2 Definitions: +(31) 'unique product identifier' means a unique string of characters for the identification of products that also enables a web link to the product passport; +Recital (27): A 'model' usually means a version of a product of which all units share the same technical characteristics relevant for the ecodesign requirements and the same model identifier, a 'batch' usually means a subset of a specific model composed of all products produced in a specific manufacturing plant at a specific moment in time and an 'item' usually means a single unit of a model. + +
+
Name
+
identification
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#IdentificationEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
identification
+
+ + +
+
+ +
+

Materials

+
+ +Properties which are relevant for the materials of the product. + +
+
Name
+
materials
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#MaterialsEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
materials
+
+ + +
+
+ +
+

Metadata

+
+ +Metadata of the product passport. These are mentioned in the ESPR proposal from March 30th, 2022 and some changed by the provisional agreement from January 9th, 2024. + +
+
Name
+
metadata
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#MetadataEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
metadata
+
+ + +
+
+ +
+

Operation

+
+ +Operational information of the product. + +
+
Name
+
operation
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#OperationEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
operation
+
+ + +
+
+ +
+

Sources

+
+ +Documents that are mandatory if applicable for the product. These are mentioned in the ESPR provisional agreement from January 9th, 2024 ANNEX III: +(e) compliance documentation and information required under this Regulation or other Union law applicable to the product, such as the declaration of conformity, technical documentation or conformity certificates; +(f) user manuals, instructions, warnings or safety information, as required by other Union legislation applicable to the product. +Additionally requirements are mentioned in Article 21: +7. Manufacturers shall ensure that a product covered by a delegated act adopted pursuant to Article 4 is accompanied by instructions in digital format that enable customers and other relevant actors to assemble, install, operate, store, maintain, repair and dispose of the product in a language that can be easily understood, as determined by the Member State concerned. Such instructions shall be clear, understandable and legible and include at least the information set out in Article 7(2), point (b), point (ii) specified in the delegated acts adopted pursuant to Article 4. +Article 7 states additionally: +(ii) information for customers and other actors on how to install, use, maintain and repair the product, in order to minimise its impact on the environment and to ensure optimum durability, on how to install third-party operating systems where relevant, as well as on collection for refurbishment or remanufacture, and on how to return or handle the product at the end of its life; +(2) (b) (iii) information for treatment facilities on disassembly, reuse, refurbishment, recycling, or disposal at end-of-life; +(2) (b) (iv) other information that may influence sustainable product choices for customers and the way the product is handled by parties other than the manufacturer in order to facilitate appropriate use, value retaining operations and correct treatment at end-of-life. +(5) (d) relevant instructions for the safe use of the product. +(5) (e) information relevant for disassembly, preparation for reuse, reuse, recycling and the environmentally sound management of the product at the end of its life. +Annex I: +(b) [...] availability of repair and maintenance instructions, number of materials and components used, use of standard components,[...] number and complexity of processes and whether specialised toolsare needed, ease of non-destructive disassembly and re-assembly, conditions for access to product data, conditions for access to or use of hardware and software needed; +(c) ease of upgrading, re-use, remanufacturing and refurbishment as expressed through: [...] number and complexity of processes and tools needed, ease of non-destructive disassembly and re-assembly, conditions for access to product data, conditions for access to or use of hardware and software needed, conditions of access to test protocols or not commonly available testing equipment, availability of guarantees specific to remanufactured or refurbished products, conditions for access to or use of technologies protected by intellectual property rights, modularity; +(d) design for recycling, ease and quality of recycling as expressed through: use of easily recyclable materials, safe, easy and non-destructive access to recyclable components and materials or components and materials containing hazardous substances and material composition and homogeneity, possibility for high-purity sorting, [...] number and complexity of processes and tools needed, ease of nondestructive disassembly and re-assembly, conditions for access to product data, conditions for access to or use of hardware and software needed; +(q) functional performance and conditions for use including as expressed through ability in performing its intended use, precautions of use, skills required, compatibility with other products or systems. +Additionally to consider are guidelines and instructions regarding the proper management and disposal of packaging materials after use. This can include instructions for separation, reuse, and recycling. + +
+
Name
+
sources
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#DocumentEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
sources
+
+ + +
+
+ +
+

Sustainability

+
+ +Sustainability related attributes. + +
+
Name
+
sustainability
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#SustainabilityEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
sustainability
+
+ + +
+
+ +
+

handling

+
+ +Properties connected with the handling of the product. + +
+
Name
+
handling
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#HandlingEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
handling
+
+ + +
+
+ + + +
+
+

Entities

+
+ +
+
+

Additional Data Entity

+
+
+ Entity with additional data. Properties are label, description, type, data and children. Either the fields data or children filled. Children constructs a hierarchy with the same attributes. Data is filled as the end of an path/leaf. +
+ +
+

Properties

+
+
+ +
+
Label
+
+ +The human readable name of the attribute. + +
+
Name
+
label
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Maximum permitted battery power
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
label
+
+ + +
+
+ +
+
Description
+
+ +The description of the attribute context. + +
+
Name
+
description
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Description of an attribute
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
description
+
+ + +
+
+ +
+
Type
+
+ +The complex description of the type. + +
+
Name
+
type
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#TypeEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
type
+
+ + +
+
+ +
+
Data
+
+ +The content from the attribute which is a depended of the data type and typeUnit. + +
+
Name
+
data
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
23
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
data
+
+ + +
+
+ +
+
children
+
+ +Children of the hierarchy. + +
+
Name
+
children
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#AdditionalDataEntity + +
+
+
+
+
+ + +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
children
+
+ + +
+
+
+
+

Characteristics Entity

+
+
+ Entity which defines specific characteristics of a product such as different life spans and physical dimensions. +
+ +
+

Properties

+
+
+ +
+
Lifespan
+
+ +The type of lifespan represented with the values guaranteed lifetime, technical lifetime and mean time between failures. Both can be described through the attributes: type, which defines the type such as guaranteed lifetime or technical lifetime, the unit for the lifetime, and the value represented by an integer. These attributes are mentioned in the ESPR proposal from March 30th, 2022 ANNEX I: +(a) durability and reliability of the product or its components as expressed through the products guaranteed lifetime, technical lifetime [or] mean time between failures [...]. + +
+
Name
+
lifespan
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#LifespanEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
lifespan
+
+ + +
+
+ +
+
Physical Dimension
+
+ +Physical dimensions are properties associated with physical quantities for purposes of classification or differentiation. These attributes are mentioned in the ESPR provisional agreement from January 9th, Article 7: +(2) (b) (i) information on the performance of the product in relation to one or more of the product parameters referred to in Annex I; +Annex I (i) weight and volume of the product and its packaging, and the product-to-packaging ratio. + +
+
Name
+
physicalDimension
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#PhysicalDimensionEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
physicalDimension
+
+ + +
+
+ +
+
Physical State
+
+ +The physical state of the item. There are four states of matter solid, liquid, gas and plasma which can be chosen from an enumeration. + +
+
Name
+
physicalState
+
+ + + +
+
Characteristic
+
+
+
+
Enumeration
+
+
+
Values
+
+
+
+
    +
  • solid
    • +
  • liquid
    • +
  • gas
    • +
  • plasma
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
solid
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
physicalState
+
+ + +
+
+ +
+
General Performance Class
+
+ +The performance class of the product. This attribute is mentioned ESPR provisional agreement from January 9th, 2024 Article 7: +4. When establishing the information requirements referred to in paragraph 2, point (b), point (i), the Commission shall, as appropriate in view of the specificity of the product group, determine classes of performance. Classes of performance may be based on single parameters, on aggregated scores, in absolute terms or in any other form that enables potential customers to choose the best performing products. Those classes of performance shall correspond to significant improvements in performance levels. Where classes of performance are based on parameters in relation to which performance requirements are established, they shall use as the minimum level the minimum performance required at the time when the classes of performance start to apply. +Definition: +'class of performance': means a range of performance levels in relation to one or more product parameters referred to in Annex I, based on a common methodology for the product or product group, ordered into successive steps to allow for product differentiation. + +
+
Name
+
generalPerformanceClass
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
A
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
generalPerformanceClass
+
+ + +
+
+
+
+

Chemical Material Entity

+
+
+ Material entity with attributes if applicable to the product. +
+ +
+

Properties

+
+
+ +
+
Applicable
+
+ +Check whether the connected attributes are applicable to the product. If it is not applicable (false), dummy data can be delivered. + +
+
Name
+
applicable
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#boolean + +
+
+
+
+
+ +
+
Example
+
true
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
applicable
+
+ + +
+
+ +
+
Material
+
+ +Information on different materials in the product. + +
+
Name
+
chemicalMaterial
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#MaterialEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
content
+
+ + +
+
+
+
+

ClassificationEntity

+
+
+ Encapsulates data related to the classification of the part. +
+ +
+

Properties

+
+
+ +
+
Classification Standard
+
+ +Identified classification standards that align to the Catena-X needs. + +
+
Name
+
classificationStandard
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
GIN 20510-21513
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
classificationStandard
+
+ + +
+
+ +
+
Classification ID
+
+ +The classification ID of the part type according to the corresponding standard definition mentioned in the key value pair. + +
+
Name
+
classificationID
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
1004712
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
classificationID
+
+ + +
+
+ +
+
Classification Description
+
+ +Optional property describing the classification standard. + +
+
Name
+
classificationDescription
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Generic standard for classification of parts in the automotive industry.
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
classificationDescription
+
+ + +
+
+
+
+

Code Entity

+
+
+ Code entity with code key and value. +
+ +
+

Properties

+
+
+ +
+
Code Key
+
+ +The code key for the identification of the product. Examples are GTIN, hash, DID, ISBN, TARIC. This attribute is mentioned in the ESPR proposal from March 30th, 2022 ANNEX III: +(b) the unique product identifier at the level indicated in the applicable delegated act adopted pursuant to Article 4; +(c) the Global Trade Identification Number as provided for in standard ISO/IEC 15459-6 or equivalent of products or their parts; +(d) relevant commodity codes, such as a TARIC code as defined in Council Regulation (EEC) No 2658/87. + +
+
Name
+
codeKey
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
TARIC
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
key
+
+ + +
+
+ +
+
Code Value
+
+ +The code value for the identification of the product in regard to the chosen code name. + +
+
Name
+
codeValue
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
8703 24 10 00
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
value
+
+ + +
+
+
+
+

Commercial Entity

+
+
+ Commercial information. +
+ +
+

Properties

+
+
+ +
+
Placed on Market
+
+ +The timestamp in the format (yyyy-mm-dd) with or without time zone when the product was put in the market. + +
+
Name
+
placedOnMarket
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
2000-01-01
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
placedOnMarket
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + Date Constraint +
    + +
    +
    Description
    +
    Constraint fo a timestamp in the format (yyyy-mm-dd).
    +
    + + +
    +
    Regular expression
    +
    ^\d{4}-\d{2}-\d{2}$
    +
    + +
    • +
+
+
+
+
+ +
+
Purpose
+
+ +One or more intended industry/industries of the product described by the digital product passport. If exchanged via Catena-X, 'automotive ' is a must choice included in the list. + +
+
Name
+
purpose
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
automotive
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
purpose
+
+ + +
+
+
+
+

Data Carrier Entity

+
+
+ Data Carrier Entity with type and layout of the data carrier. +
+ +
+

Properties

+
+
+ +
+
Carrier Type
+
+ +The type of data carrier such as a QR code on the product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 8: +(2) (b) the types of data carrier to be used. + +
+
Name
+
carrierType
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
QR
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
carrierType
+
+ + +
+
+ +
+
Carrier Layout
+
+ +The positioning of data carrier on the product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 8: +(2) (c) the layout in which the data carrier shall be presented and its positioning. + +
+
Name
+
carrierLayout
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
upper-left side
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
carrierLayout
+
+ + +
+
+
+
+

Document Entity

+
+
+ Document entity with header, content, category and type. +
+ +
+

Properties

+
+
+ +
+
Content
+
+ +The content of the document e.g a link. + +
+
Name
+
content
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
https://dummy.link
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
content
+
+ + +
+
+ +
+
Category
+
+ +The category in which the document can be sorted. These are mentioned in the ESPR proposal from March 30th, 2022 ANNEX III: +(e) compliance documentation and information required under this Regulation or other Union law applicable to the product, such as the declaration of conformity, technical documentation or conformity certificates; +ANNEX IV states additional information regarding the content of the technical documentation +Further information on documents are mentioned in the proposal from March 30th, 2022 ANNEX III: +(f) user manuals, instructions, warnings or safety information, as required by other Union legislation applicable to the product. +Additionally requirements are mentioned in Article 21: +(7) Manufacturers shall ensure that that a product covered by a delegated act adopted pursuant to Article 4 is accompanied by instructions that enable consumers and other end-users to safely assemble, install, operate, store, maintain, repair and dispose of the product in a language that can be easily understood by consumers and other end-users, as determined by the Member State concerned. Such instructions shall be clear, understandable and legible and include at least the information specified in the delegated acts adopted pursuant to Article 4 and pursuant to Article 7(2)(b), point (ii). +Article 7 states additionally: +(2) (b) (ii) information for consumers and other end-users on how to install, use, maintain and repair the product in order to minimize its impact on the environment and to ensure optimum durability, as well as on how to return or dispose of the product at end-of-life; +(2) (b) (iii) information for treatment facilities on disassembly, recycling, or disposal at end-of-life; +(2) (b) (iv) other information that may influence the way the product is handled by parties other than the manufacturer in order to improve performance in relation to product parameters referred to in Annex I. +(5) (d) relevant instructions for the safe use of the product. + +
+
Name
+
category
+
+ + + +
+
Characteristic
+
+
+
+
Enumeration
+
+
+
Values
+
+
+
+
    +
  • Product Specifications
    • +
  • Manufacturer Information
    • +
  • User Manuals and Guides
    • +
  • Certifications and Compliance
    • +
  • Product Images and Videos
    • +
  • Warranty Information
    • +
  • Reviews and Ratings
    • +
  • Product Variations
    • +
  • Supply Chain Information
    • +
  • Environmental Impact
    • +
  • Compatibility and Accessories
    • +
  • FAQs and Support
    • +
  • Purchase and Retail Information
    • +
  • Privacy and Data Handling
    • +
  • Third-Party Integrations
    • +
  • Legal Information
    • +
  • Safety Information
    • +
  • Repair and Installation
    • +
  • Waste Generation and Prevention
    • +
  • Specific Voluntary Labels
    • +
  • Product Packaging
    • +
  • Return and Disposal
    • +
  • End of Life
    • +
  • Material and Substance Information
    • +
  • Technical Documentation
    • +
  • Treatment facilities
    • +
  • Other
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Legal Information
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
category
+
+ + +
+
+ +
+
Content Type
+
+ +The type of content which can be expected in the "content" property. Examples are a link, restricted link, pdf, excel, etc. + +
+
Name
+
contentType
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
URL
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
type
+
+ + +
+
+ +
+
Header
+
+ +The header as a short description of the document with a maximum of 100 characters. + +
+
Name
+
header
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Example Document XYZ
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
header
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + Header Constraint +
    + +
    +
    Description
    +
    Constraint for a maximum of 100 characters.
    +
    + + +
    +
    Max. length
    +
    100
    +
    + +
    • +
+
+
+
+
+
+
+

Documentation Entity

+
+
+ Entity for a document with a header, type and content. +
+ +
+

Properties

+
+
+ +
+
Content
+
+ +The content of the document e.g a link. + +
+
Name
+
content
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
https://dummy.link
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
content
+
+ + +
+
+ +
+
Content Type
+
+ +The type of content which can be expected in the "content" property. Examples are a link, restricted link, pdf, excel, etc. + +
+
Name
+
contentType
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
URL
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
contentType
+
+ + +
+
+ +
+
Header
+
+ +The header as a short description of the document with a maximum of 100 characters. + +
+
Name
+
header
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Example Document XYZ
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
header
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + Header Constraint +
    + +
    +
    Description
    +
    Constraint for a maximum of 100 characters.
    +
    + + +
    +
    Max. length
    +
    100
    +
    + +
    • +
+
+
+
+
+
+
+

Facility Entity

+
+
+ The entity for a facility with the BPNA identifier. +
+ +
+

Properties

+
+
+ +
+
Facility
+
+ +The identifier used for a location. This attribute is mentioned in the ESPR provisional agreement from January 9th 2024 Annex III: +(i) unique facility identifiers; +Article 2 Definitions: (33) 'unique facility identifier' means a unique string of characters for the identification of locations or buildings involved in the value chain of a product or used by actors involved in the value chain of a product. + +
+
Name
+
facility
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
    +
  • https://catena-x.net/fileadmin/user_upload/Standard-Bibliothek/Update_PDF_Maerz/5_BPDM/CX_-_0010_BUSINESS_PARTNER_NUMBER_PlatformCapabilityBPDM_v_1.0.1.pdf
    • +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
BPNA1234567890AA
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
facility
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + BPNA Regular Expression +
    + +
    +
    Description
    +
    The provided regular expression ensures that the BPNA is composed of prefix 'BPNA', 10 digits and two alphanumeric letters.
    +
    + + +
    +
    Regular expression
    +
    ^BPNA[a-zA-Z0-9]{12}$
    +
    + +
    • +
+
+
+
+
+
+
+

Footprint Entity

+
+
+ Footprint Entity for the carbon and environmental footprint with the total value, unit, impact category type, lifecycle, rulebook, declaration, performance class and the facility. +
+ +
+

Properties

+
+
+ +
+
Footprint Value
+
+ +The value of the footprint of the product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Annex I: +(l) the environmental footprint of the product, expressed as a quantification, in accordance with the applicable delegated act, of a product's life cycle environmental impacts, whether in relation to one or more environmental impact categories or an aggregated set of impact categories; +(m) the carbon footprint of the product; +(ma) the material footprint of the product. + + +
+
Name
+
footprintValue
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#float + +
+
+
+
+
+ +
+
Example
+
12.678
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
value
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + Positive Range Constraint +
    + +
    +
    Description
    +
    Constraint for only positive values.
    +
    + + +
    +
    +>= +
    + DefaultScalarValue[value=0.0, typeUri='DefaultScalar[metaModelVersion=SAMM_2_1_0, urn='http://www.w3.org/2001/XMLSchema#float']'] +
    +
    + +
    • +
+
+
+
+
+ +
+
Footprint Rulebook
+
+ +The applied rulebook for the environmental footprint of the product. + +
+
Name
+
footprintRulebook
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#DocumentationEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
rulebook
+
+ + +
+
+ +
+
Footprint Lifecycle
+
+ +The lifecycle stage, to which the environmental footprint corresponds. These could be for example "raw material acquisition and pre-processing", "main product production", "distribution" or "end of life and recycling". + +
+
Name
+
footprintLifecycle
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
main product production
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
lifecycle
+
+ + +
+
+ +
+
Footprint Unit
+
+ +The unit of measurement of the environmental impact category. For each impact category a specific unit is used. If an aggregation is used, utilize the normalization and weighting methods used in the referenced rulebook. + +
+
Name
+
footprintUnit
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
kg CO2 / kWh
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
unit
+
+ + +
+
+ +
+
Footprint Type
+
+ +The type of the environmental footprint of the product. This could be one of the environmental impact categories. This attribute is mentioned in the ESPR provisional agreement from January 9th 2024 Article 7: +(2)(b)(i) information on the performance of the product in relation to one or more of the product parameters referred to in Annex I, including a scoring of reparability or durability, carbon footprint or environmental footprint; +Annex I: +(l) the environmental footprint of the product, expressed as a quantification, in accordance with the applicable delegated act, of a product's life cycle environmental impacts, whether in relation to one or more environmental impact categories or an aggregated set of impact categories. +(m) the carbon footprint of the product; +(ma) the material footprint of the product. + +
+
Name
+
footprintType
+
+ + + +
+
Characteristic
+
+
+
+
Enumeration
+
+
+
Values
+
+
+
+
    +
  • Climate Change Total
    • +
  • Climate Change Fossil
    • +
  • Climate Change Biogenic Removals and Emissions
    • +
  • Climate Change Land Use and Land Use Change
    • +
  • Ozone Depletion
    • +
  • Acidification
    • +
  • Eutrophication Aquatic Freshwater
    • +
  • Eutrophication Fresh Marine
    • +
  • Eutrophication Terrestrial
    • +
  • Photochemical Ozone Formation
    • +
  • Abiotic Depletion- Minerals and Metals
    • +
  • Fossil Fuels
    • +
  • Water Use
    • +
  • Particulate Matter Emissions
    • +
  • Ionizing Radiation, Human Health
    • +
  • Eco-Toxicity
    • +
  • Human Toxicity, Cancer Effects
    • +
  • Human Toxicity, Non-Cancer Effects
    • +
  • Land Use Related Impacts/Soil Quality
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Climate Change
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
type
+
+ + +
+
+ +
+
Performance Class
+
+ +The performance classification of the footprint. + +
+
Name
+
performanceClass
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
A
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
performanceClass
+
+ + +
+
+ +
+
Manufacturing Plant
+
+ +The manufacturing plant of the footprint in the specific lifecycle phase. + +
+
Name
+
manufacturingPlant
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#FacilityEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
manufacturingPlant
+
+ + +
+
+ +
+
Declaration
+
+ +The footprint declaration in the format of a link + +
+
Name
+
declaration
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#DocumentationEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
declaration
+
+ + +
+
+
+
+

Handling Entity

+
+
+ Entity to describe different aspects in relation with the handling of the product with attributes if applicable to the product. +
+ +
+

Properties

+
+
+ +
+
spareParts
+
+ +The list of spare parts available for the product from various suppliers. + +
+
Name
+
spareParts
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#SparePartEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
content
+
+ + +
+
+ +
+
Applicable
+
+ +Check whether the connected attributes are applicable to the product. If it is not applicable (false), dummy data can be delivered. + +
+
Name
+
applicable
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#boolean + +
+
+
+
+
+ +
+
Example
+
true
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
applicable
+
+ + +
+
+
+
+

Hazard Entity

+
+
+ Entity for the hazardous classification. +
+ +
+

Properties

+
+
+ +
+
Hazard Category
+
+ +The hazard category of the substance of concern. Defined in Article 2 of Regulation (EC) No 1272/2008 of the European Parliament and of the Council of 16 December 2008 on classification, labelling and packaging of substances and mixtures, amending and repealing Directives 67/548/EEC and 1999/45/EC, and amending Regulation (EC) No 1907/2006: +2. 'hazard category' means the division of criteria within each hazard class, specifying hazard severity. + +
+
Name
+
hazardCategory
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
category 1A
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
category
+
+ +
+
Reference
+
+
    +
  • https://eur-lex.europa.eu/legal-content/EN/TXT/?uri=CELEX:02008R1272-20231201
    • +
+
+
+ +
+
+ +
+
Hazard Class
+
+ +The hazard class of the substance of concern. Defined in Article 2 of Regulation (EC) No 1272/2008 of the European Parliament and of the Council of 16 December 2008 on classification, labelling and packaging of substances and mixtures, amending and repealing Directives 67/548/EEC and 1999/45/EC, and amending Regulation (EC) No 1907/2006: +1. 'hazard class' means the nature of the physical, health or environmental hazard. + +
+
Name
+
hazardClass
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Skin corrosion
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
class
+
+ +
+
Reference
+
+
    +
  • https://eur-lex.europa.eu/legal-content/EN/TXT/?uri=CELEX:02008R1272-20231201
    • +
+
+
+ +
+
+ +
+
Hazard Statement
+
+ +The hazard statement of the substance of concern. Defined in Article 2 of Regulation (EC) No 1272/2008 of the European Parliament and of the Council of 16 December 2008 on classification, labelling and packaging of substances and mixtures, amending and repealing Directives 67/548/EEC and 1999/45/EC, and amending Regulation (EC) No 1907/2006: +5. 'hazard statement' means a phrase assigned to a hazard class and category that describes the nature of the hazards of a hazardous substance or mixture, including, where appropriate, the degree of hazard. + +
+
Name
+
hazardStatement
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Causes severe skin burns and eye damage.
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
statement
+
+ +
+
Reference
+
+
    +
  • https://eur-lex.europa.eu/legal-content/EN/TXT/?uri=CELEX:02008R1272-20231201
    • +
+
+
+ +
+
+
+
+

Identification Entity

+
+
+ Entity with identification information of the product with part type information, local identifiers, other codes and the data carrier. +
+ +
+

Properties

+
+
+ +
+
Serial Information
+
+ +Identifier for a serial part if available. This is mentioned in the ESPR provisional agreement from January 9th, 2024 Recital (27): +[...] an 'item' usually means a single unit of a model. + +
+
Name
+
serialInformation
+
+ + + +
+
Characteristic
+
+
+
+
Set
+
+
+
Has no order
+
+
+
Duplicates not allowed
+
+
+
+ Type urn:samm:io.catenax.serial_part:3.0.0#KeyValueList + +
+
+
+
+
+ + +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
serial
+
+ + +
+
+ +
+
Batch Information
+
+ +Identifier for a batch part if available. Identifier for a serial part if available. This is mentioned in the ESPR provisional agreement from January 9th, 2024 Recital (27): +[...] a 'batch' usually means a subset of a specific model composed of all products produced in a specific manufacturing plant at a specific moment in time [...]. + +
+
Name
+
batchInformation
+
+ + + +
+
Characteristic
+
+
+
+
Set
+
+
+
Has no order
+
+
+
Duplicates not allowed
+
+
+
+ Type urn:samm:io.catenax.batch:3.0.0#KeyValueList + +
+
+
+
+
+ + +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
batch
+
+ + +
+
+ +
+
Part Type Information
+
+ +Identifier on the level of a part model or type. Identifier for a serial part if available. This is mentioned in the ESPR provisional agreement from January 9th, 2024 Recital (27): +[...] A 'model' usually means a version of a product of which all units share the same technical characteristics relevant for the ecodesign requirements and the same model identifier [...]. + +
+
Name
+
partTypeInformation
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#PartTypeEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
type
+
+ + +
+
+ +
+
Codes
+
+ +Codes for identification. + +
+
Name
+
codes
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#CodeEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
codes
+
+ + +
+
+ +
+
Data Carrier
+
+ +The type and layout of the data carrier on the product. These are mentioned in the ESPR proposal from March 30th, 2022 Article 8: +(b) the types of data carrier to be used; +(c) the layout in which the data carrier shall be presented and its positioning; +Article 2 defines: +(30) 'data carrier' means a linear bar code symbol, a two-dimensional symbol or other automatic identification data capture medium that can be read by a device. + +
+
Name
+
dataCarrier
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#DataCarrierEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
dataCarrier
+
+ + +
+
+ +
+
Part Classification
+
+ +Property describing the classification of a part. + +
+
Name
+
partClassification
+
+ + + +
+
Characteristic
+
+
+
+
SortedSet
+
+
+
Has a certain order
+
+
+
Duplicates not allowed
+
+
+
+ Type urn:samm:io.catenax.shared.part_classification:1.0.0#ClassificationEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
classification
+
+ + +
+
+
+
+

Import Entity

+
+
+ Import entity with attributes if applicable to the product. +
+ +
+

Properties

+
+
+ +
+
Importer
+
+ +Information regarding the importer of the product, if different from the owner of the passport. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex III: +(j) information related to the importer, including the information referred to in Article 23(3) and its EORI number; +Article 23 states: +(3) Importers shall, for products covered by a delegated act adopted pursuant to Article 4, indicate their name, registered trade name or registered trade mark and the postal address and electronic means of communication, where they can be contacted: (a) on the public part of the product passport, when applicable, and +(b) on the product or, where this is not possible, on the packaging, or in a document accompanying the product. + +
+
Name
+
importer
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#ImporterEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
content
+
+ + +
+
+ +
+
Applicable
+
+ +Check whether the connected attributes are applicable to the product. If it is not applicable (false), dummy data can be delivered. + +
+
Name
+
applicable
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#boolean + +
+
+
+
+
+ +
+
Example
+
true
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
applicable
+
+ + +
+
+
+
+

Importer Entity

+
+
+ Entity with information regarding the importer such as the identification and the EORI. +
+ +
+

Properties

+
+
+ +
+
EORI
+
+ +An economic operator established in the customs territory of the Union needs, for customs purposes, an EORI number. EORI stands for economic operators registration and identification number. In this case, the importer's EORI must be provided. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Annex III: +(j) information related to the importer, including the information referred to in Article 23(3) and its EORI number. + +
+
Name
+
eori
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
GB123456789000
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
eori
+
+ +
+
Reference
+
+
    +
  • https://taxation-customs.ec.europa.eu/customs-4/customs-procedures-import-and-export-0/customs-procedures/economic-operators-registration-and-identification-number-eori_en
    • +
+
+
+ +
+
Constraints
+
+
    +
  • +
    + +
    + EORI Constraint +
    + +
    +
    Description
    +
    Constraint with a pattern which ensures that the EORI number starts with two alphanumeric characters, followed by two alphabetic characters, and ends with 2 to 15 alphanumeric characters.
    +
    + + +
    +
    Regular expression
    +
    ^[A-Z]{2}[A-Z0-9]{1,18}$
    +
    + +
    • +
+
+
+
+
+ +
+
Importer Identification
+
+ +The importer of the product, if different from the owner of the passport. In the Catena-X network, the BPNL is used for the identification of companies and the information stored for this like contact information and addresses. +This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex III: +(j) information related to the importer, including the information referred to in Article 23(3) and its EORI number; +Article 23 states: +(3) Importers shall, for products covered by a delegated act adopted pursuant to Article 4, indicate their name, registered trade name or registered trade mark and the postal address and electronic means of communication, where they can be contacted: (a) on the public part of the product passport, when applicable, and +(b) on the product or, where this is not possible, on the packaging, or in a document accompanying the product. + +
+
Name
+
importerIdentification
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
    +
  • https://catena-x.net/fileadmin/user_upload/Standard-Bibliothek/Update_PDF_Maerz/5_BPDM/CX_-_0010_BUSINESS_PARTNER_NUMBER_PlatformCapabilityBPDM_v_1.0.1.pdf
    • +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
BPNL0123456789ZZ
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
id
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + BPNL Regular Expression +
    + +
    +
    Description
    +
    The provided regular expression ensures that the BPNL is composed of prefix 'BPNL', 10 digits and two alphanumeric letters.
    +
    + + +
    +
    Regular expression
    +
    ^BPNL[a-zA-Z0-9]{12}$
    +
    + +
    • +
+
+
+
+
+
+
+

Key Value List

+
+
+ A list of key value pairs for local identifiers, which are composed of a key and a corresponding value. +
+ +
+

Properties

+
+
+ +
+
Identifier Key
+
+ +The key of a local identifier. + +
+
Name
+
key
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
partInstanceId
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
key
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + Key Regular Expression +
    + +
    +
    Description
    +
    Constraint that ensures that the standard keys and custom key prefixes can be used.
    +
    + + +
    +
    Regular expression
    +
    ^(manufacturerId|partInstanceId|batchId|van|customKey:\w+)$
    +
    + +
    • +
+
+
+
+
+ +
+
Identifier Value
+
+ +The value of an identifier. + +
+
Name
+
value
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
SN12345678
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
value
+
+ + +
+
+
+
+

Key Value List

+
+
+ A list of key value pairs for local identifiers, which are composed of a key and a corresponding value. +
+ +
+

Properties

+
+
+ +
+
Identifier Key
+
+ +The key of a local identifier. + +
+
Name
+
key
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
batchId
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
key
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + Key Regular Expression +
    + +
    +
    Description
    +
    Constraint that ensures that the predefined keys are used.
    +
    + + +
    +
    Regular expression
    +
    ^(manufacturerId|batchId|customKey:\w+)$
    +
    + +
    • +
+
+
+
+
+ +
+
Identifier Value
+
+ +The value of an identifier. + +
+
Name
+
value
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
BID12345678
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
value
+
+ + +
+
+
+
+

Lifespan Entity

+
+
+ Entity for the lifespan of a product with type, unit and value. +
+ +
+

Properties

+
+
+ +
+
Life Unit
+
+ +The unit of the respective lifespan expressed through the possible units day, month, cycle, year and runningOrOperatingHour. + +
+
Name
+
lifeUnit
+
+ + + +
+
Characteristic
+
+
+
+
Enumeration
+
+
+
Values
+
+
+
+
    +
  • unit:day
    • +
  • unit:month
    • +
  • unit:year
    • +
  • unit:cycle
    • +
  • unit:runningOrOperatingHour
    • +
+
+
+
+
+ Reference +
+
    +
  • https://eclipse-esmf.github.io/samm-specification/2.1.0/index.html
    • +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
unit:month
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
unit
+
+ +
+
Reference
+
+
    +
  • https://eclipse-esmf.github.io/samm-specification/2.1.0/index.html
    • +
+
+
+ +
+
+ +
+
Life Value
+
+ +The value as an integer for the respective lifespan. + +
+
Name
+
lifeValue
+
+ + + +
+
Characteristic
+
+
+
+
Quantifiable
+
+
+
Duration
+
+
+
Characteristic for the life span value as an integer.
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#integer + +
+
+
+
+
+ +
+
Example
+
36
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
value
+
+ + +
+
+ +
+
Life Type
+
+ +The type of lifespan represented with the values guaranteed lifetime, technical lifetime and mean time between failures. This attribute is mentioned in the ESPR proposal from March 30th, 2022 ANNEX I: +(a) durability and reliability of the product or its components as expressed through the product's guaranteed lifetime, technical lifetime [or] mean time between failures [...]. + +
+
Name
+
lifeType
+
+ + + +
+
Characteristic
+
+
+
+
Enumeration
+
+
+
Values
+
+
+
+
    +
  • guaranteed lifetime
    • +
  • technical lifetime
    • +
  • mean time between failures
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
guaranteed lifetime
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
key
+
+ + +
+
+
+
+

Linear Entity

+
+
+ Entity for linear measurements of an item with an unit and value. +
+ +
+

Properties

+
+
+ +
+
Quantity Value
+
+ +The quantity value associated with the unit. + +
+
Name
+
quantityValue
+
+ + + +
+
Characteristic
+
+
+
+
Quantifiable
+
+
+
Duration
+
+
+
The quantity value associated with the unit expressed as float.
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#float + +
+
+
+
+
+ +
+
Example
+
20.0
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
value
+
+ + +
+
+ +
+
Linear Unit
+
+ +The unit of a linear attribute. + +
+
Name
+
linearUnit
+
+ + + +
+
Characteristic
+
+
+
+
Enumeration
+
+
+
Values
+
+
+
+
    +
  • unit:millimetre
    • +
  • unit:centimetre
    • +
  • unit:metre
    • +
  • unit:kilometre
    • +
  • unit:inch
    • +
  • unit:foot
    • +
  • unit:yard
    • +
+
+
+
+
+ Reference +
+
    +
  • https://eclipse-esmf.github.io/samm-specification/2.1.0/index.html
    • +
+
+
+
+
+
+ Type urn:samm:org.eclipse.esmf.samm:meta-model:2.1.0#curie + +
+
+
+
+
+ +
+
Example
+
unit:millimetre
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
unit
+
+ +
+
Reference
+
+
    +
  • https://eclipse-esmf.github.io/samm-specification/2.1.0/index.html
    • +
+
+
+ +
+
+
+
+

Manufacturer Entity

+
+
+ Manufacturing Entity with the identification of the main manufacturer and the facility location as well as the manufacturing date. +
+ +
+

Properties

+
+
+ +
+
Facility Identification
+
+ +The identifier used for a location. In the CATENA-X use case, the BPNA can be stated. This attribute is mentioned in the ESPR provisional agreement from January 9th 2024 Annex III: +(i) unique facility identifiers; +Article 2 Definitions: (33) 'unique facility identifier' means a unique string of characters for the identification of locations or buildings involved in the value chain of a product or used by actors involved in the value chain of a product. + +
+
Name
+
facilityIdentification
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#FacilityEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
facility
+
+ + +
+
+ +
+
Manufacturer Identification
+
+ +The main manufacturer, if different from the passport owner, represented by an identification number. In the Catena-X use case, the BPNL can be stated. This attribute is mentioned in the ESPR provisional agreement from January 9th 2024 Annex III: +(h) unique operator identifiers other than that of the manufacturer; +(k) the name, contact details and unique operator identifier code of the economic operator established in the Union responsible for carrying out the tasks set out in Article 4 of Regulation (EU) 2019/1020, or Article 15 of Regulation (EU) [.../...] on general product safety, or similar tasks pursuant to other EU legislation applicable to the product. + +
+
Name
+
manufacturerIdentification
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
    +
  • https://catena-x.net/fileadmin/user_upload/Standard-Bibliothek/Update_PDF_Maerz/5_BPDM/CX_-_0010_BUSINESS_PARTNER_NUMBER_PlatformCapabilityBPDM_v_1.0.1.pdf
    • +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
manufacturer
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + BPNL Regular Expression +
    + +
    +
    Description
    +
    The provided regular expression ensures that the BPNL is composed of prefix 'BPNL', 10 digits and two alphanumeric letters.
    +
    + + +
    +
    Regular expression
    +
    ^BPNL[a-zA-Z0-9]{12}$
    +
    + +
    • +
+
+
+
+
+ +
+
Manufacturing Date
+
+ +The timestamp in the format (yyyy-mm-dd) of the manufacturing date as the final step in production process (e.g. final quality check, ready-for-shipment event). + +
+
Name
+
manufacturingDate
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
2000-01-31
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
manufacturingDate
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + Date Constraint +
    + +
    +
    Description
    +
    Constraint fo a timestamp in the format (yyyy-mm-dd).
    +
    + + +
    +
    Regular expression
    +
    ^\d{4}-\d{2}-\d{2}$
    +
    + +
    • +
+
+
+
+
+
+
+

Mass Entity

+
+
+ Entity for mass measurements of an item with an unit and value. +
+ +
+

Properties

+
+
+ +
+
Quantity Value
+
+ +The quantity value associated with the unit. + +
+
Name
+
quantityValue
+
+ + + +
+
Characteristic
+
+
+
+
Quantifiable
+
+
+
Duration
+
+
+
The quantity value associated with the unit expressed as float.
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#float + +
+
+
+
+
+ +
+
Example
+
20.0
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
value
+
+ + +
+
+ +
+
Mass Unit
+
+ +The unit of a mass related attribute. + +
+
Name
+
massUnit
+
+ + + +
+
Characteristic
+
+
+
+
Enumeration
+
+
+
Values
+
+
+
+
    +
  • unit:gram
    • +
  • unit:kilogram
    • +
  • unit:tonneMetricTon
    • +
  • unit:tonUsOrShortTonUkorus
    • +
  • unit:ounceAvoirdupois
    • +
  • unit:pound
    • +
+
+
+
+
+ Reference +
+
    +
  • https://eclipse-esmf.github.io/samm-specification/2.1.0/index.html
    • +
+
+
+
+
+
+ Type urn:samm:org.eclipse.esmf.samm:meta-model:2.1.0#curie + +
+
+
+
+
+ +
+
Example
+
unit:kilogram
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
unit
+
+ +
+
Reference
+
+
    +
  • https://eclipse-esmf.github.io/samm-specification/2.1.0/index.html
    • +
+
+
+ +
+
+
+
+

Material Entity

+
+
+ Information regarding recycled and/or renewable materials in the product. +
+ +
+

Properties

+
+
+ +
+
Recycled
+
+ +The share of the material, which is recovered recycled content from the product. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I: +(h) use or content of recycled materials and recovery of materials, including critical raw materials; + +
+
Name
+
recycled
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#float + +
+
+
+
+
+ +
+
Example
+
12.5
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
recycled
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + Percentage Constraint +
    + +
    +
    Description
    +
    Range constraint for a positive percentage value.
    +
    + + +
    +
    +>= +
    + DefaultScalarValue[value=0.0, typeUri='DefaultScalar[metaModelVersion=SAMM_2_1_0, urn='http://www.w3.org/2001/XMLSchema#float']'] +
    +
    ...
    +
    +< + DefaultScalarValue[value=100.0, typeUri='DefaultScalar[metaModelVersion=SAMM_2_1_0, urn='http://www.w3.org/2001/XMLSchema#float']'] +
    + +
    • +
+
+
+
+
+ +
+
Renewable
+
+ +The share of the material, which is from a renewable resource that can be replenished. Renewable resources are those that can be reproduced by physical, chemical, or mechanical processes. These are the kind of resources that can be regenerated throughout time. Forest wood, for example, can be grown through reforestation. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I: +(ha) use or content of sustainable renewable materials; + + +
+
Name
+
renewable
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#float + +
+
+
+
+
+ +
+
Example
+
23.5
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
renewable
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + Percentage Constraint +
    + +
    +
    Description
    +
    Range constraint for a positive percentage value.
    +
    + + +
    +
    +>= +
    + DefaultScalarValue[value=0.0, typeUri='DefaultScalar[metaModelVersion=SAMM_2_1_0, urn='http://www.w3.org/2001/XMLSchema#float']'] +
    +
    ...
    +
    +< + DefaultScalarValue[value=100.0, typeUri='DefaultScalar[metaModelVersion=SAMM_2_1_0, urn='http://www.w3.org/2001/XMLSchema#float']'] +
    + +
    • +
+
+
+
+
+ +
+
Material Unit
+
+ +The unit of concentration chosen from an enumeration: mass percent, volume percent, parts per thousand, parts per million, parts per billion and parts per trillion. + +
+
Name
+
materialUnit
+
+ + + +
+
Characteristic
+
+
+
+
Enumeration
+
+
+
Values
+
+
+
+
    +
  • unit:partPerMillion
    • +
  • unit:percent
    • +
  • unit:percentVolume
    • +
  • unit:partPerThousand
    • +
  • unit:partPerTrillionUs
    • +
  • unit:partPerBillionUs
    • +
+
+
+
+
+ Reference +
+
    +
  • https://eclipse-esmf.github.io/samm-specification/2.1.0/index.html
    • +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
unit:percent
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
unit
+
+ +
+
Reference
+
+
    +
  • https://eclipse-esmf.github.io/samm-specification/2.1.0/index.html
    • +
+
+
+ +
+
+ +
+
Material Identification
+
+ +The chemical material name and identification, in accordance with the specification in the attribute for the list type. Preference is given to the IUPAC name. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Article 7: +(5) (a) the name of the substances of concern present in the product, as follows: + - name(s) in the International Union of Pure and Applied Chemistry (IUPAC) nomenclature, or another international name when IUPAC name is not available; +- other names (usual name, trade name, abbreviation); +- European Community (EC) number, as indicated in the European Inventory of Existing Commercial Chemical Substances (EINECS), the European List of Notified Chemical Substances (ELINCS) or the No Longer Polymer (NLP) list or assigned by the European Chemicals Agency (ECHA), if available; +- the Chemical Abstract Service (CAS) name(s) and number(s), if available; . + +
+
Name
+
materialIdentification
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#MaterialIdEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
id
+
+ + +
+
+ +
+
Critical
+
+ +A flag, if the material is a critical raw material. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I: +(h) use or content of recycled materials and recovery of materials, including critical raw materials; +In Annex II of the connected proposal Act of Critical Raw Materials, a list of critical raw materials can be found. + +
+
Name
+
critical
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#boolean + +
+
+
+
+
+ +
+
Example
+
true
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
critical
+
+ +
+
Reference
+
+
    +
  • https://eur-lex.europa.eu/legal-content/EN/TXT/?uri=COM:2023:0160:FIN
    • +
+
+
+ +
+
+ +
+
Concentration
+
+ +Concentration of the material at the level of the product. This attribute is specially mentioned for substances of concern mentioned in the ESPR proposal from March 30th, 2022 Article 7: +(5) (c) the concentration, maximum concentration or concentration range of the substances of concern, at the level of the product [...]. +Other substances are mentioned for the purpose of recycling in the ESPR provisional agreement from January 9th, 2024 Annex I: +(d) design for recycling, ease and quality of recycling as expressed through: use of easily recyclable materials, safe, easy and non-destructive access to recyclable components and materials or components and materials containing hazardous substances and material composition and homogeneity, possibility for high-purity sorting, number of materials and components used, use of standard components, use of component and material coding standards for the identification of components and materials, number and complexity of processes and tools needed, ease of nondestructive disassembly and re-assembly, conditions for access to product data, conditions for access to or use of hardware and software needed. + + +
+
Name
+
concentration
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#float + +
+
+
+
+
+ +
+
Example
+
5.3
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
concentration
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + Positive Range Constraint +
    + +
    +
    Description
    +
    Constraint for only positive values.
    +
    + + +
    +
    +>= +
    + DefaultScalarValue[value=0.0, typeUri='DefaultScalar[metaModelVersion=SAMM_2_1_0, urn='http://www.w3.org/2001/XMLSchema#float']'] +
    +
    + +
    • +
+
+
+
+
+ +
+
Documentation
+
+ +Documentation accompanying the material. + +
+
Name
+
documentation
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#DocumentationEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
documentation
+
+ + +
+
+
+
+

Material Id Entity

+
+
+ Id Entity with identifier, name and list type. +
+ +
+

Properties

+
+
+ +
+
Chemical Id
+
+ +The substance identification, in accordance with the specification in the attribute for the list type. + +
+
Name
+
chemicalId
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
201-004-7
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
id
+
+ + +
+
+ +
+
List Type Id
+
+ +The type of standard used for the identification of the substances. Selected can be for example CAS, IUPAC or EC. + +
+
Name
+
listTypeId
+
+ + + +
+
Characteristic
+
+
+
+
Enumeration
+
+
+
Values
+
+
+
+
    +
  • CAS
    • +
  • EC
    • +
  • IUPAC
    • +
+
+
+
+
+ Reference +
+
    +
  • https://www.cas.org/cas-data/cas-registry
    • +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
CAS
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
type
+
+ + +
+
+ +
+
Chemical Name
+
+ +The name of the material which is present in the product. + +
+
Name
+
chemicalName
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
phenolphthalein
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
name
+
+ + +
+
+
+
+

Materials Entity

+
+
+ Entity with materials on the level of the product. +
+ +
+

Properties

+
+
+ +
+
Substances of Concern
+
+ +Information regarding substances of concern in the product. The ESPR provisional agreement from January 9th, 2024 defines: +(52) 'hazardous substance' means a substance classified as hazardous pursuant to Article 3 of Regulation (EC) No 1272/2008. + +
+
Name
+
substancesOfConcern
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#SubstanceOfConcernEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
substancesOfConcern
+
+ + +
+
+ +
+
Material Composition
+
+ +Material composition of the product with information on recycled and renewable materials. + +
+
Name
+
materialComposition
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#ChemicalMaterialEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
materialComposition
+
+ + +
+
+
+
+

Metadata Entity

+
+
+ Passport Entity to describe version, status, end and issue date. +
+ +
+

Properties

+
+
+ +
+
Version
+
+ +The current version of the product passport. The possibility of modification/ updating the product passport needs to include versioning of the dataset. This attribute is an internal versioning from the passport issuer. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Article 8: +(1) [...] The information in the product passport shall be accurate, complete, and up to date. + +
+
Name
+
version
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
1.0.0
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
version
+
+ + +
+
+ +
+
Status
+
+ +The current status of the product passport declared through either: draft, approved, invalid or expired. + +
+
Name
+
status
+
+ + + +
+
Characteristic
+
+
+
+
Enumeration
+
+
+
Values
+
+
+
+
    +
  • draft
    • +
  • approved
    • +
  • invalid
    • +
  • expired
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
draft
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
status
+
+ + +
+
+ +
+
Expiration Date
+
+ +The timestamp in the format (yyyy-mm-dd) for the product passport until when it is available or a comment describing this period. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Article 8: +(2) (h) the period during which the product passport is to remain available, which shall correspond to at least the expected lifetime of a specific product. + +
+
Name
+
expirationDate
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
2030-01-01
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
expirationDate
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + Date Constraint +
    + +
    +
    Description
    +
    Constraint fo a timestamp in the format (yyyy-mm-dd).
    +
    + + +
    +
    Regular expression
    +
    ^\d{4}-\d{2}-\d{2}$
    +
    + +
    • +
+
+
+
+
+ +
+
Issue Date
+
+ +The timestamp in the format (yyyy-mm-dd) since when the product passport is available. + +
+
Name
+
issueDate
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
2000-01-01
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
issueDate
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + Date Constraint +
    + +
    +
    Description
    +
    Constraint fo a timestamp in the format (yyyy-mm-dd).
    +
    + + +
    +
    Regular expression
    +
    ^\d{4}-\d{2}-\d{2}$
    +
    + +
    • +
+
+
+
+
+ +
+
Economic Operator Id
+
+ +The identification of the owner/economic operator of the passport. Proposed, according to ISO 15459, is the CIN (company identification code). Other identification numbers like the tax identification number, value added tax identification number, commercial register number and the like are also valid entries. In the Catena-X network, the BPNL is used for the identification of companies and the information stored like contact information and addresses. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Annex III: +(k) the [...] unique operator identifier code of the economic operator established in the Union responsible for carrying out the tasks set out in Article 4 of Regulation (EU) 2019/1020, or Article 15 of Regulation (EU) on general product safety, or similar tasks pursuant to other EU legislation applicable to the product. + +
+
Name
+
economicOperatorId
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
    +
  • https://catena-x.net/fileadmin/user_upload/Standard-Bibliothek/Update_PDF_Maerz/5_BPDM/CX_-_0010_BUSINESS_PARTNER_NUMBER_PlatformCapabilityBPDM_v_1.0.1.pdf
    • +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
BPNL0123456789ZZ
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
economicOperatorId
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + BPNL Regular Expression +
    + +
    +
    Description
    +
    The provided regular expression ensures that the BPNL is composed of prefix 'BPNL', 10 digits and two alphanumeric letters.
    +
    + + +
    +
    Regular expression
    +
    ^BPNL[a-zA-Z0-9]{12}$
    +
    + +
    • +
+
+
+
+
+ +
+
Passport Identifier
+
+ +The identifier of the product passport, which is an uuidv4. + +
+
Name
+
passportIdentifier
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
    +
  • https://tools.ietf.org/html/rfc4122
    • +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
urn:uuid:550e8400-e29b-41d4-a716-446655440000
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
passportIdentifier
+
+ + +
+
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
    +
    (^[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}$)
    +
    + +
    • +
+
+
+
+
+ +
+
Predecessor
+
+ +Identification of the preceding product passport. If there is no preceding passport, input a dummy value. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Article 8: +(2)(g) [...] Any new product passport shall be linked to the product passport or passports of the original product whenever appropriate. + +
+
Name
+
predecessor
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
    +
  • https://tools.ietf.org/html/rfc4122
    • +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
urn:uuid:00000000-0000-0000-0000-000000000000
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
predecessor
+
+ + +
+
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
    +
    (^[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}$)
    +
    + +
    • +
+
+
+
+
+ +
+
Backup Reference
+
+ +A reference to the data backup of the passport. This mandatory attribute will be further defined in the future. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex III: +(kb) the reference of the certified independent third-party product passport service provider hosting the back-up copy of the product passport. +Article 10 also mentions: +(c) the data included in the product passport shall be stored by the economic operator responsible for its creation or by certified independent third-party product passport service providers authorised to act on their behalf. + +
+
Name
+
backupReference
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
https://dummy.link
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
backupReference
+
+ + +
+
+ +
+
Registration Identifier
+
+ +Identifier in the respective registry. This will be further defined in the future. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 in Article 12: +By [2 years from entering into force of this Regulation], the Commission shall set up and manage a digital registry ("the registry") storing in a secure manner at least the unique product identifier, the unique operator identifier, the unique facility identifiers. In case of products intended to be placed under the customs procedure 'release for free circulation', the registry shall also store the product commodity code. The registry shall also store the batteries' unique identifiers referred to in Article 77(3) of Regulation (EU) 2023/1542. + +
+
Name
+
registrationIdentifier
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
https://dummy.link/ID8283746239078
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
registrationIdentifier
+
+ + +
+
+ +
+
Last Modification
+
+ +Date of the latest modification. + +
+
Name
+
lastModification
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
2000-01-01
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
lastModification
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + Date Constraint +
    + +
    +
    Description
    +
    Constraint fo a timestamp in the format (yyyy-mm-dd).
    +
    + + +
    +
    Regular expression
    +
    ^\d{4}-\d{2}-\d{2}$
    +
    + +
    • +
+
+
+
+
+
+
+

Operation Entity

+
+
+ Operational information of the product such as the owner, manufacturer and importer. +
+ +
+

Properties

+
+
+ +
+
Manufacturer
+
+ +Manufacturing information of the product. In the CATENA-X use case, the BPNL and BPNA can be stated. These attributes are mentioned in the ESPR provisional agreement from January 9th 2024 Annex III: +(h) unique operator identifiers other than that of the manufacturer; +(k) the name, contact details and unique operator identifier code of the economic operator established in the Union responsible for carrying out the tasks set out in Article 4 of Regulation (EU) 2019/1020, or Article 15 of Regulation (EU) [.../...] on general product safety, or similar tasks pursuant to other EU legislation applicable to the product. + +
+
Name
+
manufacturer
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#ManufacturerEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
manufacturer
+
+ + +
+
+ +
+
Import
+
+ +Importer details such as the identification. + +
+
Name
+
import
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#ImportEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
import
+
+ + +
+
+ +
+
Other Operators
+
+ +Other operators relevant for the product. + +
+
Name
+
otherOperators
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#OperatorEntity + +
+
+
+
+
+ + +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
other
+
+ + +
+
+
+
+

Operator Entity

+
+
+ Operator with role and identification. +
+ +
+

Properties

+
+
+ +
+
Other Operator Id
+
+ +Identifier of the other operator. This can be a BPN. + +
+
Name
+
otherOperatorId
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
BPNL0123456789XX
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
id
+
+ + +
+
+ +
+
Other Operator Role
+
+ +Role of the other operator. + +
+
Name
+
otherOperatorRole
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
distributor
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
role
+
+ + +
+
+
+
+

Part Type Entity

+
+
+ Entity for the part type with manufacturer id and name. +
+ +
+

Properties

+
+
+ +
+
Manufacturer Part ID
+
+ +Part ID as assigned by the manufacturer of the part. The part ID identifies the part in the manufacturer`s dataspace. The part ID references a specific version of a part. The version number must be included in the part ID if it is available. The part ID does not reference a specific instance of a part and must not be confused with the serial number. + +
+
Name
+
manufacturerPartId
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
123-0.740-3434-A
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
manufacturerPartId
+
+ + +
+
+ +
+
Name at manufacturer
+
+ +Name of the part as assigned by the manufacturer. + +
+
Name
+
nameAtManufacturer
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Mirror left
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
nameAtManufacturer
+
+ + +
+
+
+
+

Parts Entity

+
+
+ Possible spare parts of the product with identifiers and names. +
+ +
+

Properties

+
+
+ +
+
Manufacturer Part ID
+
+ +Part ID as assigned by the manufacturer of the part. The part ID identifies the part in the manufacturer`s dataspace. The part ID references a specific version of a part. The version number must be included in the part ID if it is available. The part ID does not reference a specific instance of a part and must not be confused with the serial number. + +
+
Name
+
manufacturerPartId
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
123-0.740-3434-A
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
manufacturerPartId
+
+ + +
+
+ +
+
Name at manufacturer
+
+ +Name of the part as assigned by the manufacturer. + +
+
Name
+
nameAtManufacturer
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Mirror left
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
nameAtManufacturer
+
+ + +
+
+
+
+

Physical Dimension Entity

+
+
+ Entity for physical dimensions with linear, mass and capacity attributes. Either weight or volume is mandatory. +
+ +
+

Properties

+
+
+ +
+
Width
+
+ +The width of the item measured in a specific linear unit which can be declared in the corresponding unit attribute. + +
+
Name
+
width
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.shared.quantity:2.0.0#LinearEntity + +
+
+
+
+
+ + +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
width
+
+ + +
+
+ +
+
Length
+
+ +The length of the item measured in a specific linear unit which can be declared in the corresponding unit attribute. + +
+
Name
+
length
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.shared.quantity:2.0.0#LinearEntity + +
+
+
+
+
+ + +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
length
+
+ + +
+
+ +
+
Diameter
+
+ +The diameter of the item, if applicable, measured in a specific linear unit which can be declared in the corresponding unit attribute. + +
+
Name
+
diameter
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.shared.quantity:2.0.0#LinearEntity + +
+
+
+
+
+ + +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
diameter
+
+ + +
+
+ +
+
Height
+
+ +The height of the item measured in a specific linear unit which can be declared in the corresponding unit attribute. + +
+
Name
+
height
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.shared.quantity:2.0.0#LinearEntity + +
+
+
+
+
+ + +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
height
+
+ + +
+
+ +
+
Gross Weight
+
+ +The gross weight of the item measured in a specific mass unit which can be declared in the corresponding unit attribute. Gross weight refers to the total weight of a product, including the weight of the packaging. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7: +(2) (b) (i) information on the performance of the product in relation to the product parameters referred to in Annex I; +Annex I (i) weight and volume of the product and its packaging, and the product-to-packaging ratio. + +
+
Name
+
grossWeight
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.shared.quantity:2.0.0#MassEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
grossWeight
+
+ + +
+
+ +
+
Gross Volume
+
+ +The gross volume of the item, if possible, measured in a specific capacity unit which can be declared in the corresponding unit attribute. If there is no separate packing, the volume of the product shall be given. Gross volume refers to the total volume of a product, including the volume of the packaging. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7: +(2) (b) (i) information on the performance of the product in relation to the product parameters referred to in Annex I; +Annex I (i) weight and volume of the product and its packaging, and the product-to-packaging ratio. + +
+
Name
+
grossVolume
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.shared.quantity:2.0.0#VolumeEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
grossVolume
+
+ + +
+
+ +
+
Weight
+
+ +Weight of the product measured in a specific mass unit which can be declared in the corresponding unit attribute. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7: +(2) (b) (i) information on the performance of the product in relation to the product parameters referred to in Annex I; +Annex I (i) weight and volume of the product [...]. + +
+
Name
+
weight
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.shared.quantity:2.0.0#MassEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
weight
+
+ + +
+
+ +
+
Volume
+
+ +Volume of the product, if possible, measured in a specific capacity unit which can be declared in the corresponding unit attribute. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7: +(2) (b) (i) information on the performance of the product in relation to the product parameters referred to in Annex I; +Annex I (i) weight and volume of the product [...]. + +
+
Name
+
volume
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.shared.quantity:2.0.0#VolumeEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
volume
+
+ + +
+
+
+
+

Product Footprint Entity

+
+
+ The Product Footprint Entity with sustainability information such as the different environmental footprint types, the carbon and material footprint explicitly, applicable rules and lifecycle stages. +
+ +
+

Properties

+
+
+ +
+
Environmental Footprint
+
+ +The environmental footprint of the product. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I: +The following parameters shall, as appropriate, and where necessary supplemented by others, be used, individually or combined, as a basis for improving the product aspects referred to in Article 5(1): +(l) the environmental footprint of the product, expressed as a quantification, in accordance with the applicable delegated act, of a product's life cycle environmental impacts, whether in relation to one or more environmental impact categories or an aggregated set of impact categories. +and Article 7: +(2)(b)(i) information on the performance of the product in relation to one or more of the product parameters referred to in Annex I, including a scoring of reparability or durability, carbon footprint or environmental footprint; +and defined by Article 2: +(23) 'environmental footprint' means a quantification of product environmental impacts throughout its life cycle, whether in relation to a single environmental impact category or an aggregated set of impact categories based on the Product Environmental Footprint method or other scientific methods developed by international organisations and widely tested in collaboration with different industry sectors and adopted or implemented by the Commission in other Union legislation; +(24) 'Product Environmental Footprint method' means the life cycle assessment method to quantify the environmental impacts of products established by Recommendation (EU) 2021/2279. + +
+
Name
+
environmentalFootprint
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#FootprintEntity + +
+
+
+
+
+ + +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
environmental
+
+ + +
+
+ +
+
Carbon Footprint
+
+ +The carbon footprint of the product. This is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I: +The following parameters shall, as appropriate, and where necessary supplemented by others, be used, individually or combined, as a basis for improving the product aspects referred to in Article 5(1): +(m) the carbon footprint of the product; +and Article 7: +(2)(b)(i) information on the performance of the product in relation to one or more of the product parameters referred to in Annex I, including a scoring of reparability or durability, carbon footprint or environmental footprint; +and defined by Article 2: +(25) 'carbon footprint' means the sum of greenhouse gas (GHG) emissions and GHG removals in a product system, expressed as CO2 equivalents and based on a life cycle assessment using the single impact category of climate change. + +
+
Name
+
carbonFootprint
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#FootprintEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
carbon
+
+ + +
+
+ +
+
Material Footprint
+
+ +The material footprint of the product. This is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I: +(ma) the material footprint of the product; +and defined by Article 2: +(25a) 'material footprint' refers to the total amount of raw materials extracted to meet final consumption demands. + +
+
Name
+
materialFootprint
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#FootprintEntity + +
+
+
+
+
+ + +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
material
+
+ + +
+
+
+
+

Range Entity

+
+
+ Entity for the concentration range with two values, the highest and the lowest of the concentration range. +
+ +
+

Properties

+
+
+ +
+
Minimum Concentration
+
+ +The minimum concentration of the substance of concern at the level of the product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7: +(5) (c) [...] concentration range of the substances of concern, at the level of the product [...]. + +
+
Name
+
minConcentration
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#float + +
+
+
+
+
+ +
+
Example
+
2.1
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
min
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + Positive Range Constraint +
    + +
    +
    Description
    +
    Constraint for only positive values.
    +
    + + +
    +
    +>= +
    + DefaultScalarValue[value=0.0, typeUri='DefaultScalar[metaModelVersion=SAMM_2_1_0, urn='http://www.w3.org/2001/XMLSchema#float']'] +
    +
    + +
    • +
+
+
+
+
+ +
+
Maximum Concentration
+
+ +The maximum concentration of the substance of concern at the level of the product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7: +(5) (c) the concentration, maximum concentration or concentration range of the substances of concern, at the level of the product [...]. + +
+
Name
+
maxConcentration
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#float + +
+
+
+
+
+ +
+
Example
+
2.6
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
max
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + Positive Range Constraint +
    + +
    +
    Description
    +
    Constraint for only positive values.
    +
    + + +
    +
    +>= +
    + DefaultScalarValue[value=0.0, typeUri='DefaultScalar[metaModelVersion=SAMM_2_1_0, urn='http://www.w3.org/2001/XMLSchema#float']'] +
    +
    + +
    • +
+
+
+
+
+
+
+

Sources Entity

+
+
+ Entity for a possible spare part sources. +
+ +
+

Properties

+
+
+ +
+
Sources Identification
+
+ +The identifier of a spare part producer of the product. In the Catena-X network, the BPNL is used for the identification of companies and the information stored for this like contact information and addresses. + +
+
Name
+
sourcesIdentification
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
    +
  • https://catena-x.net/fileadmin/user_upload/Standard-Bibliothek/Update_PDF_Maerz/5_BPDM/CX_-_0010_BUSINESS_PARTNER_NUMBER_PlatformCapabilityBPDM_v_1.0.1.pdf
    • +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
BPNL0123456789ZZ
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
id
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + BPNL Regular Expression +
    + +
    +
    Description
    +
    The provided regular expression ensures that the BPNL is composed of prefix 'BPNL', 10 digits and two alphanumeric letters.
    +
    + + +
    +
    Regular expression
    +
    ^BPNL[a-zA-Z0-9]{12}$
    +
    + +
    • +
+
+
+
+
+
+
+

Spare Part Entity

+
+
+ Information regarding possible spare parts. This is mentioned in the ESPR proposal from March 30th, 2022 Annex I: +(b) ease of repair and maintenance as expressed through: characteristics, availability and delivery time of spare parts, modularity, compatibility with commonly available spare parts, availability of repair and maintenance instructions, number of materials and components used, use of standard components, use of component and material coding standards for the identification of components and materials, number and complexity of processes and tools needed, ease of non-destructive disassembly and re-assembly, conditions for access to product data, conditions for access to or use of hardware and software needed; +(c) the Global Trade Identification Number as provided for in standard ISO/IEC 15459-6 or equivalent of products or their parts. +
+ +
+

Properties

+
+
+ +
+
Spare Part Sources
+
+ +Sources of possible spare parts. + +
+
Name
+
sparePartSources
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#SourcesEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
producer
+
+ + +
+
+ +
+
Spare Part
+
+ +Possible spare parts of the product. + +
+
Name
+
sparePart
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#PartsEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
sparePart
+
+ + +
+
+
+
+

Substance Entity

+
+
+ Information regarding substances of concern in the product. +
+ +
+

Properties

+
+
+ +
+
Location
+
+ +The location of the substances of concern within the product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7: +(5) (b) the location of the substances of concern within the product. + +
+
Name
+
location
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Housing
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
location
+
+ + +
+
+ +
+
Material Unit
+
+ +The unit of concentration chosen from an enumeration: mass percent, volume percent, parts per thousand, parts per million, parts per billion and parts per trillion. + +
+
Name
+
materialUnit
+
+ + + +
+
Characteristic
+
+
+
+
Enumeration
+
+
+
Values
+
+
+
+
    +
  • unit:partPerMillion
    • +
  • unit:percent
    • +
  • unit:percentVolume
    • +
  • unit:partPerThousand
    • +
  • unit:partPerTrillionUs
    • +
  • unit:partPerBillionUs
    • +
+
+
+
+
+ Reference +
+
    +
  • https://eclipse-esmf.github.io/samm-specification/2.1.0/index.html
    • +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
unit:percent
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
unit
+
+ +
+
Reference
+
+
    +
  • https://eclipse-esmf.github.io/samm-specification/2.1.0/index.html
    • +
+
+
+ +
+
+ +
+
Concentration
+
+ +Concentration of the material at the level of the product. This attribute is specially mentioned for substances of concern mentioned in the ESPR proposal from March 30th, 2022 Article 7: +(5) (c) the concentration, maximum concentration or concentration range of the substances of concern, at the level of the product [...]. +Other substances are mentioned for the purpose of recycling in the ESPR provisional agreement from January 9th, 2024 Annex I: +(d) design for recycling, ease and quality of recycling as expressed through: use of easily recyclable materials, safe, easy and non-destructive access to recyclable components and materials or components and materials containing hazardous substances and material composition and homogeneity, possibility for high-purity sorting, number of materials and components used, use of standard components, use of component and material coding standards for the identification of components and materials, number and complexity of processes and tools needed, ease of nondestructive disassembly and re-assembly, conditions for access to product data, conditions for access to or use of hardware and software needed. + + +
+
Name
+
concentration
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#float + +
+
+
+
+
+ +
+
Example
+
5.3
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
concentration
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + Positive Range Constraint +
    + +
    +
    Description
    +
    Constraint for only positive values.
    +
    + + +
    +
    +>= +
    + DefaultScalarValue[value=0.0, typeUri='DefaultScalar[metaModelVersion=SAMM_2_1_0, urn='http://www.w3.org/2001/XMLSchema#float']'] +
    +
    + +
    • +
+
+
+
+
+ +
+
Exemption
+
+ +Exemptions to the substance of concern. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Article 7: +(5) (c) provide duly justified exemptions for substances of concern or information elements from the information requirements referred to in the first subparagraph based on the technical feasibility or relevance of tracking substances of concern, the existence of analytical methods to detect and quantify them, the need to protect confidential business information or in other duly justified cases. Substances of concern within the meaning of Article 2(28), point a), shall not be exempted if they are present in products, their relevant components or spare parts in a concentration above 0,1 % weight by weight. + +
+
Name
+
exemption
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
shall not apply to product x containing not more than 1,5 ml of liquid
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
exemption
+
+ + +
+
+ +
+
Hazard Classification
+
+ +The specification of the hazard class. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I: +(f) use of substances, and in particular the use of substances of concern, on their own, as constituents of substances or in mixtures, during the production process of products, or leading to their presence in products, including once these products become waste, and their impacts on human health and the environment; +Further defined is this by Regulation (EC) No 1272/2008 of the European Parliament and of the Council of 16 December 2008 on classification, labelling and packaging of substances and mixtures, amending and repealing Directives 67/548/EEC and 1999/45/EC, and amending Regulation (EC) No 1907/2006. +Defined in Article 2: +1. 'hazard class' means the nature of the physical, health or environmental hazard; +2. 'hazard category' means the division of criteria within each hazard class, specifying hazard severity; +5. 'hazard statement' means a phrase assigned to a hazard class and category that describes the nature of the hazards of a hazardous substance or mixture, including, where appropriate, the degree of hazard; + +
+
Name
+
hazardClassification
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#HazardEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
hazardClassification
+
+ +
+
Reference
+
+
    +
  • https://eur-lex.europa.eu/legal-content/EN/TXT/?uri=CELEX:02008R1272-20231201
    • +
+
+
+ +
+
+ +
+
Concentration Range
+
+ +The concentration range for the substance of concern. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7: +(5) (c) [...] concentration range of the substances of concern, at the level of the product [...]. + +
+
Name
+
concentrationRange
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#RangeEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
concentrationRange
+
+ + +
+
+ +
+
Material Identification
+
+ +The chemical material name and identification, in accordance with the specification in the attribute for the list type. Preference is given to the IUPAC name. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Article 7: +(5) (a) the name of the substances of concern present in the product, as follows: + - name(s) in the International Union of Pure and Applied Chemistry (IUPAC) nomenclature, or another international name when IUPAC name is not available; +- other names (usual name, trade name, abbreviation); +- European Community (EC) number, as indicated in the European Inventory of Existing Commercial Chemical Substances (EINECS), the European List of Notified Chemical Substances (ELINCS) or the No Longer Polymer (NLP) list or assigned by the European Chemicals Agency (ECHA), if available; +- the Chemical Abstract Service (CAS) name(s) and number(s), if available; . + +
+
Name
+
materialIdentification
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#MaterialIdEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
id
+
+ + +
+
+ +
+
Documentation
+
+ +Documentation accompanying the material. + +
+
Name
+
documentation
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#DocumentationEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
documentation
+
+ + +
+
+
+
+

Substance Of Concern Entity

+
+
+ Substance of Concern entity with attributes if applicable to the product. +
+ +
+

Properties

+
+
+ +
+
Applicable
+
+ +Check whether the connected attributes are applicable to the product. If it is not applicable (false), dummy data can be delivered. + +
+
Name
+
applicable
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#boolean + +
+
+
+
+
+ +
+
Example
+
true
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
applicable
+
+ + +
+
+ +
+
Substance of Concern
+
+ +Information regarding substances of concern in the product. Attributes are among others substance names, ids, concentration, location and hazard class. This is mentioned in the ESPR provisional agreement from January 9th, 2024 Article 7: +(5) (a) the name of the substances of concern present in the product, as follows: +- name(s) in the International Union of Pure and Applied Chemistry (IUPAC) nomenclature, or another international name when IUPAC name is not available; +- other names (usual name, trade name, abbreviation); +- European Community (EC) number, as indicated in the European Inventory of Existing Commercial Chemical Substances (EINECS), the European List of Notified Chemical Substances (ELINCS) or the No Longer Polymer (NLP) list or assigned by the European Chemicals Agency (ECHA), if available; +- the Chemical Abstract Service (CAS) name(s) and number(s), if available; +(5) (b) the location of the substances of concern within the product. +(5) (c) the concentration, maximum concentration or concentration range of the substances of concern, at the level of the product its relevant components, or spare parts; +(d) relevant instructions for the safe use of the product; +(e) information relevant for disassembly, preparation for reuse, reuse, recycling and the environmentally sound management of the product at the end of its life. +And in the next paragraph: +(c) provide duly justified exemptions for substances of concern or information elements from the information requirements referred to in the first subparagraph. + +
+
Name
+
substanceOfConcern
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#SubstanceEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
content
+
+ + +
+
+
+
+

Sustainability Entity

+
+
+ Entity with the properties regarding the sustainability of the product. +
+ +
+

Properties

+
+
+ +
+
State
+
+ +The status of the product (original, repurposed, re-used, remanufactured or waste) to indicated, whether it is a used product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Annex I: +(j) incorporation of used components. + +
+
Name
+
state
+
+ + + +
+
Characteristic
+
+
+
+
Enumeration
+
+
+
Values
+
+
+
+
    +
  • original
    • +
  • repurposed
    • +
  • re-used
    • +
  • remanufactured
    • +
  • waste
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
original
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
status
+
+ + +
+
+ +
+
Product Footprint
+
+ +The carbon and environmental footprint or material footprint of the product. These attributes are mentioned in the ESPR provisional agreement from January 9th 2024 Annex I: +(l) the environmental footprint of the product, expressed as a quantification, in accordance with the applicable delegated act, of a product's life cycle environmental impacts, whether in relation to one or more environmental impact categories or an aggregated set of impact categories; +(m) the carbon footprint of the product; +(ma) the material footprint of the product; +All are defined by Article 2: +(23) 'environmental footprint' means a quantification of product environmental impacts throughout its life cycle, whether in relation to a single environmental impact category or an aggregated set of impact categories based on the Product Environmental Footprint method or other scientific methods developed by international organisations and widely tested in collaboration with different industry sectors and adopted or implemented by the Commission in other Union +legislation; +(25) 'carbon footprint' means the sum of greenhouse gas (GHG) emissions and GHG removals in a product system, expressed as CO2 equivalents and based on a life cycle assessment using the single impact category of climate change. +(25a) 'material footprint' refers to the total amount of raw materials extracted to meet final consumption demands; + +
+
Name
+
productFootprint
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#ProductFootprintEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
productFootprint
+
+ + +
+
+ +
+
Reparability Score
+
+ +The reparability score. This attribute is mentioned ESPR provisional agreement from January 9th, 2024 Article 7: +(b) as appropriate, also require products to be accompanied by: +(i) information on the performance of the product in relation to one or more of the product parameters referred to in Annex I, including a scoring of reparability or durability [...]. + +
+
Name
+
reparabilityScore
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
B
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
reparabilityScore
+
+ + +
+
+ +
+
Durability Score
+
+ +The durability score. This attribute is mentioned ESPR provisional agreement from January 9th, 2024 Article 7: +(b) as appropriate, also require products to be accompanied by: +(i) information on the performance of the product in relation to one or more of the product parameters referred to in Annex I, including a scoring of reparability or durability [...]. + +
+
Name
+
durabilityScore
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
A
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
durabilityScore
+
+ + +
+
+
+
+

Type Entity

+
+
+ Entity for type with unit and data type. +
+ +
+

Properties

+
+
+ +
+
Type Unit
+
+ +Choose a unit type from the unit catalog, or if the property "children" is filled, leave empty. + +
+
Name
+
typeUnit
+
+ + + +
+
Characteristic
+
+
+
+
+ Reference +
+
    +
  • https://eclipse-esmf.github.io/samm-specification/2.1.0/index.html
    • +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
unit:volume
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
typeUnit
+
+ + +
+
+ +
+
Data Type
+
+ +Data type that describe the content of the attributes children and data. In case "object" is selected in the enumeration, the children field will be used in the AdditionalDataEntity instead of the "data" property. If it is an other type, the content will be specified in "data" as a string. + +
+
Name
+
dataType
+
+ + + +
+
Characteristic
+
+
+
+
Enumeration
+
+
+
Values
+
+
+
+
    +
  • array
    • +
  • object
    • +
  • xsd:string
    • +
  • xsd:integer
    • +
  • xsd:boolean
    • +
  • xsd:double
    • +
  • xsd:float
    • +
  • xsd:byte
    • +
+
+
+
+
+ Reference +
+
    +
  • https://eclipse-esmf.github.io/samm-specification/2.1.0/index.html
    • +
+
    +
  • https://www.w3.org/2001/XMLSchema
    • +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
xsd:integer
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
dataType
+
+ +
+
Reference
+
+
    +
  • https://eclipse-esmf.github.io/samm-specification/2.1.0/index.html
    • +
+
+
+ +
+
+
+
+

Volume Entity

+
+
+ Entity for volume measurements of an item with an unit and value. +
+ +
+

Properties

+
+
+ +
+
Quantity Value
+
+ +The quantity value associated with the unit. + +
+
Name
+
quantityValue
+
+ + + +
+
Characteristic
+
+
+
+
Quantifiable
+
+
+
Duration
+
+
+
The quantity value associated with the unit expressed as float.
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#float + +
+
+
+
+
+ +
+
Example
+
20.0
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
value
+
+ + +
+
+ +
+
Volume Unit
+
+ +The unit of a volume related attribute. + +
+
Name
+
volumeUnit
+
+ + + +
+
Characteristic
+
+
+
+
Enumeration
+
+
+
Values
+
+
+
+
    +
  • unit:cubicMetre
    • +
  • unit:litre
    • +
  • unit:millilitre
    • +
  • unit:cubicCentimetre
    • +
  • unit:cubicInch
    • +
  • unit:cubicFoot
    • +
  • unit:cubicYard
    • +
  • unit:hectolitre
    • +
+
+
+
+
+ Reference +
+
    +
  • https://eclipse-esmf.github.io/samm-specification/2.1.0/index.html
    • +
+
+
+
+
+
+ Type urn:samm:org.eclipse.esmf.samm:meta-model:2.1.0#curie + +
+
+
+
+
+ +
+
Example
+
unit:litre
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
unit
+
+ +
+
Reference
+
+
    +
  • https://eclipse-esmf.github.io/samm-specification/2.1.0/index.html
    • +
+
+
+ +
+
+
+ +
+ Third party licenses + +
+ +
+ + +
+ + + \ No newline at end of file diff --git a/io.catenax.generic.digital_product_passport/5.0.0/gen/DigitalProductPassport.json b/io.catenax.generic.digital_product_passport/5.0.0/gen/DigitalProductPassport.json new file mode 100644 index 000000000..cc2590c9a --- /dev/null +++ b/io.catenax.generic.digital_product_passport/5.0.0/gen/DigitalProductPassport.json @@ -0,0 +1,261 @@ +{ + "metadata" : { + "backupReference" : "https://dummy.link", + "registrationIdentifier" : "https://dummy.link/ID8283746239078", + "economicOperatorId" : "BPNL0123456789ZZ", + "lastModification" : "2000-01-01", + "predecessor" : "urn:uuid:00000000-0000-0000-0000-000000000000", + "issueDate" : "2000-01-01", + "version" : "1.0.0", + "passportIdentifier" : "urn:uuid:550e8400-e29b-41d4-a716-446655440000", + "status" : "draft", + "expirationDate" : "2030-01-01" + }, + "characteristics" : { + "generalPerformanceClass" : "A", + "physicalState" : "solid", + "physicalDimension" : { + "volume" : { + "value" : 20.0, + "unit" : "unit:cubicMetre" + }, + "grossWeight" : { + "value" : 20.0, + "unit" : "unit:gram" + }, + "diameter" : { + "value" : 20.0, + "unit" : "unit:millimetre" + }, + "grossVolume" : { + "value" : 20.0, + "unit" : "unit:cubicMetre" + }, + "width" : { + "value" : 20.0, + "unit" : "unit:millimetre" + }, + "length" : { + "value" : 20.0, + "unit" : "unit:millimetre" + }, + "weight" : { + "value" : 20.0, + "unit" : "unit:gram" + }, + "height" : { + "value" : 20.0, + "unit" : "unit:millimetre" + } + }, + "lifespan" : [ { + "value" : 36, + "unit" : "unit:day", + "key" : "guaranteed lifetime" + } ] + }, + "commercial" : { + "placedOnMarket" : "2000-01-01", + "purpose" : [ "automotive" ] + }, + "identification" : { + "batch" : [ { + "value" : "BID12345678", + "key" : "batchId" + } ], + "codes" : [ { + "value" : "8703 24 10 00", + "key" : "TARIC" + } ], + "type" : { + "manufacturerPartId" : "123-0.740-3434-A", + "nameAtManufacturer" : "Mirror left" + }, + "classification" : [ { + "classificationStandard" : "GIN 20510-21513", + "classificationID" : "1004712", + "classificationDescription" : "Generic standard for classification of parts in the automotive industry." + } ], + "serial" : [ { + "value" : "SN12345678", + "key" : "partInstanceId" + } ], + "dataCarrier" : { + "carrierType" : "QR", + "carrierLayout" : "upper-left side" + } + }, + "sources" : [ { + "header" : "Example Document XYZ", + "category" : "Product Specifications", + "type" : "URL", + "content" : "https://dummy.link" + } ], + "materials" : { + "substancesOfConcern" : { + "applicable" : true, + "content" : [ { + "unit" : "unit:partPerMillion", + "hazardClassification" : { + "category" : "category 1A", + "statement" : "Causes severe skin burns and eye damage.", + "class" : "Skin corrosion" + }, + "documentation" : [ { + "contentType" : "URL", + "header" : "Example Document XYZ", + "content" : "https://dummy.link" + } ], + "concentrationRange" : [ { + "max" : 2.6, + "min" : 2.1 + } ], + "location" : "Housing", + "concentration" : 5.3, + "exemption" : "shall not apply to product x containing not more than 1,5 ml of liquid", + "id" : [ { + "type" : "CAS", + "name" : "phenolphthalein", + "id" : "201-004-7" + } ] + } ] + }, + "materialComposition" : { + "applicable" : true, + "content" : [ { + "unit" : "unit:partPerMillion", + "recycled" : 12.5, + "critical" : true, + "renewable" : 23.5, + "documentation" : [ { + "contentType" : "URL", + "header" : "Example Document XYZ", + "content" : "https://dummy.link" + } ], + "concentration" : 5.3, + "id" : [ { + "type" : "CAS", + "name" : "phenolphthalein", + "id" : "201-004-7" + } ] + } ] + } + }, + "handling" : { + "applicable" : true, + "content" : { + "producer" : [ { + "id" : "BPNL0123456789ZZ" + } ], + "sparePart" : [ { + "manufacturerPartId" : "123-0.740-3434-A", + "nameAtManufacturer" : "Mirror left" + } ] + } + }, + "additionalData" : [ { + "description" : "Description of an attribute", + "label" : "Maximum permitted battery power", + "type" : { + "typeUnit" : "unit:volume", + "dataType" : "array" + }, + "data" : "23", + "children" : [ { + "description" : "Description of an attribute", + "label" : "Maximum permitted battery power", + "type" : { + "typeUnit" : "unit:volume", + "dataType" : "array" + }, + "data" : "23" + } ] + } ], + "operation" : { + "import" : { + "applicable" : true, + "content" : { + "eori" : "GB123456789000", + "id" : "BPNL0123456789ZZ" + } + }, + "other" : { + "id" : "BPNL0123456789XX", + "role" : "distributor" + }, + "manufacturer" : { + "facility" : [ { + "facility" : "BPNA1234567890AA" + } ], + "manufacturingDate" : "2000-01-31", + "manufacturer" : "BPNLbi7tAJ8UiMsF" + } + }, + "sustainability" : { + "reparabilityScore" : "B", + "productFootprint" : { + "material" : [ { + "lifecycle" : "main product production", + "rulebook" : [ { + "contentType" : "URL", + "header" : "Example Document XYZ", + "content" : "https://dummy.link" + } ], + "unit" : "kg CO2 / kWh", + "performanceClass" : "A", + "manufacturingPlant" : [ { + "facility" : "BPNA1234567890AA" + } ], + "type" : "Climate Change Total", + "value" : 12.678, + "declaration" : [ { + "contentType" : "URL", + "header" : "Example Document XYZ", + "content" : "https://dummy.link" + } ] + } ], + "carbon" : [ { + "lifecycle" : "main product production", + "rulebook" : [ { + "contentType" : "URL", + "header" : "Example Document XYZ", + "content" : "https://dummy.link" + } ], + "unit" : "kg CO2 / kWh", + "performanceClass" : "A", + "manufacturingPlant" : [ { + "facility" : "BPNA1234567890AA" + } ], + "type" : "Climate Change Total", + "value" : 12.678, + "declaration" : [ { + "contentType" : "URL", + "header" : "Example Document XYZ", + "content" : "https://dummy.link" + } ] + } ], + "environmental" : [ { + "lifecycle" : "main product production", + "rulebook" : [ { + "contentType" : "URL", + "header" : "Example Document XYZ", + "content" : "https://dummy.link" + } ], + "unit" : "kg CO2 / kWh", + "performanceClass" : "A", + "manufacturingPlant" : [ { + "facility" : "BPNA1234567890AA" + } ], + "type" : "Climate Change Total", + "value" : 12.678, + "declaration" : [ { + "contentType" : "URL", + "header" : "Example Document XYZ", + "content" : "https://dummy.link" + } ] + } ] + }, + "status" : "original", + "durabilityScore" : "A" + } +} \ No newline at end of file diff --git a/io.catenax.generic.digital_product_passport/5.0.0/gen/DigitalProductPassport.yml b/io.catenax.generic.digital_product_passport/5.0.0/gen/DigitalProductPassport.yml new file mode 100644 index 000000000..8341af2e7 --- /dev/null +++ b/io.catenax.generic.digital_product_passport/5.0.0/gen/DigitalProductPassport.yml @@ -0,0 +1,1580 @@ +--- +openapi: 3.0.3 +info: + title: Digital Product Passport + version: v5 +servers: +- url: catenax.io/api/v5 + variables: + api-version: + default: v5 +paths: + /{tenant-id}/digital-product-passport: + get: + tags: + - DigitalProductPassport + operationId: getDigitalProductPassport + 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/DigitalProductPassport' + "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/DigitalProductPassport' + 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.generic.digital_product_passport_5.0.0_StatusEnumeration: + type: string + description: "The current status of the product passport declared through either:\ + \ draft, approved, invalid or expired." + enum: + - draft + - approved + - invalid + - expired + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DateTrait: + type: string + description: Constraint fo a timestamp in the format (yyyy-mm-dd). + pattern: "^\\d{4}-\\d{2}-\\d{2}$" + urn_samm_io.catenax.shared.business_partner_number_2.0.0_BpnlTrait: + type: string + description: "The provided regular expression ensures that the BPNL is composed\ + \ of prefix 'BPNL', 10 digits and two alphanumeric letters." + pattern: "^BPNL[a-zA-Z0-9]{12}$" + 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_io.catenax.generic.digital_product_passport_5.0.0_IdentifierCharacteristic: + type: string + description: Characteristic for Identifiers. + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_MetadataCharacteristic: + description: Characteristic for the passport metadata of the digital product + passport. + type: object + properties: + version: + description: |- + The current version of the product passport. The possibility of modification/ updating the product passport needs to include versioning of the dataset. This attribute is an internal versioning from the passport issuer. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Article 8: + (1) [...] The information in the product passport shall be accurate, complete, and up to date. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + status: + description: "The current status of the product passport declared through\ + \ either: draft, approved, invalid or expired." + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_StatusEnumeration' + expirationDate: + description: |- + The timestamp in the format (yyyy-mm-dd) for the product passport until when it is available or a comment describing this period. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Article 8: + (2) (h) the period during which the product passport is to remain available, which shall correspond to at least the expected lifetime of a specific product. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DateTrait' + issueDate: + description: The timestamp in the format (yyyy-mm-dd) since when the product + passport is available. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DateTrait' + economicOperatorId: + description: |- + The identification of the owner/economic operator of the passport. Proposed, according to ISO 15459, is the CIN (company identification code). Other identification numbers like the tax identification number, value added tax identification number, commercial register number and the like are also valid entries. In the Catena-X network, the BPNL is used for the identification of companies and the information stored like contact information and addresses. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Annex III: + (k) the [...] unique operator identifier code of the economic operator established in the Union responsible for carrying out the tasks set out in Article 4 of Regulation (EU) 2019/1020, or Article 15 of Regulation (EU) on general product safety, or similar tasks pursuant to other EU legislation applicable to the product. + $ref: '#/components/schemas/urn_samm_io.catenax.shared.business_partner_number_2.0.0_BpnlTrait' + passportIdentifier: + description: "The identifier of the product passport, which is an uuidv4." + $ref: '#/components/schemas/urn_samm_io.catenax.shared.uuid_2.0.0_UuidV4Trait' + predecessor: + description: |- + Identification of the preceding product passport. If there is no preceding passport, input a dummy value. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Article 8: + (2)(g) [...] Any new product passport shall be linked to the product passport or passports of the original product whenever appropriate. + $ref: '#/components/schemas/urn_samm_io.catenax.shared.uuid_2.0.0_UuidV4Trait' + backupReference: + description: |- + A reference to the data backup of the passport. This mandatory attribute will be further defined in the future. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex III: + (kb) the reference of the certified independent third-party product passport service provider hosting the back-up copy of the product passport. + Article 10 also mentions: + (c) the data included in the product passport shall be stored by the economic operator responsible for its creation or by certified independent third-party product passport service providers authorised to act on their behalf. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + registrationIdentifier: + description: |- + Identifier in the respective registry. This will be further defined in the future. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 in Article 12: + By [2 years from entering into force of this Regulation], the Commission shall set up and manage a digital registry ("the registry") storing in a secure manner at least the unique product identifier, the unique operator identifier, the unique facility identifiers. In case of products intended to be placed under the customs procedure 'release for free circulation', the registry shall also store the product commodity code. The registry shall also store the batteries' unique identifiers referred to in Article 77(3) of Regulation (EU) 2023/1542. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_IdentifierCharacteristic' + lastModification: + description: Date of the latest modification. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DateTrait' + required: + - version + - expirationDate + - issueDate + - economicOperatorId + - passportIdentifier + - predecessor + - backupReference + urn_samm_io.catenax.serial_part_3.0.0_KeyTrait: + type: string + description: Constraint that ensures that the standard keys and custom key prefixes + can be used. + pattern: ^(manufacturerId|partInstanceId|batchId|van|customKey:\w+)$ + urn_samm_io.catenax.serial_part_3.0.0_ValueCharacteristic: + type: string + description: The value of an identifier. + urn_samm_io.catenax.serial_part_3.0.0_KeyValueList: + description: "A list of key value pairs for local identifiers, which are composed\ + \ of a key and a corresponding value." + type: object + properties: + key: + description: 'The key of a local identifier. ' + $ref: '#/components/schemas/urn_samm_io.catenax.serial_part_3.0.0_KeyTrait' + value: + description: The value of an identifier. + $ref: '#/components/schemas/urn_samm_io.catenax.serial_part_3.0.0_ValueCharacteristic' + required: + - key + - value + urn_samm_io.catenax.serial_part_3.0.0_LocalIdentifierCharacteristic: + description: "A single serialized part may have multiple attributes, that uniquely\ + \ identify a that part in a specific dataspace (e.g. the manufacturer`s dataspace)" + type: array + items: + $ref: '#/components/schemas/urn_samm_io.catenax.serial_part_3.0.0_KeyValueList' + uniqueItems: true + urn_samm_io.catenax.batch_3.0.0_KeyTrait: + type: string + description: Constraint that ensures that the predefined keys are used. + pattern: ^(manufacturerId|batchId|customKey:\w+)$ + urn_samm_io.catenax.batch_3.0.0_ValueCharacteristic: + type: string + description: The value of an identifier. + urn_samm_io.catenax.batch_3.0.0_KeyValueList: + description: "A list of key value pairs for local identifiers, which are composed\ + \ of a key and a corresponding value." + type: object + properties: + key: + description: The key of a local identifier. + $ref: '#/components/schemas/urn_samm_io.catenax.batch_3.0.0_KeyTrait' + value: + description: The value of an identifier. + $ref: '#/components/schemas/urn_samm_io.catenax.batch_3.0.0_ValueCharacteristic' + required: + - key + - value + urn_samm_io.catenax.batch_3.0.0_LocalIdentifierCharacteristic: + description: "A batch may have multiple attributes, which uniquely identify\ + \ that batch in a specific dataspace(e.g. the manufacturer`s dataspace)" + type: array + items: + $ref: '#/components/schemas/urn_samm_io.catenax.batch_3.0.0_KeyValueList' + uniqueItems: true + urn_samm_io.catenax.part_type_information_1.0.0_PartIdCharacteristic: + type: string + description: "The part ID is a multi-character string, usually assigned by an\ + \ ERP system." + urn_samm_io.catenax.part_type_information_1.0.0_PartNameCharacteristic: + type: string + description: Part name in string format from the respective system in the value + chain. + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PartTypeCharacteristic: + description: Characteristic for the part type. + type: object + properties: + manufacturerPartId: + description: Part ID as assigned by the manufacturer of the part. The part + ID identifies the part in the manufacturer`s dataspace. The part ID references + a specific version of a part. The version number must be included in the + part ID if it is available. The part ID does not reference a specific + instance of a part and must not be confused with the serial number. + $ref: '#/components/schemas/urn_samm_io.catenax.part_type_information_1.0.0_PartIdCharacteristic' + nameAtManufacturer: + description: Name of the part as assigned by the manufacturer. + $ref: '#/components/schemas/urn_samm_io.catenax.part_type_information_1.0.0_PartNameCharacteristic' + required: + - manufacturerPartId + - nameAtManufacturer + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_CodeEntity: + description: Code entity with code key and value. + type: object + properties: + key: + description: |- + The code key for the identification of the product. Examples are GTIN, hash, DID, ISBN, TARIC. This attribute is mentioned in the ESPR proposal from March 30th, 2022 ANNEX III: + (b) the unique product identifier at the level indicated in the applicable delegated act adopted pursuant to Article 4; + (c) the Global Trade Identification Number as provided for in standard ISO/IEC 15459-6 or equivalent of products or their parts; + (d) relevant commodity codes, such as a TARIC code as defined in Council Regulation (EEC) No 2658/87. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_IdentifierCharacteristic' + value: + description: The code value for the identification of the product in regard + to the chosen code name. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_IdentifierCharacteristic' + required: + - key + - value + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_CodeList: + description: A list of additional codes. + type: array + items: + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_CodeEntity' + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DataCarrierCharacteristic: + description: Data Carrier Characteristic for the product. + type: object + properties: + carrierType: + description: |- + The type of data carrier such as a QR code on the product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 8: + (2) (b) the types of data carrier to be used. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + carrierLayout: + description: |- + The positioning of data carrier on the product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 8: + (2) (c) the layout in which the data carrier shall be presented and its positioning. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + required: + - carrierType + - carrierLayout + urn_samm_io.catenax.shared.part_classification_1.0.0_ClassificationStandardCharacteristic: + type: string + description: Identified classification standards that align to the Catena-X + needs. + urn_samm_io.catenax.shared.part_classification_1.0.0_ClassificationIDCharacteristic: + type: string + description: "It can be numeric or a string, depending on the chosen classification\ + \ standard." + urn_samm_io.catenax.shared.part_classification_1.0.0_ClassificationEntity: + description: Encapsulates data related to the classification of the part. + type: object + properties: + classificationStandard: + description: Identified classification standards that align to the Catena-X + needs. + $ref: '#/components/schemas/urn_samm_io.catenax.shared.part_classification_1.0.0_ClassificationStandardCharacteristic' + classificationID: + description: The classification ID of the part type according to the corresponding + standard definition mentioned in the key value pair. + $ref: '#/components/schemas/urn_samm_io.catenax.shared.part_classification_1.0.0_ClassificationIDCharacteristic' + classificationDescription: + description: Optional property describing the classification standard. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + required: + - classificationStandard + - classificationID + urn_samm_io.catenax.shared.part_classification_1.0.0_ClassificationCharacteristic: + description: Classification characteristic enabling a set of further properties. + type: array + items: + $ref: '#/components/schemas/urn_samm_io.catenax.shared.part_classification_1.0.0_ClassificationEntity' + uniqueItems: true + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_IdentificationCharacteristic: + description: Identification information of the product. + type: object + properties: + serial: + description: |- + Identifier for a serial part if available. This is mentioned in the ESPR provisional agreement from January 9th, 2024 Recital (27): + [...] an 'item' usually means a single unit of a model. + $ref: '#/components/schemas/urn_samm_io.catenax.serial_part_3.0.0_LocalIdentifierCharacteristic' + batch: + description: |- + Identifier for a batch part if available. Identifier for a serial part if available. This is mentioned in the ESPR provisional agreement from January 9th, 2024 Recital (27): + [...] a 'batch' usually means a subset of a specific model composed of all products produced in a specific manufacturing plant at a specific moment in time [...]. + $ref: '#/components/schemas/urn_samm_io.catenax.batch_3.0.0_LocalIdentifierCharacteristic' + type: + description: |- + Identifier on the level of a part model or type. Identifier for a serial part if available. This is mentioned in the ESPR provisional agreement from January 9th, 2024 Recital (27): + [...] A 'model' usually means a version of a product of which all units share the same technical characteristics relevant for the ecodesign requirements and the same model identifier [...]. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PartTypeCharacteristic' + codes: + description: Codes for identification. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_CodeList' + dataCarrier: + description: |- + The type and layout of the data carrier on the product. These are mentioned in the ESPR proposal from March 30th, 2022 Article 8: + (b) the types of data carrier to be used; + (c) the layout in which the data carrier shall be presented and its positioning; + Article 2 defines: + (30) 'data carrier' means a linear bar code symbol, a two-dimensional symbol or other automatic identification data capture medium that can be read by a device. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DataCarrierCharacteristic' + classification: + description: Property describing the classification of a part. + $ref: '#/components/schemas/urn_samm_io.catenax.shared.part_classification_1.0.0_ClassificationCharacteristic' + required: + - type + - codes + - dataCarrier + - classification + urn_samm_io.catenax.shared.business_partner_number_2.0.0_BpnaTrait: + type: string + description: "The provided regular expression ensures that the BPNA is composed\ + \ of prefix 'BPNA', 10 digits and two alphanumeric letters." + pattern: "^BPNA[a-zA-Z0-9]{12}$" + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_FacilityEntity: + description: The entity for a facility with the BPNA identifier. + type: object + properties: + facility: + description: |- + The identifier used for a location. This attribute is mentioned in the ESPR provisional agreement from January 9th 2024 Annex III: + (i) unique facility identifiers; + Article 2 Definitions: (33) 'unique facility identifier' means a unique string of characters for the identification of locations or buildings involved in the value chain of a product or used by actors involved in the value chain of a product. + $ref: '#/components/schemas/urn_samm_io.catenax.shared.business_partner_number_2.0.0_BpnaTrait' + required: + - facility + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_FacilityList: + description: List of facilities. + type: array + items: + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_FacilityEntity' + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_ManufacturerCharacteristic: + description: Manufacturing information. + type: object + properties: + facility: + description: |- + The identifier used for a location. In the CATENA-X use case, the BPNA can be stated. This attribute is mentioned in the ESPR provisional agreement from January 9th 2024 Annex III: + (i) unique facility identifiers; + Article 2 Definitions: (33) 'unique facility identifier' means a unique string of characters for the identification of locations or buildings involved in the value chain of a product or used by actors involved in the value chain of a product. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_FacilityList' + manufacturer: + description: |- + The main manufacturer, if different from the passport owner, represented by an identification number. In the Catena-X use case, the BPNL can be stated. This attribute is mentioned in the ESPR provisional agreement from January 9th 2024 Annex III: + (h) unique operator identifiers other than that of the manufacturer; + (k) the name, contact details and unique operator identifier code of the economic operator established in the Union responsible for carrying out the tasks set out in Article 4 of Regulation (EU) 2019/1020, or Article 15 of Regulation (EU) [.../...] on general product safety, or similar tasks pursuant to other EU legislation applicable to the product. + $ref: '#/components/schemas/urn_samm_io.catenax.shared.business_partner_number_2.0.0_BpnlTrait' + manufacturingDate: + description: "The timestamp in the format (yyyy-mm-dd) of the manufacturing\ + \ date as the final step in production process (e.g. final quality check,\ + \ ready-for-shipment event)." + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DateTrait' + required: + - facility + - manufacturer + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_EoriTrait: + type: string + description: "Constraint with a pattern which ensures that the EORI number starts\ + \ with two alphanumeric characters, followed by two alphabetic characters,\ + \ and ends with 2 to 15 alphanumeric characters." + pattern: "^[A-Z]{2}[A-Z0-9]{1,18}$" + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_ImporterCharacteristic: + description: Characteristic with information regarding the importer. + type: object + properties: + eori: + description: |- + An economic operator established in the customs territory of the Union needs, for customs purposes, an EORI number. EORI stands for economic operators registration and identification number. In this case, the importer's EORI must be provided. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Annex III: + (j) information related to the importer, including the information referred to in Article 23(3) and its EORI number. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_EoriTrait' + id: + description: |- + The importer of the product, if different from the owner of the passport. In the Catena-X network, the BPNL is used for the identification of companies and the information stored for this like contact information and addresses. + This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex III: + (j) information related to the importer, including the information referred to in Article 23(3) and its EORI number; + Article 23 states: + (3) Importers shall, for products covered by a delegated act adopted pursuant to Article 4, indicate their name, registered trade name or registered trade mark and the postal address and electronic means of communication, where they can be contacted: (a) on the public part of the product passport, when applicable, and + (b) on the product or, where this is not possible, on the packaging, or in a document accompanying the product. + $ref: '#/components/schemas/urn_samm_io.catenax.shared.business_partner_number_2.0.0_BpnlTrait' + required: + - eori + - id + 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.generic.digital_product_passport_5.0.0_ImportCharacteristic: + description: Import Characteristic for the product. + type: object + properties: + content: + description: |- + Information regarding the importer of the product, if different from the owner of the passport. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex III: + (j) information related to the importer, including the information referred to in Article 23(3) and its EORI number; + Article 23 states: + (3) Importers shall, for products covered by a delegated act adopted pursuant to Article 4, indicate their name, registered trade name or registered trade mark and the postal address and electronic means of communication, where they can be contacted: (a) on the public part of the product passport, when applicable, and + (b) on the product or, where this is not possible, on the packaging, or in a document accompanying the product. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_ImporterCharacteristic' + applicable: + description: "Check whether the connected attributes are applicable to the\ + \ product. If it is not applicable (false), dummy data can be delivered." + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Boolean' + required: + - content + - applicable + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_OperatorCharacteristic: + description: Other operators characteristic. + type: object + properties: + id: + description: Identifier of the other operator. This can be a BPN. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + role: + description: Role of the other operator. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + required: + - id + - role + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_OperationCharacteristic: + description: Operational information of the product. + type: object + properties: + manufacturer: + description: |- + Manufacturing information of the product. In the CATENA-X use case, the BPNL and BPNA can be stated. These attributes are mentioned in the ESPR provisional agreement from January 9th 2024 Annex III: + (h) unique operator identifiers other than that of the manufacturer; + (k) the name, contact details and unique operator identifier code of the economic operator established in the Union responsible for carrying out the tasks set out in Article 4 of Regulation (EU) 2019/1020, or Article 15 of Regulation (EU) [.../...] on general product safety, or similar tasks pursuant to other EU legislation applicable to the product. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_ManufacturerCharacteristic' + import: + description: Importer details such as the identification. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_ImportCharacteristic' + other: + description: Other operators relevant for the product. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_OperatorCharacteristic' + required: + - manufacturer + - import + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_SourcesEntity: + description: Entity for a possible spare part sources. + type: object + properties: + id: + description: "The identifier of a spare part producer of the product. In\ + \ the Catena-X network, the BPNL is used for the identification of companies\ + \ and the information stored for this like contact information and addresses." + $ref: '#/components/schemas/urn_samm_io.catenax.shared.business_partner_number_2.0.0_BpnlTrait' + required: + - id + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_SourcesList: + description: List of possible spare part sources. + type: array + items: + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_SourcesEntity' + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PartsEntity: + description: Possible spare parts of the product with identifiers and names. + type: object + properties: + manufacturerPartId: + description: Part ID as assigned by the manufacturer of the part. The part + ID identifies the part in the manufacturer`s dataspace. The part ID references + a specific version of a part. The version number must be included in the + part ID if it is available. The part ID does not reference a specific + instance of a part and must not be confused with the serial number. + $ref: '#/components/schemas/urn_samm_io.catenax.part_type_information_1.0.0_PartIdCharacteristic' + nameAtManufacturer: + description: Name of the part as assigned by the manufacturer. + $ref: '#/components/schemas/urn_samm_io.catenax.part_type_information_1.0.0_PartNameCharacteristic' + required: + - manufacturerPartId + - nameAtManufacturer + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PartList: + description: A list of possible spare parts of the product. + type: array + items: + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PartsEntity' + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_SparePart: + description: Characteristic describing sources and spare parts. + type: object + properties: + producer: + description: Sources of possible spare parts. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_SourcesList' + sparePart: + description: Possible spare parts of the product. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PartList' + required: + - producer + - sparePart + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_HandlingCharacteristic: + description: Characteristic to describe aspects which are connected with the + handling of the product. + type: object + properties: + content: + description: The list of spare parts available for the product from various + suppliers. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_SparePart' + applicable: + description: "Check whether the connected attributes are applicable to the\ + \ product. If it is not applicable (false), dummy data can be delivered." + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Boolean' + required: + - content + - applicable + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_LifeEnumeration: + type: string + description: "Enumeration with the possible units day, month, cycle, year and\ + \ runningOrOperatingHour." + enum: + - unit:day + - unit:month + - unit:year + - unit:cycle + - unit:runningOrOperatingHour + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_LifeValueCharacteristic: + type: number + description: Characteristic for the life span value as an integer. + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_LifeTypeEnumeration: + type: string + description: "Enumeration with the values guaranteed lifetime, technical lifetime\ + \ and mean time between failures." + enum: + - guaranteed lifetime + - technical lifetime + - mean time between failures + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_LifespanEntity: + description: "Entity for the lifespan of a product with type, unit and value." + type: object + properties: + unit: + description: "The unit of the respective lifespan expressed through the\ + \ possible units day, month, cycle, year and runningOrOperatingHour." + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_LifeEnumeration' + value: + description: The value as an integer for the respective lifespan. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_LifeValueCharacteristic' + key: + description: |- + The type of lifespan represented with the values guaranteed lifetime, technical lifetime and mean time between failures. This attribute is mentioned in the ESPR proposal from March 30th, 2022 ANNEX I: + (a) durability and reliability of the product or its components as expressed through the product's guaranteed lifetime, technical lifetime [or] mean time between failures [...]. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_LifeTypeEnumeration' + required: + - unit + - value + - key + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_LifespanList: + description: List of different life spans of a product. + type: array + items: + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_LifespanEntity' + urn_samm_io.catenax.shared.quantity_2.0.0_QuantityValueCharacteristic: + type: number + description: The quantity value associated with the unit expressed as float. + urn_samm_io.catenax.shared.quantity_2.0.0_LinearUnitEnumeration: + type: string + pattern: "[a-zA-Z]*:[a-zA-Z]+" + description: "The unit of a linear attribute that may be used for height, width,\ + \ length and diameter." + enum: + - unit:millimetre + - unit:centimetre + - unit:metre + - unit:kilometre + - unit:inch + - unit:foot + - unit:yard + urn_samm_io.catenax.shared.quantity_2.0.0_LinearCharacteristic: + description: Characteristic for linear measurements of an item. + type: object + properties: + value: + description: The quantity value associated with the unit. + $ref: '#/components/schemas/urn_samm_io.catenax.shared.quantity_2.0.0_QuantityValueCharacteristic' + unit: + description: The unit of a linear attribute. + $ref: '#/components/schemas/urn_samm_io.catenax.shared.quantity_2.0.0_LinearUnitEnumeration' + required: + - value + - unit + urn_samm_io.catenax.shared.quantity_2.0.0_MassUnitEnumeration: + type: string + pattern: "[a-zA-Z]*:[a-zA-Z]+" + description: Enumeration for mass units. + enum: + - unit:gram + - unit:kilogram + - unit:tonneMetricTon + - unit:tonUsOrShortTonUkorus + - unit:ounceAvoirdupois + - unit:pound + urn_samm_io.catenax.shared.quantity_2.0.0_MassCharacteristic: + description: Characteristic for mass measurements of an item. + type: object + properties: + value: + description: The quantity value associated with the unit. + $ref: '#/components/schemas/urn_samm_io.catenax.shared.quantity_2.0.0_QuantityValueCharacteristic' + unit: + description: The unit of a mass related attribute. + $ref: '#/components/schemas/urn_samm_io.catenax.shared.quantity_2.0.0_MassUnitEnumeration' + required: + - value + - unit + urn_samm_io.catenax.shared.quantity_2.0.0_VolumeUnitEnumeration: + type: string + pattern: "[a-zA-Z]*:[a-zA-Z]+" + description: Enumeration for volume units. + enum: + - unit:cubicMetre + - unit:litre + - unit:millilitre + - unit:cubicCentimetre + - unit:cubicInch + - unit:cubicFoot + - unit:cubicYard + - unit:hectolitre + urn_samm_io.catenax.shared.quantity_2.0.0_VolumeCharacteristic: + description: Characteristic for volume measurements of an item. + type: object + properties: + value: + description: The quantity value associated with the unit. + $ref: '#/components/schemas/urn_samm_io.catenax.shared.quantity_2.0.0_QuantityValueCharacteristic' + unit: + description: The unit of a volume related attribute. + $ref: '#/components/schemas/urn_samm_io.catenax.shared.quantity_2.0.0_VolumeUnitEnumeration' + required: + - value + - unit + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PhysicalDimensionCharacteristic: + description: "Characteristic for physical dimensions with linear, mass and capacity\ + \ attributes." + type: object + properties: + width: + description: The width of the item measured in a specific linear unit which + can be declared in the corresponding unit attribute. + $ref: '#/components/schemas/urn_samm_io.catenax.shared.quantity_2.0.0_LinearCharacteristic' + length: + description: The length of the item measured in a specific linear unit which + can be declared in the corresponding unit attribute. + $ref: '#/components/schemas/urn_samm_io.catenax.shared.quantity_2.0.0_LinearCharacteristic' + diameter: + description: "The diameter of the item, if applicable, measured in a specific\ + \ linear unit which can be declared in the corresponding unit attribute." + $ref: '#/components/schemas/urn_samm_io.catenax.shared.quantity_2.0.0_LinearCharacteristic' + height: + description: The height of the item measured in a specific linear unit which + can be declared in the corresponding unit attribute. + $ref: '#/components/schemas/urn_samm_io.catenax.shared.quantity_2.0.0_LinearCharacteristic' + grossWeight: + description: |- + The gross weight of the item measured in a specific mass unit which can be declared in the corresponding unit attribute. Gross weight refers to the total weight of a product, including the weight of the packaging. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7: + (2) (b) (i) information on the performance of the product in relation to the product parameters referred to in Annex I; + Annex I (i) weight and volume of the product and its packaging, and the product-to-packaging ratio. + $ref: '#/components/schemas/urn_samm_io.catenax.shared.quantity_2.0.0_MassCharacteristic' + grossVolume: + description: |- + The gross volume of the item, if possible, measured in a specific capacity unit which can be declared in the corresponding unit attribute. If there is no separate packing, the volume of the product shall be given. Gross volume refers to the total volume of a product, including the volume of the packaging. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7: + (2) (b) (i) information on the performance of the product in relation to the product parameters referred to in Annex I; + Annex I (i) weight and volume of the product and its packaging, and the product-to-packaging ratio. + $ref: '#/components/schemas/urn_samm_io.catenax.shared.quantity_2.0.0_VolumeCharacteristic' + weight: + description: |- + Weight of the product measured in a specific mass unit which can be declared in the corresponding unit attribute. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7: + (2) (b) (i) information on the performance of the product in relation to the product parameters referred to in Annex I; + Annex I (i) weight and volume of the product [...]. + $ref: '#/components/schemas/urn_samm_io.catenax.shared.quantity_2.0.0_MassCharacteristic' + volume: + description: |- + Volume of the product, if possible, measured in a specific capacity unit which can be declared in the corresponding unit attribute. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7: + (2) (b) (i) information on the performance of the product in relation to the product parameters referred to in Annex I; + Annex I (i) weight and volume of the product [...]. + $ref: '#/components/schemas/urn_samm_io.catenax.shared.quantity_2.0.0_VolumeCharacteristic' + required: + - grossWeight + - grossVolume + - weight + - volume + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PhysicalStateEnumeration: + type: string + description: "Enumeration with the values solid, liquid, gas and plasma." + enum: + - solid + - liquid + - gas + - plasma + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_ProductCharacteristics: + description: Defines a set of specific characteristics of a product. + type: object + properties: + lifespan: + description: |- + The type of lifespan represented with the values guaranteed lifetime, technical lifetime and mean time between failures. Both can be described through the attributes: type, which defines the type such as guaranteed lifetime or technical lifetime, the unit for the lifetime, and the value represented by an integer. These attributes are mentioned in the ESPR proposal from March 30th, 2022 ANNEX I: + (a) durability and reliability of the product or its components as expressed through the products guaranteed lifetime, technical lifetime [or] mean time between failures [...]. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_LifespanList' + physicalDimension: + description: |- + Physical dimensions are properties associated with physical quantities for purposes of classification or differentiation. These attributes are mentioned in the ESPR provisional agreement from January 9th, Article 7: + (2) (b) (i) information on the performance of the product in relation to one or more of the product parameters referred to in Annex I; + Annex I (i) weight and volume of the product and its packaging, and the product-to-packaging ratio. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PhysicalDimensionCharacteristic' + physicalState: + description: "The physical state of the item. There are four states of matter\ + \ solid, liquid, gas and plasma which can be chosen from an enumeration." + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PhysicalStateEnumeration' + generalPerformanceClass: + description: |- + The performance class of the product. This attribute is mentioned ESPR provisional agreement from January 9th, 2024 Article 7: + 4. When establishing the information requirements referred to in paragraph 2, point (b), point (i), the Commission shall, as appropriate in view of the specificity of the product group, determine classes of performance. Classes of performance may be based on single parameters, on aggregated scores, in absolute terms or in any other form that enables potential customers to choose the best performing products. Those classes of performance shall correspond to significant improvements in performance levels. Where classes of performance are based on parameters in relation to which performance requirements are established, they shall use as the minimum level the minimum performance required at the time when the classes of performance start to apply. + Definition: + 'class of performance': means a range of performance levels in relation to one or more product parameters referred to in Annex I, based on a common methodology for the product or product group, ordered into successive steps to allow for product differentiation. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + required: + - lifespan + - physicalDimension + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_StringList: + description: List of strings. + type: array + items: + type: string + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_CommercialCharacteristic: + description: Commercial information of the product. + type: object + properties: + placedOnMarket: + description: The timestamp in the format (yyyy-mm-dd) with or without time + zone when the product was put in the market. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DateTrait' + purpose: + description: "One or more intended industry/industries of the product described\ + \ by the digital product passport. If exchanged via Catena-X, 'automotive\ + \ ' is a must choice included in the list." + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_StringList' + required: + - purpose + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_ConcentrationEnumeration: + type: string + description: "Enumeration of possible units of concentration with percent, volume\ + \ percent, parts per thousand, parts per million, parts per billion and parts\ + \ per trillion." + enum: + - unit:partPerMillion + - unit:percent + - unit:percentVolume + - unit:partPerThousand + - unit:partPerTrillionUs + - unit:partPerBillionUs + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PositiveTrait: + type: number + description: Constraint for only positive values. + minimum: 0.0 + exclusiveMinimum: false + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_HazardCharacteristic: + description: Characteristic for the hazardous classification. + type: object + properties: + category: + description: |- + The hazard category of the substance of concern. Defined in Article 2 of Regulation (EC) No 1272/2008 of the European Parliament and of the Council of 16 December 2008 on classification, labelling and packaging of substances and mixtures, amending and repealing Directives 67/548/EEC and 1999/45/EC, and amending Regulation (EC) No 1907/2006: + 2. 'hazard category' means the division of criteria within each hazard class, specifying hazard severity. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + class: + description: |- + The hazard class of the substance of concern. Defined in Article 2 of Regulation (EC) No 1272/2008 of the European Parliament and of the Council of 16 December 2008 on classification, labelling and packaging of substances and mixtures, amending and repealing Directives 67/548/EEC and 1999/45/EC, and amending Regulation (EC) No 1907/2006: + 1. 'hazard class' means the nature of the physical, health or environmental hazard. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + statement: + description: |- + The hazard statement of the substance of concern. Defined in Article 2 of Regulation (EC) No 1272/2008 of the European Parliament and of the Council of 16 December 2008 on classification, labelling and packaging of substances and mixtures, amending and repealing Directives 67/548/EEC and 1999/45/EC, and amending Regulation (EC) No 1907/2006: + 5. 'hazard statement' means a phrase assigned to a hazard class and category that describes the nature of the hazards of a hazardous substance or mixture, including, where appropriate, the degree of hazard. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + required: + - category + - class + - statement + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_RangeEntity: + description: "Entity for the concentration range with two values, the highest\ + \ and the lowest of the concentration range." + type: object + properties: + min: + description: |- + The minimum concentration of the substance of concern at the level of the product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7: + (5) (c) [...] concentration range of the substances of concern, at the level of the product [...]. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PositiveTrait' + max: + description: |- + The maximum concentration of the substance of concern at the level of the product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7: + (5) (c) the concentration, maximum concentration or concentration range of the substances of concern, at the level of the product [...]. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PositiveTrait' + required: + - max + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_RangeCharacteristic: + description: "Range characteristic with two values, the highest and the lowest\ + \ of the concentration range. Only providing the maximum range is also possible." + type: array + items: + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_RangeEntity' + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_ListTypeEnumerationId: + type: string + description: Enumeration of different systems and organizations related to the + identification and classification of chemical substances in the field of chemistry. + The enumeration values are EC or CAS. + enum: + - CAS + - EC + - IUPAC + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_MaterialIdEntity: + description: "Id Entity with identifier, name and list type." + type: object + properties: + id: + description: "The substance identification, in accordance with the specification\ + \ in the attribute for the list type." + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_IdentifierCharacteristic' + type: + description: "The type of standard used for the identification of the substances.\ + \ Selected can be for example CAS, IUPAC or EC." + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_ListTypeEnumerationId' + name: + description: The name of the material which is present in the product. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + required: + - id + - type + - name + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_MaterialIdList: + description: List of ids for the identification. + type: array + items: + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_MaterialIdEntity' + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_HeaderTrait: + type: string + description: Constraint for a maximum of 100 characters. + maxLength: 100 + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentationEntity: + description: "Entity for a document with a header, type and content." + type: object + properties: + content: + description: The content of the document e.g a link. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + contentType: + description: "The type of content which can be expected in the \"content\"\ + \ property. Examples are a link, restricted link, pdf, excel, etc." + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + header: + description: The header as a short description of the document with a maximum + of 100 characters. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_HeaderTrait' + required: + - content + - contentType + - header + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentList: + description: List of documents. + type: array + items: + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentationEntity' + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_SubstanceEntity: + description: Information regarding substances of concern in the product. + type: object + properties: + location: + description: |- + The location of the substances of concern within the product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7: + (5) (b) the location of the substances of concern within the product. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + unit: + description: "The unit of concentration chosen from an enumeration: mass\ + \ percent, volume percent, parts per thousand, parts per million, parts\ + \ per billion and parts per trillion." + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_ConcentrationEnumeration' + concentration: + description: | + Concentration of the material at the level of the product. This attribute is specially mentioned for substances of concern mentioned in the ESPR proposal from March 30th, 2022 Article 7: + (5) (c) the concentration, maximum concentration or concentration range of the substances of concern, at the level of the product [...]. + Other substances are mentioned for the purpose of recycling in the ESPR provisional agreement from January 9th, 2024 Annex I: + (d) design for recycling, ease and quality of recycling as expressed through: use of easily recyclable materials, safe, easy and non-destructive access to recyclable components and materials or components and materials containing hazardous substances and material composition and homogeneity, possibility for high-purity sorting, number of materials and components used, use of standard components, use of component and material coding standards for the identification of components and materials, number and complexity of processes and tools needed, ease of nondestructive disassembly and re-assembly, conditions for access to product data, conditions for access to or use of hardware and software needed. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PositiveTrait' + exemption: + description: |- + Exemptions to the substance of concern. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Article 7: + (5) (c) provide duly justified exemptions for substances of concern or information elements from the information requirements referred to in the first subparagraph based on the technical feasibility or relevance of tracking substances of concern, the existence of analytical methods to detect and quantify them, the need to protect confidential business information or in other duly justified cases. Substances of concern within the meaning of Article 2(28), point a), shall not be exempted if they are present in products, their relevant components or spare parts in a concentration above 0,1 % weight by weight. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + hazardClassification: + description: |- + The specification of the hazard class. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I: + (f) use of substances, and in particular the use of substances of concern, on their own, as constituents of substances or in mixtures, during the production process of products, or leading to their presence in products, including once these products become waste, and their impacts on human health and the environment; + Further defined is this by Regulation (EC) No 1272/2008 of the European Parliament and of the Council of 16 December 2008 on classification, labelling and packaging of substances and mixtures, amending and repealing Directives 67/548/EEC and 1999/45/EC, and amending Regulation (EC) No 1907/2006. + Defined in Article 2: + 1. 'hazard class' means the nature of the physical, health or environmental hazard; + 2. 'hazard category' means the division of criteria within each hazard class, specifying hazard severity; + 5. 'hazard statement' means a phrase assigned to a hazard class and category that describes the nature of the hazards of a hazardous substance or mixture, including, where appropriate, the degree of hazard; + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_HazardCharacteristic' + concentrationRange: + description: |- + The concentration range for the substance of concern. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7: + (5) (c) [...] concentration range of the substances of concern, at the level of the product [...]. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_RangeCharacteristic' + id: + description: "The chemical material name and identification, in accordance\ + \ with the specification in the attribute for the list type. Preference\ + \ is given to the IUPAC name. This attribute is mentioned in the ESPR\ + \ provisional agreement from January 9th, 2024 Article 7:\n(5) (a) the\ + \ name of the substances of concern present in the product, as follows:\n\ + \ - name(s) in the International Union of Pure and Applied Chemistry (IUPAC)\ + \ nomenclature, or another international name when IUPAC name is not available;\ + \ \n- other names (usual name, trade name, abbreviation);\n- European\ + \ Community (EC) number, as indicated in the European Inventory of Existing\ + \ Commercial Chemical Substances (EINECS), the European List of Notified\ + \ Chemical Substances (ELINCS) or the No Longer Polymer (NLP) list or\ + \ assigned by the European Chemicals Agency (ECHA), if available;\n- the\ + \ Chemical Abstract Service (CAS) name(s) and number(s), if available;\ + \ ." + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_MaterialIdList' + documentation: + description: Documentation accompanying the material. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentList' + required: + - location + - unit + - concentration + - exemption + - hazardClassification + - concentrationRange + - id + - documentation + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_SubstanceList: + description: Characteristic for a list of substances of concern. + type: array + items: + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_SubstanceEntity' + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_SubstanceOfConcernCharacteristic: + description: Substance of concern Characteristic of the product. + type: object + properties: + applicable: + description: "Check whether the connected attributes are applicable to the\ + \ product. If it is not applicable (false), dummy data can be delivered." + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Boolean' + content: + description: "Information regarding substances of concern in the product.\ + \ Attributes are among others substance names, ids, concentration, location\ + \ and hazard class. This is mentioned in the ESPR provisional agreement\ + \ from January 9th, 2024 Article 7:\n(5) (a) the name of the substances\ + \ of concern present in the product, as follows:\n- name(s) in the International\ + \ Union of Pure and Applied Chemistry (IUPAC) nomenclature, or another\ + \ international name when IUPAC name is not available; \n- other names\ + \ (usual name, trade name, abbreviation);\n- European Community (EC) number,\ + \ as indicated in the European Inventory of Existing Commercial Chemical\ + \ Substances (EINECS), the European List of Notified Chemical Substances\ + \ (ELINCS) or the No Longer Polymer (NLP) list or assigned by the European\ + \ Chemicals Agency (ECHA), if available;\n- the Chemical Abstract Service\ + \ (CAS) name(s) and number(s), if available;\n(5) (b) the location of\ + \ the substances of concern within the product.\n(5) (c) the concentration,\ + \ maximum concentration or concentration range of the substances of concern,\ + \ at the level of the product its relevant components, or spare parts;\n\ + (d) relevant instructions for the safe use of the product;\n(e) information\ + \ relevant for disassembly, preparation for reuse, reuse, recycling and\ + \ the environmentally sound management of the product at the end of its\ + \ life.\nAnd in the next paragraph:\n(c) provide duly justified exemptions\ + \ for substances of concern or information elements from the information\ + \ requirements referred to in the first subparagraph." + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_SubstanceList' + required: + - applicable + - content + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PercentageTrait: + type: number + description: Range constraint for a positive percentage value. + maximum: 100.0 + exclusiveMaximum: false + minimum: 0.0 + exclusiveMinimum: false + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_MaterialEntity: + description: Information regarding recycled and/or renewable materials in the + product. + type: object + properties: + recycled: + description: |- + The share of the material, which is recovered recycled content from the product. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I: + (h) use or content of recycled materials and recovery of materials, including critical raw materials; + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PercentageTrait' + renewable: + description: | + The share of the material, which is from a renewable resource that can be replenished. Renewable resources are those that can be reproduced by physical, chemical, or mechanical processes. These are the kind of resources that can be regenerated throughout time. Forest wood, for example, can be grown through reforestation. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I: + (ha) use or content of sustainable renewable materials; + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PercentageTrait' + unit: + description: "The unit of concentration chosen from an enumeration: mass\ + \ percent, volume percent, parts per thousand, parts per million, parts\ + \ per billion and parts per trillion." + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_ConcentrationEnumeration' + id: + description: "The chemical material name and identification, in accordance\ + \ with the specification in the attribute for the list type. Preference\ + \ is given to the IUPAC name. This attribute is mentioned in the ESPR\ + \ provisional agreement from January 9th, 2024 Article 7:\n(5) (a) the\ + \ name of the substances of concern present in the product, as follows:\n\ + \ - name(s) in the International Union of Pure and Applied Chemistry (IUPAC)\ + \ nomenclature, or another international name when IUPAC name is not available;\ + \ \n- other names (usual name, trade name, abbreviation);\n- European\ + \ Community (EC) number, as indicated in the European Inventory of Existing\ + \ Commercial Chemical Substances (EINECS), the European List of Notified\ + \ Chemical Substances (ELINCS) or the No Longer Polymer (NLP) list or\ + \ assigned by the European Chemicals Agency (ECHA), if available;\n- the\ + \ Chemical Abstract Service (CAS) name(s) and number(s), if available;\ + \ ." + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_MaterialIdList' + critical: + description: |- + A flag, if the material is a critical raw material. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I: + (h) use or content of recycled materials and recovery of materials, including critical raw materials; + In Annex II of the connected proposal Act of Critical Raw Materials, a list of critical raw materials can be found. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Boolean' + concentration: + description: | + Concentration of the material at the level of the product. This attribute is specially mentioned for substances of concern mentioned in the ESPR proposal from March 30th, 2022 Article 7: + (5) (c) the concentration, maximum concentration or concentration range of the substances of concern, at the level of the product [...]. + Other substances are mentioned for the purpose of recycling in the ESPR provisional agreement from January 9th, 2024 Annex I: + (d) design for recycling, ease and quality of recycling as expressed through: use of easily recyclable materials, safe, easy and non-destructive access to recyclable components and materials or components and materials containing hazardous substances and material composition and homogeneity, possibility for high-purity sorting, number of materials and components used, use of standard components, use of component and material coding standards for the identification of components and materials, number and complexity of processes and tools needed, ease of nondestructive disassembly and re-assembly, conditions for access to product data, conditions for access to or use of hardware and software needed. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PositiveTrait' + documentation: + description: Documentation accompanying the material. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentList' + required: + - recycled + - renewable + - unit + - id + - critical + - concentration + - documentation + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_MaterialList: + description: A list of different materials in the product. + type: array + items: + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_MaterialEntity' + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_MaterialCharacteristic: + description: Material Characteristic with information on the materials. + type: object + properties: + applicable: + description: "Check whether the connected attributes are applicable to the\ + \ product. If it is not applicable (false), dummy data can be delivered." + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Boolean' + content: + description: Information on different materials in the product. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_MaterialList' + required: + - applicable + - content + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_MaterialsCharacteristic: + description: Materials Characteristic on product level. + type: object + properties: + substancesOfConcern: + description: |- + Information regarding substances of concern in the product. The ESPR provisional agreement from January 9th, 2024 defines: + (52) 'hazardous substance' means a substance classified as hazardous pursuant to Article 3 of Regulation (EC) No 1272/2008. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_SubstanceOfConcernCharacteristic' + materialComposition: + description: Material composition of the product with information on recycled + and renewable materials. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_MaterialCharacteristic' + required: + - substancesOfConcern + - materialComposition + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_StateEnumeration: + type: string + description: "Enumeration defined as original, repurposed, re-used, remanufactured\ + \ or waste." + enum: + - original + - repurposed + - re-used + - remanufactured + - waste + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_CategoryEnumeration: + type: string + description: Enumeration of the 19 impact categories in accordance to EN15804+A2. + enum: + - Climate Change Total + - Climate Change Fossil + - Climate Change Biogenic Removals and Emissions + - Climate Change Land Use and Land Use Change + - Ozone Depletion + - Acidification + - Eutrophication Aquatic Freshwater + - Eutrophication Fresh Marine + - Eutrophication Terrestrial + - Photochemical Ozone Formation + - Abiotic Depletion- Minerals and Metals + - Fossil Fuels + - Water Use + - Particulate Matter Emissions + - "Ionizing Radiation, Human Health" + - Eco-Toxicity + - "Human Toxicity, Cancer Effects" + - "Human Toxicity, Non-Cancer Effects" + - Land Use Related Impacts/Soil Quality + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_FootprintEntity: + description: "Footprint Entity for the carbon and environmental footprint with\ + \ the total value, unit, impact category type, lifecycle, rulebook, declaration,\ + \ performance class and the facility." + type: object + properties: + value: + description: | + The value of the footprint of the product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Annex I: + (l) the environmental footprint of the product, expressed as a quantification, in accordance with the applicable delegated act, of a product's life cycle environmental impacts, whether in relation to one or more environmental impact categories or an aggregated set of impact categories; + (m) the carbon footprint of the product; + (ma) the material footprint of the product. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PositiveTrait' + rulebook: + description: The applied rulebook for the environmental footprint of the + product. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentList' + lifecycle: + description: "The lifecycle stage, to which the environmental footprint\ + \ corresponds. These could be for example \"raw material acquisition and\ + \ pre-processing\", \"main product production\", \"distribution\" or \"\ + end of life and recycling\"." + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + unit: + description: "The unit of measurement of the environmental impact category.\ + \ For each impact category a specific unit is used. If an aggregation\ + \ is used, utilize the normalization and weighting methods used in the\ + \ referenced rulebook." + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + type: + description: |- + The type of the environmental footprint of the product. This could be one of the environmental impact categories. This attribute is mentioned in the ESPR provisional agreement from January 9th 2024 Article 7: + (2)(b)(i) information on the performance of the product in relation to one or more of the product parameters referred to in Annex I, including a scoring of reparability or durability, carbon footprint or environmental footprint; + Annex I: + (l) the environmental footprint of the product, expressed as a quantification, in accordance with the applicable delegated act, of a product's life cycle environmental impacts, whether in relation to one or more environmental impact categories or an aggregated set of impact categories. + (m) the carbon footprint of the product; + (ma) the material footprint of the product. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_CategoryEnumeration' + performanceClass: + description: The performance classification of the footprint. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + manufacturingPlant: + description: The manufacturing plant of the footprint in the specific lifecycle + phase. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_FacilityList' + declaration: + description: 'The footprint declaration in the format of a link ' + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentList' + required: + - value + - rulebook + - lifecycle + - unit + - type + - manufacturingPlant + - declaration + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_FootprintList: + description: Footprint List for the environmental footprint. + type: array + items: + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_FootprintEntity' + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_ProductFootprintCharacteristic: + description: The Product Footprint Characteristic with sustainability information. + type: object + properties: + environmental: + description: |- + The environmental footprint of the product. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I: + The following parameters shall, as appropriate, and where necessary supplemented by others, be used, individually or combined, as a basis for improving the product aspects referred to in Article 5(1): + (l) the environmental footprint of the product, expressed as a quantification, in accordance with the applicable delegated act, of a product's life cycle environmental impacts, whether in relation to one or more environmental impact categories or an aggregated set of impact categories. + and Article 7: + (2)(b)(i) information on the performance of the product in relation to one or more of the product parameters referred to in Annex I, including a scoring of reparability or durability, carbon footprint or environmental footprint; + and defined by Article 2: + (23) 'environmental footprint' means a quantification of product environmental impacts throughout its life cycle, whether in relation to a single environmental impact category or an aggregated set of impact categories based on the Product Environmental Footprint method or other scientific methods developed by international organisations and widely tested in collaboration with different industry sectors and adopted or implemented by the Commission in other Union legislation; + (24) 'Product Environmental Footprint method' means the life cycle assessment method to quantify the environmental impacts of products established by Recommendation (EU) 2021/2279. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_FootprintList' + carbon: + description: |- + The carbon footprint of the product. This is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I: + The following parameters shall, as appropriate, and where necessary supplemented by others, be used, individually or combined, as a basis for improving the product aspects referred to in Article 5(1): + (m) the carbon footprint of the product; + and Article 7: + (2)(b)(i) information on the performance of the product in relation to one or more of the product parameters referred to in Annex I, including a scoring of reparability or durability, carbon footprint or environmental footprint; + and defined by Article 2: + (25) 'carbon footprint' means the sum of greenhouse gas (GHG) emissions and GHG removals in a product system, expressed as CO2 equivalents and based on a life cycle assessment using the single impact category of climate change. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_FootprintList' + material: + description: |- + The material footprint of the product. This is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I: + (ma) the material footprint of the product; + and defined by Article 2: + (25a) 'material footprint' refers to the total amount of raw materials extracted to meet final consumption demands. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_FootprintList' + required: + - carbon + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_SustainabilityCharacteristic: + description: Characteristic which describes relevant information for the sustainability + of the product. + type: object + properties: + status: + description: |- + The status of the product (original, repurposed, re-used, remanufactured or waste) to indicated, whether it is a used product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Annex I: + (j) incorporation of used components. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_StateEnumeration' + productFootprint: + description: "The carbon and environmental footprint or material footprint\ + \ of the product. These attributes are mentioned in the ESPR provisional\ + \ agreement from January 9th 2024 Annex I:\n(l) the environmental footprint\ + \ of the product, expressed as a quantification, in accordance with the\ + \ applicable delegated act, of a product's life cycle environmental impacts,\ + \ whether in relation to one or more environmental impact categories or\ + \ an aggregated set of impact categories;\n(m) the carbon footprint of\ + \ the product;\n(ma) the material footprint of the product;\nAll are defined\ + \ by Article 2:\n(23) 'environmental footprint' means a quantification\ + \ of product environmental impacts throughout its life cycle, whether\ + \ in relation to a single environmental impact category or an aggregated\ + \ set of impact categories based on the Product Environmental Footprint\ + \ method or other scientific methods developed by international organisations\ + \ and widely tested in collaboration with different industry sectors and\ + \ adopted or implemented by the Commission in other Union \nlegislation;\n\ + (25) 'carbon footprint' means the sum of greenhouse gas (GHG) emissions\ + \ and GHG removals in a product system, expressed as CO2 equivalents and\ + \ based on a life cycle assessment using the single impact category of\ + \ climate change.\n(25a) 'material footprint' refers to the total amount\ + \ of raw materials extracted to meet final consumption demands;" + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_ProductFootprintCharacteristic' + reparabilityScore: + description: |- + The reparability score. This attribute is mentioned ESPR provisional agreement from January 9th, 2024 Article 7: + (b) as appropriate, also require products to be accompanied by: + (i) information on the performance of the product in relation to one or more of the product parameters referred to in Annex I, including a scoring of reparability or durability [...]. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + durabilityScore: + description: |- + The durability score. This attribute is mentioned ESPR provisional agreement from January 9th, 2024 Article 7: + (b) as appropriate, also require products to be accompanied by: + (i) information on the performance of the product in relation to one or more of the product parameters referred to in Annex I, including a scoring of reparability or durability [...]. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + required: + - status + - productFootprint + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_SourceCategoryEnumeration: + type: string + description: The types of sources that can be linked in a digital product passport + can vary depending on the nature of the product and the information that needs + to be included. This is an enumeration of possible sources. + enum: + - Product Specifications + - Manufacturer Information + - User Manuals and Guides + - Certifications and Compliance + - Product Images and Videos + - Warranty Information + - Reviews and Ratings + - Product Variations + - Supply Chain Information + - Environmental Impact + - Compatibility and Accessories + - FAQs and Support + - Purchase and Retail Information + - Privacy and Data Handling + - Third-Party Integrations + - Legal Information + - Safety Information + - Repair and Installation + - Waste Generation and Prevention + - Specific Voluntary Labels + - Product Packaging + - Return and Disposal + - End of Life + - Material and Substance Information + - Technical Documentation + - Treatment facilities + - Other + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentEntity: + description: "Document entity with header, content, category and type." + type: object + properties: + content: + description: The content of the document e.g a link. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + category: + description: |- + The category in which the document can be sorted. These are mentioned in the ESPR proposal from March 30th, 2022 ANNEX III: + (e) compliance documentation and information required under this Regulation or other Union law applicable to the product, such as the declaration of conformity, technical documentation or conformity certificates; + ANNEX IV states additional information regarding the content of the technical documentation + Further information on documents are mentioned in the proposal from March 30th, 2022 ANNEX III: + (f) user manuals, instructions, warnings or safety information, as required by other Union legislation applicable to the product. + Additionally requirements are mentioned in Article 21: + (7) Manufacturers shall ensure that that a product covered by a delegated act adopted pursuant to Article 4 is accompanied by instructions that enable consumers and other end-users to safely assemble, install, operate, store, maintain, repair and dispose of the product in a language that can be easily understood by consumers and other end-users, as determined by the Member State concerned. Such instructions shall be clear, understandable and legible and include at least the information specified in the delegated acts adopted pursuant to Article 4 and pursuant to Article 7(2)(b), point (ii). + Article 7 states additionally: + (2) (b) (ii) information for consumers and other end-users on how to install, use, maintain and repair the product in order to minimize its impact on the environment and to ensure optimum durability, as well as on how to return or dispose of the product at end-of-life; + (2) (b) (iii) information for treatment facilities on disassembly, recycling, or disposal at end-of-life; + (2) (b) (iv) other information that may influence the way the product is handled by parties other than the manufacturer in order to improve performance in relation to product parameters referred to in Annex I. + (5) (d) relevant instructions for the safe use of the product. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_SourceCategoryEnumeration' + type: + description: "The type of content which can be expected in the \"content\"\ + \ property. Examples are a link, restricted link, pdf, excel, etc." + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + header: + description: The header as a short description of the document with a maximum + of 100 characters. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_HeaderTrait' + required: + - content + - category + - type + - header + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_SourceList: + description: A list of documents. + type: array + items: + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentEntity' + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_UnitCatalog: + type: string + description: Link to the unit catalog with all possible units in the format + "unit:xxx". + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DataTypeEnumeration: + type: string + description: "Data type that describe the content of the attributes children\ + \ and data. In case \"object\" is selected in the enumeration, the children\ + \ field will be used in the AdditionalDataEntity instead of the \"data\" property.\ + \ If it is an other type, the content will be specified in \"data\" as a string." + enum: + - array + - object + - xsd:string + - xsd:integer + - xsd:boolean + - xsd:double + - xsd:float + - xsd:byte + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_TypeCharacteristic: + description: Characteristic for the data type. + type: object + properties: + typeUnit: + description: "Choose a unit type from the unit catalog, or if the property\ + \ \"children\" is filled, leave empty." + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_UnitCatalog' + dataType: + description: "Data type that describe the content of the attributes children\ + \ and data. In case \"object\" is selected in the enumeration, the children\ + \ field will be used in the AdditionalDataEntity instead of the \"data\"\ + \ property. If it is an other type, the content will be specified in \"\ + data\" as a string." + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DataTypeEnumeration' + required: + - dataType + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_AdditionalDataEntity: + description: "Entity with additional data. Properties are label, description,\ + \ type, data and children. Either the fields data or children filled. Children\ + \ constructs a hierarchy with the same attributes. Data is filled as the end\ + \ of an path/leaf." + type: object + properties: + label: + description: The human readable name of the attribute. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + description: + description: The description of the attribute context. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + type: + description: The complex description of the type. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_TypeCharacteristic' + data: + description: The content from the attribute which is a depended of the data + type and typeUnit. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + children: + description: Children of the hierarchy. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_AdditionalDataList' + required: + - label + - description + - type + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_AdditionalDataList: + description: List of additional data. + type: array + items: + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_AdditionalDataEntity' + DigitalProductPassport: + description: |- + The Digital Product Passport (DPP) allows to share process and product-related information amongst supply chain businesses, authorities and consumers. The DPP allows for efficient information flows following best practices; and the possibility of accompanying the measures under this Regulation with mitigating measures so that impacts are expected to remain proportionate for SMEs.This is expected to increase transparency, both for supply chain businesses and for the general public, and increase efficiencies in terms of information transfer to support the data exchange between economic actors in integrating circularity in product design and manufacturing. + In particular, it is likely to help facilitate and streamline the monitoring and enforcement of the regulation carried out by EU and Member State authorities. It is also likely to provide a market-intelligence tool that may be used for revising and refining obligations in the future. + The DPP includes data about components, materials and chemical substances, information on reparability, spare parts, environmental impact and professional disposal for a product. + The data model will be updated, as newer versions of the regulation will be published. + The main basis is provided by the document "Proposal for a REGULATION OF THE EUROPEAN PARLIAMENT AND OF THE COUNCIL establishing a framework for setting ecodesign requirements for sustainable products and repealing Directive 2009/125/EC" from March 30th, 2022. The latest version of the document was the provisional agreement between the EU Council and the Parliament from January 9th, 2024. The text is informal, but the content of the final regulation was agreed between these two institutions. + The Title of Ecodesign Regulation has been changed to: Proposal for a REGULATION OF THE EUROPEAN PARLIAMENT AND OF THE COUNCIL establishing a framework for setting ecodesign requirements for sustainable products, amending Regulation (EU) 2023/1542 and repealing Directive 2009/125/EC. + type: object + properties: + metadata: + description: "Metadata of the product passport. These are mentioned in the\ + \ ESPR proposal from March 30th, 2022 and some changed by the provisional\ + \ agreement from January 9th, 2024." + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_MetadataCharacteristic' + identification: + description: "Identification information of the product, especially identifiers\ + \ and codes. These are mentioned in the ESPR provisional agreement from\ + \ January 9th, 2024 ANNEX III:\n(b) the unique product identifier at the\ + \ level indicated in the applicable delegated act adopted pursuant to\ + \ Article 4.\nAdditionally in Article 9 regarding general requirements\ + \ for the product passport is stated that:\nA product passport shall meet\ + \ the following conditions:\n(a) it shall be connected through a data\ + \ carrier to a persistent unique product identifier;\n(e) the information\ + \ included in the product passport shall refer to the product model, batch,\ + \ or item as specified in the delegated act adopted pursuant to Article\ + \ 4.\nArticle 2 Definitions: \n(31) 'unique product identifier' means\ + \ a unique string of characters for the identification of products that\ + \ also enables a web link to the product passport;\nRecital (27): A 'model'\ + \ usually means a version of a product of which all units share the same\ + \ technical characteristics relevant for the ecodesign requirements and\ + \ the same model identifier, a 'batch' usually means a subset of a specific\ + \ model composed of all products produced in a specific manufacturing\ + \ plant at a specific moment in time and an 'item' usually means a single\ + \ unit of a model." + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_IdentificationCharacteristic' + operation: + description: Operational information of the product. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_OperationCharacteristic' + handling: + description: Properties connected with the handling of the product. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_HandlingCharacteristic' + characteristics: + description: Defines specific characteristics of a product. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_ProductCharacteristics' + commercial: + description: Commercial information of the product. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_CommercialCharacteristic' + materials: + description: Properties which are relevant for the materials of the product. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_MaterialsCharacteristic' + sustainability: + description: Sustainability related attributes. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_SustainabilityCharacteristic' + sources: + description: |- + Documents that are mandatory if applicable for the product. These are mentioned in the ESPR provisional agreement from January 9th, 2024 ANNEX III: + (e) compliance documentation and information required under this Regulation or other Union law applicable to the product, such as the declaration of conformity, technical documentation or conformity certificates; + (f) user manuals, instructions, warnings or safety information, as required by other Union legislation applicable to the product. + Additionally requirements are mentioned in Article 21: + 7. Manufacturers shall ensure that a product covered by a delegated act adopted pursuant to Article 4 is accompanied by instructions in digital format that enable customers and other relevant actors to assemble, install, operate, store, maintain, repair and dispose of the product in a language that can be easily understood, as determined by the Member State concerned. Such instructions shall be clear, understandable and legible and include at least the information set out in Article 7(2), point (b), point (ii) specified in the delegated acts adopted pursuant to Article 4. + Article 7 states additionally: + (ii) information for customers and other actors on how to install, use, maintain and repair the product, in order to minimise its impact on the environment and to ensure optimum durability, on how to install third-party operating systems where relevant, as well as on collection for refurbishment or remanufacture, and on how to return or handle the product at the end of its life; + (2) (b) (iii) information for treatment facilities on disassembly, reuse, refurbishment, recycling, or disposal at end-of-life; + (2) (b) (iv) other information that may influence sustainable product choices for customers and the way the product is handled by parties other than the manufacturer in order to facilitate appropriate use, value retaining operations and correct treatment at end-of-life. + (5) (d) relevant instructions for the safe use of the product. + (5) (e) information relevant for disassembly, preparation for reuse, reuse, recycling and the environmentally sound management of the product at the end of its life. + Annex I: + (b) [...] availability of repair and maintenance instructions, number of materials and components used, use of standard components,[...] number and complexity of processes and whether specialised toolsare needed, ease of non-destructive disassembly and re-assembly, conditions for access to product data, conditions for access to or use of hardware and software needed; + (c) ease of upgrading, re-use, remanufacturing and refurbishment as expressed through: [...] number and complexity of processes and tools needed, ease of non-destructive disassembly and re-assembly, conditions for access to product data, conditions for access to or use of hardware and software needed, conditions of access to test protocols or not commonly available testing equipment, availability of guarantees specific to remanufactured or refurbished products, conditions for access to or use of technologies protected by intellectual property rights, modularity; + (d) design for recycling, ease and quality of recycling as expressed through: use of easily recyclable materials, safe, easy and non-destructive access to recyclable components and materials or components and materials containing hazardous substances and material composition and homogeneity, possibility for high-purity sorting, [...] number and complexity of processes and tools needed, ease of nondestructive disassembly and re-assembly, conditions for access to product data, conditions for access to or use of hardware and software needed; + (q) functional performance and conditions for use including as expressed through ability in performing its intended use, precautions of use, skills required, compatibility with other products or systems. + Additionally to consider are guidelines and instructions regarding the proper management and disposal of packaging materials after use. This can include instructions for separation, reuse, and recycling. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_SourceList' + additionalData: + description: "Data in form of open fields which need to be transferred in\ + \ addition. The regulation is still under development and may change in\ + \ the future. To accommodate this, additional data allows the option to\ + \ include additional data required by future changes to the regulation.\ + \ In addition, the DPP can be easily updated and adapted to the new requirements.\ + \ \nThe ESPR provisional agreement from January 9th, 2024 Article 9 mentions:\n\ + 2. Where other Union legislation requires or allows the inclusion of specific\ + \ information in the product passport, that information may be included\ + \ in the product passport pursuant to the applicable delegated act adopted\ + \ pursuant to Article 4." + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_AdditionalDataList' + required: + - metadata + - identification + - operation + - handling + - characteristics + - commercial + - materials + - sustainability + - sources + 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' + DigitalProductPassport: + content: + application/json: + schema: + $ref: '#/components/schemas/PagingSchema' + description: The request was successful. + requestBodies: + DigitalProductPassport: + content: + application/json: + schema: + $ref: '#/components/schemas/DigitalProductPassport' diff --git a/io.catenax.generic.digital_product_passport/5.0.0/metadata.json b/io.catenax.generic.digital_product_passport/5.0.0/metadata.json new file mode 100644 index 000000000..eb94ac1ea --- /dev/null +++ b/io.catenax.generic.digital_product_passport/5.0.0/metadata.json @@ -0,0 +1 @@ +{ "status" : "release"} diff --git a/io.catenax.generic.digital_product_passport/RELEASE_NOTES.md b/io.catenax.generic.digital_product_passport/RELEASE_NOTES.md index 19f85f32c..7d5169154 100644 --- a/io.catenax.generic.digital_product_passport/RELEASE_NOTES.md +++ b/io.catenax.generic.digital_product_passport/RELEASE_NOTES.md @@ -1,7 +1,23 @@ # Changelog All notable changes to this model will be documented in this file. -## [4.0.0] - 2023-02-19 +## [5.0.0] - 2024-05-21 +### Changed +- structure and pattern below chemicalName and chemicalId changed for materials +- header example value made more generic +- codeKey is now open and no longer an enumeration +- description text added for packaging sustainability information in the attribute structure for sources + +### Added +- lastModification in metadata (optional) +- otherOperatorsId in operation (optional) +- otherOperatorsRole in operation (optional) +- purpose attribute added in commercial + +### Deleted +- codeDescription deleted due to duplication with codeKey + +## [4.0.0] - 2024-02-19 ### Changed - Either-or possibilities are deleted in order to only allow one possible verifiable input - Changed descriptions to reference the latest regulation from January 9th, 2024. diff --git a/io.catenax.manufactured_parts_quality_information/1.0.0/metadata.json b/io.catenax.manufactured_parts_quality_information/1.0.0/metadata.json index a182c7b85..970dbd818 100644 --- a/io.catenax.manufactured_parts_quality_information/1.0.0/metadata.json +++ b/io.catenax.manufactured_parts_quality_information/1.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.manufactured_parts_quality_information/RELEASE_NOTES.md b/io.catenax.manufactured_parts_quality_information/RELEASE_NOTES.md index b88bbfdc2..e137afce4 100644 --- a/io.catenax.manufactured_parts_quality_information/RELEASE_NOTES.md +++ b/io.catenax.manufactured_parts_quality_information/RELEASE_NOTES.md @@ -13,7 +13,7 @@ All notable changes to this model will be documented in this file. ### Removed -## [2.0.0] - 2024-01-29 +## [2.0.0] - 2024-01-29 -> deprecated ### Added - metaInformation property added to root entity - integration of the shared UUID characteristic and RegEx for Catena-X identifiers @@ -26,7 +26,7 @@ All notable changes to this model will be documented in this file. ### Removed - Manufacturing entity -> all properties are now located on ManufacturedPart entity -## [1.0.0] - 2022-12-13 +## [1.0.0] - 2022-12-13 -> deprecated ### Added - initial version of this model diff --git a/io.catenax.material.chemical_material_passport/2.0.0/ChemicalMaterialPassport.ttl b/io.catenax.material.chemical_material_passport/2.0.0/ChemicalMaterialPassport.ttl new file mode 100644 index 000000000..ec4319e97 --- /dev/null +++ b/io.catenax.material.chemical_material_passport/2.0.0/ChemicalMaterialPassport.ttl @@ -0,0 +1,834 @@ +####################################################################### +# Copyright (c) 2024 BASF SE +# Copyright (c) 2024 BMW AG +# Copyright (c) 2024 CGI Deutschland B.V. & Co. KG +# Copyright (c) 2024 Henkel AG & Co. KGaA +# Copyright (c) 2024 T-Systems International GmbH +# Copyright (c) 2024 ZF Friedrichshafen AG +# Copyright (c) 2024 Contributors to the Eclipse Foundation +# +# 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-passport: . +@prefix ext-quantity: . + +:ChemicalMaterialPassport a samm:Aspect ; + samm:preferredName "Chemical Material Passport"@en ; + samm:description "The information in a Digital Product Passport allows stakeholders in the value chain to map information and obtain a better understanding of the composition of the product, the environmental impact of the production and use phase, and the aspect of circularity. To serve the same purpose as the Digital Passport, the Chemical Material Passport also plays an important role in providing more detailed information in terms of sustainability, safety and waste management. It can replace the current way of communication and data exchange from multi-channels by one streamlined data flow."@en ; + samm:properties ( [ samm:property :productSpecificParameters; samm:payloadName "specific" ] [ samm:property :genericParameters; samm:payloadName "generic" ] ) ; + samm:operations ( ) ; + samm:events ( ) . + +:productSpecificParameters a samm:Property ; + samm:preferredName "Product Specific Parameters"@en ; + samm:description "Product specific parameters of the electric drive."@en ; + samm:characteristic :SpecificCharacteristic . + +:genericParameters a samm:Property ; + samm:preferredName "Product Generic Parameters"@en ; + samm:description "The product generic parameters. These are defined by the Digital Product Passport proposal from the ESPR. The main basis is provided by the document \"Proposal for a REGULATION OF THE EUROPEAN PARLIAMENT AND OF THE COUNCIL establishing a framework for setting ecodesign requirements for sustainable products and repealing Directive 2009/125/EC\" from March 30th, 2022. The latest version of the document was the provisional agreement between the EU Council and the Parliament from January 9th, 2024."@en ; + samm:characteristic :GenericCharacteristic . + +:SpecificCharacteristic a samm:Characteristic ; + samm:preferredName "Specific Characteristic"@en ; + samm:description "The Characteristic to describe product specific parameters of the electric drive."@en ; + samm:dataType :SpecificEntity . + +:GenericCharacteristic a samm:Characteristic ; + samm:preferredName "Generic Characteristic"@en ; + samm:description "Characteristic for the product generic parameters."@en ; + samm:dataType :GenericEntity . + +:SpecificEntity a samm:Entity ; + samm:preferredName "Specific Entity"@en ; + samm:description "The Entity for product specific parameters of the electric drive."@en ; + samm:properties ( :parameter :productType :hazardAssessment :transport :disposal :safety :compliance ) . + +:GenericEntity a samm:Entity ; + samm:preferredName "Generic Entity"@en ; + samm:description "Entity for the product generic parameters."@en ; + samm:properties ( ext-passport:identification ext-passport:operation ext-passport:characteristics ext-passport:commercial ext-passport:materials ext-passport:sources ext-passport:sustainability ext-passport:metadata ) . + +:parameter a samm:Property ; + samm:preferredName "Parameter"@en ; + samm:description "Parameters of the chemical material."@en ; + samm:characteristic :ParameterCharacteristic . + +:productType a samm:Property ; + samm:preferredName "Product Type"@en ; + samm:description "Information, whether the product is a substance, mixture or article. Definitions from REACH Regulation (EC) No 1907/2006: \n\"substance\": means a chemical element and its compounds in the natural state or obtained by any manufacturing process, including any additive necessary to preserve its stability and any impurity deriving from the process used, but excluding any solvent which may be separated without affecting the stability of the substance or changing its composition;\n\"mixture\": means a mixture or solution composed of two or more substances;\n\"article\": means an object which during production is given a special shape, surface or design which determines its function to a greater degree than does its chemical composition;"@en ; + samm:see ; + samm:characteristic :MaterialEnumeration ; + samm:exampleValue "substance" . + +:hazardAssessment a samm:Property ; + samm:preferredName "Hazard Assessment"@en ; + samm:description "Hazard assessment refers to evaluating and identifying potential risks or dangers associated with the specific material."@en ; + samm:characteristic :HazardAssessmentCharacteristic . + +:transport a samm:Property ; + samm:preferredName "Transport"@en ; + samm:description "Transport related information."@en ; + samm:characteristic :TransportCharacteristic . + +:disposal a samm:Property ; + samm:preferredName "Disposal"@en ; + samm:description "The safe and appropriate elimination or management of these materials once they are no longer needed or usable."@en ; + samm:characteristic :DisposalCharacteristic . + +:safety a samm:Property ; + samm:preferredName "Safety"@en ; + samm:description "Safety related attributes of the chemical material."@en ; + samm:characteristic :SafetyCharacteristic . + +:compliance a samm:Property ; + samm:preferredName "Compliance"@en ; + samm:description "Compliance refers to adhering to relevant regulations, standards, or specifications regarding the testing, documentation, and presentation of parameters, methods, and results. This ensures that the product meets required safety, quality, and regulatory standards throughout its lifecycle, from manufacturing to post-application use."@en ; + samm:characteristic :ComplianceCharacteristic . + +:ParameterCharacteristic a samm:Characteristic ; + samm:preferredName "Parameter Characteristic"@en ; + samm:description "Parameter Characteristic for the chemical material."@en ; + samm:dataType :ParameterEntity . + +:MaterialEnumeration a samm-c:Enumeration ; + samm:preferredName "Material Enumeration"@en ; + samm:description "Enumeration with the values substance, mixture and article."@en ; + samm:dataType xsd:string ; + samm-c:values ( "substance" "mixture" "article" ) . + +:HazardAssessmentCharacteristic a samm:Characteristic ; + samm:preferredName "Hazard Assessment Characteristic"@en ; + samm:description "Characteristic for the hazard assessment."@en ; + samm:dataType :HazardAssessmentEntity . + +:TransportCharacteristic a samm:Characteristic ; + samm:preferredName "Transport Characteristic"@en ; + samm:description "Characteristic for transport."@en ; + samm:dataType :TransportEntity . + +:DisposalCharacteristic a samm:Characteristic ; + samm:preferredName "Disposal Characteristic"@en ; + samm:description "Characteristic for disposal related attributes."@en ; + samm:dataType :DisposalEntity . + +:SafetyCharacteristic a samm:Characteristic ; + samm:preferredName "Safety Characteristic"@en ; + samm:description "Characteristic for safety information."@en ; + samm:dataType :SafetyEntity . + +:ComplianceCharacteristic a samm:Characteristic ; + samm:preferredName "Compliance Characteristic"@en ; + samm:description "Characteristic for compliance attributes."@en ; + samm:dataType :ComplianceEntity . + +:ParameterEntity a samm:Entity ; + samm:preferredName "Parameter Entity"@en ; + samm:description "Parameter Entity for the chemical material."@en ; + samm:properties ( :parameterBeforeUse :parameterAfterUse ) . + +:HazardAssessmentEntity a samm:Entity ; + samm:preferredName "Hazard Assessment Entity"@en ; + samm:description "Entity for the hazard assessment."@en ; + samm:properties ( :classification :labeling [ samm:property :hazardAssessmentDocumentation; samm:payloadName "documentation" ] ) . + +:TransportEntity a samm:Entity ; + samm:preferredName "Transport Entity"@en ; + samm:description "Entity for transport attributes."@en ; + samm:properties ( :productTransport :unTransport ) . + +:DisposalEntity a samm:Entity ; + samm:preferredName "Disposal Entity"@en ; + samm:description "Entity for disposal related attributes."@en ; + samm:properties ( [ samm:property :disposalBeforeUse; samm:payloadName "beforeUse" ] [ samm:property :disposalAfterUse; samm:payloadName "afterUse" ] [ samm:property :disposalWasteCode; samm:payloadName "wasteCode" ] [ samm:property :disposalPackagingInformation; samm:payloadName "packaging" ] ) . + +:SafetyEntity a samm:Entity ; + samm:preferredName "Safety Entity"@en ; + samm:description "Entity for safety information."@en ; + samm:properties ( [ samm:property :safetyDocumentation; samm:payloadName "documentation" ] :emergencyPhone :firstAidDocument ) . + +:ComplianceEntity a samm:Entity ; + samm:preferredName "Compliance Entity"@en ; + samm:description "Entity for compliance attributes."@en ; + samm:properties ( :complianceCountry :complianceRegulationName :complianceResult [ samm:property :complianceReasonForExemption; samm:optional true ] [ samm:property :complianceRemark; samm:optional true ] ) . + +:parameterBeforeUse a samm:Property ; + samm:preferredName "Parameter Before Use"@en ; + samm:description "Parameters of the chemical material before use."@en ; + samm:characteristic :ParameterBeforeUseList . + +:parameterAfterUse a samm:Property ; + samm:preferredName "Parameter After Use"@en ; + samm:description "Parameters of the chemical material after use."@en ; + samm:characteristic :ParameterAfterUseCharacteristic . + +:classification a samm:Property ; + samm:preferredName "Classification"@en ; + samm:description "Classification for the hazard assessment."@en ; + samm:characteristic :ClassificationList . + +:labeling a samm:Property ; + samm:preferredName "Labeling"@en ; + samm:description "The material labeling."@en ; + samm:see ; + samm:characteristic :LabelingCharacteristic . + +:hazardAssessmentDocumentation a samm:Property ; + samm:preferredName "Hazard Assessment Documentation"@en ; + samm:description "Documentation providing hazard assessment information for ensuring the safe management of chemical materials throughout their lifecycle."@en ; + samm:characteristic ext-passport:DocumentList . + +:productTransport a samm:Property ; + samm:preferredName "Product Transport"@en ; + samm:description "Transport related attributes, which are not UN related."@en ; + samm:characteristic :ProductTransportCharacteristic . + +:unTransport a samm:Property ; + samm:preferredName "UN Transport"@en ; + samm:description "Transport related attributes from the UN."@en ; + samm:characteristic :UNTransportList . + +:disposalBeforeUse a samm:Property ; + samm:preferredName "Disposal Before Use"@en ; + samm:description "Management and disposal practices for chemicals that are no longer needed or deemed unsuitable for their intended purpose. This information can be provided as a document, detailing the properties of waste that render it hazardous, along with disposal and recovery operations or recommendations, and accidental release measures."@en ; + samm:characteristic ext-passport:DocumentList . + +:disposalAfterUse a samm:Property ; + samm:preferredName "Disposal After Use"@en ; + samm:description "Chemical Management and Disposal Guides post-usage as document."@en ; + samm:characteristic ext-passport:DocumentList . + +:disposalWasteCode a samm:Property ; + samm:preferredName "Disposal Waste Code"@en ; + samm:description "A waste code is a standardized alphanumeric code used to classify different types of waste according to their characteristics, origin, and potential hazards. These codes help in proper identification, handling, treatment, and disposal of waste materials."@en ; + samm:characteristic :WasteCodeCharacteristic . + +:disposalPackagingInformation a samm:Property ; + samm:preferredName "Disposal Packaging Information"@en ; + samm:description "Guidelines and instructions regarding the proper management and disposal of packaging materials after use. Includes instructions on separation, reuse, and recycling."@en ; + samm:characteristic ext-passport:DocumentList . + +:safetyDocumentation a samm:Property ; + samm:preferredName "Safety Documentation"@en ; + samm:description "Safety information in a document that outlines safety protocols, procedures, and guidelines to be followed in specific situations involving the product. It provides clear instructions on accident prevention, how to respond to emergencies, and mitigate potential hazards. Examples include exposure scenarios, safety data sheets, risk assessments, and information on safety equipment and personal protective equipment (PPE)."@en ; + samm:characteristic ext-passport:DocumentList . + +:emergencyPhone a samm:Property ; + samm:preferredName "Emergency Phone"@en ; + samm:description "A phone number in case of emergency serves the vital purpose of providing immediate access to emergency responders."@en ; + samm:characteristic :EmergencyList . + +:firstAidDocument a samm:Property ; + samm:preferredName "First Aid Document"@en ; + samm:description "Information on how to proceed in case of an emergency is essential. It includes guidance on providing initial assistance or immediate care to a person who has been injured before professional medical help arrives."@en ; + samm:characteristic ext-passport:DocumentList . + +:complianceCountry a samm:Property ; + samm:preferredName "Compliance Country"@en ; + samm:description "The name of the country of compliance denotes the country whose rules and regulations the product must adhere to."@en ; + samm:see ; + samm:characteristic :ProductComplianceCountryTrait ; + samm:exampleValue "UK" . + +:complianceRegulationName a samm:Property ; + samm:preferredName "Compliance Regulation Name"@en ; + samm:description "The name of the regulation or standard with which the product must comply can be sourced from Supplier Survey information. This attribute is referenced in ANNEX VI of the Proposal for a REGULATION OF THE EUROPEAN PARLIAMENT AND OF THE COUNCIL on detergents and surfactants, amending Regulation (EU) 2019/1020 and repealing Regulation (EC) No 648/2004:\nThe product passport shall include the following information: [...]\n(e) references to Union legal acts that the detergent or surfactant complies with;"@en ; + samm:characteristic :StringList ; + samm:exampleValue "UK -REACH regulation" . + +:complianceResult a samm:Property ; + samm:preferredName "Compliance Result"@en ; + samm:description "The statement indicates whether the product complies with the aforementioned regulations."@en ; + samm:characteristic samm-c:Boolean ; + samm:exampleValue true . + +:complianceReasonForExemption a samm:Property ; + samm:preferredName "Compliance Reason For Exemption"@en ; + samm:description "Data providing details and justifications for an exemption from compliance with certain regulations, standards, or requirements. This information assists regulatory authorities or stakeholders in evaluating the merits of the exemption and making decisions in accordance with legal and regulatory requirements."@en ; + samm:characteristic :StringList ; + samm:exampleValue "Radioactive substance" . + +:complianceRemark a samm:Property ; + samm:preferredName "Compliance Remark"@en ; + samm:description "If necessary, any remarks that provide relevant information for compliance. Further clarification supplements the compliance information, offering additional context or details to ensure thorough understanding and adherence to regulatory requirements."@en ; + samm:characteristic samm-c:Text ; + samm:exampleValue "If you need more information about the (pre-)registration status, please get in contact with our experts from the Compliance Team: www.xyz.com" . + +:ParameterBeforeUseList a samm-c:List ; + samm:preferredName "Parameter Before Use List"@en ; + samm:description "List of parameters of the chemical material before use."@en ; + samm:dataType :ParameterBeforeUseEntity . + +:ParameterAfterUseCharacteristic a samm:Characteristic ; + samm:preferredName "Parameter After Use Characteristic"@en ; + samm:description "Characteristic for parameters of the chemical material after use."@en ; + samm:dataType :ParameterAfterUseEntity . + +:ClassificationList a samm-c:List ; + samm:preferredName "Classification List"@en ; + samm:description "List for the hazard classification."@en ; + samm:dataType :ClassificationEntity . + +:LabelingCharacteristic a samm:Characteristic ; + samm:preferredName "Labeling Characteristic"@en ; + samm:description "Characteristic for material labeling."@en ; + samm:dataType :LabelingEntity . + +:ProductTransportCharacteristic a samm:Characteristic ; + samm:preferredName "Product Transport Characteristic"@en ; + samm:description "Product transportation Characteristic."@en ; + samm:dataType :ProductTransportEntity . + +:UNTransportList a samm-c:List ; + samm:preferredName "UN Transport List"@en ; + samm:description "List of transport related attributes from the UN."@en ; + samm:dataType :UNTransportEntity . + +:WasteCodeCharacteristic a samm:Characteristic ; + samm:preferredName "Waste Code Characteristic"@en ; + samm:description "Characteristic for the waste code of the material."@en ; + samm:dataType :WasteCodeEntity . + +:EmergencyList a samm:Characteristic ; + samm:preferredName "Emergency List"@en ; + samm:description "List of information on how to proceed in case of an emergency."@en ; + samm:dataType :EmergencyEntity . + +:ProductComplianceCountryTrait a samm-c:Trait ; + samm:preferredName "Product Compliance Country Trait"@en ; + samm:description "Trait restricting the input to valid country codes."@en ; + samm-c:baseCharacteristic :StringList ; + samm-c:constraint :CountryCodeRegEx . + +:StringList a samm-c:List ; + samm:preferredName "String List"@en ; + samm:description "List of text strings."@en ; + samm:dataType xsd:string . + +:ParameterBeforeUseEntity a samm:Entity ; + samm:preferredName "Parameter Before Use Entity"@en ; + samm:description "Entity for parameters of the chemical material before use."@en ; + samm:properties ( [ samm:property :productParameterName; samm:payloadName "name" ] [ samm:property :productParameterValue; samm:payloadName "value" ] [ samm:property :productParameterUnit; samm:payloadName "unit" ] [ samm:property :productParameterResult; samm:payloadName "result" ] [ samm:property :productParameterMethod; samm:optional true; samm:payloadName "method" ] [ samm:property :productParameterRemark; samm:optional true; samm:payloadName "remark" ] [ samm:property :parameterClassificationStatement; samm:optional true; samm:payloadName "classificationStatement" ] [ samm:property :parameterTestGLPCompliance; samm:payloadName "testGLPCompliance" ] [ samm:property :parameterDocumentation; samm:payloadName "documentation" ] ) . + +:ParameterAfterUseEntity a samm:Entity ; + samm:preferredName "Parameter After Use Entity"@en ; + samm:description "Characteristic for parameters of the chemical material after use."@en ; + samm:properties ( [ samm:property :parameterAfterUseDocumentation; samm:payloadName "documentation" ] ext-passport:applicable ) . + +:ClassificationEntity a samm:Entity ; + samm:preferredName "Classification Entity"@en ; + samm:description "Entity for the hazard classification."@en ; + samm:properties ( [ samm:property :classificationRule; samm:payloadName "rule" ] [ samm:property :classificationHazardInfo; samm:payloadName "hazardous" ] [ samm:property :classificationHazardClassRoute; samm:payloadName "route" ] [ samm:property :classificationRemark; samm:payloadName "remark" ] [ samm:property ext-passport:hazardCategory; samm:payloadName "category" ] [ samm:property ext-passport:hazardClass; samm:payloadName "class" ] [ samm:property ext-passport:hazardStatement; samm:payloadName "statement" ] ) . + +:LabelingEntity a samm:Entity ; + samm:preferredName "Labeling Entity"@en ; + samm:description "Entity for the labeling of the chemical material."@en ; + samm:properties ( :signalWord :hazardPictogram [ samm:property :hazardStatement; samm:payloadName "hazard" ] :precautionary :supplementalRequirements ) . + +:ProductTransportEntity a samm:Entity ; + samm:preferredName "Product Transport Entity"@en ; + samm:description "Entity for transport."@en ; + samm:properties ( [ samm:property :emergencyTemperatureMinValue; samm:optional true; samm:payloadName "emergencyTemperatureMin" ] [ samm:property :emergencyTemperatureMaxValue; samm:optional true; samm:payloadName "emergencyTemperatureMax" ] [ samm:property :transportOtherInformation; samm:optional true; samm:payloadName "other" ] [ samm:property :controlTemperature; samm:optional true; samm:payloadName "controlTemperature" ] [ samm:property :transportPictogram; samm:optional true; samm:payloadName "pictogram" ] ) . + +:UNTransportEntity a samm:Entity ; + samm:preferredName "UN Transport Entity"@en ; + samm:description "Entity with transport related attributes."@en ; + samm:see ; + samm:properties ( :transportRegulation :unNumber :unShippingName :unHazardClassCode :unHazardClassName :unPackagingGroup [ samm:property :unExceptedQuantityCode; samm:optional true ] [ samm:property :environmentallyHazardous; samm:optional true ] [ samm:property :unSpecialProvisionsCode; samm:optional true ] [ samm:property :unLimitedQuantityValue; samm:optional true ] [ samm:property :unLimitedQuantityUnit; samm:optional true ] ) . + +:WasteCodeEntity a samm:Entity ; + samm:preferredName "Waste Code Entity"@en ; + samm:description "Entity for the waste code of the material."@en ; + samm:properties ( [ samm:property :wasteCodeDescription; samm:payloadName "description" ] [ samm:property :wasteCodeRegulation; samm:payloadName "regulation" ] [ samm:property :wasteCode; samm:payloadName "code" ] ) . + +:EmergencyEntity a samm:Entity ; + samm:preferredName "Emergency Entity"@en ; + samm:description "Entity for information on how to proceed in case of an emergency."@en ; + samm:properties ( [ samm:property :emergencyAvailability; samm:payloadName "availability" ] [ samm:property :emergencyPhoneNumber; samm:payloadName "number" ] ) . + +:CountryCodeRegEx a samm-c:RegularExpressionConstraint ; + samm:preferredName "Country Code RegEx"@en ; + samm:description "Regex pattern including all valid ISO 3166 country codes, ensuring a precise match."@en ; + samm:value "\\b(?:A[BDEFGHIJKLMNOQSTUWXZ]|B[ABDEFGHJMNRSVWY]|C[ACDDEFGHIKLMNOPQRSTUVXYZ]|D[EJKMOZ]|E[CEGHRST]|F[IJKMOR]|G[ABDEFGHILMNPQRSTUWY]|H[KMNRTU]|I[DELNOQRST]|J[EMOP]|KE|L[ABCIKRSTUVY]|M[ACDEFGHKLMNOPQRSTUVWXYZ]|N[ACEFGILOPRTUVYZ]|OM|P[AEFGHKLMNRSTWY]|QA|R[EOSUW]|S[ABCDEGHIJKLMNRTUVYZ]|T[CDGHJMNPRW]|U[AGKMSTYZ]|V[ACEGINU]|W[FS]|X[KYZ]|Y[ETU]|Z[AMW])\\b" . + +:productParameterName a samm:Property ; + samm:preferredName "Product Parameter Name"@en ; + samm:description "The name of the parameter for the product tested and presented, for instance, in the Certificate of Analysis or Safety Data Sheet, found in Section 9. Parameters for chemical products usually encompass their chemical composition, physical properties, performance characteristics, and toxicological aspects. These parameters vary depending on the chemical's nature, its intended use, and relevant safety or regulatory considerations."@en ; + samm:characteristic samm-c:Text ; + samm:exampleValue "VOC content" . + +:productParameterValue a samm:Property ; + samm:preferredName "Product Parameter Value"@en ; + samm:description "The value resulting from the tested parameter is typically presented in Section 9 of the Safety Data Sheet or Certificate of Analysis."@en ; + samm:characteristic samm-c:Text ; + samm:exampleValue "95.5" . + +:productParameterUnit a samm:Property ; + samm:preferredName "Product Parameter Unit"@en ; + samm:description "The unit of measurement for the parameter value presented in Section 9 of the Safety Data Sheet or Certificate of Analysis varies depending on the specific parameter being reported."@en ; + samm:see ; + samm:characteristic samm-c:Text ; + samm:exampleValue "unit:percent" . + +:productParameterResult a samm:Property ; + samm:preferredName "Product Parameter Result"@en ; + samm:description "Other types of results, if not numerical values, for parameters presented in Section 9 of the Safety Data Sheet or Certificate of Analysis may include qualitative descriptions like \"pass\" or \"fail,\" as well as ranges, thresholds, or classifications."@en ; + samm:characteristic samm-c:Text ; + samm:exampleValue "positive" . + +:productParameterMethod a samm:Property ; + samm:preferredName "Product Parameter Method"@en ; + samm:description "Testing methods or standards used for testing parameters."@en ; + samm:characteristic :ParameterMethodList . + +:productParameterRemark a samm:Property ; + samm:preferredName "Product Parameter Remark"@en ; + samm:description "Commentary on the test/parameter presented in the Certificate of Analysis or Safety Data Sheet in Section 9. Selecting \"not applicable\" is also an option."@en ; + samm:characteristic samm-c:Text ; + samm:exampleValue "not applicable" . + +:parameterClassificationStatement a samm:Property ; + samm:preferredName "Parameter Classification Statement"@en ; + samm:description "List of classification statements resulting from the test should include information on whether the result impacts the hazard classification of the product, particularly in the case of properties such as explosives in Safety Data Sheets (SDS)."@en ; + samm:characteristic :StringList ; + samm:exampleValue "Risk of explosion if heated under confinement" . + +:parameterTestGLPCompliance a samm:Property ; + samm:preferredName "Parameter Test GLP Compliance"@en ; + samm:description "Statement indicating whether the test for the parameter was conducted in accordance with the Good Laboratory Practice (GLP) standard, as outlined in ISO/IEC 17025:2017, which specifies general requirements for the competence of testing and calibration laboratories."@en ; + samm:see ; + samm:characteristic samm-c:Boolean ; + samm:exampleValue false . + +:parameterDocumentation a samm:Property ; + samm:preferredName "Parameter Documentation"@en ; + samm:description "Reference to the confirmation of the result typically includes a link to the document containing the confirmation, such as the Certificate of Analysis (CoA)."@en ; + samm:characteristic ext-passport:DocumentList . + +:parameterAfterUseDocumentation a samm:Property ; + samm:preferredName "Parameter After Use Documentation"@en ; + samm:description "Parameters of a product that may change or become relevant after its intended use are often documented as post-application characteristics. This data can be found in documents such as \"Technical Documentation.\""@en ; + samm:characteristic ext-passport:DocumentList . + +:classificationRule a samm:Property ; + samm:preferredName "Classification Rule"@en ; + samm:description "Name of the classification rule under which the hazard assessment has been prepared."@en ; + samm:characteristic samm-c:Text ; + samm:exampleValue "CLP Regulation (EC) No 1272/2008" . + +:classificationHazardInfo a samm:Property ; + samm:preferredName "classification Hazard Info"@en ; + samm:description "Information if the product is hazardous or not, according to the connected rule."@en ; + samm:characteristic samm-c:Boolean ; + samm:exampleValue true . + +:classificationHazardClassRoute a samm:Property ; + samm:preferredName "Classification Hazard Class Route"@en ; + samm:description "Certain classifications must be communicated with the relevant route of exposure according to CLP Regulation (EC) No 1272/2008, which include:\n- oral,\n- dermal,\n- inhalation gas,\n- inhalation vapour,\n- inhalation dust/mist/fume."@en ; + samm:characteristic :RouteEnumeration ; + samm:exampleValue "oral" . + +:classificationRemark a samm:Property ; + samm:preferredName "Classification Remark"@en ; + samm:description "Additional remarks for classification information supplement the classification details for a particular chemical material. These remarks assist stakeholders in making informed decisions regarding safety, handling, and regulatory compliance."@en ; + samm:characteristic samm-c:Text ; + samm:exampleValue "No additional information available" . + +:signalWord a samm:Property ; + samm:preferredName "Signal Word"@en ; + samm:description "According to CLP Regulation (EC) No 1272/2008, a \"signal word\" refers to a term indicating the relative severity of hazards to alert the reader to a potential danger. There are two levels distinguished:\n(a) ‘Danger’ means a signal word indicating the more severe hazard categories;\n(b) ‘Warning’ means a signal word indicating the less severe hazard categories;"@en ; + samm:characteristic :SignalWordEnumeration ; + samm:exampleValue "Danger" . + +:hazardPictogram a samm:Property ; + samm:preferredName "Hazard Pictogram"@en ; + samm:description "A hazard pictogram is a graphical symbol used to convey specific information about the hazards associated with a chemical substance or mixture."@en ; + samm:characteristic :HazardPictogramList . + +:hazardStatement a samm:Property ; + samm:preferredName "Hazard Statement"@en ; + samm:description "Describes the nature of a hazard associated with a chemical substance or mixture."@en ; + samm:characteristic :HazardStatementList . + +:precautionary a samm:Property ; + samm:preferredName "Precautionary"@en ; + samm:description "A precautionary code for materials is a standardized code used to convey specific precautionary measures that should be taken when handling, storing, or using a chemical substance or mixture."@en ; + samm:characteristic :PrecautionaryList . + +:supplementalRequirements a samm:Property ; + samm:preferredName "Supplemental Requirements"@en ; + samm:description "Supplemental requirements often include additional codes, symbols, or statements beyond those required by regulations."@en ; + samm:characteristic :SupplementalRequirementsList . + +:emergencyTemperatureMinValue a samm:Property ; + samm:preferredName "Emergency Temperature Min Value"@en ; + samm:description "The critical minimum temperature for transporting the product refers to the lowest temperature at which the product can be safely transported without compromising its integrity or functionality. Emergency temperature refers to a temperature that poses a significant risk, potentially leading to hazardous conditions or product damage."@en ; + samm:characteristic :CelsiusDegreeMeasurement ; + samm:exampleValue "-20.0"^^xsd:float . + +:emergencyTemperatureMaxValue a samm:Property ; + samm:preferredName "Emergency Temperature Max Value"@en ; + samm:description "The critical maximum temperature for transporting the product refers to the highest temperature at which the product can be safely transported without degradation or posing a risk. Emergency temperature refers to a temperature that poses a significant risk, potentially leading to hazardous conditions or product damage."@en ; + samm:characteristic :CelsiusDegreeMeasurement ; + samm:exampleValue "35.0"^^xsd:float . + +:transportOtherInformation a samm:Property ; + samm:preferredName "Transport Other Information"@en ; + samm:description "Additional information related to the transport of the product. Relevant details that could aid in making decisions regarding the shipping of the product."@en ; + samm:characteristic samm-c:Text ; + samm:exampleValue "Not permitted for transport" . + +:controlTemperature a samm:Property ; + samm:preferredName "Control Temperature"@en ; + samm:description "The controlled temperature for transportation refers to the range of values within which the temperature conditions of goods or products are monitored and regulated during transportation in degree celcius. This information is crucial for mitigating risks associated with temperature-sensitive products, ensuring their integrity and quality throughout the shipping process."@en ; + samm:characteristic samm-c:Text ; + samm:exampleValue "20 - 25 C" . + +:transportPictogram a samm:Property ; + samm:preferredName "Transport Pictogram"@en ; + samm:description "Links to transport related pictograms."@en ; + samm:characteristic :StringList ; + samm:exampleValue "https://example.link" . + +:transportRegulation a samm:Property ; + samm:preferredName "Transport Regulation"@en ; + samm:description "Indicate regulations for transportation for example: Land transport (ADR/RID), Inland waterway transport (ADN), Sea transport (IMDG), Air transport (ICAO-TI/IATA-DGR) and so on."@en ; + samm:characteristic samm-c:Text ; + samm:exampleValue "ADR - Agreement concerning the International Carriage of Dangerous Goods by Road" . + +:unNumber a samm:Property ; + samm:preferredName "UN Number"@en ; + samm:description "The UN number or ID number is a four-digit identification code for substances, mixtures, or articles."@en ; + samm:see ; + samm:characteristic :UNNumberTrait ; + samm:exampleValue "3113" . + +:unShippingName a samm:Property ; + samm:preferredName "UN Shipping Name"@en ; + samm:description "The proper shipping name is provided in column 2, \"Name and description,\" of Table A of Chapter 3.2 Dangerous Goods List of the UN Regulations."@en ; + samm:see ; + samm:characteristic samm-c:Text ; + samm:exampleValue "ORGANIC PEROXIDE TYPE C, LIQUID, TEMPERATURE CONTROLLED (Tert-BUTYL PEROXY-2-ETHYLHEXANOATE)" . + +:unHazardClassCode a samm:Property ; + samm:preferredName "UN Hazard Class Code"@en ; + samm:description "The transport class of the dangerous group according to UN Regulations."@en ; + samm:characteristic :FloatQuantityValue ; + samm:exampleValue "5.2"^^xsd:float . + +:unHazardClassName a samm:Property ; + samm:preferredName "UN Hazard Class Name"@en ; + samm:description "The classified dangerous group in transportation refers to the classification of hazardous materials or dangerous goods according to the United Nations (UN) Globally Harmonized System of Classification and Labelling of Chemicals (GHS) and the UN Model Regulations for the Transport of Dangerous Goods."@en ; + samm:characteristic samm-c:Text ; + samm:exampleValue "Oxidising substances" . + +:unPackagingGroup a samm:Property ; + samm:preferredName "UN Packaging Group"@en ; + samm:description "Group to which certain substances may be assigned for packaging purposes according to their degree of danger:\nPackaging group I: Substances presenting high danger,\nPackaging group II: Substances presenting medium danger,\nPackaging group III: Substances presenting low danger.\nNot all dangerous goods assigned to hazard classes or their divisions will be allocated to Packaging Groups."@en ; + samm:see ; + samm:characteristic :PackagingGroupEnumeration ; + samm:exampleValue "I" . + +:unExceptedQuantityCode a samm:Property ; + samm:preferredName "UN Excepted Quantity Code"@en ; + samm:description "Chapter 3.5 of UN Transportation Regulation pertains to dangerous goods packed in excepted quantities, with possible codes including E0, E1, E2, E3, E4, and E5."@en ; + samm:see ; + samm:characteristic :QuantityCodeEnumeration ; + samm:exampleValue "E0" . + +:environmentallyHazardous a samm:Property ; + samm:preferredName "Environmentally Hazardous"@en ; + samm:description "The indication of whether a substance or mixture is environmentally hazardous according to the criteria of the UN Model Regulations (as reflected in ADR, RID, and ADN) and whether it is a marine pollutant according to the IMDG Code and the Emergency Response Procedures for Ships Carrying Dangerous Goods."@en ; + samm:characteristic :StringList ; + samm:exampleValue "Marine pollutant" . + +:unSpecialProvisionsCode a samm:Property ; + samm:preferredName "UN Special Provisions Code"@en ; + samm:description "The UN Special Provisions Code refers to a set of additional requirements or conditions specified by the United Nations for the transportation of certain dangerous goods."@en ; + samm:characteristic :SpecialProvisionsCodeList . + +:unLimitedQuantityValue a samm:Property ; + samm:preferredName "UN Limited Quantity Value"@en ; + samm:description "Maximum quantity per inner packaging or article for carrying dangerous goods refers to the maximum amount of a hazardous material permitted for transportation."@en ; + samm:characteristic :FloatQuantityValue ; + samm:exampleValue "5.0"^^xsd:float . + +:unLimitedQuantityUnit a samm:Property ; + samm:preferredName "UN Limited Quantity Unit"@en ; + samm:description "Unit of the limited quantity value."@en ; + samm:characteristic ext-quantity:ItemUnitEnumeration ; + samm:exampleValue "unit:kilogram"^^samm:curie . + +:wasteCodeDescription a samm:Property ; + samm:preferredName "Waste Code Description"@en ; + samm:description "Description of the related waste code."@en ; + samm:characteristic samm-c:Text ; + samm:exampleValue "waste paint and varnish containing organic solvents or other hazardous substances" . + +:wasteCodeRegulation a samm:Property ; + samm:preferredName "Waste Code Regulation"@en ; + samm:description "The name of the regulation that applies to waste codes can vary depending on the region or jurisdiction. Examples include Regulation (EC) No 1013/2006 in the European Union or Annex VIII of the Basel Convention."@en ; + samm:see ; + samm:characteristic samm-c:Text ; + samm:exampleValue "European List of Waste acc. Regulation (EC) No 1013/2006" . + +:wasteCode a samm:Property ; + samm:preferredName "Waste Code"@en ; + samm:description "A waste code is used to identify the type of waste."@en ; + samm:characteristic samm-c:Text ; + samm:exampleValue "08 01 11*" . + +:emergencyAvailability a samm:Property ; + samm:preferredName "Emergency Availability"@en ; + samm:description "The period of time when emergency phone numbers are available."@en ; + samm:characteristic samm-c:Text ; + samm:exampleValue "Only available during the following office hours: xx - xx" . + +:emergencyPhoneNumber a samm:Property ; + samm:preferredName "Emergency Phone Number"@en ; + samm:description "The phone number in case of an emergency."@en ; + samm:characteristic samm-c:Text ; + samm:exampleValue "+49111222333" . + +:ParameterMethodList a samm-c:List ; + samm:preferredName "Parameter Method List"@en ; + samm:description "List of testing methods or standards used for testing parameters."@en ; + samm:dataType :ParameterMethodEntity . + +:RouteEnumeration a samm-c:Enumeration ; + samm:preferredName "Route Enumeration"@en ; + samm:description "Enumeration with oral, dermal, inhalation gas, inhalation vapour, inhalation dust/mist/fume and not applicable"@en ; + samm:dataType xsd:string ; + samm-c:values ( "oral" "dermal" "inhalation gas" "inhalation vapour" "inhalation dust/mist/fume" "not applicable" ) . + +:SignalWordEnumeration a samm-c:Enumeration ; + samm:preferredName "Signal Word Enumeration"@en ; + samm:description "Enumeration with Danger and Warning."@en ; + samm:dataType xsd:string ; + samm-c:values ( "Danger" "Warning" ) . + +:HazardPictogramList a samm-c:List ; + samm:preferredName "Hazard Pictogram List"@en ; + samm:description "List of hazard pictograms."@en ; + samm:dataType :HazardPictogramEntity . + +:HazardStatementList a samm-c:List ; + samm:preferredName "Hazard Statement List"@en ; + samm:description "List for the hazard statement."@en ; + samm:dataType :HazardStatementEntity . + +:PrecautionaryList a samm:Characteristic ; + samm:preferredName "Precautionary List"@en ; + samm:description "List for precautionary codes."@en ; + samm:dataType :PrecautionaryEntity . + +:SupplementalRequirementsList a samm-c:List ; + samm:preferredName "Supplemental Requirements List"@en ; + samm:description "List for supplemental requirements."@en ; + samm:dataType :SupplementalRequirementsEntity . + +:CelsiusDegreeMeasurement a samm-c:Measurement ; + samm:preferredName "Celsius Degree Measurement"@en ; + samm:description "Measurement as float in celsius degree."@en ; + samm:dataType xsd:float ; + samm-c:unit unit:degreeCelsius . + +:UNNumberTrait a samm-c:Trait ; + samm:preferredName "UN Number Trait"@en ; + samm:description "Trait for the UN number."@en ; + samm-c:baseCharacteristic samm-c:Text ; + samm-c:constraint :UNNumberConstraint . + +:FloatQuantityValue a samm-c:Quantifiable ; + samm:preferredName "Float Quantity Value"@en ; + samm:description "Value as float."@en ; + samm:dataType xsd:float . + +:PackagingGroupEnumeration a samm-c:Enumeration ; + samm:preferredName "Packaging Group Enumeration"@en ; + samm:description "Enumeration to match \"I\", \"II\", \"III\", or \"not applicable\"."@en ; + samm:dataType xsd:string ; + samm-c:values ( "I" "II" "III" "not applicable" ) . + +:QuantityCodeEnumeration a samm-c:Enumeration ; + samm:preferredName "Quantity Code Enumeration"@en ; + samm:description "Enumeration for the codes E0, E1, E2, E3, E4, and E5."@en ; + samm:dataType xsd:string ; + samm-c:values ( "E0" "E1" "E2" "E3" "E4" "E5" ) . + +:SpecialProvisionsCodeList a samm-c:List ; + samm:preferredName "Special Provisions Code List"@en ; + samm:description "List of the special provisions codes."@en ; + samm:dataType :SpecialProvisionsCodeEntity . + +:ParameterMethodEntity a samm:Entity ; + samm:preferredName "Parameter Method Entity"@en ; + samm:description "Testing methods or standards used for testing parameters with method names."@en ; + samm:properties ( :parameterMethodName :parameterMethodConditions :parameterMethodDescription ) . + +:HazardPictogramEntity a samm:Entity ; + samm:preferredName "Hazard Pictogram Entity"@en ; + samm:description "Entity for the hazard pictogram."@en ; + samm:properties ( [ samm:property :hazardPictogramCode; samm:payloadName "code" ] [ samm:property :hazardPictogramImage; samm:payloadName "image" ] [ samm:property :hazardPictogramName; samm:payloadName "name" ] ) . + +:HazardStatementEntity a samm:Entity ; + samm:preferredName "Hazard Statement Entity"@en ; + samm:description "Entity for the hazard statement."@en ; + samm:properties ( [ samm:property :hazardStatementCode; samm:payloadName "code" ] [ samm:property :hazardStatementText; samm:payloadName "text" ] ) . + +:PrecautionaryEntity a samm:Entity ; + samm:preferredName "Precautionary Entity"@en ; + samm:description "Entity for precautionary codes."@en ; + samm:properties ( [ samm:property :precautionaryCode; samm:payloadName "code" ] [ samm:property :precautionaryText; samm:payloadName "text" ] ) . + +:SupplementalRequirementsEntity a samm:Entity ; + samm:preferredName "Supplemental Requirements Entity"@en ; + samm:description "Entity for supplemental requirements."@en ; + samm:properties ( [ samm:property :supplementalRequirementsCode; samm:optional true; samm:payloadName "code" ] [ samm:property :supplementalRequirementsText; samm:optional true; samm:payloadName "text" ] [ samm:property :supplementalRequirementsPictogram; samm:optional true; samm:payloadName "pictogram" ] [ samm:property :productLabelingNotes; samm:optional true; samm:payloadName "notes" ] ) . + +:UNNumberConstraint a samm-c:RegularExpressionConstraint ; + samm:preferredName "UN Number Constraint"@en ; + samm:description "Constraint to four digits numbers."@en ; + samm:value "^\\d{4}$" . + +:SpecialProvisionsCodeEntity a samm:Entity ; + samm:preferredName "Special Provisions Code Entity"@en ; + samm:description "Entity for the special provisions code."@en ; + samm:properties ( [ samm:property :specialProvisionsCode; samm:payloadName "code" ] [ samm:property :specialProvisionsInfo; samm:payloadName "text" ] ) . + +:parameterMethodName a samm:Property ; + samm:preferredName "Parameter Method Name"@en ; + samm:description "The name of the testing method or standard used for testing parameters can vary depending on the context and industry. It might be referred to by a specific code, standard name, or regulation/directive."@en ; + samm:characteristic samm-c:Text ; + samm:exampleValue "Directive 2004/42/CE" . + +:parameterMethodConditions a samm:Property ; + samm:preferredName "Parameter Method Conditions"@en ; + samm:description "The relevant conditions for conducting a measurement or analysis of a chemical parameter ensure the accuracy, reliability, and consistency of the results obtained from the method used. These conditions are typically presented in the Certificate of Analysis or Safety Data Sheet, specifically in Section 9."@en ; + samm:characteristic samm-c:Text ; + samm:exampleValue "50 degree celsius" . + +:parameterMethodDescription a samm:Property ; + samm:preferredName "Parameter Method Description"@en ; + samm:description "Short description of the method used to determine parameter presented in Certificate of Analysis or Safety Data Sheet in Section 9."@en ; + samm:characteristic samm-c:Text ; + samm:exampleValue "Evaporation in oven." . + +:hazardPictogramCode a samm:Property ; + samm:preferredName "Hazard Pictogram Code"@en ; + samm:description "The code of a pictogram refers to a set of symbols used to visually represent and communicate information about the hazards associated with a chemical material."@en ; + samm:characteristic samm-c:Text ; + samm:exampleValue "GHS05" . + +:hazardPictogramImage a samm:Property ; + samm:preferredName "Hazard Pictogram Image"@en ; + samm:description "Link to the picture of the pictogram. Definition from CLP Regulation (EC) No 1272/2008 : ‘hazard pictogram’ means a graphical composition that includes a symbol plus other graphic elements, such as a border, background pattern or colour that is intended to convey specific information on the hazard concerned;"@en ; + samm:characteristic :LinkCharacteristic ; + samm:exampleValue "https://example.link" . + +:hazardPictogramName a samm:Property ; + samm:preferredName "Hazard Pictogram Name"@en ; + samm:description "The meaning or description of a pictogram is the explanation that accompanies it, providing information and context about its purpose and the hazards it represents."@en ; + samm:characteristic samm-c:Text ; + samm:exampleValue "Corrosive" . + +:hazardStatementCode a samm:Property ; + samm:preferredName "Hazard Statement Code"@en ; + samm:description "According to CLP Regulation (EC) No 1272/2008, each hazard statement is designated a code, starting with the letter H followed by three digits. These codes can be associated with multiple hazard statements or be assigned to a single statement."@en ; + samm:characteristic samm-c:Text ; + samm:exampleValue "H220" . + +:hazardStatementText a samm:Property ; + samm:preferredName "Hazard Statement Text"@en ; + samm:description "Definition from CLP Regulation (EC) No 1272/2008 ‘hazard statement’ means a phrase assigned to a hazard class and category that describes the nature of the hazards of a hazardous substance or mixture, including, where appropriate, the degree of hazard;"@en ; + samm:characteristic samm-c:Text ; + samm:exampleValue "Extremely flammable gas" . + +:precautionaryCode a samm:Property ; + samm:preferredName "Precautionary Code"@en ; + samm:description "Each precautionary statement is designated a code, starting with the letter P and followed by three digits."@en ; + samm:characteristic :PrecautionaryCodeTrait ; + samm:exampleValue "P103" . + +:precautionaryText a samm:Property ; + samm:preferredName "Precautionary Text"@en ; + samm:description "Definition from CLP Regulation (EC) No 1272/2008: ‘precautionary statement’ means a phrase that describes recommended measure(s) to minimise or prevent adverse effects resulting from exposure to a hazardous substance or mixture due to its use or disposal."@en ; + samm:characteristic samm-c:Text ; + samm:exampleValue "Read label before use." . + +:supplementalRequirementsCode a samm:Property ; + samm:preferredName "Supplemental Requirements Code"@en ; + samm:description "Supplemental codes used for labeling statements provide additional information or context about the hazards, handling, or regulatory requirements associated with chemical materials. This data can be helpful for stakeholders in managing chemical materials by offering further guidance on safe handling practices, storage conditions, emergency response procedures, or regulatory compliance measures."@en ; + samm:characteristic samm-c:Text ; + samm:exampleValue "XYZ" . + +:supplementalRequirementsText a samm:Property ; + samm:preferredName "Supplemental Requirements Text"@en ; + samm:description "Any supplemental text used for labeling provides data that could be helpful for stakeholders in managing chemical materials."@en ; + samm:characteristic samm-c:Text ; + samm:exampleValue "Substance is phototoxic." . + +:supplementalRequirementsPictogram a samm:Property ; + samm:preferredName "Supplemental Requirements Pictogram"@en ; + samm:description "Supplemental pictures or pictograms used for additional labeling provide data that could be helpful for stakeholders in managing chemical materials."@en ; + samm:characteristic :LinkCharacteristic ; + samm:exampleValue "https://example.link" . + +:productLabelingNotes a samm:Property ; + samm:preferredName "Product Labeling Notes"@en ; + samm:description "Labeling notes consist of statements that provide additional information regarding hazardous possible reactions or other important considerations related to the chemical material. These notes help stakeholders understand potential risks and take appropriate precautions when handling, storing, or using the material."@en ; + samm:characteristic samm-c:Text ; + samm:exampleValue "The substance can react dangerously with: alcohols" . + +:specialProvisionsCode a samm:Property ; + samm:preferredName "Special Provisions Code"@en ; + samm:description "Code of special provisions or exceptions that must be met."@en ; + samm:see ; + samm:characteristic :IntegerCharacteristic ; + samm:exampleValue 274 . + +:specialProvisionsInfo a samm:Property ; + samm:preferredName "Special Provisions Info"@en ; + samm:description "Text aligned with special provisions under UN transport regulation Chapter 3.3."@en ; + samm:see ; + samm:characteristic samm-c:Text ; + samm:exampleValue "The provision of 3.1.2.8 apply" . + +:LinkCharacteristic a samm:Characteristic ; + samm:preferredName "Link Characteristic"@en ; + samm:description "Characteristic for a simple web link."@en ; + samm:dataType xsd:string . + +:PrecautionaryCodeTrait a samm-c:Trait ; + samm:preferredName "Precautionary Code Trait"@en ; + samm:description "Trait for the precautionary codes."@en ; + samm-c:baseCharacteristic samm-c:Text ; + samm-c:constraint :PrecautionaryCodeConstraint . + +:IntegerCharacteristic a samm:Characteristic ; + samm:preferredName "Integer Characteristic"@en ; + samm:description "Characteristic for integer values."@en ; + samm:dataType xsd:integer . + +:PrecautionaryCodeConstraint a samm-c:RegularExpressionConstraint ; + samm:preferredName "Precautionary Code Constraint"@en ; + samm:description "Constraint starting with the letter P followed by three digits."@en ; + samm:value "^P\\d{3}$" . + diff --git a/io.catenax.material.chemical_material_passport/2.0.0/gen/ChemicalMaterialPassport-aas.xml b/io.catenax.material.chemical_material_passport/2.0.0/gen/ChemicalMaterialPassport-aas.xml new file mode 100644 index 000000000..a101c5853 --- /dev/null +++ b/io.catenax.material.chemical_material_passport/2.0.0/gen/ChemicalMaterialPassport-aas.xml @@ -0,0 +1,22401 @@ + + + + + defaultAdminShell + + + en + defaultAdminShell + + + + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#ChemicalMaterialPassport + + Type + + + + ModelReference + + + Submodel + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#ChemicalMaterialPassport/submodel + + + + + + + + + ChemicalMaterialPassport + + + en + The information in a Digital Product Passport allows stakeholders in the value chain to map information and obtain a better understanding of the composition of the product, the environmental impact of the production and use phase, and the aspect of circularity. To serve the same purpose as the Digital Passport, the Chemical Material Passport also plays an important role in providing more detailed information in terms of sustainability, safety and waste management. It can replace the current way of communication and data exchange from multi-channels by one streamlined data flow. + + + + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#ChemicalMaterialPassport/submodel + Template + + ModelReference + + + ConceptDescription + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#ChemicalMaterialPassport + + + + + + SpecificEntity + + + en + Specific Entity + + + + + en + The Entity for product specific parameters of the electric drive. + + + + + ParameterEntity + + + en + Parameter Entity + + + + + en + Parameter Entity for the chemical material. + + + + + parameterBeforeUse + + + en + Parameter Before Use + + + + + en + Parameters of the chemical material before use. + + + true + DataElement + + + ParameterBeforeUseEntity + + + en + Parameter Before Use Entity + + + + + en + Entity for parameters of the chemical material before use. + + + + + productParameterName + + + en + Product Parameter Name + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#productParameterName + + + + xs:string + + + + productParameterValue + + + en + Product Parameter Value + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#productParameterValue + + + + xs:string + + + + productParameterUnit + + + en + Product Parameter Unit + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#productParameterUnit + + + + + + ExternalReference + + + GlobalReference + https://eclipse-esmf.github.io/samm-specification/2.1.0/appendix/unitcatalog.html + + + + + xs:string + + + + productParameterResult + + + en + Product Parameter Result + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#productParameterResult + + + + xs:string + + + + productParameterMethod + + + en + Product Parameter Method + + + + + en + Testing methods or standards used for testing parameters. + + + true + DataElement + + + ParameterMethodEntity + + + en + Parameter Method Entity + + + + + en + Testing methods or standards used for testing parameters with method names. + + + + + parameterMethodName + + + en + Parameter Method Name + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#parameterMethodName + + + + xs:string + + + + parameterMethodConditions + + + en + Parameter Method Conditions + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#parameterMethodConditions + + + + xs:string + + + + parameterMethodDescription + + + en + Parameter Method Description + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#parameterMethodDescription + + + + xs:string + + + + + + + + productParameterRemark + + + en + Product Parameter Remark + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#productParameterRemark + + + + xs:string + + + + parameterClassificationStatement + + + en + Parameter Classification Statement + + + + + en + List of classification statements resulting from the test should include information on whether the result impacts the hazard classification of the product, particularly in the case of properties such as explosives in Safety Data Sheets (SDS). + + + true + DataElement + + + parameterClassificationStatement + + + en + Parameter Classification Statement + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#parameterClassificationStatement + + + + xs:string + + + + + + parameterTestGLPCompliance + + + en + Parameter Test GLP Compliance + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#parameterTestGLPCompliance + + + + + + ExternalReference + + + GlobalReference + https://www.iso.org/standard/66912.html + + + + + xs:boolean + + + + parameterDocumentation + + + en + Parameter Documentation + + + + + en + Reference to the confirmation of the result typically includes a link to the document containing the confirmation, such as the Certificate of Analysis (CoA). + + + true + DataElement + + + DocumentationEntity + + + en + Documentation Entity + + + + + en + Entity for a document with a header, type and content. + + + + + content + + + en + Content + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + xs:string + + + + contentType + + + en + Content Type + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + xs:string + + + + header + + + en + Header + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + xs:string + + + + + + + + + + + + ParameterAfterUseEntity + + + en + Parameter After Use Entity + + + + + en + Characteristic for parameters of the chemical material after use. + + + + + parameterAfterUseDocumentation + + + en + Parameter After Use Documentation + + + + + en + Parameters of a product that may change or become relevant after its intended use are often documented as post-application characteristics. This data can be found in documents such as "Technical Documentation." + + + true + DataElement + + + DocumentationEntity + + + en + Documentation Entity + + + + + en + Entity for a document with a header, type and content. + + + + + content + + + en + Content + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + xs:string + + + + contentType + + + en + Content Type + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + xs:string + + + + header + + + en + Header + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + xs:string + + + + + + + + applicable + + + en + Applicable + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#applicable + + + + xs:boolean + + + + + + + + productType + + + en + Product Type + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#productType + + + + + + ExternalReference + + + GlobalReference + https://eur-lex.europa.eu/legal-content/EN/TXT/?uri=CELEX:02006R1907-20231201 + + + + + xs:string + + + + HazardAssessmentEntity + + + en + Hazard Assessment Entity + + + + + en + Entity for the hazard assessment. + + + + + classification + + + en + Classification + + + + + en + Classification for the hazard assessment. + + + true + DataElement + + + ClassificationEntity + + + en + Classification Entity + + + + + en + Entity for the hazard classification. + + + + + classificationRule + + + en + Classification Rule + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#classificationRule + + + + xs:string + + + + classificationHazardInfo + + + en + classification Hazard Info + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#classificationHazardInfo + + + + xs:boolean + + + + classificationHazardClassRoute + + + en + Classification Hazard Class Route + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#classificationHazardClassRoute + + + + xs:string + + + + classificationRemark + + + en + Classification Remark + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#classificationRemark + + + + xs:string + + + + hazardCategory + + + en + Hazard Category + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#hazardCategory + + + + + + ExternalReference + + + GlobalReference + https://eur-lex.europa.eu/legal-content/EN/TXT/?uri=CELEX:02008R1272-20231201 + + + + + xs:string + + + + hazardClass + + + en + Hazard Class + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#hazardClass + + + + + + ExternalReference + + + GlobalReference + https://eur-lex.europa.eu/legal-content/EN/TXT/?uri=CELEX:02008R1272-20231201 + + + + + xs:string + + + + hazardStatement + + + en + Hazard Statement + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#hazardStatement + + + + + + ExternalReference + + + GlobalReference + https://eur-lex.europa.eu/legal-content/EN/TXT/?uri=CELEX:02008R1272-20231201 + + + + + xs:string + + + + + + + + LabelingEntity + + + en + Labeling Entity + + + + + en + Entity for the labeling of the chemical material. + + + + + ExternalReference + + + GlobalReference + https://eur-lex.europa.eu/eli/reg/2008/1272/oj + + + + + + + signalWord + + + en + Signal Word + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#signalWord + + + + xs:string + + + + hazardPictogram + + + en + Hazard Pictogram + + + + + en + A hazard pictogram is a graphical symbol used to convey specific information about the hazards associated with a chemical substance or mixture. + + + true + DataElement + + + HazardPictogramEntity + + + en + Hazard Pictogram Entity + + + + + en + Entity for the hazard pictogram. + + + + + hazardPictogramCode + + + en + Hazard Pictogram Code + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#hazardPictogramCode + + + + xs:string + + + + hazardPictogramImage + + + en + Hazard Pictogram Image + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#hazardPictogramImage + + + + xs:string + + + + hazardPictogramName + + + en + Hazard Pictogram Name + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#hazardPictogramName + + + + xs:string + + + + + + + + hazardStatement + + + en + Hazard Statement + + + + + en + Describes the nature of a hazard associated with a chemical substance or mixture. + + + true + DataElement + + + HazardStatementEntity + + + en + Hazard Statement Entity + + + + + en + Entity for the hazard statement. + + + + + hazardStatementCode + + + en + Hazard Statement Code + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#hazardStatementCode + + + + xs:string + + + + hazardStatementText + + + en + Hazard Statement Text + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#hazardStatementText + + + + xs:string + + + + + + + + PrecautionaryEntity + + + en + Precautionary Entity + + + + + en + Entity for precautionary codes. + + + + + precautionaryCode + + + en + Precautionary Code + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#precautionaryCode + + + + xs:string + + + + precautionaryText + + + en + Precautionary Text + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#precautionaryText + + + + xs:string + + + + + + supplementalRequirements + + + en + Supplemental Requirements + + + + + en + Supplemental requirements often include additional codes, symbols, or statements beyond those required by regulations. + + + true + DataElement + + + SupplementalRequirementsEntity + + + en + Supplemental Requirements Entity + + + + + en + Entity for supplemental requirements. + + + + + supplementalRequirementsCode + + + en + Supplemental Requirements Code + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#supplementalRequirementsCode + + + + xs:string + + + + supplementalRequirementsText + + + en + Supplemental Requirements Text + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#supplementalRequirementsText + + + + xs:string + + + + supplementalRequirementsPictogram + + + en + Supplemental Requirements Pictogram + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#supplementalRequirementsPictogram + + + + xs:string + + + + productLabelingNotes + + + en + Product Labeling Notes + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#productLabelingNotes + + + + xs:string + + + + + + + + + + hazardAssessmentDocumentation + + + en + Hazard Assessment Documentation + + + + + en + Documentation providing hazard assessment information for ensuring the safe management of chemical materials throughout their lifecycle. + + + true + DataElement + + + DocumentationEntity + + + en + Documentation Entity + + + + + en + Entity for a document with a header, type and content. + + + + + content + + + en + Content + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + xs:string + + + + contentType + + + en + Content Type + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + xs:string + + + + header + + + en + Header + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + xs:string + + + + + + + + + + TransportEntity + + + en + Transport Entity + + + + + en + Entity for transport attributes. + + + + + ProductTransportEntity + + + en + Product Transport Entity + + + + + en + Entity for transport. + + + + + emergencyTemperatureMinValue + + + en + Emergency Temperature Min Value + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#emergencyTemperatureMinValue + + + + xs:float + + + + emergencyTemperatureMaxValue + + + en + Emergency Temperature Max Value + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#emergencyTemperatureMaxValue + + + + xs:float + + + + transportOtherInformation + + + en + Transport Other Information + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#transportOtherInformation + + + + xs:string + + + + controlTemperature + + + en + Control Temperature + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#controlTemperature + + + + xs:string + + + + transportPictogram + + + en + Transport Pictogram + + + + + en + Links to transport related pictograms. + + + true + DataElement + + + transportPictogram + + + en + Transport Pictogram + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#transportPictogram + + + + xs:string + + + + + + + + unTransport + + + en + UN Transport + + + + + en + Transport related attributes from the UN. + + + true + DataElement + + + UNTransportEntity + + + en + UN Transport Entity + + + + + en + Entity with transport related attributes. + + + + + ExternalReference + + + GlobalReference + https://unece.org/sites/default/files/2023-08/ST-SG-AC10-1r23e_Vol1_WEB.pdf + + + + + + + transportRegulation + + + en + Transport Regulation + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#transportRegulation + + + + xs:string + + + + unNumber + + + en + UN Number + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#unNumber + + + + + + ExternalReference + + + GlobalReference + https://unece.org/sites/default/files/2023-08/ST-SG-AC10-1r23e_Vol1_WEB.pdf + + + + + xs:string + + + + unShippingName + + + en + UN Shipping Name + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#unShippingName + + + + + + ExternalReference + + + GlobalReference + https://unece.org/sites/default/files/2023-08/ST-SG-AC10-1r23e_Vol1_WEB.pdf + + + + + xs:string + + + + unHazardClassCode + + + en + UN Hazard Class Code + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#unHazardClassCode + + + + xs:float + + + + unHazardClassName + + + en + UN Hazard Class Name + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#unHazardClassName + + + + xs:string + + + + unPackagingGroup + + + en + UN Packaging Group + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#unPackagingGroup + + + + + + ExternalReference + + + GlobalReference + https://unece.org/sites/default/files/2023-08/ST-SG-AC10-1r23e_Vol1_WEB.pdf + + + + + xs:string + + + + unExceptedQuantityCode + + + en + UN Excepted Quantity Code + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#unExceptedQuantityCode + + + + + + ExternalReference + + + GlobalReference + https://unece.org/sites/default/files/2023-08/ST-SG-AC10-1r23e_Vol1_WEB.pdf + + + + + xs:string + + + + environmentallyHazardous + + + en + Environmentally Hazardous + + + + + en + The indication of whether a substance or mixture is environmentally hazardous according to the criteria of the UN Model Regulations (as reflected in ADR, RID, and ADN) and whether it is a marine pollutant according to the IMDG Code and the Emergency Response Procedures for Ships Carrying Dangerous Goods. + + + true + DataElement + + + environmentallyHazardous + + + en + Environmentally Hazardous + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#environmentallyHazardous + + + + xs:string + + + + + + unSpecialProvisionsCode + + + en + UN Special Provisions Code + + + + + en + The UN Special Provisions Code refers to a set of additional requirements or conditions specified by the United Nations for the transportation of certain dangerous goods. + + + true + DataElement + + + SpecialProvisionsCodeEntity + + + en + Special Provisions Code Entity + + + + + en + Entity for the special provisions code. + + + + + specialProvisionsCode + + + en + Special Provisions Code + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#specialProvisionsCode + + + + + + ExternalReference + + + GlobalReference + https://unece.org/sites/default/files/2023-08/ST-SG-AC10-1r23e_Vol1_WEB.pdf + + + + + xs:integer + + + + specialProvisionsInfo + + + en + Special Provisions Info + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#specialProvisionsInfo + + + + + + ExternalReference + + + GlobalReference + https://unece.org/sites/default/files/2023-08/ST-SG-AC10-1r23e_Vol1_WEB.pdf + + + + + xs:string + + + + + + + + unLimitedQuantityValue + + + en + UN Limited Quantity Value + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#unLimitedQuantityValue + + + + xs:float + + + + unLimitedQuantityUnit + + + en + UN Limited Quantity Unit + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#unLimitedQuantityUnit + + + + xs:string + + + + + + + + + + DisposalEntity + + + en + Disposal Entity + + + + + en + Entity for disposal related attributes. + + + + + disposalBeforeUse + + + en + Disposal Before Use + + + + + en + Management and disposal practices for chemicals that are no longer needed or deemed unsuitable for their intended purpose. This information can be provided as a document, detailing the properties of waste that render it hazardous, along with disposal and recovery operations or recommendations, and accidental release measures. + + + true + DataElement + + + DocumentationEntity + + + en + Documentation Entity + + + + + en + Entity for a document with a header, type and content. + + + + + content + + + en + Content + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + xs:string + + + + contentType + + + en + Content Type + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + xs:string + + + + header + + + en + Header + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + xs:string + + + + + + + + disposalAfterUse + + + en + Disposal After Use + + + + + en + Chemical Management and Disposal Guides post-usage as document. + + + true + DataElement + + + DocumentationEntity + + + en + Documentation Entity + + + + + en + Entity for a document with a header, type and content. + + + + + content + + + en + Content + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + xs:string + + + + contentType + + + en + Content Type + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + xs:string + + + + header + + + en + Header + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + xs:string + + + + + + + + WasteCodeEntity + + + en + Waste Code Entity + + + + + en + Entity for the waste code of the material. + + + + + wasteCodeDescription + + + en + Waste Code Description + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#wasteCodeDescription + + + + xs:string + + + + wasteCodeRegulation + + + en + Waste Code Regulation + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#wasteCodeRegulation + + + + + + ExternalReference + + + GlobalReference + https://eur-lex.europa.eu/legal-content/EN/TXT/?uri=CELEX:02000D0532-20150601 + + + + + xs:string + + + + wasteCode + + + en + Waste Code + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#wasteCode + + + + xs:string + + + + + + disposalPackagingInformation + + + en + Disposal Packaging Information + + + + + en + Guidelines and instructions regarding the proper management and disposal of packaging materials after use. Includes instructions on separation, reuse, and recycling. + + + true + DataElement + + + DocumentationEntity + + + en + Documentation Entity + + + + + en + Entity for a document with a header, type and content. + + + + + content + + + en + Content + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + xs:string + + + + contentType + + + en + Content Type + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + xs:string + + + + header + + + en + Header + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + xs:string + + + + + + + + + + SafetyEntity + + + en + Safety Entity + + + + + en + Entity for safety information. + + + + + safetyDocumentation + + + en + Safety Documentation + + + + + en + Safety information in a document that outlines safety protocols, procedures, and guidelines to be followed in specific situations involving the product. It provides clear instructions on accident prevention, how to respond to emergencies, and mitigate potential hazards. Examples include exposure scenarios, safety data sheets, risk assessments, and information on safety equipment and personal protective equipment (PPE). + + + true + DataElement + + + DocumentationEntity + + + en + Documentation Entity + + + + + en + Entity for a document with a header, type and content. + + + + + content + + + en + Content + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + xs:string + + + + contentType + + + en + Content Type + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + xs:string + + + + header + + + en + Header + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + xs:string + + + + + + + + EmergencyEntity + + + en + Emergency Entity + + + + + en + Entity for information on how to proceed in case of an emergency. + + + + + emergencyAvailability + + + en + Emergency Availability + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#emergencyAvailability + + + + xs:string + + + + emergencyPhoneNumber + + + en + Emergency Phone Number + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#emergencyPhoneNumber + + + + xs:string + + + + + + firstAidDocument + + + en + First Aid Document + + + + + en + Information on how to proceed in case of an emergency is essential. It includes guidance on providing initial assistance or immediate care to a person who has been injured before professional medical help arrives. + + + true + DataElement + + + DocumentationEntity + + + en + Documentation Entity + + + + + en + Entity for a document with a header, type and content. + + + + + content + + + en + Content + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + xs:string + + + + contentType + + + en + Content Type + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + xs:string + + + + header + + + en + Header + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + xs:string + + + + + + + + + + ComplianceEntity + + + en + Compliance Entity + + + + + en + Entity for compliance attributes. + + + + + complianceCountry + + + en + Compliance Country + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#complianceCountry + + + + + + ExternalReference + + + GlobalReference + https://www.iso.org/iso-3166-country-codes.html + + + + + xs:string + + + + complianceRegulationName + + + en + Compliance Regulation Name + + + + + en + The name of the regulation or standard with which the product must comply can be sourced from Supplier Survey information. This attribute is referenced in ANNEX VI of the Proposal for a REGULATION OF THE EUROPEAN PARLIAMENT AND OF THE COUNCIL on detergents and surfactants, amending Regulation (EU) 2019/1020 and repealing Regulation (EC) No 648/2004: +The product passport shall include the following information: [...] +(e) references to Union legal acts that the detergent or surfactant complies with; + + + true + DataElement + + + complianceRegulationName + + + en + Compliance Regulation Name + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#complianceRegulationName + + + + xs:string + + + + + + complianceResult + + + en + Compliance Result + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#complianceResult + + + + xs:boolean + + + + complianceReasonForExemption + + + en + Compliance Reason For Exemption + + + + + en + Data providing details and justifications for an exemption from compliance with certain regulations, standards, or requirements. This information assists regulatory authorities or stakeholders in evaluating the merits of the exemption and making decisions in accordance with legal and regulatory requirements. + + + true + DataElement + + + complianceReasonForExemption + + + en + Compliance Reason For Exemption + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#complianceReasonForExemption + + + + xs:string + + + + + + complianceRemark + + + en + Compliance Remark + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#complianceRemark + + + + xs:string + + + + + + + + GenericEntity + + + en + Generic Entity + + + + + en + Entity for the product generic parameters. + + + + + IdentificationEntity + + + en + Identification Entity + + + + + en + Entity with identification information of the product with part type information, local identifiers, other codes and the data carrier. + + + + + serialInformation + + + en + Serial Information + + + + + en + Identifier for a serial part if available. This is mentioned in the ESPR provisional agreement from January 9th, 2024 Recital (27): +[...] an 'item' usually means a single unit of a model. + + + true + DataElement + + + KeyValueList + + + en + Key Value List + + + + + en + A list of key value pairs for local identifiers, which are composed of a key and a corresponding value. + + + + + key + + + en + Identifier Key + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.serial_part:3.0.0#key + + + + xs:string + + + + value + + + en + Identifier Value + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.serial_part:3.0.0#value + + + + xs:string + + + + + + + + batchInformation + + + en + Batch Information + + + + + en + Identifier for a batch part if available. Identifier for a serial part if available. This is mentioned in the ESPR provisional agreement from January 9th, 2024 Recital (27): +[...] a 'batch' usually means a subset of a specific model composed of all products produced in a specific manufacturing plant at a specific moment in time [...]. + + + true + DataElement + + + KeyValueList + + + en + Key Value List + + + + + en + A list of key value pairs for local identifiers, which are composed of a key and a corresponding value. + + + + + key + + + en + Identifier Key + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.batch:3.0.0#key + + + + xs:string + + + + value + + + en + Identifier Value + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.batch:3.0.0#value + + + + xs:string + + + + + + + + PartTypeEntity + + + en + Part Type Entity + + + + + en + Entity for the part type with manufacturer id and name. + + + + + manufacturerPartId + + + en + Manufacturer Part ID + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.part_type_information:1.0.0#manufacturerPartId + + + + xs:string + + + + nameAtManufacturer + + + en + Name at manufacturer + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.part_type_information:1.0.0#nameAtManufacturer + + + + xs:string + + + + + + codes + + + en + Codes + + + + + en + Codes for identification. + + + true + DataElement + + + CodeEntity + + + en + Code Entity + + + + + en + Code entity with code key and value. + + + + + codeKey + + + en + Code Key + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#codeKey + + + + xs:string + + + + codeValue + + + en + Code Value + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#codeValue + + + + xs:string + + + + + + + + DataCarrierEntity + + + en + Data Carrier Entity + + + + + en + Data Carrier Entity with type and layout of the data carrier. + + + + + carrierType + + + en + Carrier Type + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#carrierType + + + + xs:string + + + + carrierLayout + + + en + Carrier Layout + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#carrierLayout + + + + xs:string + + + + + + partClassification + + + en + Part Classification + + + + + en + Property describing the classification of a part. + + + true + DataElement + + + ClassificationEntity + + + en + ClassificationEntity + + + + + en + Encapsulates data related to the classification of the part. + + + + + classificationStandard + + + en + Classification Standard + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.shared.part_classification:1.0.0#classificationStandard + + + + xs:string + + + + classificationID + + + en + Classification ID + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.shared.part_classification:1.0.0#classificationID + + + + xs:string + + + + classificationDescription + + + en + Classification Description + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.shared.part_classification:1.0.0#classificationDescription + + + + xs:string + + + + + + + + + + OperationEntity + + + en + Operation Entity + + + + + en + Operational information of the product such as the owner, manufacturer and importer. + + + + + ManufacturerEntity + + + en + Manufacturer Entity + + + + + en + Manufacturing Entity with the identification of the main manufacturer and the facility location as well as the manufacturing date. + + + + + facilityIdentification + + + en + Facility Identification + + + + + en + The identifier used for a location. In the CATENA-X use case, the BPNA can be stated. This attribute is mentioned in the ESPR provisional agreement from January 9th 2024 Annex III: +(i) unique facility identifiers; +Article 2 Definitions: (33) 'unique facility identifier' means a unique string of characters for the identification of locations or buildings involved in the value chain of a product or used by actors involved in the value chain of a product. + + + true + DataElement + + + FacilityEntity + + + en + Facility Entity + + + + + en + The entity for a facility with the BPNA identifier. + + + + + facility + + + en + Facility + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#facility + + + + xs:string + + + + + + + + manufacturerIdentification + + + en + Manufacturer Identification + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#manufacturerIdentification + + + + xs:string + + + + manufacturingDate + + + en + Manufacturing Date + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#manufacturingDate + + + + xs:string + + + + + + ImportEntity + + + en + Import Entity + + + + + en + Import entity with attributes if applicable to the product. + + + + + ImporterEntity + + + en + Importer Entity + + + + + en + Entity with information regarding the importer such as the identification and the EORI. + + + + + eori + + + en + EORI + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#eori + + + + + + ExternalReference + + + GlobalReference + https://taxation-customs.ec.europa.eu/customs-4/customs-procedures-import-and-export-0/customs-procedures/economic-operators-registration-and-identification-number-eori_en + + + + + xs:string + + + + importerIdentification + + + en + Importer Identification + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#importerIdentification + + + + xs:string + + + + + + applicable + + + en + Applicable + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#applicable + + + + xs:boolean + + + + + + OperatorEntity + + + en + Operator Entity + + + + + en + Operator with role and identification. + + + + + otherOperatorId + + + en + Other Operator Id + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#otherOperatorId + + + + xs:string + + + + otherOperatorRole + + + en + Other Operator Role + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#otherOperatorRole + + + + xs:string + + + + + + + + CharacteristicsEntity + + + en + Characteristics Entity + + + + + en + Entity which defines specific characteristics of a product such as different life spans and physical dimensions. + + + + + lifespan + + + en + Lifespan + + + + + en + The type of lifespan represented with the values guaranteed lifetime, technical lifetime and mean time between failures. Both can be described through the attributes: type, which defines the type such as guaranteed lifetime or technical lifetime, the unit for the lifetime, and the value represented by an integer. These attributes are mentioned in the ESPR proposal from March 30th, 2022 ANNEX I: +(a) durability and reliability of the product or its components as expressed through the products guaranteed lifetime, technical lifetime [or] mean time between failures [...]. + + + true + DataElement + + + LifespanEntity + + + en + Lifespan Entity + + + + + en + Entity for the lifespan of a product with type, unit and value. + + + + + lifeUnit + + + en + Life Unit + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#lifeUnit + + + + + + ExternalReference + + + GlobalReference + https://eclipse-esmf.github.io/samm-specification/2.1.0/index.html + + + + + xs:string + + + + lifeValue + + + en + Life Value + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#lifeValue + + + + xs:integer + + + + lifeType + + + en + Life Type + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#lifeType + + + + xs:string + + + + + + + + PhysicalDimensionEntity + + + en + Physical Dimension Entity + + + + + en + Entity for physical dimensions with linear, mass and capacity attributes. Either weight or volume is mandatory. + + + + + LinearEntity + + + en + Linear Entity + + + + + en + Entity for linear measurements of an item with an unit and value. + + + + + quantityValue + + + en + Quantity Value + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.shared.quantity:2.0.0#quantityValue + + + + xs:float + + + + linearUnit + + + en + Linear Unit + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.shared.quantity:2.0.0#linearUnit + + + + + + ExternalReference + + + GlobalReference + https://eclipse-esmf.github.io/samm-specification/2.1.0/index.html + + + + + xs:string + + + + + + LinearEntity + + + en + Linear Entity + + + + + en + Entity for linear measurements of an item with an unit and value. + + + + + quantityValue + + + en + Quantity Value + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.shared.quantity:2.0.0#quantityValue + + + + xs:float + + + + linearUnit + + + en + Linear Unit + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.shared.quantity:2.0.0#linearUnit + + + + + + ExternalReference + + + GlobalReference + https://eclipse-esmf.github.io/samm-specification/2.1.0/index.html + + + + + xs:string + + + + + + LinearEntity + + + en + Linear Entity + + + + + en + Entity for linear measurements of an item with an unit and value. + + + + + quantityValue + + + en + Quantity Value + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.shared.quantity:2.0.0#quantityValue + + + + xs:float + + + + linearUnit + + + en + Linear Unit + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.shared.quantity:2.0.0#linearUnit + + + + + + ExternalReference + + + GlobalReference + https://eclipse-esmf.github.io/samm-specification/2.1.0/index.html + + + + + xs:string + + + + + + LinearEntity + + + en + Linear Entity + + + + + en + Entity for linear measurements of an item with an unit and value. + + + + + quantityValue + + + en + Quantity Value + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.shared.quantity:2.0.0#quantityValue + + + + xs:float + + + + linearUnit + + + en + Linear Unit + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.shared.quantity:2.0.0#linearUnit + + + + + + ExternalReference + + + GlobalReference + https://eclipse-esmf.github.io/samm-specification/2.1.0/index.html + + + + + xs:string + + + + + + MassEntity + + + en + Mass Entity + + + + + en + Entity for mass measurements of an item with an unit and value. + + + + + quantityValue + + + en + Quantity Value + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.shared.quantity:2.0.0#quantityValue + + + + xs:float + + + + massUnit + + + en + Mass Unit + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.shared.quantity:2.0.0#massUnit + + + + + + ExternalReference + + + GlobalReference + https://eclipse-esmf.github.io/samm-specification/2.1.0/index.html + + + + + xs:string + + + + + + VolumeEntity + + + en + Volume Entity + + + + + en + Entity for volume measurements of an item with an unit and value. + + + + + quantityValue + + + en + Quantity Value + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.shared.quantity:2.0.0#quantityValue + + + + xs:float + + + + volumeUnit + + + en + Volume Unit + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.shared.quantity:2.0.0#volumeUnit + + + + + + ExternalReference + + + GlobalReference + https://eclipse-esmf.github.io/samm-specification/2.1.0/index.html + + + + + xs:string + + + + + + MassEntity + + + en + Mass Entity + + + + + en + Entity for mass measurements of an item with an unit and value. + + + + + quantityValue + + + en + Quantity Value + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.shared.quantity:2.0.0#quantityValue + + + + xs:float + + + + massUnit + + + en + Mass Unit + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.shared.quantity:2.0.0#massUnit + + + + + + ExternalReference + + + GlobalReference + https://eclipse-esmf.github.io/samm-specification/2.1.0/index.html + + + + + xs:string + + + + + + VolumeEntity + + + en + Volume Entity + + + + + en + Entity for volume measurements of an item with an unit and value. + + + + + quantityValue + + + en + Quantity Value + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.shared.quantity:2.0.0#quantityValue + + + + xs:float + + + + volumeUnit + + + en + Volume Unit + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.shared.quantity:2.0.0#volumeUnit + + + + + + ExternalReference + + + GlobalReference + https://eclipse-esmf.github.io/samm-specification/2.1.0/index.html + + + + + xs:string + + + + + + + + physicalState + + + en + Physical State + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#physicalState + + + + xs:string + + + + generalPerformanceClass + + + en + General Performance Class + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#generalPerformanceClass + + + + xs:string + + + + + + CommercialEntity + + + en + Commercial Entity + + + + + en + Commercial information. + + + + + placedOnMarket + + + en + Placed on Market + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#placedOnMarket + + + + xs:string + + + + purpose + + + en + Purpose + + + + + en + One or more intended industry/industries of the product described by the digital product passport. If exchanged via Catena-X, 'automotive ' is a must choice included in the list. + + + true + DataElement + + + purpose + + + en + Purpose + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#purpose + + + + xs:string + + + + + + + + MaterialsEntity + + + en + Materials Entity + + + + + en + Entity with materials on the level of the product. + + + + + SubstanceOfConcernEntity + + + en + Substance Of Concern Entity + + + + + en + Substance of Concern entity with attributes if applicable to the product. + + + + + applicable + + + en + Applicable + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#applicable + + + + xs:boolean + + + + substanceOfConcern + + + en + Substance of Concern + + + + + en + Information regarding substances of concern in the product. Attributes are among others substance names, ids, concentration, location and hazard class. This is mentioned in the ESPR provisional agreement from January 9th, 2024 Article 7: +(5) (a) the name of the substances of concern present in the product, as follows: +- name(s) in the International Union of Pure and Applied Chemistry (IUPAC) nomenclature, or another international name when IUPAC name is not available; +- other names (usual name, trade name, abbreviation); +- European Community (EC) number, as indicated in the European Inventory of Existing Commercial Chemical Substances (EINECS), the European List of Notified Chemical Substances (ELINCS) or the No Longer Polymer (NLP) list or assigned by the European Chemicals Agency (ECHA), if available; +- the Chemical Abstract Service (CAS) name(s) and number(s), if available; +(5) (b) the location of the substances of concern within the product. +(5) (c) the concentration, maximum concentration or concentration range of the substances of concern, at the level of the product its relevant components, or spare parts; +(d) relevant instructions for the safe use of the product; +(e) information relevant for disassembly, preparation for reuse, reuse, recycling and the environmentally sound management of the product at the end of its life. +And in the next paragraph: +(c) provide duly justified exemptions for substances of concern or information elements from the information requirements referred to in the first subparagraph. + + + true + DataElement + + + SubstanceEntity + + + en + Substance Entity + + + + + en + Information regarding substances of concern in the product. + + + + + location + + + en + Location + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#location + + + + xs:string + + + + materialUnit + + + en + Material Unit + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#materialUnit + + + + + + ExternalReference + + + GlobalReference + https://eclipse-esmf.github.io/samm-specification/2.1.0/index.html + + + + + xs:string + + + + concentration + + + en + Concentration + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#concentration + + + + xs:float + + + + exemption + + + en + Exemption + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#exemption + + + + xs:string + + + + HazardEntity + + + en + Hazard Entity + + + + + en + Entity for the hazardous classification. + + + + + ExternalReference + + + GlobalReference + https://eur-lex.europa.eu/legal-content/EN/TXT/?uri=CELEX:02008R1272-20231201 + + + + + + + hazardCategory + + + en + Hazard Category + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#hazardCategory + + + + + + ExternalReference + + + GlobalReference + https://eur-lex.europa.eu/legal-content/EN/TXT/?uri=CELEX:02008R1272-20231201 + + + + + xs:string + + + + hazardClass + + + en + Hazard Class + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#hazardClass + + + + + + ExternalReference + + + GlobalReference + https://eur-lex.europa.eu/legal-content/EN/TXT/?uri=CELEX:02008R1272-20231201 + + + + + xs:string + + + + hazardStatement + + + en + Hazard Statement + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#hazardStatement + + + + + + ExternalReference + + + GlobalReference + https://eur-lex.europa.eu/legal-content/EN/TXT/?uri=CELEX:02008R1272-20231201 + + + + + xs:string + + + + + + concentrationRange + + + en + Concentration Range + + + + + en + The concentration range for the substance of concern. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7: +(5) (c) [...] concentration range of the substances of concern, at the level of the product [...]. + + + true + DataElement + + + RangeEntity + + + en + Range Entity + + + + + en + Entity for the concentration range with two values, the highest and the lowest of the concentration range. + + + + + minConcentration + + + en + Minimum Concentration + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#minConcentration + + + + xs:float + + + + maxConcentration + + + en + Maximum Concentration + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#maxConcentration + + + + xs:float + + + + + + + + materialIdentification + + + en + Material Identification + + + + + en + The chemical material name and identification, in accordance with the specification in the attribute for the list type. Preference is given to the IUPAC name. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Article 7: +(5) (a) the name of the substances of concern present in the product, as follows: + - name(s) in the International Union of Pure and Applied Chemistry (IUPAC) nomenclature, or another international name when IUPAC name is not available; +- other names (usual name, trade name, abbreviation); +- European Community (EC) number, as indicated in the European Inventory of Existing Commercial Chemical Substances (EINECS), the European List of Notified Chemical Substances (ELINCS) or the No Longer Polymer (NLP) list or assigned by the European Chemicals Agency (ECHA), if available; +- the Chemical Abstract Service (CAS) name(s) and number(s), if available; . + + + true + DataElement + + + MaterialIdEntity + + + en + Material Id Entity + + + + + en + Id Entity with identifier, name and list type. + + + + + chemicalId + + + en + Chemical Id + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#chemicalId + + + + xs:string + + + + listTypeId + + + en + List Type Id + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#listTypeId + + + + xs:string + + + + chemicalName + + + en + Chemical Name + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#chemicalName + + + + xs:string + + + + + + + + documentation + + + en + Documentation + + + + + en + Documentation accompanying the material. + + + true + DataElement + + + DocumentationEntity + + + en + Documentation Entity + + + + + en + Entity for a document with a header, type and content. + + + + + content + + + en + Content + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + xs:string + + + + contentType + + + en + Content Type + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + xs:string + + + + header + + + en + Header + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + xs:string + + + + + + + + + + + + + + ChemicalMaterialEntity + + + en + Chemical Material Entity + + + + + en + Material entity with attributes if applicable to the product. + + + + + applicable + + + en + Applicable + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#applicable + + + + xs:boolean + + + + chemicalMaterial + + + en + Material + + + + + en + Information on different materials in the product. + + + true + DataElement + + + MaterialEntity + + + en + Material Entity + + + + + en + Information regarding recycled and/or renewable materials in the product. + + + + + recycled + + + en + Recycled + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#recycled + + + + xs:float + + + + renewable + + + en + Renewable + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#renewable + + + + xs:float + + + + materialUnit + + + en + Material Unit + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#materialUnit + + + + + + ExternalReference + + + GlobalReference + https://eclipse-esmf.github.io/samm-specification/2.1.0/index.html + + + + + xs:string + + + + materialIdentification + + + en + Material Identification + + + + + en + The chemical material name and identification, in accordance with the specification in the attribute for the list type. Preference is given to the IUPAC name. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Article 7: +(5) (a) the name of the substances of concern present in the product, as follows: + - name(s) in the International Union of Pure and Applied Chemistry (IUPAC) nomenclature, or another international name when IUPAC name is not available; +- other names (usual name, trade name, abbreviation); +- European Community (EC) number, as indicated in the European Inventory of Existing Commercial Chemical Substances (EINECS), the European List of Notified Chemical Substances (ELINCS) or the No Longer Polymer (NLP) list or assigned by the European Chemicals Agency (ECHA), if available; +- the Chemical Abstract Service (CAS) name(s) and number(s), if available; . + + + true + DataElement + + + MaterialIdEntity + + + en + Material Id Entity + + + + + en + Id Entity with identifier, name and list type. + + + + + chemicalId + + + en + Chemical Id + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#chemicalId + + + + xs:string + + + + listTypeId + + + en + List Type Id + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#listTypeId + + + + xs:string + + + + chemicalName + + + en + Chemical Name + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#chemicalName + + + + xs:string + + + + + + + + critical + + + en + Critical + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#critical + + + + + + ExternalReference + + + GlobalReference + https://eur-lex.europa.eu/legal-content/EN/TXT/?uri=COM:2023:0160:FIN + + + + + xs:boolean + + + + concentration + + + en + Concentration + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#concentration + + + + xs:float + + + + documentation + + + en + Documentation + + + + + en + Documentation accompanying the material. + + + true + DataElement + + + DocumentationEntity + + + en + Documentation Entity + + + + + en + Entity for a document with a header, type and content. + + + + + content + + + en + Content + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + xs:string + + + + contentType + + + en + Content Type + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + xs:string + + + + header + + + en + Header + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + xs:string + + + + + + + + + + + + + + + + sources + + + en + Sources + + + + + en + Documents that are mandatory if applicable for the product. These are mentioned in the ESPR provisional agreement from January 9th, 2024 ANNEX III: +(e) compliance documentation and information required under this Regulation or other Union law applicable to the product, such as the declaration of conformity, technical documentation or conformity certificates; +(f) user manuals, instructions, warnings or safety information, as required by other Union legislation applicable to the product. +Additionally requirements are mentioned in Article 21: +7. Manufacturers shall ensure that a product covered by a delegated act adopted pursuant to Article 4 is accompanied by instructions in digital format that enable customers and other relevant actors to assemble, install, operate, store, maintain, repair and dispose of the product in a language that can be easily understood, as determined by the Member State concerned. Such instructions shall be clear, understandable and legible and include at least the information set out in Article 7(2), point (b), point (ii) specified in the delegated acts adopted pursuant to Article 4. +Article 7 states additionally: +(ii) information for customers and other actors on how to install, use, maintain and repair the product, in order to minimise its impact on the environment and to ensure optimum durability, on how to install third-party operating systems where relevant, as well as on collection for refurbishment or remanufacture, and on how to return or handle the product at the end of its life; +(2) (b) (iii) information for treatment facilities on disassembly, reuse, refurbishment, recycling, or disposal at end-of-life; +(2) (b) (iv) other information that may influence sustainable product choices for customers and the way the product is handled by parties other than the manufacturer in order to facilitate appropriate use, value retaining operations and correct treatment at end-of-life. +(5) (d) relevant instructions for the safe use of the product. +(5) (e) information relevant for disassembly, preparation for reuse, reuse, recycling and the environmentally sound management of the product at the end of its life. +Annex I: +(b) [...] availability of repair and maintenance instructions, number of materials and components used, use of standard components,[...] number and complexity of processes and whether specialised toolsare needed, ease of non-destructive disassembly and re-assembly, conditions for access to product data, conditions for access to or use of hardware and software needed; +(c) ease of upgrading, re-use, remanufacturing and refurbishment as expressed through: [...] number and complexity of processes and tools needed, ease of non-destructive disassembly and re-assembly, conditions for access to product data, conditions for access to or use of hardware and software needed, conditions of access to test protocols or not commonly available testing equipment, availability of guarantees specific to remanufactured or refurbished products, conditions for access to or use of technologies protected by intellectual property rights, modularity; +(d) design for recycling, ease and quality of recycling as expressed through: use of easily recyclable materials, safe, easy and non-destructive access to recyclable components and materials or components and materials containing hazardous substances and material composition and homogeneity, possibility for high-purity sorting, [...] number and complexity of processes and tools needed, ease of nondestructive disassembly and re-assembly, conditions for access to product data, conditions for access to or use of hardware and software needed; +(q) functional performance and conditions for use including as expressed through ability in performing its intended use, precautions of use, skills required, compatibility with other products or systems. +Additionally to consider are guidelines and instructions regarding the proper management and disposal of packaging materials after use. This can include instructions for separation, reuse, and recycling. + + + true + DataElement + + + DocumentEntity + + + en + Document Entity + + + + + en + Document entity with header, content, category and type. + + + + + content + + + en + Content + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + xs:string + + + + category + + + en + Category + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#category + + + + xs:string + + + + contentType + + + en + Content Type + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + xs:string + + + + header + + + en + Header + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + xs:string + + + + + + + + SustainabilityEntity + + + en + Sustainability Entity + + + + + en + Entity with the properties regarding the sustainability of the product. + + + + + state + + + en + State + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#state + + + + xs:string + + + + ProductFootprintEntity + + + en + Product Footprint Entity + + + + + en + The Product Footprint Entity with sustainability information such as the different environmental footprint types, the carbon and material footprint explicitly, applicable rules and lifecycle stages. + + + + + environmentalFootprint + + + en + Environmental Footprint + + + + + en + The environmental footprint of the product. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I: +The following parameters shall, as appropriate, and where necessary supplemented by others, be used, individually or combined, as a basis for improving the product aspects referred to in Article 5(1): +(l) the environmental footprint of the product, expressed as a quantification, in accordance with the applicable delegated act, of a product's life cycle environmental impacts, whether in relation to one or more environmental impact categories or an aggregated set of impact categories. +and Article 7: +(2)(b)(i) information on the performance of the product in relation to one or more of the product parameters referred to in Annex I, including a scoring of reparability or durability, carbon footprint or environmental footprint; +and defined by Article 2: +(23) 'environmental footprint' means a quantification of product environmental impacts throughout its life cycle, whether in relation to a single environmental impact category or an aggregated set of impact categories based on the Product Environmental Footprint method or other scientific methods developed by international organisations and widely tested in collaboration with different industry sectors and adopted or implemented by the Commission in other Union legislation; +(24) 'Product Environmental Footprint method' means the life cycle assessment method to quantify the environmental impacts of products established by Recommendation (EU) 2021/2279. + + + true + DataElement + + + FootprintEntity + + + en + Footprint Entity + + + + + en + Footprint Entity for the carbon and environmental footprint with the total value, unit, impact category type, lifecycle, rulebook, declaration, performance class and the facility. + + + + + footprintValue + + + en + Footprint Value + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#footprintValue + + + + xs:float + + + + footprintRulebook + + + en + Footprint Rulebook + + + + + en + The applied rulebook for the environmental footprint of the product. + + + true + DataElement + + + DocumentationEntity + + + en + Documentation Entity + + + + + en + Entity for a document with a header, type and content. + + + + + content + + + en + Content + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + xs:string + + + + contentType + + + en + Content Type + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + xs:string + + + + header + + + en + Header + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + xs:string + + + + + + + + footprintLifecycle + + + en + Footprint Lifecycle + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#footprintLifecycle + + + + xs:string + + + + footprintUnit + + + en + Footprint Unit + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#footprintUnit + + + + xs:string + + + + footprintType + + + en + Footprint Type + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#footprintType + + + + xs:string + + + + performanceClass + + + en + Performance Class + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#performanceClass + + + + xs:string + + + + manufacturingPlant + + + en + Manufacturing Plant + + + + + en + The manufacturing plant of the footprint in the specific lifecycle phase. + + + true + DataElement + + + FacilityEntity + + + en + Facility Entity + + + + + en + The entity for a facility with the BPNA identifier. + + + + + facility + + + en + Facility + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#facility + + + + xs:string + + + + + + + + declaration + + + en + Declaration + + + + + en + The footprint declaration in the format of a link + + + true + DataElement + + + DocumentationEntity + + + en + Documentation Entity + + + + + en + Entity for a document with a header, type and content. + + + + + content + + + en + Content + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + xs:string + + + + contentType + + + en + Content Type + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + xs:string + + + + header + + + en + Header + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + xs:string + + + + + + + + + + + + carbonFootprint + + + en + Carbon Footprint + + + + + en + The carbon footprint of the product. This is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I: +The following parameters shall, as appropriate, and where necessary supplemented by others, be used, individually or combined, as a basis for improving the product aspects referred to in Article 5(1): +(m) the carbon footprint of the product; +and Article 7: +(2)(b)(i) information on the performance of the product in relation to one or more of the product parameters referred to in Annex I, including a scoring of reparability or durability, carbon footprint or environmental footprint; +and defined by Article 2: +(25) 'carbon footprint' means the sum of greenhouse gas (GHG) emissions and GHG removals in a product system, expressed as CO2 equivalents and based on a life cycle assessment using the single impact category of climate change. + + + true + DataElement + + + FootprintEntity + + + en + Footprint Entity + + + + + en + Footprint Entity for the carbon and environmental footprint with the total value, unit, impact category type, lifecycle, rulebook, declaration, performance class and the facility. + + + + + footprintValue + + + en + Footprint Value + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#footprintValue + + + + xs:float + + + + footprintRulebook + + + en + Footprint Rulebook + + + + + en + The applied rulebook for the environmental footprint of the product. + + + true + DataElement + + + DocumentationEntity + + + en + Documentation Entity + + + + + en + Entity for a document with a header, type and content. + + + + + content + + + en + Content + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + xs:string + + + + contentType + + + en + Content Type + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + xs:string + + + + header + + + en + Header + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + xs:string + + + + + + + + footprintLifecycle + + + en + Footprint Lifecycle + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#footprintLifecycle + + + + xs:string + + + + footprintUnit + + + en + Footprint Unit + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#footprintUnit + + + + xs:string + + + + footprintType + + + en + Footprint Type + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#footprintType + + + + xs:string + + + + performanceClass + + + en + Performance Class + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#performanceClass + + + + xs:string + + + + manufacturingPlant + + + en + Manufacturing Plant + + + + + en + The manufacturing plant of the footprint in the specific lifecycle phase. + + + true + DataElement + + + FacilityEntity + + + en + Facility Entity + + + + + en + The entity for a facility with the BPNA identifier. + + + + + facility + + + en + Facility + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#facility + + + + xs:string + + + + + + + + declaration + + + en + Declaration + + + + + en + The footprint declaration in the format of a link + + + true + DataElement + + + DocumentationEntity + + + en + Documentation Entity + + + + + en + Entity for a document with a header, type and content. + + + + + content + + + en + Content + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + xs:string + + + + contentType + + + en + Content Type + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + xs:string + + + + header + + + en + Header + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + xs:string + + + + + + + + + + + + materialFootprint + + + en + Material Footprint + + + + + en + The material footprint of the product. This is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I: +(ma) the material footprint of the product; +and defined by Article 2: +(25a) 'material footprint' refers to the total amount of raw materials extracted to meet final consumption demands. + + + true + DataElement + + + FootprintEntity + + + en + Footprint Entity + + + + + en + Footprint Entity for the carbon and environmental footprint with the total value, unit, impact category type, lifecycle, rulebook, declaration, performance class and the facility. + + + + + footprintValue + + + en + Footprint Value + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#footprintValue + + + + xs:float + + + + footprintRulebook + + + en + Footprint Rulebook + + + + + en + The applied rulebook for the environmental footprint of the product. + + + true + DataElement + + + DocumentationEntity + + + en + Documentation Entity + + + + + en + Entity for a document with a header, type and content. + + + + + content + + + en + Content + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + xs:string + + + + contentType + + + en + Content Type + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + xs:string + + + + header + + + en + Header + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + xs:string + + + + + + + + footprintLifecycle + + + en + Footprint Lifecycle + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#footprintLifecycle + + + + xs:string + + + + footprintUnit + + + en + Footprint Unit + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#footprintUnit + + + + xs:string + + + + footprintType + + + en + Footprint Type + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#footprintType + + + + xs:string + + + + performanceClass + + + en + Performance Class + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#performanceClass + + + + xs:string + + + + manufacturingPlant + + + en + Manufacturing Plant + + + + + en + The manufacturing plant of the footprint in the specific lifecycle phase. + + + true + DataElement + + + FacilityEntity + + + en + Facility Entity + + + + + en + The entity for a facility with the BPNA identifier. + + + + + facility + + + en + Facility + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#facility + + + + xs:string + + + + + + + + declaration + + + en + Declaration + + + + + en + The footprint declaration in the format of a link + + + true + DataElement + + + DocumentationEntity + + + en + Documentation Entity + + + + + en + Entity for a document with a header, type and content. + + + + + content + + + en + Content + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + xs:string + + + + contentType + + + en + Content Type + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + xs:string + + + + header + + + en + Header + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + xs:string + + + + + + + + + + + + + + reparabilityScore + + + en + Reparability Score + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#reparabilityScore + + + + xs:string + + + + durabilityScore + + + en + Durability Score + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#durabilityScore + + + + xs:string + + + + + + MetadataEntity + + + en + Metadata Entity + + + + + en + Passport Entity to describe version, status, end and issue date. + + + + + version + + + en + Version + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#version + + + + xs:string + + + + status + + + en + Status + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#status + + + + xs:string + + + + expirationDate + + + en + Expiration Date + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#expirationDate + + + + xs:string + + + + issueDate + + + en + Issue Date + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#issueDate + + + + xs:string + + + + economicOperatorId + + + en + Economic Operator Id + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#economicOperatorId + + + + xs:string + + + + passportIdentifier + + + en + Passport Identifier + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#passportIdentifier + + + + xs:string + + + + predecessor + + + en + Predecessor + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#predecessor + + + + xs:string + + + + backupReference + + + en + Backup Reference + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#backupReference + + + + xs:string + + + + registrationIdentifier + + + en + Registration Identifier + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#registrationIdentifier + + + + xs:string + + + + lastModification + + + en + Last Modification + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#lastModification + + + + xs:string + + + + + + + + + + + + APPLICATION_CLASS + ChemicalMaterialPassport + + + en + Chemical Material Passport + + + + + en + The information in a Digital Product Passport allows stakeholders in the value chain to map information and obtain a better understanding of the composition of the product, the environmental impact of the production and use phase, and the aspect of circularity. To serve the same purpose as the Digital Passport, the Chemical Material Passport also plays an important role in providing more detailed information in terms of sustainability, safety and waste management. It can replace the current way of communication and data exchange from multi-channels by one streamlined data flow. + + + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#ChemicalMaterialPassport + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Chemical Material Passport + + + + + en + ChemicalMaterialPassport + + + + + en + The information in a Digital Product Passport allows stakeholders in the value chain to map information and obtain a better understanding of the composition of the product, the environmental impact of the production and use phase, and the aspect of circularity. To serve the same purpose as the Digital Passport, the Chemical Material Passport also plays an important role in providing more detailed information in terms of sustainability, safety and waste management. It can replace the current way of communication and data exchange from multi-channels by one streamlined data flow. + + + + + + + + + productParameterName + + + en + Product Parameter Name + + + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#productParameterName + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Product Parameter Name + + + + + en + productParameterName + + + STRING + + + en + The name of the parameter for the product tested and presented, for instance, in the Certificate of Analysis or Safety Data Sheet, found in Section 9. Parameters for chemical products usually encompass their chemical composition, physical properties, performance characteristics, and toxicological aspects. These parameters vary depending on the chemical's nature, its intended use, and relevant safety or regulatory considerations. + + + + + + + + + productParameterValue + + + en + Product Parameter Value + + + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#productParameterValue + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Product Parameter Value + + + + + en + productParameterValue + + + STRING + + + en + The value resulting from the tested parameter is typically presented in Section 9 of the Safety Data Sheet or Certificate of Analysis. + + + + + + + + + productParameterUnit + + + en + Product Parameter Unit + + + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#productParameterUnit + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Product Parameter Unit + + + + + en + productParameterUnit + + + STRING + + + en + The unit of measurement for the parameter value presented in Section 9 of the Safety Data Sheet or Certificate of Analysis varies depending on the specific parameter being reported. + + + + + + + + + productParameterResult + + + en + Product Parameter Result + + + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#productParameterResult + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Product Parameter Result + + + + + en + productParameterResult + + + STRING + + + en + Other types of results, if not numerical values, for parameters presented in Section 9 of the Safety Data Sheet or Certificate of Analysis may include qualitative descriptions like "pass" or "fail," as well as ranges, thresholds, or classifications. + + + + + + + + + parameterMethodName + + + en + Parameter Method Name + + + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#parameterMethodName + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Parameter Method Name + + + + + en + parameterMethodName + + + STRING + + + en + The name of the testing method or standard used for testing parameters can vary depending on the context and industry. It might be referred to by a specific code, standard name, or regulation/directive. + + + + + + + + + parameterMethodConditions + + + en + Parameter Method Conditions + + + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#parameterMethodConditions + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Parameter Method Conditions + + + + + en + parameterMethodConditions + + + STRING + + + en + The relevant conditions for conducting a measurement or analysis of a chemical parameter ensure the accuracy, reliability, and consistency of the results obtained from the method used. These conditions are typically presented in the Certificate of Analysis or Safety Data Sheet, specifically in Section 9. + + + + + + + + + parameterMethodDescription + + + en + Parameter Method Description + + + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#parameterMethodDescription + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Parameter Method Description + + + + + en + parameterMethodDescription + + + STRING + + + en + Short description of the method used to determine parameter presented in Certificate of Analysis or Safety Data Sheet in Section 9. + + + + + + + + + productParameterMethod + + + en + Product Parameter Method + + + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#productParameterMethod + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Product Parameter Method + + + + + en + productParameterMethod + + + STRING + + + en + Testing methods or standards used for testing parameters. + + + + + + + + + productParameterRemark + + + en + Product Parameter Remark + + + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#productParameterRemark + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Product Parameter Remark + + + + + en + productParameterRemark + + + STRING + + + en + Commentary on the test/parameter presented in the Certificate of Analysis or Safety Data Sheet in Section 9. Selecting "not applicable" is also an option. + + + + + + + + + parameterClassificationStatement + + + en + Parameter Classification Statement + + + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#parameterClassificationStatement + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Parameter Classification Statement + + + + + en + parameterClassificationStatement + + + STRING + + + en + List of classification statements resulting from the test should include information on whether the result impacts the hazard classification of the product, particularly in the case of properties such as explosives in Safety Data Sheets (SDS). + + + + + + + + + parameterTestGLPCompliance + + + en + Parameter Test GLP Compliance + + + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#parameterTestGLPCompliance + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Parameter Test GLP Compliance + + + + + en + parameterTestGLPCompliance + + + BOOLEAN + + + en + Statement indicating whether the test for the parameter was conducted in accordance with the Good Laboratory Practice (GLP) standard, as outlined in ISO/IEC 17025:2017, which specifies general requirements for the competence of testing and calibration laboratories. + + + + + + + + + content + + + en + Content + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Content + + + + + en + content + + + STRING + + + en + The content of the document e.g a link. + + + + + + + + + contentType + + + en + Content Type + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Content Type + + + + + en + contentType + + + STRING + + + en + The type of content which can be expected in the "content" property. Examples are a link, restricted link, pdf, excel, etc. + + + + + + + + + header + + + en + Header + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Header + + + + + en + header + + + STRING + + + en + The header as a short description of the document with a maximum of 100 characters. + + + + + + + + + parameterDocumentation + + + en + Parameter Documentation + + + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#parameterDocumentation + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Parameter Documentation + + + + + en + parameterDocumentation + + + STRING + + + en + Reference to the confirmation of the result typically includes a link to the document containing the confirmation, such as the Certificate of Analysis (CoA). + + + + + + + + + parameterBeforeUse + + + en + Parameter Before Use + + + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#parameterBeforeUse + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Parameter Before Use + + + + + en + parameterBeforeUse + + + STRING + + + en + Parameters of the chemical material before use. + + + + + + + + + content + + + en + Content + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Content + + + + + en + content + + + STRING + + + en + The content of the document e.g a link. + + + + + + + + + contentType + + + en + Content Type + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Content Type + + + + + en + contentType + + + STRING + + + en + The type of content which can be expected in the "content" property. Examples are a link, restricted link, pdf, excel, etc. + + + + + + + + + header + + + en + Header + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Header + + + + + en + header + + + STRING + + + en + The header as a short description of the document with a maximum of 100 characters. + + + + + + + + + parameterAfterUseDocumentation + + + en + Parameter After Use Documentation + + + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#parameterAfterUseDocumentation + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Parameter After Use Documentation + + + + + en + parameterAfterUseDocumentation + + + STRING + + + en + Parameters of a product that may change or become relevant after its intended use are often documented as post-application characteristics. This data can be found in documents such as "Technical Documentation." + + + + + + + + + applicable + + + en + Applicable + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#applicable + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Applicable + + + + + en + applicable + + + BOOLEAN + + + en + Check whether the connected attributes are applicable to the product. If it is not applicable (false), dummy data can be delivered. + + + + + + + + + parameterAfterUse + + + en + Parameter After Use + + + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#parameterAfterUse + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Parameter After Use + + + + + en + parameterAfterUse + + + STRING + + + en + Parameters of the chemical material after use. + + + + + + + + + parameter + + + en + Parameter + + + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#parameter + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Parameter + + + + + en + parameter + + + STRING + + + en + Parameters of the chemical material. + + + + + + + + + productType + + + en + Product Type + + + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#productType + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Product Type + + + + + en + productType + + + STRING + + + en + Information, whether the product is a substance, mixture or article. Definitions from REACH Regulation (EC) No 1907/2006: +"substance": means a chemical element and its compounds in the natural state or obtained by any manufacturing process, including any additive necessary to preserve its stability and any impurity deriving from the process used, but excluding any solvent which may be separated without affecting the stability of the substance or changing its composition; +"mixture": means a mixture or solution composed of two or more substances; +"article": means an object which during production is given a special shape, surface or design which determines its function to a greater degree than does its chemical composition; + + + + + + substance + + ModelReference + + + DataElement + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#MaterialEnumeration:substance + + + + + + mixture + + ModelReference + + + DataElement + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#MaterialEnumeration:mixture + + + + + + article + + ModelReference + + + DataElement + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#MaterialEnumeration:article + + + + + + + + + + + + + classificationRule + + + en + Classification Rule + + + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#classificationRule + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Classification Rule + + + + + en + classificationRule + + + STRING + + + en + Name of the classification rule under which the hazard assessment has been prepared. + + + + + + + + + classificationHazardInfo + + + en + classification Hazard Info + + + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#classificationHazardInfo + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + classification Hazard Info + + + + + en + classificationHazardInfo + + + BOOLEAN + + + en + Information if the product is hazardous or not, according to the connected rule. + + + + + + + + + classificationHazardClassRoute + + + en + Classification Hazard Class Route + + + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#classificationHazardClassRoute + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Classification Hazard Class Route + + + + + en + classificationHazardClassRoute + + + STRING + + + en + Certain classifications must be communicated with the relevant route of exposure according to CLP Regulation (EC) No 1272/2008, which include: +- oral, +- dermal, +- inhalation gas, +- inhalation vapour, +- inhalation dust/mist/fume. + + + + + + oral + + ModelReference + + + DataElement + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#RouteEnumeration:oral + + + + + + dermal + + ModelReference + + + DataElement + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#RouteEnumeration:dermal + + + + + + inhalation gas + + ModelReference + + + DataElement + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#RouteEnumeration:inhalation gas + + + + + + inhalation vapour + + ModelReference + + + DataElement + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#RouteEnumeration:inhalation vapour + + + + + + inhalation dust/mist/fume + + ModelReference + + + DataElement + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#RouteEnumeration:inhalation dust/mist/fume + + + + + + not applicable + + ModelReference + + + DataElement + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#RouteEnumeration:not applicable + + + + + + + + + + + + + classificationRemark + + + en + Classification Remark + + + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#classificationRemark + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Classification Remark + + + + + en + classificationRemark + + + STRING + + + en + Additional remarks for classification information supplement the classification details for a particular chemical material. These remarks assist stakeholders in making informed decisions regarding safety, handling, and regulatory compliance. + + + + + + + + + hazardCategory + + + en + Hazard Category + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#hazardCategory + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Hazard Category + + + + + en + hazardCategory + + + STRING + + + en + The hazard category of the substance of concern. Defined in Article 2 of Regulation (EC) No 1272/2008 of the European Parliament and of the Council of 16 December 2008 on classification, labelling and packaging of substances and mixtures, amending and repealing Directives 67/548/EEC and 1999/45/EC, and amending Regulation (EC) No 1907/2006: +2. 'hazard category' means the division of criteria within each hazard class, specifying hazard severity. + + + + + + + + + hazardClass + + + en + Hazard Class + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#hazardClass + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Hazard Class + + + + + en + hazardClass + + + STRING + + + en + The hazard class of the substance of concern. Defined in Article 2 of Regulation (EC) No 1272/2008 of the European Parliament and of the Council of 16 December 2008 on classification, labelling and packaging of substances and mixtures, amending and repealing Directives 67/548/EEC and 1999/45/EC, and amending Regulation (EC) No 1907/2006: +1. 'hazard class' means the nature of the physical, health or environmental hazard. + + + + + + + + + hazardStatement + + + en + Hazard Statement + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#hazardStatement + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Hazard Statement + + + + + en + hazardStatement + + + STRING + + + en + The hazard statement of the substance of concern. Defined in Article 2 of Regulation (EC) No 1272/2008 of the European Parliament and of the Council of 16 December 2008 on classification, labelling and packaging of substances and mixtures, amending and repealing Directives 67/548/EEC and 1999/45/EC, and amending Regulation (EC) No 1907/2006: +5. 'hazard statement' means a phrase assigned to a hazard class and category that describes the nature of the hazards of a hazardous substance or mixture, including, where appropriate, the degree of hazard. + + + + + + + + + classification + + + en + Classification + + + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#classification + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Classification + + + + + en + classification + + + STRING + + + en + Classification for the hazard assessment. + + + + + + + + + signalWord + + + en + Signal Word + + + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#signalWord + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Signal Word + + + + + en + signalWord + + + STRING + + + en + According to CLP Regulation (EC) No 1272/2008, a "signal word" refers to a term indicating the relative severity of hazards to alert the reader to a potential danger. There are two levels distinguished: +(a) ‘Danger’ means a signal word indicating the more severe hazard categories; +(b) ‘Warning’ means a signal word indicating the less severe hazard categories; + + + + + + Danger + + ModelReference + + + DataElement + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#SignalWordEnumeration:Danger + + + + + + Warning + + ModelReference + + + DataElement + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#SignalWordEnumeration:Warning + + + + + + + + + + + + + hazardPictogramCode + + + en + Hazard Pictogram Code + + + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#hazardPictogramCode + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Hazard Pictogram Code + + + + + en + hazardPictogramCode + + + STRING + + + en + The code of a pictogram refers to a set of symbols used to visually represent and communicate information about the hazards associated with a chemical material. + + + + + + + + + hazardPictogramImage + + + en + Hazard Pictogram Image + + + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#hazardPictogramImage + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Hazard Pictogram Image + + + + + en + hazardPictogramImage + + + STRING + + + en + Link to the picture of the pictogram. Definition from CLP Regulation (EC) No 1272/2008 : ‘hazard pictogram’ means a graphical composition that includes a symbol plus other graphic elements, such as a border, background pattern or colour that is intended to convey specific information on the hazard concerned; + + + + + + + + + hazardPictogramName + + + en + Hazard Pictogram Name + + + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#hazardPictogramName + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Hazard Pictogram Name + + + + + en + hazardPictogramName + + + STRING + + + en + The meaning or description of a pictogram is the explanation that accompanies it, providing information and context about its purpose and the hazards it represents. + + + + + + + + + hazardPictogram + + + en + Hazard Pictogram + + + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#hazardPictogram + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Hazard Pictogram + + + + + en + hazardPictogram + + + STRING + + + en + A hazard pictogram is a graphical symbol used to convey specific information about the hazards associated with a chemical substance or mixture. + + + + + + + + + hazardStatementCode + + + en + Hazard Statement Code + + + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#hazardStatementCode + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Hazard Statement Code + + + + + en + hazardStatementCode + + + STRING + + + en + According to CLP Regulation (EC) No 1272/2008, each hazard statement is designated a code, starting with the letter H followed by three digits. These codes can be associated with multiple hazard statements or be assigned to a single statement. + + + + + + + + + hazardStatementText + + + en + Hazard Statement Text + + + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#hazardStatementText + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Hazard Statement Text + + + + + en + hazardStatementText + + + STRING + + + en + Definition from CLP Regulation (EC) No 1272/2008 ‘hazard statement’ means a phrase assigned to a hazard class and category that describes the nature of the hazards of a hazardous substance or mixture, including, where appropriate, the degree of hazard; + + + + + + + + + hazardStatement + + + en + Hazard Statement + + + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#hazardStatement + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Hazard Statement + + + + + en + hazardStatement + + + STRING + + + en + Describes the nature of a hazard associated with a chemical substance or mixture. + + + + + + + + + precautionaryCode + + + en + Precautionary Code + + + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#precautionaryCode + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Precautionary Code + + + + + en + precautionaryCode + + + STRING + + + en + Each precautionary statement is designated a code, starting with the letter P and followed by three digits. + + + + + + + + + precautionaryText + + + en + Precautionary Text + + + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#precautionaryText + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Precautionary Text + + + + + en + precautionaryText + + + STRING + + + en + Definition from CLP Regulation (EC) No 1272/2008: ‘precautionary statement’ means a phrase that describes recommended measure(s) to minimise or prevent adverse effects resulting from exposure to a hazardous substance or mixture due to its use or disposal. + + + + + + + + + precautionary + + + en + Precautionary + + + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#precautionary + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Precautionary + + + + + en + precautionary + + + STRING + + + en + A precautionary code for materials is a standardized code used to convey specific precautionary measures that should be taken when handling, storing, or using a chemical substance or mixture. + + + + + + + + + supplementalRequirementsCode + + + en + Supplemental Requirements Code + + + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#supplementalRequirementsCode + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Supplemental Requirements Code + + + + + en + supplementalRequirementsCode + + + STRING + + + en + Supplemental codes used for labeling statements provide additional information or context about the hazards, handling, or regulatory requirements associated with chemical materials. This data can be helpful for stakeholders in managing chemical materials by offering further guidance on safe handling practices, storage conditions, emergency response procedures, or regulatory compliance measures. + + + + + + + + + supplementalRequirementsText + + + en + Supplemental Requirements Text + + + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#supplementalRequirementsText + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Supplemental Requirements Text + + + + + en + supplementalRequirementsText + + + STRING + + + en + Any supplemental text used for labeling provides data that could be helpful for stakeholders in managing chemical materials. + + + + + + + + + supplementalRequirementsPictogram + + + en + Supplemental Requirements Pictogram + + + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#supplementalRequirementsPictogram + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Supplemental Requirements Pictogram + + + + + en + supplementalRequirementsPictogram + + + STRING + + + en + Supplemental pictures or pictograms used for additional labeling provide data that could be helpful for stakeholders in managing chemical materials. + + + + + + + + + productLabelingNotes + + + en + Product Labeling Notes + + + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#productLabelingNotes + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Product Labeling Notes + + + + + en + productLabelingNotes + + + STRING + + + en + Labeling notes consist of statements that provide additional information regarding hazardous possible reactions or other important considerations related to the chemical material. These notes help stakeholders understand potential risks and take appropriate precautions when handling, storing, or using the material. + + + + + + + + + supplementalRequirements + + + en + Supplemental Requirements + + + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#supplementalRequirements + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Supplemental Requirements + + + + + en + supplementalRequirements + + + STRING + + + en + Supplemental requirements often include additional codes, symbols, or statements beyond those required by regulations. + + + + + + + + + labeling + + + en + Labeling + + + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#labeling + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Labeling + + + + + en + labeling + + + STRING + + + en + The material labeling. + + + + + + + + + content + + + en + Content + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Content + + + + + en + content + + + STRING + + + en + The content of the document e.g a link. + + + + + + + + + contentType + + + en + Content Type + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Content Type + + + + + en + contentType + + + STRING + + + en + The type of content which can be expected in the "content" property. Examples are a link, restricted link, pdf, excel, etc. + + + + + + + + + header + + + en + Header + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Header + + + + + en + header + + + STRING + + + en + The header as a short description of the document with a maximum of 100 characters. + + + + + + + + + hazardAssessmentDocumentation + + + en + Hazard Assessment Documentation + + + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#hazardAssessmentDocumentation + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Hazard Assessment Documentation + + + + + en + hazardAssessmentDocumentation + + + STRING + + + en + Documentation providing hazard assessment information for ensuring the safe management of chemical materials throughout their lifecycle. + + + + + + + + + hazardAssessment + + + en + Hazard Assessment + + + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#hazardAssessment + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Hazard Assessment + + + + + en + hazardAssessment + + + STRING + + + en + Hazard assessment refers to evaluating and identifying potential risks or dangers associated with the specific material. + + + + + + + + + emergencyTemperatureMinValue + + + en + Emergency Temperature Min Value + + + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#emergencyTemperatureMinValue + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Emergency Temperature Min Value + + + + + en + emergencyTemperatureMinValue + + + degreeCelsius + REAL_MEASURE + + + en + The critical minimum temperature for transporting the product refers to the lowest temperature at which the product can be safely transported without compromising its integrity or functionality. Emergency temperature refers to a temperature that poses a significant risk, potentially leading to hazardous conditions or product damage. + + + + + + + + + emergencyTemperatureMaxValue + + + en + Emergency Temperature Max Value + + + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#emergencyTemperatureMaxValue + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Emergency Temperature Max Value + + + + + en + emergencyTemperatureMaxValue + + + degreeCelsius + REAL_MEASURE + + + en + The critical maximum temperature for transporting the product refers to the highest temperature at which the product can be safely transported without degradation or posing a risk. Emergency temperature refers to a temperature that poses a significant risk, potentially leading to hazardous conditions or product damage. + + + + + + + + + transportOtherInformation + + + en + Transport Other Information + + + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#transportOtherInformation + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Transport Other Information + + + + + en + transportOtherInformation + + + STRING + + + en + Additional information related to the transport of the product. Relevant details that could aid in making decisions regarding the shipping of the product. + + + + + + + + + controlTemperature + + + en + Control Temperature + + + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#controlTemperature + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Control Temperature + + + + + en + controlTemperature + + + STRING + + + en + The controlled temperature for transportation refers to the range of values within which the temperature conditions of goods or products are monitored and regulated during transportation in degree celcius. This information is crucial for mitigating risks associated with temperature-sensitive products, ensuring their integrity and quality throughout the shipping process. + + + + + + + + + transportPictogram + + + en + Transport Pictogram + + + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#transportPictogram + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Transport Pictogram + + + + + en + transportPictogram + + + STRING + + + en + Links to transport related pictograms. + + + + + + + + + productTransport + + + en + Product Transport + + + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#productTransport + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Product Transport + + + + + en + productTransport + + + STRING + + + en + Transport related attributes, which are not UN related. + + + + + + + + + transportRegulation + + + en + Transport Regulation + + + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#transportRegulation + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Transport Regulation + + + + + en + transportRegulation + + + STRING + + + en + Indicate regulations for transportation for example: Land transport (ADR/RID), Inland waterway transport (ADN), Sea transport (IMDG), Air transport (ICAO-TI/IATA-DGR) and so on. + + + + + + + + + unNumber + + + en + UN Number + + + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#unNumber + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + UN Number + + + + + en + unNumber + + + STRING + + + en + The UN number or ID number is a four-digit identification code for substances, mixtures, or articles. + + + + + + + + + unShippingName + + + en + UN Shipping Name + + + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#unShippingName + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + UN Shipping Name + + + + + en + unShippingName + + + STRING + + + en + The proper shipping name is provided in column 2, "Name and description," of Table A of Chapter 3.2 Dangerous Goods List of the UN Regulations. + + + + + + + + + unHazardClassCode + + + en + UN Hazard Class Code + + + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#unHazardClassCode + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + UN Hazard Class Code + + + + + en + unHazardClassCode + + + REAL_MEASURE + + + en + The transport class of the dangerous group according to UN Regulations. + + + + + + + + + unHazardClassName + + + en + UN Hazard Class Name + + + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#unHazardClassName + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + UN Hazard Class Name + + + + + en + unHazardClassName + + + STRING + + + en + The classified dangerous group in transportation refers to the classification of hazardous materials or dangerous goods according to the United Nations (UN) Globally Harmonized System of Classification and Labelling of Chemicals (GHS) and the UN Model Regulations for the Transport of Dangerous Goods. + + + + + + + + + unPackagingGroup + + + en + UN Packaging Group + + + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#unPackagingGroup + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + UN Packaging Group + + + + + en + unPackagingGroup + + + STRING + + + en + Group to which certain substances may be assigned for packaging purposes according to their degree of danger: +Packaging group I: Substances presenting high danger, +Packaging group II: Substances presenting medium danger, +Packaging group III: Substances presenting low danger. +Not all dangerous goods assigned to hazard classes or their divisions will be allocated to Packaging Groups. + + + + + + I + + ModelReference + + + DataElement + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#PackagingGroupEnumeration:I + + + + + + II + + ModelReference + + + DataElement + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#PackagingGroupEnumeration:II + + + + + + III + + ModelReference + + + DataElement + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#PackagingGroupEnumeration:III + + + + + + not applicable + + ModelReference + + + DataElement + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#PackagingGroupEnumeration:not applicable + + + + + + + + + + + + + unExceptedQuantityCode + + + en + UN Excepted Quantity Code + + + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#unExceptedQuantityCode + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + UN Excepted Quantity Code + + + + + en + unExceptedQuantityCode + + + STRING + + + en + Chapter 3.5 of UN Transportation Regulation pertains to dangerous goods packed in excepted quantities, with possible codes including E0, E1, E2, E3, E4, and E5. + + + + + + E0 + + ModelReference + + + DataElement + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#QuantityCodeEnumeration:E0 + + + + + + E1 + + ModelReference + + + DataElement + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#QuantityCodeEnumeration:E1 + + + + + + E2 + + ModelReference + + + DataElement + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#QuantityCodeEnumeration:E2 + + + + + + E3 + + ModelReference + + + DataElement + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#QuantityCodeEnumeration:E3 + + + + + + E4 + + ModelReference + + + DataElement + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#QuantityCodeEnumeration:E4 + + + + + + E5 + + ModelReference + + + DataElement + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#QuantityCodeEnumeration:E5 + + + + + + + + + + + + + environmentallyHazardous + + + en + Environmentally Hazardous + + + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#environmentallyHazardous + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Environmentally Hazardous + + + + + en + environmentallyHazardous + + + STRING + + + en + The indication of whether a substance or mixture is environmentally hazardous according to the criteria of the UN Model Regulations (as reflected in ADR, RID, and ADN) and whether it is a marine pollutant according to the IMDG Code and the Emergency Response Procedures for Ships Carrying Dangerous Goods. + + + + + + + + + specialProvisionsCode + + + en + Special Provisions Code + + + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#specialProvisionsCode + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Special Provisions Code + + + + + en + specialProvisionsCode + + + INTEGER_MEASURE + + + en + Code of special provisions or exceptions that must be met. + + + + + + + + + specialProvisionsInfo + + + en + Special Provisions Info + + + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#specialProvisionsInfo + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Special Provisions Info + + + + + en + specialProvisionsInfo + + + STRING + + + en + Text aligned with special provisions under UN transport regulation Chapter 3.3. + + + + + + + + + unSpecialProvisionsCode + + + en + UN Special Provisions Code + + + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#unSpecialProvisionsCode + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + UN Special Provisions Code + + + + + en + unSpecialProvisionsCode + + + STRING + + + en + The UN Special Provisions Code refers to a set of additional requirements or conditions specified by the United Nations for the transportation of certain dangerous goods. + + + + + + + + + unLimitedQuantityValue + + + en + UN Limited Quantity Value + + + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#unLimitedQuantityValue + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + UN Limited Quantity Value + + + + + en + unLimitedQuantityValue + + + REAL_MEASURE + + + en + Maximum quantity per inner packaging or article for carrying dangerous goods refers to the maximum amount of a hazardous material permitted for transportation. + + + + + + + + + unLimitedQuantityUnit + + + en + UN Limited Quantity Unit + + + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#unLimitedQuantityUnit + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + UN Limited Quantity Unit + + + + + en + unLimitedQuantityUnit + + + STRING + + + en + Unit of the limited quantity value. + + + + + + unit:piece + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#ItemUnitEnumeration:unit:piece + + + + + + unit:set + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#ItemUnitEnumeration:unit:set + + + + + + unit:pair + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#ItemUnitEnumeration:unit:pair + + + + + + unit:page + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#ItemUnitEnumeration:unit:page + + + + + + unit:cycle + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#ItemUnitEnumeration:unit:cycle + + + + + + unit:kilowattHour + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#ItemUnitEnumeration:unit:kilowattHour + + + + + + unit:gram + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#ItemUnitEnumeration:unit:gram + + + + + + unit:kilogram + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#ItemUnitEnumeration:unit:kilogram + + + + + + unit:tonneMetricTon + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#ItemUnitEnumeration:unit:tonneMetricTon + + + + + + unit:tonUsOrShortTonUkorus + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#ItemUnitEnumeration:unit:tonUsOrShortTonUkorus + + + + + + unit:ounceAvoirdupois + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#ItemUnitEnumeration:unit:ounceAvoirdupois + + + + + + unit:pound + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#ItemUnitEnumeration:unit:pound + + + + + + unit:metre + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#ItemUnitEnumeration:unit:metre + + + + + + unit:centimetre + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#ItemUnitEnumeration:unit:centimetre + + + + + + unit:kilometre + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#ItemUnitEnumeration:unit:kilometre + + + + + + unit:inch + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#ItemUnitEnumeration:unit:inch + + + + + + unit:foot + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#ItemUnitEnumeration:unit:foot + + + + + + unit:yard + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#ItemUnitEnumeration:unit:yard + + + + + + unit:squareCentimetre + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#ItemUnitEnumeration:unit:squareCentimetre + + + + + + unit:squareMetre + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#ItemUnitEnumeration:unit:squareMetre + + + + + + unit:squareInch + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#ItemUnitEnumeration:unit:squareInch + + + + + + unit:squareFoot + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#ItemUnitEnumeration:unit:squareFoot + + + + + + unit:squareYard + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#ItemUnitEnumeration:unit:squareYard + + + + + + unit:cubicCentimetre + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#ItemUnitEnumeration:unit:cubicCentimetre + + + + + + unit:cubicMetre + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#ItemUnitEnumeration:unit:cubicMetre + + + + + + unit:cubicInch + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#ItemUnitEnumeration:unit:cubicInch + + + + + + unit:cubicFoot + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#ItemUnitEnumeration:unit:cubicFoot + + + + + + unit:cubicYard + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#ItemUnitEnumeration:unit:cubicYard + + + + + + unit:litre + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#ItemUnitEnumeration:unit:litre + + + + + + unit:millilitre + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#ItemUnitEnumeration:unit:millilitre + + + + + + unit:hectolitre + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#ItemUnitEnumeration:unit:hectolitre + + + + + + unit:secondUnitOfTime + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#ItemUnitEnumeration:unit:secondUnitOfTime + + + + + + unit:minuteUnitOfTime + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#ItemUnitEnumeration:unit:minuteUnitOfTime + + + + + + unit:hourUnitOfTime + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#ItemUnitEnumeration:unit:hourUnitOfTime + + + + + + unit:day + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#ItemUnitEnumeration:unit:day + + + + + + + + + + + + + unTransport + + + en + UN Transport + + + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#unTransport + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + UN Transport + + + + + en + unTransport + + + STRING + + + en + Transport related attributes from the UN. + + + + + + + + + transport + + + en + Transport + + + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#transport + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Transport + + + + + en + transport + + + STRING + + + en + Transport related information. + + + + + + + + + content + + + en + Content + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Content + + + + + en + content + + + STRING + + + en + The content of the document e.g a link. + + + + + + + + + contentType + + + en + Content Type + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Content Type + + + + + en + contentType + + + STRING + + + en + The type of content which can be expected in the "content" property. Examples are a link, restricted link, pdf, excel, etc. + + + + + + + + + header + + + en + Header + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Header + + + + + en + header + + + STRING + + + en + The header as a short description of the document with a maximum of 100 characters. + + + + + + + + + disposalBeforeUse + + + en + Disposal Before Use + + + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#disposalBeforeUse + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Disposal Before Use + + + + + en + disposalBeforeUse + + + STRING + + + en + Management and disposal practices for chemicals that are no longer needed or deemed unsuitable for their intended purpose. This information can be provided as a document, detailing the properties of waste that render it hazardous, along with disposal and recovery operations or recommendations, and accidental release measures. + + + + + + + + + content + + + en + Content + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Content + + + + + en + content + + + STRING + + + en + The content of the document e.g a link. + + + + + + + + + contentType + + + en + Content Type + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Content Type + + + + + en + contentType + + + STRING + + + en + The type of content which can be expected in the "content" property. Examples are a link, restricted link, pdf, excel, etc. + + + + + + + + + header + + + en + Header + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Header + + + + + en + header + + + STRING + + + en + The header as a short description of the document with a maximum of 100 characters. + + + + + + + + + disposalAfterUse + + + en + Disposal After Use + + + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#disposalAfterUse + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Disposal After Use + + + + + en + disposalAfterUse + + + STRING + + + en + Chemical Management and Disposal Guides post-usage as document. + + + + + + + + + wasteCodeDescription + + + en + Waste Code Description + + + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#wasteCodeDescription + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Waste Code Description + + + + + en + wasteCodeDescription + + + STRING + + + en + Description of the related waste code. + + + + + + + + + wasteCodeRegulation + + + en + Waste Code Regulation + + + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#wasteCodeRegulation + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Waste Code Regulation + + + + + en + wasteCodeRegulation + + + STRING + + + en + The name of the regulation that applies to waste codes can vary depending on the region or jurisdiction. Examples include Regulation (EC) No 1013/2006 in the European Union or Annex VIII of the Basel Convention. + + + + + + + + + wasteCode + + + en + Waste Code + + + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#wasteCode + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Waste Code + + + + + en + wasteCode + + + STRING + + + en + A waste code is used to identify the type of waste. + + + + + + + + + disposalWasteCode + + + en + Disposal Waste Code + + + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#disposalWasteCode + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Disposal Waste Code + + + + + en + disposalWasteCode + + + STRING + + + en + A waste code is a standardized alphanumeric code used to classify different types of waste according to their characteristics, origin, and potential hazards. These codes help in proper identification, handling, treatment, and disposal of waste materials. + + + + + + + + + content + + + en + Content + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Content + + + + + en + content + + + STRING + + + en + The content of the document e.g a link. + + + + + + + + + contentType + + + en + Content Type + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Content Type + + + + + en + contentType + + + STRING + + + en + The type of content which can be expected in the "content" property. Examples are a link, restricted link, pdf, excel, etc. + + + + + + + + + header + + + en + Header + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Header + + + + + en + header + + + STRING + + + en + The header as a short description of the document with a maximum of 100 characters. + + + + + + + + + disposalPackagingInformation + + + en + Disposal Packaging Information + + + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#disposalPackagingInformation + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Disposal Packaging Information + + + + + en + disposalPackagingInformation + + + STRING + + + en + Guidelines and instructions regarding the proper management and disposal of packaging materials after use. Includes instructions on separation, reuse, and recycling. + + + + + + + + + disposal + + + en + Disposal + + + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#disposal + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Disposal + + + + + en + disposal + + + STRING + + + en + The safe and appropriate elimination or management of these materials once they are no longer needed or usable. + + + + + + + + + content + + + en + Content + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Content + + + + + en + content + + + STRING + + + en + The content of the document e.g a link. + + + + + + + + + contentType + + + en + Content Type + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Content Type + + + + + en + contentType + + + STRING + + + en + The type of content which can be expected in the "content" property. Examples are a link, restricted link, pdf, excel, etc. + + + + + + + + + header + + + en + Header + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Header + + + + + en + header + + + STRING + + + en + The header as a short description of the document with a maximum of 100 characters. + + + + + + + + + safetyDocumentation + + + en + Safety Documentation + + + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#safetyDocumentation + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Safety Documentation + + + + + en + safetyDocumentation + + + STRING + + + en + Safety information in a document that outlines safety protocols, procedures, and guidelines to be followed in specific situations involving the product. It provides clear instructions on accident prevention, how to respond to emergencies, and mitigate potential hazards. Examples include exposure scenarios, safety data sheets, risk assessments, and information on safety equipment and personal protective equipment (PPE). + + + + + + + + + emergencyAvailability + + + en + Emergency Availability + + + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#emergencyAvailability + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Emergency Availability + + + + + en + emergencyAvailability + + + STRING + + + en + The period of time when emergency phone numbers are available. + + + + + + + + + emergencyPhoneNumber + + + en + Emergency Phone Number + + + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#emergencyPhoneNumber + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Emergency Phone Number + + + + + en + emergencyPhoneNumber + + + STRING + + + en + The phone number in case of an emergency. + + + + + + + + + emergencyPhone + + + en + Emergency Phone + + + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#emergencyPhone + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Emergency Phone + + + + + en + emergencyPhone + + + STRING + + + en + A phone number in case of emergency serves the vital purpose of providing immediate access to emergency responders. + + + + + + + + + content + + + en + Content + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Content + + + + + en + content + + + STRING + + + en + The content of the document e.g a link. + + + + + + + + + contentType + + + en + Content Type + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Content Type + + + + + en + contentType + + + STRING + + + en + The type of content which can be expected in the "content" property. Examples are a link, restricted link, pdf, excel, etc. + + + + + + + + + header + + + en + Header + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Header + + + + + en + header + + + STRING + + + en + The header as a short description of the document with a maximum of 100 characters. + + + + + + + + + firstAidDocument + + + en + First Aid Document + + + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#firstAidDocument + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + First Aid Document + + + + + en + firstAidDocument + + + STRING + + + en + Information on how to proceed in case of an emergency is essential. It includes guidance on providing initial assistance or immediate care to a person who has been injured before professional medical help arrives. + + + + + + + + + safety + + + en + Safety + + + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#safety + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Safety + + + + + en + safety + + + STRING + + + en + Safety related attributes of the chemical material. + + + + + + + + + complianceCountry + + + en + Compliance Country + + + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#complianceCountry + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Compliance Country + + + + + en + complianceCountry + + + STRING + + + en + The name of the country of compliance denotes the country whose rules and regulations the product must adhere to. + + + + + + + + + complianceRegulationName + + + en + Compliance Regulation Name + + + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#complianceRegulationName + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Compliance Regulation Name + + + + + en + complianceRegulationName + + + STRING + + + en + The name of the regulation or standard with which the product must comply can be sourced from Supplier Survey information. This attribute is referenced in ANNEX VI of the Proposal for a REGULATION OF THE EUROPEAN PARLIAMENT AND OF THE COUNCIL on detergents and surfactants, amending Regulation (EU) 2019/1020 and repealing Regulation (EC) No 648/2004: +The product passport shall include the following information: [...] +(e) references to Union legal acts that the detergent or surfactant complies with; + + + + + + + + + complianceResult + + + en + Compliance Result + + + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#complianceResult + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Compliance Result + + + + + en + complianceResult + + + BOOLEAN + + + en + The statement indicates whether the product complies with the aforementioned regulations. + + + + + + + + + complianceReasonForExemption + + + en + Compliance Reason For Exemption + + + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#complianceReasonForExemption + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Compliance Reason For Exemption + + + + + en + complianceReasonForExemption + + + STRING + + + en + Data providing details and justifications for an exemption from compliance with certain regulations, standards, or requirements. This information assists regulatory authorities or stakeholders in evaluating the merits of the exemption and making decisions in accordance with legal and regulatory requirements. + + + + + + + + + complianceRemark + + + en + Compliance Remark + + + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#complianceRemark + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Compliance Remark + + + + + en + complianceRemark + + + STRING + + + en + If necessary, any remarks that provide relevant information for compliance. Further clarification supplements the compliance information, offering additional context or details to ensure thorough understanding and adherence to regulatory requirements. + + + + + + + + + compliance + + + en + Compliance + + + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#compliance + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Compliance + + + + + en + compliance + + + STRING + + + en + Compliance refers to adhering to relevant regulations, standards, or specifications regarding the testing, documentation, and presentation of parameters, methods, and results. This ensures that the product meets required safety, quality, and regulatory standards throughout its lifecycle, from manufacturing to post-application use. + + + + + + + + + productSpecificParameters + + + en + Product Specific Parameters + + + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#productSpecificParameters + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Product Specific Parameters + + + + + en + productSpecificParameters + + + STRING + + + en + Product specific parameters of the electric drive. + + + + + + + + + key + + + en + Identifier Key + + + urn:samm:io.catenax.serial_part:3.0.0#key + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Identifier Key + + + + + en + key + + + STRING + + + en + The key of a local identifier. + + + + + + + + + value + + + en + Identifier Value + + + urn:samm:io.catenax.serial_part:3.0.0#value + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Identifier Value + + + + + en + value + + + STRING + + + en + The value of an identifier. + + + + + + + + + serialInformation + + + en + Serial Information + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#serialInformation + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Serial Information + + + + + en + serialInformation + + + STRING + + + en + Identifier for a serial part if available. This is mentioned in the ESPR provisional agreement from January 9th, 2024 Recital (27): +[...] an 'item' usually means a single unit of a model. + + + + + + + + + key + + + en + Identifier Key + + + urn:samm:io.catenax.batch:3.0.0#key + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Identifier Key + + + + + en + key + + + STRING + + + en + The key of a local identifier. + + + + + + + + + value + + + en + Identifier Value + + + urn:samm:io.catenax.batch:3.0.0#value + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Identifier Value + + + + + en + value + + + STRING + + + en + The value of an identifier. + + + + + + + + + batchInformation + + + en + Batch Information + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#batchInformation + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Batch Information + + + + + en + batchInformation + + + STRING + + + en + Identifier for a batch part if available. Identifier for a serial part if available. This is mentioned in the ESPR provisional agreement from January 9th, 2024 Recital (27): +[...] a 'batch' usually means a subset of a specific model composed of all products produced in a specific manufacturing plant at a specific moment in time [...]. + + + + + + + + + manufacturerPartId + + + en + Manufacturer Part ID + + + urn:samm:io.catenax.part_type_information:1.0.0#manufacturerPartId + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Manufacturer Part ID + + + + + en + manufacturerPartId + + + STRING + + + en + Part ID as assigned by the manufacturer of the part. The part ID identifies the part in the manufacturer`s dataspace. The part ID references a specific version of a part. The version number must be included in the part ID if it is available. The part ID does not reference a specific instance of a part and must not be confused with the serial number. + + + + + + + + + nameAtManufacturer + + + en + Name at manufacturer + + + urn:samm:io.catenax.part_type_information:1.0.0#nameAtManufacturer + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Name at manufacturer + + + + + en + nameAtManufacturer + + + STRING + + + en + Name of the part as assigned by the manufacturer. + + + + + + + + + partTypeInformation + + + en + Part Type Information + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#partTypeInformation + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Part Type Information + + + + + en + partTypeInformation + + + STRING + + + en + Identifier on the level of a part model or type. Identifier for a serial part if available. This is mentioned in the ESPR provisional agreement from January 9th, 2024 Recital (27): +[...] A 'model' usually means a version of a product of which all units share the same technical characteristics relevant for the ecodesign requirements and the same model identifier [...]. + + + + + + + + + codeKey + + + en + Code Key + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#codeKey + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Code Key + + + + + en + codeKey + + + STRING + + + en + The code key for the identification of the product. Examples are GTIN, hash, DID, ISBN, TARIC. This attribute is mentioned in the ESPR proposal from March 30th, 2022 ANNEX III: +(b) the unique product identifier at the level indicated in the applicable delegated act adopted pursuant to Article 4; +(c) the Global Trade Identification Number as provided for in standard ISO/IEC 15459-6 or equivalent of products or their parts; +(d) relevant commodity codes, such as a TARIC code as defined in Council Regulation (EEC) No 2658/87. + + + + + + + + + codeValue + + + en + Code Value + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#codeValue + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Code Value + + + + + en + codeValue + + + STRING + + + en + The code value for the identification of the product in regard to the chosen code name. + + + + + + + + + codes + + + en + Codes + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#codes + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Codes + + + + + en + codes + + + STRING + + + en + Codes for identification. + + + + + + + + + carrierType + + + en + Carrier Type + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#carrierType + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Carrier Type + + + + + en + carrierType + + + STRING + + + en + The type of data carrier such as a QR code on the product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 8: +(2) (b) the types of data carrier to be used. + + + + + + + + + carrierLayout + + + en + Carrier Layout + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#carrierLayout + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Carrier Layout + + + + + en + carrierLayout + + + STRING + + + en + The positioning of data carrier on the product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 8: +(2) (c) the layout in which the data carrier shall be presented and its positioning. + + + + + + + + + dataCarrier + + + en + Data Carrier + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#dataCarrier + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Data Carrier + + + + + en + dataCarrier + + + STRING + + + en + The type and layout of the data carrier on the product. These are mentioned in the ESPR proposal from March 30th, 2022 Article 8: +(b) the types of data carrier to be used; +(c) the layout in which the data carrier shall be presented and its positioning; +Article 2 defines: +(30) 'data carrier' means a linear bar code symbol, a two-dimensional symbol or other automatic identification data capture medium that can be read by a device. + + + + + + + + + classificationStandard + + + en + Classification Standard + + + urn:samm:io.catenax.shared.part_classification:1.0.0#classificationStandard + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Classification Standard + + + + + en + classificationStandard + + + STRING + + + en + Identified classification standards that align to the Catena-X needs. + + + + + + + + + classificationID + + + en + Classification ID + + + urn:samm:io.catenax.shared.part_classification:1.0.0#classificationID + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Classification ID + + + + + en + classificationID + + + STRING + + + en + The classification ID of the part type according to the corresponding standard definition mentioned in the key value pair. + + + + + + + + + classificationDescription + + + en + Classification Description + + + urn:samm:io.catenax.shared.part_classification:1.0.0#classificationDescription + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Classification Description + + + + + en + classificationDescription + + + STRING + + + en + Optional property describing the classification standard. + + + + + + + + + partClassification + + + en + Part Classification + + + urn:samm:io.catenax.shared.part_classification:1.0.0#partClassification + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Part Classification + + + + + en + partClassification + + + STRING + + + en + Property describing the classification of a part. + + + + + + + + + identification + + + en + Identification + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#identification + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Identification + + + + + en + identification + + + STRING + + + en + Identification information of the product, especially identifiers and codes. These are mentioned in the ESPR provisional agreement from January 9th, 2024 ANNEX III: +(b) the unique product identifier at the level indicated in the applicable delegated act adopted pursuant to Article 4. +Additionally in Article 9 regarding general requirements for the product passport is stated that: +A product passport shall meet the following conditions: +(a) it shall be connected through a data carrier to a persistent unique product identifier; +(e) the information included in the product passport shall refer to the product model, batch, or item as specified in the delegated act adopted pursuant to Article 4. +Article 2 Definitions: +(31) 'unique product identifier' means a unique string of characters for the identification of products that also enables a web link to the product passport; +Recital (27): A 'model' usually means a version of a product of which all units share the same technical characteristics relevant for the ecodesign requirements and the same model identifier, a 'batch' usually means a subset of a specific model composed of all products produced in a specific manufacturing plant at a specific moment in time and an 'item' usually means a single unit of a model. + + + + + + + + + facility + + + en + Facility + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#facility + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Facility + + + + + en + facility + + + STRING + + + en + The identifier used for a location. This attribute is mentioned in the ESPR provisional agreement from January 9th 2024 Annex III: +(i) unique facility identifiers; +Article 2 Definitions: (33) 'unique facility identifier' means a unique string of characters for the identification of locations or buildings involved in the value chain of a product or used by actors involved in the value chain of a product. + + + + + + + + + facilityIdentification + + + en + Facility Identification + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#facilityIdentification + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Facility Identification + + + + + en + facilityIdentification + + + STRING + + + en + The identifier used for a location. In the CATENA-X use case, the BPNA can be stated. This attribute is mentioned in the ESPR provisional agreement from January 9th 2024 Annex III: +(i) unique facility identifiers; +Article 2 Definitions: (33) 'unique facility identifier' means a unique string of characters for the identification of locations or buildings involved in the value chain of a product or used by actors involved in the value chain of a product. + + + + + + + + + manufacturerIdentification + + + en + Manufacturer Identification + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#manufacturerIdentification + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Manufacturer Identification + + + + + en + manufacturerIdentification + + + STRING + + + en + The main manufacturer, if different from the passport owner, represented by an identification number. In the Catena-X use case, the BPNL can be stated. This attribute is mentioned in the ESPR provisional agreement from January 9th 2024 Annex III: +(h) unique operator identifiers other than that of the manufacturer; +(k) the name, contact details and unique operator identifier code of the economic operator established in the Union responsible for carrying out the tasks set out in Article 4 of Regulation (EU) 2019/1020, or Article 15 of Regulation (EU) [.../...] on general product safety, or similar tasks pursuant to other EU legislation applicable to the product. + + + + + + + + + manufacturingDate + + + en + Manufacturing Date + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#manufacturingDate + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Manufacturing Date + + + + + en + manufacturingDate + + + STRING + + + en + The timestamp in the format (yyyy-mm-dd) of the manufacturing date as the final step in production process (e.g. final quality check, ready-for-shipment event). + + + + + + + + + manufacturer + + + en + Manufacturer + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#manufacturer + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Manufacturer + + + + + en + manufacturer + + + STRING + + + en + Manufacturing information of the product. In the CATENA-X use case, the BPNL and BPNA can be stated. These attributes are mentioned in the ESPR provisional agreement from January 9th 2024 Annex III: +(h) unique operator identifiers other than that of the manufacturer; +(k) the name, contact details and unique operator identifier code of the economic operator established in the Union responsible for carrying out the tasks set out in Article 4 of Regulation (EU) 2019/1020, or Article 15 of Regulation (EU) [.../...] on general product safety, or similar tasks pursuant to other EU legislation applicable to the product. + + + + + + + + + eori + + + en + EORI + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#eori + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + EORI + + + + + en + eori + + + STRING + + + en + An economic operator established in the customs territory of the Union needs, for customs purposes, an EORI number. EORI stands for economic operators registration and identification number. In this case, the importer's EORI must be provided. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Annex III: +(j) information related to the importer, including the information referred to in Article 23(3) and its EORI number. + + + + + + + + + importerIdentification + + + en + Importer Identification + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#importerIdentification + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Importer Identification + + + + + en + importerIdentification + + + STRING + + + en + The importer of the product, if different from the owner of the passport. In the Catena-X network, the BPNL is used for the identification of companies and the information stored for this like contact information and addresses. +This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex III: +(j) information related to the importer, including the information referred to in Article 23(3) and its EORI number; +Article 23 states: +(3) Importers shall, for products covered by a delegated act adopted pursuant to Article 4, indicate their name, registered trade name or registered trade mark and the postal address and electronic means of communication, where they can be contacted: (a) on the public part of the product passport, when applicable, and +(b) on the product or, where this is not possible, on the packaging, or in a document accompanying the product. + + + + + + + + + importer + + + en + Importer + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#importer + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Importer + + + + + en + importer + + + STRING + + + en + Information regarding the importer of the product, if different from the owner of the passport. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex III: +(j) information related to the importer, including the information referred to in Article 23(3) and its EORI number; +Article 23 states: +(3) Importers shall, for products covered by a delegated act adopted pursuant to Article 4, indicate their name, registered trade name or registered trade mark and the postal address and electronic means of communication, where they can be contacted: (a) on the public part of the product passport, when applicable, and +(b) on the product or, where this is not possible, on the packaging, or in a document accompanying the product. + + + + + + + + + applicable + + + en + Applicable + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#applicable + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Applicable + + + + + en + applicable + + + BOOLEAN + + + en + Check whether the connected attributes are applicable to the product. If it is not applicable (false), dummy data can be delivered. + + + + + + + + + import + + + en + Import + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#import + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Import + + + + + en + import + + + STRING + + + en + Importer details such as the identification. + + + + + + + + + otherOperatorId + + + en + Other Operator Id + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#otherOperatorId + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Other Operator Id + + + + + en + otherOperatorId + + + STRING + + + en + Identifier of the other operator. This can be a BPN. + + + + + + + + + otherOperatorRole + + + en + Other Operator Role + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#otherOperatorRole + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Other Operator Role + + + + + en + otherOperatorRole + + + STRING + + + en + Role of the other operator. + + + + + + + + + otherOperators + + + en + Other Operators + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#otherOperators + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Other Operators + + + + + en + otherOperators + + + STRING + + + en + Other operators relevant for the product. + + + + + + + + + operation + + + en + Operation + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#operation + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Operation + + + + + en + operation + + + STRING + + + en + Operational information of the product. + + + + + + + + + lifeUnit + + + en + Life Unit + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#lifeUnit + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Life Unit + + + + + en + lifeUnit + + + STRING + + + en + The unit of the respective lifespan expressed through the possible units day, month, cycle, year and runningOrOperatingHour. + + + + + + unit:day + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#LifeEnumeration:unit:day + + + + + + unit:month + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#LifeEnumeration:unit:month + + + + + + unit:year + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#LifeEnumeration:unit:year + + + + + + unit:cycle + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#LifeEnumeration:unit:cycle + + + + + + unit:runningOrOperatingHour + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#LifeEnumeration:unit:runningOrOperatingHour + + + + + + + + + + + + + lifeValue + + + en + Life Value + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#lifeValue + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Life Value + + + + + en + lifeValue + + + INTEGER_MEASURE + + + en + The value as an integer for the respective lifespan. + + + + + + + + + lifeType + + + en + Life Type + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#lifeType + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Life Type + + + + + en + lifeType + + + STRING + + + en + The type of lifespan represented with the values guaranteed lifetime, technical lifetime and mean time between failures. This attribute is mentioned in the ESPR proposal from March 30th, 2022 ANNEX I: +(a) durability and reliability of the product or its components as expressed through the product's guaranteed lifetime, technical lifetime [or] mean time between failures [...]. + + + + + + guaranteed lifetime + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#LifeTypeEnumeration:guaranteed lifetime + + + + + + technical lifetime + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#LifeTypeEnumeration:technical lifetime + + + + + + mean time between failures + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#LifeTypeEnumeration:mean time between failures + + + + + + + + + + + + + lifespan + + + en + Lifespan + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#lifespan + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Lifespan + + + + + en + lifespan + + + STRING + + + en + The type of lifespan represented with the values guaranteed lifetime, technical lifetime and mean time between failures. Both can be described through the attributes: type, which defines the type such as guaranteed lifetime or technical lifetime, the unit for the lifetime, and the value represented by an integer. These attributes are mentioned in the ESPR proposal from March 30th, 2022 ANNEX I: +(a) durability and reliability of the product or its components as expressed through the products guaranteed lifetime, technical lifetime [or] mean time between failures [...]. + + + + + + + + + quantityValue + + + en + Quantity Value + + + urn:samm:io.catenax.shared.quantity:2.0.0#quantityValue + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Quantity Value + + + + + en + quantityValue + + + REAL_MEASURE + + + en + The quantity value associated with the unit. + + + + + + + + + linearUnit + + + en + Linear Unit + + + urn:samm:io.catenax.shared.quantity:2.0.0#linearUnit + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Linear Unit + + + + + en + linearUnit + + + STRING + + + en + The unit of a linear attribute. + + + + + + unit:millimetre + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#LinearUnitEnumeration:unit:millimetre + + + + + + unit:centimetre + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#LinearUnitEnumeration:unit:centimetre + + + + + + unit:metre + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#LinearUnitEnumeration:unit:metre + + + + + + unit:kilometre + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#LinearUnitEnumeration:unit:kilometre + + + + + + unit:inch + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#LinearUnitEnumeration:unit:inch + + + + + + unit:foot + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#LinearUnitEnumeration:unit:foot + + + + + + unit:yard + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#LinearUnitEnumeration:unit:yard + + + + + + + + + + + + + width + + + en + Width + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#width + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Width + + + + + en + width + + + STRING + + + en + The width of the item measured in a specific linear unit which can be declared in the corresponding unit attribute. + + + + + + + + + quantityValue + + + en + Quantity Value + + + urn:samm:io.catenax.shared.quantity:2.0.0#quantityValue + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Quantity Value + + + + + en + quantityValue + + + REAL_MEASURE + + + en + The quantity value associated with the unit. + + + + + + + + + linearUnit + + + en + Linear Unit + + + urn:samm:io.catenax.shared.quantity:2.0.0#linearUnit + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Linear Unit + + + + + en + linearUnit + + + STRING + + + en + The unit of a linear attribute. + + + + + + + + + length + + + en + Length + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#length + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Length + + + + + en + length + + + STRING + + + en + The length of the item measured in a specific linear unit which can be declared in the corresponding unit attribute. + + + + + + + + + quantityValue + + + en + Quantity Value + + + urn:samm:io.catenax.shared.quantity:2.0.0#quantityValue + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Quantity Value + + + + + en + quantityValue + + + REAL_MEASURE + + + en + The quantity value associated with the unit. + + + + + + + + + linearUnit + + + en + Linear Unit + + + urn:samm:io.catenax.shared.quantity:2.0.0#linearUnit + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Linear Unit + + + + + en + linearUnit + + + STRING + + + en + The unit of a linear attribute. + + + + + + + + + diameter + + + en + Diameter + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#diameter + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Diameter + + + + + en + diameter + + + STRING + + + en + The diameter of the item, if applicable, measured in a specific linear unit which can be declared in the corresponding unit attribute. + + + + + + + + + quantityValue + + + en + Quantity Value + + + urn:samm:io.catenax.shared.quantity:2.0.0#quantityValue + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Quantity Value + + + + + en + quantityValue + + + REAL_MEASURE + + + en + The quantity value associated with the unit. + + + + + + + + + linearUnit + + + en + Linear Unit + + + urn:samm:io.catenax.shared.quantity:2.0.0#linearUnit + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Linear Unit + + + + + en + linearUnit + + + STRING + + + en + The unit of a linear attribute. + + + + + + + + + height + + + en + Height + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#height + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Height + + + + + en + height + + + STRING + + + en + The height of the item measured in a specific linear unit which can be declared in the corresponding unit attribute. + + + + + + + + + quantityValue + + + en + Quantity Value + + + urn:samm:io.catenax.shared.quantity:2.0.0#quantityValue + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Quantity Value + + + + + en + quantityValue + + + REAL_MEASURE + + + en + The quantity value associated with the unit. + + + + + + + + + massUnit + + + en + Mass Unit + + + urn:samm:io.catenax.shared.quantity:2.0.0#massUnit + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Mass Unit + + + + + en + massUnit + + + STRING + + + en + The unit of a mass related attribute. + + + + + + unit:gram + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#MassUnitEnumeration:unit:gram + + + + + + unit:kilogram + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#MassUnitEnumeration:unit:kilogram + + + + + + unit:tonneMetricTon + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#MassUnitEnumeration:unit:tonneMetricTon + + + + + + unit:tonUsOrShortTonUkorus + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#MassUnitEnumeration:unit:tonUsOrShortTonUkorus + + + + + + unit:ounceAvoirdupois + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#MassUnitEnumeration:unit:ounceAvoirdupois + + + + + + unit:pound + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#MassUnitEnumeration:unit:pound + + + + + + + + + + + + + grossWeight + + + en + Gross Weight + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#grossWeight + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Gross Weight + + + + + en + grossWeight + + + STRING + + + en + The gross weight of the item measured in a specific mass unit which can be declared in the corresponding unit attribute. Gross weight refers to the total weight of a product, including the weight of the packaging. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7: +(2) (b) (i) information on the performance of the product in relation to the product parameters referred to in Annex I; +Annex I (i) weight and volume of the product and its packaging, and the product-to-packaging ratio. + + + + + + + + + quantityValue + + + en + Quantity Value + + + urn:samm:io.catenax.shared.quantity:2.0.0#quantityValue + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Quantity Value + + + + + en + quantityValue + + + REAL_MEASURE + + + en + The quantity value associated with the unit. + + + + + + + + + volumeUnit + + + en + Volume Unit + + + urn:samm:io.catenax.shared.quantity:2.0.0#volumeUnit + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Volume Unit + + + + + en + volumeUnit + + + STRING + + + en + The unit of a volume related attribute. + + + + + + unit:cubicMetre + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#VolumeUnitEnumeration:unit:cubicMetre + + + + + + unit:litre + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#VolumeUnitEnumeration:unit:litre + + + + + + unit:millilitre + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#VolumeUnitEnumeration:unit:millilitre + + + + + + unit:cubicCentimetre + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#VolumeUnitEnumeration:unit:cubicCentimetre + + + + + + unit:cubicInch + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#VolumeUnitEnumeration:unit:cubicInch + + + + + + unit:cubicFoot + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#VolumeUnitEnumeration:unit:cubicFoot + + + + + + unit:cubicYard + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#VolumeUnitEnumeration:unit:cubicYard + + + + + + unit:hectolitre + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#VolumeUnitEnumeration:unit:hectolitre + + + + + + + + + + + + + grossVolume + + + en + Gross Volume + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#grossVolume + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Gross Volume + + + + + en + grossVolume + + + STRING + + + en + The gross volume of the item, if possible, measured in a specific capacity unit which can be declared in the corresponding unit attribute. If there is no separate packing, the volume of the product shall be given. Gross volume refers to the total volume of a product, including the volume of the packaging. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7: +(2) (b) (i) information on the performance of the product in relation to the product parameters referred to in Annex I; +Annex I (i) weight and volume of the product and its packaging, and the product-to-packaging ratio. + + + + + + + + + quantityValue + + + en + Quantity Value + + + urn:samm:io.catenax.shared.quantity:2.0.0#quantityValue + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Quantity Value + + + + + en + quantityValue + + + REAL_MEASURE + + + en + The quantity value associated with the unit. + + + + + + + + + massUnit + + + en + Mass Unit + + + urn:samm:io.catenax.shared.quantity:2.0.0#massUnit + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Mass Unit + + + + + en + massUnit + + + STRING + + + en + The unit of a mass related attribute. + + + + + + + + + weight + + + en + Weight + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#weight + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Weight + + + + + en + weight + + + STRING + + + en + Weight of the product measured in a specific mass unit which can be declared in the corresponding unit attribute. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7: +(2) (b) (i) information on the performance of the product in relation to the product parameters referred to in Annex I; +Annex I (i) weight and volume of the product [...]. + + + + + + + + + quantityValue + + + en + Quantity Value + + + urn:samm:io.catenax.shared.quantity:2.0.0#quantityValue + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Quantity Value + + + + + en + quantityValue + + + REAL_MEASURE + + + en + The quantity value associated with the unit. + + + + + + + + + volumeUnit + + + en + Volume Unit + + + urn:samm:io.catenax.shared.quantity:2.0.0#volumeUnit + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Volume Unit + + + + + en + volumeUnit + + + STRING + + + en + The unit of a volume related attribute. + + + + + + + + + volume + + + en + Volume + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#volume + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Volume + + + + + en + volume + + + STRING + + + en + Volume of the product, if possible, measured in a specific capacity unit which can be declared in the corresponding unit attribute. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7: +(2) (b) (i) information on the performance of the product in relation to the product parameters referred to in Annex I; +Annex I (i) weight and volume of the product [...]. + + + + + + + + + physicalDimension + + + en + Physical Dimension + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#physicalDimension + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Physical Dimension + + + + + en + physicalDimension + + + STRING + + + en + Physical dimensions are properties associated with physical quantities for purposes of classification or differentiation. These attributes are mentioned in the ESPR provisional agreement from January 9th, Article 7: +(2) (b) (i) information on the performance of the product in relation to one or more of the product parameters referred to in Annex I; +Annex I (i) weight and volume of the product and its packaging, and the product-to-packaging ratio. + + + + + + + + + physicalState + + + en + Physical State + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#physicalState + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Physical State + + + + + en + physicalState + + + STRING + + + en + The physical state of the item. There are four states of matter solid, liquid, gas and plasma which can be chosen from an enumeration. + + + + + + solid + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#PhysicalStateEnumeration:solid + + + + + + liquid + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#PhysicalStateEnumeration:liquid + + + + + + gas + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#PhysicalStateEnumeration:gas + + + + + + plasma + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#PhysicalStateEnumeration:plasma + + + + + + + + + + + + + generalPerformanceClass + + + en + General Performance Class + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#generalPerformanceClass + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + General Performance Class + + + + + en + generalPerformanceClass + + + STRING + + + en + The performance class of the product. This attribute is mentioned ESPR provisional agreement from January 9th, 2024 Article 7: +4. When establishing the information requirements referred to in paragraph 2, point (b), point (i), the Commission shall, as appropriate in view of the specificity of the product group, determine classes of performance. Classes of performance may be based on single parameters, on aggregated scores, in absolute terms or in any other form that enables potential customers to choose the best performing products. Those classes of performance shall correspond to significant improvements in performance levels. Where classes of performance are based on parameters in relation to which performance requirements are established, they shall use as the minimum level the minimum performance required at the time when the classes of performance start to apply. +Definition: +'class of performance': means a range of performance levels in relation to one or more product parameters referred to in Annex I, based on a common methodology for the product or product group, ordered into successive steps to allow for product differentiation. + + + + + + + + + characteristics + + + en + Characteristics + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#characteristics + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Characteristics + + + + + en + characteristics + + + STRING + + + en + Defines specific characteristics of a product. + + + + + + + + + placedOnMarket + + + en + Placed on Market + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#placedOnMarket + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Placed on Market + + + + + en + placedOnMarket + + + STRING + + + en + The timestamp in the format (yyyy-mm-dd) with or without time zone when the product was put in the market. + + + + + + + + + purpose + + + en + Purpose + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#purpose + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Purpose + + + + + en + purpose + + + STRING + + + en + One or more intended industry/industries of the product described by the digital product passport. If exchanged via Catena-X, 'automotive ' is a must choice included in the list. + + + + + + + + + commercial + + + en + Commercial + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#commercial + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Commercial + + + + + en + commercial + + + STRING + + + en + Commercial information of the product. + + + + + + + + + applicable + + + en + Applicable + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#applicable + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Applicable + + + + + en + applicable + + + BOOLEAN + + + en + Check whether the connected attributes are applicable to the product. If it is not applicable (false), dummy data can be delivered. + + + + + + + + + location + + + en + Location + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#location + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Location + + + + + en + location + + + STRING + + + en + The location of the substances of concern within the product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7: +(5) (b) the location of the substances of concern within the product. + + + + + + + + + materialUnit + + + en + Material Unit + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#materialUnit + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Material Unit + + + + + en + materialUnit + + + STRING + + + en + The unit of concentration chosen from an enumeration: mass percent, volume percent, parts per thousand, parts per million, parts per billion and parts per trillion. + + + + + + unit:partPerMillion + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#ConcentrationEnumeration:unit:partPerMillion + + + + + + unit:percent + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#ConcentrationEnumeration:unit:percent + + + + + + unit:percentVolume + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#ConcentrationEnumeration:unit:percentVolume + + + + + + unit:partPerThousand + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#ConcentrationEnumeration:unit:partPerThousand + + + + + + unit:partPerTrillionUs + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#ConcentrationEnumeration:unit:partPerTrillionUs + + + + + + unit:partPerBillionUs + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#ConcentrationEnumeration:unit:partPerBillionUs + + + + + + + + + + + + + concentration + + + en + Concentration + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#concentration + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Concentration + + + + + en + concentration + + + REAL_MEASURE + + + en + Concentration of the material at the level of the product. This attribute is specially mentioned for substances of concern mentioned in the ESPR proposal from March 30th, 2022 Article 7: +(5) (c) the concentration, maximum concentration or concentration range of the substances of concern, at the level of the product [...]. +Other substances are mentioned for the purpose of recycling in the ESPR provisional agreement from January 9th, 2024 Annex I: +(d) design for recycling, ease and quality of recycling as expressed through: use of easily recyclable materials, safe, easy and non-destructive access to recyclable components and materials or components and materials containing hazardous substances and material composition and homogeneity, possibility for high-purity sorting, number of materials and components used, use of standard components, use of component and material coding standards for the identification of components and materials, number and complexity of processes and tools needed, ease of nondestructive disassembly and re-assembly, conditions for access to product data, conditions for access to or use of hardware and software needed. + + + + + + + + + + exemption + + + en + Exemption + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#exemption + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Exemption + + + + + en + exemption + + + STRING + + + en + Exemptions to the substance of concern. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Article 7: +(5) (c) provide duly justified exemptions for substances of concern or information elements from the information requirements referred to in the first subparagraph based on the technical feasibility or relevance of tracking substances of concern, the existence of analytical methods to detect and quantify them, the need to protect confidential business information or in other duly justified cases. Substances of concern within the meaning of Article 2(28), point a), shall not be exempted if they are present in products, their relevant components or spare parts in a concentration above 0,1 % weight by weight. + + + + + + + + + hazardCategory + + + en + Hazard Category + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#hazardCategory + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Hazard Category + + + + + en + hazardCategory + + + STRING + + + en + The hazard category of the substance of concern. Defined in Article 2 of Regulation (EC) No 1272/2008 of the European Parliament and of the Council of 16 December 2008 on classification, labelling and packaging of substances and mixtures, amending and repealing Directives 67/548/EEC and 1999/45/EC, and amending Regulation (EC) No 1907/2006: +2. 'hazard category' means the division of criteria within each hazard class, specifying hazard severity. + + + + + + + + + hazardClass + + + en + Hazard Class + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#hazardClass + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Hazard Class + + + + + en + hazardClass + + + STRING + + + en + The hazard class of the substance of concern. Defined in Article 2 of Regulation (EC) No 1272/2008 of the European Parliament and of the Council of 16 December 2008 on classification, labelling and packaging of substances and mixtures, amending and repealing Directives 67/548/EEC and 1999/45/EC, and amending Regulation (EC) No 1907/2006: +1. 'hazard class' means the nature of the physical, health or environmental hazard. + + + + + + + + + hazardStatement + + + en + Hazard Statement + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#hazardStatement + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Hazard Statement + + + + + en + hazardStatement + + + STRING + + + en + The hazard statement of the substance of concern. Defined in Article 2 of Regulation (EC) No 1272/2008 of the European Parliament and of the Council of 16 December 2008 on classification, labelling and packaging of substances and mixtures, amending and repealing Directives 67/548/EEC and 1999/45/EC, and amending Regulation (EC) No 1907/2006: +5. 'hazard statement' means a phrase assigned to a hazard class and category that describes the nature of the hazards of a hazardous substance or mixture, including, where appropriate, the degree of hazard. + + + + + + + + + hazardClassification + + + en + Hazard Classification + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#hazardClassification + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Hazard Classification + + + + + en + hazardClassification + + + STRING + + + en + The specification of the hazard class. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I: +(f) use of substances, and in particular the use of substances of concern, on their own, as constituents of substances or in mixtures, during the production process of products, or leading to their presence in products, including once these products become waste, and their impacts on human health and the environment; +Further defined is this by Regulation (EC) No 1272/2008 of the European Parliament and of the Council of 16 December 2008 on classification, labelling and packaging of substances and mixtures, amending and repealing Directives 67/548/EEC and 1999/45/EC, and amending Regulation (EC) No 1907/2006. +Defined in Article 2: +1. 'hazard class' means the nature of the physical, health or environmental hazard; +2. 'hazard category' means the division of criteria within each hazard class, specifying hazard severity; +5. 'hazard statement' means a phrase assigned to a hazard class and category that describes the nature of the hazards of a hazardous substance or mixture, including, where appropriate, the degree of hazard; + + + + + + + + + minConcentration + + + en + Minimum Concentration + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#minConcentration + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Minimum Concentration + + + + + en + minConcentration + + + REAL_MEASURE + + + en + The minimum concentration of the substance of concern at the level of the product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7: +(5) (c) [...] concentration range of the substances of concern, at the level of the product [...]. + + + + + + + + + maxConcentration + + + en + Maximum Concentration + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#maxConcentration + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Maximum Concentration + + + + + en + maxConcentration + + + REAL_MEASURE + + + en + The maximum concentration of the substance of concern at the level of the product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7: +(5) (c) the concentration, maximum concentration or concentration range of the substances of concern, at the level of the product [...]. + + + + + + + + + concentrationRange + + + en + Concentration Range + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#concentrationRange + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Concentration Range + + + + + en + concentrationRange + + + STRING + + + en + The concentration range for the substance of concern. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7: +(5) (c) [...] concentration range of the substances of concern, at the level of the product [...]. + + + + + + + + + chemicalId + + + en + Chemical Id + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#chemicalId + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Chemical Id + + + + + en + chemicalId + + + STRING + + + en + The substance identification, in accordance with the specification in the attribute for the list type. + + + + + + + + + listTypeId + + + en + List Type Id + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#listTypeId + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + List Type Id + + + + + en + listTypeId + + + STRING + + + en + The type of standard used for the identification of the substances. Selected can be for example CAS, IUPAC or EC. + + + + + + CAS + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#ListTypeEnumerationId:CAS + + + + + + EC + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#ListTypeEnumerationId:EC + + + + + + IUPAC + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#ListTypeEnumerationId:IUPAC + + + + + + + + + + + + + chemicalName + + + en + Chemical Name + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#chemicalName + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Chemical Name + + + + + en + chemicalName + + + STRING + + + en + The name of the material which is present in the product. + + + + + + + + + materialIdentification + + + en + Material Identification + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#materialIdentification + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Material Identification + + + + + en + materialIdentification + + + STRING + + + en + The chemical material name and identification, in accordance with the specification in the attribute for the list type. Preference is given to the IUPAC name. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Article 7: +(5) (a) the name of the substances of concern present in the product, as follows: + - name(s) in the International Union of Pure and Applied Chemistry (IUPAC) nomenclature, or another international name when IUPAC name is not available; +- other names (usual name, trade name, abbreviation); +- European Community (EC) number, as indicated in the European Inventory of Existing Commercial Chemical Substances (EINECS), the European List of Notified Chemical Substances (ELINCS) or the No Longer Polymer (NLP) list or assigned by the European Chemicals Agency (ECHA), if available; +- the Chemical Abstract Service (CAS) name(s) and number(s), if available; . + + + + + + + + + content + + + en + Content + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Content + + + + + en + content + + + STRING + + + en + The content of the document e.g a link. + + + + + + + + + contentType + + + en + Content Type + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Content Type + + + + + en + contentType + + + STRING + + + en + The type of content which can be expected in the "content" property. Examples are a link, restricted link, pdf, excel, etc. + + + + + + + + + header + + + en + Header + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Header + + + + + en + header + + + STRING + + + en + The header as a short description of the document with a maximum of 100 characters. + + + + + + + + + documentation + + + en + Documentation + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#documentation + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Documentation + + + + + en + documentation + + + STRING + + + en + Documentation accompanying the material. + + + + + + + + + substanceOfConcern + + + en + Substance of Concern + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#substanceOfConcern + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Substance of Concern + + + + + en + substanceOfConcern + + + STRING + + + en + Information regarding substances of concern in the product. Attributes are among others substance names, ids, concentration, location and hazard class. This is mentioned in the ESPR provisional agreement from January 9th, 2024 Article 7: +(5) (a) the name of the substances of concern present in the product, as follows: +- name(s) in the International Union of Pure and Applied Chemistry (IUPAC) nomenclature, or another international name when IUPAC name is not available; +- other names (usual name, trade name, abbreviation); +- European Community (EC) number, as indicated in the European Inventory of Existing Commercial Chemical Substances (EINECS), the European List of Notified Chemical Substances (ELINCS) or the No Longer Polymer (NLP) list or assigned by the European Chemicals Agency (ECHA), if available; +- the Chemical Abstract Service (CAS) name(s) and number(s), if available; +(5) (b) the location of the substances of concern within the product. +(5) (c) the concentration, maximum concentration or concentration range of the substances of concern, at the level of the product its relevant components, or spare parts; +(d) relevant instructions for the safe use of the product; +(e) information relevant for disassembly, preparation for reuse, reuse, recycling and the environmentally sound management of the product at the end of its life. +And in the next paragraph: +(c) provide duly justified exemptions for substances of concern or information elements from the information requirements referred to in the first subparagraph. + + + + + + + + + substancesOfConcern + + + en + Substances of Concern + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#substancesOfConcern + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Substances of Concern + + + + + en + substancesOfConcern + + + STRING + + + en + Information regarding substances of concern in the product. The ESPR provisional agreement from January 9th, 2024 defines: +(52) 'hazardous substance' means a substance classified as hazardous pursuant to Article 3 of Regulation (EC) No 1272/2008. + + + + + + + + + applicable + + + en + Applicable + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#applicable + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Applicable + + + + + en + applicable + + + BOOLEAN + + + en + Check whether the connected attributes are applicable to the product. If it is not applicable (false), dummy data can be delivered. + + + + + + + + + recycled + + + en + Recycled + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#recycled + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Recycled + + + + + en + recycled + + + REAL_MEASURE + + + en + The share of the material, which is recovered recycled content from the product. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I: +(h) use or content of recycled materials and recovery of materials, including critical raw materials; + + + + + + + + + renewable + + + en + Renewable + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#renewable + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Renewable + + + + + en + renewable + + + REAL_MEASURE + + + en + The share of the material, which is from a renewable resource that can be replenished. Renewable resources are those that can be reproduced by physical, chemical, or mechanical processes. These are the kind of resources that can be regenerated throughout time. Forest wood, for example, can be grown through reforestation. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I: +(ha) use or content of sustainable renewable materials; + + + + + + + + + + materialUnit + + + en + Material Unit + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#materialUnit + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Material Unit + + + + + en + materialUnit + + + STRING + + + en + The unit of concentration chosen from an enumeration: mass percent, volume percent, parts per thousand, parts per million, parts per billion and parts per trillion. + + + + + + + + + chemicalId + + + en + Chemical Id + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#chemicalId + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Chemical Id + + + + + en + chemicalId + + + STRING + + + en + The substance identification, in accordance with the specification in the attribute for the list type. + + + + + + + + + listTypeId + + + en + List Type Id + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#listTypeId + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + List Type Id + + + + + en + listTypeId + + + STRING + + + en + The type of standard used for the identification of the substances. Selected can be for example CAS, IUPAC or EC. + + + + + + + + + chemicalName + + + en + Chemical Name + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#chemicalName + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Chemical Name + + + + + en + chemicalName + + + STRING + + + en + The name of the material which is present in the product. + + + + + + + + + materialIdentification + + + en + Material Identification + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#materialIdentification + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Material Identification + + + + + en + materialIdentification + + + STRING + + + en + The chemical material name and identification, in accordance with the specification in the attribute for the list type. Preference is given to the IUPAC name. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Article 7: +(5) (a) the name of the substances of concern present in the product, as follows: + - name(s) in the International Union of Pure and Applied Chemistry (IUPAC) nomenclature, or another international name when IUPAC name is not available; +- other names (usual name, trade name, abbreviation); +- European Community (EC) number, as indicated in the European Inventory of Existing Commercial Chemical Substances (EINECS), the European List of Notified Chemical Substances (ELINCS) or the No Longer Polymer (NLP) list or assigned by the European Chemicals Agency (ECHA), if available; +- the Chemical Abstract Service (CAS) name(s) and number(s), if available; . + + + + + + + + + critical + + + en + Critical + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#critical + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Critical + + + + + en + critical + + + BOOLEAN + + + en + A flag, if the material is a critical raw material. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I: +(h) use or content of recycled materials and recovery of materials, including critical raw materials; +In Annex II of the connected proposal Act of Critical Raw Materials, a list of critical raw materials can be found. + + + + + + + + + concentration + + + en + Concentration + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#concentration + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Concentration + + + + + en + concentration + + + REAL_MEASURE + + + en + Concentration of the material at the level of the product. This attribute is specially mentioned for substances of concern mentioned in the ESPR proposal from March 30th, 2022 Article 7: +(5) (c) the concentration, maximum concentration or concentration range of the substances of concern, at the level of the product [...]. +Other substances are mentioned for the purpose of recycling in the ESPR provisional agreement from January 9th, 2024 Annex I: +(d) design for recycling, ease and quality of recycling as expressed through: use of easily recyclable materials, safe, easy and non-destructive access to recyclable components and materials or components and materials containing hazardous substances and material composition and homogeneity, possibility for high-purity sorting, number of materials and components used, use of standard components, use of component and material coding standards for the identification of components and materials, number and complexity of processes and tools needed, ease of nondestructive disassembly and re-assembly, conditions for access to product data, conditions for access to or use of hardware and software needed. + + + + + + + + + + content + + + en + Content + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Content + + + + + en + content + + + STRING + + + en + The content of the document e.g a link. + + + + + + + + + contentType + + + en + Content Type + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Content Type + + + + + en + contentType + + + STRING + + + en + The type of content which can be expected in the "content" property. Examples are a link, restricted link, pdf, excel, etc. + + + + + + + + + header + + + en + Header + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Header + + + + + en + header + + + STRING + + + en + The header as a short description of the document with a maximum of 100 characters. + + + + + + + + + documentation + + + en + Documentation + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#documentation + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Documentation + + + + + en + documentation + + + STRING + + + en + Documentation accompanying the material. + + + + + + + + + chemicalMaterial + + + en + Material + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#chemicalMaterial + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Material + + + + + en + chemicalMaterial + + + STRING + + + en + Information on different materials in the product. + + + + + + + + + materialComposition + + + en + Material Composition + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#materialComposition + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Material Composition + + + + + en + materialComposition + + + STRING + + + en + Material composition of the product with information on recycled and renewable materials. + + + + + + + + + materials + + + en + Materials + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#materials + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Materials + + + + + en + materials + + + STRING + + + en + Properties which are relevant for the materials of the product. + + + + + + + + + content + + + en + Content + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Content + + + + + en + content + + + STRING + + + en + The content of the document e.g a link. + + + + + + + + + category + + + en + Category + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#category + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Category + + + + + en + category + + + STRING + + + en + The category in which the document can be sorted. These are mentioned in the ESPR proposal from March 30th, 2022 ANNEX III: +(e) compliance documentation and information required under this Regulation or other Union law applicable to the product, such as the declaration of conformity, technical documentation or conformity certificates; +ANNEX IV states additional information regarding the content of the technical documentation +Further information on documents are mentioned in the proposal from March 30th, 2022 ANNEX III: +(f) user manuals, instructions, warnings or safety information, as required by other Union legislation applicable to the product. +Additionally requirements are mentioned in Article 21: +(7) Manufacturers shall ensure that that a product covered by a delegated act adopted pursuant to Article 4 is accompanied by instructions that enable consumers and other end-users to safely assemble, install, operate, store, maintain, repair and dispose of the product in a language that can be easily understood by consumers and other end-users, as determined by the Member State concerned. Such instructions shall be clear, understandable and legible and include at least the information specified in the delegated acts adopted pursuant to Article 4 and pursuant to Article 7(2)(b), point (ii). +Article 7 states additionally: +(2) (b) (ii) information for consumers and other end-users on how to install, use, maintain and repair the product in order to minimize its impact on the environment and to ensure optimum durability, as well as on how to return or dispose of the product at end-of-life; +(2) (b) (iii) information for treatment facilities on disassembly, recycling, or disposal at end-of-life; +(2) (b) (iv) other information that may influence the way the product is handled by parties other than the manufacturer in order to improve performance in relation to product parameters referred to in Annex I. +(5) (d) relevant instructions for the safe use of the product. + + + + + + Product Specifications + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#SourceCategoryEnumeration:Product Specifications + + + + + + Manufacturer Information + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#SourceCategoryEnumeration:Manufacturer Information + + + + + + User Manuals and Guides + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#SourceCategoryEnumeration:User Manuals and Guides + + + + + + Certifications and Compliance + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#SourceCategoryEnumeration:Certifications and Compliance + + + + + + Product Images and Videos + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#SourceCategoryEnumeration:Product Images and Videos + + + + + + Warranty Information + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#SourceCategoryEnumeration:Warranty Information + + + + + + Reviews and Ratings + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#SourceCategoryEnumeration:Reviews and Ratings + + + + + + Product Variations + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#SourceCategoryEnumeration:Product Variations + + + + + + Supply Chain Information + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#SourceCategoryEnumeration:Supply Chain Information + + + + + + Environmental Impact + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#SourceCategoryEnumeration:Environmental Impact + + + + + + Compatibility and Accessories + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#SourceCategoryEnumeration:Compatibility and Accessories + + + + + + FAQs and Support + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#SourceCategoryEnumeration:FAQs and Support + + + + + + Purchase and Retail Information + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#SourceCategoryEnumeration:Purchase and Retail Information + + + + + + Privacy and Data Handling + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#SourceCategoryEnumeration:Privacy and Data Handling + + + + + + Third-Party Integrations + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#SourceCategoryEnumeration:Third-Party Integrations + + + + + + Legal Information + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#SourceCategoryEnumeration:Legal Information + + + + + + Safety Information + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#SourceCategoryEnumeration:Safety Information + + + + + + Repair and Installation + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#SourceCategoryEnumeration:Repair and Installation + + + + + + Waste Generation and Prevention + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#SourceCategoryEnumeration:Waste Generation and Prevention + + + + + + Specific Voluntary Labels + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#SourceCategoryEnumeration:Specific Voluntary Labels + + + + + + Product Packaging + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#SourceCategoryEnumeration:Product Packaging + + + + + + Return and Disposal + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#SourceCategoryEnumeration:Return and Disposal + + + + + + End of Life + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#SourceCategoryEnumeration:End of Life + + + + + + Material and Substance Information + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#SourceCategoryEnumeration:Material and Substance Information + + + + + + Technical Documentation + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#SourceCategoryEnumeration:Technical Documentation + + + + + + Treatment facilities + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#SourceCategoryEnumeration:Treatment facilities + + + + + + Other + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#SourceCategoryEnumeration:Other + + + + + + + + + + + + + contentType + + + en + Content Type + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Content Type + + + + + en + contentType + + + STRING + + + en + The type of content which can be expected in the "content" property. Examples are a link, restricted link, pdf, excel, etc. + + + + + + + + + header + + + en + Header + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Header + + + + + en + header + + + STRING + + + en + The header as a short description of the document with a maximum of 100 characters. + + + + + + + + + sources + + + en + Sources + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#sources + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Sources + + + + + en + sources + + + STRING + + + en + Documents that are mandatory if applicable for the product. These are mentioned in the ESPR provisional agreement from January 9th, 2024 ANNEX III: +(e) compliance documentation and information required under this Regulation or other Union law applicable to the product, such as the declaration of conformity, technical documentation or conformity certificates; +(f) user manuals, instructions, warnings or safety information, as required by other Union legislation applicable to the product. +Additionally requirements are mentioned in Article 21: +7. Manufacturers shall ensure that a product covered by a delegated act adopted pursuant to Article 4 is accompanied by instructions in digital format that enable customers and other relevant actors to assemble, install, operate, store, maintain, repair and dispose of the product in a language that can be easily understood, as determined by the Member State concerned. Such instructions shall be clear, understandable and legible and include at least the information set out in Article 7(2), point (b), point (ii) specified in the delegated acts adopted pursuant to Article 4. +Article 7 states additionally: +(ii) information for customers and other actors on how to install, use, maintain and repair the product, in order to minimise its impact on the environment and to ensure optimum durability, on how to install third-party operating systems where relevant, as well as on collection for refurbishment or remanufacture, and on how to return or handle the product at the end of its life; +(2) (b) (iii) information for treatment facilities on disassembly, reuse, refurbishment, recycling, or disposal at end-of-life; +(2) (b) (iv) other information that may influence sustainable product choices for customers and the way the product is handled by parties other than the manufacturer in order to facilitate appropriate use, value retaining operations and correct treatment at end-of-life. +(5) (d) relevant instructions for the safe use of the product. +(5) (e) information relevant for disassembly, preparation for reuse, reuse, recycling and the environmentally sound management of the product at the end of its life. +Annex I: +(b) [...] availability of repair and maintenance instructions, number of materials and components used, use of standard components,[...] number and complexity of processes and whether specialised toolsare needed, ease of non-destructive disassembly and re-assembly, conditions for access to product data, conditions for access to or use of hardware and software needed; +(c) ease of upgrading, re-use, remanufacturing and refurbishment as expressed through: [...] number and complexity of processes and tools needed, ease of non-destructive disassembly and re-assembly, conditions for access to product data, conditions for access to or use of hardware and software needed, conditions of access to test protocols or not commonly available testing equipment, availability of guarantees specific to remanufactured or refurbished products, conditions for access to or use of technologies protected by intellectual property rights, modularity; +(d) design for recycling, ease and quality of recycling as expressed through: use of easily recyclable materials, safe, easy and non-destructive access to recyclable components and materials or components and materials containing hazardous substances and material composition and homogeneity, possibility for high-purity sorting, [...] number and complexity of processes and tools needed, ease of nondestructive disassembly and re-assembly, conditions for access to product data, conditions for access to or use of hardware and software needed; +(q) functional performance and conditions for use including as expressed through ability in performing its intended use, precautions of use, skills required, compatibility with other products or systems. +Additionally to consider are guidelines and instructions regarding the proper management and disposal of packaging materials after use. This can include instructions for separation, reuse, and recycling. + + + + + + + + + state + + + en + State + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#state + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + State + + + + + en + state + + + STRING + + + en + The status of the product (original, repurposed, re-used, remanufactured or waste) to indicated, whether it is a used product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Annex I: +(j) incorporation of used components. + + + + + + original + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#StateEnumeration:original + + + + + + repurposed + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#StateEnumeration:repurposed + + + + + + re-used + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#StateEnumeration:re-used + + + + + + remanufactured + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#StateEnumeration:remanufactured + + + + + + waste + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#StateEnumeration:waste + + + + + + + + + + + + + footprintValue + + + en + Footprint Value + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#footprintValue + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Footprint Value + + + + + en + footprintValue + + + REAL_MEASURE + + + en + The value of the footprint of the product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Annex I: +(l) the environmental footprint of the product, expressed as a quantification, in accordance with the applicable delegated act, of a product's life cycle environmental impacts, whether in relation to one or more environmental impact categories or an aggregated set of impact categories; +(m) the carbon footprint of the product; +(ma) the material footprint of the product. + + + + + + + + + + content + + + en + Content + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Content + + + + + en + content + + + STRING + + + en + The content of the document e.g a link. + + + + + + + + + contentType + + + en + Content Type + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Content Type + + + + + en + contentType + + + STRING + + + en + The type of content which can be expected in the "content" property. Examples are a link, restricted link, pdf, excel, etc. + + + + + + + + + header + + + en + Header + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Header + + + + + en + header + + + STRING + + + en + The header as a short description of the document with a maximum of 100 characters. + + + + + + + + + footprintRulebook + + + en + Footprint Rulebook + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#footprintRulebook + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Footprint Rulebook + + + + + en + footprintRulebook + + + STRING + + + en + The applied rulebook for the environmental footprint of the product. + + + + + + + + + footprintLifecycle + + + en + Footprint Lifecycle + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#footprintLifecycle + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Footprint Lifecycle + + + + + en + footprintLifecycle + + + STRING + + + en + The lifecycle stage, to which the environmental footprint corresponds. These could be for example "raw material acquisition and pre-processing", "main product production", "distribution" or "end of life and recycling". + + + + + + + + + footprintUnit + + + en + Footprint Unit + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#footprintUnit + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Footprint Unit + + + + + en + footprintUnit + + + STRING + + + en + The unit of measurement of the environmental impact category. For each impact category a specific unit is used. If an aggregation is used, utilize the normalization and weighting methods used in the referenced rulebook. + + + + + + + + + footprintType + + + en + Footprint Type + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#footprintType + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Footprint Type + + + + + en + footprintType + + + STRING + + + en + The type of the environmental footprint of the product. This could be one of the environmental impact categories. This attribute is mentioned in the ESPR provisional agreement from January 9th 2024 Article 7: +(2)(b)(i) information on the performance of the product in relation to one or more of the product parameters referred to in Annex I, including a scoring of reparability or durability, carbon footprint or environmental footprint; +Annex I: +(l) the environmental footprint of the product, expressed as a quantification, in accordance with the applicable delegated act, of a product's life cycle environmental impacts, whether in relation to one or more environmental impact categories or an aggregated set of impact categories. +(m) the carbon footprint of the product; +(ma) the material footprint of the product. + + + + + + Climate Change Total + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#CategoryEnumeration:Climate Change Total + + + + + + Climate Change Fossil + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#CategoryEnumeration:Climate Change Fossil + + + + + + Climate Change Biogenic Removals and Emissions + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#CategoryEnumeration:Climate Change Biogenic Removals and Emissions + + + + + + Climate Change Land Use and Land Use Change + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#CategoryEnumeration:Climate Change Land Use and Land Use Change + + + + + + Ozone Depletion + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#CategoryEnumeration:Ozone Depletion + + + + + + Acidification + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#CategoryEnumeration:Acidification + + + + + + Eutrophication Aquatic Freshwater + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#CategoryEnumeration:Eutrophication Aquatic Freshwater + + + + + + Eutrophication Fresh Marine + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#CategoryEnumeration:Eutrophication Fresh Marine + + + + + + Eutrophication Terrestrial + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#CategoryEnumeration:Eutrophication Terrestrial + + + + + + Photochemical Ozone Formation + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#CategoryEnumeration:Photochemical Ozone Formation + + + + + + Abiotic Depletion- Minerals and Metals + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#CategoryEnumeration:Abiotic Depletion- Minerals and Metals + + + + + + Fossil Fuels + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#CategoryEnumeration:Fossil Fuels + + + + + + Water Use + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#CategoryEnumeration:Water Use + + + + + + Particulate Matter Emissions + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#CategoryEnumeration:Particulate Matter Emissions + + + + + + Ionizing Radiation, Human Health + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#CategoryEnumeration:Ionizing Radiation, Human Health + + + + + + Eco-Toxicity + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#CategoryEnumeration:Eco-Toxicity + + + + + + Human Toxicity, Cancer Effects + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#CategoryEnumeration:Human Toxicity, Cancer Effects + + + + + + Human Toxicity, Non-Cancer Effects + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#CategoryEnumeration:Human Toxicity, Non-Cancer Effects + + + + + + Land Use Related Impacts/Soil Quality + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#CategoryEnumeration:Land Use Related Impacts/Soil Quality + + + + + + + + + + + + + performanceClass + + + en + Performance Class + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#performanceClass + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Performance Class + + + + + en + performanceClass + + + STRING + + + en + The performance classification of the footprint. + + + + + + + + + facility + + + en + Facility + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#facility + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Facility + + + + + en + facility + + + STRING + + + en + The identifier used for a location. This attribute is mentioned in the ESPR provisional agreement from January 9th 2024 Annex III: +(i) unique facility identifiers; +Article 2 Definitions: (33) 'unique facility identifier' means a unique string of characters for the identification of locations or buildings involved in the value chain of a product or used by actors involved in the value chain of a product. + + + + + + + + + manufacturingPlant + + + en + Manufacturing Plant + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#manufacturingPlant + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Manufacturing Plant + + + + + en + manufacturingPlant + + + STRING + + + en + The manufacturing plant of the footprint in the specific lifecycle phase. + + + + + + + + + content + + + en + Content + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Content + + + + + en + content + + + STRING + + + en + The content of the document e.g a link. + + + + + + + + + contentType + + + en + Content Type + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Content Type + + + + + en + contentType + + + STRING + + + en + The type of content which can be expected in the "content" property. Examples are a link, restricted link, pdf, excel, etc. + + + + + + + + + header + + + en + Header + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Header + + + + + en + header + + + STRING + + + en + The header as a short description of the document with a maximum of 100 characters. + + + + + + + + + declaration + + + en + Declaration + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#declaration + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Declaration + + + + + en + declaration + + + STRING + + + en + The footprint declaration in the format of a link + + + + + + + + + environmentalFootprint + + + en + Environmental Footprint + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#environmentalFootprint + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Environmental Footprint + + + + + en + environmentalFootprint + + + STRING + + + en + The environmental footprint of the product. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I: +The following parameters shall, as appropriate, and where necessary supplemented by others, be used, individually or combined, as a basis for improving the product aspects referred to in Article 5(1): +(l) the environmental footprint of the product, expressed as a quantification, in accordance with the applicable delegated act, of a product's life cycle environmental impacts, whether in relation to one or more environmental impact categories or an aggregated set of impact categories. +and Article 7: +(2)(b)(i) information on the performance of the product in relation to one or more of the product parameters referred to in Annex I, including a scoring of reparability or durability, carbon footprint or environmental footprint; +and defined by Article 2: +(23) 'environmental footprint' means a quantification of product environmental impacts throughout its life cycle, whether in relation to a single environmental impact category or an aggregated set of impact categories based on the Product Environmental Footprint method or other scientific methods developed by international organisations and widely tested in collaboration with different industry sectors and adopted or implemented by the Commission in other Union legislation; +(24) 'Product Environmental Footprint method' means the life cycle assessment method to quantify the environmental impacts of products established by Recommendation (EU) 2021/2279. + + + + + + + + + footprintValue + + + en + Footprint Value + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#footprintValue + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Footprint Value + + + + + en + footprintValue + + + REAL_MEASURE + + + en + The value of the footprint of the product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Annex I: +(l) the environmental footprint of the product, expressed as a quantification, in accordance with the applicable delegated act, of a product's life cycle environmental impacts, whether in relation to one or more environmental impact categories or an aggregated set of impact categories; +(m) the carbon footprint of the product; +(ma) the material footprint of the product. + + + + + + + + + + content + + + en + Content + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Content + + + + + en + content + + + STRING + + + en + The content of the document e.g a link. + + + + + + + + + contentType + + + en + Content Type + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Content Type + + + + + en + contentType + + + STRING + + + en + The type of content which can be expected in the "content" property. Examples are a link, restricted link, pdf, excel, etc. + + + + + + + + + header + + + en + Header + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Header + + + + + en + header + + + STRING + + + en + The header as a short description of the document with a maximum of 100 characters. + + + + + + + + + footprintRulebook + + + en + Footprint Rulebook + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#footprintRulebook + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Footprint Rulebook + + + + + en + footprintRulebook + + + STRING + + + en + The applied rulebook for the environmental footprint of the product. + + + + + + + + + footprintLifecycle + + + en + Footprint Lifecycle + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#footprintLifecycle + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Footprint Lifecycle + + + + + en + footprintLifecycle + + + STRING + + + en + The lifecycle stage, to which the environmental footprint corresponds. These could be for example "raw material acquisition and pre-processing", "main product production", "distribution" or "end of life and recycling". + + + + + + + + + footprintUnit + + + en + Footprint Unit + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#footprintUnit + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Footprint Unit + + + + + en + footprintUnit + + + STRING + + + en + The unit of measurement of the environmental impact category. For each impact category a specific unit is used. If an aggregation is used, utilize the normalization and weighting methods used in the referenced rulebook. + + + + + + + + + footprintType + + + en + Footprint Type + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#footprintType + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Footprint Type + + + + + en + footprintType + + + STRING + + + en + The type of the environmental footprint of the product. This could be one of the environmental impact categories. This attribute is mentioned in the ESPR provisional agreement from January 9th 2024 Article 7: +(2)(b)(i) information on the performance of the product in relation to one or more of the product parameters referred to in Annex I, including a scoring of reparability or durability, carbon footprint or environmental footprint; +Annex I: +(l) the environmental footprint of the product, expressed as a quantification, in accordance with the applicable delegated act, of a product's life cycle environmental impacts, whether in relation to one or more environmental impact categories or an aggregated set of impact categories. +(m) the carbon footprint of the product; +(ma) the material footprint of the product. + + + + + + + + + performanceClass + + + en + Performance Class + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#performanceClass + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Performance Class + + + + + en + performanceClass + + + STRING + + + en + The performance classification of the footprint. + + + + + + + + + facility + + + en + Facility + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#facility + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Facility + + + + + en + facility + + + STRING + + + en + The identifier used for a location. This attribute is mentioned in the ESPR provisional agreement from January 9th 2024 Annex III: +(i) unique facility identifiers; +Article 2 Definitions: (33) 'unique facility identifier' means a unique string of characters for the identification of locations or buildings involved in the value chain of a product or used by actors involved in the value chain of a product. + + + + + + + + + manufacturingPlant + + + en + Manufacturing Plant + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#manufacturingPlant + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Manufacturing Plant + + + + + en + manufacturingPlant + + + STRING + + + en + The manufacturing plant of the footprint in the specific lifecycle phase. + + + + + + + + + content + + + en + Content + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Content + + + + + en + content + + + STRING + + + en + The content of the document e.g a link. + + + + + + + + + contentType + + + en + Content Type + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Content Type + + + + + en + contentType + + + STRING + + + en + The type of content which can be expected in the "content" property. Examples are a link, restricted link, pdf, excel, etc. + + + + + + + + + header + + + en + Header + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Header + + + + + en + header + + + STRING + + + en + The header as a short description of the document with a maximum of 100 characters. + + + + + + + + + declaration + + + en + Declaration + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#declaration + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Declaration + + + + + en + declaration + + + STRING + + + en + The footprint declaration in the format of a link + + + + + + + + + carbonFootprint + + + en + Carbon Footprint + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#carbonFootprint + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Carbon Footprint + + + + + en + carbonFootprint + + + STRING + + + en + The carbon footprint of the product. This is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I: +The following parameters shall, as appropriate, and where necessary supplemented by others, be used, individually or combined, as a basis for improving the product aspects referred to in Article 5(1): +(m) the carbon footprint of the product; +and Article 7: +(2)(b)(i) information on the performance of the product in relation to one or more of the product parameters referred to in Annex I, including a scoring of reparability or durability, carbon footprint or environmental footprint; +and defined by Article 2: +(25) 'carbon footprint' means the sum of greenhouse gas (GHG) emissions and GHG removals in a product system, expressed as CO2 equivalents and based on a life cycle assessment using the single impact category of climate change. + + + + + + + + + footprintValue + + + en + Footprint Value + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#footprintValue + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Footprint Value + + + + + en + footprintValue + + + REAL_MEASURE + + + en + The value of the footprint of the product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Annex I: +(l) the environmental footprint of the product, expressed as a quantification, in accordance with the applicable delegated act, of a product's life cycle environmental impacts, whether in relation to one or more environmental impact categories or an aggregated set of impact categories; +(m) the carbon footprint of the product; +(ma) the material footprint of the product. + + + + + + + + + + content + + + en + Content + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Content + + + + + en + content + + + STRING + + + en + The content of the document e.g a link. + + + + + + + + + contentType + + + en + Content Type + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Content Type + + + + + en + contentType + + + STRING + + + en + The type of content which can be expected in the "content" property. Examples are a link, restricted link, pdf, excel, etc. + + + + + + + + + header + + + en + Header + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Header + + + + + en + header + + + STRING + + + en + The header as a short description of the document with a maximum of 100 characters. + + + + + + + + + footprintRulebook + + + en + Footprint Rulebook + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#footprintRulebook + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Footprint Rulebook + + + + + en + footprintRulebook + + + STRING + + + en + The applied rulebook for the environmental footprint of the product. + + + + + + + + + footprintLifecycle + + + en + Footprint Lifecycle + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#footprintLifecycle + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Footprint Lifecycle + + + + + en + footprintLifecycle + + + STRING + + + en + The lifecycle stage, to which the environmental footprint corresponds. These could be for example "raw material acquisition and pre-processing", "main product production", "distribution" or "end of life and recycling". + + + + + + + + + footprintUnit + + + en + Footprint Unit + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#footprintUnit + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Footprint Unit + + + + + en + footprintUnit + + + STRING + + + en + The unit of measurement of the environmental impact category. For each impact category a specific unit is used. If an aggregation is used, utilize the normalization and weighting methods used in the referenced rulebook. + + + + + + + + + footprintType + + + en + Footprint Type + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#footprintType + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Footprint Type + + + + + en + footprintType + + + STRING + + + en + The type of the environmental footprint of the product. This could be one of the environmental impact categories. This attribute is mentioned in the ESPR provisional agreement from January 9th 2024 Article 7: +(2)(b)(i) information on the performance of the product in relation to one or more of the product parameters referred to in Annex I, including a scoring of reparability or durability, carbon footprint or environmental footprint; +Annex I: +(l) the environmental footprint of the product, expressed as a quantification, in accordance with the applicable delegated act, of a product's life cycle environmental impacts, whether in relation to one or more environmental impact categories or an aggregated set of impact categories. +(m) the carbon footprint of the product; +(ma) the material footprint of the product. + + + + + + + + + performanceClass + + + en + Performance Class + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#performanceClass + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Performance Class + + + + + en + performanceClass + + + STRING + + + en + The performance classification of the footprint. + + + + + + + + + facility + + + en + Facility + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#facility + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Facility + + + + + en + facility + + + STRING + + + en + The identifier used for a location. This attribute is mentioned in the ESPR provisional agreement from January 9th 2024 Annex III: +(i) unique facility identifiers; +Article 2 Definitions: (33) 'unique facility identifier' means a unique string of characters for the identification of locations or buildings involved in the value chain of a product or used by actors involved in the value chain of a product. + + + + + + + + + manufacturingPlant + + + en + Manufacturing Plant + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#manufacturingPlant + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Manufacturing Plant + + + + + en + manufacturingPlant + + + STRING + + + en + The manufacturing plant of the footprint in the specific lifecycle phase. + + + + + + + + + content + + + en + Content + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Content + + + + + en + content + + + STRING + + + en + The content of the document e.g a link. + + + + + + + + + contentType + + + en + Content Type + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Content Type + + + + + en + contentType + + + STRING + + + en + The type of content which can be expected in the "content" property. Examples are a link, restricted link, pdf, excel, etc. + + + + + + + + + header + + + en + Header + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Header + + + + + en + header + + + STRING + + + en + The header as a short description of the document with a maximum of 100 characters. + + + + + + + + + declaration + + + en + Declaration + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#declaration + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Declaration + + + + + en + declaration + + + STRING + + + en + The footprint declaration in the format of a link + + + + + + + + + materialFootprint + + + en + Material Footprint + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#materialFootprint + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Material Footprint + + + + + en + materialFootprint + + + STRING + + + en + The material footprint of the product. This is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I: +(ma) the material footprint of the product; +and defined by Article 2: +(25a) 'material footprint' refers to the total amount of raw materials extracted to meet final consumption demands. + + + + + + + + + productFootprint + + + en + Product Footprint + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#productFootprint + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Product Footprint + + + + + en + productFootprint + + + STRING + + + en + The carbon and environmental footprint or material footprint of the product. These attributes are mentioned in the ESPR provisional agreement from January 9th 2024 Annex I: +(l) the environmental footprint of the product, expressed as a quantification, in accordance with the applicable delegated act, of a product's life cycle environmental impacts, whether in relation to one or more environmental impact categories or an aggregated set of impact categories; +(m) the carbon footprint of the product; +(ma) the material footprint of the product; +All are defined by Article 2: +(23) 'environmental footprint' means a quantification of product environmental impacts throughout its life cycle, whether in relation to a single environmental impact category or an aggregated set of impact categories based on the Product Environmental Footprint method or other scientific methods developed by international organisations and widely tested in collaboration with different industry sectors and adopted or implemented by the Commission in other Union +legislation; +(25) 'carbon footprint' means the sum of greenhouse gas (GHG) emissions and GHG removals in a product system, expressed as CO2 equivalents and based on a life cycle assessment using the single impact category of climate change. +(25a) 'material footprint' refers to the total amount of raw materials extracted to meet final consumption demands; + + + + + + + + + reparabilityScore + + + en + Reparability Score + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#reparabilityScore + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Reparability Score + + + + + en + reparabilityScore + + + STRING + + + en + The reparability score. This attribute is mentioned ESPR provisional agreement from January 9th, 2024 Article 7: +(b) as appropriate, also require products to be accompanied by: +(i) information on the performance of the product in relation to one or more of the product parameters referred to in Annex I, including a scoring of reparability or durability [...]. + + + + + + + + + durabilityScore + + + en + Durability Score + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#durabilityScore + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Durability Score + + + + + en + durabilityScore + + + STRING + + + en + The durability score. This attribute is mentioned ESPR provisional agreement from January 9th, 2024 Article 7: +(b) as appropriate, also require products to be accompanied by: +(i) information on the performance of the product in relation to one or more of the product parameters referred to in Annex I, including a scoring of reparability or durability [...]. + + + + + + + + + sustainability + + + en + Sustainability + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#sustainability + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Sustainability + + + + + en + sustainability + + + STRING + + + en + Sustainability related attributes. + + + + + + + + + version + + + en + Version + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#version + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Version + + + + + en + version + + + STRING + + + en + The current version of the product passport. The possibility of modification/ updating the product passport needs to include versioning of the dataset. This attribute is an internal versioning from the passport issuer. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Article 8: +(1) [...] The information in the product passport shall be accurate, complete, and up to date. + + + + + + + + + status + + + en + Status + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#status + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Status + + + + + en + status + + + STRING + + + en + The current status of the product passport declared through either: draft, approved, invalid or expired. + + + + + + draft + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#StatusEnumeration:draft + + + + + + approved + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#StatusEnumeration:approved + + + + + + invalid + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#StatusEnumeration:invalid + + + + + + expired + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#StatusEnumeration:expired + + + + + + + + + + + + + expirationDate + + + en + Expiration Date + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#expirationDate + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Expiration Date + + + + + en + expirationDate + + + STRING + + + en + The timestamp in the format (yyyy-mm-dd) for the product passport until when it is available or a comment describing this period. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Article 8: +(2) (h) the period during which the product passport is to remain available, which shall correspond to at least the expected lifetime of a specific product. + + + + + + + + + issueDate + + + en + Issue Date + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#issueDate + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Issue Date + + + + + en + issueDate + + + STRING + + + en + The timestamp in the format (yyyy-mm-dd) since when the product passport is available. + + + + + + + + + economicOperatorId + + + en + Economic Operator Id + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#economicOperatorId + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Economic Operator Id + + + + + en + economicOperatorId + + + STRING + + + en + The identification of the owner/economic operator of the passport. Proposed, according to ISO 15459, is the CIN (company identification code). Other identification numbers like the tax identification number, value added tax identification number, commercial register number and the like are also valid entries. In the Catena-X network, the BPNL is used for the identification of companies and the information stored like contact information and addresses. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Annex III: +(k) the [...] unique operator identifier code of the economic operator established in the Union responsible for carrying out the tasks set out in Article 4 of Regulation (EU) 2019/1020, or Article 15 of Regulation (EU) on general product safety, or similar tasks pursuant to other EU legislation applicable to the product. + + + + + + + + + passportIdentifier + + + en + Passport Identifier + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#passportIdentifier + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Passport Identifier + + + + + en + passportIdentifier + + + STRING + + + en + The identifier of the product passport, which is an uuidv4. + + + + + + + + + predecessor + + + en + Predecessor + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#predecessor + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Predecessor + + + + + en + predecessor + + + STRING + + + en + Identification of the preceding product passport. If there is no preceding passport, input a dummy value. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Article 8: +(2)(g) [...] Any new product passport shall be linked to the product passport or passports of the original product whenever appropriate. + + + + + + + + + backupReference + + + en + Backup Reference + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#backupReference + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Backup Reference + + + + + en + backupReference + + + STRING + + + en + A reference to the data backup of the passport. This mandatory attribute will be further defined in the future. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex III: +(kb) the reference of the certified independent third-party product passport service provider hosting the back-up copy of the product passport. +Article 10 also mentions: +(c) the data included in the product passport shall be stored by the economic operator responsible for its creation or by certified independent third-party product passport service providers authorised to act on their behalf. + + + + + + + + + registrationIdentifier + + + en + Registration Identifier + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#registrationIdentifier + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Registration Identifier + + + + + en + registrationIdentifier + + + STRING + + + en + Identifier in the respective registry. This will be further defined in the future. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 in Article 12: +By [2 years from entering into force of this Regulation], the Commission shall set up and manage a digital registry ("the registry") storing in a secure manner at least the unique product identifier, the unique operator identifier, the unique facility identifiers. In case of products intended to be placed under the customs procedure 'release for free circulation', the registry shall also store the product commodity code. The registry shall also store the batteries' unique identifiers referred to in Article 77(3) of Regulation (EU) 2023/1542. + + + + + + + + + lastModification + + + en + Last Modification + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#lastModification + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Last Modification + + + + + en + lastModification + + + STRING + + + en + Date of the latest modification. + + + + + + + + + metadata + + + en + Metadata + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#metadata + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Metadata + + + + + en + metadata + + + STRING + + + en + Metadata of the product passport. These are mentioned in the ESPR proposal from March 30th, 2022 and some changed by the provisional agreement from January 9th, 2024. + + + + + + + + + genericParameters + + + en + Product Generic Parameters + + + urn:samm:io.catenax.material.chemical_material_passport:2.0.0#genericParameters + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Product Generic Parameters + + + + + en + genericParameters + + + STRING + + + en + The product generic parameters. These are defined by the Digital Product Passport proposal from the ESPR. The main basis is provided by the document "Proposal for a REGULATION OF THE EUROPEAN PARLIAMENT AND OF THE COUNCIL establishing a framework for setting ecodesign requirements for sustainable products and repealing Directive 2009/125/EC" from March 30th, 2022. The latest version of the document was the provisional agreement between the EU Council and the Parliament from January 9th, 2024. + + + + + + + + + diff --git a/io.catenax.material.chemical_material_passport/2.0.0/gen/ChemicalMaterialPassport-schema.json b/io.catenax.material.chemical_material_passport/2.0.0/gen/ChemicalMaterialPassport-schema.json new file mode 100644 index 000000000..3804ec139 --- /dev/null +++ b/io.catenax.material.chemical_material_passport/2.0.0/gen/ChemicalMaterialPassport-schema.json @@ -0,0 +1,1640 @@ +{ + "$schema" : "http://json-schema.org/draft-04/schema", + "description" : "The information in a Digital Product Passport allows stakeholders in the value chain to map information and obtain a better understanding of the composition of the product, the environmental impact of the production and use phase, and the aspect of circularity. To serve the same purpose as the Digital Passport, the Chemical Material Passport also plays an important role in providing more detailed information in terms of sustainability, safety and waste management. It can replace the current way of communication and data exchange from multi-channels by one streamlined data flow.", + "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.material.chemical_material_passport_2.0.0_ParameterMethodEntity" : { + "description" : "Testing methods or standards used for testing parameters with method names.", + "type" : "object", + "properties" : { + "parameterMethodName" : { + "description" : "The name of the testing method or standard used for testing parameters can vary depending on the context and industry. It might be referred to by a specific code, standard name, or regulation/directive.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "parameterMethodConditions" : { + "description" : "The relevant conditions for conducting a measurement or analysis of a chemical parameter ensure the accuracy, reliability, and consistency of the results obtained from the method used. These conditions are typically presented in the Certificate of Analysis or Safety Data Sheet, specifically in Section 9.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "parameterMethodDescription" : { + "description" : "Short description of the method used to determine parameter presented in Certificate of Analysis or Safety Data Sheet in Section 9.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + } + }, + "required" : [ "parameterMethodName", "parameterMethodConditions", "parameterMethodDescription" ] + }, + "urn_samm_io.catenax.material.chemical_material_passport_2.0.0_ParameterMethodList" : { + "description" : "List of testing methods or standards used for testing parameters.", + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/urn_samm_io.catenax.material.chemical_material_passport_2.0.0_ParameterMethodEntity" + } + }, + "urn_samm_io.catenax.material.chemical_material_passport_2.0.0_StringList" : { + "description" : "List of text strings.", + "type" : "array", + "items" : { + "type" : "string" + } + }, + "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.generic.digital_product_passport_5.0.0_HeaderTrait" : { + "type" : "string", + "description" : "Constraint for a maximum of 100 characters.", + "maxLength" : 100 + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentationEntity" : { + "description" : "Entity for a document with a header, type and content.", + "type" : "object", + "properties" : { + "content" : { + "description" : "The content of the document e.g a link.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "contentType" : { + "description" : "The type of content which can be expected in the \"content\" property. Examples are a link, restricted link, pdf, excel, etc.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "header" : { + "description" : "The header as a short description of the document with a maximum of 100 characters.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_HeaderTrait" + } + }, + "required" : [ "content", "contentType", "header" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentList" : { + "description" : "List of documents.", + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentationEntity" + } + }, + "urn_samm_io.catenax.material.chemical_material_passport_2.0.0_ParameterBeforeUseEntity" : { + "description" : "Entity for parameters of the chemical material before use.", + "type" : "object", + "properties" : { + "name" : { + "description" : "The name of the parameter for the product tested and presented, for instance, in the Certificate of Analysis or Safety Data Sheet, found in Section 9. Parameters for chemical products usually encompass their chemical composition, physical properties, performance characteristics, and toxicological aspects. These parameters vary depending on the chemical's nature, its intended use, and relevant safety or regulatory considerations.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "value" : { + "description" : "The value resulting from the tested parameter is typically presented in Section 9 of the Safety Data Sheet or Certificate of Analysis.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "unit" : { + "description" : "The unit of measurement for the parameter value presented in Section 9 of the Safety Data Sheet or Certificate of Analysis varies depending on the specific parameter being reported.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "result" : { + "description" : "Other types of results, if not numerical values, for parameters presented in Section 9 of the Safety Data Sheet or Certificate of Analysis may include qualitative descriptions like \"pass\" or \"fail,\" as well as ranges, thresholds, or classifications.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "method" : { + "description" : "Testing methods or standards used for testing parameters.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.material.chemical_material_passport_2.0.0_ParameterMethodList" + }, + "remark" : { + "description" : "Commentary on the test/parameter presented in the Certificate of Analysis or Safety Data Sheet in Section 9. Selecting \"not applicable\" is also an option.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "classificationStatement" : { + "description" : "List of classification statements resulting from the test should include information on whether the result impacts the hazard classification of the product, particularly in the case of properties such as explosives in Safety Data Sheets (SDS).", + "$ref" : "#/components/schemas/urn_samm_io.catenax.material.chemical_material_passport_2.0.0_StringList" + }, + "testGLPCompliance" : { + "description" : "Statement indicating whether the test for the parameter was conducted in accordance with the Good Laboratory Practice (GLP) standard, as outlined in ISO/IEC 17025:2017, which specifies general requirements for the competence of testing and calibration laboratories.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Boolean" + }, + "documentation" : { + "description" : "Reference to the confirmation of the result typically includes a link to the document containing the confirmation, such as the Certificate of Analysis (CoA).", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentList" + } + }, + "required" : [ "name", "value", "unit", "result", "testGLPCompliance", "documentation" ] + }, + "urn_samm_io.catenax.material.chemical_material_passport_2.0.0_ParameterBeforeUseList" : { + "description" : "List of parameters of the chemical material before use.", + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/urn_samm_io.catenax.material.chemical_material_passport_2.0.0_ParameterBeforeUseEntity" + } + }, + "urn_samm_io.catenax.material.chemical_material_passport_2.0.0_ParameterAfterUseCharacteristic" : { + "description" : "Characteristic for parameters of the chemical material after use.", + "type" : "object", + "properties" : { + "documentation" : { + "description" : "Parameters of a product that may change or become relevant after its intended use are often documented as post-application characteristics. This data can be found in documents such as \"Technical Documentation.\"", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentList" + }, + "applicable" : { + "description" : "Check whether the connected attributes are applicable to the product. If it is not applicable (false), dummy data can be delivered.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Boolean" + } + }, + "required" : [ "documentation", "applicable" ] + }, + "urn_samm_io.catenax.material.chemical_material_passport_2.0.0_ParameterCharacteristic" : { + "description" : "Parameter Characteristic for the chemical material.", + "type" : "object", + "properties" : { + "parameterBeforeUse" : { + "description" : "Parameters of the chemical material before use.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.material.chemical_material_passport_2.0.0_ParameterBeforeUseList" + }, + "parameterAfterUse" : { + "description" : "Parameters of the chemical material after use.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.material.chemical_material_passport_2.0.0_ParameterAfterUseCharacteristic" + } + }, + "required" : [ "parameterBeforeUse", "parameterAfterUse" ] + }, + "urn_samm_io.catenax.material.chemical_material_passport_2.0.0_MaterialEnumeration" : { + "type" : "string", + "description" : "Enumeration with the values substance, mixture and article.", + "enum" : [ "substance", "mixture", "article" ] + }, + "urn_samm_io.catenax.material.chemical_material_passport_2.0.0_RouteEnumeration" : { + "type" : "string", + "description" : "Enumeration with oral, dermal, inhalation gas, inhalation vapour, inhalation dust/mist/fume and not applicable", + "enum" : [ "oral", "dermal", "inhalation gas", "inhalation vapour", "inhalation dust/mist/fume", "not applicable" ] + }, + "urn_samm_io.catenax.material.chemical_material_passport_2.0.0_ClassificationEntity" : { + "description" : "Entity for the hazard classification.", + "type" : "object", + "properties" : { + "rule" : { + "description" : "Name of the classification rule under which the hazard assessment has been prepared.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "hazardous" : { + "description" : "Information if the product is hazardous or not, according to the connected rule.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Boolean" + }, + "route" : { + "description" : "Certain classifications must be communicated with the relevant route of exposure according to CLP Regulation (EC) No 1272/2008, which include:\n- oral,\n- dermal,\n- inhalation gas,\n- inhalation vapour,\n- inhalation dust/mist/fume.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.material.chemical_material_passport_2.0.0_RouteEnumeration" + }, + "remark" : { + "description" : "Additional remarks for classification information supplement the classification details for a particular chemical material. These remarks assist stakeholders in making informed decisions regarding safety, handling, and regulatory compliance.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "category" : { + "description" : "The hazard category of the substance of concern. Defined in Article 2 of Regulation (EC) No 1272/2008 of the European Parliament and of the Council of 16 December 2008 on classification, labelling and packaging of substances and mixtures, amending and repealing Directives 67/548/EEC and 1999/45/EC, and amending Regulation (EC) No 1907/2006:\n2. 'hazard category' means the division of criteria within each hazard class, specifying hazard severity.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "class" : { + "description" : "The hazard class of the substance of concern. Defined in Article 2 of Regulation (EC) No 1272/2008 of the European Parliament and of the Council of 16 December 2008 on classification, labelling and packaging of substances and mixtures, amending and repealing Directives 67/548/EEC and 1999/45/EC, and amending Regulation (EC) No 1907/2006:\n1. 'hazard class' means the nature of the physical, health or environmental hazard.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "statement" : { + "description" : "The hazard statement of the substance of concern. Defined in Article 2 of Regulation (EC) No 1272/2008 of the European Parliament and of the Council of 16 December 2008 on classification, labelling and packaging of substances and mixtures, amending and repealing Directives 67/548/EEC and 1999/45/EC, and amending Regulation (EC) No 1907/2006:\n5. 'hazard statement' means a phrase assigned to a hazard class and category that describes the nature of the hazards of a hazardous substance or mixture, including, where appropriate, the degree of hazard.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + } + }, + "required" : [ "rule", "hazardous", "route", "remark", "category", "class", "statement" ] + }, + "urn_samm_io.catenax.material.chemical_material_passport_2.0.0_ClassificationList" : { + "description" : "List for the hazard classification.", + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/urn_samm_io.catenax.material.chemical_material_passport_2.0.0_ClassificationEntity" + } + }, + "urn_samm_io.catenax.material.chemical_material_passport_2.0.0_SignalWordEnumeration" : { + "type" : "string", + "description" : "Enumeration with Danger and Warning.", + "enum" : [ "Danger", "Warning" ] + }, + "urn_samm_io.catenax.material.chemical_material_passport_2.0.0_LinkCharacteristic" : { + "type" : "string", + "description" : "Characteristic for a simple web link." + }, + "urn_samm_io.catenax.material.chemical_material_passport_2.0.0_HazardPictogramEntity" : { + "description" : "Entity for the hazard pictogram.", + "type" : "object", + "properties" : { + "code" : { + "description" : "The code of a pictogram refers to a set of symbols used to visually represent and communicate information about the hazards associated with a chemical material.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "image" : { + "description" : "Link to the picture of the pictogram. Definition from CLP Regulation (EC) No 1272/2008 : ‘hazard pictogram’ means a graphical composition that includes a symbol plus other graphic elements, such as a border, background pattern or colour that is intended to convey specific information on the hazard concerned;", + "$ref" : "#/components/schemas/urn_samm_io.catenax.material.chemical_material_passport_2.0.0_LinkCharacteristic" + }, + "name" : { + "description" : "The meaning or description of a pictogram is the explanation that accompanies it, providing information and context about its purpose and the hazards it represents.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + } + }, + "required" : [ "code", "image", "name" ] + }, + "urn_samm_io.catenax.material.chemical_material_passport_2.0.0_HazardPictogramList" : { + "description" : "List of hazard pictograms.", + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/urn_samm_io.catenax.material.chemical_material_passport_2.0.0_HazardPictogramEntity" + } + }, + "urn_samm_io.catenax.material.chemical_material_passport_2.0.0_HazardStatementEntity" : { + "description" : "Entity for the hazard statement.", + "type" : "object", + "properties" : { + "code" : { + "description" : "According to CLP Regulation (EC) No 1272/2008, each hazard statement is designated a code, starting with the letter H followed by three digits. These codes can be associated with multiple hazard statements or be assigned to a single statement.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "text" : { + "description" : "Definition from CLP Regulation (EC) No 1272/2008 ‘hazard statement’ means a phrase assigned to a hazard class and category that describes the nature of the hazards of a hazardous substance or mixture, including, where appropriate, the degree of hazard;", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + } + }, + "required" : [ "code", "text" ] + }, + "urn_samm_io.catenax.material.chemical_material_passport_2.0.0_HazardStatementList" : { + "description" : "List for the hazard statement.", + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/urn_samm_io.catenax.material.chemical_material_passport_2.0.0_HazardStatementEntity" + } + }, + "urn_samm_io.catenax.material.chemical_material_passport_2.0.0_PrecautionaryCodeTrait" : { + "type" : "string", + "description" : "Constraint starting with the letter P followed by three digits.", + "pattern" : "^P\\d{3}$" + }, + "urn_samm_io.catenax.material.chemical_material_passport_2.0.0_PrecautionaryList" : { + "description" : "List for precautionary codes.", + "type" : "object", + "properties" : { + "code" : { + "description" : "Each precautionary statement is designated a code, starting with the letter P and followed by three digits.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.material.chemical_material_passport_2.0.0_PrecautionaryCodeTrait" + }, + "text" : { + "description" : "Definition from CLP Regulation (EC) No 1272/2008: ‘precautionary statement’ means a phrase that describes recommended measure(s) to minimise or prevent adverse effects resulting from exposure to a hazardous substance or mixture due to its use or disposal.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + } + }, + "required" : [ "code", "text" ] + }, + "urn_samm_io.catenax.material.chemical_material_passport_2.0.0_SupplementalRequirementsEntity" : { + "description" : "Entity for supplemental requirements.", + "type" : "object", + "properties" : { + "code" : { + "description" : "Supplemental codes used for labeling statements provide additional information or context about the hazards, handling, or regulatory requirements associated with chemical materials. This data can be helpful for stakeholders in managing chemical materials by offering further guidance on safe handling practices, storage conditions, emergency response procedures, or regulatory compliance measures.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "text" : { + "description" : "Any supplemental text used for labeling provides data that could be helpful for stakeholders in managing chemical materials.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "pictogram" : { + "description" : "Supplemental pictures or pictograms used for additional labeling provide data that could be helpful for stakeholders in managing chemical materials.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.material.chemical_material_passport_2.0.0_LinkCharacteristic" + }, + "notes" : { + "description" : "Labeling notes consist of statements that provide additional information regarding hazardous possible reactions or other important considerations related to the chemical material. These notes help stakeholders understand potential risks and take appropriate precautions when handling, storing, or using the material.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + } + } + }, + "urn_samm_io.catenax.material.chemical_material_passport_2.0.0_SupplementalRequirementsList" : { + "description" : "List for supplemental requirements.", + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/urn_samm_io.catenax.material.chemical_material_passport_2.0.0_SupplementalRequirementsEntity" + } + }, + "urn_samm_io.catenax.material.chemical_material_passport_2.0.0_LabelingCharacteristic" : { + "description" : "Characteristic for material labeling.", + "type" : "object", + "properties" : { + "signalWord" : { + "description" : "According to CLP Regulation (EC) No 1272/2008, a \"signal word\" refers to a term indicating the relative severity of hazards to alert the reader to a potential danger. There are two levels distinguished:\n(a) ‘Danger’ means a signal word indicating the more severe hazard categories;\n(b) ‘Warning’ means a signal word indicating the less severe hazard categories;", + "$ref" : "#/components/schemas/urn_samm_io.catenax.material.chemical_material_passport_2.0.0_SignalWordEnumeration" + }, + "hazardPictogram" : { + "description" : "A hazard pictogram is a graphical symbol used to convey specific information about the hazards associated with a chemical substance or mixture.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.material.chemical_material_passport_2.0.0_HazardPictogramList" + }, + "hazard" : { + "description" : "Describes the nature of a hazard associated with a chemical substance or mixture.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.material.chemical_material_passport_2.0.0_HazardStatementList" + }, + "precautionary" : { + "description" : "A precautionary code for materials is a standardized code used to convey specific precautionary measures that should be taken when handling, storing, or using a chemical substance or mixture.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.material.chemical_material_passport_2.0.0_PrecautionaryList" + }, + "supplementalRequirements" : { + "description" : "Supplemental requirements often include additional codes, symbols, or statements beyond those required by regulations.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.material.chemical_material_passport_2.0.0_SupplementalRequirementsList" + } + }, + "required" : [ "signalWord", "hazardPictogram", "hazard", "precautionary", "supplementalRequirements" ] + }, + "urn_samm_io.catenax.material.chemical_material_passport_2.0.0_HazardAssessmentCharacteristic" : { + "description" : "Characteristic for the hazard assessment.", + "type" : "object", + "properties" : { + "classification" : { + "description" : "Classification for the hazard assessment.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.material.chemical_material_passport_2.0.0_ClassificationList" + }, + "labeling" : { + "description" : "The material labeling.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.material.chemical_material_passport_2.0.0_LabelingCharacteristic" + }, + "documentation" : { + "description" : "Documentation providing hazard assessment information for ensuring the safe management of chemical materials throughout their lifecycle.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentList" + } + }, + "required" : [ "classification", "labeling", "documentation" ] + }, + "urn_samm_io.catenax.material.chemical_material_passport_2.0.0_CelsiusDegreeMeasurement" : { + "type" : "number", + "description" : "Measurement as float in celsius degree." + }, + "urn_samm_io.catenax.material.chemical_material_passport_2.0.0_ProductTransportCharacteristic" : { + "description" : "Product transportation Characteristic.", + "type" : "object", + "properties" : { + "emergencyTemperatureMin" : { + "description" : "The critical minimum temperature for transporting the product refers to the lowest temperature at which the product can be safely transported without compromising its integrity or functionality. Emergency temperature refers to a temperature that poses a significant risk, potentially leading to hazardous conditions or product damage.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.material.chemical_material_passport_2.0.0_CelsiusDegreeMeasurement" + }, + "emergencyTemperatureMax" : { + "description" : "The critical maximum temperature for transporting the product refers to the highest temperature at which the product can be safely transported without degradation or posing a risk. Emergency temperature refers to a temperature that poses a significant risk, potentially leading to hazardous conditions or product damage.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.material.chemical_material_passport_2.0.0_CelsiusDegreeMeasurement" + }, + "other" : { + "description" : "Additional information related to the transport of the product. Relevant details that could aid in making decisions regarding the shipping of the product.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "controlTemperature" : { + "description" : "The controlled temperature for transportation refers to the range of values within which the temperature conditions of goods or products are monitored and regulated during transportation in degree celcius. This information is crucial for mitigating risks associated with temperature-sensitive products, ensuring their integrity and quality throughout the shipping process.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "pictogram" : { + "description" : "Links to transport related pictograms.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.material.chemical_material_passport_2.0.0_StringList" + } + } + }, + "urn_samm_io.catenax.material.chemical_material_passport_2.0.0_UNNumberTrait" : { + "type" : "string", + "description" : "Constraint to four digits numbers.", + "pattern" : "^\\d{4}$" + }, + "urn_samm_io.catenax.material.chemical_material_passport_2.0.0_FloatQuantityValue" : { + "type" : "number", + "description" : "Value as float." + }, + "urn_samm_io.catenax.material.chemical_material_passport_2.0.0_PackagingGroupEnumeration" : { + "type" : "string", + "description" : "Enumeration to match \"I\", \"II\", \"III\", or \"not applicable\".", + "enum" : [ "I", "II", "III", "not applicable" ] + }, + "urn_samm_io.catenax.material.chemical_material_passport_2.0.0_QuantityCodeEnumeration" : { + "type" : "string", + "description" : "Enumeration for the codes E0, E1, E2, E3, E4, and E5.", + "enum" : [ "E0", "E1", "E2", "E3", "E4", "E5" ] + }, + "urn_samm_io.catenax.material.chemical_material_passport_2.0.0_IntegerCharacteristic" : { + "type" : "number", + "description" : "Characteristic for integer values." + }, + "urn_samm_io.catenax.material.chemical_material_passport_2.0.0_SpecialProvisionsCodeEntity" : { + "description" : "Entity for the special provisions code.", + "type" : "object", + "properties" : { + "code" : { + "description" : "Code of special provisions or exceptions that must be met.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.material.chemical_material_passport_2.0.0_IntegerCharacteristic" + }, + "text" : { + "description" : "Text aligned with special provisions under UN transport regulation Chapter 3.3.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + } + }, + "required" : [ "code", "text" ] + }, + "urn_samm_io.catenax.material.chemical_material_passport_2.0.0_SpecialProvisionsCodeList" : { + "description" : "List of the special provisions codes.", + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/urn_samm_io.catenax.material.chemical_material_passport_2.0.0_SpecialProvisionsCodeEntity" + } + }, + "urn_samm_io.catenax.shared.quantity_2.0.0_ItemUnitEnumeration" : { + "type" : "string", + "pattern" : "[a-zA-Z]*:[a-zA-Z]+", + "description" : "Enumeration for common item units.", + "enum" : [ "unit:piece", "unit:set", "unit:pair", "unit:page", "unit:cycle", "unit:kilowattHour", "unit:gram", "unit:kilogram", "unit:tonneMetricTon", "unit:tonUsOrShortTonUkorus", "unit:ounceAvoirdupois", "unit:pound", "unit:metre", "unit:centimetre", "unit:kilometre", "unit:inch", "unit:foot", "unit:yard", "unit:squareCentimetre", "unit:squareMetre", "unit:squareInch", "unit:squareFoot", "unit:squareYard", "unit:cubicCentimetre", "unit:cubicMetre", "unit:cubicInch", "unit:cubicFoot", "unit:cubicYard", "unit:litre", "unit:millilitre", "unit:hectolitre", "unit:secondUnitOfTime", "unit:minuteUnitOfTime", "unit:hourUnitOfTime", "unit:day" ] + }, + "urn_samm_io.catenax.material.chemical_material_passport_2.0.0_UNTransportEntity" : { + "description" : "Entity with transport related attributes.", + "type" : "object", + "properties" : { + "transportRegulation" : { + "description" : "Indicate regulations for transportation for example: Land transport (ADR/RID), Inland waterway transport (ADN), Sea transport (IMDG), Air transport (ICAO-TI/IATA-DGR) and so on.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "unNumber" : { + "description" : "The UN number or ID number is a four-digit identification code for substances, mixtures, or articles.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.material.chemical_material_passport_2.0.0_UNNumberTrait" + }, + "unShippingName" : { + "description" : "The proper shipping name is provided in column 2, \"Name and description,\" of Table A of Chapter 3.2 Dangerous Goods List of the UN Regulations.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "unHazardClassCode" : { + "description" : "The transport class of the dangerous group according to UN Regulations.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.material.chemical_material_passport_2.0.0_FloatQuantityValue" + }, + "unHazardClassName" : { + "description" : "The classified dangerous group in transportation refers to the classification of hazardous materials or dangerous goods according to the United Nations (UN) Globally Harmonized System of Classification and Labelling of Chemicals (GHS) and the UN Model Regulations for the Transport of Dangerous Goods.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "unPackagingGroup" : { + "description" : "Group to which certain substances may be assigned for packaging purposes according to their degree of danger:\nPackaging group I: Substances presenting high danger,\nPackaging group II: Substances presenting medium danger,\nPackaging group III: Substances presenting low danger.\nNot all dangerous goods assigned to hazard classes or their divisions will be allocated to Packaging Groups.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.material.chemical_material_passport_2.0.0_PackagingGroupEnumeration" + }, + "unExceptedQuantityCode" : { + "description" : "Chapter 3.5 of UN Transportation Regulation pertains to dangerous goods packed in excepted quantities, with possible codes including E0, E1, E2, E3, E4, and E5.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.material.chemical_material_passport_2.0.0_QuantityCodeEnumeration" + }, + "environmentallyHazardous" : { + "description" : "The indication of whether a substance or mixture is environmentally hazardous according to the criteria of the UN Model Regulations (as reflected in ADR, RID, and ADN) and whether it is a marine pollutant according to the IMDG Code and the Emergency Response Procedures for Ships Carrying Dangerous Goods.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.material.chemical_material_passport_2.0.0_StringList" + }, + "unSpecialProvisionsCode" : { + "description" : "The UN Special Provisions Code refers to a set of additional requirements or conditions specified by the United Nations for the transportation of certain dangerous goods.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.material.chemical_material_passport_2.0.0_SpecialProvisionsCodeList" + }, + "unLimitedQuantityValue" : { + "description" : "Maximum quantity per inner packaging or article for carrying dangerous goods refers to the maximum amount of a hazardous material permitted for transportation.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.material.chemical_material_passport_2.0.0_FloatQuantityValue" + }, + "unLimitedQuantityUnit" : { + "description" : "Unit of the limited quantity value.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.quantity_2.0.0_ItemUnitEnumeration" + } + }, + "required" : [ "transportRegulation", "unNumber", "unShippingName", "unHazardClassCode", "unHazardClassName", "unPackagingGroup" ] + }, + "urn_samm_io.catenax.material.chemical_material_passport_2.0.0_UNTransportList" : { + "description" : "List of transport related attributes from the UN.", + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/urn_samm_io.catenax.material.chemical_material_passport_2.0.0_UNTransportEntity" + } + }, + "urn_samm_io.catenax.material.chemical_material_passport_2.0.0_TransportCharacteristic" : { + "description" : "Characteristic for transport.", + "type" : "object", + "properties" : { + "productTransport" : { + "description" : "Transport related attributes, which are not UN related.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.material.chemical_material_passport_2.0.0_ProductTransportCharacteristic" + }, + "unTransport" : { + "description" : "Transport related attributes from the UN.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.material.chemical_material_passport_2.0.0_UNTransportList" + } + }, + "required" : [ "productTransport", "unTransport" ] + }, + "urn_samm_io.catenax.material.chemical_material_passport_2.0.0_WasteCodeCharacteristic" : { + "description" : "Characteristic for the waste code of the material.", + "type" : "object", + "properties" : { + "description" : { + "description" : "Description of the related waste code.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "regulation" : { + "description" : "The name of the regulation that applies to waste codes can vary depending on the region or jurisdiction. Examples include Regulation (EC) No 1013/2006 in the European Union or Annex VIII of the Basel Convention.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "code" : { + "description" : "A waste code is used to identify the type of waste.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + } + }, + "required" : [ "description", "regulation", "code" ] + }, + "urn_samm_io.catenax.material.chemical_material_passport_2.0.0_DisposalCharacteristic" : { + "description" : "Characteristic for disposal related attributes.", + "type" : "object", + "properties" : { + "beforeUse" : { + "description" : "Management and disposal practices for chemicals that are no longer needed or deemed unsuitable for their intended purpose. This information can be provided as a document, detailing the properties of waste that render it hazardous, along with disposal and recovery operations or recommendations, and accidental release measures.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentList" + }, + "afterUse" : { + "description" : "Chemical Management and Disposal Guides post-usage as document.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentList" + }, + "wasteCode" : { + "description" : "A waste code is a standardized alphanumeric code used to classify different types of waste according to their characteristics, origin, and potential hazards. These codes help in proper identification, handling, treatment, and disposal of waste materials.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.material.chemical_material_passport_2.0.0_WasteCodeCharacteristic" + }, + "packaging" : { + "description" : "Guidelines and instructions regarding the proper management and disposal of packaging materials after use. Includes instructions on separation, reuse, and recycling.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentList" + } + }, + "required" : [ "beforeUse", "afterUse", "wasteCode", "packaging" ] + }, + "urn_samm_io.catenax.material.chemical_material_passport_2.0.0_EmergencyList" : { + "description" : "List of information on how to proceed in case of an emergency.", + "type" : "object", + "properties" : { + "availability" : { + "description" : "The period of time when emergency phone numbers are available.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "number" : { + "description" : "The phone number in case of an emergency.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + } + }, + "required" : [ "availability", "number" ] + }, + "urn_samm_io.catenax.material.chemical_material_passport_2.0.0_SafetyCharacteristic" : { + "description" : "Characteristic for safety information.", + "type" : "object", + "properties" : { + "documentation" : { + "description" : "Safety information in a document that outlines safety protocols, procedures, and guidelines to be followed in specific situations involving the product. It provides clear instructions on accident prevention, how to respond to emergencies, and mitigate potential hazards. Examples include exposure scenarios, safety data sheets, risk assessments, and information on safety equipment and personal protective equipment (PPE).", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentList" + }, + "emergencyPhone" : { + "description" : "A phone number in case of emergency serves the vital purpose of providing immediate access to emergency responders.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.material.chemical_material_passport_2.0.0_EmergencyList" + }, + "firstAidDocument" : { + "description" : "Information on how to proceed in case of an emergency is essential. It includes guidance on providing initial assistance or immediate care to a person who has been injured before professional medical help arrives.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentList" + } + }, + "required" : [ "documentation", "emergencyPhone", "firstAidDocument" ] + }, + "urn_samm_io.catenax.material.chemical_material_passport_2.0.0_ProductComplianceCountryTrait" : { + "description" : "Regex pattern including all valid ISO 3166 country codes, ensuring a precise match.", + "type" : "array", + "items" : { + "type" : "string" + }, + "pattern" : "\\b(?:A[BDEFGHIJKLMNOQSTUWXZ]|B[ABDEFGHJMNRSVWY]|C[ACDDEFGHIKLMNOPQRSTUVXYZ]|D[EJKMOZ]|E[CEGHRST]|F[IJKMOR]|G[ABDEFGHILMNPQRSTUWY]|H[KMNRTU]|I[DELNOQRST]|J[EMOP]|KE|L[ABCIKRSTUVY]|M[ACDEFGHKLMNOPQRSTUVWXYZ]|N[ACEFGILOPRTUVYZ]|OM|P[AEFGHKLMNRSTWY]|QA|R[EOSUW]|S[ABCDEGHIJKLMNRTUVYZ]|T[CDGHJMNPRW]|U[AGKMSTYZ]|V[ACEGINU]|W[FS]|X[KYZ]|Y[ETU]|Z[AMW])\\b" + }, + "urn_samm_io.catenax.material.chemical_material_passport_2.0.0_ComplianceCharacteristic" : { + "description" : "Characteristic for compliance attributes.", + "type" : "object", + "properties" : { + "complianceCountry" : { + "description" : "The name of the country of compliance denotes the country whose rules and regulations the product must adhere to.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.material.chemical_material_passport_2.0.0_ProductComplianceCountryTrait" + }, + "complianceRegulationName" : { + "description" : "The name of the regulation or standard with which the product must comply can be sourced from Supplier Survey information. This attribute is referenced in ANNEX VI of the Proposal for a REGULATION OF THE EUROPEAN PARLIAMENT AND OF THE COUNCIL on detergents and surfactants, amending Regulation (EU) 2019/1020 and repealing Regulation (EC) No 648/2004:\nThe product passport shall include the following information: [...]\n(e) references to Union legal acts that the detergent or surfactant complies with;", + "$ref" : "#/components/schemas/urn_samm_io.catenax.material.chemical_material_passport_2.0.0_StringList" + }, + "complianceResult" : { + "description" : "The statement indicates whether the product complies with the aforementioned regulations.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Boolean" + }, + "complianceReasonForExemption" : { + "description" : "Data providing details and justifications for an exemption from compliance with certain regulations, standards, or requirements. This information assists regulatory authorities or stakeholders in evaluating the merits of the exemption and making decisions in accordance with legal and regulatory requirements.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.material.chemical_material_passport_2.0.0_StringList" + }, + "complianceRemark" : { + "description" : "If necessary, any remarks that provide relevant information for compliance. Further clarification supplements the compliance information, offering additional context or details to ensure thorough understanding and adherence to regulatory requirements.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + } + }, + "required" : [ "complianceCountry", "complianceRegulationName", "complianceResult" ] + }, + "urn_samm_io.catenax.material.chemical_material_passport_2.0.0_SpecificCharacteristic" : { + "description" : "The Characteristic to describe product specific parameters of the electric drive.", + "type" : "object", + "properties" : { + "parameter" : { + "description" : "Parameters of the chemical material.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.material.chemical_material_passport_2.0.0_ParameterCharacteristic" + }, + "productType" : { + "description" : "Information, whether the product is a substance, mixture or article. Definitions from REACH Regulation (EC) No 1907/2006: \n\"substance\": means a chemical element and its compounds in the natural state or obtained by any manufacturing process, including any additive necessary to preserve its stability and any impurity deriving from the process used, but excluding any solvent which may be separated without affecting the stability of the substance or changing its composition;\n\"mixture\": means a mixture or solution composed of two or more substances;\n\"article\": means an object which during production is given a special shape, surface or design which determines its function to a greater degree than does its chemical composition;", + "$ref" : "#/components/schemas/urn_samm_io.catenax.material.chemical_material_passport_2.0.0_MaterialEnumeration" + }, + "hazardAssessment" : { + "description" : "Hazard assessment refers to evaluating and identifying potential risks or dangers associated with the specific material.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.material.chemical_material_passport_2.0.0_HazardAssessmentCharacteristic" + }, + "transport" : { + "description" : "Transport related information.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.material.chemical_material_passport_2.0.0_TransportCharacteristic" + }, + "disposal" : { + "description" : "The safe and appropriate elimination or management of these materials once they are no longer needed or usable.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.material.chemical_material_passport_2.0.0_DisposalCharacteristic" + }, + "safety" : { + "description" : "Safety related attributes of the chemical material.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.material.chemical_material_passport_2.0.0_SafetyCharacteristic" + }, + "compliance" : { + "description" : "Compliance refers to adhering to relevant regulations, standards, or specifications regarding the testing, documentation, and presentation of parameters, methods, and results. This ensures that the product meets required safety, quality, and regulatory standards throughout its lifecycle, from manufacturing to post-application use.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.material.chemical_material_passport_2.0.0_ComplianceCharacteristic" + } + }, + "required" : [ "parameter", "productType", "hazardAssessment", "transport", "disposal", "safety", "compliance" ] + }, + "urn_samm_io.catenax.serial_part_3.0.0_KeyTrait" : { + "type" : "string", + "description" : "Constraint that ensures that the standard keys and custom key prefixes can be used.", + "pattern" : "^(manufacturerId|partInstanceId|batchId|van|customKey:\\w+)$" + }, + "urn_samm_io.catenax.serial_part_3.0.0_ValueCharacteristic" : { + "type" : "string", + "description" : "The value of an identifier." + }, + "urn_samm_io.catenax.serial_part_3.0.0_KeyValueList" : { + "description" : "A list of key value pairs for local identifiers, which are composed of a key and a corresponding value.", + "type" : "object", + "properties" : { + "key" : { + "description" : "The key of a local identifier. ", + "$ref" : "#/components/schemas/urn_samm_io.catenax.serial_part_3.0.0_KeyTrait" + }, + "value" : { + "description" : "The value of an identifier.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.serial_part_3.0.0_ValueCharacteristic" + } + }, + "required" : [ "key", "value" ] + }, + "urn_samm_io.catenax.serial_part_3.0.0_LocalIdentifierCharacteristic" : { + "description" : "A single serialized part may have multiple attributes, that uniquely identify a that part in a specific dataspace (e.g. the manufacturer`s dataspace)", + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/urn_samm_io.catenax.serial_part_3.0.0_KeyValueList" + }, + "uniqueItems" : true + }, + "urn_samm_io.catenax.batch_3.0.0_KeyTrait" : { + "type" : "string", + "description" : "Constraint that ensures that the predefined keys are used.", + "pattern" : "^(manufacturerId|batchId|customKey:\\w+)$" + }, + "urn_samm_io.catenax.batch_3.0.0_ValueCharacteristic" : { + "type" : "string", + "description" : "The value of an identifier." + }, + "urn_samm_io.catenax.batch_3.0.0_KeyValueList" : { + "description" : "A list of key value pairs for local identifiers, which are composed of a key and a corresponding value.", + "type" : "object", + "properties" : { + "key" : { + "description" : "The key of a local identifier.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.batch_3.0.0_KeyTrait" + }, + "value" : { + "description" : "The value of an identifier.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.batch_3.0.0_ValueCharacteristic" + } + }, + "required" : [ "key", "value" ] + }, + "urn_samm_io.catenax.batch_3.0.0_LocalIdentifierCharacteristic" : { + "description" : "A batch may have multiple attributes, which uniquely identify that batch in a specific dataspace(e.g. the manufacturer`s dataspace)", + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/urn_samm_io.catenax.batch_3.0.0_KeyValueList" + }, + "uniqueItems" : true + }, + "urn_samm_io.catenax.part_type_information_1.0.0_PartIdCharacteristic" : { + "type" : "string", + "description" : "The part ID is a multi-character string, usually assigned by an ERP system." + }, + "urn_samm_io.catenax.part_type_information_1.0.0_PartNameCharacteristic" : { + "type" : "string", + "description" : "Part name in string format from the respective system in the value chain." + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PartTypeCharacteristic" : { + "description" : "Characteristic for the part type.", + "type" : "object", + "properties" : { + "manufacturerPartId" : { + "description" : "Part ID as assigned by the manufacturer of the part. The part ID identifies the part in the manufacturer`s dataspace. The part ID references a specific version of a part. The version number must be included in the part ID if it is available. The part ID does not reference a specific instance of a part and must not be confused with the serial number.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.part_type_information_1.0.0_PartIdCharacteristic" + }, + "nameAtManufacturer" : { + "description" : "Name of the part as assigned by the manufacturer.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.part_type_information_1.0.0_PartNameCharacteristic" + } + }, + "required" : [ "manufacturerPartId", "nameAtManufacturer" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_IdentifierCharacteristic" : { + "type" : "string", + "description" : "Characteristic for Identifiers." + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_CodeEntity" : { + "description" : "Code entity with code key and value.", + "type" : "object", + "properties" : { + "key" : { + "description" : "The code key for the identification of the product. Examples are GTIN, hash, DID, ISBN, TARIC. This attribute is mentioned in the ESPR proposal from March 30th, 2022 ANNEX III:\n(b) the unique product identifier at the level indicated in the applicable delegated act adopted pursuant to Article 4;\n(c) the Global Trade Identification Number as provided for in standard ISO/IEC 15459-6 or equivalent of products or their parts;\n(d) relevant commodity codes, such as a TARIC code as defined in Council Regulation (EEC) No 2658/87.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_IdentifierCharacteristic" + }, + "value" : { + "description" : "The code value for the identification of the product in regard to the chosen code name.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_IdentifierCharacteristic" + } + }, + "required" : [ "key", "value" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_CodeList" : { + "description" : "A list of additional codes.", + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_CodeEntity" + } + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DataCarrierCharacteristic" : { + "description" : "Data Carrier Characteristic for the product.", + "type" : "object", + "properties" : { + "carrierType" : { + "description" : "The type of data carrier such as a QR code on the product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 8:\n(2) (b) the types of data carrier to be used.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "carrierLayout" : { + "description" : "The positioning of data carrier on the product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 8:\n(2) (c) the layout in which the data carrier shall be presented and its positioning.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + } + }, + "required" : [ "carrierType", "carrierLayout" ] + }, + "urn_samm_io.catenax.shared.part_classification_1.0.0_ClassificationStandardCharacteristic" : { + "type" : "string", + "description" : "Identified classification standards that align to the Catena-X needs." + }, + "urn_samm_io.catenax.shared.part_classification_1.0.0_ClassificationIDCharacteristic" : { + "type" : "string", + "description" : "It can be numeric or a string, depending on the chosen classification standard." + }, + "urn_samm_io.catenax.shared.part_classification_1.0.0_ClassificationEntity" : { + "description" : "Encapsulates data related to the classification of the part.", + "type" : "object", + "properties" : { + "classificationStandard" : { + "description" : "Identified classification standards that align to the Catena-X needs.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.part_classification_1.0.0_ClassificationStandardCharacteristic" + }, + "classificationID" : { + "description" : "The classification ID of the part type according to the corresponding standard definition mentioned in the key value pair.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.part_classification_1.0.0_ClassificationIDCharacteristic" + }, + "classificationDescription" : { + "description" : "Optional property describing the classification standard.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + } + }, + "required" : [ "classificationStandard", "classificationID" ] + }, + "urn_samm_io.catenax.shared.part_classification_1.0.0_ClassificationCharacteristic" : { + "description" : "Classification characteristic enabling a set of further properties.", + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.part_classification_1.0.0_ClassificationEntity" + }, + "uniqueItems" : true + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_IdentificationCharacteristic" : { + "description" : "Identification information of the product.", + "type" : "object", + "properties" : { + "serial" : { + "description" : "Identifier for a serial part if available. This is mentioned in the ESPR provisional agreement from January 9th, 2024 Recital (27):\n[...] an 'item' usually means a single unit of a model.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.serial_part_3.0.0_LocalIdentifierCharacteristic" + }, + "batch" : { + "description" : "Identifier for a batch part if available. Identifier for a serial part if available. This is mentioned in the ESPR provisional agreement from January 9th, 2024 Recital (27):\n[...] a 'batch' usually means a subset of a specific model composed of all products produced in a specific manufacturing plant at a specific moment in time [...].", + "$ref" : "#/components/schemas/urn_samm_io.catenax.batch_3.0.0_LocalIdentifierCharacteristic" + }, + "type" : { + "description" : "Identifier on the level of a part model or type. Identifier for a serial part if available. This is mentioned in the ESPR provisional agreement from January 9th, 2024 Recital (27):\n[...] A 'model' usually means a version of a product of which all units share the same technical characteristics relevant for the ecodesign requirements and the same model identifier [...].", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PartTypeCharacteristic" + }, + "codes" : { + "description" : "Codes for identification.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_CodeList" + }, + "dataCarrier" : { + "description" : "The type and layout of the data carrier on the product. These are mentioned in the ESPR proposal from March 30th, 2022 Article 8:\n(b) the types of data carrier to be used;\n(c) the layout in which the data carrier shall be presented and its positioning;\nArticle 2 defines:\n(30) 'data carrier' means a linear bar code symbol, a two-dimensional symbol or other automatic identification data capture medium that can be read by a device.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DataCarrierCharacteristic" + }, + "classification" : { + "description" : "Property describing the classification of a part.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.part_classification_1.0.0_ClassificationCharacteristic" + } + }, + "required" : [ "type", "codes", "dataCarrier", "classification" ] + }, + "urn_samm_io.catenax.shared.business_partner_number_2.0.0_BpnaTrait" : { + "type" : "string", + "description" : "The provided regular expression ensures that the BPNA is composed of prefix 'BPNA', 10 digits and two alphanumeric letters.", + "pattern" : "^BPNA[a-zA-Z0-9]{12}$" + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_FacilityEntity" : { + "description" : "The entity for a facility with the BPNA identifier.", + "type" : "object", + "properties" : { + "facility" : { + "description" : "The identifier used for a location. This attribute is mentioned in the ESPR provisional agreement from January 9th 2024 Annex III:\n(i) unique facility identifiers;\nArticle 2 Definitions: (33) 'unique facility identifier' means a unique string of characters for the identification of locations or buildings involved in the value chain of a product or used by actors involved in the value chain of a product.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.business_partner_number_2.0.0_BpnaTrait" + } + }, + "required" : [ "facility" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_FacilityList" : { + "description" : "List of facilities.", + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_FacilityEntity" + } + }, + "urn_samm_io.catenax.shared.business_partner_number_2.0.0_BpnlTrait" : { + "type" : "string", + "description" : "The provided regular expression ensures that the BPNL is composed of prefix 'BPNL', 10 digits and two alphanumeric letters.", + "pattern" : "^BPNL[a-zA-Z0-9]{12}$" + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DateTrait" : { + "type" : "string", + "description" : "Constraint fo a timestamp in the format (yyyy-mm-dd).", + "pattern" : "^\\d{4}-\\d{2}-\\d{2}$" + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_ManufacturerCharacteristic" : { + "description" : "Manufacturing information.", + "type" : "object", + "properties" : { + "facility" : { + "description" : "The identifier used for a location. In the CATENA-X use case, the BPNA can be stated. This attribute is mentioned in the ESPR provisional agreement from January 9th 2024 Annex III:\n(i) unique facility identifiers;\nArticle 2 Definitions: (33) 'unique facility identifier' means a unique string of characters for the identification of locations or buildings involved in the value chain of a product or used by actors involved in the value chain of a product.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_FacilityList" + }, + "manufacturer" : { + "description" : "The main manufacturer, if different from the passport owner, represented by an identification number. In the Catena-X use case, the BPNL can be stated. This attribute is mentioned in the ESPR provisional agreement from January 9th 2024 Annex III:\n(h) unique operator identifiers other than that of the manufacturer;\n(k) the name, contact details and unique operator identifier code of the economic operator established in the Union responsible for carrying out the tasks set out in Article 4 of Regulation (EU) 2019/1020, or Article 15 of Regulation (EU) [.../...] on general product safety, or similar tasks pursuant to other EU legislation applicable to the product.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.business_partner_number_2.0.0_BpnlTrait" + }, + "manufacturingDate" : { + "description" : "The timestamp in the format (yyyy-mm-dd) of the manufacturing date as the final step in production process (e.g. final quality check, ready-for-shipment event).", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DateTrait" + } + }, + "required" : [ "facility", "manufacturer" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_EoriTrait" : { + "type" : "string", + "description" : "Constraint with a pattern which ensures that the EORI number starts with two alphanumeric characters, followed by two alphabetic characters, and ends with 2 to 15 alphanumeric characters.", + "pattern" : "^[A-Z]{2}[A-Z0-9]{1,18}$" + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_ImporterCharacteristic" : { + "description" : "Characteristic with information regarding the importer.", + "type" : "object", + "properties" : { + "eori" : { + "description" : "An economic operator established in the customs territory of the Union needs, for customs purposes, an EORI number. EORI stands for economic operators registration and identification number. In this case, the importer's EORI must be provided. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Annex III:\n(j) information related to the importer, including the information referred to in Article 23(3) and its EORI number.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_EoriTrait" + }, + "id" : { + "description" : "The importer of the product, if different from the owner of the passport. In the Catena-X network, the BPNL is used for the identification of companies and the information stored for this like contact information and addresses.\nThis attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex III:\n(j) information related to the importer, including the information referred to in Article 23(3) and its EORI number;\nArticle 23 states:\n(3) Importers shall, for products covered by a delegated act adopted pursuant to Article 4, indicate their name, registered trade name or registered trade mark and the postal address and electronic means of communication, where they can be contacted: (a) on the public part of the product passport, when applicable, and\n(b) on the product or, where this is not possible, on the packaging, or in a document accompanying the product.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.business_partner_number_2.0.0_BpnlTrait" + } + }, + "required" : [ "eori", "id" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_ImportCharacteristic" : { + "description" : "Import Characteristic for the product.", + "type" : "object", + "properties" : { + "content" : { + "description" : "Information regarding the importer of the product, if different from the owner of the passport. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex III:\n(j) information related to the importer, including the information referred to in Article 23(3) and its EORI number;\nArticle 23 states:\n(3) Importers shall, for products covered by a delegated act adopted pursuant to Article 4, indicate their name, registered trade name or registered trade mark and the postal address and electronic means of communication, where they can be contacted: (a) on the public part of the product passport, when applicable, and\n(b) on the product or, where this is not possible, on the packaging, or in a document accompanying the product.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_ImporterCharacteristic" + }, + "applicable" : { + "description" : "Check whether the connected attributes are applicable to the product. If it is not applicable (false), dummy data can be delivered.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Boolean" + } + }, + "required" : [ "content", "applicable" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_OperatorCharacteristic" : { + "description" : "Other operators characteristic.", + "type" : "object", + "properties" : { + "id" : { + "description" : "Identifier of the other operator. This can be a BPN.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "role" : { + "description" : "Role of the other operator.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + } + }, + "required" : [ "id", "role" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_OperationCharacteristic" : { + "description" : "Operational information of the product.", + "type" : "object", + "properties" : { + "manufacturer" : { + "description" : "Manufacturing information of the product. In the CATENA-X use case, the BPNL and BPNA can be stated. These attributes are mentioned in the ESPR provisional agreement from January 9th 2024 Annex III:\n(h) unique operator identifiers other than that of the manufacturer;\n(k) the name, contact details and unique operator identifier code of the economic operator established in the Union responsible for carrying out the tasks set out in Article 4 of Regulation (EU) 2019/1020, or Article 15 of Regulation (EU) [.../...] on general product safety, or similar tasks pursuant to other EU legislation applicable to the product.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_ManufacturerCharacteristic" + }, + "import" : { + "description" : "Importer details such as the identification.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_ImportCharacteristic" + }, + "other" : { + "description" : "Other operators relevant for the product.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_OperatorCharacteristic" + } + }, + "required" : [ "manufacturer", "import" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_LifeEnumeration" : { + "type" : "string", + "description" : "Enumeration with the possible units day, month, cycle, year and runningOrOperatingHour.", + "enum" : [ "unit:day", "unit:month", "unit:year", "unit:cycle", "unit:runningOrOperatingHour" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_LifeValueCharacteristic" : { + "type" : "number", + "description" : "Characteristic for the life span value as an integer." + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_LifeTypeEnumeration" : { + "type" : "string", + "description" : "Enumeration with the values guaranteed lifetime, technical lifetime and mean time between failures.", + "enum" : [ "guaranteed lifetime", "technical lifetime", "mean time between failures" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_LifespanEntity" : { + "description" : "Entity for the lifespan of a product with type, unit and value.", + "type" : "object", + "properties" : { + "unit" : { + "description" : "The unit of the respective lifespan expressed through the possible units day, month, cycle, year and runningOrOperatingHour.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_LifeEnumeration" + }, + "value" : { + "description" : "The value as an integer for the respective lifespan.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_LifeValueCharacteristic" + }, + "key" : { + "description" : "The type of lifespan represented with the values guaranteed lifetime, technical lifetime and mean time between failures. This attribute is mentioned in the ESPR proposal from March 30th, 2022 ANNEX I:\n(a) durability and reliability of the product or its components as expressed through the product's guaranteed lifetime, technical lifetime [or] mean time between failures [...].", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_LifeTypeEnumeration" + } + }, + "required" : [ "unit", "value", "key" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_LifespanList" : { + "description" : "List of different life spans of a product.", + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_LifespanEntity" + } + }, + "urn_samm_io.catenax.shared.quantity_2.0.0_QuantityValueCharacteristic" : { + "type" : "number", + "description" : "The quantity value associated with the unit expressed as float." + }, + "urn_samm_io.catenax.shared.quantity_2.0.0_LinearUnitEnumeration" : { + "type" : "string", + "pattern" : "[a-zA-Z]*:[a-zA-Z]+", + "description" : "The unit of a linear attribute that may be used for height, width, length and diameter.", + "enum" : [ "unit:millimetre", "unit:centimetre", "unit:metre", "unit:kilometre", "unit:inch", "unit:foot", "unit:yard" ] + }, + "urn_samm_io.catenax.shared.quantity_2.0.0_LinearCharacteristic" : { + "description" : "Characteristic for linear measurements of an item.", + "type" : "object", + "properties" : { + "value" : { + "description" : "The quantity value associated with the unit.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.quantity_2.0.0_QuantityValueCharacteristic" + }, + "unit" : { + "description" : "The unit of a linear attribute.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.quantity_2.0.0_LinearUnitEnumeration" + } + }, + "required" : [ "value", "unit" ] + }, + "urn_samm_io.catenax.shared.quantity_2.0.0_MassUnitEnumeration" : { + "type" : "string", + "pattern" : "[a-zA-Z]*:[a-zA-Z]+", + "description" : "Enumeration for mass units.", + "enum" : [ "unit:gram", "unit:kilogram", "unit:tonneMetricTon", "unit:tonUsOrShortTonUkorus", "unit:ounceAvoirdupois", "unit:pound" ] + }, + "urn_samm_io.catenax.shared.quantity_2.0.0_MassCharacteristic" : { + "description" : "Characteristic for mass measurements of an item.", + "type" : "object", + "properties" : { + "value" : { + "description" : "The quantity value associated with the unit.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.quantity_2.0.0_QuantityValueCharacteristic" + }, + "unit" : { + "description" : "The unit of a mass related attribute.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.quantity_2.0.0_MassUnitEnumeration" + } + }, + "required" : [ "value", "unit" ] + }, + "urn_samm_io.catenax.shared.quantity_2.0.0_VolumeUnitEnumeration" : { + "type" : "string", + "pattern" : "[a-zA-Z]*:[a-zA-Z]+", + "description" : "Enumeration for volume units.", + "enum" : [ "unit:cubicMetre", "unit:litre", "unit:millilitre", "unit:cubicCentimetre", "unit:cubicInch", "unit:cubicFoot", "unit:cubicYard", "unit:hectolitre" ] + }, + "urn_samm_io.catenax.shared.quantity_2.0.0_VolumeCharacteristic" : { + "description" : "Characteristic for volume measurements of an item.", + "type" : "object", + "properties" : { + "value" : { + "description" : "The quantity value associated with the unit.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.quantity_2.0.0_QuantityValueCharacteristic" + }, + "unit" : { + "description" : "The unit of a volume related attribute.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.quantity_2.0.0_VolumeUnitEnumeration" + } + }, + "required" : [ "value", "unit" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PhysicalDimensionCharacteristic" : { + "description" : "Characteristic for physical dimensions with linear, mass and capacity attributes.", + "type" : "object", + "properties" : { + "width" : { + "description" : "The width of the item measured in a specific linear unit which can be declared in the corresponding unit attribute.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.quantity_2.0.0_LinearCharacteristic" + }, + "length" : { + "description" : "The length of the item measured in a specific linear unit which can be declared in the corresponding unit attribute.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.quantity_2.0.0_LinearCharacteristic" + }, + "diameter" : { + "description" : "The diameter of the item, if applicable, measured in a specific linear unit which can be declared in the corresponding unit attribute.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.quantity_2.0.0_LinearCharacteristic" + }, + "height" : { + "description" : "The height of the item measured in a specific linear unit which can be declared in the corresponding unit attribute.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.quantity_2.0.0_LinearCharacteristic" + }, + "grossWeight" : { + "description" : "The gross weight of the item measured in a specific mass unit which can be declared in the corresponding unit attribute. Gross weight refers to the total weight of a product, including the weight of the packaging. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7:\n(2) (b) (i) information on the performance of the product in relation to the product parameters referred to in Annex I;\nAnnex I (i) weight and volume of the product and its packaging, and the product-to-packaging ratio.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.quantity_2.0.0_MassCharacteristic" + }, + "grossVolume" : { + "description" : "The gross volume of the item, if possible, measured in a specific capacity unit which can be declared in the corresponding unit attribute. If there is no separate packing, the volume of the product shall be given. Gross volume refers to the total volume of a product, including the volume of the packaging. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7:\n(2) (b) (i) information on the performance of the product in relation to the product parameters referred to in Annex I;\nAnnex I (i) weight and volume of the product and its packaging, and the product-to-packaging ratio.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.quantity_2.0.0_VolumeCharacteristic" + }, + "weight" : { + "description" : "Weight of the product measured in a specific mass unit which can be declared in the corresponding unit attribute. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7:\n(2) (b) (i) information on the performance of the product in relation to the product parameters referred to in Annex I;\nAnnex I (i) weight and volume of the product [...].", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.quantity_2.0.0_MassCharacteristic" + }, + "volume" : { + "description" : "Volume of the product, if possible, measured in a specific capacity unit which can be declared in the corresponding unit attribute. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7:\n(2) (b) (i) information on the performance of the product in relation to the product parameters referred to in Annex I;\nAnnex I (i) weight and volume of the product [...].", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.quantity_2.0.0_VolumeCharacteristic" + } + }, + "required" : [ "grossWeight", "grossVolume", "weight", "volume" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PhysicalStateEnumeration" : { + "type" : "string", + "description" : "Enumeration with the values solid, liquid, gas and plasma.", + "enum" : [ "solid", "liquid", "gas", "plasma" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_ProductCharacteristics" : { + "description" : "Defines a set of specific characteristics of a product.", + "type" : "object", + "properties" : { + "lifespan" : { + "description" : "The type of lifespan represented with the values guaranteed lifetime, technical lifetime and mean time between failures. Both can be described through the attributes: type, which defines the type such as guaranteed lifetime or technical lifetime, the unit for the lifetime, and the value represented by an integer. These attributes are mentioned in the ESPR proposal from March 30th, 2022 ANNEX I:\n(a) durability and reliability of the product or its components as expressed through the products guaranteed lifetime, technical lifetime [or] mean time between failures [...].", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_LifespanList" + }, + "physicalDimension" : { + "description" : "Physical dimensions are properties associated with physical quantities for purposes of classification or differentiation. These attributes are mentioned in the ESPR provisional agreement from January 9th, Article 7:\n(2) (b) (i) information on the performance of the product in relation to one or more of the product parameters referred to in Annex I;\nAnnex I (i) weight and volume of the product and its packaging, and the product-to-packaging ratio.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PhysicalDimensionCharacteristic" + }, + "physicalState" : { + "description" : "The physical state of the item. There are four states of matter solid, liquid, gas and plasma which can be chosen from an enumeration.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PhysicalStateEnumeration" + }, + "generalPerformanceClass" : { + "description" : "The performance class of the product. This attribute is mentioned ESPR provisional agreement from January 9th, 2024 Article 7:\n4. When establishing the information requirements referred to in paragraph 2, point (b), point (i), the Commission shall, as appropriate in view of the specificity of the product group, determine classes of performance. Classes of performance may be based on single parameters, on aggregated scores, in absolute terms or in any other form that enables potential customers to choose the best performing products. Those classes of performance shall correspond to significant improvements in performance levels. Where classes of performance are based on parameters in relation to which performance requirements are established, they shall use as the minimum level the minimum performance required at the time when the classes of performance start to apply.\nDefinition:\n'class of performance': means a range of performance levels in relation to one or more product parameters referred to in Annex I, based on a common methodology for the product or product group, ordered into successive steps to allow for product differentiation.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + } + }, + "required" : [ "lifespan", "physicalDimension" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_StringList" : { + "description" : "List of strings.", + "type" : "array", + "items" : { + "type" : "string" + } + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_CommercialCharacteristic" : { + "description" : "Commercial information of the product.", + "type" : "object", + "properties" : { + "placedOnMarket" : { + "description" : "The timestamp in the format (yyyy-mm-dd) with or without time zone when the product was put in the market.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DateTrait" + }, + "purpose" : { + "description" : "One or more intended industry/industries of the product described by the digital product passport. If exchanged via Catena-X, 'automotive ' is a must choice included in the list.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_StringList" + } + }, + "required" : [ "purpose" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_ConcentrationEnumeration" : { + "type" : "string", + "description" : "Enumeration of possible units of concentration with percent, volume percent, parts per thousand, parts per million, parts per billion and parts per trillion.", + "enum" : [ "unit:partPerMillion", "unit:percent", "unit:percentVolume", "unit:partPerThousand", "unit:partPerTrillionUs", "unit:partPerBillionUs" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PositiveTrait" : { + "type" : "number", + "description" : "Constraint for only positive values.", + "minimum" : 0.0, + "exclusiveMinimum" : false + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_HazardCharacteristic" : { + "description" : "Characteristic for the hazardous classification.", + "type" : "object", + "properties" : { + "category" : { + "description" : "The hazard category of the substance of concern. Defined in Article 2 of Regulation (EC) No 1272/2008 of the European Parliament and of the Council of 16 December 2008 on classification, labelling and packaging of substances and mixtures, amending and repealing Directives 67/548/EEC and 1999/45/EC, and amending Regulation (EC) No 1907/2006:\n2. 'hazard category' means the division of criteria within each hazard class, specifying hazard severity.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "class" : { + "description" : "The hazard class of the substance of concern. Defined in Article 2 of Regulation (EC) No 1272/2008 of the European Parliament and of the Council of 16 December 2008 on classification, labelling and packaging of substances and mixtures, amending and repealing Directives 67/548/EEC and 1999/45/EC, and amending Regulation (EC) No 1907/2006:\n1. 'hazard class' means the nature of the physical, health or environmental hazard.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "statement" : { + "description" : "The hazard statement of the substance of concern. Defined in Article 2 of Regulation (EC) No 1272/2008 of the European Parliament and of the Council of 16 December 2008 on classification, labelling and packaging of substances and mixtures, amending and repealing Directives 67/548/EEC and 1999/45/EC, and amending Regulation (EC) No 1907/2006:\n5. 'hazard statement' means a phrase assigned to a hazard class and category that describes the nature of the hazards of a hazardous substance or mixture, including, where appropriate, the degree of hazard.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + } + }, + "required" : [ "category", "class", "statement" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_RangeEntity" : { + "description" : "Entity for the concentration range with two values, the highest and the lowest of the concentration range.", + "type" : "object", + "properties" : { + "min" : { + "description" : "The minimum concentration of the substance of concern at the level of the product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7:\n(5) (c) [...] concentration range of the substances of concern, at the level of the product [...].", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PositiveTrait" + }, + "max" : { + "description" : "The maximum concentration of the substance of concern at the level of the product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7:\n(5) (c) the concentration, maximum concentration or concentration range of the substances of concern, at the level of the product [...].", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PositiveTrait" + } + }, + "required" : [ "max" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_RangeCharacteristic" : { + "description" : "Range characteristic with two values, the highest and the lowest of the concentration range. Only providing the maximum range is also possible.", + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_RangeEntity" + } + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_ListTypeEnumerationId" : { + "type" : "string", + "description" : "Enumeration of different systems and organizations related to the identification and classification of chemical substances in the field of chemistry. The enumeration values are EC or CAS.", + "enum" : [ "CAS", "EC", "IUPAC" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_MaterialIdEntity" : { + "description" : "Id Entity with identifier, name and list type.", + "type" : "object", + "properties" : { + "id" : { + "description" : "The substance identification, in accordance with the specification in the attribute for the list type.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_IdentifierCharacteristic" + }, + "type" : { + "description" : "The type of standard used for the identification of the substances. Selected can be for example CAS, IUPAC or EC.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_ListTypeEnumerationId" + }, + "name" : { + "description" : "The name of the material which is present in the product.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + } + }, + "required" : [ "id", "type", "name" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_MaterialIdList" : { + "description" : "List of ids for the identification.", + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_MaterialIdEntity" + } + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_SubstanceEntity" : { + "description" : "Information regarding substances of concern in the product.", + "type" : "object", + "properties" : { + "location" : { + "description" : "The location of the substances of concern within the product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7:\n(5) (b) the location of the substances of concern within the product.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "unit" : { + "description" : "The unit of concentration chosen from an enumeration: mass percent, volume percent, parts per thousand, parts per million, parts per billion and parts per trillion.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_ConcentrationEnumeration" + }, + "concentration" : { + "description" : "Concentration of the material at the level of the product. This attribute is specially mentioned for substances of concern mentioned in the ESPR proposal from March 30th, 2022 Article 7:\n(5) (c) the concentration, maximum concentration or concentration range of the substances of concern, at the level of the product [...].\nOther substances are mentioned for the purpose of recycling in the ESPR provisional agreement from January 9th, 2024 Annex I:\n(d) design for recycling, ease and quality of recycling as expressed through: use of easily recyclable materials, safe, easy and non-destructive access to recyclable components and materials or components and materials containing hazardous substances and material composition and homogeneity, possibility for high-purity sorting, number of materials and components used, use of standard components, use of component and material coding standards for the identification of components and materials, number and complexity of processes and tools needed, ease of nondestructive disassembly and re-assembly, conditions for access to product data, conditions for access to or use of hardware and software needed.\n", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PositiveTrait" + }, + "exemption" : { + "description" : "Exemptions to the substance of concern. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Article 7:\n(5) (c) provide duly justified exemptions for substances of concern or information elements from the information requirements referred to in the first subparagraph based on the technical feasibility or relevance of tracking substances of concern, the existence of analytical methods to detect and quantify them, the need to protect confidential business information or in other duly justified cases. Substances of concern within the meaning of Article 2(28), point a), shall not be exempted if they are present in products, their relevant components or spare parts in a concentration above 0,1 % weight by weight.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "hazardClassification" : { + "description" : "The specification of the hazard class. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I:\n(f) use of substances, and in particular the use of substances of concern, on their own, as constituents of substances or in mixtures, during the production process of products, or leading to their presence in products, including once these products become waste, and their impacts on human health and the environment;\nFurther defined is this by Regulation (EC) No 1272/2008 of the European Parliament and of the Council of 16 December 2008 on classification, labelling and packaging of substances and mixtures, amending and repealing Directives 67/548/EEC and 1999/45/EC, and amending Regulation (EC) No 1907/2006.\nDefined in Article 2:\n1. 'hazard class' means the nature of the physical, health or environmental hazard;\n2. 'hazard category' means the division of criteria within each hazard class, specifying hazard severity;\n5. 'hazard statement' means a phrase assigned to a hazard class and category that describes the nature of the hazards of a hazardous substance or mixture, including, where appropriate, the degree of hazard;", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_HazardCharacteristic" + }, + "concentrationRange" : { + "description" : "The concentration range for the substance of concern. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7:\n(5) (c) [...] concentration range of the substances of concern, at the level of the product [...].", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_RangeCharacteristic" + }, + "id" : { + "description" : "The chemical material name and identification, in accordance with the specification in the attribute for the list type. Preference is given to the IUPAC name. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Article 7:\n(5) (a) the name of the substances of concern present in the product, as follows:\n - name(s) in the International Union of Pure and Applied Chemistry (IUPAC) nomenclature, or another international name when IUPAC name is not available; \n- other names (usual name, trade name, abbreviation);\n- European Community (EC) number, as indicated in the European Inventory of Existing Commercial Chemical Substances (EINECS), the European List of Notified Chemical Substances (ELINCS) or the No Longer Polymer (NLP) list or assigned by the European Chemicals Agency (ECHA), if available;\n- the Chemical Abstract Service (CAS) name(s) and number(s), if available; .", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_MaterialIdList" + }, + "documentation" : { + "description" : "Documentation accompanying the material.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentList" + } + }, + "required" : [ "location", "unit", "concentration", "exemption", "hazardClassification", "concentrationRange", "id", "documentation" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_SubstanceList" : { + "description" : "Characteristic for a list of substances of concern.", + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_SubstanceEntity" + } + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_SubstanceOfConcernCharacteristic" : { + "description" : "Substance of concern Characteristic of the product.", + "type" : "object", + "properties" : { + "applicable" : { + "description" : "Check whether the connected attributes are applicable to the product. If it is not applicable (false), dummy data can be delivered.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Boolean" + }, + "content" : { + "description" : "Information regarding substances of concern in the product. Attributes are among others substance names, ids, concentration, location and hazard class. This is mentioned in the ESPR provisional agreement from January 9th, 2024 Article 7:\n(5) (a) the name of the substances of concern present in the product, as follows:\n- name(s) in the International Union of Pure and Applied Chemistry (IUPAC) nomenclature, or another international name when IUPAC name is not available; \n- other names (usual name, trade name, abbreviation);\n- European Community (EC) number, as indicated in the European Inventory of Existing Commercial Chemical Substances (EINECS), the European List of Notified Chemical Substances (ELINCS) or the No Longer Polymer (NLP) list or assigned by the European Chemicals Agency (ECHA), if available;\n- the Chemical Abstract Service (CAS) name(s) and number(s), if available;\n(5) (b) the location of the substances of concern within the product.\n(5) (c) the concentration, maximum concentration or concentration range of the substances of concern, at the level of the product its relevant components, or spare parts;\n(d) relevant instructions for the safe use of the product;\n(e) information relevant for disassembly, preparation for reuse, reuse, recycling and the environmentally sound management of the product at the end of its life.\nAnd in the next paragraph:\n(c) provide duly justified exemptions for substances of concern or information elements from the information requirements referred to in the first subparagraph.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_SubstanceList" + } + }, + "required" : [ "applicable", "content" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PercentageTrait" : { + "type" : "number", + "description" : "Range constraint for a positive percentage value.", + "maximum" : 100.0, + "exclusiveMaximum" : false, + "minimum" : 0.0, + "exclusiveMinimum" : false + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_MaterialEntity" : { + "description" : "Information regarding recycled and/or renewable materials in the product.", + "type" : "object", + "properties" : { + "recycled" : { + "description" : "The share of the material, which is recovered recycled content from the product. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I:\n(h) use or content of recycled materials and recovery of materials, including critical raw materials;", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PercentageTrait" + }, + "renewable" : { + "description" : "The share of the material, which is from a renewable resource that can be replenished. Renewable resources are those that can be reproduced by physical, chemical, or mechanical processes. These are the kind of resources that can be regenerated throughout time. Forest wood, for example, can be grown through reforestation. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I:\n(ha) use or content of sustainable renewable materials;\n", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PercentageTrait" + }, + "unit" : { + "description" : "The unit of concentration chosen from an enumeration: mass percent, volume percent, parts per thousand, parts per million, parts per billion and parts per trillion.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_ConcentrationEnumeration" + }, + "id" : { + "description" : "The chemical material name and identification, in accordance with the specification in the attribute for the list type. Preference is given to the IUPAC name. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Article 7:\n(5) (a) the name of the substances of concern present in the product, as follows:\n - name(s) in the International Union of Pure and Applied Chemistry (IUPAC) nomenclature, or another international name when IUPAC name is not available; \n- other names (usual name, trade name, abbreviation);\n- European Community (EC) number, as indicated in the European Inventory of Existing Commercial Chemical Substances (EINECS), the European List of Notified Chemical Substances (ELINCS) or the No Longer Polymer (NLP) list or assigned by the European Chemicals Agency (ECHA), if available;\n- the Chemical Abstract Service (CAS) name(s) and number(s), if available; .", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_MaterialIdList" + }, + "critical" : { + "description" : "A flag, if the material is a critical raw material. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I:\n(h) use or content of recycled materials and recovery of materials, including critical raw materials;\nIn Annex II of the connected proposal Act of Critical Raw Materials, a list of critical raw materials can be found.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Boolean" + }, + "concentration" : { + "description" : "Concentration of the material at the level of the product. This attribute is specially mentioned for substances of concern mentioned in the ESPR proposal from March 30th, 2022 Article 7:\n(5) (c) the concentration, maximum concentration or concentration range of the substances of concern, at the level of the product [...].\nOther substances are mentioned for the purpose of recycling in the ESPR provisional agreement from January 9th, 2024 Annex I:\n(d) design for recycling, ease and quality of recycling as expressed through: use of easily recyclable materials, safe, easy and non-destructive access to recyclable components and materials or components and materials containing hazardous substances and material composition and homogeneity, possibility for high-purity sorting, number of materials and components used, use of standard components, use of component and material coding standards for the identification of components and materials, number and complexity of processes and tools needed, ease of nondestructive disassembly and re-assembly, conditions for access to product data, conditions for access to or use of hardware and software needed.\n", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PositiveTrait" + }, + "documentation" : { + "description" : "Documentation accompanying the material.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentList" + } + }, + "required" : [ "recycled", "renewable", "unit", "id", "critical", "concentration", "documentation" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_MaterialList" : { + "description" : "A list of different materials in the product.", + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_MaterialEntity" + } + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_MaterialCharacteristic" : { + "description" : "Material Characteristic with information on the materials.", + "type" : "object", + "properties" : { + "applicable" : { + "description" : "Check whether the connected attributes are applicable to the product. If it is not applicable (false), dummy data can be delivered.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Boolean" + }, + "content" : { + "description" : "Information on different materials in the product.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_MaterialList" + } + }, + "required" : [ "applicable", "content" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_MaterialsCharacteristic" : { + "description" : "Materials Characteristic on product level.", + "type" : "object", + "properties" : { + "substancesOfConcern" : { + "description" : "Information regarding substances of concern in the product. The ESPR provisional agreement from January 9th, 2024 defines:\n(52) 'hazardous substance' means a substance classified as hazardous pursuant to Article 3 of Regulation (EC) No 1272/2008.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_SubstanceOfConcernCharacteristic" + }, + "materialComposition" : { + "description" : "Material composition of the product with information on recycled and renewable materials.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_MaterialCharacteristic" + } + }, + "required" : [ "substancesOfConcern", "materialComposition" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_SourceCategoryEnumeration" : { + "type" : "string", + "description" : "The types of sources that can be linked in a digital product passport can vary depending on the nature of the product and the information that needs to be included. This is an enumeration of possible sources.", + "enum" : [ "Product Specifications", "Manufacturer Information", "User Manuals and Guides", "Certifications and Compliance", "Product Images and Videos", "Warranty Information", "Reviews and Ratings", "Product Variations", "Supply Chain Information", "Environmental Impact", "Compatibility and Accessories", "FAQs and Support", "Purchase and Retail Information", "Privacy and Data Handling", "Third-Party Integrations", "Legal Information", "Safety Information", "Repair and Installation", "Waste Generation and Prevention", "Specific Voluntary Labels", "Product Packaging", "Return and Disposal", "End of Life", "Material and Substance Information", "Technical Documentation", "Treatment facilities", "Other" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentEntity" : { + "description" : "Document entity with header, content, category and type.", + "type" : "object", + "properties" : { + "content" : { + "description" : "The content of the document e.g a link.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "category" : { + "description" : "The category in which the document can be sorted. These are mentioned in the ESPR proposal from March 30th, 2022 ANNEX III:\n(e) compliance documentation and information required under this Regulation or other Union law applicable to the product, such as the declaration of conformity, technical documentation or conformity certificates;\nANNEX IV states additional information regarding the content of the technical documentation\nFurther information on documents are mentioned in the proposal from March 30th, 2022 ANNEX III:\n(f) user manuals, instructions, warnings or safety information, as required by other Union legislation applicable to the product.\nAdditionally requirements are mentioned in Article 21:\n(7) Manufacturers shall ensure that that a product covered by a delegated act adopted pursuant to Article 4 is accompanied by instructions that enable consumers and other end-users to safely assemble, install, operate, store, maintain, repair and dispose of the product in a language that can be easily understood by consumers and other end-users, as determined by the Member State concerned. Such instructions shall be clear, understandable and legible and include at least the information specified in the delegated acts adopted pursuant to Article 4 and pursuant to Article 7(2)(b), point (ii).\nArticle 7 states additionally:\n(2) (b) (ii) information for consumers and other end-users on how to install, use, maintain and repair the product in order to minimize its impact on the environment and to ensure optimum durability, as well as on how to return or dispose of the product at end-of-life;\n(2) (b) (iii) information for treatment facilities on disassembly, recycling, or disposal at end-of-life;\n(2) (b) (iv) other information that may influence the way the product is handled by parties other than the manufacturer in order to improve performance in relation to product parameters referred to in Annex I.\n(5) (d) relevant instructions for the safe use of the product.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_SourceCategoryEnumeration" + }, + "type" : { + "description" : "The type of content which can be expected in the \"content\" property. Examples are a link, restricted link, pdf, excel, etc.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "header" : { + "description" : "The header as a short description of the document with a maximum of 100 characters.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_HeaderTrait" + } + }, + "required" : [ "content", "category", "type", "header" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_SourceList" : { + "description" : "A list of documents.", + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentEntity" + } + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_StateEnumeration" : { + "type" : "string", + "description" : "Enumeration defined as original, repurposed, re-used, remanufactured or waste.", + "enum" : [ "original", "repurposed", "re-used", "remanufactured", "waste" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_CategoryEnumeration" : { + "type" : "string", + "description" : "Enumeration of the 19 impact categories in accordance to EN15804+A2.", + "enum" : [ "Climate Change Total", "Climate Change Fossil", "Climate Change Biogenic Removals and Emissions", "Climate Change Land Use and Land Use Change", "Ozone Depletion", "Acidification", "Eutrophication Aquatic Freshwater", "Eutrophication Fresh Marine", "Eutrophication Terrestrial", "Photochemical Ozone Formation", "Abiotic Depletion- Minerals and Metals", "Fossil Fuels", "Water Use", "Particulate Matter Emissions", "Ionizing Radiation, Human Health", "Eco-Toxicity", "Human Toxicity, Cancer Effects", "Human Toxicity, Non-Cancer Effects", "Land Use Related Impacts/Soil Quality" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_FootprintEntity" : { + "description" : "Footprint Entity for the carbon and environmental footprint with the total value, unit, impact category type, lifecycle, rulebook, declaration, performance class and the facility.", + "type" : "object", + "properties" : { + "value" : { + "description" : "The value of the footprint of the product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Annex I:\n(l) the environmental footprint of the product, expressed as a quantification, in accordance with the applicable delegated act, of a product's life cycle environmental impacts, whether in relation to one or more environmental impact categories or an aggregated set of impact categories;\n(m) the carbon footprint of the product;\n(ma) the material footprint of the product.\n", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PositiveTrait" + }, + "rulebook" : { + "description" : "The applied rulebook for the environmental footprint of the product.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentList" + }, + "lifecycle" : { + "description" : "The lifecycle stage, to which the environmental footprint corresponds. These could be for example \"raw material acquisition and pre-processing\", \"main product production\", \"distribution\" or \"end of life and recycling\".", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "unit" : { + "description" : "The unit of measurement of the environmental impact category. For each impact category a specific unit is used. If an aggregation is used, utilize the normalization and weighting methods used in the referenced rulebook.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "type" : { + "description" : "The type of the environmental footprint of the product. This could be one of the environmental impact categories. This attribute is mentioned in the ESPR provisional agreement from January 9th 2024 Article 7:\n(2)(b)(i) information on the performance of the product in relation to one or more of the product parameters referred to in Annex I, including a scoring of reparability or durability, carbon footprint or environmental footprint;\nAnnex I:\n(l) the environmental footprint of the product, expressed as a quantification, in accordance with the applicable delegated act, of a product's life cycle environmental impacts, whether in relation to one or more environmental impact categories or an aggregated set of impact categories.\n(m) the carbon footprint of the product;\n(ma) the material footprint of the product.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_CategoryEnumeration" + }, + "performanceClass" : { + "description" : "The performance classification of the footprint.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "manufacturingPlant" : { + "description" : "The manufacturing plant of the footprint in the specific lifecycle phase.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_FacilityList" + }, + "declaration" : { + "description" : "The footprint declaration in the format of a link ", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentList" + } + }, + "required" : [ "value", "rulebook", "lifecycle", "unit", "type", "manufacturingPlant", "declaration" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_FootprintList" : { + "description" : "Footprint List for the environmental footprint.", + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_FootprintEntity" + } + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_ProductFootprintCharacteristic" : { + "description" : "The Product Footprint Characteristic with sustainability information.", + "type" : "object", + "properties" : { + "environmental" : { + "description" : "The environmental footprint of the product. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I:\nThe following parameters shall, as appropriate, and where necessary supplemented by others, be used, individually or combined, as a basis for improving the product aspects referred to in Article 5(1):\n(l) the environmental footprint of the product, expressed as a quantification, in accordance with the applicable delegated act, of a product's life cycle environmental impacts, whether in relation to one or more environmental impact categories or an aggregated set of impact categories.\nand Article 7:\n(2)(b)(i) information on the performance of the product in relation to one or more of the product parameters referred to in Annex I, including a scoring of reparability or durability, carbon footprint or environmental footprint;\nand defined by Article 2:\n(23) 'environmental footprint' means a quantification of product environmental impacts throughout its life cycle, whether in relation to a single environmental impact category or an aggregated set of impact categories based on the Product Environmental Footprint method or other scientific methods developed by international organisations and widely tested in collaboration with different industry sectors and adopted or implemented by the Commission in other Union legislation;\n(24) 'Product Environmental Footprint method' means the life cycle assessment method to quantify the environmental impacts of products established by Recommendation (EU) 2021/2279.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_FootprintList" + }, + "carbon" : { + "description" : "The carbon footprint of the product. This is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I:\nThe following parameters shall, as appropriate, and where necessary supplemented by others, be used, individually or combined, as a basis for improving the product aspects referred to in Article 5(1):\n(m) the carbon footprint of the product;\nand Article 7:\n(2)(b)(i) information on the performance of the product in relation to one or more of the product parameters referred to in Annex I, including a scoring of reparability or durability, carbon footprint or environmental footprint;\nand defined by Article 2:\n(25) 'carbon footprint' means the sum of greenhouse gas (GHG) emissions and GHG removals in a product system, expressed as CO2 equivalents and based on a life cycle assessment using the single impact category of climate change.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_FootprintList" + }, + "material" : { + "description" : "The material footprint of the product. This is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I:\n(ma) the material footprint of the product;\nand defined by Article 2:\n(25a) 'material footprint' refers to the total amount of raw materials extracted to meet final consumption demands.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_FootprintList" + } + }, + "required" : [ "carbon" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_SustainabilityCharacteristic" : { + "description" : "Characteristic which describes relevant information for the sustainability of the product.", + "type" : "object", + "properties" : { + "status" : { + "description" : "The status of the product (original, repurposed, re-used, remanufactured or waste) to indicated, whether it is a used product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Annex I:\n(j) incorporation of used components.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_StateEnumeration" + }, + "productFootprint" : { + "description" : "The carbon and environmental footprint or material footprint of the product. These attributes are mentioned in the ESPR provisional agreement from January 9th 2024 Annex I:\n(l) the environmental footprint of the product, expressed as a quantification, in accordance with the applicable delegated act, of a product's life cycle environmental impacts, whether in relation to one or more environmental impact categories or an aggregated set of impact categories;\n(m) the carbon footprint of the product;\n(ma) the material footprint of the product;\nAll are defined by Article 2:\n(23) 'environmental footprint' means a quantification of product environmental impacts throughout its life cycle, whether in relation to a single environmental impact category or an aggregated set of impact categories based on the Product Environmental Footprint method or other scientific methods developed by international organisations and widely tested in collaboration with different industry sectors and adopted or implemented by the Commission in other Union \nlegislation;\n(25) 'carbon footprint' means the sum of greenhouse gas (GHG) emissions and GHG removals in a product system, expressed as CO2 equivalents and based on a life cycle assessment using the single impact category of climate change.\n(25a) 'material footprint' refers to the total amount of raw materials extracted to meet final consumption demands;", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_ProductFootprintCharacteristic" + }, + "reparabilityScore" : { + "description" : "The reparability score. This attribute is mentioned ESPR provisional agreement from January 9th, 2024 Article 7:\n(b) as appropriate, also require products to be accompanied by:\n(i) information on the performance of the product in relation to one or more of the product parameters referred to in Annex I, including a scoring of reparability or durability [...].", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "durabilityScore" : { + "description" : "The durability score. This attribute is mentioned ESPR provisional agreement from January 9th, 2024 Article 7:\n(b) as appropriate, also require products to be accompanied by:\n(i) information on the performance of the product in relation to one or more of the product parameters referred to in Annex I, including a scoring of reparability or durability [...].", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + } + }, + "required" : [ "status", "productFootprint" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_StatusEnumeration" : { + "type" : "string", + "description" : "The current status of the product passport declared through either: draft, approved, invalid or expired.", + "enum" : [ "draft", "approved", "invalid", "expired" ] + }, + "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_io.catenax.generic.digital_product_passport_5.0.0_MetadataCharacteristic" : { + "description" : "Characteristic for the passport metadata of the digital product passport.", + "type" : "object", + "properties" : { + "version" : { + "description" : "The current version of the product passport. The possibility of modification/ updating the product passport needs to include versioning of the dataset. This attribute is an internal versioning from the passport issuer. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Article 8:\n(1) [...] The information in the product passport shall be accurate, complete, and up to date.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "status" : { + "description" : "The current status of the product passport declared through either: draft, approved, invalid or expired.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_StatusEnumeration" + }, + "expirationDate" : { + "description" : "The timestamp in the format (yyyy-mm-dd) for the product passport until when it is available or a comment describing this period. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Article 8:\n(2) (h) the period during which the product passport is to remain available, which shall correspond to at least the expected lifetime of a specific product.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DateTrait" + }, + "issueDate" : { + "description" : "The timestamp in the format (yyyy-mm-dd) since when the product passport is available.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DateTrait" + }, + "economicOperatorId" : { + "description" : "The identification of the owner/economic operator of the passport. Proposed, according to ISO 15459, is the CIN (company identification code). Other identification numbers like the tax identification number, value added tax identification number, commercial register number and the like are also valid entries. In the Catena-X network, the BPNL is used for the identification of companies and the information stored like contact information and addresses. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Annex III:\n(k) the [...] unique operator identifier code of the economic operator established in the Union responsible for carrying out the tasks set out in Article 4 of Regulation (EU) 2019/1020, or Article 15 of Regulation (EU) on general product safety, or similar tasks pursuant to other EU legislation applicable to the product.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.business_partner_number_2.0.0_BpnlTrait" + }, + "passportIdentifier" : { + "description" : "The identifier of the product passport, which is an uuidv4.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.uuid_2.0.0_UuidV4Trait" + }, + "predecessor" : { + "description" : "Identification of the preceding product passport. If there is no preceding passport, input a dummy value. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Article 8:\n(2)(g) [...] Any new product passport shall be linked to the product passport or passports of the original product whenever appropriate.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.uuid_2.0.0_UuidV4Trait" + }, + "backupReference" : { + "description" : "A reference to the data backup of the passport. This mandatory attribute will be further defined in the future. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex III:\n(kb) the reference of the certified independent third-party product passport service provider hosting the back-up copy of the product passport.\nArticle 10 also mentions:\n(c) the data included in the product passport shall be stored by the economic operator responsible for its creation or by certified independent third-party product passport service providers authorised to act on their behalf.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "registrationIdentifier" : { + "description" : "Identifier in the respective registry. This will be further defined in the future. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 in Article 12:\nBy [2 years from entering into force of this Regulation], the Commission shall set up and manage a digital registry (\"the registry\") storing in a secure manner at least the unique product identifier, the unique operator identifier, the unique facility identifiers. In case of products intended to be placed under the customs procedure 'release for free circulation', the registry shall also store the product commodity code. The registry shall also store the batteries' unique identifiers referred to in Article 77(3) of Regulation (EU) 2023/1542.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_IdentifierCharacteristic" + }, + "lastModification" : { + "description" : "Date of the latest modification.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DateTrait" + } + }, + "required" : [ "version", "expirationDate", "issueDate", "economicOperatorId", "passportIdentifier", "predecessor", "backupReference" ] + }, + "urn_samm_io.catenax.material.chemical_material_passport_2.0.0_GenericCharacteristic" : { + "description" : "Characteristic for the product generic parameters.", + "type" : "object", + "properties" : { + "identification" : { + "description" : "Identification information of the product, especially identifiers and codes. These are mentioned in the ESPR provisional agreement from January 9th, 2024 ANNEX III:\n(b) the unique product identifier at the level indicated in the applicable delegated act adopted pursuant to Article 4.\nAdditionally in Article 9 regarding general requirements for the product passport is stated that:\nA product passport shall meet the following conditions:\n(a) it shall be connected through a data carrier to a persistent unique product identifier;\n(e) the information included in the product passport shall refer to the product model, batch, or item as specified in the delegated act adopted pursuant to Article 4.\nArticle 2 Definitions: \n(31) 'unique product identifier' means a unique string of characters for the identification of products that also enables a web link to the product passport;\nRecital (27): A 'model' usually means a version of a product of which all units share the same technical characteristics relevant for the ecodesign requirements and the same model identifier, a 'batch' usually means a subset of a specific model composed of all products produced in a specific manufacturing plant at a specific moment in time and an 'item' usually means a single unit of a model.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_IdentificationCharacteristic" + }, + "operation" : { + "description" : "Operational information of the product.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_OperationCharacteristic" + }, + "characteristics" : { + "description" : "Defines specific characteristics of a product.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_ProductCharacteristics" + }, + "commercial" : { + "description" : "Commercial information of the product.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_CommercialCharacteristic" + }, + "materials" : { + "description" : "Properties which are relevant for the materials of the product.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_MaterialsCharacteristic" + }, + "sources" : { + "description" : "Documents that are mandatory if applicable for the product. These are mentioned in the ESPR provisional agreement from January 9th, 2024 ANNEX III:\n(e) compliance documentation and information required under this Regulation or other Union law applicable to the product, such as the declaration of conformity, technical documentation or conformity certificates;\n(f) user manuals, instructions, warnings or safety information, as required by other Union legislation applicable to the product.\nAdditionally requirements are mentioned in Article 21:\n7. Manufacturers shall ensure that a product covered by a delegated act adopted pursuant to Article 4 is accompanied by instructions in digital format that enable customers and other relevant actors to assemble, install, operate, store, maintain, repair and dispose of the product in a language that can be easily understood, as determined by the Member State concerned. Such instructions shall be clear, understandable and legible and include at least the information set out in Article 7(2), point (b), point (ii) specified in the delegated acts adopted pursuant to Article 4.\nArticle 7 states additionally:\n(ii) information for customers and other actors on how to install, use, maintain and repair the product, in order to minimise its impact on the environment and to ensure optimum durability, on how to install third-party operating systems where relevant, as well as on collection for refurbishment or remanufacture, and on how to return or handle the product at the end of its life;\n(2) (b) (iii) information for treatment facilities on disassembly, reuse, refurbishment, recycling, or disposal at end-of-life;\n(2) (b) (iv) other information that may influence sustainable product choices for customers and the way the product is handled by parties other than the manufacturer in order to facilitate appropriate use, value retaining operations and correct treatment at end-of-life.\n(5) (d) relevant instructions for the safe use of the product.\n(5) (e) information relevant for disassembly, preparation for reuse, reuse, recycling and the environmentally sound management of the product at the end of its life.\nAnnex I:\n(b) [...] availability of repair and maintenance instructions, number of materials and components used, use of standard components,[...] number and complexity of processes and whether specialised toolsare needed, ease of non-destructive disassembly and re-assembly, conditions for access to product data, conditions for access to or use of hardware and software needed;\n(c) ease of upgrading, re-use, remanufacturing and refurbishment as expressed through: [...] number and complexity of processes and tools needed, ease of non-destructive disassembly and re-assembly, conditions for access to product data, conditions for access to or use of hardware and software needed, conditions of access to test protocols or not commonly available testing equipment, availability of guarantees specific to remanufactured or refurbished products, conditions for access to or use of technologies protected by intellectual property rights, modularity;\n(d) design for recycling, ease and quality of recycling as expressed through: use of easily recyclable materials, safe, easy and non-destructive access to recyclable components and materials or components and materials containing hazardous substances and material composition and homogeneity, possibility for high-purity sorting, [...] number and complexity of processes and tools needed, ease of nondestructive disassembly and re-assembly, conditions for access to product data, conditions for access to or use of hardware and software needed;\n(q) functional performance and conditions for use including as expressed through ability in performing its intended use, precautions of use, skills required, compatibility with other products or systems.\nAdditionally to consider are guidelines and instructions regarding the proper management and disposal of packaging materials after use. This can include instructions for separation, reuse, and recycling.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_SourceList" + }, + "sustainability" : { + "description" : "Sustainability related attributes.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_SustainabilityCharacteristic" + }, + "metadata" : { + "description" : "Metadata of the product passport. These are mentioned in the ESPR proposal from March 30th, 2022 and some changed by the provisional agreement from January 9th, 2024.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_MetadataCharacteristic" + } + }, + "required" : [ "identification", "operation", "characteristics", "commercial", "materials", "sources", "sustainability", "metadata" ] + } + } + }, + "properties" : { + "specific" : { + "description" : "Product specific parameters of the electric drive.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.material.chemical_material_passport_2.0.0_SpecificCharacteristic" + }, + "generic" : { + "description" : "The product generic parameters. These are defined by the Digital Product Passport proposal from the ESPR. The main basis is provided by the document \"Proposal for a REGULATION OF THE EUROPEAN PARLIAMENT AND OF THE COUNCIL establishing a framework for setting ecodesign requirements for sustainable products and repealing Directive 2009/125/EC\" from March 30th, 2022. The latest version of the document was the provisional agreement between the EU Council and the Parliament from January 9th, 2024.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.material.chemical_material_passport_2.0.0_GenericCharacteristic" + } + }, + "required" : [ "specific", "generic" ] +} \ No newline at end of file diff --git a/io.catenax.material.chemical_material_passport/2.0.0/gen/ChemicalMaterialPassport.aasx b/io.catenax.material.chemical_material_passport/2.0.0/gen/ChemicalMaterialPassport.aasx new file mode 100644 index 000000000..f4dc93cfa Binary files /dev/null and b/io.catenax.material.chemical_material_passport/2.0.0/gen/ChemicalMaterialPassport.aasx differ diff --git a/io.catenax.material.chemical_material_passport/2.0.0/gen/ChemicalMaterialPassport.html b/io.catenax.material.chemical_material_passport/2.0.0/gen/ChemicalMaterialPassport.html new file mode 100644 index 000000000..94503f452 --- /dev/null +++ b/io.catenax.material.chemical_material_passport/2.0.0/gen/ChemicalMaterialPassport.html @@ -0,0 +1,14639 @@ + + + + + + + + + + + + + + Documentation Chemical Material Passport + + +
+
+
+
+

Aspect Model Chemical Material Passport

+
urn:samm:io.catenax.material.chemical_material_passport:2.0.0#ChemicalMaterialPassport
+
+
+
+
+
+
+
+ +
+ + +
+ The information in a Digital Product Passport allows stakeholders in the value chain to map information and obtain a better understanding of the composition of the product, the environmental impact of the production and use phase, and the aspect of circularity. To serve the same purpose as the Digital Passport, the Chemical Material Passport also plays an important role in providing more detailed information in terms of sustainability, safety and waste management. It can replace the current way of communication and data exchange from multi-channels by one streamlined data flow. +
+ + +
+

Overview

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

Properties

+
+ +
+ +
+

Product Generic Parameters

+
+ +The product generic parameters. These are defined by the Digital Product Passport proposal from the ESPR. The main basis is provided by the document "Proposal for a REGULATION OF THE EUROPEAN PARLIAMENT AND OF THE COUNCIL establishing a framework for setting ecodesign requirements for sustainable products and repealing Directive 2009/125/EC" from March 30th, 2022. The latest version of the document was the provisional agreement between the EU Council and the Parliament from January 9th, 2024. + +
+
Name
+
genericParameters
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.material.chemical_material_passport:2.0.0#GenericEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
generic
+
+ + +
+
+ +
+

Product Specific Parameters

+
+ +Product specific parameters of the electric drive. + +
+
Name
+
productSpecificParameters
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.material.chemical_material_passport:2.0.0#SpecificEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
specific
+
+ + +
+
+ + + +
+
+

Entities

+
+ +
+
+

Characteristics Entity

+
+
+ Entity which defines specific characteristics of a product such as different life spans and physical dimensions. +
+ +
+

Properties

+
+
+ +
+
Lifespan
+
+ +The type of lifespan represented with the values guaranteed lifetime, technical lifetime and mean time between failures. Both can be described through the attributes: type, which defines the type such as guaranteed lifetime or technical lifetime, the unit for the lifetime, and the value represented by an integer. These attributes are mentioned in the ESPR proposal from March 30th, 2022 ANNEX I: +(a) durability and reliability of the product or its components as expressed through the products guaranteed lifetime, technical lifetime [or] mean time between failures [...]. + +
+
Name
+
lifespan
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#LifespanEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
lifespan
+
+ + +
+
+ +
+
Physical Dimension
+
+ +Physical dimensions are properties associated with physical quantities for purposes of classification or differentiation. These attributes are mentioned in the ESPR provisional agreement from January 9th, Article 7: +(2) (b) (i) information on the performance of the product in relation to one or more of the product parameters referred to in Annex I; +Annex I (i) weight and volume of the product and its packaging, and the product-to-packaging ratio. + +
+
Name
+
physicalDimension
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#PhysicalDimensionEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
physicalDimension
+
+ + +
+
+ +
+
Physical State
+
+ +The physical state of the item. There are four states of matter solid, liquid, gas and plasma which can be chosen from an enumeration. + +
+
Name
+
physicalState
+
+ + + +
+
Characteristic
+
+
+
+
Enumeration
+
+
+
Values
+
+
+
+
    +
  • solid
    • +
  • liquid
    • +
  • gas
    • +
  • plasma
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
solid
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
physicalState
+
+ + +
+
+ +
+
General Performance Class
+
+ +The performance class of the product. This attribute is mentioned ESPR provisional agreement from January 9th, 2024 Article 7: +4. When establishing the information requirements referred to in paragraph 2, point (b), point (i), the Commission shall, as appropriate in view of the specificity of the product group, determine classes of performance. Classes of performance may be based on single parameters, on aggregated scores, in absolute terms or in any other form that enables potential customers to choose the best performing products. Those classes of performance shall correspond to significant improvements in performance levels. Where classes of performance are based on parameters in relation to which performance requirements are established, they shall use as the minimum level the minimum performance required at the time when the classes of performance start to apply. +Definition: +'class of performance': means a range of performance levels in relation to one or more product parameters referred to in Annex I, based on a common methodology for the product or product group, ordered into successive steps to allow for product differentiation. + +
+
Name
+
generalPerformanceClass
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
A
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
generalPerformanceClass
+
+ + +
+
+
+
+

Chemical Material Entity

+
+
+ Material entity with attributes if applicable to the product. +
+ +
+

Properties

+
+
+ +
+
Applicable
+
+ +Check whether the connected attributes are applicable to the product. If it is not applicable (false), dummy data can be delivered. + +
+
Name
+
applicable
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#boolean + +
+
+
+
+
+ +
+
Example
+
true
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
applicable
+
+ + +
+
+ +
+
Material
+
+ +Information on different materials in the product. + +
+
Name
+
chemicalMaterial
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#MaterialEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
content
+
+ + +
+
+
+
+

Classification Entity

+
+
+ Entity for the hazard classification. +
+ +
+

Properties

+
+
+ +
+
Classification Rule
+
+ +Name of the classification rule under which the hazard assessment has been prepared. + +
+
Name
+
classificationRule
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
CLP Regulation (EC) No 1272/2008
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
rule
+
+ + +
+
+ +
+
classification Hazard Info
+
+ +Information if the product is hazardous or not, according to the connected rule. + +
+
Name
+
classificationHazardInfo
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#boolean + +
+
+
+
+
+ +
+
Example
+
true
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
hazardous
+
+ + +
+
+ +
+
Classification Hazard Class Route
+
+ +Certain classifications must be communicated with the relevant route of exposure according to CLP Regulation (EC) No 1272/2008, which include: +- oral, +- dermal, +- inhalation gas, +- inhalation vapour, +- inhalation dust/mist/fume. + +
+
Name
+
classificationHazardClassRoute
+
+ + + +
+
Characteristic
+
+
+
+
Enumeration
+
+
+
Values
+
+
+
+
    +
  • oral
    • +
  • dermal
    • +
  • inhalation gas
    • +
  • inhalation vapour
    • +
  • inhalation dust/mist/fume
    • +
  • not applicable
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
oral
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
route
+
+ + +
+
+ +
+
Classification Remark
+
+ +Additional remarks for classification information supplement the classification details for a particular chemical material. These remarks assist stakeholders in making informed decisions regarding safety, handling, and regulatory compliance. + +
+
Name
+
classificationRemark
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
No additional information available
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
remark
+
+ + +
+
+ +
+
Hazard Category
+
+ +The hazard category of the substance of concern. Defined in Article 2 of Regulation (EC) No 1272/2008 of the European Parliament and of the Council of 16 December 2008 on classification, labelling and packaging of substances and mixtures, amending and repealing Directives 67/548/EEC and 1999/45/EC, and amending Regulation (EC) No 1907/2006: +2. 'hazard category' means the division of criteria within each hazard class, specifying hazard severity. + +
+
Name
+
hazardCategory
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
category 1A
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
category
+
+ +
+
Reference
+
+
    +
  • https://eur-lex.europa.eu/legal-content/EN/TXT/?uri=CELEX:02008R1272-20231201
    • +
+
+
+ +
+
+ +
+
Hazard Class
+
+ +The hazard class of the substance of concern. Defined in Article 2 of Regulation (EC) No 1272/2008 of the European Parliament and of the Council of 16 December 2008 on classification, labelling and packaging of substances and mixtures, amending and repealing Directives 67/548/EEC and 1999/45/EC, and amending Regulation (EC) No 1907/2006: +1. 'hazard class' means the nature of the physical, health or environmental hazard. + +
+
Name
+
hazardClass
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Skin corrosion
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
class
+
+ +
+
Reference
+
+
    +
  • https://eur-lex.europa.eu/legal-content/EN/TXT/?uri=CELEX:02008R1272-20231201
    • +
+
+
+ +
+
+ +
+
Hazard Statement
+
+ +The hazard statement of the substance of concern. Defined in Article 2 of Regulation (EC) No 1272/2008 of the European Parliament and of the Council of 16 December 2008 on classification, labelling and packaging of substances and mixtures, amending and repealing Directives 67/548/EEC and 1999/45/EC, and amending Regulation (EC) No 1907/2006: +5. 'hazard statement' means a phrase assigned to a hazard class and category that describes the nature of the hazards of a hazardous substance or mixture, including, where appropriate, the degree of hazard. + +
+
Name
+
hazardStatement
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Causes severe skin burns and eye damage.
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
statement
+
+ +
+
Reference
+
+
    +
  • https://eur-lex.europa.eu/legal-content/EN/TXT/?uri=CELEX:02008R1272-20231201
    • +
+
+
+ +
+
+
+
+

ClassificationEntity

+
+
+ Encapsulates data related to the classification of the part. +
+ +
+

Properties

+
+
+ +
+
Classification Standard
+
+ +Identified classification standards that align to the Catena-X needs. + +
+
Name
+
classificationStandard
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
GIN 20510-21513
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
classificationStandard
+
+ + +
+
+ +
+
Classification ID
+
+ +The classification ID of the part type according to the corresponding standard definition mentioned in the key value pair. + +
+
Name
+
classificationID
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
1004712
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
classificationID
+
+ + +
+
+ +
+
Classification Description
+
+ +Optional property describing the classification standard. + +
+
Name
+
classificationDescription
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Generic standard for classification of parts in the automotive industry.
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
classificationDescription
+
+ + +
+
+
+
+

Code Entity

+
+
+ Code entity with code key and value. +
+ +
+

Properties

+
+
+ +
+
Code Key
+
+ +The code key for the identification of the product. Examples are GTIN, hash, DID, ISBN, TARIC. This attribute is mentioned in the ESPR proposal from March 30th, 2022 ANNEX III: +(b) the unique product identifier at the level indicated in the applicable delegated act adopted pursuant to Article 4; +(c) the Global Trade Identification Number as provided for in standard ISO/IEC 15459-6 or equivalent of products or their parts; +(d) relevant commodity codes, such as a TARIC code as defined in Council Regulation (EEC) No 2658/87. + +
+
Name
+
codeKey
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
TARIC
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
key
+
+ + +
+
+ +
+
Code Value
+
+ +The code value for the identification of the product in regard to the chosen code name. + +
+
Name
+
codeValue
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
8703 24 10 00
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
value
+
+ + +
+
+
+
+

Commercial Entity

+
+
+ Commercial information. +
+ +
+

Properties

+
+
+ +
+
Placed on Market
+
+ +The timestamp in the format (yyyy-mm-dd) with or without time zone when the product was put in the market. + +
+
Name
+
placedOnMarket
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
2000-01-01
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
placedOnMarket
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + Date Constraint +
    + +
    +
    Description
    +
    Constraint fo a timestamp in the format (yyyy-mm-dd).
    +
    + + +
    +
    Regular expression
    +
    ^\d{4}-\d{2}-\d{2}$
    +
    + +
    • +
+
+
+
+
+ +
+
Purpose
+
+ +One or more intended industry/industries of the product described by the digital product passport. If exchanged via Catena-X, 'automotive ' is a must choice included in the list. + +
+
Name
+
purpose
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
automotive
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
purpose
+
+ + +
+
+
+
+

Compliance Entity

+
+
+ Entity for compliance attributes. +
+ +
+

Properties

+
+
+ +
+
Compliance Country
+
+ +The name of the country of compliance denotes the country whose rules and regulations the product must adhere to. + +
+
Name
+
complianceCountry
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
UK
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
complianceCountry
+
+ +
+
Reference
+
+
    +
  • https://www.iso.org/iso-3166-country-codes.html
    • +
+
+
+ +
+
Constraints
+
+
    +
  • +
    + +
    + Country Code RegEx +
    + +
    +
    Description
    +
    Regex pattern including all valid ISO 3166 country codes, ensuring a precise match.
    +
    + + +
    +
    Regular expression
    +
    \b(?:A[BDEFGHIJKLMNOQSTUWXZ]|B[ABDEFGHJMNRSVWY]|C[ACDDEFGHIKLMNOPQRSTUVXYZ]|D[EJKMOZ]|E[CEGHRST]|F[IJKMOR]|G[ABDEFGHILMNPQRSTUWY]|H[KMNRTU]|I[DELNOQRST]|J[EMOP]|KE|L[ABCIKRSTUVY]|M[ACDEFGHKLMNOPQRSTUVWXYZ]|N[ACEFGILOPRTUVYZ]|OM|P[AEFGHKLMNRSTWY]|QA|R[EOSUW]|S[ABCDEGHIJKLMNRTUVYZ]|T[CDGHJMNPRW]|U[AGKMSTYZ]|V[ACEGINU]|W[FS]|X[KYZ]|Y[ETU]|Z[AMW])\b
    +
    + +
    • +
+
+
+
+
+ +
+
Compliance Regulation Name
+
+ +The name of the regulation or standard with which the product must comply can be sourced from Supplier Survey information. This attribute is referenced in ANNEX VI of the Proposal for a REGULATION OF THE EUROPEAN PARLIAMENT AND OF THE COUNCIL on detergents and surfactants, amending Regulation (EU) 2019/1020 and repealing Regulation (EC) No 648/2004: +The product passport shall include the following information: [...] +(e) references to Union legal acts that the detergent or surfactant complies with; + +
+
Name
+
complianceRegulationName
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
UK -REACH regulation
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
complianceRegulationName
+
+ + +
+
+ +
+
Compliance Result
+
+ +The statement indicates whether the product complies with the aforementioned regulations. + +
+
Name
+
complianceResult
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#boolean + +
+
+
+
+
+ +
+
Example
+
true
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
complianceResult
+
+ + +
+
+ +
+
Compliance Reason For Exemption
+
+ +Data providing details and justifications for an exemption from compliance with certain regulations, standards, or requirements. This information assists regulatory authorities or stakeholders in evaluating the merits of the exemption and making decisions in accordance with legal and regulatory requirements. + +
+
Name
+
complianceReasonForExemption
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Radioactive substance
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
complianceReasonForExemption
+
+ + +
+
+ +
+
Compliance Remark
+
+ +If necessary, any remarks that provide relevant information for compliance. Further clarification supplements the compliance information, offering additional context or details to ensure thorough understanding and adherence to regulatory requirements. + +
+
Name
+
complianceRemark
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
If you need more information about the (pre-)registration status, please get in contact with our experts from the Compliance Team: www.xyz.com
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
complianceRemark
+
+ + +
+
+
+
+

Data Carrier Entity

+
+
+ Data Carrier Entity with type and layout of the data carrier. +
+ +
+

Properties

+
+
+ +
+
Carrier Type
+
+ +The type of data carrier such as a QR code on the product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 8: +(2) (b) the types of data carrier to be used. + +
+
Name
+
carrierType
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
QR
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
carrierType
+
+ + +
+
+ +
+
Carrier Layout
+
+ +The positioning of data carrier on the product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 8: +(2) (c) the layout in which the data carrier shall be presented and its positioning. + +
+
Name
+
carrierLayout
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
upper-left side
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
carrierLayout
+
+ + +
+
+
+
+

Disposal Entity

+
+
+ Entity for disposal related attributes. +
+ +
+

Properties

+
+
+ +
+
Disposal Before Use
+
+ +Management and disposal practices for chemicals that are no longer needed or deemed unsuitable for their intended purpose. This information can be provided as a document, detailing the properties of waste that render it hazardous, along with disposal and recovery operations or recommendations, and accidental release measures. + +
+
Name
+
disposalBeforeUse
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#DocumentationEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
beforeUse
+
+ + +
+
+ +
+
Disposal After Use
+
+ +Chemical Management and Disposal Guides post-usage as document. + +
+
Name
+
disposalAfterUse
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#DocumentationEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
afterUse
+
+ + +
+
+ +
+
Disposal Waste Code
+
+ +A waste code is a standardized alphanumeric code used to classify different types of waste according to their characteristics, origin, and potential hazards. These codes help in proper identification, handling, treatment, and disposal of waste materials. + +
+
Name
+
disposalWasteCode
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.material.chemical_material_passport:2.0.0#WasteCodeEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
wasteCode
+
+ + +
+
+ +
+
Disposal Packaging Information
+
+ +Guidelines and instructions regarding the proper management and disposal of packaging materials after use. Includes instructions on separation, reuse, and recycling. + +
+
Name
+
disposalPackagingInformation
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#DocumentationEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
packaging
+
+ + +
+
+
+
+

Document Entity

+
+
+ Document entity with header, content, category and type. +
+ +
+

Properties

+
+
+ +
+
Content
+
+ +The content of the document e.g a link. + +
+
Name
+
content
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
https://dummy.link
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
content
+
+ + +
+
+ +
+
Category
+
+ +The category in which the document can be sorted. These are mentioned in the ESPR proposal from March 30th, 2022 ANNEX III: +(e) compliance documentation and information required under this Regulation or other Union law applicable to the product, such as the declaration of conformity, technical documentation or conformity certificates; +ANNEX IV states additional information regarding the content of the technical documentation +Further information on documents are mentioned in the proposal from March 30th, 2022 ANNEX III: +(f) user manuals, instructions, warnings or safety information, as required by other Union legislation applicable to the product. +Additionally requirements are mentioned in Article 21: +(7) Manufacturers shall ensure that that a product covered by a delegated act adopted pursuant to Article 4 is accompanied by instructions that enable consumers and other end-users to safely assemble, install, operate, store, maintain, repair and dispose of the product in a language that can be easily understood by consumers and other end-users, as determined by the Member State concerned. Such instructions shall be clear, understandable and legible and include at least the information specified in the delegated acts adopted pursuant to Article 4 and pursuant to Article 7(2)(b), point (ii). +Article 7 states additionally: +(2) (b) (ii) information for consumers and other end-users on how to install, use, maintain and repair the product in order to minimize its impact on the environment and to ensure optimum durability, as well as on how to return or dispose of the product at end-of-life; +(2) (b) (iii) information for treatment facilities on disassembly, recycling, or disposal at end-of-life; +(2) (b) (iv) other information that may influence the way the product is handled by parties other than the manufacturer in order to improve performance in relation to product parameters referred to in Annex I. +(5) (d) relevant instructions for the safe use of the product. + +
+
Name
+
category
+
+ + + +
+
Characteristic
+
+
+
+
Enumeration
+
+
+
Values
+
+
+
+
    +
  • Product Specifications
    • +
  • Manufacturer Information
    • +
  • User Manuals and Guides
    • +
  • Certifications and Compliance
    • +
  • Product Images and Videos
    • +
  • Warranty Information
    • +
  • Reviews and Ratings
    • +
  • Product Variations
    • +
  • Supply Chain Information
    • +
  • Environmental Impact
    • +
  • Compatibility and Accessories
    • +
  • FAQs and Support
    • +
  • Purchase and Retail Information
    • +
  • Privacy and Data Handling
    • +
  • Third-Party Integrations
    • +
  • Legal Information
    • +
  • Safety Information
    • +
  • Repair and Installation
    • +
  • Waste Generation and Prevention
    • +
  • Specific Voluntary Labels
    • +
  • Product Packaging
    • +
  • Return and Disposal
    • +
  • End of Life
    • +
  • Material and Substance Information
    • +
  • Technical Documentation
    • +
  • Treatment facilities
    • +
  • Other
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Legal Information
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
category
+
+ + +
+
+ +
+
Content Type
+
+ +The type of content which can be expected in the "content" property. Examples are a link, restricted link, pdf, excel, etc. + +
+
Name
+
contentType
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
URL
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
type
+
+ + +
+
+ +
+
Header
+
+ +The header as a short description of the document with a maximum of 100 characters. + +
+
Name
+
header
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Example Document XYZ
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
header
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + Header Constraint +
    + +
    +
    Description
    +
    Constraint for a maximum of 100 characters.
    +
    + + +
    +
    Max. length
    +
    100
    +
    + +
    • +
+
+
+
+
+
+
+

Documentation Entity

+
+
+ Entity for a document with a header, type and content. +
+ +
+

Properties

+
+
+ +
+
Content
+
+ +The content of the document e.g a link. + +
+
Name
+
content
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
https://dummy.link
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
content
+
+ + +
+
+ +
+
Content Type
+
+ +The type of content which can be expected in the "content" property. Examples are a link, restricted link, pdf, excel, etc. + +
+
Name
+
contentType
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
URL
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
contentType
+
+ + +
+
+ +
+
Header
+
+ +The header as a short description of the document with a maximum of 100 characters. + +
+
Name
+
header
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Example Document XYZ
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
header
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + Header Constraint +
    + +
    +
    Description
    +
    Constraint for a maximum of 100 characters.
    +
    + + +
    +
    Max. length
    +
    100
    +
    + +
    • +
+
+
+
+
+
+
+

Emergency Entity

+
+
+ Entity for information on how to proceed in case of an emergency. +
+ +
+

Properties

+
+
+ +
+
Emergency Availability
+
+ +The period of time when emergency phone numbers are available. + +
+
Name
+
emergencyAvailability
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Only available during the following office hours: xx - xx
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
availability
+
+ + +
+
+ +
+
Emergency Phone Number
+
+ +The phone number in case of an emergency. + +
+
Name
+
emergencyPhoneNumber
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
+49111222333
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
number
+
+ + +
+
+
+
+

Facility Entity

+
+
+ The entity for a facility with the BPNA identifier. +
+ +
+

Properties

+
+
+ +
+
Facility
+
+ +The identifier used for a location. This attribute is mentioned in the ESPR provisional agreement from January 9th 2024 Annex III: +(i) unique facility identifiers; +Article 2 Definitions: (33) 'unique facility identifier' means a unique string of characters for the identification of locations or buildings involved in the value chain of a product or used by actors involved in the value chain of a product. + +
+
Name
+
facility
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
    +
  • https://catena-x.net/fileadmin/user_upload/Standard-Bibliothek/Update_PDF_Maerz/5_BPDM/CX_-_0010_BUSINESS_PARTNER_NUMBER_PlatformCapabilityBPDM_v_1.0.1.pdf
    • +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
BPNA1234567890AA
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
facility
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + BPNA Regular Expression +
    + +
    +
    Description
    +
    The provided regular expression ensures that the BPNA is composed of prefix 'BPNA', 10 digits and two alphanumeric letters.
    +
    + + +
    +
    Regular expression
    +
    ^BPNA[a-zA-Z0-9]{12}$
    +
    + +
    • +
+
+
+
+
+
+
+

Footprint Entity

+
+
+ Footprint Entity for the carbon and environmental footprint with the total value, unit, impact category type, lifecycle, rulebook, declaration, performance class and the facility. +
+ +
+

Properties

+
+
+ +
+
Footprint Value
+
+ +The value of the footprint of the product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Annex I: +(l) the environmental footprint of the product, expressed as a quantification, in accordance with the applicable delegated act, of a product's life cycle environmental impacts, whether in relation to one or more environmental impact categories or an aggregated set of impact categories; +(m) the carbon footprint of the product; +(ma) the material footprint of the product. + + +
+
Name
+
footprintValue
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#float + +
+
+
+
+
+ +
+
Example
+
12.678
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
value
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + Positive Range Constraint +
    + +
    +
    Description
    +
    Constraint for only positive values.
    +
    + + +
    +
    +>= +
    + DefaultScalarValue[value=0.0, typeUri='DefaultScalar[metaModelVersion=SAMM_2_1_0, urn='http://www.w3.org/2001/XMLSchema#float']'] +
    +
    + +
    • +
+
+
+
+
+ +
+
Footprint Rulebook
+
+ +The applied rulebook for the environmental footprint of the product. + +
+
Name
+
footprintRulebook
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#DocumentationEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
rulebook
+
+ + +
+
+ +
+
Footprint Lifecycle
+
+ +The lifecycle stage, to which the environmental footprint corresponds. These could be for example "raw material acquisition and pre-processing", "main product production", "distribution" or "end of life and recycling". + +
+
Name
+
footprintLifecycle
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
main product production
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
lifecycle
+
+ + +
+
+ +
+
Footprint Unit
+
+ +The unit of measurement of the environmental impact category. For each impact category a specific unit is used. If an aggregation is used, utilize the normalization and weighting methods used in the referenced rulebook. + +
+
Name
+
footprintUnit
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
kg CO2 / kWh
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
unit
+
+ + +
+
+ +
+
Footprint Type
+
+ +The type of the environmental footprint of the product. This could be one of the environmental impact categories. This attribute is mentioned in the ESPR provisional agreement from January 9th 2024 Article 7: +(2)(b)(i) information on the performance of the product in relation to one or more of the product parameters referred to in Annex I, including a scoring of reparability or durability, carbon footprint or environmental footprint; +Annex I: +(l) the environmental footprint of the product, expressed as a quantification, in accordance with the applicable delegated act, of a product's life cycle environmental impacts, whether in relation to one or more environmental impact categories or an aggregated set of impact categories. +(m) the carbon footprint of the product; +(ma) the material footprint of the product. + +
+
Name
+
footprintType
+
+ + + +
+
Characteristic
+
+
+
+
Enumeration
+
+
+
Values
+
+
+
+
    +
  • Climate Change Total
    • +
  • Climate Change Fossil
    • +
  • Climate Change Biogenic Removals and Emissions
    • +
  • Climate Change Land Use and Land Use Change
    • +
  • Ozone Depletion
    • +
  • Acidification
    • +
  • Eutrophication Aquatic Freshwater
    • +
  • Eutrophication Fresh Marine
    • +
  • Eutrophication Terrestrial
    • +
  • Photochemical Ozone Formation
    • +
  • Abiotic Depletion- Minerals and Metals
    • +
  • Fossil Fuels
    • +
  • Water Use
    • +
  • Particulate Matter Emissions
    • +
  • Ionizing Radiation, Human Health
    • +
  • Eco-Toxicity
    • +
  • Human Toxicity, Cancer Effects
    • +
  • Human Toxicity, Non-Cancer Effects
    • +
  • Land Use Related Impacts/Soil Quality
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Climate Change
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
type
+
+ + +
+
+ +
+
Performance Class
+
+ +The performance classification of the footprint. + +
+
Name
+
performanceClass
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
A
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
performanceClass
+
+ + +
+
+ +
+
Manufacturing Plant
+
+ +The manufacturing plant of the footprint in the specific lifecycle phase. + +
+
Name
+
manufacturingPlant
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#FacilityEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
manufacturingPlant
+
+ + +
+
+ +
+
Declaration
+
+ +The footprint declaration in the format of a link + +
+
Name
+
declaration
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#DocumentationEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
declaration
+
+ + +
+
+
+
+

Generic Entity

+
+
+ Entity for the product generic parameters. +
+ +
+

Properties

+
+
+ +
+
Identification
+
+ +Identification information of the product, especially identifiers and codes. These are mentioned in the ESPR provisional agreement from January 9th, 2024 ANNEX III: +(b) the unique product identifier at the level indicated in the applicable delegated act adopted pursuant to Article 4. +Additionally in Article 9 regarding general requirements for the product passport is stated that: +A product passport shall meet the following conditions: +(a) it shall be connected through a data carrier to a persistent unique product identifier; +(e) the information included in the product passport shall refer to the product model, batch, or item as specified in the delegated act adopted pursuant to Article 4. +Article 2 Definitions: +(31) 'unique product identifier' means a unique string of characters for the identification of products that also enables a web link to the product passport; +Recital (27): A 'model' usually means a version of a product of which all units share the same technical characteristics relevant for the ecodesign requirements and the same model identifier, a 'batch' usually means a subset of a specific model composed of all products produced in a specific manufacturing plant at a specific moment in time and an 'item' usually means a single unit of a model. + +
+
Name
+
identification
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#IdentificationEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
identification
+
+ + +
+
+ +
+
Operation
+
+ +Operational information of the product. + +
+
Name
+
operation
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#OperationEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
operation
+
+ + +
+
+ +
+
Characteristics
+
+ +Defines specific characteristics of a product. + +
+
Name
+
characteristics
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#CharacteristicsEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
characteristics
+
+ + +
+
+ +
+
Commercial
+
+ +Commercial information of the product. + +
+
Name
+
commercial
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#CommercialEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
commercial
+
+ + +
+
+ +
+
Materials
+
+ +Properties which are relevant for the materials of the product. + +
+
Name
+
materials
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#MaterialsEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
materials
+
+ + +
+
+ +
+
Sources
+
+ +Documents that are mandatory if applicable for the product. These are mentioned in the ESPR provisional agreement from January 9th, 2024 ANNEX III: +(e) compliance documentation and information required under this Regulation or other Union law applicable to the product, such as the declaration of conformity, technical documentation or conformity certificates; +(f) user manuals, instructions, warnings or safety information, as required by other Union legislation applicable to the product. +Additionally requirements are mentioned in Article 21: +7. Manufacturers shall ensure that a product covered by a delegated act adopted pursuant to Article 4 is accompanied by instructions in digital format that enable customers and other relevant actors to assemble, install, operate, store, maintain, repair and dispose of the product in a language that can be easily understood, as determined by the Member State concerned. Such instructions shall be clear, understandable and legible and include at least the information set out in Article 7(2), point (b), point (ii) specified in the delegated acts adopted pursuant to Article 4. +Article 7 states additionally: +(ii) information for customers and other actors on how to install, use, maintain and repair the product, in order to minimise its impact on the environment and to ensure optimum durability, on how to install third-party operating systems where relevant, as well as on collection for refurbishment or remanufacture, and on how to return or handle the product at the end of its life; +(2) (b) (iii) information for treatment facilities on disassembly, reuse, refurbishment, recycling, or disposal at end-of-life; +(2) (b) (iv) other information that may influence sustainable product choices for customers and the way the product is handled by parties other than the manufacturer in order to facilitate appropriate use, value retaining operations and correct treatment at end-of-life. +(5) (d) relevant instructions for the safe use of the product. +(5) (e) information relevant for disassembly, preparation for reuse, reuse, recycling and the environmentally sound management of the product at the end of its life. +Annex I: +(b) [...] availability of repair and maintenance instructions, number of materials and components used, use of standard components,[...] number and complexity of processes and whether specialised toolsare needed, ease of non-destructive disassembly and re-assembly, conditions for access to product data, conditions for access to or use of hardware and software needed; +(c) ease of upgrading, re-use, remanufacturing and refurbishment as expressed through: [...] number and complexity of processes and tools needed, ease of non-destructive disassembly and re-assembly, conditions for access to product data, conditions for access to or use of hardware and software needed, conditions of access to test protocols or not commonly available testing equipment, availability of guarantees specific to remanufactured or refurbished products, conditions for access to or use of technologies protected by intellectual property rights, modularity; +(d) design for recycling, ease and quality of recycling as expressed through: use of easily recyclable materials, safe, easy and non-destructive access to recyclable components and materials or components and materials containing hazardous substances and material composition and homogeneity, possibility for high-purity sorting, [...] number and complexity of processes and tools needed, ease of nondestructive disassembly and re-assembly, conditions for access to product data, conditions for access to or use of hardware and software needed; +(q) functional performance and conditions for use including as expressed through ability in performing its intended use, precautions of use, skills required, compatibility with other products or systems. +Additionally to consider are guidelines and instructions regarding the proper management and disposal of packaging materials after use. This can include instructions for separation, reuse, and recycling. + +
+
Name
+
sources
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#DocumentEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
sources
+
+ + +
+
+ +
+
Sustainability
+
+ +Sustainability related attributes. + +
+
Name
+
sustainability
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#SustainabilityEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
sustainability
+
+ + +
+
+ +
+
Metadata
+
+ +Metadata of the product passport. These are mentioned in the ESPR proposal from March 30th, 2022 and some changed by the provisional agreement from January 9th, 2024. + +
+
Name
+
metadata
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#MetadataEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
metadata
+
+ + +
+
+
+
+

Hazard Assessment Entity

+
+
+ Entity for the hazard assessment. +
+ +
+

Properties

+
+
+ +
+
Classification
+
+ +Classification for the hazard assessment. + +
+
Name
+
classification
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.material.chemical_material_passport:2.0.0#ClassificationEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
classification
+
+ + +
+
+ +
+
Labeling
+
+ +The material labeling. + +
+
Name
+
labeling
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.material.chemical_material_passport:2.0.0#LabelingEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
labeling
+
+ +
+
Reference
+
+
    +
  • https://eur-lex.europa.eu/eli/reg/2008/1272/oj
    • +
+
+
+ +
+
+ +
+
Hazard Assessment Documentation
+
+ +Documentation providing hazard assessment information for ensuring the safe management of chemical materials throughout their lifecycle. + +
+
Name
+
hazardAssessmentDocumentation
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#DocumentationEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
documentation
+
+ + +
+
+
+
+

Hazard Entity

+
+
+ Entity for the hazardous classification. +
+ +
+

Properties

+
+
+ +
+
Hazard Category
+
+ +The hazard category of the substance of concern. Defined in Article 2 of Regulation (EC) No 1272/2008 of the European Parliament and of the Council of 16 December 2008 on classification, labelling and packaging of substances and mixtures, amending and repealing Directives 67/548/EEC and 1999/45/EC, and amending Regulation (EC) No 1907/2006: +2. 'hazard category' means the division of criteria within each hazard class, specifying hazard severity. + +
+
Name
+
hazardCategory
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
category 1A
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
category
+
+ +
+
Reference
+
+
    +
  • https://eur-lex.europa.eu/legal-content/EN/TXT/?uri=CELEX:02008R1272-20231201
    • +
+
+
+ +
+
+ +
+
Hazard Class
+
+ +The hazard class of the substance of concern. Defined in Article 2 of Regulation (EC) No 1272/2008 of the European Parliament and of the Council of 16 December 2008 on classification, labelling and packaging of substances and mixtures, amending and repealing Directives 67/548/EEC and 1999/45/EC, and amending Regulation (EC) No 1907/2006: +1. 'hazard class' means the nature of the physical, health or environmental hazard. + +
+
Name
+
hazardClass
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Skin corrosion
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
class
+
+ +
+
Reference
+
+
    +
  • https://eur-lex.europa.eu/legal-content/EN/TXT/?uri=CELEX:02008R1272-20231201
    • +
+
+
+ +
+
+ +
+
Hazard Statement
+
+ +The hazard statement of the substance of concern. Defined in Article 2 of Regulation (EC) No 1272/2008 of the European Parliament and of the Council of 16 December 2008 on classification, labelling and packaging of substances and mixtures, amending and repealing Directives 67/548/EEC and 1999/45/EC, and amending Regulation (EC) No 1907/2006: +5. 'hazard statement' means a phrase assigned to a hazard class and category that describes the nature of the hazards of a hazardous substance or mixture, including, where appropriate, the degree of hazard. + +
+
Name
+
hazardStatement
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Causes severe skin burns and eye damage.
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
statement
+
+ +
+
Reference
+
+
    +
  • https://eur-lex.europa.eu/legal-content/EN/TXT/?uri=CELEX:02008R1272-20231201
    • +
+
+
+ +
+
+
+
+

Hazard Pictogram Entity

+
+
+ Entity for the hazard pictogram. +
+ +
+

Properties

+
+
+ +
+
Hazard Pictogram Code
+
+ +The code of a pictogram refers to a set of symbols used to visually represent and communicate information about the hazards associated with a chemical material. + +
+
Name
+
hazardPictogramCode
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
GHS05
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
code
+
+ + +
+
+ +
+
Hazard Pictogram Image
+
+ +Link to the picture of the pictogram. Definition from CLP Regulation (EC) No 1272/2008 : ‘hazard pictogram’ means a graphical composition that includes a symbol plus other graphic elements, such as a border, background pattern or colour that is intended to convey specific information on the hazard concerned; + +
+
Name
+
hazardPictogramImage
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
https://example.link
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
image
+
+ + +
+
+ +
+
Hazard Pictogram Name
+
+ +The meaning or description of a pictogram is the explanation that accompanies it, providing information and context about its purpose and the hazards it represents. + +
+
Name
+
hazardPictogramName
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Corrosive
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
name
+
+ + +
+
+
+
+

Hazard Statement Entity

+
+
+ Entity for the hazard statement. +
+ +
+

Properties

+
+
+ +
+
Hazard Statement Code
+
+ +According to CLP Regulation (EC) No 1272/2008, each hazard statement is designated a code, starting with the letter H followed by three digits. These codes can be associated with multiple hazard statements or be assigned to a single statement. + +
+
Name
+
hazardStatementCode
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
H220
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
code
+
+ + +
+
+ +
+
Hazard Statement Text
+
+ +Definition from CLP Regulation (EC) No 1272/2008 ‘hazard statement’ means a phrase assigned to a hazard class and category that describes the nature of the hazards of a hazardous substance or mixture, including, where appropriate, the degree of hazard; + +
+
Name
+
hazardStatementText
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Extremely flammable gas
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
text
+
+ + +
+
+
+
+

Identification Entity

+
+
+ Entity with identification information of the product with part type information, local identifiers, other codes and the data carrier. +
+ +
+

Properties

+
+
+ +
+
Serial Information
+
+ +Identifier for a serial part if available. This is mentioned in the ESPR provisional agreement from January 9th, 2024 Recital (27): +[...] an 'item' usually means a single unit of a model. + +
+
Name
+
serialInformation
+
+ + + +
+
Characteristic
+
+
+
+
Set
+
+
+
Has no order
+
+
+
Duplicates not allowed
+
+
+
+ Type urn:samm:io.catenax.serial_part:3.0.0#KeyValueList + +
+
+
+
+
+ + +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
serial
+
+ + +
+
+ +
+
Batch Information
+
+ +Identifier for a batch part if available. Identifier for a serial part if available. This is mentioned in the ESPR provisional agreement from January 9th, 2024 Recital (27): +[...] a 'batch' usually means a subset of a specific model composed of all products produced in a specific manufacturing plant at a specific moment in time [...]. + +
+
Name
+
batchInformation
+
+ + + +
+
Characteristic
+
+
+
+
Set
+
+
+
Has no order
+
+
+
Duplicates not allowed
+
+
+
+ Type urn:samm:io.catenax.batch:3.0.0#KeyValueList + +
+
+
+
+
+ + +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
batch
+
+ + +
+
+ +
+
Part Type Information
+
+ +Identifier on the level of a part model or type. Identifier for a serial part if available. This is mentioned in the ESPR provisional agreement from January 9th, 2024 Recital (27): +[...] A 'model' usually means a version of a product of which all units share the same technical characteristics relevant for the ecodesign requirements and the same model identifier [...]. + +
+
Name
+
partTypeInformation
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#PartTypeEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
type
+
+ + +
+
+ +
+
Codes
+
+ +Codes for identification. + +
+
Name
+
codes
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#CodeEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
codes
+
+ + +
+
+ +
+
Data Carrier
+
+ +The type and layout of the data carrier on the product. These are mentioned in the ESPR proposal from March 30th, 2022 Article 8: +(b) the types of data carrier to be used; +(c) the layout in which the data carrier shall be presented and its positioning; +Article 2 defines: +(30) 'data carrier' means a linear bar code symbol, a two-dimensional symbol or other automatic identification data capture medium that can be read by a device. + +
+
Name
+
dataCarrier
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#DataCarrierEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
dataCarrier
+
+ + +
+
+ +
+
Part Classification
+
+ +Property describing the classification of a part. + +
+
Name
+
partClassification
+
+ + + +
+
Characteristic
+
+
+
+
SortedSet
+
+
+
Has a certain order
+
+
+
Duplicates not allowed
+
+
+
+ Type urn:samm:io.catenax.shared.part_classification:1.0.0#ClassificationEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
classification
+
+ + +
+
+
+
+

Import Entity

+
+
+ Import entity with attributes if applicable to the product. +
+ +
+

Properties

+
+
+ +
+
Importer
+
+ +Information regarding the importer of the product, if different from the owner of the passport. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex III: +(j) information related to the importer, including the information referred to in Article 23(3) and its EORI number; +Article 23 states: +(3) Importers shall, for products covered by a delegated act adopted pursuant to Article 4, indicate their name, registered trade name or registered trade mark and the postal address and electronic means of communication, where they can be contacted: (a) on the public part of the product passport, when applicable, and +(b) on the product or, where this is not possible, on the packaging, or in a document accompanying the product. + +
+
Name
+
importer
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#ImporterEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
content
+
+ + +
+
+ +
+
Applicable
+
+ +Check whether the connected attributes are applicable to the product. If it is not applicable (false), dummy data can be delivered. + +
+
Name
+
applicable
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#boolean + +
+
+
+
+
+ +
+
Example
+
true
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
applicable
+
+ + +
+
+
+
+

Importer Entity

+
+
+ Entity with information regarding the importer such as the identification and the EORI. +
+ +
+

Properties

+
+
+ +
+
EORI
+
+ +An economic operator established in the customs territory of the Union needs, for customs purposes, an EORI number. EORI stands for economic operators registration and identification number. In this case, the importer's EORI must be provided. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Annex III: +(j) information related to the importer, including the information referred to in Article 23(3) and its EORI number. + +
+
Name
+
eori
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
GB123456789000
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
eori
+
+ +
+
Reference
+
+
    +
  • https://taxation-customs.ec.europa.eu/customs-4/customs-procedures-import-and-export-0/customs-procedures/economic-operators-registration-and-identification-number-eori_en
    • +
+
+
+ +
+
Constraints
+
+
    +
  • +
    + +
    + EORI Constraint +
    + +
    +
    Description
    +
    Constraint with a pattern which ensures that the EORI number starts with two alphanumeric characters, followed by two alphabetic characters, and ends with 2 to 15 alphanumeric characters.
    +
    + + +
    +
    Regular expression
    +
    ^[A-Z]{2}[A-Z0-9]{1,18}$
    +
    + +
    • +
+
+
+
+
+ +
+
Importer Identification
+
+ +The importer of the product, if different from the owner of the passport. In the Catena-X network, the BPNL is used for the identification of companies and the information stored for this like contact information and addresses. +This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex III: +(j) information related to the importer, including the information referred to in Article 23(3) and its EORI number; +Article 23 states: +(3) Importers shall, for products covered by a delegated act adopted pursuant to Article 4, indicate their name, registered trade name or registered trade mark and the postal address and electronic means of communication, where they can be contacted: (a) on the public part of the product passport, when applicable, and +(b) on the product or, where this is not possible, on the packaging, or in a document accompanying the product. + +
+
Name
+
importerIdentification
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
    +
  • https://catena-x.net/fileadmin/user_upload/Standard-Bibliothek/Update_PDF_Maerz/5_BPDM/CX_-_0010_BUSINESS_PARTNER_NUMBER_PlatformCapabilityBPDM_v_1.0.1.pdf
    • +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
BPNL0123456789ZZ
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
id
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + BPNL Regular Expression +
    + +
    +
    Description
    +
    The provided regular expression ensures that the BPNL is composed of prefix 'BPNL', 10 digits and two alphanumeric letters.
    +
    + + +
    +
    Regular expression
    +
    ^BPNL[a-zA-Z0-9]{12}$
    +
    + +
    • +
+
+
+
+
+
+
+

Key Value List

+
+
+ A list of key value pairs for local identifiers, which are composed of a key and a corresponding value. +
+ +
+

Properties

+
+
+ +
+
Identifier Key
+
+ +The key of a local identifier. + +
+
Name
+
key
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
partInstanceId
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
key
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + Key Regular Expression +
    + +
    +
    Description
    +
    Constraint that ensures that the standard keys and custom key prefixes can be used.
    +
    + + +
    +
    Regular expression
    +
    ^(manufacturerId|partInstanceId|batchId|van|customKey:\w+)$
    +
    + +
    • +
+
+
+
+
+ +
+
Identifier Value
+
+ +The value of an identifier. + +
+
Name
+
value
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
SN12345678
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
value
+
+ + +
+
+
+
+

Key Value List

+
+
+ A list of key value pairs for local identifiers, which are composed of a key and a corresponding value. +
+ +
+

Properties

+
+
+ +
+
Identifier Key
+
+ +The key of a local identifier. + +
+
Name
+
key
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
batchId
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
key
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + Key Regular Expression +
    + +
    +
    Description
    +
    Constraint that ensures that the predefined keys are used.
    +
    + + +
    +
    Regular expression
    +
    ^(manufacturerId|batchId|customKey:\w+)$
    +
    + +
    • +
+
+
+
+
+ +
+
Identifier Value
+
+ +The value of an identifier. + +
+
Name
+
value
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
BID12345678
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
value
+
+ + +
+
+
+
+

Labeling Entity

+
+
+ Entity for the labeling of the chemical material. +
+ +
+

Properties

+
+
+ +
+
Signal Word
+
+ +According to CLP Regulation (EC) No 1272/2008, a "signal word" refers to a term indicating the relative severity of hazards to alert the reader to a potential danger. There are two levels distinguished: +(a) ‘Danger’ means a signal word indicating the more severe hazard categories; +(b) ‘Warning’ means a signal word indicating the less severe hazard categories; + +
+
Name
+
signalWord
+
+ + + +
+
Characteristic
+
+
+
+
Enumeration
+
+
+
Values
+
+
+
+
    +
  • Danger
    • +
  • Warning
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Danger
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
signalWord
+
+ + +
+
+ +
+
Hazard Pictogram
+
+ +A hazard pictogram is a graphical symbol used to convey specific information about the hazards associated with a chemical substance or mixture. + +
+
Name
+
hazardPictogram
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.material.chemical_material_passport:2.0.0#HazardPictogramEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
hazardPictogram
+
+ + +
+
+ +
+
Hazard Statement
+
+ +Describes the nature of a hazard associated with a chemical substance or mixture. + +
+
Name
+
hazardStatement
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.material.chemical_material_passport:2.0.0#HazardStatementEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
hazard
+
+ + +
+
+ +
+
Precautionary
+
+ +A precautionary code for materials is a standardized code used to convey specific precautionary measures that should be taken when handling, storing, or using a chemical substance or mixture. + +
+
Name
+
precautionary
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.material.chemical_material_passport:2.0.0#PrecautionaryEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
precautionary
+
+ + +
+
+ +
+
Supplemental Requirements
+
+ +Supplemental requirements often include additional codes, symbols, or statements beyond those required by regulations. + +
+
Name
+
supplementalRequirements
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.material.chemical_material_passport:2.0.0#SupplementalRequirementsEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
supplementalRequirements
+
+ + +
+
+
+
+

Lifespan Entity

+
+
+ Entity for the lifespan of a product with type, unit and value. +
+ +
+

Properties

+
+
+ +
+
Life Unit
+
+ +The unit of the respective lifespan expressed through the possible units day, month, cycle, year and runningOrOperatingHour. + +
+
Name
+
lifeUnit
+
+ + + +
+
Characteristic
+
+
+
+
Enumeration
+
+
+
Values
+
+
+
+
    +
  • unit:day
    • +
  • unit:month
    • +
  • unit:year
    • +
  • unit:cycle
    • +
  • unit:runningOrOperatingHour
    • +
+
+
+
+
+ Reference +
+
    +
  • https://eclipse-esmf.github.io/samm-specification/2.1.0/index.html
    • +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
unit:month
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
unit
+
+ +
+
Reference
+
+
    +
  • https://eclipse-esmf.github.io/samm-specification/2.1.0/index.html
    • +
+
+
+ +
+
+ +
+
Life Value
+
+ +The value as an integer for the respective lifespan. + +
+
Name
+
lifeValue
+
+ + + +
+
Characteristic
+
+
+
+
Quantifiable
+
+
+
Duration
+
+
+
Characteristic for the life span value as an integer.
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#integer + +
+
+
+
+
+ +
+
Example
+
36
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
value
+
+ + +
+
+ +
+
Life Type
+
+ +The type of lifespan represented with the values guaranteed lifetime, technical lifetime and mean time between failures. This attribute is mentioned in the ESPR proposal from March 30th, 2022 ANNEX I: +(a) durability and reliability of the product or its components as expressed through the product's guaranteed lifetime, technical lifetime [or] mean time between failures [...]. + +
+
Name
+
lifeType
+
+ + + +
+
Characteristic
+
+
+
+
Enumeration
+
+
+
Values
+
+
+
+
    +
  • guaranteed lifetime
    • +
  • technical lifetime
    • +
  • mean time between failures
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
guaranteed lifetime
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
key
+
+ + +
+
+
+
+

Linear Entity

+
+
+ Entity for linear measurements of an item with an unit and value. +
+ +
+

Properties

+
+
+ +
+
Quantity Value
+
+ +The quantity value associated with the unit. + +
+
Name
+
quantityValue
+
+ + + +
+
Characteristic
+
+
+
+
Quantifiable
+
+
+
Duration
+
+
+
The quantity value associated with the unit expressed as float.
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#float + +
+
+
+
+
+ +
+
Example
+
20.0
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
value
+
+ + +
+
+ +
+
Linear Unit
+
+ +The unit of a linear attribute. + +
+
Name
+
linearUnit
+
+ + + +
+
Characteristic
+
+
+
+
Enumeration
+
+
+
Values
+
+
+
+
    +
  • unit:millimetre
    • +
  • unit:centimetre
    • +
  • unit:metre
    • +
  • unit:kilometre
    • +
  • unit:inch
    • +
  • unit:foot
    • +
  • unit:yard
    • +
+
+
+
+
+ Reference +
+
    +
  • https://eclipse-esmf.github.io/samm-specification/2.1.0/index.html
    • +
+
+
+
+
+
+ Type urn:samm:org.eclipse.esmf.samm:meta-model:2.1.0#curie + +
+
+
+
+
+ +
+
Example
+
unit:millimetre
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
unit
+
+ +
+
Reference
+
+
    +
  • https://eclipse-esmf.github.io/samm-specification/2.1.0/index.html
    • +
+
+
+ +
+
+
+
+

Manufacturer Entity

+
+
+ Manufacturing Entity with the identification of the main manufacturer and the facility location as well as the manufacturing date. +
+ +
+

Properties

+
+
+ +
+
Facility Identification
+
+ +The identifier used for a location. In the CATENA-X use case, the BPNA can be stated. This attribute is mentioned in the ESPR provisional agreement from January 9th 2024 Annex III: +(i) unique facility identifiers; +Article 2 Definitions: (33) 'unique facility identifier' means a unique string of characters for the identification of locations or buildings involved in the value chain of a product or used by actors involved in the value chain of a product. + +
+
Name
+
facilityIdentification
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#FacilityEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
facility
+
+ + +
+
+ +
+
Manufacturer Identification
+
+ +The main manufacturer, if different from the passport owner, represented by an identification number. In the Catena-X use case, the BPNL can be stated. This attribute is mentioned in the ESPR provisional agreement from January 9th 2024 Annex III: +(h) unique operator identifiers other than that of the manufacturer; +(k) the name, contact details and unique operator identifier code of the economic operator established in the Union responsible for carrying out the tasks set out in Article 4 of Regulation (EU) 2019/1020, or Article 15 of Regulation (EU) [.../...] on general product safety, or similar tasks pursuant to other EU legislation applicable to the product. + +
+
Name
+
manufacturerIdentification
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
    +
  • https://catena-x.net/fileadmin/user_upload/Standard-Bibliothek/Update_PDF_Maerz/5_BPDM/CX_-_0010_BUSINESS_PARTNER_NUMBER_PlatformCapabilityBPDM_v_1.0.1.pdf
    • +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
manufacturer
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + BPNL Regular Expression +
    + +
    +
    Description
    +
    The provided regular expression ensures that the BPNL is composed of prefix 'BPNL', 10 digits and two alphanumeric letters.
    +
    + + +
    +
    Regular expression
    +
    ^BPNL[a-zA-Z0-9]{12}$
    +
    + +
    • +
+
+
+
+
+ +
+
Manufacturing Date
+
+ +The timestamp in the format (yyyy-mm-dd) of the manufacturing date as the final step in production process (e.g. final quality check, ready-for-shipment event). + +
+
Name
+
manufacturingDate
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
2000-01-31
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
manufacturingDate
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + Date Constraint +
    + +
    +
    Description
    +
    Constraint fo a timestamp in the format (yyyy-mm-dd).
    +
    + + +
    +
    Regular expression
    +
    ^\d{4}-\d{2}-\d{2}$
    +
    + +
    • +
+
+
+
+
+
+
+

Mass Entity

+
+
+ Entity for mass measurements of an item with an unit and value. +
+ +
+

Properties

+
+
+ +
+
Quantity Value
+
+ +The quantity value associated with the unit. + +
+
Name
+
quantityValue
+
+ + + +
+
Characteristic
+
+
+
+
Quantifiable
+
+
+
Duration
+
+
+
The quantity value associated with the unit expressed as float.
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#float + +
+
+
+
+
+ +
+
Example
+
20.0
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
value
+
+ + +
+
+ +
+
Mass Unit
+
+ +The unit of a mass related attribute. + +
+
Name
+
massUnit
+
+ + + +
+
Characteristic
+
+
+
+
Enumeration
+
+
+
Values
+
+
+
+
    +
  • unit:gram
    • +
  • unit:kilogram
    • +
  • unit:tonneMetricTon
    • +
  • unit:tonUsOrShortTonUkorus
    • +
  • unit:ounceAvoirdupois
    • +
  • unit:pound
    • +
+
+
+
+
+ Reference +
+
    +
  • https://eclipse-esmf.github.io/samm-specification/2.1.0/index.html
    • +
+
+
+
+
+
+ Type urn:samm:org.eclipse.esmf.samm:meta-model:2.1.0#curie + +
+
+
+
+
+ +
+
Example
+
unit:kilogram
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
unit
+
+ +
+
Reference
+
+
    +
  • https://eclipse-esmf.github.io/samm-specification/2.1.0/index.html
    • +
+
+
+ +
+
+
+
+

Material Entity

+
+
+ Information regarding recycled and/or renewable materials in the product. +
+ +
+

Properties

+
+
+ +
+
Recycled
+
+ +The share of the material, which is recovered recycled content from the product. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I: +(h) use or content of recycled materials and recovery of materials, including critical raw materials; + +
+
Name
+
recycled
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#float + +
+
+
+
+
+ +
+
Example
+
12.5
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
recycled
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + Percentage Constraint +
    + +
    +
    Description
    +
    Range constraint for a positive percentage value.
    +
    + + +
    +
    +>= +
    + DefaultScalarValue[value=0.0, typeUri='DefaultScalar[metaModelVersion=SAMM_2_1_0, urn='http://www.w3.org/2001/XMLSchema#float']'] +
    +
    ...
    +
    +< + DefaultScalarValue[value=100.0, typeUri='DefaultScalar[metaModelVersion=SAMM_2_1_0, urn='http://www.w3.org/2001/XMLSchema#float']'] +
    + +
    • +
+
+
+
+
+ +
+
Renewable
+
+ +The share of the material, which is from a renewable resource that can be replenished. Renewable resources are those that can be reproduced by physical, chemical, or mechanical processes. These are the kind of resources that can be regenerated throughout time. Forest wood, for example, can be grown through reforestation. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I: +(ha) use or content of sustainable renewable materials; + + +
+
Name
+
renewable
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#float + +
+
+
+
+
+ +
+
Example
+
23.5
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
renewable
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + Percentage Constraint +
    + +
    +
    Description
    +
    Range constraint for a positive percentage value.
    +
    + + +
    +
    +>= +
    + DefaultScalarValue[value=0.0, typeUri='DefaultScalar[metaModelVersion=SAMM_2_1_0, urn='http://www.w3.org/2001/XMLSchema#float']'] +
    +
    ...
    +
    +< + DefaultScalarValue[value=100.0, typeUri='DefaultScalar[metaModelVersion=SAMM_2_1_0, urn='http://www.w3.org/2001/XMLSchema#float']'] +
    + +
    • +
+
+
+
+
+ +
+
Material Unit
+
+ +The unit of concentration chosen from an enumeration: mass percent, volume percent, parts per thousand, parts per million, parts per billion and parts per trillion. + +
+
Name
+
materialUnit
+
+ + + +
+
Characteristic
+
+
+
+
Enumeration
+
+
+
Values
+
+
+
+
    +
  • unit:partPerMillion
    • +
  • unit:percent
    • +
  • unit:percentVolume
    • +
  • unit:partPerThousand
    • +
  • unit:partPerTrillionUs
    • +
  • unit:partPerBillionUs
    • +
+
+
+
+
+ Reference +
+
    +
  • https://eclipse-esmf.github.io/samm-specification/2.1.0/index.html
    • +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
unit:percent
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
unit
+
+ +
+
Reference
+
+
    +
  • https://eclipse-esmf.github.io/samm-specification/2.1.0/index.html
    • +
+
+
+ +
+
+ +
+
Material Identification
+
+ +The chemical material name and identification, in accordance with the specification in the attribute for the list type. Preference is given to the IUPAC name. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Article 7: +(5) (a) the name of the substances of concern present in the product, as follows: + - name(s) in the International Union of Pure and Applied Chemistry (IUPAC) nomenclature, or another international name when IUPAC name is not available; +- other names (usual name, trade name, abbreviation); +- European Community (EC) number, as indicated in the European Inventory of Existing Commercial Chemical Substances (EINECS), the European List of Notified Chemical Substances (ELINCS) or the No Longer Polymer (NLP) list or assigned by the European Chemicals Agency (ECHA), if available; +- the Chemical Abstract Service (CAS) name(s) and number(s), if available; . + +
+
Name
+
materialIdentification
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#MaterialIdEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
id
+
+ + +
+
+ +
+
Critical
+
+ +A flag, if the material is a critical raw material. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I: +(h) use or content of recycled materials and recovery of materials, including critical raw materials; +In Annex II of the connected proposal Act of Critical Raw Materials, a list of critical raw materials can be found. + +
+
Name
+
critical
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#boolean + +
+
+
+
+
+ +
+
Example
+
true
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
critical
+
+ +
+
Reference
+
+
    +
  • https://eur-lex.europa.eu/legal-content/EN/TXT/?uri=COM:2023:0160:FIN
    • +
+
+
+ +
+
+ +
+
Concentration
+
+ +Concentration of the material at the level of the product. This attribute is specially mentioned for substances of concern mentioned in the ESPR proposal from March 30th, 2022 Article 7: +(5) (c) the concentration, maximum concentration or concentration range of the substances of concern, at the level of the product [...]. +Other substances are mentioned for the purpose of recycling in the ESPR provisional agreement from January 9th, 2024 Annex I: +(d) design for recycling, ease and quality of recycling as expressed through: use of easily recyclable materials, safe, easy and non-destructive access to recyclable components and materials or components and materials containing hazardous substances and material composition and homogeneity, possibility for high-purity sorting, number of materials and components used, use of standard components, use of component and material coding standards for the identification of components and materials, number and complexity of processes and tools needed, ease of nondestructive disassembly and re-assembly, conditions for access to product data, conditions for access to or use of hardware and software needed. + + +
+
Name
+
concentration
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#float + +
+
+
+
+
+ +
+
Example
+
5.3
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
concentration
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + Positive Range Constraint +
    + +
    +
    Description
    +
    Constraint for only positive values.
    +
    + + +
    +
    +>= +
    + DefaultScalarValue[value=0.0, typeUri='DefaultScalar[metaModelVersion=SAMM_2_1_0, urn='http://www.w3.org/2001/XMLSchema#float']'] +
    +
    + +
    • +
+
+
+
+
+ +
+
Documentation
+
+ +Documentation accompanying the material. + +
+
Name
+
documentation
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#DocumentationEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
documentation
+
+ + +
+
+
+
+

Material Id Entity

+
+
+ Id Entity with identifier, name and list type. +
+ +
+

Properties

+
+
+ +
+
Chemical Id
+
+ +The substance identification, in accordance with the specification in the attribute for the list type. + +
+
Name
+
chemicalId
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
201-004-7
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
id
+
+ + +
+
+ +
+
List Type Id
+
+ +The type of standard used for the identification of the substances. Selected can be for example CAS, IUPAC or EC. + +
+
Name
+
listTypeId
+
+ + + +
+
Characteristic
+
+
+
+
Enumeration
+
+
+
Values
+
+
+
+
    +
  • CAS
    • +
  • EC
    • +
  • IUPAC
    • +
+
+
+
+
+ Reference +
+
    +
  • https://www.cas.org/cas-data/cas-registry
    • +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
CAS
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
type
+
+ + +
+
+ +
+
Chemical Name
+
+ +The name of the material which is present in the product. + +
+
Name
+
chemicalName
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
phenolphthalein
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
name
+
+ + +
+
+
+
+

Materials Entity

+
+
+ Entity with materials on the level of the product. +
+ +
+

Properties

+
+
+ +
+
Substances of Concern
+
+ +Information regarding substances of concern in the product. The ESPR provisional agreement from January 9th, 2024 defines: +(52) 'hazardous substance' means a substance classified as hazardous pursuant to Article 3 of Regulation (EC) No 1272/2008. + +
+
Name
+
substancesOfConcern
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#SubstanceOfConcernEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
substancesOfConcern
+
+ + +
+
+ +
+
Material Composition
+
+ +Material composition of the product with information on recycled and renewable materials. + +
+
Name
+
materialComposition
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#ChemicalMaterialEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
materialComposition
+
+ + +
+
+
+
+

Metadata Entity

+
+
+ Passport Entity to describe version, status, end and issue date. +
+ +
+

Properties

+
+
+ +
+
Version
+
+ +The current version of the product passport. The possibility of modification/ updating the product passport needs to include versioning of the dataset. This attribute is an internal versioning from the passport issuer. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Article 8: +(1) [...] The information in the product passport shall be accurate, complete, and up to date. + +
+
Name
+
version
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
1.0.0
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
version
+
+ + +
+
+ +
+
Status
+
+ +The current status of the product passport declared through either: draft, approved, invalid or expired. + +
+
Name
+
status
+
+ + + +
+
Characteristic
+
+
+
+
Enumeration
+
+
+
Values
+
+
+
+
    +
  • draft
    • +
  • approved
    • +
  • invalid
    • +
  • expired
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
draft
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
status
+
+ + +
+
+ +
+
Expiration Date
+
+ +The timestamp in the format (yyyy-mm-dd) for the product passport until when it is available or a comment describing this period. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Article 8: +(2) (h) the period during which the product passport is to remain available, which shall correspond to at least the expected lifetime of a specific product. + +
+
Name
+
expirationDate
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
2030-01-01
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
expirationDate
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + Date Constraint +
    + +
    +
    Description
    +
    Constraint fo a timestamp in the format (yyyy-mm-dd).
    +
    + + +
    +
    Regular expression
    +
    ^\d{4}-\d{2}-\d{2}$
    +
    + +
    • +
+
+
+
+
+ +
+
Issue Date
+
+ +The timestamp in the format (yyyy-mm-dd) since when the product passport is available. + +
+
Name
+
issueDate
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
2000-01-01
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
issueDate
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + Date Constraint +
    + +
    +
    Description
    +
    Constraint fo a timestamp in the format (yyyy-mm-dd).
    +
    + + +
    +
    Regular expression
    +
    ^\d{4}-\d{2}-\d{2}$
    +
    + +
    • +
+
+
+
+
+ +
+
Economic Operator Id
+
+ +The identification of the owner/economic operator of the passport. Proposed, according to ISO 15459, is the CIN (company identification code). Other identification numbers like the tax identification number, value added tax identification number, commercial register number and the like are also valid entries. In the Catena-X network, the BPNL is used for the identification of companies and the information stored like contact information and addresses. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Annex III: +(k) the [...] unique operator identifier code of the economic operator established in the Union responsible for carrying out the tasks set out in Article 4 of Regulation (EU) 2019/1020, or Article 15 of Regulation (EU) on general product safety, or similar tasks pursuant to other EU legislation applicable to the product. + +
+
Name
+
economicOperatorId
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
    +
  • https://catena-x.net/fileadmin/user_upload/Standard-Bibliothek/Update_PDF_Maerz/5_BPDM/CX_-_0010_BUSINESS_PARTNER_NUMBER_PlatformCapabilityBPDM_v_1.0.1.pdf
    • +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
BPNL0123456789ZZ
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
economicOperatorId
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + BPNL Regular Expression +
    + +
    +
    Description
    +
    The provided regular expression ensures that the BPNL is composed of prefix 'BPNL', 10 digits and two alphanumeric letters.
    +
    + + +
    +
    Regular expression
    +
    ^BPNL[a-zA-Z0-9]{12}$
    +
    + +
    • +
+
+
+
+
+ +
+
Passport Identifier
+
+ +The identifier of the product passport, which is an uuidv4. + +
+
Name
+
passportIdentifier
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
    +
  • https://tools.ietf.org/html/rfc4122
    • +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
urn:uuid:550e8400-e29b-41d4-a716-446655440000
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
passportIdentifier
+
+ + +
+
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
    +
    (^[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}$)
    +
    + +
    • +
+
+
+
+
+ +
+
Predecessor
+
+ +Identification of the preceding product passport. If there is no preceding passport, input a dummy value. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Article 8: +(2)(g) [...] Any new product passport shall be linked to the product passport or passports of the original product whenever appropriate. + +
+
Name
+
predecessor
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
    +
  • https://tools.ietf.org/html/rfc4122
    • +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
urn:uuid:00000000-0000-0000-0000-000000000000
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
predecessor
+
+ + +
+
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
    +
    (^[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}$)
    +
    + +
    • +
+
+
+
+
+ +
+
Backup Reference
+
+ +A reference to the data backup of the passport. This mandatory attribute will be further defined in the future. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex III: +(kb) the reference of the certified independent third-party product passport service provider hosting the back-up copy of the product passport. +Article 10 also mentions: +(c) the data included in the product passport shall be stored by the economic operator responsible for its creation or by certified independent third-party product passport service providers authorised to act on their behalf. + +
+
Name
+
backupReference
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
https://dummy.link
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
backupReference
+
+ + +
+
+ +
+
Registration Identifier
+
+ +Identifier in the respective registry. This will be further defined in the future. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 in Article 12: +By [2 years from entering into force of this Regulation], the Commission shall set up and manage a digital registry ("the registry") storing in a secure manner at least the unique product identifier, the unique operator identifier, the unique facility identifiers. In case of products intended to be placed under the customs procedure 'release for free circulation', the registry shall also store the product commodity code. The registry shall also store the batteries' unique identifiers referred to in Article 77(3) of Regulation (EU) 2023/1542. + +
+
Name
+
registrationIdentifier
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
https://dummy.link/ID8283746239078
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
registrationIdentifier
+
+ + +
+
+ +
+
Last Modification
+
+ +Date of the latest modification. + +
+
Name
+
lastModification
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
2000-01-01
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
lastModification
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + Date Constraint +
    + +
    +
    Description
    +
    Constraint fo a timestamp in the format (yyyy-mm-dd).
    +
    + + +
    +
    Regular expression
    +
    ^\d{4}-\d{2}-\d{2}$
    +
    + +
    • +
+
+
+
+
+
+
+

Operation Entity

+
+
+ Operational information of the product such as the owner, manufacturer and importer. +
+ +
+

Properties

+
+
+ +
+
Manufacturer
+
+ +Manufacturing information of the product. In the CATENA-X use case, the BPNL and BPNA can be stated. These attributes are mentioned in the ESPR provisional agreement from January 9th 2024 Annex III: +(h) unique operator identifiers other than that of the manufacturer; +(k) the name, contact details and unique operator identifier code of the economic operator established in the Union responsible for carrying out the tasks set out in Article 4 of Regulation (EU) 2019/1020, or Article 15 of Regulation (EU) [.../...] on general product safety, or similar tasks pursuant to other EU legislation applicable to the product. + +
+
Name
+
manufacturer
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#ManufacturerEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
manufacturer
+
+ + +
+
+ +
+
Import
+
+ +Importer details such as the identification. + +
+
Name
+
import
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#ImportEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
import
+
+ + +
+
+ +
+
Other Operators
+
+ +Other operators relevant for the product. + +
+
Name
+
otherOperators
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#OperatorEntity + +
+
+
+
+
+ + +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
other
+
+ + +
+
+
+
+

Operator Entity

+
+
+ Operator with role and identification. +
+ +
+

Properties

+
+
+ +
+
Other Operator Id
+
+ +Identifier of the other operator. This can be a BPN. + +
+
Name
+
otherOperatorId
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
BPNL0123456789XX
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
id
+
+ + +
+
+ +
+
Other Operator Role
+
+ +Role of the other operator. + +
+
Name
+
otherOperatorRole
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
distributor
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
role
+
+ + +
+
+
+
+

Parameter After Use Entity

+
+
+ Characteristic for parameters of the chemical material after use. +
+ +
+

Properties

+
+
+ +
+
Parameter After Use Documentation
+
+ +Parameters of a product that may change or become relevant after its intended use are often documented as post-application characteristics. This data can be found in documents such as "Technical Documentation." + +
+
Name
+
parameterAfterUseDocumentation
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#DocumentationEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
documentation
+
+ + +
+
+ +
+
Applicable
+
+ +Check whether the connected attributes are applicable to the product. If it is not applicable (false), dummy data can be delivered. + +
+
Name
+
applicable
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#boolean + +
+
+
+
+
+ +
+
Example
+
true
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
applicable
+
+ + +
+
+
+
+

Parameter Before Use Entity

+
+
+ Entity for parameters of the chemical material before use. +
+ +
+

Properties

+
+
+ +
+
Product Parameter Name
+
+ +The name of the parameter for the product tested and presented, for instance, in the Certificate of Analysis or Safety Data Sheet, found in Section 9. Parameters for chemical products usually encompass their chemical composition, physical properties, performance characteristics, and toxicological aspects. These parameters vary depending on the chemical's nature, its intended use, and relevant safety or regulatory considerations. + +
+
Name
+
productParameterName
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
VOC content
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
name
+
+ + +
+
+ +
+
Product Parameter Value
+
+ +The value resulting from the tested parameter is typically presented in Section 9 of the Safety Data Sheet or Certificate of Analysis. + +
+
Name
+
productParameterValue
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
95.5
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
value
+
+ + +
+
+ +
+
Product Parameter Unit
+
+ +The unit of measurement for the parameter value presented in Section 9 of the Safety Data Sheet or Certificate of Analysis varies depending on the specific parameter being reported. + +
+
Name
+
productParameterUnit
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
unit:percent
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
unit
+
+ +
+
Reference
+
+
    +
  • https://eclipse-esmf.github.io/samm-specification/2.1.0/appendix/unitcatalog.html
    • +
+
+
+ +
+
+ +
+
Product Parameter Result
+
+ +Other types of results, if not numerical values, for parameters presented in Section 9 of the Safety Data Sheet or Certificate of Analysis may include qualitative descriptions like "pass" or "fail," as well as ranges, thresholds, or classifications. + +
+
Name
+
productParameterResult
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
positive
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
result
+
+ + +
+
+ +
+
Product Parameter Method
+
+ +Testing methods or standards used for testing parameters. + +
+
Name
+
productParameterMethod
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.material.chemical_material_passport:2.0.0#ParameterMethodEntity + +
+
+
+
+
+ + +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
method
+
+ + +
+
+ +
+
Product Parameter Remark
+
+ +Commentary on the test/parameter presented in the Certificate of Analysis or Safety Data Sheet in Section 9. Selecting "not applicable" is also an option. + +
+
Name
+
productParameterRemark
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
not applicable
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
remark
+
+ + +
+
+ +
+
Parameter Classification Statement
+
+ +List of classification statements resulting from the test should include information on whether the result impacts the hazard classification of the product, particularly in the case of properties such as explosives in Safety Data Sheets (SDS). + +
+
Name
+
parameterClassificationStatement
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Risk of explosion if heated under confinement
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
classificationStatement
+
+ + +
+
+ +
+
Parameter Test GLP Compliance
+
+ +Statement indicating whether the test for the parameter was conducted in accordance with the Good Laboratory Practice (GLP) standard, as outlined in ISO/IEC 17025:2017, which specifies general requirements for the competence of testing and calibration laboratories. + +
+
Name
+
parameterTestGLPCompliance
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#boolean + +
+
+
+
+
+ +
+
Example
+
false
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
testGLPCompliance
+
+ +
+
Reference
+
+
    +
  • https://www.iso.org/standard/66912.html
    • +
+
+
+ +
+
+ +
+
Parameter Documentation
+
+ +Reference to the confirmation of the result typically includes a link to the document containing the confirmation, such as the Certificate of Analysis (CoA). + +
+
Name
+
parameterDocumentation
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#DocumentationEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
documentation
+
+ + +
+
+
+
+

Parameter Entity

+
+
+ Parameter Entity for the chemical material. +
+ +
+

Properties

+
+
+ +
+
Parameter Before Use
+
+ +Parameters of the chemical material before use. + +
+
Name
+
parameterBeforeUse
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.material.chemical_material_passport:2.0.0#ParameterBeforeUseEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
parameterBeforeUse
+
+ + +
+
+ +
+
Parameter After Use
+
+ +Parameters of the chemical material after use. + +
+
Name
+
parameterAfterUse
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.material.chemical_material_passport:2.0.0#ParameterAfterUseEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
parameterAfterUse
+
+ + +
+
+
+
+

Parameter Method Entity

+
+
+ Testing methods or standards used for testing parameters with method names. +
+ +
+

Properties

+
+
+ +
+
Parameter Method Name
+
+ +The name of the testing method or standard used for testing parameters can vary depending on the context and industry. It might be referred to by a specific code, standard name, or regulation/directive. + +
+
Name
+
parameterMethodName
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Directive 2004/42/CE
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
parameterMethodName
+
+ + +
+
+ +
+
Parameter Method Conditions
+
+ +The relevant conditions for conducting a measurement or analysis of a chemical parameter ensure the accuracy, reliability, and consistency of the results obtained from the method used. These conditions are typically presented in the Certificate of Analysis or Safety Data Sheet, specifically in Section 9. + +
+
Name
+
parameterMethodConditions
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
50 degree celsius
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
parameterMethodConditions
+
+ + +
+
+ +
+
Parameter Method Description
+
+ +Short description of the method used to determine parameter presented in Certificate of Analysis or Safety Data Sheet in Section 9. + +
+
Name
+
parameterMethodDescription
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Evaporation in oven.
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
parameterMethodDescription
+
+ + +
+
+
+
+

Part Type Entity

+
+
+ Entity for the part type with manufacturer id and name. +
+ +
+

Properties

+
+
+ +
+
Manufacturer Part ID
+
+ +Part ID as assigned by the manufacturer of the part. The part ID identifies the part in the manufacturer`s dataspace. The part ID references a specific version of a part. The version number must be included in the part ID if it is available. The part ID does not reference a specific instance of a part and must not be confused with the serial number. + +
+
Name
+
manufacturerPartId
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
123-0.740-3434-A
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
manufacturerPartId
+
+ + +
+
+ +
+
Name at manufacturer
+
+ +Name of the part as assigned by the manufacturer. + +
+
Name
+
nameAtManufacturer
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Mirror left
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
nameAtManufacturer
+
+ + +
+
+
+
+

Physical Dimension Entity

+
+
+ Entity for physical dimensions with linear, mass and capacity attributes. Either weight or volume is mandatory. +
+ +
+

Properties

+
+
+ +
+
Width
+
+ +The width of the item measured in a specific linear unit which can be declared in the corresponding unit attribute. + +
+
Name
+
width
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.shared.quantity:2.0.0#LinearEntity + +
+
+
+
+
+ + +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
width
+
+ + +
+
+ +
+
Length
+
+ +The length of the item measured in a specific linear unit which can be declared in the corresponding unit attribute. + +
+
Name
+
length
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.shared.quantity:2.0.0#LinearEntity + +
+
+
+
+
+ + +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
length
+
+ + +
+
+ +
+
Diameter
+
+ +The diameter of the item, if applicable, measured in a specific linear unit which can be declared in the corresponding unit attribute. + +
+
Name
+
diameter
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.shared.quantity:2.0.0#LinearEntity + +
+
+
+
+
+ + +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
diameter
+
+ + +
+
+ +
+
Height
+
+ +The height of the item measured in a specific linear unit which can be declared in the corresponding unit attribute. + +
+
Name
+
height
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.shared.quantity:2.0.0#LinearEntity + +
+
+
+
+
+ + +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
height
+
+ + +
+
+ +
+
Gross Weight
+
+ +The gross weight of the item measured in a specific mass unit which can be declared in the corresponding unit attribute. Gross weight refers to the total weight of a product, including the weight of the packaging. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7: +(2) (b) (i) information on the performance of the product in relation to the product parameters referred to in Annex I; +Annex I (i) weight and volume of the product and its packaging, and the product-to-packaging ratio. + +
+
Name
+
grossWeight
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.shared.quantity:2.0.0#MassEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
grossWeight
+
+ + +
+
+ +
+
Gross Volume
+
+ +The gross volume of the item, if possible, measured in a specific capacity unit which can be declared in the corresponding unit attribute. If there is no separate packing, the volume of the product shall be given. Gross volume refers to the total volume of a product, including the volume of the packaging. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7: +(2) (b) (i) information on the performance of the product in relation to the product parameters referred to in Annex I; +Annex I (i) weight and volume of the product and its packaging, and the product-to-packaging ratio. + +
+
Name
+
grossVolume
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.shared.quantity:2.0.0#VolumeEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
grossVolume
+
+ + +
+
+ +
+
Weight
+
+ +Weight of the product measured in a specific mass unit which can be declared in the corresponding unit attribute. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7: +(2) (b) (i) information on the performance of the product in relation to the product parameters referred to in Annex I; +Annex I (i) weight and volume of the product [...]. + +
+
Name
+
weight
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.shared.quantity:2.0.0#MassEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
weight
+
+ + +
+
+ +
+
Volume
+
+ +Volume of the product, if possible, measured in a specific capacity unit which can be declared in the corresponding unit attribute. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7: +(2) (b) (i) information on the performance of the product in relation to the product parameters referred to in Annex I; +Annex I (i) weight and volume of the product [...]. + +
+
Name
+
volume
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.shared.quantity:2.0.0#VolumeEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
volume
+
+ + +
+
+
+
+

Precautionary Entity

+
+
+ Entity for precautionary codes. +
+ +
+

Properties

+
+
+ +
+
Precautionary Code
+
+ +Each precautionary statement is designated a code, starting with the letter P and followed by three digits. + +
+
Name
+
precautionaryCode
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
P103
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
code
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + Precautionary Code Constraint +
    + +
    +
    Description
    +
    Constraint starting with the letter P followed by three digits.
    +
    + + +
    +
    Regular expression
    +
    ^P\d{3}$
    +
    + +
    • +
+
+
+
+
+ +
+
Precautionary Text
+
+ +Definition from CLP Regulation (EC) No 1272/2008: ‘precautionary statement’ means a phrase that describes recommended measure(s) to minimise or prevent adverse effects resulting from exposure to a hazardous substance or mixture due to its use or disposal. + +
+
Name
+
precautionaryText
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Read label before use.
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
text
+
+ + +
+
+
+
+

Product Footprint Entity

+
+
+ The Product Footprint Entity with sustainability information such as the different environmental footprint types, the carbon and material footprint explicitly, applicable rules and lifecycle stages. +
+ +
+

Properties

+
+
+ +
+
Environmental Footprint
+
+ +The environmental footprint of the product. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I: +The following parameters shall, as appropriate, and where necessary supplemented by others, be used, individually or combined, as a basis for improving the product aspects referred to in Article 5(1): +(l) the environmental footprint of the product, expressed as a quantification, in accordance with the applicable delegated act, of a product's life cycle environmental impacts, whether in relation to one or more environmental impact categories or an aggregated set of impact categories. +and Article 7: +(2)(b)(i) information on the performance of the product in relation to one or more of the product parameters referred to in Annex I, including a scoring of reparability or durability, carbon footprint or environmental footprint; +and defined by Article 2: +(23) 'environmental footprint' means a quantification of product environmental impacts throughout its life cycle, whether in relation to a single environmental impact category or an aggregated set of impact categories based on the Product Environmental Footprint method or other scientific methods developed by international organisations and widely tested in collaboration with different industry sectors and adopted or implemented by the Commission in other Union legislation; +(24) 'Product Environmental Footprint method' means the life cycle assessment method to quantify the environmental impacts of products established by Recommendation (EU) 2021/2279. + +
+
Name
+
environmentalFootprint
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#FootprintEntity + +
+
+
+
+
+ + +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
environmental
+
+ + +
+
+ +
+
Carbon Footprint
+
+ +The carbon footprint of the product. This is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I: +The following parameters shall, as appropriate, and where necessary supplemented by others, be used, individually or combined, as a basis for improving the product aspects referred to in Article 5(1): +(m) the carbon footprint of the product; +and Article 7: +(2)(b)(i) information on the performance of the product in relation to one or more of the product parameters referred to in Annex I, including a scoring of reparability or durability, carbon footprint or environmental footprint; +and defined by Article 2: +(25) 'carbon footprint' means the sum of greenhouse gas (GHG) emissions and GHG removals in a product system, expressed as CO2 equivalents and based on a life cycle assessment using the single impact category of climate change. + +
+
Name
+
carbonFootprint
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#FootprintEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
carbon
+
+ + +
+
+ +
+
Material Footprint
+
+ +The material footprint of the product. This is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I: +(ma) the material footprint of the product; +and defined by Article 2: +(25a) 'material footprint' refers to the total amount of raw materials extracted to meet final consumption demands. + +
+
Name
+
materialFootprint
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#FootprintEntity + +
+
+
+
+
+ + +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
material
+
+ + +
+
+
+
+

Product Transport Entity

+
+
+ Entity for transport. +
+ +
+

Properties

+
+
+ +
+
Emergency Temperature Min Value
+
+ +The critical minimum temperature for transporting the product refers to the lowest temperature at which the product can be safely transported without compromising its integrity or functionality. Emergency temperature refers to a temperature that poses a significant risk, potentially leading to hazardous conditions or product damage. + +
+
Name
+
emergencyTemperatureMinValue
+
+ + + +
+
Characteristic
+
+
+
+
Measurement
+
+
+
Measurement as float in celsius degree.
+
+
+
Unit
+
+
+
+
    +
  • + degree Celsius +
    • +
  • + Symbol °C +
    • +
  • + Code CEL +
    • +
  • + Conversion factor 1 × K +
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#float + +
+
+
+
+
+ +
+
Example
+
-20.0
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
emergencyTemperatureMin
+
+ + +
+
+ +
+
Emergency Temperature Max Value
+
+ +The critical maximum temperature for transporting the product refers to the highest temperature at which the product can be safely transported without degradation or posing a risk. Emergency temperature refers to a temperature that poses a significant risk, potentially leading to hazardous conditions or product damage. + +
+
Name
+
emergencyTemperatureMaxValue
+
+ + + +
+
Characteristic
+
+
+
+
Measurement
+
+
+
Measurement as float in celsius degree.
+
+
+
Unit
+
+
+
+
    +
  • + degree Celsius +
    • +
  • + Symbol °C +
    • +
  • + Code CEL +
    • +
  • + Conversion factor 1 × K +
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#float + +
+
+
+
+
+ +
+
Example
+
35.0
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
emergencyTemperatureMax
+
+ + +
+
+ +
+
Transport Other Information
+
+ +Additional information related to the transport of the product. Relevant details that could aid in making decisions regarding the shipping of the product. + +
+
Name
+
transportOtherInformation
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Not permitted for transport
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
other
+
+ + +
+
+ +
+
Control Temperature
+
+ +The controlled temperature for transportation refers to the range of values within which the temperature conditions of goods or products are monitored and regulated during transportation in degree celcius. This information is crucial for mitigating risks associated with temperature-sensitive products, ensuring their integrity and quality throughout the shipping process. + +
+
Name
+
controlTemperature
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
20 - 25 C
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
controlTemperature
+
+ + +
+
+ +
+
Transport Pictogram
+
+ +Links to transport related pictograms. + +
+
Name
+
transportPictogram
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
https://example.link
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
pictogram
+
+ + +
+
+
+
+

Range Entity

+
+
+ Entity for the concentration range with two values, the highest and the lowest of the concentration range. +
+ +
+

Properties

+
+
+ +
+
Minimum Concentration
+
+ +The minimum concentration of the substance of concern at the level of the product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7: +(5) (c) [...] concentration range of the substances of concern, at the level of the product [...]. + +
+
Name
+
minConcentration
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#float + +
+
+
+
+
+ +
+
Example
+
2.1
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
min
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + Positive Range Constraint +
    + +
    +
    Description
    +
    Constraint for only positive values.
    +
    + + +
    +
    +>= +
    + DefaultScalarValue[value=0.0, typeUri='DefaultScalar[metaModelVersion=SAMM_2_1_0, urn='http://www.w3.org/2001/XMLSchema#float']'] +
    +
    + +
    • +
+
+
+
+
+ +
+
Maximum Concentration
+
+ +The maximum concentration of the substance of concern at the level of the product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7: +(5) (c) the concentration, maximum concentration or concentration range of the substances of concern, at the level of the product [...]. + +
+
Name
+
maxConcentration
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#float + +
+
+
+
+
+ +
+
Example
+
2.6
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
max
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + Positive Range Constraint +
    + +
    +
    Description
    +
    Constraint for only positive values.
    +
    + + +
    +
    +>= +
    + DefaultScalarValue[value=0.0, typeUri='DefaultScalar[metaModelVersion=SAMM_2_1_0, urn='http://www.w3.org/2001/XMLSchema#float']'] +
    +
    + +
    • +
+
+
+
+
+
+
+

Safety Entity

+
+
+ Entity for safety information. +
+ +
+

Properties

+
+
+ +
+
Safety Documentation
+
+ +Safety information in a document that outlines safety protocols, procedures, and guidelines to be followed in specific situations involving the product. It provides clear instructions on accident prevention, how to respond to emergencies, and mitigate potential hazards. Examples include exposure scenarios, safety data sheets, risk assessments, and information on safety equipment and personal protective equipment (PPE). + +
+
Name
+
safetyDocumentation
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#DocumentationEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
documentation
+
+ + +
+
+ +
+
Emergency Phone
+
+ +A phone number in case of emergency serves the vital purpose of providing immediate access to emergency responders. + +
+
Name
+
emergencyPhone
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.material.chemical_material_passport:2.0.0#EmergencyEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
emergencyPhone
+
+ + +
+
+ +
+
First Aid Document
+
+ +Information on how to proceed in case of an emergency is essential. It includes guidance on providing initial assistance or immediate care to a person who has been injured before professional medical help arrives. + +
+
Name
+
firstAidDocument
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#DocumentationEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
firstAidDocument
+
+ + +
+
+
+
+

Special Provisions Code Entity

+
+
+ Entity for the special provisions code. +
+ +
+

Properties

+
+
+ +
+
Special Provisions Code
+
+ +Code of special provisions or exceptions that must be met. + +
+
Name
+
specialProvisionsCode
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#integer + +
+
+
+
+
+ +
+
Example
+
274
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
code
+
+ +
+
Reference
+
+
    +
  • https://unece.org/sites/default/files/2023-08/ST-SG-AC10-1r23e_Vol1_WEB.pdf
    • +
+
+
+ +
+
+ +
+
Special Provisions Info
+
+ +Text aligned with special provisions under UN transport regulation Chapter 3.3. + +
+
Name
+
specialProvisionsInfo
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
The provision of 3.1.2.8 apply
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
text
+
+ +
+
Reference
+
+
    +
  • https://unece.org/sites/default/files/2023-08/ST-SG-AC10-1r23e_Vol1_WEB.pdf
    • +
+
+
+ +
+
+
+
+

Specific Entity

+
+
+ The Entity for product specific parameters of the electric drive. +
+ +
+

Properties

+
+
+ +
+
Parameter
+
+ +Parameters of the chemical material. + +
+
Name
+
parameter
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.material.chemical_material_passport:2.0.0#ParameterEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
parameter
+
+ + +
+
+ +
+
Product Type
+
+ +Information, whether the product is a substance, mixture or article. Definitions from REACH Regulation (EC) No 1907/2006: +"substance": means a chemical element and its compounds in the natural state or obtained by any manufacturing process, including any additive necessary to preserve its stability and any impurity deriving from the process used, but excluding any solvent which may be separated without affecting the stability of the substance or changing its composition; +"mixture": means a mixture or solution composed of two or more substances; +"article": means an object which during production is given a special shape, surface or design which determines its function to a greater degree than does its chemical composition; + +
+
Name
+
productType
+
+ + + +
+
Characteristic
+
+
+
+
Enumeration
+
+
+
Values
+
+
+
+
    +
  • substance
    • +
  • mixture
    • +
  • article
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
substance
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
productType
+
+ +
+
Reference
+
+
    +
  • https://eur-lex.europa.eu/legal-content/EN/TXT/?uri=CELEX:02006R1907-20231201
    • +
+
+
+ +
+
+ +
+
Hazard Assessment
+
+ +Hazard assessment refers to evaluating and identifying potential risks or dangers associated with the specific material. + +
+
Name
+
hazardAssessment
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.material.chemical_material_passport:2.0.0#HazardAssessmentEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
hazardAssessment
+
+ + +
+
+ +
+
Transport
+
+ +Transport related information. + +
+
Name
+
transport
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.material.chemical_material_passport:2.0.0#TransportEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
transport
+
+ + +
+
+ +
+
Disposal
+
+ +The safe and appropriate elimination or management of these materials once they are no longer needed or usable. + +
+
Name
+
disposal
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.material.chemical_material_passport:2.0.0#DisposalEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
disposal
+
+ + +
+
+ +
+
Safety
+
+ +Safety related attributes of the chemical material. + +
+
Name
+
safety
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.material.chemical_material_passport:2.0.0#SafetyEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
safety
+
+ + +
+
+ +
+
Compliance
+
+ +Compliance refers to adhering to relevant regulations, standards, or specifications regarding the testing, documentation, and presentation of parameters, methods, and results. This ensures that the product meets required safety, quality, and regulatory standards throughout its lifecycle, from manufacturing to post-application use. + +
+
Name
+
compliance
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.material.chemical_material_passport:2.0.0#ComplianceEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
compliance
+
+ + +
+
+
+
+

Substance Entity

+
+
+ Information regarding substances of concern in the product. +
+ +
+

Properties

+
+
+ +
+
Location
+
+ +The location of the substances of concern within the product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7: +(5) (b) the location of the substances of concern within the product. + +
+
Name
+
location
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Housing
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
location
+
+ + +
+
+ +
+
Material Unit
+
+ +The unit of concentration chosen from an enumeration: mass percent, volume percent, parts per thousand, parts per million, parts per billion and parts per trillion. + +
+
Name
+
materialUnit
+
+ + + +
+
Characteristic
+
+
+
+
Enumeration
+
+
+
Values
+
+
+
+
    +
  • unit:partPerMillion
    • +
  • unit:percent
    • +
  • unit:percentVolume
    • +
  • unit:partPerThousand
    • +
  • unit:partPerTrillionUs
    • +
  • unit:partPerBillionUs
    • +
+
+
+
+
+ Reference +
+
    +
  • https://eclipse-esmf.github.io/samm-specification/2.1.0/index.html
    • +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
unit:percent
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
unit
+
+ +
+
Reference
+
+
    +
  • https://eclipse-esmf.github.io/samm-specification/2.1.0/index.html
    • +
+
+
+ +
+
+ +
+
Concentration
+
+ +Concentration of the material at the level of the product. This attribute is specially mentioned for substances of concern mentioned in the ESPR proposal from March 30th, 2022 Article 7: +(5) (c) the concentration, maximum concentration or concentration range of the substances of concern, at the level of the product [...]. +Other substances are mentioned for the purpose of recycling in the ESPR provisional agreement from January 9th, 2024 Annex I: +(d) design for recycling, ease and quality of recycling as expressed through: use of easily recyclable materials, safe, easy and non-destructive access to recyclable components and materials or components and materials containing hazardous substances and material composition and homogeneity, possibility for high-purity sorting, number of materials and components used, use of standard components, use of component and material coding standards for the identification of components and materials, number and complexity of processes and tools needed, ease of nondestructive disassembly and re-assembly, conditions for access to product data, conditions for access to or use of hardware and software needed. + + +
+
Name
+
concentration
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#float + +
+
+
+
+
+ +
+
Example
+
5.3
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
concentration
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + Positive Range Constraint +
    + +
    +
    Description
    +
    Constraint for only positive values.
    +
    + + +
    +
    +>= +
    + DefaultScalarValue[value=0.0, typeUri='DefaultScalar[metaModelVersion=SAMM_2_1_0, urn='http://www.w3.org/2001/XMLSchema#float']'] +
    +
    + +
    • +
+
+
+
+
+ +
+
Exemption
+
+ +Exemptions to the substance of concern. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Article 7: +(5) (c) provide duly justified exemptions for substances of concern or information elements from the information requirements referred to in the first subparagraph based on the technical feasibility or relevance of tracking substances of concern, the existence of analytical methods to detect and quantify them, the need to protect confidential business information or in other duly justified cases. Substances of concern within the meaning of Article 2(28), point a), shall not be exempted if they are present in products, their relevant components or spare parts in a concentration above 0,1 % weight by weight. + +
+
Name
+
exemption
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
shall not apply to product x containing not more than 1,5 ml of liquid
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
exemption
+
+ + +
+
+ +
+
Hazard Classification
+
+ +The specification of the hazard class. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I: +(f) use of substances, and in particular the use of substances of concern, on their own, as constituents of substances or in mixtures, during the production process of products, or leading to their presence in products, including once these products become waste, and their impacts on human health and the environment; +Further defined is this by Regulation (EC) No 1272/2008 of the European Parliament and of the Council of 16 December 2008 on classification, labelling and packaging of substances and mixtures, amending and repealing Directives 67/548/EEC and 1999/45/EC, and amending Regulation (EC) No 1907/2006. +Defined in Article 2: +1. 'hazard class' means the nature of the physical, health or environmental hazard; +2. 'hazard category' means the division of criteria within each hazard class, specifying hazard severity; +5. 'hazard statement' means a phrase assigned to a hazard class and category that describes the nature of the hazards of a hazardous substance or mixture, including, where appropriate, the degree of hazard; + +
+
Name
+
hazardClassification
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#HazardEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
hazardClassification
+
+ +
+
Reference
+
+
    +
  • https://eur-lex.europa.eu/legal-content/EN/TXT/?uri=CELEX:02008R1272-20231201
    • +
+
+
+ +
+
+ +
+
Concentration Range
+
+ +The concentration range for the substance of concern. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7: +(5) (c) [...] concentration range of the substances of concern, at the level of the product [...]. + +
+
Name
+
concentrationRange
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#RangeEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
concentrationRange
+
+ + +
+
+ +
+
Material Identification
+
+ +The chemical material name and identification, in accordance with the specification in the attribute for the list type. Preference is given to the IUPAC name. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Article 7: +(5) (a) the name of the substances of concern present in the product, as follows: + - name(s) in the International Union of Pure and Applied Chemistry (IUPAC) nomenclature, or another international name when IUPAC name is not available; +- other names (usual name, trade name, abbreviation); +- European Community (EC) number, as indicated in the European Inventory of Existing Commercial Chemical Substances (EINECS), the European List of Notified Chemical Substances (ELINCS) or the No Longer Polymer (NLP) list or assigned by the European Chemicals Agency (ECHA), if available; +- the Chemical Abstract Service (CAS) name(s) and number(s), if available; . + +
+
Name
+
materialIdentification
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#MaterialIdEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
id
+
+ + +
+
+ +
+
Documentation
+
+ +Documentation accompanying the material. + +
+
Name
+
documentation
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#DocumentationEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
documentation
+
+ + +
+
+
+
+

Substance Of Concern Entity

+
+
+ Substance of Concern entity with attributes if applicable to the product. +
+ +
+

Properties

+
+
+ +
+
Applicable
+
+ +Check whether the connected attributes are applicable to the product. If it is not applicable (false), dummy data can be delivered. + +
+
Name
+
applicable
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#boolean + +
+
+
+
+
+ +
+
Example
+
true
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
applicable
+
+ + +
+
+ +
+
Substance of Concern
+
+ +Information regarding substances of concern in the product. Attributes are among others substance names, ids, concentration, location and hazard class. This is mentioned in the ESPR provisional agreement from January 9th, 2024 Article 7: +(5) (a) the name of the substances of concern present in the product, as follows: +- name(s) in the International Union of Pure and Applied Chemistry (IUPAC) nomenclature, or another international name when IUPAC name is not available; +- other names (usual name, trade name, abbreviation); +- European Community (EC) number, as indicated in the European Inventory of Existing Commercial Chemical Substances (EINECS), the European List of Notified Chemical Substances (ELINCS) or the No Longer Polymer (NLP) list or assigned by the European Chemicals Agency (ECHA), if available; +- the Chemical Abstract Service (CAS) name(s) and number(s), if available; +(5) (b) the location of the substances of concern within the product. +(5) (c) the concentration, maximum concentration or concentration range of the substances of concern, at the level of the product its relevant components, or spare parts; +(d) relevant instructions for the safe use of the product; +(e) information relevant for disassembly, preparation for reuse, reuse, recycling and the environmentally sound management of the product at the end of its life. +And in the next paragraph: +(c) provide duly justified exemptions for substances of concern or information elements from the information requirements referred to in the first subparagraph. + +
+
Name
+
substanceOfConcern
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#SubstanceEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
content
+
+ + +
+
+
+
+

Supplemental Requirements Entity

+
+
+ Entity for supplemental requirements. +
+ +
+

Properties

+
+
+ +
+
Supplemental Requirements Code
+
+ +Supplemental codes used for labeling statements provide additional information or context about the hazards, handling, or regulatory requirements associated with chemical materials. This data can be helpful for stakeholders in managing chemical materials by offering further guidance on safe handling practices, storage conditions, emergency response procedures, or regulatory compliance measures. + +
+
Name
+
supplementalRequirementsCode
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
XYZ
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
code
+
+ + +
+
+ +
+
Supplemental Requirements Text
+
+ +Any supplemental text used for labeling provides data that could be helpful for stakeholders in managing chemical materials. + +
+
Name
+
supplementalRequirementsText
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Substance is phototoxic.
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
text
+
+ + +
+
+ +
+
Supplemental Requirements Pictogram
+
+ +Supplemental pictures or pictograms used for additional labeling provide data that could be helpful for stakeholders in managing chemical materials. + +
+
Name
+
supplementalRequirementsPictogram
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
https://example.link
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
pictogram
+
+ + +
+
+ +
+
Product Labeling Notes
+
+ +Labeling notes consist of statements that provide additional information regarding hazardous possible reactions or other important considerations related to the chemical material. These notes help stakeholders understand potential risks and take appropriate precautions when handling, storing, or using the material. + +
+
Name
+
productLabelingNotes
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
The substance can react dangerously with: alcohols
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
notes
+
+ + +
+
+
+
+

Sustainability Entity

+
+
+ Entity with the properties regarding the sustainability of the product. +
+ +
+

Properties

+
+
+ +
+
State
+
+ +The status of the product (original, repurposed, re-used, remanufactured or waste) to indicated, whether it is a used product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Annex I: +(j) incorporation of used components. + +
+
Name
+
state
+
+ + + +
+
Characteristic
+
+
+
+
Enumeration
+
+
+
Values
+
+
+
+
    +
  • original
    • +
  • repurposed
    • +
  • re-used
    • +
  • remanufactured
    • +
  • waste
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
original
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
status
+
+ + +
+
+ +
+
Product Footprint
+
+ +The carbon and environmental footprint or material footprint of the product. These attributes are mentioned in the ESPR provisional agreement from January 9th 2024 Annex I: +(l) the environmental footprint of the product, expressed as a quantification, in accordance with the applicable delegated act, of a product's life cycle environmental impacts, whether in relation to one or more environmental impact categories or an aggregated set of impact categories; +(m) the carbon footprint of the product; +(ma) the material footprint of the product; +All are defined by Article 2: +(23) 'environmental footprint' means a quantification of product environmental impacts throughout its life cycle, whether in relation to a single environmental impact category or an aggregated set of impact categories based on the Product Environmental Footprint method or other scientific methods developed by international organisations and widely tested in collaboration with different industry sectors and adopted or implemented by the Commission in other Union +legislation; +(25) 'carbon footprint' means the sum of greenhouse gas (GHG) emissions and GHG removals in a product system, expressed as CO2 equivalents and based on a life cycle assessment using the single impact category of climate change. +(25a) 'material footprint' refers to the total amount of raw materials extracted to meet final consumption demands; + +
+
Name
+
productFootprint
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#ProductFootprintEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
productFootprint
+
+ + +
+
+ +
+
Reparability Score
+
+ +The reparability score. This attribute is mentioned ESPR provisional agreement from January 9th, 2024 Article 7: +(b) as appropriate, also require products to be accompanied by: +(i) information on the performance of the product in relation to one or more of the product parameters referred to in Annex I, including a scoring of reparability or durability [...]. + +
+
Name
+
reparabilityScore
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
B
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
reparabilityScore
+
+ + +
+
+ +
+
Durability Score
+
+ +The durability score. This attribute is mentioned ESPR provisional agreement from January 9th, 2024 Article 7: +(b) as appropriate, also require products to be accompanied by: +(i) information on the performance of the product in relation to one or more of the product parameters referred to in Annex I, including a scoring of reparability or durability [...]. + +
+
Name
+
durabilityScore
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
A
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
durabilityScore
+
+ + +
+
+
+
+

Transport Entity

+
+
+ Entity for transport attributes. +
+ +
+

Properties

+
+
+ +
+
Product Transport
+
+ +Transport related attributes, which are not UN related. + +
+
Name
+
productTransport
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.material.chemical_material_passport:2.0.0#ProductTransportEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
productTransport
+
+ + +
+
+ +
+
UN Transport
+
+ +Transport related attributes from the UN. + +
+
Name
+
unTransport
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.material.chemical_material_passport:2.0.0#UNTransportEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
unTransport
+
+ + +
+
+
+
+

UN Transport Entity

+
+
+ Entity with transport related attributes. +
+
+ Reference +
+
    +
  • https://unece.org/sites/default/files/2023-08/ST-SG-AC10-1r23e_Vol1_WEB.pdf
    • +
+
+
+ +
+

Properties

+
+
+ +
+
Transport Regulation
+
+ +Indicate regulations for transportation for example: Land transport (ADR/RID), Inland waterway transport (ADN), Sea transport (IMDG), Air transport (ICAO-TI/IATA-DGR) and so on. + +
+
Name
+
transportRegulation
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
ADR - Agreement concerning the International Carriage of Dangerous Goods by Road
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
transportRegulation
+
+ + +
+
+ +
+
UN Number
+
+ +The UN number or ID number is a four-digit identification code for substances, mixtures, or articles. + +
+
Name
+
unNumber
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
3113
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
unNumber
+
+ +
+
Reference
+
+
    +
  • https://unece.org/sites/default/files/2023-08/ST-SG-AC10-1r23e_Vol1_WEB.pdf
    • +
+
+
+ +
+
Constraints
+
+
    +
  • +
    + +
    + UN Number Constraint +
    + +
    +
    Description
    +
    Constraint to four digits numbers.
    +
    + + +
    +
    Regular expression
    +
    ^\d{4}$
    +
    + +
    • +
+
+
+
+
+ +
+
UN Shipping Name
+
+ +The proper shipping name is provided in column 2, "Name and description," of Table A of Chapter 3.2 Dangerous Goods List of the UN Regulations. + +
+
Name
+
unShippingName
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
ORGANIC PEROXIDE TYPE C, LIQUID, TEMPERATURE CONTROLLED (Tert-BUTYL PEROXY-2-ETHYLHEXANOATE)
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
unShippingName
+
+ +
+
Reference
+
+
    +
  • https://unece.org/sites/default/files/2023-08/ST-SG-AC10-1r23e_Vol1_WEB.pdf
    • +
+
+
+ +
+
+ +
+
UN Hazard Class Code
+
+ +The transport class of the dangerous group according to UN Regulations. + +
+
Name
+
unHazardClassCode
+
+ + + +
+
Characteristic
+
+
+
+
Quantifiable
+
+
+
Duration
+
+
+
Value as float.
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#float + +
+
+
+
+
+ +
+
Example
+
5.2
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
unHazardClassCode
+
+ + +
+
+ +
+
UN Hazard Class Name
+
+ +The classified dangerous group in transportation refers to the classification of hazardous materials or dangerous goods according to the United Nations (UN) Globally Harmonized System of Classification and Labelling of Chemicals (GHS) and the UN Model Regulations for the Transport of Dangerous Goods. + +
+
Name
+
unHazardClassName
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Oxidising substances
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
unHazardClassName
+
+ + +
+
+ +
+
UN Packaging Group
+
+ +Group to which certain substances may be assigned for packaging purposes according to their degree of danger: +Packaging group I: Substances presenting high danger, +Packaging group II: Substances presenting medium danger, +Packaging group III: Substances presenting low danger. +Not all dangerous goods assigned to hazard classes or their divisions will be allocated to Packaging Groups. + +
+
Name
+
unPackagingGroup
+
+ + + +
+
Characteristic
+
+
+
+
Enumeration
+
+
+
Values
+
+
+
+
    +
  • I
    • +
  • II
    • +
  • III
    • +
  • not applicable
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
I
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
unPackagingGroup
+
+ +
+
Reference
+
+
    +
  • https://unece.org/sites/default/files/2023-08/ST-SG-AC10-1r23e_Vol1_WEB.pdf
    • +
+
+
+ +
+
+ +
+
UN Excepted Quantity Code
+
+ +Chapter 3.5 of UN Transportation Regulation pertains to dangerous goods packed in excepted quantities, with possible codes including E0, E1, E2, E3, E4, and E5. + +
+
Name
+
unExceptedQuantityCode
+
+ + + +
+
Characteristic
+
+
+
+
Enumeration
+
+
+
Values
+
+
+
+
    +
  • E0
    • +
  • E1
    • +
  • E2
    • +
  • E3
    • +
  • E4
    • +
  • E5
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
E0
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
unExceptedQuantityCode
+
+ +
+
Reference
+
+
    +
  • https://unece.org/sites/default/files/2023-08/ST-SG-AC10-1r23e_Vol1_WEB.pdf
    • +
+
+
+ +
+
+ +
+
Environmentally Hazardous
+
+ +The indication of whether a substance or mixture is environmentally hazardous according to the criteria of the UN Model Regulations (as reflected in ADR, RID, and ADN) and whether it is a marine pollutant according to the IMDG Code and the Emergency Response Procedures for Ships Carrying Dangerous Goods. + +
+
Name
+
environmentallyHazardous
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Marine pollutant
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
environmentallyHazardous
+
+ + +
+
+ +
+
UN Special Provisions Code
+
+ +The UN Special Provisions Code refers to a set of additional requirements or conditions specified by the United Nations for the transportation of certain dangerous goods. + +
+
Name
+
unSpecialProvisionsCode
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.material.chemical_material_passport:2.0.0#SpecialProvisionsCodeEntity + +
+
+
+
+
+ + +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
unSpecialProvisionsCode
+
+ + +
+
+ +
+
UN Limited Quantity Value
+
+ +Maximum quantity per inner packaging or article for carrying dangerous goods refers to the maximum amount of a hazardous material permitted for transportation. + +
+
Name
+
unLimitedQuantityValue
+
+ + + +
+
Characteristic
+
+
+
+
Quantifiable
+
+
+
Duration
+
+
+
Value as float.
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#float + +
+
+
+
+
+ +
+
Example
+
5.0
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
unLimitedQuantityValue
+
+ + +
+
+ +
+
UN Limited Quantity Unit
+
+ +Unit of the limited quantity value. + +
+
Name
+
unLimitedQuantityUnit
+
+ + + +
+
Characteristic
+
+
+
+
Enumeration
+
+
+
Values
+
+
+
+
    +
  • unit:piece
    • +
  • unit:set
    • +
  • unit:pair
    • +
  • unit:page
    • +
  • unit:cycle
    • +
  • unit:kilowattHour
    • +
  • unit:gram
    • +
  • unit:kilogram
    • +
  • unit:tonneMetricTon
    • +
  • unit:tonUsOrShortTonUkorus
    • +
  • unit:ounceAvoirdupois
    • +
  • unit:pound
    • +
  • unit:metre
    • +
  • unit:centimetre
    • +
  • unit:kilometre
    • +
  • unit:inch
    • +
  • unit:foot
    • +
  • unit:yard
    • +
  • unit:squareCentimetre
    • +
  • unit:squareMetre
    • +
  • unit:squareInch
    • +
  • unit:squareFoot
    • +
  • unit:squareYard
    • +
  • unit:cubicCentimetre
    • +
  • unit:cubicMetre
    • +
  • unit:cubicInch
    • +
  • unit:cubicFoot
    • +
  • unit:cubicYard
    • +
  • unit:litre
    • +
  • unit:millilitre
    • +
  • unit:hectolitre
    • +
  • unit:secondUnitOfTime
    • +
  • unit:minuteUnitOfTime
    • +
  • unit:hourUnitOfTime
    • +
  • unit:day
    • +
+
+
+
+
+ Reference +
+
    +
  • https://eclipse-esmf.github.io/samm-specification/2.1.0/index.html
    • +
+
+
+
+
+
+ Type urn:samm:org.eclipse.esmf.samm:meta-model:2.1.0#curie + +
+
+
+
+
+ +
+
Example
+
unit:kilogram
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
unLimitedQuantityUnit
+
+ + +
+
+
+
+

Volume Entity

+
+
+ Entity for volume measurements of an item with an unit and value. +
+ +
+

Properties

+
+
+ +
+
Quantity Value
+
+ +The quantity value associated with the unit. + +
+
Name
+
quantityValue
+
+ + + +
+
Characteristic
+
+
+
+
Quantifiable
+
+
+
Duration
+
+
+
The quantity value associated with the unit expressed as float.
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#float + +
+
+
+
+
+ +
+
Example
+
20.0
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
value
+
+ + +
+
+ +
+
Volume Unit
+
+ +The unit of a volume related attribute. + +
+
Name
+
volumeUnit
+
+ + + +
+
Characteristic
+
+
+
+
Enumeration
+
+
+
Values
+
+
+
+
    +
  • unit:cubicMetre
    • +
  • unit:litre
    • +
  • unit:millilitre
    • +
  • unit:cubicCentimetre
    • +
  • unit:cubicInch
    • +
  • unit:cubicFoot
    • +
  • unit:cubicYard
    • +
  • unit:hectolitre
    • +
+
+
+
+
+ Reference +
+
    +
  • https://eclipse-esmf.github.io/samm-specification/2.1.0/index.html
    • +
+
+
+
+
+
+ Type urn:samm:org.eclipse.esmf.samm:meta-model:2.1.0#curie + +
+
+
+
+
+ +
+
Example
+
unit:litre
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
unit
+
+ +
+
Reference
+
+
    +
  • https://eclipse-esmf.github.io/samm-specification/2.1.0/index.html
    • +
+
+
+ +
+
+
+
+

Waste Code Entity

+
+
+ Entity for the waste code of the material. +
+ +
+

Properties

+
+
+ +
+
Waste Code Description
+
+ +Description of the related waste code. + +
+
Name
+
wasteCodeDescription
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
waste paint and varnish containing organic solvents or other hazardous substances
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
description
+
+ + +
+
+ +
+
Waste Code Regulation
+
+ +The name of the regulation that applies to waste codes can vary depending on the region or jurisdiction. Examples include Regulation (EC) No 1013/2006 in the European Union or Annex VIII of the Basel Convention. + +
+
Name
+
wasteCodeRegulation
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
European List of Waste acc. Regulation (EC) No 1013/2006
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
regulation
+
+ +
+
Reference
+
+
    +
  • https://eur-lex.europa.eu/legal-content/EN/TXT/?uri=CELEX:02000D0532-20150601
    • +
+
+
+ +
+
+ +
+
Waste Code
+
+ +A waste code is used to identify the type of waste. + +
+
Name
+
wasteCode
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
08 01 11*
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
code
+
+ + +
+
+
+ +
+ Third party licenses + +
+ +
+ + +
+ + + \ No newline at end of file diff --git a/io.catenax.material.chemical_material_passport/2.0.0/gen/ChemicalMaterialPassport.json b/io.catenax.material.chemical_material_passport/2.0.0/gen/ChemicalMaterialPassport.json new file mode 100644 index 000000000..4b5f737de --- /dev/null +++ b/io.catenax.material.chemical_material_passport/2.0.0/gen/ChemicalMaterialPassport.json @@ -0,0 +1,373 @@ +{ + "specific" : { + "safety" : { + "emergencyPhone" : { + "number" : "+49111222333", + "availability" : "Only available during the following office hours: xx - xx" + }, + "firstAidDocument" : [ { + "contentType" : "URL", + "header" : "Example Document XYZ", + "content" : "https://dummy.link" + } ], + "documentation" : [ { + "contentType" : "URL", + "header" : "Example Document XYZ", + "content" : "https://dummy.link" + } ] + }, + "compliance" : { + "complianceCountry" : [ "UK" ], + "complianceRemark" : "If you need more information about the (pre-)registration status, please get in contact with our experts from the Compliance Team: www.xyz.com", + "complianceReasonForExemption" : [ "Radioactive substance" ], + "complianceResult" : true, + "complianceRegulationName" : [ "UK -REACH regulation" ] + }, + "parameter" : { + "parameterBeforeUse" : [ { + "result" : "positive", + "unit" : "unit:percent", + "method" : [ { + "parameterMethodName" : "Directive 2004/42/CE", + "parameterMethodConditions" : "50 degree celsius", + "parameterMethodDescription" : "Evaporation in oven." + } ], + "testGLPCompliance" : false, + "documentation" : [ { + "contentType" : "URL", + "header" : "Example Document XYZ", + "content" : "https://dummy.link" + } ], + "name" : "VOC content", + "remark" : "not applicable", + "value" : "95.5", + "classificationStatement" : [ "Risk of explosion if heated under confinement" ] + } ], + "parameterAfterUse" : { + "applicable" : true, + "documentation" : [ { + "contentType" : "URL", + "header" : "Example Document XYZ", + "content" : "https://dummy.link" + } ] + } + }, + "hazardAssessment" : { + "classification" : [ { + "route" : "oral", + "hazardous" : true, + "statement" : "Causes severe skin burns and eye damage.", + "rule" : "CLP Regulation (EC) No 1272/2008", + "remark" : "No additional information available", + "category" : "category 1A", + "class" : "Skin corrosion" + } ], + "labeling" : { + "hazardPictogram" : [ { + "name" : "Corrosive", + "image" : "https://example.link", + "code" : "GHS05" + } ], + "signalWord" : "Danger", + "hazard" : [ { + "code" : "H220", + "text" : "Extremely flammable gas" + } ], + "precautionary" : { + "code" : "P103", + "text" : "Read label before use." + }, + "supplementalRequirements" : [ { + "code" : "XYZ", + "text" : "Substance is phototoxic.", + "notes" : "The substance can react dangerously with: alcohols", + "pictogram" : "https://example.link" + } ] + }, + "documentation" : [ { + "contentType" : "URL", + "header" : "Example Document XYZ", + "content" : "https://dummy.link" + } ] + }, + "transport" : { + "unTransport" : [ { + "unShippingName" : "ORGANIC PEROXIDE TYPE C, LIQUID, TEMPERATURE CONTROLLED (Tert-BUTYL PEROXY-2-ETHYLHEXANOATE)", + "unLimitedQuantityUnit" : "unit:piece", + "unExceptedQuantityCode" : "E0", + "unSpecialProvisionsCode" : [ { + "code" : 274, + "text" : "The provision of 3.1.2.8 apply" + } ], + "unPackagingGroup" : "I", + "unHazardClassCode" : 5.2, + "environmentallyHazardous" : [ "Marine pollutant" ], + "unNumber" : "3113", + "transportRegulation" : "ADR - Agreement concerning the International Carriage of Dangerous Goods by Road", + "unHazardClassName" : "Oxidising substances", + "unLimitedQuantityValue" : 5.0 + } ], + "productTransport" : { + "emergencyTemperatureMax" : 35.0, + "controlTemperature" : "20 - 25 C", + "other" : "Not permitted for transport", + "emergencyTemperatureMin" : -20.0, + "pictogram" : [ "https://example.link" ] + } + }, + "productType" : "substance", + "disposal" : { + "wasteCode" : { + "regulation" : "European List of Waste acc. Regulation (EC) No 1013/2006", + "description" : "waste paint and varnish containing organic solvents or other hazardous substances", + "code" : "08 01 11*" + }, + "packaging" : [ { + "contentType" : "URL", + "header" : "Example Document XYZ", + "content" : "https://dummy.link" + } ], + "beforeUse" : [ { + "contentType" : "URL", + "header" : "Example Document XYZ", + "content" : "https://dummy.link" + } ], + "afterUse" : [ { + "contentType" : "URL", + "header" : "Example Document XYZ", + "content" : "https://dummy.link" + } ] + } + }, + "generic" : { + "characteristics" : { + "generalPerformanceClass" : "A", + "physicalState" : "solid", + "physicalDimension" : { + "volume" : { + "value" : 20.0, + "unit" : "unit:cubicMetre" + }, + "grossWeight" : { + "value" : 20.0, + "unit" : "unit:gram" + }, + "diameter" : { + "value" : 20.0, + "unit" : "unit:millimetre" + }, + "grossVolume" : { + "value" : 20.0, + "unit" : "unit:cubicMetre" + }, + "width" : { + "value" : 20.0, + "unit" : "unit:millimetre" + }, + "length" : { + "value" : 20.0, + "unit" : "unit:millimetre" + }, + "weight" : { + "value" : 20.0, + "unit" : "unit:gram" + }, + "height" : { + "value" : 20.0, + "unit" : "unit:millimetre" + } + }, + "lifespan" : [ { + "value" : 36, + "unit" : "unit:day", + "key" : "guaranteed lifetime" + } ] + }, + "commercial" : { + "placedOnMarket" : "2000-01-01", + "purpose" : [ "automotive" ] + }, + "metadata" : { + "backupReference" : "https://dummy.link", + "registrationIdentifier" : "https://dummy.link/ID8283746239078", + "economicOperatorId" : "BPNL0123456789ZZ", + "lastModification" : "2000-01-01", + "predecessor" : "urn:uuid:00000000-0000-0000-0000-000000000000", + "issueDate" : "2000-01-01", + "version" : "1.0.0", + "passportIdentifier" : "urn:uuid:550e8400-e29b-41d4-a716-446655440000", + "status" : "draft", + "expirationDate" : "2030-01-01" + }, + "identification" : { + "batch" : [ { + "value" : "BID12345678", + "key" : "batchId" + } ], + "codes" : [ { + "value" : "8703 24 10 00", + "key" : "TARIC" + } ], + "type" : { + "manufacturerPartId" : "123-0.740-3434-A", + "nameAtManufacturer" : "Mirror left" + }, + "classification" : [ { + "classificationStandard" : "GIN 20510-21513", + "classificationID" : "1004712", + "classificationDescription" : "Generic standard for classification of parts in the automotive industry." + } ], + "serial" : [ { + "value" : "SN12345678", + "key" : "partInstanceId" + } ], + "dataCarrier" : { + "carrierType" : "QR", + "carrierLayout" : "upper-left side" + } + }, + "sources" : [ { + "header" : "Example Document XYZ", + "category" : "Product Specifications", + "type" : "URL", + "content" : "https://dummy.link" + } ], + "materials" : { + "substancesOfConcern" : { + "applicable" : true, + "content" : [ { + "unit" : "unit:partPerMillion", + "hazardClassification" : { + "category" : "category 1A", + "statement" : "Causes severe skin burns and eye damage.", + "class" : "Skin corrosion" + }, + "documentation" : [ { + "contentType" : "URL", + "header" : "Example Document XYZ", + "content" : "https://dummy.link" + } ], + "concentrationRange" : [ { + "max" : 2.6, + "min" : 2.1 + } ], + "location" : "Housing", + "concentration" : 5.3, + "exemption" : "shall not apply to product x containing not more than 1,5 ml of liquid", + "id" : [ { + "type" : "CAS", + "name" : "phenolphthalein", + "id" : "201-004-7" + } ] + } ] + }, + "materialComposition" : { + "applicable" : true, + "content" : [ { + "unit" : "unit:partPerMillion", + "recycled" : 12.5, + "critical" : true, + "renewable" : 23.5, + "documentation" : [ { + "contentType" : "URL", + "header" : "Example Document XYZ", + "content" : "https://dummy.link" + } ], + "concentration" : 5.3, + "id" : [ { + "type" : "CAS", + "name" : "phenolphthalein", + "id" : "201-004-7" + } ] + } ] + } + }, + "operation" : { + "import" : { + "applicable" : true, + "content" : { + "eori" : "GB123456789000", + "id" : "BPNL0123456789ZZ" + } + }, + "other" : { + "id" : "BPNL0123456789XX", + "role" : "distributor" + }, + "manufacturer" : { + "facility" : [ { + "facility" : "BPNA1234567890AA" + } ], + "manufacturingDate" : "2000-01-31", + "manufacturer" : "BPNLEBzuVKNzzEOA" + } + }, + "sustainability" : { + "reparabilityScore" : "B", + "productFootprint" : { + "material" : [ { + "lifecycle" : "main product production", + "rulebook" : [ { + "contentType" : "URL", + "header" : "Example Document XYZ", + "content" : "https://dummy.link" + } ], + "unit" : "kg CO2 / kWh", + "performanceClass" : "A", + "manufacturingPlant" : [ { + "facility" : "BPNA1234567890AA" + } ], + "type" : "Climate Change Total", + "value" : 12.678, + "declaration" : [ { + "contentType" : "URL", + "header" : "Example Document XYZ", + "content" : "https://dummy.link" + } ] + } ], + "carbon" : [ { + "lifecycle" : "main product production", + "rulebook" : [ { + "contentType" : "URL", + "header" : "Example Document XYZ", + "content" : "https://dummy.link" + } ], + "unit" : "kg CO2 / kWh", + "performanceClass" : "A", + "manufacturingPlant" : [ { + "facility" : "BPNA1234567890AA" + } ], + "type" : "Climate Change Total", + "value" : 12.678, + "declaration" : [ { + "contentType" : "URL", + "header" : "Example Document XYZ", + "content" : "https://dummy.link" + } ] + } ], + "environmental" : [ { + "lifecycle" : "main product production", + "rulebook" : [ { + "contentType" : "URL", + "header" : "Example Document XYZ", + "content" : "https://dummy.link" + } ], + "unit" : "kg CO2 / kWh", + "performanceClass" : "A", + "manufacturingPlant" : [ { + "facility" : "BPNA1234567890AA" + } ], + "type" : "Climate Change Total", + "value" : 12.678, + "declaration" : [ { + "contentType" : "URL", + "header" : "Example Document XYZ", + "content" : "https://dummy.link" + } ] + } ] + }, + "status" : "original", + "durabilityScore" : "A" + } + } +} \ No newline at end of file diff --git a/io.catenax.material.chemical_material_passport/2.0.0/gen/ChemicalMaterialPassport.yml b/io.catenax.material.chemical_material_passport/2.0.0/gen/ChemicalMaterialPassport.yml new file mode 100644 index 000000000..234a3bf04 --- /dev/null +++ b/io.catenax.material.chemical_material_passport/2.0.0/gen/ChemicalMaterialPassport.yml @@ -0,0 +1,2179 @@ +--- +openapi: 3.0.3 +info: + title: Chemical Material Passport + version: v2 +servers: +- url: catenax.io/api/v2 + variables: + api-version: + default: v2 +paths: + /{tenant-id}/chemical-material-passport: + get: + tags: + - ChemicalMaterialPassport + operationId: getChemicalMaterialPassport + 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/ChemicalMaterialPassport' + "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_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.material.chemical_material_passport_2.0.0_ParameterMethodEntity: + description: Testing methods or standards used for testing parameters with method + names. + type: object + properties: + parameterMethodName: + description: "The name of the testing method or standard used for testing\ + \ parameters can vary depending on the context and industry. It might\ + \ be referred to by a specific code, standard name, or regulation/directive." + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + parameterMethodConditions: + description: "The relevant conditions for conducting a measurement or analysis\ + \ of a chemical parameter ensure the accuracy, reliability, and consistency\ + \ of the results obtained from the method used. These conditions are typically\ + \ presented in the Certificate of Analysis or Safety Data Sheet, specifically\ + \ in Section 9." + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + parameterMethodDescription: + description: Short description of the method used to determine parameter + presented in Certificate of Analysis or Safety Data Sheet in Section 9. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + required: + - parameterMethodName + - parameterMethodConditions + - parameterMethodDescription + urn_samm_io.catenax.material.chemical_material_passport_2.0.0_ParameterMethodList: + description: List of testing methods or standards used for testing parameters. + type: array + items: + $ref: '#/components/schemas/urn_samm_io.catenax.material.chemical_material_passport_2.0.0_ParameterMethodEntity' + urn_samm_io.catenax.material.chemical_material_passport_2.0.0_StringList: + description: List of text strings. + type: array + items: + type: string + 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.generic.digital_product_passport_5.0.0_HeaderTrait: + type: string + description: Constraint for a maximum of 100 characters. + maxLength: 100 + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentationEntity: + description: "Entity for a document with a header, type and content." + type: object + properties: + content: + description: The content of the document e.g a link. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + contentType: + description: "The type of content which can be expected in the \"content\"\ + \ property. Examples are a link, restricted link, pdf, excel, etc." + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + header: + description: The header as a short description of the document with a maximum + of 100 characters. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_HeaderTrait' + required: + - content + - contentType + - header + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentList: + description: List of documents. + type: array + items: + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentationEntity' + urn_samm_io.catenax.material.chemical_material_passport_2.0.0_ParameterBeforeUseEntity: + description: Entity for parameters of the chemical material before use. + type: object + properties: + name: + description: "The name of the parameter for the product tested and presented,\ + \ for instance, in the Certificate of Analysis or Safety Data Sheet, found\ + \ in Section 9. Parameters for chemical products usually encompass their\ + \ chemical composition, physical properties, performance characteristics,\ + \ and toxicological aspects. These parameters vary depending on the chemical's\ + \ nature, its intended use, and relevant safety or regulatory considerations." + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + value: + description: The value resulting from the tested parameter is typically + presented in Section 9 of the Safety Data Sheet or Certificate of Analysis. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + unit: + description: The unit of measurement for the parameter value presented in + Section 9 of the Safety Data Sheet or Certificate of Analysis varies depending + on the specific parameter being reported. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + result: + description: "Other types of results, if not numerical values, for parameters\ + \ presented in Section 9 of the Safety Data Sheet or Certificate of Analysis\ + \ may include qualitative descriptions like \"pass\" or \"fail,\" as well\ + \ as ranges, thresholds, or classifications." + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + method: + description: Testing methods or standards used for testing parameters. + $ref: '#/components/schemas/urn_samm_io.catenax.material.chemical_material_passport_2.0.0_ParameterMethodList' + remark: + description: Commentary on the test/parameter presented in the Certificate + of Analysis or Safety Data Sheet in Section 9. Selecting "not applicable" + is also an option. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + classificationStatement: + description: "List of classification statements resulting from the test\ + \ should include information on whether the result impacts the hazard\ + \ classification of the product, particularly in the case of properties\ + \ such as explosives in Safety Data Sheets (SDS)." + $ref: '#/components/schemas/urn_samm_io.catenax.material.chemical_material_passport_2.0.0_StringList' + testGLPCompliance: + description: "Statement indicating whether the test for the parameter was\ + \ conducted in accordance with the Good Laboratory Practice (GLP) standard,\ + \ as outlined in ISO/IEC 17025:2017, which specifies general requirements\ + \ for the competence of testing and calibration laboratories." + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Boolean' + documentation: + description: "Reference to the confirmation of the result typically includes\ + \ a link to the document containing the confirmation, such as the Certificate\ + \ of Analysis (CoA)." + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentList' + required: + - name + - value + - unit + - result + - testGLPCompliance + - documentation + urn_samm_io.catenax.material.chemical_material_passport_2.0.0_ParameterBeforeUseList: + description: List of parameters of the chemical material before use. + type: array + items: + $ref: '#/components/schemas/urn_samm_io.catenax.material.chemical_material_passport_2.0.0_ParameterBeforeUseEntity' + urn_samm_io.catenax.material.chemical_material_passport_2.0.0_ParameterAfterUseCharacteristic: + description: Characteristic for parameters of the chemical material after use. + type: object + properties: + documentation: + description: Parameters of a product that may change or become relevant + after its intended use are often documented as post-application characteristics. + This data can be found in documents such as "Technical Documentation." + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentList' + applicable: + description: "Check whether the connected attributes are applicable to the\ + \ product. If it is not applicable (false), dummy data can be delivered." + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Boolean' + required: + - documentation + - applicable + urn_samm_io.catenax.material.chemical_material_passport_2.0.0_ParameterCharacteristic: + description: Parameter Characteristic for the chemical material. + type: object + properties: + parameterBeforeUse: + description: Parameters of the chemical material before use. + $ref: '#/components/schemas/urn_samm_io.catenax.material.chemical_material_passport_2.0.0_ParameterBeforeUseList' + parameterAfterUse: + description: Parameters of the chemical material after use. + $ref: '#/components/schemas/urn_samm_io.catenax.material.chemical_material_passport_2.0.0_ParameterAfterUseCharacteristic' + required: + - parameterBeforeUse + - parameterAfterUse + urn_samm_io.catenax.material.chemical_material_passport_2.0.0_MaterialEnumeration: + type: string + description: "Enumeration with the values substance, mixture and article." + enum: + - substance + - mixture + - article + urn_samm_io.catenax.material.chemical_material_passport_2.0.0_RouteEnumeration: + type: string + description: "Enumeration with oral, dermal, inhalation gas, inhalation vapour,\ + \ inhalation dust/mist/fume and not applicable" + enum: + - oral + - dermal + - inhalation gas + - inhalation vapour + - inhalation dust/mist/fume + - not applicable + urn_samm_io.catenax.material.chemical_material_passport_2.0.0_ClassificationEntity: + description: Entity for the hazard classification. + type: object + properties: + rule: + description: Name of the classification rule under which the hazard assessment + has been prepared. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + hazardous: + description: "Information if the product is hazardous or not, according\ + \ to the connected rule." + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Boolean' + route: + description: |- + Certain classifications must be communicated with the relevant route of exposure according to CLP Regulation (EC) No 1272/2008, which include: + - oral, + - dermal, + - inhalation gas, + - inhalation vapour, + - inhalation dust/mist/fume. + $ref: '#/components/schemas/urn_samm_io.catenax.material.chemical_material_passport_2.0.0_RouteEnumeration' + remark: + description: "Additional remarks for classification information supplement\ + \ the classification details for a particular chemical material. These\ + \ remarks assist stakeholders in making informed decisions regarding safety,\ + \ handling, and regulatory compliance." + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + category: + description: |- + The hazard category of the substance of concern. Defined in Article 2 of Regulation (EC) No 1272/2008 of the European Parliament and of the Council of 16 December 2008 on classification, labelling and packaging of substances and mixtures, amending and repealing Directives 67/548/EEC and 1999/45/EC, and amending Regulation (EC) No 1907/2006: + 2. 'hazard category' means the division of criteria within each hazard class, specifying hazard severity. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + class: + description: |- + The hazard class of the substance of concern. Defined in Article 2 of Regulation (EC) No 1272/2008 of the European Parliament and of the Council of 16 December 2008 on classification, labelling and packaging of substances and mixtures, amending and repealing Directives 67/548/EEC and 1999/45/EC, and amending Regulation (EC) No 1907/2006: + 1. 'hazard class' means the nature of the physical, health or environmental hazard. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + statement: + description: |- + The hazard statement of the substance of concern. Defined in Article 2 of Regulation (EC) No 1272/2008 of the European Parliament and of the Council of 16 December 2008 on classification, labelling and packaging of substances and mixtures, amending and repealing Directives 67/548/EEC and 1999/45/EC, and amending Regulation (EC) No 1907/2006: + 5. 'hazard statement' means a phrase assigned to a hazard class and category that describes the nature of the hazards of a hazardous substance or mixture, including, where appropriate, the degree of hazard. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + required: + - rule + - hazardous + - route + - remark + - category + - class + - statement + urn_samm_io.catenax.material.chemical_material_passport_2.0.0_ClassificationList: + description: List for the hazard classification. + type: array + items: + $ref: '#/components/schemas/urn_samm_io.catenax.material.chemical_material_passport_2.0.0_ClassificationEntity' + urn_samm_io.catenax.material.chemical_material_passport_2.0.0_SignalWordEnumeration: + type: string + description: Enumeration with Danger and Warning. + enum: + - Danger + - Warning + urn_samm_io.catenax.material.chemical_material_passport_2.0.0_LinkCharacteristic: + type: string + description: Characteristic for a simple web link. + urn_samm_io.catenax.material.chemical_material_passport_2.0.0_HazardPictogramEntity: + description: Entity for the hazard pictogram. + type: object + properties: + code: + description: The code of a pictogram refers to a set of symbols used to + visually represent and communicate information about the hazards associated + with a chemical material. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + image: + description: "Link to the picture of the pictogram. Definition from CLP\ + \ Regulation (EC) No 1272/2008 : ‘hazard pictogram’ means a graphical\ + \ composition that includes a symbol plus other graphic elements, such\ + \ as a border, background pattern or colour that is intended to convey\ + \ specific information on the hazard concerned;" + $ref: '#/components/schemas/urn_samm_io.catenax.material.chemical_material_passport_2.0.0_LinkCharacteristic' + name: + description: "The meaning or description of a pictogram is the explanation\ + \ that accompanies it, providing information and context about its purpose\ + \ and the hazards it represents." + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + required: + - code + - image + - name + urn_samm_io.catenax.material.chemical_material_passport_2.0.0_HazardPictogramList: + description: List of hazard pictograms. + type: array + items: + $ref: '#/components/schemas/urn_samm_io.catenax.material.chemical_material_passport_2.0.0_HazardPictogramEntity' + urn_samm_io.catenax.material.chemical_material_passport_2.0.0_HazardStatementEntity: + description: Entity for the hazard statement. + type: object + properties: + code: + description: "According to CLP Regulation (EC) No 1272/2008, each hazard\ + \ statement is designated a code, starting with the letter H followed\ + \ by three digits. These codes can be associated with multiple hazard\ + \ statements or be assigned to a single statement." + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + text: + description: "Definition from CLP Regulation (EC) No 1272/2008 ‘hazard statement’\ + \ means a phrase assigned to a hazard class and category that describes\ + \ the nature of the hazards of a hazardous substance or mixture, including,\ + \ where appropriate, the degree of hazard;" + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + required: + - code + - text + urn_samm_io.catenax.material.chemical_material_passport_2.0.0_HazardStatementList: + description: List for the hazard statement. + type: array + items: + $ref: '#/components/schemas/urn_samm_io.catenax.material.chemical_material_passport_2.0.0_HazardStatementEntity' + urn_samm_io.catenax.material.chemical_material_passport_2.0.0_PrecautionaryCodeTrait: + type: string + description: Constraint starting with the letter P followed by three digits. + pattern: "^P\\d{3}$" + urn_samm_io.catenax.material.chemical_material_passport_2.0.0_PrecautionaryList: + description: List for precautionary codes. + type: object + properties: + code: + description: "Each precautionary statement is designated a code, starting\ + \ with the letter P and followed by three digits." + $ref: '#/components/schemas/urn_samm_io.catenax.material.chemical_material_passport_2.0.0_PrecautionaryCodeTrait' + text: + description: "Definition from CLP Regulation (EC) No 1272/2008: ‘precautionary\ + \ statement’ means a phrase that describes recommended measure(s) to minimise\ + \ or prevent adverse effects resulting from exposure to a hazardous substance\ + \ or mixture due to its use or disposal." + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + required: + - code + - text + urn_samm_io.catenax.material.chemical_material_passport_2.0.0_SupplementalRequirementsEntity: + description: Entity for supplemental requirements. + type: object + properties: + code: + description: "Supplemental codes used for labeling statements provide additional\ + \ information or context about the hazards, handling, or regulatory requirements\ + \ associated with chemical materials. This data can be helpful for stakeholders\ + \ in managing chemical materials by offering further guidance on safe\ + \ handling practices, storage conditions, emergency response procedures,\ + \ or regulatory compliance measures." + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + text: + description: Any supplemental text used for labeling provides data that + could be helpful for stakeholders in managing chemical materials. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + pictogram: + description: Supplemental pictures or pictograms used for additional labeling + provide data that could be helpful for stakeholders in managing chemical + materials. + $ref: '#/components/schemas/urn_samm_io.catenax.material.chemical_material_passport_2.0.0_LinkCharacteristic' + notes: + description: "Labeling notes consist of statements that provide additional\ + \ information regarding hazardous possible reactions or other important\ + \ considerations related to the chemical material. These notes help stakeholders\ + \ understand potential risks and take appropriate precautions when handling,\ + \ storing, or using the material." + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + urn_samm_io.catenax.material.chemical_material_passport_2.0.0_SupplementalRequirementsList: + description: List for supplemental requirements. + type: array + items: + $ref: '#/components/schemas/urn_samm_io.catenax.material.chemical_material_passport_2.0.0_SupplementalRequirementsEntity' + urn_samm_io.catenax.material.chemical_material_passport_2.0.0_LabelingCharacteristic: + description: Characteristic for material labeling. + type: object + properties: + signalWord: + description: |- + According to CLP Regulation (EC) No 1272/2008, a "signal word" refers to a term indicating the relative severity of hazards to alert the reader to a potential danger. There are two levels distinguished: + (a) ‘Danger’ means a signal word indicating the more severe hazard categories; + (b) ‘Warning’ means a signal word indicating the less severe hazard categories; + $ref: '#/components/schemas/urn_samm_io.catenax.material.chemical_material_passport_2.0.0_SignalWordEnumeration' + hazardPictogram: + description: A hazard pictogram is a graphical symbol used to convey specific + information about the hazards associated with a chemical substance or + mixture. + $ref: '#/components/schemas/urn_samm_io.catenax.material.chemical_material_passport_2.0.0_HazardPictogramList' + hazard: + description: Describes the nature of a hazard associated with a chemical + substance or mixture. + $ref: '#/components/schemas/urn_samm_io.catenax.material.chemical_material_passport_2.0.0_HazardStatementList' + precautionary: + description: "A precautionary code for materials is a standardized code\ + \ used to convey specific precautionary measures that should be taken\ + \ when handling, storing, or using a chemical substance or mixture." + $ref: '#/components/schemas/urn_samm_io.catenax.material.chemical_material_passport_2.0.0_PrecautionaryList' + supplementalRequirements: + description: "Supplemental requirements often include additional codes,\ + \ symbols, or statements beyond those required by regulations." + $ref: '#/components/schemas/urn_samm_io.catenax.material.chemical_material_passport_2.0.0_SupplementalRequirementsList' + required: + - signalWord + - hazardPictogram + - hazard + - precautionary + - supplementalRequirements + urn_samm_io.catenax.material.chemical_material_passport_2.0.0_HazardAssessmentCharacteristic: + description: Characteristic for the hazard assessment. + type: object + properties: + classification: + description: Classification for the hazard assessment. + $ref: '#/components/schemas/urn_samm_io.catenax.material.chemical_material_passport_2.0.0_ClassificationList' + labeling: + description: The material labeling. + $ref: '#/components/schemas/urn_samm_io.catenax.material.chemical_material_passport_2.0.0_LabelingCharacteristic' + documentation: + description: Documentation providing hazard assessment information for ensuring + the safe management of chemical materials throughout their lifecycle. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentList' + required: + - classification + - labeling + - documentation + urn_samm_io.catenax.material.chemical_material_passport_2.0.0_CelsiusDegreeMeasurement: + type: number + description: Measurement as float in celsius degree. + urn_samm_io.catenax.material.chemical_material_passport_2.0.0_ProductTransportCharacteristic: + description: Product transportation Characteristic. + type: object + properties: + emergencyTemperatureMin: + description: "The critical minimum temperature for transporting the product\ + \ refers to the lowest temperature at which the product can be safely\ + \ transported without compromising its integrity or functionality. Emergency\ + \ temperature refers to a temperature that poses a significant risk, potentially\ + \ leading to hazardous conditions or product damage." + $ref: '#/components/schemas/urn_samm_io.catenax.material.chemical_material_passport_2.0.0_CelsiusDegreeMeasurement' + emergencyTemperatureMax: + description: "The critical maximum temperature for transporting the product\ + \ refers to the highest temperature at which the product can be safely\ + \ transported without degradation or posing a risk. Emergency temperature\ + \ refers to a temperature that poses a significant risk, potentially leading\ + \ to hazardous conditions or product damage." + $ref: '#/components/schemas/urn_samm_io.catenax.material.chemical_material_passport_2.0.0_CelsiusDegreeMeasurement' + other: + description: Additional information related to the transport of the product. + Relevant details that could aid in making decisions regarding the shipping + of the product. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + controlTemperature: + description: "The controlled temperature for transportation refers to the\ + \ range of values within which the temperature conditions of goods or\ + \ products are monitored and regulated during transportation in degree\ + \ celcius. This information is crucial for mitigating risks associated\ + \ with temperature-sensitive products, ensuring their integrity and quality\ + \ throughout the shipping process." + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + pictogram: + description: Links to transport related pictograms. + $ref: '#/components/schemas/urn_samm_io.catenax.material.chemical_material_passport_2.0.0_StringList' + urn_samm_io.catenax.material.chemical_material_passport_2.0.0_UNNumberTrait: + type: string + description: Constraint to four digits numbers. + pattern: "^\\d{4}$" + urn_samm_io.catenax.material.chemical_material_passport_2.0.0_FloatQuantityValue: + type: number + description: Value as float. + urn_samm_io.catenax.material.chemical_material_passport_2.0.0_PackagingGroupEnumeration: + type: string + description: "Enumeration to match \"I\", \"II\", \"III\", or \"not applicable\"\ + ." + enum: + - I + - II + - III + - not applicable + urn_samm_io.catenax.material.chemical_material_passport_2.0.0_QuantityCodeEnumeration: + type: string + description: "Enumeration for the codes E0, E1, E2, E3, E4, and E5." + enum: + - E0 + - E1 + - E2 + - E3 + - E4 + - E5 + urn_samm_io.catenax.material.chemical_material_passport_2.0.0_IntegerCharacteristic: + type: number + description: Characteristic for integer values. + urn_samm_io.catenax.material.chemical_material_passport_2.0.0_SpecialProvisionsCodeEntity: + description: Entity for the special provisions code. + type: object + properties: + code: + description: Code of special provisions or exceptions that must be met. + $ref: '#/components/schemas/urn_samm_io.catenax.material.chemical_material_passport_2.0.0_IntegerCharacteristic' + text: + description: Text aligned with special provisions under UN transport regulation + Chapter 3.3. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + required: + - code + - text + urn_samm_io.catenax.material.chemical_material_passport_2.0.0_SpecialProvisionsCodeList: + description: List of the special provisions codes. + type: array + items: + $ref: '#/components/schemas/urn_samm_io.catenax.material.chemical_material_passport_2.0.0_SpecialProvisionsCodeEntity' + urn_samm_io.catenax.shared.quantity_2.0.0_ItemUnitEnumeration: + type: string + pattern: "[a-zA-Z]*:[a-zA-Z]+" + description: Enumeration for common item units. + enum: + - unit:piece + - unit:set + - unit:pair + - unit:page + - unit:cycle + - unit:kilowattHour + - unit:gram + - unit:kilogram + - unit:tonneMetricTon + - unit:tonUsOrShortTonUkorus + - unit:ounceAvoirdupois + - unit:pound + - unit:metre + - unit:centimetre + - unit:kilometre + - unit:inch + - unit:foot + - unit:yard + - unit:squareCentimetre + - unit:squareMetre + - unit:squareInch + - unit:squareFoot + - unit:squareYard + - unit:cubicCentimetre + - unit:cubicMetre + - unit:cubicInch + - unit:cubicFoot + - unit:cubicYard + - unit:litre + - unit:millilitre + - unit:hectolitre + - unit:secondUnitOfTime + - unit:minuteUnitOfTime + - unit:hourUnitOfTime + - unit:day + urn_samm_io.catenax.material.chemical_material_passport_2.0.0_UNTransportEntity: + description: Entity with transport related attributes. + type: object + properties: + transportRegulation: + description: "Indicate regulations for transportation for example: Land\ + \ transport (ADR/RID), Inland waterway transport (ADN), Sea transport\ + \ (IMDG), Air transport (ICAO-TI/IATA-DGR) and so on." + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + unNumber: + description: "The UN number or ID number is a four-digit identification\ + \ code for substances, mixtures, or articles." + $ref: '#/components/schemas/urn_samm_io.catenax.material.chemical_material_passport_2.0.0_UNNumberTrait' + unShippingName: + description: "The proper shipping name is provided in column 2, \"Name and\ + \ description,\" of Table A of Chapter 3.2 Dangerous Goods List of the\ + \ UN Regulations." + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + unHazardClassCode: + description: The transport class of the dangerous group according to UN + Regulations. + $ref: '#/components/schemas/urn_samm_io.catenax.material.chemical_material_passport_2.0.0_FloatQuantityValue' + unHazardClassName: + description: The classified dangerous group in transportation refers to + the classification of hazardous materials or dangerous goods according + to the United Nations (UN) Globally Harmonized System of Classification + and Labelling of Chemicals (GHS) and the UN Model Regulations for the + Transport of Dangerous Goods. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + unPackagingGroup: + description: |- + Group to which certain substances may be assigned for packaging purposes according to their degree of danger: + Packaging group I: Substances presenting high danger, + Packaging group II: Substances presenting medium danger, + Packaging group III: Substances presenting low danger. + Not all dangerous goods assigned to hazard classes or their divisions will be allocated to Packaging Groups. + $ref: '#/components/schemas/urn_samm_io.catenax.material.chemical_material_passport_2.0.0_PackagingGroupEnumeration' + unExceptedQuantityCode: + description: "Chapter 3.5 of UN Transportation Regulation pertains to dangerous\ + \ goods packed in excepted quantities, with possible codes including E0,\ + \ E1, E2, E3, E4, and E5." + $ref: '#/components/schemas/urn_samm_io.catenax.material.chemical_material_passport_2.0.0_QuantityCodeEnumeration' + environmentallyHazardous: + description: "The indication of whether a substance or mixture is environmentally\ + \ hazardous according to the criteria of the UN Model Regulations (as\ + \ reflected in ADR, RID, and ADN) and whether it is a marine pollutant\ + \ according to the IMDG Code and the Emergency Response Procedures for\ + \ Ships Carrying Dangerous Goods." + $ref: '#/components/schemas/urn_samm_io.catenax.material.chemical_material_passport_2.0.0_StringList' + unSpecialProvisionsCode: + description: The UN Special Provisions Code refers to a set of additional + requirements or conditions specified by the United Nations for the transportation + of certain dangerous goods. + $ref: '#/components/schemas/urn_samm_io.catenax.material.chemical_material_passport_2.0.0_SpecialProvisionsCodeList' + unLimitedQuantityValue: + description: Maximum quantity per inner packaging or article for carrying + dangerous goods refers to the maximum amount of a hazardous material permitted + for transportation. + $ref: '#/components/schemas/urn_samm_io.catenax.material.chemical_material_passport_2.0.0_FloatQuantityValue' + unLimitedQuantityUnit: + description: Unit of the limited quantity value. + $ref: '#/components/schemas/urn_samm_io.catenax.shared.quantity_2.0.0_ItemUnitEnumeration' + required: + - transportRegulation + - unNumber + - unShippingName + - unHazardClassCode + - unHazardClassName + - unPackagingGroup + urn_samm_io.catenax.material.chemical_material_passport_2.0.0_UNTransportList: + description: List of transport related attributes from the UN. + type: array + items: + $ref: '#/components/schemas/urn_samm_io.catenax.material.chemical_material_passport_2.0.0_UNTransportEntity' + urn_samm_io.catenax.material.chemical_material_passport_2.0.0_TransportCharacteristic: + description: Characteristic for transport. + type: object + properties: + productTransport: + description: "Transport related attributes, which are not UN related." + $ref: '#/components/schemas/urn_samm_io.catenax.material.chemical_material_passport_2.0.0_ProductTransportCharacteristic' + unTransport: + description: Transport related attributes from the UN. + $ref: '#/components/schemas/urn_samm_io.catenax.material.chemical_material_passport_2.0.0_UNTransportList' + required: + - productTransport + - unTransport + urn_samm_io.catenax.material.chemical_material_passport_2.0.0_WasteCodeCharacteristic: + description: Characteristic for the waste code of the material. + type: object + properties: + description: + description: Description of the related waste code. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + regulation: + description: The name of the regulation that applies to waste codes can + vary depending on the region or jurisdiction. Examples include Regulation + (EC) No 1013/2006 in the European Union or Annex VIII of the Basel Convention. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + code: + description: A waste code is used to identify the type of waste. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + required: + - description + - regulation + - code + urn_samm_io.catenax.material.chemical_material_passport_2.0.0_DisposalCharacteristic: + description: Characteristic for disposal related attributes. + type: object + properties: + beforeUse: + description: "Management and disposal practices for chemicals that are no\ + \ longer needed or deemed unsuitable for their intended purpose. This\ + \ information can be provided as a document, detailing the properties\ + \ of waste that render it hazardous, along with disposal and recovery\ + \ operations or recommendations, and accidental release measures." + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentList' + afterUse: + description: Chemical Management and Disposal Guides post-usage as document. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentList' + wasteCode: + description: "A waste code is a standardized alphanumeric code used to classify\ + \ different types of waste according to their characteristics, origin,\ + \ and potential hazards. These codes help in proper identification, handling,\ + \ treatment, and disposal of waste materials." + $ref: '#/components/schemas/urn_samm_io.catenax.material.chemical_material_passport_2.0.0_WasteCodeCharacteristic' + packaging: + description: "Guidelines and instructions regarding the proper management\ + \ and disposal of packaging materials after use. Includes instructions\ + \ on separation, reuse, and recycling." + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentList' + required: + - beforeUse + - afterUse + - wasteCode + - packaging + urn_samm_io.catenax.material.chemical_material_passport_2.0.0_EmergencyList: + description: List of information on how to proceed in case of an emergency. + type: object + properties: + availability: + description: The period of time when emergency phone numbers are available. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + number: + description: The phone number in case of an emergency. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + required: + - availability + - number + urn_samm_io.catenax.material.chemical_material_passport_2.0.0_SafetyCharacteristic: + description: Characteristic for safety information. + type: object + properties: + documentation: + description: "Safety information in a document that outlines safety protocols,\ + \ procedures, and guidelines to be followed in specific situations involving\ + \ the product. It provides clear instructions on accident prevention,\ + \ how to respond to emergencies, and mitigate potential hazards. Examples\ + \ include exposure scenarios, safety data sheets, risk assessments, and\ + \ information on safety equipment and personal protective equipment (PPE)." + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentList' + emergencyPhone: + description: A phone number in case of emergency serves the vital purpose + of providing immediate access to emergency responders. + $ref: '#/components/schemas/urn_samm_io.catenax.material.chemical_material_passport_2.0.0_EmergencyList' + firstAidDocument: + description: Information on how to proceed in case of an emergency is essential. + It includes guidance on providing initial assistance or immediate care + to a person who has been injured before professional medical help arrives. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentList' + required: + - documentation + - emergencyPhone + - firstAidDocument + urn_samm_io.catenax.material.chemical_material_passport_2.0.0_ProductComplianceCountryTrait: + description: "Regex pattern including all valid ISO 3166 country codes, ensuring\ + \ a precise match." + type: array + items: + type: string + pattern: "\\b(?:A[BDEFGHIJKLMNOQSTUWXZ]|B[ABDEFGHJMNRSVWY]|C[ACDDEFGHIKLMNOPQRSTUVXYZ]|D[EJKMOZ]|E[CEGHRST]|F[IJKMOR]|G[ABDEFGHILMNPQRSTUWY]|H[KMNRTU]|I[DELNOQRST]|J[EMOP]|KE|L[ABCIKRSTUVY]|M[ACDEFGHKLMNOPQRSTUVWXYZ]|N[ACEFGILOPRTUVYZ]|OM|P[AEFGHKLMNRSTWY]|QA|R[EOSUW]|S[ABCDEGHIJKLMNRTUVYZ]|T[CDGHJMNPRW]|U[AGKMSTYZ]|V[ACEGINU]|W[FS]|X[KYZ]|Y[ETU]|Z[AMW])\\\ + b" + urn_samm_io.catenax.material.chemical_material_passport_2.0.0_ComplianceCharacteristic: + description: Characteristic for compliance attributes. + type: object + properties: + complianceCountry: + description: The name of the country of compliance denotes the country whose + rules and regulations the product must adhere to. + $ref: '#/components/schemas/urn_samm_io.catenax.material.chemical_material_passport_2.0.0_ProductComplianceCountryTrait' + complianceRegulationName: + description: |- + The name of the regulation or standard with which the product must comply can be sourced from Supplier Survey information. This attribute is referenced in ANNEX VI of the Proposal for a REGULATION OF THE EUROPEAN PARLIAMENT AND OF THE COUNCIL on detergents and surfactants, amending Regulation (EU) 2019/1020 and repealing Regulation (EC) No 648/2004: + The product passport shall include the following information: [...] + (e) references to Union legal acts that the detergent or surfactant complies with; + $ref: '#/components/schemas/urn_samm_io.catenax.material.chemical_material_passport_2.0.0_StringList' + complianceResult: + description: The statement indicates whether the product complies with the + aforementioned regulations. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Boolean' + complianceReasonForExemption: + description: "Data providing details and justifications for an exemption\ + \ from compliance with certain regulations, standards, or requirements.\ + \ This information assists regulatory authorities or stakeholders in evaluating\ + \ the merits of the exemption and making decisions in accordance with\ + \ legal and regulatory requirements." + $ref: '#/components/schemas/urn_samm_io.catenax.material.chemical_material_passport_2.0.0_StringList' + complianceRemark: + description: "If necessary, any remarks that provide relevant information\ + \ for compliance. Further clarification supplements the compliance information,\ + \ offering additional context or details to ensure thorough understanding\ + \ and adherence to regulatory requirements." + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + required: + - complianceCountry + - complianceRegulationName + - complianceResult + urn_samm_io.catenax.material.chemical_material_passport_2.0.0_SpecificCharacteristic: + description: The Characteristic to describe product specific parameters of the + electric drive. + type: object + properties: + parameter: + description: Parameters of the chemical material. + $ref: '#/components/schemas/urn_samm_io.catenax.material.chemical_material_passport_2.0.0_ParameterCharacteristic' + productType: + description: "Information, whether the product is a substance, mixture or\ + \ article. Definitions from REACH Regulation (EC) No 1907/2006: \n\"substance\"\ + : means a chemical element and its compounds in the natural state or obtained\ + \ by any manufacturing process, including any additive necessary to preserve\ + \ its stability and any impurity deriving from the process used, but excluding\ + \ any solvent which may be separated without affecting the stability of\ + \ the substance or changing its composition;\n\"mixture\": means a mixture\ + \ or solution composed of two or more substances;\n\"article\": means\ + \ an object which during production is given a special shape, surface\ + \ or design which determines its function to a greater degree than does\ + \ its chemical composition;" + $ref: '#/components/schemas/urn_samm_io.catenax.material.chemical_material_passport_2.0.0_MaterialEnumeration' + hazardAssessment: + description: Hazard assessment refers to evaluating and identifying potential + risks or dangers associated with the specific material. + $ref: '#/components/schemas/urn_samm_io.catenax.material.chemical_material_passport_2.0.0_HazardAssessmentCharacteristic' + transport: + description: Transport related information. + $ref: '#/components/schemas/urn_samm_io.catenax.material.chemical_material_passport_2.0.0_TransportCharacteristic' + disposal: + description: The safe and appropriate elimination or management of these + materials once they are no longer needed or usable. + $ref: '#/components/schemas/urn_samm_io.catenax.material.chemical_material_passport_2.0.0_DisposalCharacteristic' + safety: + description: Safety related attributes of the chemical material. + $ref: '#/components/schemas/urn_samm_io.catenax.material.chemical_material_passport_2.0.0_SafetyCharacteristic' + compliance: + description: "Compliance refers to adhering to relevant regulations, standards,\ + \ or specifications regarding the testing, documentation, and presentation\ + \ of parameters, methods, and results. This ensures that the product meets\ + \ required safety, quality, and regulatory standards throughout its lifecycle,\ + \ from manufacturing to post-application use." + $ref: '#/components/schemas/urn_samm_io.catenax.material.chemical_material_passport_2.0.0_ComplianceCharacteristic' + required: + - parameter + - productType + - hazardAssessment + - transport + - disposal + - safety + - compliance + urn_samm_io.catenax.serial_part_3.0.0_KeyTrait: + type: string + description: Constraint that ensures that the standard keys and custom key prefixes + can be used. + pattern: ^(manufacturerId|partInstanceId|batchId|van|customKey:\w+)$ + urn_samm_io.catenax.serial_part_3.0.0_ValueCharacteristic: + type: string + description: The value of an identifier. + urn_samm_io.catenax.serial_part_3.0.0_KeyValueList: + description: "A list of key value pairs for local identifiers, which are composed\ + \ of a key and a corresponding value." + type: object + properties: + key: + description: 'The key of a local identifier. ' + $ref: '#/components/schemas/urn_samm_io.catenax.serial_part_3.0.0_KeyTrait' + value: + description: The value of an identifier. + $ref: '#/components/schemas/urn_samm_io.catenax.serial_part_3.0.0_ValueCharacteristic' + required: + - key + - value + urn_samm_io.catenax.serial_part_3.0.0_LocalIdentifierCharacteristic: + description: "A single serialized part may have multiple attributes, that uniquely\ + \ identify a that part in a specific dataspace (e.g. the manufacturer`s dataspace)" + type: array + items: + $ref: '#/components/schemas/urn_samm_io.catenax.serial_part_3.0.0_KeyValueList' + uniqueItems: true + urn_samm_io.catenax.batch_3.0.0_KeyTrait: + type: string + description: Constraint that ensures that the predefined keys are used. + pattern: ^(manufacturerId|batchId|customKey:\w+)$ + urn_samm_io.catenax.batch_3.0.0_ValueCharacteristic: + type: string + description: The value of an identifier. + urn_samm_io.catenax.batch_3.0.0_KeyValueList: + description: "A list of key value pairs for local identifiers, which are composed\ + \ of a key and a corresponding value." + type: object + properties: + key: + description: The key of a local identifier. + $ref: '#/components/schemas/urn_samm_io.catenax.batch_3.0.0_KeyTrait' + value: + description: The value of an identifier. + $ref: '#/components/schemas/urn_samm_io.catenax.batch_3.0.0_ValueCharacteristic' + required: + - key + - value + urn_samm_io.catenax.batch_3.0.0_LocalIdentifierCharacteristic: + description: "A batch may have multiple attributes, which uniquely identify\ + \ that batch in a specific dataspace(e.g. the manufacturer`s dataspace)" + type: array + items: + $ref: '#/components/schemas/urn_samm_io.catenax.batch_3.0.0_KeyValueList' + uniqueItems: true + urn_samm_io.catenax.part_type_information_1.0.0_PartIdCharacteristic: + type: string + description: "The part ID is a multi-character string, usually assigned by an\ + \ ERP system." + urn_samm_io.catenax.part_type_information_1.0.0_PartNameCharacteristic: + type: string + description: Part name in string format from the respective system in the value + chain. + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PartTypeCharacteristic: + description: Characteristic for the part type. + type: object + properties: + manufacturerPartId: + description: Part ID as assigned by the manufacturer of the part. The part + ID identifies the part in the manufacturer`s dataspace. The part ID references + a specific version of a part. The version number must be included in the + part ID if it is available. The part ID does not reference a specific + instance of a part and must not be confused with the serial number. + $ref: '#/components/schemas/urn_samm_io.catenax.part_type_information_1.0.0_PartIdCharacteristic' + nameAtManufacturer: + description: Name of the part as assigned by the manufacturer. + $ref: '#/components/schemas/urn_samm_io.catenax.part_type_information_1.0.0_PartNameCharacteristic' + required: + - manufacturerPartId + - nameAtManufacturer + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_IdentifierCharacteristic: + type: string + description: Characteristic for Identifiers. + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_CodeEntity: + description: Code entity with code key and value. + type: object + properties: + key: + description: |- + The code key for the identification of the product. Examples are GTIN, hash, DID, ISBN, TARIC. This attribute is mentioned in the ESPR proposal from March 30th, 2022 ANNEX III: + (b) the unique product identifier at the level indicated in the applicable delegated act adopted pursuant to Article 4; + (c) the Global Trade Identification Number as provided for in standard ISO/IEC 15459-6 or equivalent of products or their parts; + (d) relevant commodity codes, such as a TARIC code as defined in Council Regulation (EEC) No 2658/87. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_IdentifierCharacteristic' + value: + description: The code value for the identification of the product in regard + to the chosen code name. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_IdentifierCharacteristic' + required: + - key + - value + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_CodeList: + description: A list of additional codes. + type: array + items: + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_CodeEntity' + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DataCarrierCharacteristic: + description: Data Carrier Characteristic for the product. + type: object + properties: + carrierType: + description: |- + The type of data carrier such as a QR code on the product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 8: + (2) (b) the types of data carrier to be used. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + carrierLayout: + description: |- + The positioning of data carrier on the product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 8: + (2) (c) the layout in which the data carrier shall be presented and its positioning. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + required: + - carrierType + - carrierLayout + urn_samm_io.catenax.shared.part_classification_1.0.0_ClassificationStandardCharacteristic: + type: string + description: Identified classification standards that align to the Catena-X + needs. + urn_samm_io.catenax.shared.part_classification_1.0.0_ClassificationIDCharacteristic: + type: string + description: "It can be numeric or a string, depending on the chosen classification\ + \ standard." + urn_samm_io.catenax.shared.part_classification_1.0.0_ClassificationEntity: + description: Encapsulates data related to the classification of the part. + type: object + properties: + classificationStandard: + description: Identified classification standards that align to the Catena-X + needs. + $ref: '#/components/schemas/urn_samm_io.catenax.shared.part_classification_1.0.0_ClassificationStandardCharacteristic' + classificationID: + description: The classification ID of the part type according to the corresponding + standard definition mentioned in the key value pair. + $ref: '#/components/schemas/urn_samm_io.catenax.shared.part_classification_1.0.0_ClassificationIDCharacteristic' + classificationDescription: + description: Optional property describing the classification standard. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + required: + - classificationStandard + - classificationID + urn_samm_io.catenax.shared.part_classification_1.0.0_ClassificationCharacteristic: + description: Classification characteristic enabling a set of further properties. + type: array + items: + $ref: '#/components/schemas/urn_samm_io.catenax.shared.part_classification_1.0.0_ClassificationEntity' + uniqueItems: true + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_IdentificationCharacteristic: + description: Identification information of the product. + type: object + properties: + serial: + description: |- + Identifier for a serial part if available. This is mentioned in the ESPR provisional agreement from January 9th, 2024 Recital (27): + [...] an 'item' usually means a single unit of a model. + $ref: '#/components/schemas/urn_samm_io.catenax.serial_part_3.0.0_LocalIdentifierCharacteristic' + batch: + description: |- + Identifier for a batch part if available. Identifier for a serial part if available. This is mentioned in the ESPR provisional agreement from January 9th, 2024 Recital (27): + [...] a 'batch' usually means a subset of a specific model composed of all products produced in a specific manufacturing plant at a specific moment in time [...]. + $ref: '#/components/schemas/urn_samm_io.catenax.batch_3.0.0_LocalIdentifierCharacteristic' + type: + description: |- + Identifier on the level of a part model or type. Identifier for a serial part if available. This is mentioned in the ESPR provisional agreement from January 9th, 2024 Recital (27): + [...] A 'model' usually means a version of a product of which all units share the same technical characteristics relevant for the ecodesign requirements and the same model identifier [...]. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PartTypeCharacteristic' + codes: + description: Codes for identification. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_CodeList' + dataCarrier: + description: |- + The type and layout of the data carrier on the product. These are mentioned in the ESPR proposal from March 30th, 2022 Article 8: + (b) the types of data carrier to be used; + (c) the layout in which the data carrier shall be presented and its positioning; + Article 2 defines: + (30) 'data carrier' means a linear bar code symbol, a two-dimensional symbol or other automatic identification data capture medium that can be read by a device. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DataCarrierCharacteristic' + classification: + description: Property describing the classification of a part. + $ref: '#/components/schemas/urn_samm_io.catenax.shared.part_classification_1.0.0_ClassificationCharacteristic' + required: + - type + - codes + - dataCarrier + - classification + urn_samm_io.catenax.shared.business_partner_number_2.0.0_BpnaTrait: + type: string + description: "The provided regular expression ensures that the BPNA is composed\ + \ of prefix 'BPNA', 10 digits and two alphanumeric letters." + pattern: "^BPNA[a-zA-Z0-9]{12}$" + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_FacilityEntity: + description: The entity for a facility with the BPNA identifier. + type: object + properties: + facility: + description: |- + The identifier used for a location. This attribute is mentioned in the ESPR provisional agreement from January 9th 2024 Annex III: + (i) unique facility identifiers; + Article 2 Definitions: (33) 'unique facility identifier' means a unique string of characters for the identification of locations or buildings involved in the value chain of a product or used by actors involved in the value chain of a product. + $ref: '#/components/schemas/urn_samm_io.catenax.shared.business_partner_number_2.0.0_BpnaTrait' + required: + - facility + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_FacilityList: + description: List of facilities. + type: array + items: + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_FacilityEntity' + urn_samm_io.catenax.shared.business_partner_number_2.0.0_BpnlTrait: + type: string + description: "The provided regular expression ensures that the BPNL is composed\ + \ of prefix 'BPNL', 10 digits and two alphanumeric letters." + pattern: "^BPNL[a-zA-Z0-9]{12}$" + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DateTrait: + type: string + description: Constraint fo a timestamp in the format (yyyy-mm-dd). + pattern: "^\\d{4}-\\d{2}-\\d{2}$" + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_ManufacturerCharacteristic: + description: Manufacturing information. + type: object + properties: + facility: + description: |- + The identifier used for a location. In the CATENA-X use case, the BPNA can be stated. This attribute is mentioned in the ESPR provisional agreement from January 9th 2024 Annex III: + (i) unique facility identifiers; + Article 2 Definitions: (33) 'unique facility identifier' means a unique string of characters for the identification of locations or buildings involved in the value chain of a product or used by actors involved in the value chain of a product. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_FacilityList' + manufacturer: + description: |- + The main manufacturer, if different from the passport owner, represented by an identification number. In the Catena-X use case, the BPNL can be stated. This attribute is mentioned in the ESPR provisional agreement from January 9th 2024 Annex III: + (h) unique operator identifiers other than that of the manufacturer; + (k) the name, contact details and unique operator identifier code of the economic operator established in the Union responsible for carrying out the tasks set out in Article 4 of Regulation (EU) 2019/1020, or Article 15 of Regulation (EU) [.../...] on general product safety, or similar tasks pursuant to other EU legislation applicable to the product. + $ref: '#/components/schemas/urn_samm_io.catenax.shared.business_partner_number_2.0.0_BpnlTrait' + manufacturingDate: + description: "The timestamp in the format (yyyy-mm-dd) of the manufacturing\ + \ date as the final step in production process (e.g. final quality check,\ + \ ready-for-shipment event)." + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DateTrait' + required: + - facility + - manufacturer + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_EoriTrait: + type: string + description: "Constraint with a pattern which ensures that the EORI number starts\ + \ with two alphanumeric characters, followed by two alphabetic characters,\ + \ and ends with 2 to 15 alphanumeric characters." + pattern: "^[A-Z]{2}[A-Z0-9]{1,18}$" + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_ImporterCharacteristic: + description: Characteristic with information regarding the importer. + type: object + properties: + eori: + description: |- + An economic operator established in the customs territory of the Union needs, for customs purposes, an EORI number. EORI stands for economic operators registration and identification number. In this case, the importer's EORI must be provided. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Annex III: + (j) information related to the importer, including the information referred to in Article 23(3) and its EORI number. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_EoriTrait' + id: + description: |- + The importer of the product, if different from the owner of the passport. In the Catena-X network, the BPNL is used for the identification of companies and the information stored for this like contact information and addresses. + This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex III: + (j) information related to the importer, including the information referred to in Article 23(3) and its EORI number; + Article 23 states: + (3) Importers shall, for products covered by a delegated act adopted pursuant to Article 4, indicate their name, registered trade name or registered trade mark and the postal address and electronic means of communication, where they can be contacted: (a) on the public part of the product passport, when applicable, and + (b) on the product or, where this is not possible, on the packaging, or in a document accompanying the product. + $ref: '#/components/schemas/urn_samm_io.catenax.shared.business_partner_number_2.0.0_BpnlTrait' + required: + - eori + - id + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_ImportCharacteristic: + description: Import Characteristic for the product. + type: object + properties: + content: + description: |- + Information regarding the importer of the product, if different from the owner of the passport. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex III: + (j) information related to the importer, including the information referred to in Article 23(3) and its EORI number; + Article 23 states: + (3) Importers shall, for products covered by a delegated act adopted pursuant to Article 4, indicate their name, registered trade name or registered trade mark and the postal address and electronic means of communication, where they can be contacted: (a) on the public part of the product passport, when applicable, and + (b) on the product or, where this is not possible, on the packaging, or in a document accompanying the product. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_ImporterCharacteristic' + applicable: + description: "Check whether the connected attributes are applicable to the\ + \ product. If it is not applicable (false), dummy data can be delivered." + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Boolean' + required: + - content + - applicable + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_OperatorCharacteristic: + description: Other operators characteristic. + type: object + properties: + id: + description: Identifier of the other operator. This can be a BPN. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + role: + description: Role of the other operator. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + required: + - id + - role + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_OperationCharacteristic: + description: Operational information of the product. + type: object + properties: + manufacturer: + description: |- + Manufacturing information of the product. In the CATENA-X use case, the BPNL and BPNA can be stated. These attributes are mentioned in the ESPR provisional agreement from January 9th 2024 Annex III: + (h) unique operator identifiers other than that of the manufacturer; + (k) the name, contact details and unique operator identifier code of the economic operator established in the Union responsible for carrying out the tasks set out in Article 4 of Regulation (EU) 2019/1020, or Article 15 of Regulation (EU) [.../...] on general product safety, or similar tasks pursuant to other EU legislation applicable to the product. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_ManufacturerCharacteristic' + import: + description: Importer details such as the identification. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_ImportCharacteristic' + other: + description: Other operators relevant for the product. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_OperatorCharacteristic' + required: + - manufacturer + - import + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_LifeEnumeration: + type: string + description: "Enumeration with the possible units day, month, cycle, year and\ + \ runningOrOperatingHour." + enum: + - unit:day + - unit:month + - unit:year + - unit:cycle + - unit:runningOrOperatingHour + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_LifeValueCharacteristic: + type: number + description: Characteristic for the life span value as an integer. + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_LifeTypeEnumeration: + type: string + description: "Enumeration with the values guaranteed lifetime, technical lifetime\ + \ and mean time between failures." + enum: + - guaranteed lifetime + - technical lifetime + - mean time between failures + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_LifespanEntity: + description: "Entity for the lifespan of a product with type, unit and value." + type: object + properties: + unit: + description: "The unit of the respective lifespan expressed through the\ + \ possible units day, month, cycle, year and runningOrOperatingHour." + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_LifeEnumeration' + value: + description: The value as an integer for the respective lifespan. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_LifeValueCharacteristic' + key: + description: |- + The type of lifespan represented with the values guaranteed lifetime, technical lifetime and mean time between failures. This attribute is mentioned in the ESPR proposal from March 30th, 2022 ANNEX I: + (a) durability and reliability of the product or its components as expressed through the product's guaranteed lifetime, technical lifetime [or] mean time between failures [...]. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_LifeTypeEnumeration' + required: + - unit + - value + - key + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_LifespanList: + description: List of different life spans of a product. + type: array + items: + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_LifespanEntity' + urn_samm_io.catenax.shared.quantity_2.0.0_QuantityValueCharacteristic: + type: number + description: The quantity value associated with the unit expressed as float. + urn_samm_io.catenax.shared.quantity_2.0.0_LinearUnitEnumeration: + type: string + pattern: "[a-zA-Z]*:[a-zA-Z]+" + description: "The unit of a linear attribute that may be used for height, width,\ + \ length and diameter." + enum: + - unit:millimetre + - unit:centimetre + - unit:metre + - unit:kilometre + - unit:inch + - unit:foot + - unit:yard + urn_samm_io.catenax.shared.quantity_2.0.0_LinearCharacteristic: + description: Characteristic for linear measurements of an item. + type: object + properties: + value: + description: The quantity value associated with the unit. + $ref: '#/components/schemas/urn_samm_io.catenax.shared.quantity_2.0.0_QuantityValueCharacteristic' + unit: + description: The unit of a linear attribute. + $ref: '#/components/schemas/urn_samm_io.catenax.shared.quantity_2.0.0_LinearUnitEnumeration' + required: + - value + - unit + urn_samm_io.catenax.shared.quantity_2.0.0_MassUnitEnumeration: + type: string + pattern: "[a-zA-Z]*:[a-zA-Z]+" + description: Enumeration for mass units. + enum: + - unit:gram + - unit:kilogram + - unit:tonneMetricTon + - unit:tonUsOrShortTonUkorus + - unit:ounceAvoirdupois + - unit:pound + urn_samm_io.catenax.shared.quantity_2.0.0_MassCharacteristic: + description: Characteristic for mass measurements of an item. + type: object + properties: + value: + description: The quantity value associated with the unit. + $ref: '#/components/schemas/urn_samm_io.catenax.shared.quantity_2.0.0_QuantityValueCharacteristic' + unit: + description: The unit of a mass related attribute. + $ref: '#/components/schemas/urn_samm_io.catenax.shared.quantity_2.0.0_MassUnitEnumeration' + required: + - value + - unit + urn_samm_io.catenax.shared.quantity_2.0.0_VolumeUnitEnumeration: + type: string + pattern: "[a-zA-Z]*:[a-zA-Z]+" + description: Enumeration for volume units. + enum: + - unit:cubicMetre + - unit:litre + - unit:millilitre + - unit:cubicCentimetre + - unit:cubicInch + - unit:cubicFoot + - unit:cubicYard + - unit:hectolitre + urn_samm_io.catenax.shared.quantity_2.0.0_VolumeCharacteristic: + description: Characteristic for volume measurements of an item. + type: object + properties: + value: + description: The quantity value associated with the unit. + $ref: '#/components/schemas/urn_samm_io.catenax.shared.quantity_2.0.0_QuantityValueCharacteristic' + unit: + description: The unit of a volume related attribute. + $ref: '#/components/schemas/urn_samm_io.catenax.shared.quantity_2.0.0_VolumeUnitEnumeration' + required: + - value + - unit + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PhysicalDimensionCharacteristic: + description: "Characteristic for physical dimensions with linear, mass and capacity\ + \ attributes." + type: object + properties: + width: + description: The width of the item measured in a specific linear unit which + can be declared in the corresponding unit attribute. + $ref: '#/components/schemas/urn_samm_io.catenax.shared.quantity_2.0.0_LinearCharacteristic' + length: + description: The length of the item measured in a specific linear unit which + can be declared in the corresponding unit attribute. + $ref: '#/components/schemas/urn_samm_io.catenax.shared.quantity_2.0.0_LinearCharacteristic' + diameter: + description: "The diameter of the item, if applicable, measured in a specific\ + \ linear unit which can be declared in the corresponding unit attribute." + $ref: '#/components/schemas/urn_samm_io.catenax.shared.quantity_2.0.0_LinearCharacteristic' + height: + description: The height of the item measured in a specific linear unit which + can be declared in the corresponding unit attribute. + $ref: '#/components/schemas/urn_samm_io.catenax.shared.quantity_2.0.0_LinearCharacteristic' + grossWeight: + description: |- + The gross weight of the item measured in a specific mass unit which can be declared in the corresponding unit attribute. Gross weight refers to the total weight of a product, including the weight of the packaging. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7: + (2) (b) (i) information on the performance of the product in relation to the product parameters referred to in Annex I; + Annex I (i) weight and volume of the product and its packaging, and the product-to-packaging ratio. + $ref: '#/components/schemas/urn_samm_io.catenax.shared.quantity_2.0.0_MassCharacteristic' + grossVolume: + description: |- + The gross volume of the item, if possible, measured in a specific capacity unit which can be declared in the corresponding unit attribute. If there is no separate packing, the volume of the product shall be given. Gross volume refers to the total volume of a product, including the volume of the packaging. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7: + (2) (b) (i) information on the performance of the product in relation to the product parameters referred to in Annex I; + Annex I (i) weight and volume of the product and its packaging, and the product-to-packaging ratio. + $ref: '#/components/schemas/urn_samm_io.catenax.shared.quantity_2.0.0_VolumeCharacteristic' + weight: + description: |- + Weight of the product measured in a specific mass unit which can be declared in the corresponding unit attribute. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7: + (2) (b) (i) information on the performance of the product in relation to the product parameters referred to in Annex I; + Annex I (i) weight and volume of the product [...]. + $ref: '#/components/schemas/urn_samm_io.catenax.shared.quantity_2.0.0_MassCharacteristic' + volume: + description: |- + Volume of the product, if possible, measured in a specific capacity unit which can be declared in the corresponding unit attribute. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7: + (2) (b) (i) information on the performance of the product in relation to the product parameters referred to in Annex I; + Annex I (i) weight and volume of the product [...]. + $ref: '#/components/schemas/urn_samm_io.catenax.shared.quantity_2.0.0_VolumeCharacteristic' + required: + - grossWeight + - grossVolume + - weight + - volume + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PhysicalStateEnumeration: + type: string + description: "Enumeration with the values solid, liquid, gas and plasma." + enum: + - solid + - liquid + - gas + - plasma + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_ProductCharacteristics: + description: Defines a set of specific characteristics of a product. + type: object + properties: + lifespan: + description: |- + The type of lifespan represented with the values guaranteed lifetime, technical lifetime and mean time between failures. Both can be described through the attributes: type, which defines the type such as guaranteed lifetime or technical lifetime, the unit for the lifetime, and the value represented by an integer. These attributes are mentioned in the ESPR proposal from March 30th, 2022 ANNEX I: + (a) durability and reliability of the product or its components as expressed through the products guaranteed lifetime, technical lifetime [or] mean time between failures [...]. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_LifespanList' + physicalDimension: + description: |- + Physical dimensions are properties associated with physical quantities for purposes of classification or differentiation. These attributes are mentioned in the ESPR provisional agreement from January 9th, Article 7: + (2) (b) (i) information on the performance of the product in relation to one or more of the product parameters referred to in Annex I; + Annex I (i) weight and volume of the product and its packaging, and the product-to-packaging ratio. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PhysicalDimensionCharacteristic' + physicalState: + description: "The physical state of the item. There are four states of matter\ + \ solid, liquid, gas and plasma which can be chosen from an enumeration." + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PhysicalStateEnumeration' + generalPerformanceClass: + description: |- + The performance class of the product. This attribute is mentioned ESPR provisional agreement from January 9th, 2024 Article 7: + 4. When establishing the information requirements referred to in paragraph 2, point (b), point (i), the Commission shall, as appropriate in view of the specificity of the product group, determine classes of performance. Classes of performance may be based on single parameters, on aggregated scores, in absolute terms or in any other form that enables potential customers to choose the best performing products. Those classes of performance shall correspond to significant improvements in performance levels. Where classes of performance are based on parameters in relation to which performance requirements are established, they shall use as the minimum level the minimum performance required at the time when the classes of performance start to apply. + Definition: + 'class of performance': means a range of performance levels in relation to one or more product parameters referred to in Annex I, based on a common methodology for the product or product group, ordered into successive steps to allow for product differentiation. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + required: + - lifespan + - physicalDimension + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_StringList: + description: List of strings. + type: array + items: + type: string + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_CommercialCharacteristic: + description: Commercial information of the product. + type: object + properties: + placedOnMarket: + description: The timestamp in the format (yyyy-mm-dd) with or without time + zone when the product was put in the market. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DateTrait' + purpose: + description: "One or more intended industry/industries of the product described\ + \ by the digital product passport. If exchanged via Catena-X, 'automotive\ + \ ' is a must choice included in the list." + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_StringList' + required: + - purpose + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_ConcentrationEnumeration: + type: string + description: "Enumeration of possible units of concentration with percent, volume\ + \ percent, parts per thousand, parts per million, parts per billion and parts\ + \ per trillion." + enum: + - unit:partPerMillion + - unit:percent + - unit:percentVolume + - unit:partPerThousand + - unit:partPerTrillionUs + - unit:partPerBillionUs + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PositiveTrait: + type: number + description: Constraint for only positive values. + minimum: 0.0 + exclusiveMinimum: false + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_HazardCharacteristic: + description: Characteristic for the hazardous classification. + type: object + properties: + category: + description: |- + The hazard category of the substance of concern. Defined in Article 2 of Regulation (EC) No 1272/2008 of the European Parliament and of the Council of 16 December 2008 on classification, labelling and packaging of substances and mixtures, amending and repealing Directives 67/548/EEC and 1999/45/EC, and amending Regulation (EC) No 1907/2006: + 2. 'hazard category' means the division of criteria within each hazard class, specifying hazard severity. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + class: + description: |- + The hazard class of the substance of concern. Defined in Article 2 of Regulation (EC) No 1272/2008 of the European Parliament and of the Council of 16 December 2008 on classification, labelling and packaging of substances and mixtures, amending and repealing Directives 67/548/EEC and 1999/45/EC, and amending Regulation (EC) No 1907/2006: + 1. 'hazard class' means the nature of the physical, health or environmental hazard. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + statement: + description: |- + The hazard statement of the substance of concern. Defined in Article 2 of Regulation (EC) No 1272/2008 of the European Parliament and of the Council of 16 December 2008 on classification, labelling and packaging of substances and mixtures, amending and repealing Directives 67/548/EEC and 1999/45/EC, and amending Regulation (EC) No 1907/2006: + 5. 'hazard statement' means a phrase assigned to a hazard class and category that describes the nature of the hazards of a hazardous substance or mixture, including, where appropriate, the degree of hazard. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + required: + - category + - class + - statement + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_RangeEntity: + description: "Entity for the concentration range with two values, the highest\ + \ and the lowest of the concentration range." + type: object + properties: + min: + description: |- + The minimum concentration of the substance of concern at the level of the product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7: + (5) (c) [...] concentration range of the substances of concern, at the level of the product [...]. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PositiveTrait' + max: + description: |- + The maximum concentration of the substance of concern at the level of the product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7: + (5) (c) the concentration, maximum concentration or concentration range of the substances of concern, at the level of the product [...]. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PositiveTrait' + required: + - max + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_RangeCharacteristic: + description: "Range characteristic with two values, the highest and the lowest\ + \ of the concentration range. Only providing the maximum range is also possible." + type: array + items: + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_RangeEntity' + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_ListTypeEnumerationId: + type: string + description: Enumeration of different systems and organizations related to the + identification and classification of chemical substances in the field of chemistry. + The enumeration values are EC or CAS. + enum: + - CAS + - EC + - IUPAC + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_MaterialIdEntity: + description: "Id Entity with identifier, name and list type." + type: object + properties: + id: + description: "The substance identification, in accordance with the specification\ + \ in the attribute for the list type." + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_IdentifierCharacteristic' + type: + description: "The type of standard used for the identification of the substances.\ + \ Selected can be for example CAS, IUPAC or EC." + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_ListTypeEnumerationId' + name: + description: The name of the material which is present in the product. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + required: + - id + - type + - name + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_MaterialIdList: + description: List of ids for the identification. + type: array + items: + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_MaterialIdEntity' + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_SubstanceEntity: + description: Information regarding substances of concern in the product. + type: object + properties: + location: + description: |- + The location of the substances of concern within the product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7: + (5) (b) the location of the substances of concern within the product. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + unit: + description: "The unit of concentration chosen from an enumeration: mass\ + \ percent, volume percent, parts per thousand, parts per million, parts\ + \ per billion and parts per trillion." + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_ConcentrationEnumeration' + concentration: + description: | + Concentration of the material at the level of the product. This attribute is specially mentioned for substances of concern mentioned in the ESPR proposal from March 30th, 2022 Article 7: + (5) (c) the concentration, maximum concentration or concentration range of the substances of concern, at the level of the product [...]. + Other substances are mentioned for the purpose of recycling in the ESPR provisional agreement from January 9th, 2024 Annex I: + (d) design for recycling, ease and quality of recycling as expressed through: use of easily recyclable materials, safe, easy and non-destructive access to recyclable components and materials or components and materials containing hazardous substances and material composition and homogeneity, possibility for high-purity sorting, number of materials and components used, use of standard components, use of component and material coding standards for the identification of components and materials, number and complexity of processes and tools needed, ease of nondestructive disassembly and re-assembly, conditions for access to product data, conditions for access to or use of hardware and software needed. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PositiveTrait' + exemption: + description: |- + Exemptions to the substance of concern. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Article 7: + (5) (c) provide duly justified exemptions for substances of concern or information elements from the information requirements referred to in the first subparagraph based on the technical feasibility or relevance of tracking substances of concern, the existence of analytical methods to detect and quantify them, the need to protect confidential business information or in other duly justified cases. Substances of concern within the meaning of Article 2(28), point a), shall not be exempted if they are present in products, their relevant components or spare parts in a concentration above 0,1 % weight by weight. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + hazardClassification: + description: |- + The specification of the hazard class. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I: + (f) use of substances, and in particular the use of substances of concern, on their own, as constituents of substances or in mixtures, during the production process of products, or leading to their presence in products, including once these products become waste, and their impacts on human health and the environment; + Further defined is this by Regulation (EC) No 1272/2008 of the European Parliament and of the Council of 16 December 2008 on classification, labelling and packaging of substances and mixtures, amending and repealing Directives 67/548/EEC and 1999/45/EC, and amending Regulation (EC) No 1907/2006. + Defined in Article 2: + 1. 'hazard class' means the nature of the physical, health or environmental hazard; + 2. 'hazard category' means the division of criteria within each hazard class, specifying hazard severity; + 5. 'hazard statement' means a phrase assigned to a hazard class and category that describes the nature of the hazards of a hazardous substance or mixture, including, where appropriate, the degree of hazard; + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_HazardCharacteristic' + concentrationRange: + description: |- + The concentration range for the substance of concern. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7: + (5) (c) [...] concentration range of the substances of concern, at the level of the product [...]. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_RangeCharacteristic' + id: + description: "The chemical material name and identification, in accordance\ + \ with the specification in the attribute for the list type. Preference\ + \ is given to the IUPAC name. This attribute is mentioned in the ESPR\ + \ provisional agreement from January 9th, 2024 Article 7:\n(5) (a) the\ + \ name of the substances of concern present in the product, as follows:\n\ + \ - name(s) in the International Union of Pure and Applied Chemistry (IUPAC)\ + \ nomenclature, or another international name when IUPAC name is not available;\ + \ \n- other names (usual name, trade name, abbreviation);\n- European\ + \ Community (EC) number, as indicated in the European Inventory of Existing\ + \ Commercial Chemical Substances (EINECS), the European List of Notified\ + \ Chemical Substances (ELINCS) or the No Longer Polymer (NLP) list or\ + \ assigned by the European Chemicals Agency (ECHA), if available;\n- the\ + \ Chemical Abstract Service (CAS) name(s) and number(s), if available;\ + \ ." + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_MaterialIdList' + documentation: + description: Documentation accompanying the material. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentList' + required: + - location + - unit + - concentration + - exemption + - hazardClassification + - concentrationRange + - id + - documentation + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_SubstanceList: + description: Characteristic for a list of substances of concern. + type: array + items: + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_SubstanceEntity' + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_SubstanceOfConcernCharacteristic: + description: Substance of concern Characteristic of the product. + type: object + properties: + applicable: + description: "Check whether the connected attributes are applicable to the\ + \ product. If it is not applicable (false), dummy data can be delivered." + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Boolean' + content: + description: "Information regarding substances of concern in the product.\ + \ Attributes are among others substance names, ids, concentration, location\ + \ and hazard class. This is mentioned in the ESPR provisional agreement\ + \ from January 9th, 2024 Article 7:\n(5) (a) the name of the substances\ + \ of concern present in the product, as follows:\n- name(s) in the International\ + \ Union of Pure and Applied Chemistry (IUPAC) nomenclature, or another\ + \ international name when IUPAC name is not available; \n- other names\ + \ (usual name, trade name, abbreviation);\n- European Community (EC) number,\ + \ as indicated in the European Inventory of Existing Commercial Chemical\ + \ Substances (EINECS), the European List of Notified Chemical Substances\ + \ (ELINCS) or the No Longer Polymer (NLP) list or assigned by the European\ + \ Chemicals Agency (ECHA), if available;\n- the Chemical Abstract Service\ + \ (CAS) name(s) and number(s), if available;\n(5) (b) the location of\ + \ the substances of concern within the product.\n(5) (c) the concentration,\ + \ maximum concentration or concentration range of the substances of concern,\ + \ at the level of the product its relevant components, or spare parts;\n\ + (d) relevant instructions for the safe use of the product;\n(e) information\ + \ relevant for disassembly, preparation for reuse, reuse, recycling and\ + \ the environmentally sound management of the product at the end of its\ + \ life.\nAnd in the next paragraph:\n(c) provide duly justified exemptions\ + \ for substances of concern or information elements from the information\ + \ requirements referred to in the first subparagraph." + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_SubstanceList' + required: + - applicable + - content + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PercentageTrait: + type: number + description: Range constraint for a positive percentage value. + maximum: 100.0 + exclusiveMaximum: false + minimum: 0.0 + exclusiveMinimum: false + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_MaterialEntity: + description: Information regarding recycled and/or renewable materials in the + product. + type: object + properties: + recycled: + description: |- + The share of the material, which is recovered recycled content from the product. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I: + (h) use or content of recycled materials and recovery of materials, including critical raw materials; + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PercentageTrait' + renewable: + description: | + The share of the material, which is from a renewable resource that can be replenished. Renewable resources are those that can be reproduced by physical, chemical, or mechanical processes. These are the kind of resources that can be regenerated throughout time. Forest wood, for example, can be grown through reforestation. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I: + (ha) use or content of sustainable renewable materials; + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PercentageTrait' + unit: + description: "The unit of concentration chosen from an enumeration: mass\ + \ percent, volume percent, parts per thousand, parts per million, parts\ + \ per billion and parts per trillion." + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_ConcentrationEnumeration' + id: + description: "The chemical material name and identification, in accordance\ + \ with the specification in the attribute for the list type. Preference\ + \ is given to the IUPAC name. This attribute is mentioned in the ESPR\ + \ provisional agreement from January 9th, 2024 Article 7:\n(5) (a) the\ + \ name of the substances of concern present in the product, as follows:\n\ + \ - name(s) in the International Union of Pure and Applied Chemistry (IUPAC)\ + \ nomenclature, or another international name when IUPAC name is not available;\ + \ \n- other names (usual name, trade name, abbreviation);\n- European\ + \ Community (EC) number, as indicated in the European Inventory of Existing\ + \ Commercial Chemical Substances (EINECS), the European List of Notified\ + \ Chemical Substances (ELINCS) or the No Longer Polymer (NLP) list or\ + \ assigned by the European Chemicals Agency (ECHA), if available;\n- the\ + \ Chemical Abstract Service (CAS) name(s) and number(s), if available;\ + \ ." + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_MaterialIdList' + critical: + description: |- + A flag, if the material is a critical raw material. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I: + (h) use or content of recycled materials and recovery of materials, including critical raw materials; + In Annex II of the connected proposal Act of Critical Raw Materials, a list of critical raw materials can be found. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Boolean' + concentration: + description: | + Concentration of the material at the level of the product. This attribute is specially mentioned for substances of concern mentioned in the ESPR proposal from March 30th, 2022 Article 7: + (5) (c) the concentration, maximum concentration or concentration range of the substances of concern, at the level of the product [...]. + Other substances are mentioned for the purpose of recycling in the ESPR provisional agreement from January 9th, 2024 Annex I: + (d) design for recycling, ease and quality of recycling as expressed through: use of easily recyclable materials, safe, easy and non-destructive access to recyclable components and materials or components and materials containing hazardous substances and material composition and homogeneity, possibility for high-purity sorting, number of materials and components used, use of standard components, use of component and material coding standards for the identification of components and materials, number and complexity of processes and tools needed, ease of nondestructive disassembly and re-assembly, conditions for access to product data, conditions for access to or use of hardware and software needed. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PositiveTrait' + documentation: + description: Documentation accompanying the material. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentList' + required: + - recycled + - renewable + - unit + - id + - critical + - concentration + - documentation + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_MaterialList: + description: A list of different materials in the product. + type: array + items: + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_MaterialEntity' + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_MaterialCharacteristic: + description: Material Characteristic with information on the materials. + type: object + properties: + applicable: + description: "Check whether the connected attributes are applicable to the\ + \ product. If it is not applicable (false), dummy data can be delivered." + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Boolean' + content: + description: Information on different materials in the product. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_MaterialList' + required: + - applicable + - content + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_MaterialsCharacteristic: + description: Materials Characteristic on product level. + type: object + properties: + substancesOfConcern: + description: |- + Information regarding substances of concern in the product. The ESPR provisional agreement from January 9th, 2024 defines: + (52) 'hazardous substance' means a substance classified as hazardous pursuant to Article 3 of Regulation (EC) No 1272/2008. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_SubstanceOfConcernCharacteristic' + materialComposition: + description: Material composition of the product with information on recycled + and renewable materials. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_MaterialCharacteristic' + required: + - substancesOfConcern + - materialComposition + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_SourceCategoryEnumeration: + type: string + description: The types of sources that can be linked in a digital product passport + can vary depending on the nature of the product and the information that needs + to be included. This is an enumeration of possible sources. + enum: + - Product Specifications + - Manufacturer Information + - User Manuals and Guides + - Certifications and Compliance + - Product Images and Videos + - Warranty Information + - Reviews and Ratings + - Product Variations + - Supply Chain Information + - Environmental Impact + - Compatibility and Accessories + - FAQs and Support + - Purchase and Retail Information + - Privacy and Data Handling + - Third-Party Integrations + - Legal Information + - Safety Information + - Repair and Installation + - Waste Generation and Prevention + - Specific Voluntary Labels + - Product Packaging + - Return and Disposal + - End of Life + - Material and Substance Information + - Technical Documentation + - Treatment facilities + - Other + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentEntity: + description: "Document entity with header, content, category and type." + type: object + properties: + content: + description: The content of the document e.g a link. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + category: + description: |- + The category in which the document can be sorted. These are mentioned in the ESPR proposal from March 30th, 2022 ANNEX III: + (e) compliance documentation and information required under this Regulation or other Union law applicable to the product, such as the declaration of conformity, technical documentation or conformity certificates; + ANNEX IV states additional information regarding the content of the technical documentation + Further information on documents are mentioned in the proposal from March 30th, 2022 ANNEX III: + (f) user manuals, instructions, warnings or safety information, as required by other Union legislation applicable to the product. + Additionally requirements are mentioned in Article 21: + (7) Manufacturers shall ensure that that a product covered by a delegated act adopted pursuant to Article 4 is accompanied by instructions that enable consumers and other end-users to safely assemble, install, operate, store, maintain, repair and dispose of the product in a language that can be easily understood by consumers and other end-users, as determined by the Member State concerned. Such instructions shall be clear, understandable and legible and include at least the information specified in the delegated acts adopted pursuant to Article 4 and pursuant to Article 7(2)(b), point (ii). + Article 7 states additionally: + (2) (b) (ii) information for consumers and other end-users on how to install, use, maintain and repair the product in order to minimize its impact on the environment and to ensure optimum durability, as well as on how to return or dispose of the product at end-of-life; + (2) (b) (iii) information for treatment facilities on disassembly, recycling, or disposal at end-of-life; + (2) (b) (iv) other information that may influence the way the product is handled by parties other than the manufacturer in order to improve performance in relation to product parameters referred to in Annex I. + (5) (d) relevant instructions for the safe use of the product. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_SourceCategoryEnumeration' + type: + description: "The type of content which can be expected in the \"content\"\ + \ property. Examples are a link, restricted link, pdf, excel, etc." + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + header: + description: The header as a short description of the document with a maximum + of 100 characters. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_HeaderTrait' + required: + - content + - category + - type + - header + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_SourceList: + description: A list of documents. + type: array + items: + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentEntity' + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_StateEnumeration: + type: string + description: "Enumeration defined as original, repurposed, re-used, remanufactured\ + \ or waste." + enum: + - original + - repurposed + - re-used + - remanufactured + - waste + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_CategoryEnumeration: + type: string + description: Enumeration of the 19 impact categories in accordance to EN15804+A2. + enum: + - Climate Change Total + - Climate Change Fossil + - Climate Change Biogenic Removals and Emissions + - Climate Change Land Use and Land Use Change + - Ozone Depletion + - Acidification + - Eutrophication Aquatic Freshwater + - Eutrophication Fresh Marine + - Eutrophication Terrestrial + - Photochemical Ozone Formation + - Abiotic Depletion- Minerals and Metals + - Fossil Fuels + - Water Use + - Particulate Matter Emissions + - "Ionizing Radiation, Human Health" + - Eco-Toxicity + - "Human Toxicity, Cancer Effects" + - "Human Toxicity, Non-Cancer Effects" + - Land Use Related Impacts/Soil Quality + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_FootprintEntity: + description: "Footprint Entity for the carbon and environmental footprint with\ + \ the total value, unit, impact category type, lifecycle, rulebook, declaration,\ + \ performance class and the facility." + type: object + properties: + value: + description: | + The value of the footprint of the product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Annex I: + (l) the environmental footprint of the product, expressed as a quantification, in accordance with the applicable delegated act, of a product's life cycle environmental impacts, whether in relation to one or more environmental impact categories or an aggregated set of impact categories; + (m) the carbon footprint of the product; + (ma) the material footprint of the product. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PositiveTrait' + rulebook: + description: The applied rulebook for the environmental footprint of the + product. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentList' + lifecycle: + description: "The lifecycle stage, to which the environmental footprint\ + \ corresponds. These could be for example \"raw material acquisition and\ + \ pre-processing\", \"main product production\", \"distribution\" or \"\ + end of life and recycling\"." + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + unit: + description: "The unit of measurement of the environmental impact category.\ + \ For each impact category a specific unit is used. If an aggregation\ + \ is used, utilize the normalization and weighting methods used in the\ + \ referenced rulebook." + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + type: + description: |- + The type of the environmental footprint of the product. This could be one of the environmental impact categories. This attribute is mentioned in the ESPR provisional agreement from January 9th 2024 Article 7: + (2)(b)(i) information on the performance of the product in relation to one or more of the product parameters referred to in Annex I, including a scoring of reparability or durability, carbon footprint or environmental footprint; + Annex I: + (l) the environmental footprint of the product, expressed as a quantification, in accordance with the applicable delegated act, of a product's life cycle environmental impacts, whether in relation to one or more environmental impact categories or an aggregated set of impact categories. + (m) the carbon footprint of the product; + (ma) the material footprint of the product. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_CategoryEnumeration' + performanceClass: + description: The performance classification of the footprint. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + manufacturingPlant: + description: The manufacturing plant of the footprint in the specific lifecycle + phase. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_FacilityList' + declaration: + description: 'The footprint declaration in the format of a link ' + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentList' + required: + - value + - rulebook + - lifecycle + - unit + - type + - manufacturingPlant + - declaration + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_FootprintList: + description: Footprint List for the environmental footprint. + type: array + items: + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_FootprintEntity' + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_ProductFootprintCharacteristic: + description: The Product Footprint Characteristic with sustainability information. + type: object + properties: + environmental: + description: |- + The environmental footprint of the product. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I: + The following parameters shall, as appropriate, and where necessary supplemented by others, be used, individually or combined, as a basis for improving the product aspects referred to in Article 5(1): + (l) the environmental footprint of the product, expressed as a quantification, in accordance with the applicable delegated act, of a product's life cycle environmental impacts, whether in relation to one or more environmental impact categories or an aggregated set of impact categories. + and Article 7: + (2)(b)(i) information on the performance of the product in relation to one or more of the product parameters referred to in Annex I, including a scoring of reparability or durability, carbon footprint or environmental footprint; + and defined by Article 2: + (23) 'environmental footprint' means a quantification of product environmental impacts throughout its life cycle, whether in relation to a single environmental impact category or an aggregated set of impact categories based on the Product Environmental Footprint method or other scientific methods developed by international organisations and widely tested in collaboration with different industry sectors and adopted or implemented by the Commission in other Union legislation; + (24) 'Product Environmental Footprint method' means the life cycle assessment method to quantify the environmental impacts of products established by Recommendation (EU) 2021/2279. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_FootprintList' + carbon: + description: |- + The carbon footprint of the product. This is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I: + The following parameters shall, as appropriate, and where necessary supplemented by others, be used, individually or combined, as a basis for improving the product aspects referred to in Article 5(1): + (m) the carbon footprint of the product; + and Article 7: + (2)(b)(i) information on the performance of the product in relation to one or more of the product parameters referred to in Annex I, including a scoring of reparability or durability, carbon footprint or environmental footprint; + and defined by Article 2: + (25) 'carbon footprint' means the sum of greenhouse gas (GHG) emissions and GHG removals in a product system, expressed as CO2 equivalents and based on a life cycle assessment using the single impact category of climate change. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_FootprintList' + material: + description: |- + The material footprint of the product. This is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I: + (ma) the material footprint of the product; + and defined by Article 2: + (25a) 'material footprint' refers to the total amount of raw materials extracted to meet final consumption demands. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_FootprintList' + required: + - carbon + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_SustainabilityCharacteristic: + description: Characteristic which describes relevant information for the sustainability + of the product. + type: object + properties: + status: + description: |- + The status of the product (original, repurposed, re-used, remanufactured or waste) to indicated, whether it is a used product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Annex I: + (j) incorporation of used components. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_StateEnumeration' + productFootprint: + description: "The carbon and environmental footprint or material footprint\ + \ of the product. These attributes are mentioned in the ESPR provisional\ + \ agreement from January 9th 2024 Annex I:\n(l) the environmental footprint\ + \ of the product, expressed as a quantification, in accordance with the\ + \ applicable delegated act, of a product's life cycle environmental impacts,\ + \ whether in relation to one or more environmental impact categories or\ + \ an aggregated set of impact categories;\n(m) the carbon footprint of\ + \ the product;\n(ma) the material footprint of the product;\nAll are defined\ + \ by Article 2:\n(23) 'environmental footprint' means a quantification\ + \ of product environmental impacts throughout its life cycle, whether\ + \ in relation to a single environmental impact category or an aggregated\ + \ set of impact categories based on the Product Environmental Footprint\ + \ method or other scientific methods developed by international organisations\ + \ and widely tested in collaboration with different industry sectors and\ + \ adopted or implemented by the Commission in other Union \nlegislation;\n\ + (25) 'carbon footprint' means the sum of greenhouse gas (GHG) emissions\ + \ and GHG removals in a product system, expressed as CO2 equivalents and\ + \ based on a life cycle assessment using the single impact category of\ + \ climate change.\n(25a) 'material footprint' refers to the total amount\ + \ of raw materials extracted to meet final consumption demands;" + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_ProductFootprintCharacteristic' + reparabilityScore: + description: |- + The reparability score. This attribute is mentioned ESPR provisional agreement from January 9th, 2024 Article 7: + (b) as appropriate, also require products to be accompanied by: + (i) information on the performance of the product in relation to one or more of the product parameters referred to in Annex I, including a scoring of reparability or durability [...]. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + durabilityScore: + description: |- + The durability score. This attribute is mentioned ESPR provisional agreement from January 9th, 2024 Article 7: + (b) as appropriate, also require products to be accompanied by: + (i) information on the performance of the product in relation to one or more of the product parameters referred to in Annex I, including a scoring of reparability or durability [...]. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + required: + - status + - productFootprint + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_StatusEnumeration: + type: string + description: "The current status of the product passport declared through either:\ + \ draft, approved, invalid or expired." + enum: + - draft + - approved + - invalid + - expired + 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_io.catenax.generic.digital_product_passport_5.0.0_MetadataCharacteristic: + description: Characteristic for the passport metadata of the digital product + passport. + type: object + properties: + version: + description: |- + The current version of the product passport. The possibility of modification/ updating the product passport needs to include versioning of the dataset. This attribute is an internal versioning from the passport issuer. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Article 8: + (1) [...] The information in the product passport shall be accurate, complete, and up to date. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + status: + description: "The current status of the product passport declared through\ + \ either: draft, approved, invalid or expired." + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_StatusEnumeration' + expirationDate: + description: |- + The timestamp in the format (yyyy-mm-dd) for the product passport until when it is available or a comment describing this period. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Article 8: + (2) (h) the period during which the product passport is to remain available, which shall correspond to at least the expected lifetime of a specific product. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DateTrait' + issueDate: + description: The timestamp in the format (yyyy-mm-dd) since when the product + passport is available. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DateTrait' + economicOperatorId: + description: |- + The identification of the owner/economic operator of the passport. Proposed, according to ISO 15459, is the CIN (company identification code). Other identification numbers like the tax identification number, value added tax identification number, commercial register number and the like are also valid entries. In the Catena-X network, the BPNL is used for the identification of companies and the information stored like contact information and addresses. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Annex III: + (k) the [...] unique operator identifier code of the economic operator established in the Union responsible for carrying out the tasks set out in Article 4 of Regulation (EU) 2019/1020, or Article 15 of Regulation (EU) on general product safety, or similar tasks pursuant to other EU legislation applicable to the product. + $ref: '#/components/schemas/urn_samm_io.catenax.shared.business_partner_number_2.0.0_BpnlTrait' + passportIdentifier: + description: "The identifier of the product passport, which is an uuidv4." + $ref: '#/components/schemas/urn_samm_io.catenax.shared.uuid_2.0.0_UuidV4Trait' + predecessor: + description: |- + Identification of the preceding product passport. If there is no preceding passport, input a dummy value. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Article 8: + (2)(g) [...] Any new product passport shall be linked to the product passport or passports of the original product whenever appropriate. + $ref: '#/components/schemas/urn_samm_io.catenax.shared.uuid_2.0.0_UuidV4Trait' + backupReference: + description: |- + A reference to the data backup of the passport. This mandatory attribute will be further defined in the future. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex III: + (kb) the reference of the certified independent third-party product passport service provider hosting the back-up copy of the product passport. + Article 10 also mentions: + (c) the data included in the product passport shall be stored by the economic operator responsible for its creation or by certified independent third-party product passport service providers authorised to act on their behalf. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + registrationIdentifier: + description: |- + Identifier in the respective registry. This will be further defined in the future. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 in Article 12: + By [2 years from entering into force of this Regulation], the Commission shall set up and manage a digital registry ("the registry") storing in a secure manner at least the unique product identifier, the unique operator identifier, the unique facility identifiers. In case of products intended to be placed under the customs procedure 'release for free circulation', the registry shall also store the product commodity code. The registry shall also store the batteries' unique identifiers referred to in Article 77(3) of Regulation (EU) 2023/1542. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_IdentifierCharacteristic' + lastModification: + description: Date of the latest modification. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DateTrait' + required: + - version + - expirationDate + - issueDate + - economicOperatorId + - passportIdentifier + - predecessor + - backupReference + urn_samm_io.catenax.material.chemical_material_passport_2.0.0_GenericCharacteristic: + description: Characteristic for the product generic parameters. + type: object + properties: + identification: + description: "Identification information of the product, especially identifiers\ + \ and codes. These are mentioned in the ESPR provisional agreement from\ + \ January 9th, 2024 ANNEX III:\n(b) the unique product identifier at the\ + \ level indicated in the applicable delegated act adopted pursuant to\ + \ Article 4.\nAdditionally in Article 9 regarding general requirements\ + \ for the product passport is stated that:\nA product passport shall meet\ + \ the following conditions:\n(a) it shall be connected through a data\ + \ carrier to a persistent unique product identifier;\n(e) the information\ + \ included in the product passport shall refer to the product model, batch,\ + \ or item as specified in the delegated act adopted pursuant to Article\ + \ 4.\nArticle 2 Definitions: \n(31) 'unique product identifier' means\ + \ a unique string of characters for the identification of products that\ + \ also enables a web link to the product passport;\nRecital (27): A 'model'\ + \ usually means a version of a product of which all units share the same\ + \ technical characteristics relevant for the ecodesign requirements and\ + \ the same model identifier, a 'batch' usually means a subset of a specific\ + \ model composed of all products produced in a specific manufacturing\ + \ plant at a specific moment in time and an 'item' usually means a single\ + \ unit of a model." + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_IdentificationCharacteristic' + operation: + description: Operational information of the product. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_OperationCharacteristic' + characteristics: + description: Defines specific characteristics of a product. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_ProductCharacteristics' + commercial: + description: Commercial information of the product. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_CommercialCharacteristic' + materials: + description: Properties which are relevant for the materials of the product. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_MaterialsCharacteristic' + sources: + description: |- + Documents that are mandatory if applicable for the product. These are mentioned in the ESPR provisional agreement from January 9th, 2024 ANNEX III: + (e) compliance documentation and information required under this Regulation or other Union law applicable to the product, such as the declaration of conformity, technical documentation or conformity certificates; + (f) user manuals, instructions, warnings or safety information, as required by other Union legislation applicable to the product. + Additionally requirements are mentioned in Article 21: + 7. Manufacturers shall ensure that a product covered by a delegated act adopted pursuant to Article 4 is accompanied by instructions in digital format that enable customers and other relevant actors to assemble, install, operate, store, maintain, repair and dispose of the product in a language that can be easily understood, as determined by the Member State concerned. Such instructions shall be clear, understandable and legible and include at least the information set out in Article 7(2), point (b), point (ii) specified in the delegated acts adopted pursuant to Article 4. + Article 7 states additionally: + (ii) information for customers and other actors on how to install, use, maintain and repair the product, in order to minimise its impact on the environment and to ensure optimum durability, on how to install third-party operating systems where relevant, as well as on collection for refurbishment or remanufacture, and on how to return or handle the product at the end of its life; + (2) (b) (iii) information for treatment facilities on disassembly, reuse, refurbishment, recycling, or disposal at end-of-life; + (2) (b) (iv) other information that may influence sustainable product choices for customers and the way the product is handled by parties other than the manufacturer in order to facilitate appropriate use, value retaining operations and correct treatment at end-of-life. + (5) (d) relevant instructions for the safe use of the product. + (5) (e) information relevant for disassembly, preparation for reuse, reuse, recycling and the environmentally sound management of the product at the end of its life. + Annex I: + (b) [...] availability of repair and maintenance instructions, number of materials and components used, use of standard components,[...] number and complexity of processes and whether specialised toolsare needed, ease of non-destructive disassembly and re-assembly, conditions for access to product data, conditions for access to or use of hardware and software needed; + (c) ease of upgrading, re-use, remanufacturing and refurbishment as expressed through: [...] number and complexity of processes and tools needed, ease of non-destructive disassembly and re-assembly, conditions for access to product data, conditions for access to or use of hardware and software needed, conditions of access to test protocols or not commonly available testing equipment, availability of guarantees specific to remanufactured or refurbished products, conditions for access to or use of technologies protected by intellectual property rights, modularity; + (d) design for recycling, ease and quality of recycling as expressed through: use of easily recyclable materials, safe, easy and non-destructive access to recyclable components and materials or components and materials containing hazardous substances and material composition and homogeneity, possibility for high-purity sorting, [...] number and complexity of processes and tools needed, ease of nondestructive disassembly and re-assembly, conditions for access to product data, conditions for access to or use of hardware and software needed; + (q) functional performance and conditions for use including as expressed through ability in performing its intended use, precautions of use, skills required, compatibility with other products or systems. + Additionally to consider are guidelines and instructions regarding the proper management and disposal of packaging materials after use. This can include instructions for separation, reuse, and recycling. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_SourceList' + sustainability: + description: Sustainability related attributes. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_SustainabilityCharacteristic' + metadata: + description: "Metadata of the product passport. These are mentioned in the\ + \ ESPR proposal from March 30th, 2022 and some changed by the provisional\ + \ agreement from January 9th, 2024." + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_MetadataCharacteristic' + required: + - identification + - operation + - characteristics + - commercial + - materials + - sources + - sustainability + - metadata + ChemicalMaterialPassport: + description: "The information in a Digital Product Passport allows stakeholders\ + \ in the value chain to map information and obtain a better understanding\ + \ of the composition of the product, the environmental impact of the production\ + \ and use phase, and the aspect of circularity. To serve the same purpose\ + \ as the Digital Passport, the Chemical Material Passport also plays an important\ + \ role in providing more detailed information in terms of sustainability,\ + \ safety and waste management. It can replace the current way of communication\ + \ and data exchange from multi-channels by one streamlined data flow." + type: object + properties: + specific: + description: Product specific parameters of the electric drive. + $ref: '#/components/schemas/urn_samm_io.catenax.material.chemical_material_passport_2.0.0_SpecificCharacteristic' + generic: + description: "The product generic parameters. These are defined by the Digital\ + \ Product Passport proposal from the ESPR. The main basis is provided\ + \ by the document \"Proposal for a REGULATION OF THE EUROPEAN PARLIAMENT\ + \ AND OF THE COUNCIL establishing a framework for setting ecodesign requirements\ + \ for sustainable products and repealing Directive 2009/125/EC\" from\ + \ March 30th, 2022. The latest version of the document was the provisional\ + \ agreement between the EU Council and the Parliament from January 9th,\ + \ 2024." + $ref: '#/components/schemas/urn_samm_io.catenax.material.chemical_material_passport_2.0.0_GenericCharacteristic' + required: + - specific + - generic + 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' + ChemicalMaterialPassport: + content: + application/json: + schema: + $ref: '#/components/schemas/ChemicalMaterialPassport' + description: The request was successful. + requestBodies: + ChemicalMaterialPassport: + content: + application/json: + schema: + $ref: '#/components/schemas/ChemicalMaterialPassport' diff --git a/io.catenax.material.chemical_material_passport/2.0.0/metadata.json b/io.catenax.material.chemical_material_passport/2.0.0/metadata.json new file mode 100644 index 000000000..0fdd8255b --- /dev/null +++ b/io.catenax.material.chemical_material_passport/2.0.0/metadata.json @@ -0,0 +1 @@ +{ "status" : "release"} \ No newline at end of file diff --git a/io.catenax.material.chemical_material_passport/RELEASE_NOTES.md b/io.catenax.material.chemical_material_passport/RELEASE_NOTES.md index dd8fdf49e..a1dce2b3d 100644 --- a/io.catenax.material.chemical_material_passport/RELEASE_NOTES.md +++ b/io.catenax.material.chemical_material_passport/RELEASE_NOTES.md @@ -3,6 +3,13 @@ All notable changes to this model will be documented in this file. ## [Unreleased] +## [2.0.0] - 2024-05-21 +### Changed +- connection update to @prefix ext-passport: +- changed safetyDocument to safetyDocumentation and changed payload name +- moved methodName together with "condition" and "description" of the method +- changed payload name from unspecific to generic on highest level + ## [1.0.0] - 2024-04-22 ### Added - initial model diff --git a/io.catenax.material_flow_scenario_request/2.0.0/MaterialFlowScenarioRequestAspect.ttl b/io.catenax.material_flow_scenario_request/2.0.0/MaterialFlowScenarioRequestAspect.ttl new file mode 100644 index 000000000..5dc9f0c75 --- /dev/null +++ b/io.catenax.material_flow_scenario_request/2.0.0/MaterialFlowScenarioRequestAspect.ttl @@ -0,0 +1,214 @@ +########################################################################################## +# Copyright (c) 2023,2024 Fraunhofer-Gesellschaft zur Förderung der angewandten Forschung e. V. +# Copyright (c) 2023,2024 German Edge Cloud GmbH & Co. KG +# Copyright (c) 2023,2024 Siemens AG +# Copyright (c) 2023,2024 Contributors to the Eclipse Foundation + +# +# 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-result: . + +:MaterialFlowScenarioRequestAspect a samm:Aspect ; + samm:preferredName "Material Flow Scenario Request Aspect"@en ; + samm:description "Aspect model describing the Material Flow Scenario Request"@en ; + samm:properties ( :materialFlowScenarioRequest ) ; + samm:operations ( ) ; + samm:events ( ) . + +:materialFlowScenarioRequest a samm:Property ; + samm:preferredName "Material Flow Scenario Request"@en ; + samm:description "Contains standardized attributes for the content of the Material Flow Scenario Request"@en ; + samm:characteristic :MaterialFlowScenarioRequestCharacteristic . + +:MaterialFlowScenarioRequestCharacteristic a samm:Characteristic ; + samm:preferredName "Material Flow Scenario Request Characteristic"@en ; + samm:description "Characteristic describing the aspect Material Flow Scenario Request"@en ; + samm:dataType :MaterialFlowScenarioRequest . + +:MaterialFlowScenarioRequest a samm:Entity ; + samm:preferredName "Material Flow Scenario Request"@en ; + samm:description "The Material Flow Scenario Request contains standardized attributes for exchanging scenario requests and the resulting simulation results between two OSIM Manager Instances"@en ; + samm:properties ( :scenarioHeader [ samm:property :scenarioParameter; samm:optional true ] :scenarioSimResults ) . + +:scenarioHeader a samm:Property ; + samm:preferredName "Scenario Header"@en ; + samm:description "Required parameters for the scenario header"@en ; + samm:characteristic :ScenarioHeaderCharacteristic . + +:scenarioParameter a samm:Property ; + samm:preferredName "Scenario Parameter"@en ; + samm:description "Required parameters for the material flow scenario request"@en ; + samm:characteristic :ScenarioParameterCharacteristic . + +:scenarioSimResults a samm:Property ; + samm:preferredName "Scenario Sim Results"@en ; + samm:description "Simulation results of the scenario"@en ; + samm:characteristic :ScenarioSimResultsCharacteristic . + +:ScenarioHeaderCharacteristic a samm:Characteristic ; + samm:preferredName "Scenario Header Characteristic"@en ; + samm:description "Characteristic describing the parameter for a scenario header"@en ; + samm:dataType :ScenarioHeader . + +:ScenarioParameterCharacteristic a samm-c:Collection ; + samm:preferredName "Scenario Parameter Characteristic"@en ; + samm:description "Characteristic describing the scenario parameter"@en ; + samm:dataType :ScenarioParameter . + +:ScenarioSimResultsCharacteristic a samm:Characteristic ; + samm:preferredName "Scenario Simulation Results Characteristic"@en ; + samm:description "Characteristic for simulation results"@en ; + samm:dataType :ScenarioSimResults . + +:ScenarioHeader a samm:Entity ; + samm:preferredName "Scenario Header"@en ; + samm:description "Headers required for every exchange"@en ; + samm:properties ( :scenarioId :scenarioTitle :scenarioCreationTimestamp :scenarioExpirationTimestamp :scenarioOwner :scenarioOwnerRole [ samm:property :scenarioDescription; samm:optional true ] ) . + +:ScenarioParameter a samm:Entity ; + samm:preferredName "Scenario Parameter"@en ; + samm:description "Parameters which are used to describe a material flow scenario request"@en ; + samm:properties ( :parameterId :parameterDeliveryDateInitial :parameterDeliveryDateUpdated :parameterQuantityInitial :parameterQuantityUpdated :parameterOrderId :parameterComment ext-result:materialNumber ext-result:materialName ext-result:unitOfMeasurement ) . + +:ScenarioSimResults a samm:Entity ; + samm:preferredName "Scenario Simulation Results"@en ; + samm:description "Attached to a scenario simulation results of the feedback requestor"@en ; + samm:properties ( :resultOwnId [ samm:property :resultOwnSimRunInitial; samm:optional true ] [ samm:property :resultOwnSimRunUpdated; samm:optional true ] ) . + +:scenarioId a samm:Property ; + samm:preferredName "Scenario ID"@en ; + samm:description "ID of scenario header"@en ; + samm:characteristic samm-c:Text ; + samm:exampleValue "8d464b8b-6977-4952-8a22-0489067ca081" . + +:scenarioTitle a samm:Property ; + samm:preferredName "Scenario Title"@en ; + samm:description "Title of scenario"@en ; + samm:characteristic samm-c:Text ; + samm:exampleValue "Delivery Modification" . + +:scenarioCreationTimestamp a samm:Property ; + samm:preferredName "Scenario Creation Timestamp"@en ; + samm:description "Date and Time of scenario creation"@en ; + samm:characteristic samm-c:Timestamp ; + samm:exampleValue "2023-10-04T09:10:00.000Z"^^xsd:dateTime . + +:scenarioExpirationTimestamp a samm:Property ; + samm:preferredName "Scenario Expiration Timestamp"@en ; + samm:description "Date and Time of validity expiration"@en ; + samm:characteristic samm-c:Timestamp ; + samm:exampleValue "2023-10-07T09:10:00.000Z"^^xsd:dateTime . + +:scenarioOwner a samm:Property ; + samm:preferredName "Scenario Owner"@en ; + samm:description "Owner of the simulation scenario"@en ; + samm:characteristic :ScenarioOwnerCharacteristic . + +:scenarioOwnerRole a samm:Property ; + samm:preferredName "Scenario Owner Role"@en ; + samm:description "Role of the scenario owner"@en ; + samm:characteristic :ScenarioOwnerRoleCharacteristic ; + samm:exampleValue "Customer" . + +:scenarioDescription a samm:Property ; + samm:preferredName "Scenario Description"@en ; + samm:description "Description of the scenario"@en ; + samm:characteristic samm-c:Text ; + samm:exampleValue "Changes in Delivery Date" . + +:parameterId a samm:Property ; + samm:preferredName "Parameter ID"@en ; + samm:description "Identifier of scenario parameter"@en ; + samm:characteristic samm-c:Text ; + samm:exampleValue "847c71e5-614a-468b-a3a0-674bf2af3004" . + +:parameterDeliveryDateInitial a samm:Property ; + samm:preferredName "Parameter Delivery Date Initial"@en ; + samm:description "Delivery date initial (without scenario changes), optional, NULL when initially not set"@en ; + samm:characteristic samm-c:Timestamp ; + samm:exampleValue "2023-10-09T10:00:00.000Z"^^xsd:dateTime . + +:parameterDeliveryDateUpdated a samm:Property ; + samm:preferredName "Parameter Delivery Date Updated"@en ; + samm:description "Delivery date updated (with scenario changes)"@en ; + samm:characteristic samm-c:Timestamp ; + samm:exampleValue "2023-10-10T09:00:00.000Z"^^xsd:dateTime . + +:parameterQuantityInitial a samm:Property ; + samm:preferredName "Parameter Quantity Initial"@en ; + samm:description "Amount initial (without scenario changes), optional, NULL, when initially not set"@en ; + samm:characteristic :QuantityCharacteristic ; + samm:exampleValue "1"^^xsd:float . + +:parameterQuantityUpdated a samm:Property ; + samm:preferredName "Parameter Quantity Updated"@en ; + samm:description "Amount updated (with scenario changes)"@en ; + samm:characteristic :QuantityCharacteristic ; + samm:exampleValue "1"^^xsd:float . + +:parameterOrderId a samm:Property ; + samm:preferredName "Parameter Order Id"@en ; + samm:description "ID of the order"@en ; + samm:characteristic samm-c:Text ; + samm:exampleValue "OID-011123546" . + +:parameterComment a samm:Property ; + samm:preferredName "Parameter Comment"@en ; + samm:description "Optional description of parameters"@en ; + samm:characteristic samm-c:Text ; + samm:exampleValue "updated Delivery Date" . + +:resultOwnId a samm:Property ; + samm:preferredName "Result Own Id"@en ; + samm:description "ID of scenario result own"@en ; + samm:characteristic samm-c:Text ; + samm:exampleValue "916b5688-8bd8-4d7e-83b9-e0d40939274e" . + +:resultOwnSimRunInitial a samm:Property ; + samm:preferredName "Result Own Sim Run Initial"@en ; + samm:description "Foreign key to simulation result based on initial parameters"@en ; + samm:characteristic :SimResult . + +:resultOwnSimRunUpdated a samm:Property ; + samm:preferredName "Result Own Sim Run Updated"@en ; + samm:description "Foreign key to simulation result based on updated parameter (scenario)"@en ; + samm:characteristic :SimResult . + +:ScenarioOwnerCharacteristic a samm:Characteristic ; + samm:preferredName "Scenario Owner Characteristic"@en ; + samm:description "Characteristic describing the Scenario Owner"@en ; + samm:dataType ext-result:BusinessPartnerSite . + +:ScenarioOwnerRoleCharacteristic a samm-c:Enumeration ; + samm:preferredName "Scenario Owner Role Characteristic"@en ; + samm:description "Characteristic describing possible values for the role of the scenario owner"@en ; + samm:dataType xsd:string ; + samm-c:values ( "Customer" "Supplier" "LogisticianReceiving" "LogisticianSending" ) . + +:QuantityCharacteristic a samm:Characteristic ; + samm:preferredName "Quantity Characteristic"@en ; + samm:description "Describes a property which is a Float"@en ; + samm:dataType xsd:float . + +:SimResult a samm:Characteristic ; + samm:preferredName "Sim Result"@en ; + samm:description "Characteristic describing the property for a Material Flow Simulation Result"@en ; + samm:dataType ext-result:MaterialFlowSimulationResult . diff --git a/io.catenax.material_flow_scenario_request/2.0.0/gen/MaterialFlowScenarioRequestAspect-aas.xml b/io.catenax.material_flow_scenario_request/2.0.0/gen/MaterialFlowScenarioRequestAspect-aas.xml new file mode 100644 index 000000000..ab453abfb --- /dev/null +++ b/io.catenax.material_flow_scenario_request/2.0.0/gen/MaterialFlowScenarioRequestAspect-aas.xml @@ -0,0 +1,6878 @@ + + + + + defaultAdminShell + + + en + defaultAdminShell + + + + urn:samm:io.catenax.material_flow_scenario_request:2.0.0#MaterialFlowScenarioRequestAspect + + Type + + + + ModelReference + + + Submodel + urn:samm:io.catenax.material_flow_scenario_request:2.0.0#MaterialFlowScenarioRequestAspect/submodel + + + + + + + + + MaterialFlowScenarioRequestAspect + + + en + Aspect model describing the Material Flow Scenario Request + + + + urn:samm:io.catenax.material_flow_scenario_request:2.0.0#MaterialFlowScenarioRequestAspect/submodel + Template + + ModelReference + + + ConceptDescription + urn:samm:io.catenax.material_flow_scenario_request:2.0.0#MaterialFlowScenarioRequestAspect + + + + + + MaterialFlowScenarioRequest + + + en + Material Flow Scenario Request + + + + + en + The Material Flow Scenario Request contains standardized attributes for exchanging scenario requests and the resulting simulation results between two OSIM Manager Instances + + + + + ScenarioHeader + + + en + Scenario Header + + + + + en + Headers required for every exchange + + + + + scenarioId + + + en + Scenario ID + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material_flow_scenario_request:2.0.0#scenarioId + + + + xs:string + + + + scenarioTitle + + + en + Scenario Title + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material_flow_scenario_request:2.0.0#scenarioTitle + + + + xs:string + + + + scenarioCreationTimestamp + + + en + Scenario Creation Timestamp + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material_flow_scenario_request:2.0.0#scenarioCreationTimestamp + + + + xs:dateTime + + + + scenarioExpirationTimestamp + + + en + Scenario Expiration Timestamp + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material_flow_scenario_request:2.0.0#scenarioExpirationTimestamp + + + + xs:dateTime + + + + BusinessPartnerSite + + + en + Business Partner Site + + + + + en + Identifier for the physical location of a business partner plant or site, (e.g. BPNS in Catena-X context) + + + + + bpnsProperty + + + en + bpnsProperty + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#bpnsProperty + + + + xs:string + + + + + + scenarioOwnerRole + + + en + Scenario Owner Role + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material_flow_scenario_request:2.0.0#scenarioOwnerRole + + + + xs:string + + + + scenarioDescription + + + en + Scenario Description + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material_flow_scenario_request:2.0.0#scenarioDescription + + + + xs:string + + + + + + scenarioParameter + + + en + Scenario Parameter + + + + + en + Required parameters for the material flow scenario request + + + true + DataElement + + + ScenarioParameter + + + en + Scenario Parameter + + + + + en + Parameters which are used to describe a material flow scenario request + + + + + parameterId + + + en + Parameter ID + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material_flow_scenario_request:2.0.0#parameterId + + + + xs:string + + + + parameterDeliveryDateInitial + + + en + Parameter Delivery Date Initial + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material_flow_scenario_request:2.0.0#parameterDeliveryDateInitial + + + + xs:dateTime + + + + parameterDeliveryDateUpdated + + + en + Parameter Delivery Date Updated + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material_flow_scenario_request:2.0.0#parameterDeliveryDateUpdated + + + + xs:dateTime + + + + parameterQuantityInitial + + + en + Parameter Quantity Initial + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material_flow_scenario_request:2.0.0#parameterQuantityInitial + + + + xs:float + + + + parameterQuantityUpdated + + + en + Parameter Quantity Updated + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material_flow_scenario_request:2.0.0#parameterQuantityUpdated + + + + xs:float + + + + parameterOrderId + + + en + Parameter Order Id + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material_flow_scenario_request:2.0.0#parameterOrderId + + + + xs:string + + + + parameterComment + + + en + Parameter Comment + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material_flow_scenario_request:2.0.0#parameterComment + + + + xs:string + + + + materialNumber + + + en + Material Number + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#materialNumber + + + + xs:string + + + + materialName + + + en + Material Name + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#materialName + + + + xs:string + + + + unitOfMeasurement + + + en + Unit Of Measurement + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#unitOfMeasurement + + + + xs:string + + + + + + + + ScenarioSimResults + + + en + Scenario Simulation Results + + + + + en + Attached to a scenario simulation results of the feedback requestor + + + + + resultOwnId + + + en + Result Own Id + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material_flow_scenario_request:2.0.0#resultOwnId + + + + xs:string + + + + MaterialFlowSimulationResult + + + en + Material Flow Simulation Result + + + + + en + Result of a Material Flow Simulation + + + + + description + + + en + Description + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#description + + + + xs:string + + + + runId + + + en + RunId + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#runId + + + + xs:string + + + + comment + + + en + Comment + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#comment + + + + xs:string + + + + expirationTimestamp + + + en + ExpirationTimestamp + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#expirationTimestamp + + + + xs:dateTime + + + + BusinessPartnerSite + + + en + Business Partner Site + + + + + en + Identifier for the physical location of a business partner plant or site, (e.g. BPNS in Catena-X context) + + + + + bpnsProperty + + + en + bpnsProperty + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#bpnsProperty + + + + xs:string + + + + + + dataQuality + + + en + Data Quality + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#dataQuality + + + + xs:nonNegativeInteger + + + + shipments + + + en + Shipments + + + + + en + List of shipments + + + true + DataElement + + + Shipment + + + en + Shipment + + + + + en + Delivery item from a sender to a recipient containing goods + + + + + shipmentId + + + en + Shipment Id + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#shipmentId + + + + xs:string + + + + BusinessPartnerSite + + + en + Business Partner Site + + + + + en + Identifier for the physical location of a business partner plant or site, (e.g. BPNS in Catena-X context) + + + + + bpnsProperty + + + en + bpnsProperty + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#bpnsProperty + + + + xs:string + + + + + + destinationTimestamp + + + en + Destination Timestamp + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#destinationTimestamp + + + + xs:dateTime + + + + BusinessPartnerSite + + + en + Business Partner Site + + + + + en + Identifier for the physical location of a business partner plant or site, (e.g. BPNS in Catena-X context) + + + + + bpnsProperty + + + en + bpnsProperty + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#bpnsProperty + + + + xs:string + + + + + + recipientTimestampPlanned + + + en + Recipient Timestamp Planned + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#recipientTimestampPlanned + + + + xs:dateTime + + + + splittingAllowed + + + en + Splitting Allowed + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#splittingAllowed + + + + xs:boolean + + + + BusinessPartnerSite + + + en + Business Partner Site + + + + + en + Identifier for the physical location of a business partner plant or site, (e.g. BPNS in Catena-X context) + + + + + bpnsProperty + + + en + bpnsProperty + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#bpnsProperty + + + + xs:string + + + + + + BusinessPartnerSite + + + en + Business Partner Site + + + + + en + Identifier for the physical location of a business partner plant or site, (e.g. BPNS in Catena-X context) + + + + + bpnsProperty + + + en + bpnsProperty + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#bpnsProperty + + + + xs:string + + + + + + handlingUnits + + + en + Handling Units + + + + + en + List of Handling Units + + + true + DataElement + + + HandlingUnit + + + en + Handling Unit + + + + + en + Handling Unit is the smallest shipment unit and cannot be divided into several shipments + + + + + handlingUnitId + + + en + Handling Unit Id + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#handlingUnitId + + + + xs:string + + + + name + + + en + Name + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#name + + + + xs:string + + + + volume + + + en + Volume + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#volume + + + + xs:float + + + + weight + + + en + Weight + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#weight + + + + xs:float + + + + amount + + + en + Amount + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#amount + + + + xs:positiveInteger + + + + batches + + + en + Batches + + + + + en + List of material batches contained within a handling unit + + + true + DataElement + + + MaterialBatch + + + en + Material Batch + + + + + en + Material Batches are part of a handling unit + + + + + batchSerialNumber + + + en + Batch Serial Number + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#batchSerialNumber + + + + xs:string + + + + materialNumber + + + en + Material Number + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#materialNumber + + + + xs:string + + + + materialName + + + en + Material Name + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#materialName + + + + xs:string + + + + materialHazardousGoods + + + en + Material Hazardous Goods + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#materialHazardousGoods + + + + xs:boolean + + + + batchExpirationTimestamp + + + en + Batch Expiration Timestamp + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#batchExpirationTimestamp + + + + xs:dateTime + + + + quantity + + + en + Quantity + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#quantity + + + + xs:float + + + + unitOfMeasurement + + + en + Unit Of Measurement + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#unitOfMeasurement + + + + xs:string + + + + batchNumber + + + en + Batch Number + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#batchNumber + + + + xs:string + + + + batchOrderId + + + en + Batch Order Id + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#batchOrderId + + + + xs:string + + + + + + + + + + + + + + + + timestamp + + + en + Timestamp + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#timestamp + + + + xs:dateTime + + + + + + MaterialFlowSimulationResult + + + en + Material Flow Simulation Result + + + + + en + Result of a Material Flow Simulation + + + + + description + + + en + Description + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#description + + + + xs:string + + + + runId + + + en + RunId + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#runId + + + + xs:string + + + + comment + + + en + Comment + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#comment + + + + xs:string + + + + expirationTimestamp + + + en + ExpirationTimestamp + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#expirationTimestamp + + + + xs:dateTime + + + + BusinessPartnerSite + + + en + Business Partner Site + + + + + en + Identifier for the physical location of a business partner plant or site, (e.g. BPNS in Catena-X context) + + + + + bpnsProperty + + + en + bpnsProperty + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#bpnsProperty + + + + xs:string + + + + + + dataQuality + + + en + Data Quality + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#dataQuality + + + + xs:nonNegativeInteger + + + + shipments + + + en + Shipments + + + + + en + List of shipments + + + true + DataElement + + + Shipment + + + en + Shipment + + + + + en + Delivery item from a sender to a recipient containing goods + + + + + shipmentId + + + en + Shipment Id + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#shipmentId + + + + xs:string + + + + BusinessPartnerSite + + + en + Business Partner Site + + + + + en + Identifier for the physical location of a business partner plant or site, (e.g. BPNS in Catena-X context) + + + + + bpnsProperty + + + en + bpnsProperty + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#bpnsProperty + + + + xs:string + + + + + + destinationTimestamp + + + en + Destination Timestamp + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#destinationTimestamp + + + + xs:dateTime + + + + BusinessPartnerSite + + + en + Business Partner Site + + + + + en + Identifier for the physical location of a business partner plant or site, (e.g. BPNS in Catena-X context) + + + + + bpnsProperty + + + en + bpnsProperty + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#bpnsProperty + + + + xs:string + + + + + + recipientTimestampPlanned + + + en + Recipient Timestamp Planned + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#recipientTimestampPlanned + + + + xs:dateTime + + + + splittingAllowed + + + en + Splitting Allowed + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#splittingAllowed + + + + xs:boolean + + + + BusinessPartnerSite + + + en + Business Partner Site + + + + + en + Identifier for the physical location of a business partner plant or site, (e.g. BPNS in Catena-X context) + + + + + bpnsProperty + + + en + bpnsProperty + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#bpnsProperty + + + + xs:string + + + + + + BusinessPartnerSite + + + en + Business Partner Site + + + + + en + Identifier for the physical location of a business partner plant or site, (e.g. BPNS in Catena-X context) + + + + + bpnsProperty + + + en + bpnsProperty + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#bpnsProperty + + + + xs:string + + + + + + handlingUnits + + + en + Handling Units + + + + + en + List of Handling Units + + + true + DataElement + + + HandlingUnit + + + en + Handling Unit + + + + + en + Handling Unit is the smallest shipment unit and cannot be divided into several shipments + + + + + handlingUnitId + + + en + Handling Unit Id + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#handlingUnitId + + + + xs:string + + + + name + + + en + Name + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#name + + + + xs:string + + + + volume + + + en + Volume + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#volume + + + + xs:float + + + + weight + + + en + Weight + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#weight + + + + xs:float + + + + amount + + + en + Amount + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#amount + + + + xs:positiveInteger + + + + batches + + + en + Batches + + + + + en + List of material batches contained within a handling unit + + + true + DataElement + + + MaterialBatch + + + en + Material Batch + + + + + en + Material Batches are part of a handling unit + + + + + batchSerialNumber + + + en + Batch Serial Number + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#batchSerialNumber + + + + xs:string + + + + materialNumber + + + en + Material Number + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#materialNumber + + + + xs:string + + + + materialName + + + en + Material Name + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#materialName + + + + xs:string + + + + materialHazardousGoods + + + en + Material Hazardous Goods + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#materialHazardousGoods + + + + xs:boolean + + + + batchExpirationTimestamp + + + en + Batch Expiration Timestamp + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#batchExpirationTimestamp + + + + xs:dateTime + + + + quantity + + + en + Quantity + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#quantity + + + + xs:float + + + + unitOfMeasurement + + + en + Unit Of Measurement + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#unitOfMeasurement + + + + xs:string + + + + batchNumber + + + en + Batch Number + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#batchNumber + + + + xs:string + + + + batchOrderId + + + en + Batch Order Id + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#batchOrderId + + + + xs:string + + + + + + + + + + + + + + + + timestamp + + + en + Timestamp + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#timestamp + + + + xs:dateTime + + + + + + + + + + + + + + APPLICATION_CLASS + MaterialFlowScenarioRequestAspect + + + en + Material Flow Scenario Request Aspect + + + + + en + Aspect model describing the Material Flow Scenario Request + + + urn:samm:io.catenax.material_flow_scenario_request:2.0.0#MaterialFlowScenarioRequestAspect + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Material Flow Scenario Request Aspect + + + + + en + MaterialFlowScenarioRequestAspect + + + + + en + Aspect model describing the Material Flow Scenario Request + + + + + + + + + scenarioId + + + en + Scenario ID + + + urn:samm:io.catenax.material_flow_scenario_request:2.0.0#scenarioId + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Scenario ID + + + + + en + scenarioId + + + STRING + + + en + ID of scenario header + + + + + + + + + scenarioTitle + + + en + Scenario Title + + + urn:samm:io.catenax.material_flow_scenario_request:2.0.0#scenarioTitle + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Scenario Title + + + + + en + scenarioTitle + + + STRING + + + en + Title of scenario + + + + + + + + + scenarioCreationTimestamp + + + en + Scenario Creation Timestamp + + + urn:samm:io.catenax.material_flow_scenario_request:2.0.0#scenarioCreationTimestamp + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Scenario Creation Timestamp + + + + + en + scenarioCreationTimestamp + + + STRING + + + en + Date and Time of scenario creation + + + + + + + + + scenarioExpirationTimestamp + + + en + Scenario Expiration Timestamp + + + urn:samm:io.catenax.material_flow_scenario_request:2.0.0#scenarioExpirationTimestamp + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Scenario Expiration Timestamp + + + + + en + scenarioExpirationTimestamp + + + STRING + + + en + Date and Time of validity expiration + + + + + + + + + bpnsProperty + + + en + bpnsProperty + + + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#bpnsProperty + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + bpnsProperty + + + + + en + bpnsProperty + + + STRING + + + en + Property based on BPNS + + + + + + + + + scenarioOwner + + + en + Scenario Owner + + + urn:samm:io.catenax.material_flow_scenario_request:2.0.0#scenarioOwner + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Scenario Owner + + + + + en + scenarioOwner + + + STRING + + + en + Owner of the simulation scenario + + + + + + + + + scenarioOwnerRole + + + en + Scenario Owner Role + + + urn:samm:io.catenax.material_flow_scenario_request:2.0.0#scenarioOwnerRole + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Scenario Owner Role + + + + + en + scenarioOwnerRole + + + STRING + + + en + Role of the scenario owner + + + + + + Customer + + ModelReference + + + DataElement + urn:samm:io.catenax.material_flow_scenario_request:2.0.0#ScenarioOwnerRoleCharacteristic:Customer + + + + + + Supplier + + ModelReference + + + DataElement + urn:samm:io.catenax.material_flow_scenario_request:2.0.0#ScenarioOwnerRoleCharacteristic:Supplier + + + + + + LogisticianReceiving + + ModelReference + + + DataElement + urn:samm:io.catenax.material_flow_scenario_request:2.0.0#ScenarioOwnerRoleCharacteristic:LogisticianReceiving + + + + + + LogisticianSending + + ModelReference + + + DataElement + urn:samm:io.catenax.material_flow_scenario_request:2.0.0#ScenarioOwnerRoleCharacteristic:LogisticianSending + + + + + + + + + + + + + scenarioDescription + + + en + Scenario Description + + + urn:samm:io.catenax.material_flow_scenario_request:2.0.0#scenarioDescription + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Scenario Description + + + + + en + scenarioDescription + + + STRING + + + en + Description of the scenario + + + + + + + + + scenarioHeader + + + en + Scenario Header + + + urn:samm:io.catenax.material_flow_scenario_request:2.0.0#scenarioHeader + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Scenario Header + + + + + en + scenarioHeader + + + STRING + + + en + Required parameters for the scenario header + + + + + + + + + parameterId + + + en + Parameter ID + + + urn:samm:io.catenax.material_flow_scenario_request:2.0.0#parameterId + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Parameter ID + + + + + en + parameterId + + + STRING + + + en + Identifier of scenario parameter + + + + + + + + + parameterDeliveryDateInitial + + + en + Parameter Delivery Date Initial + + + urn:samm:io.catenax.material_flow_scenario_request:2.0.0#parameterDeliveryDateInitial + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Parameter Delivery Date Initial + + + + + en + parameterDeliveryDateInitial + + + STRING + + + en + Delivery date initial (without scenario changes), optional, NULL when initially not set + + + + + + + + + parameterDeliveryDateUpdated + + + en + Parameter Delivery Date Updated + + + urn:samm:io.catenax.material_flow_scenario_request:2.0.0#parameterDeliveryDateUpdated + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Parameter Delivery Date Updated + + + + + en + parameterDeliveryDateUpdated + + + STRING + + + en + Delivery date updated (with scenario changes) + + + + + + + + + parameterQuantityInitial + + + en + Parameter Quantity Initial + + + urn:samm:io.catenax.material_flow_scenario_request:2.0.0#parameterQuantityInitial + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Parameter Quantity Initial + + + + + en + parameterQuantityInitial + + + REAL_MEASURE + + + en + Amount initial (without scenario changes), optional, NULL, when initially not set + + + + + + + + + parameterQuantityUpdated + + + en + Parameter Quantity Updated + + + urn:samm:io.catenax.material_flow_scenario_request:2.0.0#parameterQuantityUpdated + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Parameter Quantity Updated + + + + + en + parameterQuantityUpdated + + + REAL_MEASURE + + + en + Amount updated (with scenario changes) + + + + + + + + + parameterOrderId + + + en + Parameter Order Id + + + urn:samm:io.catenax.material_flow_scenario_request:2.0.0#parameterOrderId + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Parameter Order Id + + + + + en + parameterOrderId + + + STRING + + + en + ID of the order + + + + + + + + + parameterComment + + + en + Parameter Comment + + + urn:samm:io.catenax.material_flow_scenario_request:2.0.0#parameterComment + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Parameter Comment + + + + + en + parameterComment + + + STRING + + + en + Optional description of parameters + + + + + + + + + materialNumber + + + en + Material Number + + + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#materialNumber + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Material Number + + + + + en + materialNumber + + + STRING + + + en + ID of the material contained in the batch + + + + + + + + + materialName + + + en + Material Name + + + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#materialName + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Material Name + + + + + en + materialName + + + STRING + + + en + Name of the material + + + + + + + + + unitOfMeasurement + + + en + Unit Of Measurement + + + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#unitOfMeasurement + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Unit Of Measurement + + + + + en + unitOfMeasurement + + + STRING + + + en + Unit used for measuring the quantity + + + + + + KG + + ModelReference + + + DataElement + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#UnitOfMeasurementCharacteristic:KG + + + + + + Liter + + ModelReference + + + DataElement + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#UnitOfMeasurementCharacteristic:Liter + + + + + + Piece + + ModelReference + + + DataElement + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#UnitOfMeasurementCharacteristic:Piece + + + + + + + + + + + + + scenarioParameter + + + en + Scenario Parameter + + + urn:samm:io.catenax.material_flow_scenario_request:2.0.0#scenarioParameter + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Scenario Parameter + + + + + en + scenarioParameter + + + STRING + + + en + Required parameters for the material flow scenario request + + + + + + + + + resultOwnId + + + en + Result Own Id + + + urn:samm:io.catenax.material_flow_scenario_request:2.0.0#resultOwnId + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Result Own Id + + + + + en + resultOwnId + + + STRING + + + en + ID of scenario result own + + + + + + + + + description + + + en + Description + + + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#description + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Description + + + + + en + description + + + STRING + + + en + Verbal description + + + + + + + + + runId + + + en + RunId + + + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#runId + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + RunId + + + + + en + runId + + + STRING + + + en + Id of the simulation run + + + + + + + + + comment + + + en + Comment + + + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#comment + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Comment + + + + + en + comment + + + STRING + + + en + Additional comments + + + + + + + + + expirationTimestamp + + + en + ExpirationTimestamp + + + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#expirationTimestamp + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + ExpirationTimestamp + + + + + en + expirationTimestamp + + + STRING + + + en + Date and time when the simulation is expired + + + + + + + + + bpnsProperty + + + en + bpnsProperty + + + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#bpnsProperty + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + bpnsProperty + + + + + en + bpnsProperty + + + STRING + + + en + Property based on BPNS + + + + + + + + + owner + + + en + Owner + + + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#owner + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Owner + + + + + en + owner + + + STRING + + + en + Site identifier of the simulation originator + + + + + + + + + dataQuality + + + en + Data Quality + + + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#dataQuality + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Data Quality + + + + + en + dataQuality + + + INTEGER_COUNT + + + en + Information on quality of simulation results + + + + + + 0 + + ModelReference + + + DataElement + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#DataQualityOptions:0 + + + + + + 1 + + ModelReference + + + DataElement + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#DataQualityOptions:1 + + + + + + 2 + + ModelReference + + + DataElement + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#DataQualityOptions:2 + + + + + + 3 + + ModelReference + + + DataElement + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#DataQualityOptions:3 + + + + + + 4 + + ModelReference + + + DataElement + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#DataQualityOptions:4 + + + + + + 5 + + ModelReference + + + DataElement + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#DataQualityOptions:5 + + + + + + + + + + + + + shipmentId + + + en + Shipment Id + + + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#shipmentId + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Shipment Id + + + + + en + shipmentId + + + STRING + + + en + ID to identify the shipment + + + + + + + + + bpnsProperty + + + en + bpnsProperty + + + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#bpnsProperty + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + bpnsProperty + + + + + en + bpnsProperty + + + STRING + + + en + Property based on BPNS + + + + + + + + + destination + + + en + Destination + + + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#destination + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Destination + + + + + en + destination + + + STRING + + + en + Address where the shipment is immediately delivered to (by logistician) or provided for pickup (by producer) + + + + + + + + + destinationTimestamp + + + en + Destination Timestamp + + + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#destinationTimestamp + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Destination Timestamp + + + + + en + destinationTimestamp + + + STRING + + + en + Time when delivery arrives or is ready at goods issue + + + + + + + + + bpnsProperty + + + en + bpnsProperty + + + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#bpnsProperty + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + bpnsProperty + + + + + en + bpnsProperty + + + STRING + + + en + Property based on BPNS + + + + + + + + + recipient + + + en + Recipient + + + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#recipient + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Recipient + + + + + en + recipient + + + STRING + + + en + Address of final recipient of shipment + + + + + + + + + recipientTimestampPlanned + + + en + Recipient Timestamp Planned + + + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#recipientTimestampPlanned + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Recipient Timestamp Planned + + + + + en + recipientTimestampPlanned + + + STRING + + + en + Planned delivery time + + + + + + + + + splittingAllowed + + + en + Splitting Allowed + + + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#splittingAllowed + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Splitting Allowed + + + + + en + splittingAllowed + + + BOOLEAN + + + en + Permission to split the shipment into individual deliveries + + + + + + + + + bpnsProperty + + + en + bpnsProperty + + + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#bpnsProperty + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + bpnsProperty + + + + + en + bpnsProperty + + + STRING + + + en + Property based on BPNS + + + + + + + + + logistics + + + en + Logistics + + + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#logistics + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Logistics + + + + + en + logistics + + + STRING + + + en + Address of logistician executing the shipment + + + + + + + + + bpnsProperty + + + en + bpnsProperty + + + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#bpnsProperty + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + bpnsProperty + + + + + en + bpnsProperty + + + STRING + + + en + Property based on BPNS + + + + + + + + + preceding + + + en + Preceding + + + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#preceding + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Preceding + + + + + en + preceding + + + STRING + + + en + Reference ID of a preceding shipment + + + + + + + + + handlingUnitId + + + en + Handling Unit Id + + + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#handlingUnitId + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Handling Unit Id + + + + + en + handlingUnitId + + + STRING + + + en + ID of the handling unit + + + + + + + + + name + + + en + Name + + + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#name + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Name + + + + + en + name + + + STRING + + + en + Name of the type of handling unit + + + + + + + + + volume + + + en + Volume + + + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#volume + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Volume + + + + + en + volume + + + litre + REAL_MEASURE + + + en + Volume of the handling unit + + + + + + + + + weight + + + en + Weight + + + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#weight + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Weight + + + + + en + weight + + + kilogram + REAL_MEASURE + + + en + Weight of the handling unit + + + + + + + + + amount + + + en + Amount + + + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#amount + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Amount + + + + + en + amount + + + piece + INTEGER_COUNT + + + en + Number of handling units with identical content + + + + + + + + + batchSerialNumber + + + en + Batch Serial Number + + + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#batchSerialNumber + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Batch Serial Number + + + + + en + batchSerialNumber + + + STRING + + + en + can be used to uniquely identify a singe product part + + + + + + + + + materialNumber + + + en + Material Number + + + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#materialNumber + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Material Number + + + + + en + materialNumber + + + STRING + + + en + ID of the material contained in the batch + + + + + + + + + materialName + + + en + Material Name + + + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#materialName + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Material Name + + + + + en + materialName + + + STRING + + + en + Name of the material + + + + + + + + + materialHazardousGoods + + + en + Material Hazardous Goods + + + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#materialHazardousGoods + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Material Hazardous Goods + + + + + en + materialHazardousGoods + + + BOOLEAN + + + en + Flags hazardous goods + + + + + + + + + batchExpirationTimestamp + + + en + Batch Expiration Timestamp + + + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#batchExpirationTimestamp + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Batch Expiration Timestamp + + + + + en + batchExpirationTimestamp + + + STRING + + + en + Expiration date of batch + + + + + + + + + quantity + + + en + Quantity + + + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#quantity + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Quantity + + + + + en + quantity + + + REAL_MEASURE + + + en + Amount of materials + + + + + + + + + unitOfMeasurement + + + en + Unit Of Measurement + + + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#unitOfMeasurement + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Unit Of Measurement + + + + + en + unitOfMeasurement + + + STRING + + + en + Unit used for measuring the quantity + + + + + + + + + batchNumber + + + en + Batch Number + + + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#batchNumber + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Batch Number + + + + + en + batchNumber + + + STRING + + + en + Number of the batch, generated by originator (e.g. from ERP system, no uuid) + + + + + + + + + batchOrderId + + + en + Batch Order Id + + + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#batchOrderId + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Batch Order Id + + + + + en + batchOrderId + + + STRING + + + en + Order ID to which the batch belongs + + + + + + + + + batches + + + en + Batches + + + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#batches + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Batches + + + + + en + batches + + + STRING + + + en + List of material batches contained within a handling unit + + + + + + + + + handlingUnits + + + en + Handling Units + + + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#handlingUnits + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Handling Units + + + + + en + handlingUnits + + + STRING + + + en + List of Handling Units + + + + + + + + + shipments + + + en + Shipments + + + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#shipments + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Shipments + + + + + en + shipments + + + STRING + + + en + List of shipments + + + + + + + + + timestamp + + + en + Timestamp + + + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#timestamp + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Timestamp + + + + + en + timestamp + + + STRING + + + en + Timestamp of simulation run + + + + + + + + + resultOwnSimRunInitial + + + en + Result Own Sim Run Initial + + + urn:samm:io.catenax.material_flow_scenario_request:2.0.0#resultOwnSimRunInitial + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Result Own Sim Run Initial + + + + + en + resultOwnSimRunInitial + + + STRING + + + en + Foreign key to simulation result based on initial parameters + + + + + + + + + description + + + en + Description + + + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#description + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Description + + + + + en + description + + + STRING + + + en + Verbal description + + + + + + + + + runId + + + en + RunId + + + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#runId + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + RunId + + + + + en + runId + + + STRING + + + en + Id of the simulation run + + + + + + + + + comment + + + en + Comment + + + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#comment + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Comment + + + + + en + comment + + + STRING + + + en + Additional comments + + + + + + + + + expirationTimestamp + + + en + ExpirationTimestamp + + + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#expirationTimestamp + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + ExpirationTimestamp + + + + + en + expirationTimestamp + + + STRING + + + en + Date and time when the simulation is expired + + + + + + + + + bpnsProperty + + + en + bpnsProperty + + + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#bpnsProperty + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + bpnsProperty + + + + + en + bpnsProperty + + + STRING + + + en + Property based on BPNS + + + + + + + + + owner + + + en + Owner + + + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#owner + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Owner + + + + + en + owner + + + STRING + + + en + Site identifier of the simulation originator + + + + + + + + + dataQuality + + + en + Data Quality + + + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#dataQuality + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Data Quality + + + + + en + dataQuality + + + INTEGER_COUNT + + + en + Information on quality of simulation results + + + + + + + + + shipmentId + + + en + Shipment Id + + + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#shipmentId + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Shipment Id + + + + + en + shipmentId + + + STRING + + + en + ID to identify the shipment + + + + + + + + + bpnsProperty + + + en + bpnsProperty + + + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#bpnsProperty + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + bpnsProperty + + + + + en + bpnsProperty + + + STRING + + + en + Property based on BPNS + + + + + + + + + destination + + + en + Destination + + + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#destination + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Destination + + + + + en + destination + + + STRING + + + en + Address where the shipment is immediately delivered to (by logistician) or provided for pickup (by producer) + + + + + + + + + destinationTimestamp + + + en + Destination Timestamp + + + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#destinationTimestamp + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Destination Timestamp + + + + + en + destinationTimestamp + + + STRING + + + en + Time when delivery arrives or is ready at goods issue + + + + + + + + + bpnsProperty + + + en + bpnsProperty + + + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#bpnsProperty + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + bpnsProperty + + + + + en + bpnsProperty + + + STRING + + + en + Property based on BPNS + + + + + + + + + recipient + + + en + Recipient + + + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#recipient + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Recipient + + + + + en + recipient + + + STRING + + + en + Address of final recipient of shipment + + + + + + + + + recipientTimestampPlanned + + + en + Recipient Timestamp Planned + + + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#recipientTimestampPlanned + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Recipient Timestamp Planned + + + + + en + recipientTimestampPlanned + + + STRING + + + en + Planned delivery time + + + + + + + + + splittingAllowed + + + en + Splitting Allowed + + + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#splittingAllowed + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Splitting Allowed + + + + + en + splittingAllowed + + + BOOLEAN + + + en + Permission to split the shipment into individual deliveries + + + + + + + + + bpnsProperty + + + en + bpnsProperty + + + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#bpnsProperty + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + bpnsProperty + + + + + en + bpnsProperty + + + STRING + + + en + Property based on BPNS + + + + + + + + + logistics + + + en + Logistics + + + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#logistics + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Logistics + + + + + en + logistics + + + STRING + + + en + Address of logistician executing the shipment + + + + + + + + + bpnsProperty + + + en + bpnsProperty + + + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#bpnsProperty + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + bpnsProperty + + + + + en + bpnsProperty + + + STRING + + + en + Property based on BPNS + + + + + + + + + preceding + + + en + Preceding + + + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#preceding + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Preceding + + + + + en + preceding + + + STRING + + + en + Reference ID of a preceding shipment + + + + + + + + + handlingUnitId + + + en + Handling Unit Id + + + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#handlingUnitId + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Handling Unit Id + + + + + en + handlingUnitId + + + STRING + + + en + ID of the handling unit + + + + + + + + + name + + + en + Name + + + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#name + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Name + + + + + en + name + + + STRING + + + en + Name of the type of handling unit + + + + + + + + + volume + + + en + Volume + + + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#volume + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Volume + + + + + en + volume + + + REAL_MEASURE + + + en + Volume of the handling unit + + + + + + + + + weight + + + en + Weight + + + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#weight + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Weight + + + + + en + weight + + + REAL_MEASURE + + + en + Weight of the handling unit + + + + + + + + + amount + + + en + Amount + + + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#amount + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Amount + + + + + en + amount + + + INTEGER_COUNT + + + en + Number of handling units with identical content + + + + + + + + + batchSerialNumber + + + en + Batch Serial Number + + + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#batchSerialNumber + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Batch Serial Number + + + + + en + batchSerialNumber + + + STRING + + + en + can be used to uniquely identify a singe product part + + + + + + + + + materialNumber + + + en + Material Number + + + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#materialNumber + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Material Number + + + + + en + materialNumber + + + STRING + + + en + ID of the material contained in the batch + + + + + + + + + materialName + + + en + Material Name + + + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#materialName + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Material Name + + + + + en + materialName + + + STRING + + + en + Name of the material + + + + + + + + + materialHazardousGoods + + + en + Material Hazardous Goods + + + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#materialHazardousGoods + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Material Hazardous Goods + + + + + en + materialHazardousGoods + + + BOOLEAN + + + en + Flags hazardous goods + + + + + + + + + batchExpirationTimestamp + + + en + Batch Expiration Timestamp + + + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#batchExpirationTimestamp + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Batch Expiration Timestamp + + + + + en + batchExpirationTimestamp + + + STRING + + + en + Expiration date of batch + + + + + + + + + quantity + + + en + Quantity + + + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#quantity + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Quantity + + + + + en + quantity + + + REAL_MEASURE + + + en + Amount of materials + + + + + + + + + unitOfMeasurement + + + en + Unit Of Measurement + + + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#unitOfMeasurement + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Unit Of Measurement + + + + + en + unitOfMeasurement + + + STRING + + + en + Unit used for measuring the quantity + + + + + + + + + batchNumber + + + en + Batch Number + + + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#batchNumber + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Batch Number + + + + + en + batchNumber + + + STRING + + + en + Number of the batch, generated by originator (e.g. from ERP system, no uuid) + + + + + + + + + batchOrderId + + + en + Batch Order Id + + + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#batchOrderId + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Batch Order Id + + + + + en + batchOrderId + + + STRING + + + en + Order ID to which the batch belongs + + + + + + + + + batches + + + en + Batches + + + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#batches + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Batches + + + + + en + batches + + + STRING + + + en + List of material batches contained within a handling unit + + + + + + + + + handlingUnits + + + en + Handling Units + + + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#handlingUnits + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Handling Units + + + + + en + handlingUnits + + + STRING + + + en + List of Handling Units + + + + + + + + + shipments + + + en + Shipments + + + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#shipments + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Shipments + + + + + en + shipments + + + STRING + + + en + List of shipments + + + + + + + + + timestamp + + + en + Timestamp + + + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#timestamp + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Timestamp + + + + + en + timestamp + + + STRING + + + en + Timestamp of simulation run + + + + + + + + + resultOwnSimRunUpdated + + + en + Result Own Sim Run Updated + + + urn:samm:io.catenax.material_flow_scenario_request:2.0.0#resultOwnSimRunUpdated + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Result Own Sim Run Updated + + + + + en + resultOwnSimRunUpdated + + + STRING + + + en + Foreign key to simulation result based on updated parameter (scenario) + + + + + + + + + scenarioSimResults + + + en + Scenario Sim Results + + + urn:samm:io.catenax.material_flow_scenario_request:2.0.0#scenarioSimResults + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Scenario Sim Results + + + + + en + scenarioSimResults + + + STRING + + + en + Simulation results of the scenario + + + + + + + + + materialFlowScenarioRequest + + + en + Material Flow Scenario Request + + + urn:samm:io.catenax.material_flow_scenario_request:2.0.0#materialFlowScenarioRequest + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Material Flow Scenario Request + + + + + en + materialFlowScenarioRequest + + + STRING + + + en + Contains standardized attributes for the content of the Material Flow Scenario Request + + + + + + + + + diff --git a/io.catenax.material_flow_scenario_request/2.0.0/gen/MaterialFlowScenarioRequestAspect-schema.json b/io.catenax.material_flow_scenario_request/2.0.0/gen/MaterialFlowScenarioRequestAspect-schema.json new file mode 100644 index 000000000..340b44816 --- /dev/null +++ b/io.catenax.material_flow_scenario_request/2.0.0/gen/MaterialFlowScenarioRequestAspect-schema.json @@ -0,0 +1,401 @@ +{ + "$schema" : "http://json-schema.org/draft-04/schema", + "description" : "Aspect model describing the Material Flow Scenario Request", + "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_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.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.material_flow_scenario_request_2.0.0_ScenarioOwnerCharacteristic" : { + "description" : "Reference of preceding shipments", + "type" : "object", + "properties" : { + "bpnsProperty" : { + "description" : "Property based on BPNS", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.business_partner_number_2.0.0_BpnsTrait" + } + }, + "required" : [ "bpnsProperty" ] + }, + "urn_samm_io.catenax.material_flow_scenario_request_2.0.0_ScenarioOwnerRoleCharacteristic" : { + "type" : "string", + "description" : "Characteristic describing possible values for the role of the scenario owner", + "enum" : [ "Customer", "Supplier", "LogisticianReceiving", "LogisticianSending" ] + }, + "urn_samm_io.catenax.material_flow_scenario_request_2.0.0_ScenarioHeaderCharacteristic" : { + "description" : "Characteristic describing the parameter for a scenario header", + "type" : "object", + "properties" : { + "scenarioId" : { + "description" : "ID of scenario header", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "scenarioTitle" : { + "description" : "Title of scenario", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "scenarioCreationTimestamp" : { + "description" : "Date and Time of scenario creation", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Timestamp" + }, + "scenarioExpirationTimestamp" : { + "description" : "Date and Time of validity expiration", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Timestamp" + }, + "scenarioOwner" : { + "description" : "Owner of the simulation scenario", + "$ref" : "#/components/schemas/urn_samm_io.catenax.material_flow_scenario_request_2.0.0_ScenarioOwnerCharacteristic" + }, + "scenarioOwnerRole" : { + "description" : "Role of the scenario owner", + "$ref" : "#/components/schemas/urn_samm_io.catenax.material_flow_scenario_request_2.0.0_ScenarioOwnerRoleCharacteristic" + }, + "scenarioDescription" : { + "description" : "Description of the scenario", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + } + }, + "required" : [ "scenarioId", "scenarioTitle", "scenarioCreationTimestamp", "scenarioExpirationTimestamp", "scenarioOwner", "scenarioOwnerRole" ] + }, + "urn_samm_io.catenax.material_flow_scenario_request_2.0.0_QuantityCharacteristic" : { + "type" : "number", + "description" : "Describes a property which is a Float" + }, + "urn_samm_io.catenax.material_flow_simulation_result_3.0.0_Text" : { + "type" : "string", + "description" : "Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc." + }, + "urn_samm_io.catenax.material_flow_simulation_result_3.0.0_UnitOfMeasurementCharacteristic" : { + "type" : "string", + "description" : "Possible options for units of measurement", + "enum" : [ "KG", "Liter", "Piece" ] + }, + "urn_samm_io.catenax.material_flow_scenario_request_2.0.0_ScenarioParameter" : { + "description" : "Parameters which are used to describe a material flow scenario request", + "type" : "object", + "properties" : { + "parameterId" : { + "description" : "Identifier of scenario parameter", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "parameterDeliveryDateInitial" : { + "description" : "Delivery date initial (without scenario changes), optional, NULL when initially not set", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Timestamp" + }, + "parameterDeliveryDateUpdated" : { + "description" : "Delivery date updated (with scenario changes)", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Timestamp" + }, + "parameterQuantityInitial" : { + "description" : "Amount initial (without scenario changes), optional, NULL, when initially not set", + "$ref" : "#/components/schemas/urn_samm_io.catenax.material_flow_scenario_request_2.0.0_QuantityCharacteristic" + }, + "parameterQuantityUpdated" : { + "description" : "Amount updated (with scenario changes)", + "$ref" : "#/components/schemas/urn_samm_io.catenax.material_flow_scenario_request_2.0.0_QuantityCharacteristic" + }, + "parameterOrderId" : { + "description" : "ID of the order", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "parameterComment" : { + "description" : "Optional description of parameters", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "materialNumber" : { + "description" : "ID of the material contained in the batch", + "$ref" : "#/components/schemas/urn_samm_io.catenax.material_flow_simulation_result_3.0.0_Text" + }, + "materialName" : { + "description" : "Name of the material", + "$ref" : "#/components/schemas/urn_samm_io.catenax.material_flow_simulation_result_3.0.0_Text" + }, + "unitOfMeasurement" : { + "description" : "Unit used for measuring the quantity", + "$ref" : "#/components/schemas/urn_samm_io.catenax.material_flow_simulation_result_3.0.0_UnitOfMeasurementCharacteristic" + } + }, + "required" : [ "parameterId", "parameterDeliveryDateInitial", "parameterDeliveryDateUpdated", "parameterQuantityInitial", "parameterQuantityUpdated", "parameterOrderId", "parameterComment", "materialNumber", "materialName", "unitOfMeasurement" ] + }, + "urn_samm_io.catenax.material_flow_scenario_request_2.0.0_ScenarioParameterCharacteristic" : { + "description" : "Characteristic describing the scenario parameter", + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/urn_samm_io.catenax.material_flow_scenario_request_2.0.0_ScenarioParameter" + } + }, + "urn_samm_io.catenax.material_flow_simulation_result_3.0.0_BusinessPartnerSite" : { + "description" : "Reference of preceding shipments", + "type" : "object", + "properties" : { + "bpnsProperty" : { + "description" : "Property based on BPNS", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.business_partner_number_2.0.0_BpnsTrait" + } + }, + "required" : [ "bpnsProperty" ] + }, + "urn_samm_io.catenax.material_flow_simulation_result_3.0.0_DataQualityOptions" : { + "type" : "number", + "minimum" : 0, + "description" : "Possible values determining data quality", + "enum" : [ 0, 1, 2, 3, 4, 5 ] + }, + "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.material_flow_simulation_result_3.0.0_VolumeCharacteristic" : { + "type" : "number", + "description" : "Volumetric value determining the volume of the handling unit" + }, + "urn_samm_io.catenax.material_flow_simulation_result_3.0.0_WeightCharacteristic" : { + "type" : "number", + "description" : "Amount of weight of the handling unit" + }, + "urn_samm_io.catenax.material_flow_simulation_result_3.0.0_AmountCharacteristic" : { + "type" : "number", + "minimum" : 1, + "description" : "Number describing handling units with identical pieces" + }, + "urn_samm_io.catenax.material_flow_simulation_result_3.0.0_QuantityCharacteristic" : { + "type" : "number", + "description" : "Number of materials contained within a handling unit" + }, + "urn_samm_io.catenax.material_flow_simulation_result_3.0.0_MaterialBatch" : { + "description" : "Material Batches are part of a handling unit", + "type" : "object", + "properties" : { + "batchSerialNumber" : { + "description" : "can be used to uniquely identify a singe product part", + "$ref" : "#/components/schemas/urn_samm_io.catenax.material_flow_simulation_result_3.0.0_Text" + }, + "materialNumber" : { + "description" : "ID of the material contained in the batch", + "$ref" : "#/components/schemas/urn_samm_io.catenax.material_flow_simulation_result_3.0.0_Text" + }, + "materialName" : { + "description" : "Name of the material", + "$ref" : "#/components/schemas/urn_samm_io.catenax.material_flow_simulation_result_3.0.0_Text" + }, + "materialHazardousGoods" : { + "description" : "Flags hazardous goods", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Boolean" + }, + "batchExpirationTimestamp" : { + "description" : "Expiration date of batch", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Timestamp" + }, + "quantity" : { + "description" : "Amount of materials", + "$ref" : "#/components/schemas/urn_samm_io.catenax.material_flow_simulation_result_3.0.0_QuantityCharacteristic" + }, + "unitOfMeasurement" : { + "description" : "Unit used for measuring the quantity", + "$ref" : "#/components/schemas/urn_samm_io.catenax.material_flow_simulation_result_3.0.0_UnitOfMeasurementCharacteristic" + }, + "batchNumber" : { + "description" : "Number of the batch, generated by originator (e.g. from ERP system, no uuid)", + "$ref" : "#/components/schemas/urn_samm_io.catenax.material_flow_simulation_result_3.0.0_Text" + }, + "batchOrderId" : { + "description" : "Order ID to which the batch belongs", + "$ref" : "#/components/schemas/urn_samm_io.catenax.material_flow_simulation_result_3.0.0_Text" + } + }, + "required" : [ "batchSerialNumber", "materialNumber", "materialName", "materialHazardousGoods", "batchExpirationTimestamp", "quantity", "unitOfMeasurement", "batchNumber", "batchOrderId" ] + }, + "urn_samm_io.catenax.material_flow_simulation_result_3.0.0_BatchList" : { + "description" : "List of material batches", + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/urn_samm_io.catenax.material_flow_simulation_result_3.0.0_MaterialBatch" + } + }, + "urn_samm_io.catenax.material_flow_simulation_result_3.0.0_HandlingUnit" : { + "description" : "Handling Unit is the smallest shipment unit and cannot be divided into several shipments", + "type" : "object", + "properties" : { + "handlingUnitId" : { + "description" : "ID of the handling unit", + "$ref" : "#/components/schemas/urn_samm_io.catenax.material_flow_simulation_result_3.0.0_Text" + }, + "name" : { + "description" : "Name of the type of handling unit", + "$ref" : "#/components/schemas/urn_samm_io.catenax.material_flow_simulation_result_3.0.0_Text" + }, + "volume" : { + "description" : "Volume of the handling unit", + "$ref" : "#/components/schemas/urn_samm_io.catenax.material_flow_simulation_result_3.0.0_VolumeCharacteristic" + }, + "weight" : { + "description" : "Weight of the handling unit", + "$ref" : "#/components/schemas/urn_samm_io.catenax.material_flow_simulation_result_3.0.0_WeightCharacteristic" + }, + "amount" : { + "description" : "Number of handling units with identical content", + "$ref" : "#/components/schemas/urn_samm_io.catenax.material_flow_simulation_result_3.0.0_AmountCharacteristic" + }, + "batches" : { + "description" : "List of material batches contained within a handling unit", + "$ref" : "#/components/schemas/urn_samm_io.catenax.material_flow_simulation_result_3.0.0_BatchList" + } + }, + "required" : [ "handlingUnitId", "name", "volume", "weight", "amount", "batches" ] + }, + "urn_samm_io.catenax.material_flow_simulation_result_3.0.0_HandlingUnitList" : { + "description" : "List of handling units included in the shipment", + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/urn_samm_io.catenax.material_flow_simulation_result_3.0.0_HandlingUnit" + } + }, + "urn_samm_io.catenax.material_flow_simulation_result_3.0.0_Shipment" : { + "description" : "Delivery item from a sender to a recipient containing goods", + "type" : "object", + "properties" : { + "shipmentId" : { + "description" : "ID to identify the shipment", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "destination" : { + "description" : "Address where the shipment is immediately delivered to (by logistician) or provided for pickup (by producer)", + "$ref" : "#/components/schemas/urn_samm_io.catenax.material_flow_simulation_result_3.0.0_BusinessPartnerSite" + }, + "destinationTimestamp" : { + "description" : "Time when delivery arrives or is ready at goods issue", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Timestamp" + }, + "recipient" : { + "description" : "Address of final recipient of shipment", + "$ref" : "#/components/schemas/urn_samm_io.catenax.material_flow_simulation_result_3.0.0_BusinessPartnerSite" + }, + "recipientTimestampPlanned" : { + "description" : "Planned delivery time", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Timestamp" + }, + "splittingAllowed" : { + "description" : "Permission to split the shipment into individual deliveries", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Boolean" + }, + "logistics" : { + "description" : "Address of logistician executing the shipment", + "$ref" : "#/components/schemas/urn_samm_io.catenax.material_flow_simulation_result_3.0.0_BusinessPartnerSite" + }, + "preceding" : { + "description" : "Reference ID of a preceding shipment", + "$ref" : "#/components/schemas/urn_samm_io.catenax.material_flow_simulation_result_3.0.0_BusinessPartnerSite" + }, + "handlingUnits" : { + "description" : "List of Handling Units", + "$ref" : "#/components/schemas/urn_samm_io.catenax.material_flow_simulation_result_3.0.0_HandlingUnitList" + } + }, + "required" : [ "shipmentId", "destination", "destinationTimestamp", "recipient", "recipientTimestampPlanned", "splittingAllowed", "logistics", "preceding", "handlingUnits" ] + }, + "urn_samm_io.catenax.material_flow_simulation_result_3.0.0_ShipmentList" : { + "description" : "List of shipments contained in the simulation", + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/urn_samm_io.catenax.material_flow_simulation_result_3.0.0_Shipment" + } + }, + "urn_samm_io.catenax.material_flow_scenario_request_2.0.0_SimResult" : { + "description" : "Characteristic describing the property for a Material Flow Simulation Result", + "type" : "object", + "properties" : { + "description" : { + "description" : "Verbal description", + "$ref" : "#/components/schemas/urn_samm_io.catenax.material_flow_simulation_result_3.0.0_Text" + }, + "runId" : { + "description" : "Id of the simulation run", + "$ref" : "#/components/schemas/urn_samm_io.catenax.material_flow_simulation_result_3.0.0_Text" + }, + "comment" : { + "description" : "Additional comments", + "$ref" : "#/components/schemas/urn_samm_io.catenax.material_flow_simulation_result_3.0.0_Text" + }, + "expirationTimestamp" : { + "description" : "Date and time when the simulation is expired", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Timestamp" + }, + "owner" : { + "description" : "Site identifier of the simulation originator", + "$ref" : "#/components/schemas/urn_samm_io.catenax.material_flow_simulation_result_3.0.0_BusinessPartnerSite" + }, + "dataQuality" : { + "description" : "Information on quality of simulation results", + "$ref" : "#/components/schemas/urn_samm_io.catenax.material_flow_simulation_result_3.0.0_DataQualityOptions" + }, + "shipments" : { + "description" : "List of shipments", + "$ref" : "#/components/schemas/urn_samm_io.catenax.material_flow_simulation_result_3.0.0_ShipmentList" + }, + "timestamp" : { + "description" : "Timestamp of simulation run", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Timestamp" + } + }, + "required" : [ "description", "runId", "comment", "expirationTimestamp", "owner", "dataQuality", "shipments", "timestamp" ] + }, + "urn_samm_io.catenax.material_flow_scenario_request_2.0.0_ScenarioSimResultsCharacteristic" : { + "description" : "Characteristic for simulation results", + "type" : "object", + "properties" : { + "resultOwnId" : { + "description" : "ID of scenario result own", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "resultOwnSimRunInitial" : { + "description" : "Foreign key to simulation result based on initial parameters", + "$ref" : "#/components/schemas/urn_samm_io.catenax.material_flow_scenario_request_2.0.0_SimResult" + }, + "resultOwnSimRunUpdated" : { + "description" : "Foreign key to simulation result based on updated parameter (scenario)", + "$ref" : "#/components/schemas/urn_samm_io.catenax.material_flow_scenario_request_2.0.0_SimResult" + } + }, + "required" : [ "resultOwnId" ] + }, + "urn_samm_io.catenax.material_flow_scenario_request_2.0.0_MaterialFlowScenarioRequestCharacteristic" : { + "description" : "Characteristic describing the aspect Material Flow Scenario Request", + "type" : "object", + "properties" : { + "scenarioHeader" : { + "description" : "Required parameters for the scenario header", + "$ref" : "#/components/schemas/urn_samm_io.catenax.material_flow_scenario_request_2.0.0_ScenarioHeaderCharacteristic" + }, + "scenarioParameter" : { + "description" : "Required parameters for the material flow scenario request", + "$ref" : "#/components/schemas/urn_samm_io.catenax.material_flow_scenario_request_2.0.0_ScenarioParameterCharacteristic" + }, + "scenarioSimResults" : { + "description" : "Simulation results of the scenario", + "$ref" : "#/components/schemas/urn_samm_io.catenax.material_flow_scenario_request_2.0.0_ScenarioSimResultsCharacteristic" + } + }, + "required" : [ "scenarioHeader", "scenarioSimResults" ] + } + } + }, + "properties" : { + "materialFlowScenarioRequest" : { + "description" : "Contains standardized attributes for the content of the Material Flow Scenario Request", + "$ref" : "#/components/schemas/urn_samm_io.catenax.material_flow_scenario_request_2.0.0_MaterialFlowScenarioRequestCharacteristic" + } + }, + "required" : [ "materialFlowScenarioRequest" ] +} \ No newline at end of file diff --git a/io.catenax.material_flow_scenario_request/2.0.0/gen/MaterialFlowScenarioRequestAspect.aasx b/io.catenax.material_flow_scenario_request/2.0.0/gen/MaterialFlowScenarioRequestAspect.aasx new file mode 100644 index 000000000..37d762d75 Binary files /dev/null and b/io.catenax.material_flow_scenario_request/2.0.0/gen/MaterialFlowScenarioRequestAspect.aasx differ diff --git a/io.catenax.material_flow_scenario_request/2.0.0/gen/MaterialFlowScenarioRequestAspect.html b/io.catenax.material_flow_scenario_request/2.0.0/gen/MaterialFlowScenarioRequestAspect.html new file mode 100644 index 000000000..4aa8b6277 --- /dev/null +++ b/io.catenax.material_flow_scenario_request/2.0.0/gen/MaterialFlowScenarioRequestAspect.html @@ -0,0 +1,3701 @@ + + + + + + + + + + + + + + Documentation Material Flow Scenario Request Aspect + + +
+
+
+
+

Aspect Model Material Flow Scenario Request Aspect

+
urn:samm:io.catenax.material_flow_scenario_request:2.0.0#MaterialFlowScenarioRequestAspect
+
+
+
+
+
+
+
+ +
+ + +
+ Aspect model describing the Material Flow Scenario Request +
+ + +
+

Overview

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

Properties

+
+ +
+ +
+

Material Flow Scenario Request

+
+ +Contains standardized attributes for the content of the Material Flow Scenario Request + +
+
Name
+
materialFlowScenarioRequest
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.material_flow_scenario_request:2.0.0#MaterialFlowScenarioRequest + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
materialFlowScenarioRequest
+
+ + +
+
+ + + +
+
+

Entities

+
+ +
+
+

Business Partner Site

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

Properties

+
+
+ +
+
bpnsProperty
+
+ +Property based on BPNS + +
+
Name
+
bpnsProperty
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
    +
  • https://catena-x.net/fileadmin/user_upload/Standard-Bibliothek/Update_PDF_Maerz/5_BPDM/CX_-_0010_BUSINESS_PARTNER_NUMBER_PlatformCapabilityBPDM_v_1.0.1.pdf
    • +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
BPNS0123456789ZZ
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
bpnsProperty
+
+ + +
+
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
    +
    ^BPNS[a-zA-Z0-9]{12}$
    +
    + +
    • +
+
+
+
+
+
+
+

Handling Unit

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

Properties

+
+
+ +
+
Handling Unit Id
+
+ +ID of the handling unit + +
+
Name
+
handlingUnitId
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
HUT_1
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
handlingUnitId
+
+ + +
+
+ +
+
Name
+
+ +Name of the type of handling unit + +
+
Name
+
name
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Palette
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
name
+
+ + +
+
+ +
+
Volume
+
+ +Volume of the handling unit + +
+
Name
+
volume
+
+ + + +
+
Characteristic
+
+
+
+
Measurement
+
+
+
Volumetric value determining the volume of the handling unit
+
+
+
Unit
+
+
+
+
    +
  • + litre +
    • +
  • + Symbol l +
    • +
  • + Code LTR +
    • +
  • + Conversion factor 10⁻³ m³ +
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#float + +
+
+
+
+
+ +
+
Example
+
1.0
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
volume
+
+ + +
+
+ +
+
Weight
+
+ +Weight of the handling unit + +
+
Name
+
weight
+
+ + + +
+
Characteristic
+
+
+
+
Measurement
+
+
+
Amount of weight of the handling unit
+
+
+
Unit
+
+
+
+
    +
  • + kilogram +
    • +
  • + Symbol kg +
    • +
  • + Code KGM +
    • +
  • + Conversion factor kg +
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#float + +
+
+
+
+
+ +
+
Example
+
189.0
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
weight
+
+ + +
+
+ +
+
Amount
+
+ +Number of handling units with identical content + +
+
Name
+
amount
+
+ + + +
+
Characteristic
+
+
+
+
Quantifiable
+
+
+
Duration
+
+
+
Number describing handling units with identical pieces
+
+
+
Unit
+
+
+
+
    +
  • + piece +
    • +
  • + Code H87 +
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#positiveInteger + +
+
+
+
+
+ +
+
Example
+
1
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
amount
+
+ + +
+
+ +
+
Batches
+
+ +List of material batches contained within a handling unit + +
+
Name
+
batches
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.material_flow_simulation_result:3.0.0#MaterialBatch + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
batches
+
+ + +
+
+
+
+

Material Batch

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

Properties

+
+
+ +
+
Batch Serial Number
+
+ +can be used to uniquely identify a singe product part + +
+
Name
+
batchSerialNumber
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Batch_1
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
batchSerialNumber
+
+ + +
+
+ +
+
Material Number
+
+ +ID of the material contained in the batch + +
+
Name
+
materialNumber
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
KK1000GR
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
materialNumber
+
+ + +
+
+ +
+
Material Name
+
+ +Name of the material + +
+
Name
+
materialName
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
KK1000GR-Gehäuse-Rot
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
materialName
+
+ + +
+
+ +
+
Material Hazardous Goods
+
+ +Flags hazardous goods + +
+
Name
+
materialHazardousGoods
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#boolean + +
+
+
+
+
+ +
+
Example
+
false
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
materialHazardousGoods
+
+ + +
+
+ +
+
Batch Expiration Timestamp
+
+ +Expiration date of batch + +
+
Name
+
batchExpirationTimestamp
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#dateTime + +
+
+
+
+
+ +
+
Example
+
2023-08-22T16:00:00.000Z
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
batchExpirationTimestamp
+
+ + +
+
+ +
+
Quantity
+
+ +Amount of materials + +
+
Name
+
quantity
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#float + +
+
+
+
+
+ +
+
Example
+
50.0
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
quantity
+
+ + +
+
+ +
+
Unit Of Measurement
+
+ +Unit used for measuring the quantity + +
+
Name
+
unitOfMeasurement
+
+ + + +
+
Characteristic
+
+
+
+
Enumeration
+
+
+
Values
+
+
+
+
    +
  • KG
    • +
  • Liter
    • +
  • Piece
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
unitOfMeasurement
+
+ + +
+
+ +
+
Batch Number
+
+ +Number of the batch, generated by originator (e.g. from ERP system, no uuid) + +
+
Name
+
batchNumber
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
45
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
batchNumber
+
+ + +
+
+ +
+
Batch Order Id
+
+ +Order ID to which the batch belongs + +
+
Name
+
batchOrderId
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Order-0001
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
batchOrderId
+
+ + +
+
+
+
+

Material Flow Scenario Request

+
+
+ The Material Flow Scenario Request contains standardized attributes for exchanging scenario requests and the resulting simulation results between two OSIM Manager Instances +
+ +
+

Properties

+
+
+ +
+
Scenario Header
+
+ +Required parameters for the scenario header + +
+
Name
+
scenarioHeader
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.material_flow_scenario_request:2.0.0#ScenarioHeader + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
scenarioHeader
+
+ + +
+
+ +
+
Scenario Parameter
+
+ +Required parameters for the material flow scenario request + +
+
Name
+
scenarioParameter
+
+ + + +
+
Characteristic
+
+
+
+
Collection
+
+
+
Has no order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.material_flow_scenario_request:2.0.0#ScenarioParameter + +
+
+
+
+
+ + +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
scenarioParameter
+
+ + +
+
+ +
+
Scenario Sim Results
+
+ +Simulation results of the scenario + +
+
Name
+
scenarioSimResults
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.material_flow_scenario_request:2.0.0#ScenarioSimResults + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
scenarioSimResults
+
+ + +
+
+
+
+

Material Flow Simulation Result

+
+
+ Result of a Material Flow Simulation +
+ +
+

Properties

+
+
+ +
+
Description
+
+ +Verbal description + +
+
Name
+
description
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Please simulate asap
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
description
+
+ + +
+
+ +
+
RunId
+
+ +Id of the simulation run + +
+
Name
+
runId
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
0fece48b-c8d1-4180-1a9caca6d67e
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
runId
+
+ + +
+
+ +
+
Comment
+
+ +Additional comments + +
+
Name
+
comment
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
successful simulation
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
comment
+
+ + +
+
+ +
+
ExpirationTimestamp
+
+ +Date and time when the simulation is expired + +
+
Name
+
expirationTimestamp
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#dateTime + +
+
+
+
+
+ +
+
Example
+
2023-03-24T09:15:24.000Z
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
expirationTimestamp
+
+ + +
+
+ +
+
Owner
+
+ +Site identifier of the simulation originator + +
+
Name
+
owner
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.material_flow_simulation_result:3.0.0#BusinessPartnerSite + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
owner
+
+ + +
+
+ +
+
Data Quality
+
+ +Information on quality of simulation results + +
+
Name
+
dataQuality
+
+ + + +
+
Characteristic
+
+
+
+
Enumeration
+
+
+
Values
+
+
+
+
    +
  • 0
    • +
  • 1
    • +
  • 2
    • +
  • 3
    • +
  • 4
    • +
  • 5
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#nonNegativeInteger + +
+
+
+
+
+ +
+
Example
+
0
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
dataQuality
+
+ + +
+
+ +
+
Shipments
+
+ +List of shipments + +
+
Name
+
shipments
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.material_flow_simulation_result:3.0.0#Shipment + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
shipments
+
+ + +
+
+ +
+
Timestamp
+
+ +Timestamp of simulation run + +
+
Name
+
timestamp
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#dateTime + +
+
+
+
+
+ +
+
Example
+
2023-03-09T14:13:42.806Z
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
timestamp
+
+ + +
+
+
+
+

Scenario Header

+
+
+ Headers required for every exchange +
+ +
+

Properties

+
+
+ +
+
Scenario ID
+
+ +ID of scenario header + +
+
Name
+
scenarioId
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
8d464b8b-6977-4952-8a22-0489067ca081
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
scenarioId
+
+ + +
+
+ +
+
Scenario Title
+
+ +Title of scenario + +
+
Name
+
scenarioTitle
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Delivery Modification
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
scenarioTitle
+
+ + +
+
+ +
+
Scenario Creation Timestamp
+
+ +Date and Time of scenario creation + +
+
Name
+
scenarioCreationTimestamp
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#dateTime + +
+
+
+
+
+ +
+
Example
+
2023-10-04T09:10:00.000Z
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
scenarioCreationTimestamp
+
+ + +
+
+ +
+
Scenario Expiration Timestamp
+
+ +Date and Time of validity expiration + +
+
Name
+
scenarioExpirationTimestamp
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#dateTime + +
+
+
+
+
+ +
+
Example
+
2023-10-07T09:10:00.000Z
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
scenarioExpirationTimestamp
+
+ + +
+
+ +
+
Scenario Owner
+
+ +Owner of the simulation scenario + +
+
Name
+
scenarioOwner
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.material_flow_simulation_result:3.0.0#BusinessPartnerSite + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
scenarioOwner
+
+ + +
+
+ +
+
Scenario Owner Role
+
+ +Role of the scenario owner + +
+
Name
+
scenarioOwnerRole
+
+ + + +
+
Characteristic
+
+
+
+
Enumeration
+
+
+
Values
+
+
+
+
    +
  • Customer
    • +
  • Supplier
    • +
  • LogisticianReceiving
    • +
  • LogisticianSending
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Customer
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
scenarioOwnerRole
+
+ + +
+
+ +
+
Scenario Description
+
+ +Description of the scenario + +
+
Name
+
scenarioDescription
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Changes in Delivery Date
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
scenarioDescription
+
+ + +
+
+
+
+

Scenario Parameter

+
+
+ Parameters which are used to describe a material flow scenario request +
+ +
+

Properties

+
+
+ +
+
Parameter ID
+
+ +Identifier of scenario parameter + +
+
Name
+
parameterId
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
847c71e5-614a-468b-a3a0-674bf2af3004
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
parameterId
+
+ + +
+
+ +
+
Parameter Delivery Date Initial
+
+ +Delivery date initial (without scenario changes), optional, NULL when initially not set + +
+
Name
+
parameterDeliveryDateInitial
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#dateTime + +
+
+
+
+
+ +
+
Example
+
2023-10-09T10:00:00.000Z
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
parameterDeliveryDateInitial
+
+ + +
+
+ +
+
Parameter Delivery Date Updated
+
+ +Delivery date updated (with scenario changes) + +
+
Name
+
parameterDeliveryDateUpdated
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#dateTime + +
+
+
+
+
+ +
+
Example
+
2023-10-10T09:00:00.000Z
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
parameterDeliveryDateUpdated
+
+ + +
+
+ +
+
Parameter Quantity Initial
+
+ +Amount initial (without scenario changes), optional, NULL, when initially not set + +
+
Name
+
parameterQuantityInitial
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#float + +
+
+
+
+
+ +
+
Example
+
1.0
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
parameterQuantityInitial
+
+ + +
+
+ +
+
Parameter Quantity Updated
+
+ +Amount updated (with scenario changes) + +
+
Name
+
parameterQuantityUpdated
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#float + +
+
+
+
+
+ +
+
Example
+
1.0
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
parameterQuantityUpdated
+
+ + +
+
+ +
+
Parameter Order Id
+
+ +ID of the order + +
+
Name
+
parameterOrderId
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
OID-011123546
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
parameterOrderId
+
+ + +
+
+ +
+
Parameter Comment
+
+ +Optional description of parameters + +
+
Name
+
parameterComment
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
updated Delivery Date
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
parameterComment
+
+ + +
+
+ +
+
Material Number
+
+ +ID of the material contained in the batch + +
+
Name
+
materialNumber
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
KK1000GR
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
materialNumber
+
+ + +
+
+ +
+
Material Name
+
+ +Name of the material + +
+
Name
+
materialName
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
KK1000GR-Gehäuse-Rot
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
materialName
+
+ + +
+
+ +
+
Unit Of Measurement
+
+ +Unit used for measuring the quantity + +
+
Name
+
unitOfMeasurement
+
+ + + +
+
Characteristic
+
+
+
+
Enumeration
+
+
+
Values
+
+
+
+
    +
  • KG
    • +
  • Liter
    • +
  • Piece
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
unitOfMeasurement
+
+ + +
+
+
+
+

Scenario Simulation Results

+
+
+ Attached to a scenario simulation results of the feedback requestor +
+ +
+

Properties

+
+
+ +
+
Result Own Id
+
+ +ID of scenario result own + +
+
Name
+
resultOwnId
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
916b5688-8bd8-4d7e-83b9-e0d40939274e
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
resultOwnId
+
+ + +
+
+ +
+
Result Own Sim Run Initial
+
+ +Foreign key to simulation result based on initial parameters + +
+
Name
+
resultOwnSimRunInitial
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.material_flow_simulation_result:3.0.0#MaterialFlowSimulationResult + +
+
+
+
+
+ + +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
resultOwnSimRunInitial
+
+ + +
+
+ +
+
Result Own Sim Run Updated
+
+ +Foreign key to simulation result based on updated parameter (scenario) + +
+
Name
+
resultOwnSimRunUpdated
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.material_flow_simulation_result:3.0.0#MaterialFlowSimulationResult + +
+
+
+
+
+ + +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
resultOwnSimRunUpdated
+
+ + +
+
+
+
+

Shipment

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

Properties

+
+
+ +
+
Shipment Id
+
+ +ID to identify the shipment + +
+
Name
+
shipmentId
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
DE51515151
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
shipmentId
+
+ + +
+
+ +
+
Destination
+
+ +Address where the shipment is immediately delivered to (by logistician) or provided for pickup (by producer) + +
+
Name
+
destination
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.material_flow_simulation_result:3.0.0#BusinessPartnerSite + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
destination
+
+ + +
+
+ +
+
Destination Timestamp
+
+ +Time when delivery arrives or is ready at goods issue + +
+
Name
+
destinationTimestamp
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#dateTime + +
+
+
+
+
+ +
+
Example
+
2023-03-19T09:00:00.000Z
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
destinationTimestamp
+
+ + +
+
+ +
+
Recipient
+
+ +Address of final recipient of shipment + +
+
Name
+
recipient
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.material_flow_simulation_result:3.0.0#BusinessPartnerSite + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
recipient
+
+ + +
+
+ +
+
Recipient Timestamp Planned
+
+ +Planned delivery time + +
+
Name
+
recipientTimestampPlanned
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#dateTime + +
+
+
+
+
+ +
+
Example
+
2023-04-19T09:00:00.000Z
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
recipientTimestampPlanned
+
+ + +
+
+ +
+
Splitting Allowed
+
+ +Permission to split the shipment into individual deliveries + +
+
Name
+
splittingAllowed
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#boolean + +
+
+
+
+
+ +
+
Example
+
true
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
splittingAllowed
+
+ + +
+
+ +
+
Logistics
+
+ +Address of logistician executing the shipment + +
+
Name
+
logistics
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.material_flow_simulation_result:3.0.0#BusinessPartnerSite + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
logistics
+
+ + +
+
+ +
+
Preceding
+
+ +Reference ID of a preceding shipment + +
+
Name
+
preceding
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.material_flow_simulation_result:3.0.0#BusinessPartnerSite + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
preceding
+
+ + +
+
+ +
+
Handling Units
+
+ +List of Handling Units + +
+
Name
+
handlingUnits
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.material_flow_simulation_result:3.0.0#HandlingUnit + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
handlingUnits
+
+ + +
+
+
+ +
+ Third party licenses + +
+ +
+ + +
+ + + \ No newline at end of file diff --git a/io.catenax.material_flow_scenario_request/2.0.0/gen/MaterialFlowScenarioRequestAspect.json b/io.catenax.material_flow_scenario_request/2.0.0/gen/MaterialFlowScenarioRequestAspect.json new file mode 100644 index 000000000..948dc4f43 --- /dev/null +++ b/io.catenax.material_flow_scenario_request/2.0.0/gen/MaterialFlowScenarioRequestAspect.json @@ -0,0 +1,124 @@ +{ + "materialFlowScenarioRequest" : { + "scenarioSimResults" : { + "resultOwnId" : "916b5688-8bd8-4d7e-83b9-e0d40939274e", + "resultOwnSimRunInitial" : { + "owner" : { + "bpnsProperty" : "BPNS0123456789ZZ" + }, + "dataQuality" : 0, + "description" : "Please simulate asap", + "comment" : "successful simulation ", + "expirationTimestamp" : "2023-03-24T09:15:24.000Z", + "runId" : "0fece48b-c8d1-4180-1a9caca6d67e", + "shipments" : [ { + "handlingUnits" : [ { + "name" : "Palette", + "volume" : 1.0, + "weight" : 189.0, + "batches" : [ { + "unitOfMeasurement" : "KG", + "materialName" : "KK1000GR-Gehäuse-Rot", + "quantity" : 50.0, + "materialNumber" : "KK1000GR", + "materialHazardousGoods" : false, + "batchSerialNumber" : "Batch_1", + "batchOrderId" : "Order-0001", + "batchExpirationTimestamp" : "2023-08-22T16:00:00.000Z", + "batchNumber" : "45" + } ], + "handlingUnitId" : "HUT_1", + "amount" : 1 + } ], + "shipmentId" : "DE51515151", + "recipientTimestampPlanned" : "2023-04-19T09:00:00.000Z", + "destination" : { + "bpnsProperty" : "BPNS0123456789ZZ" + }, + "recipient" : { + "bpnsProperty" : "BPNS0123456789ZZ" + }, + "logistics" : { + "bpnsProperty" : "BPNS0123456789ZZ" + }, + "preceding" : { + "bpnsProperty" : "BPNS0123456789ZZ" + }, + "splittingAllowed" : true, + "destinationTimestamp" : "2023-03-19T09:00:00.000Z" + } ], + "timestamp" : "2023-03-09T14:13:42.806Z" + }, + "resultOwnSimRunUpdated" : { + "owner" : { + "bpnsProperty" : "BPNS0123456789ZZ" + }, + "dataQuality" : 0, + "description" : "Please simulate asap", + "comment" : "successful simulation ", + "expirationTimestamp" : "2023-03-24T09:15:24.000Z", + "runId" : "0fece48b-c8d1-4180-1a9caca6d67e", + "shipments" : [ { + "handlingUnits" : [ { + "name" : "Palette", + "volume" : 1.0, + "weight" : 189.0, + "batches" : [ { + "unitOfMeasurement" : "KG", + "materialName" : "KK1000GR-Gehäuse-Rot", + "quantity" : 50.0, + "materialNumber" : "KK1000GR", + "materialHazardousGoods" : false, + "batchSerialNumber" : "Batch_1", + "batchOrderId" : "Order-0001", + "batchExpirationTimestamp" : "2023-08-22T16:00:00.000Z", + "batchNumber" : "45" + } ], + "handlingUnitId" : "HUT_1", + "amount" : 1 + } ], + "shipmentId" : "DE51515151", + "recipientTimestampPlanned" : "2023-04-19T09:00:00.000Z", + "destination" : { + "bpnsProperty" : "BPNS0123456789ZZ" + }, + "recipient" : { + "bpnsProperty" : "BPNS0123456789ZZ" + }, + "logistics" : { + "bpnsProperty" : "BPNS0123456789ZZ" + }, + "preceding" : { + "bpnsProperty" : "BPNS0123456789ZZ" + }, + "splittingAllowed" : true, + "destinationTimestamp" : "2023-03-19T09:00:00.000Z" + } ], + "timestamp" : "2023-03-09T14:13:42.806Z" + } + }, + "scenarioParameter" : [ { + "unitOfMeasurement" : "KG", + "parameterComment" : "updated Delivery Date", + "materialName" : "KK1000GR-Gehäuse-Rot", + "parameterQuantityUpdated" : 1.0, + "parameterId" : "847c71e5-614a-468b-a3a0-674bf2af3004", + "materialNumber" : "KK1000GR", + "parameterDeliveryDateUpdated" : "2023-10-10T09:00:00.000Z", + "parameterDeliveryDateInitial" : "2023-10-09T10:00:00.000Z", + "parameterOrderId" : "OID-011123546", + "parameterQuantityInitial" : 1.0 + } ], + "scenarioHeader" : { + "scenarioOwnerRole" : "Customer", + "scenarioCreationTimestamp" : "2023-10-04T09:10:00.000Z", + "scenarioExpirationTimestamp" : "2023-10-07T09:10:00.000Z", + "scenarioOwner" : { + "bpnsProperty" : "BPNS0123456789ZZ" + }, + "scenarioDescription" : "Changes in Delivery Date", + "scenarioId" : "8d464b8b-6977-4952-8a22-0489067ca081", + "scenarioTitle" : "Delivery Modification" + } + } +} \ No newline at end of file diff --git a/io.catenax.material_flow_scenario_request/2.0.0/gen/MaterialFlowScenarioRequestAspect.yml b/io.catenax.material_flow_scenario_request/2.0.0/gen/MaterialFlowScenarioRequestAspect.yml new file mode 100644 index 000000000..036b6feb0 --- /dev/null +++ b/io.catenax.material_flow_scenario_request/2.0.0/gen/MaterialFlowScenarioRequestAspect.yml @@ -0,0 +1,469 @@ +--- +openapi: 3.0.3 +info: + title: Material Flow Scenario Request Aspect + version: v2 +servers: +- url: catenax.io/api/v2 + variables: + api-version: + default: v2 +paths: + /{tenant-id}/material-flow-scenario-request-aspect: + get: + tags: + - MaterialFlowScenarioRequestAspect + operationId: getMaterialFlowScenarioRequestAspect + 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/MaterialFlowScenarioRequestAspect' + "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_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_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.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.material_flow_scenario_request_2.0.0_ScenarioOwnerCharacteristic: + description: Reference of preceding shipments + type: object + properties: + bpnsProperty: + description: Property based on BPNS + $ref: '#/components/schemas/urn_samm_io.catenax.shared.business_partner_number_2.0.0_BpnsTrait' + required: + - bpnsProperty + urn_samm_io.catenax.material_flow_scenario_request_2.0.0_ScenarioOwnerRoleCharacteristic: + type: string + description: Characteristic describing possible values for the role of the scenario + owner + enum: + - Customer + - Supplier + - LogisticianReceiving + - LogisticianSending + urn_samm_io.catenax.material_flow_scenario_request_2.0.0_ScenarioHeaderCharacteristic: + description: Characteristic describing the parameter for a scenario header + type: object + properties: + scenarioId: + description: ID of scenario header + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + scenarioTitle: + description: Title of scenario + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + scenarioCreationTimestamp: + description: Date and Time of scenario creation + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Timestamp' + scenarioExpirationTimestamp: + description: Date and Time of validity expiration + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Timestamp' + scenarioOwner: + description: Owner of the simulation scenario + $ref: '#/components/schemas/urn_samm_io.catenax.material_flow_scenario_request_2.0.0_ScenarioOwnerCharacteristic' + scenarioOwnerRole: + description: Role of the scenario owner + $ref: '#/components/schemas/urn_samm_io.catenax.material_flow_scenario_request_2.0.0_ScenarioOwnerRoleCharacteristic' + scenarioDescription: + description: Description of the scenario + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + required: + - scenarioId + - scenarioTitle + - scenarioCreationTimestamp + - scenarioExpirationTimestamp + - scenarioOwner + - scenarioOwnerRole + urn_samm_io.catenax.material_flow_scenario_request_2.0.0_QuantityCharacteristic: + type: number + description: Describes a property which is a Float + urn_samm_io.catenax.material_flow_simulation_result_3.0.0_Text: + type: string + description: "Describes a Property which contains plain text. This is intended\ + \ exclusively for human readable strings, not for identifiers, measurement\ + \ values, etc." + urn_samm_io.catenax.material_flow_simulation_result_3.0.0_UnitOfMeasurementCharacteristic: + type: string + description: Possible options for units of measurement + enum: + - KG + - Liter + - Piece + urn_samm_io.catenax.material_flow_scenario_request_2.0.0_ScenarioParameter: + description: Parameters which are used to describe a material flow scenario + request + type: object + properties: + parameterId: + description: Identifier of scenario parameter + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + parameterDeliveryDateInitial: + description: "Delivery date initial (without scenario changes), optional,\ + \ NULL when initially not set" + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Timestamp' + parameterDeliveryDateUpdated: + description: Delivery date updated (with scenario changes) + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Timestamp' + parameterQuantityInitial: + description: "Amount initial (without scenario changes), optional, NULL,\ + \ when initially not set" + $ref: '#/components/schemas/urn_samm_io.catenax.material_flow_scenario_request_2.0.0_QuantityCharacteristic' + parameterQuantityUpdated: + description: Amount updated (with scenario changes) + $ref: '#/components/schemas/urn_samm_io.catenax.material_flow_scenario_request_2.0.0_QuantityCharacteristic' + parameterOrderId: + description: ID of the order + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + parameterComment: + description: Optional description of parameters + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + materialNumber: + description: ID of the material contained in the batch + $ref: '#/components/schemas/urn_samm_io.catenax.material_flow_simulation_result_3.0.0_Text' + materialName: + description: Name of the material + $ref: '#/components/schemas/urn_samm_io.catenax.material_flow_simulation_result_3.0.0_Text' + unitOfMeasurement: + description: Unit used for measuring the quantity + $ref: '#/components/schemas/urn_samm_io.catenax.material_flow_simulation_result_3.0.0_UnitOfMeasurementCharacteristic' + required: + - parameterId + - parameterDeliveryDateInitial + - parameterDeliveryDateUpdated + - parameterQuantityInitial + - parameterQuantityUpdated + - parameterOrderId + - parameterComment + - materialNumber + - materialName + - unitOfMeasurement + urn_samm_io.catenax.material_flow_scenario_request_2.0.0_ScenarioParameterCharacteristic: + description: Characteristic describing the scenario parameter + type: array + items: + $ref: '#/components/schemas/urn_samm_io.catenax.material_flow_scenario_request_2.0.0_ScenarioParameter' + urn_samm_io.catenax.material_flow_simulation_result_3.0.0_BusinessPartnerSite: + description: Reference of preceding shipments + type: object + properties: + bpnsProperty: + description: Property based on BPNS + $ref: '#/components/schemas/urn_samm_io.catenax.shared.business_partner_number_2.0.0_BpnsTrait' + required: + - bpnsProperty + urn_samm_io.catenax.material_flow_simulation_result_3.0.0_DataQualityOptions: + type: number + minimum: 0 + description: Possible values determining data quality + enum: + - 0 + - 1 + - 2 + - 3 + - 4 + - 5 + 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.material_flow_simulation_result_3.0.0_VolumeCharacteristic: + type: number + description: Volumetric value determining the volume of the handling unit + urn_samm_io.catenax.material_flow_simulation_result_3.0.0_WeightCharacteristic: + type: number + description: Amount of weight of the handling unit + urn_samm_io.catenax.material_flow_simulation_result_3.0.0_AmountCharacteristic: + type: number + minimum: 1 + description: Number describing handling units with identical pieces + urn_samm_io.catenax.material_flow_simulation_result_3.0.0_QuantityCharacteristic: + type: number + description: Number of materials contained within a handling unit + urn_samm_io.catenax.material_flow_simulation_result_3.0.0_MaterialBatch: + description: Material Batches are part of a handling unit + type: object + properties: + batchSerialNumber: + description: can be used to uniquely identify a singe product part + $ref: '#/components/schemas/urn_samm_io.catenax.material_flow_simulation_result_3.0.0_Text' + materialNumber: + description: ID of the material contained in the batch + $ref: '#/components/schemas/urn_samm_io.catenax.material_flow_simulation_result_3.0.0_Text' + materialName: + description: Name of the material + $ref: '#/components/schemas/urn_samm_io.catenax.material_flow_simulation_result_3.0.0_Text' + materialHazardousGoods: + description: Flags hazardous goods + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Boolean' + batchExpirationTimestamp: + description: Expiration date of batch + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Timestamp' + quantity: + description: Amount of materials + $ref: '#/components/schemas/urn_samm_io.catenax.material_flow_simulation_result_3.0.0_QuantityCharacteristic' + unitOfMeasurement: + description: Unit used for measuring the quantity + $ref: '#/components/schemas/urn_samm_io.catenax.material_flow_simulation_result_3.0.0_UnitOfMeasurementCharacteristic' + batchNumber: + description: "Number of the batch, generated by originator (e.g. from ERP\ + \ system, no uuid)" + $ref: '#/components/schemas/urn_samm_io.catenax.material_flow_simulation_result_3.0.0_Text' + batchOrderId: + description: Order ID to which the batch belongs + $ref: '#/components/schemas/urn_samm_io.catenax.material_flow_simulation_result_3.0.0_Text' + required: + - batchSerialNumber + - materialNumber + - materialName + - materialHazardousGoods + - batchExpirationTimestamp + - quantity + - unitOfMeasurement + - batchNumber + - batchOrderId + urn_samm_io.catenax.material_flow_simulation_result_3.0.0_BatchList: + description: List of material batches + type: array + items: + $ref: '#/components/schemas/urn_samm_io.catenax.material_flow_simulation_result_3.0.0_MaterialBatch' + urn_samm_io.catenax.material_flow_simulation_result_3.0.0_HandlingUnit: + description: Handling Unit is the smallest shipment unit and cannot be divided + into several shipments + type: object + properties: + handlingUnitId: + description: ID of the handling unit + $ref: '#/components/schemas/urn_samm_io.catenax.material_flow_simulation_result_3.0.0_Text' + name: + description: Name of the type of handling unit + $ref: '#/components/schemas/urn_samm_io.catenax.material_flow_simulation_result_3.0.0_Text' + volume: + description: Volume of the handling unit + $ref: '#/components/schemas/urn_samm_io.catenax.material_flow_simulation_result_3.0.0_VolumeCharacteristic' + weight: + description: Weight of the handling unit + $ref: '#/components/schemas/urn_samm_io.catenax.material_flow_simulation_result_3.0.0_WeightCharacteristic' + amount: + description: Number of handling units with identical content + $ref: '#/components/schemas/urn_samm_io.catenax.material_flow_simulation_result_3.0.0_AmountCharacteristic' + batches: + description: List of material batches contained within a handling unit + $ref: '#/components/schemas/urn_samm_io.catenax.material_flow_simulation_result_3.0.0_BatchList' + required: + - handlingUnitId + - name + - volume + - weight + - amount + - batches + urn_samm_io.catenax.material_flow_simulation_result_3.0.0_HandlingUnitList: + description: List of handling units included in the shipment + type: array + items: + $ref: '#/components/schemas/urn_samm_io.catenax.material_flow_simulation_result_3.0.0_HandlingUnit' + urn_samm_io.catenax.material_flow_simulation_result_3.0.0_Shipment: + description: Delivery item from a sender to a recipient containing goods + type: object + properties: + shipmentId: + description: ID to identify the shipment + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + destination: + description: Address where the shipment is immediately delivered to (by + logistician) or provided for pickup (by producer) + $ref: '#/components/schemas/urn_samm_io.catenax.material_flow_simulation_result_3.0.0_BusinessPartnerSite' + destinationTimestamp: + description: Time when delivery arrives or is ready at goods issue + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Timestamp' + recipient: + description: Address of final recipient of shipment + $ref: '#/components/schemas/urn_samm_io.catenax.material_flow_simulation_result_3.0.0_BusinessPartnerSite' + recipientTimestampPlanned: + description: Planned delivery time + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Timestamp' + splittingAllowed: + description: Permission to split the shipment into individual deliveries + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Boolean' + logistics: + description: Address of logistician executing the shipment + $ref: '#/components/schemas/urn_samm_io.catenax.material_flow_simulation_result_3.0.0_BusinessPartnerSite' + preceding: + description: Reference ID of a preceding shipment + $ref: '#/components/schemas/urn_samm_io.catenax.material_flow_simulation_result_3.0.0_BusinessPartnerSite' + handlingUnits: + description: List of Handling Units + $ref: '#/components/schemas/urn_samm_io.catenax.material_flow_simulation_result_3.0.0_HandlingUnitList' + required: + - shipmentId + - destination + - destinationTimestamp + - recipient + - recipientTimestampPlanned + - splittingAllowed + - logistics + - preceding + - handlingUnits + urn_samm_io.catenax.material_flow_simulation_result_3.0.0_ShipmentList: + description: List of shipments contained in the simulation + type: array + items: + $ref: '#/components/schemas/urn_samm_io.catenax.material_flow_simulation_result_3.0.0_Shipment' + urn_samm_io.catenax.material_flow_scenario_request_2.0.0_SimResult: + description: Characteristic describing the property for a Material Flow Simulation + Result + type: object + properties: + description: + description: Verbal description + $ref: '#/components/schemas/urn_samm_io.catenax.material_flow_simulation_result_3.0.0_Text' + runId: + description: Id of the simulation run + $ref: '#/components/schemas/urn_samm_io.catenax.material_flow_simulation_result_3.0.0_Text' + comment: + description: Additional comments + $ref: '#/components/schemas/urn_samm_io.catenax.material_flow_simulation_result_3.0.0_Text' + expirationTimestamp: + description: Date and time when the simulation is expired + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Timestamp' + owner: + description: Site identifier of the simulation originator + $ref: '#/components/schemas/urn_samm_io.catenax.material_flow_simulation_result_3.0.0_BusinessPartnerSite' + dataQuality: + description: Information on quality of simulation results + $ref: '#/components/schemas/urn_samm_io.catenax.material_flow_simulation_result_3.0.0_DataQualityOptions' + shipments: + description: List of shipments + $ref: '#/components/schemas/urn_samm_io.catenax.material_flow_simulation_result_3.0.0_ShipmentList' + timestamp: + description: Timestamp of simulation run + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Timestamp' + required: + - description + - runId + - comment + - expirationTimestamp + - owner + - dataQuality + - shipments + - timestamp + urn_samm_io.catenax.material_flow_scenario_request_2.0.0_ScenarioSimResultsCharacteristic: + description: Characteristic for simulation results + type: object + properties: + resultOwnId: + description: ID of scenario result own + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + resultOwnSimRunInitial: + description: Foreign key to simulation result based on initial parameters + $ref: '#/components/schemas/urn_samm_io.catenax.material_flow_scenario_request_2.0.0_SimResult' + resultOwnSimRunUpdated: + description: Foreign key to simulation result based on updated parameter + (scenario) + $ref: '#/components/schemas/urn_samm_io.catenax.material_flow_scenario_request_2.0.0_SimResult' + required: + - resultOwnId + urn_samm_io.catenax.material_flow_scenario_request_2.0.0_MaterialFlowScenarioRequestCharacteristic: + description: Characteristic describing the aspect Material Flow Scenario Request + type: object + properties: + scenarioHeader: + description: Required parameters for the scenario header + $ref: '#/components/schemas/urn_samm_io.catenax.material_flow_scenario_request_2.0.0_ScenarioHeaderCharacteristic' + scenarioParameter: + description: Required parameters for the material flow scenario request + $ref: '#/components/schemas/urn_samm_io.catenax.material_flow_scenario_request_2.0.0_ScenarioParameterCharacteristic' + scenarioSimResults: + description: Simulation results of the scenario + $ref: '#/components/schemas/urn_samm_io.catenax.material_flow_scenario_request_2.0.0_ScenarioSimResultsCharacteristic' + required: + - scenarioHeader + - scenarioSimResults + MaterialFlowScenarioRequestAspect: + description: Aspect model describing the Material Flow Scenario Request + type: object + properties: + materialFlowScenarioRequest: + description: Contains standardized attributes for the content of the Material + Flow Scenario Request + $ref: '#/components/schemas/urn_samm_io.catenax.material_flow_scenario_request_2.0.0_MaterialFlowScenarioRequestCharacteristic' + required: + - materialFlowScenarioRequest + 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' + MaterialFlowScenarioRequestAspect: + content: + application/json: + schema: + $ref: '#/components/schemas/MaterialFlowScenarioRequestAspect' + description: The request was successful. + requestBodies: + MaterialFlowScenarioRequestAspect: + content: + application/json: + schema: + $ref: '#/components/schemas/MaterialFlowScenarioRequestAspect' diff --git a/io.catenax.material_flow_scenario_request/2.0.0/metadata.json b/io.catenax.material_flow_scenario_request/2.0.0/metadata.json new file mode 100644 index 000000000..84245e4eb --- /dev/null +++ b/io.catenax.material_flow_scenario_request/2.0.0/metadata.json @@ -0,0 +1 @@ +{ "status" : "release" } diff --git a/io.catenax.material_flow_scenario_request/RELEASE_NOTES.md b/io.catenax.material_flow_scenario_request/RELEASE_NOTES.md index a65cda634..b16b87c5b 100644 --- a/io.catenax.material_flow_scenario_request/RELEASE_NOTES.md +++ b/io.catenax.material_flow_scenario_request/RELEASE_NOTES.md @@ -2,6 +2,11 @@ All notable changes to this model will be documented in this file. +## [2.0.0] 2024-05-21 + +- Instead of one scenario parameter we can now define a set of scenario parameters +- Change scenario owner characteristic to BusinessPartnerSite + ## [1.0.0] 2023-10-23 - initial version of the aspect model for Scenario Simulation Request diff --git a/io.catenax.material_flow_simulation_result/3.0.0/MaterialFlowSimulationResultAspect.ttl b/io.catenax.material_flow_simulation_result/3.0.0/MaterialFlowSimulationResultAspect.ttl new file mode 100644 index 000000000..2d46c27e5 --- /dev/null +++ b/io.catenax.material_flow_simulation_result/3.0.0/MaterialFlowSimulationResultAspect.ttl @@ -0,0 +1,337 @@ +########################################################################################## +# Copyright (c) 2023,2024 Fraunhofer-Gesellschaft zur Förderung der angewandten Forschung e. V. +# Copyright (c) 2023,2024 German Edge Cloud GmbH & Co. KG +# Copyright (c) 2023,2024 Siemens AG +# Copyright (c) 2023,2024 Contributors to the Eclipse Foundation +# +# 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: . + +:MaterialFlowSimulationResultAspect a samm:Aspect ; + samm:preferredName "Material Flow Simulation Result Aspect"@en ; + samm:description "Aspect Model for the result of a Material Flow Simulation"@en ; + samm:properties ( :materialFlowSimulationResult ) ; + samm:operations ( ) ; + samm:events ( ) . + +:materialFlowSimulationResult a samm:Property ; + samm:preferredName "Material Flow Simulation Result"@en ; + samm:description "Contains standardized attributes for the result of a material flow simulation"@en ; + samm:characteristic :MaterialFlowSimulationResultCharacteristic . + +:MaterialFlowSimulationResultCharacteristic a samm:Characteristic ; + samm:preferredName "Material Flow Simulation Result Characteristic"@en ; + samm:description "Characteristic describing the aspect material flow simulation result"@en ; + samm:dataType :MaterialFlowSimulationResult . + +:MaterialFlowSimulationResult a samm:Entity ; + samm:preferredName "Material Flow Simulation Result"@en ; + samm:description "Result of a Material Flow Simulation"@en ; + samm:properties ( :description :runId :comment :expirationTimestamp :owner :dataQuality :shipments :timestamp ) . + +:description a samm:Property ; + samm:preferredName "Description"@en ; + samm:description "Verbal description"@en ; + samm:characteristic :Text ; + samm:exampleValue "Please simulate asap" . + +:runId a samm:Property ; + samm:preferredName "RunId"@en ; + samm:description "Id of the simulation run"@en ; + samm:characteristic :Text ; + samm:exampleValue "0fece48b-c8d1-4180-1a9caca6d67e" . + +:comment a samm:Property ; + samm:preferredName "Comment"@en ; + samm:description "Additional comments"@en ; + samm:characteristic :Text ; + samm:exampleValue "successful simulation " . + +:expirationTimestamp a samm:Property ; + samm:preferredName "ExpirationTimestamp"@en ; + samm:description "Date and time when the simulation is expired"@en ; + samm:characteristic samm-c:Timestamp ; + samm:exampleValue "2023-03-24T09:15:24.000Z"^^xsd:dateTime . + +:owner a samm:Property ; + samm:preferredName "Owner"@en ; + samm:description "Site identifier of the simulation originator"@en ; + samm:characteristic :OwnerCharacteristic . + +:dataQuality a samm:Property ; + samm:preferredName "Data Quality"@en ; + samm:description "Information on quality of simulation results"@en ; + samm:characteristic :DataQualityOptions ; + samm:exampleValue "0"^^xsd:nonNegativeInteger . + +:shipments a samm:Property ; + samm:preferredName "Shipments"@en ; + samm:description "List of shipments"@en ; + samm:characteristic :ShipmentList . + +:timestamp a samm:Property ; + samm:preferredName "Timestamp"@en ; + samm:description "Timestamp of simulation run"@en ; + samm:characteristic samm-c:Timestamp ; + samm:exampleValue "2023-03-09T14:13:42.806Z"^^xsd:dateTime . + +:Text a samm:Characteristic ; + samm:preferredName "Text"@en ; + samm:description "Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc."@en ; + samm:dataType xsd:string . + +:OwnerCharacteristic a samm-c:SingleEntity ; + samm:preferredName "Owner Characteristic"@en ; + samm:description "Site identifier of the simulation originator"@en ; + samm:dataType :BusinessPartnerSite . + +:DataQualityOptions a samm-c:Enumeration ; + samm:preferredName "Data Quality Options"@en ; + samm:description "Possible values determining data quality"@en ; + samm:dataType xsd:nonNegativeInteger ; + samm-c:values ( "0"^^xsd:nonNegativeInteger "1"^^xsd:nonNegativeInteger "2"^^xsd:nonNegativeInteger "3"^^xsd:nonNegativeInteger "4"^^xsd:nonNegativeInteger "5"^^xsd:nonNegativeInteger ) . + +:ShipmentList a samm-c:List ; + samm:preferredName "Shipment List"@en ; + samm:description "List of shipments contained in the simulation"@en ; + samm:dataType :Shipment . + +:BusinessPartnerSite a samm:Entity ; + samm:preferredName "Business Partner Site"@en ; + samm:description "Identifier for the physical location of a business partner plant or site, (e.g. BPNS in Catena-X context)"@en ; + samm:properties ( :bpnsProperty ) . + +:Shipment a samm:Entity ; + samm:preferredName "Shipment"@en ; + samm:description "Delivery item from a sender to a recipient containing goods"@en ; + samm:properties ( :shipmentId :destination :destinationTimestamp :recipient :recipientTimestampPlanned :splittingAllowed :logistics :preceding :handlingUnits ) . + +:bpnsProperty a samm:Property ; + samm:preferredName "bpnsProperty"@en ; + samm:description "Property based on BPNS"@en ; + samm:characteristic ext-number:BpnsTrait ; + samm:exampleValue "BPNS0123456789ZZ" . + +:shipmentId a samm:Property ; + samm:preferredName "Shipment Id"@en ; + samm:description "ID to identify the shipment"@en ; + samm:characteristic samm-c:Text ; + samm:exampleValue "DE51515151" . + +:destination a samm:Property ; + samm:preferredName "Destination"@en ; + samm:description "Address where the shipment is immediately delivered to (by logistician) or provided for pickup (by producer)"@en ; + samm:characteristic :DestinationCharacteristic . + +:destinationTimestamp a samm:Property ; + samm:preferredName "Destination Timestamp"@en ; + samm:description "Time when delivery arrives or is ready at goods issue"@en ; + samm:characteristic samm-c:Timestamp ; + samm:exampleValue "2023-03-19T09:00:00.000Z"^^xsd:dateTime . + +:recipient a samm:Property ; + samm:preferredName "Recipient"@en ; + samm:description "Address of final recipient of shipment"@en ; + samm:characteristic :RecipientCharacteristic . + +:recipientTimestampPlanned a samm:Property ; + samm:preferredName "Recipient Timestamp Planned"@en ; + samm:description "Planned delivery time"@en ; + samm:characteristic samm-c:Timestamp ; + samm:exampleValue "2023-04-19T09:00:00.000Z"^^xsd:dateTime . + +:splittingAllowed a samm:Property ; + samm:preferredName "Splitting Allowed"@en ; + samm:description "Permission to split the shipment into individual deliveries"@en ; + samm:characteristic samm-c:Boolean ; + samm:exampleValue true . + +:logistics a samm:Property ; + samm:preferredName "Logistics"@en ; + samm:description "Address of logistician executing the shipment"@en ; + samm:characteristic :LogisticsCharacteristic . + +:preceding a samm:Property ; + samm:preferredName "Preceding"@en ; + samm:description "Reference ID of a preceding shipment"@en ; + samm:characteristic :PrecedingCharacteristic . + +:handlingUnits a samm:Property ; + samm:preferredName "Handling Units"@en ; + samm:description "List of Handling Units"@en ; + samm:characteristic :HandlingUnitList . + +:DestinationCharacteristic a samm-c:SingleEntity ; + samm:preferredName "Destination Characteristic"@en ; + samm:description "Address where the shipment is immediately delivered to (by logistician) or provided for pickup (by producer)"@en ; + samm:dataType :BusinessPartnerSite . + +:RecipientCharacteristic a samm-c:SingleEntity ; + samm:preferredName "Recipient Characteristic"@en ; + samm:description "Location identifier of the final recipient of the shipment"@en ; + samm:dataType :BusinessPartnerSite . + +:LogisticsCharacteristic a samm-c:SingleEntity ; + samm:preferredName "Logistics Characteristic"@en ; + samm:description "Site identifier of the logistician executing the shipment"@en ; + samm:dataType :BusinessPartnerSite . + +:PrecedingCharacteristic a samm-c:SingleEntity ; + samm:preferredName "Preceding Characteristic"@en ; + samm:description "Reference of preceding shipments"@en ; + samm:dataType :BusinessPartnerSite . + +:HandlingUnitList a samm-c:List ; + samm:preferredName "Handling Unit List"@en ; + samm:description "List of handling units included in the shipment"@en ; + samm:dataType :HandlingUnit . + +:HandlingUnit a samm:Entity ; + samm:preferredName "Handling Unit"@en ; + samm:description "Handling Unit is the smallest shipment unit and cannot be divided into several shipments"@en ; + samm:properties ( :handlingUnitId :name :volume :weight :amount :batches ) . + +:handlingUnitId a samm:Property ; + samm:preferredName "Handling Unit Id"@en ; + samm:description "ID of the handling unit"@en ; + samm:characteristic :Text ; + samm:exampleValue "HUT_1" . + +:name a samm:Property ; + samm:preferredName "Name"@en ; + samm:description "Name of the type of handling unit"@en ; + samm:characteristic :Text ; + samm:exampleValue "Palette" . + +:volume a samm:Property ; + samm:preferredName "Volume"@en ; + samm:description "Volume of the handling unit"@en ; + samm:characteristic :VolumeCharacteristic ; + samm:exampleValue "1.00"^^xsd:float . + +:weight a samm:Property ; + samm:preferredName "Weight"@en ; + samm:description "Weight of the handling unit"@en ; + samm:characteristic :WeightCharacteristic ; + samm:exampleValue "189"^^xsd:float . + +:amount a samm:Property ; + samm:preferredName "Amount"@en ; + samm:description "Number of handling units with identical content"@en ; + samm:characteristic :AmountCharacteristic ; + samm:exampleValue "1"^^xsd:positiveInteger . + +:batches a samm:Property ; + samm:preferredName "Batches"@en ; + samm:description "List of material batches contained within a handling unit"@en ; + samm:characteristic :BatchList . + +:VolumeCharacteristic a samm-c:Measurement ; + samm:preferredName "Volume Characteristic"@en ; + samm:description "Volumetric value determining the volume of the handling unit"@en ; + samm:dataType xsd:float ; + samm-c:unit unit:litre . + +:WeightCharacteristic a samm-c:Measurement ; + samm:preferredName "Weight Characteristic"@en ; + samm:description "Amount of weight of the handling unit"@en ; + samm:dataType xsd:float ; + samm-c:unit unit:kilogram . + +:AmountCharacteristic a samm-c:Quantifiable ; + samm:preferredName "Amount Characteristic"@en ; + samm:description "Number describing handling units with identical pieces"@en ; + samm:dataType xsd:positiveInteger ; + samm-c:unit unit:piece . + +:BatchList a samm-c:List ; + samm:preferredName "Batch List"@en ; + samm:description "List of material batches"@en ; + samm:dataType :MaterialBatch . + +:MaterialBatch a samm:Entity ; + samm:preferredName "Material Batch"@en ; + samm:description "Material Batches are part of a handling unit"@en ; + samm:properties ( :batchSerialNumber :materialNumber :materialName :materialHazardousGoods :batchExpirationTimestamp :quantity :unitOfMeasurement :batchNumber :batchOrderId ) . + +:batchSerialNumber a samm:Property ; + samm:preferredName "Batch Serial Number"@en ; + samm:description "can be used to uniquely identify a singe product part"@en ; + samm:characteristic :Text ; + samm:exampleValue "Batch_1" . + +:materialNumber a samm:Property ; + samm:preferredName "Material Number"@en ; + samm:description "ID of the material contained in the batch"@en ; + samm:characteristic :Text ; + samm:exampleValue "KK1000GR" . + +:materialName a samm:Property ; + samm:preferredName "Material Name"@en ; + samm:description "Name of the material"@en ; + samm:characteristic :Text ; + samm:exampleValue "KK1000GR-Gehäuse-Rot" . + +:materialHazardousGoods a samm:Property ; + samm:preferredName "Material Hazardous Goods"@en ; + samm:description "Flags hazardous goods"@en ; + samm:characteristic samm-c:Boolean ; + samm:exampleValue false . + +:batchExpirationTimestamp a samm:Property ; + samm:preferredName "Batch Expiration Timestamp"@en ; + samm:description "Expiration date of batch"@en ; + samm:characteristic samm-c:Timestamp ; + samm:exampleValue "2023-08-22T16:00:00.000Z"^^xsd:dateTime . + +:quantity a samm:Property ; + samm:preferredName "Quantity"@en ; + samm:description "Amount of materials"@en ; + samm:characteristic :QuantityCharacteristic ; + samm:exampleValue "50"^^xsd:float . + +:unitOfMeasurement a samm:Property ; + samm:preferredName "Unit Of Measurement"@en ; + samm:description "Unit used for measuring the quantity"@en ; + samm:characteristic :UnitOfMeasurementCharacteristic . + +:batchNumber a samm:Property ; + samm:preferredName "Batch Number"@en ; + samm:description "Number of the batch, generated by originator (e.g. from ERP system, no uuid)"@en ; + samm:characteristic :Text ; + samm:exampleValue "45" . + +:batchOrderId a samm:Property ; + samm:preferredName "Batch Order Id"@en ; + samm:description "Order ID to which the batch belongs"@en ; + samm:characteristic :Text ; + samm:exampleValue "Order-0001" . + +:QuantityCharacteristic a samm:Characteristic ; + samm:preferredName "Quantity Characteristic"@en ; + samm:description "Number of materials contained within a handling unit"@en ; + samm:dataType xsd:float . + +:UnitOfMeasurementCharacteristic a samm-c:Enumeration ; + samm:preferredName "Unit Of Measurement Characteristic"@en ; + samm:description "Possible options for units of measurement"@en ; + samm:dataType xsd:string ; + samm-c:values ( "KG" "Liter" "Piece" ) . diff --git a/io.catenax.material_flow_simulation_result/3.0.0/gen/MaterialFlowSimulationResultAspect-aas.xml b/io.catenax.material_flow_simulation_result/3.0.0/gen/MaterialFlowSimulationResultAspect-aas.xml new file mode 100644 index 000000000..d8dcc9561 --- /dev/null +++ b/io.catenax.material_flow_simulation_result/3.0.0/gen/MaterialFlowSimulationResultAspect-aas.xml @@ -0,0 +1,2766 @@ + + + + + defaultAdminShell + + + en + defaultAdminShell + + + + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#MaterialFlowSimulationResultAspect + + Type + + + + ModelReference + + + Submodel + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#MaterialFlowSimulationResultAspect/submodel + + + + + + + + + MaterialFlowSimulationResultAspect + + + en + Aspect Model for the result of a Material Flow Simulation + + + + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#MaterialFlowSimulationResultAspect/submodel + Template + + ModelReference + + + ConceptDescription + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#MaterialFlowSimulationResultAspect + + + + + + MaterialFlowSimulationResult + + + en + Material Flow Simulation Result + + + + + en + Result of a Material Flow Simulation + + + + + description + + + en + Description + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#description + + + + xs:string + + + + runId + + + en + RunId + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#runId + + + + xs:string + + + + comment + + + en + Comment + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#comment + + + + xs:string + + + + expirationTimestamp + + + en + ExpirationTimestamp + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#expirationTimestamp + + + + xs:dateTime + + + + BusinessPartnerSite + + + en + Business Partner Site + + + + + en + Identifier for the physical location of a business partner plant or site, (e.g. BPNS in Catena-X context) + + + + + bpnsProperty + + + en + bpnsProperty + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#bpnsProperty + + + + xs:string + + + + + + dataQuality + + + en + Data Quality + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#dataQuality + + + + xs:nonNegativeInteger + + + + shipments + + + en + Shipments + + + + + en + List of shipments + + + true + DataElement + + + Shipment + + + en + Shipment + + + + + en + Delivery item from a sender to a recipient containing goods + + + + + shipmentId + + + en + Shipment Id + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#shipmentId + + + + xs:string + + + + BusinessPartnerSite + + + en + Business Partner Site + + + + + en + Identifier for the physical location of a business partner plant or site, (e.g. BPNS in Catena-X context) + + + + + bpnsProperty + + + en + bpnsProperty + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#bpnsProperty + + + + xs:string + + + + + + destinationTimestamp + + + en + Destination Timestamp + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#destinationTimestamp + + + + xs:dateTime + + + + BusinessPartnerSite + + + en + Business Partner Site + + + + + en + Identifier for the physical location of a business partner plant or site, (e.g. BPNS in Catena-X context) + + + + + bpnsProperty + + + en + bpnsProperty + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#bpnsProperty + + + + xs:string + + + + + + recipientTimestampPlanned + + + en + Recipient Timestamp Planned + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#recipientTimestampPlanned + + + + xs:dateTime + + + + splittingAllowed + + + en + Splitting Allowed + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#splittingAllowed + + + + xs:boolean + + + + BusinessPartnerSite + + + en + Business Partner Site + + + + + en + Identifier for the physical location of a business partner plant or site, (e.g. BPNS in Catena-X context) + + + + + bpnsProperty + + + en + bpnsProperty + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#bpnsProperty + + + + xs:string + + + + + + BusinessPartnerSite + + + en + Business Partner Site + + + + + en + Identifier for the physical location of a business partner plant or site, (e.g. BPNS in Catena-X context) + + + + + bpnsProperty + + + en + bpnsProperty + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#bpnsProperty + + + + xs:string + + + + + + handlingUnits + + + en + Handling Units + + + + + en + List of Handling Units + + + true + DataElement + + + HandlingUnit + + + en + Handling Unit + + + + + en + Handling Unit is the smallest shipment unit and cannot be divided into several shipments + + + + + handlingUnitId + + + en + Handling Unit Id + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#handlingUnitId + + + + xs:string + + + + name + + + en + Name + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#name + + + + xs:string + + + + volume + + + en + Volume + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#volume + + + + xs:float + + + + weight + + + en + Weight + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#weight + + + + xs:float + + + + amount + + + en + Amount + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#amount + + + + xs:positiveInteger + + + + batches + + + en + Batches + + + + + en + List of material batches contained within a handling unit + + + true + DataElement + + + MaterialBatch + + + en + Material Batch + + + + + en + Material Batches are part of a handling unit + + + + + batchSerialNumber + + + en + Batch Serial Number + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#batchSerialNumber + + + + xs:string + + + + materialNumber + + + en + Material Number + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#materialNumber + + + + xs:string + + + + materialName + + + en + Material Name + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#materialName + + + + xs:string + + + + materialHazardousGoods + + + en + Material Hazardous Goods + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#materialHazardousGoods + + + + xs:boolean + + + + batchExpirationTimestamp + + + en + Batch Expiration Timestamp + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#batchExpirationTimestamp + + + + xs:dateTime + + + + quantity + + + en + Quantity + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#quantity + + + + xs:float + + + + unitOfMeasurement + + + en + Unit Of Measurement + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#unitOfMeasurement + + + + xs:string + + + + batchNumber + + + en + Batch Number + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#batchNumber + + + + xs:string + + + + batchOrderId + + + en + Batch Order Id + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#batchOrderId + + + + xs:string + + + + + + + + + + + + + + + + timestamp + + + en + Timestamp + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#timestamp + + + + xs:dateTime + + + + + + + + + + APPLICATION_CLASS + MaterialFlowSimulationResultAspect + + + en + Material Flow Simulation Result Aspect + + + + + en + Aspect Model for the result of a Material Flow Simulation + + + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#MaterialFlowSimulationResultAspect + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Material Flow Simulation Result Aspect + + + + + en + MaterialFlowSimulationResultAspect + + + + + en + Aspect Model for the result of a Material Flow Simulation + + + + + + + + + description + + + en + Description + + + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#description + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Description + + + + + en + description + + + STRING + + + en + Verbal description + + + + + + + + + runId + + + en + RunId + + + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#runId + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + RunId + + + + + en + runId + + + STRING + + + en + Id of the simulation run + + + + + + + + + comment + + + en + Comment + + + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#comment + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Comment + + + + + en + comment + + + STRING + + + en + Additional comments + + + + + + + + + expirationTimestamp + + + en + ExpirationTimestamp + + + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#expirationTimestamp + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + ExpirationTimestamp + + + + + en + expirationTimestamp + + + STRING + + + en + Date and time when the simulation is expired + + + + + + + + + bpnsProperty + + + en + bpnsProperty + + + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#bpnsProperty + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + bpnsProperty + + + + + en + bpnsProperty + + + STRING + + + en + Property based on BPNS + + + + + + + + + owner + + + en + Owner + + + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#owner + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Owner + + + + + en + owner + + + STRING + + + en + Site identifier of the simulation originator + + + + + + + + + dataQuality + + + en + Data Quality + + + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#dataQuality + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Data Quality + + + + + en + dataQuality + + + INTEGER_COUNT + + + en + Information on quality of simulation results + + + + + + 0 + + ModelReference + + + DataElement + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#DataQualityOptions:0 + + + + + + 1 + + ModelReference + + + DataElement + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#DataQualityOptions:1 + + + + + + 2 + + ModelReference + + + DataElement + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#DataQualityOptions:2 + + + + + + 3 + + ModelReference + + + DataElement + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#DataQualityOptions:3 + + + + + + 4 + + ModelReference + + + DataElement + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#DataQualityOptions:4 + + + + + + 5 + + ModelReference + + + DataElement + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#DataQualityOptions:5 + + + + + + + + + + + + + shipmentId + + + en + Shipment Id + + + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#shipmentId + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Shipment Id + + + + + en + shipmentId + + + STRING + + + en + ID to identify the shipment + + + + + + + + + bpnsProperty + + + en + bpnsProperty + + + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#bpnsProperty + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + bpnsProperty + + + + + en + bpnsProperty + + + STRING + + + en + Property based on BPNS + + + + + + + + + destination + + + en + Destination + + + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#destination + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Destination + + + + + en + destination + + + STRING + + + en + Address where the shipment is immediately delivered to (by logistician) or provided for pickup (by producer) + + + + + + + + + destinationTimestamp + + + en + Destination Timestamp + + + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#destinationTimestamp + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Destination Timestamp + + + + + en + destinationTimestamp + + + STRING + + + en + Time when delivery arrives or is ready at goods issue + + + + + + + + + bpnsProperty + + + en + bpnsProperty + + + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#bpnsProperty + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + bpnsProperty + + + + + en + bpnsProperty + + + STRING + + + en + Property based on BPNS + + + + + + + + + recipient + + + en + Recipient + + + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#recipient + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Recipient + + + + + en + recipient + + + STRING + + + en + Address of final recipient of shipment + + + + + + + + + recipientTimestampPlanned + + + en + Recipient Timestamp Planned + + + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#recipientTimestampPlanned + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Recipient Timestamp Planned + + + + + en + recipientTimestampPlanned + + + STRING + + + en + Planned delivery time + + + + + + + + + splittingAllowed + + + en + Splitting Allowed + + + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#splittingAllowed + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Splitting Allowed + + + + + en + splittingAllowed + + + BOOLEAN + + + en + Permission to split the shipment into individual deliveries + + + + + + + + + bpnsProperty + + + en + bpnsProperty + + + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#bpnsProperty + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + bpnsProperty + + + + + en + bpnsProperty + + + STRING + + + en + Property based on BPNS + + + + + + + + + logistics + + + en + Logistics + + + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#logistics + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Logistics + + + + + en + logistics + + + STRING + + + en + Address of logistician executing the shipment + + + + + + + + + bpnsProperty + + + en + bpnsProperty + + + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#bpnsProperty + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + bpnsProperty + + + + + en + bpnsProperty + + + STRING + + + en + Property based on BPNS + + + + + + + + + preceding + + + en + Preceding + + + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#preceding + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Preceding + + + + + en + preceding + + + STRING + + + en + Reference ID of a preceding shipment + + + + + + + + + handlingUnitId + + + en + Handling Unit Id + + + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#handlingUnitId + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Handling Unit Id + + + + + en + handlingUnitId + + + STRING + + + en + ID of the handling unit + + + + + + + + + name + + + en + Name + + + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#name + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Name + + + + + en + name + + + STRING + + + en + Name of the type of handling unit + + + + + + + + + volume + + + en + Volume + + + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#volume + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Volume + + + + + en + volume + + + litre + REAL_MEASURE + + + en + Volume of the handling unit + + + + + + + + + weight + + + en + Weight + + + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#weight + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Weight + + + + + en + weight + + + kilogram + REAL_MEASURE + + + en + Weight of the handling unit + + + + + + + + + amount + + + en + Amount + + + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#amount + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Amount + + + + + en + amount + + + piece + INTEGER_COUNT + + + en + Number of handling units with identical content + + + + + + + + + batchSerialNumber + + + en + Batch Serial Number + + + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#batchSerialNumber + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Batch Serial Number + + + + + en + batchSerialNumber + + + STRING + + + en + can be used to uniquely identify a singe product part + + + + + + + + + materialNumber + + + en + Material Number + + + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#materialNumber + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Material Number + + + + + en + materialNumber + + + STRING + + + en + ID of the material contained in the batch + + + + + + + + + materialName + + + en + Material Name + + + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#materialName + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Material Name + + + + + en + materialName + + + STRING + + + en + Name of the material + + + + + + + + + materialHazardousGoods + + + en + Material Hazardous Goods + + + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#materialHazardousGoods + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Material Hazardous Goods + + + + + en + materialHazardousGoods + + + BOOLEAN + + + en + Flags hazardous goods + + + + + + + + + batchExpirationTimestamp + + + en + Batch Expiration Timestamp + + + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#batchExpirationTimestamp + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Batch Expiration Timestamp + + + + + en + batchExpirationTimestamp + + + STRING + + + en + Expiration date of batch + + + + + + + + + quantity + + + en + Quantity + + + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#quantity + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Quantity + + + + + en + quantity + + + REAL_MEASURE + + + en + Amount of materials + + + + + + + + + unitOfMeasurement + + + en + Unit Of Measurement + + + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#unitOfMeasurement + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Unit Of Measurement + + + + + en + unitOfMeasurement + + + STRING + + + en + Unit used for measuring the quantity + + + + + + KG + + ModelReference + + + DataElement + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#UnitOfMeasurementCharacteristic:KG + + + + + + Liter + + ModelReference + + + DataElement + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#UnitOfMeasurementCharacteristic:Liter + + + + + + Piece + + ModelReference + + + DataElement + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#UnitOfMeasurementCharacteristic:Piece + + + + + + + + + + + + + batchNumber + + + en + Batch Number + + + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#batchNumber + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Batch Number + + + + + en + batchNumber + + + STRING + + + en + Number of the batch, generated by originator (e.g. from ERP system, no uuid) + + + + + + + + + batchOrderId + + + en + Batch Order Id + + + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#batchOrderId + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Batch Order Id + + + + + en + batchOrderId + + + STRING + + + en + Order ID to which the batch belongs + + + + + + + + + batches + + + en + Batches + + + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#batches + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Batches + + + + + en + batches + + + STRING + + + en + List of material batches contained within a handling unit + + + + + + + + + handlingUnits + + + en + Handling Units + + + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#handlingUnits + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Handling Units + + + + + en + handlingUnits + + + STRING + + + en + List of Handling Units + + + + + + + + + shipments + + + en + Shipments + + + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#shipments + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Shipments + + + + + en + shipments + + + STRING + + + en + List of shipments + + + + + + + + + timestamp + + + en + Timestamp + + + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#timestamp + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Timestamp + + + + + en + timestamp + + + STRING + + + en + Timestamp of simulation run + + + + + + + + + materialFlowSimulationResult + + + en + Material Flow Simulation Result + + + urn:samm:io.catenax.material_flow_simulation_result:3.0.0#materialFlowSimulationResult + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Material Flow Simulation Result + + + + + en + materialFlowSimulationResult + + + STRING + + + en + Contains standardized attributes for the result of a material flow simulation + + + + + + + + + diff --git a/io.catenax.material_flow_simulation_result/3.0.0/gen/MaterialFlowSimulationResultAspect-schema.json b/io.catenax.material_flow_simulation_result/3.0.0/gen/MaterialFlowSimulationResultAspect-schema.json new file mode 100644 index 000000000..4d50c6435 --- /dev/null +++ b/io.catenax.material_flow_simulation_result/3.0.0/gen/MaterialFlowSimulationResultAspect-schema.json @@ -0,0 +1,254 @@ +{ + "$schema" : "http://json-schema.org/draft-04/schema", + "description" : "Aspect Model for the result of a Material Flow Simulation", + "type" : "object", + "components" : { + "schemas" : { + "urn_samm_io.catenax.material_flow_simulation_result_3.0.0_Text" : { + "type" : "string", + "description" : "Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc." + }, + "urn_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.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.material_flow_simulation_result_3.0.0_BusinessPartnerSite" : { + "description" : "Reference of preceding shipments", + "type" : "object", + "properties" : { + "bpnsProperty" : { + "description" : "Property based on BPNS", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.business_partner_number_2.0.0_BpnsTrait" + } + }, + "required" : [ "bpnsProperty" ] + }, + "urn_samm_io.catenax.material_flow_simulation_result_3.0.0_DataQualityOptions" : { + "type" : "number", + "minimum" : 0, + "description" : "Possible values determining data quality", + "enum" : [ 0, 1, 2, 3, 4, 5 ] + }, + "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_org.eclipse.esmf.samm_characteristic_2.1.0_Boolean" : { + "type" : "boolean", + "description" : "Represents a boolean value (i.e. a \"flag\")." + }, + "urn_samm_io.catenax.material_flow_simulation_result_3.0.0_VolumeCharacteristic" : { + "type" : "number", + "description" : "Volumetric value determining the volume of the handling unit" + }, + "urn_samm_io.catenax.material_flow_simulation_result_3.0.0_WeightCharacteristic" : { + "type" : "number", + "description" : "Amount of weight of the handling unit" + }, + "urn_samm_io.catenax.material_flow_simulation_result_3.0.0_AmountCharacteristic" : { + "type" : "number", + "minimum" : 1, + "description" : "Number describing handling units with identical pieces" + }, + "urn_samm_io.catenax.material_flow_simulation_result_3.0.0_QuantityCharacteristic" : { + "type" : "number", + "description" : "Number of materials contained within a handling unit" + }, + "urn_samm_io.catenax.material_flow_simulation_result_3.0.0_UnitOfMeasurementCharacteristic" : { + "type" : "string", + "description" : "Possible options for units of measurement", + "enum" : [ "KG", "Liter", "Piece" ] + }, + "urn_samm_io.catenax.material_flow_simulation_result_3.0.0_MaterialBatch" : { + "description" : "Material Batches are part of a handling unit", + "type" : "object", + "properties" : { + "batchSerialNumber" : { + "description" : "can be used to uniquely identify a singe product part", + "$ref" : "#/components/schemas/urn_samm_io.catenax.material_flow_simulation_result_3.0.0_Text" + }, + "materialNumber" : { + "description" : "ID of the material contained in the batch", + "$ref" : "#/components/schemas/urn_samm_io.catenax.material_flow_simulation_result_3.0.0_Text" + }, + "materialName" : { + "description" : "Name of the material", + "$ref" : "#/components/schemas/urn_samm_io.catenax.material_flow_simulation_result_3.0.0_Text" + }, + "materialHazardousGoods" : { + "description" : "Flags hazardous goods", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Boolean" + }, + "batchExpirationTimestamp" : { + "description" : "Expiration date of batch", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Timestamp" + }, + "quantity" : { + "description" : "Amount of materials", + "$ref" : "#/components/schemas/urn_samm_io.catenax.material_flow_simulation_result_3.0.0_QuantityCharacteristic" + }, + "unitOfMeasurement" : { + "description" : "Unit used for measuring the quantity", + "$ref" : "#/components/schemas/urn_samm_io.catenax.material_flow_simulation_result_3.0.0_UnitOfMeasurementCharacteristic" + }, + "batchNumber" : { + "description" : "Number of the batch, generated by originator (e.g. from ERP system, no uuid)", + "$ref" : "#/components/schemas/urn_samm_io.catenax.material_flow_simulation_result_3.0.0_Text" + }, + "batchOrderId" : { + "description" : "Order ID to which the batch belongs", + "$ref" : "#/components/schemas/urn_samm_io.catenax.material_flow_simulation_result_3.0.0_Text" + } + }, + "required" : [ "batchSerialNumber", "materialNumber", "materialName", "materialHazardousGoods", "batchExpirationTimestamp", "quantity", "unitOfMeasurement", "batchNumber", "batchOrderId" ] + }, + "urn_samm_io.catenax.material_flow_simulation_result_3.0.0_BatchList" : { + "description" : "List of material batches", + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/urn_samm_io.catenax.material_flow_simulation_result_3.0.0_MaterialBatch" + } + }, + "urn_samm_io.catenax.material_flow_simulation_result_3.0.0_HandlingUnit" : { + "description" : "Handling Unit is the smallest shipment unit and cannot be divided into several shipments", + "type" : "object", + "properties" : { + "handlingUnitId" : { + "description" : "ID of the handling unit", + "$ref" : "#/components/schemas/urn_samm_io.catenax.material_flow_simulation_result_3.0.0_Text" + }, + "name" : { + "description" : "Name of the type of handling unit", + "$ref" : "#/components/schemas/urn_samm_io.catenax.material_flow_simulation_result_3.0.0_Text" + }, + "volume" : { + "description" : "Volume of the handling unit", + "$ref" : "#/components/schemas/urn_samm_io.catenax.material_flow_simulation_result_3.0.0_VolumeCharacteristic" + }, + "weight" : { + "description" : "Weight of the handling unit", + "$ref" : "#/components/schemas/urn_samm_io.catenax.material_flow_simulation_result_3.0.0_WeightCharacteristic" + }, + "amount" : { + "description" : "Number of handling units with identical content", + "$ref" : "#/components/schemas/urn_samm_io.catenax.material_flow_simulation_result_3.0.0_AmountCharacteristic" + }, + "batches" : { + "description" : "List of material batches contained within a handling unit", + "$ref" : "#/components/schemas/urn_samm_io.catenax.material_flow_simulation_result_3.0.0_BatchList" + } + }, + "required" : [ "handlingUnitId", "name", "volume", "weight", "amount", "batches" ] + }, + "urn_samm_io.catenax.material_flow_simulation_result_3.0.0_HandlingUnitList" : { + "description" : "List of handling units included in the shipment", + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/urn_samm_io.catenax.material_flow_simulation_result_3.0.0_HandlingUnit" + } + }, + "urn_samm_io.catenax.material_flow_simulation_result_3.0.0_Shipment" : { + "description" : "Delivery item from a sender to a recipient containing goods", + "type" : "object", + "properties" : { + "shipmentId" : { + "description" : "ID to identify the shipment", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "destination" : { + "description" : "Address where the shipment is immediately delivered to (by logistician) or provided for pickup (by producer)", + "$ref" : "#/components/schemas/urn_samm_io.catenax.material_flow_simulation_result_3.0.0_BusinessPartnerSite" + }, + "destinationTimestamp" : { + "description" : "Time when delivery arrives or is ready at goods issue", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Timestamp" + }, + "recipient" : { + "description" : "Address of final recipient of shipment", + "$ref" : "#/components/schemas/urn_samm_io.catenax.material_flow_simulation_result_3.0.0_BusinessPartnerSite" + }, + "recipientTimestampPlanned" : { + "description" : "Planned delivery time", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Timestamp" + }, + "splittingAllowed" : { + "description" : "Permission to split the shipment into individual deliveries", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Boolean" + }, + "logistics" : { + "description" : "Address of logistician executing the shipment", + "$ref" : "#/components/schemas/urn_samm_io.catenax.material_flow_simulation_result_3.0.0_BusinessPartnerSite" + }, + "preceding" : { + "description" : "Reference ID of a preceding shipment", + "$ref" : "#/components/schemas/urn_samm_io.catenax.material_flow_simulation_result_3.0.0_BusinessPartnerSite" + }, + "handlingUnits" : { + "description" : "List of Handling Units", + "$ref" : "#/components/schemas/urn_samm_io.catenax.material_flow_simulation_result_3.0.0_HandlingUnitList" + } + }, + "required" : [ "shipmentId", "destination", "destinationTimestamp", "recipient", "recipientTimestampPlanned", "splittingAllowed", "logistics", "preceding", "handlingUnits" ] + }, + "urn_samm_io.catenax.material_flow_simulation_result_3.0.0_ShipmentList" : { + "description" : "List of shipments contained in the simulation", + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/urn_samm_io.catenax.material_flow_simulation_result_3.0.0_Shipment" + } + }, + "urn_samm_io.catenax.material_flow_simulation_result_3.0.0_MaterialFlowSimulationResultCharacteristic" : { + "description" : "Characteristic describing the aspect material flow simulation result", + "type" : "object", + "properties" : { + "description" : { + "description" : "Verbal description", + "$ref" : "#/components/schemas/urn_samm_io.catenax.material_flow_simulation_result_3.0.0_Text" + }, + "runId" : { + "description" : "Id of the simulation run", + "$ref" : "#/components/schemas/urn_samm_io.catenax.material_flow_simulation_result_3.0.0_Text" + }, + "comment" : { + "description" : "Additional comments", + "$ref" : "#/components/schemas/urn_samm_io.catenax.material_flow_simulation_result_3.0.0_Text" + }, + "expirationTimestamp" : { + "description" : "Date and time when the simulation is expired", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Timestamp" + }, + "owner" : { + "description" : "Site identifier of the simulation originator", + "$ref" : "#/components/schemas/urn_samm_io.catenax.material_flow_simulation_result_3.0.0_BusinessPartnerSite" + }, + "dataQuality" : { + "description" : "Information on quality of simulation results", + "$ref" : "#/components/schemas/urn_samm_io.catenax.material_flow_simulation_result_3.0.0_DataQualityOptions" + }, + "shipments" : { + "description" : "List of shipments", + "$ref" : "#/components/schemas/urn_samm_io.catenax.material_flow_simulation_result_3.0.0_ShipmentList" + }, + "timestamp" : { + "description" : "Timestamp of simulation run", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Timestamp" + } + }, + "required" : [ "description", "runId", "comment", "expirationTimestamp", "owner", "dataQuality", "shipments", "timestamp" ] + } + } + }, + "properties" : { + "materialFlowSimulationResult" : { + "description" : "Contains standardized attributes for the result of a material flow simulation", + "$ref" : "#/components/schemas/urn_samm_io.catenax.material_flow_simulation_result_3.0.0_MaterialFlowSimulationResultCharacteristic" + } + }, + "required" : [ "materialFlowSimulationResult" ] +} \ No newline at end of file diff --git a/io.catenax.material_flow_simulation_result/3.0.0/gen/MaterialFlowSimulationResultAspect.aasx b/io.catenax.material_flow_simulation_result/3.0.0/gen/MaterialFlowSimulationResultAspect.aasx new file mode 100644 index 000000000..23e216b32 Binary files /dev/null and b/io.catenax.material_flow_simulation_result/3.0.0/gen/MaterialFlowSimulationResultAspect.aasx differ diff --git a/io.catenax.material_flow_simulation_result/3.0.0/gen/MaterialFlowSimulationResultAspect.html b/io.catenax.material_flow_simulation_result/3.0.0/gen/MaterialFlowSimulationResultAspect.html new file mode 100644 index 000000000..f2574abef --- /dev/null +++ b/io.catenax.material_flow_simulation_result/3.0.0/gen/MaterialFlowSimulationResultAspect.html @@ -0,0 +1,2384 @@ + + + + + + + + + + + + + + Documentation Material Flow Simulation Result Aspect + + +
+
+
+
+

Aspect Model Material Flow Simulation Result Aspect

+
urn:samm:io.catenax.material_flow_simulation_result:3.0.0#MaterialFlowSimulationResultAspect
+
+
+
+
+
+
+
+ +
+ + +
+ Aspect Model for the result of a Material Flow Simulation +
+ + +
+

Overview

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

Properties

+
+ +
+ +
+

Material Flow Simulation Result

+
+ +Contains standardized attributes for the result of a material flow simulation + +
+
Name
+
materialFlowSimulationResult
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.material_flow_simulation_result:3.0.0#MaterialFlowSimulationResult + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
materialFlowSimulationResult
+
+ + +
+
+ + + +
+
+

Entities

+
+ +
+
+

Business Partner Site

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

Properties

+
+
+ +
+
bpnsProperty
+
+ +Property based on BPNS + +
+
Name
+
bpnsProperty
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
    +
  • https://catena-x.net/fileadmin/user_upload/Standard-Bibliothek/Update_PDF_Maerz/5_BPDM/CX_-_0010_BUSINESS_PARTNER_NUMBER_PlatformCapabilityBPDM_v_1.0.1.pdf
    • +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
BPNS0123456789ZZ
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
bpnsProperty
+
+ + +
+
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
    +
    ^BPNS[a-zA-Z0-9]{12}$
    +
    + +
    • +
+
+
+
+
+
+
+

Handling Unit

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

Properties

+
+
+ +
+
Handling Unit Id
+
+ +ID of the handling unit + +
+
Name
+
handlingUnitId
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
HUT_1
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
handlingUnitId
+
+ + +
+
+ +
+
Name
+
+ +Name of the type of handling unit + +
+
Name
+
name
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Palette
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
name
+
+ + +
+
+ +
+
Volume
+
+ +Volume of the handling unit + +
+
Name
+
volume
+
+ + + +
+
Characteristic
+
+
+
+
Measurement
+
+
+
Volumetric value determining the volume of the handling unit
+
+
+
Unit
+
+
+
+
    +
  • + litre +
    • +
  • + Symbol l +
    • +
  • + Code LTR +
    • +
  • + Conversion factor 10⁻³ m³ +
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#float + +
+
+
+
+
+ +
+
Example
+
1.0
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
volume
+
+ + +
+
+ +
+
Weight
+
+ +Weight of the handling unit + +
+
Name
+
weight
+
+ + + +
+
Characteristic
+
+
+
+
Measurement
+
+
+
Amount of weight of the handling unit
+
+
+
Unit
+
+
+
+
    +
  • + kilogram +
    • +
  • + Symbol kg +
    • +
  • + Code KGM +
    • +
  • + Conversion factor kg +
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#float + +
+
+
+
+
+ +
+
Example
+
189.0
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
weight
+
+ + +
+
+ +
+
Amount
+
+ +Number of handling units with identical content + +
+
Name
+
amount
+
+ + + +
+
Characteristic
+
+
+
+
Quantifiable
+
+
+
Duration
+
+
+
Number describing handling units with identical pieces
+
+
+
Unit
+
+
+
+
    +
  • + piece +
    • +
  • + Code H87 +
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#positiveInteger + +
+
+
+
+
+ +
+
Example
+
1
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
amount
+
+ + +
+
+ +
+
Batches
+
+ +List of material batches contained within a handling unit + +
+
Name
+
batches
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.material_flow_simulation_result:3.0.0#MaterialBatch + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
batches
+
+ + +
+
+
+
+

Material Batch

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

Properties

+
+
+ +
+
Batch Serial Number
+
+ +can be used to uniquely identify a singe product part + +
+
Name
+
batchSerialNumber
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Batch_1
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
batchSerialNumber
+
+ + +
+
+ +
+
Material Number
+
+ +ID of the material contained in the batch + +
+
Name
+
materialNumber
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
KK1000GR
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
materialNumber
+
+ + +
+
+ +
+
Material Name
+
+ +Name of the material + +
+
Name
+
materialName
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
KK1000GR-Gehäuse-Rot
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
materialName
+
+ + +
+
+ +
+
Material Hazardous Goods
+
+ +Flags hazardous goods + +
+
Name
+
materialHazardousGoods
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#boolean + +
+
+
+
+
+ +
+
Example
+
false
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
materialHazardousGoods
+
+ + +
+
+ +
+
Batch Expiration Timestamp
+
+ +Expiration date of batch + +
+
Name
+
batchExpirationTimestamp
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#dateTime + +
+
+
+
+
+ +
+
Example
+
2023-08-22T16:00:00.000Z
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
batchExpirationTimestamp
+
+ + +
+
+ +
+
Quantity
+
+ +Amount of materials + +
+
Name
+
quantity
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#float + +
+
+
+
+
+ +
+
Example
+
50.0
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
quantity
+
+ + +
+
+ +
+
Unit Of Measurement
+
+ +Unit used for measuring the quantity + +
+
Name
+
unitOfMeasurement
+
+ + + +
+
Characteristic
+
+
+
+
Enumeration
+
+
+
Values
+
+
+
+
    +
  • KG
    • +
  • Liter
    • +
  • Piece
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
unitOfMeasurement
+
+ + +
+
+ +
+
Batch Number
+
+ +Number of the batch, generated by originator (e.g. from ERP system, no uuid) + +
+
Name
+
batchNumber
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
45
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
batchNumber
+
+ + +
+
+ +
+
Batch Order Id
+
+ +Order ID to which the batch belongs + +
+
Name
+
batchOrderId
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Order-0001
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
batchOrderId
+
+ + +
+
+
+
+

Material Flow Simulation Result

+
+
+ Result of a Material Flow Simulation +
+ +
+

Properties

+
+
+ +
+
Description
+
+ +Verbal description + +
+
Name
+
description
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Please simulate asap
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
description
+
+ + +
+
+ +
+
RunId
+
+ +Id of the simulation run + +
+
Name
+
runId
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
0fece48b-c8d1-4180-1a9caca6d67e
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
runId
+
+ + +
+
+ +
+
Comment
+
+ +Additional comments + +
+
Name
+
comment
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
successful simulation
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
comment
+
+ + +
+
+ +
+
ExpirationTimestamp
+
+ +Date and time when the simulation is expired + +
+
Name
+
expirationTimestamp
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#dateTime + +
+
+
+
+
+ +
+
Example
+
2023-03-24T09:15:24.000Z
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
expirationTimestamp
+
+ + +
+
+ +
+
Owner
+
+ +Site identifier of the simulation originator + +
+
Name
+
owner
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.material_flow_simulation_result:3.0.0#BusinessPartnerSite + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
owner
+
+ + +
+
+ +
+
Data Quality
+
+ +Information on quality of simulation results + +
+
Name
+
dataQuality
+
+ + + +
+
Characteristic
+
+
+
+
Enumeration
+
+
+
Values
+
+
+
+
    +
  • 0
    • +
  • 1
    • +
  • 2
    • +
  • 3
    • +
  • 4
    • +
  • 5
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#nonNegativeInteger + +
+
+
+
+
+ +
+
Example
+
0
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
dataQuality
+
+ + +
+
+ +
+
Shipments
+
+ +List of shipments + +
+
Name
+
shipments
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.material_flow_simulation_result:3.0.0#Shipment + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
shipments
+
+ + +
+
+ +
+
Timestamp
+
+ +Timestamp of simulation run + +
+
Name
+
timestamp
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#dateTime + +
+
+
+
+
+ +
+
Example
+
2023-03-09T14:13:42.806Z
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
timestamp
+
+ + +
+
+
+
+

Shipment

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

Properties

+
+
+ +
+
Shipment Id
+
+ +ID to identify the shipment + +
+
Name
+
shipmentId
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
DE51515151
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
shipmentId
+
+ + +
+
+ +
+
Destination
+
+ +Address where the shipment is immediately delivered to (by logistician) or provided for pickup (by producer) + +
+
Name
+
destination
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.material_flow_simulation_result:3.0.0#BusinessPartnerSite + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
destination
+
+ + +
+
+ +
+
Destination Timestamp
+
+ +Time when delivery arrives or is ready at goods issue + +
+
Name
+
destinationTimestamp
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#dateTime + +
+
+
+
+
+ +
+
Example
+
2023-03-19T09:00:00.000Z
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
destinationTimestamp
+
+ + +
+
+ +
+
Recipient
+
+ +Address of final recipient of shipment + +
+
Name
+
recipient
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.material_flow_simulation_result:3.0.0#BusinessPartnerSite + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
recipient
+
+ + +
+
+ +
+
Recipient Timestamp Planned
+
+ +Planned delivery time + +
+
Name
+
recipientTimestampPlanned
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#dateTime + +
+
+
+
+
+ +
+
Example
+
2023-04-19T09:00:00.000Z
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
recipientTimestampPlanned
+
+ + +
+
+ +
+
Splitting Allowed
+
+ +Permission to split the shipment into individual deliveries + +
+
Name
+
splittingAllowed
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#boolean + +
+
+
+
+
+ +
+
Example
+
true
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
splittingAllowed
+
+ + +
+
+ +
+
Logistics
+
+ +Address of logistician executing the shipment + +
+
Name
+
logistics
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.material_flow_simulation_result:3.0.0#BusinessPartnerSite + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
logistics
+
+ + +
+
+ +
+
Preceding
+
+ +Reference ID of a preceding shipment + +
+
Name
+
preceding
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.material_flow_simulation_result:3.0.0#BusinessPartnerSite + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
preceding
+
+ + +
+
+ +
+
Handling Units
+
+ +List of Handling Units + +
+
Name
+
handlingUnits
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.material_flow_simulation_result:3.0.0#HandlingUnit + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
handlingUnits
+
+ + +
+
+
+ +
+ Third party licenses + +
+ +
+ + +
+ + + \ No newline at end of file diff --git a/io.catenax.material_flow_simulation_result/3.0.0/gen/MaterialFlowSimulationResultAspect.json b/io.catenax.material_flow_simulation_result/3.0.0/gen/MaterialFlowSimulationResultAspect.json new file mode 100644 index 000000000..dcdab0aba --- /dev/null +++ b/io.catenax.material_flow_simulation_result/3.0.0/gen/MaterialFlowSimulationResultAspect.json @@ -0,0 +1,49 @@ +{ + "materialFlowSimulationResult" : { + "owner" : { + "bpnsProperty" : "BPNS0123456789ZZ" + }, + "dataQuality" : 0, + "description" : "Please simulate asap", + "comment" : "successful simulation ", + "expirationTimestamp" : "2023-03-24T09:15:24.000Z", + "runId" : "0fece48b-c8d1-4180-1a9caca6d67e", + "shipments" : [ { + "handlingUnits" : [ { + "name" : "Palette", + "volume" : 1.0, + "weight" : 189.0, + "batches" : [ { + "unitOfMeasurement" : "KG", + "materialName" : "KK1000GR-Gehäuse-Rot", + "quantity" : 50.0, + "materialNumber" : "KK1000GR", + "materialHazardousGoods" : false, + "batchSerialNumber" : "Batch_1", + "batchOrderId" : "Order-0001", + "batchExpirationTimestamp" : "2023-08-22T16:00:00.000Z", + "batchNumber" : "45" + } ], + "handlingUnitId" : "HUT_1", + "amount" : 1 + } ], + "shipmentId" : "DE51515151", + "recipientTimestampPlanned" : "2023-04-19T09:00:00.000Z", + "destination" : { + "bpnsProperty" : "BPNS0123456789ZZ" + }, + "recipient" : { + "bpnsProperty" : "BPNS0123456789ZZ" + }, + "logistics" : { + "bpnsProperty" : "BPNS0123456789ZZ" + }, + "preceding" : { + "bpnsProperty" : "BPNS0123456789ZZ" + }, + "splittingAllowed" : true, + "destinationTimestamp" : "2023-03-19T09:00:00.000Z" + } ], + "timestamp" : "2023-03-09T14:13:42.806Z" + } +} \ No newline at end of file diff --git a/io.catenax.material_flow_simulation_result/3.0.0/gen/MaterialFlowSimulationResultAspect.yml b/io.catenax.material_flow_simulation_result/3.0.0/gen/MaterialFlowSimulationResultAspect.yml new file mode 100644 index 000000000..88908feb1 --- /dev/null +++ b/io.catenax.material_flow_simulation_result/3.0.0/gen/MaterialFlowSimulationResultAspect.yml @@ -0,0 +1,330 @@ +--- +openapi: 3.0.3 +info: + title: Material Flow Simulation Result Aspect + version: v3 +servers: +- url: catenax.io/api/v3 + variables: + api-version: + default: v3 +paths: + /{tenant-id}/material-flow-simulation-result-aspect: + get: + tags: + - MaterialFlowSimulationResultAspect + operationId: getMaterialFlowSimulationResultAspect + 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/MaterialFlowSimulationResultAspect' + "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.material_flow_simulation_result_3.0.0_Text: + type: string + description: "Describes a Property which contains plain text. This is intended\ + \ exclusively for human readable strings, not for identifiers, measurement\ + \ values, etc." + urn_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.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.material_flow_simulation_result_3.0.0_BusinessPartnerSite: + description: Reference of preceding shipments + type: object + properties: + bpnsProperty: + description: Property based on BPNS + $ref: '#/components/schemas/urn_samm_io.catenax.shared.business_partner_number_2.0.0_BpnsTrait' + required: + - bpnsProperty + urn_samm_io.catenax.material_flow_simulation_result_3.0.0_DataQualityOptions: + type: number + minimum: 0 + description: Possible values determining data quality + enum: + - 0 + - 1 + - 2 + - 3 + - 4 + - 5 + 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_org.eclipse.esmf.samm_characteristic_2.1.0_Boolean: + type: boolean + description: Represents a boolean value (i.e. a "flag"). + urn_samm_io.catenax.material_flow_simulation_result_3.0.0_VolumeCharacteristic: + type: number + description: Volumetric value determining the volume of the handling unit + urn_samm_io.catenax.material_flow_simulation_result_3.0.0_WeightCharacteristic: + type: number + description: Amount of weight of the handling unit + urn_samm_io.catenax.material_flow_simulation_result_3.0.0_AmountCharacteristic: + type: number + minimum: 1 + description: Number describing handling units with identical pieces + urn_samm_io.catenax.material_flow_simulation_result_3.0.0_QuantityCharacteristic: + type: number + description: Number of materials contained within a handling unit + urn_samm_io.catenax.material_flow_simulation_result_3.0.0_UnitOfMeasurementCharacteristic: + type: string + description: Possible options for units of measurement + enum: + - KG + - Liter + - Piece + urn_samm_io.catenax.material_flow_simulation_result_3.0.0_MaterialBatch: + description: Material Batches are part of a handling unit + type: object + properties: + batchSerialNumber: + description: can be used to uniquely identify a singe product part + $ref: '#/components/schemas/urn_samm_io.catenax.material_flow_simulation_result_3.0.0_Text' + materialNumber: + description: ID of the material contained in the batch + $ref: '#/components/schemas/urn_samm_io.catenax.material_flow_simulation_result_3.0.0_Text' + materialName: + description: Name of the material + $ref: '#/components/schemas/urn_samm_io.catenax.material_flow_simulation_result_3.0.0_Text' + materialHazardousGoods: + description: Flags hazardous goods + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Boolean' + batchExpirationTimestamp: + description: Expiration date of batch + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Timestamp' + quantity: + description: Amount of materials + $ref: '#/components/schemas/urn_samm_io.catenax.material_flow_simulation_result_3.0.0_QuantityCharacteristic' + unitOfMeasurement: + description: Unit used for measuring the quantity + $ref: '#/components/schemas/urn_samm_io.catenax.material_flow_simulation_result_3.0.0_UnitOfMeasurementCharacteristic' + batchNumber: + description: "Number of the batch, generated by originator (e.g. from ERP\ + \ system, no uuid)" + $ref: '#/components/schemas/urn_samm_io.catenax.material_flow_simulation_result_3.0.0_Text' + batchOrderId: + description: Order ID to which the batch belongs + $ref: '#/components/schemas/urn_samm_io.catenax.material_flow_simulation_result_3.0.0_Text' + required: + - batchSerialNumber + - materialNumber + - materialName + - materialHazardousGoods + - batchExpirationTimestamp + - quantity + - unitOfMeasurement + - batchNumber + - batchOrderId + urn_samm_io.catenax.material_flow_simulation_result_3.0.0_BatchList: + description: List of material batches + type: array + items: + $ref: '#/components/schemas/urn_samm_io.catenax.material_flow_simulation_result_3.0.0_MaterialBatch' + urn_samm_io.catenax.material_flow_simulation_result_3.0.0_HandlingUnit: + description: Handling Unit is the smallest shipment unit and cannot be divided + into several shipments + type: object + properties: + handlingUnitId: + description: ID of the handling unit + $ref: '#/components/schemas/urn_samm_io.catenax.material_flow_simulation_result_3.0.0_Text' + name: + description: Name of the type of handling unit + $ref: '#/components/schemas/urn_samm_io.catenax.material_flow_simulation_result_3.0.0_Text' + volume: + description: Volume of the handling unit + $ref: '#/components/schemas/urn_samm_io.catenax.material_flow_simulation_result_3.0.0_VolumeCharacteristic' + weight: + description: Weight of the handling unit + $ref: '#/components/schemas/urn_samm_io.catenax.material_flow_simulation_result_3.0.0_WeightCharacteristic' + amount: + description: Number of handling units with identical content + $ref: '#/components/schemas/urn_samm_io.catenax.material_flow_simulation_result_3.0.0_AmountCharacteristic' + batches: + description: List of material batches contained within a handling unit + $ref: '#/components/schemas/urn_samm_io.catenax.material_flow_simulation_result_3.0.0_BatchList' + required: + - handlingUnitId + - name + - volume + - weight + - amount + - batches + urn_samm_io.catenax.material_flow_simulation_result_3.0.0_HandlingUnitList: + description: List of handling units included in the shipment + type: array + items: + $ref: '#/components/schemas/urn_samm_io.catenax.material_flow_simulation_result_3.0.0_HandlingUnit' + urn_samm_io.catenax.material_flow_simulation_result_3.0.0_Shipment: + description: Delivery item from a sender to a recipient containing goods + type: object + properties: + shipmentId: + description: ID to identify the shipment + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + destination: + description: Address where the shipment is immediately delivered to (by + logistician) or provided for pickup (by producer) + $ref: '#/components/schemas/urn_samm_io.catenax.material_flow_simulation_result_3.0.0_BusinessPartnerSite' + destinationTimestamp: + description: Time when delivery arrives or is ready at goods issue + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Timestamp' + recipient: + description: Address of final recipient of shipment + $ref: '#/components/schemas/urn_samm_io.catenax.material_flow_simulation_result_3.0.0_BusinessPartnerSite' + recipientTimestampPlanned: + description: Planned delivery time + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Timestamp' + splittingAllowed: + description: Permission to split the shipment into individual deliveries + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Boolean' + logistics: + description: Address of logistician executing the shipment + $ref: '#/components/schemas/urn_samm_io.catenax.material_flow_simulation_result_3.0.0_BusinessPartnerSite' + preceding: + description: Reference ID of a preceding shipment + $ref: '#/components/schemas/urn_samm_io.catenax.material_flow_simulation_result_3.0.0_BusinessPartnerSite' + handlingUnits: + description: List of Handling Units + $ref: '#/components/schemas/urn_samm_io.catenax.material_flow_simulation_result_3.0.0_HandlingUnitList' + required: + - shipmentId + - destination + - destinationTimestamp + - recipient + - recipientTimestampPlanned + - splittingAllowed + - logistics + - preceding + - handlingUnits + urn_samm_io.catenax.material_flow_simulation_result_3.0.0_ShipmentList: + description: List of shipments contained in the simulation + type: array + items: + $ref: '#/components/schemas/urn_samm_io.catenax.material_flow_simulation_result_3.0.0_Shipment' + urn_samm_io.catenax.material_flow_simulation_result_3.0.0_MaterialFlowSimulationResultCharacteristic: + description: Characteristic describing the aspect material flow simulation result + type: object + properties: + description: + description: Verbal description + $ref: '#/components/schemas/urn_samm_io.catenax.material_flow_simulation_result_3.0.0_Text' + runId: + description: Id of the simulation run + $ref: '#/components/schemas/urn_samm_io.catenax.material_flow_simulation_result_3.0.0_Text' + comment: + description: Additional comments + $ref: '#/components/schemas/urn_samm_io.catenax.material_flow_simulation_result_3.0.0_Text' + expirationTimestamp: + description: Date and time when the simulation is expired + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Timestamp' + owner: + description: Site identifier of the simulation originator + $ref: '#/components/schemas/urn_samm_io.catenax.material_flow_simulation_result_3.0.0_BusinessPartnerSite' + dataQuality: + description: Information on quality of simulation results + $ref: '#/components/schemas/urn_samm_io.catenax.material_flow_simulation_result_3.0.0_DataQualityOptions' + shipments: + description: List of shipments + $ref: '#/components/schemas/urn_samm_io.catenax.material_flow_simulation_result_3.0.0_ShipmentList' + timestamp: + description: Timestamp of simulation run + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Timestamp' + required: + - description + - runId + - comment + - expirationTimestamp + - owner + - dataQuality + - shipments + - timestamp + MaterialFlowSimulationResultAspect: + description: Aspect Model for the result of a Material Flow Simulation + type: object + properties: + materialFlowSimulationResult: + description: Contains standardized attributes for the result of a material + flow simulation + $ref: '#/components/schemas/urn_samm_io.catenax.material_flow_simulation_result_3.0.0_MaterialFlowSimulationResultCharacteristic' + required: + - materialFlowSimulationResult + 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' + MaterialFlowSimulationResultAspect: + content: + application/json: + schema: + $ref: '#/components/schemas/MaterialFlowSimulationResultAspect' + description: The request was successful. + requestBodies: + MaterialFlowSimulationResultAspect: + content: + application/json: + schema: + $ref: '#/components/schemas/MaterialFlowSimulationResultAspect' diff --git a/io.catenax.material_flow_simulation_result/3.0.0/metadata.json b/io.catenax.material_flow_simulation_result/3.0.0/metadata.json new file mode 100644 index 000000000..84245e4eb --- /dev/null +++ b/io.catenax.material_flow_simulation_result/3.0.0/metadata.json @@ -0,0 +1 @@ +{ "status" : "release" } diff --git a/io.catenax.material_flow_simulation_result/RELEASE_NOTES.md b/io.catenax.material_flow_simulation_result/RELEASE_NOTES.md index 64ed56f2c..5f23d7c97 100644 --- a/io.catenax.material_flow_simulation_result/RELEASE_NOTES.md +++ b/io.catenax.material_flow_simulation_result/RELEASE_NOTES.md @@ -2,6 +2,12 @@ All notable changes to this model will be documented in this file. +## [3.0.0] 2024-05-21 + +- Add BPNS as entity with properties +- Update header +- Replace `batchID` with `batchSerialNumber` + ## [2.0.0] 2023-10-16 ### Added diff --git a/io.catenax.material_for_recycling/1.1.0/MaterialForRecycling.ttl b/io.catenax.material_for_recycling/1.1.0/MaterialForRecycling.ttl deleted file mode 100644 index 03f63022c..000000000 --- a/io.catenax.material_for_recycling/1.1.0/MaterialForRecycling.ttl +++ /dev/null @@ -1,144 +0,0 @@ -####################################################################### -# Copyright (c) 2022 T-Systems International GmbH -# Copyright (c) 2022 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) -# Copyright (c) 2022 Fraunhofer-Gesellschaft zur Förderung der angewandten Forschung e.V. für ihre Institute IPK und IPK -# Copyright (c) 2022 Henkel AG & Co. KGaA -# Copyright (c) 2022 SAP SE -# Copyright (c) 2022 Badische Anilin und Sodafabrik societates Europaea -# Copyright (c) 2022 LRP Autorecycling Leipzig GmbH -# Copyright (c) 2022 ZF Friedrichshafen AG -# Copyright (c) 2022 Contributors to the Eclipse Foundation -# -# 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 xsd: . -@prefix bamm: . -@prefix unit: . -@prefix bamm-c: . -@prefix bamm-e: . -@prefix rdf: . -@prefix : . - -:materialName a bamm:Property; - bamm:name "materialName"; - bamm:description "The commercial name of a material"@en; - bamm:exampleValue "Polyamid"; - bamm:characteristic bamm-c:Text. -:materialAbbreviation a bamm:Property; - bamm:name "materialAbbreviation"; - bamm:description "A short abbreviation of the materialName"@en; - bamm:exampleValue "PA66G40"; - bamm:characteristic bamm-c:Text. -:Percentage a bamm-c:Quantifiable; - bamm:name "Percentage"; - bamm:description "Percentage of already recycled material contained."@en; - bamm:dataType xsd:double; - bamm-c:unit unit:percent. -:MaterialForRecycling a bamm:Aspect; - bamm:name "MaterialForRecycling"; - bamm:description "This model depicts a material as seen by the recycler at the end of the lifecycle of a product. If a material consists of only one single component the name and class for the aspect are not used"@en; - bamm:preferredName "material for recycling"@en; - bamm:operations (); - bamm:properties ([ - bamm:property :materialName; - bamm:optional "true"^^xsd:boolean -] [ - bamm:property :materialClass; - bamm:optional "true"^^xsd:boolean -] :component [ - bamm:property :recycledContent; - bamm:optional "true"^^xsd:boolean -]). -:materialClass a bamm:Property; - bamm:name "materialClass"; - bamm:description "The class of a material following the referenced standard."@en; - bamm:exampleValue "plastic"; - bamm:characteristic :MaterialClass. -:component a bamm:Property; - bamm:name "component"; - bamm:description "Components the material consists of"@en; - bamm:characteristic :ComponentCharacteristic; - bamm:preferredName "component"@en. -:MaterialClass a bamm:Characteristic; - bamm:name "MaterialClass"; - bamm:description "Class according to the refernced standard the material belongs to. The IMDS recommendations and the IMDS rules are exclusevily accessible within the IMDS portal to members of the IMDS association. In order to access the data one needs to be member of the association."@en; - bamm:dataType xsd:string; - bamm:preferredName "material class"@en; - bamm:see . -:ComponentCharacteristic a bamm-c:Set; - bamm:name "ComponentCharacteristic"; - bamm:description "Describes the consistency"@en; - bamm:dataType :ComponentEntity; - bamm:preferredName "component characteristic"@en. -:ComponentEntity a bamm:Entity; - bamm:name "ComponentEntity"; - bamm:description "The properties that describe a component"@en; - bamm:preferredName "component entity"@en; - bamm:properties ([ - bamm:property :aggregateState; - bamm:optional "true"^^xsd:boolean -] [ - bamm:property :recycledContent; - bamm:optional "true"^^xsd:boolean -] [ - bamm:property :materialAbbreviation; - bamm:optional "true"^^xsd:boolean -] :materialClass :materialName [ - bamm:property :quantity; - bamm:optional "true"^^xsd:boolean -]). -:aggregateState a bamm:Property; - bamm:name "aggregateState"; - bamm:description "The aggregate state the materialis in at the timepoint the item is disassembled"@en; - bamm:exampleValue "liquid"; - bamm:characteristic :AggregateState. -:recycledContent a bamm:Property; - bamm:name "recycledContent"; - bamm:description "Indicates if the material was is recycled. Percentage of how much of the material was recycled. This can be an aggregation regarding the materials below."@en; - bamm:characteristic :Percentage; - bamm:preferredName "recycled content"@en. -:quantity a bamm:Property; - bamm:name "quantity"; - bamm:description "quantity of the material expressed in value and unit"@en; - bamm:characteristic :QuantityCharacteristic; - bamm:preferredName "quantity"@en. -:AggregateState a bamm-c:Enumeration; - bamm:name "AggregateState"; - bamm:dataType xsd:string; - bamm:preferredName "aggregate state"@en; - bamm-c:values ("solid" "liquid" "gasenous"). -:Value a bamm:Characteristic; - bamm:name "Value"; - bamm:description "Quantifiable value as double in reference to the measurementUnit"@en; - bamm:dataType xsd:double; - bamm:preferredName "Value"@en. -:QuantityCharacteristic a bamm:Characteristic; - bamm:name "QuantityCharacteristic"; - bamm:description "quantity characteristic for the material expressed in value and unit"@en; - bamm:dataType :QuantityEntity; - bamm:preferredName "quantity characteristic"@en. -:QuantityEntity a bamm:Entity; - bamm:name "QuantityEntity"; - bamm:description "Quantity of the material"@en; - bamm:preferredName "QuantityEntity"@en; - bamm:properties (:unit :value). -:unit a bamm:Property; - bamm:name "unit"; - bamm:description "Unit of Measurement for the quantity of serialized objects.\nThe recommended units are the SI units such as unit:kilogram or additional unit:percent"@en; - bamm:exampleValue "kilogram"^^bamm:curie; - bamm:characteristic bamm-c:UnitReference; - bamm:see . -:value a bamm:Property; - bamm:name "value"; - bamm:description "Measurement value as a double. The unit is saved in the property measurementUnit"@en; - bamm:characteristic :Value; - bamm:preferredName "value"@en. diff --git a/io.catenax.material_for_recycling/1.1.0/gen/MaterialForRecycling-aas.xml b/io.catenax.material_for_recycling/1.1.0/gen/MaterialForRecycling-aas.xml deleted file mode 100644 index be418c362..000000000 --- a/io.catenax.material_for_recycling/1.1.0/gen/MaterialForRecycling-aas.xml +++ /dev/null @@ -1,883 +0,0 @@ - - - - - defaultAdminShell - - - en - defaultAdminShell - - - - urn:samm:io.catenax.material_for_recycling:1.1.0#MaterialForRecycling - - Type - - - - ModelReference - - - Submodel - urn:samm:io.catenax.material_for_recycling:1.1.0#MaterialForRecycling/submodel - - - - - - - - - MaterialForRecycling - - - en - This model depicts a material as seen by the recycler at the end of the lifecycle of a product. If a material consists of only one single component the name and class for the aspect are not used - - - - urn:samm:io.catenax.material_for_recycling:1.1.0#MaterialForRecycling/submodel - Template - - ModelReference - - - ConceptDescription - urn:samm:io.catenax.material_for_recycling:1.1.0#MaterialForRecycling - - - - - - materialName - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.material_for_recycling:1.1.0#materialName - - - - xs:string - - - - materialClass - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.material_for_recycling:1.1.0#materialClass - - - - xs:string - - - - component - - - en - component - - - - - en - Components the material consists of - - - true - DataElement - - - ComponentEntity - - - en - component entity - - - - - en - The properties that describe a component - - - - - aggregateState - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.material_for_recycling:1.1.0#aggregateState - - - - xs:string - - - - recycledContent - - - en - recycled content - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.material_for_recycling:1.1.0#recycledContent - - - - xs:double - - - - materialAbbreviation - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.material_for_recycling:1.1.0#materialAbbreviation - - - - xs:string - - - - materialClass - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.material_for_recycling:1.1.0#materialClass - - - - xs:string - - - - materialName - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.material_for_recycling:1.1.0#materialName - - - - xs:string - - - - QuantityEntity - - - en - QuantityEntity - - - - - en - Quantity of the material - - - - - unit - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.material_for_recycling:1.1.0#unit - - - - - - ExternalReference - - - GlobalReference - https://openmanufacturingplatform.github.io/sds-bamm-aspect-meta-model/bamm-specification/snapshot/appendix/unitcatalog.html - - - - - xs:string - - - - value - - - en - value - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.material_for_recycling:1.1.0#value - - - - xs:double - - - - - - - - - - recycledContent - - - en - recycled content - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.material_for_recycling:1.1.0#recycledContent - - - - xs:double - - - - - - - - APPLICATION_CLASS - MaterialForRecycling - - - en - material for recycling - - - - - en - This model depicts a material as seen by the recycler at the end of the lifecycle of a product. If a material consists of only one single component the name and class for the aspect are not used - - - urn:samm:io.catenax.material_for_recycling:1.1.0#MaterialForRecycling - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - material for recycling - - - - - en - MaterialForRecycling - - - - - en - This model depicts a material as seen by the recycler at the end of the lifecycle of a product. If a material consists of only one single component the name and class for the aspect are not used - - - - - - - - - materialName - urn:samm:io.catenax.material_for_recycling:1.1.0#materialName - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - materialName - - - - - en - materialName - - - STRING - - - en - The commercial name of a material - - - - - - - - - materialClass - urn:samm:io.catenax.material_for_recycling:1.1.0#materialClass - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - materialClass - - - - - en - materialClass - - - STRING - - - en - The class of a material following the referenced standard. - - - - - - - - - aggregateState - urn:samm:io.catenax.material_for_recycling:1.1.0#aggregateState - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - aggregateState - - - - - en - aggregateState - - - STRING - - - en - The aggregate state the materialis in at the timepoint the item is disassembled - - - - - - solid - - ModelReference - - - DataElement - urn:samm:io.catenax.material_for_recycling:1.1.0#AggregateState:solid - - - - - - liquid - - ModelReference - - - DataElement - urn:samm:io.catenax.material_for_recycling:1.1.0#AggregateState:liquid - - - - - - gasenous - - ModelReference - - - DataElement - urn:samm:io.catenax.material_for_recycling:1.1.0#AggregateState:gasenous - - - - - - - - - - - - - recycledContent - - - en - recycled content - - - urn:samm:io.catenax.material_for_recycling:1.1.0#recycledContent - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - recycled content - - - - - en - recycledContent - - - percent - REAL_MEASURE - - - en - Indicates if the material was is recycled. Percentage of how much of the material was recycled. This can be an aggregation regarding the materials below. - - - - - - - - - materialAbbreviation - urn:samm:io.catenax.material_for_recycling:1.1.0#materialAbbreviation - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - materialAbbreviation - - - - - en - materialAbbreviation - - - STRING - - - en - A short abbreviation of the materialName - - - - - - - - - materialClass - urn:samm:io.catenax.material_for_recycling:1.1.0#materialClass - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - materialClass - - - - - en - materialClass - - - STRING - - - en - The class of a material following the referenced standard. - - - - - - - - - materialName - urn:samm:io.catenax.material_for_recycling:1.1.0#materialName - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - materialName - - - - - en - materialName - - - STRING - - - en - The commercial name of a material - - - - - - - - - unit - urn:samm:io.catenax.material_for_recycling:1.1.0#unit - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - unit - - - - - en - unit - - - STRING - - - en - Unit of Measurement for the quantity of serialized objects. -The recommended units are the SI units such as unit:kilogram or additional unit:percent - - - - - - - - - value - - - en - value - - - urn:samm:io.catenax.material_for_recycling:1.1.0#value - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - value - - - - - en - value - - - REAL_MEASURE - - - en - Measurement value as a double. The unit is saved in the property measurementUnit - - - - - - - - - quantity - - - en - quantity - - - urn:samm:io.catenax.material_for_recycling:1.1.0#quantity - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - quantity - - - - - en - quantity - - - STRING - - - en - quantity of the material expressed in value and unit - - - - - - - - - component - - - en - component - - - urn:samm:io.catenax.material_for_recycling:1.1.0#component - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - component - - - - - en - component - - - STRING - - - en - Components the material consists of - - - - - - - - - recycledContent - - - en - recycled content - - - urn:samm:io.catenax.material_for_recycling:1.1.0#recycledContent - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - recycled content - - - - - en - recycledContent - - - REAL_MEASURE - - - en - Indicates if the material was is recycled. Percentage of how much of the material was recycled. This can be an aggregation regarding the materials below. - - - - - - - - - diff --git a/io.catenax.material_for_recycling/1.1.0/gen/MaterialForRecycling-schema.json b/io.catenax.material_for_recycling/1.1.0/gen/MaterialForRecycling-schema.json deleted file mode 100644 index 1ad4fe047..000000000 --- a/io.catenax.material_for_recycling/1.1.0/gen/MaterialForRecycling-schema.json +++ /dev/null @@ -1,107 +0,0 @@ -{ - "$schema" : "http://json-schema.org/draft-04/schema", - "description" : "This model depicts a material as seen by the recycler at the end of the lifecycle of a product. If a material consists of only one single component the name and class for the aspect are not used", - "type" : "object", - "components" : { - "schemas" : { - "urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text" : { - "type" : "string", - "description" : "Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc." - }, - "urn_bamm_io.catenax.material_for_recycling_1.1.0_MaterialClass" : { - "type" : "string", - "description" : "Class according to the refernced standard the material belongs to. The IMDS recommendations and the IMDS rules are exclusevily accessible within the IMDS portal to members of the IMDS association. In order to access the data one needs to be member of the association." - }, - "urn_bamm_io.catenax.material_for_recycling_1.1.0_AggregateState" : { - "type" : "string", - "enum" : [ "solid", "liquid", "gasenous" ] - }, - "urn_bamm_io.catenax.material_for_recycling_1.1.0_Percentage" : { - "type" : "number", - "description" : "Percentage of already recycled material contained." - }, - "urn_bamm_io.openmanufacturing_characteristic_2.0.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_bamm_io.catenax.material_for_recycling_1.1.0_Value" : { - "type" : "number", - "description" : "Quantifiable value as double in reference to the measurementUnit" - }, - "urn_bamm_io.catenax.material_for_recycling_1.1.0_QuantityCharacteristic" : { - "description" : "quantity characteristic for the material expressed in value and unit", - "type" : "object", - "properties" : { - "unit" : { - "description" : "Unit of Measurement for the quantity of serialized objects.\nThe recommended units are the SI units such as unit:kilogram or additional unit:percent", - "$ref" : "#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_UnitReference" - }, - "value" : { - "description" : "Measurement value as a double. The unit is saved in the property measurementUnit", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.material_for_recycling_1.1.0_Value" - } - }, - "required" : [ "unit", "value" ] - }, - "urn_bamm_io.catenax.material_for_recycling_1.1.0_ComponentEntity" : { - "description" : "The properties that describe a component", - "type" : "object", - "properties" : { - "aggregateState" : { - "description" : "The aggregate state the materialis in at the timepoint the item is disassembled", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.material_for_recycling_1.1.0_AggregateState" - }, - "recycledContent" : { - "description" : "Indicates if the material was is recycled. Percentage of how much of the material was recycled. This can be an aggregation regarding the materials below.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.material_for_recycling_1.1.0_Percentage" - }, - "materialAbbreviation" : { - "description" : "A short abbreviation of the materialName", - "$ref" : "#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text" - }, - "materialClass" : { - "description" : "The class of a material following the referenced standard.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.material_for_recycling_1.1.0_MaterialClass" - }, - "materialName" : { - "description" : "The commercial name of a material", - "$ref" : "#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text" - }, - "quantity" : { - "description" : "quantity of the material expressed in value and unit", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.material_for_recycling_1.1.0_QuantityCharacteristic" - } - }, - "required" : [ "materialClass", "materialName" ] - }, - "urn_bamm_io.catenax.material_for_recycling_1.1.0_ComponentCharacteristic" : { - "description" : "Describes the consistency", - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/urn_bamm_io.catenax.material_for_recycling_1.1.0_ComponentEntity" - }, - "uniqueItems" : true - } - } - }, - "properties" : { - "materialName" : { - "description" : "The commercial name of a material", - "$ref" : "#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text" - }, - "materialClass" : { - "description" : "The class of a material following the referenced standard.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.material_for_recycling_1.1.0_MaterialClass" - }, - "component" : { - "description" : "Components the material consists of", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.material_for_recycling_1.1.0_ComponentCharacteristic" - }, - "recycledContent" : { - "description" : "Indicates if the material was is recycled. Percentage of how much of the material was recycled. This can be an aggregation regarding the materials below.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.material_for_recycling_1.1.0_Percentage" - } - }, - "required" : [ "component" ] -} \ No newline at end of file diff --git a/io.catenax.material_for_recycling/1.1.0/gen/MaterialForRecycling.aasx b/io.catenax.material_for_recycling/1.1.0/gen/MaterialForRecycling.aasx deleted file mode 100644 index f9fa71452..000000000 Binary files a/io.catenax.material_for_recycling/1.1.0/gen/MaterialForRecycling.aasx and /dev/null differ diff --git a/io.catenax.material_for_recycling/1.1.0/gen/MaterialForRecycling.html b/io.catenax.material_for_recycling/1.1.0/gen/MaterialForRecycling.html deleted file mode 100644 index 812718b96..000000000 --- a/io.catenax.material_for_recycling/1.1.0/gen/MaterialForRecycling.html +++ /dev/null @@ -1,1077 +0,0 @@ - - - - - - - - - - - - - - Dokumentation material for recycling - - -
-
-
-
-

Aspect Model material for recycling

-
urn:bamm:io.catenax.material_for_recycling:1.1.0#MaterialForRecycling
-
-
-
-
-
-
-
- -
- - -
- This model depicts a material as seen by the recycler at the end of the lifecycle of a product. If a material consists of only one single component the name and class for the aspect are not used -
- - -
-

Übersicht

-
-
-
-
- Aspect Model Diagram -
-
-
- - -
-
-

Properties

-
- -
- -
-

component

-
- -Components the material consists of - -
-
Name
-
component
-
- - - -
-
Characteristic
-
-
-
-
Set
-
-
-
Has no order
-
-
-
Duplicates not allowed
-
-
-
- Typ urn:bamm:io.catenax.material_for_recycling:1.1.0#ComponentEntity - -
-
-
-
-
- - -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
component
-
- - -
-
- -
-

materialClass

-
- -The class of a material following the referenced standard. - -
-
Name
-
materialClass
-
- - - -
-
Characteristic
-
-
-
-
- Referenz -
-
    -
  • https://www.mdsystem.com/imdsnt/startpage/index.jsp
    • -
-
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Beispiel
-
plastic
-
- -
-
Optional
-
- Ja
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
materialClass
-
- - -
-
- -
-

materialName

-
- -The commercial name of a material - -
-
Name
-
materialName
-
- - - -
-
Characteristic
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Beispiel
-
Polyamid
-
- -
-
Optional
-
- Ja
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
materialName
-
- - -
-
- -
-

recycled content

-
- -Indicates if the material was is recycled. Percentage of how much of the material was recycled. This can be an aggregation regarding the materials below. - -
-
Name
-
recycledContent
-
- - - -
-
Characteristic
-
-
-
-
Quantifiable
-
-
-
Duration
-
-
-
Percentage of already recycled material contained.
-
-
-
Einheit
-
-
-
-
    -
  • - percent -
    • -
  • - Symbol % -
    • -
  • - Code P1 -
    • -
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#double - -
-
-
-
-
- - -
-
Optional
-
- Ja
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
recycledContent
-
- - -
-
- - - -
-
-

Objekt

-
- -
-
-

QuantityEntity

-
-
- Quantity of the material -
- -
-

Properties

-
-
- -
-
unit
-
- -Unit of Measurement for the quantity of serialized objects. -The recommended units are the SI units such as unit:kilogram or additional unit:percent - -
-
Name
-
unit
-
- - - -
-
Characteristic
-
-
-
-
- Typ urn:bamm:io.openmanufacturing:meta-model:2.0.0#curie - -
-
-
-
-
- -
-
Beispiel
-
kilogram
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
unit
-
- -
-
Referenz
-
-
    -
  • https://openmanufacturingplatform.github.io/sds-bamm-aspect-meta-model/bamm-specification/snapshot/appendix/unitcatalog.html
    • -
-
-
- -
-
- -
-
value
-
- -Measurement value as a double. The unit is saved in the property measurementUnit - -
-
Name
-
value
-
- - - -
-
Characteristic
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#double - -
-
-
-
-
- - -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
value
-
- - -
-
-
-
-

component entity

-
-
- The properties that describe a component -
- -
-

Properties

-
-
- -
-
aggregateState
-
- -The aggregate state the materialis in at the timepoint the item is disassembled - -
-
Name
-
aggregateState
-
- - - -
-
Characteristic
-
-
-
-
Enumeration
-
-
-
Werte
-
-
-
-
    -
  • solid
    • -
  • liquid
    • -
  • gasenous
    • -
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Beispiel
-
liquid
-
- -
-
Optional
-
- Ja
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
aggregateState
-
- - -
-
- -
-
recycled content
-
- -Indicates if the material was is recycled. Percentage of how much of the material was recycled. This can be an aggregation regarding the materials below. - -
-
Name
-
recycledContent
-
- - - -
-
Characteristic
-
-
-
-
Quantifiable
-
-
-
Duration
-
-
-
Percentage of already recycled material contained.
-
-
-
Einheit
-
-
-
-
    -
  • - percent -
    • -
  • - Symbol % -
    • -
  • - Code P1 -
    • -
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#double - -
-
-
-
-
- - -
-
Optional
-
- Ja
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
recycledContent
-
- - -
-
- -
-
materialAbbreviation
-
- -A short abbreviation of the materialName - -
-
Name
-
materialAbbreviation
-
- - - -
-
Characteristic
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Beispiel
-
PA66G40
-
- -
-
Optional
-
- Ja
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
materialAbbreviation
-
- - -
-
- -
-
materialClass
-
- -The class of a material following the referenced standard. - -
-
Name
-
materialClass
-
- - - -
-
Characteristic
-
-
-
-
- Referenz -
-
    -
  • https://www.mdsystem.com/imdsnt/startpage/index.jsp
    • -
-
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Beispiel
-
plastic
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
materialClass
-
- - -
-
- -
-
materialName
-
- -The commercial name of a material - -
-
Name
-
materialName
-
- - - -
-
Characteristic
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Beispiel
-
Polyamid
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
materialName
-
- - -
-
- -
-
quantity
-
- -quantity of the material expressed in value and unit - -
-
Name
-
quantity
-
- - - -
-
Characteristic
-
-
-
-
SingleEntity
-
-
-
- Typ urn:bamm:io.catenax.material_for_recycling:1.1.0#QuantityEntity - -
-
-
-
-
- - -
-
Optional
-
- Ja
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
quantity
-
- - -
-
-
- -
- Third party licenses - -
- -
- - -
- - - \ No newline at end of file diff --git a/io.catenax.material_for_recycling/1.1.0/gen/MaterialForRecycling.json b/io.catenax.material_for_recycling/1.1.0/gen/MaterialForRecycling.json deleted file mode 100644 index 0164b7843..000000000 --- a/io.catenax.material_for_recycling/1.1.0/gen/MaterialForRecycling.json +++ /dev/null @@ -1,16 +0,0 @@ -{ - "materialName" : "Polyamid", - "materialClass" : "plastic", - "component" : [ { - "aggregateState" : "solid", - "materialName" : "Polyamid", - "recycledContent" : -1.7976931348623157E308, - "materialClass" : "plastic", - "quantity" : { - "value" : -1.7976931348623157E308, - "unit" : "kilogram" - }, - "materialAbbreviation" : "PA66G40" - } ], - "recycledContent" : -1.7976931348623157E308 -} \ No newline at end of file diff --git a/io.catenax.material_for_recycling/1.1.0/gen/MaterialForRecycling.yml b/io.catenax.material_for_recycling/1.1.0/gen/MaterialForRecycling.yml deleted file mode 100644 index c02b84d35..000000000 --- a/io.catenax.material_for_recycling/1.1.0/gen/MaterialForRecycling.yml +++ /dev/null @@ -1,224 +0,0 @@ ---- -openapi: 3.0.3 -info: - title: material for recycling - version: v1 -servers: -- url: catenax.io/api/v1 - variables: - api-version: - default: v1 -paths: - /{tenant-id}/material-for-recycling: - get: - tags: - - MaterialForRecycling - operationId: getMaterialForRecycling - 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/MaterialForRecycling' - "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/MaterialForRecycling' - totalItems: - type: number - totalPages: - type: number - pageSize: - type: number - currentPage: - type: number - urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text: - type: string - description: "Describes a Property which contains plain text. This is intended\ - \ exclusively for human readable strings, not for identifiers, measurement\ - \ values, etc." - urn_bamm_io.catenax.material_for_recycling_1.1.0_MaterialClass: - type: string - description: Class according to the refernced standard the material belongs - to. The IMDS recommendations and the IMDS rules are exclusevily accessible - within the IMDS portal to members of the IMDS association. In order to access - the data one needs to be member of the association. - urn_bamm_io.catenax.material_for_recycling_1.1.0_AggregateState: - type: string - enum: - - solid - - liquid - - gasenous - urn_bamm_io.catenax.material_for_recycling_1.1.0_Percentage: - type: number - description: Percentage of already recycled material contained. - urn_bamm_io.openmanufacturing_characteristic_2.0.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_bamm_io.catenax.material_for_recycling_1.1.0_Value: - type: number - description: Quantifiable value as double in reference to the measurementUnit - urn_bamm_io.catenax.material_for_recycling_1.1.0_QuantityCharacteristic: - description: quantity characteristic for the material expressed in value and - unit - type: object - properties: - unit: - description: |- - Unit of Measurement for the quantity of serialized objects. - The recommended units are the SI units such as unit:kilogram or additional unit:percent - $ref: '#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_UnitReference' - value: - description: Measurement value as a double. The unit is saved in the property - measurementUnit - $ref: '#/components/schemas/urn_bamm_io.catenax.material_for_recycling_1.1.0_Value' - required: - - unit - - value - urn_bamm_io.catenax.material_for_recycling_1.1.0_ComponentEntity: - description: The properties that describe a component - type: object - properties: - aggregateState: - description: The aggregate state the materialis in at the timepoint the - item is disassembled - $ref: '#/components/schemas/urn_bamm_io.catenax.material_for_recycling_1.1.0_AggregateState' - recycledContent: - description: Indicates if the material was is recycled. Percentage of how - much of the material was recycled. This can be an aggregation regarding - the materials below. - $ref: '#/components/schemas/urn_bamm_io.catenax.material_for_recycling_1.1.0_Percentage' - materialAbbreviation: - description: A short abbreviation of the materialName - $ref: '#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text' - materialClass: - description: The class of a material following the referenced standard. - $ref: '#/components/schemas/urn_bamm_io.catenax.material_for_recycling_1.1.0_MaterialClass' - materialName: - description: The commercial name of a material - $ref: '#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text' - quantity: - description: quantity of the material expressed in value and unit - $ref: '#/components/schemas/urn_bamm_io.catenax.material_for_recycling_1.1.0_QuantityCharacteristic' - required: - - materialClass - - materialName - urn_bamm_io.catenax.material_for_recycling_1.1.0_ComponentCharacteristic: - description: Describes the consistency - type: array - items: - $ref: '#/components/schemas/urn_bamm_io.catenax.material_for_recycling_1.1.0_ComponentEntity' - uniqueItems: true - MaterialForRecycling: - description: This model depicts a material as seen by the recycler at the end - of the lifecycle of a product. If a material consists of only one single component - the name and class for the aspect are not used - type: object - properties: - materialName: - description: The commercial name of a material - $ref: '#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text' - materialClass: - description: The class of a material following the referenced standard. - $ref: '#/components/schemas/urn_bamm_io.catenax.material_for_recycling_1.1.0_MaterialClass' - component: - description: Components the material consists of - $ref: '#/components/schemas/urn_bamm_io.catenax.material_for_recycling_1.1.0_ComponentCharacteristic' - recycledContent: - description: Indicates if the material was is recycled. Percentage of how - much of the material was recycled. This can be an aggregation regarding - the materials below. - $ref: '#/components/schemas/urn_bamm_io.catenax.material_for_recycling_1.1.0_Percentage' - required: - - component - 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' - MaterialForRecycling: - content: - application/json: - schema: - $ref: '#/components/schemas/PagingSchema' - description: The request was successful. - requestBodies: - MaterialForRecycling: - content: - application/json: - schema: - $ref: '#/components/schemas/MaterialForRecycling' diff --git a/io.catenax.material_for_recycling/1.1.0/metadata.json b/io.catenax.material_for_recycling/1.1.0/metadata.json deleted file mode 100644 index 9e759dfb1..000000000 --- a/io.catenax.material_for_recycling/1.1.0/metadata.json +++ /dev/null @@ -1 +0,0 @@ -{ "status" : "deprecate"} diff --git a/io.catenax.part_as_planned/1.0.0/PartAsPlanned.ttl b/io.catenax.part_as_planned/1.0.0/PartAsPlanned.ttl deleted file mode 100644 index 9cf6ad71c..000000000 --- a/io.catenax.part_as_planned/1.0.0/PartAsPlanned.ttl +++ /dev/null @@ -1,147 +0,0 @@ -####################################################################### -# Copyright (c) 2022 BASF SE -# Copyright (c) 2022 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) -# Copyright (c) 2022 Fraunhofer-Gesellschaft zur Foerderung der angewandten Forschung e.V. (represented by Fraunhofer ISST & Fraunhofer IML) -# Copyright (c) 2022 German Edge Cloud GmbH & Co. KG -# Copyright (c) 2022 Henkel AG & Co. KGaA -# Copyright (c) 2022 Mercedes Benz AG -# Copyright (c) 2022 Robert Bosch Manufacturing Solutions GmbH -# Copyright (c) 2022 SAP SE -# Copyright (c) 2022 Siemens AG -# Copyright (c) 2022 T-Systems International GmbH -# Copyright (c) 2022 ZF Friedrichshafen AG -# Copyright (c) 2022 Contributors to the Eclipse Foundation -# -# 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 xsd: . -@prefix bamm: . -@prefix unit: . -@prefix bamm-c: . -@prefix bamm-e: . -@prefix : . - -:UUIDv4RegularExpression a bamm-c:RegularExpressionConstraint; - bamm:name "UUIDv4RegularExpression"; - bamm:preferredName "Catena-X Id Regular Expression"@en; - bamm: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)."@en; - bamm:value "^[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}$". -:UUIDv4 a bamm:Characteristic; - bamm:name "UUIDv4"; - bamm:preferredName "UUIDv4"@en; - bamm:description "A version 4 UUID is a universally unique identifier that is generated using random 32 hexadecimal characters."@en; - bamm:dataType xsd:string. -:catenaXId a bamm:Property; - bamm:name "catenaXId"; - bamm:preferredName "Catena-X Identifier"@en; - bamm:description "The fully anonymous Catena-X ID of the serialized part, valid for the Catena-X dataspace."@en; - bamm:characteristic :CatenaXIdTrait; - bamm:exampleValue "580d3adf-1981-44a0-a214-13d6ceed9379". -:CatenaXIdTrait a bamm-c:Trait; - bamm:name "CatenaXIdTrait"; - bamm:preferredName "Catena-X ID Trait"@en; - bamm:description "Trait to ensure data format for Catena-X ID"@en; - bamm-c:constraint :UUIDv4RegularExpression; - bamm-c:baseCharacteristic :UUIDv4. -:partTypeInformation a bamm:Property; - bamm:name "partTypeInformation"; - bamm:preferredName "Part Type Information"@en; - bamm:description "The part type from which the serialized part has been instantiated"@en; - bamm:characteristic :PartTypeInformationCharacteristic. -:PartTypeInformationCharacteristic a bamm:Characteristic; - bamm:name "PartTypeInformationCharacteristic"; - bamm:preferredName "Part Type Information Characteristic"@en; - bamm:description "The characteristics of the part type"@en; - bamm:dataType :PartTypeInformationEntity. -:PartTypeInformationEntity a bamm:Entity; - bamm:name "PartTypeInformationEntity"; - bamm:preferredName "Part Type Information Entity"@en; - bamm:description "Encapsulation for data related to the part type"@en; - bamm:properties (:manufacturerPartId :nameAtManufacturer :classification). -:manufacturerPartId a bamm:Property; - bamm:name "manufacturerPartId"; - bamm:preferredName "Manufacturer Part ID"@en; - bamm:description "Part ID as assigned by the manufacturer of the part. The Part ID identifies the part (as designed) in the manufacturer`s dataspace. The Part ID does not reference a specific instance of a part and thus should not be confused with the serial number."@en; - bamm:characteristic :PartIdCharacteristic; - bamm:exampleValue "123-0.740-3434-A". -:nameAtManufacturer a bamm:Property; - bamm:name "nameAtManufacturer"; - bamm:preferredName "Name at Manufacturer"@en; - bamm:description "Name of the part as assigned by the manufacturer"@en; - bamm:characteristic :PartNameCharacteristic; - bamm:exampleValue "Mirror left". -:classification a bamm:Property; - bamm:name "classification"; - bamm:preferredName "Classifcation"@en; - bamm:description "The classification of the part type according to STEP standard definition"@en; - bamm:characteristic :ClassificationCharacteristic; - bamm:exampleValue "software". -:PartIdCharacteristic a bamm:Characteristic; - bamm:name "PartIdCharacteristic"; - bamm:preferredName "Part ID Characteristic"@en; - bamm:description "The part ID is a multi-character string, ususally assigned by an ERP system"@en; - bamm:dataType xsd:string. -:PartNameCharacteristic a bamm:Characteristic; - bamm:name "PartNameCharacteristic"; - bamm:preferredName "Part Name Characteristic"@en; - bamm:description "Part Name in string format from the respective system in the value chain"@en; - bamm:dataType xsd:string. -:ClassificationCharacteristic a bamm-c:Enumeration; - bamm:name "ClassificationCharacteristic"; - bamm:preferredName "Classification Characteristic"@en; - bamm:description "A part type must be placed into one of the following classes: 'component', 'product', 'software', ‘assembly’, 'tool', or 'raw material'."@en; - bamm:dataType xsd:string; - bamm:see ; - bamm-c:values ("product" "raw material" "software" "assembly" "tool" "component"). -:PartAsPlanned a bamm:Aspect; - bamm:name "PartAsPlanned"; - bamm:preferredName "Part AsPlanned"@en; - bamm:description "A Part AsPlanned represents an item in the Catena-X Bill of Material (BOM) in As-Planned lifecycle status. "@en; - bamm:properties (:catenaXId :partTypeInformation [ - bamm:property :validityPeriod; - bamm:optional "true"^^xsd:boolean -]); - bamm:operations (). -:validityPeriod a bamm:Property; - bamm:name "validityPeriod"; - bamm:preferredName "Validity Period"@en; - bamm:description "The period of time during which the Part is offered by the manufacturer and can be purchased by customers."@en; - bamm:characteristic :ValidityPeriodCharacteristic. -:ValidityPeriodCharacteristic a bamm:Characteristic; - bamm:name "ValidityPeriodCharacteristic"; - bamm:preferredName "Validity Period Characteristic"@en; - bamm:description "ValidityPeriodCharacteristic"@en; - bamm:dataType :ValidityPeriodEntity. -:ValidityPeriodEntity a bamm:Entity; - bamm:name "ValidityPeriodEntity"; - bamm:preferredName "ValidityPeriodEntity"@en; - bamm:properties ([ - bamm:property :validFrom; - bamm:optional "true"^^xsd:boolean -] [ - bamm:property :validTo; - bamm:optional "true"^^xsd:boolean -]). -:validFrom a bamm:Property; - bamm:name "validFrom"; - bamm:preferredName "Valid From"@en; - bamm:description "Start date of validity period"@en; - bamm:characteristic :Timestamp. -:validTo a bamm:Property; - bamm:name "validTo"; - bamm:preferredName "Valid To"@en; - bamm:description "End date of validity period"@en; - bamm:characteristic :Timestamp. -:Timestamp a bamm:Characteristic; - bamm:name "Timestamp"; - bamm:description "Describes a Property which contains the date and time with an optional timezone."@en; - bamm:dataType xsd:dateTime. diff --git a/io.catenax.part_as_planned/1.0.0/gen/PartAsPlanned-aas.xml b/io.catenax.part_as_planned/1.0.0/gen/PartAsPlanned-aas.xml deleted file mode 100644 index e720615d7..000000000 --- a/io.catenax.part_as_planned/1.0.0/gen/PartAsPlanned-aas.xml +++ /dev/null @@ -1,701 +0,0 @@ - - - - - defaultAdminShell - - - en - defaultAdminShell - - - - urn:samm:io.catenax.part_as_planned:1.0.0#PartAsPlanned - - Type - - - - ModelReference - - - Submodel - urn:samm:io.catenax.part_as_planned:1.0.0#PartAsPlanned/submodel - - - - - - - - - PartAsPlanned - - - en - A Part AsPlanned represents an item in the Catena-X Bill of Material (BOM) in As-Planned lifecycle status. - - - - urn:samm:io.catenax.part_as_planned:1.0.0#PartAsPlanned/submodel - Template - - ModelReference - - - ConceptDescription - urn:samm:io.catenax.part_as_planned:1.0.0#PartAsPlanned - - - - - - catenaXId - - - en - Catena-X Identifier - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.part_as_planned:1.0.0#catenaXId - - - - xs:string - - - - PartTypeInformationEntity - - - en - Part Type Information Entity - - - - - en - Encapsulation for data related to the part type - - - - - manufacturerPartId - - - en - Manufacturer Part ID - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.part_as_planned:1.0.0#manufacturerPartId - - - - xs:string - - - - nameAtManufacturer - - - en - Name at Manufacturer - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.part_as_planned:1.0.0#nameAtManufacturer - - - - xs:string - - - - classification - - - en - Classifcation - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.part_as_planned:1.0.0#classification - - - - xs:string - - - - - - ValidityPeriodEntity - - - en - ValidityPeriodEntity - - - - - validFrom - - - en - Valid From - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.part_as_planned:1.0.0#validFrom - - - - xs:dateTime - - - - validTo - - - en - Valid To - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.part_as_planned:1.0.0#validTo - - - - xs:dateTime - - - - - - - - - - APPLICATION_CLASS - PartAsPlanned - - - en - Part AsPlanned - - - - - en - A Part AsPlanned represents an item in the Catena-X Bill of Material (BOM) in As-Planned lifecycle status. - - - urn:samm:io.catenax.part_as_planned:1.0.0#PartAsPlanned - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Part AsPlanned - - - - - en - PartAsPlanned - - - - - en - A Part AsPlanned represents an item in the Catena-X Bill of Material (BOM) in As-Planned lifecycle status. - - - - - - - - - catenaXId - - - en - Catena-X Identifier - - - urn:samm:io.catenax.part_as_planned:1.0.0#catenaXId - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Catena-X Identifier - - - - - en - catenaXId - - - STRING - - - en - The fully anonymous Catena-X ID of the serialized part, valid for the Catena-X dataspace. - - - - - - - - - manufacturerPartId - - - en - Manufacturer Part ID - - - urn:samm:io.catenax.part_as_planned:1.0.0#manufacturerPartId - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Manufacturer Part ID - - - - - en - manufacturerPartId - - - STRING - - - en - Part ID as assigned by the manufacturer of the part. The Part ID identifies the part (as designed) in the manufacturer`s dataspace. The Part ID does not reference a specific instance of a part and thus should not be confused with the serial number. - - - - - - - - - nameAtManufacturer - - - en - Name at Manufacturer - - - urn:samm:io.catenax.part_as_planned:1.0.0#nameAtManufacturer - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Name at Manufacturer - - - - - en - nameAtManufacturer - - - STRING - - - en - Name of the part as assigned by the manufacturer - - - - - - - - - classification - - - en - Classifcation - - - urn:samm:io.catenax.part_as_planned:1.0.0#classification - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Classifcation - - - - - en - classification - - - STRING - - - en - The classification of the part type according to STEP standard definition - - - - - - product - - ModelReference - - - DataElement - urn:samm:io.catenax.part_as_planned:1.0.0#ClassificationCharacteristic:product - - - - - - raw material - - ModelReference - - - DataElement - urn:samm:io.catenax.part_as_planned:1.0.0#ClassificationCharacteristic:raw material - - - - - - software - - ModelReference - - - DataElement - urn:samm:io.catenax.part_as_planned:1.0.0#ClassificationCharacteristic:software - - - - - - assembly - - ModelReference - - - DataElement - urn:samm:io.catenax.part_as_planned:1.0.0#ClassificationCharacteristic:assembly - - - - - - tool - - ModelReference - - - DataElement - urn:samm:io.catenax.part_as_planned:1.0.0#ClassificationCharacteristic:tool - - - - - - component - - ModelReference - - - DataElement - urn:samm:io.catenax.part_as_planned:1.0.0#ClassificationCharacteristic:component - - - - - - - - - - - - - partTypeInformation - - - en - Part Type Information - - - urn:samm:io.catenax.part_as_planned:1.0.0#partTypeInformation - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Part Type Information - - - - - en - partTypeInformation - - - STRING - - - en - The part type from which the serialized part has been instantiated - - - - - - - - - validFrom - - - en - Valid From - - - urn:samm:io.catenax.part_as_planned:1.0.0#validFrom - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Valid From - - - - - en - validFrom - - - STRING - - - en - Start date of validity period - - - - - - - - - validTo - - - en - Valid To - - - urn:samm:io.catenax.part_as_planned:1.0.0#validTo - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Valid To - - - - - en - validTo - - - STRING - - - en - End date of validity period - - - - - - - - - validityPeriod - - - en - Validity Period - - - urn:samm:io.catenax.part_as_planned:1.0.0#validityPeriod - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Validity Period - - - - - en - validityPeriod - - - STRING - - - en - The period of time during which the Part is offered by the manufacturer and can be purchased by customers. - - - - - - - - - diff --git a/io.catenax.part_as_planned/1.0.0/gen/PartAsPlanned-schema.json b/io.catenax.part_as_planned/1.0.0/gen/PartAsPlanned-schema.json deleted file mode 100644 index f23b7aa65..000000000 --- a/io.catenax.part_as_planned/1.0.0/gen/PartAsPlanned-schema.json +++ /dev/null @@ -1,80 +0,0 @@ -{ - "$schema" : "http://json-schema.org/draft-04/schema", - "description" : "A Part AsPlanned represents an item in the Catena-X Bill of Material (BOM) in As-Planned lifecycle status. ", - "type" : "object", - "components" : { - "schemas" : { - "urn_bamm_io.catenax.part_as_planned_1.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).", - "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_bamm_io.catenax.part_as_planned_1.0.0_PartIdCharacteristic" : { - "type" : "string", - "description" : "The part ID is a multi-character string, ususally assigned by an ERP system" - }, - "urn_bamm_io.catenax.part_as_planned_1.0.0_PartNameCharacteristic" : { - "type" : "string", - "description" : "Part Name in string format from the respective system in the value chain" - }, - "urn_bamm_io.catenax.part_as_planned_1.0.0_ClassificationCharacteristic" : { - "type" : "string", - "description" : "A part type must be placed into one of the following classes: 'component', 'product', 'software', ‘assembly’, 'tool', or 'raw material'.", - "enum" : [ "product", "raw material", "software", "assembly", "tool", "component" ] - }, - "urn_bamm_io.catenax.part_as_planned_1.0.0_PartTypeInformationCharacteristic" : { - "description" : "The characteristics of the part type", - "type" : "object", - "properties" : { - "manufacturerPartId" : { - "description" : "Part ID as assigned by the manufacturer of the part. The Part ID identifies the part (as designed) in the manufacturer`s dataspace. The Part ID does not reference a specific instance of a part and thus should not be confused with the serial number.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.part_as_planned_1.0.0_PartIdCharacteristic" - }, - "nameAtManufacturer" : { - "description" : "Name of the part as assigned by the manufacturer", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.part_as_planned_1.0.0_PartNameCharacteristic" - }, - "classification" : { - "description" : "The classification of the part type according to STEP standard definition", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.part_as_planned_1.0.0_ClassificationCharacteristic" - } - }, - "required" : [ "manufacturerPartId", "nameAtManufacturer", "classification" ] - }, - "urn_bamm_io.catenax.part_as_planned_1.0.0_Timestamp" : { - "type" : "string", - "pattern" : "-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T(([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](\\.[0-9]+)?|(24:00:00(\\.0+)?))(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?", - "description" : "Describes a Property which contains the date and time with an optional timezone." - }, - "urn_bamm_io.catenax.part_as_planned_1.0.0_ValidityPeriodCharacteristic" : { - "type" : "object", - "properties" : { - "validFrom" : { - "description" : "Start date of validity period", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.part_as_planned_1.0.0_Timestamp" - }, - "validTo" : { - "description" : "End date of validity period", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.part_as_planned_1.0.0_Timestamp" - } - }, - "description" : "ValidityPeriodCharacteristic" - } - } - }, - "properties" : { - "catenaXId" : { - "description" : "The fully anonymous Catena-X ID of the serialized part, valid for the Catena-X dataspace.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.part_as_planned_1.0.0_CatenaXIdTrait" - }, - "partTypeInformation" : { - "description" : "The part type from which the serialized part has been instantiated", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.part_as_planned_1.0.0_PartTypeInformationCharacteristic" - }, - "validityPeriod" : { - "description" : "The period of time during which the Part is offered by the manufacturer and can be purchased by customers.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.part_as_planned_1.0.0_ValidityPeriodCharacteristic" - } - }, - "required" : [ "catenaXId", "partTypeInformation" ] -} \ No newline at end of file diff --git a/io.catenax.part_as_planned/1.0.0/gen/PartAsPlanned.aasx b/io.catenax.part_as_planned/1.0.0/gen/PartAsPlanned.aasx deleted file mode 100644 index 03f80733d..000000000 Binary files a/io.catenax.part_as_planned/1.0.0/gen/PartAsPlanned.aasx and /dev/null differ diff --git a/io.catenax.part_as_planned/1.0.0/gen/PartAsPlanned.html b/io.catenax.part_as_planned/1.0.0/gen/PartAsPlanned.html deleted file mode 100644 index 176893740..000000000 --- a/io.catenax.part_as_planned/1.0.0/gen/PartAsPlanned.html +++ /dev/null @@ -1,818 +0,0 @@ - - - - - - - - - - - - - - Dokumentation Part AsPlanned - - -
-
-
-
-

Aspect Model Part AsPlanned

-
urn:bamm:io.catenax.part_as_planned:1.0.0#PartAsPlanned
-
-
-
-
-
-
-
- -
- - -
- A Part AsPlanned represents an item in the Catena-X Bill of Material (BOM) in As-Planned lifecycle status. -
- - -
-

Übersicht

-
-
-
-
- Aspect Model Diagram -
-
-
- - -
-
-

Properties

-
- -
- -
-

Catena-X Identifier

-
- -The fully anonymous Catena-X ID of the serialized part, valid for the Catena-X dataspace. - -
-
Name
-
catenaXId
-
- - - -
-
Characteristic
-
-
-
-
Trait
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Beispiel
-
580d3adf-1981-44a0-a214-13d6ceed9379
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
catenaXId
-
- - -
-
Bedingungen
-
-
    -
  • -
    - -
    - Catena-X Id Regular Expression -
    - -
    -
    Beschreibung
    -
    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).
    -
    - - -
    -
    Regulärer Ausdruck
    -
    ^[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}$
    -
    - -
    • -
-
-
-
-
- -
-

Part Type Information

-
- -The part type from which the serialized part has been instantiated - -
-
Name
-
partTypeInformation
-
- - - -
-
Characteristic
-
-
-
-
SingleEntity
-
-
-
- Typ urn:bamm:io.catenax.part_as_planned:1.0.0#PartTypeInformationEntity - -
-
-
-
-
- - -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
partTypeInformation
-
- - -
-
- -
-

Validity Period

-
- -The period of time during which the Part is offered by the manufacturer and can be purchased by customers. - -
-
Name
-
validityPeriod
-
- - - -
-
Characteristic
-
-
-
-
SingleEntity
-
-
-
- Typ urn:bamm:io.catenax.part_as_planned:1.0.0#ValidityPeriodEntity - -
-
-
-
-
- - -
-
Optional
-
- Ja
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
validityPeriod
-
- - -
-
- - - -
-
-

Objekt

-
- -
-
-

Part Type Information Entity

-
-
- Encapsulation for data related to the part type -
- -
-

Properties

-
-
- -
-
Manufacturer Part ID
-
- -Part ID as assigned by the manufacturer of the part. The Part ID identifies the part (as designed) in the manufacturer`s dataspace. The Part ID does not reference a specific instance of a part and thus should not be confused with the serial number. - -
-
Name
-
manufacturerPartId
-
- - - -
-
Characteristic
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Beispiel
-
123-0.740-3434-A
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
manufacturerPartId
-
- - -
-
- -
-
Name at Manufacturer
-
- -Name of the part as assigned by the manufacturer - -
-
Name
-
nameAtManufacturer
-
- - - -
-
Characteristic
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Beispiel
-
Mirror left
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
nameAtManufacturer
-
- - -
-
- -
-
Classifcation
-
- -The classification of the part type according to STEP standard definition - -
-
Name
-
classification
-
- - - -
-
Characteristic
-
-
-
-
Enumeration
-
-
-
Werte
-
-
-
-
    -
  • product
    • -
  • raw material
    • -
  • software
    • -
  • assembly
    • -
  • tool
    • -
  • component
    • -
-
-
-
-
- Referenz -
-
    -
  • http://private.pdm-if.org/web/pdm-if/recommended-practices1
    • -
-
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Beispiel
-
software
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
classification
-
- - -
-
-
-
-

ValidityPeriodEntity

-
-
- -
- -
-

Properties

-
-
- -
-
Valid From
-
- -Start date of validity period - -
-
Name
-
validFrom
-
- - - -
-
Characteristic
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#dateTime - -
-
-
-
-
- - -
-
Optional
-
- Ja
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
validFrom
-
- - -
-
- -
-
Valid To
-
- -End date of validity period - -
-
Name
-
validTo
-
- - - -
-
Characteristic
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#dateTime - -
-
-
-
-
- - -
-
Optional
-
- Ja
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
validTo
-
- - -
-
-
- -
- Third party licenses - -
- -
- - -
- - - \ No newline at end of file diff --git a/io.catenax.part_as_planned/1.0.0/gen/PartAsPlanned.json b/io.catenax.part_as_planned/1.0.0/gen/PartAsPlanned.json deleted file mode 100644 index 2fe4e5f38..000000000 --- a/io.catenax.part_as_planned/1.0.0/gen/PartAsPlanned.json +++ /dev/null @@ -1,12 +0,0 @@ -{ - "partTypeInformation" : { - "classification" : "product", - "manufacturerPartId" : "123-0.740-3434-A", - "nameAtManufacturer" : "Mirror left" - }, - "validityPeriod" : { - "validFrom" : "2023-03-14T17:11:48.148+01:00", - "validTo" : "2023-03-14T17:11:48.148+01:00" - }, - "catenaXId" : "580d3adf-1981-44a0-a214-13d6ceed9379" -} \ No newline at end of file diff --git a/io.catenax.part_as_planned/1.0.0/gen/PartAsPlanned.yml b/io.catenax.part_as_planned/1.0.0/gen/PartAsPlanned.yml deleted file mode 100644 index 4f2803e21..000000000 --- a/io.catenax.part_as_planned/1.0.0/gen/PartAsPlanned.yml +++ /dev/null @@ -1,171 +0,0 @@ ---- -openapi: 3.0.3 -info: - title: Part AsPlanned - version: v1 -servers: -- url: catenax.io/api/v1 - variables: - api-version: - default: v1 -paths: - /{tenant-id}/part-as-planned: - get: - tags: - - PartAsPlanned - operationId: getPartAsPlanned - 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/PartAsPlanned' - "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_bamm_io.catenax.part_as_planned_1.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)." - 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_bamm_io.catenax.part_as_planned_1.0.0_PartIdCharacteristic: - type: string - description: "The part ID is a multi-character string, ususally assigned by\ - \ an ERP system" - urn_bamm_io.catenax.part_as_planned_1.0.0_PartNameCharacteristic: - type: string - description: Part Name in string format from the respective system in the value - chain - urn_bamm_io.catenax.part_as_planned_1.0.0_ClassificationCharacteristic: - type: string - description: "A part type must be placed into one of the following classes:\ - \ 'component', 'product', 'software', ‘assembly’, 'tool', or 'raw material'." - enum: - - product - - raw material - - software - - assembly - - tool - - component - urn_bamm_io.catenax.part_as_planned_1.0.0_PartTypeInformationCharacteristic: - description: The characteristics of the part type - type: object - properties: - manufacturerPartId: - description: Part ID as assigned by the manufacturer of the part. The Part - ID identifies the part (as designed) in the manufacturer`s dataspace. - The Part ID does not reference a specific instance of a part and thus - should not be confused with the serial number. - $ref: '#/components/schemas/urn_bamm_io.catenax.part_as_planned_1.0.0_PartIdCharacteristic' - nameAtManufacturer: - description: Name of the part as assigned by the manufacturer - $ref: '#/components/schemas/urn_bamm_io.catenax.part_as_planned_1.0.0_PartNameCharacteristic' - classification: - description: The classification of the part type according to STEP standard - definition - $ref: '#/components/schemas/urn_bamm_io.catenax.part_as_planned_1.0.0_ClassificationCharacteristic' - required: - - manufacturerPartId - - nameAtManufacturer - - classification - urn_bamm_io.catenax.part_as_planned_1.0.0_Timestamp: - type: string - pattern: "-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T(([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](\\\ - .[0-9]+)?|(24:00:00(\\.0+)?))(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?" - description: Describes a Property which contains the date and time with an optional - timezone. - urn_bamm_io.catenax.part_as_planned_1.0.0_ValidityPeriodCharacteristic: - type: object - properties: - validFrom: - description: Start date of validity period - $ref: '#/components/schemas/urn_bamm_io.catenax.part_as_planned_1.0.0_Timestamp' - validTo: - description: End date of validity period - $ref: '#/components/schemas/urn_bamm_io.catenax.part_as_planned_1.0.0_Timestamp' - description: ValidityPeriodCharacteristic - PartAsPlanned: - description: 'A Part AsPlanned represents an item in the Catena-X Bill of Material - (BOM) in As-Planned lifecycle status. ' - type: object - properties: - catenaXId: - description: "The fully anonymous Catena-X ID of the serialized part, valid\ - \ for the Catena-X dataspace." - $ref: '#/components/schemas/urn_bamm_io.catenax.part_as_planned_1.0.0_CatenaXIdTrait' - partTypeInformation: - description: The part type from which the serialized part has been instantiated - $ref: '#/components/schemas/urn_bamm_io.catenax.part_as_planned_1.0.0_PartTypeInformationCharacteristic' - validityPeriod: - description: The period of time during which the Part is offered by the - manufacturer and can be purchased by customers. - $ref: '#/components/schemas/urn_bamm_io.catenax.part_as_planned_1.0.0_ValidityPeriodCharacteristic' - required: - - catenaXId - - partTypeInformation - 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' - PartAsPlanned: - content: - application/json: - schema: - $ref: '#/components/schemas/PartAsPlanned' - description: The request was successful. - requestBodies: - PartAsPlanned: - content: - application/json: - schema: - $ref: '#/components/schemas/PartAsPlanned' diff --git a/io.catenax.part_as_planned/1.0.0/metadata.json b/io.catenax.part_as_planned/1.0.0/metadata.json deleted file mode 100644 index bf40b864e..000000000 --- a/io.catenax.part_as_planned/1.0.0/metadata.json +++ /dev/null @@ -1 +0,0 @@ -{ "status" : "deprecate"} diff --git a/io.catenax.part_as_planned/1.0.1/PartAsPlanned.ttl b/io.catenax.part_as_planned/1.0.1/PartAsPlanned.ttl deleted file mode 100644 index 453657024..000000000 --- a/io.catenax.part_as_planned/1.0.1/PartAsPlanned.ttl +++ /dev/null @@ -1,139 +0,0 @@ -####################################################################### -# Copyright (c) 2023 BASF SE -# Copyright (c) 2023 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) -# Copyright (c) 2023 Fraunhofer-Gesellschaft zur Foerderung der angewandten Forschung e.V. (represented by Fraunhofer ISST & Fraunhofer IML) -# Copyright (c) 2023 German Edge Cloud GmbH & Co. KG -# Copyright (c) 2023 Henkel AG & Co. KGaA -# Copyright (c) 2023 Mercedes Benz AG -# Copyright (c) 2023 Robert Bosch Manufacturing Solutions GmbH -# Copyright (c) 2023 SAP SE -# Copyright (c) 2023 Siemens AG -# Copyright (c) 2023 T-Systems International GmbH -# Copyright (c) 2023 ZF Friedrichshafen AG -# Copyright (c) 2023 Contributors to the Eclipse Foundation -# -# 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 bamm: . -@prefix bamm-c: . -@prefix bamm-e: . -@prefix unit: . -@prefix rdf: . -@prefix rdfs: . -@prefix xsd: . -@prefix : . - -@prefix bamm: . -@prefix bamm-c: . -@prefix bamm-e: . -@prefix unit: . -@prefix rdf: . -@prefix rdfs: . -@prefix xsd: . -@prefix : . - -:PartAsPlanned a bamm:Aspect; - bamm:preferredName "Part as Planned"@en; - bamm:description "A Part as Planned represents an item in the Catena-X Bill of Material (BOM) in As-Planned lifecycle status in a specific version. "@en; - bamm:properties (:catenaXId :partTypeInformation [ - bamm:property :validityPeriod; - bamm:optional "true"^^xsd:boolean -]); - bamm:operations (); - bamm:events (). -:catenaXId a bamm:Property; - bamm:preferredName "Catena-X ID"@en; - bamm:description "The fully anonymous Catena-X ID of the serialized part, valid for the Catena-X dataspace."@en; - bamm:characteristic :CatenaXIdTrait; - bamm:exampleValue "580d3adf-1981-44a0-a214-13d6ceed9379". -:partTypeInformation a bamm:Property; - bamm:preferredName "Part Type Information"@en; - bamm:description "The part type from which the serialized part has been instantiated"@en; - bamm:characteristic :PartTypeInformationCharacteristic. -:validityPeriod a bamm:Property; - bamm:preferredName "Validity Period"@en; - bamm:description "The period of time during which the Part is offered by the manufacturer and can be purchased by customers."@en; - bamm:characteristic :ValidityPeriodCharacteristic. -:CatenaXIdTrait a bamm-c:Trait; - bamm:preferredName "Catena-X ID Trait"@en; - bamm:description "Trait to ensure data format for Catena-X ID"@en; - bamm-c:baseCharacteristic :Uuidv4Characteristic; - bamm-c:constraint :Uuidv4RegularExpression. -:PartTypeInformationCharacteristic a bamm:Characteristic; - bamm:preferredName "Part Type Information Characteristic"@en; - bamm:description "The characteristics of the part type"@en; - bamm:dataType :PartTypeInformationEntity. -:ValidityPeriodCharacteristic a bamm:Characteristic; - bamm:preferredName "Validity Period Characteristic"@en; - bamm:description "Characteristic to define a continuous validity period."@en; - bamm:dataType :ValidityPeriodEntity. -:PartTypeInformationEntity a bamm:Entity; - bamm:preferredName "Part Type Information Entity"@en; - bamm:description "Encapsulation for data related to the part type"@en; - bamm:properties (:manufacturerPartId :nameAtManufacturer :classification). -:ValidityPeriodEntity a bamm:Entity; - bamm:preferredName "Validity Period Entity"@en; - bamm:description "Defines a continuous validity period."@en; - bamm:properties ([ - bamm:property :validFrom; - bamm:optional "true"^^xsd:boolean -] [ - bamm:property :validTo; - bamm:optional "true"^^xsd:boolean -]). -:manufacturerPartId a bamm:Property; - bamm:preferredName "Manufacturer Part ID"@en; - bamm:description "Part ID as assigned by the manufacturer of the part. The Part ID identifies the part in the manufacturer`s dataspace. The Part ID references a specific version of a part. The version number must be included in the Part ID if it is available.\n\nThe Part ID does not reference a specific instance of a part and must not be confused with the serial number."@en; - bamm:characteristic :PartIdCharacteristic; - bamm:exampleValue "123-0.740-3434-A". -:nameAtManufacturer a bamm:Property; - bamm:preferredName "Name at manufacturer"@en; - bamm:description "Name of the part as assigned by the manufacturer"@en; - bamm:characteristic :PartNameCharacteristic; - bamm:exampleValue "Mirror left". -:classification a bamm:Property; - bamm:preferredName "Classifcation"@en; - bamm:description "The classification of the part type according to STEP standard definition"@en; - bamm:characteristic :ClassificationEnumerationCharacteristic; - bamm:exampleValue "software". -:validFrom a bamm:Property; - bamm:preferredName "Valid from"@en; - bamm:description "Start date of validity period"@en; - bamm:characteristic bamm-c:Timestamp; - bamm:exampleValue "2023-03-06T14:50:23.230+01:00"^^xsd:dateTime. -:validTo a bamm:Property; - bamm:preferredName "Valid to"@en; - bamm:description "End date of validity period"@en; - bamm:characteristic bamm-c:Timestamp; - bamm:exampleValue "2023-08-06T14:50:23.230+01:00"^^xsd:dateTime. -:PartIdCharacteristic a bamm:Characteristic; - bamm:preferredName "Part ID Characteristic"@en; - bamm:description "The part ID is a multi-character string, ususally assigned by an ERP system"@en; - bamm:dataType xsd:string. -:PartNameCharacteristic a bamm:Characteristic; - bamm:preferredName "Part Name Characteristic"@en; - bamm:description "Part Name in string format from the respective system in the value chain"@en; - bamm:dataType xsd:string. -:Uuidv4Characteristic a bamm:Characteristic; - bamm:preferredName "UUIDv4"@en; - bamm:description "A version 4 UUID is a universally unique identifier that is generated using random 32 hexadecimal characters."@en; - bamm:dataType xsd:string. -:Uuidv4RegularExpression a bamm-c:RegularExpressionConstraint; - bamm:preferredName "Catena-X ID Regular Expression"@en; - bamm: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)."@en; - bamm:value "(^[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}$)". -:ClassificationEnumerationCharacteristic a bamm-c:Enumeration; - bamm:preferredName "Classification Enumeration Characteristic"@en; - bamm:description "A part type must be placed into one of the following classes: 'component', 'product', 'software', ‘assembly’, 'tool', or 'raw material'."@en; - bamm:dataType xsd:string; - bamm:see ; - bamm-c:values ("product" "raw material" "software" "assembly" "tool" "component"). diff --git a/io.catenax.part_as_planned/1.0.1/gen/PartAsPlanned-aas.xml b/io.catenax.part_as_planned/1.0.1/gen/PartAsPlanned-aas.xml deleted file mode 100644 index 27036c1d9..000000000 --- a/io.catenax.part_as_planned/1.0.1/gen/PartAsPlanned-aas.xml +++ /dev/null @@ -1,709 +0,0 @@ - - - - - defaultAdminShell - - - en - defaultAdminShell - - - - urn:samm:io.catenax.part_as_planned:1.0.1#PartAsPlanned - - Type - - - - ModelReference - - - Submodel - urn:samm:io.catenax.part_as_planned:1.0.1#PartAsPlanned/submodel - - - - - - - - - PartAsPlanned - - - en - A Part as Planned represents an item in the Catena-X Bill of Material (BOM) in As-Planned lifecycle status in a specific version. - - - - urn:samm:io.catenax.part_as_planned:1.0.1#PartAsPlanned/submodel - Template - - ModelReference - - - ConceptDescription - urn:samm:io.catenax.part_as_planned:1.0.1#PartAsPlanned - - - - - - catenaXId - - - en - Catena-X ID - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.part_as_planned:1.0.1#catenaXId - - - - xs:string - - - - PartTypeInformationEntity - - - en - Part Type Information Entity - - - - - en - Encapsulation for data related to the part type - - - - - manufacturerPartId - - - en - Manufacturer Part ID - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.part_as_planned:1.0.1#manufacturerPartId - - - - xs:string - - - - nameAtManufacturer - - - en - Name at manufacturer - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.part_as_planned:1.0.1#nameAtManufacturer - - - - xs:string - - - - classification - - - en - Classifcation - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.part_as_planned:1.0.1#classification - - - - xs:string - - - - - - ValidityPeriodEntity - - - en - Validity Period Entity - - - - - en - Defines a continuous validity period. - - - - - validFrom - - - en - Valid from - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.part_as_planned:1.0.1#validFrom - - - - xs:dateTime - - - - validTo - - - en - Valid to - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.part_as_planned:1.0.1#validTo - - - - xs:dateTime - - - - - - - - - - APPLICATION_CLASS - PartAsPlanned - - - en - Part as Planned - - - - - en - A Part as Planned represents an item in the Catena-X Bill of Material (BOM) in As-Planned lifecycle status in a specific version. - - - urn:samm:io.catenax.part_as_planned:1.0.1#PartAsPlanned - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Part as Planned - - - - - en - PartAsPlanned - - - - - en - A Part as Planned represents an item in the Catena-X Bill of Material (BOM) in As-Planned lifecycle status in a specific version. - - - - - - - - - catenaXId - - - en - Catena-X ID - - - urn:samm:io.catenax.part_as_planned:1.0.1#catenaXId - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Catena-X ID - - - - - en - catenaXId - - - STRING - - - en - The fully anonymous Catena-X ID of the serialized part, valid for the Catena-X dataspace. - - - - - - - - - manufacturerPartId - - - en - Manufacturer Part ID - - - urn:samm:io.catenax.part_as_planned:1.0.1#manufacturerPartId - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Manufacturer Part ID - - - - - en - manufacturerPartId - - - STRING - - - en - Part ID as assigned by the manufacturer of the part. The Part ID identifies the part in the manufacturer`s dataspace. The Part ID references a specific version of a part. The version number must be included in the Part ID if it is available. - -The Part ID does not reference a specific instance of a part and must not be confused with the serial number. - - - - - - - - - nameAtManufacturer - - - en - Name at manufacturer - - - urn:samm:io.catenax.part_as_planned:1.0.1#nameAtManufacturer - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Name at manufacturer - - - - - en - nameAtManufacturer - - - STRING - - - en - Name of the part as assigned by the manufacturer - - - - - - - - - classification - - - en - Classifcation - - - urn:samm:io.catenax.part_as_planned:1.0.1#classification - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Classifcation - - - - - en - classification - - - STRING - - - en - The classification of the part type according to STEP standard definition - - - - - - product - - ModelReference - - - DataElement - urn:samm:io.catenax.part_as_planned:1.0.1#ClassificationEnumerationCharacteristic:product - - - - - - raw material - - ModelReference - - - DataElement - urn:samm:io.catenax.part_as_planned:1.0.1#ClassificationEnumerationCharacteristic:raw material - - - - - - software - - ModelReference - - - DataElement - urn:samm:io.catenax.part_as_planned:1.0.1#ClassificationEnumerationCharacteristic:software - - - - - - assembly - - ModelReference - - - DataElement - urn:samm:io.catenax.part_as_planned:1.0.1#ClassificationEnumerationCharacteristic:assembly - - - - - - tool - - ModelReference - - - DataElement - urn:samm:io.catenax.part_as_planned:1.0.1#ClassificationEnumerationCharacteristic:tool - - - - - - component - - ModelReference - - - DataElement - urn:samm:io.catenax.part_as_planned:1.0.1#ClassificationEnumerationCharacteristic:component - - - - - - - - - - - - - partTypeInformation - - - en - Part Type Information - - - urn:samm:io.catenax.part_as_planned:1.0.1#partTypeInformation - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Part Type Information - - - - - en - partTypeInformation - - - STRING - - - en - The part type from which the serialized part has been instantiated - - - - - - - - - validFrom - - - en - Valid from - - - urn:samm:io.catenax.part_as_planned:1.0.1#validFrom - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Valid from - - - - - en - validFrom - - - STRING - - - en - Start date of validity period - - - - - - - - - validTo - - - en - Valid to - - - urn:samm:io.catenax.part_as_planned:1.0.1#validTo - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Valid to - - - - - en - validTo - - - STRING - - - en - End date of validity period - - - - - - - - - validityPeriod - - - en - Validity Period - - - urn:samm:io.catenax.part_as_planned:1.0.1#validityPeriod - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Validity Period - - - - - en - validityPeriod - - - STRING - - - en - The period of time during which the Part is offered by the manufacturer and can be purchased by customers. - - - - - - - - - diff --git a/io.catenax.part_as_planned/1.0.1/gen/PartAsPlanned-schema.json b/io.catenax.part_as_planned/1.0.1/gen/PartAsPlanned-schema.json deleted file mode 100644 index 09353d163..000000000 --- a/io.catenax.part_as_planned/1.0.1/gen/PartAsPlanned-schema.json +++ /dev/null @@ -1,80 +0,0 @@ -{ - "$schema" : "http://json-schema.org/draft-04/schema", - "description" : "A Part as Planned represents an item in the Catena-X Bill of Material (BOM) in As-Planned lifecycle status in a specific version. ", - "type" : "object", - "components" : { - "schemas" : { - "urn_bamm_io.catenax.part_as_planned_1.0.1_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).", - "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_bamm_io.catenax.part_as_planned_1.0.1_PartIdCharacteristic" : { - "type" : "string", - "description" : "The part ID is a multi-character string, ususally assigned by an ERP system" - }, - "urn_bamm_io.catenax.part_as_planned_1.0.1_PartNameCharacteristic" : { - "type" : "string", - "description" : "Part Name in string format from the respective system in the value chain" - }, - "urn_bamm_io.catenax.part_as_planned_1.0.1_ClassificationEnumerationCharacteristic" : { - "type" : "string", - "description" : "A part type must be placed into one of the following classes: 'component', 'product', 'software', ‘assembly’, 'tool', or 'raw material'.", - "enum" : [ "product", "raw material", "software", "assembly", "tool", "component" ] - }, - "urn_bamm_io.catenax.part_as_planned_1.0.1_PartTypeInformationCharacteristic" : { - "description" : "The characteristics of the part type", - "type" : "object", - "properties" : { - "manufacturerPartId" : { - "description" : "Part ID as assigned by the manufacturer of the part. The Part ID identifies the part in the manufacturer`s dataspace. The Part ID references a specific version of a part. The version number must be included in the Part ID if it is available.\n\nThe Part ID does not reference a specific instance of a part and must not be confused with the serial number.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.part_as_planned_1.0.1_PartIdCharacteristic" - }, - "nameAtManufacturer" : { - "description" : "Name of the part as assigned by the manufacturer", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.part_as_planned_1.0.1_PartNameCharacteristic" - }, - "classification" : { - "description" : "The classification of the part type according to STEP standard definition", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.part_as_planned_1.0.1_ClassificationEnumerationCharacteristic" - } - }, - "required" : [ "manufacturerPartId", "nameAtManufacturer", "classification" ] - }, - "urn_bamm_io.openmanufacturing_characteristic_2.0.0_Timestamp" : { - "type" : "string", - "pattern" : "-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T(([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](\\.[0-9]+)?|(24:00:00(\\.0+)?))(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?", - "description" : "Describes a Property which contains the date and time with an optional timezone." - }, - "urn_bamm_io.catenax.part_as_planned_1.0.1_ValidityPeriodCharacteristic" : { - "description" : "Characteristic to define a continuous validity period.", - "type" : "object", - "properties" : { - "validFrom" : { - "description" : "Start date of validity period", - "$ref" : "#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Timestamp" - }, - "validTo" : { - "description" : "End date of validity period", - "$ref" : "#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Timestamp" - } - } - } - } - }, - "properties" : { - "catenaXId" : { - "description" : "The fully anonymous Catena-X ID of the serialized part, valid for the Catena-X dataspace.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.part_as_planned_1.0.1_CatenaXIdTrait" - }, - "partTypeInformation" : { - "description" : "The part type from which the serialized part has been instantiated", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.part_as_planned_1.0.1_PartTypeInformationCharacteristic" - }, - "validityPeriod" : { - "description" : "The period of time during which the Part is offered by the manufacturer and can be purchased by customers.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.part_as_planned_1.0.1_ValidityPeriodCharacteristic" - } - }, - "required" : [ "catenaXId", "partTypeInformation" ] -} \ No newline at end of file diff --git a/io.catenax.part_as_planned/1.0.1/gen/PartAsPlanned.aasx b/io.catenax.part_as_planned/1.0.1/gen/PartAsPlanned.aasx deleted file mode 100644 index 5ba29ddf8..000000000 Binary files a/io.catenax.part_as_planned/1.0.1/gen/PartAsPlanned.aasx and /dev/null differ diff --git a/io.catenax.part_as_planned/1.0.1/gen/PartAsPlanned.html b/io.catenax.part_as_planned/1.0.1/gen/PartAsPlanned.html deleted file mode 100644 index 1d9a11e8c..000000000 --- a/io.catenax.part_as_planned/1.0.1/gen/PartAsPlanned.html +++ /dev/null @@ -1,828 +0,0 @@ - - - - - - - - - - - - - - Dokumentation Part as Planned - - -
-
-
-
-

Aspect Model Part as Planned

-
urn:bamm:io.catenax.part_as_planned:1.0.1#PartAsPlanned
-
-
-
-
-
-
-
- -
- - -
- A Part as Planned represents an item in the Catena-X Bill of Material (BOM) in As-Planned lifecycle status in a specific version. -
- - -
-

Übersicht

-
-
-
-
- Aspect Model Diagram -
-
-
- - -
-
-

Properties

-
- -
- -
-

Catena-X ID

-
- -The fully anonymous Catena-X ID of the serialized part, valid for the Catena-X dataspace. - -
-
Name
-
catenaXId
-
- - - -
-
Characteristic
-
-
-
-
Trait
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Beispiel
-
580d3adf-1981-44a0-a214-13d6ceed9379
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
catenaXId
-
- - -
-
Bedingungen
-
-
    -
  • -
    - -
    - Catena-X ID Regular Expression -
    - -
    -
    Beschreibung
    -
    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).
    -
    - - -
    -
    Regulärer Ausdruck
    -
    (^[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}$)
    -
    - -
    • -
-
-
-
-
- -
-

Part Type Information

-
- -The part type from which the serialized part has been instantiated - -
-
Name
-
partTypeInformation
-
- - - -
-
Characteristic
-
-
-
-
SingleEntity
-
-
-
- Typ urn:bamm:io.catenax.part_as_planned:1.0.1#PartTypeInformationEntity - -
-
-
-
-
- - -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
partTypeInformation
-
- - -
-
- -
-

Validity Period

-
- -The period of time during which the Part is offered by the manufacturer and can be purchased by customers. - -
-
Name
-
validityPeriod
-
- - - -
-
Characteristic
-
-
-
-
SingleEntity
-
-
-
- Typ urn:bamm:io.catenax.part_as_planned:1.0.1#ValidityPeriodEntity - -
-
-
-
-
- - -
-
Optional
-
- Ja
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
validityPeriod
-
- - -
-
- - - -
-
-

Objekt

-
- -
-
-

Part Type Information Entity

-
-
- Encapsulation for data related to the part type -
- -
-

Properties

-
-
- -
-
Manufacturer Part ID
-
- -Part ID as assigned by the manufacturer of the part. The Part ID identifies the part in the manufacturer`s dataspace. The Part ID references a specific version of a part. The version number must be included in the Part ID if it is available. - -The Part ID does not reference a specific instance of a part and must not be confused with the serial number. - -
-
Name
-
manufacturerPartId
-
- - - -
-
Characteristic
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Beispiel
-
123-0.740-3434-A
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
manufacturerPartId
-
- - -
-
- -
-
Name at manufacturer
-
- -Name of the part as assigned by the manufacturer - -
-
Name
-
nameAtManufacturer
-
- - - -
-
Characteristic
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Beispiel
-
Mirror left
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
nameAtManufacturer
-
- - -
-
- -
-
Classifcation
-
- -The classification of the part type according to STEP standard definition - -
-
Name
-
classification
-
- - - -
-
Characteristic
-
-
-
-
Enumeration
-
-
-
Werte
-
-
-
-
    -
  • product
    • -
  • raw material
    • -
  • software
    • -
  • assembly
    • -
  • tool
    • -
  • component
    • -
-
-
-
-
- Referenz -
-
    -
  • http://private.pdm-if.org/web/pdm-if/recommended-practices1
    • -
-
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Beispiel
-
software
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
classification
-
- - -
-
-
-
-

Validity Period Entity

-
-
- Defines a continuous validity period. -
- -
-

Properties

-
-
- -
-
Valid from
-
- -Start date of validity period - -
-
Name
-
validFrom
-
- - - -
-
Characteristic
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#dateTime - -
-
-
-
-
- -
-
Beispiel
-
2023-03-06T14:50:23.230+01:00
-
- -
-
Optional
-
- Ja
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
validFrom
-
- - -
-
- -
-
Valid to
-
- -End date of validity period - -
-
Name
-
validTo
-
- - - -
-
Characteristic
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#dateTime - -
-
-
-
-
- -
-
Beispiel
-
2023-08-06T14:50:23.230+01:00
-
- -
-
Optional
-
- Ja
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
validTo
-
- - -
-
-
- -
- Third party licenses - -
- -
- - -
- - - \ No newline at end of file diff --git a/io.catenax.part_as_planned/1.0.1/gen/PartAsPlanned.json b/io.catenax.part_as_planned/1.0.1/gen/PartAsPlanned.json deleted file mode 100644 index b0e461c22..000000000 --- a/io.catenax.part_as_planned/1.0.1/gen/PartAsPlanned.json +++ /dev/null @@ -1,12 +0,0 @@ -{ - "partTypeInformation" : { - "classification" : "product", - "manufacturerPartId" : "123-0.740-3434-A", - "nameAtManufacturer" : "Mirror left" - }, - "validityPeriod" : { - "validFrom" : "2023-03-06T14:50:23.230+01:00", - "validTo" : "2023-08-06T14:50:23.230+01:00" - }, - "catenaXId" : "580d3adf-1981-44a0-a214-13d6ceed9379" -} \ No newline at end of file diff --git a/io.catenax.part_as_planned/1.0.1/gen/PartAsPlanned.yml b/io.catenax.part_as_planned/1.0.1/gen/PartAsPlanned.yml deleted file mode 100644 index 6204e43a1..000000000 --- a/io.catenax.part_as_planned/1.0.1/gen/PartAsPlanned.yml +++ /dev/null @@ -1,171 +0,0 @@ ---- -openapi: 3.0.3 -info: - title: Part as Planned - version: v1 -servers: -- url: catenax.io/api/v1 - variables: - api-version: - default: v1 -paths: - /{tenant-id}/part-as-planned: - get: - tags: - - PartAsPlanned - operationId: getPartAsPlanned - 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/PartAsPlanned' - "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_bamm_io.catenax.part_as_planned_1.0.1_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)." - 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_bamm_io.catenax.part_as_planned_1.0.1_PartIdCharacteristic: - type: string - description: "The part ID is a multi-character string, ususally assigned by\ - \ an ERP system" - urn_bamm_io.catenax.part_as_planned_1.0.1_PartNameCharacteristic: - type: string - description: Part Name in string format from the respective system in the value - chain - urn_bamm_io.catenax.part_as_planned_1.0.1_ClassificationEnumerationCharacteristic: - type: string - description: "A part type must be placed into one of the following classes:\ - \ 'component', 'product', 'software', ‘assembly’, 'tool', or 'raw material'." - enum: - - product - - raw material - - software - - assembly - - tool - - component - urn_bamm_io.catenax.part_as_planned_1.0.1_PartTypeInformationCharacteristic: - description: The characteristics of the part type - type: object - properties: - manufacturerPartId: - description: |- - Part ID as assigned by the manufacturer of the part. The Part ID identifies the part in the manufacturer`s dataspace. The Part ID references a specific version of a part. The version number must be included in the Part ID if it is available. - - The Part ID does not reference a specific instance of a part and must not be confused with the serial number. - $ref: '#/components/schemas/urn_bamm_io.catenax.part_as_planned_1.0.1_PartIdCharacteristic' - nameAtManufacturer: - description: Name of the part as assigned by the manufacturer - $ref: '#/components/schemas/urn_bamm_io.catenax.part_as_planned_1.0.1_PartNameCharacteristic' - classification: - description: The classification of the part type according to STEP standard - definition - $ref: '#/components/schemas/urn_bamm_io.catenax.part_as_planned_1.0.1_ClassificationEnumerationCharacteristic' - required: - - manufacturerPartId - - nameAtManufacturer - - classification - urn_bamm_io.openmanufacturing_characteristic_2.0.0_Timestamp: - type: string - pattern: "-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T(([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](\\\ - .[0-9]+)?|(24:00:00(\\.0+)?))(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?" - description: Describes a Property which contains the date and time with an optional - timezone. - urn_bamm_io.catenax.part_as_planned_1.0.1_ValidityPeriodCharacteristic: - description: Characteristic to define a continuous validity period. - type: object - properties: - validFrom: - description: Start date of validity period - $ref: '#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Timestamp' - validTo: - description: End date of validity period - $ref: '#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Timestamp' - PartAsPlanned: - description: 'A Part as Planned represents an item in the Catena-X Bill of Material - (BOM) in As-Planned lifecycle status in a specific version. ' - type: object - properties: - catenaXId: - description: "The fully anonymous Catena-X ID of the serialized part, valid\ - \ for the Catena-X dataspace." - $ref: '#/components/schemas/urn_bamm_io.catenax.part_as_planned_1.0.1_CatenaXIdTrait' - partTypeInformation: - description: The part type from which the serialized part has been instantiated - $ref: '#/components/schemas/urn_bamm_io.catenax.part_as_planned_1.0.1_PartTypeInformationCharacteristic' - validityPeriod: - description: The period of time during which the Part is offered by the - manufacturer and can be purchased by customers. - $ref: '#/components/schemas/urn_bamm_io.catenax.part_as_planned_1.0.1_ValidityPeriodCharacteristic' - required: - - catenaXId - - partTypeInformation - 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' - PartAsPlanned: - content: - application/json: - schema: - $ref: '#/components/schemas/PartAsPlanned' - description: The request was successful. - requestBodies: - PartAsPlanned: - content: - application/json: - schema: - $ref: '#/components/schemas/PartAsPlanned' diff --git a/io.catenax.part_as_planned/1.0.1/metadata.json b/io.catenax.part_as_planned/1.0.1/metadata.json deleted file mode 100644 index bf40b864e..000000000 --- a/io.catenax.part_as_planned/1.0.1/metadata.json +++ /dev/null @@ -1 +0,0 @@ -{ "status" : "deprecate"} diff --git a/io.catenax.parts_analyses/1.0.0/PartsAnalyses.ttl b/io.catenax.parts_analyses/1.0.0/PartsAnalyses.ttl deleted file mode 100644 index 6904f293a..000000000 --- a/io.catenax.parts_analyses/1.0.0/PartsAnalyses.ttl +++ /dev/null @@ -1,121 +0,0 @@ -####################################################################### -# Copyright (c) 2022 Robert Bosch GmbH -# Copyright (c) 2022 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) -# Copyright (c) 2022 Mercedes Benz AG -# Copyright (c) 2022 Volkswagen AG -# Copyright (c) 2022 ZF Friedrichshafen AG -# Copyright (c) 2022 SAP SE -# Copyright (c) 2022 Siemens AG -# Copyright (c) 2022 Contributors to the Eclipse Foundation -# -# 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 bamm: . -@prefix bamm-c: . -@prefix bamm-e: . -@prefix unit: . -@prefix rdf: . -@prefix rdfs: . -@prefix xsd: . -@prefix : . - -:UUIDv4RegularExpression a bamm-c:RegularExpressionConstraint; - bamm:preferredName "Catena-X Id Regular Expression"@en; - bamm: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."@en; - bamm:value "(^[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}$)"; - bamm:see . -:UUIDv4 a bamm:Characteristic; - bamm:preferredName "UUIDv4"@en; - bamm:description "A version 4 UUID is a universally unique identifier that is generated using random 32 hexadecimal characters."@en; - bamm:dataType xsd:string. -:CatenaXIdTrait a bamm-c:Trait; - bamm:preferredName "Catena-X ID Trait"@en; - bamm:description "Trait to ensure data format for Catena-X ID"@en; - bamm-c:constraint :UUIDv4RegularExpression; - bamm-c:baseCharacteristic :UUIDv4. -:PartAnalysis a bamm:Entity; - bamm:preferredName "Part Analysis"@en; - bamm:description "The analysis results of ONE part"@en; - bamm:properties ([ - bamm:property :catenaXIdentifier; - bamm:optional "true"^^xsd:boolean -] :manufacturerPartIdentifier [ - bamm:property :manufacturerSerialPartNumber; - bamm:optional "true"^^xsd:boolean -] [ - bamm:property :customerPartIdentifier; - bamm:optional "true"^^xsd:boolean -] :nameAtManufacturer :status :isDefect :resultsDescription :qualityTaskId). -:catenaXIdentifier a bamm:Property; - bamm:preferredName "Catena-X ID"@en; - bamm:description "The fully anonymous Catena-X ID of the analyzed part - only available after digital twin registry is fully operational"@en; - bamm:characteristic :CatenaXIdTrait; - bamm:exampleValue "urn:uuid:580d3adf-1981-44a0-a214-13d6ceed9000". -:manufacturerPartIdentifier a bamm:Property; - bamm:preferredName "Manufacturer Part ID"@en; - bamm:description "Part Id of the analyzed part as assigned by the manufacturer of the part. The Part Id identifies the part type and is not unique for each serial part"@en; - bamm:characteristic bamm-c:Text; - bamm:exampleValue "123-0.740-3434-A". -:manufacturerSerialPartNumber a bamm:Property; - bamm:preferredName "Manufacturer serial part identifier ID"@en; - bamm: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."@en; - bamm:characteristic bamm-c:Text; - bamm:exampleValue "436347347.4343884384.FTG.538348". -:customerPartIdentifier a bamm:Property; - bamm:preferredName "Customer part identifier"@en; - bamm:description "Part ID as assigned by Original Equipment Manaufacturer."@en; - bamm:characteristic bamm-c:Text; - bamm:exampleValue "PRT-12345". -:nameAtManufacturer a bamm:Property; - bamm:preferredName "Manufacturer part name ID"@en; - bamm:description "Name of the analyzed part as assigned by the manufacturer of the part."@en; - bamm:characteristic bamm-c:Text; - bamm:exampleValue "Steering assembly". -:status a bamm:Property; - bamm:preferredName "Status"@en; - bamm:description "Status of this part analysis"@en; - bamm:characteristic :StatusCharacteristic; - bamm:exampleValue "new". -:isDefect a bamm:Property; - bamm:preferredName "Part defect flag"@en; - bamm:description "True: Analysis turned out that analyzed part is defect accroding part's specification."@en; - bamm:characteristic bamm-c:Boolean; - bamm:exampleValue "true"^^xsd:boolean. -:resultsDescription a bamm:Property; - bamm:preferredName "Several results of analysis"@en; - bamm:description "Detailed description of part analysis results."@en; - bamm:characteristic bamm-c:Text; - bamm:exampleValue "Corrossion on component xyz in steering motor". -:qualityTaskId a bamm:Property; - bamm:preferredName "Quality Task ID"@en; - bamm:description "A unique quality task identifier where these list of parts analysis belong to."@en; - bamm:characteristic bamm-c:Text; - bamm:exampleValue "BPN-811_2022_000001". -:StatusCharacteristic a bamm-c:Enumeration; - bamm:preferredName "StatusCharacteristic"@en; - bamm:description "Enumeration of the different status values"@en; - bamm:dataType xsd:string; - bamm-c:values ("new" "in progress" "completed" "closed"). -:PartsAnalyses a bamm:Aspect; - bamm:preferredName "Part Analysis"@en; - bamm:description "List of part analysis for one quality task"@en; - bamm:properties (:listOfPartAnalyses); - bamm:operations (); - bamm:events (). -:listOfPartAnalyses a bamm:Property; - bamm:preferredName "List Of several Part Analyses"@en; - bamm:description "A list of several part analyses"@en; - bamm:characteristic :ListOfPartsAnalyses. -:ListOfPartsAnalyses a bamm-c:List; - bamm:preferredName "Parts Analyses"@en; - bamm:description "A list for all parts analyses"@en; - bamm:dataType :PartAnalysis. diff --git a/io.catenax.parts_analyses/1.0.0/gen/PartsAnalyses-aas.xml b/io.catenax.parts_analyses/1.0.0/gen/PartsAnalyses-aas.xml deleted file mode 100644 index a595c802a..000000000 --- a/io.catenax.parts_analyses/1.0.0/gen/PartsAnalyses-aas.xml +++ /dev/null @@ -1,837 +0,0 @@ - - - - - defaultAdminShell - - - en - defaultAdminShell - - - - urn:samm:io.catenax.parts_analyses:1.0.0#PartsAnalyses - - Type - - - - ModelReference - - - Submodel - urn:samm:io.catenax.parts_analyses:1.0.0#PartsAnalyses/submodel - - - - - - - - - PartsAnalyses - - - en - List of part analysis for one quality task - - - - urn:samm:io.catenax.parts_analyses:1.0.0#PartsAnalyses/submodel - Template - - ModelReference - - - ConceptDescription - urn:samm:io.catenax.parts_analyses:1.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 - - - - - catenaXIdentifier - - - en - Catena-X ID - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.parts_analyses:1.0.0#catenaXIdentifier - - - - xs:string - - - - manufacturerPartIdentifier - - - en - Manufacturer Part ID - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.parts_analyses:1.0.0#manufacturerPartIdentifier - - - - xs:string - - - - manufacturerSerialPartNumber - - - en - Manufacturer serial part identifier ID - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.parts_analyses:1.0.0#manufacturerSerialPartNumber - - - - xs:string - - - - customerPartIdentifier - - - en - Customer part identifier - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.parts_analyses:1.0.0#customerPartIdentifier - - - - xs:string - - - - nameAtManufacturer - - - en - Manufacturer part name ID - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.parts_analyses:1.0.0#nameAtManufacturer - - - - xs:string - - - - status - - - en - Status - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.parts_analyses:1.0.0#status - - - - xs:string - - - - isDefect - - - en - Part defect flag - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.parts_analyses:1.0.0#isDefect - - - - xs:boolean - - - - resultsDescription - - - en - Several results of analysis - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.parts_analyses:1.0.0#resultsDescription - - - - xs:string - - - - qualityTaskId - - - en - Quality Task ID - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.parts_analyses:1.0.0#qualityTaskId - - - - xs:string - - - - - - - - - - - - APPLICATION_CLASS - PartsAnalyses - - - en - Part Analysis - - - - - en - List of part analysis for one quality task - - - urn:samm:io.catenax.parts_analyses:1.0.0#PartsAnalyses - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Part Analysis - - - - - en - PartsAnalyses - - - - - en - List of part analysis for one quality task - - - - - - - - - catenaXIdentifier - - - en - Catena-X ID - - - urn:samm:io.catenax.parts_analyses:1.0.0#catenaXIdentifier - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Catena-X ID - - - - - en - catenaXIdentifier - - - STRING - - - en - The fully anonymous Catena-X ID of the analyzed part - only available after digital twin registry is fully operational - - - - - - - - - manufacturerPartIdentifier - - - en - Manufacturer Part ID - - - urn:samm:io.catenax.parts_analyses:1.0.0#manufacturerPartIdentifier - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Manufacturer Part ID - - - - - en - manufacturerPartIdentifier - - - STRING - - - en - Part Id of the analyzed part as assigned by the manufacturer of the part. The Part Id identifies the part type and is not unique for each serial part - - - - - - - - - manufacturerSerialPartNumber - - - en - Manufacturer serial part identifier ID - - - urn:samm:io.catenax.parts_analyses:1.0.0#manufacturerSerialPartNumber - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Manufacturer serial part identifier ID - - - - - 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. - - - - - - - - - customerPartIdentifier - - - en - Customer part identifier - - - urn:samm:io.catenax.parts_analyses:1.0.0#customerPartIdentifier - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Customer part identifier - - - - - en - customerPartIdentifier - - - STRING - - - en - Part ID as assigned by Original Equipment Manaufacturer. - - - - - - - - - nameAtManufacturer - - - en - Manufacturer part name ID - - - urn:samm:io.catenax.parts_analyses:1.0.0#nameAtManufacturer - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Manufacturer part name ID - - - - - en - nameAtManufacturer - - - STRING - - - en - Name of the analyzed part as assigned by the manufacturer of the part. - - - - - - - - - status - - - en - Status - - - urn:samm:io.catenax.parts_analyses:1.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:1.0.0#StatusCharacteristic:new - - - - - - in progress - - ModelReference - - - DataElement - urn:samm:io.catenax.parts_analyses:1.0.0#StatusCharacteristic:in progress - - - - - - completed - - ModelReference - - - DataElement - urn:samm:io.catenax.parts_analyses:1.0.0#StatusCharacteristic:completed - - - - - - closed - - ModelReference - - - DataElement - urn:samm:io.catenax.parts_analyses:1.0.0#StatusCharacteristic:closed - - - - - - - - - - - - - isDefect - - - en - Part defect flag - - - urn:samm:io.catenax.parts_analyses:1.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:1.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. - - - - - - - - - qualityTaskId - - - en - Quality Task ID - - - urn:samm:io.catenax.parts_analyses: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. - - - - - - - - - listOfPartAnalyses - - - en - List Of several Part Analyses - - - urn:samm:io.catenax.parts_analyses:1.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/1.0.0/gen/PartsAnalyses-schema.json b/io.catenax.parts_analyses/1.0.0/gen/PartsAnalyses-schema.json deleted file mode 100644 index a08dc42d8..000000000 --- a/io.catenax.parts_analyses/1.0.0/gen/PartsAnalyses-schema.json +++ /dev/null @@ -1,84 +0,0 @@ -{ - "$schema" : "http://json-schema.org/draft-04/schema", - "description" : "List of part analysis for one quality task", - "type" : "object", - "components" : { - "schemas" : { - "urn_bamm_io.catenax.parts_analyses_1.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_bamm_io.openmanufacturing_characteristic_2.0.0_Text" : { - "type" : "string", - "description" : "Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc." - }, - "urn_bamm_io.catenax.parts_analyses_1.0.0_StatusCharacteristic" : { - "type" : "string", - "description" : "Enumeration of the different status values", - "enum" : [ "new", "in progress", "completed", "closed" ] - }, - "urn_bamm_io.openmanufacturing_characteristic_2.0.0_Boolean" : { - "type" : "boolean", - "description" : "Represents a boolean value (i.e. a \"flag\")." - }, - "urn_bamm_io.catenax.parts_analyses_1.0.0_PartAnalysis" : { - "description" : "The analysis results of ONE part", - "type" : "object", - "properties" : { - "catenaXIdentifier" : { - "description" : "The fully anonymous Catena-X ID of the analyzed part - only available after digital twin registry is fully operational", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.parts_analyses_1.0.0_CatenaXIdTrait" - }, - "manufacturerPartIdentifier" : { - "description" : "Part Id of the analyzed part as assigned by the manufacturer of the part. The Part Id identifies the part type and is not unique for each serial part", - "$ref" : "#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.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_bamm_io.openmanufacturing_characteristic_2.0.0_Text" - }, - "customerPartIdentifier" : { - "description" : "Part ID as assigned by Original Equipment Manaufacturer.", - "$ref" : "#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text" - }, - "nameAtManufacturer" : { - "description" : "Name of the analyzed part as assigned by the manufacturer of the part.", - "$ref" : "#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text" - }, - "status" : { - "description" : "Status of this part analysis", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.parts_analyses_1.0.0_StatusCharacteristic" - }, - "isDefect" : { - "description" : "True: Analysis turned out that analyzed part is defect accroding part's specification.", - "$ref" : "#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Boolean" - }, - "resultsDescription" : { - "description" : "Detailed description of part analysis results.", - "$ref" : "#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text" - }, - "qualityTaskId" : { - "description" : "A unique quality task identifier where these list of parts analysis belong to.", - "$ref" : "#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text" - } - }, - "required" : [ "manufacturerPartIdentifier", "nameAtManufacturer", "status", "isDefect", "resultsDescription", "qualityTaskId" ] - }, - "urn_bamm_io.catenax.parts_analyses_1.0.0_ListOfPartsAnalyses" : { - "description" : "A list for all parts analyses", - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/urn_bamm_io.catenax.parts_analyses_1.0.0_PartAnalysis" - } - } - } - }, - "properties" : { - "listOfPartAnalyses" : { - "description" : "A list of several part analyses", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.parts_analyses_1.0.0_ListOfPartsAnalyses" - } - }, - "required" : [ "listOfPartAnalyses" ] -} \ No newline at end of file diff --git a/io.catenax.parts_analyses/1.0.0/gen/PartsAnalyses.aasx b/io.catenax.parts_analyses/1.0.0/gen/PartsAnalyses.aasx deleted file mode 100644 index 15cd850bd..000000000 Binary files a/io.catenax.parts_analyses/1.0.0/gen/PartsAnalyses.aasx and /dev/null differ diff --git a/io.catenax.parts_analyses/1.0.0/gen/PartsAnalyses.html b/io.catenax.parts_analyses/1.0.0/gen/PartsAnalyses.html deleted file mode 100644 index 20667be10..000000000 --- a/io.catenax.parts_analyses/1.0.0/gen/PartsAnalyses.html +++ /dev/null @@ -1,927 +0,0 @@ - - - - - - - - - - - - - - Dokumentation Part Analysis - - -
-
-
-
-

Aspect Model Part Analysis

-
urn:bamm:io.catenax.parts_analyses:1.0.0#PartsAnalyses
-
-
-
-
-
-
-
- -
- - -
- List of part analysis for one quality task -
- - -
-

Übersicht

-
-
-
-
- Aspect Model Diagram -
-
-
- - -
-
-

Properties

-
- -
- -
-

List Of several Part Analyses

-
- -A list of several part analyses - -
-
Name
-
listOfPartAnalyses
-
- - - -
-
Characteristic
-
-
-
-
List
-
-
-
Sortierung
-
-
-
Erlaubt Duplikate
-
-
-
- Typ urn:bamm:io.catenax.parts_analyses:1.0.0#PartAnalysis - -
-
-
-
-
- - -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
listOfPartAnalyses
-
- - -
-
- - - -
-
-

Objekt

-
- -
-
-

Part Analysis

-
-
- The analysis results of ONE part -
- -
-

Properties

-
-
- -
-
Catena-X ID
-
- -The fully anonymous Catena-X ID of the analyzed part - only available after digital twin registry is fully operational - -
-
Name
-
catenaXIdentifier
-
- - - -
-
Characteristic
-
-
-
-
Trait
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Beispiel
-
urn:uuid:580d3adf-1981-44a0-a214-13d6ceed9000
-
- -
-
Optional
-
- Ja
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
catenaXIdentifier
-
- - -
-
Bedingungen
-
-
    -
  • -
    - -
    - Catena-X Id Regular Expression -
    - -
    -
    Beschreibung
    -
    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.
    -
    - -
    -
    Referenz
    -
    -
    -
      -
    • https://datatracker.ietf.org/doc/html/rfc4122
      • -
    -
    -
    -
    - -
    -
    Regulärer Ausdruck
    -
    (^[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}$)
    -
    - -
    • -
-
-
-
-
- -
-
Manufacturer Part ID
-
- -Part Id of the analyzed part as assigned by the manufacturer of the part. The Part Id identifies the part type and is not unique for each serial part - -
-
Name
-
manufacturerPartIdentifier
-
- - - -
-
Characteristic
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Beispiel
-
123-0.740-3434-A
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
manufacturerPartIdentifier
-
- - -
-
- -
-
Manufacturer serial part identifier ID
-
- -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
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Beispiel
-
436347347.4343884384.FTG.538348
-
- -
-
Optional
-
- Ja
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
manufacturerSerialPartNumber
-
- - -
-
- -
-
Customer part identifier
-
- -Part ID as assigned by Original Equipment Manaufacturer. - -
-
Name
-
customerPartIdentifier
-
- - - -
-
Characteristic
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Beispiel
-
PRT-12345
-
- -
-
Optional
-
- Ja
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
customerPartIdentifier
-
- - -
-
- -
-
Manufacturer part name ID
-
- -Name of the analyzed part as assigned by the manufacturer of the part. - -
-
Name
-
nameAtManufacturer
-
- - - -
-
Characteristic
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Beispiel
-
Steering assembly
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
nameAtManufacturer
-
- - -
-
- -
-
Status
-
- -Status of this part analysis - -
-
Name
-
status
-
- - - -
-
Characteristic
-
-
-
-
Enumeration
-
-
-
Werte
-
-
-
-
    -
  • new
    • -
  • in progress
    • -
  • completed
    • -
  • closed
    • -
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Beispiel
-
new
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
status
-
- - -
-
- -
-
Part defect flag
-
- -True: Analysis turned out that analyzed part is defect accroding part's specification. - -
-
Name
-
isDefect
-
- - - -
-
Characteristic
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#boolean - -
-
-
-
-
- -
-
Beispiel
-
true
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
isDefect
-
- - -
-
- -
-
Several results of analysis
-
- -Detailed description of part analysis results. - -
-
Name
-
resultsDescription
-
- - - -
-
Characteristic
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Beispiel
-
Corrossion on component xyz in steering motor
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
resultsDescription
-
- - -
-
- -
-
Quality Task ID
-
- -A unique quality task identifier where these list of parts analysis belong to. - -
-
Name
-
qualityTaskId
-
- - - -
-
Characteristic
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Beispiel
-
BPN-811_2022_000001
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
qualityTaskId
-
- - -
-
-
- -
- Third party licenses - -
- -
- - -
- - - \ No newline at end of file diff --git a/io.catenax.parts_analyses/1.0.0/gen/PartsAnalyses.json b/io.catenax.parts_analyses/1.0.0/gen/PartsAnalyses.json deleted file mode 100644 index 260015bee..000000000 --- a/io.catenax.parts_analyses/1.0.0/gen/PartsAnalyses.json +++ /dev/null @@ -1,13 +0,0 @@ -{ - "listOfPartAnalyses" : [ { - "customerPartIdentifier" : "PRT-12345", - "resultsDescription" : "Corrossion on component xyz in steering motor", - "qualityTaskId" : "BPN-811_2022_000001", - "manufacturerSerialPartNumber" : "436347347.4343884384.FTG.538348", - "catenaXIdentifier" : "urn:uuid:580d3adf-1981-44a0-a214-13d6ceed9000", - "isDefect" : true, - "nameAtManufacturer" : "Steering assembly", - "manufacturerPartIdentifier" : "123-0.740-3434-A", - "status" : "new" - } ] -} \ No newline at end of file diff --git a/io.catenax.parts_analyses/1.0.0/gen/PartsAnalyses.yml b/io.catenax.parts_analyses/1.0.0/gen/PartsAnalyses.yml deleted file mode 100644 index 7a898c7bd..000000000 --- a/io.catenax.parts_analyses/1.0.0/gen/PartsAnalyses.yml +++ /dev/null @@ -1,206 +0,0 @@ ---- -openapi: 3.0.3 -info: - title: Part Analysis - version: v1 -servers: -- url: catenax.io/api/v1 - variables: - api-version: - default: v1 -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_bamm_io.catenax.parts_analyses_1.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_bamm_io.openmanufacturing_characteristic_2.0.0_Text: - type: string - description: "Describes a Property which contains plain text. This is intended\ - \ exclusively for human readable strings, not for identifiers, measurement\ - \ values, etc." - urn_bamm_io.catenax.parts_analyses_1.0.0_StatusCharacteristic: - type: string - description: Enumeration of the different status values - enum: - - new - - in progress - - completed - - closed - urn_bamm_io.openmanufacturing_characteristic_2.0.0_Boolean: - type: boolean - description: Represents a boolean value (i.e. a "flag"). - urn_bamm_io.catenax.parts_analyses_1.0.0_PartAnalysis: - description: The analysis results of ONE part - type: object - properties: - catenaXIdentifier: - description: The fully anonymous Catena-X ID of the analyzed part - only - available after digital twin registry is fully operational - $ref: '#/components/schemas/urn_bamm_io.catenax.parts_analyses_1.0.0_CatenaXIdTrait' - manufacturerPartIdentifier: - description: Part Id of the analyzed part as assigned by the manufacturer - of the part. The Part Id identifies the part type and is not unique for - each serial part - $ref: '#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.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_bamm_io.openmanufacturing_characteristic_2.0.0_Text' - customerPartIdentifier: - description: Part ID as assigned by Original Equipment Manaufacturer. - $ref: '#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text' - nameAtManufacturer: - description: Name of the analyzed part as assigned by the manufacturer of - the part. - $ref: '#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text' - status: - description: Status of this part analysis - $ref: '#/components/schemas/urn_bamm_io.catenax.parts_analyses_1.0.0_StatusCharacteristic' - isDefect: - description: "True: Analysis turned out that analyzed part is defect accroding\ - \ part's specification." - $ref: '#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Boolean' - resultsDescription: - description: Detailed description of part analysis results. - $ref: '#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text' - qualityTaskId: - description: A unique quality task identifier where these list of parts - analysis belong to. - $ref: '#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text' - required: - - manufacturerPartIdentifier - - nameAtManufacturer - - status - - isDefect - - resultsDescription - - qualityTaskId - urn_bamm_io.catenax.parts_analyses_1.0.0_ListOfPartsAnalyses: - description: A list for all parts analyses - type: array - items: - $ref: '#/components/schemas/urn_bamm_io.catenax.parts_analyses_1.0.0_PartAnalysis' - PartsAnalyses: - description: List of part analysis for one quality task - type: object - properties: - listOfPartAnalyses: - description: A list of several part analyses - $ref: '#/components/schemas/urn_bamm_io.catenax.parts_analyses_1.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.parts_analyses/1.0.0/metadata.json b/io.catenax.parts_analyses/1.0.0/metadata.json deleted file mode 100644 index 970dbd818..000000000 --- a/io.catenax.parts_analyses/1.0.0/metadata.json +++ /dev/null @@ -1 +0,0 @@ -{ "status" : "deprecate"} \ No newline at end of file diff --git a/io.catenax.parts_analyses/2.0.0/metadata.json b/io.catenax.parts_analyses/2.0.0/metadata.json index a182c7b85..970dbd818 100644 --- a/io.catenax.parts_analyses/2.0.0/metadata.json +++ b/io.catenax.parts_analyses/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.parts_analyses/RELEASE_NOTES.md b/io.catenax.parts_analyses/RELEASE_NOTES.md index 34146ed38..65a61b9d5 100644 --- a/io.catenax.parts_analyses/RELEASE_NOTES.md +++ b/io.catenax.parts_analyses/RELEASE_NOTES.md @@ -17,7 +17,7 @@ All notable changes to this model will be documented in this file. ### Removed - oem properties -> replaced by parent properties -## [2.0.0] - 2023-06-23 +## [2.0.0] - 2023-06-23 -> deprecated ### Added - property manufacturerAnalysisID: ID of internal system from manufacturer - property customerAnalysisID: ID of internal system from customer @@ -32,12 +32,11 @@ All notable changes to this model will be documented in this file. ### Removed -## [1.0.0] - 2022-12-13 +## [1.0.0] - 2022-12-13 -> deprecated ### Added - initial version of this model ### Changed n/a -### Removed - +### Removed \ No newline at end of file diff --git a/io.catenax.pcf/7.0.0/Pcf.ttl b/io.catenax.pcf/7.0.0/Pcf.ttl new file mode 100644 index 000000000..a0bdef2d9 --- /dev/null +++ b/io.catenax.pcf/7.0.0/Pcf.ttl @@ -0,0 +1,851 @@ +####################################################################### +# Copyright (c) 2022, 2023, 2024 ZF Friedrichshafen AG +# Copyright (c) 2022, 2023, 2024 T-Systems International GmbH +# Copyright (c) 2022, 2023, 2024 Robert Bosch Manufacturing Solutions GmbH +# Copyright (c) 2022, 2023, 2024 Siemens AG +# Copyright (c) 2022, 2023, 2024 SAP AG +# Copyright (c) 2022, 2023, 2024 BASF SE +# Copyright (c) 2022, 2023, 2024 Contributors to the Eclipse Foundation +# +# 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-uuid: . + +:Pcf a samm:Aspect ; + samm:preferredName "Product (Carbon) Footprint"@en ; + samm:description "A Product (Carbon) Footprint represents the carbon footprint of a product with values as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the WBCSD (World Business Council for Sustainable Development) Pathfinder framework and the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD/ PACT initiative."@en ; + samm:see ; + samm:properties ( [ samm:property :id; samm:payloadName "id" ] [ samm:property :specVersion; samm:payloadName "specVersion" ] [ samm:property :partialFullPcf; samm:payloadName "partialFullPcf" ] [ samm:property :precedingPfIds; samm:optional true; samm:payloadName "precedingPfIds" ] [ samm:property :version; samm:payloadName "version" ] [ samm:property :created; samm:payloadName "created" ] [ samm:property :status; samm:payloadName "extWBCSD_pfStatus" ] [ samm:property :validityPeriodStart; samm:optional true; samm:payloadName "validityPeriodStart" ] [ samm:property :validityPeriodEnd; samm:optional true; samm:payloadName "validityPeriodEnd" ] [ samm:property :comment; samm:optional true; samm:payloadName "comment" ] [ samm:property :companyName; samm:payloadName "companyName" ] [ samm:property :companyIds; samm:payloadName "companyIds" ] [ samm:property :productDescription; samm:optional true; samm:payloadName "productDescription" ] [ samm:property :productIds; samm:payloadName "productIds" ] [ samm:property :productCategoryCpc; samm:payloadName "extWBCSD_productCodeCpc" ] [ samm:property :productNameCompany; samm:payloadName "productName" ] [ samm:property :pcf; samm:payloadName "pcf" ] [ samm:property :pcfLegalStatement; samm:optional true; samm:payloadName "pcfLegalStatement" ] ) ; + samm:operations ( ) ; + samm:events ( ) . + +:id a samm:Property ; + samm:preferredName "Product Footprint Identifier"@en ; + samm:description "Mandatory: The product footprint identifier as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative."@en ; + samm:see ; + samm:characteristic ext-uuid:UuidV4Trait ; + samm:exampleValue "3893bb5d-da16-4dc1-9185-11d97476c254" . + +:specVersion a samm:Property ; + samm:preferredName "Product Footprint Specification Version"@en ; + samm:description "Mandatory: Version of the product footprint data specification as defined in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative."@en ; + samm:see ; + samm:characteristic samm-c:Text ; + samm:exampleValue "urn:io.catenax.pcf:datamodel:version:7.0.0" . + +:partialFullPcf a samm:Property ; + samm:preferredName "Partial Or Full PCF (Product Carbon Footprint)"@en ; + samm:description "Mandatory: Indicator for partial or full PCF (Product Carbon Footprint) declaration as specified in the Catena-X PCF Rulebook (Version 3.0.0)."@en ; + samm:characteristic :PartialFullPcfCharacteristic ; + samm:exampleValue "Cradle-to-gate" . + +:precedingPfIds a samm:Property ; + samm:preferredName "Previous PCF (Product Carbon Footprint) Identifiers"@en ; + samm:description "Optional: Set of preceding PCF (Product Carbon Footprint) identifiers without duplicates as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the WBCSD (World Business Council for Sustainable Development) Pathfinder framework and the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD/ PACT initiative. Declared as \"optional\" in WBCSD, needs to be covered by application."@en ; + samm:see ; + samm:characteristic :PrecedingPfIdsCharacteristic . + +:version a samm:Property ; + samm:preferredName "Product (Carbon) Footprint Version"@en ; + samm:description "Mandatory: Version of the product (carbon) footprint as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. In Catena-X for example set to \"0\" per default."@en ; + samm:see ; + samm:characteristic :ProductFootprintVersion ; + samm:exampleValue "0"^^xsd:nonNegativeInteger . + +:created a samm:Property ; + samm:preferredName "Creation of the Product (Carbon) Footprint"@en ; + samm:description "Mandatory: Timestamp of the creation of the Product (Carbon) Footprint as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative."@en ; + samm:see ; + samm:characteristic samm-c:Timestamp ; + samm:exampleValue "2022-05-22T21:47:32Z"^^xsd:dateTime . + +:status a samm:Property ; + samm:preferredName "Status"@en ; + samm:description "Mandatory: Status indicator of a product (carbon) footprint as specified in the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. WBCSD specific extension, in Catena-X for example set to \"Active\" per default."@en ; + samm:see ; + samm:characteristic :PfStatusCharacteristic ; + samm:exampleValue "Active" . + +:validityPeriodStart a samm:Property ; + samm:preferredName "Validity Period Start"@en ; + samm:description "Optional: Start of interval during which the product (carbon) footprint is declared as valid as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. If specified, the validity period start must be equal to or greater than the reference period end."@en ; + samm:see ; + samm:characteristic samm-c:Timestamp ; + samm:exampleValue "2022-01-01T00:00:01Z"^^xsd:dateTime . + +:validityPeriodEnd a samm:Property ; + samm:preferredName "Validity Period End"@en ; + samm:description "Optional: End of interval during which the product (carbon) footprint is declared as valid as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative."@en ; + samm:see ; + samm:characteristic samm-c:Timestamp ; + samm:exampleValue "2022-12-31T23:59:59Z"^^xsd:dateTime . + +:comment a samm:Property ; + samm:preferredName "Comment"@en ; + samm:description "Optional: Additional information and instructions related to the calculation of the product (carbon) footprint as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative."@en ; + samm:see ; + samm:characteristic samm-c:Text ; + samm:exampleValue "Additional explanatory information not reflected by other attributes" . + +:companyName a samm:Property ; + samm:preferredName "Company Name"@en ; + samm:description "Mandatory: Name of the product (carbon) footprint data owner as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative."@en ; + samm:see ; + samm:characteristic :NonEmptyStringTrait ; + samm:exampleValue "My Corp" . + +:companyIds a samm:Property ; + samm:preferredName "Company IDs"@en ; + samm:description "Mandatory: Non-empty set of Uniform Resource Names (URN). Each value is supposed to uniquely identify the product (carbon) footprint data owner as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.1.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. For Catena-X Industry Core compliance the set of URNs must contain at least the Business Partner Number Legal Entity (BPNL) in the specified format urn:bpn:id:BPNL[a-zA-Z0-9]{12}. "@en ; + samm:see ; + samm:characteristic :IdsTrait ; + samm:exampleValue "urn:bpn:id:BPNL000000000DW"^^xsd:anyURI . + +:productDescription a samm:Property ; + samm:preferredName "Product Description"@en ; + samm:description "Optional: Free-form description of the product as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative."@en ; + samm:see ; + samm:characteristic samm-c:Text ; + samm:exampleValue "Ethanol, 95% solution" . + +:productIds a samm:Property ; + samm:preferredName "Product IDs"@en ; + samm:description "Mandatory: Non-empty set of product identifiers. Each value is supposed to uniquely identify the product as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.1.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. In Catena-X productId corresponds with Industry Core manufacturerPartId."@en ; + samm:see ; + samm:characteristic :IdsTrait ; + samm:exampleValue "urn:gtin:4712345060507"^^xsd:anyURI . + +:productCategoryCpc a samm:Property ; + samm:preferredName "Product Category"@en ; + samm:description "Mandatory: UN (United Nations) Product Classification Code (CPC - Central Classification Code) of a given product as specified the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. WBCSD specific extension, which will probably be declared as \"optional\" in a later WBCSD specification version. In Catena-X for example specified with default value \"011-99000\"."@en ; + samm:see ; + samm:characteristic samm-c:Text ; + samm:exampleValue "011-99000" . + +:productNameCompany a samm:Property ; + samm:preferredName "Product Trade Name"@en ; + samm:description "Mandatory: Non-empty trade name of a product as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.1.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. In Catena-X productNameCompany corresponds with Industry Core nameAtManufacturer. "@en ; + samm:see ; + samm:characteristic :NonEmptyStringTrait ; + samm:exampleValue "My Product Name" . + +:pcf a samm:Property ; + samm:preferredName "PCF (Product Carbon Footprint)"@en ; + samm:description "A PCF (Product Carbon Footprint) represents the carbon footprint of a product and related data as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative."@en ; + samm:see ; + samm:characteristic :CarbonFootprint . + +:pcfLegalStatement a samm:Property ; + samm:preferredName "PCF (Product Carbon Footprint) Legal Statement"@en ; + samm:description "Optional: Option for legal statement/ disclaimer as specified in the Catena-X PCF Rulebook (Version 3.0.0)."@en ; + samm:characteristic samm-c:Text ; + samm:exampleValue "This PCF (Product Carbon Footprint) is for information purposes only. It is based upon the standards mentioned above." . + +:PartialFullPcfCharacteristic a samm-c:Enumeration ; + samm:preferredName "Partial Or Full PCF (Product Carbon Footprint) Characteristic"@en ; + samm:description "Characteristic for defining an indicator for partial or full PCF (Product Carbon Footprint) declaration as specified in the Catena-X PCF Rulebook (Version 3.0.0)."@en ; + samm:dataType xsd:string ; + samm-c:values ( "Cradle-to-gate" "Cradle-to-grave" ) . + +:PrecedingPfIdsCharacteristic a samm-c:List ; + samm:preferredName "Previous PCF (Product Carbon Footprint) Identifiers Characteristic"@en ; + samm:description "Characteristic for defining a non-empty set of product (carbon) footprint identifiers as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the WBCSD (World Business Council for Sustainable Development) Pathfinder framework and the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD/ PACT initiative."@en ; + samm:see ; + samm:dataType :PrecedingPfId . + +:ProductFootprintVersion a samm:Characteristic ; + samm:preferredName "Product (Carbon) Footprint Version Characteristic"@en ; + samm:description "Characteristic for defining a product footprint version as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative."@en ; + samm:see ; + samm:dataType xsd:nonNegativeInteger . + +:PfStatusCharacteristic a samm-c:Enumeration ; + samm:preferredName "PF (Product Footprint) Status Characteristic"@en ; + samm:description "Characteristic for defining a status indicator of a product (carbon) footprint as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. Enumeration with possible \"Active\" and \"Deprecated\"."@en ; + samm:see ; + samm:dataType xsd:string ; + samm-c:values ( "Active" "Deprecated" ) . + +:NonEmptyStringTrait a samm-c:Trait ; + samm:preferredName "Non Empty String Trait"@en ; + samm:description "Trait for defining a string with at least one character."@en ; + samm-c:baseCharacteristic samm-c:Text ; + samm-c:constraint :NonEmptyString . + +:IdsTrait a samm-c:Trait ; + samm:preferredName "IDs Trait"@en ; + samm:description "Trait for URIs (Uniform Resource Identifiers)."@en ; + samm-c:baseCharacteristic :IdSet ; + samm-c:constraint :NonEmptySetConstraint . + +:CarbonFootprint a samm-c:SingleEntity ; + samm:preferredName "PCF (Product Carbon Footprint) Characteristic"@en ; + samm:description "Characteristic for defining a PCF (Product Carbon Footprint) as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative."@en ; + samm:dataType :PcfEntity . + +:PrecedingPfId a samm:Entity ; + samm:preferredName "Preceding PCF (Product Carbon Footprint) Identifier Entity"@en ; + samm:description "Entity for defining a preceding PCF (Product Carbon Footprint) identifier entity as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative."@en ; + samm:see ; + samm:properties ( :id ) . + +:NonEmptyString a samm-c:LengthConstraint ; + samm:preferredName "Non Empty String Constraint"@en ; + samm:description "Constraint for ensuring that a string has at least one character."@en ; + samm-c:minValue "1"^^xsd:nonNegativeInteger . + +:IdSet a samm-c:List ; + samm:preferredName "ID Set Characteristic"@en ; + samm:description "Characteristic for defining a set of URIs (Uniform Resource Identifiers)."@en ; + samm:dataType xsd:anyURI . + +:NonEmptySetConstraint a samm-c:LengthConstraint ; + samm:preferredName "Non Empty Set Constraint"@en ; + samm:description "Constraint for defining a non-empty set of URIs (Uniform Resource Identifieres)."@en ; + samm-c:minValue "1"^^xsd:nonNegativeInteger . + +:PcfEntity a samm:Entity ; + samm:preferredName "PCF (Product Carbon Footprint) Entity"@en ; + samm:description "Entity for defining a PCF (Product Carbon Footprint) as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative."@en ; + samm:see ; + samm:properties ( [ samm:property :declaredUnit; samm:payloadName "declaredUnit" ] [ samm:property :unitaryProductAmount; samm:payloadName "unitaryProductAmount" ] [ samm:property :productMassPerDeclaredUnit; samm:payloadName "productMassPerDeclaredUnit" ] [ samm:property :exemptedEmissionsPercent; samm:payloadName "exemptedEmissionsPercent" ] [ samm:property :exemptedEmissionsDescription; samm:optional true; samm:payloadName "exemptedEmissionsDescription" ] [ samm:property :boundaryProcessesDescription; samm:optional true; samm:payloadName "boundaryProcessesDescription" ] [ samm:property :geographyCountrySubdivision; samm:optional true; samm:payloadName "geographyCountrySubdivision" ] [ samm:property :geographyCountry; samm:optional true; samm:payloadName "geographyCountry" ] [ samm:property :geographyRegionOrSubregion; samm:payloadName "geographyRegionOrSubregion" ] [ samm:property :referencePeriodStart; samm:payloadName "referencePeriodStart" ] [ samm:property :referencePeriodEnd; samm:payloadName "referencePeriodEnd" ] [ samm:property :crossSectoralStandardsUsed; samm:payloadName "crossSectoralStandardsUsed" ] [ samm:property :productOrSectorSpecificRules; samm:payloadName "productOrSectorSpecificRules" ] [ samm:property :characterizationFactors; samm:payloadName "extWBCSD_characterizationFactors" ] [ samm:property :allocationRulesDescription; samm:optional true; samm:payloadName "extWBCSD_allocationRulesDescription" ] [ samm:property :allocationWasteIncineration; samm:payloadName "extTFS_allocationWasteIncineration" ] [ samm:property :primaryDataShare; samm:optional true; samm:payloadName "primaryDataShare" ] [ samm:property :secondaryEmissionFactorSources; samm:payloadName "secondaryEmissionFactorSources" ] [ samm:property :dqi; samm:optional true; samm:payloadName "dataQualityRating" ] [ samm:property :packagingEmissionsIncluded; samm:payloadName "extWBCSD_packagingEmissionsIncluded" ] [ samm:property :pcfExcludingBiogenic; samm:payloadName "pcfExcludingBiogenic" ] [ samm:property :pcfIncludingBiogenic; samm:optional true; samm:payloadName "pcfIncludingBiogenic" ] [ samm:property :fossilGhgEmissions; samm:optional true; samm:payloadName "fossilGhgEmissions" ] [ samm:property :biogenicCarbonEmissionsOtherThanCO2; samm:optional true; samm:payloadName "biogenicCarbonEmissionsOtherThanCO2" ] [ samm:property :biogenicCarbonWithdrawal; samm:optional true; samm:payloadName "biogenicCarbonWithdrawal" ] [ samm:property :dlucGhgEmissions; samm:optional true; samm:payloadName "dlucGhgEmissions" ] [ samm:property :luGhgEmissions; samm:optional true; samm:payloadName "extTFS_luGhgEmissions" ] [ samm:property :aircraftGhgEmissions; samm:optional true; samm:payloadName "aircraftGhgEmissions" ] [ samm:property :packagingGhgEmissions; samm:optional true; samm:payloadName "extWBCSD_packagingGhgEmissions" ] [ samm:property :distributionStagePcfExcludingBiogenic; samm:optional true; samm:payloadName "distributionStagePcfExcludingBiogenic" ] [ samm:property :distributionStagePcfIncludingBiogenic; samm:optional true; samm:payloadName "distributionStagePcfIncludingBiogenic" ] [ samm:property :distributionStageFossilGhgEmissions; samm:optional true; samm:payloadName "distributionStageFossilGhgEmissions" ] [ samm:property :distributionStageBiogenicCarbonEmissionsOtherThanCO2; samm:optional true; samm:payloadName "distributionStageBiogenicCarbonEmissionsOtherThanCO2" ] [ samm:property :distributionStageBiogenicCarbonWithdrawal; samm:optional true; samm:payloadName "distributionStageBiogenicCarbonWithdrawal" ] [ samm:property :distributionStageDlucGhgEmissions; samm:optional true; samm:payloadName "extTFS_distributionStageDlucGhgEmissions" ] [ samm:property :distributionStageLuGhgEmissions; samm:optional true; samm:payloadName "extTFS_distributionStageLuGhgEmissions" ] [ samm:property :carbonContentTotal; samm:optional true; samm:payloadName "carbonContentTotal" ] [ samm:property :fossilCarbonContent; samm:optional true; samm:payloadName "extWBCSD_fossilCarbonContent" ] [ samm:property :biogenicCarbonContent; samm:optional true; samm:payloadName "carbonContentBiogenic" ] [ samm:property :distributionStageAircraftGhgEmissions; samm:optional true; samm:payloadName "distributionStageAircraftGhgEmissions" ] ) . + +:declaredUnit a samm:Property ; + samm:preferredName "Unit of measurement"@en ; + samm:description "Mandatory: Unit of analysis of a product in context of the PCF (product carbon footprint) as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. In Catena-X for example list of valid units includes \"piece\"."@en ; + samm:see ; + samm:characteristic :DeclaredUnitCharacteristic ; + samm:exampleValue "kilogram" . + +:unitaryProductAmount a samm:Property ; + samm:preferredName "Unitary Product Amount"@en ; + samm:description "Mandatory: Amount of units contained within a product in context of the PCF (Product Carbon Footprint) as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative."@en ; + samm:see ; + samm:characteristic :StrictlyPositiveDecimalTrait ; + samm:exampleValue "1000.0"^^xsd:float . + +:productMassPerDeclaredUnit a samm:Property ; + samm:preferredName "Product Mass Per Declared Unit"@en ; + samm:description "Mandatory: Mass of a product per declared unit (net, unpackaged) in context of the PCF (Product Carbon Footprint) as specified in the Catena-X PCF Rulebook (Version 3.0.0)."@en ; + samm:characteristic :PositiveDecimalWeightTrait ; + samm:exampleValue "0.456"^^xsd:decimal . + +:exemptedEmissionsPercent a samm:Property ; + samm:preferredName "Exempted Emissions Percent"@en ; + samm:description "Mandatory: Applied cut-off percentage of emissions excluded from PCF (Product Carbon Footprint).\nFor accordance with Catena-X PCF Rulebook (Version 3.0.0) <3%."@en ; + samm:see ; + samm:characteristic :ExemptedEmissionsPercentTrait ; + samm:exampleValue "0.0"^^xsd:decimal . + +:exemptedEmissionsDescription a samm:Property ; + samm:preferredName "Exempted Emissions Description"@en ; + samm:description "Optional: Rationale behind exclusion of specific PCF (Product Carbon Footprint) emissions as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative."@en ; + samm:see ; + samm:characteristic samm-c:Text ; + samm:exampleValue "No exemption" . + +:boundaryProcessesDescription a samm:Property ; + samm:preferredName "Boundary Processes Description"@en ; + samm:description "Optional: Processes attributable to each lifecycle stage as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative."@en ; + samm:see ; + samm:characteristic samm-c:Text ; + samm:exampleValue "Electricity consumption included as an input in the production phase" . + +:geographyCountrySubdivision a samm:Property ; + samm:preferredName "Geography Country Subdivision"@en ; + samm:description "Optional: Subdivision of a country which must be an ISO 3166-2 subdivision code as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative."@en ; + samm:see ; + samm:characteristic :GeographyCountrySubdivisionTrait ; + samm:exampleValue "US-NY" . + +:geographyCountry a samm:Property ; + samm:preferredName "Geography Country"@en ; + samm:description "Optional: Two letter country code that must conform to data type ISO 3166CC as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative."@en ; + samm:see ; + samm:characteristic :GeographyCountryTrait ; + samm:exampleValue "DE" . + +:geographyRegionOrSubregion a samm:Property ; + samm:preferredName "Region"@en ; + samm:description "Mandatory: Region according to list as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative."@en ; + samm:see ; + samm:characteristic :GeographyRegionOrSubregionCharacteristic ; + samm:exampleValue "Europe" . + +:referencePeriodStart a samm:Property ; + samm:preferredName "Reference Period Start"@en ; + samm:description "Mandatory: Start of time boundary for which a PCF (Product Carbon Footprint) value is considered to be representative as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative."@en ; + samm:see ; + samm:characteristic samm-c:Timestamp ; + samm:exampleValue "2022-01-01T00:00:01Z"^^xsd:dateTime . + +:referencePeriodEnd a samm:Property ; + samm:preferredName "Reference Period End"@en ; + samm:description "Mandatory: End of time boundary for which a PCF (Product Carbon Footprint) value is considered to be representative as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative."@en ; + samm:see ; + samm:characteristic samm-c:Timestamp ; + samm:exampleValue "2022-12-31T23:59:59Z"^^xsd:dateTime . + +:crossSectoralStandardsUsed a samm:Property ; + samm:preferredName "Cross Sectoral Standards Used"@en ; + samm:description "Mandatory: Discloses the cross-sectoral standards applied for calculating or allocating GHG (Greenhouse Gas) emissions as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative."@en ; + samm:see ; + samm:characteristic :CrossSectoralStandardSet . + +:productOrSectorSpecificRules a samm:Property ; + samm:preferredName "Product or Sector Specific Rules"@en ; + samm:description "Mandatory: Product or sector specific rules applied for calculating or allocating GHG (Greenhouse Gas) emissions, e.g. PCRs (Product Category Rules), including operators or publishers and according rule names as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative."@en ; + samm:see ; + samm:characteristic :ProductOrSectorSpecificRuleSet . + +:characterizationFactors a samm:Property ; + samm:preferredName "Characterization Factors"@en ; + samm:description "Mandatory: IPCC (Intergovernmental Panel on Climate Change) version of the GWP (Global Warming Potential) characterization factors used for calculating the PCF (Product Carbon Footprint) as specified in the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. WBCSD specific extension, in Catena-X for example specified by default with value \\\"AR6\\\". Default value can be overwritten."@en ; + samm:see ; + samm:characteristic :CharacterizationFactorsCharacteristic ; + samm:exampleValue "AR6" . + +:allocationRulesDescription a samm:Property ; + samm:preferredName "Allocation Rules Description"@en ; + samm:description "Optional: Allocation rules used and underlying reasoning in context of a product carbon footprint as specified in the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. WBCSD specific extension, in Catena-X for example specified by default with value \"In accordance with Catena-X PCF Rulebook (Version 3.0.0)\"."@en ; + samm:see ; + samm:characteristic samm-c:Text ; + samm:exampleValue "In accordance with Catena-X PCF Rulebook" . + +:allocationWasteIncineration a samm:Property ; + samm:preferredName "Allocation Waste Incineration"@en ; + samm:description "Mandatory: Allocation approach used for waste incineration with energy recovery as specified by the TFS (Together For Sustainability) initiative. In Catena-X for example must be specified by value \"cut-off\"."@en ; + samm:characteristic :AllocationWasteIncinerationCharacteristic ; + samm:exampleValue "cut-off" . + +:primaryDataShare a samm:Property ; + samm:preferredName "Primary Data Share"@en ; + samm:description "Mandatory starting 2025: Share of primary data in percent as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative."@en ; + samm:see ; + samm:characteristic :PercentTrait ; + samm:exampleValue "56.12"^^xsd:decimal . + +:secondaryEmissionFactorSources a samm:Property ; + samm:preferredName "Secondary Emission Factor Sources"@en ; + samm:description "Mandatory: Emission factors used for the PCF (Product Carbon Footprint) calculation as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative."@en ; + samm:see ; + samm:characteristic :EmissionFactorDSSet . + +:dqi a samm:Property ; + samm:preferredName "DQI (Data Quality Indicators)"@en ; + samm:description "Mandatory starting 2025: Quantitative data quality indicators of a PCF (Product Carbon Footprint) as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative."@en ; + samm:see ; + samm:characteristic :DataQualityIndicators . + +:packagingEmissionsIncluded a samm:Property ; + samm:preferredName "Packaging Emissions Included"@en ; + samm:description "Mandatory: The Catena-X PCF Rulebook requires to include packaging from a system boundary perspective. \"FALSE\" is only possible due to the application of the cut-off rule.\nFlag indicating whether packaging emissions are included in a PCF (Product Carbon Footprint) as specified in the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. WBCSD specific extension."@en ; + samm:see ; + samm:characteristic samm-c:Boolean . + +:pcfExcludingBiogenic a samm:Property ; + samm:preferredName "PCF (Product Carbon Footprint) Excluding Biogenic"@en ; + samm:description "Mandatory: Product carbon footprint of a product excluding biogenic emissions as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative."@en ; + samm:see ; + samm:characteristic :PositiveEmissionsTrait ; + samm:exampleValue "2.0"^^xsd:decimal . + +:pcfIncludingBiogenic a samm:Property ; + samm:preferredName "PCF (Product Carbon Footprint) Including Biogenic"@en ; + samm:description "Mandatory starting 2025: Product carbon footprint of a product including biogenic emissions as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. Optional value in current specification version but will be mandatory in future version."@en ; + samm:see ; + samm:characteristic :PositiveOrNegativeEmission ; + samm:exampleValue "1.0"^^xsd:decimal . + +:fossilGhgEmissions a samm:Property ; + samm:preferredName "Fossil Emissions"@en ; + samm:description "Mandatory starting 2025: Emissions from combustion of fossil sources as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. Identical to \"pcfExcludingBiogenic\", will be removed in later version."@en ; + samm:see ; + samm:characteristic :PositiveEmissionsTrait ; + samm:exampleValue "0.5"^^xsd:decimal . + +:biogenicCarbonEmissionsOtherThanCO2 a samm:Property ; + samm:preferredName "Biogenic Carbon Emissions Other Than CO2"@en ; + samm:description "Mandatory starting 2025: GWP (Global Warming Potential) of biogenic CO2e-emissions in production phase which contain only GHG (Greenhouse Gas) emissions other than CO2 - excludes biogenic CO2. For specification see Catena-X PCF Rulebook (Version 3.0.0)."@en ; + samm:characteristic :PositiveEmissionsTrait ; + samm:exampleValue "1.0"^^xsd:decimal . + +:biogenicCarbonWithdrawal a samm:Property ; + samm:preferredName "Biogenic Carbon Withdrawal"@en ; + samm:description "Mandatory starting 2025: Biogenic carbon content in the product converted to CO2e as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.1.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative."@en ; + samm:see ; + samm:characteristic :NegativeEmissionsTrait ; + samm:exampleValue "0.0"^^xsd:decimal . + +:dlucGhgEmissions a samm:Property ; + samm:preferredName "dLUC (direct land use change) GHG (Greenhouse Gas) Emissions"@en ; + samm:description "Mandatory starting 2025: Direct land use change CO2e emissions in context of a product carbon footprint as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative."@en ; + samm:characteristic :PositiveEmissionsTrait ; + samm:exampleValue "0.4"^^xsd:decimal . + +:luGhgEmissions a samm:Property ; + samm:preferredName "LU (Land Use) GHG (Greenhouse Gas) Emissions"@en ; + samm:description "Mandatory starting 2025: Land use CO2 emissions in context of a product carbon footprint as specified by the TFS (Together For Sustainability) initiative. TFS specific extension."@en ; + samm:characteristic :PositiveOrNegativeEmission ; + samm:exampleValue "0.3"^^xsd:decimal . + +:aircraftGhgEmissions a samm:Property ; + samm:preferredName "Aircraft GHG Emissions"@en ; + samm:description "Mandatory starting 2025: GHG (Greenhouse Gas) emissions resulting from aircraft engine usage for the transport of the product as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative."@en ; + samm:see ; + samm:characteristic :PositiveEmissionsTrait ; + samm:exampleValue "0.0"^^xsd:decimal . + +:packagingGhgEmissions a samm:Property ; + samm:preferredName "Packaging GHG (Greenhouse Gas) Emissions"@en ; + samm:description "Optional: Emissions resulting from the packaging of the product as specified in the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. WBCSD specific extension. In Catena-X not relevant to be reported separately."@en ; + samm:see ; + samm:characteristic :PositiveEmissionsTrait ; + samm:exampleValue "0"^^xsd:decimal . + +:distributionStagePcfExcludingBiogenic a samm:Property ; + samm:preferredName "Distribution Stage PCF (Product Carbon Footprint) Excluding Biogenic"@en ; + samm:description "Optional: Product carbon footprint for the distribution stage of a product excluding biogenic emissions as specified in the Catena-X PCF Rulebook (Version 3.0.0)."@en ; + samm:characteristic :PositiveEmissionsTrait ; + samm:exampleValue "1.5"^^xsd:decimal . + +:distributionStagePcfIncludingBiogenic a samm:Property ; + samm:preferredName "Distribution Stage PCF (Product Carbon Footprint) Including Biogenic"@en ; + samm:description "Optional: Product carbon footprint for the distribution stage of a product including biogenic emissions as specified in the Catena-X PCF Rulebook (Version 3.0.0)."@en ; + samm:characteristic :PositiveOrNegativeEmission ; + samm:exampleValue "0.0"^^xsd:decimal . + +:distributionStageFossilGhgEmissions a samm:Property ; + samm:preferredName "Distribution Stage Fossil GHG (Greenhouse Gas) Emissions"@en ; + samm:description "Optional: Emissions from the combustion of fossil sources in the distribution stage as specified in the Catena-X PCF Rulebook (Version 3.0.0)."@en ; + samm:characteristic :PositiveEmissionsTrait ; + samm:exampleValue "0.5"^^xsd:decimal . + +:distributionStageBiogenicCarbonEmissionsOtherThanCO2 a samm:Property ; + samm:preferredName "Distribution Stage Biogenic Carbon Emissions Other Than CO2"@en ; + samm:description "Optional: GWP (Global Warming Potential) of biogenic CO2e-emissions in distribution phase which contain only GHG (Greenhouse Gas) emissions other than CO2 ? excludes biogenic CO2. For specification see Catena-X PCF Rulebook (Version 3.0.0)."@en ; + samm:characteristic :PositiveEmissionsTrait ; + samm:exampleValue "1.0"^^xsd:decimal . + +:distributionStageBiogenicCarbonWithdrawal a samm:Property ; + samm:preferredName "Distribution Stage Biogenic Carbon Withdrawal"@en ; + samm:description "Optional: GWP (Global Warming Potential) of biogenic CO2-withdrawal in distribution stage (biogenic CO2 contained in the product) as specified in the Catena-X PCF Rulebook (Version 3.0.0)."@en ; + samm:characteristic :NegativeEmissionsTrait ; + samm:exampleValue "0.0"^^xsd:decimal . + +:distributionStageDlucGhgEmissions a samm:Property ; + samm:preferredName "Distribution Stage dLUC (direct land use change) GHG (Greenhouse Gas) Emissions"@en ; + samm:description "Optional: Direct land use change CO2 emissions during distribution stage in context of a product carbon footprint as specified by the TFS (Together For Sustainability) initiative. TFS specific extension."@en ; + samm:characteristic :PositiveEmissionsTrait ; + samm:exampleValue "1.0"^^xsd:decimal . + +:distributionStageLuGhgEmissions a samm:Property ; + samm:preferredName "Distribution Stage LU (Land Use) GHG (Greenhouse Gas) Emissions"@en ; + samm:description "Optional: Land use CO2 emissions in context of a product carbon footprint as specified by the TFS (Together For Sustainability) initiative. TFS specific extension."@en ; + samm:characteristic :PositiveOrNegativeEmission ; + samm:exampleValue "1.1"^^xsd:decimal . + +:carbonContentTotal a samm:Property ; + samm:preferredName "Carbon Content Total"@en ; + samm:description "Mandatory starting 2025: Total carbon content per declared unit in context of a product carbon footprint as specified in the Catena-X PCF Rulebook (Version 3.0.0)."@en ; + samm:characteristic :PositiveEmissionsTrait ; + samm:exampleValue "2.5"^^xsd:decimal . + +:fossilCarbonContent a samm:Property ; + samm:preferredName "Fossil Carbon Content"@en ; + samm:description "Mandatory starting 2025: Fossil carbon amount embodied in a product as specified in the technical specifications for PCF Data Exchange (Version 2.1.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. Must be calculated with kgC (kilogram Carbon) / declaredUnit equal to or greater zero; WBCSD specific extension, in Catena-X specified by a calculated value."@en ; + samm:see ; + samm:characteristic :PositiveEmissionsTrait ; + samm:exampleValue "0.1"^^xsd:decimal . + +:biogenicCarbonContent a samm:Property ; + samm:preferredName "Biogenic Carbon Content"@en ; + samm:description "Mandatory starting 2025: Biogenic carbon amount embodied in a product as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.1.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. Must be calculated with kgC (kilogram Carbon) / declaredUnit equal to or greater zero."@en ; + samm:see ; + samm:characteristic :PositiveEmissionsTrait ; + samm:exampleValue "0.0"^^xsd:decimal . + +:distributionStageAircraftGhgEmissions a samm:Property ; + samm:preferredName "Distribution Stage Aircraft GHG Emissions"@en ; + samm:description "Optional: GHG (Greenhouse Gas) emissions for the distribution stage resulting from aircraft engine usage for the transport of the product as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative."@en ; + samm:see ; + samm:characteristic :PositiveEmissionsTrait ; + samm:exampleValue "0.0"^^xsd:decimal . + +:DeclaredUnitCharacteristic a samm-c:Enumeration ; + samm:preferredName "Declared Unit Characteristic"@en ; + samm:description "Unit of analysis of the product with accepted values as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. For countable products/ components/ materials, Catena-X for example adds the unit \"piece\" to the value list specified by WBCSD."@en ; + samm:see ; + samm:dataType xsd:string ; + samm-c:values ( "liter" "kilogram" "cubic meter" "kilowatt hour" "megajoule" "ton kilometer" "square meter" "piece" ) . + +:StrictlyPositiveDecimalTrait a samm-c:Trait ; + samm:preferredName "Strictly Positive Decimal Trait"@en ; + samm:description "Trait for defining a positive, non-zero decimal."@en ; + samm-c:baseCharacteristic :StrictlyPositiveDecimal ; + samm-c:constraint :StrictlyPositiveDecimalConstraint . + +:PositiveDecimalWeightTrait a samm-c:Trait ; + samm:preferredName "Positive Decimal Weight Trait"@en ; + samm:description "Trait for defining a decimal weight value declared in kg equal to or greater than zero."@en ; + samm-c:baseCharacteristic :PositiveDecimalWeight ; + samm-c:constraint :PositiveDecimalConstraint . + +:ExemptedEmissionsPercentTrait a samm-c:Trait ; + samm:preferredName "Exempted Emissions Percent Trait"@en ; + samm:description "Trait for defining a percentage value for exempted emissions in context of a product carbon footprint."@en ; + samm-c:baseCharacteristic :ExemptedEmissionsPercentCharacteristic ; + samm-c:constraint :ExemptedEmissionsPercentConstraint . + +:GeographyCountrySubdivisionTrait a samm-c:Trait ; + samm:preferredName "Geography Country Subdivision Trait"@en ; + samm:description "Trait for defining a country subdivision in context of a product carbon footprint."@en ; + samm-c:baseCharacteristic samm-c:Text ; + samm-c:constraint :GeographyCountrySubdivisionConstraint . + +:GeographyCountryTrait a samm-c:Trait ; + samm:preferredName "Geography Country Trait"@en ; + samm:description "Trait for defining a geography country in context of a product carbon footprint."@en ; + samm-c:baseCharacteristic samm-c:Text ; + samm-c:constraint :GeographyCountryConstraint . + +:GeographyRegionOrSubregionCharacteristic a samm-c:Enumeration ; + samm:preferredName "Geography Region Or Subregion Characteristic"@en ; + samm:description "Characteristic for defining a list of valid geographic regions as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. In Catena-X for example \"Global\" has been added to the value list."@en ; + samm:see ; + samm:dataType xsd:string ; + samm-c:values ( "Africa" "Americas" "Asia" "Europe" "Oceania" "Australia and New Zealand" "Central Asia" "Eastern Asia" "Eastern Europe" "Latin America and the Caribbean" "Melanesia" "Micronesia" "Northern Africa" "Northern America" "Northern Europe" "Polynesia" "South-eastern Asia" "Southern Asia" "Southern Europe" "Sub-Saharan Africa" "Western Asia" "Western Europe" "Global" "Several" ) . + +:CrossSectoralStandardSet a samm-c:List ; + samm:preferredName "Cross Sectoral Standards Used Characteristic"@en ; + samm:description "Characteristic for defining the list of valid accounting standards used for product carbon footprint calculation as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative."@en ; + samm:see ; + samm:dataType :CrossSectoralStandard . + +:ProductOrSectorSpecificRuleSet a samm-c:Set ; + samm:preferredName "Product Or Sector Specific Rules Set"@en ; + samm:description "Characteristic for defining the set of product or sector specific rules of a product carbon footprint as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative."@en ; + samm:see ; + samm:dataType :ProductOrSectorSpecificRule . + +:CharacterizationFactorsCharacteristic a samm-c:Enumeration ; + samm:preferredName "Characterization Factors Characteristic"@en ; + samm:description "Characteristic for defining the characterization factors of a product carbon footprint as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. In Catena-X for example specified by a default value."@en ; + samm:see ; + samm:dataType xsd:string ; + samm-c:values ( "AR5" "AR6" ) . + +:AllocationWasteIncinerationCharacteristic a samm-c:Enumeration ; + samm:preferredName "Allocation Waste Incineration Characteristic"@en ; + samm:description "Characteristic for defining the allocation approach used for waste incineration as specified by the TFS (Together For Sustainability) initiative."@en ; + samm:dataType xsd:string ; + samm-c:values ( "cut-off" "reverse cut-off" "system expansion" ) . + +:PercentTrait a samm-c:Trait ; + samm:preferredName "Percent Trait"@en ; + samm:description "Trait for a decimal number in the range of and including 0 and 100."@en ; + samm-c:baseCharacteristic :Percent ; + samm-c:constraint :PercentConstraint . + +:EmissionFactorDSSet a samm-c:Set ; + samm:preferredName "Emission Factor Data Sources Set Characteristic"@en ; + samm:description "Characteristic for defining a set of emission factor sources used for calculating a product carbon footprint as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative."@en ; + samm:see ; + samm:dataType :EmissionFactorDS . + +:DataQualityIndicators a samm:Characteristic ; + samm:preferredName "Data Quality Indicators"@en ; + samm:description "Characteristic for defining the quantitative data quality indicators of a PCF (Product Carbon Footprint) as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative."@en ; + samm:see ; + samm:dataType :DataQualityIndicator . + +:PositiveEmissionsTrait a samm-c:Trait ; + samm:preferredName "Positive Emissions Trait"@en ; + samm:description "Trait for emissions equal to or greater than zero in context of a PCF (Product Carbon Footprint)."@en ; + samm-c:baseCharacteristic :PositiveEmission ; + samm-c:constraint :PositiveEmissionConstraint . + +:PositiveOrNegativeEmission a samm-c:Quantifiable ; + samm:preferredName "Positive Or Negative Emission"@en ; + samm:description "Characteristic for defining (positive or negative) emissions in context of a PCF (Product Carbon Footprint) as specified by the WBCSD (World Business Council for Sustainable Development) Pathfinder initiative."@en ; + samm:see ; + samm:dataType xsd:decimal . + +:NegativeEmissionsTrait a samm-c:Trait ; + samm:preferredName "Negative Emissions Trait"@en ; + samm:description "Trait for emissions equal to or less than zero in context of a PCF (Product Carbon Footprint)."@en ; + samm-c:baseCharacteristic :NegativeEmission ; + samm-c:constraint :NegativeEmissionConstraint . + +:StrictlyPositiveDecimal a samm:Characteristic ; + samm:preferredName "Strictly Positive Decimal"@en ; + samm:description "A positive, non-zero decimal."@en ; + samm:dataType xsd:float . + +:StrictlyPositiveDecimalConstraint a samm-c:RangeConstraint ; + samm:preferredName "Strictly Positive Decimal Constraint"@en ; + samm:description "Constraint for defining a positive, non-zero decimal."@en ; + samm-c:minValue "0.0"^^xsd:float ; + samm-c:lowerBoundDefinition samm-c:GREATER_THAN ; + samm-c:upperBoundDefinition samm-c:LESS_THAN . + +:PositiveDecimalWeight a samm-c:Quantifiable ; + samm:preferredName "Positive Decimal Weight"@en ; + samm:description "Characteristic for defining a decimal weight value declared in unit kilogram equal to or greater than zero."@en ; + samm:dataType xsd:decimal ; + samm-c:unit unit:kilogram . + +:PositiveDecimalConstraint a samm-c:RangeConstraint ; + samm:preferredName "Positive Decimal Constraint"@en ; + samm:description "Constraint for defining a decimal equal to or greater than zero."@en ; + samm-c:minValue "0"^^xsd:decimal ; + samm-c:lowerBoundDefinition samm-c:AT_LEAST ; + samm-c:upperBoundDefinition samm-c:LESS_THAN . + +:ExemptedEmissionsPercentCharacteristic a samm-c:Quantifiable ; + samm:preferredName "Exempted Emissions Percent Characteristic"@en ; + samm:description "Characteristic for defining the percentage of emissions excluded from a PCF (Product Carbon Footprint) as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative."@en ; + samm:see ; + samm:dataType xsd:decimal . + +:ExemptedEmissionsPercentConstraint a samm-c:RangeConstraint ; + samm:preferredName "Exempted Emissions Percent Constraint"@en ; + samm:description "Characteristic for defining the percentage of emissions excluded from a PCF (Product Carbon Footprint) as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative."@en ; + samm:see ; + samm-c:minValue "0.0"^^xsd:decimal ; + samm-c:maxValue "5.0"^^xsd:decimal ; + samm-c:lowerBoundDefinition samm-c:AT_LEAST ; + samm-c:upperBoundDefinition samm-c:AT_MOST . + +:GeographyCountrySubdivisionConstraint a samm-c:RegularExpressionConstraint ; + samm:preferredName "Subdivision Constraint"@en ; + samm:description "Constraint for defining a geography country subdivision in compliance to ISO 3166-2 as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative."@en ; + samm:see ; + samm:value "([A-Z]{2}-[A-Z0-9]{1,3}|)" . + +:GeographyCountryConstraint a samm-c:RegularExpressionConstraint ; + samm:preferredName "Country Constraint"@en ; + samm:description "Constraint for defining a geography country conform to ISO 3166CC as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative."@en ; + samm:see ; + samm:value "([A-Z]{2})" . + +:CrossSectoralStandard a samm:Entity ; + samm:preferredName "Cross Sectoral Standard Entity"@en ; + samm:description "Entity for defining an accounting standard used for product carbon footprint calculation as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative."@en ; + samm:see ; + samm:properties ( [ samm:property :crossSectoralStandard; samm:payloadName "crossSectoralStandard" ] ) . + +:ProductOrSectorSpecificRule a samm:Entity ; + samm:preferredName "Product Or Sector Specific Rule"@en ; + samm:description "Entity for defining a product or sector specific rule of a product carbon footprint as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative."@en ; + samm:see ; + samm:properties ( [ samm:property :operator; samm:payloadName "extWBCSD_operator" ] [ samm:property :ruleNames; samm:payloadName "productOrSectorSpecificRules" ] [ samm:property :otherOperatorName; samm:optional true; samm:payloadName "extWBCSD_otherOperatorName" ] ) . + +:Percent a samm-c:Quantifiable ; + samm:preferredName "Percent"@en ; + samm:description "Decimal number in the range of and including 0 and 100."@en ; + samm:dataType xsd:decimal ; + samm-c:unit unit:percent . + +:PercentConstraint a samm-c:RangeConstraint ; + samm:preferredName "Percent Constraint"@en ; + samm:description "Constraint for a decimal number in the range of and including 0 and 100."@en ; + samm-c:minValue "0.0"^^xsd:decimal ; + samm-c:maxValue "100.0"^^xsd:decimal ; + samm-c:lowerBoundDefinition samm-c:AT_LEAST ; + samm-c:upperBoundDefinition samm-c:AT_MOST . + +:EmissionFactorDS a samm:Entity ; + samm:preferredName "Emission Factor Data Source Entity"@en ; + samm:description "Entity for defining an emission factor data source used to calculate a product carbon footprint as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative."@en ; + samm:see ; + samm:properties ( [ samm:property :emissionFactorDS; samm:payloadName "secondaryEmissionFactorSource" ] ) . + +:DataQualityIndicator a samm:Entity ; + samm:preferredName "Data Quality Indicator"@en ; + samm:description "Entity for defining a quantitative data quality indicator of a PCF (Product Carbon Footprint) as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative."@en ; + samm:see ; + samm:properties ( [ samm:property :coveragePercent; samm:optional true; samm:payloadName "coveragePercent" ] [ samm:property :technologicalDQR; samm:optional true; samm:payloadName "technologicalDQR" ] [ samm:property :temporalDQR; samm:optional true; samm:payloadName "temporalDQR" ] [ samm:property :geographicalDQR; samm:optional true; samm:payloadName "geographicalDQR" ] [ samm:property :completenessDQR; samm:optional true; samm:payloadName "completenessDQR" ] [ samm:property :reliabilityDQR; samm:optional true; samm:payloadName "reliabilityDQR" ] ) . + +:PositiveEmission a samm-c:Quantifiable ; + samm:preferredName "Positive Emission"@en ; + samm:description "Characteristic for defining emissions expressed as a decimal equal to or greater than zero in context of a PCF (Product Carbon Footprint) as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative."@en ; + samm:see ; + samm:dataType xsd:decimal . + +:PositiveEmissionConstraint a samm-c:RangeConstraint ; + samm:preferredName "PositiveEmissionConstraint"@en ; + samm:description "Only positive emission values (>0) are valid "@en ; + samm-c:minValue "0.0"^^xsd:decimal ; + samm-c:lowerBoundDefinition samm-c:AT_LEAST ; + samm-c:upperBoundDefinition samm-c:LESS_THAN . + +:NegativeEmission a samm-c:Quantifiable ; + samm:preferredName "Negative Emission"@en ; + samm:description "Characteristic for defining emissions expressed as a decimal equal to or less than zero in context of a PCF (Product Carbon Footprint) as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.1.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative."@en ; + samm:dataType xsd:decimal . + +:NegativeEmissionConstraint a samm-c:RangeConstraint ; + samm:preferredName "Negative Emission Constraint"@en ; + samm:description "Only negative emission values (<=0) are valid."@en ; + samm-c:maxValue "0.0"^^xsd:decimal ; + samm-c:lowerBoundDefinition samm-c:GREATER_THAN ; + samm-c:upperBoundDefinition samm-c:AT_MOST . + +:crossSectoralStandard a samm:Property ; + samm:preferredName "Cross Sectoral Standard"@en ; + samm:description "Mandatory: Discloses a cross-sectoral standard applied for calculating or allocating GHG (Greenhouse Gas) emissions as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative."@en ; + samm:see ; + samm:characteristic :CrossSectoralStandardsUsedEnumerationCharacteristic ; + samm:exampleValue "ISO Standard 14044" . + +:operator a samm:Property ; + samm:preferredName "Operator or Publisher of Sector Specific Rules"@en ; + samm:description "Mandatory: Operator of PCR (Product Category Rule)/ PSR (Product Specific Rule) as specified in the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. WBCSD specific extension, in Catena-X for example must always be \"Other\"."@en ; + samm:see ; + samm:characteristic :ProductOrSectorSpecificRuleOperator ; + samm:exampleValue "Other" . + +:ruleNames a samm:Property ; + samm:preferredName "Product or Sector Specific Rule Names"@en ; + samm:description "Mandatory: Product-specific or sector-specific set of rules used for calculating or allocating GHG (Greenhouse Gas) emissions applied from the specified operator as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative."@en ; + samm:see ; + samm:characteristic :RuleNamesTrait . + +:otherOperatorName a samm:Property ; + samm:preferredName "Other Operator Name"@en ; + samm:description "Optional: Other operator of PCR (Product Category Rule)/ PSR (Product Specific Rule) as specified in the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. WBCSD specific extension, in Catena-X for example specified by a default value."@en ; + samm:see ; + samm:characteristic :NonEmptyStringTrait ; + samm:exampleValue "NSF" . + +:emissionFactorDS a samm:Property ; + samm:preferredName "Emission Factor Data Source"@en ; + samm:description "Mandatory: Emission factor data source used to calculate a product carbon footprint as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative."@en ; + samm:see ; + samm:characteristic samm-c:Text ; + samm:exampleValue "ecoinvent 3.8" . + +:coveragePercent a samm:Property ; + samm:preferredName "Coverage Percent"@en ; + samm:description "Mandatory starting 2025: Percentage of PCF (Product Carbon Footprint) included in the data quality assessment based on the >5% emissions threshold as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. In Catena-X for example set to \"100\" per default."@en ; + samm:see ; + samm:characteristic :PercentTrait ; + samm:exampleValue "100"^^xsd:decimal . + +:technologicalDQR a samm:Property ; + samm:preferredName "Technological DQR (Data Quality Rating)"@en ; + samm:description "Optional: Technological representativeness of the sources used for PCF (Product Carbon Footprint) calculation based on weighted average of all inputs representing >5% of PCF emissions. Specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative."@en ; + samm:see ; + samm:characteristic :DqiNumberTrait ; + samm:exampleValue "2.0"^^xsd:decimal . + +:temporalDQR a samm:Property ; + samm:preferredName "Temporal DQR (Data Quality Rating)"@en ; + samm:description "Optional: Temporal representativeness of the sources used for PCF (Product Carbon Footprint) calculation based on weighted average of all inputs representing >5% of PCF emissions. Specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative."@en ; + samm:see ; + samm:characteristic :DqiNumberTrait ; + samm:exampleValue "2.0"^^xsd:decimal . + +:geographicalDQR a samm:Property ; + samm:preferredName "Geographical DQR (Data Quality Rating)"@en ; + samm:description "Optional: Geographical representativeness of the sources used for PCF (Product Carbon Footprint) calculation based on weighted average of all inputs representing >5% of PCF emissions. Specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative."@en ; + samm:see ; + samm:characteristic :DqiNumberTrait ; + samm:exampleValue "2.0"^^xsd:decimal . + +:completenessDQR a samm:Property ; + samm:preferredName "Completeness DQR (Data Quality Rating)"@en ; + samm:description "Optional: Completeness of the data collected for PCF (Product Carbon Footprint) calculation based on weighted average of all inputs representing >5% of PCF emissions. Specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative."@en ; + samm:see ; + samm:characteristic :DqiNumberTrait ; + samm:exampleValue "2.0"^^xsd:decimal . + +:reliabilityDQR a samm:Property ; + samm:preferredName "Reliability DQR (Data Quality Rating)"@en ; + samm:description "Optional: Reliability of the data collected for PCF (Product Carbon Footprint) calculation based on weighted average of all inputs representing >5% of PCF emissions. Specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative."@en ; + samm:see ; + samm:characteristic :DqiNumberTrait ; + samm:exampleValue "2.0"^^xsd:decimal . + +:CrossSectoralStandardsUsedEnumerationCharacteristic a samm-c:Enumeration ; + samm:preferredName "Cross Sectoral Standards Used Enumeration Characteristic"@en ; + samm:description "Characteristic for defining the enumeration of valid accounting standards used for product carbon footprint calculation as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative."@en ; + samm:see ; + samm:dataType xsd:string ; + samm-c:values ( "ISO Standard 14067" "ISO Standard 14044" "Pathfinder v1" "Pathfinder v2" "PAS 2050" "ISO Standard 14040" "ISO Standard 14041" "ISO Standard 14042" "ISO Standard 14043" "PEF" "Other" "GHG Protocol Product Standard" ) . + +:ProductOrSectorSpecificRuleOperator a samm-c:Enumeration ; + samm:preferredName "Product Or Sector Specific Rule Operator"@en ; + samm:description "Enumeration of PCR (Product Category Rule) operators as specified in the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. WBCSD specific extension for example in Catena-X."@en ; + samm:see ; + samm:dataType xsd:string ; + samm-c:values ( "PEF" "EPD International" "Other" ) . + +:RuleNamesTrait a samm-c:Trait ; + samm:preferredName "Rule Names Trait"@en ; + samm:description "Trait for defining a non-empty set of rule names as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative."@en ; + samm-c:baseCharacteristic :RuleNamesCharacteristic ; + samm-c:constraint :RuleNamesConstraint . + +:DqiNumberTrait a samm-c:Trait ; + samm:preferredName "DQI (Data Quality Indicator) Number Trait"@en ; + samm:description "Trait for defining a decimal between 1 and 3 including."@en ; + samm-c:baseCharacteristic :DqiNumber ; + samm-c:constraint :DqiNumberConstraint . + +:RuleNamesCharacteristic a samm-c:Set ; + samm:preferredName "Rule Names Characteristic"@en ; + samm:description "Non-empty set of rules applied by the specified operator. Defined by the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative."@en ; + samm:see ; + samm:dataType :RuleName . + +:RuleNamesConstraint a samm-c:LengthConstraint ; + samm:preferredName "Rule Names Constraint"@en ; + samm:description "Constraint for defining a non-empty set of rule names as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative."@en ; + samm:see ; + samm-c:minValue "1"^^xsd:nonNegativeInteger . + +:DqiNumber a samm:Characteristic ; + samm:preferredName "DQI (Data Quality Indicator) Number"@en ; + samm:description "Decimal between 1 and 3 including"@en ; + samm:dataType xsd:decimal . + +:DqiNumberConstraint a samm-c:RangeConstraint ; + samm:preferredName "DQI (Data Quality Indicator) Number Constraint"@en ; + samm:description "Constraint for defining a decimal between 1 and 3 including."@en ; + samm-c:minValue "1"^^xsd:decimal ; + samm-c:maxValue "3"^^xsd:decimal ; + samm-c:lowerBoundDefinition samm-c:AT_LEAST ; + samm-c:upperBoundDefinition samm-c:AT_MOST . + +:RuleName a samm:Entity ; + samm:preferredName "Rule Name"@en ; + samm:description "Name of a rule applied by a specified operator as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative."@en ; + samm:see ; + samm:properties ( :ruleName ) . + +:ruleName a samm:Property ; + samm:preferredName "Rule Name"@en ; + samm:description "Name of a rule applied by a specific operator as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative."@en ; + samm:see ; + samm:characteristic :NonEmptyStringTrait ; + samm:exampleValue "urn:tfs-initiative.com:PCR:The Product Carbon Footprint Guideline for the Chemical Industry:version:v2.0" . + diff --git a/io.catenax.pcf/7.0.0/gen/Pcf-aas.xml b/io.catenax.pcf/7.0.0/gen/Pcf-aas.xml new file mode 100644 index 000000000..211a6cd17 --- /dev/null +++ b/io.catenax.pcf/7.0.0/gen/Pcf-aas.xml @@ -0,0 +1,6227 @@ + + + + + defaultAdminShell + + + en + defaultAdminShell + + + + urn:samm:io.catenax.pcf:7.0.0#Pcf + + Type + + + + ModelReference + + + Submodel + urn:samm:io.catenax.pcf:7.0.0#Pcf/submodel + + + + + + + + + Pcf + + + en + A Product (Carbon) Footprint represents the carbon footprint of a product with values as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the WBCSD (World Business Council for Sustainable Development) Pathfinder framework and the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD/ PACT initiative. + + + + urn:samm:io.catenax.pcf:7.0.0#Pcf/submodel + Template + + ModelReference + + + ConceptDescription + urn:samm:io.catenax.pcf:7.0.0#Pcf + + + + + + ExternalReference + + + GlobalReference + https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/ + + + + + + + id + + + en + Product Footprint Identifier + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.pcf:7.0.0#id + + + + + + ExternalReference + + + GlobalReference + https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/ + + + + + xs:string + + + + specVersion + + + en + Product Footprint Specification Version + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.pcf:7.0.0#specVersion + + + + + + ExternalReference + + + GlobalReference + https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/ + + + + + xs:string + + + + partialFullPcf + + + en + Partial Or Full PCF (Product Carbon Footprint) + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.pcf:7.0.0#partialFullPcf + + + + xs:string + + + + precedingPfIds + + + en + Previous PCF (Product Carbon Footprint) Identifiers + + + + + en + Optional: Set of preceding PCF (Product Carbon Footprint) identifiers without duplicates as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the WBCSD (World Business Council for Sustainable Development) Pathfinder framework and the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD/ PACT initiative. Declared as "optional" in WBCSD, needs to be covered by application. + + + + + ExternalReference + + + GlobalReference + https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/ + + + + + true + DataElement + + + PrecedingPfId + + + en + Preceding PCF (Product Carbon Footprint) Identifier Entity + + + + + en + Entity for defining a preceding PCF (Product Carbon Footprint) identifier entity as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. + + + + + ExternalReference + + + GlobalReference + https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/ + + + + + + + id + + + en + Product Footprint Identifier + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.pcf:7.0.0#id + + + + + + ExternalReference + + + GlobalReference + https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/ + + + + + xs:string + + + + + + + + version + + + en + Product (Carbon) Footprint Version + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.pcf:7.0.0#version + + + + + + ExternalReference + + + GlobalReference + https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/ + + + + + xs:nonNegativeInteger + + + + created + + + en + Creation of the Product (Carbon) Footprint + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.pcf:7.0.0#created + + + + + + ExternalReference + + + GlobalReference + https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/ + + + + + xs:dateTime + + + + status + + + en + Status + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.pcf:7.0.0#status + + + + + + ExternalReference + + + GlobalReference + https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/ + + + + + xs:string + + + + validityPeriodStart + + + en + Validity Period Start + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.pcf:7.0.0#validityPeriodStart + + + + + + ExternalReference + + + GlobalReference + https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/ + + + + + xs:dateTime + + + + validityPeriodEnd + + + en + Validity Period End + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.pcf:7.0.0#validityPeriodEnd + + + + + + ExternalReference + + + GlobalReference + https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/ + + + + + xs:dateTime + + + + comment + + + en + Comment + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.pcf:7.0.0#comment + + + + + + ExternalReference + + + GlobalReference + https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/ + + + + + xs:string + + + + companyName + + + en + Company Name + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.pcf:7.0.0#companyName + + + + + + ExternalReference + + + GlobalReference + https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/ + + + + + xs:string + + + + companyIds + + + en + Company IDs + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.pcf:7.0.0#companyIds + + + + + + ExternalReference + + + GlobalReference + urn:samm:io.catenax.shared.business_partner_number:2.0.0#bpnlProperty + + + + + xs:anyURI + + + + productDescription + + + en + Product Description + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.pcf:7.0.0#productDescription + + + + + + ExternalReference + + + GlobalReference + https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/ + + + + + xs:string + + + + productIds + + + en + Product IDs + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.pcf:7.0.0#productIds + + + + + + ExternalReference + + + GlobalReference + urn:samm:io.catenax.part_type_information:1.0.0#manufacturerPartId + + + + + xs:anyURI + + + + productCategoryCpc + + + en + Product Category + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.pcf:7.0.0#productCategoryCpc + + + + + + ExternalReference + + + GlobalReference + https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/ + + + + + xs:string + + + + productNameCompany + + + en + Product Trade Name + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.pcf:7.0.0#productNameCompany + + + + + + ExternalReference + + + GlobalReference + urn:samm:io.catenax.part_type_information:1.0.0#nameAtManufacturer + + + + + xs:string + + + + PcfEntity + + + en + PCF (Product Carbon Footprint) Entity + + + + + en + Entity for defining a PCF (Product Carbon Footprint) as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. + + + + + ExternalReference + + + GlobalReference + https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/ + + + + + + + declaredUnit + + + en + Unit of measurement + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.pcf:7.0.0#declaredUnit + + + + + + ExternalReference + + + GlobalReference + https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/ + + + + + xs:string + + + + unitaryProductAmount + + + en + Unitary Product Amount + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.pcf:7.0.0#unitaryProductAmount + + + + + + ExternalReference + + + GlobalReference + https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/ + + + + + xs:float + + + + productMassPerDeclaredUnit + + + en + Product Mass Per Declared Unit + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.pcf:7.0.0#productMassPerDeclaredUnit + + + + xs:decimal + + + + exemptedEmissionsPercent + + + en + Exempted Emissions Percent + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.pcf:7.0.0#exemptedEmissionsPercent + + + + + + ExternalReference + + + GlobalReference + https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/ + + + + + xs:decimal + + + + exemptedEmissionsDescription + + + en + Exempted Emissions Description + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.pcf:7.0.0#exemptedEmissionsDescription + + + + + + ExternalReference + + + GlobalReference + https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/ + + + + + xs:string + + + + boundaryProcessesDescription + + + en + Boundary Processes Description + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.pcf:7.0.0#boundaryProcessesDescription + + + + + + ExternalReference + + + GlobalReference + https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/ + + + + + xs:string + + + + geographyCountrySubdivision + + + en + Geography Country Subdivision + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.pcf:7.0.0#geographyCountrySubdivision + + + + + + ExternalReference + + + GlobalReference + https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/ + + + + + xs:string + + + + geographyCountry + + + en + Geography Country + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.pcf:7.0.0#geographyCountry + + + + + + ExternalReference + + + GlobalReference + https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/ + + + + + xs:string + + + + geographyRegionOrSubregion + + + en + Region + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.pcf:7.0.0#geographyRegionOrSubregion + + + + + + ExternalReference + + + GlobalReference + https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/ + + + + + xs:string + + + + referencePeriodStart + + + en + Reference Period Start + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.pcf:7.0.0#referencePeriodStart + + + + + + ExternalReference + + + GlobalReference + https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/ + + + + + xs:dateTime + + + + referencePeriodEnd + + + en + Reference Period End + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.pcf:7.0.0#referencePeriodEnd + + + + + + ExternalReference + + + GlobalReference + https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/ + + + + + xs:dateTime + + + + crossSectoralStandardsUsed + + + en + Cross Sectoral Standards Used + + + + + en + Mandatory: Discloses the cross-sectoral standards applied for calculating or allocating GHG (Greenhouse Gas) emissions as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. + + + + + ExternalReference + + + GlobalReference + https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/ + + + + + true + DataElement + + + CrossSectoralStandard + + + en + Cross Sectoral Standard Entity + + + + + en + Entity for defining an accounting standard used for product carbon footprint calculation as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. + + + + + ExternalReference + + + GlobalReference + https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/ + + + + + + + crossSectoralStandard + + + en + Cross Sectoral Standard + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.pcf:7.0.0#crossSectoralStandard + + + + + + ExternalReference + + + GlobalReference + https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/ + + + + + xs:string + + + + + + + + productOrSectorSpecificRules + + + en + Product or Sector Specific Rules + + + + + en + Mandatory: Product or sector specific rules applied for calculating or allocating GHG (Greenhouse Gas) emissions, e.g. PCRs (Product Category Rules), including operators or publishers and according rule names as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. + + + + + ExternalReference + + + GlobalReference + https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/ + + + + + true + DataElement + + + ProductOrSectorSpecificRule + + + en + Product Or Sector Specific Rule + + + + + en + Entity for defining a product or sector specific rule of a product carbon footprint as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. + + + + + ExternalReference + + + GlobalReference + https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/ + + + + + + + operator + + + en + Operator or Publisher of Sector Specific Rules + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.pcf:7.0.0#operator + + + + + + ExternalReference + + + GlobalReference + https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/ + + + + + xs:string + + + + RuleName + + + en + Rule Name + + + + + en + Name of a rule applied by a specified operator as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. + + + + + ExternalReference + + + GlobalReference + https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/ + + + + + + + ruleName + + + en + Rule Name + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.pcf:7.0.0#ruleName + + + + + + ExternalReference + + + GlobalReference + https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/ + + + + + xs:string + + + + + + otherOperatorName + + + en + Other Operator Name + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.pcf:7.0.0#otherOperatorName + + + + + + ExternalReference + + + GlobalReference + https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/ + + + + + xs:string + + + + + + + + characterizationFactors + + + en + Characterization Factors + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.pcf:7.0.0#characterizationFactors + + + + + + ExternalReference + + + GlobalReference + https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/ + + + + + xs:string + + + + allocationRulesDescription + + + en + Allocation Rules Description + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.pcf:7.0.0#allocationRulesDescription + + + + + + ExternalReference + + + GlobalReference + https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/ + + + + + xs:string + + + + allocationWasteIncineration + + + en + Allocation Waste Incineration + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.pcf:7.0.0#allocationWasteIncineration + + + + xs:string + + + + primaryDataShare + + + en + Primary Data Share + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.pcf:7.0.0#primaryDataShare + + + + + + ExternalReference + + + GlobalReference + https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/ + + + + + xs:decimal + + + + secondaryEmissionFactorSources + + + en + Secondary Emission Factor Sources + + + + + en + Mandatory: Emission factors used for the PCF (Product Carbon Footprint) calculation as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. + + + + + ExternalReference + + + GlobalReference + https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/ + + + + + true + DataElement + + + EmissionFactorDS + + + en + Emission Factor Data Source Entity + + + + + en + Entity for defining an emission factor data source used to calculate a product carbon footprint as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. + + + + + ExternalReference + + + GlobalReference + https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/ + + + + + + + emissionFactorDS + + + en + Emission Factor Data Source + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.pcf:7.0.0#emissionFactorDS + + + + + + ExternalReference + + + GlobalReference + https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/ + + + + + xs:string + + + + + + + + DataQualityIndicator + + + en + Data Quality Indicator + + + + + en + Entity for defining a quantitative data quality indicator of a PCF (Product Carbon Footprint) as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. + + + + + ExternalReference + + + GlobalReference + https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/ + + + + + + + coveragePercent + + + en + Coverage Percent + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.pcf:7.0.0#coveragePercent + + + + + + ExternalReference + + + GlobalReference + https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/ + + + + + xs:decimal + + + + technologicalDQR + + + en + Technological DQR (Data Quality Rating) + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.pcf:7.0.0#technologicalDQR + + + + + + ExternalReference + + + GlobalReference + https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/ + + + + + xs:decimal + + + + temporalDQR + + + en + Temporal DQR (Data Quality Rating) + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.pcf:7.0.0#temporalDQR + + + + + + ExternalReference + + + GlobalReference + https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/ + + + + + xs:decimal + + + + geographicalDQR + + + en + Geographical DQR (Data Quality Rating) + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.pcf:7.0.0#geographicalDQR + + + + + + ExternalReference + + + GlobalReference + https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/ + + + + + xs:decimal + + + + completenessDQR + + + en + Completeness DQR (Data Quality Rating) + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.pcf:7.0.0#completenessDQR + + + + + + ExternalReference + + + GlobalReference + https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/ + + + + + xs:decimal + + + + reliabilityDQR + + + en + Reliability DQR (Data Quality Rating) + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.pcf:7.0.0#reliabilityDQR + + + + + + ExternalReference + + + GlobalReference + https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/ + + + + + xs:decimal + + + + + + packagingEmissionsIncluded + + + en + Packaging Emissions Included + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.pcf:7.0.0#packagingEmissionsIncluded + + + + + + ExternalReference + + + GlobalReference + https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/ + + + + + xs:boolean + + + + pcfExcludingBiogenic + + + en + PCF (Product Carbon Footprint) Excluding Biogenic + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.pcf:7.0.0#pcfExcludingBiogenic + + + + + + ExternalReference + + + GlobalReference + https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/ + + + + + xs:decimal + + + + pcfIncludingBiogenic + + + en + PCF (Product Carbon Footprint) Including Biogenic + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.pcf:7.0.0#pcfIncludingBiogenic + + + + + + ExternalReference + + + GlobalReference + https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/ + + + + + xs:decimal + + + + fossilGhgEmissions + + + en + Fossil Emissions + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.pcf:7.0.0#fossilGhgEmissions + + + + + + ExternalReference + + + GlobalReference + https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/ + + + + + xs:decimal + + + + biogenicCarbonEmissionsOtherThanCO2 + + + en + Biogenic Carbon Emissions Other Than CO2 + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.pcf:7.0.0#biogenicCarbonEmissionsOtherThanCO2 + + + + xs:decimal + + + + biogenicCarbonWithdrawal + + + en + Biogenic Carbon Withdrawal + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.pcf:7.0.0#biogenicCarbonWithdrawal + + + + + + ExternalReference + + + GlobalReference + https://wbcsd.github.io/tr/2023/data-exchange-protocol-20231207/ + + + + + xs:decimal + + + + dlucGhgEmissions + + + en + dLUC (direct land use change) GHG (Greenhouse Gas) Emissions + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.pcf:7.0.0#dlucGhgEmissions + + + + xs:decimal + + + + luGhgEmissions + + + en + LU (Land Use) GHG (Greenhouse Gas) Emissions + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.pcf:7.0.0#luGhgEmissions + + + + xs:decimal + + + + aircraftGhgEmissions + + + en + Aircraft GHG Emissions + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.pcf:7.0.0#aircraftGhgEmissions + + + + + + ExternalReference + + + GlobalReference + https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/ + + + + + xs:decimal + + + + packagingGhgEmissions + + + en + Packaging GHG (Greenhouse Gas) Emissions + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.pcf:7.0.0#packagingGhgEmissions + + + + + + ExternalReference + + + GlobalReference + https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/ + + + + + xs:decimal + + + + distributionStagePcfExcludingBiogenic + + + en + Distribution Stage PCF (Product Carbon Footprint) Excluding Biogenic + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.pcf:7.0.0#distributionStagePcfExcludingBiogenic + + + + xs:decimal + + + + distributionStagePcfIncludingBiogenic + + + en + Distribution Stage PCF (Product Carbon Footprint) Including Biogenic + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.pcf:7.0.0#distributionStagePcfIncludingBiogenic + + + + xs:decimal + + + + distributionStageFossilGhgEmissions + + + en + Distribution Stage Fossil GHG (Greenhouse Gas) Emissions + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.pcf:7.0.0#distributionStageFossilGhgEmissions + + + + xs:decimal + + + + distributionStageBiogenicCarbonEmissionsOtherThanCO2 + + + en + Distribution Stage Biogenic Carbon Emissions Other Than CO2 + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.pcf:7.0.0#distributionStageBiogenicCarbonEmissionsOtherThanCO2 + + + + xs:decimal + + + + distributionStageBiogenicCarbonWithdrawal + + + en + Distribution Stage Biogenic Carbon Withdrawal + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.pcf:7.0.0#distributionStageBiogenicCarbonWithdrawal + + + + xs:decimal + + + + distributionStageDlucGhgEmissions + + + en + Distribution Stage dLUC (direct land use change) GHG (Greenhouse Gas) Emissions + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.pcf:7.0.0#distributionStageDlucGhgEmissions + + + + xs:decimal + + + + distributionStageLuGhgEmissions + + + en + Distribution Stage LU (Land Use) GHG (Greenhouse Gas) Emissions + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.pcf:7.0.0#distributionStageLuGhgEmissions + + + + xs:decimal + + + + carbonContentTotal + + + en + Carbon Content Total + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.pcf:7.0.0#carbonContentTotal + + + + xs:decimal + + + + fossilCarbonContent + + + en + Fossil Carbon Content + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.pcf:7.0.0#fossilCarbonContent + + + + + + ExternalReference + + + GlobalReference + https://wbcsd.github.io/tr/2023/data-exchange-protocol-20231207/ + + + + + xs:decimal + + + + biogenicCarbonContent + + + en + Biogenic Carbon Content + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.pcf:7.0.0#biogenicCarbonContent + + + + + + ExternalReference + + + GlobalReference + https://wbcsd.github.io/tr/2023/data-exchange-protocol-20231207/ + + + + + xs:decimal + + + + distributionStageAircraftGhgEmissions + + + en + Distribution Stage Aircraft GHG Emissions + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.pcf:7.0.0#distributionStageAircraftGhgEmissions + + + + + + ExternalReference + + + GlobalReference + https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/ + + + + + xs:decimal + + + + + + pcfLegalStatement + + + en + PCF (Product Carbon Footprint) Legal Statement + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.pcf:7.0.0#pcfLegalStatement + + + + xs:string + + + + + + + + APPLICATION_CLASS + Pcf + + + en + Product (Carbon) Footprint + + + + + en + A Product (Carbon) Footprint represents the carbon footprint of a product with values as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the WBCSD (World Business Council for Sustainable Development) Pathfinder framework and the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD/ PACT initiative. + + + urn:samm:io.catenax.pcf:7.0.0#Pcf + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Product (Carbon) Footprint + + + + + en + Pcf + + + + + en + A Product (Carbon) Footprint represents the carbon footprint of a product with values as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the WBCSD (World Business Council for Sustainable Development) Pathfinder framework and the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD/ PACT initiative. + + + + + + + + + id + + + en + Product Footprint Identifier + + + urn:samm:io.catenax.pcf:7.0.0#id + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Product Footprint Identifier + + + + + en + id + + + STRING + + + en + Mandatory: The product footprint identifier as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. + + + + + + + + + specVersion + + + en + Product Footprint Specification Version + + + urn:samm:io.catenax.pcf:7.0.0#specVersion + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Product Footprint Specification Version + + + + + en + specVersion + + + STRING + + + en + Mandatory: Version of the product footprint data specification as defined in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. + + + + + + + + + partialFullPcf + + + en + Partial Or Full PCF (Product Carbon Footprint) + + + urn:samm:io.catenax.pcf:7.0.0#partialFullPcf + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Partial Or Full PCF (Product Carbon Footprint) + + + + + en + partialFullPcf + + + STRING + + + en + Mandatory: Indicator for partial or full PCF (Product Carbon Footprint) declaration as specified in the Catena-X PCF Rulebook (Version 3.0.0). + + + + + + Cradle-to-gate + + ModelReference + + + DataElement + urn:samm:io.catenax.pcf:7.0.0#PartialFullPcfCharacteristic:Cradle-to-gate + + + + + + Cradle-to-grave + + ModelReference + + + DataElement + urn:samm:io.catenax.pcf:7.0.0#PartialFullPcfCharacteristic:Cradle-to-grave + + + + + + + + + + + + + id + + + en + Product Footprint Identifier + + + urn:samm:io.catenax.pcf:7.0.0#id + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Product Footprint Identifier + + + + + en + id + + + STRING + + + en + Mandatory: The product footprint identifier as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. + + + + + + + + + precedingPfIds + + + en + Previous PCF (Product Carbon Footprint) Identifiers + + + urn:samm:io.catenax.pcf:7.0.0#precedingPfIds + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Previous PCF (Product Carbon Footprint) Identifiers + + + + + en + precedingPfIds + + + STRING + + + en + Optional: Set of preceding PCF (Product Carbon Footprint) identifiers without duplicates as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the WBCSD (World Business Council for Sustainable Development) Pathfinder framework and the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD/ PACT initiative. Declared as "optional" in WBCSD, needs to be covered by application. + + + + + + + + + version + + + en + Product (Carbon) Footprint Version + + + urn:samm:io.catenax.pcf:7.0.0#version + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Product (Carbon) Footprint Version + + + + + en + version + + + INTEGER_COUNT + + + en + Mandatory: Version of the product (carbon) footprint as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. In Catena-X for example set to "0" per default. + + + + + + + + + created + + + en + Creation of the Product (Carbon) Footprint + + + urn:samm:io.catenax.pcf:7.0.0#created + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Creation of the Product (Carbon) Footprint + + + + + en + created + + + STRING + + + en + Mandatory: Timestamp of the creation of the Product (Carbon) Footprint as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. + + + + + + + + + status + + + en + Status + + + urn:samm:io.catenax.pcf:7.0.0#status + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Status + + + + + en + status + + + STRING + + + en + Mandatory: Status indicator of a product (carbon) footprint as specified in the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. WBCSD specific extension, in Catena-X for example set to "Active" per default. + + + + + + Active + + ModelReference + + + DataElement + urn:samm:io.catenax.pcf:7.0.0#PfStatusCharacteristic:Active + + + + + + Deprecated + + ModelReference + + + DataElement + urn:samm:io.catenax.pcf:7.0.0#PfStatusCharacteristic:Deprecated + + + + + + + + + + + + + validityPeriodStart + + + en + Validity Period Start + + + urn:samm:io.catenax.pcf:7.0.0#validityPeriodStart + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Validity Period Start + + + + + en + validityPeriodStart + + + STRING + + + en + Optional: Start of interval during which the product (carbon) footprint is declared as valid as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. If specified, the validity period start must be equal to or greater than the reference period end. + + + + + + + + + validityPeriodEnd + + + en + Validity Period End + + + urn:samm:io.catenax.pcf:7.0.0#validityPeriodEnd + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Validity Period End + + + + + en + validityPeriodEnd + + + STRING + + + en + Optional: End of interval during which the product (carbon) footprint is declared as valid as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. + + + + + + + + + comment + + + en + Comment + + + urn:samm:io.catenax.pcf:7.0.0#comment + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Comment + + + + + en + comment + + + STRING + + + en + Optional: Additional information and instructions related to the calculation of the product (carbon) footprint as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. + + + + + + + + + companyName + + + en + Company Name + + + urn:samm:io.catenax.pcf:7.0.0#companyName + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Company Name + + + + + en + companyName + + + STRING + + + en + Mandatory: Name of the product (carbon) footprint data owner as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. + + + + + + + + + companyIds + + + en + Company IDs + + + urn:samm:io.catenax.pcf:7.0.0#companyIds + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Company IDs + + + + + en + companyIds + + + STRING + + + en + Mandatory: Non-empty set of Uniform Resource Names (URN). Each value is supposed to uniquely identify the product (carbon) footprint data owner as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.1.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. For Catena-X Industry Core compliance the set of URNs must contain at least the Business Partner Number Legal Entity (BPNL) in the specified format urn:bpn:id:BPNL[a-zA-Z0-9]{12}.  + + + + + + + + + productDescription + + + en + Product Description + + + urn:samm:io.catenax.pcf:7.0.0#productDescription + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Product Description + + + + + en + productDescription + + + STRING + + + en + Optional: Free-form description of the product as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. + + + + + + + + + productIds + + + en + Product IDs + + + urn:samm:io.catenax.pcf:7.0.0#productIds + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Product IDs + + + + + en + productIds + + + STRING + + + en + Mandatory: Non-empty set of product identifiers. Each value is supposed to uniquely identify the product as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.1.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. In Catena-X productId corresponds with Industry Core manufacturerPartId. + + + + + + + + + productCategoryCpc + + + en + Product Category + + + urn:samm:io.catenax.pcf:7.0.0#productCategoryCpc + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Product Category + + + + + en + productCategoryCpc + + + STRING + + + en + Mandatory: UN (United Nations) Product Classification Code (CPC - Central Classification Code) of a given product as specified the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. WBCSD specific extension, which will probably be declared as "optional" in a later WBCSD specification version. In Catena-X for example specified with default value "011-99000". + + + + + + + + + productNameCompany + + + en + Product Trade Name + + + urn:samm:io.catenax.pcf:7.0.0#productNameCompany + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Product Trade Name + + + + + en + productNameCompany + + + STRING + + + en + Mandatory: Non-empty trade name of a product as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.1.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. In Catena-X productNameCompany corresponds with Industry Core nameAtManufacturer.  + + + + + + + + + declaredUnit + + + en + Unit of measurement + + + urn:samm:io.catenax.pcf:7.0.0#declaredUnit + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Unit of measurement + + + + + en + declaredUnit + + + STRING + + + en + Mandatory: Unit of analysis of a product in context of the PCF (product carbon footprint) as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. In Catena-X for example list of valid units includes "piece". + + + + + + liter + + ModelReference + + + DataElement + urn:samm:io.catenax.pcf:7.0.0#DeclaredUnitCharacteristic:liter + + + + + + kilogram + + ModelReference + + + DataElement + urn:samm:io.catenax.pcf:7.0.0#DeclaredUnitCharacteristic:kilogram + + + + + + cubic meter + + ModelReference + + + DataElement + urn:samm:io.catenax.pcf:7.0.0#DeclaredUnitCharacteristic:cubic meter + + + + + + kilowatt hour + + ModelReference + + + DataElement + urn:samm:io.catenax.pcf:7.0.0#DeclaredUnitCharacteristic:kilowatt hour + + + + + + megajoule + + ModelReference + + + DataElement + urn:samm:io.catenax.pcf:7.0.0#DeclaredUnitCharacteristic:megajoule + + + + + + ton kilometer + + ModelReference + + + DataElement + urn:samm:io.catenax.pcf:7.0.0#DeclaredUnitCharacteristic:ton kilometer + + + + + + square meter + + ModelReference + + + DataElement + urn:samm:io.catenax.pcf:7.0.0#DeclaredUnitCharacteristic:square meter + + + + + + piece + + ModelReference + + + DataElement + urn:samm:io.catenax.pcf:7.0.0#DeclaredUnitCharacteristic:piece + + + + + + + + + + + + + unitaryProductAmount + + + en + Unitary Product Amount + + + urn:samm:io.catenax.pcf:7.0.0#unitaryProductAmount + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Unitary Product Amount + + + + + en + unitaryProductAmount + + + REAL_MEASURE + + + en + Mandatory: Amount of units contained within a product in context of the PCF (Product Carbon Footprint) as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. + + + + + + + + + productMassPerDeclaredUnit + + + en + Product Mass Per Declared Unit + + + urn:samm:io.catenax.pcf:7.0.0#productMassPerDeclaredUnit + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Product Mass Per Declared Unit + + + + + en + productMassPerDeclaredUnit + + + INTEGER_MEASURE + + + en + Mandatory: Mass of a product per declared unit (net, unpackaged) in context of the PCF (Product Carbon Footprint) as specified in the Catena-X PCF Rulebook (Version 3.0.0). + + + + + + + + + exemptedEmissionsPercent + + + en + Exempted Emissions Percent + + + urn:samm:io.catenax.pcf:7.0.0#exemptedEmissionsPercent + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Exempted Emissions Percent + + + + + en + exemptedEmissionsPercent + + + INTEGER_MEASURE + + + en + Mandatory: Applied cut-off percentage of emissions excluded from PCF (Product Carbon Footprint). +For accordance with Catena-X PCF Rulebook (Version 3.0.0) <3%. + + + + + + + + + exemptedEmissionsDescription + + + en + Exempted Emissions Description + + + urn:samm:io.catenax.pcf:7.0.0#exemptedEmissionsDescription + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Exempted Emissions Description + + + + + en + exemptedEmissionsDescription + + + STRING + + + en + Optional: Rationale behind exclusion of specific PCF (Product Carbon Footprint) emissions as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. + + + + + + + + + boundaryProcessesDescription + + + en + Boundary Processes Description + + + urn:samm:io.catenax.pcf:7.0.0#boundaryProcessesDescription + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Boundary Processes Description + + + + + en + boundaryProcessesDescription + + + STRING + + + en + Optional: Processes attributable to each lifecycle stage as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. + + + + + + + + + geographyCountrySubdivision + + + en + Geography Country Subdivision + + + urn:samm:io.catenax.pcf:7.0.0#geographyCountrySubdivision + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Geography Country Subdivision + + + + + en + geographyCountrySubdivision + + + STRING + + + en + Optional: Subdivision of a country which must be an ISO 3166-2 subdivision code as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. + + + + + + + + + geographyCountry + + + en + Geography Country + + + urn:samm:io.catenax.pcf:7.0.0#geographyCountry + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Geography Country + + + + + en + geographyCountry + + + STRING + + + en + Optional: Two letter country code that must conform to data type ISO 3166CC as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. + + + + + + + + + geographyRegionOrSubregion + + + en + Region + + + urn:samm:io.catenax.pcf:7.0.0#geographyRegionOrSubregion + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Region + + + + + en + geographyRegionOrSubregion + + + STRING + + + en + Mandatory: Region according to list as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. + + + + + + Africa + + ModelReference + + + DataElement + urn:samm:io.catenax.pcf:7.0.0#GeographyRegionOrSubregionCharacteristic:Africa + + + + + + Americas + + ModelReference + + + DataElement + urn:samm:io.catenax.pcf:7.0.0#GeographyRegionOrSubregionCharacteristic:Americas + + + + + + Asia + + ModelReference + + + DataElement + urn:samm:io.catenax.pcf:7.0.0#GeographyRegionOrSubregionCharacteristic:Asia + + + + + + Europe + + ModelReference + + + DataElement + urn:samm:io.catenax.pcf:7.0.0#GeographyRegionOrSubregionCharacteristic:Europe + + + + + + Oceania + + ModelReference + + + DataElement + urn:samm:io.catenax.pcf:7.0.0#GeographyRegionOrSubregionCharacteristic:Oceania + + + + + + Australia and New Zealand + + ModelReference + + + DataElement + urn:samm:io.catenax.pcf:7.0.0#GeographyRegionOrSubregionCharacteristic:Australia and New Zealand + + + + + + Central Asia + + ModelReference + + + DataElement + urn:samm:io.catenax.pcf:7.0.0#GeographyRegionOrSubregionCharacteristic:Central Asia + + + + + + Eastern Asia + + ModelReference + + + DataElement + urn:samm:io.catenax.pcf:7.0.0#GeographyRegionOrSubregionCharacteristic:Eastern Asia + + + + + + Eastern Europe + + ModelReference + + + DataElement + urn:samm:io.catenax.pcf:7.0.0#GeographyRegionOrSubregionCharacteristic:Eastern Europe + + + + + + Latin America and the Caribbean + + ModelReference + + + DataElement + urn:samm:io.catenax.pcf:7.0.0#GeographyRegionOrSubregionCharacteristic:Latin America and the Caribbean + + + + + + Melanesia + + ModelReference + + + DataElement + urn:samm:io.catenax.pcf:7.0.0#GeographyRegionOrSubregionCharacteristic:Melanesia + + + + + + Micronesia + + ModelReference + + + DataElement + urn:samm:io.catenax.pcf:7.0.0#GeographyRegionOrSubregionCharacteristic:Micronesia + + + + + + Northern Africa + + ModelReference + + + DataElement + urn:samm:io.catenax.pcf:7.0.0#GeographyRegionOrSubregionCharacteristic:Northern Africa + + + + + + Northern America + + ModelReference + + + DataElement + urn:samm:io.catenax.pcf:7.0.0#GeographyRegionOrSubregionCharacteristic:Northern America + + + + + + Northern Europe + + ModelReference + + + DataElement + urn:samm:io.catenax.pcf:7.0.0#GeographyRegionOrSubregionCharacteristic:Northern Europe + + + + + + Polynesia + + ModelReference + + + DataElement + urn:samm:io.catenax.pcf:7.0.0#GeographyRegionOrSubregionCharacteristic:Polynesia + + + + + + South-eastern Asia + + ModelReference + + + DataElement + urn:samm:io.catenax.pcf:7.0.0#GeographyRegionOrSubregionCharacteristic:South-eastern Asia + + + + + + Southern Asia + + ModelReference + + + DataElement + urn:samm:io.catenax.pcf:7.0.0#GeographyRegionOrSubregionCharacteristic:Southern Asia + + + + + + Southern Europe + + ModelReference + + + DataElement + urn:samm:io.catenax.pcf:7.0.0#GeographyRegionOrSubregionCharacteristic:Southern Europe + + + + + + Sub-Saharan Africa + + ModelReference + + + DataElement + urn:samm:io.catenax.pcf:7.0.0#GeographyRegionOrSubregionCharacteristic:Sub-Saharan Africa + + + + + + Western Asia + + ModelReference + + + DataElement + urn:samm:io.catenax.pcf:7.0.0#GeographyRegionOrSubregionCharacteristic:Western Asia + + + + + + Western Europe + + ModelReference + + + DataElement + urn:samm:io.catenax.pcf:7.0.0#GeographyRegionOrSubregionCharacteristic:Western Europe + + + + + + Global + + ModelReference + + + DataElement + urn:samm:io.catenax.pcf:7.0.0#GeographyRegionOrSubregionCharacteristic:Global + + + + + + Several + + ModelReference + + + DataElement + urn:samm:io.catenax.pcf:7.0.0#GeographyRegionOrSubregionCharacteristic:Several + + + + + + + + + + + + + referencePeriodStart + + + en + Reference Period Start + + + urn:samm:io.catenax.pcf:7.0.0#referencePeriodStart + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Reference Period Start + + + + + en + referencePeriodStart + + + STRING + + + en + Mandatory: Start of time boundary for which a PCF (Product Carbon Footprint) value is considered to be representative as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. + + + + + + + + + referencePeriodEnd + + + en + Reference Period End + + + urn:samm:io.catenax.pcf:7.0.0#referencePeriodEnd + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Reference Period End + + + + + en + referencePeriodEnd + + + STRING + + + en + Mandatory: End of time boundary for which a PCF (Product Carbon Footprint) value is considered to be representative as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. + + + + + + + + + crossSectoralStandard + + + en + Cross Sectoral Standard + + + urn:samm:io.catenax.pcf:7.0.0#crossSectoralStandard + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Cross Sectoral Standard + + + + + en + crossSectoralStandard + + + STRING + + + en + Mandatory: Discloses a cross-sectoral standard applied for calculating or allocating GHG (Greenhouse Gas) emissions as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. + + + + + + ISO Standard 14067 + + ModelReference + + + DataElement + urn:samm:io.catenax.pcf:7.0.0#CrossSectoralStandardsUsedEnumerationCharacteristic:ISO Standard 14067 + + + + + + ISO Standard 14044 + + ModelReference + + + DataElement + urn:samm:io.catenax.pcf:7.0.0#CrossSectoralStandardsUsedEnumerationCharacteristic:ISO Standard 14044 + + + + + + Pathfinder v1 + + ModelReference + + + DataElement + urn:samm:io.catenax.pcf:7.0.0#CrossSectoralStandardsUsedEnumerationCharacteristic:Pathfinder v1 + + + + + + Pathfinder v2 + + ModelReference + + + DataElement + urn:samm:io.catenax.pcf:7.0.0#CrossSectoralStandardsUsedEnumerationCharacteristic:Pathfinder v2 + + + + + + PAS 2050 + + ModelReference + + + DataElement + urn:samm:io.catenax.pcf:7.0.0#CrossSectoralStandardsUsedEnumerationCharacteristic:PAS 2050 + + + + + + ISO Standard 14040 + + ModelReference + + + DataElement + urn:samm:io.catenax.pcf:7.0.0#CrossSectoralStandardsUsedEnumerationCharacteristic:ISO Standard 14040 + + + + + + ISO Standard 14041 + + ModelReference + + + DataElement + urn:samm:io.catenax.pcf:7.0.0#CrossSectoralStandardsUsedEnumerationCharacteristic:ISO Standard 14041 + + + + + + ISO Standard 14042 + + ModelReference + + + DataElement + urn:samm:io.catenax.pcf:7.0.0#CrossSectoralStandardsUsedEnumerationCharacteristic:ISO Standard 14042 + + + + + + ISO Standard 14043 + + ModelReference + + + DataElement + urn:samm:io.catenax.pcf:7.0.0#CrossSectoralStandardsUsedEnumerationCharacteristic:ISO Standard 14043 + + + + + + PEF + + ModelReference + + + DataElement + urn:samm:io.catenax.pcf:7.0.0#CrossSectoralStandardsUsedEnumerationCharacteristic:PEF + + + + + + Other + + ModelReference + + + DataElement + urn:samm:io.catenax.pcf:7.0.0#CrossSectoralStandardsUsedEnumerationCharacteristic:Other + + + + + + GHG Protocol Product Standard + + ModelReference + + + DataElement + urn:samm:io.catenax.pcf:7.0.0#CrossSectoralStandardsUsedEnumerationCharacteristic:GHG Protocol Product Standard + + + + + + + + + + + + + crossSectoralStandardsUsed + + + en + Cross Sectoral Standards Used + + + urn:samm:io.catenax.pcf:7.0.0#crossSectoralStandardsUsed + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Cross Sectoral Standards Used + + + + + en + crossSectoralStandardsUsed + + + STRING + + + en + Mandatory: Discloses the cross-sectoral standards applied for calculating or allocating GHG (Greenhouse Gas) emissions as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. + + + + + + + + + operator + + + en + Operator or Publisher of Sector Specific Rules + + + urn:samm:io.catenax.pcf:7.0.0#operator + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Operator or Publisher of Sector Specific Rules + + + + + en + operator + + + STRING + + + en + Mandatory: Operator of PCR (Product Category Rule)/ PSR (Product Specific Rule) as specified in the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. WBCSD specific extension, in Catena-X for example must always be "Other". + + + + + + PEF + + ModelReference + + + DataElement + urn:samm:io.catenax.pcf:7.0.0#ProductOrSectorSpecificRuleOperator:PEF + + + + + + EPD International + + ModelReference + + + DataElement + urn:samm:io.catenax.pcf:7.0.0#ProductOrSectorSpecificRuleOperator:EPD International + + + + + + Other + + ModelReference + + + DataElement + urn:samm:io.catenax.pcf:7.0.0#ProductOrSectorSpecificRuleOperator:Other + + + + + + + + + + + + + ruleName + + + en + Rule Name + + + urn:samm:io.catenax.pcf:7.0.0#ruleName + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Rule Name + + + + + en + ruleName + + + STRING + + + en + Name of a rule applied by a specific operator as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. + + + + + + + + + ruleNames + + + en + Product or Sector Specific Rule Names + + + urn:samm:io.catenax.pcf:7.0.0#ruleNames + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Product or Sector Specific Rule Names + + + + + en + ruleNames + + + STRING + + + en + Mandatory: Product-specific or sector-specific set of rules used for calculating or allocating GHG (Greenhouse Gas) emissions applied from the specified operator as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. + + + + + + + + + otherOperatorName + + + en + Other Operator Name + + + urn:samm:io.catenax.pcf:7.0.0#otherOperatorName + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Other Operator Name + + + + + en + otherOperatorName + + + STRING + + + en + Optional: Other operator of PCR (Product Category Rule)/ PSR (Product Specific Rule) as specified in the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. WBCSD specific extension, in Catena-X for example specified by a default value. + + + + + + + + + productOrSectorSpecificRules + + + en + Product or Sector Specific Rules + + + urn:samm:io.catenax.pcf:7.0.0#productOrSectorSpecificRules + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Product or Sector Specific Rules + + + + + en + productOrSectorSpecificRules + + + STRING + + + en + Mandatory: Product or sector specific rules applied for calculating or allocating GHG (Greenhouse Gas) emissions, e.g. PCRs (Product Category Rules), including operators or publishers and according rule names as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. + + + + + + + + + characterizationFactors + + + en + Characterization Factors + + + urn:samm:io.catenax.pcf:7.0.0#characterizationFactors + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Characterization Factors + + + + + en + characterizationFactors + + + STRING + + + en + Mandatory: IPCC (Intergovernmental Panel on Climate Change) version of the GWP (Global Warming Potential) characterization factors used for calculating the PCF (Product Carbon Footprint) as specified in the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. WBCSD specific extension, in Catena-X for example specified by default with value \"AR6\". Default value can be overwritten. + + + + + + AR5 + + ModelReference + + + DataElement + urn:samm:io.catenax.pcf:7.0.0#CharacterizationFactorsCharacteristic:AR5 + + + + + + AR6 + + ModelReference + + + DataElement + urn:samm:io.catenax.pcf:7.0.0#CharacterizationFactorsCharacteristic:AR6 + + + + + + + + + + + + + allocationRulesDescription + + + en + Allocation Rules Description + + + urn:samm:io.catenax.pcf:7.0.0#allocationRulesDescription + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Allocation Rules Description + + + + + en + allocationRulesDescription + + + STRING + + + en + Optional: Allocation rules used and underlying reasoning in context of a product carbon footprint as specified in the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. WBCSD specific extension, in Catena-X for example specified by default with value "In accordance with Catena-X PCF Rulebook (Version 3.0.0)". + + + + + + + + + allocationWasteIncineration + + + en + Allocation Waste Incineration + + + urn:samm:io.catenax.pcf:7.0.0#allocationWasteIncineration + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Allocation Waste Incineration + + + + + en + allocationWasteIncineration + + + STRING + + + en + Mandatory: Allocation approach used for waste incineration with energy recovery as specified by the TFS (Together For Sustainability) initiative. In Catena-X for example must be specified by value "cut-off". + + + + + + cut-off + + ModelReference + + + DataElement + urn:samm:io.catenax.pcf:7.0.0#AllocationWasteIncinerationCharacteristic:cut-off + + + + + + reverse cut-off + + ModelReference + + + DataElement + urn:samm:io.catenax.pcf:7.0.0#AllocationWasteIncinerationCharacteristic:reverse cut-off + + + + + + system expansion + + ModelReference + + + DataElement + urn:samm:io.catenax.pcf:7.0.0#AllocationWasteIncinerationCharacteristic:system expansion + + + + + + + + + + + + + primaryDataShare + + + en + Primary Data Share + + + urn:samm:io.catenax.pcf:7.0.0#primaryDataShare + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Primary Data Share + + + + + en + primaryDataShare + + + INTEGER_MEASURE + + + en + Mandatory starting 2025: Share of primary data in percent as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. + + + + + + + + + emissionFactorDS + + + en + Emission Factor Data Source + + + urn:samm:io.catenax.pcf:7.0.0#emissionFactorDS + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Emission Factor Data Source + + + + + en + emissionFactorDS + + + STRING + + + en + Mandatory: Emission factor data source used to calculate a product carbon footprint as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. + + + + + + + + + secondaryEmissionFactorSources + + + en + Secondary Emission Factor Sources + + + urn:samm:io.catenax.pcf:7.0.0#secondaryEmissionFactorSources + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Secondary Emission Factor Sources + + + + + en + secondaryEmissionFactorSources + + + STRING + + + en + Mandatory: Emission factors used for the PCF (Product Carbon Footprint) calculation as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. + + + + + + + + + coveragePercent + + + en + Coverage Percent + + + urn:samm:io.catenax.pcf:7.0.0#coveragePercent + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Coverage Percent + + + + + en + coveragePercent + + + INTEGER_MEASURE + + + en + Mandatory starting 2025: Percentage of PCF (Product Carbon Footprint) included in the data quality assessment based on the >5% emissions threshold as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. In Catena-X for example set to "100" per default. + + + + + + + + + technologicalDQR + + + en + Technological DQR (Data Quality Rating) + + + urn:samm:io.catenax.pcf:7.0.0#technologicalDQR + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Technological DQR (Data Quality Rating) + + + + + en + technologicalDQR + + + INTEGER_MEASURE + + + en + Optional: Technological representativeness of the sources used for PCF (Product Carbon Footprint) calculation based on weighted average of all inputs representing >5% of PCF emissions. Specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. + + + + + + + + + temporalDQR + + + en + Temporal DQR (Data Quality Rating) + + + urn:samm:io.catenax.pcf:7.0.0#temporalDQR + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Temporal DQR (Data Quality Rating) + + + + + en + temporalDQR + + + INTEGER_MEASURE + + + en + Optional: Temporal representativeness of the sources used for PCF (Product Carbon Footprint) calculation based on weighted average of all inputs representing >5% of PCF emissions. Specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. + + + + + + + + + geographicalDQR + + + en + Geographical DQR (Data Quality Rating) + + + urn:samm:io.catenax.pcf:7.0.0#geographicalDQR + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Geographical DQR (Data Quality Rating) + + + + + en + geographicalDQR + + + INTEGER_MEASURE + + + en + Optional: Geographical representativeness of the sources used for PCF (Product Carbon Footprint) calculation based on weighted average of all inputs representing >5% of PCF emissions. Specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. + + + + + + + + + completenessDQR + + + en + Completeness DQR (Data Quality Rating) + + + urn:samm:io.catenax.pcf:7.0.0#completenessDQR + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Completeness DQR (Data Quality Rating) + + + + + en + completenessDQR + + + INTEGER_MEASURE + + + en + Optional: Completeness of the data collected for PCF (Product Carbon Footprint) calculation based on weighted average of all inputs representing >5% of PCF emissions. Specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. + + + + + + + + + reliabilityDQR + + + en + Reliability DQR (Data Quality Rating) + + + urn:samm:io.catenax.pcf:7.0.0#reliabilityDQR + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Reliability DQR (Data Quality Rating) + + + + + en + reliabilityDQR + + + INTEGER_MEASURE + + + en + Optional: Reliability of the data collected for PCF (Product Carbon Footprint) calculation based on weighted average of all inputs representing >5% of PCF emissions. Specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. + + + + + + + + + dqi + + + en + DQI (Data Quality Indicators) + + + urn:samm:io.catenax.pcf:7.0.0#dqi + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + DQI (Data Quality Indicators) + + + + + en + dqi + + + STRING + + + en + Mandatory starting 2025: Quantitative data quality indicators of a PCF (Product Carbon Footprint) as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. + + + + + + + + + packagingEmissionsIncluded + + + en + Packaging Emissions Included + + + urn:samm:io.catenax.pcf:7.0.0#packagingEmissionsIncluded + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Packaging Emissions Included + + + + + en + packagingEmissionsIncluded + + + BOOLEAN + + + en + Mandatory: The Catena-X PCF Rulebook requires to include packaging from a system boundary perspective. "FALSE" is only possible due to the application of the cut-off rule. +Flag indicating whether packaging emissions are included in a PCF (Product Carbon Footprint) as specified in the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. WBCSD specific extension. + + + + + + + + + pcfExcludingBiogenic + + + en + PCF (Product Carbon Footprint) Excluding Biogenic + + + urn:samm:io.catenax.pcf:7.0.0#pcfExcludingBiogenic + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + PCF (Product Carbon Footprint) Excluding Biogenic + + + + + en + pcfExcludingBiogenic + + + INTEGER_MEASURE + + + en + Mandatory: Product carbon footprint of a product excluding biogenic emissions as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. + + + + + + + + + pcfIncludingBiogenic + + + en + PCF (Product Carbon Footprint) Including Biogenic + + + urn:samm:io.catenax.pcf:7.0.0#pcfIncludingBiogenic + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + PCF (Product Carbon Footprint) Including Biogenic + + + + + en + pcfIncludingBiogenic + + + INTEGER_MEASURE + + + en + Mandatory starting 2025: Product carbon footprint of a product including biogenic emissions as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. Optional value in current specification version but will be mandatory in future version. + + + + + + + + + fossilGhgEmissions + + + en + Fossil Emissions + + + urn:samm:io.catenax.pcf:7.0.0#fossilGhgEmissions + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Fossil Emissions + + + + + en + fossilGhgEmissions + + + INTEGER_MEASURE + + + en + Mandatory starting 2025: Emissions from combustion of fossil sources as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. Identical to "pcfExcludingBiogenic", will be removed in later version. + + + + + + + + + biogenicCarbonEmissionsOtherThanCO2 + + + en + Biogenic Carbon Emissions Other Than CO2 + + + urn:samm:io.catenax.pcf:7.0.0#biogenicCarbonEmissionsOtherThanCO2 + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Biogenic Carbon Emissions Other Than CO2 + + + + + en + biogenicCarbonEmissionsOtherThanCO2 + + + INTEGER_MEASURE + + + en + Mandatory starting 2025: GWP (Global Warming Potential) of biogenic CO2e-emissions in production phase which contain only GHG (Greenhouse Gas) emissions other than CO2 - excludes biogenic CO2. For specification see Catena-X PCF Rulebook (Version 3.0.0). + + + + + + + + + biogenicCarbonWithdrawal + + + en + Biogenic Carbon Withdrawal + + + urn:samm:io.catenax.pcf:7.0.0#biogenicCarbonWithdrawal + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Biogenic Carbon Withdrawal + + + + + en + biogenicCarbonWithdrawal + + + INTEGER_MEASURE + + + en + Mandatory starting 2025: Biogenic carbon content in the product converted to CO2e as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.1.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. + + + + + + + + + dlucGhgEmissions + + + en + dLUC (direct land use change) GHG (Greenhouse Gas) Emissions + + + urn:samm:io.catenax.pcf:7.0.0#dlucGhgEmissions + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + dLUC (direct land use change) GHG (Greenhouse Gas) Emissions + + + + + en + dlucGhgEmissions + + + INTEGER_MEASURE + + + en + Mandatory starting 2025: Direct land use change CO2e emissions in context of a product carbon footprint as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. + + + + + + + + + luGhgEmissions + + + en + LU (Land Use) GHG (Greenhouse Gas) Emissions + + + urn:samm:io.catenax.pcf:7.0.0#luGhgEmissions + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + LU (Land Use) GHG (Greenhouse Gas) Emissions + + + + + en + luGhgEmissions + + + INTEGER_MEASURE + + + en + Mandatory starting 2025: Land use CO2 emissions in context of a product carbon footprint as specified by the TFS (Together For Sustainability) initiative. TFS specific extension. + + + + + + + + + aircraftGhgEmissions + + + en + Aircraft GHG Emissions + + + urn:samm:io.catenax.pcf:7.0.0#aircraftGhgEmissions + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Aircraft GHG Emissions + + + + + en + aircraftGhgEmissions + + + INTEGER_MEASURE + + + en + Mandatory starting 2025: GHG (Greenhouse Gas) emissions resulting from aircraft engine usage for the transport of the product as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. + + + + + + + + + packagingGhgEmissions + + + en + Packaging GHG (Greenhouse Gas) Emissions + + + urn:samm:io.catenax.pcf:7.0.0#packagingGhgEmissions + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Packaging GHG (Greenhouse Gas) Emissions + + + + + en + packagingGhgEmissions + + + INTEGER_MEASURE + + + en + Optional: Emissions resulting from the packaging of the product as specified in the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. WBCSD specific extension. In Catena-X not relevant to be reported separately. + + + + + + + + + distributionStagePcfExcludingBiogenic + + + en + Distribution Stage PCF (Product Carbon Footprint) Excluding Biogenic + + + urn:samm:io.catenax.pcf:7.0.0#distributionStagePcfExcludingBiogenic + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Distribution Stage PCF (Product Carbon Footprint) Excluding Biogenic + + + + + en + distributionStagePcfExcludingBiogenic + + + INTEGER_MEASURE + + + en + Optional: Product carbon footprint for the distribution stage of a product excluding biogenic emissions as specified in the Catena-X PCF Rulebook (Version 3.0.0). + + + + + + + + + distributionStagePcfIncludingBiogenic + + + en + Distribution Stage PCF (Product Carbon Footprint) Including Biogenic + + + urn:samm:io.catenax.pcf:7.0.0#distributionStagePcfIncludingBiogenic + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Distribution Stage PCF (Product Carbon Footprint) Including Biogenic + + + + + en + distributionStagePcfIncludingBiogenic + + + INTEGER_MEASURE + + + en + Optional: Product carbon footprint for the distribution stage of a product including biogenic emissions as specified in the Catena-X PCF Rulebook (Version 3.0.0). + + + + + + + + + distributionStageFossilGhgEmissions + + + en + Distribution Stage Fossil GHG (Greenhouse Gas) Emissions + + + urn:samm:io.catenax.pcf:7.0.0#distributionStageFossilGhgEmissions + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Distribution Stage Fossil GHG (Greenhouse Gas) Emissions + + + + + en + distributionStageFossilGhgEmissions + + + INTEGER_MEASURE + + + en + Optional: Emissions from the combustion of fossil sources in the distribution stage as specified in the Catena-X PCF Rulebook (Version 3.0.0). + + + + + + + + + distributionStageBiogenicCarbonEmissionsOtherThanCO2 + + + en + Distribution Stage Biogenic Carbon Emissions Other Than CO2 + + + urn:samm:io.catenax.pcf:7.0.0#distributionStageBiogenicCarbonEmissionsOtherThanCO2 + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Distribution Stage Biogenic Carbon Emissions Other Than CO2 + + + + + en + distributionStageBiogenicCarbonEmissionsOtherThanCO2 + + + INTEGER_MEASURE + + + en + Optional: GWP (Global Warming Potential) of biogenic CO2e-emissions in distribution phase which contain only GHG (Greenhouse Gas) emissions other than CO2 ? excludes biogenic CO2. For specification see Catena-X PCF Rulebook (Version 3.0.0). + + + + + + + + + distributionStageBiogenicCarbonWithdrawal + + + en + Distribution Stage Biogenic Carbon Withdrawal + + + urn:samm:io.catenax.pcf:7.0.0#distributionStageBiogenicCarbonWithdrawal + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Distribution Stage Biogenic Carbon Withdrawal + + + + + en + distributionStageBiogenicCarbonWithdrawal + + + INTEGER_MEASURE + + + en + Optional: GWP (Global Warming Potential) of biogenic CO2-withdrawal in distribution stage (biogenic CO2 contained in the product) as specified in the Catena-X PCF Rulebook (Version 3.0.0). + + + + + + + + + distributionStageDlucGhgEmissions + + + en + Distribution Stage dLUC (direct land use change) GHG (Greenhouse Gas) Emissions + + + urn:samm:io.catenax.pcf:7.0.0#distributionStageDlucGhgEmissions + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Distribution Stage dLUC (direct land use change) GHG (Greenhouse Gas) Emissions + + + + + en + distributionStageDlucGhgEmissions + + + INTEGER_MEASURE + + + en + Optional: Direct land use change CO2 emissions during distribution stage in context of a product carbon footprint as specified by the TFS (Together For Sustainability) initiative. TFS specific extension. + + + + + + + + + distributionStageLuGhgEmissions + + + en + Distribution Stage LU (Land Use) GHG (Greenhouse Gas) Emissions + + + urn:samm:io.catenax.pcf:7.0.0#distributionStageLuGhgEmissions + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Distribution Stage LU (Land Use) GHG (Greenhouse Gas) Emissions + + + + + en + distributionStageLuGhgEmissions + + + INTEGER_MEASURE + + + en + Optional: Land use CO2 emissions in context of a product carbon footprint as specified by the TFS (Together For Sustainability) initiative. TFS specific extension. + + + + + + + + + carbonContentTotal + + + en + Carbon Content Total + + + urn:samm:io.catenax.pcf:7.0.0#carbonContentTotal + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Carbon Content Total + + + + + en + carbonContentTotal + + + INTEGER_MEASURE + + + en + Mandatory starting 2025: Total carbon content per declared unit in context of a product carbon footprint as specified in the Catena-X PCF Rulebook (Version 3.0.0). + + + + + + + + + fossilCarbonContent + + + en + Fossil Carbon Content + + + urn:samm:io.catenax.pcf:7.0.0#fossilCarbonContent + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Fossil Carbon Content + + + + + en + fossilCarbonContent + + + INTEGER_MEASURE + + + en + Mandatory starting 2025: Fossil carbon amount embodied in a product as specified in the technical specifications for PCF Data Exchange (Version 2.1.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. Must be calculated with kgC (kilogram Carbon) / declaredUnit equal to or greater zero; WBCSD specific extension, in Catena-X specified by a calculated value. + + + + + + + + + biogenicCarbonContent + + + en + Biogenic Carbon Content + + + urn:samm:io.catenax.pcf:7.0.0#biogenicCarbonContent + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Biogenic Carbon Content + + + + + en + biogenicCarbonContent + + + INTEGER_MEASURE + + + en + Mandatory starting 2025: Biogenic carbon amount embodied in a product as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.1.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. Must be calculated with kgC (kilogram Carbon) / declaredUnit equal to or greater zero. + + + + + + + + + distributionStageAircraftGhgEmissions + + + en + Distribution Stage Aircraft GHG Emissions + + + urn:samm:io.catenax.pcf:7.0.0#distributionStageAircraftGhgEmissions + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Distribution Stage Aircraft GHG Emissions + + + + + en + distributionStageAircraftGhgEmissions + + + INTEGER_MEASURE + + + en + Optional: GHG (Greenhouse Gas) emissions for the distribution stage resulting from aircraft engine usage for the transport of the product as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. + + + + + + + + + pcf + + + en + PCF (Product Carbon Footprint) + + + urn:samm:io.catenax.pcf:7.0.0#pcf + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + PCF (Product Carbon Footprint) + + + + + en + pcf + + + STRING + + + en + A PCF (Product Carbon Footprint) represents the carbon footprint of a product and related data as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. + + + + + + + + + pcfLegalStatement + + + en + PCF (Product Carbon Footprint) Legal Statement + + + urn:samm:io.catenax.pcf:7.0.0#pcfLegalStatement + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + PCF (Product Carbon Footprint) Legal Statement + + + + + en + pcfLegalStatement + + + STRING + + + en + Optional: Option for legal statement/ disclaimer as specified in the Catena-X PCF Rulebook (Version 3.0.0). + + + + + + + + + diff --git a/io.catenax.pcf/7.0.0/gen/Pcf-schema.json b/io.catenax.pcf/7.0.0/gen/Pcf-schema.json new file mode 100644 index 000000000..bf78430ec --- /dev/null +++ b/io.catenax.pcf/7.0.0/gen/Pcf-schema.json @@ -0,0 +1,522 @@ +{ + "$schema" : "http://json-schema.org/draft-04/schema", + "description" : "A Product (Carbon) Footprint represents the carbon footprint of a product with values as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the WBCSD (World Business Council for Sustainable Development) Pathfinder framework and the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD/ PACT initiative.", + "type" : "object", + "components" : { + "schemas" : { + "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.pcf_7.0.0_PartialFullPcfCharacteristic" : { + "type" : "string", + "description" : "Characteristic for defining an indicator for partial or full PCF (Product Carbon Footprint) declaration as specified in the Catena-X PCF Rulebook (Version 3.0.0).", + "enum" : [ "Cradle-to-gate", "Cradle-to-grave" ] + }, + "urn_samm_io.catenax.pcf_7.0.0_PrecedingPfId" : { + "description" : "Entity for defining a preceding PCF (Product Carbon Footprint) identifier entity as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.", + "type" : "object", + "properties" : { + "id" : { + "description" : "Mandatory: The product footprint identifier as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.uuid_2.0.0_UuidV4Trait" + } + }, + "required" : [ "id" ] + }, + "urn_samm_io.catenax.pcf_7.0.0_PrecedingPfIdsCharacteristic" : { + "description" : "Characteristic for defining a non-empty set of product (carbon) footprint identifiers as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the WBCSD (World Business Council for Sustainable Development) Pathfinder framework and the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD/ PACT initiative.", + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/urn_samm_io.catenax.pcf_7.0.0_PrecedingPfId" + } + }, + "urn_samm_io.catenax.pcf_7.0.0_ProductFootprintVersion" : { + "type" : "number", + "minimum" : 0, + "description" : "Characteristic for defining a product footprint version as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative." + }, + "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.pcf_7.0.0_PfStatusCharacteristic" : { + "type" : "string", + "description" : "Characteristic for defining a status indicator of a product (carbon) footprint as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. Enumeration with possible \"Active\" and \"Deprecated\".", + "enum" : [ "Active", "Deprecated" ] + }, + "urn_samm_io.catenax.pcf_7.0.0_NonEmptyStringTrait" : { + "type" : "string", + "description" : "Constraint for ensuring that a string has at least one character.", + "minLength" : 1 + }, + "urn_samm_io.catenax.pcf_7.0.0_IdsTrait" : { + "description" : "Constraint for defining a non-empty set of URIs (Uniform Resource Identifieres).", + "type" : "array", + "items" : { + "type" : "string", + "format" : "uri" + }, + "minItems" : 1 + }, + "urn_samm_io.catenax.pcf_7.0.0_DeclaredUnitCharacteristic" : { + "type" : "string", + "description" : "Unit of analysis of the product with accepted values as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. For countable products/ components/ materials, Catena-X for example adds the unit \"piece\" to the value list specified by WBCSD.", + "enum" : [ "liter", "kilogram", "cubic meter", "kilowatt hour", "megajoule", "ton kilometer", "square meter", "piece" ] + }, + "urn_samm_io.catenax.pcf_7.0.0_StrictlyPositiveDecimalTrait" : { + "type" : "number", + "description" : "Constraint for defining a positive, non-zero decimal.", + "minimum" : 0.0, + "exclusiveMinimum" : true + }, + "urn_samm_io.catenax.pcf_7.0.0_PositiveDecimalWeightTrait" : { + "type" : "number", + "description" : "Constraint for defining a decimal equal to or greater than zero.", + "minimum" : 0, + "exclusiveMinimum" : false + }, + "urn_samm_io.catenax.pcf_7.0.0_ExemptedEmissionsPercentTrait" : { + "type" : "number", + "description" : "Characteristic for defining the percentage of emissions excluded from a PCF (Product Carbon Footprint) as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.", + "maximum" : 5.0, + "exclusiveMaximum" : false, + "minimum" : 0.0, + "exclusiveMinimum" : false + }, + "urn_samm_io.catenax.pcf_7.0.0_GeographyCountrySubdivisionTrait" : { + "type" : "string", + "description" : "Constraint for defining a geography country subdivision in compliance to ISO 3166-2 as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.", + "pattern" : "([A-Z]{2}-[A-Z0-9]{1,3}|)" + }, + "urn_samm_io.catenax.pcf_7.0.0_GeographyCountryTrait" : { + "type" : "string", + "description" : "Constraint for defining a geography country conform to ISO 3166CC as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.", + "pattern" : "([A-Z]{2})" + }, + "urn_samm_io.catenax.pcf_7.0.0_GeographyRegionOrSubregionCharacteristic" : { + "type" : "string", + "description" : "Characteristic for defining a list of valid geographic regions as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. In Catena-X for example \"Global\" has been added to the value list.", + "enum" : [ "Africa", "Americas", "Asia", "Europe", "Oceania", "Australia and New Zealand", "Central Asia", "Eastern Asia", "Eastern Europe", "Latin America and the Caribbean", "Melanesia", "Micronesia", "Northern Africa", "Northern America", "Northern Europe", "Polynesia", "South-eastern Asia", "Southern Asia", "Southern Europe", "Sub-Saharan Africa", "Western Asia", "Western Europe", "Global", "Several" ] + }, + "urn_samm_io.catenax.pcf_7.0.0_CrossSectoralStandardsUsedEnumerationCharacteristic" : { + "type" : "string", + "description" : "Characteristic for defining the enumeration of valid accounting standards used for product carbon footprint calculation as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.", + "enum" : [ "ISO Standard 14067", "ISO Standard 14044", "Pathfinder v1", "Pathfinder v2", "PAS 2050", "ISO Standard 14040", "ISO Standard 14041", "ISO Standard 14042", "ISO Standard 14043", "PEF", "Other", "GHG Protocol Product Standard" ] + }, + "urn_samm_io.catenax.pcf_7.0.0_CrossSectoralStandard" : { + "description" : "Entity for defining an accounting standard used for product carbon footprint calculation as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.", + "type" : "object", + "properties" : { + "crossSectoralStandard" : { + "description" : "Mandatory: Discloses a cross-sectoral standard applied for calculating or allocating GHG (Greenhouse Gas) emissions as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.pcf_7.0.0_CrossSectoralStandardsUsedEnumerationCharacteristic" + } + }, + "required" : [ "crossSectoralStandard" ] + }, + "urn_samm_io.catenax.pcf_7.0.0_CrossSectoralStandardSet" : { + "description" : "Characteristic for defining the list of valid accounting standards used for product carbon footprint calculation as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.", + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/urn_samm_io.catenax.pcf_7.0.0_CrossSectoralStandard" + } + }, + "urn_samm_io.catenax.pcf_7.0.0_ProductOrSectorSpecificRuleOperator" : { + "type" : "string", + "description" : "Enumeration of PCR (Product Category Rule) operators as specified in the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. WBCSD specific extension for example in Catena-X.", + "enum" : [ "PEF", "EPD International", "Other" ] + }, + "urn_samm_io.catenax.pcf_7.0.0_RuleName" : { + "description" : "Name of a rule applied by a specified operator as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.", + "type" : "object", + "properties" : { + "ruleName" : { + "description" : "Name of a rule applied by a specific operator as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.pcf_7.0.0_NonEmptyStringTrait" + } + }, + "required" : [ "ruleName" ] + }, + "urn_samm_io.catenax.pcf_7.0.0_RuleNamesTrait" : { + "description" : "Constraint for defining a non-empty set of rule names as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.", + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/urn_samm_io.catenax.pcf_7.0.0_RuleName" + }, + "uniqueItems" : true, + "minItems" : 1 + }, + "urn_samm_io.catenax.pcf_7.0.0_ProductOrSectorSpecificRule" : { + "description" : "Entity for defining a product or sector specific rule of a product carbon footprint as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.", + "type" : "object", + "properties" : { + "extWBCSD_operator" : { + "description" : "Mandatory: Operator of PCR (Product Category Rule)/ PSR (Product Specific Rule) as specified in the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. WBCSD specific extension, in Catena-X for example must always be \"Other\".", + "$ref" : "#/components/schemas/urn_samm_io.catenax.pcf_7.0.0_ProductOrSectorSpecificRuleOperator" + }, + "productOrSectorSpecificRules" : { + "description" : "Mandatory: Product-specific or sector-specific set of rules used for calculating or allocating GHG (Greenhouse Gas) emissions applied from the specified operator as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.pcf_7.0.0_RuleNamesTrait" + }, + "extWBCSD_otherOperatorName" : { + "description" : "Optional: Other operator of PCR (Product Category Rule)/ PSR (Product Specific Rule) as specified in the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. WBCSD specific extension, in Catena-X for example specified by a default value.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.pcf_7.0.0_NonEmptyStringTrait" + } + }, + "required" : [ "extWBCSD_operator", "productOrSectorSpecificRules" ] + }, + "urn_samm_io.catenax.pcf_7.0.0_ProductOrSectorSpecificRuleSet" : { + "description" : "Characteristic for defining the set of product or sector specific rules of a product carbon footprint as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.", + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/urn_samm_io.catenax.pcf_7.0.0_ProductOrSectorSpecificRule" + }, + "uniqueItems" : true + }, + "urn_samm_io.catenax.pcf_7.0.0_CharacterizationFactorsCharacteristic" : { + "type" : "string", + "description" : "Characteristic for defining the characterization factors of a product carbon footprint as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. In Catena-X for example specified by a default value.", + "enum" : [ "AR5", "AR6" ] + }, + "urn_samm_io.catenax.pcf_7.0.0_AllocationWasteIncinerationCharacteristic" : { + "type" : "string", + "description" : "Characteristic for defining the allocation approach used for waste incineration as specified by the TFS (Together For Sustainability) initiative.", + "enum" : [ "cut-off", "reverse cut-off", "system expansion" ] + }, + "urn_samm_io.catenax.pcf_7.0.0_PercentTrait" : { + "type" : "number", + "description" : "Constraint for a decimal number in the range of and including 0 and 100.", + "maximum" : 100.0, + "exclusiveMaximum" : false, + "minimum" : 0.0, + "exclusiveMinimum" : false + }, + "urn_samm_io.catenax.pcf_7.0.0_EmissionFactorDS" : { + "description" : "Entity for defining an emission factor data source used to calculate a product carbon footprint as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.", + "type" : "object", + "properties" : { + "secondaryEmissionFactorSource" : { + "description" : "Mandatory: Emission factor data source used to calculate a product carbon footprint as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + } + }, + "required" : [ "secondaryEmissionFactorSource" ] + }, + "urn_samm_io.catenax.pcf_7.0.0_EmissionFactorDSSet" : { + "description" : "Characteristic for defining a set of emission factor sources used for calculating a product carbon footprint as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.", + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/urn_samm_io.catenax.pcf_7.0.0_EmissionFactorDS" + }, + "uniqueItems" : true + }, + "urn_samm_io.catenax.pcf_7.0.0_DqiNumberTrait" : { + "type" : "number", + "description" : "Constraint for defining a decimal between 1 and 3 including.", + "maximum" : 3, + "exclusiveMaximum" : false, + "minimum" : 1, + "exclusiveMinimum" : false + }, + "urn_samm_io.catenax.pcf_7.0.0_DataQualityIndicators" : { + "description" : "Characteristic for defining the quantitative data quality indicators of a PCF (Product Carbon Footprint) as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.", + "type" : "object", + "properties" : { + "coveragePercent" : { + "description" : "Mandatory starting 2025: Percentage of PCF (Product Carbon Footprint) included in the data quality assessment based on the >5% emissions threshold as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. In Catena-X for example set to \"100\" per default.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.pcf_7.0.0_PercentTrait" + }, + "technologicalDQR" : { + "description" : "Optional: Technological representativeness of the sources used for PCF (Product Carbon Footprint) calculation based on weighted average of all inputs representing >5% of PCF emissions. Specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.pcf_7.0.0_DqiNumberTrait" + }, + "temporalDQR" : { + "description" : "Optional: Temporal representativeness of the sources used for PCF (Product Carbon Footprint) calculation based on weighted average of all inputs representing >5% of PCF emissions. Specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.pcf_7.0.0_DqiNumberTrait" + }, + "geographicalDQR" : { + "description" : "Optional: Geographical representativeness of the sources used for PCF (Product Carbon Footprint) calculation based on weighted average of all inputs representing >5% of PCF emissions. Specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.pcf_7.0.0_DqiNumberTrait" + }, + "completenessDQR" : { + "description" : "Optional: Completeness of the data collected for PCF (Product Carbon Footprint) calculation based on weighted average of all inputs representing >5% of PCF emissions. Specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.pcf_7.0.0_DqiNumberTrait" + }, + "reliabilityDQR" : { + "description" : "Optional: Reliability of the data collected for PCF (Product Carbon Footprint) calculation based on weighted average of all inputs representing >5% of PCF emissions. Specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.pcf_7.0.0_DqiNumberTrait" + } + } + }, + "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.pcf_7.0.0_PositiveEmissionsTrait" : { + "type" : "number", + "description" : "Only positive emission values (>0) are valid ", + "minimum" : 0.0, + "exclusiveMinimum" : false + }, + "urn_samm_io.catenax.pcf_7.0.0_PositiveOrNegativeEmission" : { + "type" : "number", + "description" : "Characteristic for defining (positive or negative) emissions in context of a PCF (Product Carbon Footprint) as specified by the WBCSD (World Business Council for Sustainable Development) Pathfinder initiative." + }, + "urn_samm_io.catenax.pcf_7.0.0_NegativeEmissionsTrait" : { + "type" : "number", + "description" : "Only negative emission values (<=0) are valid.", + "maximum" : 0.0, + "exclusiveMaximum" : false + }, + "urn_samm_io.catenax.pcf_7.0.0_PcfEntity" : { + "description" : "Characteristic for defining a PCF (Product Carbon Footprint) as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.", + "type" : "object", + "properties" : { + "declaredUnit" : { + "description" : "Mandatory: Unit of analysis of a product in context of the PCF (product carbon footprint) as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. In Catena-X for example list of valid units includes \"piece\".", + "$ref" : "#/components/schemas/urn_samm_io.catenax.pcf_7.0.0_DeclaredUnitCharacteristic" + }, + "unitaryProductAmount" : { + "description" : "Mandatory: Amount of units contained within a product in context of the PCF (Product Carbon Footprint) as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.pcf_7.0.0_StrictlyPositiveDecimalTrait" + }, + "productMassPerDeclaredUnit" : { + "description" : "Mandatory: Mass of a product per declared unit (net, unpackaged) in context of the PCF (Product Carbon Footprint) as specified in the Catena-X PCF Rulebook (Version 3.0.0).", + "$ref" : "#/components/schemas/urn_samm_io.catenax.pcf_7.0.0_PositiveDecimalWeightTrait" + }, + "exemptedEmissionsPercent" : { + "description" : "Mandatory: Applied cut-off percentage of emissions excluded from PCF (Product Carbon Footprint).\nFor accordance with Catena-X PCF Rulebook (Version 3.0.0) <3%.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.pcf_7.0.0_ExemptedEmissionsPercentTrait" + }, + "exemptedEmissionsDescription" : { + "description" : "Optional: Rationale behind exclusion of specific PCF (Product Carbon Footprint) emissions as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "boundaryProcessesDescription" : { + "description" : "Optional: Processes attributable to each lifecycle stage as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "geographyCountrySubdivision" : { + "description" : "Optional: Subdivision of a country which must be an ISO 3166-2 subdivision code as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.pcf_7.0.0_GeographyCountrySubdivisionTrait" + }, + "geographyCountry" : { + "description" : "Optional: Two letter country code that must conform to data type ISO 3166CC as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.pcf_7.0.0_GeographyCountryTrait" + }, + "geographyRegionOrSubregion" : { + "description" : "Mandatory: Region according to list as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.pcf_7.0.0_GeographyRegionOrSubregionCharacteristic" + }, + "referencePeriodStart" : { + "description" : "Mandatory: Start of time boundary for which a PCF (Product Carbon Footprint) value is considered to be representative as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Timestamp" + }, + "referencePeriodEnd" : { + "description" : "Mandatory: End of time boundary for which a PCF (Product Carbon Footprint) value is considered to be representative as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Timestamp" + }, + "crossSectoralStandardsUsed" : { + "description" : "Mandatory: Discloses the cross-sectoral standards applied for calculating or allocating GHG (Greenhouse Gas) emissions as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.pcf_7.0.0_CrossSectoralStandardSet" + }, + "productOrSectorSpecificRules" : { + "description" : "Mandatory: Product or sector specific rules applied for calculating or allocating GHG (Greenhouse Gas) emissions, e.g. PCRs (Product Category Rules), including operators or publishers and according rule names as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.pcf_7.0.0_ProductOrSectorSpecificRuleSet" + }, + "extWBCSD_characterizationFactors" : { + "description" : "Mandatory: IPCC (Intergovernmental Panel on Climate Change) version of the GWP (Global Warming Potential) characterization factors used for calculating the PCF (Product Carbon Footprint) as specified in the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. WBCSD specific extension, in Catena-X for example specified by default with value \\\"AR6\\\". Default value can be overwritten.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.pcf_7.0.0_CharacterizationFactorsCharacteristic" + }, + "extWBCSD_allocationRulesDescription" : { + "description" : "Optional: Allocation rules used and underlying reasoning in context of a product carbon footprint as specified in the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. WBCSD specific extension, in Catena-X for example specified by default with value \"In accordance with Catena-X PCF Rulebook (Version 3.0.0)\".", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "extTFS_allocationWasteIncineration" : { + "description" : "Mandatory: Allocation approach used for waste incineration with energy recovery as specified by the TFS (Together For Sustainability) initiative. In Catena-X for example must be specified by value \"cut-off\".", + "$ref" : "#/components/schemas/urn_samm_io.catenax.pcf_7.0.0_AllocationWasteIncinerationCharacteristic" + }, + "primaryDataShare" : { + "description" : "Mandatory starting 2025: Share of primary data in percent as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.pcf_7.0.0_PercentTrait" + }, + "secondaryEmissionFactorSources" : { + "description" : "Mandatory: Emission factors used for the PCF (Product Carbon Footprint) calculation as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.pcf_7.0.0_EmissionFactorDSSet" + }, + "dataQualityRating" : { + "description" : "Mandatory starting 2025: Quantitative data quality indicators of a PCF (Product Carbon Footprint) as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.pcf_7.0.0_DataQualityIndicators" + }, + "extWBCSD_packagingEmissionsIncluded" : { + "description" : "Mandatory: The Catena-X PCF Rulebook requires to include packaging from a system boundary perspective. \"FALSE\" is only possible due to the application of the cut-off rule.\nFlag indicating whether packaging emissions are included in a PCF (Product Carbon Footprint) as specified in the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. WBCSD specific extension.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Boolean" + }, + "pcfExcludingBiogenic" : { + "description" : "Mandatory: Product carbon footprint of a product excluding biogenic emissions as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.pcf_7.0.0_PositiveEmissionsTrait" + }, + "pcfIncludingBiogenic" : { + "description" : "Mandatory starting 2025: Product carbon footprint of a product including biogenic emissions as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. Optional value in current specification version but will be mandatory in future version.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.pcf_7.0.0_PositiveOrNegativeEmission" + }, + "fossilGhgEmissions" : { + "description" : "Mandatory starting 2025: Emissions from combustion of fossil sources as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. Identical to \"pcfExcludingBiogenic\", will be removed in later version.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.pcf_7.0.0_PositiveEmissionsTrait" + }, + "biogenicCarbonEmissionsOtherThanCO2" : { + "description" : "Mandatory starting 2025: GWP (Global Warming Potential) of biogenic CO2e-emissions in production phase which contain only GHG (Greenhouse Gas) emissions other than CO2 - excludes biogenic CO2. For specification see Catena-X PCF Rulebook (Version 3.0.0).", + "$ref" : "#/components/schemas/urn_samm_io.catenax.pcf_7.0.0_PositiveEmissionsTrait" + }, + "biogenicCarbonWithdrawal" : { + "description" : "Mandatory starting 2025: Biogenic carbon content in the product converted to CO2e as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.1.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.pcf_7.0.0_NegativeEmissionsTrait" + }, + "dlucGhgEmissions" : { + "description" : "Mandatory starting 2025: Direct land use change CO2e emissions in context of a product carbon footprint as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.pcf_7.0.0_PositiveEmissionsTrait" + }, + "extTFS_luGhgEmissions" : { + "description" : "Mandatory starting 2025: Land use CO2 emissions in context of a product carbon footprint as specified by the TFS (Together For Sustainability) initiative. TFS specific extension.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.pcf_7.0.0_PositiveOrNegativeEmission" + }, + "aircraftGhgEmissions" : { + "description" : "Mandatory starting 2025: GHG (Greenhouse Gas) emissions resulting from aircraft engine usage for the transport of the product as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.pcf_7.0.0_PositiveEmissionsTrait" + }, + "extWBCSD_packagingGhgEmissions" : { + "description" : "Optional: Emissions resulting from the packaging of the product as specified in the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. WBCSD specific extension. In Catena-X not relevant to be reported separately.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.pcf_7.0.0_PositiveEmissionsTrait" + }, + "distributionStagePcfExcludingBiogenic" : { + "description" : "Optional: Product carbon footprint for the distribution stage of a product excluding biogenic emissions as specified in the Catena-X PCF Rulebook (Version 3.0.0).", + "$ref" : "#/components/schemas/urn_samm_io.catenax.pcf_7.0.0_PositiveEmissionsTrait" + }, + "distributionStagePcfIncludingBiogenic" : { + "description" : "Optional: Product carbon footprint for the distribution stage of a product including biogenic emissions as specified in the Catena-X PCF Rulebook (Version 3.0.0).", + "$ref" : "#/components/schemas/urn_samm_io.catenax.pcf_7.0.0_PositiveOrNegativeEmission" + }, + "distributionStageFossilGhgEmissions" : { + "description" : "Optional: Emissions from the combustion of fossil sources in the distribution stage as specified in the Catena-X PCF Rulebook (Version 3.0.0).", + "$ref" : "#/components/schemas/urn_samm_io.catenax.pcf_7.0.0_PositiveEmissionsTrait" + }, + "distributionStageBiogenicCarbonEmissionsOtherThanCO2" : { + "description" : "Optional: GWP (Global Warming Potential) of biogenic CO2e-emissions in distribution phase which contain only GHG (Greenhouse Gas) emissions other than CO2 ? excludes biogenic CO2. For specification see Catena-X PCF Rulebook (Version 3.0.0).", + "$ref" : "#/components/schemas/urn_samm_io.catenax.pcf_7.0.0_PositiveEmissionsTrait" + }, + "distributionStageBiogenicCarbonWithdrawal" : { + "description" : "Optional: GWP (Global Warming Potential) of biogenic CO2-withdrawal in distribution stage (biogenic CO2 contained in the product) as specified in the Catena-X PCF Rulebook (Version 3.0.0).", + "$ref" : "#/components/schemas/urn_samm_io.catenax.pcf_7.0.0_NegativeEmissionsTrait" + }, + "extTFS_distributionStageDlucGhgEmissions" : { + "description" : "Optional: Direct land use change CO2 emissions during distribution stage in context of a product carbon footprint as specified by the TFS (Together For Sustainability) initiative. TFS specific extension.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.pcf_7.0.0_PositiveEmissionsTrait" + }, + "extTFS_distributionStageLuGhgEmissions" : { + "description" : "Optional: Land use CO2 emissions in context of a product carbon footprint as specified by the TFS (Together For Sustainability) initiative. TFS specific extension.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.pcf_7.0.0_PositiveOrNegativeEmission" + }, + "carbonContentTotal" : { + "description" : "Mandatory starting 2025: Total carbon content per declared unit in context of a product carbon footprint as specified in the Catena-X PCF Rulebook (Version 3.0.0).", + "$ref" : "#/components/schemas/urn_samm_io.catenax.pcf_7.0.0_PositiveEmissionsTrait" + }, + "extWBCSD_fossilCarbonContent" : { + "description" : "Mandatory starting 2025: Fossil carbon amount embodied in a product as specified in the technical specifications for PCF Data Exchange (Version 2.1.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. Must be calculated with kgC (kilogram Carbon) / declaredUnit equal to or greater zero; WBCSD specific extension, in Catena-X specified by a calculated value.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.pcf_7.0.0_PositiveEmissionsTrait" + }, + "carbonContentBiogenic" : { + "description" : "Mandatory starting 2025: Biogenic carbon amount embodied in a product as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.1.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. Must be calculated with kgC (kilogram Carbon) / declaredUnit equal to or greater zero.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.pcf_7.0.0_PositiveEmissionsTrait" + }, + "distributionStageAircraftGhgEmissions" : { + "description" : "Optional: GHG (Greenhouse Gas) emissions for the distribution stage resulting from aircraft engine usage for the transport of the product as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.pcf_7.0.0_PositiveEmissionsTrait" + } + }, + "required" : [ "declaredUnit", "unitaryProductAmount", "productMassPerDeclaredUnit", "exemptedEmissionsPercent", "geographyRegionOrSubregion", "referencePeriodStart", "referencePeriodEnd", "crossSectoralStandardsUsed", "productOrSectorSpecificRules", "extWBCSD_characterizationFactors", "extTFS_allocationWasteIncineration", "secondaryEmissionFactorSources", "extWBCSD_packagingEmissionsIncluded", "pcfExcludingBiogenic" ] + } + } + }, + "properties" : { + "id" : { + "description" : "Mandatory: The product footprint identifier as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.uuid_2.0.0_UuidV4Trait" + }, + "specVersion" : { + "description" : "Mandatory: Version of the product footprint data specification as defined in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "partialFullPcf" : { + "description" : "Mandatory: Indicator for partial or full PCF (Product Carbon Footprint) declaration as specified in the Catena-X PCF Rulebook (Version 3.0.0).", + "$ref" : "#/components/schemas/urn_samm_io.catenax.pcf_7.0.0_PartialFullPcfCharacteristic" + }, + "precedingPfIds" : { + "description" : "Optional: Set of preceding PCF (Product Carbon Footprint) identifiers without duplicates as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the WBCSD (World Business Council for Sustainable Development) Pathfinder framework and the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD/ PACT initiative. Declared as \"optional\" in WBCSD, needs to be covered by application.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.pcf_7.0.0_PrecedingPfIdsCharacteristic" + }, + "version" : { + "description" : "Mandatory: Version of the product (carbon) footprint as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. In Catena-X for example set to \"0\" per default.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.pcf_7.0.0_ProductFootprintVersion" + }, + "created" : { + "description" : "Mandatory: Timestamp of the creation of the Product (Carbon) Footprint as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Timestamp" + }, + "extWBCSD_pfStatus" : { + "description" : "Mandatory: Status indicator of a product (carbon) footprint as specified in the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. WBCSD specific extension, in Catena-X for example set to \"Active\" per default.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.pcf_7.0.0_PfStatusCharacteristic" + }, + "validityPeriodStart" : { + "description" : "Optional: Start of interval during which the product (carbon) footprint is declared as valid as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. If specified, the validity period start must be equal to or greater than the reference period end.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Timestamp" + }, + "validityPeriodEnd" : { + "description" : "Optional: End of interval during which the product (carbon) footprint is declared as valid as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Timestamp" + }, + "comment" : { + "description" : "Optional: Additional information and instructions related to the calculation of the product (carbon) footprint as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "companyName" : { + "description" : "Mandatory: Name of the product (carbon) footprint data owner as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.pcf_7.0.0_NonEmptyStringTrait" + }, + "companyIds" : { + "description" : "Mandatory: Non-empty set of Uniform Resource Names (URN). Each value is supposed to uniquely identify the product (carbon) footprint data owner as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.1.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. For Catena-X Industry Core compliance the set of URNs must contain at least the Business Partner Number Legal Entity (BPNL) in the specified format urn:bpn:id:BPNL[a-zA-Z0-9]{12}. ", + "$ref" : "#/components/schemas/urn_samm_io.catenax.pcf_7.0.0_IdsTrait" + }, + "productDescription" : { + "description" : "Optional: Free-form description of the product as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "productIds" : { + "description" : "Mandatory: Non-empty set of product identifiers. Each value is supposed to uniquely identify the product as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.1.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. In Catena-X productId corresponds with Industry Core manufacturerPartId.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.pcf_7.0.0_IdsTrait" + }, + "extWBCSD_productCodeCpc" : { + "description" : "Mandatory: UN (United Nations) Product Classification Code (CPC - Central Classification Code) of a given product as specified the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. WBCSD specific extension, which will probably be declared as \"optional\" in a later WBCSD specification version. In Catena-X for example specified with default value \"011-99000\".", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "productName" : { + "description" : "Mandatory: Non-empty trade name of a product as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.1.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. In Catena-X productNameCompany corresponds with Industry Core nameAtManufacturer. ", + "$ref" : "#/components/schemas/urn_samm_io.catenax.pcf_7.0.0_NonEmptyStringTrait" + }, + "pcf" : { + "description" : "A PCF (Product Carbon Footprint) represents the carbon footprint of a product and related data as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.pcf_7.0.0_PcfEntity" + }, + "pcfLegalStatement" : { + "description" : "Optional: Option for legal statement/ disclaimer as specified in the Catena-X PCF Rulebook (Version 3.0.0).", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + } + }, + "required" : [ "id", "specVersion", "partialFullPcf", "version", "created", "extWBCSD_pfStatus", "companyName", "companyIds", "productIds", "extWBCSD_productCodeCpc", "productName", "pcf" ] +} \ No newline at end of file diff --git a/io.catenax.pcf/7.0.0/gen/Pcf.aasx b/io.catenax.pcf/7.0.0/gen/Pcf.aasx new file mode 100644 index 000000000..92f0341cf Binary files /dev/null and b/io.catenax.pcf/7.0.0/gen/Pcf.aasx differ diff --git a/io.catenax.pcf/7.0.0/gen/Pcf.html b/io.catenax.pcf/7.0.0/gen/Pcf.html new file mode 100644 index 000000000..b54b79e18 --- /dev/null +++ b/io.catenax.pcf/7.0.0/gen/Pcf.html @@ -0,0 +1,6665 @@ + + + + + + + + + + + + + + Documentation Product (Carbon) Footprint + + +
+
+
+
+

Aspect Model Product (Carbon) Footprint

+
urn:samm:io.catenax.pcf:7.0.0#Pcf
+
+
+
+
+
+
+
+ +
+ + +
+ A Product (Carbon) Footprint represents the carbon footprint of a product with values as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the WBCSD (World Business Council for Sustainable Development) Pathfinder framework and the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD/ PACT initiative. +
+ + +
+

Overview

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

Properties

+
+ +
+ +
+

Comment

+
+ +Optional: Additional information and instructions related to the calculation of the product (carbon) footprint as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. + +
+
Name
+
comment
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Additional explanatory information not reflected by other attributes
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
comment
+
+ +
+
Reference
+
+
    +
  • https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/
    • +
+
+
+ +
+
+ +
+

Company IDs

+
+ +Mandatory: Non-empty set of Uniform Resource Names (URN). Each value is supposed to uniquely identify the product (carbon) footprint data owner as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.1.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. For Catena-X Industry Core compliance the set of URNs must contain at least the Business Partner Number Legal Entity (BPNL) in the specified format urn:bpn:id:BPNL[a-zA-Z0-9]{12}.  + +
+
Name
+
companyIds
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#anyURI + +
+
+
+
+
+ +
+
Example
+
urn:bpn:id:BPNL000000000DW
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
companyIds
+
+ +
+
Reference
+
+
    +
  • urn:samm:io.catenax.shared.business_partner_number:2.0.0#bpnlProperty
    • +
+
+
+ +
+
Constraints
+
+
    +
  • +
    + +
    + Non Empty Set Constraint +
    + +
    +
    Description
    +
    Constraint for defining a non-empty set of URIs (Uniform Resource Identifieres).
    +
    + + +
    +
    Min. Length
    +
    1
    +
    + +
    • +
+
+
+
+
+ +
+

Company Name

+
+ +Mandatory: Name of the product (carbon) footprint data owner as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. + +
+
Name
+
companyName
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
My Corp
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
companyName
+
+ +
+
Reference
+
+
    +
  • https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/
    • +
+
+
+ +
+
Constraints
+
+
    +
  • +
    + +
    + Non Empty String Constraint +
    + +
    +
    Description
    +
    Constraint for ensuring that a string has at least one character.
    +
    + + +
    +
    Min. Length
    +
    1
    +
    + +
    • +
+
+
+
+
+ +
+

Creation of the Product (Carbon) Footprint

+
+ +Mandatory: Timestamp of the creation of the Product (Carbon) Footprint as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. + +
+
Name
+
created
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#dateTime + +
+
+
+
+
+ +
+
Example
+
2022-05-22T21:47:32Z
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
created
+
+ +
+
Reference
+
+
    +
  • https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/
    • +
+
+
+ +
+
+ +
+

PCF (Product Carbon Footprint)

+
+ +A PCF (Product Carbon Footprint) represents the carbon footprint of a product and related data as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. + +
+
Name
+
pcf
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.pcf:7.0.0#PcfEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
pcf
+
+ +
+
Reference
+
+
    +
  • https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/
    • +
+
+
+ +
+
+ +
+

PCF (Product Carbon Footprint) Legal Statement

+
+ +Optional: Option for legal statement/ disclaimer as specified in the Catena-X PCF Rulebook (Version 3.0.0). + +
+
Name
+
pcfLegalStatement
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
This PCF (Product Carbon Footprint) is for information purposes only. It is based upon the standards mentioned above.
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
pcfLegalStatement
+
+ + +
+
+ +
+

Partial Or Full PCF (Product Carbon Footprint)

+
+ +Mandatory: Indicator for partial or full PCF (Product Carbon Footprint) declaration as specified in the Catena-X PCF Rulebook (Version 3.0.0). + +
+
Name
+
partialFullPcf
+
+ + + +
+
Characteristic
+
+
+
+
Enumeration
+
+
+
Values
+
+
+
+
    +
  • Cradle-to-gate
    • +
  • Cradle-to-grave
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Cradle-to-gate
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
partialFullPcf
+
+ + +
+
+ +
+

Previous PCF (Product Carbon Footprint) Identifiers

+
+ +Optional: Set of preceding PCF (Product Carbon Footprint) identifiers without duplicates as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the WBCSD (World Business Council for Sustainable Development) Pathfinder framework and the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD/ PACT initiative. Declared as "optional" in WBCSD, needs to be covered by application. + +
+
Name
+
precedingPfIds
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Reference +
+
    +
  • https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/
    • +
+
+
+
+
+
+ Type urn:samm:io.catenax.pcf:7.0.0#PrecedingPfId + +
+
+
+
+
+ + +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
precedingPfIds
+
+ +
+
Reference
+
+
    +
  • https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/
    • +
+
+
+ +
+
+ +
+

Product (Carbon) Footprint Version

+
+ +Mandatory: Version of the product (carbon) footprint as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. In Catena-X for example set to "0" per default. + +
+
Name
+
version
+
+ + + +
+
Characteristic
+
+
+
+
+ Reference +
+
    +
  • https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/
    • +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#nonNegativeInteger + +
+
+
+
+
+ +
+
Example
+
0
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
version
+
+ +
+
Reference
+
+
    +
  • https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/
    • +
+
+
+ +
+
+ +
+

Product Category

+
+ +Mandatory: UN (United Nations) Product Classification Code (CPC - Central Classification Code) of a given product as specified the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. WBCSD specific extension, which will probably be declared as "optional" in a later WBCSD specification version. In Catena-X for example specified with default value "011-99000". + +
+
Name
+
productCategoryCpc
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
011-99000
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
extWBCSD_productCodeCpc
+
+ +
+
Reference
+
+
    +
  • https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/
    • +
+
+
+ +
+
+ +
+

Product Description

+
+ +Optional: Free-form description of the product as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. + +
+
Name
+
productDescription
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Ethanol, 95% solution
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
productDescription
+
+ +
+
Reference
+
+
    +
  • https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/
    • +
+
+
+ +
+
+ +
+

Product Footprint Identifier

+
+ +Mandatory: The product footprint identifier as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. + +
+
Name
+
id
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
    +
  • https://tools.ietf.org/html/rfc4122
    • +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
3893bb5d-da16-4dc1-9185-11d97476c254
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
id
+
+ +
+
Reference
+
+
    +
  • https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/
    • +
+
+
+ +
+
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
    +
    (^[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}$)
    +
    + +
    • +
+
+
+
+
+ +
+

Product Footprint Specification Version

+
+ +Mandatory: Version of the product footprint data specification as defined in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. + +
+
Name
+
specVersion
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
urn:io.catenax.pcf:datamodel:version:7.0.0
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
specVersion
+
+ +
+
Reference
+
+
    +
  • https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/
    • +
+
+
+ +
+
+ +
+

Product IDs

+
+ +Mandatory: Non-empty set of product identifiers. Each value is supposed to uniquely identify the product as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.1.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. In Catena-X productId corresponds with Industry Core manufacturerPartId. + +
+
Name
+
productIds
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#anyURI + +
+
+
+
+
+ +
+
Example
+
urn:gtin:4712345060507
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
productIds
+
+ +
+
Reference
+
+
    +
  • urn:samm:io.catenax.part_type_information:1.0.0#manufacturerPartId
    • +
+
+
+ +
+
Constraints
+
+
    +
  • +
    + +
    + Non Empty Set Constraint +
    + +
    +
    Description
    +
    Constraint for defining a non-empty set of URIs (Uniform Resource Identifieres).
    +
    + + +
    +
    Min. Length
    +
    1
    +
    + +
    • +
+
+
+
+
+ +
+

Product Trade Name

+
+ +Mandatory: Non-empty trade name of a product as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.1.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. In Catena-X productNameCompany corresponds with Industry Core nameAtManufacturer.  + +
+
Name
+
productNameCompany
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
My Product Name
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
productName
+
+ +
+
Reference
+
+
    +
  • urn:samm:io.catenax.part_type_information:1.0.0#nameAtManufacturer
    • +
+
+
+ +
+
Constraints
+
+
    +
  • +
    + +
    + Non Empty String Constraint +
    + +
    +
    Description
    +
    Constraint for ensuring that a string has at least one character.
    +
    + + +
    +
    Min. Length
    +
    1
    +
    + +
    • +
+
+
+
+
+ +
+

Status

+
+ +Mandatory: Status indicator of a product (carbon) footprint as specified in the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. WBCSD specific extension, in Catena-X for example set to "Active" per default. + +
+
Name
+
status
+
+ + + +
+
Characteristic
+
+
+
+
Enumeration
+
+
+
Values
+
+
+
+
    +
  • Active
    • +
  • Deprecated
    • +
+
+
+
+
+ Reference +
+
    +
  • https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/
    • +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Active
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
extWBCSD_pfStatus
+
+ +
+
Reference
+
+
    +
  • https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/
    • +
+
+
+ +
+
+ +
+

Validity Period End

+
+ +Optional: End of interval during which the product (carbon) footprint is declared as valid as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. + +
+
Name
+
validityPeriodEnd
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#dateTime + +
+
+
+
+
+ +
+
Example
+
2022-12-31T23:59:59Z
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
validityPeriodEnd
+
+ +
+
Reference
+
+
    +
  • https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/
    • +
+
+
+ +
+
+ +
+

Validity Period Start

+
+ +Optional: Start of interval during which the product (carbon) footprint is declared as valid as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. If specified, the validity period start must be equal to or greater than the reference period end. + +
+
Name
+
validityPeriodStart
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#dateTime + +
+
+
+
+
+ +
+
Example
+
2022-01-01T00:00:01Z
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
validityPeriodStart
+
+ +
+
Reference
+
+
    +
  • https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/
    • +
+
+
+ +
+
+ + + +
+
+

Entities

+
+ +
+
+

Cross Sectoral Standard Entity

+
+
+ Entity for defining an accounting standard used for product carbon footprint calculation as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. +
+
+ Reference +
+
    +
  • https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/
    • +
+
+
+ +
+

Properties

+
+
+ +
+
Cross Sectoral Standard
+
+ +Mandatory: Discloses a cross-sectoral standard applied for calculating or allocating GHG (Greenhouse Gas) emissions as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. + +
+
Name
+
crossSectoralStandard
+
+ + + +
+
Characteristic
+
+
+
+
Enumeration
+
+
+
Values
+
+
+
+
    +
  • ISO Standard 14067
    • +
  • ISO Standard 14044
    • +
  • Pathfinder v1
    • +
  • Pathfinder v2
    • +
  • PAS 2050
    • +
  • ISO Standard 14040
    • +
  • ISO Standard 14041
    • +
  • ISO Standard 14042
    • +
  • ISO Standard 14043
    • +
  • PEF
    • +
  • Other
    • +
  • GHG Protocol Product Standard
    • +
+
+
+
+
+ Reference +
+
    +
  • https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/
    • +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
ISO Standard 14044
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
crossSectoralStandard
+
+ +
+
Reference
+
+
    +
  • https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/
    • +
+
+
+ +
+
+
+
+

Data Quality Indicator

+
+
+ Entity for defining a quantitative data quality indicator of a PCF (Product Carbon Footprint) as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. +
+
+ Reference +
+
    +
  • https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/
    • +
+
+
+ +
+

Properties

+
+
+ +
+
Coverage Percent
+
+ +Mandatory starting 2025: Percentage of PCF (Product Carbon Footprint) included in the data quality assessment based on the >5% emissions threshold as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. In Catena-X for example set to "100" per default. + +
+
Name
+
coveragePercent
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#decimal + +
+
+
+
+
+ +
+
Example
+
100
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
coveragePercent
+
+ +
+
Reference
+
+
    +
  • https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/
    • +
+
+
+ +
+
Constraints
+
+
    +
  • +
    + +
    + Percent Constraint +
    + +
    +
    Description
    +
    Constraint for a decimal number in the range of and including 0 and 100.
    +
    + + +
    +
    +>= +
    + DefaultScalarValue[value=0.0, typeUri='DefaultScalar[metaModelVersion=SAMM_2_1_0, urn='http://www.w3.org/2001/XMLSchema#decimal']'] +
    +
    ...
    +
    +< + DefaultScalarValue[value=100.0, typeUri='DefaultScalar[metaModelVersion=SAMM_2_1_0, urn='http://www.w3.org/2001/XMLSchema#decimal']'] +
    + +
    • +
+
+
+
+
+ +
+
Technological DQR (Data Quality Rating)
+
+ +Optional: Technological representativeness of the sources used for PCF (Product Carbon Footprint) calculation based on weighted average of all inputs representing >5% of PCF emissions. Specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. + +
+
Name
+
technologicalDQR
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#decimal + +
+
+
+
+
+ +
+
Example
+
2.0
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
technologicalDQR
+
+ +
+
Reference
+
+
    +
  • https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/
    • +
+
+
+ +
+
Constraints
+
+
    +
  • +
    + +
    + DQI (Data Quality Indicator) Number Constraint +
    + +
    +
    Description
    +
    Constraint for defining a decimal between 1 and 3 including.
    +
    + + +
    +
    +>= +
    + DefaultScalarValue[value=1, typeUri='DefaultScalar[metaModelVersion=SAMM_2_1_0, urn='http://www.w3.org/2001/XMLSchema#decimal']'] +
    +
    ...
    +
    +< + DefaultScalarValue[value=3, typeUri='DefaultScalar[metaModelVersion=SAMM_2_1_0, urn='http://www.w3.org/2001/XMLSchema#decimal']'] +
    + +
    • +
+
+
+
+
+ +
+
Temporal DQR (Data Quality Rating)
+
+ +Optional: Temporal representativeness of the sources used for PCF (Product Carbon Footprint) calculation based on weighted average of all inputs representing >5% of PCF emissions. Specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. + +
+
Name
+
temporalDQR
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#decimal + +
+
+
+
+
+ +
+
Example
+
2.0
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
temporalDQR
+
+ +
+
Reference
+
+
    +
  • https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/
    • +
+
+
+ +
+
Constraints
+
+
    +
  • +
    + +
    + DQI (Data Quality Indicator) Number Constraint +
    + +
    +
    Description
    +
    Constraint for defining a decimal between 1 and 3 including.
    +
    + + +
    +
    +>= +
    + DefaultScalarValue[value=1, typeUri='DefaultScalar[metaModelVersion=SAMM_2_1_0, urn='http://www.w3.org/2001/XMLSchema#decimal']'] +
    +
    ...
    +
    +< + DefaultScalarValue[value=3, typeUri='DefaultScalar[metaModelVersion=SAMM_2_1_0, urn='http://www.w3.org/2001/XMLSchema#decimal']'] +
    + +
    • +
+
+
+
+
+ +
+
Geographical DQR (Data Quality Rating)
+
+ +Optional: Geographical representativeness of the sources used for PCF (Product Carbon Footprint) calculation based on weighted average of all inputs representing >5% of PCF emissions. Specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. + +
+
Name
+
geographicalDQR
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#decimal + +
+
+
+
+
+ +
+
Example
+
2.0
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
geographicalDQR
+
+ +
+
Reference
+
+
    +
  • https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/
    • +
+
+
+ +
+
Constraints
+
+
    +
  • +
    + +
    + DQI (Data Quality Indicator) Number Constraint +
    + +
    +
    Description
    +
    Constraint for defining a decimal between 1 and 3 including.
    +
    + + +
    +
    +>= +
    + DefaultScalarValue[value=1, typeUri='DefaultScalar[metaModelVersion=SAMM_2_1_0, urn='http://www.w3.org/2001/XMLSchema#decimal']'] +
    +
    ...
    +
    +< + DefaultScalarValue[value=3, typeUri='DefaultScalar[metaModelVersion=SAMM_2_1_0, urn='http://www.w3.org/2001/XMLSchema#decimal']'] +
    + +
    • +
+
+
+
+
+ +
+
Completeness DQR (Data Quality Rating)
+
+ +Optional: Completeness of the data collected for PCF (Product Carbon Footprint) calculation based on weighted average of all inputs representing >5% of PCF emissions. Specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. + +
+
Name
+
completenessDQR
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#decimal + +
+
+
+
+
+ +
+
Example
+
2.0
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
completenessDQR
+
+ +
+
Reference
+
+
    +
  • https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/
    • +
+
+
+ +
+
Constraints
+
+
    +
  • +
    + +
    + DQI (Data Quality Indicator) Number Constraint +
    + +
    +
    Description
    +
    Constraint for defining a decimal between 1 and 3 including.
    +
    + + +
    +
    +>= +
    + DefaultScalarValue[value=1, typeUri='DefaultScalar[metaModelVersion=SAMM_2_1_0, urn='http://www.w3.org/2001/XMLSchema#decimal']'] +
    +
    ...
    +
    +< + DefaultScalarValue[value=3, typeUri='DefaultScalar[metaModelVersion=SAMM_2_1_0, urn='http://www.w3.org/2001/XMLSchema#decimal']'] +
    + +
    • +
+
+
+
+
+ +
+
Reliability DQR (Data Quality Rating)
+
+ +Optional: Reliability of the data collected for PCF (Product Carbon Footprint) calculation based on weighted average of all inputs representing >5% of PCF emissions. Specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. + +
+
Name
+
reliabilityDQR
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#decimal + +
+
+
+
+
+ +
+
Example
+
2.0
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
reliabilityDQR
+
+ +
+
Reference
+
+
    +
  • https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/
    • +
+
+
+ +
+
Constraints
+
+
    +
  • +
    + +
    + DQI (Data Quality Indicator) Number Constraint +
    + +
    +
    Description
    +
    Constraint for defining a decimal between 1 and 3 including.
    +
    + + +
    +
    +>= +
    + DefaultScalarValue[value=1, typeUri='DefaultScalar[metaModelVersion=SAMM_2_1_0, urn='http://www.w3.org/2001/XMLSchema#decimal']'] +
    +
    ...
    +
    +< + DefaultScalarValue[value=3, typeUri='DefaultScalar[metaModelVersion=SAMM_2_1_0, urn='http://www.w3.org/2001/XMLSchema#decimal']'] +
    + +
    • +
+
+
+
+
+
+
+

Emission Factor Data Source Entity

+
+
+ Entity for defining an emission factor data source used to calculate a product carbon footprint as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. +
+
+ Reference +
+
    +
  • https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/
    • +
+
+
+ +
+

Properties

+
+
+ +
+
Emission Factor Data Source
+
+ +Mandatory: Emission factor data source used to calculate a product carbon footprint as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. + +
+
Name
+
emissionFactorDS
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
ecoinvent 3.8
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
secondaryEmissionFactorSource
+
+ +
+
Reference
+
+
    +
  • https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/
    • +
+
+
+ +
+
+
+
+

PCF (Product Carbon Footprint) Entity

+
+
+ Entity for defining a PCF (Product Carbon Footprint) as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. +
+
+ Reference +
+
    +
  • https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/
    • +
+
+
+ +
+

Properties

+
+
+ +
+
Unit of measurement
+
+ +Mandatory: Unit of analysis of a product in context of the PCF (product carbon footprint) as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. In Catena-X for example list of valid units includes "piece". + +
+
Name
+
declaredUnit
+
+ + + +
+
Characteristic
+
+
+
+
Enumeration
+
+
+
Values
+
+
+
+
    +
  • liter
    • +
  • kilogram
    • +
  • cubic meter
    • +
  • kilowatt hour
    • +
  • megajoule
    • +
  • ton kilometer
    • +
  • square meter
    • +
  • piece
    • +
+
+
+
+
+ Reference +
+
    +
  • https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/
    • +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
kilogram
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
declaredUnit
+
+ +
+
Reference
+
+
    +
  • https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/
    • +
+
+
+ +
+
+ +
+
Unitary Product Amount
+
+ +Mandatory: Amount of units contained within a product in context of the PCF (Product Carbon Footprint) as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. + +
+
Name
+
unitaryProductAmount
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#float + +
+
+
+
+
+ +
+
Example
+
1000.0
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
unitaryProductAmount
+
+ +
+
Reference
+
+
    +
  • https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/
    • +
+
+
+ +
+
Constraints
+
+
    +
  • +
    + +
    + Strictly Positive Decimal Constraint +
    + +
    +
    Description
    +
    Constraint for defining a positive, non-zero decimal.
    +
    + + +
    +
    +> +
    + DefaultScalarValue[value=0.0, typeUri='DefaultScalar[metaModelVersion=SAMM_2_1_0, urn='http://www.w3.org/2001/XMLSchema#float']'] +
    +
    + +
    • +
+
+
+
+
+ +
+
Product Mass Per Declared Unit
+
+ +Mandatory: Mass of a product per declared unit (net, unpackaged) in context of the PCF (Product Carbon Footprint) as specified in the Catena-X PCF Rulebook (Version 3.0.0). + +
+
Name
+
productMassPerDeclaredUnit
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#decimal + +
+
+
+
+
+ +
+
Example
+
0.456
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
productMassPerDeclaredUnit
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + Positive Decimal Constraint +
    + +
    +
    Description
    +
    Constraint for defining a decimal equal to or greater than zero.
    +
    + + +
    +
    +>= +
    + DefaultScalarValue[value=0, typeUri='DefaultScalar[metaModelVersion=SAMM_2_1_0, urn='http://www.w3.org/2001/XMLSchema#decimal']'] +
    +
    + +
    • +
+
+
+
+
+ +
+
Exempted Emissions Percent
+
+ +Mandatory: Applied cut-off percentage of emissions excluded from PCF (Product Carbon Footprint). +For accordance with Catena-X PCF Rulebook (Version 3.0.0) <3%. + +
+
Name
+
exemptedEmissionsPercent
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
    +
  • https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/
    • +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#decimal + +
+
+
+
+
+ +
+
Example
+
0.0
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
exemptedEmissionsPercent
+
+ +
+
Reference
+
+
    +
  • https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/
    • +
+
+
+ +
+
Constraints
+
+
    +
  • +
    + +
    + Exempted Emissions Percent Constraint +
    + +
    +
    Description
    +
    Characteristic for defining the percentage of emissions excluded from a PCF (Product Carbon Footprint) as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.
    +
    + +
    +
    Reference
    +
    +
    +
      +
    • https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/
      • +
    +
    +
    +
    + +
    +
    +>= +
    + DefaultScalarValue[value=0.0, typeUri='DefaultScalar[metaModelVersion=SAMM_2_1_0, urn='http://www.w3.org/2001/XMLSchema#decimal']'] +
    +
    ...
    +
    +< + DefaultScalarValue[value=5.0, typeUri='DefaultScalar[metaModelVersion=SAMM_2_1_0, urn='http://www.w3.org/2001/XMLSchema#decimal']'] +
    + +
    • +
+
+
+
+
+ +
+
Exempted Emissions Description
+
+ +Optional: Rationale behind exclusion of specific PCF (Product Carbon Footprint) emissions as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. + +
+
Name
+
exemptedEmissionsDescription
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
No exemption
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
exemptedEmissionsDescription
+
+ +
+
Reference
+
+
    +
  • https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/
    • +
+
+
+ +
+
+ +
+
Boundary Processes Description
+
+ +Optional: Processes attributable to each lifecycle stage as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. + +
+
Name
+
boundaryProcessesDescription
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Electricity consumption included as an input in the production phase
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
boundaryProcessesDescription
+
+ +
+
Reference
+
+
    +
  • https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/
    • +
+
+
+ +
+
+ +
+
Geography Country Subdivision
+
+ +Optional: Subdivision of a country which must be an ISO 3166-2 subdivision code as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. + +
+
Name
+
geographyCountrySubdivision
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
US-NY
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
geographyCountrySubdivision
+
+ +
+
Reference
+
+
    +
  • https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/
    • +
+
+
+ +
+
Constraints
+
+
    +
  • +
    + +
    + Subdivision Constraint +
    + +
    +
    Description
    +
    Constraint for defining a geography country subdivision in compliance to ISO 3166-2 as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.
    +
    + +
    +
    Reference
    +
    +
    +
      +
    • https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/
      • +
    +
    +
    +
    + +
    +
    Regular expression
    +
    ([A-Z]{2}-[A-Z0-9]{1,3}|)
    +
    + +
    • +
+
+
+
+
+ +
+
Geography Country
+
+ +Optional: Two letter country code that must conform to data type ISO 3166CC as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. + +
+
Name
+
geographyCountry
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
DE
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
geographyCountry
+
+ +
+
Reference
+
+
    +
  • https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/
    • +
+
+
+ +
+
Constraints
+
+
    +
  • +
    + +
    + Country Constraint +
    + +
    +
    Description
    +
    Constraint for defining a geography country conform to ISO 3166CC as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.
    +
    + +
    +
    Reference
    +
    +
    +
      +
    • https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/
      • +
    +
    +
    +
    + +
    +
    Regular expression
    +
    ([A-Z]{2})
    +
    + +
    • +
+
+
+
+
+ +
+
Region
+
+ +Mandatory: Region according to list as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. + +
+
Name
+
geographyRegionOrSubregion
+
+ + + +
+
Characteristic
+
+
+
+
Enumeration
+
+
+
Values
+
+
+
+
    +
  • Africa
    • +
  • Americas
    • +
  • Asia
    • +
  • Europe
    • +
  • Oceania
    • +
  • Australia and New Zealand
    • +
  • Central Asia
    • +
  • Eastern Asia
    • +
  • Eastern Europe
    • +
  • Latin America and the Caribbean
    • +
  • Melanesia
    • +
  • Micronesia
    • +
  • Northern Africa
    • +
  • Northern America
    • +
  • Northern Europe
    • +
  • Polynesia
    • +
  • South-eastern Asia
    • +
  • Southern Asia
    • +
  • Southern Europe
    • +
  • Sub-Saharan Africa
    • +
  • Western Asia
    • +
  • Western Europe
    • +
  • Global
    • +
  • Several
    • +
+
+
+
+
+ Reference +
+
    +
  • https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/
    • +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Europe
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
geographyRegionOrSubregion
+
+ +
+
Reference
+
+
    +
  • https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/
    • +
+
+
+ +
+
+ +
+
Reference Period Start
+
+ +Mandatory: Start of time boundary for which a PCF (Product Carbon Footprint) value is considered to be representative as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. + +
+
Name
+
referencePeriodStart
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#dateTime + +
+
+
+
+
+ +
+
Example
+
2022-01-01T00:00:01Z
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
referencePeriodStart
+
+ +
+
Reference
+
+
    +
  • https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/
    • +
+
+
+ +
+
+ +
+
Reference Period End
+
+ +Mandatory: End of time boundary for which a PCF (Product Carbon Footprint) value is considered to be representative as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. + +
+
Name
+
referencePeriodEnd
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#dateTime + +
+
+
+
+
+ +
+
Example
+
2022-12-31T23:59:59Z
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
referencePeriodEnd
+
+ +
+
Reference
+
+
    +
  • https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/
    • +
+
+
+ +
+
+ +
+
Cross Sectoral Standards Used
+
+ +Mandatory: Discloses the cross-sectoral standards applied for calculating or allocating GHG (Greenhouse Gas) emissions as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. + +
+
Name
+
crossSectoralStandardsUsed
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Reference +
+
    +
  • https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/
    • +
+
+
+
+
+
+ Type urn:samm:io.catenax.pcf:7.0.0#CrossSectoralStandard + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
crossSectoralStandardsUsed
+
+ +
+
Reference
+
+
    +
  • https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/
    • +
+
+
+ +
+
+ +
+
Product or Sector Specific Rules
+
+ +Mandatory: Product or sector specific rules applied for calculating or allocating GHG (Greenhouse Gas) emissions, e.g. PCRs (Product Category Rules), including operators or publishers and according rule names as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. + +
+
Name
+
productOrSectorSpecificRules
+
+ + + +
+
Characteristic
+
+
+
+
Set
+
+
+
Has no order
+
+
+
Duplicates not allowed
+
+
+
+ Reference +
+
    +
  • https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/
    • +
+
+
+
+
+
+ Type urn:samm:io.catenax.pcf:7.0.0#ProductOrSectorSpecificRule + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
productOrSectorSpecificRules
+
+ +
+
Reference
+
+
    +
  • https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/
    • +
+
+
+ +
+
+ +
+
Characterization Factors
+
+ +Mandatory: IPCC (Intergovernmental Panel on Climate Change) version of the GWP (Global Warming Potential) characterization factors used for calculating the PCF (Product Carbon Footprint) as specified in the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. WBCSD specific extension, in Catena-X for example specified by default with value \"AR6\". Default value can be overwritten. + +
+
Name
+
characterizationFactors
+
+ + + +
+
Characteristic
+
+
+
+
Enumeration
+
+
+
Values
+
+
+
+
    +
  • AR5
    • +
  • AR6
    • +
+
+
+
+
+ Reference +
+
    +
  • https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/
    • +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
AR6
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
extWBCSD_characterizationFactors
+
+ +
+
Reference
+
+
    +
  • https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/
    • +
+
+
+ +
+
+ +
+
Allocation Rules Description
+
+ +Optional: Allocation rules used and underlying reasoning in context of a product carbon footprint as specified in the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. WBCSD specific extension, in Catena-X for example specified by default with value "In accordance with Catena-X PCF Rulebook (Version 3.0.0)". + +
+
Name
+
allocationRulesDescription
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
In accordance with Catena-X PCF Rulebook
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
extWBCSD_allocationRulesDescription
+
+ +
+
Reference
+
+
    +
  • https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/
    • +
+
+
+ +
+
+ +
+
Allocation Waste Incineration
+
+ +Mandatory: Allocation approach used for waste incineration with energy recovery as specified by the TFS (Together For Sustainability) initiative. In Catena-X for example must be specified by value "cut-off". + +
+
Name
+
allocationWasteIncineration
+
+ + + +
+
Characteristic
+
+
+
+
Enumeration
+
+
+
Values
+
+
+
+
    +
  • cut-off
    • +
  • reverse cut-off
    • +
  • system expansion
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
cut-off
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
extTFS_allocationWasteIncineration
+
+ + +
+
+ +
+
Primary Data Share
+
+ +Mandatory starting 2025: Share of primary data in percent as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. + +
+
Name
+
primaryDataShare
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#decimal + +
+
+
+
+
+ +
+
Example
+
56.12
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
primaryDataShare
+
+ +
+
Reference
+
+
    +
  • https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/
    • +
+
+
+ +
+
Constraints
+
+
    +
  • +
    + +
    + Percent Constraint +
    + +
    +
    Description
    +
    Constraint for a decimal number in the range of and including 0 and 100.
    +
    + + +
    +
    +>= +
    + DefaultScalarValue[value=0.0, typeUri='DefaultScalar[metaModelVersion=SAMM_2_1_0, urn='http://www.w3.org/2001/XMLSchema#decimal']'] +
    +
    ...
    +
    +< + DefaultScalarValue[value=100.0, typeUri='DefaultScalar[metaModelVersion=SAMM_2_1_0, urn='http://www.w3.org/2001/XMLSchema#decimal']'] +
    + +
    • +
+
+
+
+
+ +
+
Secondary Emission Factor Sources
+
+ +Mandatory: Emission factors used for the PCF (Product Carbon Footprint) calculation as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. + +
+
Name
+
secondaryEmissionFactorSources
+
+ + + +
+
Characteristic
+
+
+
+
Set
+
+
+
Has no order
+
+
+
Duplicates not allowed
+
+
+
+ Reference +
+
    +
  • https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/
    • +
+
+
+
+
+
+ Type urn:samm:io.catenax.pcf:7.0.0#EmissionFactorDS + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
secondaryEmissionFactorSources
+
+ +
+
Reference
+
+
    +
  • https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/
    • +
+
+
+ +
+
+ +
+
DQI (Data Quality Indicators)
+
+ +Mandatory starting 2025: Quantitative data quality indicators of a PCF (Product Carbon Footprint) as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. + +
+
Name
+
dqi
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Reference +
+
    +
  • https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/
    • +
+
+
+
+
+
+ Type urn:samm:io.catenax.pcf:7.0.0#DataQualityIndicator + +
+
+
+
+
+ + +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
dataQualityRating
+
+ +
+
Reference
+
+
    +
  • https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/
    • +
+
+
+ +
+
+ +
+
Packaging Emissions Included
+
+ +Mandatory: The Catena-X PCF Rulebook requires to include packaging from a system boundary perspective. "FALSE" is only possible due to the application of the cut-off rule. +Flag indicating whether packaging emissions are included in a PCF (Product Carbon Footprint) as specified in the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. WBCSD specific extension. + +
+
Name
+
packagingEmissionsIncluded
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#boolean + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
extWBCSD_packagingEmissionsIncluded
+
+ +
+
Reference
+
+
    +
  • https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/
    • +
+
+
+ +
+
+ +
+
PCF (Product Carbon Footprint) Excluding Biogenic
+
+ +Mandatory: Product carbon footprint of a product excluding biogenic emissions as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. + +
+
Name
+
pcfExcludingBiogenic
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
    +
  • https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/
    • +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#decimal + +
+
+
+
+
+ +
+
Example
+
2.0
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
pcfExcludingBiogenic
+
+ +
+
Reference
+
+
    +
  • https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/
    • +
+
+
+ +
+
Constraints
+
+
    +
  • +
    + +
    + PositiveEmissionConstraint +
    + +
    +
    Description
    +
    Only positive emission values (>0) are valid
    +
    + + +
    +
    +>= +
    + DefaultScalarValue[value=0.0, typeUri='DefaultScalar[metaModelVersion=SAMM_2_1_0, urn='http://www.w3.org/2001/XMLSchema#decimal']'] +
    +
    + +
    • +
+
+
+
+
+ +
+
PCF (Product Carbon Footprint) Including Biogenic
+
+ +Mandatory starting 2025: Product carbon footprint of a product including biogenic emissions as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. Optional value in current specification version but will be mandatory in future version. + +
+
Name
+
pcfIncludingBiogenic
+
+ + + +
+
Characteristic
+
+
+
+
Quantifiable
+
+
+
Duration
+
+
+
Characteristic for defining (positive or negative) emissions in context of a PCF (Product Carbon Footprint) as specified by the WBCSD (World Business Council for Sustainable Development) Pathfinder initiative.
+
+
+
+ Reference +
+
    +
  • https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/
    • +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#decimal + +
+
+
+
+
+ +
+
Example
+
1.0
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
pcfIncludingBiogenic
+
+ +
+
Reference
+
+
    +
  • https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/
    • +
+
+
+ +
+
+ +
+
Fossil Emissions
+
+ +Mandatory starting 2025: Emissions from combustion of fossil sources as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. Identical to "pcfExcludingBiogenic", will be removed in later version. + +
+
Name
+
fossilGhgEmissions
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
    +
  • https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/
    • +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#decimal + +
+
+
+
+
+ +
+
Example
+
0.5
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
fossilGhgEmissions
+
+ +
+
Reference
+
+
    +
  • https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/
    • +
+
+
+ +
+
Constraints
+
+
    +
  • +
    + +
    + PositiveEmissionConstraint +
    + +
    +
    Description
    +
    Only positive emission values (>0) are valid
    +
    + + +
    +
    +>= +
    + DefaultScalarValue[value=0.0, typeUri='DefaultScalar[metaModelVersion=SAMM_2_1_0, urn='http://www.w3.org/2001/XMLSchema#decimal']'] +
    +
    + +
    • +
+
+
+
+
+ +
+
Biogenic Carbon Emissions Other Than CO2
+
+ +Mandatory starting 2025: GWP (Global Warming Potential) of biogenic CO2e-emissions in production phase which contain only GHG (Greenhouse Gas) emissions other than CO2 - excludes biogenic CO2. For specification see Catena-X PCF Rulebook (Version 3.0.0). + +
+
Name
+
biogenicCarbonEmissionsOtherThanCO2
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
    +
  • https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/
    • +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#decimal + +
+
+
+
+
+ +
+
Example
+
1.0
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
biogenicCarbonEmissionsOtherThanCO2
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + PositiveEmissionConstraint +
    + +
    +
    Description
    +
    Only positive emission values (>0) are valid
    +
    + + +
    +
    +>= +
    + DefaultScalarValue[value=0.0, typeUri='DefaultScalar[metaModelVersion=SAMM_2_1_0, urn='http://www.w3.org/2001/XMLSchema#decimal']'] +
    +
    + +
    • +
+
+
+
+
+ +
+
Biogenic Carbon Withdrawal
+
+ +Mandatory starting 2025: Biogenic carbon content in the product converted to CO2e as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.1.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. + +
+
Name
+
biogenicCarbonWithdrawal
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#decimal + +
+
+
+
+
+ +
+
Example
+
0.0
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
biogenicCarbonWithdrawal
+
+ +
+
Reference
+
+
    +
  • https://wbcsd.github.io/tr/2023/data-exchange-protocol-20231207/
    • +
+
+
+ +
+
Constraints
+
+
    +
  • +
    + +
    + Negative Emission Constraint +
    + +
    +
    Description
    +
    Only negative emission values (<=0) are valid.
    +
    + + +
    +< + DefaultScalarValue[value=0.0, typeUri='DefaultScalar[metaModelVersion=SAMM_2_1_0, urn='http://www.w3.org/2001/XMLSchema#decimal']'] +
    + +
    • +
+
+
+
+
+ +
+
dLUC (direct land use change) GHG (Greenhouse Gas) Emissions
+
+ +Mandatory starting 2025: Direct land use change CO2e emissions in context of a product carbon footprint as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. + +
+
Name
+
dlucGhgEmissions
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
    +
  • https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/
    • +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#decimal + +
+
+
+
+
+ +
+
Example
+
0.4
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
dlucGhgEmissions
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + PositiveEmissionConstraint +
    + +
    +
    Description
    +
    Only positive emission values (>0) are valid
    +
    + + +
    +
    +>= +
    + DefaultScalarValue[value=0.0, typeUri='DefaultScalar[metaModelVersion=SAMM_2_1_0, urn='http://www.w3.org/2001/XMLSchema#decimal']'] +
    +
    + +
    • +
+
+
+
+
+ +
+
LU (Land Use) GHG (Greenhouse Gas) Emissions
+
+ +Mandatory starting 2025: Land use CO2 emissions in context of a product carbon footprint as specified by the TFS (Together For Sustainability) initiative. TFS specific extension. + +
+
Name
+
luGhgEmissions
+
+ + + +
+
Characteristic
+
+
+
+
Quantifiable
+
+
+
Duration
+
+
+
Characteristic for defining (positive or negative) emissions in context of a PCF (Product Carbon Footprint) as specified by the WBCSD (World Business Council for Sustainable Development) Pathfinder initiative.
+
+
+
+ Reference +
+
    +
  • https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/
    • +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#decimal + +
+
+
+
+
+ +
+
Example
+
0.3
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
extTFS_luGhgEmissions
+
+ + +
+
+ +
+
Aircraft GHG Emissions
+
+ +Mandatory starting 2025: GHG (Greenhouse Gas) emissions resulting from aircraft engine usage for the transport of the product as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. + +
+
Name
+
aircraftGhgEmissions
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
    +
  • https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/
    • +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#decimal + +
+
+
+
+
+ +
+
Example
+
0.0
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
aircraftGhgEmissions
+
+ +
+
Reference
+
+
    +
  • https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/
    • +
+
+
+ +
+
Constraints
+
+
    +
  • +
    + +
    + PositiveEmissionConstraint +
    + +
    +
    Description
    +
    Only positive emission values (>0) are valid
    +
    + + +
    +
    +>= +
    + DefaultScalarValue[value=0.0, typeUri='DefaultScalar[metaModelVersion=SAMM_2_1_0, urn='http://www.w3.org/2001/XMLSchema#decimal']'] +
    +
    + +
    • +
+
+
+
+
+ +
+
Packaging GHG (Greenhouse Gas) Emissions
+
+ +Optional: Emissions resulting from the packaging of the product as specified in the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. WBCSD specific extension. In Catena-X not relevant to be reported separately. + +
+
Name
+
packagingGhgEmissions
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
    +
  • https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/
    • +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#decimal + +
+
+
+
+
+ +
+
Example
+
0
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
extWBCSD_packagingGhgEmissions
+
+ +
+
Reference
+
+
    +
  • https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/
    • +
+
+
+ +
+
Constraints
+
+
    +
  • +
    + +
    + PositiveEmissionConstraint +
    + +
    +
    Description
    +
    Only positive emission values (>0) are valid
    +
    + + +
    +
    +>= +
    + DefaultScalarValue[value=0.0, typeUri='DefaultScalar[metaModelVersion=SAMM_2_1_0, urn='http://www.w3.org/2001/XMLSchema#decimal']'] +
    +
    + +
    • +
+
+
+
+
+ +
+
Distribution Stage PCF (Product Carbon Footprint) Excluding Biogenic
+
+ +Optional: Product carbon footprint for the distribution stage of a product excluding biogenic emissions as specified in the Catena-X PCF Rulebook (Version 3.0.0). + +
+
Name
+
distributionStagePcfExcludingBiogenic
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
    +
  • https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/
    • +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#decimal + +
+
+
+
+
+ +
+
Example
+
1.5
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
distributionStagePcfExcludingBiogenic
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + PositiveEmissionConstraint +
    + +
    +
    Description
    +
    Only positive emission values (>0) are valid
    +
    + + +
    +
    +>= +
    + DefaultScalarValue[value=0.0, typeUri='DefaultScalar[metaModelVersion=SAMM_2_1_0, urn='http://www.w3.org/2001/XMLSchema#decimal']'] +
    +
    + +
    • +
+
+
+
+
+ +
+
Distribution Stage PCF (Product Carbon Footprint) Including Biogenic
+
+ +Optional: Product carbon footprint for the distribution stage of a product including biogenic emissions as specified in the Catena-X PCF Rulebook (Version 3.0.0). + +
+
Name
+
distributionStagePcfIncludingBiogenic
+
+ + + +
+
Characteristic
+
+
+
+
Quantifiable
+
+
+
Duration
+
+
+
Characteristic for defining (positive or negative) emissions in context of a PCF (Product Carbon Footprint) as specified by the WBCSD (World Business Council for Sustainable Development) Pathfinder initiative.
+
+
+
+ Reference +
+
    +
  • https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/
    • +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#decimal + +
+
+
+
+
+ +
+
Example
+
0.0
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
distributionStagePcfIncludingBiogenic
+
+ + +
+
+ +
+
Distribution Stage Fossil GHG (Greenhouse Gas) Emissions
+
+ +Optional: Emissions from the combustion of fossil sources in the distribution stage as specified in the Catena-X PCF Rulebook (Version 3.0.0). + +
+
Name
+
distributionStageFossilGhgEmissions
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
    +
  • https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/
    • +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#decimal + +
+
+
+
+
+ +
+
Example
+
0.5
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
distributionStageFossilGhgEmissions
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + PositiveEmissionConstraint +
    + +
    +
    Description
    +
    Only positive emission values (>0) are valid
    +
    + + +
    +
    +>= +
    + DefaultScalarValue[value=0.0, typeUri='DefaultScalar[metaModelVersion=SAMM_2_1_0, urn='http://www.w3.org/2001/XMLSchema#decimal']'] +
    +
    + +
    • +
+
+
+
+
+ +
+
Distribution Stage Biogenic Carbon Emissions Other Than CO2
+
+ +Optional: GWP (Global Warming Potential) of biogenic CO2e-emissions in distribution phase which contain only GHG (Greenhouse Gas) emissions other than CO2 ? excludes biogenic CO2. For specification see Catena-X PCF Rulebook (Version 3.0.0). + +
+
Name
+
distributionStageBiogenicCarbonEmissionsOtherThanCO2
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
    +
  • https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/
    • +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#decimal + +
+
+
+
+
+ +
+
Example
+
1.0
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
distributionStageBiogenicCarbonEmissionsOtherThanCO2
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + PositiveEmissionConstraint +
    + +
    +
    Description
    +
    Only positive emission values (>0) are valid
    +
    + + +
    +
    +>= +
    + DefaultScalarValue[value=0.0, typeUri='DefaultScalar[metaModelVersion=SAMM_2_1_0, urn='http://www.w3.org/2001/XMLSchema#decimal']'] +
    +
    + +
    • +
+
+
+
+
+ +
+
Distribution Stage Biogenic Carbon Withdrawal
+
+ +Optional: GWP (Global Warming Potential) of biogenic CO2-withdrawal in distribution stage (biogenic CO2 contained in the product) as specified in the Catena-X PCF Rulebook (Version 3.0.0). + +
+
Name
+
distributionStageBiogenicCarbonWithdrawal
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#decimal + +
+
+
+
+
+ +
+
Example
+
0.0
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
distributionStageBiogenicCarbonWithdrawal
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + Negative Emission Constraint +
    + +
    +
    Description
    +
    Only negative emission values (<=0) are valid.
    +
    + + +
    +< + DefaultScalarValue[value=0.0, typeUri='DefaultScalar[metaModelVersion=SAMM_2_1_0, urn='http://www.w3.org/2001/XMLSchema#decimal']'] +
    + +
    • +
+
+
+
+
+ +
+
Distribution Stage dLUC (direct land use change) GHG (Greenhouse Gas) Emissions
+
+ +Optional: Direct land use change CO2 emissions during distribution stage in context of a product carbon footprint as specified by the TFS (Together For Sustainability) initiative. TFS specific extension. + +
+
Name
+
distributionStageDlucGhgEmissions
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
    +
  • https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/
    • +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#decimal + +
+
+
+
+
+ +
+
Example
+
1.0
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
extTFS_distributionStageDlucGhgEmissions
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + PositiveEmissionConstraint +
    + +
    +
    Description
    +
    Only positive emission values (>0) are valid
    +
    + + +
    +
    +>= +
    + DefaultScalarValue[value=0.0, typeUri='DefaultScalar[metaModelVersion=SAMM_2_1_0, urn='http://www.w3.org/2001/XMLSchema#decimal']'] +
    +
    + +
    • +
+
+
+
+
+ +
+
Distribution Stage LU (Land Use) GHG (Greenhouse Gas) Emissions
+
+ +Optional: Land use CO2 emissions in context of a product carbon footprint as specified by the TFS (Together For Sustainability) initiative. TFS specific extension. + +
+
Name
+
distributionStageLuGhgEmissions
+
+ + + +
+
Characteristic
+
+
+
+
Quantifiable
+
+
+
Duration
+
+
+
Characteristic for defining (positive or negative) emissions in context of a PCF (Product Carbon Footprint) as specified by the WBCSD (World Business Council for Sustainable Development) Pathfinder initiative.
+
+
+
+ Reference +
+
    +
  • https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/
    • +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#decimal + +
+
+
+
+
+ +
+
Example
+
1.1
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
extTFS_distributionStageLuGhgEmissions
+
+ + +
+
+ +
+
Carbon Content Total
+
+ +Mandatory starting 2025: Total carbon content per declared unit in context of a product carbon footprint as specified in the Catena-X PCF Rulebook (Version 3.0.0). + +
+
Name
+
carbonContentTotal
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
    +
  • https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/
    • +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#decimal + +
+
+
+
+
+ +
+
Example
+
2.5
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
carbonContentTotal
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + PositiveEmissionConstraint +
    + +
    +
    Description
    +
    Only positive emission values (>0) are valid
    +
    + + +
    +
    +>= +
    + DefaultScalarValue[value=0.0, typeUri='DefaultScalar[metaModelVersion=SAMM_2_1_0, urn='http://www.w3.org/2001/XMLSchema#decimal']'] +
    +
    + +
    • +
+
+
+
+
+ +
+
Fossil Carbon Content
+
+ +Mandatory starting 2025: Fossil carbon amount embodied in a product as specified in the technical specifications for PCF Data Exchange (Version 2.1.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. Must be calculated with kgC (kilogram Carbon) / declaredUnit equal to or greater zero; WBCSD specific extension, in Catena-X specified by a calculated value. + +
+
Name
+
fossilCarbonContent
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
    +
  • https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/
    • +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#decimal + +
+
+
+
+
+ +
+
Example
+
0.1
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
extWBCSD_fossilCarbonContent
+
+ +
+
Reference
+
+
    +
  • https://wbcsd.github.io/tr/2023/data-exchange-protocol-20231207/
    • +
+
+
+ +
+
Constraints
+
+
    +
  • +
    + +
    + PositiveEmissionConstraint +
    + +
    +
    Description
    +
    Only positive emission values (>0) are valid
    +
    + + +
    +
    +>= +
    + DefaultScalarValue[value=0.0, typeUri='DefaultScalar[metaModelVersion=SAMM_2_1_0, urn='http://www.w3.org/2001/XMLSchema#decimal']'] +
    +
    + +
    • +
+
+
+
+
+ +
+
Biogenic Carbon Content
+
+ +Mandatory starting 2025: Biogenic carbon amount embodied in a product as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.1.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. Must be calculated with kgC (kilogram Carbon) / declaredUnit equal to or greater zero. + +
+
Name
+
biogenicCarbonContent
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
    +
  • https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/
    • +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#decimal + +
+
+
+
+
+ +
+
Example
+
0.0
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
carbonContentBiogenic
+
+ +
+
Reference
+
+
    +
  • https://wbcsd.github.io/tr/2023/data-exchange-protocol-20231207/
    • +
+
+
+ +
+
Constraints
+
+
    +
  • +
    + +
    + PositiveEmissionConstraint +
    + +
    +
    Description
    +
    Only positive emission values (>0) are valid
    +
    + + +
    +
    +>= +
    + DefaultScalarValue[value=0.0, typeUri='DefaultScalar[metaModelVersion=SAMM_2_1_0, urn='http://www.w3.org/2001/XMLSchema#decimal']'] +
    +
    + +
    • +
+
+
+
+
+ +
+
Distribution Stage Aircraft GHG Emissions
+
+ +Optional: GHG (Greenhouse Gas) emissions for the distribution stage resulting from aircraft engine usage for the transport of the product as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. + +
+
Name
+
distributionStageAircraftGhgEmissions
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
    +
  • https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/
    • +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#decimal + +
+
+
+
+
+ +
+
Example
+
0.0
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
distributionStageAircraftGhgEmissions
+
+ +
+
Reference
+
+
    +
  • https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/
    • +
+
+
+ +
+
Constraints
+
+
    +
  • +
    + +
    + PositiveEmissionConstraint +
    + +
    +
    Description
    +
    Only positive emission values (>0) are valid
    +
    + + +
    +
    +>= +
    + DefaultScalarValue[value=0.0, typeUri='DefaultScalar[metaModelVersion=SAMM_2_1_0, urn='http://www.w3.org/2001/XMLSchema#decimal']'] +
    +
    + +
    • +
+
+
+
+
+
+
+

Preceding PCF (Product Carbon Footprint) Identifier Entity

+
+
+ Entity for defining a preceding PCF (Product Carbon Footprint) identifier entity as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. +
+
+ Reference +
+
    +
  • https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/
    • +
+
+
+ +
+

Properties

+
+
+ +
+
Product Footprint Identifier
+
+ +Mandatory: The product footprint identifier as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. + +
+
Name
+
id
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
    +
  • https://tools.ietf.org/html/rfc4122
    • +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
3893bb5d-da16-4dc1-9185-11d97476c254
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
id
+
+ +
+
Reference
+
+
    +
  • https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/
    • +
+
+
+ +
+
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
    +
    (^[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}$)
    +
    + +
    • +
+
+
+
+
+
+
+

Product Or Sector Specific Rule

+
+
+ Entity for defining a product or sector specific rule of a product carbon footprint as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. +
+
+ Reference +
+
    +
  • https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/
    • +
+
+
+ +
+

Properties

+
+
+ +
+
Operator or Publisher of Sector Specific Rules
+
+ +Mandatory: Operator of PCR (Product Category Rule)/ PSR (Product Specific Rule) as specified in the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. WBCSD specific extension, in Catena-X for example must always be "Other". + +
+
Name
+
operator
+
+ + + +
+
Characteristic
+
+
+
+
Enumeration
+
+
+
Values
+
+
+
+
    +
  • PEF
    • +
  • EPD International
    • +
  • Other
    • +
+
+
+
+
+ Reference +
+
    +
  • https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/
    • +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Other
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
extWBCSD_operator
+
+ +
+
Reference
+
+
    +
  • https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/
    • +
+
+
+ +
+
+ +
+
Product or Sector Specific Rule Names
+
+ +Mandatory: Product-specific or sector-specific set of rules used for calculating or allocating GHG (Greenhouse Gas) emissions applied from the specified operator as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. + +
+
Name
+
ruleNames
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
    +
  • https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/
    • +
+
+
+
+
+
+ Type urn:samm:io.catenax.pcf:7.0.0#RuleName + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
productOrSectorSpecificRules
+
+ +
+
Reference
+
+
    +
  • https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/
    • +
+
+
+ +
+
Constraints
+
+
    +
  • +
    + +
    + Rule Names Constraint +
    + +
    +
    Description
    +
    Constraint for defining a non-empty set of rule names as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.
    +
    + +
    +
    Reference
    +
    +
    +
      +
    • https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/
      • +
    +
    +
    +
    + +
    +
    Min. Length
    +
    1
    +
    + +
    • +
+
+
+
+
+ +
+
Other Operator Name
+
+ +Optional: Other operator of PCR (Product Category Rule)/ PSR (Product Specific Rule) as specified in the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. WBCSD specific extension, in Catena-X for example specified by a default value. + +
+
Name
+
otherOperatorName
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
NSF
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
extWBCSD_otherOperatorName
+
+ +
+
Reference
+
+
    +
  • https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/
    • +
+
+
+ +
+
Constraints
+
+
    +
  • +
    + +
    + Non Empty String Constraint +
    + +
    +
    Description
    +
    Constraint for ensuring that a string has at least one character.
    +
    + + +
    +
    Min. Length
    +
    1
    +
    + +
    • +
+
+
+
+
+
+
+

Rule Name

+
+
+ Name of a rule applied by a specified operator as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. +
+
+ Reference +
+
    +
  • https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/
    • +
+
+
+ +
+

Properties

+
+
+ +
+
Rule Name
+
+ +Name of a rule applied by a specific operator as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. + +
+
Name
+
ruleName
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
urn:tfs-initiative.com:PCR:The Product Carbon Footprint Guideline for the Chemical Industry:version:v2.0
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
ruleName
+
+ +
+
Reference
+
+
    +
  • https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221/
    • +
+
+
+ +
+
Constraints
+
+
    +
  • +
    + +
    + Non Empty String Constraint +
    + +
    +
    Description
    +
    Constraint for ensuring that a string has at least one character.
    +
    + + +
    +
    Min. Length
    +
    1
    +
    + +
    • +
+
+
+
+
+
+ +
+ Third party licenses + +
+ +
+ + +
+ + + \ No newline at end of file diff --git a/io.catenax.pcf/7.0.0/gen/Pcf.json b/io.catenax.pcf/7.0.0/gen/Pcf.json new file mode 100644 index 000000000..fed449cc3 --- /dev/null +++ b/io.catenax.pcf/7.0.0/gen/Pcf.json @@ -0,0 +1,80 @@ +{ + "specVersion" : "urn:io.catenax.pcf:datamodel:version:7.0.0", + "companyIds" : [ "telnet://192.0.2.16:80/", "ftp://ftp.is.co.za/rfc/rfc1808.txt", "http://www.ietf.org/rfc/rfc2396.txt", "http://www.wikipedia.org", "ftp://ftp.is.co.za/rfc/rfc1808.txt" ], + "extWBCSD_productCodeCpc" : "011-99000", + "created" : "2022-05-22T21:47:32Z", + "companyName" : "My Corp", + "extWBCSD_pfStatus" : "Active", + "version" : 0, + "productName" : "My Product Name", + "pcf" : { + "biogenicCarbonEmissionsOtherThanCO2" : 1.0, + "distributionStagePcfExcludingBiogenic" : 1.5, + "biogenicCarbonWithdrawal" : 0.0, + "distributionStageBiogenicCarbonEmissionsOtherThanCO2" : 1.0, + "extWBCSD_allocationRulesDescription" : "In accordance with Catena-X PCF Rulebook", + "exemptedEmissionsDescription" : "No exemption", + "distributionStageFossilGhgEmissions" : 0.5, + "exemptedEmissionsPercent" : 0.0, + "geographyCountrySubdivision" : "US-NY", + "extTFS_luGhgEmissions" : 0.3, + "distributionStageBiogenicCarbonWithdrawal" : 0.0, + "pcfIncludingBiogenic" : 1.0, + "aircraftGhgEmissions" : 0.0, + "productMassPerDeclaredUnit" : 0.456, + "productOrSectorSpecificRules" : [ { + "extWBCSD_operator" : "PEF", + "productOrSectorSpecificRules" : [ { + "ruleName" : "urn:tfs-initiative.com:PCR:The Product Carbon Footprint Guideline for the Chemical Industry:version:v2.0" + } ], + "extWBCSD_otherOperatorName" : "NSF" + } ], + "extTFS_allocationWasteIncineration" : "cut-off", + "pcfExcludingBiogenic" : 2.0, + "referencePeriodEnd" : "2022-12-31T23:59:59Z", + "extWBCSD_characterizationFactors" : "AR5", + "secondaryEmissionFactorSources" : [ { + "secondaryEmissionFactorSource" : "ecoinvent 3.8" + } ], + "unitaryProductAmount" : 1000.0, + "declaredUnit" : "liter", + "referencePeriodStart" : "2022-01-01T00:00:01Z", + "geographyRegionOrSubregion" : "Africa", + "fossilGhgEmissions" : 0.5, + "distributionStageAircraftGhgEmissions" : 0.0, + "boundaryProcessesDescription" : "Electricity consumption included as an input in the production phase", + "geographyCountry" : "DE", + "extWBCSD_packagingGhgEmissions" : 0, + "dlucGhgEmissions" : 0.4, + "carbonContentTotal" : 2.5, + "extTFS_distributionStageLuGhgEmissions" : 1.1, + "primaryDataShare" : 56.12, + "dataQualityRating" : { + "completenessDQR" : 2.0, + "technologicalDQR" : 2.0, + "geographicalDQR" : 2.0, + "temporalDQR" : 2.0, + "reliabilityDQR" : 2.0, + "coveragePercent" : 100 + }, + "extWBCSD_packagingEmissionsIncluded" : true, + "extWBCSD_fossilCarbonContent" : 0.1, + "crossSectoralStandardsUsed" : [ { + "crossSectoralStandard" : "ISO Standard 14067" + } ], + "extTFS_distributionStageDlucGhgEmissions" : 1.0, + "distributionStagePcfIncludingBiogenic" : 0.0, + "carbonContentBiogenic" : 0.0 + }, + "partialFullPcf" : "Cradle-to-gate", + "productIds" : [ "telnet://192.0.2.16:80/", "http://www.wikipedia.org", "telnet://192.0.2.16:80/", "ftp://ftp.is.co.za/rfc/rfc1808.txt" ], + "validityPeriodStart" : "2022-01-01T00:00:01Z", + "comment" : "Additional explanatory information not reflected by other attributes", + "id" : "3893bb5d-da16-4dc1-9185-11d97476c254", + "validityPeriodEnd" : "2022-12-31T23:59:59Z", + "pcfLegalStatement" : "This PCF (Product Carbon Footprint) is for information purposes only. It is based upon the standards mentioned above.", + "productDescription" : "Ethanol, 95% solution", + "precedingPfIds" : [ { + "id" : "3893bb5d-da16-4dc1-9185-11d97476c254" + } ] +} \ No newline at end of file diff --git a/io.catenax.pcf/7.0.0/gen/Pcf.yml b/io.catenax.pcf/7.0.0/gen/Pcf.yml new file mode 100644 index 000000000..f06015c21 --- /dev/null +++ b/io.catenax.pcf/7.0.0/gen/Pcf.yml @@ -0,0 +1,990 @@ +--- +openapi: 3.0.3 +info: + title: Product (Carbon) Footprint + version: v7 +servers: +- url: catenax.io/api/v7 + variables: + api-version: + default: v7 +paths: + /{tenant-id}/pcf: + get: + tags: + - Pcf + operationId: getPcf + 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/Pcf' + "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/Pcf' + totalItems: + type: number + totalPages: + type: number + pageSize: + type: number + currentPage: + type: number + 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.pcf_7.0.0_PartialFullPcfCharacteristic: + type: string + description: Characteristic for defining an indicator for partial or full PCF + (Product Carbon Footprint) declaration as specified in the Catena-X PCF Rulebook + (Version 3.0.0). + enum: + - Cradle-to-gate + - Cradle-to-grave + urn_samm_io.catenax.pcf_7.0.0_PrecedingPfId: + description: Entity for defining a preceding PCF (Product Carbon Footprint) + identifier entity as specified in the Catena-X PCF Rulebook (Version 3.0.0) + in accordance with the technical specifications for PCF Data Exchange (Version + 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ + PACT initiative. + type: object + properties: + id: + description: "Mandatory: The product footprint identifier as specified in\ + \ the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical\ + \ specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD\ + \ (World Business Council for Sustainable Development)/ PACT initiative." + $ref: '#/components/schemas/urn_samm_io.catenax.shared.uuid_2.0.0_UuidV4Trait' + required: + - id + urn_samm_io.catenax.pcf_7.0.0_PrecedingPfIdsCharacteristic: + description: Characteristic for defining a non-empty set of product (carbon) + footprint identifiers as specified in the Catena-X PCF Rulebook (Version 3.0.0) + in accordance with the WBCSD (World Business Council for Sustainable Development) + Pathfinder framework and the technical specifications for PCF Data Exchange + (Version 2.0.0) from the WBCSD/ PACT initiative. + type: array + items: + $ref: '#/components/schemas/urn_samm_io.catenax.pcf_7.0.0_PrecedingPfId' + urn_samm_io.catenax.pcf_7.0.0_ProductFootprintVersion: + type: number + minimum: 0 + description: Characteristic for defining a product footprint version as specified + in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical + specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World + Business Council for Sustainable Development)/ PACT initiative. + 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.pcf_7.0.0_PfStatusCharacteristic: + type: string + description: Characteristic for defining a status indicator of a product (carbon) + footprint as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance + with the technical specifications for PCF Data Exchange (Version 2.0.0) from + the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. + Enumeration with possible "Active" and "Deprecated". + enum: + - Active + - Deprecated + urn_samm_io.catenax.pcf_7.0.0_NonEmptyStringTrait: + type: string + description: Constraint for ensuring that a string has at least one character. + minLength: 1 + urn_samm_io.catenax.pcf_7.0.0_IdsTrait: + description: Constraint for defining a non-empty set of URIs (Uniform Resource + Identifieres). + type: array + items: + type: string + format: uri + minItems: 1 + urn_samm_io.catenax.pcf_7.0.0_DeclaredUnitCharacteristic: + type: string + description: "Unit of analysis of the product with accepted values as specified\ + \ in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical\ + \ specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World\ + \ Business Council for Sustainable Development)/ PACT initiative. For countable\ + \ products/ components/ materials, Catena-X for example adds the unit \"piece\"\ + \ to the value list specified by WBCSD." + enum: + - liter + - kilogram + - cubic meter + - kilowatt hour + - megajoule + - ton kilometer + - square meter + - piece + urn_samm_io.catenax.pcf_7.0.0_StrictlyPositiveDecimalTrait: + type: number + description: "Constraint for defining a positive, non-zero decimal." + minimum: 0.0 + exclusiveMinimum: true + urn_samm_io.catenax.pcf_7.0.0_PositiveDecimalWeightTrait: + type: number + description: Constraint for defining a decimal equal to or greater than zero. + minimum: 0 + exclusiveMinimum: false + urn_samm_io.catenax.pcf_7.0.0_ExemptedEmissionsPercentTrait: + type: number + description: Characteristic for defining the percentage of emissions excluded + from a PCF (Product Carbon Footprint) as specified in the Catena-X PCF Rulebook + (Version 3.0.0) in accordance with the technical specifications for PCF Data + Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable + Development)/ PACT initiative. + maximum: 5.0 + exclusiveMaximum: false + minimum: 0.0 + exclusiveMinimum: false + urn_samm_io.catenax.pcf_7.0.0_GeographyCountrySubdivisionTrait: + type: string + description: Constraint for defining a geography country subdivision in compliance + to ISO 3166-2 as specified in the Catena-X PCF Rulebook (Version 3.0.0) in + accordance with the technical specifications for PCF Data Exchange (Version + 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ + PACT initiative. + pattern: "([A-Z]{2}-[A-Z0-9]{1,3}|)" + urn_samm_io.catenax.pcf_7.0.0_GeographyCountryTrait: + type: string + description: Constraint for defining a geography country conform to ISO 3166CC + as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with + the technical specifications for PCF Data Exchange (Version 2.0.0) from the + WBCSD (World Business Council for Sustainable Development)/ PACT initiative. + pattern: "([A-Z]{2})" + urn_samm_io.catenax.pcf_7.0.0_GeographyRegionOrSubregionCharacteristic: + type: string + description: Characteristic for defining a list of valid geographic regions + as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with + the technical specifications for PCF Data Exchange (Version 2.0.0) from the + WBCSD (World Business Council for Sustainable Development)/ PACT initiative. + In Catena-X for example "Global" has been added to the value list. + enum: + - Africa + - Americas + - Asia + - Europe + - Oceania + - Australia and New Zealand + - Central Asia + - Eastern Asia + - Eastern Europe + - Latin America and the Caribbean + - Melanesia + - Micronesia + - Northern Africa + - Northern America + - Northern Europe + - Polynesia + - South-eastern Asia + - Southern Asia + - Southern Europe + - Sub-Saharan Africa + - Western Asia + - Western Europe + - Global + - Several + urn_samm_io.catenax.pcf_7.0.0_CrossSectoralStandardsUsedEnumerationCharacteristic: + type: string + description: Characteristic for defining the enumeration of valid accounting + standards used for product carbon footprint calculation as specified in the + Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications + for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council + for Sustainable Development)/ PACT initiative. + enum: + - ISO Standard 14067 + - ISO Standard 14044 + - Pathfinder v1 + - Pathfinder v2 + - PAS 2050 + - ISO Standard 14040 + - ISO Standard 14041 + - ISO Standard 14042 + - ISO Standard 14043 + - PEF + - Other + - GHG Protocol Product Standard + urn_samm_io.catenax.pcf_7.0.0_CrossSectoralStandard: + description: Entity for defining an accounting standard used for product carbon + footprint calculation as specified in the Catena-X PCF Rulebook (Version 3.0.0) + in accordance with the technical specifications for PCF Data Exchange (Version + 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ + PACT initiative. + type: object + properties: + crossSectoralStandard: + description: "Mandatory: Discloses a cross-sectoral standard applied for\ + \ calculating or allocating GHG (Greenhouse Gas) emissions as specified\ + \ in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the\ + \ technical specifications for PCF Data Exchange (Version 2.0.0) from\ + \ the WBCSD (World Business Council for Sustainable Development)/ PACT\ + \ initiative." + $ref: '#/components/schemas/urn_samm_io.catenax.pcf_7.0.0_CrossSectoralStandardsUsedEnumerationCharacteristic' + required: + - crossSectoralStandard + urn_samm_io.catenax.pcf_7.0.0_CrossSectoralStandardSet: + description: Characteristic for defining the list of valid accounting standards + used for product carbon footprint calculation as specified in the Catena-X + PCF Rulebook (Version 3.0.0) in accordance with the technical specifications + for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council + for Sustainable Development)/ PACT initiative. + type: array + items: + $ref: '#/components/schemas/urn_samm_io.catenax.pcf_7.0.0_CrossSectoralStandard' + urn_samm_io.catenax.pcf_7.0.0_ProductOrSectorSpecificRuleOperator: + type: string + description: Enumeration of PCR (Product Category Rule) operators as specified + in the technical specifications for PCF Data Exchange (Version 2.0.0) from + the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. + WBCSD specific extension for example in Catena-X. + enum: + - PEF + - EPD International + - Other + urn_samm_io.catenax.pcf_7.0.0_RuleName: + description: Name of a rule applied by a specified operator as specified in + the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical + specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World + Business Council for Sustainable Development)/ PACT initiative. + type: object + properties: + ruleName: + description: Name of a rule applied by a specific operator as specified + in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical + specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World + Business Council for Sustainable Development)/ PACT initiative. + $ref: '#/components/schemas/urn_samm_io.catenax.pcf_7.0.0_NonEmptyStringTrait' + required: + - ruleName + urn_samm_io.catenax.pcf_7.0.0_RuleNamesTrait: + description: Constraint for defining a non-empty set of rule names as specified + in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical + specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World + Business Council for Sustainable Development)/ PACT initiative. + type: array + items: + $ref: '#/components/schemas/urn_samm_io.catenax.pcf_7.0.0_RuleName' + uniqueItems: true + minItems: 1 + urn_samm_io.catenax.pcf_7.0.0_ProductOrSectorSpecificRule: + description: Entity for defining a product or sector specific rule of a product + carbon footprint as specified in the Catena-X PCF Rulebook (Version 3.0.0) + in accordance with the technical specifications for PCF Data Exchange (Version + 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ + PACT initiative. + type: object + properties: + extWBCSD_operator: + description: "Mandatory: Operator of PCR (Product Category Rule)/ PSR (Product\ + \ Specific Rule) as specified in the technical specifications for PCF\ + \ Data Exchange (Version 2.0.0) from the WBCSD (World Business Council\ + \ for Sustainable Development)/ PACT initiative. WBCSD specific extension,\ + \ in Catena-X for example must always be \"Other\"." + $ref: '#/components/schemas/urn_samm_io.catenax.pcf_7.0.0_ProductOrSectorSpecificRuleOperator' + productOrSectorSpecificRules: + description: "Mandatory: Product-specific or sector-specific set of rules\ + \ used for calculating or allocating GHG (Greenhouse Gas) emissions applied\ + \ from the specified operator as specified in the Catena-X PCF Rulebook\ + \ (Version 3.0.0) in accordance with the technical specifications for\ + \ PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council\ + \ for Sustainable Development)/ PACT initiative." + $ref: '#/components/schemas/urn_samm_io.catenax.pcf_7.0.0_RuleNamesTrait' + extWBCSD_otherOperatorName: + description: "Optional: Other operator of PCR (Product Category Rule)/ PSR\ + \ (Product Specific Rule) as specified in the technical specifications\ + \ for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business\ + \ Council for Sustainable Development)/ PACT initiative. WBCSD specific\ + \ extension, in Catena-X for example specified by a default value." + $ref: '#/components/schemas/urn_samm_io.catenax.pcf_7.0.0_NonEmptyStringTrait' + required: + - extWBCSD_operator + - productOrSectorSpecificRules + urn_samm_io.catenax.pcf_7.0.0_ProductOrSectorSpecificRuleSet: + description: Characteristic for defining the set of product or sector specific + rules of a product carbon footprint as specified in the Catena-X PCF Rulebook + (Version 3.0.0) in accordance with the technical specifications for PCF Data + Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable + Development)/ PACT initiative. + type: array + items: + $ref: '#/components/schemas/urn_samm_io.catenax.pcf_7.0.0_ProductOrSectorSpecificRule' + uniqueItems: true + urn_samm_io.catenax.pcf_7.0.0_CharacterizationFactorsCharacteristic: + type: string + description: Characteristic for defining the characterization factors of a product + carbon footprint as specified in the Catena-X PCF Rulebook (Version 3.0.0) + in accordance with the technical specifications for PCF Data Exchange (Version + 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ + PACT initiative. In Catena-X for example specified by a default value. + enum: + - AR5 + - AR6 + urn_samm_io.catenax.pcf_7.0.0_AllocationWasteIncinerationCharacteristic: + type: string + description: Characteristic for defining the allocation approach used for waste + incineration as specified by the TFS (Together For Sustainability) initiative. + enum: + - cut-off + - reverse cut-off + - system expansion + urn_samm_io.catenax.pcf_7.0.0_PercentTrait: + type: number + description: Constraint for a decimal number in the range of and including 0 + and 100. + maximum: 100.0 + exclusiveMaximum: false + minimum: 0.0 + exclusiveMinimum: false + urn_samm_io.catenax.pcf_7.0.0_EmissionFactorDS: + description: Entity for defining an emission factor data source used to calculate + a product carbon footprint as specified in the Catena-X PCF Rulebook (Version + 3.0.0) in accordance with the technical specifications for PCF Data Exchange + (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ + PACT initiative. + type: object + properties: + secondaryEmissionFactorSource: + description: "Mandatory: Emission factor data source used to calculate a\ + \ product carbon footprint as specified in the Catena-X PCF Rulebook (Version\ + \ 3.0.0) in accordance with the technical specifications for PCF Data\ + \ Exchange (Version 2.0.0) from the WBCSD (World Business Council for\ + \ Sustainable Development)/ PACT initiative." + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + required: + - secondaryEmissionFactorSource + urn_samm_io.catenax.pcf_7.0.0_EmissionFactorDSSet: + description: Characteristic for defining a set of emission factor sources used + for calculating a product carbon footprint as specified in the Catena-X PCF + Rulebook (Version 3.0.0) in accordance with the technical specifications for + PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for + Sustainable Development)/ PACT initiative. + type: array + items: + $ref: '#/components/schemas/urn_samm_io.catenax.pcf_7.0.0_EmissionFactorDS' + uniqueItems: true + urn_samm_io.catenax.pcf_7.0.0_DqiNumberTrait: + type: number + description: Constraint for defining a decimal between 1 and 3 including. + maximum: 3 + exclusiveMaximum: false + minimum: 1 + exclusiveMinimum: false + urn_samm_io.catenax.pcf_7.0.0_DataQualityIndicators: + description: Characteristic for defining the quantitative data quality indicators + of a PCF (Product Carbon Footprint) as specified in the Catena-X PCF Rulebook + (Version 3.0.0) in accordance with the technical specifications for PCF Data + Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable + Development)/ PACT initiative. + type: object + properties: + coveragePercent: + description: "Mandatory starting 2025: Percentage of PCF (Product Carbon\ + \ Footprint) included in the data quality assessment based on the >5%\ + \ emissions threshold as specified in the Catena-X PCF Rulebook (Version\ + \ 3.0.0) in accordance with the technical specifications for PCF Data\ + \ Exchange (Version 2.0.0) from the WBCSD (World Business Council for\ + \ Sustainable Development)/ PACT initiative. In Catena-X for example set\ + \ to \"100\" per default." + $ref: '#/components/schemas/urn_samm_io.catenax.pcf_7.0.0_PercentTrait' + technologicalDQR: + description: "Optional: Technological representativeness of the sources\ + \ used for PCF (Product Carbon Footprint) calculation based on weighted\ + \ average of all inputs representing >5% of PCF emissions. Specified in\ + \ the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical\ + \ specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD\ + \ (World Business Council for Sustainable Development)/ PACT initiative." + $ref: '#/components/schemas/urn_samm_io.catenax.pcf_7.0.0_DqiNumberTrait' + temporalDQR: + description: "Optional: Temporal representativeness of the sources used\ + \ for PCF (Product Carbon Footprint) calculation based on weighted average\ + \ of all inputs representing >5% of PCF emissions. Specified in the Catena-X\ + \ PCF Rulebook (Version 3.0.0) in accordance with the technical specifications\ + \ for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business\ + \ Council for Sustainable Development)/ PACT initiative." + $ref: '#/components/schemas/urn_samm_io.catenax.pcf_7.0.0_DqiNumberTrait' + geographicalDQR: + description: "Optional: Geographical representativeness of the sources used\ + \ for PCF (Product Carbon Footprint) calculation based on weighted average\ + \ of all inputs representing >5% of PCF emissions. Specified in the Catena-X\ + \ PCF Rulebook (Version 3.0.0) in accordance with the technical specifications\ + \ for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business\ + \ Council for Sustainable Development)/ PACT initiative." + $ref: '#/components/schemas/urn_samm_io.catenax.pcf_7.0.0_DqiNumberTrait' + completenessDQR: + description: "Optional: Completeness of the data collected for PCF (Product\ + \ Carbon Footprint) calculation based on weighted average of all inputs\ + \ representing >5% of PCF emissions. Specified in the Catena-X PCF Rulebook\ + \ (Version 3.0.0) in accordance with the technical specifications for\ + \ PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council\ + \ for Sustainable Development)/ PACT initiative." + $ref: '#/components/schemas/urn_samm_io.catenax.pcf_7.0.0_DqiNumberTrait' + reliabilityDQR: + description: "Optional: Reliability of the data collected for PCF (Product\ + \ Carbon Footprint) calculation based on weighted average of all inputs\ + \ representing >5% of PCF emissions. Specified in the Catena-X PCF Rulebook\ + \ (Version 3.0.0) in accordance with the technical specifications for\ + \ PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council\ + \ for Sustainable Development)/ PACT initiative." + $ref: '#/components/schemas/urn_samm_io.catenax.pcf_7.0.0_DqiNumberTrait' + 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.pcf_7.0.0_PositiveEmissionsTrait: + type: number + description: 'Only positive emission values (>0) are valid ' + minimum: 0.0 + exclusiveMinimum: false + urn_samm_io.catenax.pcf_7.0.0_PositiveOrNegativeEmission: + type: number + description: Characteristic for defining (positive or negative) emissions in + context of a PCF (Product Carbon Footprint) as specified by the WBCSD (World + Business Council for Sustainable Development) Pathfinder initiative. + urn_samm_io.catenax.pcf_7.0.0_NegativeEmissionsTrait: + type: number + description: Only negative emission values (<=0) are valid. + maximum: 0.0 + exclusiveMaximum: false + urn_samm_io.catenax.pcf_7.0.0_PcfEntity: + description: Characteristic for defining a PCF (Product Carbon Footprint) as + specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with + the technical specifications for PCF Data Exchange (Version 2.0.0) from the + WBCSD (World Business Council for Sustainable Development)/ PACT initiative. + type: object + properties: + declaredUnit: + description: "Mandatory: Unit of analysis of a product in context of the\ + \ PCF (product carbon footprint) as specified in the Catena-X PCF Rulebook\ + \ (Version 3.0.0) in accordance with the technical specifications for\ + \ PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council\ + \ for Sustainable Development)/ PACT initiative. In Catena-X for example\ + \ list of valid units includes \"piece\"." + $ref: '#/components/schemas/urn_samm_io.catenax.pcf_7.0.0_DeclaredUnitCharacteristic' + unitaryProductAmount: + description: "Mandatory: Amount of units contained within a product in context\ + \ of the PCF (Product Carbon Footprint) as specified in the Catena-X PCF\ + \ Rulebook (Version 3.0.0) in accordance with the technical specifications\ + \ for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business\ + \ Council for Sustainable Development)/ PACT initiative." + $ref: '#/components/schemas/urn_samm_io.catenax.pcf_7.0.0_StrictlyPositiveDecimalTrait' + productMassPerDeclaredUnit: + description: "Mandatory: Mass of a product per declared unit (net, unpackaged)\ + \ in context of the PCF (Product Carbon Footprint) as specified in the\ + \ Catena-X PCF Rulebook (Version 3.0.0)." + $ref: '#/components/schemas/urn_samm_io.catenax.pcf_7.0.0_PositiveDecimalWeightTrait' + exemptedEmissionsPercent: + description: |- + Mandatory: Applied cut-off percentage of emissions excluded from PCF (Product Carbon Footprint). + For accordance with Catena-X PCF Rulebook (Version 3.0.0) <3%. + $ref: '#/components/schemas/urn_samm_io.catenax.pcf_7.0.0_ExemptedEmissionsPercentTrait' + exemptedEmissionsDescription: + description: "Optional: Rationale behind exclusion of specific PCF (Product\ + \ Carbon Footprint) emissions as specified in the Catena-X PCF Rulebook\ + \ (Version 3.0.0) in accordance with the technical specifications for\ + \ PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council\ + \ for Sustainable Development)/ PACT initiative." + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + boundaryProcessesDescription: + description: "Optional: Processes attributable to each lifecycle stage as\ + \ specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance\ + \ with the technical specifications for PCF Data Exchange (Version 2.0.0)\ + \ from the WBCSD (World Business Council for Sustainable Development)/\ + \ PACT initiative." + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + geographyCountrySubdivision: + description: "Optional: Subdivision of a country which must be an ISO 3166-2\ + \ subdivision code as specified in the Catena-X PCF Rulebook (Version\ + \ 3.0.0) in accordance with the technical specifications for PCF Data\ + \ Exchange (Version 2.0.0) from the WBCSD (World Business Council for\ + \ Sustainable Development)/ PACT initiative." + $ref: '#/components/schemas/urn_samm_io.catenax.pcf_7.0.0_GeographyCountrySubdivisionTrait' + geographyCountry: + description: "Optional: Two letter country code that must conform to data\ + \ type ISO 3166CC as specified in the Catena-X PCF Rulebook (Version 3.0.0)\ + \ in accordance with the technical specifications for PCF Data Exchange\ + \ (Version 2.0.0) from the WBCSD (World Business Council for Sustainable\ + \ Development)/ PACT initiative." + $ref: '#/components/schemas/urn_samm_io.catenax.pcf_7.0.0_GeographyCountryTrait' + geographyRegionOrSubregion: + description: "Mandatory: Region according to list as specified in the Catena-X\ + \ PCF Rulebook (Version 3.0.0) in accordance with the technical specifications\ + \ for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business\ + \ Council for Sustainable Development)/ PACT initiative." + $ref: '#/components/schemas/urn_samm_io.catenax.pcf_7.0.0_GeographyRegionOrSubregionCharacteristic' + referencePeriodStart: + description: "Mandatory: Start of time boundary for which a PCF (Product\ + \ Carbon Footprint) value is considered to be representative as specified\ + \ in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the\ + \ technical specifications for PCF Data Exchange (Version 2.0.0) from\ + \ the WBCSD (World Business Council for Sustainable Development)/ PACT\ + \ initiative." + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Timestamp' + referencePeriodEnd: + description: "Mandatory: End of time boundary for which a PCF (Product Carbon\ + \ Footprint) value is considered to be representative as specified in\ + \ the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical\ + \ specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD\ + \ (World Business Council for Sustainable Development)/ PACT initiative." + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Timestamp' + crossSectoralStandardsUsed: + description: "Mandatory: Discloses the cross-sectoral standards applied\ + \ for calculating or allocating GHG (Greenhouse Gas) emissions as specified\ + \ in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the\ + \ technical specifications for PCF Data Exchange (Version 2.0.0) from\ + \ the WBCSD (World Business Council for Sustainable Development)/ PACT\ + \ initiative." + $ref: '#/components/schemas/urn_samm_io.catenax.pcf_7.0.0_CrossSectoralStandardSet' + productOrSectorSpecificRules: + description: "Mandatory: Product or sector specific rules applied for calculating\ + \ or allocating GHG (Greenhouse Gas) emissions, e.g. PCRs (Product Category\ + \ Rules), including operators or publishers and according rule names as\ + \ specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance\ + \ with the technical specifications for PCF Data Exchange (Version 2.0.0)\ + \ from the WBCSD (World Business Council for Sustainable Development)/\ + \ PACT initiative." + $ref: '#/components/schemas/urn_samm_io.catenax.pcf_7.0.0_ProductOrSectorSpecificRuleSet' + extWBCSD_characterizationFactors: + description: "Mandatory: IPCC (Intergovernmental Panel on Climate Change)\ + \ version of the GWP (Global Warming Potential) characterization factors\ + \ used for calculating the PCF (Product Carbon Footprint) as specified\ + \ in the technical specifications for PCF Data Exchange (Version 2.0.0)\ + \ from the WBCSD (World Business Council for Sustainable Development)/\ + \ PACT initiative. WBCSD specific extension, in Catena-X for example specified\ + \ by default with value \\\"AR6\\\". Default value can be overwritten." + $ref: '#/components/schemas/urn_samm_io.catenax.pcf_7.0.0_CharacterizationFactorsCharacteristic' + extWBCSD_allocationRulesDescription: + description: "Optional: Allocation rules used and underlying reasoning in\ + \ context of a product carbon footprint as specified in the technical\ + \ specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD\ + \ (World Business Council for Sustainable Development)/ PACT initiative.\ + \ WBCSD specific extension, in Catena-X for example specified by default\ + \ with value \"In accordance with Catena-X PCF Rulebook (Version 3.0.0)\"\ + ." + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + extTFS_allocationWasteIncineration: + description: "Mandatory: Allocation approach used for waste incineration\ + \ with energy recovery as specified by the TFS (Together For Sustainability)\ + \ initiative. In Catena-X for example must be specified by value \"cut-off\"\ + ." + $ref: '#/components/schemas/urn_samm_io.catenax.pcf_7.0.0_AllocationWasteIncinerationCharacteristic' + primaryDataShare: + description: "Mandatory starting 2025: Share of primary data in percent\ + \ as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance\ + \ with the technical specifications for PCF Data Exchange (Version 2.0.0)\ + \ from the WBCSD (World Business Council for Sustainable Development)/\ + \ PACT initiative." + $ref: '#/components/schemas/urn_samm_io.catenax.pcf_7.0.0_PercentTrait' + secondaryEmissionFactorSources: + description: "Mandatory: Emission factors used for the PCF (Product Carbon\ + \ Footprint) calculation as specified in the Catena-X PCF Rulebook (Version\ + \ 3.0.0) in accordance with the technical specifications for PCF Data\ + \ Exchange (Version 2.0.0) from the WBCSD (World Business Council for\ + \ Sustainable Development)/ PACT initiative." + $ref: '#/components/schemas/urn_samm_io.catenax.pcf_7.0.0_EmissionFactorDSSet' + dataQualityRating: + description: "Mandatory starting 2025: Quantitative data quality indicators\ + \ of a PCF (Product Carbon Footprint) as specified in the Catena-X PCF\ + \ Rulebook (Version 3.0.0) in accordance with the technical specifications\ + \ for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business\ + \ Council for Sustainable Development)/ PACT initiative." + $ref: '#/components/schemas/urn_samm_io.catenax.pcf_7.0.0_DataQualityIndicators' + extWBCSD_packagingEmissionsIncluded: + description: |- + Mandatory: The Catena-X PCF Rulebook requires to include packaging from a system boundary perspective. "FALSE" is only possible due to the application of the cut-off rule. + Flag indicating whether packaging emissions are included in a PCF (Product Carbon Footprint) as specified in the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. WBCSD specific extension. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Boolean' + pcfExcludingBiogenic: + description: "Mandatory: Product carbon footprint of a product excluding\ + \ biogenic emissions as specified in the Catena-X PCF Rulebook (Version\ + \ 3.0.0) in accordance with the technical specifications for PCF Data\ + \ Exchange (Version 2.0.0) from the WBCSD (World Business Council for\ + \ Sustainable Development)/ PACT initiative." + $ref: '#/components/schemas/urn_samm_io.catenax.pcf_7.0.0_PositiveEmissionsTrait' + pcfIncludingBiogenic: + description: "Mandatory starting 2025: Product carbon footprint of a product\ + \ including biogenic emissions as specified in the Catena-X PCF Rulebook\ + \ (Version 3.0.0) in accordance with the technical specifications for\ + \ PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council\ + \ for Sustainable Development)/ PACT initiative. Optional value in current\ + \ specification version but will be mandatory in future version." + $ref: '#/components/schemas/urn_samm_io.catenax.pcf_7.0.0_PositiveOrNegativeEmission' + fossilGhgEmissions: + description: "Mandatory starting 2025: Emissions from combustion of fossil\ + \ sources as specified in the Catena-X PCF Rulebook (Version 3.0.0) in\ + \ accordance with the technical specifications for PCF Data Exchange (Version\ + \ 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/\ + \ PACT initiative. Identical to \"pcfExcludingBiogenic\", will be removed\ + \ in later version." + $ref: '#/components/schemas/urn_samm_io.catenax.pcf_7.0.0_PositiveEmissionsTrait' + biogenicCarbonEmissionsOtherThanCO2: + description: "Mandatory starting 2025: GWP (Global Warming Potential) of\ + \ biogenic CO2e-emissions in production phase which contain only GHG (Greenhouse\ + \ Gas) emissions other than CO2 - excludes biogenic CO2. For specification\ + \ see Catena-X PCF Rulebook (Version 3.0.0)." + $ref: '#/components/schemas/urn_samm_io.catenax.pcf_7.0.0_PositiveEmissionsTrait' + biogenicCarbonWithdrawal: + description: "Mandatory starting 2025: Biogenic carbon content in the product\ + \ converted to CO2e as specified in the Catena-X PCF Rulebook (Version\ + \ 3.0.0) in accordance with the technical specifications for PCF Data\ + \ Exchange (Version 2.1.0) from the WBCSD (World Business Council for\ + \ Sustainable Development)/ PACT initiative." + $ref: '#/components/schemas/urn_samm_io.catenax.pcf_7.0.0_NegativeEmissionsTrait' + dlucGhgEmissions: + description: "Mandatory starting 2025: Direct land use change CO2e emissions\ + \ in context of a product carbon footprint as specified in the Catena-X\ + \ PCF Rulebook (Version 3.0.0) in accordance with the technical specifications\ + \ for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business\ + \ Council for Sustainable Development)/ PACT initiative." + $ref: '#/components/schemas/urn_samm_io.catenax.pcf_7.0.0_PositiveEmissionsTrait' + extTFS_luGhgEmissions: + description: "Mandatory starting 2025: Land use CO2 emissions in context\ + \ of a product carbon footprint as specified by the TFS (Together For\ + \ Sustainability) initiative. TFS specific extension." + $ref: '#/components/schemas/urn_samm_io.catenax.pcf_7.0.0_PositiveOrNegativeEmission' + aircraftGhgEmissions: + description: "Mandatory starting 2025: GHG (Greenhouse Gas) emissions resulting\ + \ from aircraft engine usage for the transport of the product as specified\ + \ in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the\ + \ technical specifications for PCF Data Exchange (Version 2.0.0) from\ + \ the WBCSD (World Business Council for Sustainable Development)/ PACT\ + \ initiative." + $ref: '#/components/schemas/urn_samm_io.catenax.pcf_7.0.0_PositiveEmissionsTrait' + extWBCSD_packagingGhgEmissions: + description: "Optional: Emissions resulting from the packaging of the product\ + \ as specified in the technical specifications for PCF Data Exchange (Version\ + \ 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/\ + \ PACT initiative. WBCSD specific extension. In Catena-X not relevant\ + \ to be reported separately." + $ref: '#/components/schemas/urn_samm_io.catenax.pcf_7.0.0_PositiveEmissionsTrait' + distributionStagePcfExcludingBiogenic: + description: "Optional: Product carbon footprint for the distribution stage\ + \ of a product excluding biogenic emissions as specified in the Catena-X\ + \ PCF Rulebook (Version 3.0.0)." + $ref: '#/components/schemas/urn_samm_io.catenax.pcf_7.0.0_PositiveEmissionsTrait' + distributionStagePcfIncludingBiogenic: + description: "Optional: Product carbon footprint for the distribution stage\ + \ of a product including biogenic emissions as specified in the Catena-X\ + \ PCF Rulebook (Version 3.0.0)." + $ref: '#/components/schemas/urn_samm_io.catenax.pcf_7.0.0_PositiveOrNegativeEmission' + distributionStageFossilGhgEmissions: + description: "Optional: Emissions from the combustion of fossil sources\ + \ in the distribution stage as specified in the Catena-X PCF Rulebook\ + \ (Version 3.0.0)." + $ref: '#/components/schemas/urn_samm_io.catenax.pcf_7.0.0_PositiveEmissionsTrait' + distributionStageBiogenicCarbonEmissionsOtherThanCO2: + description: "Optional: GWP (Global Warming Potential) of biogenic CO2e-emissions\ + \ in distribution phase which contain only GHG (Greenhouse Gas) emissions\ + \ other than CO2 ? excludes biogenic CO2. For specification see Catena-X\ + \ PCF Rulebook (Version 3.0.0)." + $ref: '#/components/schemas/urn_samm_io.catenax.pcf_7.0.0_PositiveEmissionsTrait' + distributionStageBiogenicCarbonWithdrawal: + description: "Optional: GWP (Global Warming Potential) of biogenic CO2-withdrawal\ + \ in distribution stage (biogenic CO2 contained in the product) as specified\ + \ in the Catena-X PCF Rulebook (Version 3.0.0)." + $ref: '#/components/schemas/urn_samm_io.catenax.pcf_7.0.0_NegativeEmissionsTrait' + extTFS_distributionStageDlucGhgEmissions: + description: "Optional: Direct land use change CO2 emissions during distribution\ + \ stage in context of a product carbon footprint as specified by the TFS\ + \ (Together For Sustainability) initiative. TFS specific extension." + $ref: '#/components/schemas/urn_samm_io.catenax.pcf_7.0.0_PositiveEmissionsTrait' + extTFS_distributionStageLuGhgEmissions: + description: "Optional: Land use CO2 emissions in context of a product carbon\ + \ footprint as specified by the TFS (Together For Sustainability) initiative.\ + \ TFS specific extension." + $ref: '#/components/schemas/urn_samm_io.catenax.pcf_7.0.0_PositiveOrNegativeEmission' + carbonContentTotal: + description: "Mandatory starting 2025: Total carbon content per declared\ + \ unit in context of a product carbon footprint as specified in the Catena-X\ + \ PCF Rulebook (Version 3.0.0)." + $ref: '#/components/schemas/urn_samm_io.catenax.pcf_7.0.0_PositiveEmissionsTrait' + extWBCSD_fossilCarbonContent: + description: "Mandatory starting 2025: Fossil carbon amount embodied in\ + \ a product as specified in the technical specifications for PCF Data\ + \ Exchange (Version 2.1.0) from the WBCSD (World Business Council for\ + \ Sustainable Development)/ PACT initiative. Must be calculated with kgC\ + \ (kilogram Carbon) / declaredUnit equal to or greater zero; WBCSD specific\ + \ extension, in Catena-X specified by a calculated value." + $ref: '#/components/schemas/urn_samm_io.catenax.pcf_7.0.0_PositiveEmissionsTrait' + carbonContentBiogenic: + description: "Mandatory starting 2025: Biogenic carbon amount embodied in\ + \ a product as specified in the Catena-X PCF Rulebook (Version 3.0.0)\ + \ in accordance with the technical specifications for PCF Data Exchange\ + \ (Version 2.1.0) from the WBCSD (World Business Council for Sustainable\ + \ Development)/ PACT initiative. Must be calculated with kgC (kilogram\ + \ Carbon) / declaredUnit equal to or greater zero." + $ref: '#/components/schemas/urn_samm_io.catenax.pcf_7.0.0_PositiveEmissionsTrait' + distributionStageAircraftGhgEmissions: + description: "Optional: GHG (Greenhouse Gas) emissions for the distribution\ + \ stage resulting from aircraft engine usage for the transport of the\ + \ product as specified in the Catena-X PCF Rulebook (Version 3.0.0) in\ + \ accordance with the technical specifications for PCF Data Exchange (Version\ + \ 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/\ + \ PACT initiative." + $ref: '#/components/schemas/urn_samm_io.catenax.pcf_7.0.0_PositiveEmissionsTrait' + required: + - declaredUnit + - unitaryProductAmount + - productMassPerDeclaredUnit + - exemptedEmissionsPercent + - geographyRegionOrSubregion + - referencePeriodStart + - referencePeriodEnd + - crossSectoralStandardsUsed + - productOrSectorSpecificRules + - extWBCSD_characterizationFactors + - extTFS_allocationWasteIncineration + - secondaryEmissionFactorSources + - extWBCSD_packagingEmissionsIncluded + - pcfExcludingBiogenic + Pcf: + description: A Product (Carbon) Footprint represents the carbon footprint of + a product with values as specified in the Catena-X PCF Rulebook (Version 3.0.0) + in accordance with the WBCSD (World Business Council for Sustainable Development) + Pathfinder framework and the technical specifications for PCF Data Exchange + (Version 2.0.0) from the WBCSD/ PACT initiative. + type: object + properties: + id: + description: "Mandatory: The product footprint identifier as specified in\ + \ the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical\ + \ specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD\ + \ (World Business Council for Sustainable Development)/ PACT initiative." + $ref: '#/components/schemas/urn_samm_io.catenax.shared.uuid_2.0.0_UuidV4Trait' + specVersion: + description: "Mandatory: Version of the product footprint data specification\ + \ as defined in the Catena-X PCF Rulebook (Version 3.0.0) in accordance\ + \ with the technical specifications for PCF Data Exchange (Version 2.0.0)\ + \ from the WBCSD (World Business Council for Sustainable Development)/\ + \ PACT initiative." + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + partialFullPcf: + description: "Mandatory: Indicator for partial or full PCF (Product Carbon\ + \ Footprint) declaration as specified in the Catena-X PCF Rulebook (Version\ + \ 3.0.0)." + $ref: '#/components/schemas/urn_samm_io.catenax.pcf_7.0.0_PartialFullPcfCharacteristic' + precedingPfIds: + description: "Optional: Set of preceding PCF (Product Carbon Footprint)\ + \ identifiers without duplicates as specified in the Catena-X PCF Rulebook\ + \ (Version 3.0.0) in accordance with the WBCSD (World Business Council\ + \ for Sustainable Development) Pathfinder framework and the technical\ + \ specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD/\ + \ PACT initiative. Declared as \"optional\" in WBCSD, needs to be covered\ + \ by application." + $ref: '#/components/schemas/urn_samm_io.catenax.pcf_7.0.0_PrecedingPfIdsCharacteristic' + version: + description: "Mandatory: Version of the product (carbon) footprint as specified\ + \ in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the\ + \ technical specifications for PCF Data Exchange (Version 2.0.0) from\ + \ the WBCSD (World Business Council for Sustainable Development)/ PACT\ + \ initiative. In Catena-X for example set to \"0\" per default." + $ref: '#/components/schemas/urn_samm_io.catenax.pcf_7.0.0_ProductFootprintVersion' + created: + description: "Mandatory: Timestamp of the creation of the Product (Carbon)\ + \ Footprint as specified in the Catena-X PCF Rulebook (Version 3.0.0)\ + \ in accordance with the technical specifications for PCF Data Exchange\ + \ (Version 2.0.0) from the WBCSD (World Business Council for Sustainable\ + \ Development)/ PACT initiative." + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Timestamp' + extWBCSD_pfStatus: + description: "Mandatory: Status indicator of a product (carbon) footprint\ + \ as specified in the technical specifications for PCF Data Exchange (Version\ + \ 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/\ + \ PACT initiative. WBCSD specific extension, in Catena-X for example set\ + \ to \"Active\" per default." + $ref: '#/components/schemas/urn_samm_io.catenax.pcf_7.0.0_PfStatusCharacteristic' + validityPeriodStart: + description: "Optional: Start of interval during which the product (carbon)\ + \ footprint is declared as valid as specified in the Catena-X PCF Rulebook\ + \ (Version 3.0.0) in accordance with the technical specifications for\ + \ PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council\ + \ for Sustainable Development)/ PACT initiative. If specified, the validity\ + \ period start must be equal to or greater than the reference period end." + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Timestamp' + validityPeriodEnd: + description: "Optional: End of interval during which the product (carbon)\ + \ footprint is declared as valid as specified in the Catena-X PCF Rulebook\ + \ (Version 3.0.0) in accordance with the technical specifications for\ + \ PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council\ + \ for Sustainable Development)/ PACT initiative." + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Timestamp' + comment: + description: "Optional: Additional information and instructions related\ + \ to the calculation of the product (carbon) footprint as specified in\ + \ the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical\ + \ specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD\ + \ (World Business Council for Sustainable Development)/ PACT initiative." + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + companyName: + description: "Mandatory: Name of the product (carbon) footprint data owner\ + \ as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance\ + \ with the technical specifications for PCF Data Exchange (Version 2.0.0)\ + \ from the WBCSD (World Business Council for Sustainable Development)/\ + \ PACT initiative." + $ref: '#/components/schemas/urn_samm_io.catenax.pcf_7.0.0_NonEmptyStringTrait' + companyIds: + description: "Mandatory: Non-empty set of Uniform Resource Names (URN).\ + \ Each value is supposed to uniquely identify the product (carbon) footprint\ + \ data owner as specified in the Catena-X PCF Rulebook (Version 3.0.0)\ + \ in accordance with the technical specifications for PCF Data Exchange\ + \ (Version 2.1.0) from the WBCSD (World Business Council for Sustainable\ + \ Development)/ PACT initiative. For Catena-X Industry Core compliance\ + \ the set of URNs must contain at least the Business Partner Number Legal\ + \ Entity (BPNL) in the specified format urn:bpn:id:BPNL[a-zA-Z0-9]{12}.\_" + $ref: '#/components/schemas/urn_samm_io.catenax.pcf_7.0.0_IdsTrait' + productDescription: + description: "Optional: Free-form description of the product as specified\ + \ in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the\ + \ technical specifications for PCF Data Exchange (Version 2.0.0) from\ + \ the WBCSD (World Business Council for Sustainable Development)/ PACT\ + \ initiative." + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + productIds: + description: "Mandatory: Non-empty set of product identifiers. Each value\ + \ is supposed to uniquely identify the product as specified in the Catena-X\ + \ PCF Rulebook (Version 3.0.0) in accordance with the technical specifications\ + \ for PCF Data Exchange (Version 2.1.0) from the WBCSD (World Business\ + \ Council for Sustainable Development)/ PACT initiative. In Catena-X productId\ + \ corresponds with Industry Core manufacturerPartId." + $ref: '#/components/schemas/urn_samm_io.catenax.pcf_7.0.0_IdsTrait' + extWBCSD_productCodeCpc: + description: "Mandatory: UN (United Nations) Product Classification Code\ + \ (CPC - Central Classification Code) of a given product as specified\ + \ the technical specifications for PCF Data Exchange (Version 2.0.0) from\ + \ the WBCSD (World Business Council for Sustainable Development)/ PACT\ + \ initiative. WBCSD specific extension, which will probably be declared\ + \ as \"optional\" in a later WBCSD specification version. In Catena-X\ + \ for example specified with default value \"011-99000\"." + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + productName: + description: "Mandatory: Non-empty trade name of a product as specified\ + \ in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the\ + \ technical specifications for PCF Data Exchange (Version 2.1.0) from\ + \ the WBCSD (World Business Council for Sustainable Development)/ PACT\ + \ initiative. In Catena-X productNameCompany corresponds with Industry\ + \ Core nameAtManufacturer.\_" + $ref: '#/components/schemas/urn_samm_io.catenax.pcf_7.0.0_NonEmptyStringTrait' + pcf: + description: A PCF (Product Carbon Footprint) represents the carbon footprint + of a product and related data as specified in the Catena-X PCF Rulebook + (Version 3.0.0) in accordance with the technical specifications for PCF + Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for + Sustainable Development)/ PACT initiative. + $ref: '#/components/schemas/urn_samm_io.catenax.pcf_7.0.0_PcfEntity' + pcfLegalStatement: + description: "Optional: Option for legal statement/ disclaimer as specified\ + \ in the Catena-X PCF Rulebook (Version 3.0.0)." + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + required: + - id + - specVersion + - partialFullPcf + - version + - created + - extWBCSD_pfStatus + - companyName + - companyIds + - productIds + - extWBCSD_productCodeCpc + - productName + - pcf + 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' + Pcf: + content: + application/json: + schema: + $ref: '#/components/schemas/PagingSchema' + description: The request was successful. + requestBodies: + Pcf: + content: + application/json: + schema: + $ref: '#/components/schemas/Pcf' diff --git a/io.catenax.pcf/7.0.0/metadata.json b/io.catenax.pcf/7.0.0/metadata.json new file mode 100644 index 000000000..c22749aed --- /dev/null +++ b/io.catenax.pcf/7.0.0/metadata.json @@ -0,0 +1 @@ +{ "status" : "release"} diff --git a/io.catenax.pcf/RELEASE_NOTES.md b/io.catenax.pcf/RELEASE_NOTES.md index 9f8609d85..405d9facb 100644 --- a/io.catenax.pcf/RELEASE_NOTES.md +++ b/io.catenax.pcf/RELEASE_NOTES.md @@ -3,6 +3,12 @@ All notable changes to this model will be documented in this file. ## [Unreleased] +## [7.0.0] 2024-05-27 +### Changed +- adapted as aligned with and specified by the Catena-X use case team +- extended enumeration list of property "crossSectoralStandard" for compliance with the TfS (Together for Sustainability) standard +- updated descriptions and examples for compliance with the PCF Rulebook v3 standard + ## [6.0.0] 2024-02-26 ### Changed - adapted as aligned with and specified by the Catena-X use case team diff --git a/io.catenax.quality_task/1.0.0/metadata.json b/io.catenax.quality_task/1.0.0/metadata.json index c22749aed..bf40b864e 100644 --- a/io.catenax.quality_task/1.0.0/metadata.json +++ b/io.catenax.quality_task/1.0.0/metadata.json @@ -1 +1 @@ -{ "status" : "release"} +{ "status" : "deprecate"} diff --git a/io.catenax.quality_task/RELEASE_NOTES.md b/io.catenax.quality_task/RELEASE_NOTES.md index 71ccab50a..96ce850d0 100644 --- a/io.catenax.quality_task/RELEASE_NOTES.md +++ b/io.catenax.quality_task/RELEASE_NOTES.md @@ -19,12 +19,11 @@ This aspect model was created in the Catena-X use case quality. The purpose of t ### Removed -## [1.0.0] - 2022-12-13 +## [1.0.0] - 2022-12-13 -> deprecated ### Added - initial version of this model ### Changed n/a -### Removed - +### Removed \ No newline at end of file diff --git a/io.catenax.serial_part/1.0.0/SerialPart.ttl b/io.catenax.serial_part/1.0.0/SerialPart.ttl deleted file mode 100644 index 1068800b9..000000000 --- a/io.catenax.serial_part/1.0.0/SerialPart.ttl +++ /dev/null @@ -1,207 +0,0 @@ -####################################################################### -# Copyright (c) 2022,2023 BASF SE -# Copyright (c) 2022,2023 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) -# Copyright (c) 2022,2023 Fraunhofer-Gesellschaft zur Foerderung der angewandten Forschung e.V. (represented by Fraunhofer ISST & Fraunhofer IML) -# Copyright (c) 2022,2023 German Edge Cloud GmbH & Co. KG -# Copyright (c) 2022,2023 Henkel AG & Co. KGaA -# Copyright (c) 2022,2023 Mercedes Benz AG -# Copyright (c) 2022,2023 Robert Bosch Manufacturing Solutions GmbH -# Copyright (c) 2022,2023 SAP SE -# Copyright (c) 2022,2023 Siemens AG -# Copyright (c) 2022,2023 T-Systems International GmbH -# Copyright (c) 2022,2023 ZF Friedrichshafen AG -# Copyright (c) 2022,2023 Contributors to the Eclipse Foundation -# -# 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 bamm: . -@prefix bamm-c: . -@prefix bamm-e: . -@prefix unit: . -@prefix rdf: . -@prefix rdfs: . -@prefix xsd: . -@prefix : . - -:SerialPart a bamm:Aspect ; - bamm:preferredName "Serial Part"@en ; - bamm:description "A serialized part is an instantiation of a (design-) part, where the particular instantiation can be uniquely identified by means of a serial number or a similar identifier (e.g. VAN) or a combination of multiple identifiers (e.g. combination of manufacturer, date and number)"@en ; - bamm:properties ( :catenaXId :localIdentifiers :manufacturingInformation :partTypeInformation ) ; - bamm:operations ( ) ; - bamm:events ( ) . - -:catenaXId a bamm:Property ; - bamm:preferredName "Catena-X ID"@en ; - bamm:description "The fully anonymous Catena-X ID of the serialized part, valid for the Catena-X dataspace."@en ; - bamm:characteristic :CatenaXIdTrait ; - bamm:exampleValue "urn:uuid:580d3adf-1981-44a0-a214-13d6ceed9379" . - -:localIdentifiers a bamm:Property ; - bamm:preferredName "Local Identifiers"@en ; - bamm:description "A local identifier enables identification of a part in a specific dataspace, but is not unique in Catena-X dataspace. Multiple local identifiers may exist."@en ; - bamm:characteristic :LocalIdentifierCharacteristic . - -:manufacturingInformation a bamm:Property ; - bamm:preferredName "Manufacturing Information"@en ; - bamm:description "Information from manufacturing process, such as manufacturing date and manufacturing country"@en ; - bamm:characteristic :ManufacturingCharacteristic . - -:partTypeInformation a bamm:Property ; - bamm:preferredName "Part Type Information"@en ; - bamm:description "The part type from which the serialized part has been instantiated"@en ; - bamm:characteristic :PartTypeInformationCharacteristic . - -:CatenaXIdTrait a bamm-c:Trait ; - bamm:preferredName "Catena-X ID Trait"@en ; - bamm:description "Trait to ensure data format for Catena-X ID"@en ; - bamm-c:baseCharacteristic :Uuidv4Characteristic ; - bamm-c:constraint :Uuidv4RegularExpression . - -:LocalIdentifierCharacteristic a bamm-c:Set ; - bamm:preferredName "Local Identifier Characteristic"@en ; - bamm:description "A single serialized part may have multiple attributes, that uniquely identify a that part in a specific dataspace (e.g. the manufacturer`s dataspace)"@en ; - bamm:dataType :KeyValueList . - -:ManufacturingCharacteristic a bamm:Characteristic ; - bamm:preferredName "Manufacturing Characteristic"@en ; - bamm:description "Characteristic to describe manufacturing related data"@en ; - bamm:dataType :ManufacturingEntity . - -:PartTypeInformationCharacteristic a bamm:Characteristic ; - bamm:preferredName "Part Type Information Characteristic"@en ; - bamm:description "The characteristics of the part type"@en ; - bamm:dataType :PartTypeInformationEntity . - -:Uuidv4Characteristic a bamm:Characteristic ; - bamm:preferredName "UUIDv4 Characteristic"@en ; - bamm:description "A version 4 UUID is a universally unique identifier that is generated using random 32 hexadecimal characters."@en ; - bamm:dataType xsd:string . - -:Uuidv4RegularExpression a bamm-c:RegularExpressionConstraint ; - bamm:preferredName "Catena-X Id Regular Expression"@en ; - bamm: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."@en ; - bamm:see ; - bamm:value "(^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}$)" . - -:KeyValueList a bamm:Entity ; - bamm:preferredName "Key Value List"@en ; - bamm:description "A list of key value pairs for local identifiers, which are composed of a key and a corresponding value."@en ; - bamm:properties ( :key :value ) . - -:ManufacturingEntity a bamm:Entity ; - bamm:preferredName "Manufacturing Entity"@en ; - bamm:description "Encapsulates the manufacturing relevant attributes"@en ; - bamm:properties ( :date [ bamm:property :country; bamm:optional true ] ) . - -:PartTypeInformationEntity a bamm:Entity ; - bamm:preferredName "Part Type Information Entity"@en ; - bamm:description "Encapsulation for data related to the part type"@en ; - bamm:properties ( :manufacturerPartId [ bamm:property :customerPartId; bamm:optional true ] :nameAtManufacturer [ bamm:property :nameAtCustomer; bamm:optional true ] :classification ) . - -:key a bamm:Property ; - bamm:preferredName "Identifier Key"@en ; - bamm:description "The key of a local identifier. "@en ; - bamm:characteristic :KeyCharacteristic ; - bamm:exampleValue "PartInstanceID" . - -:value a bamm:Property ; - bamm:preferredName "Identifier Value"@en ; - bamm:description "The value of an identifier."@en ; - bamm:characteristic :ValueCharacteristic ; - bamm:exampleValue "SN12345678" . - -:date a bamm:Property ; - bamm:preferredName "Production Date"@en ; - bamm:description "Timestamp of the manufacturing date as the final step in production process (e.g. final quality check, ready-for-shipment event)"@en ; - bamm:characteristic bamm-c:Timestamp ; - bamm:exampleValue "2022-02-04T14:48:54"^^xsd:dateTime . - -:country a bamm:Property ; - bamm:preferredName "Country code"@en ; - bamm:description "Country code where the part was manufactured"@en ; - bamm:characteristic :ProductionCountryCodeTrait ; - bamm:exampleValue "HUR" . - -:manufacturerPartId a bamm:Property ; - bamm:preferredName "Manufacturer Part ID"@en ; - bamm:description "Part ID as assigned by the manufacturer of the part. The Part ID identifies the part (as designed) in the manufacturer`s dataspace. The Part ID does not reference a specific instance of a part and thus should not be confused with the serial number."@en ; - bamm:characteristic :PartIdCharacteristic ; - bamm:exampleValue "123-0.740-3434-A" . - -:customerPartId a bamm:Property ; - bamm:preferredName "Customer Part ID"@en ; - bamm:description "Part ID as assigned by the manufacturer of the part. The Part ID identifies the part (as designed) in the customer`s dataspace. The Part ID does not reference a specific instance of a part and thus should not be confused with the serial number."@en ; - bamm:characteristic :PartIdCharacteristic ; - bamm:exampleValue "PRT-12345" . - -:nameAtManufacturer a bamm:Property ; - bamm:preferredName "Name at Manufacturer"@en ; - bamm:description "Name of the part as assigned by the manufacturer"@en ; - bamm:characteristic :PartNameCharacteristic ; - bamm:exampleValue "Mirror left" . - -:nameAtCustomer a bamm:Property ; - bamm:preferredName "Name at Customer"@en ; - bamm:description "Name of the part as assigned by the customer"@en ; - bamm:characteristic :PartNameCharacteristic ; - bamm:exampleValue "side element A" . - -:classification a bamm:Property ; - bamm:preferredName "Classifcation"@en ; - bamm:description "The classification of the part type according to STEP standard definition"@en ; - bamm:characteristic :ClassificationCharacteristic ; - bamm:exampleValue "software" . - -:KeyCharacteristic a bamm:Characteristic ; - bamm:preferredName "Key Characteristic"@en ; - bamm:description "The key characteristic of a local identifier. A specific subset of keys is predefined, but additionally any other custom key is allowed. Predefined keys (to be used when applicable):\n- \"manufacturerId\" - The Business Partner Number (BPN) of the manufacturer. Value: BPN-Nummer\n- \"partInstanceId\" - The identifier of the manufacturer for the serialized instance of the part, e.g. the serial number\n- \"batchId\" - The identifier of the batch, to which the serialzed part belongs\n- \"van\" - The anonymized vehicle identification number (VIN). Value: anonymized VIN according to OEM anonymization rules. Note: If the key \"van\" is available, \"partInstanceId\" must also be available and hold the identical value."@en ; - bamm:dataType xsd:string . - -:ValueCharacteristic a bamm:Characteristic ; - bamm:preferredName "Value Characteristic"@en ; - bamm:description "The value of an identifier."@en ; - bamm:dataType xsd:string . - -:ProductionCountryCodeTrait a bamm-c:Trait ; - bamm:preferredName "Production Country Code Trait"@en ; - bamm:description "Trait to ensure standard data format for country code"@en ; - bamm-c:baseCharacteristic :CountryCodeCharacteristic ; - bamm-c:constraint :CountryCodeRegularExpression . - -:PartIdCharacteristic a bamm:Characteristic ; - bamm:preferredName "Part ID Characteristic"@en ; - bamm:description "The part ID is a multi-character string, ususally assigned by an ERP system"@en ; - bamm:dataType xsd:string . - -:PartNameCharacteristic a bamm:Characteristic ; - bamm:preferredName "Part Name Characteristic"@en ; - bamm:description "Part Name in string format from the respective system in the value chain"@en ; - bamm:dataType xsd:string . - -:ClassificationCharacteristic a bamm-c:Enumeration ; - bamm:preferredName "Classification Characteristic"@en ; - bamm:description "A part type must be placed into one of the following classes: 'component', 'product', 'software', 'assembly', 'tool', or 'raw material'."@en ; - bamm:see ; - bamm:dataType xsd:string ; - bamm-c:values ( "product" "raw material" "software" "assembly" "tool" "component" ) . - -:CountryCodeCharacteristic a bamm:Characteristic ; - bamm:preferredName "Country Code Characteristic"@en ; - bamm:description "ISO 3166-1 alpha-3 - three-letter country codes "@en ; - bamm:see ; - bamm:dataType xsd:string . - -:CountryCodeRegularExpression a bamm-c:RegularExpressionConstraint ; - bamm:preferredName "Country Code Regular Expression"@en ; - bamm:description "Regular Expression that ensures a three-letter code "@en ; - bamm:value "^[A-Z][A-Z][A-Z]$" . - diff --git a/io.catenax.serial_part/1.0.0/gen/SerialPart-aas.xml b/io.catenax.serial_part/1.0.0/gen/SerialPart-aas.xml deleted file mode 100644 index 7947213df..000000000 --- a/io.catenax.serial_part/1.0.0/gen/SerialPart-aas.xml +++ /dev/null @@ -1,1053 +0,0 @@ - - - - - defaultAdminShell - - - en - defaultAdminShell - - - - urn:samm:io.catenax.serial_part:1.0.0#SerialPart - - Type - - - - ModelReference - - - Submodel - urn:samm:io.catenax.serial_part:1.0.0#SerialPart/submodel - - - - - - - - - SerialPart - - - en - A serialized part is an instantiation of a (design-) part, where the particular instantiation can be uniquely identified by means of a serial number or a similar identifier (e.g. VAN) or a combination of multiple identifiers (e.g. combination of manufacturer, date and number) - - - - urn:samm:io.catenax.serial_part:1.0.0#SerialPart/submodel - Template - - ModelReference - - - ConceptDescription - urn:samm:io.catenax.serial_part:1.0.0#SerialPart - - - - - - catenaXId - - - en - Catena-X ID - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.serial_part:1.0.0#catenaXId - - - - xs:string - - - - localIdentifiers - - - en - Local Identifiers - - - - - en - A local identifier enables identification of a part in a specific dataspace, but is not unique in Catena-X dataspace. Multiple local identifiers may exist. - - - true - DataElement - - - KeyValueList - - - en - Key Value List - - - - - en - A list of key value pairs for local identifiers, which are composed of a key and a corresponding value. - - - - - key - - - en - Identifier Key - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.serial_part:1.0.0#key - - - - xs:string - - - - value - - - en - Identifier Value - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.serial_part:1.0.0#value - - - - xs:string - - - - - - - - ManufacturingEntity - - - en - Manufacturing Entity - - - - - en - Encapsulates the manufacturing relevant attributes - - - - - date - - - en - Production Date - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.serial_part:1.0.0#date - - - - xs:dateTime - - - - country - - - en - Country code - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.serial_part:1.0.0#country - - - - xs:string - - - - - - PartTypeInformationEntity - - - en - Part Type Information Entity - - - - - en - Encapsulation for data related to the part type - - - - - manufacturerPartId - - - en - Manufacturer Part ID - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.serial_part:1.0.0#manufacturerPartId - - - - xs:string - - - - customerPartId - - - en - Customer Part ID - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.serial_part:1.0.0#customerPartId - - - - xs:string - - - - nameAtManufacturer - - - en - Name at Manufacturer - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.serial_part:1.0.0#nameAtManufacturer - - - - xs:string - - - - nameAtCustomer - - - en - Name at Customer - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.serial_part:1.0.0#nameAtCustomer - - - - xs:string - - - - classification - - - en - Classifcation - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.serial_part:1.0.0#classification - - - - xs:string - - - - - - - - - - APPLICATION_CLASS - SerialPart - - - en - Serial Part - - - - - en - A serialized part is an instantiation of a (design-) part, where the particular instantiation can be uniquely identified by means of a serial number or a similar identifier (e.g. VAN) or a combination of multiple identifiers (e.g. combination of manufacturer, date and number) - - - urn:samm:io.catenax.serial_part:1.0.0#SerialPart - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Serial Part - - - - - en - SerialPart - - - - - en - A serialized part is an instantiation of a (design-) part, where the particular instantiation can be uniquely identified by means of a serial number or a similar identifier (e.g. VAN) or a combination of multiple identifiers (e.g. combination of manufacturer, date and number) - - - - - - - - - catenaXId - - - en - Catena-X ID - - - urn:samm:io.catenax.serial_part:1.0.0#catenaXId - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Catena-X ID - - - - - en - catenaXId - - - STRING - - - en - The fully anonymous Catena-X ID of the serialized part, valid for the Catena-X dataspace. - - - - - - - - - key - - - en - Identifier Key - - - urn:samm:io.catenax.serial_part:1.0.0#key - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Identifier Key - - - - - en - key - - - STRING - - - en - The key of a local identifier. - - - - - - - - - value - - - en - Identifier Value - - - urn:samm:io.catenax.serial_part:1.0.0#value - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Identifier Value - - - - - en - value - - - STRING - - - en - The value of an identifier. - - - - - - - - - localIdentifiers - - - en - Local Identifiers - - - urn:samm:io.catenax.serial_part:1.0.0#localIdentifiers - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Local Identifiers - - - - - en - localIdentifiers - - - STRING - - - en - A local identifier enables identification of a part in a specific dataspace, but is not unique in Catena-X dataspace. Multiple local identifiers may exist. - - - - - - - - - date - - - en - Production Date - - - urn:samm:io.catenax.serial_part:1.0.0#date - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Production Date - - - - - en - date - - - STRING - - - en - Timestamp of the manufacturing date as the final step in production process (e.g. final quality check, ready-for-shipment event) - - - - - - - - - country - - - en - Country code - - - urn:samm:io.catenax.serial_part:1.0.0#country - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Country code - - - - - en - country - - - STRING - - - en - Country code where the part was manufactured - - - - - - - - - manufacturingInformation - - - en - Manufacturing Information - - - urn:samm:io.catenax.serial_part:1.0.0#manufacturingInformation - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Manufacturing Information - - - - - en - manufacturingInformation - - - STRING - - - en - Information from manufacturing process, such as manufacturing date and manufacturing country - - - - - - - - - manufacturerPartId - - - en - Manufacturer Part ID - - - urn:samm:io.catenax.serial_part:1.0.0#manufacturerPartId - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Manufacturer Part ID - - - - - en - manufacturerPartId - - - STRING - - - en - Part ID as assigned by the manufacturer of the part. The Part ID identifies the part (as designed) in the manufacturer`s dataspace. The Part ID does not reference a specific instance of a part and thus should not be confused with the serial number. - - - - - - - - - customerPartId - - - en - Customer Part ID - - - urn:samm:io.catenax.serial_part:1.0.0#customerPartId - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Customer Part ID - - - - - en - customerPartId - - - STRING - - - en - Part ID as assigned by the manufacturer of the part. The Part ID identifies the part (as designed) in the customer`s dataspace. The Part ID does not reference a specific instance of a part and thus should not be confused with the serial number. - - - - - - - - - nameAtManufacturer - - - en - Name at Manufacturer - - - urn:samm:io.catenax.serial_part:1.0.0#nameAtManufacturer - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Name at Manufacturer - - - - - en - nameAtManufacturer - - - STRING - - - en - Name of the part as assigned by the manufacturer - - - - - - - - - nameAtCustomer - - - en - Name at Customer - - - urn:samm:io.catenax.serial_part:1.0.0#nameAtCustomer - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Name at Customer - - - - - en - nameAtCustomer - - - STRING - - - en - Name of the part as assigned by the customer - - - - - - - - - classification - - - en - Classifcation - - - urn:samm:io.catenax.serial_part:1.0.0#classification - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Classifcation - - - - - en - classification - - - STRING - - - en - The classification of the part type according to STEP standard definition - - - - - - product - - ModelReference - - - DataElement - urn:samm:io.catenax.serial_part:1.0.0#ClassificationCharacteristic:product - - - - - - raw material - - ModelReference - - - DataElement - urn:samm:io.catenax.serial_part:1.0.0#ClassificationCharacteristic:raw material - - - - - - software - - ModelReference - - - DataElement - urn:samm:io.catenax.serial_part:1.0.0#ClassificationCharacteristic:software - - - - - - assembly - - ModelReference - - - DataElement - urn:samm:io.catenax.serial_part:1.0.0#ClassificationCharacteristic:assembly - - - - - - tool - - ModelReference - - - DataElement - urn:samm:io.catenax.serial_part:1.0.0#ClassificationCharacteristic:tool - - - - - - component - - ModelReference - - - DataElement - urn:samm:io.catenax.serial_part:1.0.0#ClassificationCharacteristic:component - - - - - - - - - - - - - partTypeInformation - - - en - Part Type Information - - - urn:samm:io.catenax.serial_part:1.0.0#partTypeInformation - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Part Type Information - - - - - en - partTypeInformation - - - STRING - - - en - The part type from which the serialized part has been instantiated - - - - - - - - - diff --git a/io.catenax.serial_part/1.0.0/gen/SerialPart-schema.json b/io.catenax.serial_part/1.0.0/gen/SerialPart-schema.json deleted file mode 100644 index e580c74d1..000000000 --- a/io.catenax.serial_part/1.0.0/gen/SerialPart-schema.json +++ /dev/null @@ -1,129 +0,0 @@ -{ - "$schema" : "http://json-schema.org/draft-04/schema", - "description" : "A serialized part is an instantiation of a (design-) part, where the particular instantiation can be uniquely identified by means of a serial number or a similar identifier (e.g. VAN) or a combination of multiple identifiers (e.g. combination of manufacturer, date and number)", - "type" : "object", - "components" : { - "schemas" : { - "urn_bamm_io.catenax.serial_part_1.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" : "(^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_bamm_io.catenax.serial_part_1.0.0_KeyCharacteristic" : { - "type" : "string", - "description" : "The key characteristic of a local identifier. A specific subset of keys is predefined, but additionally any other custom key is allowed. Predefined keys (to be used when applicable):\n- \"manufacturerId\" - The Business Partner Number (BPN) of the manufacturer. Value: BPN-Nummer\n- \"partInstanceId\" - The identifier of the manufacturer for the serialized instance of the part, e.g. the serial number\n- \"batchId\" - The identifier of the batch, to which the serialzed part belongs\n- \"van\" - The anonymized vehicle identification number (VIN). Value: anonymized VIN according to OEM anonymization rules. Note: If the key \"van\" is available, \"partInstanceId\" must also be available and hold the identical value." - }, - "urn_bamm_io.catenax.serial_part_1.0.0_ValueCharacteristic" : { - "type" : "string", - "description" : "The value of an identifier." - }, - "urn_bamm_io.catenax.serial_part_1.0.0_KeyValueList" : { - "description" : "A list of key value pairs for local identifiers, which are composed of a key and a corresponding value.", - "type" : "object", - "properties" : { - "key" : { - "description" : "The key of a local identifier. ", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.serial_part_1.0.0_KeyCharacteristic" - }, - "value" : { - "description" : "The value of an identifier.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.serial_part_1.0.0_ValueCharacteristic" - } - }, - "required" : [ "key", "value" ] - }, - "urn_bamm_io.catenax.serial_part_1.0.0_LocalIdentifierCharacteristic" : { - "description" : "A single serialized part may have multiple attributes, that uniquely identify a that part in a specific dataspace (e.g. the manufacturer`s dataspace)", - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/urn_bamm_io.catenax.serial_part_1.0.0_KeyValueList" - }, - "uniqueItems" : true - }, - "urn_bamm_io.openmanufacturing_characteristic_2.0.0_Timestamp" : { - "type" : "string", - "pattern" : "-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T(([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](\\.[0-9]+)?|(24:00:00(\\.0+)?))(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?", - "description" : "Describes a Property which contains the date and time with an optional timezone." - }, - "urn_bamm_io.catenax.serial_part_1.0.0_ProductionCountryCodeTrait" : { - "type" : "string", - "description" : "Regular Expression that ensures a three-letter code ", - "pattern" : "^[A-Z][A-Z][A-Z]$" - }, - "urn_bamm_io.catenax.serial_part_1.0.0_ManufacturingCharacteristic" : { - "description" : "Characteristic to describe manufacturing related data", - "type" : "object", - "properties" : { - "date" : { - "description" : "Timestamp of the manufacturing date as the final step in production process (e.g. final quality check, ready-for-shipment event)", - "$ref" : "#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Timestamp" - }, - "country" : { - "description" : "Country code where the part was manufactured", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.serial_part_1.0.0_ProductionCountryCodeTrait" - } - }, - "required" : [ "date" ] - }, - "urn_bamm_io.catenax.serial_part_1.0.0_PartIdCharacteristic" : { - "type" : "string", - "description" : "The part ID is a multi-character string, ususally assigned by an ERP system" - }, - "urn_bamm_io.catenax.serial_part_1.0.0_PartNameCharacteristic" : { - "type" : "string", - "description" : "Part Name in string format from the respective system in the value chain" - }, - "urn_bamm_io.catenax.serial_part_1.0.0_ClassificationCharacteristic" : { - "type" : "string", - "description" : "A part type must be placed into one of the following classes: 'component', 'product', 'software', 'assembly', 'tool', or 'raw material'.", - "enum" : [ "product", "raw material", "software", "assembly", "tool", "component" ] - }, - "urn_bamm_io.catenax.serial_part_1.0.0_PartTypeInformationCharacteristic" : { - "description" : "The characteristics of the part type", - "type" : "object", - "properties" : { - "manufacturerPartId" : { - "description" : "Part ID as assigned by the manufacturer of the part. The Part ID identifies the part (as designed) in the manufacturer`s dataspace. The Part ID does not reference a specific instance of a part and thus should not be confused with the serial number.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.serial_part_1.0.0_PartIdCharacteristic" - }, - "customerPartId" : { - "description" : "Part ID as assigned by the manufacturer of the part. The Part ID identifies the part (as designed) in the customer`s dataspace. The Part ID does not reference a specific instance of a part and thus should not be confused with the serial number.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.serial_part_1.0.0_PartIdCharacteristic" - }, - "nameAtManufacturer" : { - "description" : "Name of the part as assigned by the manufacturer", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.serial_part_1.0.0_PartNameCharacteristic" - }, - "nameAtCustomer" : { - "description" : "Name of the part as assigned by the customer", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.serial_part_1.0.0_PartNameCharacteristic" - }, - "classification" : { - "description" : "The classification of the part type according to STEP standard definition", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.serial_part_1.0.0_ClassificationCharacteristic" - } - }, - "required" : [ "manufacturerPartId", "nameAtManufacturer", "classification" ] - } - } - }, - "properties" : { - "catenaXId" : { - "description" : "The fully anonymous Catena-X ID of the serialized part, valid for the Catena-X dataspace.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.serial_part_1.0.0_CatenaXIdTrait" - }, - "localIdentifiers" : { - "description" : "A local identifier enables identification of a part in a specific dataspace, but is not unique in Catena-X dataspace. Multiple local identifiers may exist.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.serial_part_1.0.0_LocalIdentifierCharacteristic" - }, - "manufacturingInformation" : { - "description" : "Information from manufacturing process, such as manufacturing date and manufacturing country", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.serial_part_1.0.0_ManufacturingCharacteristic" - }, - "partTypeInformation" : { - "description" : "The part type from which the serialized part has been instantiated", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.serial_part_1.0.0_PartTypeInformationCharacteristic" - } - }, - "required" : [ "catenaXId", "localIdentifiers", "manufacturingInformation", "partTypeInformation" ] -} \ No newline at end of file diff --git a/io.catenax.serial_part/1.0.0/gen/SerialPart.aasx b/io.catenax.serial_part/1.0.0/gen/SerialPart.aasx deleted file mode 100644 index d76e08a33..000000000 Binary files a/io.catenax.serial_part/1.0.0/gen/SerialPart.aasx and /dev/null differ diff --git a/io.catenax.serial_part/1.0.0/gen/SerialPart.html b/io.catenax.serial_part/1.0.0/gen/SerialPart.html deleted file mode 100644 index 823ed5bfa..000000000 --- a/io.catenax.serial_part/1.0.0/gen/SerialPart.html +++ /dev/null @@ -1,1152 +0,0 @@ - - - - - - - - - - - - - - Dokumentation Serial Part - - -
-
-
-
-

Aspect Model Serial Part

-
urn:bamm:io.catenax.serial_part:1.0.0#SerialPart
-
-
-
-
-
-
-
- -
- - -
- A serialized part is an instantiation of a (design-) part, where the particular instantiation can be uniquely identified by means of a serial number or a similar identifier (e.g. VAN) or a combination of multiple identifiers (e.g. combination of manufacturer, date and number) -
- - -
-

Übersicht

-
-
-
-
- Aspect Model Diagram -
-
-
- - -
-
-

Properties

-
- -
- -
-

Catena-X ID

-
- -The fully anonymous Catena-X ID of the serialized part, valid for the Catena-X dataspace. - -
-
Name
-
catenaXId
-
- - - -
-
Characteristic
-
-
-
-
Trait
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Beispiel
-
urn:uuid:580d3adf-1981-44a0-a214-13d6ceed9379
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
catenaXId
-
- - -
-
Bedingungen
-
-
    -
  • -
    - -
    - Catena-X Id Regular Expression -
    - -
    -
    Beschreibung
    -
    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.
    -
    - -
    -
    Referenz
    -
    -
    -
      -
    • https://datatracker.ietf.org/doc/html/rfc4122
      • -
    -
    -
    -
    - -
    -
    Regulärer Ausdruck
    -
    (^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}$)
    -
    - -
    • -
-
-
-
-
- -
-

Local Identifiers

-
- -A local identifier enables identification of a part in a specific dataspace, but is not unique in Catena-X dataspace. Multiple local identifiers may exist. - -
-
Name
-
localIdentifiers
-
- - - -
-
Characteristic
-
-
-
-
Set
-
-
-
Has no order
-
-
-
Duplicates not allowed
-
-
-
- Typ urn:bamm:io.catenax.serial_part:1.0.0#KeyValueList - -
-
-
-
-
- - -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
localIdentifiers
-
- - -
-
- -
-

Manufacturing Information

-
- -Information from manufacturing process, such as manufacturing date and manufacturing country - -
-
Name
-
manufacturingInformation
-
- - - -
-
Characteristic
-
-
-
-
SingleEntity
-
-
-
- Typ urn:bamm:io.catenax.serial_part:1.0.0#ManufacturingEntity - -
-
-
-
-
- - -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
manufacturingInformation
-
- - -
-
- -
-

Part Type Information

-
- -The part type from which the serialized part has been instantiated - -
-
Name
-
partTypeInformation
-
- - - -
-
Characteristic
-
-
-
-
SingleEntity
-
-
-
- Typ urn:bamm:io.catenax.serial_part:1.0.0#PartTypeInformationEntity - -
-
-
-
-
- - -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
partTypeInformation
-
- - -
-
- - - -
-
-

Objekt

-
- -
-
-

Key Value List

-
-
- A list of key value pairs for local identifiers, which are composed of a key and a corresponding value. -
- -
-

Properties

-
-
- -
-
Identifier Key
-
- -The key of a local identifier. - -
-
Name
-
key
-
- - - -
-
Characteristic
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Beispiel
-
PartInstanceID
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
key
-
- - -
-
- -
-
Identifier Value
-
- -The value of an identifier. - -
-
Name
-
value
-
- - - -
-
Characteristic
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Beispiel
-
SN12345678
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
value
-
- - -
-
-
-
-

Manufacturing Entity

-
-
- Encapsulates the manufacturing relevant attributes -
- -
-

Properties

-
-
- -
-
Production Date
-
- -Timestamp of the manufacturing date as the final step in production process (e.g. final quality check, ready-for-shipment event) - -
-
Name
-
date
-
- - - -
-
Characteristic
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#dateTime - -
-
-
-
-
- -
-
Beispiel
-
2022-02-04T14:48:54
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
date
-
- - -
-
- -
-
Country code
-
- -Country code where the part was manufactured - -
-
Name
-
country
-
- - - -
-
Characteristic
-
-
-
-
Trait
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Beispiel
-
HUR
-
- -
-
Optional
-
- Ja
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
country
-
- - -
-
Bedingungen
-
-
    -
  • -
    - -
    - Country Code Regular Expression -
    - -
    -
    Beschreibung
    -
    Regular Expression that ensures a three-letter code
    -
    - - -
    -
    Regulärer Ausdruck
    -
    ^[A-Z][A-Z][A-Z]$
    -
    - -
    • -
-
-
-
-
-
-
-

Part Type Information Entity

-
-
- Encapsulation for data related to the part type -
- -
-

Properties

-
-
- -
-
Manufacturer Part ID
-
- -Part ID as assigned by the manufacturer of the part. The Part ID identifies the part (as designed) in the manufacturer`s dataspace. The Part ID does not reference a specific instance of a part and thus should not be confused with the serial number. - -
-
Name
-
manufacturerPartId
-
- - - -
-
Characteristic
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Beispiel
-
123-0.740-3434-A
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
manufacturerPartId
-
- - -
-
- -
-
Customer Part ID
-
- -Part ID as assigned by the manufacturer of the part. The Part ID identifies the part (as designed) in the customer`s dataspace. The Part ID does not reference a specific instance of a part and thus should not be confused with the serial number. - -
-
Name
-
customerPartId
-
- - - -
-
Characteristic
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Beispiel
-
PRT-12345
-
- -
-
Optional
-
- Ja
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
customerPartId
-
- - -
-
- -
-
Name at Manufacturer
-
- -Name of the part as assigned by the manufacturer - -
-
Name
-
nameAtManufacturer
-
- - - -
-
Characteristic
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Beispiel
-
Mirror left
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
nameAtManufacturer
-
- - -
-
- -
-
Name at Customer
-
- -Name of the part as assigned by the customer - -
-
Name
-
nameAtCustomer
-
- - - -
-
Characteristic
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Beispiel
-
side element A
-
- -
-
Optional
-
- Ja
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
nameAtCustomer
-
- - -
-
- -
-
Classifcation
-
- -The classification of the part type according to STEP standard definition - -
-
Name
-
classification
-
- - - -
-
Characteristic
-
-
-
-
Enumeration
-
-
-
Werte
-
-
-
-
    -
  • product
    • -
  • raw material
    • -
  • software
    • -
  • assembly
    • -
  • tool
    • -
  • component
    • -
-
-
-
-
- Referenz -
-
    -
  • https://www.iso.org/standard/84667.html
    • -
-
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Beispiel
-
software
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
classification
-
- - -
-
-
- -
- Third party licenses - -
- -
- - -
- - - \ No newline at end of file diff --git a/io.catenax.serial_part/1.0.0/gen/SerialPart.json b/io.catenax.serial_part/1.0.0/gen/SerialPart.json deleted file mode 100644 index 200d12e3e..000000000 --- a/io.catenax.serial_part/1.0.0/gen/SerialPart.json +++ /dev/null @@ -1,18 +0,0 @@ -{ - "localIdentifiers" : [ { - "value" : "SN12345678", - "key" : "PartInstanceID" - } ], - "manufacturingInformation" : { - "date" : "2022-02-04T14:48:54", - "country" : "HUR" - }, - "catenaXId" : "urn:uuid:580d3adf-1981-44a0-a214-13d6ceed9379", - "partTypeInformation" : { - "manufacturerPartId" : "123-0.740-3434-A", - "customerPartId" : "PRT-12345", - "classification" : "product", - "nameAtManufacturer" : "Mirror left", - "nameAtCustomer" : "side element A" - } -} \ No newline at end of file diff --git a/io.catenax.serial_part/1.0.0/gen/SerialPart.yml b/io.catenax.serial_part/1.0.0/gen/SerialPart.yml deleted file mode 100644 index 97178b210..000000000 --- a/io.catenax.serial_part/1.0.0/gen/SerialPart.yml +++ /dev/null @@ -1,262 +0,0 @@ ---- -openapi: 3.0.3 -info: - title: Serial Part - version: v1 -servers: -- url: catenax.io/api/v1 - variables: - api-version: - default: v1 -paths: - /{tenant-id}/serial-part: - get: - tags: - - SerialPart - operationId: getSerialPart - 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/SerialPart' - "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/SerialPart' - totalItems: - type: number - totalPages: - type: number - pageSize: - type: number - currentPage: - type: number - urn_bamm_io.catenax.serial_part_1.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: "(^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_bamm_io.catenax.serial_part_1.0.0_KeyCharacteristic: - type: string - description: |- - The key characteristic of a local identifier. A specific subset of keys is predefined, but additionally any other custom key is allowed. Predefined keys (to be used when applicable): - - "manufacturerId" - The Business Partner Number (BPN) of the manufacturer. Value: BPN-Nummer - - "partInstanceId" - The identifier of the manufacturer for the serialized instance of the part, e.g. the serial number - - "batchId" - The identifier of the batch, to which the serialzed part belongs - - "van" - The anonymized vehicle identification number (VIN). Value: anonymized VIN according to OEM anonymization rules. Note: If the key "van" is available, "partInstanceId" must also be available and hold the identical value. - urn_bamm_io.catenax.serial_part_1.0.0_ValueCharacteristic: - type: string - description: The value of an identifier. - urn_bamm_io.catenax.serial_part_1.0.0_KeyValueList: - description: "A list of key value pairs for local identifiers, which are composed\ - \ of a key and a corresponding value." - type: object - properties: - key: - description: 'The key of a local identifier. ' - $ref: '#/components/schemas/urn_bamm_io.catenax.serial_part_1.0.0_KeyCharacteristic' - value: - description: The value of an identifier. - $ref: '#/components/schemas/urn_bamm_io.catenax.serial_part_1.0.0_ValueCharacteristic' - required: - - key - - value - urn_bamm_io.catenax.serial_part_1.0.0_LocalIdentifierCharacteristic: - description: "A single serialized part may have multiple attributes, that uniquely\ - \ identify a that part in a specific dataspace (e.g. the manufacturer`s dataspace)" - type: array - items: - $ref: '#/components/schemas/urn_bamm_io.catenax.serial_part_1.0.0_KeyValueList' - uniqueItems: true - urn_bamm_io.openmanufacturing_characteristic_2.0.0_Timestamp: - type: string - pattern: "-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T(([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](\\\ - .[0-9]+)?|(24:00:00(\\.0+)?))(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?" - description: Describes a Property which contains the date and time with an optional - timezone. - urn_bamm_io.catenax.serial_part_1.0.0_ProductionCountryCodeTrait: - type: string - description: 'Regular Expression that ensures a three-letter code ' - pattern: "^[A-Z][A-Z][A-Z]$" - urn_bamm_io.catenax.serial_part_1.0.0_ManufacturingCharacteristic: - description: Characteristic to describe manufacturing related data - type: object - properties: - date: - description: "Timestamp of the manufacturing date as the final step in production\ - \ process (e.g. final quality check, ready-for-shipment event)" - $ref: '#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Timestamp' - country: - description: Country code where the part was manufactured - $ref: '#/components/schemas/urn_bamm_io.catenax.serial_part_1.0.0_ProductionCountryCodeTrait' - required: - - date - urn_bamm_io.catenax.serial_part_1.0.0_PartIdCharacteristic: - type: string - description: "The part ID is a multi-character string, ususally assigned by\ - \ an ERP system" - urn_bamm_io.catenax.serial_part_1.0.0_PartNameCharacteristic: - type: string - description: Part Name in string format from the respective system in the value - chain - urn_bamm_io.catenax.serial_part_1.0.0_ClassificationCharacteristic: - type: string - description: "A part type must be placed into one of the following classes:\ - \ 'component', 'product', 'software', 'assembly', 'tool', or 'raw material'." - enum: - - product - - raw material - - software - - assembly - - tool - - component - urn_bamm_io.catenax.serial_part_1.0.0_PartTypeInformationCharacteristic: - description: The characteristics of the part type - type: object - properties: - manufacturerPartId: - description: Part ID as assigned by the manufacturer of the part. The Part - ID identifies the part (as designed) in the manufacturer`s dataspace. - The Part ID does not reference a specific instance of a part and thus - should not be confused with the serial number. - $ref: '#/components/schemas/urn_bamm_io.catenax.serial_part_1.0.0_PartIdCharacteristic' - customerPartId: - description: Part ID as assigned by the manufacturer of the part. The Part - ID identifies the part (as designed) in the customer`s dataspace. The - Part ID does not reference a specific instance of a part and thus should - not be confused with the serial number. - $ref: '#/components/schemas/urn_bamm_io.catenax.serial_part_1.0.0_PartIdCharacteristic' - nameAtManufacturer: - description: Name of the part as assigned by the manufacturer - $ref: '#/components/schemas/urn_bamm_io.catenax.serial_part_1.0.0_PartNameCharacteristic' - nameAtCustomer: - description: Name of the part as assigned by the customer - $ref: '#/components/schemas/urn_bamm_io.catenax.serial_part_1.0.0_PartNameCharacteristic' - classification: - description: The classification of the part type according to STEP standard - definition - $ref: '#/components/schemas/urn_bamm_io.catenax.serial_part_1.0.0_ClassificationCharacteristic' - required: - - manufacturerPartId - - nameAtManufacturer - - classification - SerialPart: - description: "A serialized part is an instantiation of a (design-) part, where\ - \ the particular instantiation can be uniquely identified by means of a serial\ - \ number or a similar identifier (e.g. VAN) or a combination of multiple identifiers\ - \ (e.g. combination of manufacturer, date and number)" - type: object - properties: - catenaXId: - description: "The fully anonymous Catena-X ID of the serialized part, valid\ - \ for the Catena-X dataspace." - $ref: '#/components/schemas/urn_bamm_io.catenax.serial_part_1.0.0_CatenaXIdTrait' - localIdentifiers: - description: "A local identifier enables identification of a part in a specific\ - \ dataspace, but is not unique in Catena-X dataspace. Multiple local identifiers\ - \ may exist." - $ref: '#/components/schemas/urn_bamm_io.catenax.serial_part_1.0.0_LocalIdentifierCharacteristic' - manufacturingInformation: - description: "Information from manufacturing process, such as manufacturing\ - \ date and manufacturing country" - $ref: '#/components/schemas/urn_bamm_io.catenax.serial_part_1.0.0_ManufacturingCharacteristic' - partTypeInformation: - description: The part type from which the serialized part has been instantiated - $ref: '#/components/schemas/urn_bamm_io.catenax.serial_part_1.0.0_PartTypeInformationCharacteristic' - required: - - catenaXId - - localIdentifiers - - manufacturingInformation - - partTypeInformation - 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' - SerialPart: - content: - application/json: - schema: - $ref: '#/components/schemas/PagingSchema' - description: The request was successful. - requestBodies: - SerialPart: - content: - application/json: - schema: - $ref: '#/components/schemas/SerialPart' diff --git a/io.catenax.serial_part/1.0.0/metadata.json b/io.catenax.serial_part/1.0.0/metadata.json deleted file mode 100644 index 9e759dfb1..000000000 --- a/io.catenax.serial_part/1.0.0/metadata.json +++ /dev/null @@ -1 +0,0 @@ -{ "status" : "deprecate"} diff --git a/io.catenax.serial_part_typization/1.1.1/SerialPartTypization.ttl b/io.catenax.serial_part_typization/1.1.1/SerialPartTypization.ttl deleted file mode 100644 index b47022652..000000000 --- a/io.catenax.serial_part_typization/1.1.1/SerialPartTypization.ttl +++ /dev/null @@ -1,213 +0,0 @@ -####################################################################### -# Copyright (c) 2022 BASF SE -# Copyright (c) 2022 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) -# Copyright (c) 2022 Fraunhofer-Gesellschaft zur Foerderung der angewandten Forschung e.V. (represented by Fraunhofer ISST & Fraunhofer IML) -# Copyright (c) 2022 German Edge Cloud GmbH & Co. KG -# Copyright (c) 2022 Henkel AG & Co. KGaA -# Copyright (c) 2022 Mercedes Benz AG -# Copyright (c) 2022 Robert Bosch Manufacturing Solutions GmbH -# Copyright (c) 2022 SAP SE -# Copyright (c) 2022 Siemens AG -# Copyright (c) 2022 T-Systems International GmbH -# Copyright (c) 2022 ZF Friedrichshafen AG -# Copyright (c) 2022 Contributors to the Eclipse Foundation -# -# 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 xsd: . -@prefix bamm: . -@prefix unit: . -@prefix bamm-c: . -@prefix bamm-e: . -@prefix : . - -:ProductionCountryCodeTrait a bamm-c:Trait; - bamm:name "ProductionCountryCodeTrait"; - bamm:preferredName "Production Country Code Trait"@en; - bamm:description "Trait to ensure standard data format for country code"@en; - bamm-c:constraint :CountryCodeRegularExpression; - bamm-c:baseCharacteristic :CountryCodeCharacteristic. -:CountryCodeRegularExpression a bamm-c:RegularExpressionConstraint; - bamm:name "CountryCodeRegularExpression"; - bamm:preferredName "Country Code Regular Expression"@en; - bamm:description "Regular Expression that ensures a three-letter code "@en; - bamm:value "^[A-Z][A-Z][A-Z]$". -:CountryCodeCharacteristic a bamm:Characteristic; - bamm:name "CountryCodeCharacteristic"; - bamm:preferredName "Country Code Characteristic"@en; - bamm:description "ISO 3166-1 alpha-3 – three-letter country codes "@en; - bamm:dataType xsd:string; - bamm:see . -:UUIDv4RegularExpression a bamm-c:RegularExpressionConstraint; - bamm:name "UUIDv4RegularExpression"; - bamm:preferredName "Catena-X Id Regular Expression"@en; - bamm: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."@en; - bamm:value "(^[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}$)"; - bamm:see . -:UUIDv4 a bamm:Characteristic; - bamm:name "UUIDv4"; - bamm:preferredName "UUIDv4"@en; - bamm:description "A version 4 UUID is a universally unique identifier that is generated using random 32 hexadecimal characters."@en; - bamm:dataType xsd:string. -:KeyValueList a bamm:Entity; - bamm:name "KeyValueList"; - bamm:preferredName "Key Value List"@en; - bamm:description "A list of key value pairs for local identifiers, which are composed of a key and a corresponding value."@en; - bamm:properties (:key :value). -:key a bamm:Property; - bamm:name "key"; - bamm:preferredName "Identifier Key"@en; - bamm:description "The key of a local identifier. "@en; - bamm:characteristic :KeyCharacteristic; - bamm:exampleValue "PartInstanceID". -:value a bamm:Property; - bamm:name "value"; - bamm:preferredName "Identifier Value"@en; - bamm:description "The value of an identifier."@en; - bamm:characteristic :ValueCharacteristic; - bamm:exampleValue "SN12345678". -:KeyCharacteristic a bamm:Characteristic; - bamm:name "KeyCharacteristic"; - bamm:preferredName "Key Characteristic"@en; - bamm:description "The key characteristic of a local identifier. A specific subset of keys is predefined, but additionally any other custom key is allowed. Predefined keys (to be used when applicable):\n- \"manufacturerId\" - The Business Partner Number (BPN) of the manufacturer. Value: BPN-Nummer\n- \"partInstanceId\" - The identifier of the manufacturer for the serialized instance of the part, e.g. the serial number\n- \"batchId\" - The identifier of the batch, to which the serialzed part belongs\n- \"van\" - The anonymized vehicle identification number (VIN). Value: anonymized VIN according to OEM anonymization rules. Note: If the key \"van\" is available, \"partInstanceId\" must also be available and hold the identical value."@en; - bamm:dataType xsd:string. -:ValueCharacteristic a bamm:Characteristic; - bamm:name "ValueCharacteristic"; - bamm:preferredName "Value Characteristic"@en; - bamm:description "The value of an identifier."@en; - bamm:dataType xsd:string. -:SerialPartTypization a bamm:Aspect; - bamm:name "SerialPartTypization"; - bamm:preferredName "Serial Part Typization"@en; - bamm:description "A serialized part is an instantiation of a (design-) part, where the particular instantiation can be uniquely identified by means of a serial numbers or a similar identifier (e.g. VAN) or a combination of multiple identifiers (e.g. combination of manufacturer, date and number)"@en; - bamm:properties (:catenaXId :localIdentifiers :manufacturingInformation :partTypeInformation); - bamm:operations (). -:catenaXId a bamm:Property; - bamm:name "catenaXId"; - bamm:preferredName "Catena-X Identifier"@en; - bamm:description "The fully anonymous Catena-X ID of the serialized part, valid for the Catena-X dataspace."@en; - bamm:characteristic :CatenaXIdTrait; - bamm:exampleValue "urn:uuid:580d3adf-1981-44a0-a214-13d6ceed9379". -:localIdentifiers a bamm:Property; - bamm:name "localIdentifiers"; - bamm:preferredName "Local Identifiers"@en; - bamm:description "A local identifier enables identification of a part in a specific dataspace, but is not unique in Catena-X dataspace. Multiple local identifiers may exist."@en; - bamm:characteristic :LocalIdentifierCharacteristic. -:manufacturingInformation a bamm:Property; - bamm:name "manufacturingInformation"; - bamm:preferredName "Manufacturing Information"@en; - bamm:description "Information from manufacturing process, such as manufacturing date and manufacturing country"@en; - bamm:characteristic :ManufacturingCharacteristic. -:partTypeInformation a bamm:Property; - bamm:name "partTypeInformation"; - bamm:preferredName "Part Type Information"@en; - bamm:description "The part type from which the serialized part has been instantiated"@en; - bamm:characteristic :PartTypeInformationCharacteristic. -:CatenaXIdTrait a bamm-c:Trait; - bamm:name "CatenaXIdTrait"; - bamm:preferredName "Catena-X ID Trait"@en; - bamm:description "Trait to ensure data format for Catena-X ID"@en; - bamm-c:constraint :UUIDv4RegularExpression; - bamm-c:baseCharacteristic :UUIDv4. -:LocalIdentifierCharacteristic a bamm-c:Set; - bamm:name "LocalIdentifierCharacteristic"; - bamm:preferredName "Local Identifier Characteristic"@en; - bamm:description "A single serialized part may have multiple attributes, that uniquely identify a that part in a specific dataspace (e.g. the manufacturer`s dataspace)"@en; - bamm:dataType :KeyValueList. -:ManufacturingCharacteristic a bamm:Characteristic; - bamm:name "ManufacturingCharacteristic"; - bamm:preferredName "Manufacturing Characteristic"@en; - bamm:description "Characteristic to describe manufacturing related data"@en; - bamm:dataType :ManufacturingEntity. -:PartTypeInformationCharacteristic a bamm:Characteristic; - bamm:name "PartTypeInformationCharacteristic"; - bamm:preferredName "Part Type Information Characteristic"@en; - bamm:description "The characteristics of the part type"@en; - bamm:dataType :PartTypeInformationEntity. -:nameAtManufacturer a bamm:Property; - bamm:name "nameAtManufacturer"; - bamm:preferredName "Name at Manufacturer"@en; - bamm:description "Name of the part as assigned by the manufacturer"@en; - bamm:characteristic :PartNameCharacteristic; - bamm:exampleValue "Mirror left". -:PartNameCharacteristic a bamm:Characteristic; - bamm:name "PartNameCharacteristic"; - bamm:preferredName "Part Name Characteristic"@en; - bamm:description "Part Name in string format from the respective system in the value chain"@en; - bamm:dataType xsd:string. -:nameAtCustomer a bamm:Property; - bamm:name "nameAtCustomer"; - bamm:preferredName "Name at Customer"@en; - bamm:description "Name of the part as assigned by the customer"@en; - bamm:characteristic :PartNameCharacteristic; - bamm:exampleValue "side element A". -:date a bamm:Property; - bamm:name "date"; - bamm:preferredName "Production Date"@en; - bamm:description "Timestamp of the manufacturing date as the final step in production process (e.g. final quality check, ready-for-shipment event)"@en; - bamm:characteristic bamm-c:Timestamp; - bamm:exampleValue "2022-02-04T14:48:54"^^xsd:dateTime. -:country a bamm:Property; - bamm:name "country"; - bamm:preferredName "Country code"@en; - bamm:description "Country code where the part was manufactured"@en; - bamm:characteristic :ProductionCountryCodeTrait; - bamm:exampleValue "HUR". -:PartTypeInformationEntity a bamm:Entity; - bamm:name "PartTypeInformationEntity"; - bamm:preferredName "Part Type Information Entity"@en; - bamm:description "Encapsulation for data related to the part type"@en; - bamm:properties (:manufacturerPartId [ - bamm:property :customerPartId; - bamm:optional "true"^^xsd:boolean -] :nameAtManufacturer [ - bamm:property :nameAtCustomer; - bamm:optional "true"^^xsd:boolean -] :classification). -:PartIdCharacteristic a bamm:Characteristic; - bamm:name "PartIdCharacteristic"; - bamm:preferredName "Part ID Characteristic"@en; - bamm:description "The part ID is a multi-character string, ususally assigned by an ERP system"@en; - bamm:dataType xsd:string. -:manufacturerPartId a bamm:Property; - bamm:name "manufacturerPartId"; - bamm:preferredName "Manufacturer Part ID"@en; - bamm:description "Part ID as assigned by the manufacturer of the part. The Part ID identifies the part (as designed) in the manufacturer`s dataspace. The Part ID does not reference a specific instance of a part and thus should not be confused with the serial number."@en; - bamm:characteristic :PartIdCharacteristic; - bamm:exampleValue "123-0.740-3434-A". -:customerPartId a bamm:Property; - bamm:name "customerPartId"; - bamm:preferredName "Customer Part ID"@en; - bamm:description "Part ID as assigned by the manufacturer of the part. The Part ID identifies the part (as designed) in the customer`s dataspace. The Part ID does not reference a specific instance of a part and thus should not be confused with the serial number."@en; - bamm:characteristic :PartIdCharacteristic; - bamm:exampleValue "PRT-12345". -:classification a bamm:Property; - bamm:name "classification"; - bamm:preferredName "Classifcation"@en; - bamm:description "The classification of the part type according to STEP standard definition"@en; - bamm:characteristic :ClassificationCharacteristic; - bamm:exampleValue "software". -:ClassificationCharacteristic a bamm-c:Enumeration; - bamm:name "ClassificationCharacteristic"; - bamm:preferredName "Classification Characteristic"@en; - bamm:description "A part type must be placed into one of the following classes: 'component', 'product', 'software', ‘assembly’, 'tool', or 'raw material'."@en; - bamm:dataType xsd:string; - bamm:see ; - bamm-c:values ("product" "raw material" "software" "assembly" "tool" "component"). -:ManufacturingEntity a bamm:Entity; - bamm:name "ManufacturingEntity"; - bamm:preferredName "Manufacturing Entity"@en; - bamm:description "Encapsulates the manufacturing relevant attributes"@en; - bamm:properties (:date [ - bamm:property :country; - bamm:optional "true"^^xsd:boolean -]). diff --git a/io.catenax.serial_part_typization/1.1.1/gen/SerialPartTypization-aas.xml b/io.catenax.serial_part_typization/1.1.1/gen/SerialPartTypization-aas.xml deleted file mode 100644 index 92f902103..000000000 --- a/io.catenax.serial_part_typization/1.1.1/gen/SerialPartTypization-aas.xml +++ /dev/null @@ -1,1053 +0,0 @@ - - - - - defaultAdminShell - - - en - defaultAdminShell - - - - urn:samm:io.catenax.serial_part_typization:1.1.1#SerialPartTypization - - Type - - - - ModelReference - - - Submodel - urn:samm:io.catenax.serial_part_typization:1.1.1#SerialPartTypization/submodel - - - - - - - - - SerialPartTypization - - - en - A serialized part is an instantiation of a (design-) part, where the particular instantiation can be uniquely identified by means of a serial numbers or a similar identifier (e.g. VAN) or a combination of multiple identifiers (e.g. combination of manufacturer, date and number) - - - - urn:samm:io.catenax.serial_part_typization:1.1.1#SerialPartTypization/submodel - Template - - ModelReference - - - ConceptDescription - urn:samm:io.catenax.serial_part_typization:1.1.1#SerialPartTypization - - - - - - catenaXId - - - en - Catena-X Identifier - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.serial_part_typization:1.1.1#catenaXId - - - - xs:string - - - - localIdentifiers - - - en - Local Identifiers - - - - - en - A local identifier enables identification of a part in a specific dataspace, but is not unique in Catena-X dataspace. Multiple local identifiers may exist. - - - true - DataElement - - - KeyValueList - - - en - Key Value List - - - - - en - A list of key value pairs for local identifiers, which are composed of a key and a corresponding value. - - - - - key - - - en - Identifier Key - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.serial_part_typization:1.1.1#key - - - - xs:string - - - - value - - - en - Identifier Value - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.serial_part_typization:1.1.1#value - - - - xs:string - - - - - - - - ManufacturingEntity - - - en - Manufacturing Entity - - - - - en - Encapsulates the manufacturing relevant attributes - - - - - date - - - en - Production Date - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.serial_part_typization:1.1.1#date - - - - xs:dateTime - - - - country - - - en - Country code - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.serial_part_typization:1.1.1#country - - - - xs:string - - - - - - PartTypeInformationEntity - - - en - Part Type Information Entity - - - - - en - Encapsulation for data related to the part type - - - - - manufacturerPartId - - - en - Manufacturer Part ID - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.serial_part_typization:1.1.1#manufacturerPartId - - - - xs:string - - - - customerPartId - - - en - Customer Part ID - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.serial_part_typization:1.1.1#customerPartId - - - - xs:string - - - - nameAtManufacturer - - - en - Name at Manufacturer - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.serial_part_typization:1.1.1#nameAtManufacturer - - - - xs:string - - - - nameAtCustomer - - - en - Name at Customer - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.serial_part_typization:1.1.1#nameAtCustomer - - - - xs:string - - - - classification - - - en - Classifcation - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.serial_part_typization:1.1.1#classification - - - - xs:string - - - - - - - - - - APPLICATION_CLASS - SerialPartTypization - - - en - Serial Part Typization - - - - - en - A serialized part is an instantiation of a (design-) part, where the particular instantiation can be uniquely identified by means of a serial numbers or a similar identifier (e.g. VAN) or a combination of multiple identifiers (e.g. combination of manufacturer, date and number) - - - urn:samm:io.catenax.serial_part_typization:1.1.1#SerialPartTypization - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Serial Part Typization - - - - - en - SerialPartTypization - - - - - en - A serialized part is an instantiation of a (design-) part, where the particular instantiation can be uniquely identified by means of a serial numbers or a similar identifier (e.g. VAN) or a combination of multiple identifiers (e.g. combination of manufacturer, date and number) - - - - - - - - - catenaXId - - - en - Catena-X Identifier - - - urn:samm:io.catenax.serial_part_typization:1.1.1#catenaXId - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Catena-X Identifier - - - - - en - catenaXId - - - STRING - - - en - The fully anonymous Catena-X ID of the serialized part, valid for the Catena-X dataspace. - - - - - - - - - key - - - en - Identifier Key - - - urn:samm:io.catenax.serial_part_typization:1.1.1#key - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Identifier Key - - - - - en - key - - - STRING - - - en - The key of a local identifier. - - - - - - - - - value - - - en - Identifier Value - - - urn:samm:io.catenax.serial_part_typization:1.1.1#value - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Identifier Value - - - - - en - value - - - STRING - - - en - The value of an identifier. - - - - - - - - - localIdentifiers - - - en - Local Identifiers - - - urn:samm:io.catenax.serial_part_typization:1.1.1#localIdentifiers - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Local Identifiers - - - - - en - localIdentifiers - - - STRING - - - en - A local identifier enables identification of a part in a specific dataspace, but is not unique in Catena-X dataspace. Multiple local identifiers may exist. - - - - - - - - - date - - - en - Production Date - - - urn:samm:io.catenax.serial_part_typization:1.1.1#date - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Production Date - - - - - en - date - - - STRING - - - en - Timestamp of the manufacturing date as the final step in production process (e.g. final quality check, ready-for-shipment event) - - - - - - - - - country - - - en - Country code - - - urn:samm:io.catenax.serial_part_typization:1.1.1#country - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Country code - - - - - en - country - - - STRING - - - en - Country code where the part was manufactured - - - - - - - - - manufacturingInformation - - - en - Manufacturing Information - - - urn:samm:io.catenax.serial_part_typization:1.1.1#manufacturingInformation - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Manufacturing Information - - - - - en - manufacturingInformation - - - STRING - - - en - Information from manufacturing process, such as manufacturing date and manufacturing country - - - - - - - - - manufacturerPartId - - - en - Manufacturer Part ID - - - urn:samm:io.catenax.serial_part_typization:1.1.1#manufacturerPartId - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Manufacturer Part ID - - - - - en - manufacturerPartId - - - STRING - - - en - Part ID as assigned by the manufacturer of the part. The Part ID identifies the part (as designed) in the manufacturer`s dataspace. The Part ID does not reference a specific instance of a part and thus should not be confused with the serial number. - - - - - - - - - customerPartId - - - en - Customer Part ID - - - urn:samm:io.catenax.serial_part_typization:1.1.1#customerPartId - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Customer Part ID - - - - - en - customerPartId - - - STRING - - - en - Part ID as assigned by the manufacturer of the part. The Part ID identifies the part (as designed) in the customer`s dataspace. The Part ID does not reference a specific instance of a part and thus should not be confused with the serial number. - - - - - - - - - nameAtManufacturer - - - en - Name at Manufacturer - - - urn:samm:io.catenax.serial_part_typization:1.1.1#nameAtManufacturer - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Name at Manufacturer - - - - - en - nameAtManufacturer - - - STRING - - - en - Name of the part as assigned by the manufacturer - - - - - - - - - nameAtCustomer - - - en - Name at Customer - - - urn:samm:io.catenax.serial_part_typization:1.1.1#nameAtCustomer - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Name at Customer - - - - - en - nameAtCustomer - - - STRING - - - en - Name of the part as assigned by the customer - - - - - - - - - classification - - - en - Classifcation - - - urn:samm:io.catenax.serial_part_typization:1.1.1#classification - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Classifcation - - - - - en - classification - - - STRING - - - en - The classification of the part type according to STEP standard definition - - - - - - product - - ModelReference - - - DataElement - urn:samm:io.catenax.serial_part_typization:1.1.1#ClassificationCharacteristic:product - - - - - - raw material - - ModelReference - - - DataElement - urn:samm:io.catenax.serial_part_typization:1.1.1#ClassificationCharacteristic:raw material - - - - - - software - - ModelReference - - - DataElement - urn:samm:io.catenax.serial_part_typization:1.1.1#ClassificationCharacteristic:software - - - - - - assembly - - ModelReference - - - DataElement - urn:samm:io.catenax.serial_part_typization:1.1.1#ClassificationCharacteristic:assembly - - - - - - tool - - ModelReference - - - DataElement - urn:samm:io.catenax.serial_part_typization:1.1.1#ClassificationCharacteristic:tool - - - - - - component - - ModelReference - - - DataElement - urn:samm:io.catenax.serial_part_typization:1.1.1#ClassificationCharacteristic:component - - - - - - - - - - - - - partTypeInformation - - - en - Part Type Information - - - urn:samm:io.catenax.serial_part_typization:1.1.1#partTypeInformation - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Part Type Information - - - - - en - partTypeInformation - - - STRING - - - en - The part type from which the serialized part has been instantiated - - - - - - - - - diff --git a/io.catenax.serial_part_typization/1.1.1/gen/SerialPartTypization-schema.json b/io.catenax.serial_part_typization/1.1.1/gen/SerialPartTypization-schema.json deleted file mode 100644 index 09cbc2541..000000000 --- a/io.catenax.serial_part_typization/1.1.1/gen/SerialPartTypization-schema.json +++ /dev/null @@ -1,129 +0,0 @@ -{ - "$schema" : "http://json-schema.org/draft-04/schema", - "description" : "A serialized part is an instantiation of a (design-) part, where the particular instantiation can be uniquely identified by means of a serial numbers or a similar identifier (e.g. VAN) or a combination of multiple identifiers (e.g. combination of manufacturer, date and number)", - "type" : "object", - "components" : { - "schemas" : { - "urn_bamm_io.catenax.serial_part_typization_1.1.1_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_bamm_io.catenax.serial_part_typization_1.1.1_KeyCharacteristic" : { - "type" : "string", - "description" : "The key characteristic of a local identifier. A specific subset of keys is predefined, but additionally any other custom key is allowed. Predefined keys (to be used when applicable):\n- \"manufacturerId\" - The Business Partner Number (BPN) of the manufacturer. Value: BPN-Nummer\n- \"partInstanceId\" - The identifier of the manufacturer for the serialized instance of the part, e.g. the serial number\n- \"batchId\" - The identifier of the batch, to which the serialzed part belongs\n- \"van\" - The anonymized vehicle identification number (VIN). Value: anonymized VIN according to OEM anonymization rules. Note: If the key \"van\" is available, \"partInstanceId\" must also be available and hold the identical value." - }, - "urn_bamm_io.catenax.serial_part_typization_1.1.1_ValueCharacteristic" : { - "type" : "string", - "description" : "The value of an identifier." - }, - "urn_bamm_io.catenax.serial_part_typization_1.1.1_KeyValueList" : { - "description" : "A list of key value pairs for local identifiers, which are composed of a key and a corresponding value.", - "type" : "object", - "properties" : { - "key" : { - "description" : "The key of a local identifier. ", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.serial_part_typization_1.1.1_KeyCharacteristic" - }, - "value" : { - "description" : "The value of an identifier.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.serial_part_typization_1.1.1_ValueCharacteristic" - } - }, - "required" : [ "key", "value" ] - }, - "urn_bamm_io.catenax.serial_part_typization_1.1.1_LocalIdentifierCharacteristic" : { - "description" : "A single serialized part may have multiple attributes, that uniquely identify a that part in a specific dataspace (e.g. the manufacturer`s dataspace)", - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/urn_bamm_io.catenax.serial_part_typization_1.1.1_KeyValueList" - }, - "uniqueItems" : true - }, - "urn_bamm_io.openmanufacturing_characteristic_2.0.0_Timestamp" : { - "type" : "string", - "pattern" : "-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T(([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](\\.[0-9]+)?|(24:00:00(\\.0+)?))(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?", - "description" : "Describes a Property which contains the date and time with an optional timezone." - }, - "urn_bamm_io.catenax.serial_part_typization_1.1.1_ProductionCountryCodeTrait" : { - "type" : "string", - "description" : "Regular Expression that ensures a three-letter code ", - "pattern" : "^[A-Z][A-Z][A-Z]$" - }, - "urn_bamm_io.catenax.serial_part_typization_1.1.1_ManufacturingCharacteristic" : { - "description" : "Characteristic to describe manufacturing related data", - "type" : "object", - "properties" : { - "date" : { - "description" : "Timestamp of the manufacturing date as the final step in production process (e.g. final quality check, ready-for-shipment event)", - "$ref" : "#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Timestamp" - }, - "country" : { - "description" : "Country code where the part was manufactured", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.serial_part_typization_1.1.1_ProductionCountryCodeTrait" - } - }, - "required" : [ "date" ] - }, - "urn_bamm_io.catenax.serial_part_typization_1.1.1_PartIdCharacteristic" : { - "type" : "string", - "description" : "The part ID is a multi-character string, ususally assigned by an ERP system" - }, - "urn_bamm_io.catenax.serial_part_typization_1.1.1_PartNameCharacteristic" : { - "type" : "string", - "description" : "Part Name in string format from the respective system in the value chain" - }, - "urn_bamm_io.catenax.serial_part_typization_1.1.1_ClassificationCharacteristic" : { - "type" : "string", - "description" : "A part type must be placed into one of the following classes: 'component', 'product', 'software', ‘assembly’, 'tool', or 'raw material'.", - "enum" : [ "product", "raw material", "software", "assembly", "tool", "component" ] - }, - "urn_bamm_io.catenax.serial_part_typization_1.1.1_PartTypeInformationCharacteristic" : { - "description" : "The characteristics of the part type", - "type" : "object", - "properties" : { - "manufacturerPartId" : { - "description" : "Part ID as assigned by the manufacturer of the part. The Part ID identifies the part (as designed) in the manufacturer`s dataspace. The Part ID does not reference a specific instance of a part and thus should not be confused with the serial number.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.serial_part_typization_1.1.1_PartIdCharacteristic" - }, - "customerPartId" : { - "description" : "Part ID as assigned by the manufacturer of the part. The Part ID identifies the part (as designed) in the customer`s dataspace. The Part ID does not reference a specific instance of a part and thus should not be confused with the serial number.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.serial_part_typization_1.1.1_PartIdCharacteristic" - }, - "nameAtManufacturer" : { - "description" : "Name of the part as assigned by the manufacturer", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.serial_part_typization_1.1.1_PartNameCharacteristic" - }, - "nameAtCustomer" : { - "description" : "Name of the part as assigned by the customer", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.serial_part_typization_1.1.1_PartNameCharacteristic" - }, - "classification" : { - "description" : "The classification of the part type according to STEP standard definition", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.serial_part_typization_1.1.1_ClassificationCharacteristic" - } - }, - "required" : [ "manufacturerPartId", "nameAtManufacturer", "classification" ] - } - } - }, - "properties" : { - "catenaXId" : { - "description" : "The fully anonymous Catena-X ID of the serialized part, valid for the Catena-X dataspace.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.serial_part_typization_1.1.1_CatenaXIdTrait" - }, - "localIdentifiers" : { - "description" : "A local identifier enables identification of a part in a specific dataspace, but is not unique in Catena-X dataspace. Multiple local identifiers may exist.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.serial_part_typization_1.1.1_LocalIdentifierCharacteristic" - }, - "manufacturingInformation" : { - "description" : "Information from manufacturing process, such as manufacturing date and manufacturing country", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.serial_part_typization_1.1.1_ManufacturingCharacteristic" - }, - "partTypeInformation" : { - "description" : "The part type from which the serialized part has been instantiated", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.serial_part_typization_1.1.1_PartTypeInformationCharacteristic" - } - }, - "required" : [ "catenaXId", "localIdentifiers", "manufacturingInformation", "partTypeInformation" ] -} \ No newline at end of file diff --git a/io.catenax.serial_part_typization/1.1.1/gen/SerialPartTypization.aasx b/io.catenax.serial_part_typization/1.1.1/gen/SerialPartTypization.aasx deleted file mode 100644 index c73f37494..000000000 Binary files a/io.catenax.serial_part_typization/1.1.1/gen/SerialPartTypization.aasx and /dev/null differ diff --git a/io.catenax.serial_part_typization/1.1.1/gen/SerialPartTypization.html b/io.catenax.serial_part_typization/1.1.1/gen/SerialPartTypization.html deleted file mode 100644 index 9953edbd9..000000000 --- a/io.catenax.serial_part_typization/1.1.1/gen/SerialPartTypization.html +++ /dev/null @@ -1,1152 +0,0 @@ - - - - - - - - - - - - - - Dokumentation Serial Part Typization - - -
-
-
-
-

Aspect Model Serial Part Typization

-
urn:bamm:io.catenax.serial_part_typization:1.1.1#SerialPartTypization
-
-
-
-
-
-
-
- -
- - -
- A serialized part is an instantiation of a (design-) part, where the particular instantiation can be uniquely identified by means of a serial numbers or a similar identifier (e.g. VAN) or a combination of multiple identifiers (e.g. combination of manufacturer, date and number) -
- - -
-

Übersicht

-
-
-
-
- Aspect Model Diagram -
-
-
- - -
-
-

Properties

-
- -
- -
-

Catena-X Identifier

-
- -The fully anonymous Catena-X ID of the serialized part, valid for the Catena-X dataspace. - -
-
Name
-
catenaXId
-
- - - -
-
Characteristic
-
-
-
-
Trait
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Beispiel
-
urn:uuid:580d3adf-1981-44a0-a214-13d6ceed9379
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
catenaXId
-
- - -
-
Bedingungen
-
-
    -
  • -
    - -
    - Catena-X Id Regular Expression -
    - -
    -
    Beschreibung
    -
    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.
    -
    - -
    -
    Referenz
    -
    -
    -
      -
    • https://datatracker.ietf.org/doc/html/rfc4122
      • -
    -
    -
    -
    - -
    -
    Regulärer Ausdruck
    -
    (^[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}$)
    -
    - -
    • -
-
-
-
-
- -
-

Local Identifiers

-
- -A local identifier enables identification of a part in a specific dataspace, but is not unique in Catena-X dataspace. Multiple local identifiers may exist. - -
-
Name
-
localIdentifiers
-
- - - -
-
Characteristic
-
-
-
-
Set
-
-
-
Has no order
-
-
-
Duplicates not allowed
-
-
-
- Typ urn:bamm:io.catenax.serial_part_typization:1.1.1#KeyValueList - -
-
-
-
-
- - -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
localIdentifiers
-
- - -
-
- -
-

Manufacturing Information

-
- -Information from manufacturing process, such as manufacturing date and manufacturing country - -
-
Name
-
manufacturingInformation
-
- - - -
-
Characteristic
-
-
-
-
SingleEntity
-
-
-
- Typ urn:bamm:io.catenax.serial_part_typization:1.1.1#ManufacturingEntity - -
-
-
-
-
- - -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
manufacturingInformation
-
- - -
-
- -
-

Part Type Information

-
- -The part type from which the serialized part has been instantiated - -
-
Name
-
partTypeInformation
-
- - - -
-
Characteristic
-
-
-
-
SingleEntity
-
-
-
- Typ urn:bamm:io.catenax.serial_part_typization:1.1.1#PartTypeInformationEntity - -
-
-
-
-
- - -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
partTypeInformation
-
- - -
-
- - - -
-
-

Objekt

-
- -
-
-

Key Value List

-
-
- A list of key value pairs for local identifiers, which are composed of a key and a corresponding value. -
- -
-

Properties

-
-
- -
-
Identifier Key
-
- -The key of a local identifier. - -
-
Name
-
key
-
- - - -
-
Characteristic
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Beispiel
-
PartInstanceID
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
key
-
- - -
-
- -
-
Identifier Value
-
- -The value of an identifier. - -
-
Name
-
value
-
- - - -
-
Characteristic
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Beispiel
-
SN12345678
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
value
-
- - -
-
-
-
-

Manufacturing Entity

-
-
- Encapsulates the manufacturing relevant attributes -
- -
-

Properties

-
-
- -
-
Production Date
-
- -Timestamp of the manufacturing date as the final step in production process (e.g. final quality check, ready-for-shipment event) - -
-
Name
-
date
-
- - - -
-
Characteristic
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#dateTime - -
-
-
-
-
- -
-
Beispiel
-
2022-02-04T14:48:54
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
date
-
- - -
-
- -
-
Country code
-
- -Country code where the part was manufactured - -
-
Name
-
country
-
- - - -
-
Characteristic
-
-
-
-
Trait
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Beispiel
-
HUR
-
- -
-
Optional
-
- Ja
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
country
-
- - -
-
Bedingungen
-
-
    -
  • -
    - -
    - Country Code Regular Expression -
    - -
    -
    Beschreibung
    -
    Regular Expression that ensures a three-letter code
    -
    - - -
    -
    Regulärer Ausdruck
    -
    ^[A-Z][A-Z][A-Z]$
    -
    - -
    • -
-
-
-
-
-
-
-

Part Type Information Entity

-
-
- Encapsulation for data related to the part type -
- -
-

Properties

-
-
- -
-
Manufacturer Part ID
-
- -Part ID as assigned by the manufacturer of the part. The Part ID identifies the part (as designed) in the manufacturer`s dataspace. The Part ID does not reference a specific instance of a part and thus should not be confused with the serial number. - -
-
Name
-
manufacturerPartId
-
- - - -
-
Characteristic
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Beispiel
-
123-0.740-3434-A
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
manufacturerPartId
-
- - -
-
- -
-
Customer Part ID
-
- -Part ID as assigned by the manufacturer of the part. The Part ID identifies the part (as designed) in the customer`s dataspace. The Part ID does not reference a specific instance of a part and thus should not be confused with the serial number. - -
-
Name
-
customerPartId
-
- - - -
-
Characteristic
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Beispiel
-
PRT-12345
-
- -
-
Optional
-
- Ja
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
customerPartId
-
- - -
-
- -
-
Name at Manufacturer
-
- -Name of the part as assigned by the manufacturer - -
-
Name
-
nameAtManufacturer
-
- - - -
-
Characteristic
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Beispiel
-
Mirror left
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
nameAtManufacturer
-
- - -
-
- -
-
Name at Customer
-
- -Name of the part as assigned by the customer - -
-
Name
-
nameAtCustomer
-
- - - -
-
Characteristic
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Beispiel
-
side element A
-
- -
-
Optional
-
- Ja
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
nameAtCustomer
-
- - -
-
- -
-
Classifcation
-
- -The classification of the part type according to STEP standard definition - -
-
Name
-
classification
-
- - - -
-
Characteristic
-
-
-
-
Enumeration
-
-
-
Werte
-
-
-
-
    -
  • product
    • -
  • raw material
    • -
  • software
    • -
  • assembly
    • -
  • tool
    • -
  • component
    • -
-
-
-
-
- Referenz -
-
    -
  • http://private.pdm-if.org/web/pdm-if/recommended-practices1
    • -
-
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Beispiel
-
software
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
classification
-
- - -
-
-
- -
- Third party licenses - -
- -
- - -
- - - \ No newline at end of file diff --git a/io.catenax.serial_part_typization/1.1.1/gen/SerialPartTypization.json b/io.catenax.serial_part_typization/1.1.1/gen/SerialPartTypization.json deleted file mode 100644 index 200d12e3e..000000000 --- a/io.catenax.serial_part_typization/1.1.1/gen/SerialPartTypization.json +++ /dev/null @@ -1,18 +0,0 @@ -{ - "localIdentifiers" : [ { - "value" : "SN12345678", - "key" : "PartInstanceID" - } ], - "manufacturingInformation" : { - "date" : "2022-02-04T14:48:54", - "country" : "HUR" - }, - "catenaXId" : "urn:uuid:580d3adf-1981-44a0-a214-13d6ceed9379", - "partTypeInformation" : { - "manufacturerPartId" : "123-0.740-3434-A", - "customerPartId" : "PRT-12345", - "classification" : "product", - "nameAtManufacturer" : "Mirror left", - "nameAtCustomer" : "side element A" - } -} \ No newline at end of file diff --git a/io.catenax.serial_part_typization/1.1.1/gen/SerialPartTypization.yml b/io.catenax.serial_part_typization/1.1.1/gen/SerialPartTypization.yml deleted file mode 100644 index 9358af860..000000000 --- a/io.catenax.serial_part_typization/1.1.1/gen/SerialPartTypization.yml +++ /dev/null @@ -1,262 +0,0 @@ ---- -openapi: 3.0.3 -info: - title: Serial Part Typization - version: v1 -servers: -- url: catenax.io/api/v1 - variables: - api-version: - default: v1 -paths: - /{tenant-id}/serial-part-typization: - get: - tags: - - SerialPartTypization - operationId: getSerialPartTypization - 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/SerialPartTypization' - "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/SerialPartTypization' - totalItems: - type: number - totalPages: - type: number - pageSize: - type: number - currentPage: - type: number - urn_bamm_io.catenax.serial_part_typization_1.1.1_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_bamm_io.catenax.serial_part_typization_1.1.1_KeyCharacteristic: - type: string - description: |- - The key characteristic of a local identifier. A specific subset of keys is predefined, but additionally any other custom key is allowed. Predefined keys (to be used when applicable): - - "manufacturerId" - The Business Partner Number (BPN) of the manufacturer. Value: BPN-Nummer - - "partInstanceId" - The identifier of the manufacturer for the serialized instance of the part, e.g. the serial number - - "batchId" - The identifier of the batch, to which the serialzed part belongs - - "van" - The anonymized vehicle identification number (VIN). Value: anonymized VIN according to OEM anonymization rules. Note: If the key "van" is available, "partInstanceId" must also be available and hold the identical value. - urn_bamm_io.catenax.serial_part_typization_1.1.1_ValueCharacteristic: - type: string - description: The value of an identifier. - urn_bamm_io.catenax.serial_part_typization_1.1.1_KeyValueList: - description: "A list of key value pairs for local identifiers, which are composed\ - \ of a key and a corresponding value." - type: object - properties: - key: - description: 'The key of a local identifier. ' - $ref: '#/components/schemas/urn_bamm_io.catenax.serial_part_typization_1.1.1_KeyCharacteristic' - value: - description: The value of an identifier. - $ref: '#/components/schemas/urn_bamm_io.catenax.serial_part_typization_1.1.1_ValueCharacteristic' - required: - - key - - value - urn_bamm_io.catenax.serial_part_typization_1.1.1_LocalIdentifierCharacteristic: - description: "A single serialized part may have multiple attributes, that uniquely\ - \ identify a that part in a specific dataspace (e.g. the manufacturer`s dataspace)" - type: array - items: - $ref: '#/components/schemas/urn_bamm_io.catenax.serial_part_typization_1.1.1_KeyValueList' - uniqueItems: true - urn_bamm_io.openmanufacturing_characteristic_2.0.0_Timestamp: - type: string - pattern: "-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T(([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](\\\ - .[0-9]+)?|(24:00:00(\\.0+)?))(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?" - description: Describes a Property which contains the date and time with an optional - timezone. - urn_bamm_io.catenax.serial_part_typization_1.1.1_ProductionCountryCodeTrait: - type: string - description: 'Regular Expression that ensures a three-letter code ' - pattern: "^[A-Z][A-Z][A-Z]$" - urn_bamm_io.catenax.serial_part_typization_1.1.1_ManufacturingCharacteristic: - description: Characteristic to describe manufacturing related data - type: object - properties: - date: - description: "Timestamp of the manufacturing date as the final step in production\ - \ process (e.g. final quality check, ready-for-shipment event)" - $ref: '#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Timestamp' - country: - description: Country code where the part was manufactured - $ref: '#/components/schemas/urn_bamm_io.catenax.serial_part_typization_1.1.1_ProductionCountryCodeTrait' - required: - - date - urn_bamm_io.catenax.serial_part_typization_1.1.1_PartIdCharacteristic: - type: string - description: "The part ID is a multi-character string, ususally assigned by\ - \ an ERP system" - urn_bamm_io.catenax.serial_part_typization_1.1.1_PartNameCharacteristic: - type: string - description: Part Name in string format from the respective system in the value - chain - urn_bamm_io.catenax.serial_part_typization_1.1.1_ClassificationCharacteristic: - type: string - description: "A part type must be placed into one of the following classes:\ - \ 'component', 'product', 'software', ‘assembly’, 'tool', or 'raw material'." - enum: - - product - - raw material - - software - - assembly - - tool - - component - urn_bamm_io.catenax.serial_part_typization_1.1.1_PartTypeInformationCharacteristic: - description: The characteristics of the part type - type: object - properties: - manufacturerPartId: - description: Part ID as assigned by the manufacturer of the part. The Part - ID identifies the part (as designed) in the manufacturer`s dataspace. - The Part ID does not reference a specific instance of a part and thus - should not be confused with the serial number. - $ref: '#/components/schemas/urn_bamm_io.catenax.serial_part_typization_1.1.1_PartIdCharacteristic' - customerPartId: - description: Part ID as assigned by the manufacturer of the part. The Part - ID identifies the part (as designed) in the customer`s dataspace. The - Part ID does not reference a specific instance of a part and thus should - not be confused with the serial number. - $ref: '#/components/schemas/urn_bamm_io.catenax.serial_part_typization_1.1.1_PartIdCharacteristic' - nameAtManufacturer: - description: Name of the part as assigned by the manufacturer - $ref: '#/components/schemas/urn_bamm_io.catenax.serial_part_typization_1.1.1_PartNameCharacteristic' - nameAtCustomer: - description: Name of the part as assigned by the customer - $ref: '#/components/schemas/urn_bamm_io.catenax.serial_part_typization_1.1.1_PartNameCharacteristic' - classification: - description: The classification of the part type according to STEP standard - definition - $ref: '#/components/schemas/urn_bamm_io.catenax.serial_part_typization_1.1.1_ClassificationCharacteristic' - required: - - manufacturerPartId - - nameAtManufacturer - - classification - SerialPartTypization: - description: "A serialized part is an instantiation of a (design-) part, where\ - \ the particular instantiation can be uniquely identified by means of a serial\ - \ numbers or a similar identifier (e.g. VAN) or a combination of multiple\ - \ identifiers (e.g. combination of manufacturer, date and number)" - type: object - properties: - catenaXId: - description: "The fully anonymous Catena-X ID of the serialized part, valid\ - \ for the Catena-X dataspace." - $ref: '#/components/schemas/urn_bamm_io.catenax.serial_part_typization_1.1.1_CatenaXIdTrait' - localIdentifiers: - description: "A local identifier enables identification of a part in a specific\ - \ dataspace, but is not unique in Catena-X dataspace. Multiple local identifiers\ - \ may exist." - $ref: '#/components/schemas/urn_bamm_io.catenax.serial_part_typization_1.1.1_LocalIdentifierCharacteristic' - manufacturingInformation: - description: "Information from manufacturing process, such as manufacturing\ - \ date and manufacturing country" - $ref: '#/components/schemas/urn_bamm_io.catenax.serial_part_typization_1.1.1_ManufacturingCharacteristic' - partTypeInformation: - description: The part type from which the serialized part has been instantiated - $ref: '#/components/schemas/urn_bamm_io.catenax.serial_part_typization_1.1.1_PartTypeInformationCharacteristic' - required: - - catenaXId - - localIdentifiers - - manufacturingInformation - - partTypeInformation - 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' - SerialPartTypization: - content: - application/json: - schema: - $ref: '#/components/schemas/PagingSchema' - description: The request was successful. - requestBodies: - SerialPartTypization: - content: - application/json: - schema: - $ref: '#/components/schemas/SerialPartTypization' diff --git a/io.catenax.serial_part_typization/1.1.1/metadata.json b/io.catenax.serial_part_typization/1.1.1/metadata.json deleted file mode 100644 index 9e759dfb1..000000000 --- a/io.catenax.serial_part_typization/1.1.1/metadata.json +++ /dev/null @@ -1 +0,0 @@ -{ "status" : "deprecate"} diff --git a/io.catenax.serial_part_typization/2.0.0/SerialPartTypization.ttl b/io.catenax.serial_part_typization/2.0.0/SerialPartTypization.ttl deleted file mode 100644 index a7ad35904..000000000 --- a/io.catenax.serial_part_typization/2.0.0/SerialPartTypization.ttl +++ /dev/null @@ -1,237 +0,0 @@ -####################################################################### -# Copyright (c) 2022,2023 BASF SE -# Copyright (c) 2022,2023 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) -# Copyright (c) 2022,2023 Fraunhofer-Gesellschaft zur Foerderung der angewandten Forschung e.V. (represented by Fraunhofer ISST & Fraunhofer IML) -# Copyright (c) 2022,2023 German Edge Cloud GmbH & Co. KG -# Copyright (c) 2022,2023 Henkel AG & Co. KGaA -# Copyright (c) 2022,2023 Mercedes Benz AG -# Copyright (c) 2022,2023 Robert Bosch Manufacturing Solutions GmbH -# Copyright (c) 2022,2023 SAP SE -# Copyright (c) 2022,2023 Siemens AG -# Copyright (c) 2022,2023 T-Systems International GmbH -# Copyright (c) 2022,2023 ZF Friedrichshafen AG -# Copyright (c) 2022,2023 Contributors to the Eclipse Foundation -# -# 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 bamm: . -@prefix bamm-c: . -@prefix bamm-e: . -@prefix unit: . -@prefix rdf: . -@prefix rdfs: . -@prefix xsd: . -@prefix : . - -:SerialPartTypization a bamm:Aspect ; - bamm:preferredName "Serial Part Typization"@en ; - bamm:description "A serialized part is an instantiation of a (design-) part, where the particular instantiation can be uniquely identified by means of a serial numbers or a similar identifier (e.g. VAN) or a combination of multiple identifiers (e.g. combination of manufacturer, date and number)"@en ; - bamm:properties ( :catenaXId :localIdentifiers :manufacturingInformation :partTypeInformation ) ; - bamm:operations ( ) ; - bamm:name "SerialPartTypization" . - -:catenaXId a bamm:Property ; - bamm:preferredName "Catena-X Identifier"@en ; - bamm:description "The fully anonymous Catena-X ID of the serialized part, valid for the Catena-X dataspace."@en ; - bamm:characteristic :CatenaXIdTrait ; - bamm:exampleValue "urn:uuid:580d3adf-1981-44a0-a214-13d6ceed9379" ; - bamm:name "catenaXId" . - -:localIdentifiers a bamm:Property ; - bamm:preferredName "Local Identifiers"@en ; - bamm:description "A local identifier enables identification of a part in a specific dataspace, but is not unique in Catena-X dataspace. Multiple local identifiers may exist."@en ; - bamm:characteristic :LocalIdentifierCharacteristic ; - bamm:name "localIdentifiers" . - -:manufacturingInformation a bamm:Property ; - bamm:preferredName "Manufacturing Information"@en ; - bamm:description "Information from manufacturing process, such as manufacturing date and manufacturing country"@en ; - bamm:characteristic :ManufacturingCharacteristic ; - bamm:name "manufacturingInformation" . - -:partTypeInformation a bamm:Property ; - bamm:preferredName "Part Type Information"@en ; - bamm:description "The part type from which the serialized part has been instantiated"@en ; - bamm:characteristic :PartTypeInformationCharacteristic ; - bamm:name "partTypeInformation" . - -:CatenaXIdTrait a bamm-c:Trait ; - bamm:preferredName "Catena-X ID Trait"@en ; - bamm:description "Trait to ensure data format for Catena-X ID"@en ; - bamm-c:baseCharacteristic :UUIDv4 ; - bamm-c:constraint :UUIDv4RegularExpression ; - bamm:name "CatenaXIdTrait" . - -:LocalIdentifierCharacteristic a bamm-c:Set ; - bamm:preferredName "Local Identifier Characteristic"@en ; - bamm:description "A single serialized part may have multiple attributes, that uniquely identify a that part in a specific dataspace (e.g. the manufacturer`s dataspace)"@en ; - bamm:dataType :KeyValueList ; - bamm:name "LocalIdentifierCharacteristic" . - -:ManufacturingCharacteristic a bamm:Characteristic ; - bamm:preferredName "Manufacturing Characteristic"@en ; - bamm:description "Characteristic to describe manufacturing related data"@en ; - bamm:dataType :ManufacturingEntity ; - bamm:name "ManufacturingCharacteristic" . - -:PartTypeInformationCharacteristic a bamm:Characteristic ; - bamm:preferredName "Part Type Information Characteristic"@en ; - bamm:description "The characteristics of the part type"@en ; - bamm:dataType :PartTypeInformationEntity ; - bamm:name "PartTypeInformationCharacteristic" . - -:UUIDv4 a bamm:Characteristic ; - bamm:preferredName "UUIDv4"@en ; - bamm:description "A version 4 UUID is a universally unique identifier that is generated using random 32 hexadecimal characters."@en ; - bamm:dataType xsd:string ; - bamm:name "UUIDv4" . - -:UUIDv4RegularExpression a bamm-c:RegularExpressionConstraint ; - bamm:preferredName "Catena-X Id Regular Expression"@en ; - bamm: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."@en ; - bamm:see ; - bamm:value "(^[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}$)" ; - bamm:name "UUIDv4RegularExpression" . - -:KeyValueList a bamm:Entity ; - bamm:preferredName "Key Value List"@en ; - bamm:description "A list of key value pairs for local identifiers, which are composed of a key and a corresponding value."@en ; - bamm:properties ( :key :value ) ; - bamm:name "KeyValueList" . - -:ManufacturingEntity a bamm:Entity ; - bamm:preferredName "Manufacturing Entity"@en ; - bamm:description "Encapsulates the manufacturing relevant attributes"@en ; - bamm:properties ( :date [ bamm:property :country; bamm:optional true ] ) ; - bamm:name "ManufacturingEntity" . - -:PartTypeInformationEntity a bamm:Entity ; - bamm:preferredName "Part Type Information Entity"@en ; - bamm:description "Encapsulation for data related to the part type"@en ; - bamm:properties ( :manufacturerPartId [ bamm:property :customerPartId; bamm:optional true ] :nameAtManufacturer [ bamm:property :nameAtCustomer; bamm:optional true ] :classification ) ; - bamm:name "PartTypeInformationEntity" . - -:key a bamm:Property ; - bamm:preferredName "Identifier Key"@en ; - bamm:description "The key of a local identifier. "@en ; - bamm:characteristic :KeyCharacteristic ; - bamm:exampleValue "PartInstanceID" ; - bamm:name "key" . - -:value a bamm:Property ; - bamm:preferredName "Identifier Value"@en ; - bamm:description "The value of an identifier."@en ; - bamm:characteristic :ValueCharacteristic ; - bamm:exampleValue "SN12345678" ; - bamm:name "value" . - -:date a bamm:Property ; - bamm:preferredName "Production Date"@en ; - bamm:description "Timestamp of the manufacturing date as the final step in production process (e.g. final quality check, ready-for-shipment event)"@en ; - bamm:characteristic bamm-c:Timestamp ; - bamm:exampleValue "2022-02-04T14:48:54"^^xsd:dateTime ; - bamm:name "date" . - -:country a bamm:Property ; - bamm:preferredName "Country code"@en ; - bamm:description "Country code where the part was manufactured"@en ; - bamm:characteristic :ProductionCountryCodeTrait ; - bamm:exampleValue "HUR" ; - bamm:name "country" . - -:manufacturerPartId a bamm:Property ; - bamm:preferredName "Manufacturer Part ID"@en ; - bamm:description "Part ID as assigned by the manufacturer of the part. The Part ID identifies the part (as designed) in the manufacturer`s dataspace. The Part ID does not reference a specific instance of a part and thus should not be confused with the serial number."@en ; - bamm:characteristic :PartIdCharacteristic ; - bamm:exampleValue "123-0.740-3434-A" ; - bamm:name "manufacturerPartId" . - -:customerPartId a bamm:Property ; - bamm:preferredName "Customer Part ID"@en ; - bamm:description "Part ID as assigned by the manufacturer of the part. The Part ID identifies the part (as designed) in the customer`s dataspace. The Part ID does not reference a specific instance of a part and thus should not be confused with the serial number."@en ; - bamm:characteristic :PartIdCharacteristic ; - bamm:exampleValue "PRT-12345" ; - bamm:name "customerPartId" . - -:nameAtManufacturer a bamm:Property ; - bamm:preferredName "Name at Manufacturer"@en ; - bamm:description "Name of the part as assigned by the manufacturer"@en ; - bamm:characteristic :PartNameCharacteristic ; - bamm:exampleValue "Mirror left" ; - bamm:name "nameAtManufacturer" . - -:nameAtCustomer a bamm:Property ; - bamm:preferredName "Name at Customer"@en ; - bamm:description "Name of the part as assigned by the customer"@en ; - bamm:characteristic :PartNameCharacteristic ; - bamm:exampleValue "side element A" ; - bamm:name "nameAtCustomer" . - -:classification a bamm:Property ; - bamm:preferredName "Classifcation"@en ; - bamm:description "The classification of the part type according to STEP standard definition"@en ; - bamm:characteristic :ClassificationCharacteristic ; - bamm:exampleValue "software" ; - bamm:name "classification" . - -:KeyCharacteristic a bamm:Characteristic ; - bamm:preferredName "Key Characteristic"@en ; - bamm:description "The key characteristic of a local identifier. A specific subset of keys is predefined, but additionally any other custom key is allowed. Predefined keys (to be used when applicable):\n- \"manufacturerId\" - The Business Partner Number (BPN) of the manufacturer. Value: BPN-Nummer\n- \"partInstanceId\" - The identifier of the manufacturer for the serialized instance of the part, e.g. the serial number\n- \"batchId\" - The identifier of the batch, to which the serialzed part belongs\n- \"van\" - The anonymized vehicle identification number (VIN). Value: anonymized VIN according to OEM anonymization rules. Note: If the key \"van\" is available, \"partInstanceId\" must also be available and hold the identical value."@en ; - bamm:dataType xsd:string ; - bamm:name "KeyCharacteristic" . - -:ValueCharacteristic a bamm:Characteristic ; - bamm:preferredName "Value Characteristic"@en ; - bamm:description "The value of an identifier."@en ; - bamm:dataType xsd:string ; - bamm:name "ValueCharacteristic" . - -:ProductionCountryCodeTrait a bamm-c:Trait ; - bamm:preferredName "Production Country Code Trait"@en ; - bamm:description "Trait to ensure standard data format for country code"@en ; - bamm-c:baseCharacteristic :CountryCodeCharacteristic ; - bamm-c:constraint :CountryCodeRegularExpression ; - bamm:name "ProductionCountryCodeTrait" . - -:PartIdCharacteristic a bamm:Characteristic ; - bamm:preferredName "Part ID Characteristic"@en ; - bamm:description "The part ID is a multi-character string, ususally assigned by an ERP system"@en ; - bamm:dataType xsd:string ; - bamm:name "PartIdCharacteristic" . - -:PartNameCharacteristic a bamm:Characteristic ; - bamm:preferredName "Part Name Characteristic"@en ; - bamm:description "Part Name in string format from the respective system in the value chain"@en ; - bamm:dataType xsd:string ; - bamm:name "PartNameCharacteristic" . - -:ClassificationCharacteristic a bamm-c:Enumeration ; - bamm:preferredName "Classification Characteristic"@en ; - bamm:description "A part type must be placed into one of the following classes: 'component', 'product', 'software', �assembly�, 'tool', or 'raw material'."@en ; - bamm:see ; - bamm:dataType xsd:string ; - bamm-c:values ( "product" "raw material" "software" "assembly" "tool" "component" ) ; - bamm:name "ClassificationCharacteristic" . - -:CountryCodeCharacteristic a bamm:Characteristic ; - bamm:preferredName "Country Code Characteristic"@en ; - bamm:description "ISO 3166-1 alpha-3 � three-letter country codes "@en ; - bamm:see ; - bamm:dataType xsd:string ; - bamm:name "CountryCodeCharacteristic" . - -:CountryCodeRegularExpression a bamm-c:RegularExpressionConstraint ; - bamm:preferredName "Country Code Regular Expression"@en ; - bamm:description "Regular Expression that ensures a three-letter code "@en ; - bamm:value "^[A-Z][A-Z][A-Z]$" ; - bamm:name "CountryCodeRegularExpression" . - diff --git a/io.catenax.serial_part_typization/2.0.0/gen/SerialPartTypization-aas.xml b/io.catenax.serial_part_typization/2.0.0/gen/SerialPartTypization-aas.xml deleted file mode 100644 index b751113ec..000000000 --- a/io.catenax.serial_part_typization/2.0.0/gen/SerialPartTypization-aas.xml +++ /dev/null @@ -1,1053 +0,0 @@ - - - - - defaultAdminShell - - - en - defaultAdminShell - - - - urn:samm:io.catenax.serial_part_typization:2.0.0#SerialPartTypization - - Type - - - - ModelReference - - - Submodel - urn:samm:io.catenax.serial_part_typization:2.0.0#SerialPartTypization/submodel - - - - - - - - - SerialPartTypization - - - en - A serialized part is an instantiation of a (design-) part, where the particular instantiation can be uniquely identified by means of a serial numbers or a similar identifier (e.g. VAN) or a combination of multiple identifiers (e.g. combination of manufacturer, date and number) - - - - urn:samm:io.catenax.serial_part_typization:2.0.0#SerialPartTypization/submodel - Template - - ModelReference - - - ConceptDescription - urn:samm:io.catenax.serial_part_typization:2.0.0#SerialPartTypization - - - - - - catenaXId - - - en - Catena-X Identifier - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.serial_part_typization:2.0.0#catenaXId - - - - xs:string - - - - localIdentifiers - - - en - Local Identifiers - - - - - en - A local identifier enables identification of a part in a specific dataspace, but is not unique in Catena-X dataspace. Multiple local identifiers may exist. - - - true - DataElement - - - KeyValueList - - - en - Key Value List - - - - - en - A list of key value pairs for local identifiers, which are composed of a key and a corresponding value. - - - - - key - - - en - Identifier Key - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.serial_part_typization:2.0.0#key - - - - xs:string - - - - value - - - en - Identifier Value - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.serial_part_typization:2.0.0#value - - - - xs:string - - - - - - - - ManufacturingEntity - - - en - Manufacturing Entity - - - - - en - Encapsulates the manufacturing relevant attributes - - - - - date - - - en - Production Date - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.serial_part_typization:2.0.0#date - - - - xs:dateTime - - - - country - - - en - Country code - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.serial_part_typization:2.0.0#country - - - - xs:string - - - - - - PartTypeInformationEntity - - - en - Part Type Information Entity - - - - - en - Encapsulation for data related to the part type - - - - - manufacturerPartId - - - en - Manufacturer Part ID - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.serial_part_typization:2.0.0#manufacturerPartId - - - - xs:string - - - - customerPartId - - - en - Customer Part ID - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.serial_part_typization:2.0.0#customerPartId - - - - xs:string - - - - nameAtManufacturer - - - en - Name at Manufacturer - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.serial_part_typization:2.0.0#nameAtManufacturer - - - - xs:string - - - - nameAtCustomer - - - en - Name at Customer - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.serial_part_typization:2.0.0#nameAtCustomer - - - - xs:string - - - - classification - - - en - Classifcation - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.serial_part_typization:2.0.0#classification - - - - xs:string - - - - - - - - - - APPLICATION_CLASS - SerialPartTypization - - - en - Serial Part Typization - - - - - en - A serialized part is an instantiation of a (design-) part, where the particular instantiation can be uniquely identified by means of a serial numbers or a similar identifier (e.g. VAN) or a combination of multiple identifiers (e.g. combination of manufacturer, date and number) - - - urn:samm:io.catenax.serial_part_typization:2.0.0#SerialPartTypization - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Serial Part Typization - - - - - en - SerialPartTypization - - - - - en - A serialized part is an instantiation of a (design-) part, where the particular instantiation can be uniquely identified by means of a serial numbers or a similar identifier (e.g. VAN) or a combination of multiple identifiers (e.g. combination of manufacturer, date and number) - - - - - - - - - catenaXId - - - en - Catena-X Identifier - - - urn:samm:io.catenax.serial_part_typization:2.0.0#catenaXId - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Catena-X Identifier - - - - - en - catenaXId - - - STRING - - - en - The fully anonymous Catena-X ID of the serialized part, valid for the Catena-X dataspace. - - - - - - - - - key - - - en - Identifier Key - - - urn:samm:io.catenax.serial_part_typization:2.0.0#key - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Identifier Key - - - - - en - key - - - STRING - - - en - The key of a local identifier. - - - - - - - - - value - - - en - Identifier Value - - - urn:samm:io.catenax.serial_part_typization:2.0.0#value - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Identifier Value - - - - - en - value - - - STRING - - - en - The value of an identifier. - - - - - - - - - localIdentifiers - - - en - Local Identifiers - - - urn:samm:io.catenax.serial_part_typization:2.0.0#localIdentifiers - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Local Identifiers - - - - - en - localIdentifiers - - - STRING - - - en - A local identifier enables identification of a part in a specific dataspace, but is not unique in Catena-X dataspace. Multiple local identifiers may exist. - - - - - - - - - date - - - en - Production Date - - - urn:samm:io.catenax.serial_part_typization:2.0.0#date - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Production Date - - - - - en - date - - - STRING - - - en - Timestamp of the manufacturing date as the final step in production process (e.g. final quality check, ready-for-shipment event) - - - - - - - - - country - - - en - Country code - - - urn:samm:io.catenax.serial_part_typization:2.0.0#country - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Country code - - - - - en - country - - - STRING - - - en - Country code where the part was manufactured - - - - - - - - - manufacturingInformation - - - en - Manufacturing Information - - - urn:samm:io.catenax.serial_part_typization:2.0.0#manufacturingInformation - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Manufacturing Information - - - - - en - manufacturingInformation - - - STRING - - - en - Information from manufacturing process, such as manufacturing date and manufacturing country - - - - - - - - - manufacturerPartId - - - en - Manufacturer Part ID - - - urn:samm:io.catenax.serial_part_typization:2.0.0#manufacturerPartId - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Manufacturer Part ID - - - - - en - manufacturerPartId - - - STRING - - - en - Part ID as assigned by the manufacturer of the part. The Part ID identifies the part (as designed) in the manufacturer`s dataspace. The Part ID does not reference a specific instance of a part and thus should not be confused with the serial number. - - - - - - - - - customerPartId - - - en - Customer Part ID - - - urn:samm:io.catenax.serial_part_typization:2.0.0#customerPartId - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Customer Part ID - - - - - en - customerPartId - - - STRING - - - en - Part ID as assigned by the manufacturer of the part. The Part ID identifies the part (as designed) in the customer`s dataspace. The Part ID does not reference a specific instance of a part and thus should not be confused with the serial number. - - - - - - - - - nameAtManufacturer - - - en - Name at Manufacturer - - - urn:samm:io.catenax.serial_part_typization:2.0.0#nameAtManufacturer - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Name at Manufacturer - - - - - en - nameAtManufacturer - - - STRING - - - en - Name of the part as assigned by the manufacturer - - - - - - - - - nameAtCustomer - - - en - Name at Customer - - - urn:samm:io.catenax.serial_part_typization:2.0.0#nameAtCustomer - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Name at Customer - - - - - en - nameAtCustomer - - - STRING - - - en - Name of the part as assigned by the customer - - - - - - - - - classification - - - en - Classifcation - - - urn:samm:io.catenax.serial_part_typization:2.0.0#classification - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Classifcation - - - - - en - classification - - - STRING - - - en - The classification of the part type according to STEP standard definition - - - - - - product - - ModelReference - - - DataElement - urn:samm:io.catenax.serial_part_typization:2.0.0#ClassificationCharacteristic:product - - - - - - raw material - - ModelReference - - - DataElement - urn:samm:io.catenax.serial_part_typization:2.0.0#ClassificationCharacteristic:raw material - - - - - - software - - ModelReference - - - DataElement - urn:samm:io.catenax.serial_part_typization:2.0.0#ClassificationCharacteristic:software - - - - - - assembly - - ModelReference - - - DataElement - urn:samm:io.catenax.serial_part_typization:2.0.0#ClassificationCharacteristic:assembly - - - - - - tool - - ModelReference - - - DataElement - urn:samm:io.catenax.serial_part_typization:2.0.0#ClassificationCharacteristic:tool - - - - - - component - - ModelReference - - - DataElement - urn:samm:io.catenax.serial_part_typization:2.0.0#ClassificationCharacteristic:component - - - - - - - - - - - - - partTypeInformation - - - en - Part Type Information - - - urn:samm:io.catenax.serial_part_typization:2.0.0#partTypeInformation - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Part Type Information - - - - - en - partTypeInformation - - - STRING - - - en - The part type from which the serialized part has been instantiated - - - - - - - - - diff --git a/io.catenax.serial_part_typization/2.0.0/gen/SerialPartTypization-schema.json b/io.catenax.serial_part_typization/2.0.0/gen/SerialPartTypization-schema.json deleted file mode 100644 index 82bb5d57a..000000000 --- a/io.catenax.serial_part_typization/2.0.0/gen/SerialPartTypization-schema.json +++ /dev/null @@ -1,129 +0,0 @@ -{ - "$schema" : "http://json-schema.org/draft-04/schema", - "description" : "A serialized part is an instantiation of a (design-) part, where the particular instantiation can be uniquely identified by means of a serial numbers or a similar identifier (e.g. VAN) or a combination of multiple identifiers (e.g. combination of manufacturer, date and number)", - "type" : "object", - "components" : { - "schemas" : { - "urn_bamm_io.catenax.serial_part_typization_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_bamm_io.catenax.serial_part_typization_2.0.0_KeyCharacteristic" : { - "type" : "string", - "description" : "The key characteristic of a local identifier. A specific subset of keys is predefined, but additionally any other custom key is allowed. Predefined keys (to be used when applicable):\n- \"manufacturerId\" - The Business Partner Number (BPN) of the manufacturer. Value: BPN-Nummer\n- \"partInstanceId\" - The identifier of the manufacturer for the serialized instance of the part, e.g. the serial number\n- \"batchId\" - The identifier of the batch, to which the serialzed part belongs\n- \"van\" - The anonymized vehicle identification number (VIN). Value: anonymized VIN according to OEM anonymization rules. Note: If the key \"van\" is available, \"partInstanceId\" must also be available and hold the identical value." - }, - "urn_bamm_io.catenax.serial_part_typization_2.0.0_ValueCharacteristic" : { - "type" : "string", - "description" : "The value of an identifier." - }, - "urn_bamm_io.catenax.serial_part_typization_2.0.0_KeyValueList" : { - "description" : "A list of key value pairs for local identifiers, which are composed of a key and a corresponding value.", - "type" : "object", - "properties" : { - "key" : { - "description" : "The key of a local identifier. ", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.serial_part_typization_2.0.0_KeyCharacteristic" - }, - "value" : { - "description" : "The value of an identifier.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.serial_part_typization_2.0.0_ValueCharacteristic" - } - }, - "required" : [ "key", "value" ] - }, - "urn_bamm_io.catenax.serial_part_typization_2.0.0_LocalIdentifierCharacteristic" : { - "description" : "A single serialized part may have multiple attributes, that uniquely identify a that part in a specific dataspace (e.g. the manufacturer`s dataspace)", - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/urn_bamm_io.catenax.serial_part_typization_2.0.0_KeyValueList" - }, - "uniqueItems" : true - }, - "urn_bamm_io.openmanufacturing_characteristic_2.0.0_Timestamp" : { - "type" : "string", - "pattern" : "-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T(([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](\\.[0-9]+)?|(24:00:00(\\.0+)?))(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?", - "description" : "Describes a Property which contains the date and time with an optional timezone." - }, - "urn_bamm_io.catenax.serial_part_typization_2.0.0_ProductionCountryCodeTrait" : { - "type" : "string", - "description" : "Regular Expression that ensures a three-letter code ", - "pattern" : "^[A-Z][A-Z][A-Z]$" - }, - "urn_bamm_io.catenax.serial_part_typization_2.0.0_ManufacturingCharacteristic" : { - "description" : "Characteristic to describe manufacturing related data", - "type" : "object", - "properties" : { - "date" : { - "description" : "Timestamp of the manufacturing date as the final step in production process (e.g. final quality check, ready-for-shipment event)", - "$ref" : "#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Timestamp" - }, - "country" : { - "description" : "Country code where the part was manufactured", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.serial_part_typization_2.0.0_ProductionCountryCodeTrait" - } - }, - "required" : [ "date" ] - }, - "urn_bamm_io.catenax.serial_part_typization_2.0.0_PartIdCharacteristic" : { - "type" : "string", - "description" : "The part ID is a multi-character string, ususally assigned by an ERP system" - }, - "urn_bamm_io.catenax.serial_part_typization_2.0.0_PartNameCharacteristic" : { - "type" : "string", - "description" : "Part Name in string format from the respective system in the value chain" - }, - "urn_bamm_io.catenax.serial_part_typization_2.0.0_ClassificationCharacteristic" : { - "type" : "string", - "description" : "A part type must be placed into one of the following classes: 'component', 'product', 'software', �assembly�, 'tool', or 'raw material'.", - "enum" : [ "product", "raw material", "software", "assembly", "tool", "component" ] - }, - "urn_bamm_io.catenax.serial_part_typization_2.0.0_PartTypeInformationCharacteristic" : { - "description" : "The characteristics of the part type", - "type" : "object", - "properties" : { - "manufacturerPartId" : { - "description" : "Part ID as assigned by the manufacturer of the part. The Part ID identifies the part (as designed) in the manufacturer`s dataspace. The Part ID does not reference a specific instance of a part and thus should not be confused with the serial number.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.serial_part_typization_2.0.0_PartIdCharacteristic" - }, - "customerPartId" : { - "description" : "Part ID as assigned by the manufacturer of the part. The Part ID identifies the part (as designed) in the customer`s dataspace. The Part ID does not reference a specific instance of a part and thus should not be confused with the serial number.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.serial_part_typization_2.0.0_PartIdCharacteristic" - }, - "nameAtManufacturer" : { - "description" : "Name of the part as assigned by the manufacturer", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.serial_part_typization_2.0.0_PartNameCharacteristic" - }, - "nameAtCustomer" : { - "description" : "Name of the part as assigned by the customer", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.serial_part_typization_2.0.0_PartNameCharacteristic" - }, - "classification" : { - "description" : "The classification of the part type according to STEP standard definition", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.serial_part_typization_2.0.0_ClassificationCharacteristic" - } - }, - "required" : [ "manufacturerPartId", "nameAtManufacturer", "classification" ] - } - } - }, - "properties" : { - "catenaXId" : { - "description" : "The fully anonymous Catena-X ID of the serialized part, valid for the Catena-X dataspace.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.serial_part_typization_2.0.0_CatenaXIdTrait" - }, - "localIdentifiers" : { - "description" : "A local identifier enables identification of a part in a specific dataspace, but is not unique in Catena-X dataspace. Multiple local identifiers may exist.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.serial_part_typization_2.0.0_LocalIdentifierCharacteristic" - }, - "manufacturingInformation" : { - "description" : "Information from manufacturing process, such as manufacturing date and manufacturing country", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.serial_part_typization_2.0.0_ManufacturingCharacteristic" - }, - "partTypeInformation" : { - "description" : "The part type from which the serialized part has been instantiated", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.serial_part_typization_2.0.0_PartTypeInformationCharacteristic" - } - }, - "required" : [ "catenaXId", "localIdentifiers", "manufacturingInformation", "partTypeInformation" ] -} \ No newline at end of file diff --git a/io.catenax.serial_part_typization/2.0.0/gen/SerialPartTypization.aasx b/io.catenax.serial_part_typization/2.0.0/gen/SerialPartTypization.aasx deleted file mode 100644 index 59c9fb56a..000000000 Binary files a/io.catenax.serial_part_typization/2.0.0/gen/SerialPartTypization.aasx and /dev/null differ diff --git a/io.catenax.serial_part_typization/2.0.0/gen/SerialPartTypization.html b/io.catenax.serial_part_typization/2.0.0/gen/SerialPartTypization.html deleted file mode 100644 index 038d18a05..000000000 --- a/io.catenax.serial_part_typization/2.0.0/gen/SerialPartTypization.html +++ /dev/null @@ -1,1152 +0,0 @@ - - - - - - - - - - - - - - Dokumentation Serial Part Typization - - -
-
-
-
-

Aspect Model Serial Part Typization

-
urn:bamm:io.catenax.serial_part_typization:2.0.0#SerialPartTypization
-
-
-
-
-
-
-
- -
- - -
- A serialized part is an instantiation of a (design-) part, where the particular instantiation can be uniquely identified by means of a serial numbers or a similar identifier (e.g. VAN) or a combination of multiple identifiers (e.g. combination of manufacturer, date and number) -
- - -
-

Übersicht

-
-
-
-
- Aspect Model Diagram -
-
-
- - -
-
-

Properties

-
- -
- -
-

Catena-X Identifier

-
- -The fully anonymous Catena-X ID of the serialized part, valid for the Catena-X dataspace. - -
-
Name
-
catenaXId
-
- - - -
-
Characteristic
-
-
-
-
Trait
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Beispiel
-
urn:uuid:580d3adf-1981-44a0-a214-13d6ceed9379
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
catenaXId
-
- - -
-
Bedingungen
-
-
    -
  • -
    - -
    - Catena-X Id Regular Expression -
    - -
    -
    Beschreibung
    -
    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.
    -
    - -
    -
    Referenz
    -
    -
    -
      -
    • https://datatracker.ietf.org/doc/html/rfc4122
      • -
    -
    -
    -
    - -
    -
    Regulärer Ausdruck
    -
    (^[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}$)
    -
    - -
    • -
-
-
-
-
- -
-

Local Identifiers

-
- -A local identifier enables identification of a part in a specific dataspace, but is not unique in Catena-X dataspace. Multiple local identifiers may exist. - -
-
Name
-
localIdentifiers
-
- - - -
-
Characteristic
-
-
-
-
Set
-
-
-
Has no order
-
-
-
Duplicates not allowed
-
-
-
- Typ urn:bamm:io.catenax.serial_part_typization:2.0.0#KeyValueList - -
-
-
-
-
- - -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
localIdentifiers
-
- - -
-
- -
-

Manufacturing Information

-
- -Information from manufacturing process, such as manufacturing date and manufacturing country - -
-
Name
-
manufacturingInformation
-
- - - -
-
Characteristic
-
-
-
-
SingleEntity
-
-
-
- Typ urn:bamm:io.catenax.serial_part_typization:2.0.0#ManufacturingEntity - -
-
-
-
-
- - -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
manufacturingInformation
-
- - -
-
- -
-

Part Type Information

-
- -The part type from which the serialized part has been instantiated - -
-
Name
-
partTypeInformation
-
- - - -
-
Characteristic
-
-
-
-
SingleEntity
-
-
-
- Typ urn:bamm:io.catenax.serial_part_typization:2.0.0#PartTypeInformationEntity - -
-
-
-
-
- - -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
partTypeInformation
-
- - -
-
- - - -
-
-

Objekt

-
- -
-
-

Key Value List

-
-
- A list of key value pairs for local identifiers, which are composed of a key and a corresponding value. -
- -
-

Properties

-
-
- -
-
Identifier Key
-
- -The key of a local identifier. - -
-
Name
-
key
-
- - - -
-
Characteristic
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Beispiel
-
PartInstanceID
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
key
-
- - -
-
- -
-
Identifier Value
-
- -The value of an identifier. - -
-
Name
-
value
-
- - - -
-
Characteristic
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Beispiel
-
SN12345678
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
value
-
- - -
-
-
-
-

Manufacturing Entity

-
-
- Encapsulates the manufacturing relevant attributes -
- -
-

Properties

-
-
- -
-
Production Date
-
- -Timestamp of the manufacturing date as the final step in production process (e.g. final quality check, ready-for-shipment event) - -
-
Name
-
date
-
- - - -
-
Characteristic
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#dateTime - -
-
-
-
-
- -
-
Beispiel
-
2022-02-04T14:48:54
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
date
-
- - -
-
- -
-
Country code
-
- -Country code where the part was manufactured - -
-
Name
-
country
-
- - - -
-
Characteristic
-
-
-
-
Trait
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Beispiel
-
HUR
-
- -
-
Optional
-
- Ja
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
country
-
- - -
-
Bedingungen
-
-
    -
  • -
    - -
    - Country Code Regular Expression -
    - -
    -
    Beschreibung
    -
    Regular Expression that ensures a three-letter code
    -
    - - -
    -
    Regulärer Ausdruck
    -
    ^[A-Z][A-Z][A-Z]$
    -
    - -
    • -
-
-
-
-
-
-
-

Part Type Information Entity

-
-
- Encapsulation for data related to the part type -
- -
-

Properties

-
-
- -
-
Manufacturer Part ID
-
- -Part ID as assigned by the manufacturer of the part. The Part ID identifies the part (as designed) in the manufacturer`s dataspace. The Part ID does not reference a specific instance of a part and thus should not be confused with the serial number. - -
-
Name
-
manufacturerPartId
-
- - - -
-
Characteristic
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Beispiel
-
123-0.740-3434-A
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
manufacturerPartId
-
- - -
-
- -
-
Customer Part ID
-
- -Part ID as assigned by the manufacturer of the part. The Part ID identifies the part (as designed) in the customer`s dataspace. The Part ID does not reference a specific instance of a part and thus should not be confused with the serial number. - -
-
Name
-
customerPartId
-
- - - -
-
Characteristic
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Beispiel
-
PRT-12345
-
- -
-
Optional
-
- Ja
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
customerPartId
-
- - -
-
- -
-
Name at Manufacturer
-
- -Name of the part as assigned by the manufacturer - -
-
Name
-
nameAtManufacturer
-
- - - -
-
Characteristic
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Beispiel
-
Mirror left
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
nameAtManufacturer
-
- - -
-
- -
-
Name at Customer
-
- -Name of the part as assigned by the customer - -
-
Name
-
nameAtCustomer
-
- - - -
-
Characteristic
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Beispiel
-
side element A
-
- -
-
Optional
-
- Ja
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
nameAtCustomer
-
- - -
-
- -
-
Classifcation
-
- -The classification of the part type according to STEP standard definition - -
-
Name
-
classification
-
- - - -
-
Characteristic
-
-
-
-
Enumeration
-
-
-
Werte
-
-
-
-
    -
  • product
    • -
  • raw material
    • -
  • software
    • -
  • assembly
    • -
  • tool
    • -
  • component
    • -
-
-
-
-
- Referenz -
-
    -
  • http://private.pdm-if.org/web/pdm-if/recommended-practices1
    • -
-
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Beispiel
-
software
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
classification
-
- - -
-
-
- -
- Third party licenses - -
- -
- - -
- - - \ No newline at end of file diff --git a/io.catenax.serial_part_typization/2.0.0/gen/SerialPartTypization.json b/io.catenax.serial_part_typization/2.0.0/gen/SerialPartTypization.json deleted file mode 100644 index 200d12e3e..000000000 --- a/io.catenax.serial_part_typization/2.0.0/gen/SerialPartTypization.json +++ /dev/null @@ -1,18 +0,0 @@ -{ - "localIdentifiers" : [ { - "value" : "SN12345678", - "key" : "PartInstanceID" - } ], - "manufacturingInformation" : { - "date" : "2022-02-04T14:48:54", - "country" : "HUR" - }, - "catenaXId" : "urn:uuid:580d3adf-1981-44a0-a214-13d6ceed9379", - "partTypeInformation" : { - "manufacturerPartId" : "123-0.740-3434-A", - "customerPartId" : "PRT-12345", - "classification" : "product", - "nameAtManufacturer" : "Mirror left", - "nameAtCustomer" : "side element A" - } -} \ No newline at end of file diff --git a/io.catenax.serial_part_typization/2.0.0/gen/SerialPartTypization.yml b/io.catenax.serial_part_typization/2.0.0/gen/SerialPartTypization.yml deleted file mode 100644 index 3178e06e0..000000000 --- a/io.catenax.serial_part_typization/2.0.0/gen/SerialPartTypization.yml +++ /dev/null @@ -1,262 +0,0 @@ ---- -openapi: 3.0.3 -info: - title: Serial Part Typization - version: v2 -servers: -- url: catenax.io/api/v2 - variables: - api-version: - default: v2 -paths: - /{tenant-id}/serial-part-typization: - get: - tags: - - SerialPartTypization - operationId: getSerialPartTypization - 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/SerialPartTypization' - "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/SerialPartTypization' - totalItems: - type: number - totalPages: - type: number - pageSize: - type: number - currentPage: - type: number - urn_bamm_io.catenax.serial_part_typization_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_bamm_io.catenax.serial_part_typization_2.0.0_KeyCharacteristic: - type: string - description: |- - The key characteristic of a local identifier. A specific subset of keys is predefined, but additionally any other custom key is allowed. Predefined keys (to be used when applicable): - - "manufacturerId" - The Business Partner Number (BPN) of the manufacturer. Value: BPN-Nummer - - "partInstanceId" - The identifier of the manufacturer for the serialized instance of the part, e.g. the serial number - - "batchId" - The identifier of the batch, to which the serialzed part belongs - - "van" - The anonymized vehicle identification number (VIN). Value: anonymized VIN according to OEM anonymization rules. Note: If the key "van" is available, "partInstanceId" must also be available and hold the identical value. - urn_bamm_io.catenax.serial_part_typization_2.0.0_ValueCharacteristic: - type: string - description: The value of an identifier. - urn_bamm_io.catenax.serial_part_typization_2.0.0_KeyValueList: - description: "A list of key value pairs for local identifiers, which are composed\ - \ of a key and a corresponding value." - type: object - properties: - key: - description: 'The key of a local identifier. ' - $ref: '#/components/schemas/urn_bamm_io.catenax.serial_part_typization_2.0.0_KeyCharacteristic' - value: - description: The value of an identifier. - $ref: '#/components/schemas/urn_bamm_io.catenax.serial_part_typization_2.0.0_ValueCharacteristic' - required: - - key - - value - urn_bamm_io.catenax.serial_part_typization_2.0.0_LocalIdentifierCharacteristic: - description: "A single serialized part may have multiple attributes, that uniquely\ - \ identify a that part in a specific dataspace (e.g. the manufacturer`s dataspace)" - type: array - items: - $ref: '#/components/schemas/urn_bamm_io.catenax.serial_part_typization_2.0.0_KeyValueList' - uniqueItems: true - urn_bamm_io.openmanufacturing_characteristic_2.0.0_Timestamp: - type: string - pattern: "-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T(([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](\\\ - .[0-9]+)?|(24:00:00(\\.0+)?))(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?" - description: Describes a Property which contains the date and time with an optional - timezone. - urn_bamm_io.catenax.serial_part_typization_2.0.0_ProductionCountryCodeTrait: - type: string - description: 'Regular Expression that ensures a three-letter code ' - pattern: "^[A-Z][A-Z][A-Z]$" - urn_bamm_io.catenax.serial_part_typization_2.0.0_ManufacturingCharacteristic: - description: Characteristic to describe manufacturing related data - type: object - properties: - date: - description: "Timestamp of the manufacturing date as the final step in production\ - \ process (e.g. final quality check, ready-for-shipment event)" - $ref: '#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Timestamp' - country: - description: Country code where the part was manufactured - $ref: '#/components/schemas/urn_bamm_io.catenax.serial_part_typization_2.0.0_ProductionCountryCodeTrait' - required: - - date - urn_bamm_io.catenax.serial_part_typization_2.0.0_PartIdCharacteristic: - type: string - description: "The part ID is a multi-character string, ususally assigned by\ - \ an ERP system" - urn_bamm_io.catenax.serial_part_typization_2.0.0_PartNameCharacteristic: - type: string - description: Part Name in string format from the respective system in the value - chain - urn_bamm_io.catenax.serial_part_typization_2.0.0_ClassificationCharacteristic: - type: string - description: "A part type must be placed into one of the following classes:\ - \ 'component', 'product', 'software', �assembly�, 'tool', or 'raw material'." - enum: - - product - - raw material - - software - - assembly - - tool - - component - urn_bamm_io.catenax.serial_part_typization_2.0.0_PartTypeInformationCharacteristic: - description: The characteristics of the part type - type: object - properties: - manufacturerPartId: - description: Part ID as assigned by the manufacturer of the part. The Part - ID identifies the part (as designed) in the manufacturer`s dataspace. - The Part ID does not reference a specific instance of a part and thus - should not be confused with the serial number. - $ref: '#/components/schemas/urn_bamm_io.catenax.serial_part_typization_2.0.0_PartIdCharacteristic' - customerPartId: - description: Part ID as assigned by the manufacturer of the part. The Part - ID identifies the part (as designed) in the customer`s dataspace. The - Part ID does not reference a specific instance of a part and thus should - not be confused with the serial number. - $ref: '#/components/schemas/urn_bamm_io.catenax.serial_part_typization_2.0.0_PartIdCharacteristic' - nameAtManufacturer: - description: Name of the part as assigned by the manufacturer - $ref: '#/components/schemas/urn_bamm_io.catenax.serial_part_typization_2.0.0_PartNameCharacteristic' - nameAtCustomer: - description: Name of the part as assigned by the customer - $ref: '#/components/schemas/urn_bamm_io.catenax.serial_part_typization_2.0.0_PartNameCharacteristic' - classification: - description: The classification of the part type according to STEP standard - definition - $ref: '#/components/schemas/urn_bamm_io.catenax.serial_part_typization_2.0.0_ClassificationCharacteristic' - required: - - manufacturerPartId - - nameAtManufacturer - - classification - SerialPartTypization: - description: "A serialized part is an instantiation of a (design-) part, where\ - \ the particular instantiation can be uniquely identified by means of a serial\ - \ numbers or a similar identifier (e.g. VAN) or a combination of multiple\ - \ identifiers (e.g. combination of manufacturer, date and number)" - type: object - properties: - catenaXId: - description: "The fully anonymous Catena-X ID of the serialized part, valid\ - \ for the Catena-X dataspace." - $ref: '#/components/schemas/urn_bamm_io.catenax.serial_part_typization_2.0.0_CatenaXIdTrait' - localIdentifiers: - description: "A local identifier enables identification of a part in a specific\ - \ dataspace, but is not unique in Catena-X dataspace. Multiple local identifiers\ - \ may exist." - $ref: '#/components/schemas/urn_bamm_io.catenax.serial_part_typization_2.0.0_LocalIdentifierCharacteristic' - manufacturingInformation: - description: "Information from manufacturing process, such as manufacturing\ - \ date and manufacturing country" - $ref: '#/components/schemas/urn_bamm_io.catenax.serial_part_typization_2.0.0_ManufacturingCharacteristic' - partTypeInformation: - description: The part type from which the serialized part has been instantiated - $ref: '#/components/schemas/urn_bamm_io.catenax.serial_part_typization_2.0.0_PartTypeInformationCharacteristic' - required: - - catenaXId - - localIdentifiers - - manufacturingInformation - - partTypeInformation - 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' - SerialPartTypization: - content: - application/json: - schema: - $ref: '#/components/schemas/PagingSchema' - description: The request was successful. - requestBodies: - SerialPartTypization: - content: - application/json: - schema: - $ref: '#/components/schemas/SerialPartTypization' diff --git a/io.catenax.serial_part_typization/2.0.0/metadata.json b/io.catenax.serial_part_typization/2.0.0/metadata.json deleted file mode 100644 index 9e759dfb1..000000000 --- a/io.catenax.serial_part_typization/2.0.0/metadata.json +++ /dev/null @@ -1 +0,0 @@ -{ "status" : "deprecate"} diff --git a/io.catenax.single_level_bom_as_planned/1.0.1/SingleLevelBomAsPlanned.ttl b/io.catenax.single_level_bom_as_planned/1.0.1/SingleLevelBomAsPlanned.ttl deleted file mode 100644 index c33e9c126..000000000 --- a/io.catenax.single_level_bom_as_planned/1.0.1/SingleLevelBomAsPlanned.ttl +++ /dev/null @@ -1,127 +0,0 @@ -####################################################################### -# Copyright (c) 2022 BASF SE -# Copyright (c) 2022 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) -# Copyright (c) 2022 Fraunhofer-Gesellschaft zur Foerderung der angewandten Forschung e.V. (represented by Fraunhofer ISST & Fraunhofer IML) -# Copyright (c) 2022 German Edge Cloud GmbH & Co. KG -# Copyright (c) 2022 Henkel AG & Co. KGaA -# Copyright (c) 2022 Mercedes Benz AG -# Copyright (c) 2022 Robert Bosch Manufacturing Solutions GmbH -# Copyright (c) 2022 SAP SE -# Copyright (c) 2022 Siemens AG -# Copyright (c) 2022 T-Systems International GmbH -# Copyright (c) 2022 ZF Friedrichshafen AG -# Copyright (c) 2022 Contributors to the Eclipse Foundation -# -# 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 bamm: . -@prefix bamm-c: . -@prefix bamm-e: . -@prefix unit: . -@prefix rdf: . -@prefix rdfs: . -@prefix xsd: . -@prefix : . - -:catenaXId a bamm:Property; - bamm:name "catenaXId"; - bamm:preferredName "Catena-X Identifier"@en; - bamm:description "The Catena-X ID of the given part (e.g. the component), valid for the Catena-X dataspace."@en; - bamm:characteristic :CatenaXIdTraitCharacteristic; - bamm:exampleValue "urn:uuid:055c1128-0375-47c8-98de-7cf802c3241d". -:CatenaXIdTraitCharacteristic a bamm-c:Trait; - bamm:name "CatenaXIdTraitCharacteristic"; - bamm:description "Trait to ensure UUID v4 data format"@en; - bamm-c:baseCharacteristic :UUIDv4Characteristic; - bamm-c:constraint :UUIDv4RegularExpression. -:childParts a bamm:Property; - bamm:name "childParts"; - bamm:preferredName "Child Parts"@en; - bamm:description "Set of child parts in As-Planned lifecycle phase, of which the given parent object is assembled by (one structural level down)."@en; - bamm:characteristic :SetOfChildPartsCharacteristic. -:SetOfChildPartsCharacteristic a bamm-c:Set; - bamm:name "SetOfChildPartsCharacteristic"; - bamm:preferredName "Set of Child Parts"@en; - bamm:description "Set of child parts the parent object is assembled by (one structural level down)."@en; - bamm:dataType :ChildData. -:UUIDv4Characteristic a bamm:Characteristic; - bamm:name "UUIDv4Characteristic"; - bamm:preferredName "UUID v4"@en; - bamm:description "A version 4 UUID is a universally unique identifier that is generated using random 32 hexadecimal characters."@en; - bamm:dataType xsd:string; - bamm:see . -:UUIDv4RegularExpression a bamm-c:RegularExpressionConstraint; - bamm:name "UUIDv4RegularExpression"; - bamm:preferredName "Catena-X Id Regular Expression"@en; - bamm: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."@en; - bamm:see ; - bamm:value "(^[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}$)". -:ChildData a bamm:Entity; - bamm:name "ChildData"; - bamm:preferredName "Child Data"@en; - bamm:description "Catena-X ID and meta data of the child part."@en; - bamm:properties (:createdOn :quantity [ - bamm:property :lastModifiedOn; - bamm:optional "true"^^xsd:boolean -] :childCatenaXId). -:createdOn a bamm:Property; - bamm:name "createdOn"; - bamm:preferredName "Created On"@en; - bamm:description "Timestamp when the relation between the parent part and the child part was created"@en; - bamm:characteristic bamm-c:Timestamp; - bamm:exampleValue "2022-02-03T14:48:54.709Z"^^xsd:dateTime. -:quantity a bamm:Property; - bamm:name "quantity"; - bamm:preferredName "Quantity"@en; - bamm:description "Quantity of which the child part is assembled into the parent part."@en; - bamm:characteristic :QuantityCharacteristic. -:lastModifiedOn a bamm:Property; - bamm:name "lastModifiedOn"; - bamm:preferredName "Last Modification Date"@en; - bamm:description "Timestamp when the relationship between parent part and child part was last modified."@en; - bamm:characteristic bamm-c:Timestamp; - bamm:exampleValue "2022-02-03T14:48:54.709Z"^^xsd:dateTime. -:childCatenaXId a bamm:Property; - bamm:name "childCatenaXId"; - bamm:preferredName "Catena-X Child Identifier"@en; - bamm:description "The Catena-X ID of the child object which is assembled into the given parent part."@en; - bamm:characteristic :CatenaXIdTraitCharacteristic. -:QuantityCharacteristic a bamm-c:Quantifiable; - bamm:name "QuantityCharacteristic"; - bamm:description "Describes the quantity in which the child part is assembled in the given parent object by providing a quantity value and the measurement unit in which the quantity is measured."@en; - bamm:dataType :Quantity. -:Quantity a bamm:Entity; - bamm:name "Quantity"; - bamm:description "Comprises the number of objects and the unit of measurement for the respective child objects"@en; - bamm:properties (:quantityNumber :measurementUnit). -:quantityNumber a bamm:Property; - bamm:name "quantityNumber"; - bamm:preferredName "Quantity Number"@en; - bamm:description "The number of objects related to the measurement unit"@en; - bamm:characteristic :NumberofObjects; - bamm:exampleValue "2.5"^^xsd:double. -:measurementUnit a bamm:Property; - bamm:name "measurementUnit"; - bamm:description "Unit of Measurement for the quantity of serialized objects"@en; - bamm:characteristic bamm-c:UnitReference; - bamm:exampleValue "litre"^^bamm:curie; - bamm:see . -:NumberofObjects a bamm:Characteristic; - bamm:name "NumberofObjects"; - bamm:description "Quantifiable number of objects in reference to the measurementUnit"@en; - bamm:dataType xsd:double. -:SingleLevelBomAsPlanned a bamm:Aspect; - bamm:name "SingleLevelBomAsPlanned"; - bamm:preferredName "Single level bill of material as planned"@en; - bamm:description "The single-level Bill of Material represents one sub-level of an assembly and does not include any lower-level subassemblies. In As-Planned lifecycle state all variants are covered (\"120% BOM\"). It includes multiple suppliers for the same component."@en; - bamm:properties (:catenaXId :childParts); - bamm:operations (). diff --git a/io.catenax.single_level_bom_as_planned/1.0.1/gen/SingleLevelBomAsPlanned-aas.xml b/io.catenax.single_level_bom_as_planned/1.0.1/gen/SingleLevelBomAsPlanned-aas.xml deleted file mode 100644 index e25b05e32..000000000 --- a/io.catenax.single_level_bom_as_planned/1.0.1/gen/SingleLevelBomAsPlanned-aas.xml +++ /dev/null @@ -1,643 +0,0 @@ - - - - - defaultAdminShell - - - en - defaultAdminShell - - - - urn:samm:io.catenax.single_level_bom_as_planned:1.0.1#SingleLevelBomAsPlanned - - Type - - - - ModelReference - - - Submodel - urn:samm:io.catenax.single_level_bom_as_planned:1.0.1#SingleLevelBomAsPlanned/submodel - - - - - - - - - SingleLevelBomAsPlanned - - - en - The single-level Bill of Material represents one sub-level of an assembly and does not include any lower-level subassemblies. In As-Planned lifecycle state all variants are covered ("120% BOM"). It includes multiple suppliers for the same component. - - - - urn:samm:io.catenax.single_level_bom_as_planned:1.0.1#SingleLevelBomAsPlanned/submodel - Template - - ModelReference - - - ConceptDescription - urn:samm:io.catenax.single_level_bom_as_planned:1.0.1#SingleLevelBomAsPlanned - - - - - - catenaXId - - - en - Catena-X Identifier - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.single_level_bom_as_planned:1.0.1#catenaXId - - - - xs:string - - - - childParts - - - en - Child Parts - - - - - en - Set of child parts in As-Planned lifecycle phase, of which the given parent object is assembled by (one structural level down). - - - true - DataElement - - - ChildData - - - en - Child Data - - - - - en - Catena-X ID and meta data of the child part. - - - - - createdOn - - - en - Created On - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.single_level_bom_as_planned:1.0.1#createdOn - - - - xs:dateTime - - - - Quantity - - - en - Comprises the number of objects and the unit of measurement for the respective child objects - - - - - quantityNumber - - - en - Quantity Number - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.single_level_bom_as_planned:1.0.1#quantityNumber - - - - xs:double - - - - measurementUnit - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.single_level_bom_as_planned:1.0.1#measurementUnit - - - - - - ExternalReference - - - GlobalReference - https://openmanufacturingplatform.github.io/sds-bamm-aspect-meta-model/bamm-specification/snapshot/appendix/unitcatalog.html - - - - - xs:string - - - - - - lastModifiedOn - - - en - Last Modification Date - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.single_level_bom_as_planned:1.0.1#lastModifiedOn - - - - xs:dateTime - - - - childCatenaXId - - - en - Catena-X Child Identifier - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.single_level_bom_as_planned:1.0.1#childCatenaXId - - - - xs:string - - - - - - - - - - - - APPLICATION_CLASS - SingleLevelBomAsPlanned - - - en - Single level bill of material as planned - - - - - en - The single-level Bill of Material represents one sub-level of an assembly and does not include any lower-level subassemblies. In As-Planned lifecycle state all variants are covered ("120% BOM"). It includes multiple suppliers for the same component. - - - urn:samm:io.catenax.single_level_bom_as_planned:1.0.1#SingleLevelBomAsPlanned - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Single level bill of material as planned - - - - - en - SingleLevelBomAsPlanned - - - - - en - The single-level Bill of Material represents one sub-level of an assembly and does not include any lower-level subassemblies. In As-Planned lifecycle state all variants are covered ("120% BOM"). It includes multiple suppliers for the same component. - - - - - - - - - catenaXId - - - en - Catena-X Identifier - - - urn:samm:io.catenax.single_level_bom_as_planned:1.0.1#catenaXId - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Catena-X Identifier - - - - - en - catenaXId - - - STRING - - - en - The Catena-X ID of the given part (e.g. the component), valid for the Catena-X dataspace. - - - - - - - - - createdOn - - - en - Created On - - - urn:samm:io.catenax.single_level_bom_as_planned:1.0.1#createdOn - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Created On - - - - - en - createdOn - - - STRING - - - en - Timestamp when the relation between the parent part and the child part was created - - - - - - - - - quantityNumber - - - en - Quantity Number - - - urn:samm:io.catenax.single_level_bom_as_planned:1.0.1#quantityNumber - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Quantity Number - - - - - en - quantityNumber - - - REAL_MEASURE - - - en - The number of objects related to the measurement unit - - - - - - - - - measurementUnit - urn:samm:io.catenax.single_level_bom_as_planned:1.0.1#measurementUnit - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - measurementUnit - - - - - en - measurementUnit - - - STRING - - - en - Unit of Measurement for the quantity of serialized objects - - - - - - - - - quantity - - - en - Quantity - - - urn:samm:io.catenax.single_level_bom_as_planned:1.0.1#quantity - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Quantity - - - - - en - quantity - - - STRING - - - en - Quantity of which the child part is assembled into the parent part. - - - - - - - - - lastModifiedOn - - - en - Last Modification Date - - - urn:samm:io.catenax.single_level_bom_as_planned:1.0.1#lastModifiedOn - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Last Modification Date - - - - - en - lastModifiedOn - - - STRING - - - en - Timestamp when the relationship between parent part and child part was last modified. - - - - - - - - - childCatenaXId - - - en - Catena-X Child Identifier - - - urn:samm:io.catenax.single_level_bom_as_planned:1.0.1#childCatenaXId - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Catena-X Child Identifier - - - - - en - childCatenaXId - - - STRING - - - en - The Catena-X ID of the child object which is assembled into the given parent part. - - - - - - - - - childParts - - - en - Child Parts - - - urn:samm:io.catenax.single_level_bom_as_planned:1.0.1#childParts - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Child Parts - - - - - en - childParts - - - STRING - - - en - Set of child parts in As-Planned lifecycle phase, of which the given parent object is assembled by (one structural level down). - - - - - - - - - diff --git a/io.catenax.single_level_bom_as_planned/1.0.1/gen/SingleLevelBomAsPlanned-schema.json b/io.catenax.single_level_bom_as_planned/1.0.1/gen/SingleLevelBomAsPlanned-schema.json deleted file mode 100644 index de6097849..000000000 --- a/io.catenax.single_level_bom_as_planned/1.0.1/gen/SingleLevelBomAsPlanned-schema.json +++ /dev/null @@ -1,85 +0,0 @@ -{ - "$schema" : "http://json-schema.org/draft-04/schema", - "description" : "The single-level Bill of Material represents one sub-level of an assembly and does not include any lower-level subassemblies. In As-Planned lifecycle state all variants are covered (\"120% BOM\"). It includes multiple suppliers for the same component.", - "type" : "object", - "components" : { - "schemas" : { - "urn_bamm_io.catenax.single_level_bom_as_planned_1.0.1_CatenaXIdTraitCharacteristic" : { - "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_bamm_io.openmanufacturing_characteristic_2.0.0_Timestamp" : { - "type" : "string", - "pattern" : "-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T(([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](\\.[0-9]+)?|(24:00:00(\\.0+)?))(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?", - "description" : "Describes a Property which contains the date and time with an optional timezone." - }, - "urn_bamm_io.catenax.single_level_bom_as_planned_1.0.1_NumberofObjects" : { - "type" : "number", - "description" : "Quantifiable number of objects in reference to the measurementUnit" - }, - "urn_bamm_io.openmanufacturing_characteristic_2.0.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_bamm_io.catenax.single_level_bom_as_planned_1.0.1_QuantityCharacteristic" : { - "description" : "Describes the quantity in which the child part is assembled in the given parent object by providing a quantity value and the measurement unit in which the quantity is measured.", - "type" : "object", - "properties" : { - "quantityNumber" : { - "description" : "The number of objects related to the measurement unit", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.single_level_bom_as_planned_1.0.1_NumberofObjects" - }, - "measurementUnit" : { - "description" : "Unit of Measurement for the quantity of serialized objects", - "$ref" : "#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_UnitReference" - } - }, - "required" : [ "quantityNumber", "measurementUnit" ] - }, - "urn_bamm_io.catenax.single_level_bom_as_planned_1.0.1_ChildData" : { - "description" : "Catena-X ID and meta data of the child part.", - "type" : "object", - "properties" : { - "createdOn" : { - "description" : "Timestamp when the relation between the parent part and the child part was created", - "$ref" : "#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Timestamp" - }, - "quantity" : { - "description" : "Quantity of which the child part is assembled into the parent part.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.single_level_bom_as_planned_1.0.1_QuantityCharacteristic" - }, - "lastModifiedOn" : { - "description" : "Timestamp when the relationship between parent part and child part was last modified.", - "$ref" : "#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Timestamp" - }, - "childCatenaXId" : { - "description" : "The Catena-X ID of the child object which is assembled into the given parent part.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.single_level_bom_as_planned_1.0.1_CatenaXIdTraitCharacteristic" - } - }, - "required" : [ "createdOn", "quantity", "childCatenaXId" ] - }, - "urn_bamm_io.catenax.single_level_bom_as_planned_1.0.1_SetOfChildPartsCharacteristic" : { - "description" : "Set of child parts the parent object is assembled by (one structural level down).", - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/urn_bamm_io.catenax.single_level_bom_as_planned_1.0.1_ChildData" - }, - "uniqueItems" : true - } - } - }, - "properties" : { - "catenaXId" : { - "description" : "The Catena-X ID of the given part (e.g. the component), valid for the Catena-X dataspace.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.single_level_bom_as_planned_1.0.1_CatenaXIdTraitCharacteristic" - }, - "childParts" : { - "description" : "Set of child parts in As-Planned lifecycle phase, of which the given parent object is assembled by (one structural level down).", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.single_level_bom_as_planned_1.0.1_SetOfChildPartsCharacteristic" - } - }, - "required" : [ "catenaXId", "childParts" ] -} \ No newline at end of file diff --git a/io.catenax.single_level_bom_as_planned/1.0.1/gen/SingleLevelBomAsPlanned.aasx b/io.catenax.single_level_bom_as_planned/1.0.1/gen/SingleLevelBomAsPlanned.aasx deleted file mode 100644 index 931c3884f..000000000 Binary files a/io.catenax.single_level_bom_as_planned/1.0.1/gen/SingleLevelBomAsPlanned.aasx and /dev/null differ diff --git a/io.catenax.single_level_bom_as_planned/1.0.1/gen/SingleLevelBomAsPlanned.html b/io.catenax.single_level_bom_as_planned/1.0.1/gen/SingleLevelBomAsPlanned.html deleted file mode 100644 index 95e293b2a..000000000 --- a/io.catenax.single_level_bom_as_planned/1.0.1/gen/SingleLevelBomAsPlanned.html +++ /dev/null @@ -1,863 +0,0 @@ - - - - - - - - - - - - - - Dokumentation Single level bill of material as planned - - -
-
-
-
-

Aspect Model Single level bill of material as planned

-
urn:bamm:io.catenax.single_level_bom_as_planned:1.0.1#SingleLevelBomAsPlanned
-
-
-
-
-
-
-
- -
- - -
- The single-level Bill of Material represents one sub-level of an assembly and does not include any lower-level subassemblies. In As-Planned lifecycle state all variants are covered ("120% BOM"). It includes multiple suppliers for the same component. -
- - -
-

Übersicht

-
-
-
-
- Aspect Model Diagram -
-
-
- - -
-
-

Properties

-
- -
- -
-

Catena-X Identifier

-
- -The Catena-X ID of the given part (e.g. the component), valid for the Catena-X dataspace. - -
-
Name
-
catenaXId
-
- - - -
-
Characteristic
-
-
-
-
Trait
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Beispiel
-
urn:uuid:055c1128-0375-47c8-98de-7cf802c3241d
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
catenaXId
-
- - -
-
Bedingungen
-
-
    -
  • -
    - -
    - Catena-X Id Regular Expression -
    - -
    -
    Beschreibung
    -
    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.
    -
    - -
    -
    Referenz
    -
    -
    -
      -
    • https://datatracker.ietf.org/doc/html/rfc4122
      • -
    -
    -
    -
    - -
    -
    Regulärer Ausdruck
    -
    (^[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}$)
    -
    - -
    • -
-
-
-
-
- -
-

Child Parts

-
- -Set of child parts in As-Planned lifecycle phase, of which the given parent object is assembled by (one structural level down). - -
-
Name
-
childParts
-
- - - -
-
Characteristic
-
-
-
-
Set
-
-
-
Has no order
-
-
-
Duplicates not allowed
-
-
-
- Typ urn:bamm:io.catenax.single_level_bom_as_planned:1.0.1#ChildData - -
-
-
-
-
- - -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
childParts
-
- - -
-
- - - -
-
-

Objekt

-
- -
-
-

Child Data

-
-
- Catena-X ID and meta data of the child part. -
- -
-

Properties

-
-
- -
-
Created On
-
- -Timestamp when the relation between the parent part and the child part was created - -
-
Name
-
createdOn
-
- - - -
-
Characteristic
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#dateTime - -
-
-
-
-
- -
-
Beispiel
-
2022-02-03T14:48:54.709Z
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
createdOn
-
- - -
-
- -
-
Quantity
-
- -Quantity of which the child part is assembled into the parent part. - -
-
Name
-
quantity
-
- - - -
-
Characteristic
-
-
-
-
Quantifiable
-
-
-
Duration
-
-
-
Describes the quantity in which the child part is assembled in the given parent object by providing a quantity value and the measurement unit in which the quantity is measured.
-
-
-
- Typ urn:bamm:io.catenax.single_level_bom_as_planned:1.0.1#Quantity - -
-
-
-
-
- - -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
quantity
-
- - -
-
- -
-
Last Modification Date
-
- -Timestamp when the relationship between parent part and child part was last modified. - -
-
Name
-
lastModifiedOn
-
- - - -
-
Characteristic
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#dateTime - -
-
-
-
-
- -
-
Beispiel
-
2022-02-03T14:48:54.709Z
-
- -
-
Optional
-
- Ja
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
lastModifiedOn
-
- - -
-
- -
-
Catena-X Child Identifier
-
- -The Catena-X ID of the child object which is assembled into the given parent part. - -
-
Name
-
childCatenaXId
-
- - - -
-
Characteristic
-
-
-
-
Trait
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- - -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
childCatenaXId
-
- - -
-
Bedingungen
-
-
    -
  • -
    - -
    - Catena-X Id Regular Expression -
    - -
    -
    Beschreibung
    -
    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.
    -
    - -
    -
    Referenz
    -
    -
    -
      -
    • https://datatracker.ietf.org/doc/html/rfc4122
      • -
    -
    -
    -
    - -
    -
    Regulärer Ausdruck
    -
    (^[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}$)
    -
    - -
    • -
-
-
-
-
-
-
-

Quantity

-
-
- Comprises the number of objects and the unit of measurement for the respective child objects -
- -
-

Properties

-
-
- -
-
Quantity Number
-
- -The number of objects related to the measurement unit - -
-
Name
-
quantityNumber
-
- - - -
-
Characteristic
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#double - -
-
-
-
-
- -
-
Beispiel
-
2.5
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
quantityNumber
-
- - -
-
- -
-
measurementUnit
-
- -Unit of Measurement for the quantity of serialized objects - -
-
Name
-
measurementUnit
-
- - - -
-
Characteristic
-
-
-
-
- Typ urn:bamm:io.openmanufacturing:meta-model:2.0.0#curie - -
-
-
-
-
- -
-
Beispiel
-
litre
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
measurementUnit
-
- -
-
Referenz
-
-
    -
  • https://openmanufacturingplatform.github.io/sds-bamm-aspect-meta-model/bamm-specification/snapshot/appendix/unitcatalog.html
    • -
-
-
- -
-
-
- -
- Third party licenses - -
- -
- - -
- - - \ No newline at end of file diff --git a/io.catenax.single_level_bom_as_planned/1.0.1/gen/SingleLevelBomAsPlanned.json b/io.catenax.single_level_bom_as_planned/1.0.1/gen/SingleLevelBomAsPlanned.json deleted file mode 100644 index d302bc3e4..000000000 --- a/io.catenax.single_level_bom_as_planned/1.0.1/gen/SingleLevelBomAsPlanned.json +++ /dev/null @@ -1,12 +0,0 @@ -{ - "catenaXId" : "urn:uuid:055c1128-0375-47c8-98de-7cf802c3241d", - "childParts" : [ { - "quantity" : { - "quantityNumber" : 2.5, - "measurementUnit" : "litre" - }, - "createdOn" : "2022-02-03T14:48:54.709Z", - "lastModifiedOn" : "2022-02-03T14:48:54.709Z", - "childCatenaXId" : "f1BD38b2-C09D-3ab6-CAEF-6813Bb0078fc" - } ] -} \ No newline at end of file diff --git a/io.catenax.single_level_bom_as_planned/1.0.1/gen/SingleLevelBomAsPlanned.yml b/io.catenax.single_level_bom_as_planned/1.0.1/gen/SingleLevelBomAsPlanned.yml deleted file mode 100644 index 0b688b55d..000000000 --- a/io.catenax.single_level_bom_as_planned/1.0.1/gen/SingleLevelBomAsPlanned.yml +++ /dev/null @@ -1,208 +0,0 @@ ---- -openapi: 3.0.3 -info: - title: Single level bill of material as planned - version: v1 -servers: -- url: catenax.io/api/v1 - variables: - api-version: - default: v1 -paths: - /{tenant-id}/single-level-bom-as-planned: - get: - tags: - - SingleLevelBomAsPlanned - operationId: getSingleLevelBomAsPlanned - 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/SingleLevelBomAsPlanned' - "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/SingleLevelBomAsPlanned' - totalItems: - type: number - totalPages: - type: number - pageSize: - type: number - currentPage: - type: number - urn_bamm_io.catenax.single_level_bom_as_planned_1.0.1_CatenaXIdTraitCharacteristic: - 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_bamm_io.openmanufacturing_characteristic_2.0.0_Timestamp: - type: string - pattern: "-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T(([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](\\\ - .[0-9]+)?|(24:00:00(\\.0+)?))(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?" - description: Describes a Property which contains the date and time with an optional - timezone. - urn_bamm_io.catenax.single_level_bom_as_planned_1.0.1_NumberofObjects: - type: number - description: Quantifiable number of objects in reference to the measurementUnit - urn_bamm_io.openmanufacturing_characteristic_2.0.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_bamm_io.catenax.single_level_bom_as_planned_1.0.1_QuantityCharacteristic: - description: Describes the quantity in which the child part is assembled in - the given parent object by providing a quantity value and the measurement - unit in which the quantity is measured. - type: object - properties: - quantityNumber: - description: The number of objects related to the measurement unit - $ref: '#/components/schemas/urn_bamm_io.catenax.single_level_bom_as_planned_1.0.1_NumberofObjects' - measurementUnit: - description: Unit of Measurement for the quantity of serialized objects - $ref: '#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_UnitReference' - required: - - quantityNumber - - measurementUnit - urn_bamm_io.catenax.single_level_bom_as_planned_1.0.1_ChildData: - description: Catena-X ID and meta data of the child part. - type: object - properties: - createdOn: - description: Timestamp when the relation between the parent part and the - child part was created - $ref: '#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Timestamp' - quantity: - description: Quantity of which the child part is assembled into the parent - part. - $ref: '#/components/schemas/urn_bamm_io.catenax.single_level_bom_as_planned_1.0.1_QuantityCharacteristic' - lastModifiedOn: - description: Timestamp when the relationship between parent part and child - part was last modified. - $ref: '#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Timestamp' - childCatenaXId: - description: The Catena-X ID of the child object which is assembled into - the given parent part. - $ref: '#/components/schemas/urn_bamm_io.catenax.single_level_bom_as_planned_1.0.1_CatenaXIdTraitCharacteristic' - required: - - createdOn - - quantity - - childCatenaXId - urn_bamm_io.catenax.single_level_bom_as_planned_1.0.1_SetOfChildPartsCharacteristic: - description: Set of child parts the parent object is assembled by (one structural - level down). - type: array - items: - $ref: '#/components/schemas/urn_bamm_io.catenax.single_level_bom_as_planned_1.0.1_ChildData' - uniqueItems: true - SingleLevelBomAsPlanned: - description: The single-level Bill of Material represents one sub-level of an - assembly and does not include any lower-level subassemblies. In As-Planned - lifecycle state all variants are covered ("120% BOM"). It includes multiple - suppliers for the same component. - type: object - properties: - catenaXId: - description: "The Catena-X ID of the given part (e.g. the component), valid\ - \ for the Catena-X dataspace." - $ref: '#/components/schemas/urn_bamm_io.catenax.single_level_bom_as_planned_1.0.1_CatenaXIdTraitCharacteristic' - childParts: - description: "Set of child parts in As-Planned lifecycle phase, of which\ - \ the given parent object is assembled by (one structural level down)." - $ref: '#/components/schemas/urn_bamm_io.catenax.single_level_bom_as_planned_1.0.1_SetOfChildPartsCharacteristic' - required: - - catenaXId - - childParts - 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' - SingleLevelBomAsPlanned: - content: - application/json: - schema: - $ref: '#/components/schemas/PagingSchema' - description: The request was successful. - requestBodies: - SingleLevelBomAsPlanned: - content: - application/json: - schema: - $ref: '#/components/schemas/SingleLevelBomAsPlanned' diff --git a/io.catenax.single_level_bom_as_planned/1.0.1/metadata.json b/io.catenax.single_level_bom_as_planned/1.0.1/metadata.json deleted file mode 100644 index 9e759dfb1..000000000 --- a/io.catenax.single_level_bom_as_planned/1.0.1/metadata.json +++ /dev/null @@ -1 +0,0 @@ -{ "status" : "deprecate"} diff --git a/io.catenax.single_level_bom_as_planned/1.1.0/SingleLevelBomAsPlanned.ttl b/io.catenax.single_level_bom_as_planned/1.1.0/SingleLevelBomAsPlanned.ttl deleted file mode 100644 index 468468150..000000000 --- a/io.catenax.single_level_bom_as_planned/1.1.0/SingleLevelBomAsPlanned.ttl +++ /dev/null @@ -1,147 +0,0 @@ -###################################################################### -# Copyright (c) 2023 BASF SE -# Copyright (c) 2023 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) -# Copyright (c) 2023 Fraunhofer-Gesellschaft zur Foerderung der angewandten Forschung e.V. (represented by Fraunhofer ISST & Fraunhofer IML) -# Copyright (c) 2023 German Edge Cloud GmbH & Co. KG -# Copyright (c) 2023 Henkel AG & Co. KGaA -# Copyright (c) 2023 Mercedes Benz AG -# Copyright (c) 2023 Robert Bosch Manufacturing Solutions GmbH -# Copyright (c) 2023 SAP SE -# Copyright (c) 2023 Siemens AG -# Copyright (c) 2023 T-Systems International GmbH -# Copyright (c) 2023 ZF Friedrichshafen AG -# Copyright (c) 2023 Contributors to the Eclipse Foundation -# -# 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 bamm: . -@prefix bamm-c: . -@prefix bamm-e: . -@prefix unit: . -@prefix rdf: . -@prefix rdfs: . -@prefix xsd: . -@prefix : . - -:SingleLevelBomAsPlanned a bamm:Aspect; - bamm:preferredName "Single Level Bill of Material as Planned"@en; - bamm:description "The single-level Bill of Material represents one sub-level of an assembly and does not include any lower-level subassemblies. In As-Planned lifecycle state all variants are covered (\"120% BoM\").\nIf multiple versions of child parts exist that can be assembled into the same parent part, all versions of the child part are included in the BoM.\nIf there are multiple suppliers for the same child part, each supplier has an entry for their child part in the BoM."@en; - bamm:properties (:catenaXId :childParts); - bamm:operations (); - bamm:events (). -:catenaXId a bamm:Property; - bamm:preferredName "Catena-X Identifier"@en; - bamm:description "The Catena-X ID of the given part (e.g. the component), valid for the Catena-X dataspace."@en; - bamm:characteristic :CatenaXIdTraitCharacteristic; - bamm:exampleValue "urn:uuid:055c1128-0375-47c8-98de-7cf802c3241d". -:childParts a bamm:Property; - bamm:preferredName "Child Parts"@en; - bamm:description "Set of child parts in As-Planned lifecycle phase, of which the given parent object is assembled by (one structural level down)."@en; - bamm:characteristic :SetOfChildPartsCharacteristic. -:CatenaXIdTraitCharacteristic a bamm-c:Trait; - bamm:preferredName "Catena-X ID Trait"@en; - bamm:description "Trait to ensure UUID v4 data format"@en; - bamm-c:baseCharacteristic :Uuidv4Characteristic; - bamm-c:constraint :Uuidv4RegularExpression. -:SetOfChildPartsCharacteristic a bamm-c:Set; - bamm:preferredName "Set of Child Parts"@en; - bamm:description "Set of child parts the parent object is assembled by (one structural level down)."@en; - bamm:dataType :ChildData. -:Uuidv4Characteristic a bamm:Characteristic; - bamm:preferredName "UUID v4"@en; - bamm:description "A version 4 UUID is a universally unique identifier that is generated using random 32 hexadecimal characters."@en; - bamm:dataType xsd:string; - bamm:see . -:Uuidv4RegularExpression a bamm-c:RegularExpressionConstraint; - bamm:preferredName "Catena-X ID Regular Expression"@en; - bamm: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."@en; - bamm:see ; - bamm:value "(^[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}$)". -:ChildData a bamm:Entity; - bamm:preferredName "Child Data"@en; - bamm:description "Catena-X ID and meta data of the child part."@en; - bamm:properties (:createdOn :quantity [ - bamm:property :lastModifiedOn; - bamm:optional "true"^^xsd:boolean -] :childCatenaXId [ - bamm:property :validityPeriod; - bamm:optional "true"^^xsd:boolean -]). -:childCatenaXId a bamm:Property; - bamm:preferredName "Catena-X Child ID"@en; - bamm:description "The Catena-X ID of the child object which is assembled into the given parent part."@en; - bamm:characteristic :CatenaXIdTraitCharacteristic. -:createdOn a bamm:Property; - bamm:preferredName "Created on"@en; - bamm:description "Timestamp when the relation between the parent part and the child part was created"@en; - bamm:characteristic bamm-c:Timestamp; - bamm:exampleValue "2022-02-03T14:48:54.709Z"^^xsd:dateTime. -:quantity a bamm:Property; - bamm:preferredName "Quantity"@en; - bamm:description "Quantity of which the child part is assembled into the parent part."@en; - bamm:characteristic :QuantityCharacteristic. -:lastModifiedOn a bamm:Property; - bamm:preferredName "Last Modified on"@en; - bamm:description "Timestamp when the relationship between parent part and child part was last modified."@en; - bamm:characteristic bamm-c:Timestamp; - bamm:exampleValue "2022-02-03T14:48:54.709Z"^^xsd:dateTime. -:validityPeriod a bamm:Property; - bamm:preferredName "Validity Period"@en; - bamm:description "The period of time during which the parent-child relation is valid. This relates to whether a child part can be built into the parent part at a given time.\nIf no validity period is given the relation is considered valid at any point in time."@en; - bamm:characteristic :ValidityPeriodCharacteristic. -:QuantityCharacteristic a bamm-c:Quantifiable; - bamm:preferredName "Quantity Characteristic"@en; - bamm:description "Describes the quantity in which the child part is assembled in the given parent object by providing a quantity value and the measurement unit in which the quantity is measured."@en; - bamm:dataType :Quantity. -:ValidityPeriodCharacteristic a bamm:Characteristic; - bamm:preferredName "Validity Period Characteristic"@en; - bamm:description "Characteristic for a validity period defined by an (optional) start and an (optional) end timestamp."@en; - bamm:dataType :ValidityPeriodEntity. -:Quantity a bamm:Entity; - bamm:preferredName "Quantity"@en; - bamm:description "Comprises the number of objects and the unit of measurement for the respective child objects"@en; - bamm:properties (:quantityNumber :measurementUnit). -:ValidityPeriodEntity a bamm:Entity; - bamm:preferredName "Validity Period Entity"@en; - bamm:description "If a validity period only has a start that means that the period is valid from the start date without a (yet) defined enddate and vice versa."@en; - bamm:properties ([ - bamm:property :validFrom; - bamm:optional "true"^^xsd:boolean -] [ - bamm:property :validTo; - bamm:optional "true"^^xsd:boolean -]). -:quantityNumber a bamm:Property; - bamm:preferredName "Quantity Number"@en; - bamm:description "The number of objects related to the measurement unit"@en; - bamm:characteristic :NumberofObjects; - bamm:exampleValue "2.5"^^xsd:double. -:measurementUnit a bamm:Property; - bamm:preferredName "Measurement Unit"@en; - bamm:description "Unit of measurement for the quantity of objects.\nIf possible, use units from the aspect meta model unit catalog, which is based on the UNECE Recommendation No. 20 \"Codes for Units of Measure used in International Trade\"."@en; - bamm:characteristic bamm-c:UnitReference; - bamm:exampleValue "unit:litre"^^bamm:curie; - bamm:see . -:NumberofObjects a bamm:Characteristic; - bamm:preferredName "Number of Objects"@en; - bamm:description "Quantifiable number of objects in reference to the measurementUnit"@en; - bamm:dataType xsd:double. -:validFrom a bamm:Property; - bamm:preferredName "Valid from"@en; - bamm:description "Start date of validity period"@en; - bamm:characteristic bamm-c:Timestamp; - bamm:exampleValue "2023-03-21T08:17:29.187+01:00"^^xsd:dateTime. -:validTo a bamm:Property; - bamm:preferredName "Valid to"@en; - bamm:description "End date of validity period"@en; - bamm:characteristic bamm-c:Timestamp; - bamm:exampleValue "2024-07-01T16:10:00.000+01:00"^^xsd:dateTime. diff --git a/io.catenax.single_level_bom_as_planned/1.1.0/gen/SingleLevelBomAsPlanned-aas.xml b/io.catenax.single_level_bom_as_planned/1.1.0/gen/SingleLevelBomAsPlanned-aas.xml deleted file mode 100644 index 4b6d70bc5..000000000 --- a/io.catenax.single_level_bom_as_planned/1.1.0/gen/SingleLevelBomAsPlanned-aas.xml +++ /dev/null @@ -1,864 +0,0 @@ - - - - - defaultAdminShell - - - en - defaultAdminShell - - - - urn:samm:io.catenax.single_level_bom_as_planned:1.1.0#SingleLevelBomAsPlanned - - Type - - - - ModelReference - - - Submodel - urn:samm:io.catenax.single_level_bom_as_planned:1.1.0#SingleLevelBomAsPlanned/submodel - - - - - - - - - SingleLevelBomAsPlanned - - - en - The single-level Bill of Material represents one sub-level of an assembly and does not include any lower-level subassemblies. In As-Planned lifecycle state all variants are covered ("120% BoM"). -If multiple versions of child parts exist that can be assembled into the same parent part, all versions of the child part are included in the BoM. -If there are multiple suppliers for the same child part, each supplier has an entry for their child part in the BoM. - - - - urn:samm:io.catenax.single_level_bom_as_planned:1.1.0#SingleLevelBomAsPlanned/submodel - Template - - ModelReference - - - ConceptDescription - urn:samm:io.catenax.single_level_bom_as_planned:1.1.0#SingleLevelBomAsPlanned - - - - - - catenaXId - - - en - Catena-X Identifier - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.single_level_bom_as_planned:1.1.0#catenaXId - - - - xs:string - - - - childParts - - - en - Child Parts - - - - - en - Set of child parts in As-Planned lifecycle phase, of which the given parent object is assembled by (one structural level down). - - - true - DataElement - - - ChildData - - - en - Child Data - - - - - en - Catena-X ID and meta data of the child part. - - - - - createdOn - - - en - Created on - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.single_level_bom_as_planned:1.1.0#createdOn - - - - xs:dateTime - - - - Quantity - - - en - Quantity - - - - - en - Comprises the number of objects and the unit of measurement for the respective child objects - - - - - quantityNumber - - - en - Quantity Number - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.single_level_bom_as_planned:1.1.0#quantityNumber - - - - xs:double - - - - measurementUnit - - - en - Measurement Unit - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.single_level_bom_as_planned:1.1.0#measurementUnit - - - - - - ExternalReference - - - GlobalReference - https://github.com/eclipse-esmf/esmf-semantic-aspect-meta-model/blob/main/esmf-semantic-aspect-meta-model/src/main/resources/samm/unit/2.0.0/units.ttl - - - - - xs:string - - - - - - lastModifiedOn - - - en - Last Modified on - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.single_level_bom_as_planned:1.1.0#lastModifiedOn - - - - xs:dateTime - - - - childCatenaXId - - - en - Catena-X Child ID - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.single_level_bom_as_planned:1.1.0#childCatenaXId - - - - xs:string - - - - ValidityPeriodEntity - - - en - Validity Period Entity - - - - - en - If a validity period only has a start that means that the period is valid from the start date without a (yet) defined enddate and vice versa. - - - - - validFrom - - - en - Valid from - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.single_level_bom_as_planned:1.1.0#validFrom - - - - xs:dateTime - - - - validTo - - - en - Valid to - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.single_level_bom_as_planned:1.1.0#validTo - - - - xs:dateTime - - - - - - - - - - - - - - APPLICATION_CLASS - SingleLevelBomAsPlanned - - - en - Single Level Bill of Material as Planned - - - - - en - The single-level Bill of Material represents one sub-level of an assembly and does not include any lower-level subassemblies. In As-Planned lifecycle state all variants are covered ("120% BoM"). -If multiple versions of child parts exist that can be assembled into the same parent part, all versions of the child part are included in the BoM. -If there are multiple suppliers for the same child part, each supplier has an entry for their child part in the BoM. - - - urn:samm:io.catenax.single_level_bom_as_planned:1.1.0#SingleLevelBomAsPlanned - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Single Level Bill of Material as Planned - - - - - en - SingleLevelBomAsPlanned - - - - - en - The single-level Bill of Material represents one sub-level of an assembly and does not include any lower-level subassemblies. In As-Planned lifecycle state all variants are covered ("120% BoM"). -If multiple versions of child parts exist that can be assembled into the same parent part, all versions of the child part are included in the BoM. -If there are multiple suppliers for the same child part, each supplier has an entry for their child part in the BoM. - - - - - - - - - catenaXId - - - en - Catena-X Identifier - - - urn:samm:io.catenax.single_level_bom_as_planned:1.1.0#catenaXId - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Catena-X Identifier - - - - - en - catenaXId - - - STRING - - - en - The Catena-X ID of the given part (e.g. the component), valid for the Catena-X dataspace. - - - - - - - - - createdOn - - - en - Created on - - - urn:samm:io.catenax.single_level_bom_as_planned:1.1.0#createdOn - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Created on - - - - - en - createdOn - - - STRING - - - en - Timestamp when the relation between the parent part and the child part was created - - - - - - - - - quantityNumber - - - en - Quantity Number - - - urn:samm:io.catenax.single_level_bom_as_planned:1.1.0#quantityNumber - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Quantity Number - - - - - en - quantityNumber - - - REAL_MEASURE - - - en - The number of objects related to the measurement unit - - - - - - - - - measurementUnit - - - en - Measurement Unit - - - urn:samm:io.catenax.single_level_bom_as_planned:1.1.0#measurementUnit - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Measurement Unit - - - - - en - measurementUnit - - - STRING - - - en - Unit of measurement for the quantity of objects. -If possible, use units from the aspect meta model unit catalog, which is based on the UNECE Recommendation No. 20 "Codes for Units of Measure used in International Trade". - - - - - - - - - quantity - - - en - Quantity - - - urn:samm:io.catenax.single_level_bom_as_planned:1.1.0#quantity - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Quantity - - - - - en - quantity - - - STRING - - - en - Quantity of which the child part is assembled into the parent part. - - - - - - - - - lastModifiedOn - - - en - Last Modified on - - - urn:samm:io.catenax.single_level_bom_as_planned:1.1.0#lastModifiedOn - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Last Modified on - - - - - en - lastModifiedOn - - - STRING - - - en - Timestamp when the relationship between parent part and child part was last modified. - - - - - - - - - childCatenaXId - - - en - Catena-X Child ID - - - urn:samm:io.catenax.single_level_bom_as_planned:1.1.0#childCatenaXId - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Catena-X Child ID - - - - - en - childCatenaXId - - - STRING - - - en - The Catena-X ID of the child object which is assembled into the given parent part. - - - - - - - - - validFrom - - - en - Valid from - - - urn:samm:io.catenax.single_level_bom_as_planned:1.1.0#validFrom - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Valid from - - - - - en - validFrom - - - STRING - - - en - Start date of validity period - - - - - - - - - validTo - - - en - Valid to - - - urn:samm:io.catenax.single_level_bom_as_planned:1.1.0#validTo - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Valid to - - - - - en - validTo - - - STRING - - - en - End date of validity period - - - - - - - - - validityPeriod - - - en - Validity Period - - - urn:samm:io.catenax.single_level_bom_as_planned:1.1.0#validityPeriod - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Validity Period - - - - - en - validityPeriod - - - STRING - - - en - The period of time during which the parent-child relation is valid. This relates to whether a child part can be built into the parent part at a given time. -If no validity period is given the relation is considered valid at any point in time. - - - - - - - - - childParts - - - en - Child Parts - - - urn:samm:io.catenax.single_level_bom_as_planned:1.1.0#childParts - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Child Parts - - - - - en - childParts - - - STRING - - - en - Set of child parts in As-Planned lifecycle phase, of which the given parent object is assembled by (one structural level down). - - - - - - - - - diff --git a/io.catenax.single_level_bom_as_planned/1.1.0/gen/SingleLevelBomAsPlanned-schema.json b/io.catenax.single_level_bom_as_planned/1.1.0/gen/SingleLevelBomAsPlanned-schema.json deleted file mode 100644 index 6f48cd2d5..000000000 --- a/io.catenax.single_level_bom_as_planned/1.1.0/gen/SingleLevelBomAsPlanned-schema.json +++ /dev/null @@ -1,103 +0,0 @@ -{ - "$schema" : "http://json-schema.org/draft-04/schema", - "description" : "The single-level Bill of Material represents one sub-level of an assembly and does not include any lower-level subassemblies. In As-Planned lifecycle state all variants are covered (\"120% BoM\").\nIf multiple versions of child parts exist that can be assembled into the same parent part, all versions of the child part are included in the BoM.\nIf there are multiple suppliers for the same child part, each supplier has an entry for their child part in the BoM.", - "type" : "object", - "components" : { - "schemas" : { - "urn_bamm_io.catenax.single_level_bom_as_planned_1.1.0_CatenaXIdTraitCharacteristic" : { - "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_bamm_io.openmanufacturing_characteristic_2.0.0_Timestamp" : { - "type" : "string", - "pattern" : "-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T(([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](\\.[0-9]+)?|(24:00:00(\\.0+)?))(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?", - "description" : "Describes a Property which contains the date and time with an optional timezone." - }, - "urn_bamm_io.catenax.single_level_bom_as_planned_1.1.0_NumberofObjects" : { - "type" : "number", - "description" : "Quantifiable number of objects in reference to the measurementUnit" - }, - "urn_bamm_io.openmanufacturing_characteristic_2.0.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_bamm_io.catenax.single_level_bom_as_planned_1.1.0_QuantityCharacteristic" : { - "description" : "Describes the quantity in which the child part is assembled in the given parent object by providing a quantity value and the measurement unit in which the quantity is measured.", - "type" : "object", - "properties" : { - "quantityNumber" : { - "description" : "The number of objects related to the measurement unit", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.single_level_bom_as_planned_1.1.0_NumberofObjects" - }, - "measurementUnit" : { - "description" : "Unit of measurement for the quantity of objects.\nIf possible, use units from the aspect meta model unit catalog, which is based on the UNECE Recommendation No. 20 \"Codes for Units of Measure used in International Trade\".", - "$ref" : "#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_UnitReference" - } - }, - "required" : [ "quantityNumber", "measurementUnit" ] - }, - "urn_bamm_io.catenax.single_level_bom_as_planned_1.1.0_ValidityPeriodCharacteristic" : { - "description" : "Characteristic for a validity period defined by an (optional) start and an (optional) end timestamp.", - "type" : "object", - "properties" : { - "validFrom" : { - "description" : "Start date of validity period", - "$ref" : "#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Timestamp" - }, - "validTo" : { - "description" : "End date of validity period", - "$ref" : "#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Timestamp" - } - } - }, - "urn_bamm_io.catenax.single_level_bom_as_planned_1.1.0_ChildData" : { - "description" : "Catena-X ID and meta data of the child part.", - "type" : "object", - "properties" : { - "createdOn" : { - "description" : "Timestamp when the relation between the parent part and the child part was created", - "$ref" : "#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Timestamp" - }, - "quantity" : { - "description" : "Quantity of which the child part is assembled into the parent part.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.single_level_bom_as_planned_1.1.0_QuantityCharacteristic" - }, - "lastModifiedOn" : { - "description" : "Timestamp when the relationship between parent part and child part was last modified.", - "$ref" : "#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Timestamp" - }, - "childCatenaXId" : { - "description" : "The Catena-X ID of the child object which is assembled into the given parent part.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.single_level_bom_as_planned_1.1.0_CatenaXIdTraitCharacteristic" - }, - "validityPeriod" : { - "description" : "The period of time during which the parent-child relation is valid. This relates to whether a child part can be built into the parent part at a given time.\nIf no validity period is given the relation is considered valid at any point in time.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.single_level_bom_as_planned_1.1.0_ValidityPeriodCharacteristic" - } - }, - "required" : [ "createdOn", "quantity", "childCatenaXId" ] - }, - "urn_bamm_io.catenax.single_level_bom_as_planned_1.1.0_SetOfChildPartsCharacteristic" : { - "description" : "Set of child parts the parent object is assembled by (one structural level down).", - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/urn_bamm_io.catenax.single_level_bom_as_planned_1.1.0_ChildData" - }, - "uniqueItems" : true - } - } - }, - "properties" : { - "catenaXId" : { - "description" : "The Catena-X ID of the given part (e.g. the component), valid for the Catena-X dataspace.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.single_level_bom_as_planned_1.1.0_CatenaXIdTraitCharacteristic" - }, - "childParts" : { - "description" : "Set of child parts in As-Planned lifecycle phase, of which the given parent object is assembled by (one structural level down).", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.single_level_bom_as_planned_1.1.0_SetOfChildPartsCharacteristic" - } - }, - "required" : [ "catenaXId", "childParts" ] -} \ No newline at end of file diff --git a/io.catenax.single_level_bom_as_planned/1.1.0/gen/SingleLevelBomAsPlanned.aasx b/io.catenax.single_level_bom_as_planned/1.1.0/gen/SingleLevelBomAsPlanned.aasx deleted file mode 100644 index fa56df493..000000000 Binary files a/io.catenax.single_level_bom_as_planned/1.1.0/gen/SingleLevelBomAsPlanned.aasx and /dev/null differ diff --git a/io.catenax.single_level_bom_as_planned/1.1.0/gen/SingleLevelBomAsPlanned.html b/io.catenax.single_level_bom_as_planned/1.1.0/gen/SingleLevelBomAsPlanned.html deleted file mode 100644 index 3d67ec91b..000000000 --- a/io.catenax.single_level_bom_as_planned/1.1.0/gen/SingleLevelBomAsPlanned.html +++ /dev/null @@ -1,1040 +0,0 @@ - - - - - - - - - - - - - - Dokumentation Single Level Bill of Material as Planned - - -
-
-
-
-

Aspect Model Single Level Bill of Material as Planned

-
urn:bamm:io.catenax.single_level_bom_as_planned:1.1.0#SingleLevelBomAsPlanned
-
-
-
-
-
-
-
- -
- - -
- The single-level Bill of Material represents one sub-level of an assembly and does not include any lower-level subassemblies. In As-Planned lifecycle state all variants are covered ("120% BoM"). -If multiple versions of child parts exist that can be assembled into the same parent part, all versions of the child part are included in the BoM. -If there are multiple suppliers for the same child part, each supplier has an entry for their child part in the BoM. -
- - -
-

Übersicht

-
-
-
-
- Aspect Model Diagram -
-
-
- - -
-
-

Properties

-
- -
- -
-

Catena-X Identifier

-
- -The Catena-X ID of the given part (e.g. the component), valid for the Catena-X dataspace. - -
-
Name
-
catenaXId
-
- - - -
-
Characteristic
-
-
-
-
Trait
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Beispiel
-
urn:uuid:055c1128-0375-47c8-98de-7cf802c3241d
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
catenaXId
-
- - -
-
Bedingungen
-
-
    -
  • -
    - -
    - Catena-X ID Regular Expression -
    - -
    -
    Beschreibung
    -
    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.
    -
    - -
    -
    Referenz
    -
    -
    -
      -
    • https://datatracker.ietf.org/doc/html/rfc4122
      • -
    -
    -
    -
    - -
    -
    Regulärer Ausdruck
    -
    (^[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}$)
    -
    - -
    • -
-
-
-
-
- -
-

Child Parts

-
- -Set of child parts in As-Planned lifecycle phase, of which the given parent object is assembled by (one structural level down). - -
-
Name
-
childParts
-
- - - -
-
Characteristic
-
-
-
-
Set
-
-
-
Has no order
-
-
-
Duplicates not allowed
-
-
-
- Typ urn:bamm:io.catenax.single_level_bom_as_planned:1.1.0#ChildData - -
-
-
-
-
- - -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
childParts
-
- - -
-
- - - -
-
-

Objekt

-
- -
-
-

Child Data

-
-
- Catena-X ID and meta data of the child part. -
- -
-

Properties

-
-
- -
-
Created on
-
- -Timestamp when the relation between the parent part and the child part was created - -
-
Name
-
createdOn
-
- - - -
-
Characteristic
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#dateTime - -
-
-
-
-
- -
-
Beispiel
-
2022-02-03T14:48:54.709Z
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
createdOn
-
- - -
-
- -
-
Quantity
-
- -Quantity of which the child part is assembled into the parent part. - -
-
Name
-
quantity
-
- - - -
-
Characteristic
-
-
-
-
Quantifiable
-
-
-
Duration
-
-
-
Describes the quantity in which the child part is assembled in the given parent object by providing a quantity value and the measurement unit in which the quantity is measured.
-
-
-
- Typ urn:bamm:io.catenax.single_level_bom_as_planned:1.1.0#Quantity - -
-
-
-
-
- - -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
quantity
-
- - -
-
- -
-
Last Modified on
-
- -Timestamp when the relationship between parent part and child part was last modified. - -
-
Name
-
lastModifiedOn
-
- - - -
-
Characteristic
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#dateTime - -
-
-
-
-
- -
-
Beispiel
-
2022-02-03T14:48:54.709Z
-
- -
-
Optional
-
- Ja
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
lastModifiedOn
-
- - -
-
- -
-
Catena-X Child ID
-
- -The Catena-X ID of the child object which is assembled into the given parent part. - -
-
Name
-
childCatenaXId
-
- - - -
-
Characteristic
-
-
-
-
Trait
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- - -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
childCatenaXId
-
- - -
-
Bedingungen
-
-
    -
  • -
    - -
    - Catena-X ID Regular Expression -
    - -
    -
    Beschreibung
    -
    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.
    -
    - -
    -
    Referenz
    -
    -
    -
      -
    • https://datatracker.ietf.org/doc/html/rfc4122
      • -
    -
    -
    -
    - -
    -
    Regulärer Ausdruck
    -
    (^[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}$)
    -
    - -
    • -
-
-
-
-
- -
-
Validity Period
-
- -The period of time during which the parent-child relation is valid. This relates to whether a child part can be built into the parent part at a given time. -If no validity period is given the relation is considered valid at any point in time. - -
-
Name
-
validityPeriod
-
- - - -
-
Characteristic
-
-
-
-
SingleEntity
-
-
-
- Typ urn:bamm:io.catenax.single_level_bom_as_planned:1.1.0#ValidityPeriodEntity - -
-
-
-
-
- - -
-
Optional
-
- Ja
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
validityPeriod
-
- - -
-
-
-
-

Quantity

-
-
- Comprises the number of objects and the unit of measurement for the respective child objects -
- -
-

Properties

-
-
- -
-
Quantity Number
-
- -The number of objects related to the measurement unit - -
-
Name
-
quantityNumber
-
- - - -
-
Characteristic
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#double - -
-
-
-
-
- -
-
Beispiel
-
2.5
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
quantityNumber
-
- - -
-
- -
-
Measurement Unit
-
- -Unit of measurement for the quantity of objects. -If possible, use units from the aspect meta model unit catalog, which is based on the UNECE Recommendation No. 20 "Codes for Units of Measure used in International Trade". - -
-
Name
-
measurementUnit
-
- - - -
-
Characteristic
-
-
-
-
- Typ urn:bamm:io.openmanufacturing:meta-model:2.0.0#curie - -
-
-
-
-
- -
-
Beispiel
-
unit:litre
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
measurementUnit
-
- -
-
Referenz
-
-
    -
  • https://github.com/eclipse-esmf/esmf-semantic-aspect-meta-model/blob/main/esmf-semantic-aspect-meta-model/src/main/resources/samm/unit/2.0.0/units.ttl
    • -
-
-
- -
-
-
-
-

Validity Period Entity

-
-
- If a validity period only has a start that means that the period is valid from the start date without a (yet) defined enddate and vice versa. -
- -
-

Properties

-
-
- -
-
Valid from
-
- -Start date of validity period - -
-
Name
-
validFrom
-
- - - -
-
Characteristic
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#dateTime - -
-
-
-
-
- -
-
Beispiel
-
2023-03-21T08:17:29.187+01:00
-
- -
-
Optional
-
- Ja
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
validFrom
-
- - -
-
- -
-
Valid to
-
- -End date of validity period - -
-
Name
-
validTo
-
- - - -
-
Characteristic
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#dateTime - -
-
-
-
-
- -
-
Beispiel
-
2024-07-01T16:10:00.000+01:00
-
- -
-
Optional
-
- Ja
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
validTo
-
- - -
-
-
- -
- Third party licenses - -
- -
- - -
- - - \ No newline at end of file diff --git a/io.catenax.single_level_bom_as_planned/1.1.0/gen/SingleLevelBomAsPlanned.json b/io.catenax.single_level_bom_as_planned/1.1.0/gen/SingleLevelBomAsPlanned.json deleted file mode 100644 index a753b3c95..000000000 --- a/io.catenax.single_level_bom_as_planned/1.1.0/gen/SingleLevelBomAsPlanned.json +++ /dev/null @@ -1,16 +0,0 @@ -{ - "catenaXId" : "urn:uuid:055c1128-0375-47c8-98de-7cf802c3241d", - "childParts" : [ { - "validityPeriod" : { - "validFrom" : "2023-03-21T08:17:29.187+01:00", - "validTo" : "2024-07-01T16:10:00.000+01:00" - }, - "quantity" : { - "quantityNumber" : 2.5, - "measurementUnit" : "unit:litre" - }, - "createdOn" : "2022-02-03T14:48:54.709Z", - "lastModifiedOn" : "2022-02-03T14:48:54.709Z", - "childCatenaXId" : "fEbdF497-B223-8365-dEbe-df4A6E67bDee" - } ] -} \ No newline at end of file diff --git a/io.catenax.single_level_bom_as_planned/1.1.0/gen/SingleLevelBomAsPlanned.yml b/io.catenax.single_level_bom_as_planned/1.1.0/gen/SingleLevelBomAsPlanned.yml deleted file mode 100644 index f05e7ecce..000000000 --- a/io.catenax.single_level_bom_as_planned/1.1.0/gen/SingleLevelBomAsPlanned.yml +++ /dev/null @@ -1,226 +0,0 @@ ---- -openapi: 3.0.3 -info: - title: Single Level Bill of Material as Planned - version: v1 -servers: -- url: catenax.io/api/v1 - variables: - api-version: - default: v1 -paths: - /{tenant-id}/single-level-bom-as-planned: - get: - tags: - - SingleLevelBomAsPlanned - operationId: getSingleLevelBomAsPlanned - 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/SingleLevelBomAsPlanned' - "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/SingleLevelBomAsPlanned' - totalItems: - type: number - totalPages: - type: number - pageSize: - type: number - currentPage: - type: number - urn_bamm_io.catenax.single_level_bom_as_planned_1.1.0_CatenaXIdTraitCharacteristic: - 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_bamm_io.openmanufacturing_characteristic_2.0.0_Timestamp: - type: string - pattern: "-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T(([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](\\\ - .[0-9]+)?|(24:00:00(\\.0+)?))(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?" - description: Describes a Property which contains the date and time with an optional - timezone. - urn_bamm_io.catenax.single_level_bom_as_planned_1.1.0_NumberofObjects: - type: number - description: Quantifiable number of objects in reference to the measurementUnit - urn_bamm_io.openmanufacturing_characteristic_2.0.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_bamm_io.catenax.single_level_bom_as_planned_1.1.0_QuantityCharacteristic: - description: Describes the quantity in which the child part is assembled in - the given parent object by providing a quantity value and the measurement - unit in which the quantity is measured. - type: object - properties: - quantityNumber: - description: The number of objects related to the measurement unit - $ref: '#/components/schemas/urn_bamm_io.catenax.single_level_bom_as_planned_1.1.0_NumberofObjects' - measurementUnit: - description: |- - Unit of measurement for the quantity of objects. - If possible, use units from the aspect meta model unit catalog, which is based on the UNECE Recommendation No. 20 "Codes for Units of Measure used in International Trade". - $ref: '#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_UnitReference' - required: - - quantityNumber - - measurementUnit - urn_bamm_io.catenax.single_level_bom_as_planned_1.1.0_ValidityPeriodCharacteristic: - description: Characteristic for a validity period defined by an (optional) start - and an (optional) end timestamp. - type: object - properties: - validFrom: - description: Start date of validity period - $ref: '#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Timestamp' - validTo: - description: End date of validity period - $ref: '#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Timestamp' - urn_bamm_io.catenax.single_level_bom_as_planned_1.1.0_ChildData: - description: Catena-X ID and meta data of the child part. - type: object - properties: - createdOn: - description: Timestamp when the relation between the parent part and the - child part was created - $ref: '#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Timestamp' - quantity: - description: Quantity of which the child part is assembled into the parent - part. - $ref: '#/components/schemas/urn_bamm_io.catenax.single_level_bom_as_planned_1.1.0_QuantityCharacteristic' - lastModifiedOn: - description: Timestamp when the relationship between parent part and child - part was last modified. - $ref: '#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Timestamp' - childCatenaXId: - description: The Catena-X ID of the child object which is assembled into - the given parent part. - $ref: '#/components/schemas/urn_bamm_io.catenax.single_level_bom_as_planned_1.1.0_CatenaXIdTraitCharacteristic' - validityPeriod: - description: |- - The period of time during which the parent-child relation is valid. This relates to whether a child part can be built into the parent part at a given time. - If no validity period is given the relation is considered valid at any point in time. - $ref: '#/components/schemas/urn_bamm_io.catenax.single_level_bom_as_planned_1.1.0_ValidityPeriodCharacteristic' - required: - - createdOn - - quantity - - childCatenaXId - urn_bamm_io.catenax.single_level_bom_as_planned_1.1.0_SetOfChildPartsCharacteristic: - description: Set of child parts the parent object is assembled by (one structural - level down). - type: array - items: - $ref: '#/components/schemas/urn_bamm_io.catenax.single_level_bom_as_planned_1.1.0_ChildData' - uniqueItems: true - SingleLevelBomAsPlanned: - description: |- - The single-level Bill of Material represents one sub-level of an assembly and does not include any lower-level subassemblies. In As-Planned lifecycle state all variants are covered ("120% BoM"). - If multiple versions of child parts exist that can be assembled into the same parent part, all versions of the child part are included in the BoM. - If there are multiple suppliers for the same child part, each supplier has an entry for their child part in the BoM. - type: object - properties: - catenaXId: - description: "The Catena-X ID of the given part (e.g. the component), valid\ - \ for the Catena-X dataspace." - $ref: '#/components/schemas/urn_bamm_io.catenax.single_level_bom_as_planned_1.1.0_CatenaXIdTraitCharacteristic' - childParts: - description: "Set of child parts in As-Planned lifecycle phase, of which\ - \ the given parent object is assembled by (one structural level down)." - $ref: '#/components/schemas/urn_bamm_io.catenax.single_level_bom_as_planned_1.1.0_SetOfChildPartsCharacteristic' - required: - - catenaXId - - childParts - 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' - SingleLevelBomAsPlanned: - content: - application/json: - schema: - $ref: '#/components/schemas/PagingSchema' - description: The request was successful. - requestBodies: - SingleLevelBomAsPlanned: - content: - application/json: - schema: - $ref: '#/components/schemas/SingleLevelBomAsPlanned' diff --git a/io.catenax.single_level_bom_as_planned/1.1.0/metadata.json b/io.catenax.single_level_bom_as_planned/1.1.0/metadata.json deleted file mode 100644 index 9e759dfb1..000000000 --- a/io.catenax.single_level_bom_as_planned/1.1.0/metadata.json +++ /dev/null @@ -1 +0,0 @@ -{ "status" : "deprecate"} diff --git a/io.catenax.single_level_usage_as_built/1.0.1/SingleLevelUsageAsBuilt.ttl b/io.catenax.single_level_usage_as_built/1.0.1/SingleLevelUsageAsBuilt.ttl deleted file mode 100644 index 6a3635d6e..000000000 --- a/io.catenax.single_level_usage_as_built/1.0.1/SingleLevelUsageAsBuilt.ttl +++ /dev/null @@ -1,129 +0,0 @@ -####################################################################### -# Copyright (c) 2022 BASF SE -# Copyright (c) 2022 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) -# Copyright (c) 2022 Fraunhofer-Gesellschaft zur Foerderung der angewandten Forschung e.V. (represented by Fraunhofer ISST & Fraunhofer IML) -# Copyright (c) 2022 German Edge Cloud GmbH & Co. KG -# Copyright (c) 2022 Henkel AG & Co. KGaA -# Copyright (c) 2022 Mercedes Benz AG -# Copyright (c) 2022 Robert Bosch Manufacturing Solutions GmbH -# Copyright (c) 2022 SAP SE -# Copyright (c) 2022 Siemens AG -# Copyright (c) 2022 T-Systems International GmbH -# Copyright (c) 2022 ZF Friedrichshafen AG -# Copyright (c) 2022 Contributors to the Eclipse Foundation -# -# 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 bamm: . -@prefix bamm-c: . -@prefix bamm-e: . -@prefix unit: . -@prefix rdf: . -@prefix rdfs: . -@prefix xsd: . -@prefix : . - -:catenaXId a bamm:Property; - bamm:name "catenaXId"; - bamm:preferredName "Catena-X Identifier"@en; - bamm:description "The Catena-X ID of the given part (e.g. the assembly), valid for the Catena-X dataspace."@en; - bamm:characteristic :CatenaXIdTraitCharacteristic; - bamm:exampleValue "urn:uuid:055c1128-0375-47c8-98de-7cf802c3241d". -:CatenaXIdTraitCharacteristic a bamm-c:Trait; - bamm:name "CatenaXIdTraitCharacteristic"; - bamm:description "Trait to ensure UUID v4 data format"@en; - bamm-c:baseCharacteristic :UUIDv4Characteristic; - bamm-c:constraint :UUIDv4RegularExpression. -:UUIDv4Characteristic a bamm:Characteristic; - bamm:name "UUIDv4Characteristic"; - bamm:preferredName "UUID v4"@en; - bamm:description "A version 4 UUID is a universally unique identifier that is generated using random 32 hexadecimal characters."@en; - bamm:dataType xsd:string; - bamm:see . -:UUIDv4RegularExpression a bamm-c:RegularExpressionConstraint; - bamm:name "UUIDv4RegularExpression"; - bamm:preferredName "Catena-X Id Regular Expression"@en; - bamm: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."@en; - bamm:see ; - bamm:value "(^[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}$)". -:createdOn a bamm:Property; - bamm:name "createdOn"; - bamm:preferredName "Created On"@en; - bamm:description "Timestamp when the relation between the parent part and the child part was created, e.g. when the given child part was assembled into the parent part."@en; - bamm:characteristic bamm-c:Timestamp; - bamm:exampleValue "2022-02-03T14:48:54.709Z"^^xsd:dateTime. -:quantity a bamm:Property; - bamm:name "quantity"; - bamm:preferredName "Quantity"@en; - bamm:description "Quantity of which the child part is assembled into the parent part. In general it is '1' for serialized parts."@en; - bamm:characteristic :QuantityCharacteristic. -:QuantityCharacteristic a bamm-c:Quantifiable; - bamm:name "QuantityCharacteristic"; - bamm:description "Describes the quantity in which the child part is assembled in the parent object by providing a quantity value and the measurement unit in which the quantity is measured."@en; - bamm:dataType :Quantity. -:lastModifiedOn a bamm:Property; - bamm:name "lastModifiedOn"; - bamm:preferredName "Last Modification Date"@en; - bamm:description "Timestamp when the assembly relationship between parent part and child part was last modified."@en; - bamm:characteristic bamm-c:Timestamp; - bamm:exampleValue "2022-02-03T14:48:54.709Z"^^xsd:dateTime. -:Quantity a bamm:Entity; - bamm:name "Quantity"; - bamm:description "Comprises the number of objects and the unit of measurement for the respective child objects"@en; - bamm:properties (:quantityNumber :measurementUnit). -:quantityNumber a bamm:Property; - bamm:name "quantityNumber"; - bamm:preferredName "Quantity Number"@en; - bamm:description "The number of objects related to the measurement unit"@en; - bamm:characteristic :NumberOfObjects; - bamm:exampleValue "2.5"^^xsd:double. -:measurementUnit a bamm:Property; - bamm:name "measurementUnit"; - bamm:description "Unit of Measurement for the quantity of serialized objects"@en; - bamm:characteristic bamm-c:UnitReference; - bamm:exampleValue "litre"^^bamm:curie; - bamm:see . -:NumberOfObjects a bamm:Characteristic; - bamm:name "NumberOfObjects"; - bamm:description "Quantifiable number of objects in reference to the measurementUnit"@en; - bamm:dataType xsd:double. -:SingleLevelUsageAsBuilt a bamm:Aspect; - bamm:name "SingleLevelUsageAsBuilt"; - bamm:preferredName "SingleLevelUsageAsBuilt"@en; - bamm:description "The aspect provides the information in which parent part(s)/product(s) the given item is assembled in. Could be a 1:1 relationship in terms of a e.g. a brake component or 1:n for e.g. coatings. The given item as well as the parent item must refer to an object from as-built lifecycle phase, i.e. a batch or a serialized part. "@en; - bamm:properties (:catenaXId :parentParts); - bamm:operations (); - bamm:events (). -:parentParts a bamm:Property; - bamm:name "parentParts"; - bamm:preferredName "Parent Parts"@en; - bamm:description "Set of parent parts, in which the given child object is assembled in (one structural level up)."@en; - bamm:characteristic :SetOfParentPartsCharacteristic. -:SetOfParentPartsCharacteristic a bamm-c:Set; - bamm:name "SetOfParentPartsCharacteristic"; - bamm:preferredName "Set of Parent Parts"@en; - bamm:description "Set of parent parts the given child object is assembled in (one structural level up)."@en; - bamm:dataType :ParentData. -:ParentData a bamm:Entity; - bamm:name "ParentData"; - bamm:preferredName "Parent Data"@en; - bamm:description "Catena-X ID and meta data of the parent part."@en; - bamm:properties (:createdOn :quantity [ - bamm:property :lastModifiedOn; - bamm:optional "true"^^xsd:boolean -] :parentCatenaXId). - -:parentCatenaXId a bamm:Property; - bamm:name "parentCatenaXId"; - bamm:preferredName "Catena-X Parent Identifier"@en; - bamm:description "The Catena-X ID of the parent object, into which the given child object is assembled in."@en; - bamm:characteristic :CatenaXIdTraitCharacteristic. diff --git a/io.catenax.single_level_usage_as_built/1.0.1/gen/SingleLevelUsageAsBuilt-aas.xml b/io.catenax.single_level_usage_as_built/1.0.1/gen/SingleLevelUsageAsBuilt-aas.xml deleted file mode 100644 index 47f8c375d..000000000 --- a/io.catenax.single_level_usage_as_built/1.0.1/gen/SingleLevelUsageAsBuilt-aas.xml +++ /dev/null @@ -1,643 +0,0 @@ - - - - - defaultAdminShell - - - en - defaultAdminShell - - - - urn:samm:io.catenax.single_level_usage_as_built:1.0.1#SingleLevelUsageAsBuilt - - Type - - - - ModelReference - - - Submodel - urn:samm:io.catenax.single_level_usage_as_built:1.0.1#SingleLevelUsageAsBuilt/submodel - - - - - - - - - SingleLevelUsageAsBuilt - - - en - The aspect provides the information in which parent part(s)/product(s) the given item is assembled in. Could be a 1:1 relationship in terms of a e.g. a brake component or 1:n for e.g. coatings. The given item as well as the parent item must refer to an object from as-built lifecycle phase, i.e. a batch or a serialized part. - - - - urn:samm:io.catenax.single_level_usage_as_built:1.0.1#SingleLevelUsageAsBuilt/submodel - Template - - ModelReference - - - ConceptDescription - urn:samm:io.catenax.single_level_usage_as_built:1.0.1#SingleLevelUsageAsBuilt - - - - - - catenaXId - - - en - Catena-X Identifier - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.single_level_usage_as_built:1.0.1#catenaXId - - - - xs:string - - - - parentParts - - - en - Parent Parts - - - - - en - Set of parent parts, in which the given child object is assembled in (one structural level up). - - - true - DataElement - - - ParentData - - - en - Parent Data - - - - - en - Catena-X ID and meta data of the parent part. - - - - - createdOn - - - en - Created On - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.single_level_usage_as_built:1.0.1#createdOn - - - - xs:dateTime - - - - Quantity - - - en - Comprises the number of objects and the unit of measurement for the respective child objects - - - - - quantityNumber - - - en - Quantity Number - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.single_level_usage_as_built:1.0.1#quantityNumber - - - - xs:double - - - - measurementUnit - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.single_level_usage_as_built:1.0.1#measurementUnit - - - - - - ExternalReference - - - GlobalReference - https://openmanufacturingplatform.github.io/sds-bamm-aspect-meta-model/bamm-specification/snapshot/appendix/unitcatalog.html - - - - - xs:string - - - - - - lastModifiedOn - - - en - Last Modification Date - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.single_level_usage_as_built:1.0.1#lastModifiedOn - - - - xs:dateTime - - - - parentCatenaXId - - - en - Catena-X Parent Identifier - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.single_level_usage_as_built:1.0.1#parentCatenaXId - - - - xs:string - - - - - - - - - - - - APPLICATION_CLASS - SingleLevelUsageAsBuilt - - - en - SingleLevelUsageAsBuilt - - - - - en - The aspect provides the information in which parent part(s)/product(s) the given item is assembled in. Could be a 1:1 relationship in terms of a e.g. a brake component or 1:n for e.g. coatings. The given item as well as the parent item must refer to an object from as-built lifecycle phase, i.e. a batch or a serialized part. - - - urn:samm:io.catenax.single_level_usage_as_built:1.0.1#SingleLevelUsageAsBuilt - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - SingleLevelUsageAsBuilt - - - - - en - SingleLevelUsageAsBuilt - - - - - en - The aspect provides the information in which parent part(s)/product(s) the given item is assembled in. Could be a 1:1 relationship in terms of a e.g. a brake component or 1:n for e.g. coatings. The given item as well as the parent item must refer to an object from as-built lifecycle phase, i.e. a batch or a serialized part. - - - - - - - - - catenaXId - - - en - Catena-X Identifier - - - urn:samm:io.catenax.single_level_usage_as_built:1.0.1#catenaXId - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Catena-X Identifier - - - - - en - catenaXId - - - STRING - - - en - The Catena-X ID of the given part (e.g. the assembly), valid for the Catena-X dataspace. - - - - - - - - - createdOn - - - en - Created On - - - urn:samm:io.catenax.single_level_usage_as_built:1.0.1#createdOn - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Created On - - - - - en - createdOn - - - STRING - - - en - Timestamp when the relation between the parent part and the child part was created, e.g. when the given child part was assembled into the parent part. - - - - - - - - - quantityNumber - - - en - Quantity Number - - - urn:samm:io.catenax.single_level_usage_as_built:1.0.1#quantityNumber - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Quantity Number - - - - - en - quantityNumber - - - REAL_MEASURE - - - en - The number of objects related to the measurement unit - - - - - - - - - measurementUnit - urn:samm:io.catenax.single_level_usage_as_built:1.0.1#measurementUnit - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - measurementUnit - - - - - en - measurementUnit - - - STRING - - - en - Unit of Measurement for the quantity of serialized objects - - - - - - - - - quantity - - - en - Quantity - - - urn:samm:io.catenax.single_level_usage_as_built:1.0.1#quantity - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Quantity - - - - - en - quantity - - - STRING - - - en - Quantity of which the child part is assembled into the parent part. In general it is '1' for serialized parts. - - - - - - - - - lastModifiedOn - - - en - Last Modification Date - - - urn:samm:io.catenax.single_level_usage_as_built:1.0.1#lastModifiedOn - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Last Modification Date - - - - - en - lastModifiedOn - - - STRING - - - en - Timestamp when the assembly relationship between parent part and child part was last modified. - - - - - - - - - parentCatenaXId - - - en - Catena-X Parent Identifier - - - urn:samm:io.catenax.single_level_usage_as_built:1.0.1#parentCatenaXId - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Catena-X Parent Identifier - - - - - en - parentCatenaXId - - - STRING - - - en - The Catena-X ID of the parent object, into which the given child object is assembled in. - - - - - - - - - parentParts - - - en - Parent Parts - - - urn:samm:io.catenax.single_level_usage_as_built:1.0.1#parentParts - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Parent Parts - - - - - en - parentParts - - - STRING - - - en - Set of parent parts, in which the given child object is assembled in (one structural level up). - - - - - - - - - diff --git a/io.catenax.single_level_usage_as_built/1.0.1/gen/SingleLevelUsageAsBuilt-schema.json b/io.catenax.single_level_usage_as_built/1.0.1/gen/SingleLevelUsageAsBuilt-schema.json deleted file mode 100644 index 59dfb9c55..000000000 --- a/io.catenax.single_level_usage_as_built/1.0.1/gen/SingleLevelUsageAsBuilt-schema.json +++ /dev/null @@ -1,85 +0,0 @@ -{ - "$schema" : "http://json-schema.org/draft-04/schema", - "description" : "The aspect provides the information in which parent part(s)/product(s) the given item is assembled in. Could be a 1:1 relationship in terms of a e.g. a brake component or 1:n for e.g. coatings. The given item as well as the parent item must refer to an object from as-built lifecycle phase, i.e. a batch or a serialized part. ", - "type" : "object", - "components" : { - "schemas" : { - "urn_bamm_io.catenax.single_level_usage_as_built_1.0.1_CatenaXIdTraitCharacteristic" : { - "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_bamm_io.openmanufacturing_characteristic_2.0.0_Timestamp" : { - "type" : "string", - "pattern" : "-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T(([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](\\.[0-9]+)?|(24:00:00(\\.0+)?))(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?", - "description" : "Describes a Property which contains the date and time with an optional timezone." - }, - "urn_bamm_io.catenax.single_level_usage_as_built_1.0.1_NumberOfObjects" : { - "type" : "number", - "description" : "Quantifiable number of objects in reference to the measurementUnit" - }, - "urn_bamm_io.openmanufacturing_characteristic_2.0.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_bamm_io.catenax.single_level_usage_as_built_1.0.1_QuantityCharacteristic" : { - "description" : "Describes the quantity in which the child part is assembled in the parent object by providing a quantity value and the measurement unit in which the quantity is measured.", - "type" : "object", - "properties" : { - "quantityNumber" : { - "description" : "The number of objects related to the measurement unit", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.single_level_usage_as_built_1.0.1_NumberOfObjects" - }, - "measurementUnit" : { - "description" : "Unit of Measurement for the quantity of serialized objects", - "$ref" : "#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_UnitReference" - } - }, - "required" : [ "quantityNumber", "measurementUnit" ] - }, - "urn_bamm_io.catenax.single_level_usage_as_built_1.0.1_ParentData" : { - "description" : "Catena-X ID and meta data of the parent part.", - "type" : "object", - "properties" : { - "createdOn" : { - "description" : "Timestamp when the relation between the parent part and the child part was created, e.g. when the given child part was assembled into the parent part.", - "$ref" : "#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Timestamp" - }, - "quantity" : { - "description" : "Quantity of which the child part is assembled into the parent part. In general it is '1' for serialized parts.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.single_level_usage_as_built_1.0.1_QuantityCharacteristic" - }, - "lastModifiedOn" : { - "description" : "Timestamp when the assembly relationship between parent part and child part was last modified.", - "$ref" : "#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Timestamp" - }, - "parentCatenaXId" : { - "description" : "The Catena-X ID of the parent object, into which the given child object is assembled in.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.single_level_usage_as_built_1.0.1_CatenaXIdTraitCharacteristic" - } - }, - "required" : [ "createdOn", "quantity", "parentCatenaXId" ] - }, - "urn_bamm_io.catenax.single_level_usage_as_built_1.0.1_SetOfParentPartsCharacteristic" : { - "description" : "Set of parent parts the given child object is assembled in (one structural level up).", - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/urn_bamm_io.catenax.single_level_usage_as_built_1.0.1_ParentData" - }, - "uniqueItems" : true - } - } - }, - "properties" : { - "catenaXId" : { - "description" : "The Catena-X ID of the given part (e.g. the assembly), valid for the Catena-X dataspace.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.single_level_usage_as_built_1.0.1_CatenaXIdTraitCharacteristic" - }, - "parentParts" : { - "description" : "Set of parent parts, in which the given child object is assembled in (one structural level up).", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.single_level_usage_as_built_1.0.1_SetOfParentPartsCharacteristic" - } - }, - "required" : [ "catenaXId", "parentParts" ] -} \ No newline at end of file diff --git a/io.catenax.single_level_usage_as_built/1.0.1/gen/SingleLevelUsageAsBuilt.aasx b/io.catenax.single_level_usage_as_built/1.0.1/gen/SingleLevelUsageAsBuilt.aasx deleted file mode 100644 index 99dc48c29..000000000 Binary files a/io.catenax.single_level_usage_as_built/1.0.1/gen/SingleLevelUsageAsBuilt.aasx and /dev/null differ diff --git a/io.catenax.single_level_usage_as_built/1.0.1/gen/SingleLevelUsageAsBuilt.html b/io.catenax.single_level_usage_as_built/1.0.1/gen/SingleLevelUsageAsBuilt.html deleted file mode 100644 index 1b1ad22b3..000000000 --- a/io.catenax.single_level_usage_as_built/1.0.1/gen/SingleLevelUsageAsBuilt.html +++ /dev/null @@ -1,863 +0,0 @@ - - - - - - - - - - - - - - Dokumentation SingleLevelUsageAsBuilt - - -
-
-
-
-

Aspect Model SingleLevelUsageAsBuilt

-
urn:bamm:io.catenax.single_level_usage_as_built:1.0.1#SingleLevelUsageAsBuilt
-
-
-
-
-
-
-
- -
- - -
- The aspect provides the information in which parent part(s)/product(s) the given item is assembled in. Could be a 1:1 relationship in terms of a e.g. a brake component or 1:n for e.g. coatings. The given item as well as the parent item must refer to an object from as-built lifecycle phase, i.e. a batch or a serialized part. -
- - -
-

Übersicht

-
-
-
-
- Aspect Model Diagram -
-
-
- - -
-
-

Properties

-
- -
- -
-

Catena-X Identifier

-
- -The Catena-X ID of the given part (e.g. the assembly), valid for the Catena-X dataspace. - -
-
Name
-
catenaXId
-
- - - -
-
Characteristic
-
-
-
-
Trait
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Beispiel
-
urn:uuid:055c1128-0375-47c8-98de-7cf802c3241d
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
catenaXId
-
- - -
-
Bedingungen
-
-
    -
  • -
    - -
    - Catena-X Id Regular Expression -
    - -
    -
    Beschreibung
    -
    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.
    -
    - -
    -
    Referenz
    -
    -
    -
      -
    • https://datatracker.ietf.org/doc/html/rfc4122
      • -
    -
    -
    -
    - -
    -
    Regulärer Ausdruck
    -
    (^[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}$)
    -
    - -
    • -
-
-
-
-
- -
-

Parent Parts

-
- -Set of parent parts, in which the given child object is assembled in (one structural level up). - -
-
Name
-
parentParts
-
- - - -
-
Characteristic
-
-
-
-
Set
-
-
-
Has no order
-
-
-
Duplicates not allowed
-
-
-
- Typ urn:bamm:io.catenax.single_level_usage_as_built:1.0.1#ParentData - -
-
-
-
-
- - -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
parentParts
-
- - -
-
- - - -
-
-

Objekt

-
- -
-
-

Parent Data

-
-
- Catena-X ID and meta data of the parent part. -
- -
-

Properties

-
-
- -
-
Created On
-
- -Timestamp when the relation between the parent part and the child part was created, e.g. when the given child part was assembled into the parent part. - -
-
Name
-
createdOn
-
- - - -
-
Characteristic
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#dateTime - -
-
-
-
-
- -
-
Beispiel
-
2022-02-03T14:48:54.709Z
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
createdOn
-
- - -
-
- -
-
Quantity
-
- -Quantity of which the child part is assembled into the parent part. In general it is '1' for serialized parts. - -
-
Name
-
quantity
-
- - - -
-
Characteristic
-
-
-
-
Quantifiable
-
-
-
Duration
-
-
-
Describes the quantity in which the child part is assembled in the parent object by providing a quantity value and the measurement unit in which the quantity is measured.
-
-
-
- Typ urn:bamm:io.catenax.single_level_usage_as_built:1.0.1#Quantity - -
-
-
-
-
- - -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
quantity
-
- - -
-
- -
-
Last Modification Date
-
- -Timestamp when the assembly relationship between parent part and child part was last modified. - -
-
Name
-
lastModifiedOn
-
- - - -
-
Characteristic
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#dateTime - -
-
-
-
-
- -
-
Beispiel
-
2022-02-03T14:48:54.709Z
-
- -
-
Optional
-
- Ja
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
lastModifiedOn
-
- - -
-
- -
-
Catena-X Parent Identifier
-
- -The Catena-X ID of the parent object, into which the given child object is assembled in. - -
-
Name
-
parentCatenaXId
-
- - - -
-
Characteristic
-
-
-
-
Trait
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- - -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
parentCatenaXId
-
- - -
-
Bedingungen
-
-
    -
  • -
    - -
    - Catena-X Id Regular Expression -
    - -
    -
    Beschreibung
    -
    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.
    -
    - -
    -
    Referenz
    -
    -
    -
      -
    • https://datatracker.ietf.org/doc/html/rfc4122
      • -
    -
    -
    -
    - -
    -
    Regulärer Ausdruck
    -
    (^[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}$)
    -
    - -
    • -
-
-
-
-
-
-
-

Quantity

-
-
- Comprises the number of objects and the unit of measurement for the respective child objects -
- -
-

Properties

-
-
- -
-
Quantity Number
-
- -The number of objects related to the measurement unit - -
-
Name
-
quantityNumber
-
- - - -
-
Characteristic
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#double - -
-
-
-
-
- -
-
Beispiel
-
2.5
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
quantityNumber
-
- - -
-
- -
-
measurementUnit
-
- -Unit of Measurement for the quantity of serialized objects - -
-
Name
-
measurementUnit
-
- - - -
-
Characteristic
-
-
-
-
- Typ urn:bamm:io.openmanufacturing:meta-model:2.0.0#curie - -
-
-
-
-
- -
-
Beispiel
-
litre
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
measurementUnit
-
- -
-
Referenz
-
-
    -
  • https://openmanufacturingplatform.github.io/sds-bamm-aspect-meta-model/bamm-specification/snapshot/appendix/unitcatalog.html
    • -
-
-
- -
-
-
- -
- Third party licenses - -
- -
- - -
- - - \ No newline at end of file diff --git a/io.catenax.single_level_usage_as_built/1.0.1/gen/SingleLevelUsageAsBuilt.json b/io.catenax.single_level_usage_as_built/1.0.1/gen/SingleLevelUsageAsBuilt.json deleted file mode 100644 index 51b7b89f8..000000000 --- a/io.catenax.single_level_usage_as_built/1.0.1/gen/SingleLevelUsageAsBuilt.json +++ /dev/null @@ -1,12 +0,0 @@ -{ - "parentParts" : [ { - "parentCatenaXId" : "46D07E5c-a0b4-Dfbf-Da6A-1c9daAa4d8bb", - "quantity" : { - "quantityNumber" : 2.5, - "measurementUnit" : "litre" - }, - "createdOn" : "2022-02-03T14:48:54.709Z", - "lastModifiedOn" : "2022-02-03T14:48:54.709Z" - } ], - "catenaXId" : "urn:uuid:055c1128-0375-47c8-98de-7cf802c3241d" -} \ No newline at end of file diff --git a/io.catenax.single_level_usage_as_built/1.0.1/gen/SingleLevelUsageAsBuilt.yml b/io.catenax.single_level_usage_as_built/1.0.1/gen/SingleLevelUsageAsBuilt.yml deleted file mode 100644 index d4f5fe458..000000000 --- a/io.catenax.single_level_usage_as_built/1.0.1/gen/SingleLevelUsageAsBuilt.yml +++ /dev/null @@ -1,210 +0,0 @@ ---- -openapi: 3.0.3 -info: - title: SingleLevelUsageAsBuilt - version: v1 -servers: -- url: catenax.io/api/v1 - variables: - api-version: - default: v1 -paths: - /{tenant-id}/single-level-usage-as-built: - get: - tags: - - SingleLevelUsageAsBuilt - operationId: getSingleLevelUsageAsBuilt - 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/SingleLevelUsageAsBuilt' - "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/SingleLevelUsageAsBuilt' - totalItems: - type: number - totalPages: - type: number - pageSize: - type: number - currentPage: - type: number - urn_bamm_io.catenax.single_level_usage_as_built_1.0.1_CatenaXIdTraitCharacteristic: - 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_bamm_io.openmanufacturing_characteristic_2.0.0_Timestamp: - type: string - pattern: "-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T(([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](\\\ - .[0-9]+)?|(24:00:00(\\.0+)?))(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?" - description: Describes a Property which contains the date and time with an optional - timezone. - urn_bamm_io.catenax.single_level_usage_as_built_1.0.1_NumberOfObjects: - type: number - description: Quantifiable number of objects in reference to the measurementUnit - urn_bamm_io.openmanufacturing_characteristic_2.0.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_bamm_io.catenax.single_level_usage_as_built_1.0.1_QuantityCharacteristic: - description: Describes the quantity in which the child part is assembled in - the parent object by providing a quantity value and the measurement unit in - which the quantity is measured. - type: object - properties: - quantityNumber: - description: The number of objects related to the measurement unit - $ref: '#/components/schemas/urn_bamm_io.catenax.single_level_usage_as_built_1.0.1_NumberOfObjects' - measurementUnit: - description: Unit of Measurement for the quantity of serialized objects - $ref: '#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_UnitReference' - required: - - quantityNumber - - measurementUnit - urn_bamm_io.catenax.single_level_usage_as_built_1.0.1_ParentData: - description: Catena-X ID and meta data of the parent part. - type: object - properties: - createdOn: - description: "Timestamp when the relation between the parent part and the\ - \ child part was created, e.g. when the given child part was assembled\ - \ into the parent part." - $ref: '#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Timestamp' - quantity: - description: Quantity of which the child part is assembled into the parent - part. In general it is '1' for serialized parts. - $ref: '#/components/schemas/urn_bamm_io.catenax.single_level_usage_as_built_1.0.1_QuantityCharacteristic' - lastModifiedOn: - description: Timestamp when the assembly relationship between parent part - and child part was last modified. - $ref: '#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Timestamp' - parentCatenaXId: - description: "The Catena-X ID of the parent object, into which the given\ - \ child object is assembled in." - $ref: '#/components/schemas/urn_bamm_io.catenax.single_level_usage_as_built_1.0.1_CatenaXIdTraitCharacteristic' - required: - - createdOn - - quantity - - parentCatenaXId - urn_bamm_io.catenax.single_level_usage_as_built_1.0.1_SetOfParentPartsCharacteristic: - description: Set of parent parts the given child object is assembled in (one - structural level up). - type: array - items: - $ref: '#/components/schemas/urn_bamm_io.catenax.single_level_usage_as_built_1.0.1_ParentData' - uniqueItems: true - SingleLevelUsageAsBuilt: - description: "The aspect provides the information in which parent part(s)/product(s)\ - \ the given item is assembled in. Could be a 1:1 relationship in terms of\ - \ a e.g. a brake component or 1:n for e.g. coatings. The given item as well\ - \ as the parent item must refer to an object from as-built lifecycle phase,\ - \ i.e. a batch or a serialized part. " - type: object - properties: - catenaXId: - description: "The Catena-X ID of the given part (e.g. the assembly), valid\ - \ for the Catena-X dataspace." - $ref: '#/components/schemas/urn_bamm_io.catenax.single_level_usage_as_built_1.0.1_CatenaXIdTraitCharacteristic' - parentParts: - description: "Set of parent parts, in which the given child object is assembled\ - \ in (one structural level up)." - $ref: '#/components/schemas/urn_bamm_io.catenax.single_level_usage_as_built_1.0.1_SetOfParentPartsCharacteristic' - required: - - catenaXId - - parentParts - 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' - SingleLevelUsageAsBuilt: - content: - application/json: - schema: - $ref: '#/components/schemas/PagingSchema' - description: The request was successful. - requestBodies: - SingleLevelUsageAsBuilt: - content: - application/json: - schema: - $ref: '#/components/schemas/SingleLevelUsageAsBuilt' diff --git a/io.catenax.single_level_usage_as_built/1.0.1/metadata.json b/io.catenax.single_level_usage_as_built/1.0.1/metadata.json deleted file mode 100644 index 9e759dfb1..000000000 --- a/io.catenax.single_level_usage_as_built/1.0.1/metadata.json +++ /dev/null @@ -1 +0,0 @@ -{ "status" : "deprecate"} diff --git a/io.catenax.single_level_usage_as_planned/1.0.0/SingleLevelUsageAsPlanned.ttl b/io.catenax.single_level_usage_as_planned/1.0.0/SingleLevelUsageAsPlanned.ttl deleted file mode 100644 index 4a81c3077..000000000 --- a/io.catenax.single_level_usage_as_planned/1.0.0/SingleLevelUsageAsPlanned.ttl +++ /dev/null @@ -1,128 +0,0 @@ -####################################################################### -# Copyright (c) 2022 BASF SE -# Copyright (c) 2022 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) -# Copyright (c) 2022 Fraunhofer-Gesellschaft zur Foerderung der angewandten Forschung e.V. (represented by Fraunhofer ISST & Fraunhofer IML) -# Copyright (c) 2022 German Edge Cloud GmbH & Co. KG -# Copyright (c) 2022 Henkel AG & Co. KGaA -# Copyright (c) 2022 Mercedes-Benz AG -# Copyright (c) 2022 Robert Bosch Manufacturing Solutions GmbH -# Copyright (c) 2022 SAP SE -# Copyright (c) 2022 Siemens AG -# Copyright (c) 2022 T-Systems International GmbH -# Copyright (c) 2022 ZF Friedrichshafen AG -# Copyright (c) 2022 Contributors to the Eclipse Foundation -# -# 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 bamm: . -@prefix bamm-c: . -@prefix bamm-e: . -@prefix unit: . -@prefix rdf: . -@prefix rdfs: . -@prefix xsd: . -@prefix : . - -:SingleLevelUsageAsPlanned a bamm:Aspect; - bamm:name "SingleLevelUsageAsPlanned"; - bamm:preferredName "SingleLevelUsageAsPlanned"@en; - bamm:description "The aspect provides the information in which parent part(s)/product(s) the given item is assembled in. Could be a 1:1 relationship in terms of a e.g. a brake component or 1:n for e.g. coatings. The given item as well as the parent item must refer to an object from as-planned lifecycle phase."@en; - bamm:properties (:catenaXId :parentParts); - bamm:operations (); - bamm:events (). -:catenaXId a bamm:Property; - bamm:name "catenaXId"; - bamm:preferredName "Catena-X Identifier"@en; - bamm:description "The Catena-X ID of the given part (e.g. the assembly), valid for the Catena-X dataspace."@en; - bamm:characteristic :CatenaXIdTraitCharacteristic; - bamm:exampleValue "urn:uuid:055c1128-0375-47c8-98de-7cf802c3241d". -:parentParts a bamm:Property; - bamm:name "parentParts"; - bamm:preferredName "Parent Parts"@en; - bamm:description "Set of parent parts, in which the given child object is assembled in (one structural level up)."@en; - bamm:characteristic :SetOfParentPartsCharacteristic. -:CatenaXIdTraitCharacteristic a bamm-c:Trait; - bamm:name "CatenaXIdTraitCharacteristic"; - bamm:description "Trait to ensure UUID v4 data format"@en; - bamm-c:baseCharacteristic :UUIDv4Characteristic; - bamm-c:constraint :UUIDv4RegularExpression. -:SetOfParentPartsCharacteristic a bamm-c:Set; - bamm:name "SetOfParentPartsCharacteristic"; - bamm:preferredName "Set of Parent Parts"@en; - bamm:description "Set of parent parts the given child object is assembled in (one structural level up)."@en; - bamm:dataType :ParentData. -:UUIDv4Characteristic a bamm:Characteristic; - bamm:name "UUIDv4Characteristic"; - bamm:preferredName "UUID v4"@en; - bamm:description "A version 4 UUID is a universally unique identifier that is generated using random 32 hexadecimal characters."@en; - bamm:dataType xsd:string; - bamm:see . -:UUIDv4RegularExpression a bamm-c:RegularExpressionConstraint; - bamm:name "UUIDv4RegularExpression"; - bamm:preferredName "Catena-X Id Regular Expression"@en; - bamm: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."@en; - bamm:see ; - bamm:value "(^[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}$)". -:parentCatenaXId a bamm:Property; - bamm:name "parentCatenaXId"; - bamm:preferredName "Catena-X Parent Identifier"@en; - bamm:description "The Catena-X ID of the parent object, into which the given child object is assembled in."@en; - bamm:characteristic :CatenaXIdTraitCharacteristic. -:ParentData a bamm:Entity; - bamm:name "ParentData"; - bamm:preferredName "Parent Data"@en; - bamm:description "Catena-X ID and meta data of the parent part."@en; - bamm:properties (:createdOn :quantity [ - bamm:property :lastModifiedOn; - bamm:optional "true"^^xsd:boolean -] :parentCatenaXId). -:createdOn a bamm:Property; - bamm:name "createdOn"; - bamm:preferredName "Created On"@en; - bamm:description "Timestamp when the relation between the parent part and the child part was created."@en; - bamm:characteristic bamm-c:Timestamp; - bamm:exampleValue "2022-02-03T14:48:54.709Z"^^xsd:dateTime. -:quantity a bamm:Property; - bamm:name "quantity"; - bamm:preferredName "Quantity"@en; - bamm:description "Quantity of which the child part is assembled into the parent part."@en; - bamm:characteristic :QuantityCharacteristic. -:lastModifiedOn a bamm:Property; - bamm:name "lastModifiedOn"; - bamm:preferredName "Last Modification Date"@en; - bamm:description "Timestamp when the assembly relationship between parent part and child part was last modified."@en; - bamm:characteristic bamm-c:Timestamp; - bamm:exampleValue "2022-02-03T14:48:54.709Z"^^xsd:dateTime. -:QuantityCharacteristic a bamm-c:Quantifiable; - bamm:name "QuantityCharacteristic"; - bamm:description "Describes the quantity in which the child part is assembled in the parent object by providing a quantity value and the measurement unit in which the quantity is measured."@en; - bamm:dataType :Quantity. -:Quantity a bamm:Entity; - bamm:name "Quantity"; - bamm:description "Comprises the number of objects and the unit of measurement for the respective child objects"@en; - bamm:properties (:quantityNumber :measurementUnit). -:quantityNumber a bamm:Property; - bamm:name "quantityNumber"; - bamm:preferredName "Quantity Number"@en; - bamm:description "The number of objects related to the measurement unit"@en; - bamm:characteristic :NumberOfObjects; - bamm:exampleValue "2.5"^^xsd:double. -:measurementUnit a bamm:Property; - bamm:name "measurementUnit"; - bamm:description "Unit of Measurement for the quantity of serialized objects"@en; - bamm:characteristic bamm-c:UnitReference; - bamm:exampleValue "litre"^^bamm:curie; - bamm:see . -:NumberOfObjects a bamm:Characteristic; - bamm:name "NumberOfObjects"; - bamm:description "Quantifiable number of objects in reference to the measurementUnit"@en; - bamm:dataType xsd:double. diff --git a/io.catenax.single_level_usage_as_planned/1.0.0/gen/SingleLevelUsageAsPlanned-aas.xml b/io.catenax.single_level_usage_as_planned/1.0.0/gen/SingleLevelUsageAsPlanned-aas.xml deleted file mode 100644 index 875249370..000000000 --- a/io.catenax.single_level_usage_as_planned/1.0.0/gen/SingleLevelUsageAsPlanned-aas.xml +++ /dev/null @@ -1,643 +0,0 @@ - - - - - defaultAdminShell - - - en - defaultAdminShell - - - - urn:samm:io.catenax.single_level_usage_as_planned:1.0.0#SingleLevelUsageAsPlanned - - Type - - - - ModelReference - - - Submodel - urn:samm:io.catenax.single_level_usage_as_planned:1.0.0#SingleLevelUsageAsPlanned/submodel - - - - - - - - - SingleLevelUsageAsPlanned - - - en - The aspect provides the information in which parent part(s)/product(s) the given item is assembled in. Could be a 1:1 relationship in terms of a e.g. a brake component or 1:n for e.g. coatings. The given item as well as the parent item must refer to an object from as-planned lifecycle phase. - - - - urn:samm:io.catenax.single_level_usage_as_planned:1.0.0#SingleLevelUsageAsPlanned/submodel - Template - - ModelReference - - - ConceptDescription - urn:samm:io.catenax.single_level_usage_as_planned:1.0.0#SingleLevelUsageAsPlanned - - - - - - catenaXId - - - en - Catena-X Identifier - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.single_level_usage_as_planned:1.0.0#catenaXId - - - - xs:string - - - - parentParts - - - en - Parent Parts - - - - - en - Set of parent parts, in which the given child object is assembled in (one structural level up). - - - true - DataElement - - - ParentData - - - en - Parent Data - - - - - en - Catena-X ID and meta data of the parent part. - - - - - createdOn - - - en - Created On - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.single_level_usage_as_planned:1.0.0#createdOn - - - - xs:dateTime - - - - Quantity - - - en - Comprises the number of objects and the unit of measurement for the respective child objects - - - - - quantityNumber - - - en - Quantity Number - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.single_level_usage_as_planned:1.0.0#quantityNumber - - - - xs:double - - - - measurementUnit - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.single_level_usage_as_planned:1.0.0#measurementUnit - - - - - - ExternalReference - - - GlobalReference - https://openmanufacturingplatform.github.io/sds-bamm-aspect-meta-model/bamm-specification/snapshot/appendix/unitcatalog.html - - - - - xs:string - - - - - - lastModifiedOn - - - en - Last Modification Date - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.single_level_usage_as_planned:1.0.0#lastModifiedOn - - - - xs:dateTime - - - - parentCatenaXId - - - en - Catena-X Parent Identifier - - - - ExternalReference - - - ConceptDescription - urn:samm:io.catenax.single_level_usage_as_planned:1.0.0#parentCatenaXId - - - - xs:string - - - - - - - - - - - - APPLICATION_CLASS - SingleLevelUsageAsPlanned - - - en - SingleLevelUsageAsPlanned - - - - - en - The aspect provides the information in which parent part(s)/product(s) the given item is assembled in. Could be a 1:1 relationship in terms of a e.g. a brake component or 1:n for e.g. coatings. The given item as well as the parent item must refer to an object from as-planned lifecycle phase. - - - urn:samm:io.catenax.single_level_usage_as_planned:1.0.0#SingleLevelUsageAsPlanned - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - SingleLevelUsageAsPlanned - - - - - en - SingleLevelUsageAsPlanned - - - - - en - The aspect provides the information in which parent part(s)/product(s) the given item is assembled in. Could be a 1:1 relationship in terms of a e.g. a brake component or 1:n for e.g. coatings. The given item as well as the parent item must refer to an object from as-planned lifecycle phase. - - - - - - - - - catenaXId - - - en - Catena-X Identifier - - - urn:samm:io.catenax.single_level_usage_as_planned:1.0.0#catenaXId - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Catena-X Identifier - - - - - en - catenaXId - - - STRING - - - en - The Catena-X ID of the given part (e.g. the assembly), valid for the Catena-X dataspace. - - - - - - - - - createdOn - - - en - Created On - - - urn:samm:io.catenax.single_level_usage_as_planned:1.0.0#createdOn - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Created On - - - - - en - createdOn - - - STRING - - - en - Timestamp when the relation between the parent part and the child part was created. - - - - - - - - - quantityNumber - - - en - Quantity Number - - - urn:samm:io.catenax.single_level_usage_as_planned:1.0.0#quantityNumber - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Quantity Number - - - - - en - quantityNumber - - - REAL_MEASURE - - - en - The number of objects related to the measurement unit - - - - - - - - - measurementUnit - urn:samm:io.catenax.single_level_usage_as_planned:1.0.0#measurementUnit - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - measurementUnit - - - - - en - measurementUnit - - - STRING - - - en - Unit of Measurement for the quantity of serialized objects - - - - - - - - - quantity - - - en - Quantity - - - urn:samm:io.catenax.single_level_usage_as_planned:1.0.0#quantity - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Quantity - - - - - en - quantity - - - STRING - - - en - Quantity of which the child part is assembled into the parent part. - - - - - - - - - lastModifiedOn - - - en - Last Modification Date - - - urn:samm:io.catenax.single_level_usage_as_planned:1.0.0#lastModifiedOn - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Last Modification Date - - - - - en - lastModifiedOn - - - STRING - - - en - Timestamp when the assembly relationship between parent part and child part was last modified. - - - - - - - - - parentCatenaXId - - - en - Catena-X Parent Identifier - - - urn:samm:io.catenax.single_level_usage_as_planned:1.0.0#parentCatenaXId - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Catena-X Parent Identifier - - - - - en - parentCatenaXId - - - STRING - - - en - The Catena-X ID of the parent object, into which the given child object is assembled in. - - - - - - - - - parentParts - - - en - Parent Parts - - - urn:samm:io.catenax.single_level_usage_as_planned:1.0.0#parentParts - - - - ExternalReference - - - GlobalReference - https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 - - - - - - - - en - Parent Parts - - - - - en - parentParts - - - STRING - - - en - Set of parent parts, in which the given child object is assembled in (one structural level up). - - - - - - - - - diff --git a/io.catenax.single_level_usage_as_planned/1.0.0/gen/SingleLevelUsageAsPlanned-schema.json b/io.catenax.single_level_usage_as_planned/1.0.0/gen/SingleLevelUsageAsPlanned-schema.json deleted file mode 100644 index c5b2b5299..000000000 --- a/io.catenax.single_level_usage_as_planned/1.0.0/gen/SingleLevelUsageAsPlanned-schema.json +++ /dev/null @@ -1,85 +0,0 @@ -{ - "$schema" : "http://json-schema.org/draft-04/schema", - "description" : "The aspect provides the information in which parent part(s)/product(s) the given item is assembled in. Could be a 1:1 relationship in terms of a e.g. a brake component or 1:n for e.g. coatings. The given item as well as the parent item must refer to an object from as-planned lifecycle phase.", - "type" : "object", - "components" : { - "schemas" : { - "urn_bamm_io.catenax.single_level_usage_as_planned_1.0.0_CatenaXIdTraitCharacteristic" : { - "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_bamm_io.openmanufacturing_characteristic_2.0.0_Timestamp" : { - "type" : "string", - "pattern" : "-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T(([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](\\.[0-9]+)?|(24:00:00(\\.0+)?))(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?", - "description" : "Describes a Property which contains the date and time with an optional timezone." - }, - "urn_bamm_io.catenax.single_level_usage_as_planned_1.0.0_NumberOfObjects" : { - "type" : "number", - "description" : "Quantifiable number of objects in reference to the measurementUnit" - }, - "urn_bamm_io.openmanufacturing_characteristic_2.0.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_bamm_io.catenax.single_level_usage_as_planned_1.0.0_QuantityCharacteristic" : { - "description" : "Describes the quantity in which the child part is assembled in the parent object by providing a quantity value and the measurement unit in which the quantity is measured.", - "type" : "object", - "properties" : { - "quantityNumber" : { - "description" : "The number of objects related to the measurement unit", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.single_level_usage_as_planned_1.0.0_NumberOfObjects" - }, - "measurementUnit" : { - "description" : "Unit of Measurement for the quantity of serialized objects", - "$ref" : "#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_UnitReference" - } - }, - "required" : [ "quantityNumber", "measurementUnit" ] - }, - "urn_bamm_io.catenax.single_level_usage_as_planned_1.0.0_ParentData" : { - "description" : "Catena-X ID and meta data of the parent part.", - "type" : "object", - "properties" : { - "createdOn" : { - "description" : "Timestamp when the relation between the parent part and the child part was created.", - "$ref" : "#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Timestamp" - }, - "quantity" : { - "description" : "Quantity of which the child part is assembled into the parent part.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.single_level_usage_as_planned_1.0.0_QuantityCharacteristic" - }, - "lastModifiedOn" : { - "description" : "Timestamp when the assembly relationship between parent part and child part was last modified.", - "$ref" : "#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Timestamp" - }, - "parentCatenaXId" : { - "description" : "The Catena-X ID of the parent object, into which the given child object is assembled in.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.single_level_usage_as_planned_1.0.0_CatenaXIdTraitCharacteristic" - } - }, - "required" : [ "createdOn", "quantity", "parentCatenaXId" ] - }, - "urn_bamm_io.catenax.single_level_usage_as_planned_1.0.0_SetOfParentPartsCharacteristic" : { - "description" : "Set of parent parts the given child object is assembled in (one structural level up).", - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/urn_bamm_io.catenax.single_level_usage_as_planned_1.0.0_ParentData" - }, - "uniqueItems" : true - } - } - }, - "properties" : { - "catenaXId" : { - "description" : "The Catena-X ID of the given part (e.g. the assembly), valid for the Catena-X dataspace.", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.single_level_usage_as_planned_1.0.0_CatenaXIdTraitCharacteristic" - }, - "parentParts" : { - "description" : "Set of parent parts, in which the given child object is assembled in (one structural level up).", - "$ref" : "#/components/schemas/urn_bamm_io.catenax.single_level_usage_as_planned_1.0.0_SetOfParentPartsCharacteristic" - } - }, - "required" : [ "catenaXId", "parentParts" ] -} \ No newline at end of file diff --git a/io.catenax.single_level_usage_as_planned/1.0.0/gen/SingleLevelUsageAsPlanned.aasx b/io.catenax.single_level_usage_as_planned/1.0.0/gen/SingleLevelUsageAsPlanned.aasx deleted file mode 100644 index ec4ca6d30..000000000 Binary files a/io.catenax.single_level_usage_as_planned/1.0.0/gen/SingleLevelUsageAsPlanned.aasx and /dev/null differ diff --git a/io.catenax.single_level_usage_as_planned/1.0.0/gen/SingleLevelUsageAsPlanned.html b/io.catenax.single_level_usage_as_planned/1.0.0/gen/SingleLevelUsageAsPlanned.html deleted file mode 100644 index 6c104ee47..000000000 --- a/io.catenax.single_level_usage_as_planned/1.0.0/gen/SingleLevelUsageAsPlanned.html +++ /dev/null @@ -1,863 +0,0 @@ - - - - - - - - - - - - - - Dokumentation SingleLevelUsageAsPlanned - - -
-
-
-
-

Aspect Model SingleLevelUsageAsPlanned

-
urn:bamm:io.catenax.single_level_usage_as_planned:1.0.0#SingleLevelUsageAsPlanned
-
-
-
-
-
-
-
- -
- - -
- The aspect provides the information in which parent part(s)/product(s) the given item is assembled in. Could be a 1:1 relationship in terms of a e.g. a brake component or 1:n for e.g. coatings. The given item as well as the parent item must refer to an object from as-planned lifecycle phase. -
- - -
-

Übersicht

-
-
-
-
- Aspect Model Diagram -
-
-
- - -
-
-

Properties

-
- -
- -
-

Catena-X Identifier

-
- -The Catena-X ID of the given part (e.g. the assembly), valid for the Catena-X dataspace. - -
-
Name
-
catenaXId
-
- - - -
-
Characteristic
-
-
-
-
Trait
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Beispiel
-
urn:uuid:055c1128-0375-47c8-98de-7cf802c3241d
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
catenaXId
-
- - -
-
Bedingungen
-
-
    -
  • -
    - -
    - Catena-X Id Regular Expression -
    - -
    -
    Beschreibung
    -
    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.
    -
    - -
    -
    Referenz
    -
    -
    -
      -
    • https://datatracker.ietf.org/doc/html/rfc4122
      • -
    -
    -
    -
    - -
    -
    Regulärer Ausdruck
    -
    (^[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}$)
    -
    - -
    • -
-
-
-
-
- -
-

Parent Parts

-
- -Set of parent parts, in which the given child object is assembled in (one structural level up). - -
-
Name
-
parentParts
-
- - - -
-
Characteristic
-
-
-
-
Set
-
-
-
Has no order
-
-
-
Duplicates not allowed
-
-
-
- Typ urn:bamm:io.catenax.single_level_usage_as_planned:1.0.0#ParentData - -
-
-
-
-
- - -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
parentParts
-
- - -
-
- - - -
-
-

Objekt

-
- -
-
-

Parent Data

-
-
- Catena-X ID and meta data of the parent part. -
- -
-

Properties

-
-
- -
-
Created On
-
- -Timestamp when the relation between the parent part and the child part was created. - -
-
Name
-
createdOn
-
- - - -
-
Characteristic
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#dateTime - -
-
-
-
-
- -
-
Beispiel
-
2022-02-03T14:48:54.709Z
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
createdOn
-
- - -
-
- -
-
Quantity
-
- -Quantity of which the child part is assembled into the parent part. - -
-
Name
-
quantity
-
- - - -
-
Characteristic
-
-
-
-
Quantifiable
-
-
-
Duration
-
-
-
Describes the quantity in which the child part is assembled in the parent object by providing a quantity value and the measurement unit in which the quantity is measured.
-
-
-
- Typ urn:bamm:io.catenax.single_level_usage_as_planned:1.0.0#Quantity - -
-
-
-
-
- - -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
quantity
-
- - -
-
- -
-
Last Modification Date
-
- -Timestamp when the assembly relationship between parent part and child part was last modified. - -
-
Name
-
lastModifiedOn
-
- - - -
-
Characteristic
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#dateTime - -
-
-
-
-
- -
-
Beispiel
-
2022-02-03T14:48:54.709Z
-
- -
-
Optional
-
- Ja
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
lastModifiedOn
-
- - -
-
- -
-
Catena-X Parent Identifier
-
- -The Catena-X ID of the parent object, into which the given child object is assembled in. - -
-
Name
-
parentCatenaXId
-
- - - -
-
Characteristic
-
-
-
-
Trait
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- - -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
parentCatenaXId
-
- - -
-
Bedingungen
-
-
    -
  • -
    - -
    - Catena-X Id Regular Expression -
    - -
    -
    Beschreibung
    -
    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.
    -
    - -
    -
    Referenz
    -
    -
    -
      -
    • https://datatracker.ietf.org/doc/html/rfc4122
      • -
    -
    -
    -
    - -
    -
    Regulärer Ausdruck
    -
    (^[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}$)
    -
    - -
    • -
-
-
-
-
-
-
-

Quantity

-
-
- Comprises the number of objects and the unit of measurement for the respective child objects -
- -
-

Properties

-
-
- -
-
Quantity Number
-
- -The number of objects related to the measurement unit - -
-
Name
-
quantityNumber
-
- - - -
-
Characteristic
-
-
-
-
- Typ http://www.w3.org/2001/XMLSchema#double - -
-
-
-
-
- -
-
Beispiel
-
2.5
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
quantityNumber
-
- - -
-
- -
-
measurementUnit
-
- -Unit of Measurement for the quantity of serialized objects - -
-
Name
-
measurementUnit
-
- - - -
-
Characteristic
-
-
-
-
- Typ urn:bamm:io.openmanufacturing:meta-model:2.0.0#curie - -
-
-
-
-
- -
-
Beispiel
-
litre
-
- -
-
Optional
-
- Nein
-
- -
-
Im Payload
-
- Ja
-
- -
-
Payload Schlüssel
-
measurementUnit
-
- -
-
Referenz
-
-
    -
  • https://openmanufacturingplatform.github.io/sds-bamm-aspect-meta-model/bamm-specification/snapshot/appendix/unitcatalog.html
    • -
-
-
- -
-
-
- -
- Third party licenses - -
- -
- - -
- - - \ No newline at end of file diff --git a/io.catenax.single_level_usage_as_planned/1.0.0/gen/SingleLevelUsageAsPlanned.json b/io.catenax.single_level_usage_as_planned/1.0.0/gen/SingleLevelUsageAsPlanned.json deleted file mode 100644 index 9ba9f956a..000000000 --- a/io.catenax.single_level_usage_as_planned/1.0.0/gen/SingleLevelUsageAsPlanned.json +++ /dev/null @@ -1,12 +0,0 @@ -{ - "parentParts" : [ { - "parentCatenaXId" : "urn:uuid:aA454948-a7C7-68DB-6603-b1AEBF3EbfA7", - "quantity" : { - "quantityNumber" : 2.5, - "measurementUnit" : "litre" - }, - "createdOn" : "2022-02-03T14:48:54.709Z", - "lastModifiedOn" : "2022-02-03T14:48:54.709Z" - } ], - "catenaXId" : "urn:uuid:055c1128-0375-47c8-98de-7cf802c3241d" -} \ No newline at end of file diff --git a/io.catenax.single_level_usage_as_planned/1.0.0/gen/SingleLevelUsageAsPlanned.yml b/io.catenax.single_level_usage_as_planned/1.0.0/gen/SingleLevelUsageAsPlanned.yml deleted file mode 100644 index f4e064903..000000000 --- a/io.catenax.single_level_usage_as_planned/1.0.0/gen/SingleLevelUsageAsPlanned.yml +++ /dev/null @@ -1,208 +0,0 @@ ---- -openapi: 3.0.3 -info: - title: SingleLevelUsageAsPlanned - version: v1 -servers: -- url: catenax.io/api/v1 - variables: - api-version: - default: v1 -paths: - /{tenant-id}/single-level-usage-as-planned: - get: - tags: - - SingleLevelUsageAsPlanned - operationId: getSingleLevelUsageAsPlanned - 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/SingleLevelUsageAsPlanned' - "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/SingleLevelUsageAsPlanned' - totalItems: - type: number - totalPages: - type: number - pageSize: - type: number - currentPage: - type: number - urn_bamm_io.catenax.single_level_usage_as_planned_1.0.0_CatenaXIdTraitCharacteristic: - 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_bamm_io.openmanufacturing_characteristic_2.0.0_Timestamp: - type: string - pattern: "-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T(([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](\\\ - .[0-9]+)?|(24:00:00(\\.0+)?))(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?" - description: Describes a Property which contains the date and time with an optional - timezone. - urn_bamm_io.catenax.single_level_usage_as_planned_1.0.0_NumberOfObjects: - type: number - description: Quantifiable number of objects in reference to the measurementUnit - urn_bamm_io.openmanufacturing_characteristic_2.0.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_bamm_io.catenax.single_level_usage_as_planned_1.0.0_QuantityCharacteristic: - description: Describes the quantity in which the child part is assembled in - the parent object by providing a quantity value and the measurement unit in - which the quantity is measured. - type: object - properties: - quantityNumber: - description: The number of objects related to the measurement unit - $ref: '#/components/schemas/urn_bamm_io.catenax.single_level_usage_as_planned_1.0.0_NumberOfObjects' - measurementUnit: - description: Unit of Measurement for the quantity of serialized objects - $ref: '#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_UnitReference' - required: - - quantityNumber - - measurementUnit - urn_bamm_io.catenax.single_level_usage_as_planned_1.0.0_ParentData: - description: Catena-X ID and meta data of the parent part. - type: object - properties: - createdOn: - description: Timestamp when the relation between the parent part and the - child part was created. - $ref: '#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Timestamp' - quantity: - description: Quantity of which the child part is assembled into the parent - part. - $ref: '#/components/schemas/urn_bamm_io.catenax.single_level_usage_as_planned_1.0.0_QuantityCharacteristic' - lastModifiedOn: - description: Timestamp when the assembly relationship between parent part - and child part was last modified. - $ref: '#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Timestamp' - parentCatenaXId: - description: "The Catena-X ID of the parent object, into which the given\ - \ child object is assembled in." - $ref: '#/components/schemas/urn_bamm_io.catenax.single_level_usage_as_planned_1.0.0_CatenaXIdTraitCharacteristic' - required: - - createdOn - - quantity - - parentCatenaXId - urn_bamm_io.catenax.single_level_usage_as_planned_1.0.0_SetOfParentPartsCharacteristic: - description: Set of parent parts the given child object is assembled in (one - structural level up). - type: array - items: - $ref: '#/components/schemas/urn_bamm_io.catenax.single_level_usage_as_planned_1.0.0_ParentData' - uniqueItems: true - SingleLevelUsageAsPlanned: - description: The aspect provides the information in which parent part(s)/product(s) - the given item is assembled in. Could be a 1:1 relationship in terms of a - e.g. a brake component or 1:n for e.g. coatings. The given item as well as - the parent item must refer to an object from as-planned lifecycle phase. - type: object - properties: - catenaXId: - description: "The Catena-X ID of the given part (e.g. the assembly), valid\ - \ for the Catena-X dataspace." - $ref: '#/components/schemas/urn_bamm_io.catenax.single_level_usage_as_planned_1.0.0_CatenaXIdTraitCharacteristic' - parentParts: - description: "Set of parent parts, in which the given child object is assembled\ - \ in (one structural level up)." - $ref: '#/components/schemas/urn_bamm_io.catenax.single_level_usage_as_planned_1.0.0_SetOfParentPartsCharacteristic' - required: - - catenaXId - - parentParts - 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' - SingleLevelUsageAsPlanned: - content: - application/json: - schema: - $ref: '#/components/schemas/PagingSchema' - description: The request was successful. - requestBodies: - SingleLevelUsageAsPlanned: - content: - application/json: - schema: - $ref: '#/components/schemas/SingleLevelUsageAsPlanned' diff --git a/io.catenax.single_level_usage_as_planned/1.0.0/metadata.json b/io.catenax.single_level_usage_as_planned/1.0.0/metadata.json deleted file mode 100644 index 9e759dfb1..000000000 --- a/io.catenax.single_level_usage_as_planned/1.0.0/metadata.json +++ /dev/null @@ -1 +0,0 @@ -{ "status" : "deprecate"} diff --git a/io.catenax.transmission.transmission_pass/3.0.0/TransmissionPass.ttl b/io.catenax.transmission.transmission_pass/3.0.0/TransmissionPass.ttl new file mode 100644 index 000000000..bdd4af432 --- /dev/null +++ b/io.catenax.transmission.transmission_pass/3.0.0/TransmissionPass.ttl @@ -0,0 +1,399 @@ +####################################################################### +# Copyright (c) 2023-2024 BASF SE +# Copyright (c) 2023-2024 BMW AG +# Copyright (c) 2024 CGI Deutschland B.V. & Co. KG +# Copyright (c) 2023-2024 Henkel AG & Co. KGaA +# Copyright (c) 2023 Robert Bosch GmbH +# Copyright (c) 2023-2024 SAP SE +# Copyright (c) 2023-2024 T-Systems International GmbH +# Copyright (c) 2023-2024 ZF Friedrichshafen AG +# Copyright (c) 2023-2024 Contributors to the Eclipse Foundation +# +# 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-passport: . + +:TransmissionPass a samm:Aspect ; + samm:preferredName "Transmission Pass"@en ; + samm:description "The transmission passport corresponds to the digital product passport information required by the proposed Ecodesign Regulation (ESPR-2022) and describes the data that is collected and available during the lifespan of a transmission."@en ; + samm:properties ( [ samm:property :productSpecificParameters; samm:payloadName "specific" ] [ samm:property :productGenericParameters; samm:payloadName "generic" ] ) ; + samm:operations ( ) ; + samm:events ( ) . + +:productSpecificParameters a samm:Property ; + samm:preferredName "Product Specific Parameters"@en ; + samm:description "Product specific parameters of the transmission."@en ; + samm:characteristic :SpecificCharacteristic . + +:productGenericParameters a samm:Property ; + samm:preferredName "Product Generic Parameters"@en ; + samm:description "The product generic parameters. These are defined by the Digital Product Passport proposal from the ESPR. The main basis is provided by the document \"Proposal for a REGULATION OF THE EUROPEAN PARLIAMENT AND OF THE COUNCIL establishing a framework for setting ecodesign requirements for sustainable products and repealing Directive 2009/125/EC\" from March 30th, 2022. The latest version of the document was the provisional agreement between the EU Council and the Parliament from January 9th, 2024."@en ; + samm:characteristic :GenericCharacteristic . + +:SpecificCharacteristic a samm:Characteristic ; + samm:preferredName "Specific Characteristic"@en ; + samm:description "The Characteristic to describe product specific parameters of the transmission."@en ; + samm:dataType :SpecificEntity . + +:GenericCharacteristic a samm:Characteristic ; + samm:preferredName "Generic Characteristic"@en ; + samm:description "Characteristic for the product generic parameters."@en ; + samm:dataType :GenericEntity . + +:SpecificEntity a samm:Entity ; + samm:preferredName "Specific Entity"@en ; + samm:description "The entity describing various product specific parameters of the transmission."@en ; + samm:properties ( :driveType :torque :power [ samm:property :torqueConverter; samm:optional true ] [ samm:property :speedResistance; samm:optional true ] :standardGearRatio :spreading :oil :electricalPerformance [ samm:property :serviceHistory; samm:optional true ] ) . + +:GenericEntity a samm:Entity ; + samm:preferredName "Generic Entity"@en ; + samm:description "Entity for the product generic parameters."@en ; + samm:properties ( :characteristics ext-passport:metadata ext-passport:identification ext-passport:operation ext-passport:handling ext-passport:commercial ext-passport:materials ext-passport:sustainability ext-passport:sources ) . + +:driveType a samm:Property ; + samm:preferredName "Drive Type"@en ; + samm:description "A list of the type of transmission drive. For example combustion, full hybrid, mild hybrid, plug-in hybrid or purely electric drive (battery or fuelcell)."@en ; + samm:characteristic :DriveTypeTrait ; + samm:exampleValue "full hybrid" . + +:torque a samm:Property ; + samm:preferredName "Torque Performance"@en ; + samm:description "The maximum input torque in newton meters (the operating characteristics of the transmission)."@en ; + samm:characteristic :TorqueNewtonMetre ; + samm:exampleValue "500"^^xsd:nonNegativeInteger . + +:power a samm:Property ; + samm:preferredName "Power"@en ; + samm:description "The maximum power in kilowatt (the operating characteristics of the transmission)."@en ; + samm:characteristic :KilowattMeasurement ; + samm:exampleValue "300"^^xsd:nonNegativeInteger . + +:torqueConverter a samm:Property ; + samm:preferredName "Torque Converter"@en ; + samm:description "A list of the used transmission damper technology (depending on the transmission type). For example NW 200 TTD and NW 200 ZDW"@en ; + samm:characteristic :StringList ; + samm:exampleValue "NW 200 TTD" . + +:speedResistance a samm:Property ; + samm:preferredName "Speed Resistance"@en ; + samm:description "The permissible maximum input speed in the respective gear depending on the transmission type."@en ; + samm:characteristic :SpeedResistanceList . + +:standardGearRatio a samm:Property ; + samm:preferredName "Standard Gear Ratio"@en ; + samm:description "The ratio in the respective gear (ratio between transmission input speed and transmission output speed). For example 1 : 4.1567; 2 : 3.898; 3 : 2.887; 4 : 2.7783; 5 : 1.811; 6 : 1.6545; 7 : 0.4377; 8 : 0.6121; R : -2.2183."@en ; + samm:characteristic :StandardGearRatioSet . + +:spreading a samm:Property ; + samm:preferredName "Spreading"@en ; + samm:description "The transmission spreading coefficient. The ratio between the smallest (shortest gear) and the largest (longest gear) ratio."@en ; + samm:characteristic :Ratio ; + samm:exampleValue "6.79"^^xsd:float . + +:oil a samm:Property ; + samm:preferredName "Oil"@en ; + samm:description "The oil used for the transmission."@en ; + samm:characteristic :OilCharacteristic . + +:electricalPerformance a samm:Property ; + samm:preferredName "Electrical Performance"@en ; + samm:description "Attributes connected to the transmission-integrated electrical machine, if applicable."@en ; + samm:characteristic :PerformanceCharacteristic . + +:serviceHistory a samm:Property ; + samm:preferredName "Service History"@en ; + samm:description "Documentation of the service history of the transmission."@en ; + samm:characteristic ext-passport:DocumentList . + +:characteristics a samm:Property ; + samm:preferredName "Characteristics"@en ; + samm:description "Defines specific characteristics of the transmission."@en ; + samm:characteristic :ProductCharacteristics . + +:DriveTypeTrait a samm-c:Trait ; + samm:preferredName "Drive Type Trait"@en ; + samm:description "Trait of the drive type."@en ; + samm-c:baseCharacteristic :DriveList ; + samm-c:constraint :DriveTypeConstraint . + +:TorqueNewtonMetre a samm-c:Measurement ; + samm:preferredName "Torque Newton Metre"@en ; + samm:description "Characteristic to describe torque in newton meters."@en ; + samm:dataType xsd:nonNegativeInteger ; + samm-c:unit unit:newtonMetre . + +:KilowattMeasurement a samm-c:Measurement ; + samm:preferredName "Kilowatt Measurement"@en ; + samm:description "The performance power in kilowatt as non-negative integer."@en ; + samm:dataType xsd:nonNegativeInteger ; + samm-c:unit unit:kilowatt . + +:StringList a samm-c:List ; + samm:preferredName "String Characteristic"@en ; + samm:description "A list with the data types string."@en ; + samm:dataType xsd:string . + +:SpeedResistanceList a samm-c:List ; + samm:preferredName "Speed Resistance List"@en ; + samm:description "The speed resistance characteristic."@en ; + samm:dataType :SpeedResistanceEntity . + +:StandardGearRatioSet a samm-c:Set ; + samm:preferredName "Standard Gear Ratio Set"@en ; + samm:description "The set of ratio in the respective gear."@en ; + samm:dataType :GearRatioEntity . + +:Ratio a samm-c:Quantifiable ; + samm:preferredName "Ratio Characteristic"@en ; + samm:description "The ratio in the respective gear."@en ; + samm:dataType xsd:float . + +:OilCharacteristic a samm:Characteristic ; + samm:preferredName "Oil Characteristic"@en ; + samm:description "Characteristic for the oil."@en ; + samm:dataType :OilEntity . + +:PerformanceCharacteristic a samm:Characteristic ; + samm:preferredName "Performance Characteristic"@en ; + samm:description "Characteristic for performance related values."@en ; + samm:dataType :PerformanceEntity . + +:ProductCharacteristics a samm:Characteristic ; + samm:preferredName "Product Characteristics"@en ; + samm:description "Defines a set of specific characteristics of the transmission."@en ; + samm:dataType :CharacteristicsEntity . + +:DriveList a samm-c:List ; + samm:preferredName "Drive List"@en ; + samm:description "List of drive types, which is restricted to combustion, full hybrid, mild hybrid, plug-in hybrid, fuel-cell and battery."@en ; + samm:dataType xsd:string . + +:DriveTypeConstraint a samm-c:RegularExpressionConstraint ; + samm:preferredName "Drive Type Constraint"@en ; + samm:description "Constraint to only allow combustion, full hybrid, mild hybrid, plug-in hybrid, fuel-cell or battery.\n"@en ; + samm:value "(combustion|full hybrid|mild hybrid|plug-in hybrid|fuel-cell|battery)" . + +:SpeedResistanceEntity a samm:Entity ; + samm:preferredName "Speed Resistance Entity"@en ; + samm:description "The speed resistance entity. Includes the gear and the speed as separate properties."@en ; + samm:properties ( :gear :ratedSpeed ) . + +:GearRatioEntity a samm:Entity ; + samm:preferredName "Gear Ratio Entity"@en ; + samm:description "Entity for the ratio in the respective gear. Includes the gear and the ratio as separate properties."@en ; + samm:properties ( :gear :gearRatio ) . + +:OilEntity a samm:Entity ; + samm:preferredName "Oil Entity"@en ; + samm:description "Entity for the oil capacity and type."@en ; + samm:properties ( :oilCapacity :oilType ) . + +:PerformanceEntity a samm:Entity ; + samm:preferredName "Performance Entity"@en ; + samm:description "Entity for the performance."@en ; + samm:properties ( :applicable :electricalMachine ) . + +:CharacteristicsEntity a samm:Entity ; + samm:preferredName "Characteristics Entity"@en ; + samm:description "Entity which defines specific characteristics of the transmission such as different life spans and physical dimensions."@en ; + samm:properties ( :warranty :lifeTime ext-passport:physicalDimension ) . + +:gear a samm:Property ; + samm:preferredName "Gear"@en ; + samm:description "Respective gear for the measurement."@en ; + samm:characteristic :GearTrait ; + samm:exampleValue "1" . + +:ratedSpeed a samm:Property ; + samm:preferredName "Rated Speed"@en ; + samm:description "The permissible maximum input speed in the respective gear (depending on the transmission type) in 1/min."@en ; + samm:characteristic :RevolutionsPerMinute ; + samm:exampleValue "7800"^^xsd:nonNegativeInteger . + +:gearRatio a samm:Property ; + samm:preferredName "Gear Ratio"@en ; + samm:description "The ratio in the respective gear (ratio between transmission input speed and transmission output speed)."@en ; + samm:characteristic :Ratio ; + samm:exampleValue "4.1567"^^xsd:float . + +:oilCapacity a samm:Property ; + samm:preferredName "Oil Capacity"@en ; + samm:description "The defined oil volume in the transmission in cubic decimeters."@en ; + samm:characteristic :Capacity ; + samm:exampleValue "8.9"^^xsd:float . + +:oilType a samm:Property ; + samm:preferredName "Oil Type"@en ; + samm:description "The type of the oil for the transmission defined by the manufacturer of the transmission."@en ; + samm:characteristic :StringList ; + samm:exampleValue "Transmission Oil XY" . + +:applicable a samm:Property ; + samm:preferredName "Applicable"@en ; + samm:description "If there is a transmission-integrated electrical machine included, select true and state the values in the connected attributes. If there is none, select false and provide dummy data."@en ; + samm:characteristic samm-c:Boolean ; + samm:exampleValue true . + +:electricalMachine a samm:Property ; + samm:preferredName "Electrical Machine"@en ; + samm:description "Attributes connected to the transmission-integrated electrical machine, if applicable. Otherwise dummy data (0 or null) can be provided."@en ; + samm:characteristic :ElectricalMachineCharacteristic . + +:warranty a samm:Property ; + samm:preferredName "Warranty"@en ; + samm:description "Commercial warranty period of the transmission (coupled to the Vehicle) in months."@en ; + samm:characteristic :MonthCharacteristics ; + samm:exampleValue "60"^^xsd:nonNegativeInteger . + +:lifeTime a samm:Property ; + samm:preferredName "Life Time"@en ; + samm:description "Expected transmission lifespan in kilometres."@en ; + samm:characteristic :KilometreCharacteristic ; + samm:exampleValue "500000"^^xsd:nonNegativeInteger . + +:GearTrait a samm-c:Trait ; + samm:preferredName "Gear Trait"@en ; + samm:description "Constraint to match a gear from 1 to 18 or R (reverse)."@en ; + samm-c:baseCharacteristic samm-c:Text ; + samm-c:constraint :GearConstraint . + +:RevolutionsPerMinute a samm-c:Measurement ; + samm:preferredName "Revolutions "@en ; + samm:description "The permissible maximum input speed in revolutions per minute in the respective gear."@en ; + samm:dataType xsd:nonNegativeInteger ; + samm-c:unit unit:revolutionsPerMinute . + +:Capacity a samm-c:Quantifiable ; + samm:preferredName "Capacity Characteristic"@en ; + samm:description "The oil capacity in dm³."@en ; + samm:dataType xsd:float ; + samm-c:unit unit:cubicDecimetre . + +:ElectricalMachineCharacteristic a samm:Characteristic ; + samm:preferredName "Electrical Machine Characteristic"@en ; + samm:description "Characteristic for the electrical machine."@en ; + samm:dataType :ElectricalMachineEntity . + +:MonthCharacteristics a samm-c:Measurement ; + samm:preferredName "Month Characteristics"@en ; + samm:description "Measurement in months as an integer."@en ; + samm:dataType xsd:nonNegativeInteger ; + samm-c:unit unit:month . + +:KilometreCharacteristic a samm-c:Measurement ; + samm:preferredName "Kilometre Characteristic"@en ; + samm:description "Measurement in kilometre as an integer."@en ; + samm:dataType xsd:nonNegativeInteger ; + samm-c:unit unit:kilometre . + +:GearConstraint a samm-c:RegularExpressionConstraint ; + samm:preferredName "Gear Constraint"@en ; + samm:description "Constraint to match a gear from 1 to 18 or R (reverse)."@en ; + samm:value "^(1[0-8]|[1-9]|R)$" . + +:ElectricalMachineEntity a samm:Entity ; + samm:preferredName "Electrical Machine Entity"@en ; + samm:description "Entity for the electrical machine with power, torque and speed values."@en ; + samm:properties ( [ samm:property :machineTorque; samm:payloadName "torque" ] [ samm:property :machinePower; samm:payloadName "power" ] [ samm:property :machineVoltage; samm:payloadName "voltage" ] [ samm:property :machineSpeed; samm:payloadName "speed" ] ) . + +:machineTorque a samm:Property ; + samm:preferredName "Machine Torque"@en ; + samm:description "The torque of the electrical machine."@en ; + samm:characteristic :MachineTorqueCharacteristic . + +:machinePower a samm:Property ; + samm:preferredName "Machine Power"@en ; + samm:description "The power of the electrical machine."@en ; + samm:characteristic :MachinePowerCharacteristic . + +:machineVoltage a samm:Property ; + samm:preferredName "Machine Voltage"@en ; + samm:description "Nominal voltage of the electric system in volt."@en ; + samm:characteristic :VoltageMeasurement ; + samm:exampleValue "52"^^xsd:decimal . + +:machineSpeed a samm:Property ; + samm:preferredName "Machine Speed"@en ; + samm:description "Maximum allowable speed for the electric motor in revolutions per minute."@en ; + samm:characteristic :RevolutionsPerMinute ; + samm:exampleValue "16700"^^xsd:nonNegativeInteger . + +:MachineTorqueCharacteristic a samm:Characteristic ; + samm:preferredName "Machine Torque Characteristic"@en ; + samm:description "The electrical machine torque."@en ; + samm:dataType :MachineTorqueEntity . + +:MachinePowerCharacteristic a samm:Characteristic ; + samm:preferredName "Machine Power Characteristic"@en ; + samm:description "The electrical machine power."@en ; + samm:dataType :MachinePowerEntity . + +:VoltageMeasurement a samm-c:Measurement ; + samm:preferredName "Voltage Measurement"@en ; + samm:description "Measurement in voltage."@en ; + samm:dataType xsd:decimal ; + samm-c:unit unit:volt . + +:MachineTorqueEntity a samm:Entity ; + samm:preferredName "Machine Torque Entity"@en ; + samm:description "The entity for the electrical machine torque."@en ; + samm:properties ( [ samm:property :maximumTorque; samm:payloadName "max" ] :maximumAvailability [ samm:property :continuousTorque; samm:payloadName "continuous" ] ) . + +:MachinePowerEntity a samm:Entity ; + samm:preferredName "Machine Power Entity"@en ; + samm:description "The entity for the electrical machine power."@en ; + samm:properties ( [ samm:property :maximumPower; samm:payloadName "max" ] [ samm:property :continuousPower; samm:payloadName "continuous" ] :maximumAvailability ) . + +:maximumTorque a samm:Property ; + samm:preferredName "MaximumTorque"@en ; + samm:description "The maximum output torque in newton meters for a specified time period."@en ; + samm:characteristic :TorqueNewtonMetre ; + samm:exampleValue "180"^^xsd:nonNegativeInteger . + +:maximumAvailability a samm:Property ; + samm:preferredName "Maximum Availability"@en ; + samm:description "Specified time period for the peak measurement in seconds."@en ; + samm:characteristic :TimeMeasurement ; + samm:exampleValue "10"^^xsd:nonNegativeInteger . + +:continuousTorque a samm:Property ; + samm:preferredName "Continuous Torque"@en ; + samm:description "The torque that can be delivered without time limit in newton meters."@en ; + samm:characteristic :TorqueNewtonMetre ; + samm:exampleValue "178"^^xsd:nonNegativeInteger . + +:maximumPower a samm:Property ; + samm:preferredName "Maximum Power"@en ; + samm:description "The maximum output power in kilowatts for a specified time period."@en ; + samm:characteristic :KilowattMeasurement ; + samm:exampleValue "22"^^xsd:nonNegativeInteger . + +:continuousPower a samm:Property ; + samm:preferredName "Continuous Power"@en ; + samm:description "The power that can be delivered without time limit."@en ; + samm:characteristic :KilowattMeasurement ; + samm:exampleValue "16"^^xsd:nonNegativeInteger . + +:TimeMeasurement a samm-c:Measurement ; + samm:preferredName "Time Measurement"@en ; + samm:description "Time in seconds."@en ; + samm:dataType xsd:nonNegativeInteger ; + samm-c:unit unit:secondUnitOfTime . + diff --git a/io.catenax.transmission.transmission_pass/3.0.0/gen/TransmissionPass-aas.xml b/io.catenax.transmission.transmission_pass/3.0.0/gen/TransmissionPass-aas.xml new file mode 100644 index 000000000..549edf0a8 --- /dev/null +++ b/io.catenax.transmission.transmission_pass/3.0.0/gen/TransmissionPass-aas.xml @@ -0,0 +1,16164 @@ + + + + + defaultAdminShell + + + en + defaultAdminShell + + + + urn:samm:io.catenax.transmission.transmission_pass:3.0.0#TransmissionPass + + Type + + + + ModelReference + + + Submodel + urn:samm:io.catenax.transmission.transmission_pass:3.0.0#TransmissionPass/submodel + + + + + + + + + TransmissionPass + + + en + The transmission passport corresponds to the digital product passport information required by the proposed Ecodesign Regulation (ESPR-2022) and describes the data that is collected and available during the lifespan of a transmission. + + + + urn:samm:io.catenax.transmission.transmission_pass:3.0.0#TransmissionPass/submodel + Template + + ModelReference + + + ConceptDescription + urn:samm:io.catenax.transmission.transmission_pass:3.0.0#TransmissionPass + + + + + + SpecificEntity + + + en + Specific Entity + + + + + en + The entity describing various product specific parameters of the transmission. + + + + + driveType + + + en + Drive Type + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.transmission.transmission_pass:3.0.0#driveType + + + + xs:string + + + + torque + + + en + Torque Performance + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.transmission.transmission_pass:3.0.0#torque + + + + xs:nonNegativeInteger + + + + power + + + en + Power + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.transmission.transmission_pass:3.0.0#power + + + + xs:nonNegativeInteger + + + + torqueConverter + + + en + Torque Converter + + + + + en + A list of the used transmission damper technology (depending on the transmission type). For example NW 200 TTD and NW 200 ZDW + + + true + DataElement + + + torqueConverter + + + en + Torque Converter + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.transmission.transmission_pass:3.0.0#torqueConverter + + + + xs:string + + + + + + speedResistance + + + en + Speed Resistance + + + + + en + The permissible maximum input speed in the respective gear depending on the transmission type. + + + true + DataElement + + + SpeedResistanceEntity + + + en + Speed Resistance Entity + + + + + en + The speed resistance entity. Includes the gear and the speed as separate properties. + + + + + gear + + + en + Gear + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.transmission.transmission_pass:3.0.0#gear + + + + xs:string + + + + ratedSpeed + + + en + Rated Speed + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.transmission.transmission_pass:3.0.0#ratedSpeed + + + + xs:nonNegativeInteger + + + + + + + + standardGearRatio + + + en + Standard Gear Ratio + + + + + en + The ratio in the respective gear (ratio between transmission input speed and transmission output speed). For example 1 : 4.1567; 2 : 3.898; 3 : 2.887; 4 : 2.7783; 5 : 1.811; 6 : 1.6545; 7 : 0.4377; 8 : 0.6121; R : -2.2183. + + + true + DataElement + + + GearRatioEntity + + + en + Gear Ratio Entity + + + + + en + Entity for the ratio in the respective gear. Includes the gear and the ratio as separate properties. + + + + + gear + + + en + Gear + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.transmission.transmission_pass:3.0.0#gear + + + + xs:string + + + + gearRatio + + + en + Gear Ratio + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.transmission.transmission_pass:3.0.0#gearRatio + + + + xs:float + + + + + + + + spreading + + + en + Spreading + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.transmission.transmission_pass:3.0.0#spreading + + + + xs:float + + + + OilEntity + + + en + Oil Entity + + + + + en + Entity for the oil capacity and type. + + + + + oilCapacity + + + en + Oil Capacity + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.transmission.transmission_pass:3.0.0#oilCapacity + + + + xs:float + + + + oilType + + + en + Oil Type + + + + + en + The type of the oil for the transmission defined by the manufacturer of the transmission. + + + true + DataElement + + + oilType + + + en + Oil Type + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.transmission.transmission_pass:3.0.0#oilType + + + + xs:string + + + + + + + + PerformanceEntity + + + en + Performance Entity + + + + + en + Entity for the performance. + + + + + applicable + + + en + Applicable + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.transmission.transmission_pass:3.0.0#applicable + + + + xs:boolean + + + + ElectricalMachineEntity + + + en + Electrical Machine Entity + + + + + en + Entity for the electrical machine with power, torque and speed values. + + + + + MachineTorqueEntity + + + en + Machine Torque Entity + + + + + en + The entity for the electrical machine torque. + + + + + maximumTorque + + + en + MaximumTorque + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.transmission.transmission_pass:3.0.0#maximumTorque + + + + xs:nonNegativeInteger + + + + maximumAvailability + + + en + Maximum Availability + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.transmission.transmission_pass:3.0.0#maximumAvailability + + + + xs:nonNegativeInteger + + + + continuousTorque + + + en + Continuous Torque + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.transmission.transmission_pass:3.0.0#continuousTorque + + + + xs:nonNegativeInteger + + + + + + MachinePowerEntity + + + en + Machine Power Entity + + + + + en + The entity for the electrical machine power. + + + + + maximumPower + + + en + Maximum Power + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.transmission.transmission_pass:3.0.0#maximumPower + + + + xs:nonNegativeInteger + + + + continuousPower + + + en + Continuous Power + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.transmission.transmission_pass:3.0.0#continuousPower + + + + xs:nonNegativeInteger + + + + maximumAvailability + + + en + Maximum Availability + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.transmission.transmission_pass:3.0.0#maximumAvailability + + + + xs:nonNegativeInteger + + + + + + machineVoltage + + + en + Machine Voltage + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.transmission.transmission_pass:3.0.0#machineVoltage + + + + xs:decimal + + + + machineSpeed + + + en + Machine Speed + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.transmission.transmission_pass:3.0.0#machineSpeed + + + + xs:nonNegativeInteger + + + + + + + + serviceHistory + + + en + Service History + + + + + en + Documentation of the service history of the transmission. + + + true + DataElement + + + DocumentationEntity + + + en + Documentation Entity + + + + + en + Entity for a document with a header, type and content. + + + + + content + + + en + Content + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + xs:string + + + + contentType + + + en + Content Type + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + xs:string + + + + header + + + en + Header + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + xs:string + + + + + + + + + + GenericEntity + + + en + Generic Entity + + + + + en + Entity for the product generic parameters. + + + + + CharacteristicsEntity + + + en + Characteristics Entity + + + + + en + Entity which defines specific characteristics of the transmission such as different life spans and physical dimensions. + + + + + warranty + + + en + Warranty + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.transmission.transmission_pass:3.0.0#warranty + + + + xs:nonNegativeInteger + + + + lifeTime + + + en + Life Time + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.transmission.transmission_pass:3.0.0#lifeTime + + + + xs:nonNegativeInteger + + + + PhysicalDimensionEntity + + + en + Physical Dimension Entity + + + + + en + Entity for physical dimensions with linear, mass and capacity attributes. Either weight or volume is mandatory. + + + + + LinearEntity + + + en + Linear Entity + + + + + en + Entity for linear measurements of an item with an unit and value. + + + + + quantityValue + + + en + Quantity Value + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.shared.quantity:2.0.0#quantityValue + + + + xs:float + + + + linearUnit + + + en + Linear Unit + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.shared.quantity:2.0.0#linearUnit + + + + + + ExternalReference + + + GlobalReference + https://eclipse-esmf.github.io/samm-specification/2.1.0/index.html + + + + + xs:string + + + + + + LinearEntity + + + en + Linear Entity + + + + + en + Entity for linear measurements of an item with an unit and value. + + + + + quantityValue + + + en + Quantity Value + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.shared.quantity:2.0.0#quantityValue + + + + xs:float + + + + linearUnit + + + en + Linear Unit + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.shared.quantity:2.0.0#linearUnit + + + + + + ExternalReference + + + GlobalReference + https://eclipse-esmf.github.io/samm-specification/2.1.0/index.html + + + + + xs:string + + + + + + LinearEntity + + + en + Linear Entity + + + + + en + Entity for linear measurements of an item with an unit and value. + + + + + quantityValue + + + en + Quantity Value + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.shared.quantity:2.0.0#quantityValue + + + + xs:float + + + + linearUnit + + + en + Linear Unit + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.shared.quantity:2.0.0#linearUnit + + + + + + ExternalReference + + + GlobalReference + https://eclipse-esmf.github.io/samm-specification/2.1.0/index.html + + + + + xs:string + + + + + + LinearEntity + + + en + Linear Entity + + + + + en + Entity for linear measurements of an item with an unit and value. + + + + + quantityValue + + + en + Quantity Value + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.shared.quantity:2.0.0#quantityValue + + + + xs:float + + + + linearUnit + + + en + Linear Unit + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.shared.quantity:2.0.0#linearUnit + + + + + + ExternalReference + + + GlobalReference + https://eclipse-esmf.github.io/samm-specification/2.1.0/index.html + + + + + xs:string + + + + + + MassEntity + + + en + Mass Entity + + + + + en + Entity for mass measurements of an item with an unit and value. + + + + + quantityValue + + + en + Quantity Value + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.shared.quantity:2.0.0#quantityValue + + + + xs:float + + + + massUnit + + + en + Mass Unit + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.shared.quantity:2.0.0#massUnit + + + + + + ExternalReference + + + GlobalReference + https://eclipse-esmf.github.io/samm-specification/2.1.0/index.html + + + + + xs:string + + + + + + VolumeEntity + + + en + Volume Entity + + + + + en + Entity for volume measurements of an item with an unit and value. + + + + + quantityValue + + + en + Quantity Value + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.shared.quantity:2.0.0#quantityValue + + + + xs:float + + + + volumeUnit + + + en + Volume Unit + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.shared.quantity:2.0.0#volumeUnit + + + + + + ExternalReference + + + GlobalReference + https://eclipse-esmf.github.io/samm-specification/2.1.0/index.html + + + + + xs:string + + + + + + MassEntity + + + en + Mass Entity + + + + + en + Entity for mass measurements of an item with an unit and value. + + + + + quantityValue + + + en + Quantity Value + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.shared.quantity:2.0.0#quantityValue + + + + xs:float + + + + massUnit + + + en + Mass Unit + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.shared.quantity:2.0.0#massUnit + + + + + + ExternalReference + + + GlobalReference + https://eclipse-esmf.github.io/samm-specification/2.1.0/index.html + + + + + xs:string + + + + + + VolumeEntity + + + en + Volume Entity + + + + + en + Entity for volume measurements of an item with an unit and value. + + + + + quantityValue + + + en + Quantity Value + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.shared.quantity:2.0.0#quantityValue + + + + xs:float + + + + volumeUnit + + + en + Volume Unit + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.shared.quantity:2.0.0#volumeUnit + + + + + + ExternalReference + + + GlobalReference + https://eclipse-esmf.github.io/samm-specification/2.1.0/index.html + + + + + xs:string + + + + + + + + + + MetadataEntity + + + en + Metadata Entity + + + + + en + Passport Entity to describe version, status, end and issue date. + + + + + version + + + en + Version + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#version + + + + xs:string + + + + status + + + en + Status + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#status + + + + xs:string + + + + expirationDate + + + en + Expiration Date + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#expirationDate + + + + xs:string + + + + issueDate + + + en + Issue Date + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#issueDate + + + + xs:string + + + + economicOperatorId + + + en + Economic Operator Id + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#economicOperatorId + + + + xs:string + + + + passportIdentifier + + + en + Passport Identifier + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#passportIdentifier + + + + xs:string + + + + predecessor + + + en + Predecessor + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#predecessor + + + + xs:string + + + + backupReference + + + en + Backup Reference + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#backupReference + + + + xs:string + + + + registrationIdentifier + + + en + Registration Identifier + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#registrationIdentifier + + + + xs:string + + + + lastModification + + + en + Last Modification + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#lastModification + + + + xs:string + + + + + + IdentificationEntity + + + en + Identification Entity + + + + + en + Entity with identification information of the product with part type information, local identifiers, other codes and the data carrier. + + + + + serialInformation + + + en + Serial Information + + + + + en + Identifier for a serial part if available. This is mentioned in the ESPR provisional agreement from January 9th, 2024 Recital (27): +[...] an 'item' usually means a single unit of a model. + + + true + DataElement + + + KeyValueList + + + en + Key Value List + + + + + en + A list of key value pairs for local identifiers, which are composed of a key and a corresponding value. + + + + + key + + + en + Identifier Key + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.serial_part:3.0.0#key + + + + xs:string + + + + value + + + en + Identifier Value + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.serial_part:3.0.0#value + + + + xs:string + + + + + + + + batchInformation + + + en + Batch Information + + + + + en + Identifier for a batch part if available. Identifier for a serial part if available. This is mentioned in the ESPR provisional agreement from January 9th, 2024 Recital (27): +[...] a 'batch' usually means a subset of a specific model composed of all products produced in a specific manufacturing plant at a specific moment in time [...]. + + + true + DataElement + + + KeyValueList + + + en + Key Value List + + + + + en + A list of key value pairs for local identifiers, which are composed of a key and a corresponding value. + + + + + key + + + en + Identifier Key + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.batch:3.0.0#key + + + + xs:string + + + + value + + + en + Identifier Value + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.batch:3.0.0#value + + + + xs:string + + + + + + + + PartTypeEntity + + + en + Part Type Entity + + + + + en + Entity for the part type with manufacturer id and name. + + + + + manufacturerPartId + + + en + Manufacturer Part ID + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.part_type_information:1.0.0#manufacturerPartId + + + + xs:string + + + + nameAtManufacturer + + + en + Name at manufacturer + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.part_type_information:1.0.0#nameAtManufacturer + + + + xs:string + + + + + + codes + + + en + Codes + + + + + en + Codes for identification. + + + true + DataElement + + + CodeEntity + + + en + Code Entity + + + + + en + Code entity with code key and value. + + + + + codeKey + + + en + Code Key + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#codeKey + + + + xs:string + + + + codeValue + + + en + Code Value + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#codeValue + + + + xs:string + + + + + + + + DataCarrierEntity + + + en + Data Carrier Entity + + + + + en + Data Carrier Entity with type and layout of the data carrier. + + + + + carrierType + + + en + Carrier Type + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#carrierType + + + + xs:string + + + + carrierLayout + + + en + Carrier Layout + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#carrierLayout + + + + xs:string + + + + + + partClassification + + + en + Part Classification + + + + + en + Property describing the classification of a part. + + + true + DataElement + + + ClassificationEntity + + + en + ClassificationEntity + + + + + en + Encapsulates data related to the classification of the part. + + + + + classificationStandard + + + en + Classification Standard + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.shared.part_classification:1.0.0#classificationStandard + + + + xs:string + + + + classificationID + + + en + Classification ID + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.shared.part_classification:1.0.0#classificationID + + + + xs:string + + + + classificationDescription + + + en + Classification Description + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.shared.part_classification:1.0.0#classificationDescription + + + + xs:string + + + + + + + + + + OperationEntity + + + en + Operation Entity + + + + + en + Operational information of the product such as the owner, manufacturer and importer. + + + + + ManufacturerEntity + + + en + Manufacturer Entity + + + + + en + Manufacturing Entity with the identification of the main manufacturer and the facility location as well as the manufacturing date. + + + + + facilityIdentification + + + en + Facility Identification + + + + + en + The identifier used for a location. In the CATENA-X use case, the BPNA can be stated. This attribute is mentioned in the ESPR provisional agreement from January 9th 2024 Annex III: +(i) unique facility identifiers; +Article 2 Definitions: (33) 'unique facility identifier' means a unique string of characters for the identification of locations or buildings involved in the value chain of a product or used by actors involved in the value chain of a product. + + + true + DataElement + + + FacilityEntity + + + en + Facility Entity + + + + + en + The entity for a facility with the BPNA identifier. + + + + + facility + + + en + Facility + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#facility + + + + xs:string + + + + + + + + manufacturerIdentification + + + en + Manufacturer Identification + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#manufacturerIdentification + + + + xs:string + + + + manufacturingDate + + + en + Manufacturing Date + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#manufacturingDate + + + + xs:string + + + + + + ImportEntity + + + en + Import Entity + + + + + en + Import entity with attributes if applicable to the product. + + + + + ImporterEntity + + + en + Importer Entity + + + + + en + Entity with information regarding the importer such as the identification and the EORI. + + + + + eori + + + en + EORI + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#eori + + + + + + ExternalReference + + + GlobalReference + https://taxation-customs.ec.europa.eu/customs-4/customs-procedures-import-and-export-0/customs-procedures/economic-operators-registration-and-identification-number-eori_en + + + + + xs:string + + + + importerIdentification + + + en + Importer Identification + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#importerIdentification + + + + xs:string + + + + + + applicable + + + en + Applicable + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#applicable + + + + xs:boolean + + + + + + OperatorEntity + + + en + Operator Entity + + + + + en + Operator with role and identification. + + + + + otherOperatorId + + + en + Other Operator Id + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#otherOperatorId + + + + xs:string + + + + otherOperatorRole + + + en + Other Operator Role + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#otherOperatorRole + + + + xs:string + + + + + + + + HandlingEntity + + + en + Handling Entity + + + + + en + Entity to describe different aspects in relation with the handling of the product with attributes if applicable to the product. + + + + + SparePartEntity + + + en + Spare Part Entity + + + + + en + Information regarding possible spare parts. This is mentioned in the ESPR proposal from March 30th, 2022 Annex I: +(b) ease of repair and maintenance as expressed through: characteristics, availability and delivery time of spare parts, modularity, compatibility with commonly available spare parts, availability of repair and maintenance instructions, number of materials and components used, use of standard components, use of component and material coding standards for the identification of components and materials, number and complexity of processes and tools needed, ease of non-destructive disassembly and re-assembly, conditions for access to product data, conditions for access to or use of hardware and software needed; +(c) the Global Trade Identification Number as provided for in standard ISO/IEC 15459-6 or equivalent of products or their parts. + + + + + sparePartSources + + + en + Spare Part Sources + + + + + en + Sources of possible spare parts. + + + true + DataElement + + + SourcesEntity + + + en + Sources Entity + + + + + en + Entity for a possible spare part sources. + + + + + sourcesIdentification + + + en + Sources Identification + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#sourcesIdentification + + + + xs:string + + + + + + + + sparePart + + + en + Spare Part + + + + + en + Possible spare parts of the product. + + + true + DataElement + + + PartsEntity + + + en + Parts Entity + + + + + en + Possible spare parts of the product with identifiers and names. + + + + + manufacturerPartId + + + en + Manufacturer Part ID + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.part_type_information:1.0.0#manufacturerPartId + + + + xs:string + + + + nameAtManufacturer + + + en + Name at manufacturer + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.part_type_information:1.0.0#nameAtManufacturer + + + + xs:string + + + + + + + + + + applicable + + + en + Applicable + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#applicable + + + + xs:boolean + + + + + + CommercialEntity + + + en + Commercial Entity + + + + + en + Commercial information. + + + + + placedOnMarket + + + en + Placed on Market + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#placedOnMarket + + + + xs:string + + + + purpose + + + en + Purpose + + + + + en + One or more intended industry/industries of the product described by the digital product passport. If exchanged via Catena-X, 'automotive ' is a must choice included in the list. + + + true + DataElement + + + purpose + + + en + Purpose + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#purpose + + + + xs:string + + + + + + + + MaterialsEntity + + + en + Materials Entity + + + + + en + Entity with materials on the level of the product. + + + + + SubstanceOfConcernEntity + + + en + Substance Of Concern Entity + + + + + en + Substance of Concern entity with attributes if applicable to the product. + + + + + applicable + + + en + Applicable + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#applicable + + + + xs:boolean + + + + substanceOfConcern + + + en + Substance of Concern + + + + + en + Information regarding substances of concern in the product. Attributes are among others substance names, ids, concentration, location and hazard class. This is mentioned in the ESPR provisional agreement from January 9th, 2024 Article 7: +(5) (a) the name of the substances of concern present in the product, as follows: +- name(s) in the International Union of Pure and Applied Chemistry (IUPAC) nomenclature, or another international name when IUPAC name is not available; +- other names (usual name, trade name, abbreviation); +- European Community (EC) number, as indicated in the European Inventory of Existing Commercial Chemical Substances (EINECS), the European List of Notified Chemical Substances (ELINCS) or the No Longer Polymer (NLP) list or assigned by the European Chemicals Agency (ECHA), if available; +- the Chemical Abstract Service (CAS) name(s) and number(s), if available; +(5) (b) the location of the substances of concern within the product. +(5) (c) the concentration, maximum concentration or concentration range of the substances of concern, at the level of the product its relevant components, or spare parts; +(d) relevant instructions for the safe use of the product; +(e) information relevant for disassembly, preparation for reuse, reuse, recycling and the environmentally sound management of the product at the end of its life. +And in the next paragraph: +(c) provide duly justified exemptions for substances of concern or information elements from the information requirements referred to in the first subparagraph. + + + true + DataElement + + + SubstanceEntity + + + en + Substance Entity + + + + + en + Information regarding substances of concern in the product. + + + + + location + + + en + Location + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#location + + + + xs:string + + + + materialUnit + + + en + Material Unit + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#materialUnit + + + + + + ExternalReference + + + GlobalReference + https://eclipse-esmf.github.io/samm-specification/2.1.0/index.html + + + + + xs:string + + + + concentration + + + en + Concentration + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#concentration + + + + xs:float + + + + exemption + + + en + Exemption + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#exemption + + + + xs:string + + + + HazardEntity + + + en + Hazard Entity + + + + + en + Entity for the hazardous classification. + + + + + ExternalReference + + + GlobalReference + https://eur-lex.europa.eu/legal-content/EN/TXT/?uri=CELEX:02008R1272-20231201 + + + + + + + hazardCategory + + + en + Hazard Category + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#hazardCategory + + + + + + ExternalReference + + + GlobalReference + https://eur-lex.europa.eu/legal-content/EN/TXT/?uri=CELEX:02008R1272-20231201 + + + + + xs:string + + + + hazardClass + + + en + Hazard Class + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#hazardClass + + + + + + ExternalReference + + + GlobalReference + https://eur-lex.europa.eu/legal-content/EN/TXT/?uri=CELEX:02008R1272-20231201 + + + + + xs:string + + + + hazardStatement + + + en + Hazard Statement + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#hazardStatement + + + + + + ExternalReference + + + GlobalReference + https://eur-lex.europa.eu/legal-content/EN/TXT/?uri=CELEX:02008R1272-20231201 + + + + + xs:string + + + + + + concentrationRange + + + en + Concentration Range + + + + + en + The concentration range for the substance of concern. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7: +(5) (c) [...] concentration range of the substances of concern, at the level of the product [...]. + + + true + DataElement + + + RangeEntity + + + en + Range Entity + + + + + en + Entity for the concentration range with two values, the highest and the lowest of the concentration range. + + + + + minConcentration + + + en + Minimum Concentration + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#minConcentration + + + + xs:float + + + + maxConcentration + + + en + Maximum Concentration + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#maxConcentration + + + + xs:float + + + + + + + + materialIdentification + + + en + Material Identification + + + + + en + The chemical material name and identification, in accordance with the specification in the attribute for the list type. Preference is given to the IUPAC name. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Article 7: +(5) (a) the name of the substances of concern present in the product, as follows: + - name(s) in the International Union of Pure and Applied Chemistry (IUPAC) nomenclature, or another international name when IUPAC name is not available; +- other names (usual name, trade name, abbreviation); +- European Community (EC) number, as indicated in the European Inventory of Existing Commercial Chemical Substances (EINECS), the European List of Notified Chemical Substances (ELINCS) or the No Longer Polymer (NLP) list or assigned by the European Chemicals Agency (ECHA), if available; +- the Chemical Abstract Service (CAS) name(s) and number(s), if available; . + + + true + DataElement + + + MaterialIdEntity + + + en + Material Id Entity + + + + + en + Id Entity with identifier, name and list type. + + + + + chemicalId + + + en + Chemical Id + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#chemicalId + + + + xs:string + + + + listTypeId + + + en + List Type Id + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#listTypeId + + + + xs:string + + + + chemicalName + + + en + Chemical Name + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#chemicalName + + + + xs:string + + + + + + + + documentation + + + en + Documentation + + + + + en + Documentation accompanying the material. + + + true + DataElement + + + DocumentationEntity + + + en + Documentation Entity + + + + + en + Entity for a document with a header, type and content. + + + + + content + + + en + Content + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + xs:string + + + + contentType + + + en + Content Type + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + xs:string + + + + header + + + en + Header + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + xs:string + + + + + + + + + + + + + + ChemicalMaterialEntity + + + en + Chemical Material Entity + + + + + en + Material entity with attributes if applicable to the product. + + + + + applicable + + + en + Applicable + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#applicable + + + + xs:boolean + + + + chemicalMaterial + + + en + Material + + + + + en + Information on different materials in the product. + + + true + DataElement + + + MaterialEntity + + + en + Material Entity + + + + + en + Information regarding recycled and/or renewable materials in the product. + + + + + recycled + + + en + Recycled + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#recycled + + + + xs:float + + + + renewable + + + en + Renewable + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#renewable + + + + xs:float + + + + materialUnit + + + en + Material Unit + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#materialUnit + + + + + + ExternalReference + + + GlobalReference + https://eclipse-esmf.github.io/samm-specification/2.1.0/index.html + + + + + xs:string + + + + materialIdentification + + + en + Material Identification + + + + + en + The chemical material name and identification, in accordance with the specification in the attribute for the list type. Preference is given to the IUPAC name. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Article 7: +(5) (a) the name of the substances of concern present in the product, as follows: + - name(s) in the International Union of Pure and Applied Chemistry (IUPAC) nomenclature, or another international name when IUPAC name is not available; +- other names (usual name, trade name, abbreviation); +- European Community (EC) number, as indicated in the European Inventory of Existing Commercial Chemical Substances (EINECS), the European List of Notified Chemical Substances (ELINCS) or the No Longer Polymer (NLP) list or assigned by the European Chemicals Agency (ECHA), if available; +- the Chemical Abstract Service (CAS) name(s) and number(s), if available; . + + + true + DataElement + + + MaterialIdEntity + + + en + Material Id Entity + + + + + en + Id Entity with identifier, name and list type. + + + + + chemicalId + + + en + Chemical Id + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#chemicalId + + + + xs:string + + + + listTypeId + + + en + List Type Id + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#listTypeId + + + + xs:string + + + + chemicalName + + + en + Chemical Name + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#chemicalName + + + + xs:string + + + + + + + + critical + + + en + Critical + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#critical + + + + + + ExternalReference + + + GlobalReference + https://eur-lex.europa.eu/legal-content/EN/TXT/?uri=COM:2023:0160:FIN + + + + + xs:boolean + + + + concentration + + + en + Concentration + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#concentration + + + + xs:float + + + + documentation + + + en + Documentation + + + + + en + Documentation accompanying the material. + + + true + DataElement + + + DocumentationEntity + + + en + Documentation Entity + + + + + en + Entity for a document with a header, type and content. + + + + + content + + + en + Content + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + xs:string + + + + contentType + + + en + Content Type + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + xs:string + + + + header + + + en + Header + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + xs:string + + + + + + + + + + + + + + + + SustainabilityEntity + + + en + Sustainability Entity + + + + + en + Entity with the properties regarding the sustainability of the product. + + + + + state + + + en + State + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#state + + + + xs:string + + + + ProductFootprintEntity + + + en + Product Footprint Entity + + + + + en + The Product Footprint Entity with sustainability information such as the different environmental footprint types, the carbon and material footprint explicitly, applicable rules and lifecycle stages. + + + + + environmentalFootprint + + + en + Environmental Footprint + + + + + en + The environmental footprint of the product. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I: +The following parameters shall, as appropriate, and where necessary supplemented by others, be used, individually or combined, as a basis for improving the product aspects referred to in Article 5(1): +(l) the environmental footprint of the product, expressed as a quantification, in accordance with the applicable delegated act, of a product's life cycle environmental impacts, whether in relation to one or more environmental impact categories or an aggregated set of impact categories. +and Article 7: +(2)(b)(i) information on the performance of the product in relation to one or more of the product parameters referred to in Annex I, including a scoring of reparability or durability, carbon footprint or environmental footprint; +and defined by Article 2: +(23) 'environmental footprint' means a quantification of product environmental impacts throughout its life cycle, whether in relation to a single environmental impact category or an aggregated set of impact categories based on the Product Environmental Footprint method or other scientific methods developed by international organisations and widely tested in collaboration with different industry sectors and adopted or implemented by the Commission in other Union legislation; +(24) 'Product Environmental Footprint method' means the life cycle assessment method to quantify the environmental impacts of products established by Recommendation (EU) 2021/2279. + + + true + DataElement + + + FootprintEntity + + + en + Footprint Entity + + + + + en + Footprint Entity for the carbon and environmental footprint with the total value, unit, impact category type, lifecycle, rulebook, declaration, performance class and the facility. + + + + + footprintValue + + + en + Footprint Value + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#footprintValue + + + + xs:float + + + + footprintRulebook + + + en + Footprint Rulebook + + + + + en + The applied rulebook for the environmental footprint of the product. + + + true + DataElement + + + DocumentationEntity + + + en + Documentation Entity + + + + + en + Entity for a document with a header, type and content. + + + + + content + + + en + Content + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + xs:string + + + + contentType + + + en + Content Type + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + xs:string + + + + header + + + en + Header + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + xs:string + + + + + + + + footprintLifecycle + + + en + Footprint Lifecycle + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#footprintLifecycle + + + + xs:string + + + + footprintUnit + + + en + Footprint Unit + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#footprintUnit + + + + xs:string + + + + footprintType + + + en + Footprint Type + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#footprintType + + + + xs:string + + + + performanceClass + + + en + Performance Class + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#performanceClass + + + + xs:string + + + + manufacturingPlant + + + en + Manufacturing Plant + + + + + en + The manufacturing plant of the footprint in the specific lifecycle phase. + + + true + DataElement + + + FacilityEntity + + + en + Facility Entity + + + + + en + The entity for a facility with the BPNA identifier. + + + + + facility + + + en + Facility + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#facility + + + + xs:string + + + + + + + + declaration + + + en + Declaration + + + + + en + The footprint declaration in the format of a link + + + true + DataElement + + + DocumentationEntity + + + en + Documentation Entity + + + + + en + Entity for a document with a header, type and content. + + + + + content + + + en + Content + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + xs:string + + + + contentType + + + en + Content Type + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + xs:string + + + + header + + + en + Header + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + xs:string + + + + + + + + + + + + carbonFootprint + + + en + Carbon Footprint + + + + + en + The carbon footprint of the product. This is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I: +The following parameters shall, as appropriate, and where necessary supplemented by others, be used, individually or combined, as a basis for improving the product aspects referred to in Article 5(1): +(m) the carbon footprint of the product; +and Article 7: +(2)(b)(i) information on the performance of the product in relation to one or more of the product parameters referred to in Annex I, including a scoring of reparability or durability, carbon footprint or environmental footprint; +and defined by Article 2: +(25) 'carbon footprint' means the sum of greenhouse gas (GHG) emissions and GHG removals in a product system, expressed as CO2 equivalents and based on a life cycle assessment using the single impact category of climate change. + + + true + DataElement + + + FootprintEntity + + + en + Footprint Entity + + + + + en + Footprint Entity for the carbon and environmental footprint with the total value, unit, impact category type, lifecycle, rulebook, declaration, performance class and the facility. + + + + + footprintValue + + + en + Footprint Value + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#footprintValue + + + + xs:float + + + + footprintRulebook + + + en + Footprint Rulebook + + + + + en + The applied rulebook for the environmental footprint of the product. + + + true + DataElement + + + DocumentationEntity + + + en + Documentation Entity + + + + + en + Entity for a document with a header, type and content. + + + + + content + + + en + Content + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + xs:string + + + + contentType + + + en + Content Type + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + xs:string + + + + header + + + en + Header + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + xs:string + + + + + + + + footprintLifecycle + + + en + Footprint Lifecycle + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#footprintLifecycle + + + + xs:string + + + + footprintUnit + + + en + Footprint Unit + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#footprintUnit + + + + xs:string + + + + footprintType + + + en + Footprint Type + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#footprintType + + + + xs:string + + + + performanceClass + + + en + Performance Class + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#performanceClass + + + + xs:string + + + + manufacturingPlant + + + en + Manufacturing Plant + + + + + en + The manufacturing plant of the footprint in the specific lifecycle phase. + + + true + DataElement + + + FacilityEntity + + + en + Facility Entity + + + + + en + The entity for a facility with the BPNA identifier. + + + + + facility + + + en + Facility + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#facility + + + + xs:string + + + + + + + + declaration + + + en + Declaration + + + + + en + The footprint declaration in the format of a link + + + true + DataElement + + + DocumentationEntity + + + en + Documentation Entity + + + + + en + Entity for a document with a header, type and content. + + + + + content + + + en + Content + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + xs:string + + + + contentType + + + en + Content Type + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + xs:string + + + + header + + + en + Header + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + xs:string + + + + + + + + + + + + materialFootprint + + + en + Material Footprint + + + + + en + The material footprint of the product. This is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I: +(ma) the material footprint of the product; +and defined by Article 2: +(25a) 'material footprint' refers to the total amount of raw materials extracted to meet final consumption demands. + + + true + DataElement + + + FootprintEntity + + + en + Footprint Entity + + + + + en + Footprint Entity for the carbon and environmental footprint with the total value, unit, impact category type, lifecycle, rulebook, declaration, performance class and the facility. + + + + + footprintValue + + + en + Footprint Value + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#footprintValue + + + + xs:float + + + + footprintRulebook + + + en + Footprint Rulebook + + + + + en + The applied rulebook for the environmental footprint of the product. + + + true + DataElement + + + DocumentationEntity + + + en + Documentation Entity + + + + + en + Entity for a document with a header, type and content. + + + + + content + + + en + Content + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + xs:string + + + + contentType + + + en + Content Type + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + xs:string + + + + header + + + en + Header + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + xs:string + + + + + + + + footprintLifecycle + + + en + Footprint Lifecycle + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#footprintLifecycle + + + + xs:string + + + + footprintUnit + + + en + Footprint Unit + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#footprintUnit + + + + xs:string + + + + footprintType + + + en + Footprint Type + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#footprintType + + + + xs:string + + + + performanceClass + + + en + Performance Class + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#performanceClass + + + + xs:string + + + + manufacturingPlant + + + en + Manufacturing Plant + + + + + en + The manufacturing plant of the footprint in the specific lifecycle phase. + + + true + DataElement + + + FacilityEntity + + + en + Facility Entity + + + + + en + The entity for a facility with the BPNA identifier. + + + + + facility + + + en + Facility + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#facility + + + + xs:string + + + + + + + + declaration + + + en + Declaration + + + + + en + The footprint declaration in the format of a link + + + true + DataElement + + + DocumentationEntity + + + en + Documentation Entity + + + + + en + Entity for a document with a header, type and content. + + + + + content + + + en + Content + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + xs:string + + + + contentType + + + en + Content Type + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + xs:string + + + + header + + + en + Header + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + xs:string + + + + + + + + + + + + + + reparabilityScore + + + en + Reparability Score + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#reparabilityScore + + + + xs:string + + + + durabilityScore + + + en + Durability Score + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#durabilityScore + + + + xs:string + + + + + + sources + + + en + Sources + + + + + en + Documents that are mandatory if applicable for the product. These are mentioned in the ESPR provisional agreement from January 9th, 2024 ANNEX III: +(e) compliance documentation and information required under this Regulation or other Union law applicable to the product, such as the declaration of conformity, technical documentation or conformity certificates; +(f) user manuals, instructions, warnings or safety information, as required by other Union legislation applicable to the product. +Additionally requirements are mentioned in Article 21: +7. Manufacturers shall ensure that a product covered by a delegated act adopted pursuant to Article 4 is accompanied by instructions in digital format that enable customers and other relevant actors to assemble, install, operate, store, maintain, repair and dispose of the product in a language that can be easily understood, as determined by the Member State concerned. Such instructions shall be clear, understandable and legible and include at least the information set out in Article 7(2), point (b), point (ii) specified in the delegated acts adopted pursuant to Article 4. +Article 7 states additionally: +(ii) information for customers and other actors on how to install, use, maintain and repair the product, in order to minimise its impact on the environment and to ensure optimum durability, on how to install third-party operating systems where relevant, as well as on collection for refurbishment or remanufacture, and on how to return or handle the product at the end of its life; +(2) (b) (iii) information for treatment facilities on disassembly, reuse, refurbishment, recycling, or disposal at end-of-life; +(2) (b) (iv) other information that may influence sustainable product choices for customers and the way the product is handled by parties other than the manufacturer in order to facilitate appropriate use, value retaining operations and correct treatment at end-of-life. +(5) (d) relevant instructions for the safe use of the product. +(5) (e) information relevant for disassembly, preparation for reuse, reuse, recycling and the environmentally sound management of the product at the end of its life. +Annex I: +(b) [...] availability of repair and maintenance instructions, number of materials and components used, use of standard components,[...] number and complexity of processes and whether specialised toolsare needed, ease of non-destructive disassembly and re-assembly, conditions for access to product data, conditions for access to or use of hardware and software needed; +(c) ease of upgrading, re-use, remanufacturing and refurbishment as expressed through: [...] number and complexity of processes and tools needed, ease of non-destructive disassembly and re-assembly, conditions for access to product data, conditions for access to or use of hardware and software needed, conditions of access to test protocols or not commonly available testing equipment, availability of guarantees specific to remanufactured or refurbished products, conditions for access to or use of technologies protected by intellectual property rights, modularity; +(d) design for recycling, ease and quality of recycling as expressed through: use of easily recyclable materials, safe, easy and non-destructive access to recyclable components and materials or components and materials containing hazardous substances and material composition and homogeneity, possibility for high-purity sorting, [...] number and complexity of processes and tools needed, ease of nondestructive disassembly and re-assembly, conditions for access to product data, conditions for access to or use of hardware and software needed; +(q) functional performance and conditions for use including as expressed through ability in performing its intended use, precautions of use, skills required, compatibility with other products or systems. +Additionally to consider are guidelines and instructions regarding the proper management and disposal of packaging materials after use. This can include instructions for separation, reuse, and recycling. + + + true + DataElement + + + DocumentEntity + + + en + Document Entity + + + + + en + Document entity with header, content, category and type. + + + + + content + + + en + Content + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + xs:string + + + + category + + + en + Category + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#category + + + + xs:string + + + + contentType + + + en + Content Type + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + xs:string + + + + header + + + en + Header + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + xs:string + + + + + + + + + + + + + + APPLICATION_CLASS + TransmissionPass + + + en + Transmission Pass + + + + + en + The transmission passport corresponds to the digital product passport information required by the proposed Ecodesign Regulation (ESPR-2022) and describes the data that is collected and available during the lifespan of a transmission. + + + urn:samm:io.catenax.transmission.transmission_pass:3.0.0#TransmissionPass + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Transmission Pass + + + + + en + TransmissionPass + + + + + en + The transmission passport corresponds to the digital product passport information required by the proposed Ecodesign Regulation (ESPR-2022) and describes the data that is collected and available during the lifespan of a transmission. + + + + + + + + + driveType + + + en + Drive Type + + + urn:samm:io.catenax.transmission.transmission_pass:3.0.0#driveType + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Drive Type + + + + + en + driveType + + + STRING + + + en + A list of the type of transmission drive. For example combustion, full hybrid, mild hybrid, plug-in hybrid or purely electric drive (battery or fuelcell). + + + + + + + + + torque + + + en + Torque Performance + + + urn:samm:io.catenax.transmission.transmission_pass:3.0.0#torque + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Torque Performance + + + + + en + torque + + + newtonMetre + INTEGER_COUNT + + + en + The maximum input torque in newton meters (the operating characteristics of the transmission). + + + + + + + + + power + + + en + Power + + + urn:samm:io.catenax.transmission.transmission_pass:3.0.0#power + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Power + + + + + en + power + + + kilowatt + INTEGER_COUNT + + + en + The maximum power in kilowatt (the operating characteristics of the transmission). + + + + + + + + + torqueConverter + + + en + Torque Converter + + + urn:samm:io.catenax.transmission.transmission_pass:3.0.0#torqueConverter + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Torque Converter + + + + + en + torqueConverter + + + STRING + + + en + A list of the used transmission damper technology (depending on the transmission type). For example NW 200 TTD and NW 200 ZDW + + + + + + + + + gear + + + en + Gear + + + urn:samm:io.catenax.transmission.transmission_pass:3.0.0#gear + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Gear + + + + + en + gear + + + STRING + + + en + Respective gear for the measurement. + + + + + + + + + ratedSpeed + + + en + Rated Speed + + + urn:samm:io.catenax.transmission.transmission_pass:3.0.0#ratedSpeed + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Rated Speed + + + + + en + ratedSpeed + + + revolutionsPerMinute + INTEGER_COUNT + + + en + The permissible maximum input speed in the respective gear (depending on the transmission type) in 1/min. + + + + + + + + + speedResistance + + + en + Speed Resistance + + + urn:samm:io.catenax.transmission.transmission_pass:3.0.0#speedResistance + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Speed Resistance + + + + + en + speedResistance + + + STRING + + + en + The permissible maximum input speed in the respective gear depending on the transmission type. + + + + + + + + + gear + + + en + Gear + + + urn:samm:io.catenax.transmission.transmission_pass:3.0.0#gear + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Gear + + + + + en + gear + + + STRING + + + en + Respective gear for the measurement. + + + + + + + + + gearRatio + + + en + Gear Ratio + + + urn:samm:io.catenax.transmission.transmission_pass:3.0.0#gearRatio + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Gear Ratio + + + + + en + gearRatio + + + REAL_MEASURE + + + en + The ratio in the respective gear (ratio between transmission input speed and transmission output speed). + + + + + + + + + standardGearRatio + + + en + Standard Gear Ratio + + + urn:samm:io.catenax.transmission.transmission_pass:3.0.0#standardGearRatio + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Standard Gear Ratio + + + + + en + standardGearRatio + + + STRING + + + en + The ratio in the respective gear (ratio between transmission input speed and transmission output speed). For example 1 : 4.1567; 2 : 3.898; 3 : 2.887; 4 : 2.7783; 5 : 1.811; 6 : 1.6545; 7 : 0.4377; 8 : 0.6121; R : -2.2183. + + + + + + + + + spreading + + + en + Spreading + + + urn:samm:io.catenax.transmission.transmission_pass:3.0.0#spreading + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Spreading + + + + + en + spreading + + + REAL_MEASURE + + + en + The transmission spreading coefficient. The ratio between the smallest (shortest gear) and the largest (longest gear) ratio. + + + + + + + + + oilCapacity + + + en + Oil Capacity + + + urn:samm:io.catenax.transmission.transmission_pass:3.0.0#oilCapacity + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Oil Capacity + + + + + en + oilCapacity + + + cubicDecimetre + REAL_MEASURE + + + en + The defined oil volume in the transmission in cubic decimeters. + + + + + + + + + oilType + + + en + Oil Type + + + urn:samm:io.catenax.transmission.transmission_pass:3.0.0#oilType + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Oil Type + + + + + en + oilType + + + STRING + + + en + The type of the oil for the transmission defined by the manufacturer of the transmission. + + + + + + + + + oil + + + en + Oil + + + urn:samm:io.catenax.transmission.transmission_pass:3.0.0#oil + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Oil + + + + + en + oil + + + STRING + + + en + The oil used for the transmission. + + + + + + + + + applicable + + + en + Applicable + + + urn:samm:io.catenax.transmission.transmission_pass:3.0.0#applicable + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Applicable + + + + + en + applicable + + + BOOLEAN + + + en + If there is a transmission-integrated electrical machine included, select true and state the values in the connected attributes. If there is none, select false and provide dummy data. + + + + + + + + + maximumTorque + + + en + MaximumTorque + + + urn:samm:io.catenax.transmission.transmission_pass:3.0.0#maximumTorque + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + MaximumTorque + + + + + en + maximumTorque + + + newtonMetre + INTEGER_COUNT + + + en + The maximum output torque in newton meters for a specified time period. + + + + + + + + + maximumAvailability + + + en + Maximum Availability + + + urn:samm:io.catenax.transmission.transmission_pass:3.0.0#maximumAvailability + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Maximum Availability + + + + + en + maximumAvailability + + + secondUnitOfTime + INTEGER_COUNT + + + en + Specified time period for the peak measurement in seconds. + + + + + + + + + continuousTorque + + + en + Continuous Torque + + + urn:samm:io.catenax.transmission.transmission_pass:3.0.0#continuousTorque + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Continuous Torque + + + + + en + continuousTorque + + + newtonMetre + INTEGER_COUNT + + + en + The torque that can be delivered without time limit in newton meters. + + + + + + + + + machineTorque + + + en + Machine Torque + + + urn:samm:io.catenax.transmission.transmission_pass:3.0.0#machineTorque + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Machine Torque + + + + + en + machineTorque + + + STRING + + + en + The torque of the electrical machine. + + + + + + + + + maximumPower + + + en + Maximum Power + + + urn:samm:io.catenax.transmission.transmission_pass:3.0.0#maximumPower + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Maximum Power + + + + + en + maximumPower + + + kilowatt + INTEGER_COUNT + + + en + The maximum output power in kilowatts for a specified time period. + + + + + + + + + continuousPower + + + en + Continuous Power + + + urn:samm:io.catenax.transmission.transmission_pass:3.0.0#continuousPower + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Continuous Power + + + + + en + continuousPower + + + kilowatt + INTEGER_COUNT + + + en + The power that can be delivered without time limit. + + + + + + + + + maximumAvailability + + + en + Maximum Availability + + + urn:samm:io.catenax.transmission.transmission_pass:3.0.0#maximumAvailability + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Maximum Availability + + + + + en + maximumAvailability + + + INTEGER_COUNT + + + en + Specified time period for the peak measurement in seconds. + + + + + + + + + machinePower + + + en + Machine Power + + + urn:samm:io.catenax.transmission.transmission_pass:3.0.0#machinePower + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Machine Power + + + + + en + machinePower + + + STRING + + + en + The power of the electrical machine. + + + + + + + + + machineVoltage + + + en + Machine Voltage + + + urn:samm:io.catenax.transmission.transmission_pass:3.0.0#machineVoltage + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Machine Voltage + + + + + en + machineVoltage + + + volt + INTEGER_MEASURE + + + en + Nominal voltage of the electric system in volt. + + + + + + + + + machineSpeed + + + en + Machine Speed + + + urn:samm:io.catenax.transmission.transmission_pass:3.0.0#machineSpeed + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Machine Speed + + + + + en + machineSpeed + + + revolutionsPerMinute + INTEGER_COUNT + + + en + Maximum allowable speed for the electric motor in revolutions per minute. + + + + + + + + + electricalMachine + + + en + Electrical Machine + + + urn:samm:io.catenax.transmission.transmission_pass:3.0.0#electricalMachine + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Electrical Machine + + + + + en + electricalMachine + + + STRING + + + en + Attributes connected to the transmission-integrated electrical machine, if applicable. Otherwise dummy data (0 or null) can be provided. + + + + + + + + + electricalPerformance + + + en + Electrical Performance + + + urn:samm:io.catenax.transmission.transmission_pass:3.0.0#electricalPerformance + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Electrical Performance + + + + + en + electricalPerformance + + + STRING + + + en + Attributes connected to the transmission-integrated electrical machine, if applicable. + + + + + + + + + content + + + en + Content + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Content + + + + + en + content + + + STRING + + + en + The content of the document e.g a link. + + + + + + + + + contentType + + + en + Content Type + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Content Type + + + + + en + contentType + + + STRING + + + en + The type of content which can be expected in the "content" property. Examples are a link, restricted link, pdf, excel, etc. + + + + + + + + + header + + + en + Header + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Header + + + + + en + header + + + STRING + + + en + The header as a short description of the document with a maximum of 100 characters. + + + + + + + + + serviceHistory + + + en + Service History + + + urn:samm:io.catenax.transmission.transmission_pass:3.0.0#serviceHistory + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Service History + + + + + en + serviceHistory + + + STRING + + + en + Documentation of the service history of the transmission. + + + + + + + + + productSpecificParameters + + + en + Product Specific Parameters + + + urn:samm:io.catenax.transmission.transmission_pass:3.0.0#productSpecificParameters + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Product Specific Parameters + + + + + en + productSpecificParameters + + + STRING + + + en + Product specific parameters of the transmission. + + + + + + + + + warranty + + + en + Warranty + + + urn:samm:io.catenax.transmission.transmission_pass:3.0.0#warranty + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Warranty + + + + + en + warranty + + + month + INTEGER_COUNT + + + en + Commercial warranty period of the transmission (coupled to the Vehicle) in months. + + + + + + + + + lifeTime + + + en + Life Time + + + urn:samm:io.catenax.transmission.transmission_pass:3.0.0#lifeTime + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Life Time + + + + + en + lifeTime + + + kilometre + INTEGER_COUNT + + + en + Expected transmission lifespan in kilometres. + + + + + + + + + quantityValue + + + en + Quantity Value + + + urn:samm:io.catenax.shared.quantity:2.0.0#quantityValue + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Quantity Value + + + + + en + quantityValue + + + REAL_MEASURE + + + en + The quantity value associated with the unit. + + + + + + + + + linearUnit + + + en + Linear Unit + + + urn:samm:io.catenax.shared.quantity:2.0.0#linearUnit + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Linear Unit + + + + + en + linearUnit + + + STRING + + + en + The unit of a linear attribute. + + + + + + unit:millimetre + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#LinearUnitEnumeration:unit:millimetre + + + + + + unit:centimetre + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#LinearUnitEnumeration:unit:centimetre + + + + + + unit:metre + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#LinearUnitEnumeration:unit:metre + + + + + + unit:kilometre + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#LinearUnitEnumeration:unit:kilometre + + + + + + unit:inch + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#LinearUnitEnumeration:unit:inch + + + + + + unit:foot + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#LinearUnitEnumeration:unit:foot + + + + + + unit:yard + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#LinearUnitEnumeration:unit:yard + + + + + + + + + + + + + width + + + en + Width + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#width + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Width + + + + + en + width + + + STRING + + + en + The width of the item measured in a specific linear unit which can be declared in the corresponding unit attribute. + + + + + + + + + quantityValue + + + en + Quantity Value + + + urn:samm:io.catenax.shared.quantity:2.0.0#quantityValue + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Quantity Value + + + + + en + quantityValue + + + REAL_MEASURE + + + en + The quantity value associated with the unit. + + + + + + + + + linearUnit + + + en + Linear Unit + + + urn:samm:io.catenax.shared.quantity:2.0.0#linearUnit + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Linear Unit + + + + + en + linearUnit + + + STRING + + + en + The unit of a linear attribute. + + + + + + + + + length + + + en + Length + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#length + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Length + + + + + en + length + + + STRING + + + en + The length of the item measured in a specific linear unit which can be declared in the corresponding unit attribute. + + + + + + + + + quantityValue + + + en + Quantity Value + + + urn:samm:io.catenax.shared.quantity:2.0.0#quantityValue + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Quantity Value + + + + + en + quantityValue + + + REAL_MEASURE + + + en + The quantity value associated with the unit. + + + + + + + + + linearUnit + + + en + Linear Unit + + + urn:samm:io.catenax.shared.quantity:2.0.0#linearUnit + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Linear Unit + + + + + en + linearUnit + + + STRING + + + en + The unit of a linear attribute. + + + + + + + + + diameter + + + en + Diameter + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#diameter + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Diameter + + + + + en + diameter + + + STRING + + + en + The diameter of the item, if applicable, measured in a specific linear unit which can be declared in the corresponding unit attribute. + + + + + + + + + quantityValue + + + en + Quantity Value + + + urn:samm:io.catenax.shared.quantity:2.0.0#quantityValue + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Quantity Value + + + + + en + quantityValue + + + REAL_MEASURE + + + en + The quantity value associated with the unit. + + + + + + + + + linearUnit + + + en + Linear Unit + + + urn:samm:io.catenax.shared.quantity:2.0.0#linearUnit + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Linear Unit + + + + + en + linearUnit + + + STRING + + + en + The unit of a linear attribute. + + + + + + + + + height + + + en + Height + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#height + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Height + + + + + en + height + + + STRING + + + en + The height of the item measured in a specific linear unit which can be declared in the corresponding unit attribute. + + + + + + + + + quantityValue + + + en + Quantity Value + + + urn:samm:io.catenax.shared.quantity:2.0.0#quantityValue + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Quantity Value + + + + + en + quantityValue + + + REAL_MEASURE + + + en + The quantity value associated with the unit. + + + + + + + + + massUnit + + + en + Mass Unit + + + urn:samm:io.catenax.shared.quantity:2.0.0#massUnit + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Mass Unit + + + + + en + massUnit + + + STRING + + + en + The unit of a mass related attribute. + + + + + + unit:gram + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#MassUnitEnumeration:unit:gram + + + + + + unit:kilogram + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#MassUnitEnumeration:unit:kilogram + + + + + + unit:tonneMetricTon + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#MassUnitEnumeration:unit:tonneMetricTon + + + + + + unit:tonUsOrShortTonUkorus + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#MassUnitEnumeration:unit:tonUsOrShortTonUkorus + + + + + + unit:ounceAvoirdupois + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#MassUnitEnumeration:unit:ounceAvoirdupois + + + + + + unit:pound + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#MassUnitEnumeration:unit:pound + + + + + + + + + + + + + grossWeight + + + en + Gross Weight + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#grossWeight + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Gross Weight + + + + + en + grossWeight + + + STRING + + + en + The gross weight of the item measured in a specific mass unit which can be declared in the corresponding unit attribute. Gross weight refers to the total weight of a product, including the weight of the packaging. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7: +(2) (b) (i) information on the performance of the product in relation to the product parameters referred to in Annex I; +Annex I (i) weight and volume of the product and its packaging, and the product-to-packaging ratio. + + + + + + + + + quantityValue + + + en + Quantity Value + + + urn:samm:io.catenax.shared.quantity:2.0.0#quantityValue + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Quantity Value + + + + + en + quantityValue + + + REAL_MEASURE + + + en + The quantity value associated with the unit. + + + + + + + + + volumeUnit + + + en + Volume Unit + + + urn:samm:io.catenax.shared.quantity:2.0.0#volumeUnit + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Volume Unit + + + + + en + volumeUnit + + + STRING + + + en + The unit of a volume related attribute. + + + + + + unit:cubicMetre + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#VolumeUnitEnumeration:unit:cubicMetre + + + + + + unit:litre + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#VolumeUnitEnumeration:unit:litre + + + + + + unit:millilitre + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#VolumeUnitEnumeration:unit:millilitre + + + + + + unit:cubicCentimetre + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#VolumeUnitEnumeration:unit:cubicCentimetre + + + + + + unit:cubicInch + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#VolumeUnitEnumeration:unit:cubicInch + + + + + + unit:cubicFoot + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#VolumeUnitEnumeration:unit:cubicFoot + + + + + + unit:cubicYard + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#VolumeUnitEnumeration:unit:cubicYard + + + + + + unit:hectolitre + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#VolumeUnitEnumeration:unit:hectolitre + + + + + + + + + + + + + grossVolume + + + en + Gross Volume + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#grossVolume + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Gross Volume + + + + + en + grossVolume + + + STRING + + + en + The gross volume of the item, if possible, measured in a specific capacity unit which can be declared in the corresponding unit attribute. If there is no separate packing, the volume of the product shall be given. Gross volume refers to the total volume of a product, including the volume of the packaging. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7: +(2) (b) (i) information on the performance of the product in relation to the product parameters referred to in Annex I; +Annex I (i) weight and volume of the product and its packaging, and the product-to-packaging ratio. + + + + + + + + + quantityValue + + + en + Quantity Value + + + urn:samm:io.catenax.shared.quantity:2.0.0#quantityValue + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Quantity Value + + + + + en + quantityValue + + + REAL_MEASURE + + + en + The quantity value associated with the unit. + + + + + + + + + massUnit + + + en + Mass Unit + + + urn:samm:io.catenax.shared.quantity:2.0.0#massUnit + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Mass Unit + + + + + en + massUnit + + + STRING + + + en + The unit of a mass related attribute. + + + + + + + + + weight + + + en + Weight + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#weight + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Weight + + + + + en + weight + + + STRING + + + en + Weight of the product measured in a specific mass unit which can be declared in the corresponding unit attribute. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7: +(2) (b) (i) information on the performance of the product in relation to the product parameters referred to in Annex I; +Annex I (i) weight and volume of the product [...]. + + + + + + + + + quantityValue + + + en + Quantity Value + + + urn:samm:io.catenax.shared.quantity:2.0.0#quantityValue + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Quantity Value + + + + + en + quantityValue + + + REAL_MEASURE + + + en + The quantity value associated with the unit. + + + + + + + + + volumeUnit + + + en + Volume Unit + + + urn:samm:io.catenax.shared.quantity:2.0.0#volumeUnit + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Volume Unit + + + + + en + volumeUnit + + + STRING + + + en + The unit of a volume related attribute. + + + + + + + + + volume + + + en + Volume + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#volume + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Volume + + + + + en + volume + + + STRING + + + en + Volume of the product, if possible, measured in a specific capacity unit which can be declared in the corresponding unit attribute. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7: +(2) (b) (i) information on the performance of the product in relation to the product parameters referred to in Annex I; +Annex I (i) weight and volume of the product [...]. + + + + + + + + + physicalDimension + + + en + Physical Dimension + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#physicalDimension + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Physical Dimension + + + + + en + physicalDimension + + + STRING + + + en + Physical dimensions are properties associated with physical quantities for purposes of classification or differentiation. These attributes are mentioned in the ESPR provisional agreement from January 9th, Article 7: +(2) (b) (i) information on the performance of the product in relation to one or more of the product parameters referred to in Annex I; +Annex I (i) weight and volume of the product and its packaging, and the product-to-packaging ratio. + + + + + + + + + characteristics + + + en + Characteristics + + + urn:samm:io.catenax.transmission.transmission_pass:3.0.0#characteristics + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Characteristics + + + + + en + characteristics + + + STRING + + + en + Defines specific characteristics of the transmission. + + + + + + + + + version + + + en + Version + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#version + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Version + + + + + en + version + + + STRING + + + en + The current version of the product passport. The possibility of modification/ updating the product passport needs to include versioning of the dataset. This attribute is an internal versioning from the passport issuer. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Article 8: +(1) [...] The information in the product passport shall be accurate, complete, and up to date. + + + + + + + + + status + + + en + Status + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#status + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Status + + + + + en + status + + + STRING + + + en + The current status of the product passport declared through either: draft, approved, invalid or expired. + + + + + + draft + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#StatusEnumeration:draft + + + + + + approved + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#StatusEnumeration:approved + + + + + + invalid + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#StatusEnumeration:invalid + + + + + + expired + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#StatusEnumeration:expired + + + + + + + + + + + + + expirationDate + + + en + Expiration Date + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#expirationDate + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Expiration Date + + + + + en + expirationDate + + + STRING + + + en + The timestamp in the format (yyyy-mm-dd) for the product passport until when it is available or a comment describing this period. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Article 8: +(2) (h) the period during which the product passport is to remain available, which shall correspond to at least the expected lifetime of a specific product. + + + + + + + + + issueDate + + + en + Issue Date + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#issueDate + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Issue Date + + + + + en + issueDate + + + STRING + + + en + The timestamp in the format (yyyy-mm-dd) since when the product passport is available. + + + + + + + + + economicOperatorId + + + en + Economic Operator Id + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#economicOperatorId + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Economic Operator Id + + + + + en + economicOperatorId + + + STRING + + + en + The identification of the owner/economic operator of the passport. Proposed, according to ISO 15459, is the CIN (company identification code). Other identification numbers like the tax identification number, value added tax identification number, commercial register number and the like are also valid entries. In the Catena-X network, the BPNL is used for the identification of companies and the information stored like contact information and addresses. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Annex III: +(k) the [...] unique operator identifier code of the economic operator established in the Union responsible for carrying out the tasks set out in Article 4 of Regulation (EU) 2019/1020, or Article 15 of Regulation (EU) on general product safety, or similar tasks pursuant to other EU legislation applicable to the product. + + + + + + + + + passportIdentifier + + + en + Passport Identifier + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#passportIdentifier + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Passport Identifier + + + + + en + passportIdentifier + + + STRING + + + en + The identifier of the product passport, which is an uuidv4. + + + + + + + + + predecessor + + + en + Predecessor + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#predecessor + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Predecessor + + + + + en + predecessor + + + STRING + + + en + Identification of the preceding product passport. If there is no preceding passport, input a dummy value. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Article 8: +(2)(g) [...] Any new product passport shall be linked to the product passport or passports of the original product whenever appropriate. + + + + + + + + + backupReference + + + en + Backup Reference + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#backupReference + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Backup Reference + + + + + en + backupReference + + + STRING + + + en + A reference to the data backup of the passport. This mandatory attribute will be further defined in the future. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex III: +(kb) the reference of the certified independent third-party product passport service provider hosting the back-up copy of the product passport. +Article 10 also mentions: +(c) the data included in the product passport shall be stored by the economic operator responsible for its creation or by certified independent third-party product passport service providers authorised to act on their behalf. + + + + + + + + + registrationIdentifier + + + en + Registration Identifier + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#registrationIdentifier + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Registration Identifier + + + + + en + registrationIdentifier + + + STRING + + + en + Identifier in the respective registry. This will be further defined in the future. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 in Article 12: +By [2 years from entering into force of this Regulation], the Commission shall set up and manage a digital registry ("the registry") storing in a secure manner at least the unique product identifier, the unique operator identifier, the unique facility identifiers. In case of products intended to be placed under the customs procedure 'release for free circulation', the registry shall also store the product commodity code. The registry shall also store the batteries' unique identifiers referred to in Article 77(3) of Regulation (EU) 2023/1542. + + + + + + + + + lastModification + + + en + Last Modification + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#lastModification + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Last Modification + + + + + en + lastModification + + + STRING + + + en + Date of the latest modification. + + + + + + + + + metadata + + + en + Metadata + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#metadata + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Metadata + + + + + en + metadata + + + STRING + + + en + Metadata of the product passport. These are mentioned in the ESPR proposal from March 30th, 2022 and some changed by the provisional agreement from January 9th, 2024. + + + + + + + + + key + + + en + Identifier Key + + + urn:samm:io.catenax.serial_part:3.0.0#key + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Identifier Key + + + + + en + key + + + STRING + + + en + The key of a local identifier. + + + + + + + + + value + + + en + Identifier Value + + + urn:samm:io.catenax.serial_part:3.0.0#value + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Identifier Value + + + + + en + value + + + STRING + + + en + The value of an identifier. + + + + + + + + + serialInformation + + + en + Serial Information + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#serialInformation + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Serial Information + + + + + en + serialInformation + + + STRING + + + en + Identifier for a serial part if available. This is mentioned in the ESPR provisional agreement from January 9th, 2024 Recital (27): +[...] an 'item' usually means a single unit of a model. + + + + + + + + + key + + + en + Identifier Key + + + urn:samm:io.catenax.batch:3.0.0#key + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Identifier Key + + + + + en + key + + + STRING + + + en + The key of a local identifier. + + + + + + + + + value + + + en + Identifier Value + + + urn:samm:io.catenax.batch:3.0.0#value + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Identifier Value + + + + + en + value + + + STRING + + + en + The value of an identifier. + + + + + + + + + batchInformation + + + en + Batch Information + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#batchInformation + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Batch Information + + + + + en + batchInformation + + + STRING + + + en + Identifier for a batch part if available. Identifier for a serial part if available. This is mentioned in the ESPR provisional agreement from January 9th, 2024 Recital (27): +[...] a 'batch' usually means a subset of a specific model composed of all products produced in a specific manufacturing plant at a specific moment in time [...]. + + + + + + + + + manufacturerPartId + + + en + Manufacturer Part ID + + + urn:samm:io.catenax.part_type_information:1.0.0#manufacturerPartId + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Manufacturer Part ID + + + + + en + manufacturerPartId + + + STRING + + + en + Part ID as assigned by the manufacturer of the part. The part ID identifies the part in the manufacturer`s dataspace. The part ID references a specific version of a part. The version number must be included in the part ID if it is available. The part ID does not reference a specific instance of a part and must not be confused with the serial number. + + + + + + + + + nameAtManufacturer + + + en + Name at manufacturer + + + urn:samm:io.catenax.part_type_information:1.0.0#nameAtManufacturer + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Name at manufacturer + + + + + en + nameAtManufacturer + + + STRING + + + en + Name of the part as assigned by the manufacturer. + + + + + + + + + partTypeInformation + + + en + Part Type Information + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#partTypeInformation + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Part Type Information + + + + + en + partTypeInformation + + + STRING + + + en + Identifier on the level of a part model or type. Identifier for a serial part if available. This is mentioned in the ESPR provisional agreement from January 9th, 2024 Recital (27): +[...] A 'model' usually means a version of a product of which all units share the same technical characteristics relevant for the ecodesign requirements and the same model identifier [...]. + + + + + + + + + codeKey + + + en + Code Key + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#codeKey + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Code Key + + + + + en + codeKey + + + STRING + + + en + The code key for the identification of the product. Examples are GTIN, hash, DID, ISBN, TARIC. This attribute is mentioned in the ESPR proposal from March 30th, 2022 ANNEX III: +(b) the unique product identifier at the level indicated in the applicable delegated act adopted pursuant to Article 4; +(c) the Global Trade Identification Number as provided for in standard ISO/IEC 15459-6 or equivalent of products or their parts; +(d) relevant commodity codes, such as a TARIC code as defined in Council Regulation (EEC) No 2658/87. + + + + + + + + + codeValue + + + en + Code Value + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#codeValue + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Code Value + + + + + en + codeValue + + + STRING + + + en + The code value for the identification of the product in regard to the chosen code name. + + + + + + + + + codes + + + en + Codes + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#codes + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Codes + + + + + en + codes + + + STRING + + + en + Codes for identification. + + + + + + + + + carrierType + + + en + Carrier Type + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#carrierType + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Carrier Type + + + + + en + carrierType + + + STRING + + + en + The type of data carrier such as a QR code on the product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 8: +(2) (b) the types of data carrier to be used. + + + + + + + + + carrierLayout + + + en + Carrier Layout + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#carrierLayout + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Carrier Layout + + + + + en + carrierLayout + + + STRING + + + en + The positioning of data carrier on the product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 8: +(2) (c) the layout in which the data carrier shall be presented and its positioning. + + + + + + + + + dataCarrier + + + en + Data Carrier + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#dataCarrier + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Data Carrier + + + + + en + dataCarrier + + + STRING + + + en + The type and layout of the data carrier on the product. These are mentioned in the ESPR proposal from March 30th, 2022 Article 8: +(b) the types of data carrier to be used; +(c) the layout in which the data carrier shall be presented and its positioning; +Article 2 defines: +(30) 'data carrier' means a linear bar code symbol, a two-dimensional symbol or other automatic identification data capture medium that can be read by a device. + + + + + + + + + classificationStandard + + + en + Classification Standard + + + urn:samm:io.catenax.shared.part_classification:1.0.0#classificationStandard + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Classification Standard + + + + + en + classificationStandard + + + STRING + + + en + Identified classification standards that align to the Catena-X needs. + + + + + + + + + classificationID + + + en + Classification ID + + + urn:samm:io.catenax.shared.part_classification:1.0.0#classificationID + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Classification ID + + + + + en + classificationID + + + STRING + + + en + The classification ID of the part type according to the corresponding standard definition mentioned in the key value pair. + + + + + + + + + classificationDescription + + + en + Classification Description + + + urn:samm:io.catenax.shared.part_classification:1.0.0#classificationDescription + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Classification Description + + + + + en + classificationDescription + + + STRING + + + en + Optional property describing the classification standard. + + + + + + + + + partClassification + + + en + Part Classification + + + urn:samm:io.catenax.shared.part_classification:1.0.0#partClassification + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Part Classification + + + + + en + partClassification + + + STRING + + + en + Property describing the classification of a part. + + + + + + + + + identification + + + en + Identification + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#identification + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Identification + + + + + en + identification + + + STRING + + + en + Identification information of the product, especially identifiers and codes. These are mentioned in the ESPR provisional agreement from January 9th, 2024 ANNEX III: +(b) the unique product identifier at the level indicated in the applicable delegated act adopted pursuant to Article 4. +Additionally in Article 9 regarding general requirements for the product passport is stated that: +A product passport shall meet the following conditions: +(a) it shall be connected through a data carrier to a persistent unique product identifier; +(e) the information included in the product passport shall refer to the product model, batch, or item as specified in the delegated act adopted pursuant to Article 4. +Article 2 Definitions: +(31) 'unique product identifier' means a unique string of characters for the identification of products that also enables a web link to the product passport; +Recital (27): A 'model' usually means a version of a product of which all units share the same technical characteristics relevant for the ecodesign requirements and the same model identifier, a 'batch' usually means a subset of a specific model composed of all products produced in a specific manufacturing plant at a specific moment in time and an 'item' usually means a single unit of a model. + + + + + + + + + facility + + + en + Facility + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#facility + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Facility + + + + + en + facility + + + STRING + + + en + The identifier used for a location. This attribute is mentioned in the ESPR provisional agreement from January 9th 2024 Annex III: +(i) unique facility identifiers; +Article 2 Definitions: (33) 'unique facility identifier' means a unique string of characters for the identification of locations or buildings involved in the value chain of a product or used by actors involved in the value chain of a product. + + + + + + + + + facilityIdentification + + + en + Facility Identification + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#facilityIdentification + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Facility Identification + + + + + en + facilityIdentification + + + STRING + + + en + The identifier used for a location. In the CATENA-X use case, the BPNA can be stated. This attribute is mentioned in the ESPR provisional agreement from January 9th 2024 Annex III: +(i) unique facility identifiers; +Article 2 Definitions: (33) 'unique facility identifier' means a unique string of characters for the identification of locations or buildings involved in the value chain of a product or used by actors involved in the value chain of a product. + + + + + + + + + manufacturerIdentification + + + en + Manufacturer Identification + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#manufacturerIdentification + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Manufacturer Identification + + + + + en + manufacturerIdentification + + + STRING + + + en + The main manufacturer, if different from the passport owner, represented by an identification number. In the Catena-X use case, the BPNL can be stated. This attribute is mentioned in the ESPR provisional agreement from January 9th 2024 Annex III: +(h) unique operator identifiers other than that of the manufacturer; +(k) the name, contact details and unique operator identifier code of the economic operator established in the Union responsible for carrying out the tasks set out in Article 4 of Regulation (EU) 2019/1020, or Article 15 of Regulation (EU) [.../...] on general product safety, or similar tasks pursuant to other EU legislation applicable to the product. + + + + + + + + + manufacturingDate + + + en + Manufacturing Date + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#manufacturingDate + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Manufacturing Date + + + + + en + manufacturingDate + + + STRING + + + en + The timestamp in the format (yyyy-mm-dd) of the manufacturing date as the final step in production process (e.g. final quality check, ready-for-shipment event). + + + + + + + + + manufacturer + + + en + Manufacturer + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#manufacturer + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Manufacturer + + + + + en + manufacturer + + + STRING + + + en + Manufacturing information of the product. In the CATENA-X use case, the BPNL and BPNA can be stated. These attributes are mentioned in the ESPR provisional agreement from January 9th 2024 Annex III: +(h) unique operator identifiers other than that of the manufacturer; +(k) the name, contact details and unique operator identifier code of the economic operator established in the Union responsible for carrying out the tasks set out in Article 4 of Regulation (EU) 2019/1020, or Article 15 of Regulation (EU) [.../...] on general product safety, or similar tasks pursuant to other EU legislation applicable to the product. + + + + + + + + + eori + + + en + EORI + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#eori + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + EORI + + + + + en + eori + + + STRING + + + en + An economic operator established in the customs territory of the Union needs, for customs purposes, an EORI number. EORI stands for economic operators registration and identification number. In this case, the importer's EORI must be provided. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Annex III: +(j) information related to the importer, including the information referred to in Article 23(3) and its EORI number. + + + + + + + + + importerIdentification + + + en + Importer Identification + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#importerIdentification + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Importer Identification + + + + + en + importerIdentification + + + STRING + + + en + The importer of the product, if different from the owner of the passport. In the Catena-X network, the BPNL is used for the identification of companies and the information stored for this like contact information and addresses. +This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex III: +(j) information related to the importer, including the information referred to in Article 23(3) and its EORI number; +Article 23 states: +(3) Importers shall, for products covered by a delegated act adopted pursuant to Article 4, indicate their name, registered trade name or registered trade mark and the postal address and electronic means of communication, where they can be contacted: (a) on the public part of the product passport, when applicable, and +(b) on the product or, where this is not possible, on the packaging, or in a document accompanying the product. + + + + + + + + + importer + + + en + Importer + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#importer + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Importer + + + + + en + importer + + + STRING + + + en + Information regarding the importer of the product, if different from the owner of the passport. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex III: +(j) information related to the importer, including the information referred to in Article 23(3) and its EORI number; +Article 23 states: +(3) Importers shall, for products covered by a delegated act adopted pursuant to Article 4, indicate their name, registered trade name or registered trade mark and the postal address and electronic means of communication, where they can be contacted: (a) on the public part of the product passport, when applicable, and +(b) on the product or, where this is not possible, on the packaging, or in a document accompanying the product. + + + + + + + + + applicable + + + en + Applicable + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#applicable + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Applicable + + + + + en + applicable + + + BOOLEAN + + + en + Check whether the connected attributes are applicable to the product. If it is not applicable (false), dummy data can be delivered. + + + + + + + + + import + + + en + Import + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#import + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Import + + + + + en + import + + + STRING + + + en + Importer details such as the identification. + + + + + + + + + otherOperatorId + + + en + Other Operator Id + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#otherOperatorId + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Other Operator Id + + + + + en + otherOperatorId + + + STRING + + + en + Identifier of the other operator. This can be a BPN. + + + + + + + + + otherOperatorRole + + + en + Other Operator Role + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#otherOperatorRole + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Other Operator Role + + + + + en + otherOperatorRole + + + STRING + + + en + Role of the other operator. + + + + + + + + + otherOperators + + + en + Other Operators + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#otherOperators + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Other Operators + + + + + en + otherOperators + + + STRING + + + en + Other operators relevant for the product. + + + + + + + + + operation + + + en + Operation + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#operation + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Operation + + + + + en + operation + + + STRING + + + en + Operational information of the product. + + + + + + + + + sourcesIdentification + + + en + Sources Identification + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#sourcesIdentification + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Sources Identification + + + + + en + sourcesIdentification + + + STRING + + + en + The identifier of a spare part producer of the product. In the Catena-X network, the BPNL is used for the identification of companies and the information stored for this like contact information and addresses. + + + + + + + + + sparePartSources + + + en + Spare Part Sources + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#sparePartSources + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Spare Part Sources + + + + + en + sparePartSources + + + STRING + + + en + Sources of possible spare parts. + + + + + + + + + manufacturerPartId + + + en + Manufacturer Part ID + + + urn:samm:io.catenax.part_type_information:1.0.0#manufacturerPartId + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Manufacturer Part ID + + + + + en + manufacturerPartId + + + STRING + + + en + Part ID as assigned by the manufacturer of the part. The part ID identifies the part in the manufacturer`s dataspace. The part ID references a specific version of a part. The version number must be included in the part ID if it is available. The part ID does not reference a specific instance of a part and must not be confused with the serial number. + + + + + + + + + nameAtManufacturer + + + en + Name at manufacturer + + + urn:samm:io.catenax.part_type_information:1.0.0#nameAtManufacturer + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Name at manufacturer + + + + + en + nameAtManufacturer + + + STRING + + + en + Name of the part as assigned by the manufacturer. + + + + + + + + + sparePart + + + en + Spare Part + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#sparePart + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Spare Part + + + + + en + sparePart + + + STRING + + + en + Possible spare parts of the product. + + + + + + + + + spareParts + + + en + spareParts + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#spareParts + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + spareParts + + + + + en + spareParts + + + STRING + + + en + The list of spare parts available for the product from various suppliers. + + + + + + + + + applicable + + + en + Applicable + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#applicable + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Applicable + + + + + en + applicable + + + BOOLEAN + + + en + Check whether the connected attributes are applicable to the product. If it is not applicable (false), dummy data can be delivered. + + + + + + + + + handling + + + en + handling + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#handling + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + handling + + + + + en + handling + + + STRING + + + en + Properties connected with the handling of the product. + + + + + + + + + placedOnMarket + + + en + Placed on Market + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#placedOnMarket + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Placed on Market + + + + + en + placedOnMarket + + + STRING + + + en + The timestamp in the format (yyyy-mm-dd) with or without time zone when the product was put in the market. + + + + + + + + + purpose + + + en + Purpose + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#purpose + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Purpose + + + + + en + purpose + + + STRING + + + en + One or more intended industry/industries of the product described by the digital product passport. If exchanged via Catena-X, 'automotive ' is a must choice included in the list. + + + + + + + + + commercial + + + en + Commercial + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#commercial + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Commercial + + + + + en + commercial + + + STRING + + + en + Commercial information of the product. + + + + + + + + + applicable + + + en + Applicable + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#applicable + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Applicable + + + + + en + applicable + + + BOOLEAN + + + en + Check whether the connected attributes are applicable to the product. If it is not applicable (false), dummy data can be delivered. + + + + + + + + + location + + + en + Location + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#location + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Location + + + + + en + location + + + STRING + + + en + The location of the substances of concern within the product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7: +(5) (b) the location of the substances of concern within the product. + + + + + + + + + materialUnit + + + en + Material Unit + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#materialUnit + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Material Unit + + + + + en + materialUnit + + + STRING + + + en + The unit of concentration chosen from an enumeration: mass percent, volume percent, parts per thousand, parts per million, parts per billion and parts per trillion. + + + + + + unit:partPerMillion + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#ConcentrationEnumeration:unit:partPerMillion + + + + + + unit:percent + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#ConcentrationEnumeration:unit:percent + + + + + + unit:percentVolume + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#ConcentrationEnumeration:unit:percentVolume + + + + + + unit:partPerThousand + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#ConcentrationEnumeration:unit:partPerThousand + + + + + + unit:partPerTrillionUs + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#ConcentrationEnumeration:unit:partPerTrillionUs + + + + + + unit:partPerBillionUs + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#ConcentrationEnumeration:unit:partPerBillionUs + + + + + + + + + + + + + concentration + + + en + Concentration + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#concentration + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Concentration + + + + + en + concentration + + + REAL_MEASURE + + + en + Concentration of the material at the level of the product. This attribute is specially mentioned for substances of concern mentioned in the ESPR proposal from March 30th, 2022 Article 7: +(5) (c) the concentration, maximum concentration or concentration range of the substances of concern, at the level of the product [...]. +Other substances are mentioned for the purpose of recycling in the ESPR provisional agreement from January 9th, 2024 Annex I: +(d) design for recycling, ease and quality of recycling as expressed through: use of easily recyclable materials, safe, easy and non-destructive access to recyclable components and materials or components and materials containing hazardous substances and material composition and homogeneity, possibility for high-purity sorting, number of materials and components used, use of standard components, use of component and material coding standards for the identification of components and materials, number and complexity of processes and tools needed, ease of nondestructive disassembly and re-assembly, conditions for access to product data, conditions for access to or use of hardware and software needed. + + + + + + + + + + exemption + + + en + Exemption + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#exemption + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Exemption + + + + + en + exemption + + + STRING + + + en + Exemptions to the substance of concern. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Article 7: +(5) (c) provide duly justified exemptions for substances of concern or information elements from the information requirements referred to in the first subparagraph based on the technical feasibility or relevance of tracking substances of concern, the existence of analytical methods to detect and quantify them, the need to protect confidential business information or in other duly justified cases. Substances of concern within the meaning of Article 2(28), point a), shall not be exempted if they are present in products, their relevant components or spare parts in a concentration above 0,1 % weight by weight. + + + + + + + + + hazardCategory + + + en + Hazard Category + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#hazardCategory + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Hazard Category + + + + + en + hazardCategory + + + STRING + + + en + The hazard category of the substance of concern. Defined in Article 2 of Regulation (EC) No 1272/2008 of the European Parliament and of the Council of 16 December 2008 on classification, labelling and packaging of substances and mixtures, amending and repealing Directives 67/548/EEC and 1999/45/EC, and amending Regulation (EC) No 1907/2006: +2. 'hazard category' means the division of criteria within each hazard class, specifying hazard severity. + + + + + + + + + hazardClass + + + en + Hazard Class + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#hazardClass + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Hazard Class + + + + + en + hazardClass + + + STRING + + + en + The hazard class of the substance of concern. Defined in Article 2 of Regulation (EC) No 1272/2008 of the European Parliament and of the Council of 16 December 2008 on classification, labelling and packaging of substances and mixtures, amending and repealing Directives 67/548/EEC and 1999/45/EC, and amending Regulation (EC) No 1907/2006: +1. 'hazard class' means the nature of the physical, health or environmental hazard. + + + + + + + + + hazardStatement + + + en + Hazard Statement + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#hazardStatement + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Hazard Statement + + + + + en + hazardStatement + + + STRING + + + en + The hazard statement of the substance of concern. Defined in Article 2 of Regulation (EC) No 1272/2008 of the European Parliament and of the Council of 16 December 2008 on classification, labelling and packaging of substances and mixtures, amending and repealing Directives 67/548/EEC and 1999/45/EC, and amending Regulation (EC) No 1907/2006: +5. 'hazard statement' means a phrase assigned to a hazard class and category that describes the nature of the hazards of a hazardous substance or mixture, including, where appropriate, the degree of hazard. + + + + + + + + + hazardClassification + + + en + Hazard Classification + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#hazardClassification + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Hazard Classification + + + + + en + hazardClassification + + + STRING + + + en + The specification of the hazard class. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I: +(f) use of substances, and in particular the use of substances of concern, on their own, as constituents of substances or in mixtures, during the production process of products, or leading to their presence in products, including once these products become waste, and their impacts on human health and the environment; +Further defined is this by Regulation (EC) No 1272/2008 of the European Parliament and of the Council of 16 December 2008 on classification, labelling and packaging of substances and mixtures, amending and repealing Directives 67/548/EEC and 1999/45/EC, and amending Regulation (EC) No 1907/2006. +Defined in Article 2: +1. 'hazard class' means the nature of the physical, health or environmental hazard; +2. 'hazard category' means the division of criteria within each hazard class, specifying hazard severity; +5. 'hazard statement' means a phrase assigned to a hazard class and category that describes the nature of the hazards of a hazardous substance or mixture, including, where appropriate, the degree of hazard; + + + + + + + + + minConcentration + + + en + Minimum Concentration + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#minConcentration + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Minimum Concentration + + + + + en + minConcentration + + + REAL_MEASURE + + + en + The minimum concentration of the substance of concern at the level of the product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7: +(5) (c) [...] concentration range of the substances of concern, at the level of the product [...]. + + + + + + + + + maxConcentration + + + en + Maximum Concentration + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#maxConcentration + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Maximum Concentration + + + + + en + maxConcentration + + + REAL_MEASURE + + + en + The maximum concentration of the substance of concern at the level of the product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7: +(5) (c) the concentration, maximum concentration or concentration range of the substances of concern, at the level of the product [...]. + + + + + + + + + concentrationRange + + + en + Concentration Range + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#concentrationRange + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Concentration Range + + + + + en + concentrationRange + + + STRING + + + en + The concentration range for the substance of concern. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7: +(5) (c) [...] concentration range of the substances of concern, at the level of the product [...]. + + + + + + + + + chemicalId + + + en + Chemical Id + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#chemicalId + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Chemical Id + + + + + en + chemicalId + + + STRING + + + en + The substance identification, in accordance with the specification in the attribute for the list type. + + + + + + + + + listTypeId + + + en + List Type Id + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#listTypeId + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + List Type Id + + + + + en + listTypeId + + + STRING + + + en + The type of standard used for the identification of the substances. Selected can be for example CAS, IUPAC or EC. + + + + + + CAS + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#ListTypeEnumerationId:CAS + + + + + + EC + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#ListTypeEnumerationId:EC + + + + + + IUPAC + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#ListTypeEnumerationId:IUPAC + + + + + + + + + + + + + chemicalName + + + en + Chemical Name + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#chemicalName + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Chemical Name + + + + + en + chemicalName + + + STRING + + + en + The name of the material which is present in the product. + + + + + + + + + materialIdentification + + + en + Material Identification + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#materialIdentification + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Material Identification + + + + + en + materialIdentification + + + STRING + + + en + The chemical material name and identification, in accordance with the specification in the attribute for the list type. Preference is given to the IUPAC name. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Article 7: +(5) (a) the name of the substances of concern present in the product, as follows: + - name(s) in the International Union of Pure and Applied Chemistry (IUPAC) nomenclature, or another international name when IUPAC name is not available; +- other names (usual name, trade name, abbreviation); +- European Community (EC) number, as indicated in the European Inventory of Existing Commercial Chemical Substances (EINECS), the European List of Notified Chemical Substances (ELINCS) or the No Longer Polymer (NLP) list or assigned by the European Chemicals Agency (ECHA), if available; +- the Chemical Abstract Service (CAS) name(s) and number(s), if available; . + + + + + + + + + content + + + en + Content + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Content + + + + + en + content + + + STRING + + + en + The content of the document e.g a link. + + + + + + + + + contentType + + + en + Content Type + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Content Type + + + + + en + contentType + + + STRING + + + en + The type of content which can be expected in the "content" property. Examples are a link, restricted link, pdf, excel, etc. + + + + + + + + + header + + + en + Header + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Header + + + + + en + header + + + STRING + + + en + The header as a short description of the document with a maximum of 100 characters. + + + + + + + + + documentation + + + en + Documentation + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#documentation + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Documentation + + + + + en + documentation + + + STRING + + + en + Documentation accompanying the material. + + + + + + + + + substanceOfConcern + + + en + Substance of Concern + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#substanceOfConcern + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Substance of Concern + + + + + en + substanceOfConcern + + + STRING + + + en + Information regarding substances of concern in the product. Attributes are among others substance names, ids, concentration, location and hazard class. This is mentioned in the ESPR provisional agreement from January 9th, 2024 Article 7: +(5) (a) the name of the substances of concern present in the product, as follows: +- name(s) in the International Union of Pure and Applied Chemistry (IUPAC) nomenclature, or another international name when IUPAC name is not available; +- other names (usual name, trade name, abbreviation); +- European Community (EC) number, as indicated in the European Inventory of Existing Commercial Chemical Substances (EINECS), the European List of Notified Chemical Substances (ELINCS) or the No Longer Polymer (NLP) list or assigned by the European Chemicals Agency (ECHA), if available; +- the Chemical Abstract Service (CAS) name(s) and number(s), if available; +(5) (b) the location of the substances of concern within the product. +(5) (c) the concentration, maximum concentration or concentration range of the substances of concern, at the level of the product its relevant components, or spare parts; +(d) relevant instructions for the safe use of the product; +(e) information relevant for disassembly, preparation for reuse, reuse, recycling and the environmentally sound management of the product at the end of its life. +And in the next paragraph: +(c) provide duly justified exemptions for substances of concern or information elements from the information requirements referred to in the first subparagraph. + + + + + + + + + substancesOfConcern + + + en + Substances of Concern + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#substancesOfConcern + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Substances of Concern + + + + + en + substancesOfConcern + + + STRING + + + en + Information regarding substances of concern in the product. The ESPR provisional agreement from January 9th, 2024 defines: +(52) 'hazardous substance' means a substance classified as hazardous pursuant to Article 3 of Regulation (EC) No 1272/2008. + + + + + + + + + applicable + + + en + Applicable + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#applicable + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Applicable + + + + + en + applicable + + + BOOLEAN + + + en + Check whether the connected attributes are applicable to the product. If it is not applicable (false), dummy data can be delivered. + + + + + + + + + recycled + + + en + Recycled + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#recycled + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Recycled + + + + + en + recycled + + + REAL_MEASURE + + + en + The share of the material, which is recovered recycled content from the product. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I: +(h) use or content of recycled materials and recovery of materials, including critical raw materials; + + + + + + + + + renewable + + + en + Renewable + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#renewable + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Renewable + + + + + en + renewable + + + REAL_MEASURE + + + en + The share of the material, which is from a renewable resource that can be replenished. Renewable resources are those that can be reproduced by physical, chemical, or mechanical processes. These are the kind of resources that can be regenerated throughout time. Forest wood, for example, can be grown through reforestation. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I: +(ha) use or content of sustainable renewable materials; + + + + + + + + + + materialUnit + + + en + Material Unit + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#materialUnit + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Material Unit + + + + + en + materialUnit + + + STRING + + + en + The unit of concentration chosen from an enumeration: mass percent, volume percent, parts per thousand, parts per million, parts per billion and parts per trillion. + + + + + + + + + chemicalId + + + en + Chemical Id + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#chemicalId + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Chemical Id + + + + + en + chemicalId + + + STRING + + + en + The substance identification, in accordance with the specification in the attribute for the list type. + + + + + + + + + listTypeId + + + en + List Type Id + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#listTypeId + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + List Type Id + + + + + en + listTypeId + + + STRING + + + en + The type of standard used for the identification of the substances. Selected can be for example CAS, IUPAC or EC. + + + + + + + + + chemicalName + + + en + Chemical Name + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#chemicalName + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Chemical Name + + + + + en + chemicalName + + + STRING + + + en + The name of the material which is present in the product. + + + + + + + + + materialIdentification + + + en + Material Identification + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#materialIdentification + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Material Identification + + + + + en + materialIdentification + + + STRING + + + en + The chemical material name and identification, in accordance with the specification in the attribute for the list type. Preference is given to the IUPAC name. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Article 7: +(5) (a) the name of the substances of concern present in the product, as follows: + - name(s) in the International Union of Pure and Applied Chemistry (IUPAC) nomenclature, or another international name when IUPAC name is not available; +- other names (usual name, trade name, abbreviation); +- European Community (EC) number, as indicated in the European Inventory of Existing Commercial Chemical Substances (EINECS), the European List of Notified Chemical Substances (ELINCS) or the No Longer Polymer (NLP) list or assigned by the European Chemicals Agency (ECHA), if available; +- the Chemical Abstract Service (CAS) name(s) and number(s), if available; . + + + + + + + + + critical + + + en + Critical + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#critical + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Critical + + + + + en + critical + + + BOOLEAN + + + en + A flag, if the material is a critical raw material. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I: +(h) use or content of recycled materials and recovery of materials, including critical raw materials; +In Annex II of the connected proposal Act of Critical Raw Materials, a list of critical raw materials can be found. + + + + + + + + + concentration + + + en + Concentration + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#concentration + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Concentration + + + + + en + concentration + + + REAL_MEASURE + + + en + Concentration of the material at the level of the product. This attribute is specially mentioned for substances of concern mentioned in the ESPR proposal from March 30th, 2022 Article 7: +(5) (c) the concentration, maximum concentration or concentration range of the substances of concern, at the level of the product [...]. +Other substances are mentioned for the purpose of recycling in the ESPR provisional agreement from January 9th, 2024 Annex I: +(d) design for recycling, ease and quality of recycling as expressed through: use of easily recyclable materials, safe, easy and non-destructive access to recyclable components and materials or components and materials containing hazardous substances and material composition and homogeneity, possibility for high-purity sorting, number of materials and components used, use of standard components, use of component and material coding standards for the identification of components and materials, number and complexity of processes and tools needed, ease of nondestructive disassembly and re-assembly, conditions for access to product data, conditions for access to or use of hardware and software needed. + + + + + + + + + + content + + + en + Content + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Content + + + + + en + content + + + STRING + + + en + The content of the document e.g a link. + + + + + + + + + contentType + + + en + Content Type + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Content Type + + + + + en + contentType + + + STRING + + + en + The type of content which can be expected in the "content" property. Examples are a link, restricted link, pdf, excel, etc. + + + + + + + + + header + + + en + Header + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Header + + + + + en + header + + + STRING + + + en + The header as a short description of the document with a maximum of 100 characters. + + + + + + + + + documentation + + + en + Documentation + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#documentation + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Documentation + + + + + en + documentation + + + STRING + + + en + Documentation accompanying the material. + + + + + + + + + chemicalMaterial + + + en + Material + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#chemicalMaterial + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Material + + + + + en + chemicalMaterial + + + STRING + + + en + Information on different materials in the product. + + + + + + + + + materialComposition + + + en + Material Composition + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#materialComposition + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Material Composition + + + + + en + materialComposition + + + STRING + + + en + Material composition of the product with information on recycled and renewable materials. + + + + + + + + + materials + + + en + Materials + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#materials + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Materials + + + + + en + materials + + + STRING + + + en + Properties which are relevant for the materials of the product. + + + + + + + + + state + + + en + State + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#state + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + State + + + + + en + state + + + STRING + + + en + The status of the product (original, repurposed, re-used, remanufactured or waste) to indicated, whether it is a used product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Annex I: +(j) incorporation of used components. + + + + + + original + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#StateEnumeration:original + + + + + + repurposed + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#StateEnumeration:repurposed + + + + + + re-used + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#StateEnumeration:re-used + + + + + + remanufactured + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#StateEnumeration:remanufactured + + + + + + waste + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#StateEnumeration:waste + + + + + + + + + + + + + footprintValue + + + en + Footprint Value + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#footprintValue + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Footprint Value + + + + + en + footprintValue + + + REAL_MEASURE + + + en + The value of the footprint of the product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Annex I: +(l) the environmental footprint of the product, expressed as a quantification, in accordance with the applicable delegated act, of a product's life cycle environmental impacts, whether in relation to one or more environmental impact categories or an aggregated set of impact categories; +(m) the carbon footprint of the product; +(ma) the material footprint of the product. + + + + + + + + + + content + + + en + Content + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Content + + + + + en + content + + + STRING + + + en + The content of the document e.g a link. + + + + + + + + + contentType + + + en + Content Type + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Content Type + + + + + en + contentType + + + STRING + + + en + The type of content which can be expected in the "content" property. Examples are a link, restricted link, pdf, excel, etc. + + + + + + + + + header + + + en + Header + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Header + + + + + en + header + + + STRING + + + en + The header as a short description of the document with a maximum of 100 characters. + + + + + + + + + footprintRulebook + + + en + Footprint Rulebook + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#footprintRulebook + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Footprint Rulebook + + + + + en + footprintRulebook + + + STRING + + + en + The applied rulebook for the environmental footprint of the product. + + + + + + + + + footprintLifecycle + + + en + Footprint Lifecycle + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#footprintLifecycle + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Footprint Lifecycle + + + + + en + footprintLifecycle + + + STRING + + + en + The lifecycle stage, to which the environmental footprint corresponds. These could be for example "raw material acquisition and pre-processing", "main product production", "distribution" or "end of life and recycling". + + + + + + + + + footprintUnit + + + en + Footprint Unit + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#footprintUnit + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Footprint Unit + + + + + en + footprintUnit + + + STRING + + + en + The unit of measurement of the environmental impact category. For each impact category a specific unit is used. If an aggregation is used, utilize the normalization and weighting methods used in the referenced rulebook. + + + + + + + + + footprintType + + + en + Footprint Type + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#footprintType + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Footprint Type + + + + + en + footprintType + + + STRING + + + en + The type of the environmental footprint of the product. This could be one of the environmental impact categories. This attribute is mentioned in the ESPR provisional agreement from January 9th 2024 Article 7: +(2)(b)(i) information on the performance of the product in relation to one or more of the product parameters referred to in Annex I, including a scoring of reparability or durability, carbon footprint or environmental footprint; +Annex I: +(l) the environmental footprint of the product, expressed as a quantification, in accordance with the applicable delegated act, of a product's life cycle environmental impacts, whether in relation to one or more environmental impact categories or an aggregated set of impact categories. +(m) the carbon footprint of the product; +(ma) the material footprint of the product. + + + + + + Climate Change Total + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#CategoryEnumeration:Climate Change Total + + + + + + Climate Change Fossil + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#CategoryEnumeration:Climate Change Fossil + + + + + + Climate Change Biogenic Removals and Emissions + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#CategoryEnumeration:Climate Change Biogenic Removals and Emissions + + + + + + Climate Change Land Use and Land Use Change + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#CategoryEnumeration:Climate Change Land Use and Land Use Change + + + + + + Ozone Depletion + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#CategoryEnumeration:Ozone Depletion + + + + + + Acidification + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#CategoryEnumeration:Acidification + + + + + + Eutrophication Aquatic Freshwater + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#CategoryEnumeration:Eutrophication Aquatic Freshwater + + + + + + Eutrophication Fresh Marine + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#CategoryEnumeration:Eutrophication Fresh Marine + + + + + + Eutrophication Terrestrial + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#CategoryEnumeration:Eutrophication Terrestrial + + + + + + Photochemical Ozone Formation + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#CategoryEnumeration:Photochemical Ozone Formation + + + + + + Abiotic Depletion- Minerals and Metals + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#CategoryEnumeration:Abiotic Depletion- Minerals and Metals + + + + + + Fossil Fuels + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#CategoryEnumeration:Fossil Fuels + + + + + + Water Use + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#CategoryEnumeration:Water Use + + + + + + Particulate Matter Emissions + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#CategoryEnumeration:Particulate Matter Emissions + + + + + + Ionizing Radiation, Human Health + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#CategoryEnumeration:Ionizing Radiation, Human Health + + + + + + Eco-Toxicity + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#CategoryEnumeration:Eco-Toxicity + + + + + + Human Toxicity, Cancer Effects + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#CategoryEnumeration:Human Toxicity, Cancer Effects + + + + + + Human Toxicity, Non-Cancer Effects + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#CategoryEnumeration:Human Toxicity, Non-Cancer Effects + + + + + + Land Use Related Impacts/Soil Quality + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#CategoryEnumeration:Land Use Related Impacts/Soil Quality + + + + + + + + + + + + + performanceClass + + + en + Performance Class + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#performanceClass + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Performance Class + + + + + en + performanceClass + + + STRING + + + en + The performance classification of the footprint. + + + + + + + + + facility + + + en + Facility + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#facility + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Facility + + + + + en + facility + + + STRING + + + en + The identifier used for a location. This attribute is mentioned in the ESPR provisional agreement from January 9th 2024 Annex III: +(i) unique facility identifiers; +Article 2 Definitions: (33) 'unique facility identifier' means a unique string of characters for the identification of locations or buildings involved in the value chain of a product or used by actors involved in the value chain of a product. + + + + + + + + + manufacturingPlant + + + en + Manufacturing Plant + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#manufacturingPlant + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Manufacturing Plant + + + + + en + manufacturingPlant + + + STRING + + + en + The manufacturing plant of the footprint in the specific lifecycle phase. + + + + + + + + + content + + + en + Content + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Content + + + + + en + content + + + STRING + + + en + The content of the document e.g a link. + + + + + + + + + contentType + + + en + Content Type + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Content Type + + + + + en + contentType + + + STRING + + + en + The type of content which can be expected in the "content" property. Examples are a link, restricted link, pdf, excel, etc. + + + + + + + + + header + + + en + Header + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Header + + + + + en + header + + + STRING + + + en + The header as a short description of the document with a maximum of 100 characters. + + + + + + + + + declaration + + + en + Declaration + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#declaration + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Declaration + + + + + en + declaration + + + STRING + + + en + The footprint declaration in the format of a link + + + + + + + + + environmentalFootprint + + + en + Environmental Footprint + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#environmentalFootprint + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Environmental Footprint + + + + + en + environmentalFootprint + + + STRING + + + en + The environmental footprint of the product. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I: +The following parameters shall, as appropriate, and where necessary supplemented by others, be used, individually or combined, as a basis for improving the product aspects referred to in Article 5(1): +(l) the environmental footprint of the product, expressed as a quantification, in accordance with the applicable delegated act, of a product's life cycle environmental impacts, whether in relation to one or more environmental impact categories or an aggregated set of impact categories. +and Article 7: +(2)(b)(i) information on the performance of the product in relation to one or more of the product parameters referred to in Annex I, including a scoring of reparability or durability, carbon footprint or environmental footprint; +and defined by Article 2: +(23) 'environmental footprint' means a quantification of product environmental impacts throughout its life cycle, whether in relation to a single environmental impact category or an aggregated set of impact categories based on the Product Environmental Footprint method or other scientific methods developed by international organisations and widely tested in collaboration with different industry sectors and adopted or implemented by the Commission in other Union legislation; +(24) 'Product Environmental Footprint method' means the life cycle assessment method to quantify the environmental impacts of products established by Recommendation (EU) 2021/2279. + + + + + + + + + footprintValue + + + en + Footprint Value + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#footprintValue + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Footprint Value + + + + + en + footprintValue + + + REAL_MEASURE + + + en + The value of the footprint of the product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Annex I: +(l) the environmental footprint of the product, expressed as a quantification, in accordance with the applicable delegated act, of a product's life cycle environmental impacts, whether in relation to one or more environmental impact categories or an aggregated set of impact categories; +(m) the carbon footprint of the product; +(ma) the material footprint of the product. + + + + + + + + + + content + + + en + Content + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Content + + + + + en + content + + + STRING + + + en + The content of the document e.g a link. + + + + + + + + + contentType + + + en + Content Type + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Content Type + + + + + en + contentType + + + STRING + + + en + The type of content which can be expected in the "content" property. Examples are a link, restricted link, pdf, excel, etc. + + + + + + + + + header + + + en + Header + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Header + + + + + en + header + + + STRING + + + en + The header as a short description of the document with a maximum of 100 characters. + + + + + + + + + footprintRulebook + + + en + Footprint Rulebook + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#footprintRulebook + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Footprint Rulebook + + + + + en + footprintRulebook + + + STRING + + + en + The applied rulebook for the environmental footprint of the product. + + + + + + + + + footprintLifecycle + + + en + Footprint Lifecycle + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#footprintLifecycle + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Footprint Lifecycle + + + + + en + footprintLifecycle + + + STRING + + + en + The lifecycle stage, to which the environmental footprint corresponds. These could be for example "raw material acquisition and pre-processing", "main product production", "distribution" or "end of life and recycling". + + + + + + + + + footprintUnit + + + en + Footprint Unit + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#footprintUnit + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Footprint Unit + + + + + en + footprintUnit + + + STRING + + + en + The unit of measurement of the environmental impact category. For each impact category a specific unit is used. If an aggregation is used, utilize the normalization and weighting methods used in the referenced rulebook. + + + + + + + + + footprintType + + + en + Footprint Type + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#footprintType + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Footprint Type + + + + + en + footprintType + + + STRING + + + en + The type of the environmental footprint of the product. This could be one of the environmental impact categories. This attribute is mentioned in the ESPR provisional agreement from January 9th 2024 Article 7: +(2)(b)(i) information on the performance of the product in relation to one or more of the product parameters referred to in Annex I, including a scoring of reparability or durability, carbon footprint or environmental footprint; +Annex I: +(l) the environmental footprint of the product, expressed as a quantification, in accordance with the applicable delegated act, of a product's life cycle environmental impacts, whether in relation to one or more environmental impact categories or an aggregated set of impact categories. +(m) the carbon footprint of the product; +(ma) the material footprint of the product. + + + + + + + + + performanceClass + + + en + Performance Class + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#performanceClass + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Performance Class + + + + + en + performanceClass + + + STRING + + + en + The performance classification of the footprint. + + + + + + + + + facility + + + en + Facility + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#facility + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Facility + + + + + en + facility + + + STRING + + + en + The identifier used for a location. This attribute is mentioned in the ESPR provisional agreement from January 9th 2024 Annex III: +(i) unique facility identifiers; +Article 2 Definitions: (33) 'unique facility identifier' means a unique string of characters for the identification of locations or buildings involved in the value chain of a product or used by actors involved in the value chain of a product. + + + + + + + + + manufacturingPlant + + + en + Manufacturing Plant + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#manufacturingPlant + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Manufacturing Plant + + + + + en + manufacturingPlant + + + STRING + + + en + The manufacturing plant of the footprint in the specific lifecycle phase. + + + + + + + + + content + + + en + Content + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Content + + + + + en + content + + + STRING + + + en + The content of the document e.g a link. + + + + + + + + + contentType + + + en + Content Type + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Content Type + + + + + en + contentType + + + STRING + + + en + The type of content which can be expected in the "content" property. Examples are a link, restricted link, pdf, excel, etc. + + + + + + + + + header + + + en + Header + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Header + + + + + en + header + + + STRING + + + en + The header as a short description of the document with a maximum of 100 characters. + + + + + + + + + declaration + + + en + Declaration + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#declaration + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Declaration + + + + + en + declaration + + + STRING + + + en + The footprint declaration in the format of a link + + + + + + + + + carbonFootprint + + + en + Carbon Footprint + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#carbonFootprint + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Carbon Footprint + + + + + en + carbonFootprint + + + STRING + + + en + The carbon footprint of the product. This is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I: +The following parameters shall, as appropriate, and where necessary supplemented by others, be used, individually or combined, as a basis for improving the product aspects referred to in Article 5(1): +(m) the carbon footprint of the product; +and Article 7: +(2)(b)(i) information on the performance of the product in relation to one or more of the product parameters referred to in Annex I, including a scoring of reparability or durability, carbon footprint or environmental footprint; +and defined by Article 2: +(25) 'carbon footprint' means the sum of greenhouse gas (GHG) emissions and GHG removals in a product system, expressed as CO2 equivalents and based on a life cycle assessment using the single impact category of climate change. + + + + + + + + + footprintValue + + + en + Footprint Value + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#footprintValue + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Footprint Value + + + + + en + footprintValue + + + REAL_MEASURE + + + en + The value of the footprint of the product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Annex I: +(l) the environmental footprint of the product, expressed as a quantification, in accordance with the applicable delegated act, of a product's life cycle environmental impacts, whether in relation to one or more environmental impact categories or an aggregated set of impact categories; +(m) the carbon footprint of the product; +(ma) the material footprint of the product. + + + + + + + + + + content + + + en + Content + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Content + + + + + en + content + + + STRING + + + en + The content of the document e.g a link. + + + + + + + + + contentType + + + en + Content Type + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Content Type + + + + + en + contentType + + + STRING + + + en + The type of content which can be expected in the "content" property. Examples are a link, restricted link, pdf, excel, etc. + + + + + + + + + header + + + en + Header + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Header + + + + + en + header + + + STRING + + + en + The header as a short description of the document with a maximum of 100 characters. + + + + + + + + + footprintRulebook + + + en + Footprint Rulebook + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#footprintRulebook + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Footprint Rulebook + + + + + en + footprintRulebook + + + STRING + + + en + The applied rulebook for the environmental footprint of the product. + + + + + + + + + footprintLifecycle + + + en + Footprint Lifecycle + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#footprintLifecycle + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Footprint Lifecycle + + + + + en + footprintLifecycle + + + STRING + + + en + The lifecycle stage, to which the environmental footprint corresponds. These could be for example "raw material acquisition and pre-processing", "main product production", "distribution" or "end of life and recycling". + + + + + + + + + footprintUnit + + + en + Footprint Unit + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#footprintUnit + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Footprint Unit + + + + + en + footprintUnit + + + STRING + + + en + The unit of measurement of the environmental impact category. For each impact category a specific unit is used. If an aggregation is used, utilize the normalization and weighting methods used in the referenced rulebook. + + + + + + + + + footprintType + + + en + Footprint Type + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#footprintType + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Footprint Type + + + + + en + footprintType + + + STRING + + + en + The type of the environmental footprint of the product. This could be one of the environmental impact categories. This attribute is mentioned in the ESPR provisional agreement from January 9th 2024 Article 7: +(2)(b)(i) information on the performance of the product in relation to one or more of the product parameters referred to in Annex I, including a scoring of reparability or durability, carbon footprint or environmental footprint; +Annex I: +(l) the environmental footprint of the product, expressed as a quantification, in accordance with the applicable delegated act, of a product's life cycle environmental impacts, whether in relation to one or more environmental impact categories or an aggregated set of impact categories. +(m) the carbon footprint of the product; +(ma) the material footprint of the product. + + + + + + + + + performanceClass + + + en + Performance Class + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#performanceClass + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Performance Class + + + + + en + performanceClass + + + STRING + + + en + The performance classification of the footprint. + + + + + + + + + facility + + + en + Facility + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#facility + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Facility + + + + + en + facility + + + STRING + + + en + The identifier used for a location. This attribute is mentioned in the ESPR provisional agreement from January 9th 2024 Annex III: +(i) unique facility identifiers; +Article 2 Definitions: (33) 'unique facility identifier' means a unique string of characters for the identification of locations or buildings involved in the value chain of a product or used by actors involved in the value chain of a product. + + + + + + + + + manufacturingPlant + + + en + Manufacturing Plant + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#manufacturingPlant + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Manufacturing Plant + + + + + en + manufacturingPlant + + + STRING + + + en + The manufacturing plant of the footprint in the specific lifecycle phase. + + + + + + + + + content + + + en + Content + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Content + + + + + en + content + + + STRING + + + en + The content of the document e.g a link. + + + + + + + + + contentType + + + en + Content Type + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Content Type + + + + + en + contentType + + + STRING + + + en + The type of content which can be expected in the "content" property. Examples are a link, restricted link, pdf, excel, etc. + + + + + + + + + header + + + en + Header + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Header + + + + + en + header + + + STRING + + + en + The header as a short description of the document with a maximum of 100 characters. + + + + + + + + + declaration + + + en + Declaration + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#declaration + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Declaration + + + + + en + declaration + + + STRING + + + en + The footprint declaration in the format of a link + + + + + + + + + materialFootprint + + + en + Material Footprint + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#materialFootprint + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Material Footprint + + + + + en + materialFootprint + + + STRING + + + en + The material footprint of the product. This is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I: +(ma) the material footprint of the product; +and defined by Article 2: +(25a) 'material footprint' refers to the total amount of raw materials extracted to meet final consumption demands. + + + + + + + + + productFootprint + + + en + Product Footprint + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#productFootprint + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Product Footprint + + + + + en + productFootprint + + + STRING + + + en + The carbon and environmental footprint or material footprint of the product. These attributes are mentioned in the ESPR provisional agreement from January 9th 2024 Annex I: +(l) the environmental footprint of the product, expressed as a quantification, in accordance with the applicable delegated act, of a product's life cycle environmental impacts, whether in relation to one or more environmental impact categories or an aggregated set of impact categories; +(m) the carbon footprint of the product; +(ma) the material footprint of the product; +All are defined by Article 2: +(23) 'environmental footprint' means a quantification of product environmental impacts throughout its life cycle, whether in relation to a single environmental impact category or an aggregated set of impact categories based on the Product Environmental Footprint method or other scientific methods developed by international organisations and widely tested in collaboration with different industry sectors and adopted or implemented by the Commission in other Union +legislation; +(25) 'carbon footprint' means the sum of greenhouse gas (GHG) emissions and GHG removals in a product system, expressed as CO2 equivalents and based on a life cycle assessment using the single impact category of climate change. +(25a) 'material footprint' refers to the total amount of raw materials extracted to meet final consumption demands; + + + + + + + + + reparabilityScore + + + en + Reparability Score + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#reparabilityScore + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Reparability Score + + + + + en + reparabilityScore + + + STRING + + + en + The reparability score. This attribute is mentioned ESPR provisional agreement from January 9th, 2024 Article 7: +(b) as appropriate, also require products to be accompanied by: +(i) information on the performance of the product in relation to one or more of the product parameters referred to in Annex I, including a scoring of reparability or durability [...]. + + + + + + + + + durabilityScore + + + en + Durability Score + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#durabilityScore + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Durability Score + + + + + en + durabilityScore + + + STRING + + + en + The durability score. This attribute is mentioned ESPR provisional agreement from January 9th, 2024 Article 7: +(b) as appropriate, also require products to be accompanied by: +(i) information on the performance of the product in relation to one or more of the product parameters referred to in Annex I, including a scoring of reparability or durability [...]. + + + + + + + + + sustainability + + + en + Sustainability + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#sustainability + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Sustainability + + + + + en + sustainability + + + STRING + + + en + Sustainability related attributes. + + + + + + + + + content + + + en + Content + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#content + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Content + + + + + en + content + + + STRING + + + en + The content of the document e.g a link. + + + + + + + + + category + + + en + Category + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#category + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Category + + + + + en + category + + + STRING + + + en + The category in which the document can be sorted. These are mentioned in the ESPR proposal from March 30th, 2022 ANNEX III: +(e) compliance documentation and information required under this Regulation or other Union law applicable to the product, such as the declaration of conformity, technical documentation or conformity certificates; +ANNEX IV states additional information regarding the content of the technical documentation +Further information on documents are mentioned in the proposal from March 30th, 2022 ANNEX III: +(f) user manuals, instructions, warnings or safety information, as required by other Union legislation applicable to the product. +Additionally requirements are mentioned in Article 21: +(7) Manufacturers shall ensure that that a product covered by a delegated act adopted pursuant to Article 4 is accompanied by instructions that enable consumers and other end-users to safely assemble, install, operate, store, maintain, repair and dispose of the product in a language that can be easily understood by consumers and other end-users, as determined by the Member State concerned. Such instructions shall be clear, understandable and legible and include at least the information specified in the delegated acts adopted pursuant to Article 4 and pursuant to Article 7(2)(b), point (ii). +Article 7 states additionally: +(2) (b) (ii) information for consumers and other end-users on how to install, use, maintain and repair the product in order to minimize its impact on the environment and to ensure optimum durability, as well as on how to return or dispose of the product at end-of-life; +(2) (b) (iii) information for treatment facilities on disassembly, recycling, or disposal at end-of-life; +(2) (b) (iv) other information that may influence the way the product is handled by parties other than the manufacturer in order to improve performance in relation to product parameters referred to in Annex I. +(5) (d) relevant instructions for the safe use of the product. + + + + + + Product Specifications + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#SourceCategoryEnumeration:Product Specifications + + + + + + Manufacturer Information + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#SourceCategoryEnumeration:Manufacturer Information + + + + + + User Manuals and Guides + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#SourceCategoryEnumeration:User Manuals and Guides + + + + + + Certifications and Compliance + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#SourceCategoryEnumeration:Certifications and Compliance + + + + + + Product Images and Videos + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#SourceCategoryEnumeration:Product Images and Videos + + + + + + Warranty Information + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#SourceCategoryEnumeration:Warranty Information + + + + + + Reviews and Ratings + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#SourceCategoryEnumeration:Reviews and Ratings + + + + + + Product Variations + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#SourceCategoryEnumeration:Product Variations + + + + + + Supply Chain Information + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#SourceCategoryEnumeration:Supply Chain Information + + + + + + Environmental Impact + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#SourceCategoryEnumeration:Environmental Impact + + + + + + Compatibility and Accessories + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#SourceCategoryEnumeration:Compatibility and Accessories + + + + + + FAQs and Support + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#SourceCategoryEnumeration:FAQs and Support + + + + + + Purchase and Retail Information + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#SourceCategoryEnumeration:Purchase and Retail Information + + + + + + Privacy and Data Handling + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#SourceCategoryEnumeration:Privacy and Data Handling + + + + + + Third-Party Integrations + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#SourceCategoryEnumeration:Third-Party Integrations + + + + + + Legal Information + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#SourceCategoryEnumeration:Legal Information + + + + + + Safety Information + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#SourceCategoryEnumeration:Safety Information + + + + + + Repair and Installation + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#SourceCategoryEnumeration:Repair and Installation + + + + + + Waste Generation and Prevention + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#SourceCategoryEnumeration:Waste Generation and Prevention + + + + + + Specific Voluntary Labels + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#SourceCategoryEnumeration:Specific Voluntary Labels + + + + + + Product Packaging + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#SourceCategoryEnumeration:Product Packaging + + + + + + Return and Disposal + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#SourceCategoryEnumeration:Return and Disposal + + + + + + End of Life + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#SourceCategoryEnumeration:End of Life + + + + + + Material and Substance Information + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#SourceCategoryEnumeration:Material and Substance Information + + + + + + Technical Documentation + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#SourceCategoryEnumeration:Technical Documentation + + + + + + Treatment facilities + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#SourceCategoryEnumeration:Treatment facilities + + + + + + Other + + ModelReference + + + DataElement + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#SourceCategoryEnumeration:Other + + + + + + + + + + + + + contentType + + + en + Content Type + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#contentType + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Content Type + + + + + en + contentType + + + STRING + + + en + The type of content which can be expected in the "content" property. Examples are a link, restricted link, pdf, excel, etc. + + + + + + + + + header + + + en + Header + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#header + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Header + + + + + en + header + + + STRING + + + en + The header as a short description of the document with a maximum of 100 characters. + + + + + + + + + sources + + + en + Sources + + + urn:samm:io.catenax.generic.digital_product_passport:5.0.0#sources + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Sources + + + + + en + sources + + + STRING + + + en + Documents that are mandatory if applicable for the product. These are mentioned in the ESPR provisional agreement from January 9th, 2024 ANNEX III: +(e) compliance documentation and information required under this Regulation or other Union law applicable to the product, such as the declaration of conformity, technical documentation or conformity certificates; +(f) user manuals, instructions, warnings or safety information, as required by other Union legislation applicable to the product. +Additionally requirements are mentioned in Article 21: +7. Manufacturers shall ensure that a product covered by a delegated act adopted pursuant to Article 4 is accompanied by instructions in digital format that enable customers and other relevant actors to assemble, install, operate, store, maintain, repair and dispose of the product in a language that can be easily understood, as determined by the Member State concerned. Such instructions shall be clear, understandable and legible and include at least the information set out in Article 7(2), point (b), point (ii) specified in the delegated acts adopted pursuant to Article 4. +Article 7 states additionally: +(ii) information for customers and other actors on how to install, use, maintain and repair the product, in order to minimise its impact on the environment and to ensure optimum durability, on how to install third-party operating systems where relevant, as well as on collection for refurbishment or remanufacture, and on how to return or handle the product at the end of its life; +(2) (b) (iii) information for treatment facilities on disassembly, reuse, refurbishment, recycling, or disposal at end-of-life; +(2) (b) (iv) other information that may influence sustainable product choices for customers and the way the product is handled by parties other than the manufacturer in order to facilitate appropriate use, value retaining operations and correct treatment at end-of-life. +(5) (d) relevant instructions for the safe use of the product. +(5) (e) information relevant for disassembly, preparation for reuse, reuse, recycling and the environmentally sound management of the product at the end of its life. +Annex I: +(b) [...] availability of repair and maintenance instructions, number of materials and components used, use of standard components,[...] number and complexity of processes and whether specialised toolsare needed, ease of non-destructive disassembly and re-assembly, conditions for access to product data, conditions for access to or use of hardware and software needed; +(c) ease of upgrading, re-use, remanufacturing and refurbishment as expressed through: [...] number and complexity of processes and tools needed, ease of non-destructive disassembly and re-assembly, conditions for access to product data, conditions for access to or use of hardware and software needed, conditions of access to test protocols or not commonly available testing equipment, availability of guarantees specific to remanufactured or refurbished products, conditions for access to or use of technologies protected by intellectual property rights, modularity; +(d) design for recycling, ease and quality of recycling as expressed through: use of easily recyclable materials, safe, easy and non-destructive access to recyclable components and materials or components and materials containing hazardous substances and material composition and homogeneity, possibility for high-purity sorting, [...] number and complexity of processes and tools needed, ease of nondestructive disassembly and re-assembly, conditions for access to product data, conditions for access to or use of hardware and software needed; +(q) functional performance and conditions for use including as expressed through ability in performing its intended use, precautions of use, skills required, compatibility with other products or systems. +Additionally to consider are guidelines and instructions regarding the proper management and disposal of packaging materials after use. This can include instructions for separation, reuse, and recycling. + + + + + + + + + productGenericParameters + + + en + Product Generic Parameters + + + urn:samm:io.catenax.transmission.transmission_pass:3.0.0#productGenericParameters + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Product Generic Parameters + + + + + en + productGenericParameters + + + STRING + + + en + The product generic parameters. These are defined by the Digital Product Passport proposal from the ESPR. The main basis is provided by the document "Proposal for a REGULATION OF THE EUROPEAN PARLIAMENT AND OF THE COUNCIL establishing a framework for setting ecodesign requirements for sustainable products and repealing Directive 2009/125/EC" from March 30th, 2022. The latest version of the document was the provisional agreement between the EU Council and the Parliament from January 9th, 2024. + + + + + + + + + diff --git a/io.catenax.transmission.transmission_pass/3.0.0/gen/TransmissionPass-schema.json b/io.catenax.transmission.transmission_pass/3.0.0/gen/TransmissionPass-schema.json new file mode 100644 index 000000000..290be74ff --- /dev/null +++ b/io.catenax.transmission.transmission_pass/3.0.0/gen/TransmissionPass-schema.json @@ -0,0 +1,1293 @@ +{ + "$schema" : "http://json-schema.org/draft-04/schema", + "description" : "The transmission passport corresponds to the digital product passport information required by the proposed Ecodesign Regulation (ESPR-2022) and describes the data that is collected and available during the lifespan of a transmission.", + "type" : "object", + "components" : { + "schemas" : { + "urn_samm_io.catenax.transmission.transmission_pass_3.0.0_DriveTypeTrait" : { + "description" : "Constraint to only allow combustion, full hybrid, mild hybrid, plug-in hybrid, fuel-cell or battery.\n", + "type" : "array", + "items" : { + "type" : "string" + }, + "pattern" : "(combustion|full hybrid|mild hybrid|plug-in hybrid|fuel-cell|battery)" + }, + "urn_samm_io.catenax.transmission.transmission_pass_3.0.0_TorqueNewtonMetre" : { + "type" : "number", + "minimum" : 0, + "description" : "Characteristic to describe torque in newton meters." + }, + "urn_samm_io.catenax.transmission.transmission_pass_3.0.0_KilowattMeasurement" : { + "type" : "number", + "minimum" : 0, + "description" : "The performance power in kilowatt as non-negative integer." + }, + "urn_samm_io.catenax.transmission.transmission_pass_3.0.0_StringList" : { + "description" : "A list with the data types string.", + "type" : "array", + "items" : { + "type" : "string" + } + }, + "urn_samm_io.catenax.transmission.transmission_pass_3.0.0_GearTrait" : { + "type" : "string", + "description" : "Constraint to match a gear from 1 to 18 or R (reverse).", + "pattern" : "^(1[0-8]|[1-9]|R)$" + }, + "urn_samm_io.catenax.transmission.transmission_pass_3.0.0_RevolutionsPerMinute" : { + "type" : "number", + "minimum" : 0, + "description" : "The permissible maximum input speed in revolutions per minute in the respective gear." + }, + "urn_samm_io.catenax.transmission.transmission_pass_3.0.0_SpeedResistanceEntity" : { + "description" : "The speed resistance entity. Includes the gear and the speed as separate properties.", + "type" : "object", + "properties" : { + "gear" : { + "description" : "Respective gear for the measurement.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.transmission.transmission_pass_3.0.0_GearTrait" + }, + "ratedSpeed" : { + "description" : "The permissible maximum input speed in the respective gear (depending on the transmission type) in 1/min.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.transmission.transmission_pass_3.0.0_RevolutionsPerMinute" + } + }, + "required" : [ "gear", "ratedSpeed" ] + }, + "urn_samm_io.catenax.transmission.transmission_pass_3.0.0_SpeedResistanceList" : { + "description" : "The speed resistance characteristic.", + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/urn_samm_io.catenax.transmission.transmission_pass_3.0.0_SpeedResistanceEntity" + } + }, + "urn_samm_io.catenax.transmission.transmission_pass_3.0.0_Ratio" : { + "type" : "number", + "description" : "The ratio in the respective gear." + }, + "urn_samm_io.catenax.transmission.transmission_pass_3.0.0_GearRatioEntity" : { + "description" : "Entity for the ratio in the respective gear. Includes the gear and the ratio as separate properties.", + "type" : "object", + "properties" : { + "gear" : { + "description" : "Respective gear for the measurement.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.transmission.transmission_pass_3.0.0_GearTrait" + }, + "gearRatio" : { + "description" : "The ratio in the respective gear (ratio between transmission input speed and transmission output speed).", + "$ref" : "#/components/schemas/urn_samm_io.catenax.transmission.transmission_pass_3.0.0_Ratio" + } + }, + "required" : [ "gear", "gearRatio" ] + }, + "urn_samm_io.catenax.transmission.transmission_pass_3.0.0_StandardGearRatioSet" : { + "description" : "The set of ratio in the respective gear.", + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/urn_samm_io.catenax.transmission.transmission_pass_3.0.0_GearRatioEntity" + }, + "uniqueItems" : true + }, + "urn_samm_io.catenax.transmission.transmission_pass_3.0.0_Capacity" : { + "type" : "number", + "description" : "The oil capacity in dm³." + }, + "urn_samm_io.catenax.transmission.transmission_pass_3.0.0_OilCharacteristic" : { + "description" : "Characteristic for the oil.", + "type" : "object", + "properties" : { + "oilCapacity" : { + "description" : "The defined oil volume in the transmission in cubic decimeters.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.transmission.transmission_pass_3.0.0_Capacity" + }, + "oilType" : { + "description" : "The type of the oil for the transmission defined by the manufacturer of the transmission.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.transmission.transmission_pass_3.0.0_StringList" + } + }, + "required" : [ "oilCapacity", "oilType" ] + }, + "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.transmission.transmission_pass_3.0.0_TimeMeasurement" : { + "type" : "number", + "minimum" : 0, + "description" : "Time in seconds." + }, + "urn_samm_io.catenax.transmission.transmission_pass_3.0.0_MachineTorqueCharacteristic" : { + "description" : "The electrical machine torque.", + "type" : "object", + "properties" : { + "max" : { + "description" : "The maximum output torque in newton meters for a specified time period.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.transmission.transmission_pass_3.0.0_TorqueNewtonMetre" + }, + "maximumAvailability" : { + "description" : "Specified time period for the peak measurement in seconds.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.transmission.transmission_pass_3.0.0_TimeMeasurement" + }, + "continuous" : { + "description" : "The torque that can be delivered without time limit in newton meters.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.transmission.transmission_pass_3.0.0_TorqueNewtonMetre" + } + }, + "required" : [ "max", "maximumAvailability", "continuous" ] + }, + "urn_samm_io.catenax.transmission.transmission_pass_3.0.0_MachinePowerCharacteristic" : { + "description" : "The electrical machine power.", + "type" : "object", + "properties" : { + "max" : { + "description" : "The maximum output power in kilowatts for a specified time period.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.transmission.transmission_pass_3.0.0_KilowattMeasurement" + }, + "continuous" : { + "description" : "The power that can be delivered without time limit.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.transmission.transmission_pass_3.0.0_KilowattMeasurement" + }, + "maximumAvailability" : { + "description" : "Specified time period for the peak measurement in seconds.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.transmission.transmission_pass_3.0.0_TimeMeasurement" + } + }, + "required" : [ "max", "continuous", "maximumAvailability" ] + }, + "urn_samm_io.catenax.transmission.transmission_pass_3.0.0_VoltageMeasurement" : { + "type" : "number", + "description" : "Measurement in voltage." + }, + "urn_samm_io.catenax.transmission.transmission_pass_3.0.0_ElectricalMachineCharacteristic" : { + "description" : "Characteristic for the electrical machine.", + "type" : "object", + "properties" : { + "torque" : { + "description" : "The torque of the electrical machine.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.transmission.transmission_pass_3.0.0_MachineTorqueCharacteristic" + }, + "power" : { + "description" : "The power of the electrical machine.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.transmission.transmission_pass_3.0.0_MachinePowerCharacteristic" + }, + "voltage" : { + "description" : "Nominal voltage of the electric system in volt.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.transmission.transmission_pass_3.0.0_VoltageMeasurement" + }, + "speed" : { + "description" : "Maximum allowable speed for the electric motor in revolutions per minute.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.transmission.transmission_pass_3.0.0_RevolutionsPerMinute" + } + }, + "required" : [ "torque", "power", "voltage", "speed" ] + }, + "urn_samm_io.catenax.transmission.transmission_pass_3.0.0_PerformanceCharacteristic" : { + "description" : "Characteristic for performance related values.", + "type" : "object", + "properties" : { + "applicable" : { + "description" : "If there is a transmission-integrated electrical machine included, select true and state the values in the connected attributes. If there is none, select false and provide dummy data.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Boolean" + }, + "electricalMachine" : { + "description" : "Attributes connected to the transmission-integrated electrical machine, if applicable. Otherwise dummy data (0 or null) can be provided.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.transmission.transmission_pass_3.0.0_ElectricalMachineCharacteristic" + } + }, + "required" : [ "applicable", "electricalMachine" ] + }, + "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.generic.digital_product_passport_5.0.0_HeaderTrait" : { + "type" : "string", + "description" : "Constraint for a maximum of 100 characters.", + "maxLength" : 100 + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentationEntity" : { + "description" : "Entity for a document with a header, type and content.", + "type" : "object", + "properties" : { + "content" : { + "description" : "The content of the document e.g a link.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "contentType" : { + "description" : "The type of content which can be expected in the \"content\" property. Examples are a link, restricted link, pdf, excel, etc.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "header" : { + "description" : "The header as a short description of the document with a maximum of 100 characters.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_HeaderTrait" + } + }, + "required" : [ "content", "contentType", "header" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentList" : { + "description" : "List of documents.", + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentationEntity" + } + }, + "urn_samm_io.catenax.transmission.transmission_pass_3.0.0_SpecificCharacteristic" : { + "description" : "The Characteristic to describe product specific parameters of the transmission.", + "type" : "object", + "properties" : { + "driveType" : { + "description" : "A list of the type of transmission drive. For example combustion, full hybrid, mild hybrid, plug-in hybrid or purely electric drive (battery or fuelcell).", + "$ref" : "#/components/schemas/urn_samm_io.catenax.transmission.transmission_pass_3.0.0_DriveTypeTrait" + }, + "torque" : { + "description" : "The maximum input torque in newton meters (the operating characteristics of the transmission).", + "$ref" : "#/components/schemas/urn_samm_io.catenax.transmission.transmission_pass_3.0.0_TorqueNewtonMetre" + }, + "power" : { + "description" : "The maximum power in kilowatt (the operating characteristics of the transmission).", + "$ref" : "#/components/schemas/urn_samm_io.catenax.transmission.transmission_pass_3.0.0_KilowattMeasurement" + }, + "torqueConverter" : { + "description" : "A list of the used transmission damper technology (depending on the transmission type). For example NW 200 TTD and NW 200 ZDW", + "$ref" : "#/components/schemas/urn_samm_io.catenax.transmission.transmission_pass_3.0.0_StringList" + }, + "speedResistance" : { + "description" : "The permissible maximum input speed in the respective gear depending on the transmission type.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.transmission.transmission_pass_3.0.0_SpeedResistanceList" + }, + "standardGearRatio" : { + "description" : "The ratio in the respective gear (ratio between transmission input speed and transmission output speed). For example 1 : 4.1567; 2 : 3.898; 3 : 2.887; 4 : 2.7783; 5 : 1.811; 6 : 1.6545; 7 : 0.4377; 8 : 0.6121; R : -2.2183.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.transmission.transmission_pass_3.0.0_StandardGearRatioSet" + }, + "spreading" : { + "description" : "The transmission spreading coefficient. The ratio between the smallest (shortest gear) and the largest (longest gear) ratio.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.transmission.transmission_pass_3.0.0_Ratio" + }, + "oil" : { + "description" : "The oil used for the transmission.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.transmission.transmission_pass_3.0.0_OilCharacteristic" + }, + "electricalPerformance" : { + "description" : "Attributes connected to the transmission-integrated electrical machine, if applicable.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.transmission.transmission_pass_3.0.0_PerformanceCharacteristic" + }, + "serviceHistory" : { + "description" : "Documentation of the service history of the transmission.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentList" + } + }, + "required" : [ "driveType", "torque", "power", "standardGearRatio", "spreading", "oil", "electricalPerformance" ] + }, + "urn_samm_io.catenax.transmission.transmission_pass_3.0.0_MonthCharacteristics" : { + "type" : "number", + "minimum" : 0, + "description" : "Measurement in months as an integer." + }, + "urn_samm_io.catenax.transmission.transmission_pass_3.0.0_KilometreCharacteristic" : { + "type" : "number", + "minimum" : 0, + "description" : "Measurement in kilometre as an integer." + }, + "urn_samm_io.catenax.shared.quantity_2.0.0_QuantityValueCharacteristic" : { + "type" : "number", + "description" : "The quantity value associated with the unit expressed as float." + }, + "urn_samm_io.catenax.shared.quantity_2.0.0_LinearUnitEnumeration" : { + "type" : "string", + "pattern" : "[a-zA-Z]*:[a-zA-Z]+", + "description" : "The unit of a linear attribute that may be used for height, width, length and diameter.", + "enum" : [ "unit:millimetre", "unit:centimetre", "unit:metre", "unit:kilometre", "unit:inch", "unit:foot", "unit:yard" ] + }, + "urn_samm_io.catenax.shared.quantity_2.0.0_LinearCharacteristic" : { + "description" : "Characteristic for linear measurements of an item.", + "type" : "object", + "properties" : { + "value" : { + "description" : "The quantity value associated with the unit.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.quantity_2.0.0_QuantityValueCharacteristic" + }, + "unit" : { + "description" : "The unit of a linear attribute.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.quantity_2.0.0_LinearUnitEnumeration" + } + }, + "required" : [ "value", "unit" ] + }, + "urn_samm_io.catenax.shared.quantity_2.0.0_MassUnitEnumeration" : { + "type" : "string", + "pattern" : "[a-zA-Z]*:[a-zA-Z]+", + "description" : "Enumeration for mass units.", + "enum" : [ "unit:gram", "unit:kilogram", "unit:tonneMetricTon", "unit:tonUsOrShortTonUkorus", "unit:ounceAvoirdupois", "unit:pound" ] + }, + "urn_samm_io.catenax.shared.quantity_2.0.0_MassCharacteristic" : { + "description" : "Characteristic for mass measurements of an item.", + "type" : "object", + "properties" : { + "value" : { + "description" : "The quantity value associated with the unit.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.quantity_2.0.0_QuantityValueCharacteristic" + }, + "unit" : { + "description" : "The unit of a mass related attribute.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.quantity_2.0.0_MassUnitEnumeration" + } + }, + "required" : [ "value", "unit" ] + }, + "urn_samm_io.catenax.shared.quantity_2.0.0_VolumeUnitEnumeration" : { + "type" : "string", + "pattern" : "[a-zA-Z]*:[a-zA-Z]+", + "description" : "Enumeration for volume units.", + "enum" : [ "unit:cubicMetre", "unit:litre", "unit:millilitre", "unit:cubicCentimetre", "unit:cubicInch", "unit:cubicFoot", "unit:cubicYard", "unit:hectolitre" ] + }, + "urn_samm_io.catenax.shared.quantity_2.0.0_VolumeCharacteristic" : { + "description" : "Characteristic for volume measurements of an item.", + "type" : "object", + "properties" : { + "value" : { + "description" : "The quantity value associated with the unit.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.quantity_2.0.0_QuantityValueCharacteristic" + }, + "unit" : { + "description" : "The unit of a volume related attribute.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.quantity_2.0.0_VolumeUnitEnumeration" + } + }, + "required" : [ "value", "unit" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PhysicalDimensionCharacteristic" : { + "description" : "Characteristic for physical dimensions with linear, mass and capacity attributes.", + "type" : "object", + "properties" : { + "width" : { + "description" : "The width of the item measured in a specific linear unit which can be declared in the corresponding unit attribute.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.quantity_2.0.0_LinearCharacteristic" + }, + "length" : { + "description" : "The length of the item measured in a specific linear unit which can be declared in the corresponding unit attribute.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.quantity_2.0.0_LinearCharacteristic" + }, + "diameter" : { + "description" : "The diameter of the item, if applicable, measured in a specific linear unit which can be declared in the corresponding unit attribute.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.quantity_2.0.0_LinearCharacteristic" + }, + "height" : { + "description" : "The height of the item measured in a specific linear unit which can be declared in the corresponding unit attribute.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.quantity_2.0.0_LinearCharacteristic" + }, + "grossWeight" : { + "description" : "The gross weight of the item measured in a specific mass unit which can be declared in the corresponding unit attribute. Gross weight refers to the total weight of a product, including the weight of the packaging. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7:\n(2) (b) (i) information on the performance of the product in relation to the product parameters referred to in Annex I;\nAnnex I (i) weight and volume of the product and its packaging, and the product-to-packaging ratio.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.quantity_2.0.0_MassCharacteristic" + }, + "grossVolume" : { + "description" : "The gross volume of the item, if possible, measured in a specific capacity unit which can be declared in the corresponding unit attribute. If there is no separate packing, the volume of the product shall be given. Gross volume refers to the total volume of a product, including the volume of the packaging. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7:\n(2) (b) (i) information on the performance of the product in relation to the product parameters referred to in Annex I;\nAnnex I (i) weight and volume of the product and its packaging, and the product-to-packaging ratio.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.quantity_2.0.0_VolumeCharacteristic" + }, + "weight" : { + "description" : "Weight of the product measured in a specific mass unit which can be declared in the corresponding unit attribute. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7:\n(2) (b) (i) information on the performance of the product in relation to the product parameters referred to in Annex I;\nAnnex I (i) weight and volume of the product [...].", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.quantity_2.0.0_MassCharacteristic" + }, + "volume" : { + "description" : "Volume of the product, if possible, measured in a specific capacity unit which can be declared in the corresponding unit attribute. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7:\n(2) (b) (i) information on the performance of the product in relation to the product parameters referred to in Annex I;\nAnnex I (i) weight and volume of the product [...].", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.quantity_2.0.0_VolumeCharacteristic" + } + }, + "required" : [ "grossWeight", "grossVolume", "weight", "volume" ] + }, + "urn_samm_io.catenax.transmission.transmission_pass_3.0.0_ProductCharacteristics" : { + "description" : "Defines a set of specific characteristics of the transmission.", + "type" : "object", + "properties" : { + "warranty" : { + "description" : "Commercial warranty period of the transmission (coupled to the Vehicle) in months.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.transmission.transmission_pass_3.0.0_MonthCharacteristics" + }, + "lifeTime" : { + "description" : "Expected transmission lifespan in kilometres.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.transmission.transmission_pass_3.0.0_KilometreCharacteristic" + }, + "physicalDimension" : { + "description" : "Physical dimensions are properties associated with physical quantities for purposes of classification or differentiation. These attributes are mentioned in the ESPR provisional agreement from January 9th, Article 7:\n(2) (b) (i) information on the performance of the product in relation to one or more of the product parameters referred to in Annex I;\nAnnex I (i) weight and volume of the product and its packaging, and the product-to-packaging ratio.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PhysicalDimensionCharacteristic" + } + }, + "required" : [ "warranty", "lifeTime", "physicalDimension" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_StatusEnumeration" : { + "type" : "string", + "description" : "The current status of the product passport declared through either: draft, approved, invalid or expired.", + "enum" : [ "draft", "approved", "invalid", "expired" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DateTrait" : { + "type" : "string", + "description" : "Constraint fo a timestamp in the format (yyyy-mm-dd).", + "pattern" : "^\\d{4}-\\d{2}-\\d{2}$" + }, + "urn_samm_io.catenax.shared.business_partner_number_2.0.0_BpnlTrait" : { + "type" : "string", + "description" : "The provided regular expression ensures that the BPNL is composed of prefix 'BPNL', 10 digits and two alphanumeric letters.", + "pattern" : "^BPNL[a-zA-Z0-9]{12}$" + }, + "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_io.catenax.generic.digital_product_passport_5.0.0_IdentifierCharacteristic" : { + "type" : "string", + "description" : "Characteristic for Identifiers." + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_MetadataCharacteristic" : { + "description" : "Characteristic for the passport metadata of the digital product passport.", + "type" : "object", + "properties" : { + "version" : { + "description" : "The current version of the product passport. The possibility of modification/ updating the product passport needs to include versioning of the dataset. This attribute is an internal versioning from the passport issuer. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Article 8:\n(1) [...] The information in the product passport shall be accurate, complete, and up to date.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "status" : { + "description" : "The current status of the product passport declared through either: draft, approved, invalid or expired.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_StatusEnumeration" + }, + "expirationDate" : { + "description" : "The timestamp in the format (yyyy-mm-dd) for the product passport until when it is available or a comment describing this period. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Article 8:\n(2) (h) the period during which the product passport is to remain available, which shall correspond to at least the expected lifetime of a specific product.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DateTrait" + }, + "issueDate" : { + "description" : "The timestamp in the format (yyyy-mm-dd) since when the product passport is available.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DateTrait" + }, + "economicOperatorId" : { + "description" : "The identification of the owner/economic operator of the passport. Proposed, according to ISO 15459, is the CIN (company identification code). Other identification numbers like the tax identification number, value added tax identification number, commercial register number and the like are also valid entries. In the Catena-X network, the BPNL is used for the identification of companies and the information stored like contact information and addresses. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Annex III:\n(k) the [...] unique operator identifier code of the economic operator established in the Union responsible for carrying out the tasks set out in Article 4 of Regulation (EU) 2019/1020, or Article 15 of Regulation (EU) on general product safety, or similar tasks pursuant to other EU legislation applicable to the product.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.business_partner_number_2.0.0_BpnlTrait" + }, + "passportIdentifier" : { + "description" : "The identifier of the product passport, which is an uuidv4.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.uuid_2.0.0_UuidV4Trait" + }, + "predecessor" : { + "description" : "Identification of the preceding product passport. If there is no preceding passport, input a dummy value. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Article 8:\n(2)(g) [...] Any new product passport shall be linked to the product passport or passports of the original product whenever appropriate.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.uuid_2.0.0_UuidV4Trait" + }, + "backupReference" : { + "description" : "A reference to the data backup of the passport. This mandatory attribute will be further defined in the future. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex III:\n(kb) the reference of the certified independent third-party product passport service provider hosting the back-up copy of the product passport.\nArticle 10 also mentions:\n(c) the data included in the product passport shall be stored by the economic operator responsible for its creation or by certified independent third-party product passport service providers authorised to act on their behalf.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "registrationIdentifier" : { + "description" : "Identifier in the respective registry. This will be further defined in the future. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 in Article 12:\nBy [2 years from entering into force of this Regulation], the Commission shall set up and manage a digital registry (\"the registry\") storing in a secure manner at least the unique product identifier, the unique operator identifier, the unique facility identifiers. In case of products intended to be placed under the customs procedure 'release for free circulation', the registry shall also store the product commodity code. The registry shall also store the batteries' unique identifiers referred to in Article 77(3) of Regulation (EU) 2023/1542.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_IdentifierCharacteristic" + }, + "lastModification" : { + "description" : "Date of the latest modification.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DateTrait" + } + }, + "required" : [ "version", "expirationDate", "issueDate", "economicOperatorId", "passportIdentifier", "predecessor", "backupReference" ] + }, + "urn_samm_io.catenax.serial_part_3.0.0_KeyTrait" : { + "type" : "string", + "description" : "Constraint that ensures that the standard keys and custom key prefixes can be used.", + "pattern" : "^(manufacturerId|partInstanceId|batchId|van|customKey:\\w+)$" + }, + "urn_samm_io.catenax.serial_part_3.0.0_ValueCharacteristic" : { + "type" : "string", + "description" : "The value of an identifier." + }, + "urn_samm_io.catenax.serial_part_3.0.0_KeyValueList" : { + "description" : "A list of key value pairs for local identifiers, which are composed of a key and a corresponding value.", + "type" : "object", + "properties" : { + "key" : { + "description" : "The key of a local identifier. ", + "$ref" : "#/components/schemas/urn_samm_io.catenax.serial_part_3.0.0_KeyTrait" + }, + "value" : { + "description" : "The value of an identifier.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.serial_part_3.0.0_ValueCharacteristic" + } + }, + "required" : [ "key", "value" ] + }, + "urn_samm_io.catenax.serial_part_3.0.0_LocalIdentifierCharacteristic" : { + "description" : "A single serialized part may have multiple attributes, that uniquely identify a that part in a specific dataspace (e.g. the manufacturer`s dataspace)", + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/urn_samm_io.catenax.serial_part_3.0.0_KeyValueList" + }, + "uniqueItems" : true + }, + "urn_samm_io.catenax.batch_3.0.0_KeyTrait" : { + "type" : "string", + "description" : "Constraint that ensures that the predefined keys are used.", + "pattern" : "^(manufacturerId|batchId|customKey:\\w+)$" + }, + "urn_samm_io.catenax.batch_3.0.0_ValueCharacteristic" : { + "type" : "string", + "description" : "The value of an identifier." + }, + "urn_samm_io.catenax.batch_3.0.0_KeyValueList" : { + "description" : "A list of key value pairs for local identifiers, which are composed of a key and a corresponding value.", + "type" : "object", + "properties" : { + "key" : { + "description" : "The key of a local identifier.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.batch_3.0.0_KeyTrait" + }, + "value" : { + "description" : "The value of an identifier.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.batch_3.0.0_ValueCharacteristic" + } + }, + "required" : [ "key", "value" ] + }, + "urn_samm_io.catenax.batch_3.0.0_LocalIdentifierCharacteristic" : { + "description" : "A batch may have multiple attributes, which uniquely identify that batch in a specific dataspace(e.g. the manufacturer`s dataspace)", + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/urn_samm_io.catenax.batch_3.0.0_KeyValueList" + }, + "uniqueItems" : true + }, + "urn_samm_io.catenax.part_type_information_1.0.0_PartIdCharacteristic" : { + "type" : "string", + "description" : "The part ID is a multi-character string, usually assigned by an ERP system." + }, + "urn_samm_io.catenax.part_type_information_1.0.0_PartNameCharacteristic" : { + "type" : "string", + "description" : "Part name in string format from the respective system in the value chain." + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PartTypeCharacteristic" : { + "description" : "Characteristic for the part type.", + "type" : "object", + "properties" : { + "manufacturerPartId" : { + "description" : "Part ID as assigned by the manufacturer of the part. The part ID identifies the part in the manufacturer`s dataspace. The part ID references a specific version of a part. The version number must be included in the part ID if it is available. The part ID does not reference a specific instance of a part and must not be confused with the serial number.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.part_type_information_1.0.0_PartIdCharacteristic" + }, + "nameAtManufacturer" : { + "description" : "Name of the part as assigned by the manufacturer.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.part_type_information_1.0.0_PartNameCharacteristic" + } + }, + "required" : [ "manufacturerPartId", "nameAtManufacturer" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_CodeEntity" : { + "description" : "Code entity with code key and value.", + "type" : "object", + "properties" : { + "key" : { + "description" : "The code key for the identification of the product. Examples are GTIN, hash, DID, ISBN, TARIC. This attribute is mentioned in the ESPR proposal from March 30th, 2022 ANNEX III:\n(b) the unique product identifier at the level indicated in the applicable delegated act adopted pursuant to Article 4;\n(c) the Global Trade Identification Number as provided for in standard ISO/IEC 15459-6 or equivalent of products or their parts;\n(d) relevant commodity codes, such as a TARIC code as defined in Council Regulation (EEC) No 2658/87.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_IdentifierCharacteristic" + }, + "value" : { + "description" : "The code value for the identification of the product in regard to the chosen code name.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_IdentifierCharacteristic" + } + }, + "required" : [ "key", "value" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_CodeList" : { + "description" : "A list of additional codes.", + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_CodeEntity" + } + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DataCarrierCharacteristic" : { + "description" : "Data Carrier Characteristic for the product.", + "type" : "object", + "properties" : { + "carrierType" : { + "description" : "The type of data carrier such as a QR code on the product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 8:\n(2) (b) the types of data carrier to be used.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "carrierLayout" : { + "description" : "The positioning of data carrier on the product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 8:\n(2) (c) the layout in which the data carrier shall be presented and its positioning.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + } + }, + "required" : [ "carrierType", "carrierLayout" ] + }, + "urn_samm_io.catenax.shared.part_classification_1.0.0_ClassificationStandardCharacteristic" : { + "type" : "string", + "description" : "Identified classification standards that align to the Catena-X needs." + }, + "urn_samm_io.catenax.shared.part_classification_1.0.0_ClassificationIDCharacteristic" : { + "type" : "string", + "description" : "It can be numeric or a string, depending on the chosen classification standard." + }, + "urn_samm_io.catenax.shared.part_classification_1.0.0_ClassificationEntity" : { + "description" : "Encapsulates data related to the classification of the part.", + "type" : "object", + "properties" : { + "classificationStandard" : { + "description" : "Identified classification standards that align to the Catena-X needs.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.part_classification_1.0.0_ClassificationStandardCharacteristic" + }, + "classificationID" : { + "description" : "The classification ID of the part type according to the corresponding standard definition mentioned in the key value pair.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.part_classification_1.0.0_ClassificationIDCharacteristic" + }, + "classificationDescription" : { + "description" : "Optional property describing the classification standard.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + } + }, + "required" : [ "classificationStandard", "classificationID" ] + }, + "urn_samm_io.catenax.shared.part_classification_1.0.0_ClassificationCharacteristic" : { + "description" : "Classification characteristic enabling a set of further properties.", + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.part_classification_1.0.0_ClassificationEntity" + }, + "uniqueItems" : true + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_IdentificationCharacteristic" : { + "description" : "Identification information of the product.", + "type" : "object", + "properties" : { + "serial" : { + "description" : "Identifier for a serial part if available. This is mentioned in the ESPR provisional agreement from January 9th, 2024 Recital (27):\n[...] an 'item' usually means a single unit of a model.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.serial_part_3.0.0_LocalIdentifierCharacteristic" + }, + "batch" : { + "description" : "Identifier for a batch part if available. Identifier for a serial part if available. This is mentioned in the ESPR provisional agreement from January 9th, 2024 Recital (27):\n[...] a 'batch' usually means a subset of a specific model composed of all products produced in a specific manufacturing plant at a specific moment in time [...].", + "$ref" : "#/components/schemas/urn_samm_io.catenax.batch_3.0.0_LocalIdentifierCharacteristic" + }, + "type" : { + "description" : "Identifier on the level of a part model or type. Identifier for a serial part if available. This is mentioned in the ESPR provisional agreement from January 9th, 2024 Recital (27):\n[...] A 'model' usually means a version of a product of which all units share the same technical characteristics relevant for the ecodesign requirements and the same model identifier [...].", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PartTypeCharacteristic" + }, + "codes" : { + "description" : "Codes for identification.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_CodeList" + }, + "dataCarrier" : { + "description" : "The type and layout of the data carrier on the product. These are mentioned in the ESPR proposal from March 30th, 2022 Article 8:\n(b) the types of data carrier to be used;\n(c) the layout in which the data carrier shall be presented and its positioning;\nArticle 2 defines:\n(30) 'data carrier' means a linear bar code symbol, a two-dimensional symbol or other automatic identification data capture medium that can be read by a device.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DataCarrierCharacteristic" + }, + "classification" : { + "description" : "Property describing the classification of a part.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.part_classification_1.0.0_ClassificationCharacteristic" + } + }, + "required" : [ "type", "codes", "dataCarrier", "classification" ] + }, + "urn_samm_io.catenax.shared.business_partner_number_2.0.0_BpnaTrait" : { + "type" : "string", + "description" : "The provided regular expression ensures that the BPNA is composed of prefix 'BPNA', 10 digits and two alphanumeric letters.", + "pattern" : "^BPNA[a-zA-Z0-9]{12}$" + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_FacilityEntity" : { + "description" : "The entity for a facility with the BPNA identifier.", + "type" : "object", + "properties" : { + "facility" : { + "description" : "The identifier used for a location. This attribute is mentioned in the ESPR provisional agreement from January 9th 2024 Annex III:\n(i) unique facility identifiers;\nArticle 2 Definitions: (33) 'unique facility identifier' means a unique string of characters for the identification of locations or buildings involved in the value chain of a product or used by actors involved in the value chain of a product.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.business_partner_number_2.0.0_BpnaTrait" + } + }, + "required" : [ "facility" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_FacilityList" : { + "description" : "List of facilities.", + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_FacilityEntity" + } + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_ManufacturerCharacteristic" : { + "description" : "Manufacturing information.", + "type" : "object", + "properties" : { + "facility" : { + "description" : "The identifier used for a location. In the CATENA-X use case, the BPNA can be stated. This attribute is mentioned in the ESPR provisional agreement from January 9th 2024 Annex III:\n(i) unique facility identifiers;\nArticle 2 Definitions: (33) 'unique facility identifier' means a unique string of characters for the identification of locations or buildings involved in the value chain of a product or used by actors involved in the value chain of a product.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_FacilityList" + }, + "manufacturer" : { + "description" : "The main manufacturer, if different from the passport owner, represented by an identification number. In the Catena-X use case, the BPNL can be stated. This attribute is mentioned in the ESPR provisional agreement from January 9th 2024 Annex III:\n(h) unique operator identifiers other than that of the manufacturer;\n(k) the name, contact details and unique operator identifier code of the economic operator established in the Union responsible for carrying out the tasks set out in Article 4 of Regulation (EU) 2019/1020, or Article 15 of Regulation (EU) [.../...] on general product safety, or similar tasks pursuant to other EU legislation applicable to the product.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.business_partner_number_2.0.0_BpnlTrait" + }, + "manufacturingDate" : { + "description" : "The timestamp in the format (yyyy-mm-dd) of the manufacturing date as the final step in production process (e.g. final quality check, ready-for-shipment event).", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DateTrait" + } + }, + "required" : [ "facility", "manufacturer" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_EoriTrait" : { + "type" : "string", + "description" : "Constraint with a pattern which ensures that the EORI number starts with two alphanumeric characters, followed by two alphabetic characters, and ends with 2 to 15 alphanumeric characters.", + "pattern" : "^[A-Z]{2}[A-Z0-9]{1,18}$" + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_ImporterCharacteristic" : { + "description" : "Characteristic with information regarding the importer.", + "type" : "object", + "properties" : { + "eori" : { + "description" : "An economic operator established in the customs territory of the Union needs, for customs purposes, an EORI number. EORI stands for economic operators registration and identification number. In this case, the importer's EORI must be provided. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Annex III:\n(j) information related to the importer, including the information referred to in Article 23(3) and its EORI number.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_EoriTrait" + }, + "id" : { + "description" : "The importer of the product, if different from the owner of the passport. In the Catena-X network, the BPNL is used for the identification of companies and the information stored for this like contact information and addresses.\nThis attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex III:\n(j) information related to the importer, including the information referred to in Article 23(3) and its EORI number;\nArticle 23 states:\n(3) Importers shall, for products covered by a delegated act adopted pursuant to Article 4, indicate their name, registered trade name or registered trade mark and the postal address and electronic means of communication, where they can be contacted: (a) on the public part of the product passport, when applicable, and\n(b) on the product or, where this is not possible, on the packaging, or in a document accompanying the product.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.business_partner_number_2.0.0_BpnlTrait" + } + }, + "required" : [ "eori", "id" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_ImportCharacteristic" : { + "description" : "Import Characteristic for the product.", + "type" : "object", + "properties" : { + "content" : { + "description" : "Information regarding the importer of the product, if different from the owner of the passport. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex III:\n(j) information related to the importer, including the information referred to in Article 23(3) and its EORI number;\nArticle 23 states:\n(3) Importers shall, for products covered by a delegated act adopted pursuant to Article 4, indicate their name, registered trade name or registered trade mark and the postal address and electronic means of communication, where they can be contacted: (a) on the public part of the product passport, when applicable, and\n(b) on the product or, where this is not possible, on the packaging, or in a document accompanying the product.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_ImporterCharacteristic" + }, + "applicable" : { + "description" : "Check whether the connected attributes are applicable to the product. If it is not applicable (false), dummy data can be delivered.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Boolean" + } + }, + "required" : [ "content", "applicable" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_OperatorCharacteristic" : { + "description" : "Other operators characteristic.", + "type" : "object", + "properties" : { + "id" : { + "description" : "Identifier of the other operator. This can be a BPN.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "role" : { + "description" : "Role of the other operator.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + } + }, + "required" : [ "id", "role" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_OperationCharacteristic" : { + "description" : "Operational information of the product.", + "type" : "object", + "properties" : { + "manufacturer" : { + "description" : "Manufacturing information of the product. In the CATENA-X use case, the BPNL and BPNA can be stated. These attributes are mentioned in the ESPR provisional agreement from January 9th 2024 Annex III:\n(h) unique operator identifiers other than that of the manufacturer;\n(k) the name, contact details and unique operator identifier code of the economic operator established in the Union responsible for carrying out the tasks set out in Article 4 of Regulation (EU) 2019/1020, or Article 15 of Regulation (EU) [.../...] on general product safety, or similar tasks pursuant to other EU legislation applicable to the product.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_ManufacturerCharacteristic" + }, + "import" : { + "description" : "Importer details such as the identification.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_ImportCharacteristic" + }, + "other" : { + "description" : "Other operators relevant for the product.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_OperatorCharacteristic" + } + }, + "required" : [ "manufacturer", "import" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_SourcesEntity" : { + "description" : "Entity for a possible spare part sources.", + "type" : "object", + "properties" : { + "id" : { + "description" : "The identifier of a spare part producer of the product. In the Catena-X network, the BPNL is used for the identification of companies and the information stored for this like contact information and addresses.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.business_partner_number_2.0.0_BpnlTrait" + } + }, + "required" : [ "id" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_SourcesList" : { + "description" : "List of possible spare part sources.", + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_SourcesEntity" + } + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PartsEntity" : { + "description" : "Possible spare parts of the product with identifiers and names.", + "type" : "object", + "properties" : { + "manufacturerPartId" : { + "description" : "Part ID as assigned by the manufacturer of the part. The part ID identifies the part in the manufacturer`s dataspace. The part ID references a specific version of a part. The version number must be included in the part ID if it is available. The part ID does not reference a specific instance of a part and must not be confused with the serial number.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.part_type_information_1.0.0_PartIdCharacteristic" + }, + "nameAtManufacturer" : { + "description" : "Name of the part as assigned by the manufacturer.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.part_type_information_1.0.0_PartNameCharacteristic" + } + }, + "required" : [ "manufacturerPartId", "nameAtManufacturer" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PartList" : { + "description" : "A list of possible spare parts of the product.", + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PartsEntity" + } + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_SparePart" : { + "description" : "Characteristic describing sources and spare parts.", + "type" : "object", + "properties" : { + "producer" : { + "description" : "Sources of possible spare parts.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_SourcesList" + }, + "sparePart" : { + "description" : "Possible spare parts of the product.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PartList" + } + }, + "required" : [ "producer", "sparePart" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_HandlingCharacteristic" : { + "description" : "Characteristic to describe aspects which are connected with the handling of the product.", + "type" : "object", + "properties" : { + "content" : { + "description" : "The list of spare parts available for the product from various suppliers.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_SparePart" + }, + "applicable" : { + "description" : "Check whether the connected attributes are applicable to the product. If it is not applicable (false), dummy data can be delivered.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Boolean" + } + }, + "required" : [ "content", "applicable" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_StringList" : { + "description" : "List of strings.", + "type" : "array", + "items" : { + "type" : "string" + } + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_CommercialCharacteristic" : { + "description" : "Commercial information of the product.", + "type" : "object", + "properties" : { + "placedOnMarket" : { + "description" : "The timestamp in the format (yyyy-mm-dd) with or without time zone when the product was put in the market.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DateTrait" + }, + "purpose" : { + "description" : "One or more intended industry/industries of the product described by the digital product passport. If exchanged via Catena-X, 'automotive ' is a must choice included in the list.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_StringList" + } + }, + "required" : [ "purpose" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_ConcentrationEnumeration" : { + "type" : "string", + "description" : "Enumeration of possible units of concentration with percent, volume percent, parts per thousand, parts per million, parts per billion and parts per trillion.", + "enum" : [ "unit:partPerMillion", "unit:percent", "unit:percentVolume", "unit:partPerThousand", "unit:partPerTrillionUs", "unit:partPerBillionUs" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PositiveTrait" : { + "type" : "number", + "description" : "Constraint for only positive values.", + "minimum" : 0.0, + "exclusiveMinimum" : false + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_HazardCharacteristic" : { + "description" : "Characteristic for the hazardous classification.", + "type" : "object", + "properties" : { + "category" : { + "description" : "The hazard category of the substance of concern. Defined in Article 2 of Regulation (EC) No 1272/2008 of the European Parliament and of the Council of 16 December 2008 on classification, labelling and packaging of substances and mixtures, amending and repealing Directives 67/548/EEC and 1999/45/EC, and amending Regulation (EC) No 1907/2006:\n2. 'hazard category' means the division of criteria within each hazard class, specifying hazard severity.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "class" : { + "description" : "The hazard class of the substance of concern. Defined in Article 2 of Regulation (EC) No 1272/2008 of the European Parliament and of the Council of 16 December 2008 on classification, labelling and packaging of substances and mixtures, amending and repealing Directives 67/548/EEC and 1999/45/EC, and amending Regulation (EC) No 1907/2006:\n1. 'hazard class' means the nature of the physical, health or environmental hazard.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "statement" : { + "description" : "The hazard statement of the substance of concern. Defined in Article 2 of Regulation (EC) No 1272/2008 of the European Parliament and of the Council of 16 December 2008 on classification, labelling and packaging of substances and mixtures, amending and repealing Directives 67/548/EEC and 1999/45/EC, and amending Regulation (EC) No 1907/2006:\n5. 'hazard statement' means a phrase assigned to a hazard class and category that describes the nature of the hazards of a hazardous substance or mixture, including, where appropriate, the degree of hazard.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + } + }, + "required" : [ "category", "class", "statement" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_RangeEntity" : { + "description" : "Entity for the concentration range with two values, the highest and the lowest of the concentration range.", + "type" : "object", + "properties" : { + "min" : { + "description" : "The minimum concentration of the substance of concern at the level of the product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7:\n(5) (c) [...] concentration range of the substances of concern, at the level of the product [...].", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PositiveTrait" + }, + "max" : { + "description" : "The maximum concentration of the substance of concern at the level of the product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7:\n(5) (c) the concentration, maximum concentration or concentration range of the substances of concern, at the level of the product [...].", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PositiveTrait" + } + }, + "required" : [ "max" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_RangeCharacteristic" : { + "description" : "Range characteristic with two values, the highest and the lowest of the concentration range. Only providing the maximum range is also possible.", + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_RangeEntity" + } + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_ListTypeEnumerationId" : { + "type" : "string", + "description" : "Enumeration of different systems and organizations related to the identification and classification of chemical substances in the field of chemistry. The enumeration values are EC or CAS.", + "enum" : [ "CAS", "EC", "IUPAC" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_MaterialIdEntity" : { + "description" : "Id Entity with identifier, name and list type.", + "type" : "object", + "properties" : { + "id" : { + "description" : "The substance identification, in accordance with the specification in the attribute for the list type.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_IdentifierCharacteristic" + }, + "type" : { + "description" : "The type of standard used for the identification of the substances. Selected can be for example CAS, IUPAC or EC.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_ListTypeEnumerationId" + }, + "name" : { + "description" : "The name of the material which is present in the product.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + } + }, + "required" : [ "id", "type", "name" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_MaterialIdList" : { + "description" : "List of ids for the identification.", + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_MaterialIdEntity" + } + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_SubstanceEntity" : { + "description" : "Information regarding substances of concern in the product.", + "type" : "object", + "properties" : { + "location" : { + "description" : "The location of the substances of concern within the product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7:\n(5) (b) the location of the substances of concern within the product.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "unit" : { + "description" : "The unit of concentration chosen from an enumeration: mass percent, volume percent, parts per thousand, parts per million, parts per billion and parts per trillion.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_ConcentrationEnumeration" + }, + "concentration" : { + "description" : "Concentration of the material at the level of the product. This attribute is specially mentioned for substances of concern mentioned in the ESPR proposal from March 30th, 2022 Article 7:\n(5) (c) the concentration, maximum concentration or concentration range of the substances of concern, at the level of the product [...].\nOther substances are mentioned for the purpose of recycling in the ESPR provisional agreement from January 9th, 2024 Annex I:\n(d) design for recycling, ease and quality of recycling as expressed through: use of easily recyclable materials, safe, easy and non-destructive access to recyclable components and materials or components and materials containing hazardous substances and material composition and homogeneity, possibility for high-purity sorting, number of materials and components used, use of standard components, use of component and material coding standards for the identification of components and materials, number and complexity of processes and tools needed, ease of nondestructive disassembly and re-assembly, conditions for access to product data, conditions for access to or use of hardware and software needed.\n", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PositiveTrait" + }, + "exemption" : { + "description" : "Exemptions to the substance of concern. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Article 7:\n(5) (c) provide duly justified exemptions for substances of concern or information elements from the information requirements referred to in the first subparagraph based on the technical feasibility or relevance of tracking substances of concern, the existence of analytical methods to detect and quantify them, the need to protect confidential business information or in other duly justified cases. Substances of concern within the meaning of Article 2(28), point a), shall not be exempted if they are present in products, their relevant components or spare parts in a concentration above 0,1 % weight by weight.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "hazardClassification" : { + "description" : "The specification of the hazard class. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I:\n(f) use of substances, and in particular the use of substances of concern, on their own, as constituents of substances or in mixtures, during the production process of products, or leading to their presence in products, including once these products become waste, and their impacts on human health and the environment;\nFurther defined is this by Regulation (EC) No 1272/2008 of the European Parliament and of the Council of 16 December 2008 on classification, labelling and packaging of substances and mixtures, amending and repealing Directives 67/548/EEC and 1999/45/EC, and amending Regulation (EC) No 1907/2006.\nDefined in Article 2:\n1. 'hazard class' means the nature of the physical, health or environmental hazard;\n2. 'hazard category' means the division of criteria within each hazard class, specifying hazard severity;\n5. 'hazard statement' means a phrase assigned to a hazard class and category that describes the nature of the hazards of a hazardous substance or mixture, including, where appropriate, the degree of hazard;", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_HazardCharacteristic" + }, + "concentrationRange" : { + "description" : "The concentration range for the substance of concern. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7:\n(5) (c) [...] concentration range of the substances of concern, at the level of the product [...].", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_RangeCharacteristic" + }, + "id" : { + "description" : "The chemical material name and identification, in accordance with the specification in the attribute for the list type. Preference is given to the IUPAC name. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Article 7:\n(5) (a) the name of the substances of concern present in the product, as follows:\n - name(s) in the International Union of Pure and Applied Chemistry (IUPAC) nomenclature, or another international name when IUPAC name is not available; \n- other names (usual name, trade name, abbreviation);\n- European Community (EC) number, as indicated in the European Inventory of Existing Commercial Chemical Substances (EINECS), the European List of Notified Chemical Substances (ELINCS) or the No Longer Polymer (NLP) list or assigned by the European Chemicals Agency (ECHA), if available;\n- the Chemical Abstract Service (CAS) name(s) and number(s), if available; .", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_MaterialIdList" + }, + "documentation" : { + "description" : "Documentation accompanying the material.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentList" + } + }, + "required" : [ "location", "unit", "concentration", "exemption", "hazardClassification", "concentrationRange", "id", "documentation" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_SubstanceList" : { + "description" : "Characteristic for a list of substances of concern.", + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_SubstanceEntity" + } + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_SubstanceOfConcernCharacteristic" : { + "description" : "Substance of concern Characteristic of the product.", + "type" : "object", + "properties" : { + "applicable" : { + "description" : "Check whether the connected attributes are applicable to the product. If it is not applicable (false), dummy data can be delivered.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Boolean" + }, + "content" : { + "description" : "Information regarding substances of concern in the product. Attributes are among others substance names, ids, concentration, location and hazard class. This is mentioned in the ESPR provisional agreement from January 9th, 2024 Article 7:\n(5) (a) the name of the substances of concern present in the product, as follows:\n- name(s) in the International Union of Pure and Applied Chemistry (IUPAC) nomenclature, or another international name when IUPAC name is not available; \n- other names (usual name, trade name, abbreviation);\n- European Community (EC) number, as indicated in the European Inventory of Existing Commercial Chemical Substances (EINECS), the European List of Notified Chemical Substances (ELINCS) or the No Longer Polymer (NLP) list or assigned by the European Chemicals Agency (ECHA), if available;\n- the Chemical Abstract Service (CAS) name(s) and number(s), if available;\n(5) (b) the location of the substances of concern within the product.\n(5) (c) the concentration, maximum concentration or concentration range of the substances of concern, at the level of the product its relevant components, or spare parts;\n(d) relevant instructions for the safe use of the product;\n(e) information relevant for disassembly, preparation for reuse, reuse, recycling and the environmentally sound management of the product at the end of its life.\nAnd in the next paragraph:\n(c) provide duly justified exemptions for substances of concern or information elements from the information requirements referred to in the first subparagraph.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_SubstanceList" + } + }, + "required" : [ "applicable", "content" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PercentageTrait" : { + "type" : "number", + "description" : "Range constraint for a positive percentage value.", + "maximum" : 100.0, + "exclusiveMaximum" : false, + "minimum" : 0.0, + "exclusiveMinimum" : false + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_MaterialEntity" : { + "description" : "Information regarding recycled and/or renewable materials in the product.", + "type" : "object", + "properties" : { + "recycled" : { + "description" : "The share of the material, which is recovered recycled content from the product. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I:\n(h) use or content of recycled materials and recovery of materials, including critical raw materials;", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PercentageTrait" + }, + "renewable" : { + "description" : "The share of the material, which is from a renewable resource that can be replenished. Renewable resources are those that can be reproduced by physical, chemical, or mechanical processes. These are the kind of resources that can be regenerated throughout time. Forest wood, for example, can be grown through reforestation. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I:\n(ha) use or content of sustainable renewable materials;\n", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PercentageTrait" + }, + "unit" : { + "description" : "The unit of concentration chosen from an enumeration: mass percent, volume percent, parts per thousand, parts per million, parts per billion and parts per trillion.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_ConcentrationEnumeration" + }, + "id" : { + "description" : "The chemical material name and identification, in accordance with the specification in the attribute for the list type. Preference is given to the IUPAC name. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Article 7:\n(5) (a) the name of the substances of concern present in the product, as follows:\n - name(s) in the International Union of Pure and Applied Chemistry (IUPAC) nomenclature, or another international name when IUPAC name is not available; \n- other names (usual name, trade name, abbreviation);\n- European Community (EC) number, as indicated in the European Inventory of Existing Commercial Chemical Substances (EINECS), the European List of Notified Chemical Substances (ELINCS) or the No Longer Polymer (NLP) list or assigned by the European Chemicals Agency (ECHA), if available;\n- the Chemical Abstract Service (CAS) name(s) and number(s), if available; .", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_MaterialIdList" + }, + "critical" : { + "description" : "A flag, if the material is a critical raw material. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I:\n(h) use or content of recycled materials and recovery of materials, including critical raw materials;\nIn Annex II of the connected proposal Act of Critical Raw Materials, a list of critical raw materials can be found.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Boolean" + }, + "concentration" : { + "description" : "Concentration of the material at the level of the product. This attribute is specially mentioned for substances of concern mentioned in the ESPR proposal from March 30th, 2022 Article 7:\n(5) (c) the concentration, maximum concentration or concentration range of the substances of concern, at the level of the product [...].\nOther substances are mentioned for the purpose of recycling in the ESPR provisional agreement from January 9th, 2024 Annex I:\n(d) design for recycling, ease and quality of recycling as expressed through: use of easily recyclable materials, safe, easy and non-destructive access to recyclable components and materials or components and materials containing hazardous substances and material composition and homogeneity, possibility for high-purity sorting, number of materials and components used, use of standard components, use of component and material coding standards for the identification of components and materials, number and complexity of processes and tools needed, ease of nondestructive disassembly and re-assembly, conditions for access to product data, conditions for access to or use of hardware and software needed.\n", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PositiveTrait" + }, + "documentation" : { + "description" : "Documentation accompanying the material.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentList" + } + }, + "required" : [ "recycled", "renewable", "unit", "id", "critical", "concentration", "documentation" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_MaterialList" : { + "description" : "A list of different materials in the product.", + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_MaterialEntity" + } + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_MaterialCharacteristic" : { + "description" : "Material Characteristic with information on the materials.", + "type" : "object", + "properties" : { + "applicable" : { + "description" : "Check whether the connected attributes are applicable to the product. If it is not applicable (false), dummy data can be delivered.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Boolean" + }, + "content" : { + "description" : "Information on different materials in the product.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_MaterialList" + } + }, + "required" : [ "applicable", "content" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_MaterialsCharacteristic" : { + "description" : "Materials Characteristic on product level.", + "type" : "object", + "properties" : { + "substancesOfConcern" : { + "description" : "Information regarding substances of concern in the product. The ESPR provisional agreement from January 9th, 2024 defines:\n(52) 'hazardous substance' means a substance classified as hazardous pursuant to Article 3 of Regulation (EC) No 1272/2008.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_SubstanceOfConcernCharacteristic" + }, + "materialComposition" : { + "description" : "Material composition of the product with information on recycled and renewable materials.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_MaterialCharacteristic" + } + }, + "required" : [ "substancesOfConcern", "materialComposition" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_StateEnumeration" : { + "type" : "string", + "description" : "Enumeration defined as original, repurposed, re-used, remanufactured or waste.", + "enum" : [ "original", "repurposed", "re-used", "remanufactured", "waste" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_CategoryEnumeration" : { + "type" : "string", + "description" : "Enumeration of the 19 impact categories in accordance to EN15804+A2.", + "enum" : [ "Climate Change Total", "Climate Change Fossil", "Climate Change Biogenic Removals and Emissions", "Climate Change Land Use and Land Use Change", "Ozone Depletion", "Acidification", "Eutrophication Aquatic Freshwater", "Eutrophication Fresh Marine", "Eutrophication Terrestrial", "Photochemical Ozone Formation", "Abiotic Depletion- Minerals and Metals", "Fossil Fuels", "Water Use", "Particulate Matter Emissions", "Ionizing Radiation, Human Health", "Eco-Toxicity", "Human Toxicity, Cancer Effects", "Human Toxicity, Non-Cancer Effects", "Land Use Related Impacts/Soil Quality" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_FootprintEntity" : { + "description" : "Footprint Entity for the carbon and environmental footprint with the total value, unit, impact category type, lifecycle, rulebook, declaration, performance class and the facility.", + "type" : "object", + "properties" : { + "value" : { + "description" : "The value of the footprint of the product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Annex I:\n(l) the environmental footprint of the product, expressed as a quantification, in accordance with the applicable delegated act, of a product's life cycle environmental impacts, whether in relation to one or more environmental impact categories or an aggregated set of impact categories;\n(m) the carbon footprint of the product;\n(ma) the material footprint of the product.\n", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PositiveTrait" + }, + "rulebook" : { + "description" : "The applied rulebook for the environmental footprint of the product.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentList" + }, + "lifecycle" : { + "description" : "The lifecycle stage, to which the environmental footprint corresponds. These could be for example \"raw material acquisition and pre-processing\", \"main product production\", \"distribution\" or \"end of life and recycling\".", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "unit" : { + "description" : "The unit of measurement of the environmental impact category. For each impact category a specific unit is used. If an aggregation is used, utilize the normalization and weighting methods used in the referenced rulebook.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "type" : { + "description" : "The type of the environmental footprint of the product. This could be one of the environmental impact categories. This attribute is mentioned in the ESPR provisional agreement from January 9th 2024 Article 7:\n(2)(b)(i) information on the performance of the product in relation to one or more of the product parameters referred to in Annex I, including a scoring of reparability or durability, carbon footprint or environmental footprint;\nAnnex I:\n(l) the environmental footprint of the product, expressed as a quantification, in accordance with the applicable delegated act, of a product's life cycle environmental impacts, whether in relation to one or more environmental impact categories or an aggregated set of impact categories.\n(m) the carbon footprint of the product;\n(ma) the material footprint of the product.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_CategoryEnumeration" + }, + "performanceClass" : { + "description" : "The performance classification of the footprint.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "manufacturingPlant" : { + "description" : "The manufacturing plant of the footprint in the specific lifecycle phase.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_FacilityList" + }, + "declaration" : { + "description" : "The footprint declaration in the format of a link ", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentList" + } + }, + "required" : [ "value", "rulebook", "lifecycle", "unit", "type", "manufacturingPlant", "declaration" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_FootprintList" : { + "description" : "Footprint List for the environmental footprint.", + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_FootprintEntity" + } + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_ProductFootprintCharacteristic" : { + "description" : "The Product Footprint Characteristic with sustainability information.", + "type" : "object", + "properties" : { + "environmental" : { + "description" : "The environmental footprint of the product. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I:\nThe following parameters shall, as appropriate, and where necessary supplemented by others, be used, individually or combined, as a basis for improving the product aspects referred to in Article 5(1):\n(l) the environmental footprint of the product, expressed as a quantification, in accordance with the applicable delegated act, of a product's life cycle environmental impacts, whether in relation to one or more environmental impact categories or an aggregated set of impact categories.\nand Article 7:\n(2)(b)(i) information on the performance of the product in relation to one or more of the product parameters referred to in Annex I, including a scoring of reparability or durability, carbon footprint or environmental footprint;\nand defined by Article 2:\n(23) 'environmental footprint' means a quantification of product environmental impacts throughout its life cycle, whether in relation to a single environmental impact category or an aggregated set of impact categories based on the Product Environmental Footprint method or other scientific methods developed by international organisations and widely tested in collaboration with different industry sectors and adopted or implemented by the Commission in other Union legislation;\n(24) 'Product Environmental Footprint method' means the life cycle assessment method to quantify the environmental impacts of products established by Recommendation (EU) 2021/2279.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_FootprintList" + }, + "carbon" : { + "description" : "The carbon footprint of the product. This is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I:\nThe following parameters shall, as appropriate, and where necessary supplemented by others, be used, individually or combined, as a basis for improving the product aspects referred to in Article 5(1):\n(m) the carbon footprint of the product;\nand Article 7:\n(2)(b)(i) information on the performance of the product in relation to one or more of the product parameters referred to in Annex I, including a scoring of reparability or durability, carbon footprint or environmental footprint;\nand defined by Article 2:\n(25) 'carbon footprint' means the sum of greenhouse gas (GHG) emissions and GHG removals in a product system, expressed as CO2 equivalents and based on a life cycle assessment using the single impact category of climate change.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_FootprintList" + }, + "material" : { + "description" : "The material footprint of the product. This is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I:\n(ma) the material footprint of the product;\nand defined by Article 2:\n(25a) 'material footprint' refers to the total amount of raw materials extracted to meet final consumption demands.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_FootprintList" + } + }, + "required" : [ "carbon" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_SustainabilityCharacteristic" : { + "description" : "Characteristic which describes relevant information for the sustainability of the product.", + "type" : "object", + "properties" : { + "status" : { + "description" : "The status of the product (original, repurposed, re-used, remanufactured or waste) to indicated, whether it is a used product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Annex I:\n(j) incorporation of used components.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_StateEnumeration" + }, + "productFootprint" : { + "description" : "The carbon and environmental footprint or material footprint of the product. These attributes are mentioned in the ESPR provisional agreement from January 9th 2024 Annex I:\n(l) the environmental footprint of the product, expressed as a quantification, in accordance with the applicable delegated act, of a product's life cycle environmental impacts, whether in relation to one or more environmental impact categories or an aggregated set of impact categories;\n(m) the carbon footprint of the product;\n(ma) the material footprint of the product;\nAll are defined by Article 2:\n(23) 'environmental footprint' means a quantification of product environmental impacts throughout its life cycle, whether in relation to a single environmental impact category or an aggregated set of impact categories based on the Product Environmental Footprint method or other scientific methods developed by international organisations and widely tested in collaboration with different industry sectors and adopted or implemented by the Commission in other Union \nlegislation;\n(25) 'carbon footprint' means the sum of greenhouse gas (GHG) emissions and GHG removals in a product system, expressed as CO2 equivalents and based on a life cycle assessment using the single impact category of climate change.\n(25a) 'material footprint' refers to the total amount of raw materials extracted to meet final consumption demands;", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_ProductFootprintCharacteristic" + }, + "reparabilityScore" : { + "description" : "The reparability score. This attribute is mentioned ESPR provisional agreement from January 9th, 2024 Article 7:\n(b) as appropriate, also require products to be accompanied by:\n(i) information on the performance of the product in relation to one or more of the product parameters referred to in Annex I, including a scoring of reparability or durability [...].", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "durabilityScore" : { + "description" : "The durability score. This attribute is mentioned ESPR provisional agreement from January 9th, 2024 Article 7:\n(b) as appropriate, also require products to be accompanied by:\n(i) information on the performance of the product in relation to one or more of the product parameters referred to in Annex I, including a scoring of reparability or durability [...].", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + } + }, + "required" : [ "status", "productFootprint" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_SourceCategoryEnumeration" : { + "type" : "string", + "description" : "The types of sources that can be linked in a digital product passport can vary depending on the nature of the product and the information that needs to be included. This is an enumeration of possible sources.", + "enum" : [ "Product Specifications", "Manufacturer Information", "User Manuals and Guides", "Certifications and Compliance", "Product Images and Videos", "Warranty Information", "Reviews and Ratings", "Product Variations", "Supply Chain Information", "Environmental Impact", "Compatibility and Accessories", "FAQs and Support", "Purchase and Retail Information", "Privacy and Data Handling", "Third-Party Integrations", "Legal Information", "Safety Information", "Repair and Installation", "Waste Generation and Prevention", "Specific Voluntary Labels", "Product Packaging", "Return and Disposal", "End of Life", "Material and Substance Information", "Technical Documentation", "Treatment facilities", "Other" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentEntity" : { + "description" : "Document entity with header, content, category and type.", + "type" : "object", + "properties" : { + "content" : { + "description" : "The content of the document e.g a link.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "category" : { + "description" : "The category in which the document can be sorted. These are mentioned in the ESPR proposal from March 30th, 2022 ANNEX III:\n(e) compliance documentation and information required under this Regulation or other Union law applicable to the product, such as the declaration of conformity, technical documentation or conformity certificates;\nANNEX IV states additional information regarding the content of the technical documentation\nFurther information on documents are mentioned in the proposal from March 30th, 2022 ANNEX III:\n(f) user manuals, instructions, warnings or safety information, as required by other Union legislation applicable to the product.\nAdditionally requirements are mentioned in Article 21:\n(7) Manufacturers shall ensure that that a product covered by a delegated act adopted pursuant to Article 4 is accompanied by instructions that enable consumers and other end-users to safely assemble, install, operate, store, maintain, repair and dispose of the product in a language that can be easily understood by consumers and other end-users, as determined by the Member State concerned. Such instructions shall be clear, understandable and legible and include at least the information specified in the delegated acts adopted pursuant to Article 4 and pursuant to Article 7(2)(b), point (ii).\nArticle 7 states additionally:\n(2) (b) (ii) information for consumers and other end-users on how to install, use, maintain and repair the product in order to minimize its impact on the environment and to ensure optimum durability, as well as on how to return or dispose of the product at end-of-life;\n(2) (b) (iii) information for treatment facilities on disassembly, recycling, or disposal at end-of-life;\n(2) (b) (iv) other information that may influence the way the product is handled by parties other than the manufacturer in order to improve performance in relation to product parameters referred to in Annex I.\n(5) (d) relevant instructions for the safe use of the product.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_SourceCategoryEnumeration" + }, + "type" : { + "description" : "The type of content which can be expected in the \"content\" property. Examples are a link, restricted link, pdf, excel, etc.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "header" : { + "description" : "The header as a short description of the document with a maximum of 100 characters.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_HeaderTrait" + } + }, + "required" : [ "content", "category", "type", "header" ] + }, + "urn_samm_io.catenax.generic.digital_product_passport_5.0.0_SourceList" : { + "description" : "A list of documents.", + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentEntity" + } + }, + "urn_samm_io.catenax.transmission.transmission_pass_3.0.0_GenericCharacteristic" : { + "description" : "Characteristic for the product generic parameters.", + "type" : "object", + "properties" : { + "characteristics" : { + "description" : "Defines specific characteristics of the transmission.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.transmission.transmission_pass_3.0.0_ProductCharacteristics" + }, + "metadata" : { + "description" : "Metadata of the product passport. These are mentioned in the ESPR proposal from March 30th, 2022 and some changed by the provisional agreement from January 9th, 2024.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_MetadataCharacteristic" + }, + "identification" : { + "description" : "Identification information of the product, especially identifiers and codes. These are mentioned in the ESPR provisional agreement from January 9th, 2024 ANNEX III:\n(b) the unique product identifier at the level indicated in the applicable delegated act adopted pursuant to Article 4.\nAdditionally in Article 9 regarding general requirements for the product passport is stated that:\nA product passport shall meet the following conditions:\n(a) it shall be connected through a data carrier to a persistent unique product identifier;\n(e) the information included in the product passport shall refer to the product model, batch, or item as specified in the delegated act adopted pursuant to Article 4.\nArticle 2 Definitions: \n(31) 'unique product identifier' means a unique string of characters for the identification of products that also enables a web link to the product passport;\nRecital (27): A 'model' usually means a version of a product of which all units share the same technical characteristics relevant for the ecodesign requirements and the same model identifier, a 'batch' usually means a subset of a specific model composed of all products produced in a specific manufacturing plant at a specific moment in time and an 'item' usually means a single unit of a model.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_IdentificationCharacteristic" + }, + "operation" : { + "description" : "Operational information of the product.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_OperationCharacteristic" + }, + "handling" : { + "description" : "Properties connected with the handling of the product.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_HandlingCharacteristic" + }, + "commercial" : { + "description" : "Commercial information of the product.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_CommercialCharacteristic" + }, + "materials" : { + "description" : "Properties which are relevant for the materials of the product.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_MaterialsCharacteristic" + }, + "sustainability" : { + "description" : "Sustainability related attributes.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_SustainabilityCharacteristic" + }, + "sources" : { + "description" : "Documents that are mandatory if applicable for the product. These are mentioned in the ESPR provisional agreement from January 9th, 2024 ANNEX III:\n(e) compliance documentation and information required under this Regulation or other Union law applicable to the product, such as the declaration of conformity, technical documentation or conformity certificates;\n(f) user manuals, instructions, warnings or safety information, as required by other Union legislation applicable to the product.\nAdditionally requirements are mentioned in Article 21:\n7. Manufacturers shall ensure that a product covered by a delegated act adopted pursuant to Article 4 is accompanied by instructions in digital format that enable customers and other relevant actors to assemble, install, operate, store, maintain, repair and dispose of the product in a language that can be easily understood, as determined by the Member State concerned. Such instructions shall be clear, understandable and legible and include at least the information set out in Article 7(2), point (b), point (ii) specified in the delegated acts adopted pursuant to Article 4.\nArticle 7 states additionally:\n(ii) information for customers and other actors on how to install, use, maintain and repair the product, in order to minimise its impact on the environment and to ensure optimum durability, on how to install third-party operating systems where relevant, as well as on collection for refurbishment or remanufacture, and on how to return or handle the product at the end of its life;\n(2) (b) (iii) information for treatment facilities on disassembly, reuse, refurbishment, recycling, or disposal at end-of-life;\n(2) (b) (iv) other information that may influence sustainable product choices for customers and the way the product is handled by parties other than the manufacturer in order to facilitate appropriate use, value retaining operations and correct treatment at end-of-life.\n(5) (d) relevant instructions for the safe use of the product.\n(5) (e) information relevant for disassembly, preparation for reuse, reuse, recycling and the environmentally sound management of the product at the end of its life.\nAnnex I:\n(b) [...] availability of repair and maintenance instructions, number of materials and components used, use of standard components,[...] number and complexity of processes and whether specialised toolsare needed, ease of non-destructive disassembly and re-assembly, conditions for access to product data, conditions for access to or use of hardware and software needed;\n(c) ease of upgrading, re-use, remanufacturing and refurbishment as expressed through: [...] number and complexity of processes and tools needed, ease of non-destructive disassembly and re-assembly, conditions for access to product data, conditions for access to or use of hardware and software needed, conditions of access to test protocols or not commonly available testing equipment, availability of guarantees specific to remanufactured or refurbished products, conditions for access to or use of technologies protected by intellectual property rights, modularity;\n(d) design for recycling, ease and quality of recycling as expressed through: use of easily recyclable materials, safe, easy and non-destructive access to recyclable components and materials or components and materials containing hazardous substances and material composition and homogeneity, possibility for high-purity sorting, [...] number and complexity of processes and tools needed, ease of nondestructive disassembly and re-assembly, conditions for access to product data, conditions for access to or use of hardware and software needed;\n(q) functional performance and conditions for use including as expressed through ability in performing its intended use, precautions of use, skills required, compatibility with other products or systems.\nAdditionally to consider are guidelines and instructions regarding the proper management and disposal of packaging materials after use. This can include instructions for separation, reuse, and recycling.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_SourceList" + } + }, + "required" : [ "characteristics", "metadata", "identification", "operation", "handling", "commercial", "materials", "sustainability", "sources" ] + } + } + }, + "properties" : { + "specific" : { + "description" : "Product specific parameters of the transmission.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.transmission.transmission_pass_3.0.0_SpecificCharacteristic" + }, + "generic" : { + "description" : "The product generic parameters. These are defined by the Digital Product Passport proposal from the ESPR. The main basis is provided by the document \"Proposal for a REGULATION OF THE EUROPEAN PARLIAMENT AND OF THE COUNCIL establishing a framework for setting ecodesign requirements for sustainable products and repealing Directive 2009/125/EC\" from March 30th, 2022. The latest version of the document was the provisional agreement between the EU Council and the Parliament from January 9th, 2024.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.transmission.transmission_pass_3.0.0_GenericCharacteristic" + } + }, + "required" : [ "specific", "generic" ] +} \ No newline at end of file diff --git a/io.catenax.transmission.transmission_pass/3.0.0/gen/TransmissionPass.aasx b/io.catenax.transmission.transmission_pass/3.0.0/gen/TransmissionPass.aasx new file mode 100644 index 000000000..2a7f14744 Binary files /dev/null and b/io.catenax.transmission.transmission_pass/3.0.0/gen/TransmissionPass.aasx differ diff --git a/io.catenax.transmission.transmission_pass/3.0.0/gen/TransmissionPass.html b/io.catenax.transmission.transmission_pass/3.0.0/gen/TransmissionPass.html new file mode 100644 index 000000000..dadf778ef --- /dev/null +++ b/io.catenax.transmission.transmission_pass/3.0.0/gen/TransmissionPass.html @@ -0,0 +1,11525 @@ + + + + + + + + + + + + + + Documentation Transmission Pass + + +
+
+
+
+

Aspect Model Transmission Pass

+
urn:samm:io.catenax.transmission.transmission_pass:3.0.0#TransmissionPass
+
+
+
+
+
+
+
+ +
+ + +
+ The transmission passport corresponds to the digital product passport information required by the proposed Ecodesign Regulation (ESPR-2022) and describes the data that is collected and available during the lifespan of a transmission. +
+ + +
+

Overview

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

Properties

+
+ +
+ +
+

Product Generic Parameters

+
+ +The product generic parameters. These are defined by the Digital Product Passport proposal from the ESPR. The main basis is provided by the document "Proposal for a REGULATION OF THE EUROPEAN PARLIAMENT AND OF THE COUNCIL establishing a framework for setting ecodesign requirements for sustainable products and repealing Directive 2009/125/EC" from March 30th, 2022. The latest version of the document was the provisional agreement between the EU Council and the Parliament from January 9th, 2024. + +
+
Name
+
productGenericParameters
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.transmission.transmission_pass:3.0.0#GenericEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
generic
+
+ + +
+
+ +
+

Product Specific Parameters

+
+ +Product specific parameters of the transmission. + +
+
Name
+
productSpecificParameters
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.transmission.transmission_pass:3.0.0#SpecificEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
specific
+
+ + +
+
+ + + +
+
+

Entities

+
+ +
+
+

Characteristics Entity

+
+
+ Entity which defines specific characteristics of the transmission such as different life spans and physical dimensions. +
+ +
+

Properties

+
+
+ +
+
Warranty
+
+ +Commercial warranty period of the transmission (coupled to the Vehicle) in months. + +
+
Name
+
warranty
+
+ + + +
+
Characteristic
+
+
+
+
Measurement
+
+
+
Measurement in months as an integer.
+
+
+
Unit
+
+
+
+
    +
  • + month +
    • +
  • + Symbol mo +
    • +
  • + Code MON +
    • +
  • + Conversion factor 2.629800 × 10⁶ s +
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#nonNegativeInteger + +
+
+
+
+
+ +
+
Example
+
60
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
warranty
+
+ + +
+
+ +
+
Life Time
+
+ +Expected transmission lifespan in kilometres. + +
+
Name
+
lifeTime
+
+ + + +
+
Characteristic
+
+
+
+
Measurement
+
+
+
Measurement in kilometre as an integer.
+
+
+
Unit
+
+
+
+
    +
  • + kilometre +
    • +
  • + Symbol km +
    • +
  • + Code KMT +
    • +
  • + Conversion factor 10³ m +
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#nonNegativeInteger + +
+
+
+
+
+ +
+
Example
+
500000
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
lifeTime
+
+ + +
+
+ +
+
Physical Dimension
+
+ +Physical dimensions are properties associated with physical quantities for purposes of classification or differentiation. These attributes are mentioned in the ESPR provisional agreement from January 9th, Article 7: +(2) (b) (i) information on the performance of the product in relation to one or more of the product parameters referred to in Annex I; +Annex I (i) weight and volume of the product and its packaging, and the product-to-packaging ratio. + +
+
Name
+
physicalDimension
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#PhysicalDimensionEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
physicalDimension
+
+ + +
+
+
+
+

Chemical Material Entity

+
+
+ Material entity with attributes if applicable to the product. +
+ +
+

Properties

+
+
+ +
+
Applicable
+
+ +Check whether the connected attributes are applicable to the product. If it is not applicable (false), dummy data can be delivered. + +
+
Name
+
applicable
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#boolean + +
+
+
+
+
+ +
+
Example
+
true
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
applicable
+
+ + +
+
+ +
+
Material
+
+ +Information on different materials in the product. + +
+
Name
+
chemicalMaterial
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#MaterialEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
content
+
+ + +
+
+
+
+

ClassificationEntity

+
+
+ Encapsulates data related to the classification of the part. +
+ +
+

Properties

+
+
+ +
+
Classification Standard
+
+ +Identified classification standards that align to the Catena-X needs. + +
+
Name
+
classificationStandard
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
GIN 20510-21513
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
classificationStandard
+
+ + +
+
+ +
+
Classification ID
+
+ +The classification ID of the part type according to the corresponding standard definition mentioned in the key value pair. + +
+
Name
+
classificationID
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
1004712
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
classificationID
+
+ + +
+
+ +
+
Classification Description
+
+ +Optional property describing the classification standard. + +
+
Name
+
classificationDescription
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Generic standard for classification of parts in the automotive industry.
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
classificationDescription
+
+ + +
+
+
+
+

Code Entity

+
+
+ Code entity with code key and value. +
+ +
+

Properties

+
+
+ +
+
Code Key
+
+ +The code key for the identification of the product. Examples are GTIN, hash, DID, ISBN, TARIC. This attribute is mentioned in the ESPR proposal from March 30th, 2022 ANNEX III: +(b) the unique product identifier at the level indicated in the applicable delegated act adopted pursuant to Article 4; +(c) the Global Trade Identification Number as provided for in standard ISO/IEC 15459-6 or equivalent of products or their parts; +(d) relevant commodity codes, such as a TARIC code as defined in Council Regulation (EEC) No 2658/87. + +
+
Name
+
codeKey
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
TARIC
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
key
+
+ + +
+
+ +
+
Code Value
+
+ +The code value for the identification of the product in regard to the chosen code name. + +
+
Name
+
codeValue
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
8703 24 10 00
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
value
+
+ + +
+
+
+
+

Commercial Entity

+
+
+ Commercial information. +
+ +
+

Properties

+
+
+ +
+
Placed on Market
+
+ +The timestamp in the format (yyyy-mm-dd) with or without time zone when the product was put in the market. + +
+
Name
+
placedOnMarket
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
2000-01-01
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
placedOnMarket
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + Date Constraint +
    + +
    +
    Description
    +
    Constraint fo a timestamp in the format (yyyy-mm-dd).
    +
    + + +
    +
    Regular expression
    +
    ^\d{4}-\d{2}-\d{2}$
    +
    + +
    • +
+
+
+
+
+ +
+
Purpose
+
+ +One or more intended industry/industries of the product described by the digital product passport. If exchanged via Catena-X, 'automotive ' is a must choice included in the list. + +
+
Name
+
purpose
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
automotive
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
purpose
+
+ + +
+
+
+
+

Data Carrier Entity

+
+
+ Data Carrier Entity with type and layout of the data carrier. +
+ +
+

Properties

+
+
+ +
+
Carrier Type
+
+ +The type of data carrier such as a QR code on the product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 8: +(2) (b) the types of data carrier to be used. + +
+
Name
+
carrierType
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
QR
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
carrierType
+
+ + +
+
+ +
+
Carrier Layout
+
+ +The positioning of data carrier on the product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 8: +(2) (c) the layout in which the data carrier shall be presented and its positioning. + +
+
Name
+
carrierLayout
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
upper-left side
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
carrierLayout
+
+ + +
+
+
+
+

Document Entity

+
+
+ Document entity with header, content, category and type. +
+ +
+

Properties

+
+
+ +
+
Content
+
+ +The content of the document e.g a link. + +
+
Name
+
content
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
https://dummy.link
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
content
+
+ + +
+
+ +
+
Category
+
+ +The category in which the document can be sorted. These are mentioned in the ESPR proposal from March 30th, 2022 ANNEX III: +(e) compliance documentation and information required under this Regulation or other Union law applicable to the product, such as the declaration of conformity, technical documentation or conformity certificates; +ANNEX IV states additional information regarding the content of the technical documentation +Further information on documents are mentioned in the proposal from March 30th, 2022 ANNEX III: +(f) user manuals, instructions, warnings or safety information, as required by other Union legislation applicable to the product. +Additionally requirements are mentioned in Article 21: +(7) Manufacturers shall ensure that that a product covered by a delegated act adopted pursuant to Article 4 is accompanied by instructions that enable consumers and other end-users to safely assemble, install, operate, store, maintain, repair and dispose of the product in a language that can be easily understood by consumers and other end-users, as determined by the Member State concerned. Such instructions shall be clear, understandable and legible and include at least the information specified in the delegated acts adopted pursuant to Article 4 and pursuant to Article 7(2)(b), point (ii). +Article 7 states additionally: +(2) (b) (ii) information for consumers and other end-users on how to install, use, maintain and repair the product in order to minimize its impact on the environment and to ensure optimum durability, as well as on how to return or dispose of the product at end-of-life; +(2) (b) (iii) information for treatment facilities on disassembly, recycling, or disposal at end-of-life; +(2) (b) (iv) other information that may influence the way the product is handled by parties other than the manufacturer in order to improve performance in relation to product parameters referred to in Annex I. +(5) (d) relevant instructions for the safe use of the product. + +
+
Name
+
category
+
+ + + +
+
Characteristic
+
+
+
+
Enumeration
+
+
+
Values
+
+
+
+
    +
  • Product Specifications
    • +
  • Manufacturer Information
    • +
  • User Manuals and Guides
    • +
  • Certifications and Compliance
    • +
  • Product Images and Videos
    • +
  • Warranty Information
    • +
  • Reviews and Ratings
    • +
  • Product Variations
    • +
  • Supply Chain Information
    • +
  • Environmental Impact
    • +
  • Compatibility and Accessories
    • +
  • FAQs and Support
    • +
  • Purchase and Retail Information
    • +
  • Privacy and Data Handling
    • +
  • Third-Party Integrations
    • +
  • Legal Information
    • +
  • Safety Information
    • +
  • Repair and Installation
    • +
  • Waste Generation and Prevention
    • +
  • Specific Voluntary Labels
    • +
  • Product Packaging
    • +
  • Return and Disposal
    • +
  • End of Life
    • +
  • Material and Substance Information
    • +
  • Technical Documentation
    • +
  • Treatment facilities
    • +
  • Other
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Legal Information
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
category
+
+ + +
+
+ +
+
Content Type
+
+ +The type of content which can be expected in the "content" property. Examples are a link, restricted link, pdf, excel, etc. + +
+
Name
+
contentType
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
URL
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
type
+
+ + +
+
+ +
+
Header
+
+ +The header as a short description of the document with a maximum of 100 characters. + +
+
Name
+
header
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Example Document XYZ
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
header
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + Header Constraint +
    + +
    +
    Description
    +
    Constraint for a maximum of 100 characters.
    +
    + + +
    +
    Max. length
    +
    100
    +
    + +
    • +
+
+
+
+
+
+
+

Documentation Entity

+
+
+ Entity for a document with a header, type and content. +
+ +
+

Properties

+
+
+ +
+
Content
+
+ +The content of the document e.g a link. + +
+
Name
+
content
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
https://dummy.link
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
content
+
+ + +
+
+ +
+
Content Type
+
+ +The type of content which can be expected in the "content" property. Examples are a link, restricted link, pdf, excel, etc. + +
+
Name
+
contentType
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
URL
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
contentType
+
+ + +
+
+ +
+
Header
+
+ +The header as a short description of the document with a maximum of 100 characters. + +
+
Name
+
header
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Example Document XYZ
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
header
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + Header Constraint +
    + +
    +
    Description
    +
    Constraint for a maximum of 100 characters.
    +
    + + +
    +
    Max. length
    +
    100
    +
    + +
    • +
+
+
+
+
+
+
+

Electrical Machine Entity

+
+
+ Entity for the electrical machine with power, torque and speed values. +
+ +
+

Properties

+
+
+ +
+
Machine Torque
+
+ +The torque of the electrical machine. + +
+
Name
+
machineTorque
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.transmission.transmission_pass:3.0.0#MachineTorqueEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
torque
+
+ + +
+
+ +
+
Machine Power
+
+ +The power of the electrical machine. + +
+
Name
+
machinePower
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.transmission.transmission_pass:3.0.0#MachinePowerEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
power
+
+ + +
+
+ +
+
Machine Voltage
+
+ +Nominal voltage of the electric system in volt. + +
+
Name
+
machineVoltage
+
+ + + +
+
Characteristic
+
+
+
+
Measurement
+
+
+
Measurement in voltage.
+
+
+
Unit
+
+
+
+
    +
  • + volt +
    • +
  • + Symbol V +
    • +
  • + Code VLT +
    • +
  • + Conversion factor V +
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#decimal + +
+
+
+
+
+ +
+
Example
+
52
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
voltage
+
+ + +
+
+ +
+
Machine Speed
+
+ +Maximum allowable speed for the electric motor in revolutions per minute. + +
+
Name
+
machineSpeed
+
+ + + +
+
Characteristic
+
+
+
+
Measurement
+
+
+
The permissible maximum input speed in revolutions per minute in the respective gear.
+
+
+
Unit
+
+
+
+
    +
  • + revolutions per minute +
    • +
  • + Symbol r/min +
    • +
  • + Code RPM +
    • +
  • + Conversion factor 1.67 × 10⁻²/s +
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#nonNegativeInteger + +
+
+
+
+
+ +
+
Example
+
16700
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
speed
+
+ + +
+
+
+
+

Facility Entity

+
+
+ The entity for a facility with the BPNA identifier. +
+ +
+

Properties

+
+
+ +
+
Facility
+
+ +The identifier used for a location. This attribute is mentioned in the ESPR provisional agreement from January 9th 2024 Annex III: +(i) unique facility identifiers; +Article 2 Definitions: (33) 'unique facility identifier' means a unique string of characters for the identification of locations or buildings involved in the value chain of a product or used by actors involved in the value chain of a product. + +
+
Name
+
facility
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
    +
  • https://catena-x.net/fileadmin/user_upload/Standard-Bibliothek/Update_PDF_Maerz/5_BPDM/CX_-_0010_BUSINESS_PARTNER_NUMBER_PlatformCapabilityBPDM_v_1.0.1.pdf
    • +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
BPNA1234567890AA
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
facility
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + BPNA Regular Expression +
    + +
    +
    Description
    +
    The provided regular expression ensures that the BPNA is composed of prefix 'BPNA', 10 digits and two alphanumeric letters.
    +
    + + +
    +
    Regular expression
    +
    ^BPNA[a-zA-Z0-9]{12}$
    +
    + +
    • +
+
+
+
+
+
+
+

Footprint Entity

+
+
+ Footprint Entity for the carbon and environmental footprint with the total value, unit, impact category type, lifecycle, rulebook, declaration, performance class and the facility. +
+ +
+

Properties

+
+
+ +
+
Footprint Value
+
+ +The value of the footprint of the product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Annex I: +(l) the environmental footprint of the product, expressed as a quantification, in accordance with the applicable delegated act, of a product's life cycle environmental impacts, whether in relation to one or more environmental impact categories or an aggregated set of impact categories; +(m) the carbon footprint of the product; +(ma) the material footprint of the product. + + +
+
Name
+
footprintValue
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#float + +
+
+
+
+
+ +
+
Example
+
12.678
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
value
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + Positive Range Constraint +
    + +
    +
    Description
    +
    Constraint for only positive values.
    +
    + + +
    +
    +>= +
    + DefaultScalarValue[value=0.0, typeUri='DefaultScalar[metaModelVersion=SAMM_2_1_0, urn='http://www.w3.org/2001/XMLSchema#float']'] +
    +
    + +
    • +
+
+
+
+
+ +
+
Footprint Rulebook
+
+ +The applied rulebook for the environmental footprint of the product. + +
+
Name
+
footprintRulebook
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#DocumentationEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
rulebook
+
+ + +
+
+ +
+
Footprint Lifecycle
+
+ +The lifecycle stage, to which the environmental footprint corresponds. These could be for example "raw material acquisition and pre-processing", "main product production", "distribution" or "end of life and recycling". + +
+
Name
+
footprintLifecycle
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
main product production
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
lifecycle
+
+ + +
+
+ +
+
Footprint Unit
+
+ +The unit of measurement of the environmental impact category. For each impact category a specific unit is used. If an aggregation is used, utilize the normalization and weighting methods used in the referenced rulebook. + +
+
Name
+
footprintUnit
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
kg CO2 / kWh
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
unit
+
+ + +
+
+ +
+
Footprint Type
+
+ +The type of the environmental footprint of the product. This could be one of the environmental impact categories. This attribute is mentioned in the ESPR provisional agreement from January 9th 2024 Article 7: +(2)(b)(i) information on the performance of the product in relation to one or more of the product parameters referred to in Annex I, including a scoring of reparability or durability, carbon footprint or environmental footprint; +Annex I: +(l) the environmental footprint of the product, expressed as a quantification, in accordance with the applicable delegated act, of a product's life cycle environmental impacts, whether in relation to one or more environmental impact categories or an aggregated set of impact categories. +(m) the carbon footprint of the product; +(ma) the material footprint of the product. + +
+
Name
+
footprintType
+
+ + + +
+
Characteristic
+
+
+
+
Enumeration
+
+
+
Values
+
+
+
+
    +
  • Climate Change Total
    • +
  • Climate Change Fossil
    • +
  • Climate Change Biogenic Removals and Emissions
    • +
  • Climate Change Land Use and Land Use Change
    • +
  • Ozone Depletion
    • +
  • Acidification
    • +
  • Eutrophication Aquatic Freshwater
    • +
  • Eutrophication Fresh Marine
    • +
  • Eutrophication Terrestrial
    • +
  • Photochemical Ozone Formation
    • +
  • Abiotic Depletion- Minerals and Metals
    • +
  • Fossil Fuels
    • +
  • Water Use
    • +
  • Particulate Matter Emissions
    • +
  • Ionizing Radiation, Human Health
    • +
  • Eco-Toxicity
    • +
  • Human Toxicity, Cancer Effects
    • +
  • Human Toxicity, Non-Cancer Effects
    • +
  • Land Use Related Impacts/Soil Quality
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Climate Change
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
type
+
+ + +
+
+ +
+
Performance Class
+
+ +The performance classification of the footprint. + +
+
Name
+
performanceClass
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
A
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
performanceClass
+
+ + +
+
+ +
+
Manufacturing Plant
+
+ +The manufacturing plant of the footprint in the specific lifecycle phase. + +
+
Name
+
manufacturingPlant
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#FacilityEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
manufacturingPlant
+
+ + +
+
+ +
+
Declaration
+
+ +The footprint declaration in the format of a link + +
+
Name
+
declaration
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#DocumentationEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
declaration
+
+ + +
+
+
+
+

Gear Ratio Entity

+
+
+ Entity for the ratio in the respective gear. Includes the gear and the ratio as separate properties. +
+ +
+

Properties

+
+
+ +
+
Gear
+
+ +Respective gear for the measurement. + +
+
Name
+
gear
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
1
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
gear
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + Gear Constraint +
    + +
    +
    Description
    +
    Constraint to match a gear from 1 to 18 or R (reverse).
    +
    + + +
    +
    Regular expression
    +
    ^(1[0-8]|[1-9]|R)$
    +
    + +
    • +
+
+
+
+
+ +
+
Gear Ratio
+
+ +The ratio in the respective gear (ratio between transmission input speed and transmission output speed). + +
+
Name
+
gearRatio
+
+ + + +
+
Characteristic
+
+
+
+
Quantifiable
+
+
+
Duration
+
+
+
The ratio in the respective gear.
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#float + +
+
+
+
+
+ +
+
Example
+
4.1567
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
gearRatio
+
+ + +
+
+
+
+

Generic Entity

+
+
+ Entity for the product generic parameters. +
+ +
+

Properties

+
+
+ +
+
Characteristics
+
+ +Defines specific characteristics of the transmission. + +
+
Name
+
characteristics
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.transmission.transmission_pass:3.0.0#CharacteristicsEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
characteristics
+
+ + +
+
+ +
+
Metadata
+
+ +Metadata of the product passport. These are mentioned in the ESPR proposal from March 30th, 2022 and some changed by the provisional agreement from January 9th, 2024. + +
+
Name
+
metadata
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#MetadataEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
metadata
+
+ + +
+
+ +
+
Identification
+
+ +Identification information of the product, especially identifiers and codes. These are mentioned in the ESPR provisional agreement from January 9th, 2024 ANNEX III: +(b) the unique product identifier at the level indicated in the applicable delegated act adopted pursuant to Article 4. +Additionally in Article 9 regarding general requirements for the product passport is stated that: +A product passport shall meet the following conditions: +(a) it shall be connected through a data carrier to a persistent unique product identifier; +(e) the information included in the product passport shall refer to the product model, batch, or item as specified in the delegated act adopted pursuant to Article 4. +Article 2 Definitions: +(31) 'unique product identifier' means a unique string of characters for the identification of products that also enables a web link to the product passport; +Recital (27): A 'model' usually means a version of a product of which all units share the same technical characteristics relevant for the ecodesign requirements and the same model identifier, a 'batch' usually means a subset of a specific model composed of all products produced in a specific manufacturing plant at a specific moment in time and an 'item' usually means a single unit of a model. + +
+
Name
+
identification
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#IdentificationEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
identification
+
+ + +
+
+ +
+
Operation
+
+ +Operational information of the product. + +
+
Name
+
operation
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#OperationEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
operation
+
+ + +
+
+ +
+
handling
+
+ +Properties connected with the handling of the product. + +
+
Name
+
handling
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#HandlingEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
handling
+
+ + +
+
+ +
+
Commercial
+
+ +Commercial information of the product. + +
+
Name
+
commercial
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#CommercialEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
commercial
+
+ + +
+
+ +
+
Materials
+
+ +Properties which are relevant for the materials of the product. + +
+
Name
+
materials
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#MaterialsEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
materials
+
+ + +
+
+ +
+
Sustainability
+
+ +Sustainability related attributes. + +
+
Name
+
sustainability
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#SustainabilityEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
sustainability
+
+ + +
+
+ +
+
Sources
+
+ +Documents that are mandatory if applicable for the product. These are mentioned in the ESPR provisional agreement from January 9th, 2024 ANNEX III: +(e) compliance documentation and information required under this Regulation or other Union law applicable to the product, such as the declaration of conformity, technical documentation or conformity certificates; +(f) user manuals, instructions, warnings or safety information, as required by other Union legislation applicable to the product. +Additionally requirements are mentioned in Article 21: +7. Manufacturers shall ensure that a product covered by a delegated act adopted pursuant to Article 4 is accompanied by instructions in digital format that enable customers and other relevant actors to assemble, install, operate, store, maintain, repair and dispose of the product in a language that can be easily understood, as determined by the Member State concerned. Such instructions shall be clear, understandable and legible and include at least the information set out in Article 7(2), point (b), point (ii) specified in the delegated acts adopted pursuant to Article 4. +Article 7 states additionally: +(ii) information for customers and other actors on how to install, use, maintain and repair the product, in order to minimise its impact on the environment and to ensure optimum durability, on how to install third-party operating systems where relevant, as well as on collection for refurbishment or remanufacture, and on how to return or handle the product at the end of its life; +(2) (b) (iii) information for treatment facilities on disassembly, reuse, refurbishment, recycling, or disposal at end-of-life; +(2) (b) (iv) other information that may influence sustainable product choices for customers and the way the product is handled by parties other than the manufacturer in order to facilitate appropriate use, value retaining operations and correct treatment at end-of-life. +(5) (d) relevant instructions for the safe use of the product. +(5) (e) information relevant for disassembly, preparation for reuse, reuse, recycling and the environmentally sound management of the product at the end of its life. +Annex I: +(b) [...] availability of repair and maintenance instructions, number of materials and components used, use of standard components,[...] number and complexity of processes and whether specialised toolsare needed, ease of non-destructive disassembly and re-assembly, conditions for access to product data, conditions for access to or use of hardware and software needed; +(c) ease of upgrading, re-use, remanufacturing and refurbishment as expressed through: [...] number and complexity of processes and tools needed, ease of non-destructive disassembly and re-assembly, conditions for access to product data, conditions for access to or use of hardware and software needed, conditions of access to test protocols or not commonly available testing equipment, availability of guarantees specific to remanufactured or refurbished products, conditions for access to or use of technologies protected by intellectual property rights, modularity; +(d) design for recycling, ease and quality of recycling as expressed through: use of easily recyclable materials, safe, easy and non-destructive access to recyclable components and materials or components and materials containing hazardous substances and material composition and homogeneity, possibility for high-purity sorting, [...] number and complexity of processes and tools needed, ease of nondestructive disassembly and re-assembly, conditions for access to product data, conditions for access to or use of hardware and software needed; +(q) functional performance and conditions for use including as expressed through ability in performing its intended use, precautions of use, skills required, compatibility with other products or systems. +Additionally to consider are guidelines and instructions regarding the proper management and disposal of packaging materials after use. This can include instructions for separation, reuse, and recycling. + +
+
Name
+
sources
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#DocumentEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
sources
+
+ + +
+
+
+
+

Handling Entity

+
+
+ Entity to describe different aspects in relation with the handling of the product with attributes if applicable to the product. +
+ +
+

Properties

+
+
+ +
+
spareParts
+
+ +The list of spare parts available for the product from various suppliers. + +
+
Name
+
spareParts
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#SparePartEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
content
+
+ + +
+
+ +
+
Applicable
+
+ +Check whether the connected attributes are applicable to the product. If it is not applicable (false), dummy data can be delivered. + +
+
Name
+
applicable
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#boolean + +
+
+
+
+
+ +
+
Example
+
true
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
applicable
+
+ + +
+
+
+
+

Hazard Entity

+
+
+ Entity for the hazardous classification. +
+ +
+

Properties

+
+
+ +
+
Hazard Category
+
+ +The hazard category of the substance of concern. Defined in Article 2 of Regulation (EC) No 1272/2008 of the European Parliament and of the Council of 16 December 2008 on classification, labelling and packaging of substances and mixtures, amending and repealing Directives 67/548/EEC and 1999/45/EC, and amending Regulation (EC) No 1907/2006: +2. 'hazard category' means the division of criteria within each hazard class, specifying hazard severity. + +
+
Name
+
hazardCategory
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
category 1A
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
category
+
+ +
+
Reference
+
+
    +
  • https://eur-lex.europa.eu/legal-content/EN/TXT/?uri=CELEX:02008R1272-20231201
    • +
+
+
+ +
+
+ +
+
Hazard Class
+
+ +The hazard class of the substance of concern. Defined in Article 2 of Regulation (EC) No 1272/2008 of the European Parliament and of the Council of 16 December 2008 on classification, labelling and packaging of substances and mixtures, amending and repealing Directives 67/548/EEC and 1999/45/EC, and amending Regulation (EC) No 1907/2006: +1. 'hazard class' means the nature of the physical, health or environmental hazard. + +
+
Name
+
hazardClass
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Skin corrosion
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
class
+
+ +
+
Reference
+
+
    +
  • https://eur-lex.europa.eu/legal-content/EN/TXT/?uri=CELEX:02008R1272-20231201
    • +
+
+
+ +
+
+ +
+
Hazard Statement
+
+ +The hazard statement of the substance of concern. Defined in Article 2 of Regulation (EC) No 1272/2008 of the European Parliament and of the Council of 16 December 2008 on classification, labelling and packaging of substances and mixtures, amending and repealing Directives 67/548/EEC and 1999/45/EC, and amending Regulation (EC) No 1907/2006: +5. 'hazard statement' means a phrase assigned to a hazard class and category that describes the nature of the hazards of a hazardous substance or mixture, including, where appropriate, the degree of hazard. + +
+
Name
+
hazardStatement
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Causes severe skin burns and eye damage.
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
statement
+
+ +
+
Reference
+
+
    +
  • https://eur-lex.europa.eu/legal-content/EN/TXT/?uri=CELEX:02008R1272-20231201
    • +
+
+
+ +
+
+
+
+

Identification Entity

+
+
+ Entity with identification information of the product with part type information, local identifiers, other codes and the data carrier. +
+ +
+

Properties

+
+
+ +
+
Serial Information
+
+ +Identifier for a serial part if available. This is mentioned in the ESPR provisional agreement from January 9th, 2024 Recital (27): +[...] an 'item' usually means a single unit of a model. + +
+
Name
+
serialInformation
+
+ + + +
+
Characteristic
+
+
+
+
Set
+
+
+
Has no order
+
+
+
Duplicates not allowed
+
+
+
+ Type urn:samm:io.catenax.serial_part:3.0.0#KeyValueList + +
+
+
+
+
+ + +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
serial
+
+ + +
+
+ +
+
Batch Information
+
+ +Identifier for a batch part if available. Identifier for a serial part if available. This is mentioned in the ESPR provisional agreement from January 9th, 2024 Recital (27): +[...] a 'batch' usually means a subset of a specific model composed of all products produced in a specific manufacturing plant at a specific moment in time [...]. + +
+
Name
+
batchInformation
+
+ + + +
+
Characteristic
+
+
+
+
Set
+
+
+
Has no order
+
+
+
Duplicates not allowed
+
+
+
+ Type urn:samm:io.catenax.batch:3.0.0#KeyValueList + +
+
+
+
+
+ + +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
batch
+
+ + +
+
+ +
+
Part Type Information
+
+ +Identifier on the level of a part model or type. Identifier for a serial part if available. This is mentioned in the ESPR provisional agreement from January 9th, 2024 Recital (27): +[...] A 'model' usually means a version of a product of which all units share the same technical characteristics relevant for the ecodesign requirements and the same model identifier [...]. + +
+
Name
+
partTypeInformation
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#PartTypeEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
type
+
+ + +
+
+ +
+
Codes
+
+ +Codes for identification. + +
+
Name
+
codes
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#CodeEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
codes
+
+ + +
+
+ +
+
Data Carrier
+
+ +The type and layout of the data carrier on the product. These are mentioned in the ESPR proposal from March 30th, 2022 Article 8: +(b) the types of data carrier to be used; +(c) the layout in which the data carrier shall be presented and its positioning; +Article 2 defines: +(30) 'data carrier' means a linear bar code symbol, a two-dimensional symbol or other automatic identification data capture medium that can be read by a device. + +
+
Name
+
dataCarrier
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#DataCarrierEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
dataCarrier
+
+ + +
+
+ +
+
Part Classification
+
+ +Property describing the classification of a part. + +
+
Name
+
partClassification
+
+ + + +
+
Characteristic
+
+
+
+
SortedSet
+
+
+
Has a certain order
+
+
+
Duplicates not allowed
+
+
+
+ Type urn:samm:io.catenax.shared.part_classification:1.0.0#ClassificationEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
classification
+
+ + +
+
+
+
+

Import Entity

+
+
+ Import entity with attributes if applicable to the product. +
+ +
+

Properties

+
+
+ +
+
Importer
+
+ +Information regarding the importer of the product, if different from the owner of the passport. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex III: +(j) information related to the importer, including the information referred to in Article 23(3) and its EORI number; +Article 23 states: +(3) Importers shall, for products covered by a delegated act adopted pursuant to Article 4, indicate their name, registered trade name or registered trade mark and the postal address and electronic means of communication, where they can be contacted: (a) on the public part of the product passport, when applicable, and +(b) on the product or, where this is not possible, on the packaging, or in a document accompanying the product. + +
+
Name
+
importer
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#ImporterEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
content
+
+ + +
+
+ +
+
Applicable
+
+ +Check whether the connected attributes are applicable to the product. If it is not applicable (false), dummy data can be delivered. + +
+
Name
+
applicable
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#boolean + +
+
+
+
+
+ +
+
Example
+
true
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
applicable
+
+ + +
+
+
+
+

Importer Entity

+
+
+ Entity with information regarding the importer such as the identification and the EORI. +
+ +
+

Properties

+
+
+ +
+
EORI
+
+ +An economic operator established in the customs territory of the Union needs, for customs purposes, an EORI number. EORI stands for economic operators registration and identification number. In this case, the importer's EORI must be provided. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Annex III: +(j) information related to the importer, including the information referred to in Article 23(3) and its EORI number. + +
+
Name
+
eori
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
GB123456789000
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
eori
+
+ +
+
Reference
+
+
    +
  • https://taxation-customs.ec.europa.eu/customs-4/customs-procedures-import-and-export-0/customs-procedures/economic-operators-registration-and-identification-number-eori_en
    • +
+
+
+ +
+
Constraints
+
+
    +
  • +
    + +
    + EORI Constraint +
    + +
    +
    Description
    +
    Constraint with a pattern which ensures that the EORI number starts with two alphanumeric characters, followed by two alphabetic characters, and ends with 2 to 15 alphanumeric characters.
    +
    + + +
    +
    Regular expression
    +
    ^[A-Z]{2}[A-Z0-9]{1,18}$
    +
    + +
    • +
+
+
+
+
+ +
+
Importer Identification
+
+ +The importer of the product, if different from the owner of the passport. In the Catena-X network, the BPNL is used for the identification of companies and the information stored for this like contact information and addresses. +This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex III: +(j) information related to the importer, including the information referred to in Article 23(3) and its EORI number; +Article 23 states: +(3) Importers shall, for products covered by a delegated act adopted pursuant to Article 4, indicate their name, registered trade name or registered trade mark and the postal address and electronic means of communication, where they can be contacted: (a) on the public part of the product passport, when applicable, and +(b) on the product or, where this is not possible, on the packaging, or in a document accompanying the product. + +
+
Name
+
importerIdentification
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
    +
  • https://catena-x.net/fileadmin/user_upload/Standard-Bibliothek/Update_PDF_Maerz/5_BPDM/CX_-_0010_BUSINESS_PARTNER_NUMBER_PlatformCapabilityBPDM_v_1.0.1.pdf
    • +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
BPNL0123456789ZZ
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
id
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + BPNL Regular Expression +
    + +
    +
    Description
    +
    The provided regular expression ensures that the BPNL is composed of prefix 'BPNL', 10 digits and two alphanumeric letters.
    +
    + + +
    +
    Regular expression
    +
    ^BPNL[a-zA-Z0-9]{12}$
    +
    + +
    • +
+
+
+
+
+
+
+

Key Value List

+
+
+ A list of key value pairs for local identifiers, which are composed of a key and a corresponding value. +
+ +
+

Properties

+
+
+ +
+
Identifier Key
+
+ +The key of a local identifier. + +
+
Name
+
key
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
partInstanceId
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
key
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + Key Regular Expression +
    + +
    +
    Description
    +
    Constraint that ensures that the standard keys and custom key prefixes can be used.
    +
    + + +
    +
    Regular expression
    +
    ^(manufacturerId|partInstanceId|batchId|van|customKey:\w+)$
    +
    + +
    • +
+
+
+
+
+ +
+
Identifier Value
+
+ +The value of an identifier. + +
+
Name
+
value
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
SN12345678
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
value
+
+ + +
+
+
+
+

Key Value List

+
+
+ A list of key value pairs for local identifiers, which are composed of a key and a corresponding value. +
+ +
+

Properties

+
+
+ +
+
Identifier Key
+
+ +The key of a local identifier. + +
+
Name
+
key
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
batchId
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
key
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + Key Regular Expression +
    + +
    +
    Description
    +
    Constraint that ensures that the predefined keys are used.
    +
    + + +
    +
    Regular expression
    +
    ^(manufacturerId|batchId|customKey:\w+)$
    +
    + +
    • +
+
+
+
+
+ +
+
Identifier Value
+
+ +The value of an identifier. + +
+
Name
+
value
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
BID12345678
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
value
+
+ + +
+
+
+
+

Linear Entity

+
+
+ Entity for linear measurements of an item with an unit and value. +
+ +
+

Properties

+
+
+ +
+
Quantity Value
+
+ +The quantity value associated with the unit. + +
+
Name
+
quantityValue
+
+ + + +
+
Characteristic
+
+
+
+
Quantifiable
+
+
+
Duration
+
+
+
The quantity value associated with the unit expressed as float.
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#float + +
+
+
+
+
+ +
+
Example
+
20.0
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
value
+
+ + +
+
+ +
+
Linear Unit
+
+ +The unit of a linear attribute. + +
+
Name
+
linearUnit
+
+ + + +
+
Characteristic
+
+
+
+
Enumeration
+
+
+
Values
+
+
+
+
    +
  • unit:millimetre
    • +
  • unit:centimetre
    • +
  • unit:metre
    • +
  • unit:kilometre
    • +
  • unit:inch
    • +
  • unit:foot
    • +
  • unit:yard
    • +
+
+
+
+
+ Reference +
+
    +
  • https://eclipse-esmf.github.io/samm-specification/2.1.0/index.html
    • +
+
+
+
+
+
+ Type urn:samm:org.eclipse.esmf.samm:meta-model:2.1.0#curie + +
+
+
+
+
+ +
+
Example
+
unit:millimetre
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
unit
+
+ +
+
Reference
+
+
    +
  • https://eclipse-esmf.github.io/samm-specification/2.1.0/index.html
    • +
+
+
+ +
+
+
+
+

Machine Power Entity

+
+
+ The entity for the electrical machine power. +
+ +
+

Properties

+
+
+ +
+
Maximum Power
+
+ +The maximum output power in kilowatts for a specified time period. + +
+
Name
+
maximumPower
+
+ + + +
+
Characteristic
+
+
+
+
Measurement
+
+
+
The performance power in kilowatt as non-negative integer.
+
+
+
Unit
+
+
+
+
    +
  • + kilowatt +
    • +
  • + Symbol kW +
    • +
  • + Code KWT +
    • +
  • + Conversion factor 10³ W +
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#nonNegativeInteger + +
+
+
+
+
+ +
+
Example
+
22
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
max
+
+ + +
+
+ +
+
Continuous Power
+
+ +The power that can be delivered without time limit. + +
+
Name
+
continuousPower
+
+ + + +
+
Characteristic
+
+
+
+
Measurement
+
+
+
The performance power in kilowatt as non-negative integer.
+
+
+
Unit
+
+
+
+
    +
  • + kilowatt +
    • +
  • + Symbol kW +
    • +
  • + Code KWT +
    • +
  • + Conversion factor 10³ W +
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#nonNegativeInteger + +
+
+
+
+
+ +
+
Example
+
16
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
continuous
+
+ + +
+
+ +
+
Maximum Availability
+
+ +Specified time period for the peak measurement in seconds. + +
+
Name
+
maximumAvailability
+
+ + + +
+
Characteristic
+
+
+
+
Measurement
+
+
+
Time in seconds.
+
+
+
Unit
+
+
+
+
    +
  • + second [unit of time] +
    • +
  • + Symbol s +
    • +
  • + Code SEC +
    • +
  • + Conversion factor s +
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#nonNegativeInteger + +
+
+
+
+
+ +
+
Example
+
10
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
maximumAvailability
+
+ + +
+
+
+
+

Machine Torque Entity

+
+
+ The entity for the electrical machine torque. +
+ +
+

Properties

+
+
+ +
+
MaximumTorque
+
+ +The maximum output torque in newton meters for a specified time period. + +
+
Name
+
maximumTorque
+
+ + + +
+
Characteristic
+
+
+
+
Measurement
+
+
+
Characteristic to describe torque in newton meters.
+
+
+
Unit
+
+
+
+
    +
  • + newton metre +
    • +
  • + Symbol N·m +
    • +
  • + Code NU +
    • +
  • + Conversion factor N × m +
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#nonNegativeInteger + +
+
+
+
+
+ +
+
Example
+
180
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
max
+
+ + +
+
+ +
+
Maximum Availability
+
+ +Specified time period for the peak measurement in seconds. + +
+
Name
+
maximumAvailability
+
+ + + +
+
Characteristic
+
+
+
+
Measurement
+
+
+
Time in seconds.
+
+
+
Unit
+
+
+
+
    +
  • + second [unit of time] +
    • +
  • + Symbol s +
    • +
  • + Code SEC +
    • +
  • + Conversion factor s +
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#nonNegativeInteger + +
+
+
+
+
+ +
+
Example
+
10
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
maximumAvailability
+
+ + +
+
+ +
+
Continuous Torque
+
+ +The torque that can be delivered without time limit in newton meters. + +
+
Name
+
continuousTorque
+
+ + + +
+
Characteristic
+
+
+
+
Measurement
+
+
+
Characteristic to describe torque in newton meters.
+
+
+
Unit
+
+
+
+
    +
  • + newton metre +
    • +
  • + Symbol N·m +
    • +
  • + Code NU +
    • +
  • + Conversion factor N × m +
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#nonNegativeInteger + +
+
+
+
+
+ +
+
Example
+
178
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
continuous
+
+ + +
+
+
+
+

Manufacturer Entity

+
+
+ Manufacturing Entity with the identification of the main manufacturer and the facility location as well as the manufacturing date. +
+ +
+

Properties

+
+
+ +
+
Facility Identification
+
+ +The identifier used for a location. In the CATENA-X use case, the BPNA can be stated. This attribute is mentioned in the ESPR provisional agreement from January 9th 2024 Annex III: +(i) unique facility identifiers; +Article 2 Definitions: (33) 'unique facility identifier' means a unique string of characters for the identification of locations or buildings involved in the value chain of a product or used by actors involved in the value chain of a product. + +
+
Name
+
facilityIdentification
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#FacilityEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
facility
+
+ + +
+
+ +
+
Manufacturer Identification
+
+ +The main manufacturer, if different from the passport owner, represented by an identification number. In the Catena-X use case, the BPNL can be stated. This attribute is mentioned in the ESPR provisional agreement from January 9th 2024 Annex III: +(h) unique operator identifiers other than that of the manufacturer; +(k) the name, contact details and unique operator identifier code of the economic operator established in the Union responsible for carrying out the tasks set out in Article 4 of Regulation (EU) 2019/1020, or Article 15 of Regulation (EU) [.../...] on general product safety, or similar tasks pursuant to other EU legislation applicable to the product. + +
+
Name
+
manufacturerIdentification
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
    +
  • https://catena-x.net/fileadmin/user_upload/Standard-Bibliothek/Update_PDF_Maerz/5_BPDM/CX_-_0010_BUSINESS_PARTNER_NUMBER_PlatformCapabilityBPDM_v_1.0.1.pdf
    • +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
manufacturer
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + BPNL Regular Expression +
    + +
    +
    Description
    +
    The provided regular expression ensures that the BPNL is composed of prefix 'BPNL', 10 digits and two alphanumeric letters.
    +
    + + +
    +
    Regular expression
    +
    ^BPNL[a-zA-Z0-9]{12}$
    +
    + +
    • +
+
+
+
+
+ +
+
Manufacturing Date
+
+ +The timestamp in the format (yyyy-mm-dd) of the manufacturing date as the final step in production process (e.g. final quality check, ready-for-shipment event). + +
+
Name
+
manufacturingDate
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
2000-01-31
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
manufacturingDate
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + Date Constraint +
    + +
    +
    Description
    +
    Constraint fo a timestamp in the format (yyyy-mm-dd).
    +
    + + +
    +
    Regular expression
    +
    ^\d{4}-\d{2}-\d{2}$
    +
    + +
    • +
+
+
+
+
+
+
+

Mass Entity

+
+
+ Entity for mass measurements of an item with an unit and value. +
+ +
+

Properties

+
+
+ +
+
Quantity Value
+
+ +The quantity value associated with the unit. + +
+
Name
+
quantityValue
+
+ + + +
+
Characteristic
+
+
+
+
Quantifiable
+
+
+
Duration
+
+
+
The quantity value associated with the unit expressed as float.
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#float + +
+
+
+
+
+ +
+
Example
+
20.0
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
value
+
+ + +
+
+ +
+
Mass Unit
+
+ +The unit of a mass related attribute. + +
+
Name
+
massUnit
+
+ + + +
+
Characteristic
+
+
+
+
Enumeration
+
+
+
Values
+
+
+
+
    +
  • unit:gram
    • +
  • unit:kilogram
    • +
  • unit:tonneMetricTon
    • +
  • unit:tonUsOrShortTonUkorus
    • +
  • unit:ounceAvoirdupois
    • +
  • unit:pound
    • +
+
+
+
+
+ Reference +
+
    +
  • https://eclipse-esmf.github.io/samm-specification/2.1.0/index.html
    • +
+
+
+
+
+
+ Type urn:samm:org.eclipse.esmf.samm:meta-model:2.1.0#curie + +
+
+
+
+
+ +
+
Example
+
unit:kilogram
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
unit
+
+ +
+
Reference
+
+
    +
  • https://eclipse-esmf.github.io/samm-specification/2.1.0/index.html
    • +
+
+
+ +
+
+
+
+

Material Entity

+
+
+ Information regarding recycled and/or renewable materials in the product. +
+ +
+

Properties

+
+
+ +
+
Recycled
+
+ +The share of the material, which is recovered recycled content from the product. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I: +(h) use or content of recycled materials and recovery of materials, including critical raw materials; + +
+
Name
+
recycled
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#float + +
+
+
+
+
+ +
+
Example
+
12.5
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
recycled
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + Percentage Constraint +
    + +
    +
    Description
    +
    Range constraint for a positive percentage value.
    +
    + + +
    +
    +>= +
    + DefaultScalarValue[value=0.0, typeUri='DefaultScalar[metaModelVersion=SAMM_2_1_0, urn='http://www.w3.org/2001/XMLSchema#float']'] +
    +
    ...
    +
    +< + DefaultScalarValue[value=100.0, typeUri='DefaultScalar[metaModelVersion=SAMM_2_1_0, urn='http://www.w3.org/2001/XMLSchema#float']'] +
    + +
    • +
+
+
+
+
+ +
+
Renewable
+
+ +The share of the material, which is from a renewable resource that can be replenished. Renewable resources are those that can be reproduced by physical, chemical, or mechanical processes. These are the kind of resources that can be regenerated throughout time. Forest wood, for example, can be grown through reforestation. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I: +(ha) use or content of sustainable renewable materials; + + +
+
Name
+
renewable
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#float + +
+
+
+
+
+ +
+
Example
+
23.5
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
renewable
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + Percentage Constraint +
    + +
    +
    Description
    +
    Range constraint for a positive percentage value.
    +
    + + +
    +
    +>= +
    + DefaultScalarValue[value=0.0, typeUri='DefaultScalar[metaModelVersion=SAMM_2_1_0, urn='http://www.w3.org/2001/XMLSchema#float']'] +
    +
    ...
    +
    +< + DefaultScalarValue[value=100.0, typeUri='DefaultScalar[metaModelVersion=SAMM_2_1_0, urn='http://www.w3.org/2001/XMLSchema#float']'] +
    + +
    • +
+
+
+
+
+ +
+
Material Unit
+
+ +The unit of concentration chosen from an enumeration: mass percent, volume percent, parts per thousand, parts per million, parts per billion and parts per trillion. + +
+
Name
+
materialUnit
+
+ + + +
+
Characteristic
+
+
+
+
Enumeration
+
+
+
Values
+
+
+
+
    +
  • unit:partPerMillion
    • +
  • unit:percent
    • +
  • unit:percentVolume
    • +
  • unit:partPerThousand
    • +
  • unit:partPerTrillionUs
    • +
  • unit:partPerBillionUs
    • +
+
+
+
+
+ Reference +
+
    +
  • https://eclipse-esmf.github.io/samm-specification/2.1.0/index.html
    • +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
unit:percent
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
unit
+
+ +
+
Reference
+
+
    +
  • https://eclipse-esmf.github.io/samm-specification/2.1.0/index.html
    • +
+
+
+ +
+
+ +
+
Material Identification
+
+ +The chemical material name and identification, in accordance with the specification in the attribute for the list type. Preference is given to the IUPAC name. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Article 7: +(5) (a) the name of the substances of concern present in the product, as follows: + - name(s) in the International Union of Pure and Applied Chemistry (IUPAC) nomenclature, or another international name when IUPAC name is not available; +- other names (usual name, trade name, abbreviation); +- European Community (EC) number, as indicated in the European Inventory of Existing Commercial Chemical Substances (EINECS), the European List of Notified Chemical Substances (ELINCS) or the No Longer Polymer (NLP) list or assigned by the European Chemicals Agency (ECHA), if available; +- the Chemical Abstract Service (CAS) name(s) and number(s), if available; . + +
+
Name
+
materialIdentification
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#MaterialIdEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
id
+
+ + +
+
+ +
+
Critical
+
+ +A flag, if the material is a critical raw material. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I: +(h) use or content of recycled materials and recovery of materials, including critical raw materials; +In Annex II of the connected proposal Act of Critical Raw Materials, a list of critical raw materials can be found. + +
+
Name
+
critical
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#boolean + +
+
+
+
+
+ +
+
Example
+
true
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
critical
+
+ +
+
Reference
+
+
    +
  • https://eur-lex.europa.eu/legal-content/EN/TXT/?uri=COM:2023:0160:FIN
    • +
+
+
+ +
+
+ +
+
Concentration
+
+ +Concentration of the material at the level of the product. This attribute is specially mentioned for substances of concern mentioned in the ESPR proposal from March 30th, 2022 Article 7: +(5) (c) the concentration, maximum concentration or concentration range of the substances of concern, at the level of the product [...]. +Other substances are mentioned for the purpose of recycling in the ESPR provisional agreement from January 9th, 2024 Annex I: +(d) design for recycling, ease and quality of recycling as expressed through: use of easily recyclable materials, safe, easy and non-destructive access to recyclable components and materials or components and materials containing hazardous substances and material composition and homogeneity, possibility for high-purity sorting, number of materials and components used, use of standard components, use of component and material coding standards for the identification of components and materials, number and complexity of processes and tools needed, ease of nondestructive disassembly and re-assembly, conditions for access to product data, conditions for access to or use of hardware and software needed. + + +
+
Name
+
concentration
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#float + +
+
+
+
+
+ +
+
Example
+
5.3
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
concentration
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + Positive Range Constraint +
    + +
    +
    Description
    +
    Constraint for only positive values.
    +
    + + +
    +
    +>= +
    + DefaultScalarValue[value=0.0, typeUri='DefaultScalar[metaModelVersion=SAMM_2_1_0, urn='http://www.w3.org/2001/XMLSchema#float']'] +
    +
    + +
    • +
+
+
+
+
+ +
+
Documentation
+
+ +Documentation accompanying the material. + +
+
Name
+
documentation
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#DocumentationEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
documentation
+
+ + +
+
+
+
+

Material Id Entity

+
+
+ Id Entity with identifier, name and list type. +
+ +
+

Properties

+
+
+ +
+
Chemical Id
+
+ +The substance identification, in accordance with the specification in the attribute for the list type. + +
+
Name
+
chemicalId
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
201-004-7
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
id
+
+ + +
+
+ +
+
List Type Id
+
+ +The type of standard used for the identification of the substances. Selected can be for example CAS, IUPAC or EC. + +
+
Name
+
listTypeId
+
+ + + +
+
Characteristic
+
+
+
+
Enumeration
+
+
+
Values
+
+
+
+
    +
  • CAS
    • +
  • EC
    • +
  • IUPAC
    • +
+
+
+
+
+ Reference +
+
    +
  • https://www.cas.org/cas-data/cas-registry
    • +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
CAS
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
type
+
+ + +
+
+ +
+
Chemical Name
+
+ +The name of the material which is present in the product. + +
+
Name
+
chemicalName
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
phenolphthalein
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
name
+
+ + +
+
+
+
+

Materials Entity

+
+
+ Entity with materials on the level of the product. +
+ +
+

Properties

+
+
+ +
+
Substances of Concern
+
+ +Information regarding substances of concern in the product. The ESPR provisional agreement from January 9th, 2024 defines: +(52) 'hazardous substance' means a substance classified as hazardous pursuant to Article 3 of Regulation (EC) No 1272/2008. + +
+
Name
+
substancesOfConcern
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#SubstanceOfConcernEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
substancesOfConcern
+
+ + +
+
+ +
+
Material Composition
+
+ +Material composition of the product with information on recycled and renewable materials. + +
+
Name
+
materialComposition
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#ChemicalMaterialEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
materialComposition
+
+ + +
+
+
+
+

Metadata Entity

+
+
+ Passport Entity to describe version, status, end and issue date. +
+ +
+

Properties

+
+
+ +
+
Version
+
+ +The current version of the product passport. The possibility of modification/ updating the product passport needs to include versioning of the dataset. This attribute is an internal versioning from the passport issuer. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Article 8: +(1) [...] The information in the product passport shall be accurate, complete, and up to date. + +
+
Name
+
version
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
1.0.0
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
version
+
+ + +
+
+ +
+
Status
+
+ +The current status of the product passport declared through either: draft, approved, invalid or expired. + +
+
Name
+
status
+
+ + + +
+
Characteristic
+
+
+
+
Enumeration
+
+
+
Values
+
+
+
+
    +
  • draft
    • +
  • approved
    • +
  • invalid
    • +
  • expired
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
draft
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
status
+
+ + +
+
+ +
+
Expiration Date
+
+ +The timestamp in the format (yyyy-mm-dd) for the product passport until when it is available or a comment describing this period. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Article 8: +(2) (h) the period during which the product passport is to remain available, which shall correspond to at least the expected lifetime of a specific product. + +
+
Name
+
expirationDate
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
2030-01-01
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
expirationDate
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + Date Constraint +
    + +
    +
    Description
    +
    Constraint fo a timestamp in the format (yyyy-mm-dd).
    +
    + + +
    +
    Regular expression
    +
    ^\d{4}-\d{2}-\d{2}$
    +
    + +
    • +
+
+
+
+
+ +
+
Issue Date
+
+ +The timestamp in the format (yyyy-mm-dd) since when the product passport is available. + +
+
Name
+
issueDate
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
2000-01-01
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
issueDate
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + Date Constraint +
    + +
    +
    Description
    +
    Constraint fo a timestamp in the format (yyyy-mm-dd).
    +
    + + +
    +
    Regular expression
    +
    ^\d{4}-\d{2}-\d{2}$
    +
    + +
    • +
+
+
+
+
+ +
+
Economic Operator Id
+
+ +The identification of the owner/economic operator of the passport. Proposed, according to ISO 15459, is the CIN (company identification code). Other identification numbers like the tax identification number, value added tax identification number, commercial register number and the like are also valid entries. In the Catena-X network, the BPNL is used for the identification of companies and the information stored like contact information and addresses. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Annex III: +(k) the [...] unique operator identifier code of the economic operator established in the Union responsible for carrying out the tasks set out in Article 4 of Regulation (EU) 2019/1020, or Article 15 of Regulation (EU) on general product safety, or similar tasks pursuant to other EU legislation applicable to the product. + +
+
Name
+
economicOperatorId
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
    +
  • https://catena-x.net/fileadmin/user_upload/Standard-Bibliothek/Update_PDF_Maerz/5_BPDM/CX_-_0010_BUSINESS_PARTNER_NUMBER_PlatformCapabilityBPDM_v_1.0.1.pdf
    • +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
BPNL0123456789ZZ
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
economicOperatorId
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + BPNL Regular Expression +
    + +
    +
    Description
    +
    The provided regular expression ensures that the BPNL is composed of prefix 'BPNL', 10 digits and two alphanumeric letters.
    +
    + + +
    +
    Regular expression
    +
    ^BPNL[a-zA-Z0-9]{12}$
    +
    + +
    • +
+
+
+
+
+ +
+
Passport Identifier
+
+ +The identifier of the product passport, which is an uuidv4. + +
+
Name
+
passportIdentifier
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
    +
  • https://tools.ietf.org/html/rfc4122
    • +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
urn:uuid:550e8400-e29b-41d4-a716-446655440000
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
passportIdentifier
+
+ + +
+
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
    +
    (^[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}$)
    +
    + +
    • +
+
+
+
+
+ +
+
Predecessor
+
+ +Identification of the preceding product passport. If there is no preceding passport, input a dummy value. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Article 8: +(2)(g) [...] Any new product passport shall be linked to the product passport or passports of the original product whenever appropriate. + +
+
Name
+
predecessor
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
    +
  • https://tools.ietf.org/html/rfc4122
    • +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
urn:uuid:00000000-0000-0000-0000-000000000000
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
predecessor
+
+ + +
+
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
    +
    (^[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}$)
    +
    + +
    • +
+
+
+
+
+ +
+
Backup Reference
+
+ +A reference to the data backup of the passport. This mandatory attribute will be further defined in the future. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex III: +(kb) the reference of the certified independent third-party product passport service provider hosting the back-up copy of the product passport. +Article 10 also mentions: +(c) the data included in the product passport shall be stored by the economic operator responsible for its creation or by certified independent third-party product passport service providers authorised to act on their behalf. + +
+
Name
+
backupReference
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
https://dummy.link
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
backupReference
+
+ + +
+
+ +
+
Registration Identifier
+
+ +Identifier in the respective registry. This will be further defined in the future. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 in Article 12: +By [2 years from entering into force of this Regulation], the Commission shall set up and manage a digital registry ("the registry") storing in a secure manner at least the unique product identifier, the unique operator identifier, the unique facility identifiers. In case of products intended to be placed under the customs procedure 'release for free circulation', the registry shall also store the product commodity code. The registry shall also store the batteries' unique identifiers referred to in Article 77(3) of Regulation (EU) 2023/1542. + +
+
Name
+
registrationIdentifier
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
https://dummy.link/ID8283746239078
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
registrationIdentifier
+
+ + +
+
+ +
+
Last Modification
+
+ +Date of the latest modification. + +
+
Name
+
lastModification
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
2000-01-01
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
lastModification
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + Date Constraint +
    + +
    +
    Description
    +
    Constraint fo a timestamp in the format (yyyy-mm-dd).
    +
    + + +
    +
    Regular expression
    +
    ^\d{4}-\d{2}-\d{2}$
    +
    + +
    • +
+
+
+
+
+
+
+

Oil Entity

+
+
+ Entity for the oil capacity and type. +
+ +
+

Properties

+
+
+ +
+
Oil Capacity
+
+ +The defined oil volume in the transmission in cubic decimeters. + +
+
Name
+
oilCapacity
+
+ + + +
+
Characteristic
+
+
+
+
Quantifiable
+
+
+
Duration
+
+
+
The oil capacity in dm³.
+
+
+
Unit
+
+
+
+
    +
  • + cubic decimetre +
    • +
  • + Symbol dm³ +
    • +
  • + Code DMQ +
    • +
  • + Conversion factor 10⁻³ m³ +
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#float + +
+
+
+
+
+ +
+
Example
+
8.9
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
oilCapacity
+
+ + +
+
+ +
+
Oil Type
+
+ +The type of the oil for the transmission defined by the manufacturer of the transmission. + +
+
Name
+
oilType
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Transmission Oil XY
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
oilType
+
+ + +
+
+
+
+

Operation Entity

+
+
+ Operational information of the product such as the owner, manufacturer and importer. +
+ +
+

Properties

+
+
+ +
+
Manufacturer
+
+ +Manufacturing information of the product. In the CATENA-X use case, the BPNL and BPNA can be stated. These attributes are mentioned in the ESPR provisional agreement from January 9th 2024 Annex III: +(h) unique operator identifiers other than that of the manufacturer; +(k) the name, contact details and unique operator identifier code of the economic operator established in the Union responsible for carrying out the tasks set out in Article 4 of Regulation (EU) 2019/1020, or Article 15 of Regulation (EU) [.../...] on general product safety, or similar tasks pursuant to other EU legislation applicable to the product. + +
+
Name
+
manufacturer
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#ManufacturerEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
manufacturer
+
+ + +
+
+ +
+
Import
+
+ +Importer details such as the identification. + +
+
Name
+
import
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#ImportEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
import
+
+ + +
+
+ +
+
Other Operators
+
+ +Other operators relevant for the product. + +
+
Name
+
otherOperators
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#OperatorEntity + +
+
+
+
+
+ + +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
other
+
+ + +
+
+
+
+

Operator Entity

+
+
+ Operator with role and identification. +
+ +
+

Properties

+
+
+ +
+
Other Operator Id
+
+ +Identifier of the other operator. This can be a BPN. + +
+
Name
+
otherOperatorId
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
BPNL0123456789XX
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
id
+
+ + +
+
+ +
+
Other Operator Role
+
+ +Role of the other operator. + +
+
Name
+
otherOperatorRole
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
distributor
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
role
+
+ + +
+
+
+
+

Part Type Entity

+
+
+ Entity for the part type with manufacturer id and name. +
+ +
+

Properties

+
+
+ +
+
Manufacturer Part ID
+
+ +Part ID as assigned by the manufacturer of the part. The part ID identifies the part in the manufacturer`s dataspace. The part ID references a specific version of a part. The version number must be included in the part ID if it is available. The part ID does not reference a specific instance of a part and must not be confused with the serial number. + +
+
Name
+
manufacturerPartId
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
123-0.740-3434-A
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
manufacturerPartId
+
+ + +
+
+ +
+
Name at manufacturer
+
+ +Name of the part as assigned by the manufacturer. + +
+
Name
+
nameAtManufacturer
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Mirror left
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
nameAtManufacturer
+
+ + +
+
+
+
+

Parts Entity

+
+
+ Possible spare parts of the product with identifiers and names. +
+ +
+

Properties

+
+
+ +
+
Manufacturer Part ID
+
+ +Part ID as assigned by the manufacturer of the part. The part ID identifies the part in the manufacturer`s dataspace. The part ID references a specific version of a part. The version number must be included in the part ID if it is available. The part ID does not reference a specific instance of a part and must not be confused with the serial number. + +
+
Name
+
manufacturerPartId
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
123-0.740-3434-A
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
manufacturerPartId
+
+ + +
+
+ +
+
Name at manufacturer
+
+ +Name of the part as assigned by the manufacturer. + +
+
Name
+
nameAtManufacturer
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Mirror left
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
nameAtManufacturer
+
+ + +
+
+
+
+

Performance Entity

+
+
+ Entity for the performance. +
+ +
+

Properties

+
+
+ +
+
Applicable
+
+ +If there is a transmission-integrated electrical machine included, select true and state the values in the connected attributes. If there is none, select false and provide dummy data. + +
+
Name
+
applicable
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#boolean + +
+
+
+
+
+ +
+
Example
+
true
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
applicable
+
+ + +
+
+ +
+
Electrical Machine
+
+ +Attributes connected to the transmission-integrated electrical machine, if applicable. Otherwise dummy data (0 or null) can be provided. + +
+
Name
+
electricalMachine
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.transmission.transmission_pass:3.0.0#ElectricalMachineEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
electricalMachine
+
+ + +
+
+
+
+

Physical Dimension Entity

+
+
+ Entity for physical dimensions with linear, mass and capacity attributes. Either weight or volume is mandatory. +
+ +
+

Properties

+
+
+ +
+
Width
+
+ +The width of the item measured in a specific linear unit which can be declared in the corresponding unit attribute. + +
+
Name
+
width
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.shared.quantity:2.0.0#LinearEntity + +
+
+
+
+
+ + +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
width
+
+ + +
+
+ +
+
Length
+
+ +The length of the item measured in a specific linear unit which can be declared in the corresponding unit attribute. + +
+
Name
+
length
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.shared.quantity:2.0.0#LinearEntity + +
+
+
+
+
+ + +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
length
+
+ + +
+
+ +
+
Diameter
+
+ +The diameter of the item, if applicable, measured in a specific linear unit which can be declared in the corresponding unit attribute. + +
+
Name
+
diameter
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.shared.quantity:2.0.0#LinearEntity + +
+
+
+
+
+ + +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
diameter
+
+ + +
+
+ +
+
Height
+
+ +The height of the item measured in a specific linear unit which can be declared in the corresponding unit attribute. + +
+
Name
+
height
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.shared.quantity:2.0.0#LinearEntity + +
+
+
+
+
+ + +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
height
+
+ + +
+
+ +
+
Gross Weight
+
+ +The gross weight of the item measured in a specific mass unit which can be declared in the corresponding unit attribute. Gross weight refers to the total weight of a product, including the weight of the packaging. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7: +(2) (b) (i) information on the performance of the product in relation to the product parameters referred to in Annex I; +Annex I (i) weight and volume of the product and its packaging, and the product-to-packaging ratio. + +
+
Name
+
grossWeight
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.shared.quantity:2.0.0#MassEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
grossWeight
+
+ + +
+
+ +
+
Gross Volume
+
+ +The gross volume of the item, if possible, measured in a specific capacity unit which can be declared in the corresponding unit attribute. If there is no separate packing, the volume of the product shall be given. Gross volume refers to the total volume of a product, including the volume of the packaging. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7: +(2) (b) (i) information on the performance of the product in relation to the product parameters referred to in Annex I; +Annex I (i) weight and volume of the product and its packaging, and the product-to-packaging ratio. + +
+
Name
+
grossVolume
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.shared.quantity:2.0.0#VolumeEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
grossVolume
+
+ + +
+
+ +
+
Weight
+
+ +Weight of the product measured in a specific mass unit which can be declared in the corresponding unit attribute. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7: +(2) (b) (i) information on the performance of the product in relation to the product parameters referred to in Annex I; +Annex I (i) weight and volume of the product [...]. + +
+
Name
+
weight
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.shared.quantity:2.0.0#MassEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
weight
+
+ + +
+
+ +
+
Volume
+
+ +Volume of the product, if possible, measured in a specific capacity unit which can be declared in the corresponding unit attribute. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7: +(2) (b) (i) information on the performance of the product in relation to the product parameters referred to in Annex I; +Annex I (i) weight and volume of the product [...]. + +
+
Name
+
volume
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.shared.quantity:2.0.0#VolumeEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
volume
+
+ + +
+
+
+
+

Product Footprint Entity

+
+
+ The Product Footprint Entity with sustainability information such as the different environmental footprint types, the carbon and material footprint explicitly, applicable rules and lifecycle stages. +
+ +
+

Properties

+
+
+ +
+
Environmental Footprint
+
+ +The environmental footprint of the product. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I: +The following parameters shall, as appropriate, and where necessary supplemented by others, be used, individually or combined, as a basis for improving the product aspects referred to in Article 5(1): +(l) the environmental footprint of the product, expressed as a quantification, in accordance with the applicable delegated act, of a product's life cycle environmental impacts, whether in relation to one or more environmental impact categories or an aggregated set of impact categories. +and Article 7: +(2)(b)(i) information on the performance of the product in relation to one or more of the product parameters referred to in Annex I, including a scoring of reparability or durability, carbon footprint or environmental footprint; +and defined by Article 2: +(23) 'environmental footprint' means a quantification of product environmental impacts throughout its life cycle, whether in relation to a single environmental impact category or an aggregated set of impact categories based on the Product Environmental Footprint method or other scientific methods developed by international organisations and widely tested in collaboration with different industry sectors and adopted or implemented by the Commission in other Union legislation; +(24) 'Product Environmental Footprint method' means the life cycle assessment method to quantify the environmental impacts of products established by Recommendation (EU) 2021/2279. + +
+
Name
+
environmentalFootprint
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#FootprintEntity + +
+
+
+
+
+ + +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
environmental
+
+ + +
+
+ +
+
Carbon Footprint
+
+ +The carbon footprint of the product. This is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I: +The following parameters shall, as appropriate, and where necessary supplemented by others, be used, individually or combined, as a basis for improving the product aspects referred to in Article 5(1): +(m) the carbon footprint of the product; +and Article 7: +(2)(b)(i) information on the performance of the product in relation to one or more of the product parameters referred to in Annex I, including a scoring of reparability or durability, carbon footprint or environmental footprint; +and defined by Article 2: +(25) 'carbon footprint' means the sum of greenhouse gas (GHG) emissions and GHG removals in a product system, expressed as CO2 equivalents and based on a life cycle assessment using the single impact category of climate change. + +
+
Name
+
carbonFootprint
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#FootprintEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
carbon
+
+ + +
+
+ +
+
Material Footprint
+
+ +The material footprint of the product. This is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I: +(ma) the material footprint of the product; +and defined by Article 2: +(25a) 'material footprint' refers to the total amount of raw materials extracted to meet final consumption demands. + +
+
Name
+
materialFootprint
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#FootprintEntity + +
+
+
+
+
+ + +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
material
+
+ + +
+
+
+
+

Range Entity

+
+
+ Entity for the concentration range with two values, the highest and the lowest of the concentration range. +
+ +
+

Properties

+
+
+ +
+
Minimum Concentration
+
+ +The minimum concentration of the substance of concern at the level of the product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7: +(5) (c) [...] concentration range of the substances of concern, at the level of the product [...]. + +
+
Name
+
minConcentration
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#float + +
+
+
+
+
+ +
+
Example
+
2.1
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
min
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + Positive Range Constraint +
    + +
    +
    Description
    +
    Constraint for only positive values.
    +
    + + +
    +
    +>= +
    + DefaultScalarValue[value=0.0, typeUri='DefaultScalar[metaModelVersion=SAMM_2_1_0, urn='http://www.w3.org/2001/XMLSchema#float']'] +
    +
    + +
    • +
+
+
+
+
+ +
+
Maximum Concentration
+
+ +The maximum concentration of the substance of concern at the level of the product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7: +(5) (c) the concentration, maximum concentration or concentration range of the substances of concern, at the level of the product [...]. + +
+
Name
+
maxConcentration
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#float + +
+
+
+
+
+ +
+
Example
+
2.6
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
max
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + Positive Range Constraint +
    + +
    +
    Description
    +
    Constraint for only positive values.
    +
    + + +
    +
    +>= +
    + DefaultScalarValue[value=0.0, typeUri='DefaultScalar[metaModelVersion=SAMM_2_1_0, urn='http://www.w3.org/2001/XMLSchema#float']'] +
    +
    + +
    • +
+
+
+
+
+
+
+

Sources Entity

+
+
+ Entity for a possible spare part sources. +
+ +
+

Properties

+
+
+ +
+
Sources Identification
+
+ +The identifier of a spare part producer of the product. In the Catena-X network, the BPNL is used for the identification of companies and the information stored for this like contact information and addresses. + +
+
Name
+
sourcesIdentification
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
    +
  • https://catena-x.net/fileadmin/user_upload/Standard-Bibliothek/Update_PDF_Maerz/5_BPDM/CX_-_0010_BUSINESS_PARTNER_NUMBER_PlatformCapabilityBPDM_v_1.0.1.pdf
    • +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
BPNL0123456789ZZ
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
id
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + BPNL Regular Expression +
    + +
    +
    Description
    +
    The provided regular expression ensures that the BPNL is composed of prefix 'BPNL', 10 digits and two alphanumeric letters.
    +
    + + +
    +
    Regular expression
    +
    ^BPNL[a-zA-Z0-9]{12}$
    +
    + +
    • +
+
+
+
+
+
+
+

Spare Part Entity

+
+
+ Information regarding possible spare parts. This is mentioned in the ESPR proposal from March 30th, 2022 Annex I: +(b) ease of repair and maintenance as expressed through: characteristics, availability and delivery time of spare parts, modularity, compatibility with commonly available spare parts, availability of repair and maintenance instructions, number of materials and components used, use of standard components, use of component and material coding standards for the identification of components and materials, number and complexity of processes and tools needed, ease of non-destructive disassembly and re-assembly, conditions for access to product data, conditions for access to or use of hardware and software needed; +(c) the Global Trade Identification Number as provided for in standard ISO/IEC 15459-6 or equivalent of products or their parts. +
+ +
+

Properties

+
+
+ +
+
Spare Part Sources
+
+ +Sources of possible spare parts. + +
+
Name
+
sparePartSources
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#SourcesEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
producer
+
+ + +
+
+ +
+
Spare Part
+
+ +Possible spare parts of the product. + +
+
Name
+
sparePart
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#PartsEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
sparePart
+
+ + +
+
+
+
+

Specific Entity

+
+
+ The entity describing various product specific parameters of the transmission. +
+ +
+

Properties

+
+
+ +
+
Drive Type
+
+ +A list of the type of transmission drive. For example combustion, full hybrid, mild hybrid, plug-in hybrid or purely electric drive (battery or fuelcell). + +
+
Name
+
driveType
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
full hybrid
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
driveType
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + Drive Type Constraint +
    + +
    +
    Description
    +
    Constraint to only allow combustion, full hybrid, mild hybrid, plug-in hybrid, fuel-cell or battery. +
    +
    + + +
    +
    Regular expression
    +
    (combustion|full hybrid|mild hybrid|plug-in hybrid|fuel-cell|battery)
    +
    + +
    • +
+
+
+
+
+ +
+
Torque Performance
+
+ +The maximum input torque in newton meters (the operating characteristics of the transmission). + +
+
Name
+
torque
+
+ + + +
+
Characteristic
+
+
+
+
Measurement
+
+
+
Characteristic to describe torque in newton meters.
+
+
+
Unit
+
+
+
+
    +
  • + newton metre +
    • +
  • + Symbol N·m +
    • +
  • + Code NU +
    • +
  • + Conversion factor N × m +
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#nonNegativeInteger + +
+
+
+
+
+ +
+
Example
+
500
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
torque
+
+ + +
+
+ +
+
Power
+
+ +The maximum power in kilowatt (the operating characteristics of the transmission). + +
+
Name
+
power
+
+ + + +
+
Characteristic
+
+
+
+
Measurement
+
+
+
The performance power in kilowatt as non-negative integer.
+
+
+
Unit
+
+
+
+
    +
  • + kilowatt +
    • +
  • + Symbol kW +
    • +
  • + Code KWT +
    • +
  • + Conversion factor 10³ W +
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#nonNegativeInteger + +
+
+
+
+
+ +
+
Example
+
300
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
power
+
+ + +
+
+ +
+
Torque Converter
+
+ +A list of the used transmission damper technology (depending on the transmission type). For example NW 200 TTD and NW 200 ZDW + +
+
Name
+
torqueConverter
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
NW 200 TTD
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
torqueConverter
+
+ + +
+
+ +
+
Speed Resistance
+
+ +The permissible maximum input speed in the respective gear depending on the transmission type. + +
+
Name
+
speedResistance
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.transmission.transmission_pass:3.0.0#SpeedResistanceEntity + +
+
+
+
+
+ + +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
speedResistance
+
+ + +
+
+ +
+
Standard Gear Ratio
+
+ +The ratio in the respective gear (ratio between transmission input speed and transmission output speed). For example 1 : 4.1567; 2 : 3.898; 3 : 2.887; 4 : 2.7783; 5 : 1.811; 6 : 1.6545; 7 : 0.4377; 8 : 0.6121; R : -2.2183. + +
+
Name
+
standardGearRatio
+
+ + + +
+
Characteristic
+
+
+
+
Set
+
+
+
Has no order
+
+
+
Duplicates not allowed
+
+
+
+ Type urn:samm:io.catenax.transmission.transmission_pass:3.0.0#GearRatioEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
standardGearRatio
+
+ + +
+
+ +
+
Spreading
+
+ +The transmission spreading coefficient. The ratio between the smallest (shortest gear) and the largest (longest gear) ratio. + +
+
Name
+
spreading
+
+ + + +
+
Characteristic
+
+
+
+
Quantifiable
+
+
+
Duration
+
+
+
The ratio in the respective gear.
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#float + +
+
+
+
+
+ +
+
Example
+
6.79
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
spreading
+
+ + +
+
+ +
+
Oil
+
+ +The oil used for the transmission. + +
+
Name
+
oil
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.transmission.transmission_pass:3.0.0#OilEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
oil
+
+ + +
+
+ +
+
Electrical Performance
+
+ +Attributes connected to the transmission-integrated electrical machine, if applicable. + +
+
Name
+
electricalPerformance
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.transmission.transmission_pass:3.0.0#PerformanceEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
electricalPerformance
+
+ + +
+
+ +
+
Service History
+
+ +Documentation of the service history of the transmission. + +
+
Name
+
serviceHistory
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#DocumentationEntity + +
+
+
+
+
+ + +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
serviceHistory
+
+ + +
+
+
+
+

Speed Resistance Entity

+
+
+ The speed resistance entity. Includes the gear and the speed as separate properties. +
+ +
+

Properties

+
+
+ +
+
Gear
+
+ +Respective gear for the measurement. + +
+
Name
+
gear
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
1
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
gear
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + Gear Constraint +
    + +
    +
    Description
    +
    Constraint to match a gear from 1 to 18 or R (reverse).
    +
    + + +
    +
    Regular expression
    +
    ^(1[0-8]|[1-9]|R)$
    +
    + +
    • +
+
+
+
+
+ +
+
Rated Speed
+
+ +The permissible maximum input speed in the respective gear (depending on the transmission type) in 1/min. + +
+
Name
+
ratedSpeed
+
+ + + +
+
Characteristic
+
+
+
+
Measurement
+
+
+
The permissible maximum input speed in revolutions per minute in the respective gear.
+
+
+
Unit
+
+
+
+
    +
  • + revolutions per minute +
    • +
  • + Symbol r/min +
    • +
  • + Code RPM +
    • +
  • + Conversion factor 1.67 × 10⁻²/s +
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#nonNegativeInteger + +
+
+
+
+
+ +
+
Example
+
7800
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
ratedSpeed
+
+ + +
+
+
+
+

Substance Entity

+
+
+ Information regarding substances of concern in the product. +
+ +
+

Properties

+
+
+ +
+
Location
+
+ +The location of the substances of concern within the product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7: +(5) (b) the location of the substances of concern within the product. + +
+
Name
+
location
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Housing
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
location
+
+ + +
+
+ +
+
Material Unit
+
+ +The unit of concentration chosen from an enumeration: mass percent, volume percent, parts per thousand, parts per million, parts per billion and parts per trillion. + +
+
Name
+
materialUnit
+
+ + + +
+
Characteristic
+
+
+
+
Enumeration
+
+
+
Values
+
+
+
+
    +
  • unit:partPerMillion
    • +
  • unit:percent
    • +
  • unit:percentVolume
    • +
  • unit:partPerThousand
    • +
  • unit:partPerTrillionUs
    • +
  • unit:partPerBillionUs
    • +
+
+
+
+
+ Reference +
+
    +
  • https://eclipse-esmf.github.io/samm-specification/2.1.0/index.html
    • +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
unit:percent
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
unit
+
+ +
+
Reference
+
+
    +
  • https://eclipse-esmf.github.io/samm-specification/2.1.0/index.html
    • +
+
+
+ +
+
+ +
+
Concentration
+
+ +Concentration of the material at the level of the product. This attribute is specially mentioned for substances of concern mentioned in the ESPR proposal from March 30th, 2022 Article 7: +(5) (c) the concentration, maximum concentration or concentration range of the substances of concern, at the level of the product [...]. +Other substances are mentioned for the purpose of recycling in the ESPR provisional agreement from January 9th, 2024 Annex I: +(d) design for recycling, ease and quality of recycling as expressed through: use of easily recyclable materials, safe, easy and non-destructive access to recyclable components and materials or components and materials containing hazardous substances and material composition and homogeneity, possibility for high-purity sorting, number of materials and components used, use of standard components, use of component and material coding standards for the identification of components and materials, number and complexity of processes and tools needed, ease of nondestructive disassembly and re-assembly, conditions for access to product data, conditions for access to or use of hardware and software needed. + + +
+
Name
+
concentration
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#float + +
+
+
+
+
+ +
+
Example
+
5.3
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
concentration
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + Positive Range Constraint +
    + +
    +
    Description
    +
    Constraint for only positive values.
    +
    + + +
    +
    +>= +
    + DefaultScalarValue[value=0.0, typeUri='DefaultScalar[metaModelVersion=SAMM_2_1_0, urn='http://www.w3.org/2001/XMLSchema#float']'] +
    +
    + +
    • +
+
+
+
+
+ +
+
Exemption
+
+ +Exemptions to the substance of concern. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Article 7: +(5) (c) provide duly justified exemptions for substances of concern or information elements from the information requirements referred to in the first subparagraph based on the technical feasibility or relevance of tracking substances of concern, the existence of analytical methods to detect and quantify them, the need to protect confidential business information or in other duly justified cases. Substances of concern within the meaning of Article 2(28), point a), shall not be exempted if they are present in products, their relevant components or spare parts in a concentration above 0,1 % weight by weight. + +
+
Name
+
exemption
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
shall not apply to product x containing not more than 1,5 ml of liquid
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
exemption
+
+ + +
+
+ +
+
Hazard Classification
+
+ +The specification of the hazard class. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I: +(f) use of substances, and in particular the use of substances of concern, on their own, as constituents of substances or in mixtures, during the production process of products, or leading to their presence in products, including once these products become waste, and their impacts on human health and the environment; +Further defined is this by Regulation (EC) No 1272/2008 of the European Parliament and of the Council of 16 December 2008 on classification, labelling and packaging of substances and mixtures, amending and repealing Directives 67/548/EEC and 1999/45/EC, and amending Regulation (EC) No 1907/2006. +Defined in Article 2: +1. 'hazard class' means the nature of the physical, health or environmental hazard; +2. 'hazard category' means the division of criteria within each hazard class, specifying hazard severity; +5. 'hazard statement' means a phrase assigned to a hazard class and category that describes the nature of the hazards of a hazardous substance or mixture, including, where appropriate, the degree of hazard; + +
+
Name
+
hazardClassification
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#HazardEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
hazardClassification
+
+ +
+
Reference
+
+
    +
  • https://eur-lex.europa.eu/legal-content/EN/TXT/?uri=CELEX:02008R1272-20231201
    • +
+
+
+ +
+
+ +
+
Concentration Range
+
+ +The concentration range for the substance of concern. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7: +(5) (c) [...] concentration range of the substances of concern, at the level of the product [...]. + +
+
Name
+
concentrationRange
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#RangeEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
concentrationRange
+
+ + +
+
+ +
+
Material Identification
+
+ +The chemical material name and identification, in accordance with the specification in the attribute for the list type. Preference is given to the IUPAC name. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Article 7: +(5) (a) the name of the substances of concern present in the product, as follows: + - name(s) in the International Union of Pure and Applied Chemistry (IUPAC) nomenclature, or another international name when IUPAC name is not available; +- other names (usual name, trade name, abbreviation); +- European Community (EC) number, as indicated in the European Inventory of Existing Commercial Chemical Substances (EINECS), the European List of Notified Chemical Substances (ELINCS) or the No Longer Polymer (NLP) list or assigned by the European Chemicals Agency (ECHA), if available; +- the Chemical Abstract Service (CAS) name(s) and number(s), if available; . + +
+
Name
+
materialIdentification
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#MaterialIdEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
id
+
+ + +
+
+ +
+
Documentation
+
+ +Documentation accompanying the material. + +
+
Name
+
documentation
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#DocumentationEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
documentation
+
+ + +
+
+
+
+

Substance Of Concern Entity

+
+
+ Substance of Concern entity with attributes if applicable to the product. +
+ +
+

Properties

+
+
+ +
+
Applicable
+
+ +Check whether the connected attributes are applicable to the product. If it is not applicable (false), dummy data can be delivered. + +
+
Name
+
applicable
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#boolean + +
+
+
+
+
+ +
+
Example
+
true
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
applicable
+
+ + +
+
+ +
+
Substance of Concern
+
+ +Information regarding substances of concern in the product. Attributes are among others substance names, ids, concentration, location and hazard class. This is mentioned in the ESPR provisional agreement from January 9th, 2024 Article 7: +(5) (a) the name of the substances of concern present in the product, as follows: +- name(s) in the International Union of Pure and Applied Chemistry (IUPAC) nomenclature, or another international name when IUPAC name is not available; +- other names (usual name, trade name, abbreviation); +- European Community (EC) number, as indicated in the European Inventory of Existing Commercial Chemical Substances (EINECS), the European List of Notified Chemical Substances (ELINCS) or the No Longer Polymer (NLP) list or assigned by the European Chemicals Agency (ECHA), if available; +- the Chemical Abstract Service (CAS) name(s) and number(s), if available; +(5) (b) the location of the substances of concern within the product. +(5) (c) the concentration, maximum concentration or concentration range of the substances of concern, at the level of the product its relevant components, or spare parts; +(d) relevant instructions for the safe use of the product; +(e) information relevant for disassembly, preparation for reuse, reuse, recycling and the environmentally sound management of the product at the end of its life. +And in the next paragraph: +(c) provide duly justified exemptions for substances of concern or information elements from the information requirements referred to in the first subparagraph. + +
+
Name
+
substanceOfConcern
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#SubstanceEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
content
+
+ + +
+
+
+
+

Sustainability Entity

+
+
+ Entity with the properties regarding the sustainability of the product. +
+ +
+

Properties

+
+
+ +
+
State
+
+ +The status of the product (original, repurposed, re-used, remanufactured or waste) to indicated, whether it is a used product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Annex I: +(j) incorporation of used components. + +
+
Name
+
state
+
+ + + +
+
Characteristic
+
+
+
+
Enumeration
+
+
+
Values
+
+
+
+
    +
  • original
    • +
  • repurposed
    • +
  • re-used
    • +
  • remanufactured
    • +
  • waste
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
original
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
status
+
+ + +
+
+ +
+
Product Footprint
+
+ +The carbon and environmental footprint or material footprint of the product. These attributes are mentioned in the ESPR provisional agreement from January 9th 2024 Annex I: +(l) the environmental footprint of the product, expressed as a quantification, in accordance with the applicable delegated act, of a product's life cycle environmental impacts, whether in relation to one or more environmental impact categories or an aggregated set of impact categories; +(m) the carbon footprint of the product; +(ma) the material footprint of the product; +All are defined by Article 2: +(23) 'environmental footprint' means a quantification of product environmental impacts throughout its life cycle, whether in relation to a single environmental impact category or an aggregated set of impact categories based on the Product Environmental Footprint method or other scientific methods developed by international organisations and widely tested in collaboration with different industry sectors and adopted or implemented by the Commission in other Union +legislation; +(25) 'carbon footprint' means the sum of greenhouse gas (GHG) emissions and GHG removals in a product system, expressed as CO2 equivalents and based on a life cycle assessment using the single impact category of climate change. +(25a) 'material footprint' refers to the total amount of raw materials extracted to meet final consumption demands; + +
+
Name
+
productFootprint
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.generic.digital_product_passport:5.0.0#ProductFootprintEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
productFootprint
+
+ + +
+
+ +
+
Reparability Score
+
+ +The reparability score. This attribute is mentioned ESPR provisional agreement from January 9th, 2024 Article 7: +(b) as appropriate, also require products to be accompanied by: +(i) information on the performance of the product in relation to one or more of the product parameters referred to in Annex I, including a scoring of reparability or durability [...]. + +
+
Name
+
reparabilityScore
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
B
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
reparabilityScore
+
+ + +
+
+ +
+
Durability Score
+
+ +The durability score. This attribute is mentioned ESPR provisional agreement from January 9th, 2024 Article 7: +(b) as appropriate, also require products to be accompanied by: +(i) information on the performance of the product in relation to one or more of the product parameters referred to in Annex I, including a scoring of reparability or durability [...]. + +
+
Name
+
durabilityScore
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
A
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
durabilityScore
+
+ + +
+
+
+
+

Volume Entity

+
+
+ Entity for volume measurements of an item with an unit and value. +
+ +
+

Properties

+
+
+ +
+
Quantity Value
+
+ +The quantity value associated with the unit. + +
+
Name
+
quantityValue
+
+ + + +
+
Characteristic
+
+
+
+
Quantifiable
+
+
+
Duration
+
+
+
The quantity value associated with the unit expressed as float.
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#float + +
+
+
+
+
+ +
+
Example
+
20.0
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
value
+
+ + +
+
+ +
+
Volume Unit
+
+ +The unit of a volume related attribute. + +
+
Name
+
volumeUnit
+
+ + + +
+
Characteristic
+
+
+
+
Enumeration
+
+
+
Values
+
+
+
+
    +
  • unit:cubicMetre
    • +
  • unit:litre
    • +
  • unit:millilitre
    • +
  • unit:cubicCentimetre
    • +
  • unit:cubicInch
    • +
  • unit:cubicFoot
    • +
  • unit:cubicYard
    • +
  • unit:hectolitre
    • +
+
+
+
+
+ Reference +
+
    +
  • https://eclipse-esmf.github.io/samm-specification/2.1.0/index.html
    • +
+
+
+
+
+
+ Type urn:samm:org.eclipse.esmf.samm:meta-model:2.1.0#curie + +
+
+
+
+
+ +
+
Example
+
unit:litre
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
unit
+
+ +
+
Reference
+
+
    +
  • https://eclipse-esmf.github.io/samm-specification/2.1.0/index.html
    • +
+
+
+ +
+
+
+ +
+ Third party licenses + +
+ +
+ + +
+ + + \ No newline at end of file diff --git a/io.catenax.transmission.transmission_pass/3.0.0/gen/TransmissionPass.json b/io.catenax.transmission.transmission_pass/3.0.0/gen/TransmissionPass.json new file mode 100644 index 000000000..40d00789d --- /dev/null +++ b/io.catenax.transmission.transmission_pass/3.0.0/gen/TransmissionPass.json @@ -0,0 +1,281 @@ +{ + "specific" : { + "serviceHistory" : [ { + "contentType" : "URL", + "header" : "Example Document XYZ", + "content" : "https://dummy.link" + } ], + "oil" : { + "oilType" : [ "Transmission Oil XY" ], + "oilCapacity" : 8.9 + }, + "torqueConverter" : [ "NW 200 TTD" ], + "driveType" : [ "full hybrid" ], + "spreading" : 6.79, + "torque" : 500, + "power" : 300, + "standardGearRatio" : [ { + "gearRatio" : 4.1567, + "gear" : "1" + } ], + "speedResistance" : [ { + "ratedSpeed" : 7800, + "gear" : "1" + } ], + "electricalPerformance" : { + "applicable" : true, + "electricalMachine" : { + "torque" : { + "max" : 180, + "maximumAvailability" : 10, + "continuous" : 178 + }, + "power" : { + "max" : 22, + "continuous" : 16, + "maximumAvailability" : 10 + }, + "speed" : 16700, + "voltage" : 52 + } + } + }, + "generic" : { + "characteristics" : { + "physicalDimension" : { + "volume" : { + "value" : 20.0, + "unit" : "unit:cubicMetre" + }, + "grossWeight" : { + "value" : 20.0, + "unit" : "unit:gram" + }, + "diameter" : { + "value" : 20.0, + "unit" : "unit:millimetre" + }, + "grossVolume" : { + "value" : 20.0, + "unit" : "unit:cubicMetre" + }, + "width" : { + "value" : 20.0, + "unit" : "unit:millimetre" + }, + "length" : { + "value" : 20.0, + "unit" : "unit:millimetre" + }, + "weight" : { + "value" : 20.0, + "unit" : "unit:gram" + }, + "height" : { + "value" : 20.0, + "unit" : "unit:millimetre" + } + }, + "warranty" : 60, + "lifeTime" : 500000 + }, + "metadata" : { + "backupReference" : "https://dummy.link", + "registrationIdentifier" : "https://dummy.link/ID8283746239078", + "economicOperatorId" : "BPNL0123456789ZZ", + "lastModification" : "2000-01-01", + "predecessor" : "urn:uuid:00000000-0000-0000-0000-000000000000", + "issueDate" : "2000-01-01", + "version" : "1.0.0", + "passportIdentifier" : "urn:uuid:550e8400-e29b-41d4-a716-446655440000", + "status" : "draft", + "expirationDate" : "2030-01-01" + }, + "commercial" : { + "placedOnMarket" : "2000-01-01", + "purpose" : [ "automotive" ] + }, + "identification" : { + "batch" : [ { + "value" : "BID12345678", + "key" : "batchId" + } ], + "codes" : [ { + "value" : "8703 24 10 00", + "key" : "TARIC" + } ], + "type" : { + "manufacturerPartId" : "123-0.740-3434-A", + "nameAtManufacturer" : "Mirror left" + }, + "classification" : [ { + "classificationStandard" : "GIN 20510-21513", + "classificationID" : "1004712", + "classificationDescription" : "Generic standard for classification of parts in the automotive industry." + } ], + "serial" : [ { + "value" : "SN12345678", + "key" : "partInstanceId" + } ], + "dataCarrier" : { + "carrierType" : "QR", + "carrierLayout" : "upper-left side" + } + }, + "sources" : [ { + "header" : "Example Document XYZ", + "category" : "Product Specifications", + "type" : "URL", + "content" : "https://dummy.link" + } ], + "materials" : { + "substancesOfConcern" : { + "applicable" : true, + "content" : [ { + "unit" : "unit:partPerMillion", + "hazardClassification" : { + "category" : "category 1A", + "statement" : "Causes severe skin burns and eye damage.", + "class" : "Skin corrosion" + }, + "documentation" : [ { + "contentType" : "URL", + "header" : "Example Document XYZ", + "content" : "https://dummy.link" + } ], + "concentrationRange" : [ { + "max" : 2.6, + "min" : 2.1 + } ], + "location" : "Housing", + "concentration" : 5.3, + "exemption" : "shall not apply to product x containing not more than 1,5 ml of liquid", + "id" : [ { + "type" : "CAS", + "name" : "phenolphthalein", + "id" : "201-004-7" + } ] + } ] + }, + "materialComposition" : { + "applicable" : true, + "content" : [ { + "unit" : "unit:partPerMillion", + "recycled" : 12.5, + "critical" : true, + "renewable" : 23.5, + "documentation" : [ { + "contentType" : "URL", + "header" : "Example Document XYZ", + "content" : "https://dummy.link" + } ], + "concentration" : 5.3, + "id" : [ { + "type" : "CAS", + "name" : "phenolphthalein", + "id" : "201-004-7" + } ] + } ] + } + }, + "handling" : { + "applicable" : true, + "content" : { + "producer" : [ { + "id" : "BPNL0123456789ZZ" + } ], + "sparePart" : [ { + "manufacturerPartId" : "123-0.740-3434-A", + "nameAtManufacturer" : "Mirror left" + } ] + } + }, + "operation" : { + "import" : { + "applicable" : true, + "content" : { + "eori" : "GB123456789000", + "id" : "BPNL0123456789ZZ" + } + }, + "other" : { + "id" : "BPNL0123456789XX", + "role" : "distributor" + }, + "manufacturer" : { + "facility" : [ { + "facility" : "BPNA1234567890AA" + } ], + "manufacturingDate" : "2000-01-31", + "manufacturer" : "BPNLvO2y5Eu4L2hi" + } + }, + "sustainability" : { + "reparabilityScore" : "B", + "productFootprint" : { + "material" : [ { + "lifecycle" : "main product production", + "rulebook" : [ { + "contentType" : "URL", + "header" : "Example Document XYZ", + "content" : "https://dummy.link" + } ], + "unit" : "kg CO2 / kWh", + "performanceClass" : "A", + "manufacturingPlant" : [ { + "facility" : "BPNA1234567890AA" + } ], + "type" : "Climate Change Total", + "value" : 12.678, + "declaration" : [ { + "contentType" : "URL", + "header" : "Example Document XYZ", + "content" : "https://dummy.link" + } ] + } ], + "carbon" : [ { + "lifecycle" : "main product production", + "rulebook" : [ { + "contentType" : "URL", + "header" : "Example Document XYZ", + "content" : "https://dummy.link" + } ], + "unit" : "kg CO2 / kWh", + "performanceClass" : "A", + "manufacturingPlant" : [ { + "facility" : "BPNA1234567890AA" + } ], + "type" : "Climate Change Total", + "value" : 12.678, + "declaration" : [ { + "contentType" : "URL", + "header" : "Example Document XYZ", + "content" : "https://dummy.link" + } ] + } ], + "environmental" : [ { + "lifecycle" : "main product production", + "rulebook" : [ { + "contentType" : "URL", + "header" : "Example Document XYZ", + "content" : "https://dummy.link" + } ], + "unit" : "kg CO2 / kWh", + "performanceClass" : "A", + "manufacturingPlant" : [ { + "facility" : "BPNA1234567890AA" + } ], + "type" : "Climate Change Total", + "value" : 12.678, + "declaration" : [ { + "contentType" : "URL", + "header" : "Example Document XYZ", + "content" : "https://dummy.link" + } ] + } ] + }, + "status" : "original", + "durabilityScore" : "A" + } + } +} \ No newline at end of file diff --git a/io.catenax.transmission.transmission_pass/3.0.0/gen/TransmissionPass.yml b/io.catenax.transmission.transmission_pass/3.0.0/gen/TransmissionPass.yml new file mode 100644 index 000000000..f5c4562f7 --- /dev/null +++ b/io.catenax.transmission.transmission_pass/3.0.0/gen/TransmissionPass.yml @@ -0,0 +1,1656 @@ +--- +openapi: 3.0.3 +info: + title: Transmission Pass + version: v3 +servers: +- url: catenax.io/api/v3 + variables: + api-version: + default: v3 +paths: + /{tenant-id}/transmission-pass: + get: + tags: + - TransmissionPass + operationId: getTransmissionPass + 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/TransmissionPass' + "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.transmission.transmission_pass_3.0.0_DriveTypeTrait: + description: | + Constraint to only allow combustion, full hybrid, mild hybrid, plug-in hybrid, fuel-cell or battery. + type: array + items: + type: string + pattern: (combustion|full hybrid|mild hybrid|plug-in hybrid|fuel-cell|battery) + urn_samm_io.catenax.transmission.transmission_pass_3.0.0_TorqueNewtonMetre: + type: number + minimum: 0 + description: Characteristic to describe torque in newton meters. + urn_samm_io.catenax.transmission.transmission_pass_3.0.0_KilowattMeasurement: + type: number + minimum: 0 + description: The performance power in kilowatt as non-negative integer. + urn_samm_io.catenax.transmission.transmission_pass_3.0.0_StringList: + description: A list with the data types string. + type: array + items: + type: string + urn_samm_io.catenax.transmission.transmission_pass_3.0.0_GearTrait: + type: string + description: Constraint to match a gear from 1 to 18 or R (reverse). + pattern: "^(1[0-8]|[1-9]|R)$" + urn_samm_io.catenax.transmission.transmission_pass_3.0.0_RevolutionsPerMinute: + type: number + minimum: 0 + description: The permissible maximum input speed in revolutions per minute in + the respective gear. + urn_samm_io.catenax.transmission.transmission_pass_3.0.0_SpeedResistanceEntity: + description: The speed resistance entity. Includes the gear and the speed as + separate properties. + type: object + properties: + gear: + description: Respective gear for the measurement. + $ref: '#/components/schemas/urn_samm_io.catenax.transmission.transmission_pass_3.0.0_GearTrait' + ratedSpeed: + description: The permissible maximum input speed in the respective gear + (depending on the transmission type) in 1/min. + $ref: '#/components/schemas/urn_samm_io.catenax.transmission.transmission_pass_3.0.0_RevolutionsPerMinute' + required: + - gear + - ratedSpeed + urn_samm_io.catenax.transmission.transmission_pass_3.0.0_SpeedResistanceList: + description: The speed resistance characteristic. + type: array + items: + $ref: '#/components/schemas/urn_samm_io.catenax.transmission.transmission_pass_3.0.0_SpeedResistanceEntity' + urn_samm_io.catenax.transmission.transmission_pass_3.0.0_Ratio: + type: number + description: The ratio in the respective gear. + urn_samm_io.catenax.transmission.transmission_pass_3.0.0_GearRatioEntity: + description: Entity for the ratio in the respective gear. Includes the gear + and the ratio as separate properties. + type: object + properties: + gear: + description: Respective gear for the measurement. + $ref: '#/components/schemas/urn_samm_io.catenax.transmission.transmission_pass_3.0.0_GearTrait' + gearRatio: + description: The ratio in the respective gear (ratio between transmission + input speed and transmission output speed). + $ref: '#/components/schemas/urn_samm_io.catenax.transmission.transmission_pass_3.0.0_Ratio' + required: + - gear + - gearRatio + urn_samm_io.catenax.transmission.transmission_pass_3.0.0_StandardGearRatioSet: + description: The set of ratio in the respective gear. + type: array + items: + $ref: '#/components/schemas/urn_samm_io.catenax.transmission.transmission_pass_3.0.0_GearRatioEntity' + uniqueItems: true + urn_samm_io.catenax.transmission.transmission_pass_3.0.0_Capacity: + type: number + description: The oil capacity in dm³. + urn_samm_io.catenax.transmission.transmission_pass_3.0.0_OilCharacteristic: + description: Characteristic for the oil. + type: object + properties: + oilCapacity: + description: The defined oil volume in the transmission in cubic decimeters. + $ref: '#/components/schemas/urn_samm_io.catenax.transmission.transmission_pass_3.0.0_Capacity' + oilType: + description: The type of the oil for the transmission defined by the manufacturer + of the transmission. + $ref: '#/components/schemas/urn_samm_io.catenax.transmission.transmission_pass_3.0.0_StringList' + required: + - oilCapacity + - oilType + 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.transmission.transmission_pass_3.0.0_TimeMeasurement: + type: number + minimum: 0 + description: Time in seconds. + urn_samm_io.catenax.transmission.transmission_pass_3.0.0_MachineTorqueCharacteristic: + description: The electrical machine torque. + type: object + properties: + max: + description: The maximum output torque in newton meters for a specified + time period. + $ref: '#/components/schemas/urn_samm_io.catenax.transmission.transmission_pass_3.0.0_TorqueNewtonMetre' + maximumAvailability: + description: Specified time period for the peak measurement in seconds. + $ref: '#/components/schemas/urn_samm_io.catenax.transmission.transmission_pass_3.0.0_TimeMeasurement' + continuous: + description: The torque that can be delivered without time limit in newton + meters. + $ref: '#/components/schemas/urn_samm_io.catenax.transmission.transmission_pass_3.0.0_TorqueNewtonMetre' + required: + - max + - maximumAvailability + - continuous + urn_samm_io.catenax.transmission.transmission_pass_3.0.0_MachinePowerCharacteristic: + description: The electrical machine power. + type: object + properties: + max: + description: The maximum output power in kilowatts for a specified time + period. + $ref: '#/components/schemas/urn_samm_io.catenax.transmission.transmission_pass_3.0.0_KilowattMeasurement' + continuous: + description: The power that can be delivered without time limit. + $ref: '#/components/schemas/urn_samm_io.catenax.transmission.transmission_pass_3.0.0_KilowattMeasurement' + maximumAvailability: + description: Specified time period for the peak measurement in seconds. + $ref: '#/components/schemas/urn_samm_io.catenax.transmission.transmission_pass_3.0.0_TimeMeasurement' + required: + - max + - continuous + - maximumAvailability + urn_samm_io.catenax.transmission.transmission_pass_3.0.0_VoltageMeasurement: + type: number + description: Measurement in voltage. + urn_samm_io.catenax.transmission.transmission_pass_3.0.0_ElectricalMachineCharacteristic: + description: Characteristic for the electrical machine. + type: object + properties: + torque: + description: The torque of the electrical machine. + $ref: '#/components/schemas/urn_samm_io.catenax.transmission.transmission_pass_3.0.0_MachineTorqueCharacteristic' + power: + description: The power of the electrical machine. + $ref: '#/components/schemas/urn_samm_io.catenax.transmission.transmission_pass_3.0.0_MachinePowerCharacteristic' + voltage: + description: Nominal voltage of the electric system in volt. + $ref: '#/components/schemas/urn_samm_io.catenax.transmission.transmission_pass_3.0.0_VoltageMeasurement' + speed: + description: Maximum allowable speed for the electric motor in revolutions + per minute. + $ref: '#/components/schemas/urn_samm_io.catenax.transmission.transmission_pass_3.0.0_RevolutionsPerMinute' + required: + - torque + - power + - voltage + - speed + urn_samm_io.catenax.transmission.transmission_pass_3.0.0_PerformanceCharacteristic: + description: Characteristic for performance related values. + type: object + properties: + applicable: + description: "If there is a transmission-integrated electrical machine included,\ + \ select true and state the values in the connected attributes. If there\ + \ is none, select false and provide dummy data." + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Boolean' + electricalMachine: + description: "Attributes connected to the transmission-integrated electrical\ + \ machine, if applicable. Otherwise dummy data (0 or null) can be provided." + $ref: '#/components/schemas/urn_samm_io.catenax.transmission.transmission_pass_3.0.0_ElectricalMachineCharacteristic' + required: + - applicable + - electricalMachine + 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.generic.digital_product_passport_5.0.0_HeaderTrait: + type: string + description: Constraint for a maximum of 100 characters. + maxLength: 100 + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentationEntity: + description: "Entity for a document with a header, type and content." + type: object + properties: + content: + description: The content of the document e.g a link. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + contentType: + description: "The type of content which can be expected in the \"content\"\ + \ property. Examples are a link, restricted link, pdf, excel, etc." + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + header: + description: The header as a short description of the document with a maximum + of 100 characters. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_HeaderTrait' + required: + - content + - contentType + - header + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentList: + description: List of documents. + type: array + items: + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentationEntity' + urn_samm_io.catenax.transmission.transmission_pass_3.0.0_SpecificCharacteristic: + description: The Characteristic to describe product specific parameters of the + transmission. + type: object + properties: + driveType: + description: "A list of the type of transmission drive. For example combustion,\ + \ full hybrid, mild hybrid, plug-in hybrid or purely electric drive (battery\ + \ or fuelcell)." + $ref: '#/components/schemas/urn_samm_io.catenax.transmission.transmission_pass_3.0.0_DriveTypeTrait' + torque: + description: The maximum input torque in newton meters (the operating characteristics + of the transmission). + $ref: '#/components/schemas/urn_samm_io.catenax.transmission.transmission_pass_3.0.0_TorqueNewtonMetre' + power: + description: The maximum power in kilowatt (the operating characteristics + of the transmission). + $ref: '#/components/schemas/urn_samm_io.catenax.transmission.transmission_pass_3.0.0_KilowattMeasurement' + torqueConverter: + description: A list of the used transmission damper technology (depending + on the transmission type). For example NW 200 TTD and NW 200 ZDW + $ref: '#/components/schemas/urn_samm_io.catenax.transmission.transmission_pass_3.0.0_StringList' + speedResistance: + description: The permissible maximum input speed in the respective gear + depending on the transmission type. + $ref: '#/components/schemas/urn_samm_io.catenax.transmission.transmission_pass_3.0.0_SpeedResistanceList' + standardGearRatio: + description: "The ratio in the respective gear (ratio between transmission\ + \ input speed and transmission output speed). For example 1 : 4.1567;\ + \ 2 : 3.898; 3 : 2.887; 4 : 2.7783; 5 : 1.811; 6 : 1.6545; 7 : 0.4377;\ + \ 8 : 0.6121; R : -2.2183." + $ref: '#/components/schemas/urn_samm_io.catenax.transmission.transmission_pass_3.0.0_StandardGearRatioSet' + spreading: + description: The transmission spreading coefficient. The ratio between the + smallest (shortest gear) and the largest (longest gear) ratio. + $ref: '#/components/schemas/urn_samm_io.catenax.transmission.transmission_pass_3.0.0_Ratio' + oil: + description: The oil used for the transmission. + $ref: '#/components/schemas/urn_samm_io.catenax.transmission.transmission_pass_3.0.0_OilCharacteristic' + electricalPerformance: + description: "Attributes connected to the transmission-integrated electrical\ + \ machine, if applicable." + $ref: '#/components/schemas/urn_samm_io.catenax.transmission.transmission_pass_3.0.0_PerformanceCharacteristic' + serviceHistory: + description: Documentation of the service history of the transmission. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentList' + required: + - driveType + - torque + - power + - standardGearRatio + - spreading + - oil + - electricalPerformance + urn_samm_io.catenax.transmission.transmission_pass_3.0.0_MonthCharacteristics: + type: number + minimum: 0 + description: Measurement in months as an integer. + urn_samm_io.catenax.transmission.transmission_pass_3.0.0_KilometreCharacteristic: + type: number + minimum: 0 + description: Measurement in kilometre as an integer. + urn_samm_io.catenax.shared.quantity_2.0.0_QuantityValueCharacteristic: + type: number + description: The quantity value associated with the unit expressed as float. + urn_samm_io.catenax.shared.quantity_2.0.0_LinearUnitEnumeration: + type: string + pattern: "[a-zA-Z]*:[a-zA-Z]+" + description: "The unit of a linear attribute that may be used for height, width,\ + \ length and diameter." + enum: + - unit:millimetre + - unit:centimetre + - unit:metre + - unit:kilometre + - unit:inch + - unit:foot + - unit:yard + urn_samm_io.catenax.shared.quantity_2.0.0_LinearCharacteristic: + description: Characteristic for linear measurements of an item. + type: object + properties: + value: + description: The quantity value associated with the unit. + $ref: '#/components/schemas/urn_samm_io.catenax.shared.quantity_2.0.0_QuantityValueCharacteristic' + unit: + description: The unit of a linear attribute. + $ref: '#/components/schemas/urn_samm_io.catenax.shared.quantity_2.0.0_LinearUnitEnumeration' + required: + - value + - unit + urn_samm_io.catenax.shared.quantity_2.0.0_MassUnitEnumeration: + type: string + pattern: "[a-zA-Z]*:[a-zA-Z]+" + description: Enumeration for mass units. + enum: + - unit:gram + - unit:kilogram + - unit:tonneMetricTon + - unit:tonUsOrShortTonUkorus + - unit:ounceAvoirdupois + - unit:pound + urn_samm_io.catenax.shared.quantity_2.0.0_MassCharacteristic: + description: Characteristic for mass measurements of an item. + type: object + properties: + value: + description: The quantity value associated with the unit. + $ref: '#/components/schemas/urn_samm_io.catenax.shared.quantity_2.0.0_QuantityValueCharacteristic' + unit: + description: The unit of a mass related attribute. + $ref: '#/components/schemas/urn_samm_io.catenax.shared.quantity_2.0.0_MassUnitEnumeration' + required: + - value + - unit + urn_samm_io.catenax.shared.quantity_2.0.0_VolumeUnitEnumeration: + type: string + pattern: "[a-zA-Z]*:[a-zA-Z]+" + description: Enumeration for volume units. + enum: + - unit:cubicMetre + - unit:litre + - unit:millilitre + - unit:cubicCentimetre + - unit:cubicInch + - unit:cubicFoot + - unit:cubicYard + - unit:hectolitre + urn_samm_io.catenax.shared.quantity_2.0.0_VolumeCharacteristic: + description: Characteristic for volume measurements of an item. + type: object + properties: + value: + description: The quantity value associated with the unit. + $ref: '#/components/schemas/urn_samm_io.catenax.shared.quantity_2.0.0_QuantityValueCharacteristic' + unit: + description: The unit of a volume related attribute. + $ref: '#/components/schemas/urn_samm_io.catenax.shared.quantity_2.0.0_VolumeUnitEnumeration' + required: + - value + - unit + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PhysicalDimensionCharacteristic: + description: "Characteristic for physical dimensions with linear, mass and capacity\ + \ attributes." + type: object + properties: + width: + description: The width of the item measured in a specific linear unit which + can be declared in the corresponding unit attribute. + $ref: '#/components/schemas/urn_samm_io.catenax.shared.quantity_2.0.0_LinearCharacteristic' + length: + description: The length of the item measured in a specific linear unit which + can be declared in the corresponding unit attribute. + $ref: '#/components/schemas/urn_samm_io.catenax.shared.quantity_2.0.0_LinearCharacteristic' + diameter: + description: "The diameter of the item, if applicable, measured in a specific\ + \ linear unit which can be declared in the corresponding unit attribute." + $ref: '#/components/schemas/urn_samm_io.catenax.shared.quantity_2.0.0_LinearCharacteristic' + height: + description: The height of the item measured in a specific linear unit which + can be declared in the corresponding unit attribute. + $ref: '#/components/schemas/urn_samm_io.catenax.shared.quantity_2.0.0_LinearCharacteristic' + grossWeight: + description: |- + The gross weight of the item measured in a specific mass unit which can be declared in the corresponding unit attribute. Gross weight refers to the total weight of a product, including the weight of the packaging. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7: + (2) (b) (i) information on the performance of the product in relation to the product parameters referred to in Annex I; + Annex I (i) weight and volume of the product and its packaging, and the product-to-packaging ratio. + $ref: '#/components/schemas/urn_samm_io.catenax.shared.quantity_2.0.0_MassCharacteristic' + grossVolume: + description: |- + The gross volume of the item, if possible, measured in a specific capacity unit which can be declared in the corresponding unit attribute. If there is no separate packing, the volume of the product shall be given. Gross volume refers to the total volume of a product, including the volume of the packaging. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7: + (2) (b) (i) information on the performance of the product in relation to the product parameters referred to in Annex I; + Annex I (i) weight and volume of the product and its packaging, and the product-to-packaging ratio. + $ref: '#/components/schemas/urn_samm_io.catenax.shared.quantity_2.0.0_VolumeCharacteristic' + weight: + description: |- + Weight of the product measured in a specific mass unit which can be declared in the corresponding unit attribute. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7: + (2) (b) (i) information on the performance of the product in relation to the product parameters referred to in Annex I; + Annex I (i) weight and volume of the product [...]. + $ref: '#/components/schemas/urn_samm_io.catenax.shared.quantity_2.0.0_MassCharacteristic' + volume: + description: |- + Volume of the product, if possible, measured in a specific capacity unit which can be declared in the corresponding unit attribute. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7: + (2) (b) (i) information on the performance of the product in relation to the product parameters referred to in Annex I; + Annex I (i) weight and volume of the product [...]. + $ref: '#/components/schemas/urn_samm_io.catenax.shared.quantity_2.0.0_VolumeCharacteristic' + required: + - grossWeight + - grossVolume + - weight + - volume + urn_samm_io.catenax.transmission.transmission_pass_3.0.0_ProductCharacteristics: + description: Defines a set of specific characteristics of the transmission. + type: object + properties: + warranty: + description: Commercial warranty period of the transmission (coupled to + the Vehicle) in months. + $ref: '#/components/schemas/urn_samm_io.catenax.transmission.transmission_pass_3.0.0_MonthCharacteristics' + lifeTime: + description: Expected transmission lifespan in kilometres. + $ref: '#/components/schemas/urn_samm_io.catenax.transmission.transmission_pass_3.0.0_KilometreCharacteristic' + physicalDimension: + description: |- + Physical dimensions are properties associated with physical quantities for purposes of classification or differentiation. These attributes are mentioned in the ESPR provisional agreement from January 9th, Article 7: + (2) (b) (i) information on the performance of the product in relation to one or more of the product parameters referred to in Annex I; + Annex I (i) weight and volume of the product and its packaging, and the product-to-packaging ratio. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PhysicalDimensionCharacteristic' + required: + - warranty + - lifeTime + - physicalDimension + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_StatusEnumeration: + type: string + description: "The current status of the product passport declared through either:\ + \ draft, approved, invalid or expired." + enum: + - draft + - approved + - invalid + - expired + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DateTrait: + type: string + description: Constraint fo a timestamp in the format (yyyy-mm-dd). + pattern: "^\\d{4}-\\d{2}-\\d{2}$" + urn_samm_io.catenax.shared.business_partner_number_2.0.0_BpnlTrait: + type: string + description: "The provided regular expression ensures that the BPNL is composed\ + \ of prefix 'BPNL', 10 digits and two alphanumeric letters." + pattern: "^BPNL[a-zA-Z0-9]{12}$" + 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_io.catenax.generic.digital_product_passport_5.0.0_IdentifierCharacteristic: + type: string + description: Characteristic for Identifiers. + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_MetadataCharacteristic: + description: Characteristic for the passport metadata of the digital product + passport. + type: object + properties: + version: + description: |- + The current version of the product passport. The possibility of modification/ updating the product passport needs to include versioning of the dataset. This attribute is an internal versioning from the passport issuer. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Article 8: + (1) [...] The information in the product passport shall be accurate, complete, and up to date. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + status: + description: "The current status of the product passport declared through\ + \ either: draft, approved, invalid or expired." + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_StatusEnumeration' + expirationDate: + description: |- + The timestamp in the format (yyyy-mm-dd) for the product passport until when it is available or a comment describing this period. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Article 8: + (2) (h) the period during which the product passport is to remain available, which shall correspond to at least the expected lifetime of a specific product. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DateTrait' + issueDate: + description: The timestamp in the format (yyyy-mm-dd) since when the product + passport is available. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DateTrait' + economicOperatorId: + description: |- + The identification of the owner/economic operator of the passport. Proposed, according to ISO 15459, is the CIN (company identification code). Other identification numbers like the tax identification number, value added tax identification number, commercial register number and the like are also valid entries. In the Catena-X network, the BPNL is used for the identification of companies and the information stored like contact information and addresses. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Annex III: + (k) the [...] unique operator identifier code of the economic operator established in the Union responsible for carrying out the tasks set out in Article 4 of Regulation (EU) 2019/1020, or Article 15 of Regulation (EU) on general product safety, or similar tasks pursuant to other EU legislation applicable to the product. + $ref: '#/components/schemas/urn_samm_io.catenax.shared.business_partner_number_2.0.0_BpnlTrait' + passportIdentifier: + description: "The identifier of the product passport, which is an uuidv4." + $ref: '#/components/schemas/urn_samm_io.catenax.shared.uuid_2.0.0_UuidV4Trait' + predecessor: + description: |- + Identification of the preceding product passport. If there is no preceding passport, input a dummy value. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Article 8: + (2)(g) [...] Any new product passport shall be linked to the product passport or passports of the original product whenever appropriate. + $ref: '#/components/schemas/urn_samm_io.catenax.shared.uuid_2.0.0_UuidV4Trait' + backupReference: + description: |- + A reference to the data backup of the passport. This mandatory attribute will be further defined in the future. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex III: + (kb) the reference of the certified independent third-party product passport service provider hosting the back-up copy of the product passport. + Article 10 also mentions: + (c) the data included in the product passport shall be stored by the economic operator responsible for its creation or by certified independent third-party product passport service providers authorised to act on their behalf. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + registrationIdentifier: + description: |- + Identifier in the respective registry. This will be further defined in the future. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 in Article 12: + By [2 years from entering into force of this Regulation], the Commission shall set up and manage a digital registry ("the registry") storing in a secure manner at least the unique product identifier, the unique operator identifier, the unique facility identifiers. In case of products intended to be placed under the customs procedure 'release for free circulation', the registry shall also store the product commodity code. The registry shall also store the batteries' unique identifiers referred to in Article 77(3) of Regulation (EU) 2023/1542. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_IdentifierCharacteristic' + lastModification: + description: Date of the latest modification. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DateTrait' + required: + - version + - expirationDate + - issueDate + - economicOperatorId + - passportIdentifier + - predecessor + - backupReference + urn_samm_io.catenax.serial_part_3.0.0_KeyTrait: + type: string + description: Constraint that ensures that the standard keys and custom key prefixes + can be used. + pattern: ^(manufacturerId|partInstanceId|batchId|van|customKey:\w+)$ + urn_samm_io.catenax.serial_part_3.0.0_ValueCharacteristic: + type: string + description: The value of an identifier. + urn_samm_io.catenax.serial_part_3.0.0_KeyValueList: + description: "A list of key value pairs for local identifiers, which are composed\ + \ of a key and a corresponding value." + type: object + properties: + key: + description: 'The key of a local identifier. ' + $ref: '#/components/schemas/urn_samm_io.catenax.serial_part_3.0.0_KeyTrait' + value: + description: The value of an identifier. + $ref: '#/components/schemas/urn_samm_io.catenax.serial_part_3.0.0_ValueCharacteristic' + required: + - key + - value + urn_samm_io.catenax.serial_part_3.0.0_LocalIdentifierCharacteristic: + description: "A single serialized part may have multiple attributes, that uniquely\ + \ identify a that part in a specific dataspace (e.g. the manufacturer`s dataspace)" + type: array + items: + $ref: '#/components/schemas/urn_samm_io.catenax.serial_part_3.0.0_KeyValueList' + uniqueItems: true + urn_samm_io.catenax.batch_3.0.0_KeyTrait: + type: string + description: Constraint that ensures that the predefined keys are used. + pattern: ^(manufacturerId|batchId|customKey:\w+)$ + urn_samm_io.catenax.batch_3.0.0_ValueCharacteristic: + type: string + description: The value of an identifier. + urn_samm_io.catenax.batch_3.0.0_KeyValueList: + description: "A list of key value pairs for local identifiers, which are composed\ + \ of a key and a corresponding value." + type: object + properties: + key: + description: The key of a local identifier. + $ref: '#/components/schemas/urn_samm_io.catenax.batch_3.0.0_KeyTrait' + value: + description: The value of an identifier. + $ref: '#/components/schemas/urn_samm_io.catenax.batch_3.0.0_ValueCharacteristic' + required: + - key + - value + urn_samm_io.catenax.batch_3.0.0_LocalIdentifierCharacteristic: + description: "A batch may have multiple attributes, which uniquely identify\ + \ that batch in a specific dataspace(e.g. the manufacturer`s dataspace)" + type: array + items: + $ref: '#/components/schemas/urn_samm_io.catenax.batch_3.0.0_KeyValueList' + uniqueItems: true + urn_samm_io.catenax.part_type_information_1.0.0_PartIdCharacteristic: + type: string + description: "The part ID is a multi-character string, usually assigned by an\ + \ ERP system." + urn_samm_io.catenax.part_type_information_1.0.0_PartNameCharacteristic: + type: string + description: Part name in string format from the respective system in the value + chain. + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PartTypeCharacteristic: + description: Characteristic for the part type. + type: object + properties: + manufacturerPartId: + description: Part ID as assigned by the manufacturer of the part. The part + ID identifies the part in the manufacturer`s dataspace. The part ID references + a specific version of a part. The version number must be included in the + part ID if it is available. The part ID does not reference a specific + instance of a part and must not be confused with the serial number. + $ref: '#/components/schemas/urn_samm_io.catenax.part_type_information_1.0.0_PartIdCharacteristic' + nameAtManufacturer: + description: Name of the part as assigned by the manufacturer. + $ref: '#/components/schemas/urn_samm_io.catenax.part_type_information_1.0.0_PartNameCharacteristic' + required: + - manufacturerPartId + - nameAtManufacturer + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_CodeEntity: + description: Code entity with code key and value. + type: object + properties: + key: + description: |- + The code key for the identification of the product. Examples are GTIN, hash, DID, ISBN, TARIC. This attribute is mentioned in the ESPR proposal from March 30th, 2022 ANNEX III: + (b) the unique product identifier at the level indicated in the applicable delegated act adopted pursuant to Article 4; + (c) the Global Trade Identification Number as provided for in standard ISO/IEC 15459-6 or equivalent of products or their parts; + (d) relevant commodity codes, such as a TARIC code as defined in Council Regulation (EEC) No 2658/87. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_IdentifierCharacteristic' + value: + description: The code value for the identification of the product in regard + to the chosen code name. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_IdentifierCharacteristic' + required: + - key + - value + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_CodeList: + description: A list of additional codes. + type: array + items: + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_CodeEntity' + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DataCarrierCharacteristic: + description: Data Carrier Characteristic for the product. + type: object + properties: + carrierType: + description: |- + The type of data carrier such as a QR code on the product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 8: + (2) (b) the types of data carrier to be used. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + carrierLayout: + description: |- + The positioning of data carrier on the product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 8: + (2) (c) the layout in which the data carrier shall be presented and its positioning. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + required: + - carrierType + - carrierLayout + urn_samm_io.catenax.shared.part_classification_1.0.0_ClassificationStandardCharacteristic: + type: string + description: Identified classification standards that align to the Catena-X + needs. + urn_samm_io.catenax.shared.part_classification_1.0.0_ClassificationIDCharacteristic: + type: string + description: "It can be numeric or a string, depending on the chosen classification\ + \ standard." + urn_samm_io.catenax.shared.part_classification_1.0.0_ClassificationEntity: + description: Encapsulates data related to the classification of the part. + type: object + properties: + classificationStandard: + description: Identified classification standards that align to the Catena-X + needs. + $ref: '#/components/schemas/urn_samm_io.catenax.shared.part_classification_1.0.0_ClassificationStandardCharacteristic' + classificationID: + description: The classification ID of the part type according to the corresponding + standard definition mentioned in the key value pair. + $ref: '#/components/schemas/urn_samm_io.catenax.shared.part_classification_1.0.0_ClassificationIDCharacteristic' + classificationDescription: + description: Optional property describing the classification standard. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + required: + - classificationStandard + - classificationID + urn_samm_io.catenax.shared.part_classification_1.0.0_ClassificationCharacteristic: + description: Classification characteristic enabling a set of further properties. + type: array + items: + $ref: '#/components/schemas/urn_samm_io.catenax.shared.part_classification_1.0.0_ClassificationEntity' + uniqueItems: true + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_IdentificationCharacteristic: + description: Identification information of the product. + type: object + properties: + serial: + description: |- + Identifier for a serial part if available. This is mentioned in the ESPR provisional agreement from January 9th, 2024 Recital (27): + [...] an 'item' usually means a single unit of a model. + $ref: '#/components/schemas/urn_samm_io.catenax.serial_part_3.0.0_LocalIdentifierCharacteristic' + batch: + description: |- + Identifier for a batch part if available. Identifier for a serial part if available. This is mentioned in the ESPR provisional agreement from January 9th, 2024 Recital (27): + [...] a 'batch' usually means a subset of a specific model composed of all products produced in a specific manufacturing plant at a specific moment in time [...]. + $ref: '#/components/schemas/urn_samm_io.catenax.batch_3.0.0_LocalIdentifierCharacteristic' + type: + description: |- + Identifier on the level of a part model or type. Identifier for a serial part if available. This is mentioned in the ESPR provisional agreement from January 9th, 2024 Recital (27): + [...] A 'model' usually means a version of a product of which all units share the same technical characteristics relevant for the ecodesign requirements and the same model identifier [...]. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PartTypeCharacteristic' + codes: + description: Codes for identification. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_CodeList' + dataCarrier: + description: |- + The type and layout of the data carrier on the product. These are mentioned in the ESPR proposal from March 30th, 2022 Article 8: + (b) the types of data carrier to be used; + (c) the layout in which the data carrier shall be presented and its positioning; + Article 2 defines: + (30) 'data carrier' means a linear bar code symbol, a two-dimensional symbol or other automatic identification data capture medium that can be read by a device. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DataCarrierCharacteristic' + classification: + description: Property describing the classification of a part. + $ref: '#/components/schemas/urn_samm_io.catenax.shared.part_classification_1.0.0_ClassificationCharacteristic' + required: + - type + - codes + - dataCarrier + - classification + urn_samm_io.catenax.shared.business_partner_number_2.0.0_BpnaTrait: + type: string + description: "The provided regular expression ensures that the BPNA is composed\ + \ of prefix 'BPNA', 10 digits and two alphanumeric letters." + pattern: "^BPNA[a-zA-Z0-9]{12}$" + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_FacilityEntity: + description: The entity for a facility with the BPNA identifier. + type: object + properties: + facility: + description: |- + The identifier used for a location. This attribute is mentioned in the ESPR provisional agreement from January 9th 2024 Annex III: + (i) unique facility identifiers; + Article 2 Definitions: (33) 'unique facility identifier' means a unique string of characters for the identification of locations or buildings involved in the value chain of a product or used by actors involved in the value chain of a product. + $ref: '#/components/schemas/urn_samm_io.catenax.shared.business_partner_number_2.0.0_BpnaTrait' + required: + - facility + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_FacilityList: + description: List of facilities. + type: array + items: + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_FacilityEntity' + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_ManufacturerCharacteristic: + description: Manufacturing information. + type: object + properties: + facility: + description: |- + The identifier used for a location. In the CATENA-X use case, the BPNA can be stated. This attribute is mentioned in the ESPR provisional agreement from January 9th 2024 Annex III: + (i) unique facility identifiers; + Article 2 Definitions: (33) 'unique facility identifier' means a unique string of characters for the identification of locations or buildings involved in the value chain of a product or used by actors involved in the value chain of a product. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_FacilityList' + manufacturer: + description: |- + The main manufacturer, if different from the passport owner, represented by an identification number. In the Catena-X use case, the BPNL can be stated. This attribute is mentioned in the ESPR provisional agreement from January 9th 2024 Annex III: + (h) unique operator identifiers other than that of the manufacturer; + (k) the name, contact details and unique operator identifier code of the economic operator established in the Union responsible for carrying out the tasks set out in Article 4 of Regulation (EU) 2019/1020, or Article 15 of Regulation (EU) [.../...] on general product safety, or similar tasks pursuant to other EU legislation applicable to the product. + $ref: '#/components/schemas/urn_samm_io.catenax.shared.business_partner_number_2.0.0_BpnlTrait' + manufacturingDate: + description: "The timestamp in the format (yyyy-mm-dd) of the manufacturing\ + \ date as the final step in production process (e.g. final quality check,\ + \ ready-for-shipment event)." + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DateTrait' + required: + - facility + - manufacturer + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_EoriTrait: + type: string + description: "Constraint with a pattern which ensures that the EORI number starts\ + \ with two alphanumeric characters, followed by two alphabetic characters,\ + \ and ends with 2 to 15 alphanumeric characters." + pattern: "^[A-Z]{2}[A-Z0-9]{1,18}$" + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_ImporterCharacteristic: + description: Characteristic with information regarding the importer. + type: object + properties: + eori: + description: |- + An economic operator established in the customs territory of the Union needs, for customs purposes, an EORI number. EORI stands for economic operators registration and identification number. In this case, the importer's EORI must be provided. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Annex III: + (j) information related to the importer, including the information referred to in Article 23(3) and its EORI number. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_EoriTrait' + id: + description: |- + The importer of the product, if different from the owner of the passport. In the Catena-X network, the BPNL is used for the identification of companies and the information stored for this like contact information and addresses. + This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex III: + (j) information related to the importer, including the information referred to in Article 23(3) and its EORI number; + Article 23 states: + (3) Importers shall, for products covered by a delegated act adopted pursuant to Article 4, indicate their name, registered trade name or registered trade mark and the postal address and electronic means of communication, where they can be contacted: (a) on the public part of the product passport, when applicable, and + (b) on the product or, where this is not possible, on the packaging, or in a document accompanying the product. + $ref: '#/components/schemas/urn_samm_io.catenax.shared.business_partner_number_2.0.0_BpnlTrait' + required: + - eori + - id + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_ImportCharacteristic: + description: Import Characteristic for the product. + type: object + properties: + content: + description: |- + Information regarding the importer of the product, if different from the owner of the passport. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex III: + (j) information related to the importer, including the information referred to in Article 23(3) and its EORI number; + Article 23 states: + (3) Importers shall, for products covered by a delegated act adopted pursuant to Article 4, indicate their name, registered trade name or registered trade mark and the postal address and electronic means of communication, where they can be contacted: (a) on the public part of the product passport, when applicable, and + (b) on the product or, where this is not possible, on the packaging, or in a document accompanying the product. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_ImporterCharacteristic' + applicable: + description: "Check whether the connected attributes are applicable to the\ + \ product. If it is not applicable (false), dummy data can be delivered." + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Boolean' + required: + - content + - applicable + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_OperatorCharacteristic: + description: Other operators characteristic. + type: object + properties: + id: + description: Identifier of the other operator. This can be a BPN. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + role: + description: Role of the other operator. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + required: + - id + - role + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_OperationCharacteristic: + description: Operational information of the product. + type: object + properties: + manufacturer: + description: |- + Manufacturing information of the product. In the CATENA-X use case, the BPNL and BPNA can be stated. These attributes are mentioned in the ESPR provisional agreement from January 9th 2024 Annex III: + (h) unique operator identifiers other than that of the manufacturer; + (k) the name, contact details and unique operator identifier code of the economic operator established in the Union responsible for carrying out the tasks set out in Article 4 of Regulation (EU) 2019/1020, or Article 15 of Regulation (EU) [.../...] on general product safety, or similar tasks pursuant to other EU legislation applicable to the product. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_ManufacturerCharacteristic' + import: + description: Importer details such as the identification. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_ImportCharacteristic' + other: + description: Other operators relevant for the product. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_OperatorCharacteristic' + required: + - manufacturer + - import + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_SourcesEntity: + description: Entity for a possible spare part sources. + type: object + properties: + id: + description: "The identifier of a spare part producer of the product. In\ + \ the Catena-X network, the BPNL is used for the identification of companies\ + \ and the information stored for this like contact information and addresses." + $ref: '#/components/schemas/urn_samm_io.catenax.shared.business_partner_number_2.0.0_BpnlTrait' + required: + - id + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_SourcesList: + description: List of possible spare part sources. + type: array + items: + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_SourcesEntity' + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PartsEntity: + description: Possible spare parts of the product with identifiers and names. + type: object + properties: + manufacturerPartId: + description: Part ID as assigned by the manufacturer of the part. The part + ID identifies the part in the manufacturer`s dataspace. The part ID references + a specific version of a part. The version number must be included in the + part ID if it is available. The part ID does not reference a specific + instance of a part and must not be confused with the serial number. + $ref: '#/components/schemas/urn_samm_io.catenax.part_type_information_1.0.0_PartIdCharacteristic' + nameAtManufacturer: + description: Name of the part as assigned by the manufacturer. + $ref: '#/components/schemas/urn_samm_io.catenax.part_type_information_1.0.0_PartNameCharacteristic' + required: + - manufacturerPartId + - nameAtManufacturer + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PartList: + description: A list of possible spare parts of the product. + type: array + items: + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PartsEntity' + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_SparePart: + description: Characteristic describing sources and spare parts. + type: object + properties: + producer: + description: Sources of possible spare parts. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_SourcesList' + sparePart: + description: Possible spare parts of the product. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PartList' + required: + - producer + - sparePart + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_HandlingCharacteristic: + description: Characteristic to describe aspects which are connected with the + handling of the product. + type: object + properties: + content: + description: The list of spare parts available for the product from various + suppliers. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_SparePart' + applicable: + description: "Check whether the connected attributes are applicable to the\ + \ product. If it is not applicable (false), dummy data can be delivered." + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Boolean' + required: + - content + - applicable + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_StringList: + description: List of strings. + type: array + items: + type: string + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_CommercialCharacteristic: + description: Commercial information of the product. + type: object + properties: + placedOnMarket: + description: The timestamp in the format (yyyy-mm-dd) with or without time + zone when the product was put in the market. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DateTrait' + purpose: + description: "One or more intended industry/industries of the product described\ + \ by the digital product passport. If exchanged via Catena-X, 'automotive\ + \ ' is a must choice included in the list." + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_StringList' + required: + - purpose + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_ConcentrationEnumeration: + type: string + description: "Enumeration of possible units of concentration with percent, volume\ + \ percent, parts per thousand, parts per million, parts per billion and parts\ + \ per trillion." + enum: + - unit:partPerMillion + - unit:percent + - unit:percentVolume + - unit:partPerThousand + - unit:partPerTrillionUs + - unit:partPerBillionUs + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PositiveTrait: + type: number + description: Constraint for only positive values. + minimum: 0.0 + exclusiveMinimum: false + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_HazardCharacteristic: + description: Characteristic for the hazardous classification. + type: object + properties: + category: + description: |- + The hazard category of the substance of concern. Defined in Article 2 of Regulation (EC) No 1272/2008 of the European Parliament and of the Council of 16 December 2008 on classification, labelling and packaging of substances and mixtures, amending and repealing Directives 67/548/EEC and 1999/45/EC, and amending Regulation (EC) No 1907/2006: + 2. 'hazard category' means the division of criteria within each hazard class, specifying hazard severity. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + class: + description: |- + The hazard class of the substance of concern. Defined in Article 2 of Regulation (EC) No 1272/2008 of the European Parliament and of the Council of 16 December 2008 on classification, labelling and packaging of substances and mixtures, amending and repealing Directives 67/548/EEC and 1999/45/EC, and amending Regulation (EC) No 1907/2006: + 1. 'hazard class' means the nature of the physical, health or environmental hazard. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + statement: + description: |- + The hazard statement of the substance of concern. Defined in Article 2 of Regulation (EC) No 1272/2008 of the European Parliament and of the Council of 16 December 2008 on classification, labelling and packaging of substances and mixtures, amending and repealing Directives 67/548/EEC and 1999/45/EC, and amending Regulation (EC) No 1907/2006: + 5. 'hazard statement' means a phrase assigned to a hazard class and category that describes the nature of the hazards of a hazardous substance or mixture, including, where appropriate, the degree of hazard. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + required: + - category + - class + - statement + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_RangeEntity: + description: "Entity for the concentration range with two values, the highest\ + \ and the lowest of the concentration range." + type: object + properties: + min: + description: |- + The minimum concentration of the substance of concern at the level of the product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7: + (5) (c) [...] concentration range of the substances of concern, at the level of the product [...]. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PositiveTrait' + max: + description: |- + The maximum concentration of the substance of concern at the level of the product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7: + (5) (c) the concentration, maximum concentration or concentration range of the substances of concern, at the level of the product [...]. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PositiveTrait' + required: + - max + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_RangeCharacteristic: + description: "Range characteristic with two values, the highest and the lowest\ + \ of the concentration range. Only providing the maximum range is also possible." + type: array + items: + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_RangeEntity' + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_ListTypeEnumerationId: + type: string + description: Enumeration of different systems and organizations related to the + identification and classification of chemical substances in the field of chemistry. + The enumeration values are EC or CAS. + enum: + - CAS + - EC + - IUPAC + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_MaterialIdEntity: + description: "Id Entity with identifier, name and list type." + type: object + properties: + id: + description: "The substance identification, in accordance with the specification\ + \ in the attribute for the list type." + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_IdentifierCharacteristic' + type: + description: "The type of standard used for the identification of the substances.\ + \ Selected can be for example CAS, IUPAC or EC." + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_ListTypeEnumerationId' + name: + description: The name of the material which is present in the product. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + required: + - id + - type + - name + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_MaterialIdList: + description: List of ids for the identification. + type: array + items: + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_MaterialIdEntity' + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_SubstanceEntity: + description: Information regarding substances of concern in the product. + type: object + properties: + location: + description: |- + The location of the substances of concern within the product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7: + (5) (b) the location of the substances of concern within the product. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + unit: + description: "The unit of concentration chosen from an enumeration: mass\ + \ percent, volume percent, parts per thousand, parts per million, parts\ + \ per billion and parts per trillion." + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_ConcentrationEnumeration' + concentration: + description: | + Concentration of the material at the level of the product. This attribute is specially mentioned for substances of concern mentioned in the ESPR proposal from March 30th, 2022 Article 7: + (5) (c) the concentration, maximum concentration or concentration range of the substances of concern, at the level of the product [...]. + Other substances are mentioned for the purpose of recycling in the ESPR provisional agreement from January 9th, 2024 Annex I: + (d) design for recycling, ease and quality of recycling as expressed through: use of easily recyclable materials, safe, easy and non-destructive access to recyclable components and materials or components and materials containing hazardous substances and material composition and homogeneity, possibility for high-purity sorting, number of materials and components used, use of standard components, use of component and material coding standards for the identification of components and materials, number and complexity of processes and tools needed, ease of nondestructive disassembly and re-assembly, conditions for access to product data, conditions for access to or use of hardware and software needed. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PositiveTrait' + exemption: + description: |- + Exemptions to the substance of concern. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Article 7: + (5) (c) provide duly justified exemptions for substances of concern or information elements from the information requirements referred to in the first subparagraph based on the technical feasibility or relevance of tracking substances of concern, the existence of analytical methods to detect and quantify them, the need to protect confidential business information or in other duly justified cases. Substances of concern within the meaning of Article 2(28), point a), shall not be exempted if they are present in products, their relevant components or spare parts in a concentration above 0,1 % weight by weight. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + hazardClassification: + description: |- + The specification of the hazard class. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I: + (f) use of substances, and in particular the use of substances of concern, on their own, as constituents of substances or in mixtures, during the production process of products, or leading to their presence in products, including once these products become waste, and their impacts on human health and the environment; + Further defined is this by Regulation (EC) No 1272/2008 of the European Parliament and of the Council of 16 December 2008 on classification, labelling and packaging of substances and mixtures, amending and repealing Directives 67/548/EEC and 1999/45/EC, and amending Regulation (EC) No 1907/2006. + Defined in Article 2: + 1. 'hazard class' means the nature of the physical, health or environmental hazard; + 2. 'hazard category' means the division of criteria within each hazard class, specifying hazard severity; + 5. 'hazard statement' means a phrase assigned to a hazard class and category that describes the nature of the hazards of a hazardous substance or mixture, including, where appropriate, the degree of hazard; + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_HazardCharacteristic' + concentrationRange: + description: |- + The concentration range for the substance of concern. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Article 7: + (5) (c) [...] concentration range of the substances of concern, at the level of the product [...]. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_RangeCharacteristic' + id: + description: "The chemical material name and identification, in accordance\ + \ with the specification in the attribute for the list type. Preference\ + \ is given to the IUPAC name. This attribute is mentioned in the ESPR\ + \ provisional agreement from January 9th, 2024 Article 7:\n(5) (a) the\ + \ name of the substances of concern present in the product, as follows:\n\ + \ - name(s) in the International Union of Pure and Applied Chemistry (IUPAC)\ + \ nomenclature, or another international name when IUPAC name is not available;\ + \ \n- other names (usual name, trade name, abbreviation);\n- European\ + \ Community (EC) number, as indicated in the European Inventory of Existing\ + \ Commercial Chemical Substances (EINECS), the European List of Notified\ + \ Chemical Substances (ELINCS) or the No Longer Polymer (NLP) list or\ + \ assigned by the European Chemicals Agency (ECHA), if available;\n- the\ + \ Chemical Abstract Service (CAS) name(s) and number(s), if available;\ + \ ." + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_MaterialIdList' + documentation: + description: Documentation accompanying the material. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentList' + required: + - location + - unit + - concentration + - exemption + - hazardClassification + - concentrationRange + - id + - documentation + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_SubstanceList: + description: Characteristic for a list of substances of concern. + type: array + items: + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_SubstanceEntity' + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_SubstanceOfConcernCharacteristic: + description: Substance of concern Characteristic of the product. + type: object + properties: + applicable: + description: "Check whether the connected attributes are applicable to the\ + \ product. If it is not applicable (false), dummy data can be delivered." + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Boolean' + content: + description: "Information regarding substances of concern in the product.\ + \ Attributes are among others substance names, ids, concentration, location\ + \ and hazard class. This is mentioned in the ESPR provisional agreement\ + \ from January 9th, 2024 Article 7:\n(5) (a) the name of the substances\ + \ of concern present in the product, as follows:\n- name(s) in the International\ + \ Union of Pure and Applied Chemistry (IUPAC) nomenclature, or another\ + \ international name when IUPAC name is not available; \n- other names\ + \ (usual name, trade name, abbreviation);\n- European Community (EC) number,\ + \ as indicated in the European Inventory of Existing Commercial Chemical\ + \ Substances (EINECS), the European List of Notified Chemical Substances\ + \ (ELINCS) or the No Longer Polymer (NLP) list or assigned by the European\ + \ Chemicals Agency (ECHA), if available;\n- the Chemical Abstract Service\ + \ (CAS) name(s) and number(s), if available;\n(5) (b) the location of\ + \ the substances of concern within the product.\n(5) (c) the concentration,\ + \ maximum concentration or concentration range of the substances of concern,\ + \ at the level of the product its relevant components, or spare parts;\n\ + (d) relevant instructions for the safe use of the product;\n(e) information\ + \ relevant for disassembly, preparation for reuse, reuse, recycling and\ + \ the environmentally sound management of the product at the end of its\ + \ life.\nAnd in the next paragraph:\n(c) provide duly justified exemptions\ + \ for substances of concern or information elements from the information\ + \ requirements referred to in the first subparagraph." + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_SubstanceList' + required: + - applicable + - content + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PercentageTrait: + type: number + description: Range constraint for a positive percentage value. + maximum: 100.0 + exclusiveMaximum: false + minimum: 0.0 + exclusiveMinimum: false + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_MaterialEntity: + description: Information regarding recycled and/or renewable materials in the + product. + type: object + properties: + recycled: + description: |- + The share of the material, which is recovered recycled content from the product. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I: + (h) use or content of recycled materials and recovery of materials, including critical raw materials; + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PercentageTrait' + renewable: + description: | + The share of the material, which is from a renewable resource that can be replenished. Renewable resources are those that can be reproduced by physical, chemical, or mechanical processes. These are the kind of resources that can be regenerated throughout time. Forest wood, for example, can be grown through reforestation. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I: + (ha) use or content of sustainable renewable materials; + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PercentageTrait' + unit: + description: "The unit of concentration chosen from an enumeration: mass\ + \ percent, volume percent, parts per thousand, parts per million, parts\ + \ per billion and parts per trillion." + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_ConcentrationEnumeration' + id: + description: "The chemical material name and identification, in accordance\ + \ with the specification in the attribute for the list type. Preference\ + \ is given to the IUPAC name. This attribute is mentioned in the ESPR\ + \ provisional agreement from January 9th, 2024 Article 7:\n(5) (a) the\ + \ name of the substances of concern present in the product, as follows:\n\ + \ - name(s) in the International Union of Pure and Applied Chemistry (IUPAC)\ + \ nomenclature, or another international name when IUPAC name is not available;\ + \ \n- other names (usual name, trade name, abbreviation);\n- European\ + \ Community (EC) number, as indicated in the European Inventory of Existing\ + \ Commercial Chemical Substances (EINECS), the European List of Notified\ + \ Chemical Substances (ELINCS) or the No Longer Polymer (NLP) list or\ + \ assigned by the European Chemicals Agency (ECHA), if available;\n- the\ + \ Chemical Abstract Service (CAS) name(s) and number(s), if available;\ + \ ." + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_MaterialIdList' + critical: + description: |- + A flag, if the material is a critical raw material. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I: + (h) use or content of recycled materials and recovery of materials, including critical raw materials; + In Annex II of the connected proposal Act of Critical Raw Materials, a list of critical raw materials can be found. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Boolean' + concentration: + description: | + Concentration of the material at the level of the product. This attribute is specially mentioned for substances of concern mentioned in the ESPR proposal from March 30th, 2022 Article 7: + (5) (c) the concentration, maximum concentration or concentration range of the substances of concern, at the level of the product [...]. + Other substances are mentioned for the purpose of recycling in the ESPR provisional agreement from January 9th, 2024 Annex I: + (d) design for recycling, ease and quality of recycling as expressed through: use of easily recyclable materials, safe, easy and non-destructive access to recyclable components and materials or components and materials containing hazardous substances and material composition and homogeneity, possibility for high-purity sorting, number of materials and components used, use of standard components, use of component and material coding standards for the identification of components and materials, number and complexity of processes and tools needed, ease of nondestructive disassembly and re-assembly, conditions for access to product data, conditions for access to or use of hardware and software needed. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PositiveTrait' + documentation: + description: Documentation accompanying the material. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentList' + required: + - recycled + - renewable + - unit + - id + - critical + - concentration + - documentation + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_MaterialList: + description: A list of different materials in the product. + type: array + items: + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_MaterialEntity' + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_MaterialCharacteristic: + description: Material Characteristic with information on the materials. + type: object + properties: + applicable: + description: "Check whether the connected attributes are applicable to the\ + \ product. If it is not applicable (false), dummy data can be delivered." + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Boolean' + content: + description: Information on different materials in the product. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_MaterialList' + required: + - applicable + - content + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_MaterialsCharacteristic: + description: Materials Characteristic on product level. + type: object + properties: + substancesOfConcern: + description: |- + Information regarding substances of concern in the product. The ESPR provisional agreement from January 9th, 2024 defines: + (52) 'hazardous substance' means a substance classified as hazardous pursuant to Article 3 of Regulation (EC) No 1272/2008. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_SubstanceOfConcernCharacteristic' + materialComposition: + description: Material composition of the product with information on recycled + and renewable materials. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_MaterialCharacteristic' + required: + - substancesOfConcern + - materialComposition + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_StateEnumeration: + type: string + description: "Enumeration defined as original, repurposed, re-used, remanufactured\ + \ or waste." + enum: + - original + - repurposed + - re-used + - remanufactured + - waste + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_CategoryEnumeration: + type: string + description: Enumeration of the 19 impact categories in accordance to EN15804+A2. + enum: + - Climate Change Total + - Climate Change Fossil + - Climate Change Biogenic Removals and Emissions + - Climate Change Land Use and Land Use Change + - Ozone Depletion + - Acidification + - Eutrophication Aquatic Freshwater + - Eutrophication Fresh Marine + - Eutrophication Terrestrial + - Photochemical Ozone Formation + - Abiotic Depletion- Minerals and Metals + - Fossil Fuels + - Water Use + - Particulate Matter Emissions + - "Ionizing Radiation, Human Health" + - Eco-Toxicity + - "Human Toxicity, Cancer Effects" + - "Human Toxicity, Non-Cancer Effects" + - Land Use Related Impacts/Soil Quality + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_FootprintEntity: + description: "Footprint Entity for the carbon and environmental footprint with\ + \ the total value, unit, impact category type, lifecycle, rulebook, declaration,\ + \ performance class and the facility." + type: object + properties: + value: + description: | + The value of the footprint of the product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Annex I: + (l) the environmental footprint of the product, expressed as a quantification, in accordance with the applicable delegated act, of a product's life cycle environmental impacts, whether in relation to one or more environmental impact categories or an aggregated set of impact categories; + (m) the carbon footprint of the product; + (ma) the material footprint of the product. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_PositiveTrait' + rulebook: + description: The applied rulebook for the environmental footprint of the + product. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentList' + lifecycle: + description: "The lifecycle stage, to which the environmental footprint\ + \ corresponds. These could be for example \"raw material acquisition and\ + \ pre-processing\", \"main product production\", \"distribution\" or \"\ + end of life and recycling\"." + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + unit: + description: "The unit of measurement of the environmental impact category.\ + \ For each impact category a specific unit is used. If an aggregation\ + \ is used, utilize the normalization and weighting methods used in the\ + \ referenced rulebook." + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + type: + description: |- + The type of the environmental footprint of the product. This could be one of the environmental impact categories. This attribute is mentioned in the ESPR provisional agreement from January 9th 2024 Article 7: + (2)(b)(i) information on the performance of the product in relation to one or more of the product parameters referred to in Annex I, including a scoring of reparability or durability, carbon footprint or environmental footprint; + Annex I: + (l) the environmental footprint of the product, expressed as a quantification, in accordance with the applicable delegated act, of a product's life cycle environmental impacts, whether in relation to one or more environmental impact categories or an aggregated set of impact categories. + (m) the carbon footprint of the product; + (ma) the material footprint of the product. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_CategoryEnumeration' + performanceClass: + description: The performance classification of the footprint. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + manufacturingPlant: + description: The manufacturing plant of the footprint in the specific lifecycle + phase. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_FacilityList' + declaration: + description: 'The footprint declaration in the format of a link ' + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentList' + required: + - value + - rulebook + - lifecycle + - unit + - type + - manufacturingPlant + - declaration + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_FootprintList: + description: Footprint List for the environmental footprint. + type: array + items: + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_FootprintEntity' + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_ProductFootprintCharacteristic: + description: The Product Footprint Characteristic with sustainability information. + type: object + properties: + environmental: + description: |- + The environmental footprint of the product. This attribute is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I: + The following parameters shall, as appropriate, and where necessary supplemented by others, be used, individually or combined, as a basis for improving the product aspects referred to in Article 5(1): + (l) the environmental footprint of the product, expressed as a quantification, in accordance with the applicable delegated act, of a product's life cycle environmental impacts, whether in relation to one or more environmental impact categories or an aggregated set of impact categories. + and Article 7: + (2)(b)(i) information on the performance of the product in relation to one or more of the product parameters referred to in Annex I, including a scoring of reparability or durability, carbon footprint or environmental footprint; + and defined by Article 2: + (23) 'environmental footprint' means a quantification of product environmental impacts throughout its life cycle, whether in relation to a single environmental impact category or an aggregated set of impact categories based on the Product Environmental Footprint method or other scientific methods developed by international organisations and widely tested in collaboration with different industry sectors and adopted or implemented by the Commission in other Union legislation; + (24) 'Product Environmental Footprint method' means the life cycle assessment method to quantify the environmental impacts of products established by Recommendation (EU) 2021/2279. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_FootprintList' + carbon: + description: |- + The carbon footprint of the product. This is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I: + The following parameters shall, as appropriate, and where necessary supplemented by others, be used, individually or combined, as a basis for improving the product aspects referred to in Article 5(1): + (m) the carbon footprint of the product; + and Article 7: + (2)(b)(i) information on the performance of the product in relation to one or more of the product parameters referred to in Annex I, including a scoring of reparability or durability, carbon footprint or environmental footprint; + and defined by Article 2: + (25) 'carbon footprint' means the sum of greenhouse gas (GHG) emissions and GHG removals in a product system, expressed as CO2 equivalents and based on a life cycle assessment using the single impact category of climate change. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_FootprintList' + material: + description: |- + The material footprint of the product. This is mentioned in the ESPR provisional agreement from January 9th, 2024 Annex I: + (ma) the material footprint of the product; + and defined by Article 2: + (25a) 'material footprint' refers to the total amount of raw materials extracted to meet final consumption demands. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_FootprintList' + required: + - carbon + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_SustainabilityCharacteristic: + description: Characteristic which describes relevant information for the sustainability + of the product. + type: object + properties: + status: + description: |- + The status of the product (original, repurposed, re-used, remanufactured or waste) to indicated, whether it is a used product. This attribute is mentioned in the ESPR proposal from March 30th, 2022 Annex I: + (j) incorporation of used components. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_StateEnumeration' + productFootprint: + description: "The carbon and environmental footprint or material footprint\ + \ of the product. These attributes are mentioned in the ESPR provisional\ + \ agreement from January 9th 2024 Annex I:\n(l) the environmental footprint\ + \ of the product, expressed as a quantification, in accordance with the\ + \ applicable delegated act, of a product's life cycle environmental impacts,\ + \ whether in relation to one or more environmental impact categories or\ + \ an aggregated set of impact categories;\n(m) the carbon footprint of\ + \ the product;\n(ma) the material footprint of the product;\nAll are defined\ + \ by Article 2:\n(23) 'environmental footprint' means a quantification\ + \ of product environmental impacts throughout its life cycle, whether\ + \ in relation to a single environmental impact category or an aggregated\ + \ set of impact categories based on the Product Environmental Footprint\ + \ method or other scientific methods developed by international organisations\ + \ and widely tested in collaboration with different industry sectors and\ + \ adopted or implemented by the Commission in other Union \nlegislation;\n\ + (25) 'carbon footprint' means the sum of greenhouse gas (GHG) emissions\ + \ and GHG removals in a product system, expressed as CO2 equivalents and\ + \ based on a life cycle assessment using the single impact category of\ + \ climate change.\n(25a) 'material footprint' refers to the total amount\ + \ of raw materials extracted to meet final consumption demands;" + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_ProductFootprintCharacteristic' + reparabilityScore: + description: |- + The reparability score. This attribute is mentioned ESPR provisional agreement from January 9th, 2024 Article 7: + (b) as appropriate, also require products to be accompanied by: + (i) information on the performance of the product in relation to one or more of the product parameters referred to in Annex I, including a scoring of reparability or durability [...]. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + durabilityScore: + description: |- + The durability score. This attribute is mentioned ESPR provisional agreement from January 9th, 2024 Article 7: + (b) as appropriate, also require products to be accompanied by: + (i) information on the performance of the product in relation to one or more of the product parameters referred to in Annex I, including a scoring of reparability or durability [...]. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + required: + - status + - productFootprint + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_SourceCategoryEnumeration: + type: string + description: The types of sources that can be linked in a digital product passport + can vary depending on the nature of the product and the information that needs + to be included. This is an enumeration of possible sources. + enum: + - Product Specifications + - Manufacturer Information + - User Manuals and Guides + - Certifications and Compliance + - Product Images and Videos + - Warranty Information + - Reviews and Ratings + - Product Variations + - Supply Chain Information + - Environmental Impact + - Compatibility and Accessories + - FAQs and Support + - Purchase and Retail Information + - Privacy and Data Handling + - Third-Party Integrations + - Legal Information + - Safety Information + - Repair and Installation + - Waste Generation and Prevention + - Specific Voluntary Labels + - Product Packaging + - Return and Disposal + - End of Life + - Material and Substance Information + - Technical Documentation + - Treatment facilities + - Other + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentEntity: + description: "Document entity with header, content, category and type." + type: object + properties: + content: + description: The content of the document e.g a link. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + category: + description: |- + The category in which the document can be sorted. These are mentioned in the ESPR proposal from March 30th, 2022 ANNEX III: + (e) compliance documentation and information required under this Regulation or other Union law applicable to the product, such as the declaration of conformity, technical documentation or conformity certificates; + ANNEX IV states additional information regarding the content of the technical documentation + Further information on documents are mentioned in the proposal from March 30th, 2022 ANNEX III: + (f) user manuals, instructions, warnings or safety information, as required by other Union legislation applicable to the product. + Additionally requirements are mentioned in Article 21: + (7) Manufacturers shall ensure that that a product covered by a delegated act adopted pursuant to Article 4 is accompanied by instructions that enable consumers and other end-users to safely assemble, install, operate, store, maintain, repair and dispose of the product in a language that can be easily understood by consumers and other end-users, as determined by the Member State concerned. Such instructions shall be clear, understandable and legible and include at least the information specified in the delegated acts adopted pursuant to Article 4 and pursuant to Article 7(2)(b), point (ii). + Article 7 states additionally: + (2) (b) (ii) information for consumers and other end-users on how to install, use, maintain and repair the product in order to minimize its impact on the environment and to ensure optimum durability, as well as on how to return or dispose of the product at end-of-life; + (2) (b) (iii) information for treatment facilities on disassembly, recycling, or disposal at end-of-life; + (2) (b) (iv) other information that may influence the way the product is handled by parties other than the manufacturer in order to improve performance in relation to product parameters referred to in Annex I. + (5) (d) relevant instructions for the safe use of the product. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_SourceCategoryEnumeration' + type: + description: "The type of content which can be expected in the \"content\"\ + \ property. Examples are a link, restricted link, pdf, excel, etc." + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + header: + description: The header as a short description of the document with a maximum + of 100 characters. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_HeaderTrait' + required: + - content + - category + - type + - header + urn_samm_io.catenax.generic.digital_product_passport_5.0.0_SourceList: + description: A list of documents. + type: array + items: + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_DocumentEntity' + urn_samm_io.catenax.transmission.transmission_pass_3.0.0_GenericCharacteristic: + description: Characteristic for the product generic parameters. + type: object + properties: + characteristics: + description: Defines specific characteristics of the transmission. + $ref: '#/components/schemas/urn_samm_io.catenax.transmission.transmission_pass_3.0.0_ProductCharacteristics' + metadata: + description: "Metadata of the product passport. These are mentioned in the\ + \ ESPR proposal from March 30th, 2022 and some changed by the provisional\ + \ agreement from January 9th, 2024." + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_MetadataCharacteristic' + identification: + description: "Identification information of the product, especially identifiers\ + \ and codes. These are mentioned in the ESPR provisional agreement from\ + \ January 9th, 2024 ANNEX III:\n(b) the unique product identifier at the\ + \ level indicated in the applicable delegated act adopted pursuant to\ + \ Article 4.\nAdditionally in Article 9 regarding general requirements\ + \ for the product passport is stated that:\nA product passport shall meet\ + \ the following conditions:\n(a) it shall be connected through a data\ + \ carrier to a persistent unique product identifier;\n(e) the information\ + \ included in the product passport shall refer to the product model, batch,\ + \ or item as specified in the delegated act adopted pursuant to Article\ + \ 4.\nArticle 2 Definitions: \n(31) 'unique product identifier' means\ + \ a unique string of characters for the identification of products that\ + \ also enables a web link to the product passport;\nRecital (27): A 'model'\ + \ usually means a version of a product of which all units share the same\ + \ technical characteristics relevant for the ecodesign requirements and\ + \ the same model identifier, a 'batch' usually means a subset of a specific\ + \ model composed of all products produced in a specific manufacturing\ + \ plant at a specific moment in time and an 'item' usually means a single\ + \ unit of a model." + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_IdentificationCharacteristic' + operation: + description: Operational information of the product. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_OperationCharacteristic' + handling: + description: Properties connected with the handling of the product. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_HandlingCharacteristic' + commercial: + description: Commercial information of the product. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_CommercialCharacteristic' + materials: + description: Properties which are relevant for the materials of the product. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_MaterialsCharacteristic' + sustainability: + description: Sustainability related attributes. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_SustainabilityCharacteristic' + sources: + description: |- + Documents that are mandatory if applicable for the product. These are mentioned in the ESPR provisional agreement from January 9th, 2024 ANNEX III: + (e) compliance documentation and information required under this Regulation or other Union law applicable to the product, such as the declaration of conformity, technical documentation or conformity certificates; + (f) user manuals, instructions, warnings or safety information, as required by other Union legislation applicable to the product. + Additionally requirements are mentioned in Article 21: + 7. Manufacturers shall ensure that a product covered by a delegated act adopted pursuant to Article 4 is accompanied by instructions in digital format that enable customers and other relevant actors to assemble, install, operate, store, maintain, repair and dispose of the product in a language that can be easily understood, as determined by the Member State concerned. Such instructions shall be clear, understandable and legible and include at least the information set out in Article 7(2), point (b), point (ii) specified in the delegated acts adopted pursuant to Article 4. + Article 7 states additionally: + (ii) information for customers and other actors on how to install, use, maintain and repair the product, in order to minimise its impact on the environment and to ensure optimum durability, on how to install third-party operating systems where relevant, as well as on collection for refurbishment or remanufacture, and on how to return or handle the product at the end of its life; + (2) (b) (iii) information for treatment facilities on disassembly, reuse, refurbishment, recycling, or disposal at end-of-life; + (2) (b) (iv) other information that may influence sustainable product choices for customers and the way the product is handled by parties other than the manufacturer in order to facilitate appropriate use, value retaining operations and correct treatment at end-of-life. + (5) (d) relevant instructions for the safe use of the product. + (5) (e) information relevant for disassembly, preparation for reuse, reuse, recycling and the environmentally sound management of the product at the end of its life. + Annex I: + (b) [...] availability of repair and maintenance instructions, number of materials and components used, use of standard components,[...] number and complexity of processes and whether specialised toolsare needed, ease of non-destructive disassembly and re-assembly, conditions for access to product data, conditions for access to or use of hardware and software needed; + (c) ease of upgrading, re-use, remanufacturing and refurbishment as expressed through: [...] number and complexity of processes and tools needed, ease of non-destructive disassembly and re-assembly, conditions for access to product data, conditions for access to or use of hardware and software needed, conditions of access to test protocols or not commonly available testing equipment, availability of guarantees specific to remanufactured or refurbished products, conditions for access to or use of technologies protected by intellectual property rights, modularity; + (d) design for recycling, ease and quality of recycling as expressed through: use of easily recyclable materials, safe, easy and non-destructive access to recyclable components and materials or components and materials containing hazardous substances and material composition and homogeneity, possibility for high-purity sorting, [...] number and complexity of processes and tools needed, ease of nondestructive disassembly and re-assembly, conditions for access to product data, conditions for access to or use of hardware and software needed; + (q) functional performance and conditions for use including as expressed through ability in performing its intended use, precautions of use, skills required, compatibility with other products or systems. + Additionally to consider are guidelines and instructions regarding the proper management and disposal of packaging materials after use. This can include instructions for separation, reuse, and recycling. + $ref: '#/components/schemas/urn_samm_io.catenax.generic.digital_product_passport_5.0.0_SourceList' + required: + - characteristics + - metadata + - identification + - operation + - handling + - commercial + - materials + - sustainability + - sources + TransmissionPass: + description: The transmission passport corresponds to the digital product passport + information required by the proposed Ecodesign Regulation (ESPR-2022) and + describes the data that is collected and available during the lifespan of + a transmission. + type: object + properties: + specific: + description: Product specific parameters of the transmission. + $ref: '#/components/schemas/urn_samm_io.catenax.transmission.transmission_pass_3.0.0_SpecificCharacteristic' + generic: + description: "The product generic parameters. These are defined by the Digital\ + \ Product Passport proposal from the ESPR. The main basis is provided\ + \ by the document \"Proposal for a REGULATION OF THE EUROPEAN PARLIAMENT\ + \ AND OF THE COUNCIL establishing a framework for setting ecodesign requirements\ + \ for sustainable products and repealing Directive 2009/125/EC\" from\ + \ March 30th, 2022. The latest version of the document was the provisional\ + \ agreement between the EU Council and the Parliament from January 9th,\ + \ 2024." + $ref: '#/components/schemas/urn_samm_io.catenax.transmission.transmission_pass_3.0.0_GenericCharacteristic' + required: + - specific + - generic + 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' + TransmissionPass: + content: + application/json: + schema: + $ref: '#/components/schemas/TransmissionPass' + description: The request was successful. + requestBodies: + TransmissionPass: + content: + application/json: + schema: + $ref: '#/components/schemas/TransmissionPass' diff --git a/io.catenax.transmission.transmission_pass/3.0.0/metadata.json b/io.catenax.transmission.transmission_pass/3.0.0/metadata.json new file mode 100644 index 000000000..eb94ac1ea --- /dev/null +++ b/io.catenax.transmission.transmission_pass/3.0.0/metadata.json @@ -0,0 +1 @@ +{ "status" : "release"} diff --git a/io.catenax.transmission.transmission_pass/RELEASE_NOTES.md b/io.catenax.transmission.transmission_pass/RELEASE_NOTES.md index 2d6fc597c..e0ebec8ad 100644 --- a/io.catenax.transmission.transmission_pass/RELEASE_NOTES.md +++ b/io.catenax.transmission.transmission_pass/RELEASE_NOTES.md @@ -3,7 +3,16 @@ All notable changes to this model will be documented in this file. ## [Unreleased] -## [2.0.0] - 2024-03-4 +## [3.0.0] - 2024-05-21 +### Changed +- connection update to @prefix ext-passport: +- renamed and changed attribute and payload name from unspecific to generic on highest level +- changed example value for oilType +- changed names for torquePeak, torqueContinuous, powerPeak, powerContinuous, speed, maxPeriod +- changed PerformancePower to KilowattMeasurement (characteristic) + + +## [2.0.0] - 2024-03-04 ### Added - import of io.catenax.generic.digital_product_passport 4.0.0 diff --git a/io.catenax.week_based_capacity_group/1.0.0/WeekBasedCapacityGroup.ttl b/io.catenax.week_based_capacity_group/1.0.0/WeekBasedCapacityGroup.ttl deleted file mode 100644 index 0eb0f5121..000000000 --- a/io.catenax.week_based_capacity_group/1.0.0/WeekBasedCapacityGroup.ttl +++ /dev/null @@ -1,277 +0,0 @@ -####################################################################### -# Copyright (c) 2023 BASF SE -# Copyright (c) 2023 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) -# Copyright (c) 2023 Fraunhofer-Gesellschaft zur Foerderung der angewandten Forschung e.V. (represented by Fraunhofer IML) -# Copyright (c) 2023 Henkel AG & Co. KGaA -# Copyright (c) 2023 Mercedes Benz AG -# Copyright (c) 2023 SAP SE -# Copyright (c) 2023 SupplyOn AG -# Copyright (c) 2023 ZF Friedrichshafen AG -# Copyright (c) 2023 Contributors to the Eclipse Foundation -# -# 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 bamm: . -@prefix bamm-c: . -@prefix bamm-e: . -@prefix unit: . -@prefix rdf: . -@prefix rdfs: . -@prefix xsd: . -@prefix : . - -:WeekBasedCapacityGroup a bamm:Aspect; - bamm:preferredName "Week-Based Capacity Group"@en; - bamm:description "An entity made up of the weekly actual and maximum capacities for a specific customer in a given time period. A capacity group is used to compare demand and capacity data for one or several similar bundled materials in a defined unit of measure."@en; - bamm:properties (:capacityGroupId :name [ - bamm:property :supplierLocations; - bamm:optional "true"^^xsd:boolean -] :customer :supplier :unitOfMeasure :linkedDemandSeries :capacities :changedAt); - bamm:operations (); - bamm:events (). -:capacityGroupId a bamm:Property; - bamm:preferredName "Capacity Group ID"@en; - bamm:description "The Capacity Group ID uniquely identifies the capacity group within the business relationship between a supplier and its customer."@en; - bamm:characteristic :UUIDv4IdTrait; - bamm:exampleValue "0157ba42-d2a8-4e28-8565-7b07830c1110". -:name a bamm:Property; - bamm:preferredName "Capacity Group Name"@en; - bamm:description "Name of the capacity group."@en; - bamm:characteristic :CapacityGroupName; - bamm:exampleValue "Spark Plugs on drilling machine for car model XYZ". -:supplierLocations a bamm:Property; - bamm:preferredName "Supplier Locations"@en; - bamm:description "Set of BPNS indicating the supplier sites that will be fulfilling the demands associated with this capacity group."@en; - bamm:characteristic :BPNSSetTrait; - bamm:exampleValue "BPNS8888888888XX". -:customer a bamm:Property; - bamm:preferredName "Customer"@en; - bamm:description "The Business Partner Number (BPNL) of the party requesting materials from a supplier."@en; - bamm:characteristic :BPNLTrait; - bamm:exampleValue "BPNL8888888888XX". -:supplier a bamm:Property; - bamm:preferredName "Supplier"@en; - bamm:description "The Business Partner Number (BPNL) of the party providing materials to a customer."@en; - bamm:characteristic :BPNLTrait; - bamm:exampleValue "BPNL6666666666YY". -:unitOfMeasure a bamm:Property; - bamm:preferredName "Unit of Measure"@en; - bamm:description "Unit of measurement for capacity quantities."@en; - bamm:characteristic :UnitOfMeasure; - bamm:exampleValue "KGM". -:linkedDemandSeries a bamm:Property; - bamm:preferredName "Linked Demand Series"@en; - bamm:description "Set of demand series assigned to this capacity group."@en; - bamm:characteristic :LinkedDemandSeriesSet. -:capacities a bamm:Property; - bamm:preferredName "Capacities"@en; - bamm:description "A time series with week-based granularity along a given time period containing the capacity values."@en; - bamm:characteristic :CapacityTimeSeries. -:changedAt a bamm:Property; - bamm:preferredName "Changed At"@en; - bamm:description "Point in time when the capacity group was last updated at the supplier, either by a human user or an automated process."@en; - bamm:characteristic :Timestamp; - bamm:exampleValue "2023-03-10T12:27:11.320Z"^^xsd:dateTimeStamp. -:UUIDv4 a bamm:Characteristic; - bamm:preferredName "UUIDv4"@en; - bamm:description "A version 4 UUID is a universally unique identifier that is generated using random 32 hexadecimal characters."@en; - bamm:see ; - bamm:dataType xsd:string. -:CapacityGroupName a bamm:Characteristic; - bamm:preferredName "Capacity Group Name"@en; - bamm:description "The name of a capacity group, used to distinguish it from other capacity groups."@en; - bamm:dataType xsd:string. -:BPNSSet a bamm-c:Set; - bamm:preferredName "Business Partner Number Site Set"@en; - bamm:description "Contains a set of BPNS. Each BPNS represents a site which can be a production plant inside one location."@en; - bamm:dataType xsd:string. -:BPNL a bamm:Characteristic; - bamm:preferredName "Business Partner Number Legal Entity"@en; - bamm:description "BPNL represents the legal entity of an organization participating in Catena-X."@en; - bamm:dataType xsd:string. -:UnitOfMeasure a bamm-c:Enumeration; - bamm:preferredName "Unit of Measure"@en; - bamm:description "The Enumeration lists a selection of allowed units of measure referenced by their official code according to Codes for Units of Measure Used in International Trade"@en; - bamm:see ; - bamm:dataType xsd:string; - bamm-c:values ("GRM" "KGM" "TNE" "STN" "ONZ" "LBR" "CMT" "MTR" "KTM" "INH" "FOT" "YRD" "CMK" "MTK" "INK" "FTK" "YDK" "CMQ" "MTQ" "INQ" "FTQ" "YDQ" "MLT" "LTR" "HLT" "H87" "SET" "PR" "ZP" "KWH" ""). -:LinkedDemandSeriesSet a bamm-c:Set; - bamm:preferredName "Linked Demand Series Set"@en; - bamm:description "A set of demand series assigned to a certain capacity group."@en; - bamm:dataType :LinkedDemandSeries. -:CapacityTimeSeries a bamm-c:SortedSet; - bamm:preferredName "Capacity Time Series"@en; - bamm:description "The weekly actual and maximum capacities in a given time period."@en; - bamm:dataType :Capacity. -:Timestamp a bamm:Characteristic; - bamm:preferredName "Timestamp"@en; - bamm:description "Point in time."@en; - bamm:dataType xsd:dateTimeStamp. -:LinkedDemandSeries a bamm:Entity; - bamm:preferredName "Linked Demand Series"@en; - bamm:description "Encapsulates information used to reference a specific demand series."@en; - bamm:properties (:materialNumberCustomer [ - bamm:property :materialNumberSupplier; - bamm:optional "true"^^xsd:boolean -] :customerLocation :demandCategory). -:Capacity a bamm:Entity; - bamm:preferredName "Capacity"@en; - bamm:description "A supplier's realistically planned output per calendar week and material for a specific customer in a specific unit of measure, considering all positive or negative impacts on this capacity."@en; - bamm:properties (:calendarWeek :actualCapacity :maximumCapacity). -:materialNumberCustomer a bamm:Property; - bamm:preferredName "Customer Material Number"@en; - bamm:description "Material identifier as assigned by customer. This material number identifies the material (as planned) in the customer's database."@en; - bamm:characteristic :MaterialNumber; - bamm:exampleValue "MNR-7307-AU340474.002". -:materialNumberSupplier a bamm:Property; - bamm:preferredName "Supplier Material Number"@en; - bamm:description "Material identifier as assigned by supplier. This material number identifies the material (as planned) in the supplier's database. Used as informational field only, not for assigning demand series to capacity groups."@en; - bamm:characteristic :MaterialNumber; - bamm:exampleValue "MNR-8101-ID146955.001". -:customerLocation a bamm:Property; - bamm:preferredName "Customer Location"@en; - bamm:description "The BPNS number of the site at which the customer needs the specified material for the referenced demand series."@en; - bamm:characteristic :BPNSTrait; - bamm:exampleValue "BPNS8888888888XX". -:demandCategory a bamm:Property; - bamm:preferredName "Demand Category"@en; - bamm:description "Type of demand of the referenced demand series."@en; - bamm:characteristic :DemandCategory. -:calendarWeek a bamm:Property; - bamm:preferredName "Calendar Week"@en; - bamm:description "ISO Calendar Week of the given time series entry. Must be given as date of the Monday in the week."@en; - bamm:characteristic :CalendarWeek; - bamm:exampleValue "2022-08-01"^^xsd:date. -:actualCapacity a bamm:Property; - bamm:preferredName "Actual Capacity"@en; - bamm:description "The actual capacity is the realistically planned output per calendar week and material for a specific customer in a specific unit of measure, considering all positive or negative impacts on this capacity."@en; - bamm:characteristic :QuantityTrait; - bamm:exampleValue "1"^^xsd:decimal. -:maximumCapacity a bamm:Property; - bamm:preferredName "Maximum Capacity"@en; - bamm:description "The supplier maximum capacity is the maximal available output per calendar week and material for a specific customer in a specific unit of measure. The maximum capacity thereby restricts the flexible capacity, as the flexible capacity is obtained from the difference of a suppliers maximum capacity minus actual capacity."@en; - bamm:characteristic :QuantityTrait; - bamm:exampleValue "2"^^xsd:decimal. -:MaterialNumber a bamm:Characteristic; - bamm:preferredName "Material Number"@en; - bamm:description "The material number is a multi-character string, usually assigned by an ERP system."@en; - bamm:dataType xsd:string. -:BPNS a bamm:Characteristic; - bamm:preferredName "Business Partner Number Site"@en; - bamm:description "BPNS represents a site which can be a production plant inside one location."@en; - bamm:dataType xsd:string. -:DemandCategory a bamm-c:Enumeration; - bamm:preferredName "Demand Category"@en; - bamm:description "The classification of demands used to prioritize or allocate capacities."@en; - bamm:dataType :DemandCategoryType; - bamm-c:values (:DemandCategoryDefault :DemandCategoryAfterSales :DemandCategorySeries :DemandCategoryPhaseInPeriod :DemandCategorySingleOrder :DemandCategorySmallSeries :DemandCategoryExtraordinaryDemand :DemandCategoryPhaseOutPeriod). -:CalendarWeek a bamm:Characteristic; - bamm:preferredName "Calendar Week"@en; - bamm:description "An ISO calendar week in which a given capacity will be provided. Must be given as date of the Monday in the week."@en; - bamm:see ; - bamm:dataType xsd:date. -:Quantity a bamm:Characteristic; - bamm:preferredName "Quantity"@en; - bamm:description "Quantity of weekly actual or maximum capacity."@en; - bamm:dataType xsd:decimal. -:DemandCategoryType a bamm:Entity; - bamm:preferredName "Demand Category Type"@en; - bamm:description "Describes the type of a demand category."@en; - bamm:properties (:demandCategoryCode [ - bamm:property :demandCategoryName; - bamm:notInPayload "true"^^xsd:boolean -]). -:DemandCategoryDefault a :DemandCategoryType; - :demandCategoryCode "0001"; - :demandCategoryName "Default"^^rdf:langString. -:DemandCategoryAfterSales a :DemandCategoryType; - :demandCategoryCode "A1S1"; - :demandCategoryName "After-Sales"^^rdf:langString. -:DemandCategorySeries a :DemandCategoryType; - :demandCategoryCode "SR99"; - :demandCategoryName "Series"^^rdf:langString. -:DemandCategoryPhaseInPeriod a :DemandCategoryType; - :demandCategoryCode "PI01"; - :demandCategoryName "Phase-In Period"^^rdf:langString. -:DemandCategorySingleOrder a :DemandCategoryType; - :demandCategoryCode "OS01"; - :demandCategoryName "Single Order"^^rdf:langString. -:DemandCategorySmallSeries a :DemandCategoryType; - :demandCategoryCode "OI01"; - :demandCategoryName "Small Series"^^rdf:langString. -:DemandCategoryExtraordinaryDemand a :DemandCategoryType; - :demandCategoryCode "ED01"; - :demandCategoryName "Extraordinary Demand"^^rdf:langString. -:DemandCategoryPhaseOutPeriod a :DemandCategoryType; - :demandCategoryCode "PO01"; - :demandCategoryName "Phase-Out Period"^^rdf:langString. -:demandCategoryCode a bamm:Property; - bamm:preferredName "Demand Category Code"@en; - bamm:description "The code identifying a demand category."@en; - bamm:characteristic :DemandCategoryCode; - bamm:exampleValue "0001". -:demandCategoryName a bamm:Property; - bamm:preferredName "Demand Category Name"@en; - bamm:description "The name describing a demand category."@en; - bamm:characteristic bamm-c:MultiLanguageText; - bamm:exampleValue "Default"^^rdf:langString. -:DemandCategoryCode a bamm-c:Code; - bamm:preferredName "Demand Category Code"@en; - bamm:description "The code identifying a demand category."@en; - bamm:dataType xsd:string. -:QuantityRange a bamm-c:RangeConstraint; - bamm:preferredName "Quantity Range"@en; - bamm:description "Constraint to ensure a non-negative value for quantities."@en; - bamm-c:minValue "0"^^xsd:decimal; - bamm-c:maxValue "999999999999999999.999"^^xsd:decimal; - bamm-c:lowerBoundDefinition bamm-c:AT_LEAST; - bamm-c:upperBoundDefinition bamm-c:AT_MOST. -:BPNSTrait a bamm-c:Trait; - bamm:preferredName "BPNS Trait"@en; - bamm:description "Trait to ensure data format for BPNS."@en; - bamm-c:baseCharacteristic :BPNS; - bamm-c:constraint :BPNSRegularExpression. -:BPNSRegularExpression a bamm-c:RegularExpressionConstraint; - bamm:preferredName "BPNS Regular Expression"@en; - bamm:description "The provided regular expression ensures that the BPNS is composed of prefix 'BPNS', 10 digits and two uppercase letters."@en; - bamm:value "^BPNS[0-9]{8}[a-zA-Z0-9]{4}$". -:UUIDv4RegularExpression a bamm-c:RegularExpressionConstraint; - bamm:preferredName "UUIDv4 Regular Expression"@en; - bamm: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)."@en; - bamm:value "^[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}$". -:UUIDv4IdTrait a bamm-c:Trait; - bamm:preferredName "UUIDv4 Trait"@en; - bamm:description "Trait to ensure data format for UUIDv4."@en; - bamm-c:baseCharacteristic :UUIDv4; - bamm-c:constraint :UUIDv4RegularExpression. -:BPNLTrait a bamm-c:Trait; - bamm:preferredName "BPNL Trait"@en; - bamm:description "Trait to ensure data format for BPNL."@en; - bamm-c:baseCharacteristic :BPNL; - bamm-c:constraint :BPNLRegularExpression. -:BPNLRegularExpression a bamm-c:RegularExpressionConstraint; - bamm:preferredName "BPNL Regular Expression"@en; - bamm:description "The provided regular expression ensures that the BPNL is composed of prefix 'BPNL', 10 digits and two uppercase letters."@en; - bamm:value "^BPNL[0-9]{8}[a-zA-Z0-9]{4}$". -:QuantityFixedPoint a bamm-c:FixedPointConstraint; - bamm:preferredName "Quantity Fixed Point"@en; - bamm:description "Constraint to ensure size of quantities: 12 digits plus 3 decimal places."@en; - bamm-c:integer "15"^^xsd:positiveInteger; - bamm-c:scale "1000"^^xsd:positiveInteger. -:BPNSSetTrait a bamm-c:Trait; - bamm:preferredName "BPNS Set Trait"@en; - bamm:description "Trait to ensure data format for BPNS set."@en; - bamm-c:baseCharacteristic :BPNSSet; - bamm-c:constraint :BPNSRegularExpression. -:QuantityTrait a bamm-c:Trait; - bamm-c:baseCharacteristic :Quantity; - bamm-c:constraint :QuantityRange, :QuantityFixedPoint. diff --git a/io.catenax.week_based_capacity_group/1.0.0/metadata.json b/io.catenax.week_based_capacity_group/1.0.0/metadata.json deleted file mode 100644 index 1cf890cd1..000000000 --- a/io.catenax.week_based_capacity_group/1.0.0/metadata.json +++ /dev/null @@ -1 +0,0 @@ -{ "status" : "deprecate" }