+
+
+
+ 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
+
+
+
+
+
+
+
+ 
+
+
+
+
+
+
+Properties
+
+
+
+
+
+A unique reference within Catena-X of this items
+
+ Catena-X ID
+
+
+
+
+
+ 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}$)+
+
+
+
+
+
+
+
+
+A unique reference within Catena-X of this items
+
+ Catena-X ID
+
+
+
+
+
+ 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}$)+
+
+
+
+
+
+The child part of the observed parent item
+
+ Child Parts
+
+
+
+
+
+ Name
+ childParts
+
+
+
+
+ Characteristic
+
+
+
+
+
+
+ Set
+
+
+ Has no order
+
+
+
+ Duplicates not allowed
+
+
+
+ Optional
+
+ Nein
+
+
+
+ Im Payload
+
+ Ja
+
+
+
+
+Payload Schlüssel
+ childParts
+
+
+
+
+
+
+The child part of the observed parent item
+
+ Child Parts
+
+
+
+
+
+ Name
+ childParts
+
+
+
+
+ Characteristic
+
+
+
+
+
+
+ Set
+
+
+ Has no order
+
+
+
+ Duplicates not allowed
+
+
+
+ Optional
+
+ Nein
+
+
+
+ Im Payload
+
+ Ja
+
+
+
+
+Payload Schlüssel
+ childParts
+
+
+
+
+ defaultAdminShell
+
+
+
+
+ defaultAsset
+
+
+
+
+ JustInSequencePart
+
+ Just in Sequence Part
+
+ APPLICATION_CLASS
+
+ A just-in-sequence part is an instantiation of a (design-) part, where the particular instantiation can be uniquely identified by means of a combination of several IDs related to a just-in-sequence process.
+
+ urn:bamm:io.catenax.just_in_sequence_part:1.0.0#JustInSequencePart
+
+
+
+
+ Just in Sequence Part
+
+
+ JustInSequencePart
+
+
+ A just-in-sequence part is an instantiation of a (design-) part, where the particular instantiation can be uniquely identified by means of a combination of several IDs related to a just-in-sequence process.
+
+
+
+
+
+ http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/2/0
+
+
+
+
+
+ CatenaXIdTrait
+
+ Catena-X ID Trait
+
+ urn:bamm:io.catenax.just_in_sequence_part:1.0.0#catenaXId
+
+
+
+
+ Catena-X Identifier
+
+
+ catenaXId
+
+ String
+
+ Trait to ensure data format for Catena-X ID
+
+
+
+
+
+ http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/2/0
+
+
+
+
+
+ KeyCharacteristic
+
+ Key Characteristic
+
+ urn:bamm:io.catenax.just_in_sequence_part:1.0.0#key
+
+
+
+
+ Identifier Key
+
+
+ key
+
+ String
+
+ 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
+- "jisNumber" - a number that is used to identify the call-off that can be assumed unique within the specific just-in-sequence process. This is typically not the sequence number, but the call-off number.
+- "jisCallDate" the date of the just-in-sequence call-off as stated on the call-off document itself. Value: following the ISO 8601 format as follows: "YYYY-MM-DD" or "YYYY-MM-DDThh:mm:ss" or "YYYY-MM-DDThh:mm:ss±hh:mm"
+- "parentOrderNumber" - a number identifying the just-in-sequence- part's destination parent part. The parent part is typically known upfront to the supplier for just-in-sequence parts. This might be a temporary unique identifier.
+Not all keys might be relevant for all just-in-sequence parts. It must be ensured that a combination of these identifiers and the optional manufacturer part ID or customer part ID leads to a unique just-in-sequence part.
+
+
+
+
+
+ http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/2/0
+
+
+
+
+
+ ValueCharacteristic
+
+ Value Characteristic
+
+ urn:bamm:io.catenax.just_in_sequence_part:1.0.0#value
+
+
+
+
+ Identifier Value
+
+
+ value
+
+ String
+
+ The value of an identifier.
+
+
+
+
+
+ http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/2/0
+
+
+
+
+
+ LocalIdentifierCharacteristic
+
+ Local Identifier Characteristic
+
+ urn:bamm:io.catenax.just_in_sequence_part:1.0.0#localIdentifiers
+
+
+
+
+ Local Identifiers
+
+
+ localIdentifiers
+
+ String
+
+ A single just-in-sequence part may have multiple attributes, that uniquely identify a that part in a specific dataspace (e.g. the manufacturer`s dataspace)
+
+
+
+
+
+ http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/2/0
+
+
+
+
+
+ Timestamp
+
+ Timestamp
+
+ urn:bamm:io.catenax.just_in_sequence_part:1.0.0#date
+
+
+
+
+ Production Date
+
+
+ date
+
+ String
+
+ Describes a Property which contains the date and time with an optional timezone.
+
+
+
+
+
+ http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/2/0
+
+
+
+
+
+ ProductionCountryCodeTrait
+
+ Production Country Code Trait
+
+ urn:bamm:io.catenax.just_in_sequence_part:1.0.0#country
+
+
+
+
+ Country code
+
+
+ country
+
+ String
+
+ Trait to ensure standard data format for country code
+
+
+
+
+
+ http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/2/0
+
+
+
+
+
+ ManufacturingCharacteristic
+
+ Manufacturing Characteristic
+
+ urn:bamm:io.catenax.just_in_sequence_part:1.0.0#manufacturingInformation
+
+
+
+
+ Manufacturing Information
+
+
+ manufacturingInformation
+
+ String
+
+ Characteristic to describe manufacturing related data
+
+
+
+
+
+ http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/2/0
+
+
+
+
+
+ PartIdCharacteristic
+
+ Part ID Characteristic
+
+ urn:bamm:io.catenax.just_in_sequence_part:1.0.0#manufacturerPartId
+
+
+
+
+ Manufacturer Part ID
+
+
+ manufacturerPartId
+
+ String
+
+ The part ID is a multi-character string, usually assigned by an ERP system. Alternatively the ID of the part family can be used if no specific part ID exists.
+
+
+
+
+
+ http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/2/0
+
+
+
+
+
+ PartIdCharacteristic
+
+ Part ID Characteristic
+
+ urn:bamm:io.catenax.just_in_sequence_part:1.0.0#customerPartId
+
+
+
+
+ Customer Part ID
+
+
+ customerPartId
+
+ String
+
+ The part ID is a multi-character string, usually assigned by an ERP system. Alternatively the ID of the part family can be used if no specific part ID exists.
+
+
+
+
+
+ http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/2/0
+
+
+
+
+
+ PartNameCharacteristic
+
+ Part Name Characteristic
+
+ urn:bamm:io.catenax.just_in_sequence_part:1.0.0#nameAtManufacturer
+
+
+
+
+ Name at Manufacturer
+
+
+ nameAtManufacturer
+
+ String
+
+ Part Name in string format from the respective system in the value chain
+
+
+
+
+
+ http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/2/0
+
+
+
+
+
+ PartNameCharacteristic
+
+ Part Name Characteristic
+
+ urn:bamm:io.catenax.just_in_sequence_part:1.0.0#nameAtCustomer
+
+
+
+
+ Name at Customer
+
+
+ nameAtCustomer
+
+ String
+
+ Part Name in string format from the respective system in the value chain
+
+
+
+
+
+ http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/2/0
+
+
+
+
+
+ ClassificationCharacteristic
+
+ Classification Characteristic
+
+ urn:bamm:io.catenax.just_in_sequence_part:1.0.0#classification
+
+
+
+
+ Classifcation
+
+
+ classification
+
+ String
+
+ A part type must be placed into one of the following classes: 'component', 'product', 'software', 'assembly', 'tool', or 'raw material'.
+
+
+
+
+
+ urn:bamm:io.catenax.just_in_sequence_part:1.0.0#ClassificationCharacteristic:DefaultScalarValue[value=product, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']']
+
+
+ DefaultScalarValue[value=product, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']']
+
+
+
+
+ urn:bamm:io.catenax.just_in_sequence_part:1.0.0#ClassificationCharacteristic:DefaultScalarValue[value=raw material, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']']
+
+
+ DefaultScalarValue[value=raw material, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']']
+
+
+
+
+ urn:bamm:io.catenax.just_in_sequence_part:1.0.0#ClassificationCharacteristic:DefaultScalarValue[value=software, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']']
+
+
+ DefaultScalarValue[value=software, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']']
+
+
+
+
+ urn:bamm:io.catenax.just_in_sequence_part:1.0.0#ClassificationCharacteristic:DefaultScalarValue[value=assembly, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']']
+
+
+ DefaultScalarValue[value=assembly, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']']
+
+
+
+
+ urn:bamm:io.catenax.just_in_sequence_part:1.0.0#ClassificationCharacteristic:DefaultScalarValue[value=tool, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']']
+
+
+ DefaultScalarValue[value=tool, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']']
+
+
+
+
+ urn:bamm:io.catenax.just_in_sequence_part:1.0.0#ClassificationCharacteristic:DefaultScalarValue[value=component, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']']
+
+
+ DefaultScalarValue[value=component, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']']
+
+
+
+
+
+
+ http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/2/0
+
+
+
+
+
+ PartTypeInformationCharacteristic
+
+ Part Type Information Characteristic
+
+ urn:bamm:io.catenax.just_in_sequence_part:1.0.0#partTypeInformation
+
+
+
+
+ Part Type Information
+
+
+ partTypeInformation
+
+ String
+
+ The characteristics of the part type
+
+
+
+
+
+ http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/2/0
+
+
+
+
+
+
+
+ JustInSequencePart
+
+ A just-in-sequence part is an instantiation of a (design-) part, where the particular instantiation can be uniquely identified by means of a combination of several IDs related to a just-in-sequence process.
+
+ Template
+
+
+ urn:bamm:io.catenax.just_in_sequence_part:1.0.0#JustInSequencePart
+
+
+
+
+
+ catenaXId
+
+ Catena-X Identifier
+
+
+ The fully anonymous Catena-X ID of the just-in-sequence part, valid for the Catena-X dataspace.
+
+ Template
+
+
+ urn:bamm:io.catenax.just_in_sequence_part:1.0.0#catenaXId
+
+
+ DefaultScalarValue[value=urn:uuid:580d3adf-1981-44a0-a214-13d6ceed9379, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']']
+ http://www.w3.org/2001/XMLSchema#string
+
+
+
+
+ localIdentifiers
+
+ 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.
+
+ false
+ false
+
+
+
+ KeyValueList
+
+ Key Value List
+
+
+ A list of key value pairs for local identifiers, which are composed of a key and a corresponding value.
+
+ false
+ false
+
+
+
+ key
+
+ Identifier Key
+
+
+ The key of a local identifier.
+
+ Template
+
+
+ urn:bamm:io.catenax.just_in_sequence_part:1.0.0#key
+
+
+ DefaultScalarValue[value=jisNumber, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']']
+ http://www.w3.org/2001/XMLSchema#string
+
+
+
+
+ value
+
+ Identifier Value
+
+
+ The value of an identifier.
+
+ Template
+
+
+ urn:bamm:io.catenax.just_in_sequence_part:1.0.0#value
+
+
+ DefaultScalarValue[value=12345678ABC, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']']
+ http://www.w3.org/2001/XMLSchema#string
+
+
+
+
+
+
+
+
+
+
+ ManufacturingEntity
+
+ Manufacturing Entity
+
+
+ Encapsulates the manufacturing relevant attributes
+
+ false
+ false
+
+
+
+ date
+
+ Production Date
+
+
+ Timestamp of the manufacturing date as the final step in production process (e.g. final quality check, ready-for-shipment event)
+
+ Template
+
+
+ urn:bamm:io.catenax.just_in_sequence_part:1.0.0#date
+
+
+ DefaultScalarValue[value=2022-02-04T14:48:54, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#dateTime']']
+ http://www.w3.org/2001/XMLSchema#dateTime
+
+
+
+
+ country
+
+ Country code
+
+
+ Country code where the part was manufactured
+
+ Template
+
+
+ urn:bamm:io.catenax.just_in_sequence_part:1.0.0#country
+
+
+ DefaultScalarValue[value=HUR, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']']
+ http://www.w3.org/2001/XMLSchema#string
+
+
+
+
+
+
+
+ PartTypeInformationEntity
+
+ Part Type Information Entity
+
+
+ Encapsulation for data related to the part type
+
+ false
+ false
+
+
+
+ manufacturerPartId
+
+ Manufacturer Part ID
+
+
+ Part ID as assigned by the manufacturer of the part. The manufacturer 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 any other instance IDs.
+If no specific part ID exists a part family ID may be substituted for it.
+
+ Template
+
+
+ urn:bamm:io.catenax.just_in_sequence_part:1.0.0#manufacturerPartId
+
+
+ DefaultScalarValue[value=123-0.740-3434-A, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']']
+ http://www.w3.org/2001/XMLSchema#string
+
+
+
+
+ customerPartId
+
+ Customer Part ID
+
+
+ Part ID as assigned by the customer of the part. The customer 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 any other instance IDs.
+If no specific part ID exists a part family ID may be substituted for it.
+
+
+ Template
+
+
+ urn:bamm:io.catenax.just_in_sequence_part:1.0.0#customerPartId
+
+
+ DefaultScalarValue[value=PRT-12345, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']']
+ http://www.w3.org/2001/XMLSchema#string
+
+
+
+
+ nameAtManufacturer
+
+ Name at Manufacturer
+
+
+ Name of the part as assigned by the manufacturer
+
+ Template
+
+
+ urn:bamm:io.catenax.just_in_sequence_part:1.0.0#nameAtManufacturer
+
+
+ DefaultScalarValue[value=Mirror left, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']']
+ http://www.w3.org/2001/XMLSchema#string
+
+
+
+
+ nameAtCustomer
+
+ Name at Customer
+
+
+ Name of the part as assigned by the customer
+
+ Template
+
+
+ urn:bamm:io.catenax.just_in_sequence_part:1.0.0#nameAtCustomer
+
+
+ DefaultScalarValue[value=side element A, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']']
+ http://www.w3.org/2001/XMLSchema#string
+
+
+
+
+ classification
+
+ Classifcation
+
+
+ The classification of the part type according to STEP standard definition
+
+ Template
+
+
+ urn:bamm:io.catenax.just_in_sequence_part:1.0.0#classification
+
+
+ DefaultScalarValue[value=software, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']']
+ http://www.w3.org/2001/XMLSchema#string
+
+
+
+
+
+
+
+
+
diff --git a/io.catenax.just_in_sequence_part/1.0.0/gen/JustInSequencePart-schema.json b/io.catenax.just_in_sequence_part/1.0.0/gen/JustInSequencePart-schema.json
new file mode 100644
index 00000000..71efe7b2
--- /dev/null
+++ b/io.catenax.just_in_sequence_part/1.0.0/gen/JustInSequencePart-schema.json
@@ -0,0 +1,129 @@
+{
+ "$schema" : "http://json-schema.org/draft-04/schema",
+ "description" : "A just-in-sequence part is an instantiation of a (design-) part, where the particular instantiation can be uniquely identified by means of a combination of several IDs related to a just-in-sequence process.",
+ "type" : "object",
+ "components" : {
+ "schemas" : {
+ "urn_bamm_io.catenax.just_in_sequence_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" : "(^[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.just_in_sequence_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- \"jisNumber\" - a number that is used to identify the call-off that can be assumed unique within the specific just-in-sequence process. This is typically not the sequence number, but the call-off number.\n- \"jisCallDate\" the date of the just-in-sequence call-off as stated on the call-off document itself. Value: following the ISO 8601 format as follows: \"YYYY-MM-DD\" or \"YYYY-MM-DDThh:mm:ss\" or \"YYYY-MM-DDThh:mm:ss±hh:mm\"\n- \"parentOrderNumber\" - a number identifying the just-in-sequence- part's destination parent part. The parent part is typically known upfront to the supplier for just-in-sequence parts. This might be a temporary unique identifier.\nNot all keys might be relevant for all just-in-sequence parts. It must be ensured that a combination of these identifiers and the optional manufacturer part ID or customer part ID leads to a unique just-in-sequence part."
+ },
+ "urn_bamm_io.catenax.just_in_sequence_part_1.0.0_ValueCharacteristic" : {
+ "type" : "string",
+ "description" : "The value of an identifier."
+ },
+ "urn_bamm_io.catenax.just_in_sequence_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.just_in_sequence_part_1.0.0_KeyCharacteristic"
+ },
+ "value" : {
+ "description" : "The value of an identifier.",
+ "$ref" : "#/components/schemas/urn_bamm_io.catenax.just_in_sequence_part_1.0.0_ValueCharacteristic"
+ }
+ },
+ "required" : [ "key", "value" ]
+ },
+ "urn_bamm_io.catenax.just_in_sequence_part_1.0.0_LocalIdentifierCharacteristic" : {
+ "description" : "A single just-in-sequence 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.just_in_sequence_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.just_in_sequence_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.just_in_sequence_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.just_in_sequence_part_1.0.0_ProductionCountryCodeTrait"
+ }
+ },
+ "required" : [ "date" ]
+ },
+ "urn_bamm_io.catenax.just_in_sequence_part_1.0.0_PartIdCharacteristic" : {
+ "type" : "string",
+ "description" : "The part ID is a multi-character string, usually assigned by an ERP system. Alternatively the ID of the part family can be used if no specific part ID exists."
+ },
+ "urn_bamm_io.catenax.just_in_sequence_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.just_in_sequence_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.just_in_sequence_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 manufacturer 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 any other instance IDs. \nIf no specific part ID exists a part family ID may be substituted for it.",
+ "$ref" : "#/components/schemas/urn_bamm_io.catenax.just_in_sequence_part_1.0.0_PartIdCharacteristic"
+ },
+ "customerPartId" : {
+ "description" : "Part ID as assigned by the customer of the part. The customer 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 any other instance IDs. \nIf no specific part ID exists a part family ID may be substituted for it.\n",
+ "$ref" : "#/components/schemas/urn_bamm_io.catenax.just_in_sequence_part_1.0.0_PartIdCharacteristic"
+ },
+ "nameAtManufacturer" : {
+ "description" : "Name of the part as assigned by the manufacturer",
+ "$ref" : "#/components/schemas/urn_bamm_io.catenax.just_in_sequence_part_1.0.0_PartNameCharacteristic"
+ },
+ "nameAtCustomer" : {
+ "description" : "Name of the part as assigned by the customer",
+ "$ref" : "#/components/schemas/urn_bamm_io.catenax.just_in_sequence_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.just_in_sequence_part_1.0.0_ClassificationCharacteristic"
+ }
+ },
+ "required" : [ "nameAtManufacturer", "classification" ]
+ }
+ }
+ },
+ "properties" : {
+ "catenaXId" : {
+ "description" : "The fully anonymous Catena-X ID of the just-in-sequence part, valid for the Catena-X dataspace.",
+ "$ref" : "#/components/schemas/urn_bamm_io.catenax.just_in_sequence_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.just_in_sequence_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.just_in_sequence_part_1.0.0_ManufacturingCharacteristic"
+ },
+ "partTypeInformation" : {
+ "description" : "The part type or part family from which the just-in-sequence part has been instantiated.",
+ "$ref" : "#/components/schemas/urn_bamm_io.catenax.just_in_sequence_part_1.0.0_PartTypeInformationCharacteristic"
+ }
+ },
+ "required" : [ "catenaXId", "localIdentifiers", "manufacturingInformation", "partTypeInformation" ]
+}
\ No newline at end of file
diff --git a/io.catenax.just_in_sequence_part/1.0.0/gen/JustInSequencePart.aasx b/io.catenax.just_in_sequence_part/1.0.0/gen/JustInSequencePart.aasx
new file mode 100644
index 00000000..3f3e9e74
Binary files /dev/null and b/io.catenax.just_in_sequence_part/1.0.0/gen/JustInSequencePart.aasx differ
diff --git a/io.catenax.just_in_sequence_part/1.0.0/gen/JustInSequencePart.html b/io.catenax.just_in_sequence_part/1.0.0/gen/JustInSequencePart.html
new file mode 100644
index 00000000..7e91787b
--- /dev/null
+++ b/io.catenax.just_in_sequence_part/1.0.0/gen/JustInSequencePart.html
@@ -0,0 +1,1155 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Dokumentation Just in Sequence Part
+
+
+
+
+
+
+
+
+
+
+ Objekt
+
+
+
+
+ Child Parts Entity
+
+ Encapsulates the properties describing the child part item
+
+
+
+
+Properties
+
+
+
+
+
+
+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.
+
+ Child Parts Category
+
+
+
+
+
+ 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
+
+
+
+
+
+
+The description of the part in the primary language of the production facility of the product owner.
+
+ Part
+
+
+
+
+
+ Name
+ part
+
+
+
+
+ Characteristic
+
+
+
+
+
+
+ Set
+
+
+ Has no order
+
+
+ Duplicates not allowed
+
+
+
+
+
+
+ Optional
+
+ Nein
+
+
+
+ Im Payload
+
+ Ja
+
+
+
+
+Payload Schlüssel
+ part
+
+
+
+
+
+
+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.
+
+ Child Parts Category
+
+
+
+
+
+ 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
+
+
+
+
+
+
+The description of the part in the primary language of the production facility of the product owner.
+
+ Part
+
+
+
+
+
+ Name
+ part
+
+
+
+
+ Characteristic
+
+
+
+
+
+
+ Set
+
+
+ Has no order
+
+
+ Duplicates not allowed
+
+
+
+
+
+
+ Optional
+
+ Nein
+
+
+
+ Im Payload
+
+ Ja
+
+
+
+
+Payload Schlüssel
+ part
+
+
+
+
+
+
+Describes the Catena-X ID of the child part
+
+ Child CatenaXId
+
+
+
+
+
+ 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 within the classification.
+
+ Key
+
+
+
+
+
+ Name
+ key
+
+
+
+ Characteristic
+
+
+
+
+
+
+
+ Typ http://www.w3.org/2001/XMLSchema#string
+
+
+
+
+
+ Beispiel
+ BMW:PartFamily
+
+
+
+ Optional
+
+ Nein
+
+
+
+ Im Payload
+
+ Ja
+
+
+
+
+Payload Schlüssel
+ key
+
+
+
+
+
+
+Value within the classification.
+
+ Value
+
+
+
+
+
+ Name
+ value
+
+
+
+ Characteristic
+
+
+
+
+
+
+
+ Typ http://www.w3.org/2001/XMLSchema#string
+
+
+
+
+
+ Beispiel
+ STEEWHL
+
+
+
+ Optional
+
+ Nein
+
+
+
+ Im Payload
+
+ Ja
+
+
+
+
+Payload Schlüssel
+ value
+
+
+
+
+
+
+Key within the classification.
+
+ Key
+
+
+
+
+
+ Name
+ key
+
+
+
+ Characteristic
+
+
+
+
+
+
+
+ Typ http://www.w3.org/2001/XMLSchema#string
+
+
+
+
+
+ Beispiel
+ BMW:PartFamily
+
+
+
+ Optional
+
+ Nein
+
+
+
+ Im Payload
+
+ Ja
+
+
+
+
+Payload Schlüssel
+ key
+
+
+
+
+
+
+Value within the classification.
+
+ Value
+
+
+
+
+
+ Name
+ value
+
+
+
+ Characteristic
+
+
+
+
+
+
+
+ Typ http://www.w3.org/2001/XMLSchema#string
+
+
+
+
+
+ Beispiel
+ STEEWHL
+
+
+
+ Optional
+
+ Nein
+
+
+
+ Im Payload
+
+ Ja
+
+
+
+
+Payload Schlüssel
+ value
+
+
+
+
+
+
+
+
\ 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
new file mode 100644
index 00000000..feacf80a
--- /dev/null
+++ b/io.catenax.bom_as_specified/2.0.0/gen/SingleLevelBomAsSpecified.json
@@ -0,0 +1,22 @@
+{
+ "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
new file mode 100644
index 00000000..7da41fdb
--- /dev/null
+++ b/io.catenax.bom_as_specified/2.0.0/gen/SingleLevelBomAsSpecified.yml
@@ -0,0 +1,284 @@
+---
+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.just_in_sequence_part/1.0.0/gen/JustInSequencePart-aas.xml b/io.catenax.just_in_sequence_part/1.0.0/gen/JustInSequencePart-aas.xml
new file mode 100644
index 00000000..f7a84e48
--- /dev/null
+++ b/io.catenax.just_in_sequence_part/1.0.0/gen/JustInSequencePart-aas.xml
@@ -0,0 +1,734 @@
+
+
+
+ Part Entity
+
+ Entity encapsulating the properies describing a part
+
+
+
+
+Properties
+
+
+
+
+
+
+
+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.
+
+ Owner Part ID
+
+
+
+
+
+ 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}$)+
+
+
+
+
+
+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.
+
+ Part Version
+
+
+
+
+
+ Name
+ partVersion
+
+
+
+ Characteristic
+
+
+
+
+
+
+
+ Typ http://www.w3.org/2001/XMLSchema#string
+
+
+
+
+
+ Beispiel
+ 05
+
+
+
+ Optional
+
+ Ja
+
+
+
+ Im Payload
+
+ Ja
+
+
+
+
+Payload Schlüssel
+ partVersion
+
+
+
+
+
+
+This is the quantity how often this part is in the item.
+
+ Part Quantity
+
+
+
+
+
+ Name
+ partQuantity
+
+
+
+
+ Characteristic
+
+
+
+
+
+
+
+ SingleEntity
+
+
+
+ Optional
+
+ Ja
+
+
+
+ Im Payload
+
+ Ja
+
+
+
+
+Payload Schlüssel
+ partQuantity
+
+
+
+
+
+
+The description of the part in the primary language of the production facility of the product owner.
+
+ Part Description
+
+
+
+
+
+ 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
+
+
+
+
+
+
+The part classification.
+
+ Part Classification
+
+
+
+
+
+ Name
+ partClassification
+
+
+
+
+ Characteristic
+
+
+
+
+
+
+ Set
+
+
+ Has no order
+
+
+
+ Duplicates not allowed
+
+
+
+ Optional
+
+ Ja
+
+
+
+ Im Payload
+
+ Ja
+
+
+
+
+Payload Schlüssel
+ partClassification
+
+
+
+
+
+
+The time the item was modified the last time
+
+ Last Modified On
+
+
+
+
+
+ Name
+ lastModifiedOn
+
+
+
+ Characteristic
+
+
+
+
+
+
+
+
+
+
+ Beispiel
+ 2022-02-03T14:48:54.709Z
+
+
+
+ Optional
+
+ Ja
+
+
+
+ Im Payload
+
+ Ja
+
+
+
+
+Payload Schlüssel
+ lastModifiedOn
+
+
+
+
+
+
+The time the item was created on
+
+ Created On
+
+
+
+
+
+ Name
+ createdOn
+
+
+
+ Characteristic
+
+
+
+
+
+
+
+
+
+
+ Beispiel
+ 2022-02-03T14:48:54.709Z
+
+
+
+ Optional
+
+ Ja
+
+
+
+ Im Payload
+
+ Ja
+
+
+
+
+Payload Schlüssel
+ createdOn
+
+
+
+
+
+
+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.
+
+ Owner Part ID
+
+
+
+
+
+ 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}$)+
+
+
+
+
+
+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.
+
+ Part Version
+
+
+
+
+
+ Name
+ partVersion
+
+
+
+ Characteristic
+
+
+
+
+
+
+
+ Typ http://www.w3.org/2001/XMLSchema#string
+
+
+
+
+
+ Beispiel
+ 05
+
+
+
+ Optional
+
+ Ja
+
+
+
+ Im Payload
+
+ Ja
+
+
+
+
+Payload Schlüssel
+ partVersion
+
+
+
+
+
+
+This is the quantity how often this part is in the item.
+
+ Part Quantity
+
+
+
+
+
+ Name
+ partQuantity
+
+
+
+
+ Characteristic
+
+
+
+
+
+
+
+ SingleEntity
+
+
+
+ Optional
+
+ Ja
+
+
+
+ Im Payload
+
+ Ja
+
+
+
+
+Payload Schlüssel
+ partQuantity
+
+
+
+
+
+
+The description of the part in the primary language of the production facility of the product owner.
+
+ Part Description
+
+
+
+
+
+ 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
+
+
+
+
+
+
+The part classification.
+
+ Part Classification
+
+
+
+
+
+ Name
+ partClassification
+
+
+
+
+ Characteristic
+
+
+
+
+
+
+ Set
+
+
+ Has no order
+
+
+
+ Duplicates not allowed
+
+
+
+ Optional
+
+ Ja
+
+
+
+ Im Payload
+
+ Ja
+
+
+
+
+Payload Schlüssel
+ partClassification
+
+
+
+
+
+
+The time the item was modified the last time
+
+ Last Modified On
+
+
+
+
+
+ Name
+ lastModifiedOn
+
+
+
+ Characteristic
+
+
+
+
+
+
+
+
+
+
+ Beispiel
+ 2022-02-03T14:48:54.709Z
+
+
+
+ Optional
+
+ Ja
+
+
+
+ Im Payload
+
+ Ja
+
+
+
+
+Payload Schlüssel
+ lastModifiedOn
+
+
+
+
+
+
+The time the item was created on
+
+ Created On
+
+
+
+
+
+ Name
+ createdOn
+
+
+
+ Characteristic
+
+
+
+
+
+
+
+
+
+
+ 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
+
+
+
+
+
+
+Unit of measurement for the quantity of serialized objects.
+
+ Measurement Unit
+
+
+
+
+
+ Name
+ measurementUnit
+
+
+
+ Characteristic
+
+
+
+
+
+
+
+
+
+
+ Beispiel
+ kW
+
+
+
+ Optional
+
+ Nein
+
+
+
+ Im Payload
+
+ Ja
+
+
+
+
+Payload Schlüssel
+ measurementUnit
+
+
+
+
+
+
+The number of objects related to the measurement unit.
+
+ Quantity Number
+
+
+
+
+
+ Name
+ quantityNumber
+
+
+
+ Characteristic
+
+
+
+
+
+
+
+ Typ http://www.w3.org/2001/XMLSchema#double
+
+
+
+
+
+ Beispiel
+ 350.0
+
+
+
+ Optional
+
+ Nein
+
+
+
+ Im Payload
+
+ Ja
+
+
+
+
+Payload Schlüssel
+ quantityNumber
+
+
+
+
+
+
+Unit of measurement for the quantity of serialized objects.
+
+ Measurement Unit
+
+
+
+
+
+ Name
+ measurementUnit
+
+
+
+ Characteristic
+
+
+
+
+
+
+
+
+
+
+ Beispiel
+ kW
+
+
+
+ Optional
+
+ Nein
+
+
+
+ Im Payload
+
+ Ja
+
+
+
+
+Payload Schlüssel
+ measurementUnit
+
+
+
+
+
+
+The number of objects related to the measurement unit.
+
+ Quantity Number
+
+
+
+
+
+ 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
+
+
+
+
+
+
+
+ Aspect Model Just in Sequence Part
+urn:bamm:io.catenax.just_in_sequence_part:1.0.0#JustInSequencePart
+
+
+
+
+
+
+
+ A just-in-sequence part is an instantiation of a (design-) part, where the particular instantiation can be uniquely identified by means of a combination of several IDs related to a just-in-sequence process.
+
+
+
+
+
+ Übersicht
+
+
+
+
+
+
+
+ 
+
+
+
+
+
+
+ defaultAdminShell
+
+
+
+
+ defaultAsset
+
+
+
+
+ PartAsPlanned
+
+ Part as Planned
+
+ APPLICATION_CLASS
+
+ 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:bamm:io.catenax.part_as_planned:1.0.1#PartAsPlanned
+
+
+
+
+ Part as Planned
+
+
+ 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.
+
+
+
+
+
+ http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/2/0
+
+
+
+
+
+ CatenaXIdTrait
+
+ Catena-X ID Trait
+
+ urn:bamm:io.catenax.part_as_planned:1.0.1#catenaXId
+
+
+
+
+ Catena-X ID
+
+
+ catenaXId
+
+ String
+
+ Trait to ensure data format for Catena-X ID
+
+
+
+
+
+ http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/2/0
+
+
+
+
+
+ PartIdCharacteristic
+
+ Part ID Characteristic
+
+ urn:bamm:io.catenax.part_as_planned:1.0.1#manufacturerPartId
+
+
+
+
+ Manufacturer Part ID
+
+
+ manufacturerPartId
+
+ String
+
+ The part ID is a multi-character string, ususally assigned by an ERP system
+
+
+
+
+
+ http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/2/0
+
+
+
+
+
+ PartNameCharacteristic
+
+ Part Name Characteristic
+
+ urn:bamm:io.catenax.part_as_planned:1.0.1#nameAtManufacturer
+
+
+
+
+ Name at manufacturer
+
+
+ nameAtManufacturer
+
+ String
+
+ Part Name in string format from the respective system in the value chain
+
+
+
+
+
+ http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/2/0
+
+
+
+
+
+ ClassificationEnumerationCharacteristic
+
+ Classification Enumeration Characteristic
+
+ urn:bamm:io.catenax.part_as_planned:1.0.1#classification
+
+
+
+
+ Classifcation
+
+
+ classification
+
+ String
+
+ A part type must be placed into one of the following classes: 'component', 'product', 'software', ‘assembly’, 'tool', or 'raw material'.
+
+
+
+
+
+ urn:bamm:io.catenax.part_as_planned:1.0.1#ClassificationEnumerationCharacteristic:DefaultScalarValue[value=product, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']']
+
+
+ DefaultScalarValue[value=product, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']']
+
+
+
+
+ urn:bamm:io.catenax.part_as_planned:1.0.1#ClassificationEnumerationCharacteristic:DefaultScalarValue[value=raw material, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']']
+
+
+ DefaultScalarValue[value=raw material, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']']
+
+
+
+
+ urn:bamm:io.catenax.part_as_planned:1.0.1#ClassificationEnumerationCharacteristic:DefaultScalarValue[value=software, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']']
+
+
+ DefaultScalarValue[value=software, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']']
+
+
+
+
+ urn:bamm:io.catenax.part_as_planned:1.0.1#ClassificationEnumerationCharacteristic:DefaultScalarValue[value=assembly, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']']
+
+
+ DefaultScalarValue[value=assembly, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']']
+
+
+
+
+ urn:bamm:io.catenax.part_as_planned:1.0.1#ClassificationEnumerationCharacteristic:DefaultScalarValue[value=tool, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']']
+
+
+ DefaultScalarValue[value=tool, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']']
+
+
+
+
+ urn:bamm:io.catenax.part_as_planned:1.0.1#ClassificationEnumerationCharacteristic:DefaultScalarValue[value=component, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']']
+
+
+ DefaultScalarValue[value=component, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']']
+
+
+
+
+
+
+ http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/2/0
+
+
+
+
+
+ PartTypeInformationCharacteristic
+
+ Part Type Information Characteristic
+
+ urn:bamm:io.catenax.part_as_planned:1.0.1#partTypeInformation
+
+
+
+
+ Part Type Information
+
+
+ partTypeInformation
+
+ String
+
+ The characteristics of the part type
+
+
+
+
+
+ http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/2/0
+
+
+
+
+
+ Timestamp
+
+ Timestamp
+
+ urn:bamm:io.catenax.part_as_planned:1.0.1#validFrom
+
+
+
+
+ Valid from
+
+
+ validFrom
+
+ String
+
+ Describes a Property which contains the date and time with an optional timezone.
+
+
+
+
+
+ http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/2/0
+
+
+
+
+
+ Timestamp
+
+ Timestamp
+
+ urn:bamm:io.catenax.part_as_planned:1.0.1#validTo
+
+
+
+
+ Valid to
+
+
+ validTo
+
+ String
+
+ Describes a Property which contains the date and time with an optional timezone.
+
+
+
+
+
+ http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/2/0
+
+
+
+
+
+ ValidityPeriodCharacteristic
+
+ Validity Period Characteristic
+
+ urn:bamm:io.catenax.part_as_planned:1.0.1#validityPeriod
+
+
+
+
+ Validity Period
+
+
+ validityPeriod
+
+ String
+
+ Characteristic to define a continuous validity period.
+
+
+
+
+
+ http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/2/0
+
+
+
+
+
+
+
+ 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.
+
+ Template
+
+
+ urn:bamm:io.catenax.part_as_planned:1.0.1#PartAsPlanned
+
+
+
+
+
+ catenaXId
+
+ Catena-X ID
+
+
+ The fully anonymous Catena-X ID of the serialized part, valid for the Catena-X dataspace.
+
+ Template
+
+
+ urn:bamm:io.catenax.part_as_planned:1.0.1#catenaXId
+
+
+ DefaultScalarValue[value=580d3adf-1981-44a0-a214-13d6ceed9379, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']']
+ http://www.w3.org/2001/XMLSchema#string
+
+
+
+
+ PartTypeInformationEntity
+
+ Part Type Information Entity
+
+
+ Encapsulation for data related to the part type
+
+ false
+ false
+
+
+
+ manufacturerPartId
+
+ 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.
+
+ Template
+
+
+ urn:bamm:io.catenax.part_as_planned:1.0.1#manufacturerPartId
+
+
+ DefaultScalarValue[value=123-0.740-3434-A, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']']
+ http://www.w3.org/2001/XMLSchema#string
+
+
+
+
+ nameAtManufacturer
+
+ Name at manufacturer
+
+
+ Name of the part as assigned by the manufacturer
+
+ Template
+
+
+ urn:bamm:io.catenax.part_as_planned:1.0.1#nameAtManufacturer
+
+
+ DefaultScalarValue[value=Mirror left, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']']
+ http://www.w3.org/2001/XMLSchema#string
+
+
+
+
+ classification
+
+ Classifcation
+
+
+ The classification of the part type according to STEP standard definition
+
+ Template
+
+
+ urn:bamm:io.catenax.part_as_planned:1.0.1#classification
+
+
+ DefaultScalarValue[value=software, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']']
+ http://www.w3.org/2001/XMLSchema#string
+
+
+
+
+
+
+
+ ValidityPeriodEntity
+
+ Validity Period Entity
+
+
+ Defines a continuous validity period.
+
+ false
+ false
+
+
+
+ validFrom
+
+ Valid from
+
+
+ Start date of validity period
+
+ Template
+
+
+ urn:bamm:io.catenax.part_as_planned:1.0.1#validFrom
+
+
+ DefaultScalarValue[value=2023-03-06T14:50:23.230+01:00, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#dateTime']']
+ http://www.w3.org/2001/XMLSchema#dateTime
+
+
+
+
+ validTo
+
+ Valid to
+
+
+ End date of validity period
+
+ Template
+
+
+ urn:bamm:io.catenax.part_as_planned:1.0.1#validTo
+
+
+ DefaultScalarValue[value=2023-08-06T14:50:23.230+01:00, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#dateTime']']
+ http://www.w3.org/2001/XMLSchema#dateTime
+
+
+
+
+
+
+
+
+
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
new file mode 100644
index 00000000..09353d16
--- /dev/null
+++ b/io.catenax.part_as_planned/1.0.1/gen/PartAsPlanned-schema.json
@@ -0,0 +1,80 @@
+{
+ "$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
new file mode 100644
index 00000000..b212aefb
Binary files /dev/null and b/io.catenax.part_as_planned/1.0.1/gen/PartAsPlanned.aasx 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
new file mode 100644
index 00000000..1d9a11e8
--- /dev/null
+++ b/io.catenax.part_as_planned/1.0.1/gen/PartAsPlanned.html
@@ -0,0 +1,828 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Dokumentation Part as Planned
+
+
+
+
+
+
+
+
+
+
+Properties
+
+
+
+
+
+
+
+
+
+The fully anonymous Catena-X ID of the just-in-sequence part, valid for the Catena-X dataspace.
+
+ Catena-X Identifier
+
+
+
+
+
+ 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}$)+
+
+
+
+
+
+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.
+
+ Local Identifiers
+
+
+
+
+
+ Name
+ localIdentifiers
+
+
+
+
+ Characteristic
+
+
+
+
+
+
+ Set
+
+
+ Has no order
+
+
+
+ Duplicates not allowed
+
+
+
+ Optional
+
+ Nein
+
+
+
+ Im Payload
+
+ Ja
+
+
+
+
+Payload Schlüssel
+ localIdentifiers
+
+
+
+
+
+
+Information from manufacturing process, such as manufacturing date and manufacturing country
+
+ Manufacturing Information
+
+
+
+
+
+ Name
+ manufacturingInformation
+
+
+
+
+ Characteristic
+
+
+
+
+
+
+
+ SingleEntity
+
+
+
+ Optional
+
+ Nein
+
+
+
+ Im Payload
+
+ Ja
+
+
+
+
+Payload Schlüssel
+ manufacturingInformation
+
+
+
+
+
+
+The part type or part family from which the just-in-sequence part has been instantiated.
+
+ Part Type Information
+
+
+
+
+
+ Name
+ partTypeInformation
+
+
+
+
+ Characteristic
+
+
+
+
+
+
+
+ SingleEntity
+
+
+
+ Optional
+
+ Nein
+
+
+
+ Im Payload
+
+ Ja
+
+
+
+
+Payload Schlüssel
+ partTypeInformation
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/io.catenax.just_in_sequence_part/1.0.0/gen/JustInSequencePart.json b/io.catenax.just_in_sequence_part/1.0.0/gen/JustInSequencePart.json
new file mode 100644
index 00000000..c5a0014b
--- /dev/null
+++ b/io.catenax.just_in_sequence_part/1.0.0/gen/JustInSequencePart.json
@@ -0,0 +1,18 @@
+{
+ "localIdentifiers" : [ {
+ "value" : "12345678ABC",
+ "key" : "jisNumber"
+ } ],
+ "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.just_in_sequence_part/1.0.0/gen/JustInSequencePart.yml b/io.catenax.just_in_sequence_part/1.0.0/gen/JustInSequencePart.yml
new file mode 100644
index 00000000..9b5cb8b4
--- /dev/null
+++ b/io.catenax.just_in_sequence_part/1.0.0/gen/JustInSequencePart.yml
@@ -0,0 +1,268 @@
+---
+openapi: 3.0.3
+info:
+ title: Just in Sequence Part
+ version: v1
+servers:
+- url: catenax.io/api/v1
+ variables:
+ api-version:
+ default: v1
+paths:
+ /{tenant-id}/just-in-sequence-part:
+ get:
+ tags:
+ - JustInSequencePart
+ operationId: getJustInSequencePart
+ 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/JustInSequencePart'
+ "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/JustInSequencePart'
+ totalItems:
+ type: number
+ totalPages:
+ type: number
+ pageSize:
+ type: number
+ currentPage:
+ type: number
+ urn_bamm_io.catenax.just_in_sequence_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: "(^[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.just_in_sequence_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
+ - "jisNumber" - a number that is used to identify the call-off that can be assumed unique within the specific just-in-sequence process. This is typically not the sequence number, but the call-off number.
+ - "jisCallDate" the date of the just-in-sequence call-off as stated on the call-off document itself. Value: following the ISO 8601 format as follows: "YYYY-MM-DD" or "YYYY-MM-DDThh:mm:ss" or "YYYY-MM-DDThh:mm:ss±hh:mm"
+ - "parentOrderNumber" - a number identifying the just-in-sequence- part's destination parent part. The parent part is typically known upfront to the supplier for just-in-sequence parts. This might be a temporary unique identifier.
+ Not all keys might be relevant for all just-in-sequence parts. It must be ensured that a combination of these identifiers and the optional manufacturer part ID or customer part ID leads to a unique just-in-sequence part.
+ urn_bamm_io.catenax.just_in_sequence_part_1.0.0_ValueCharacteristic:
+ type: string
+ description: The value of an identifier.
+ urn_bamm_io.catenax.just_in_sequence_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.just_in_sequence_part_1.0.0_KeyCharacteristic'
+ value:
+ description: The value of an identifier.
+ $ref: '#/components/schemas/urn_bamm_io.catenax.just_in_sequence_part_1.0.0_ValueCharacteristic'
+ required:
+ - key
+ - value
+ urn_bamm_io.catenax.just_in_sequence_part_1.0.0_LocalIdentifierCharacteristic:
+ description: "A single just-in-sequence 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.just_in_sequence_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.just_in_sequence_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.just_in_sequence_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.just_in_sequence_part_1.0.0_ProductionCountryCodeTrait'
+ required:
+ - date
+ urn_bamm_io.catenax.just_in_sequence_part_1.0.0_PartIdCharacteristic:
+ type: string
+ description: "The part ID is a multi-character string, usually assigned by an\
+ \ ERP system. Alternatively the ID of the part family can be used if no specific\
+ \ part ID exists."
+ urn_bamm_io.catenax.just_in_sequence_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.just_in_sequence_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.just_in_sequence_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 manufacturer\
+ \ 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 any other instance\
+ \ IDs. \nIf no specific part ID exists a part family ID may be substituted\
+ \ for it."
+ $ref: '#/components/schemas/urn_bamm_io.catenax.just_in_sequence_part_1.0.0_PartIdCharacteristic'
+ customerPartId:
+ description: "Part ID as assigned by the customer of the part. The customer\
+ \ 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 any other instance\
+ \ IDs. \nIf no specific part ID exists a part family ID may be substituted\
+ \ for it.\n"
+ $ref: '#/components/schemas/urn_bamm_io.catenax.just_in_sequence_part_1.0.0_PartIdCharacteristic'
+ nameAtManufacturer:
+ description: Name of the part as assigned by the manufacturer
+ $ref: '#/components/schemas/urn_bamm_io.catenax.just_in_sequence_part_1.0.0_PartNameCharacteristic'
+ nameAtCustomer:
+ description: Name of the part as assigned by the customer
+ $ref: '#/components/schemas/urn_bamm_io.catenax.just_in_sequence_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.just_in_sequence_part_1.0.0_ClassificationCharacteristic'
+ required:
+ - nameAtManufacturer
+ - classification
+ JustInSequencePart:
+ description: "A just-in-sequence part is an instantiation of a (design-) part,\
+ \ where the particular instantiation can be uniquely identified by means of\
+ \ a combination of several IDs related to a just-in-sequence process."
+ type: object
+ properties:
+ catenaXId:
+ description: "The fully anonymous Catena-X ID of the just-in-sequence part,\
+ \ valid for the Catena-X dataspace."
+ $ref: '#/components/schemas/urn_bamm_io.catenax.just_in_sequence_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.just_in_sequence_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.just_in_sequence_part_1.0.0_ManufacturingCharacteristic'
+ partTypeInformation:
+ description: The part type or part family from which the just-in-sequence
+ part has been instantiated.
+ $ref: '#/components/schemas/urn_bamm_io.catenax.just_in_sequence_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'
+ JustInSequencePart:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/PagingSchema'
+ description: The request was successful.
+ requestBodies:
+ JustInSequencePart:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/JustInSequencePart'
diff --git a/io.catenax.material_flow_simulation_result/1.0.0/gen/MaterialFlowSimulationResult.aasx b/io.catenax.material_flow_simulation_result/1.0.0/gen/MaterialFlowSimulationResult.aasx
index ac051e7b..c084bf51 100644
Binary files a/io.catenax.material_flow_simulation_result/1.0.0/gen/MaterialFlowSimulationResult.aasx and b/io.catenax.material_flow_simulation_result/1.0.0/gen/MaterialFlowSimulationResult.aasx differ
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
new file mode 100644
index 00000000..9a551926
--- /dev/null
+++ b/io.catenax.part_as_planned/1.0.1/gen/PartAsPlanned-aas.xml
@@ -0,0 +1,482 @@
+
+
+
+
+ Objekt
+
+
+
+
+ Key Value List
+
+ A list of key value pairs for local identifiers, which are composed of a key and a corresponding value.
+
+
+
+
+Properties
+
+
+
+
+
+
+The key of a local identifier.
+
+ Identifier Key
+
+
+
+
+
+ Name
+ key
+
+
+
+ Characteristic
+
+
+
+
+
+
+
+ Typ http://www.w3.org/2001/XMLSchema#string
+
+
+
+
+
+ Beispiel
+ jisNumber
+
+
+
+ Optional
+
+ Nein
+
+
+
+ Im Payload
+
+ Ja
+
+
+
+
+Payload Schlüssel
+ key
+
+
+
+
+
+
+The value of an identifier.
+
+ Identifier Value
+
+
+
+
+
+ Name
+ value
+
+
+
+ Characteristic
+
+
+
+
+
+
+
+ Typ http://www.w3.org/2001/XMLSchema#string
+
+
+
+
+
+ Beispiel
+ 12345678ABC
+
+
+
+ Optional
+
+ Nein
+
+
+
+ Im Payload
+
+ Ja
+
+
+
+
+Payload Schlüssel
+ value
+
+
+
+
+
+ Manufacturing Entity
+
+ Encapsulates the manufacturing relevant attributes
+
+
+
+
+Properties
+
+
+
+
+
+
+Timestamp of the manufacturing date as the final step in production process (e.g. final quality check, ready-for-shipment event)
+
+ Production Date
+
+
+
+
+
+ Name
+ date
+
+
+
+ Characteristic
+
+
+
+
+
+
+
+
+
+
+ Beispiel
+ 2022-02-04T14:48:54
+
+
+
+ Optional
+
+ Nein
+
+
+
+ Im Payload
+
+ Ja
+
+
+
+
+Payload Schlüssel
+ date
+
+
+
+
+
+
+Country code where the part was manufactured
+
+ Country code
+
+
+
+
+
+ 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
+
+
+
+
+
+
+Part ID as assigned by the manufacturer of the part. The manufacturer 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 any other instance IDs.
+If no specific part ID exists a part family ID may be substituted for it.
+
+ Manufacturer Part ID
+
+
+
+
+
+ Name
+ manufacturerPartId
+
+
+
+ Characteristic
+
+
+
+
+
+
+
+ Typ http://www.w3.org/2001/XMLSchema#string
+
+
+
+
+
+ Beispiel
+ 123-0.740-3434-A
+
+
+
+ Optional
+
+ Ja
+
+
+
+ Im Payload
+
+ Ja
+
+
+
+
+Payload Schlüssel
+ manufacturerPartId
+
+
+
+
+
+
+Part ID as assigned by the customer of the part. The customer 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 any other instance IDs.
+If no specific part ID exists a part family ID may be substituted for it.
+
+
+ Customer Part ID
+
+
+
+
+
+ Name
+ customerPartId
+
+
+
+ Characteristic
+
+
+
+
+
+
+
+ Typ http://www.w3.org/2001/XMLSchema#string
+
+
+
+
+
+ Beispiel
+ PRT-12345
+
+
+
+ Optional
+
+ Ja
+
+
+
+ Im Payload
+
+ Ja
+
+
+
+
+Payload Schlüssel
+ customerPartId
+
+
+
+
+
+
+Name of the part as assigned by the manufacturer
+
+ Name at 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 of the part as assigned by the customer
+
+ Name at 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
+
+
+
+
+
+
+The classification of the part type according to STEP standard definition
+
+ Classifcation
+
+
+
+
+
+ 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
+
+
+
+
+
+
+
+ Aspect Model Part as Planned
+urn:bamm:io.catenax.part_as_planned:1.0.1#PartAsPlanned
+
+
+
+
+
+
+
+
+
+ defaultAdminShell
+
+
+
+
+ defaultAsset
+
+
+
+
+ PartAsSpecified
+
+ Part as Specified
+
+ APPLICATION_CLASS
+
+ The aspect model PartAsSpecified belongs to the Part Catalogue. A PartAsSpecified represents a certain OEM catalog part on part number level. Providing a digital representation of the part as specified by the OEM. The link to the serialized part is done via the partId, this can only be done if the respective DT was provided by the supplier within the value chain.
+
+ urn:bamm:io.catenax.part_as_specified:2.0.0#PartAsSpecified
+
+
+
+
+ Part as Specified
+
+
+ PartAsSpecified
+
+
+ The aspect model PartAsSpecified belongs to the Part Catalogue. A PartAsSpecified represents a certain OEM catalog part on part number level. Providing a digital representation of the part as specified by the OEM. The link to the serialized part is done via the partId, this can only be done if the respective DT was provided by the supplier within the value chain.
+
+
+
+
+
+ http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/2/0
+
+
+
+
+
+ Text
+
+ Text
+
+ urn:bamm:io.catenax.part_as_specified:2.0.0#key
+
+
+
+
+ Key
+
+
+ key
+
+ String
+
+ Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc.
+
+
+
+
+
+ http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/2/0
+
+
+
+
+
+ Text
+
+ Text
+
+ urn:bamm:io.catenax.part_as_specified:2.0.0#value
+
+
+
+
+ Value
+
+
+ value
+
+ String
+
+ Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc.
+
+
+
+
+
+ http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/2/0
+
+
+
+
+
+ PartClassificationCharacteristic
+
+ Part Classification Characteristic
+
+ urn:bamm:io.catenax.part_as_specified:2.0.0#partClassification
+
+
+
+
+ Part Classification
+
+
+ partClassification
+
+ String
+
+ The characteristic of the part classification
+
+
+
+
+
+ http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/2/0
+
+
+
+
+
+ Text
+
+ Text
+
+ urn:bamm:io.catenax.part_as_specified:2.0.0#nameAtOwner
+
+
+
+
+ Name at Owner
+
+
+ nameAtOwner
+
+ String
+
+ Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc.
+
+
+
+
+
+ http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/2/0
+
+
+
+
+
+ Text
+
+ Text
+
+ urn:bamm:io.catenax.part_as_specified:2.0.0#ownerPartId
+
+
+
+
+ Owner PartId
+
+
+ ownerPartId
+
+ String
+
+ Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc.
+
+
+
+
+
+ http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/2/0
+
+
+
+
+
+ Text
+
+ Text
+
+ urn:bamm:io.catenax.part_as_specified:2.0.0#partVersion
+
+
+
+
+ Part Version
+
+
+ partVersion
+
+ String
+
+ Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc.
+
+
+
+
+
+ http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/2/0
+
+
+
+
+
+ ItemCategoryCharacteristic
+
+ Item Category Characteristic
+
+ urn:bamm:io.catenax.part_as_specified:2.0.0#itemCategory
+
+
+
+
+ Item Category
+
+
+ itemCategory
+
+ String
+
+ A part type must be placed into one of the following classes: 'component', 'product', 'software', ‘assembly’, 'tool', or 'raw material'.
+
+
+
+
+
+ urn:bamm:io.catenax.part_as_specified:2.0.0#ItemCategoryCharacteristic:DefaultScalarValue[value=component, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']']
+
+
+ DefaultScalarValue[value=component, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']']
+
+
+
+
+ urn:bamm:io.catenax.part_as_specified:2.0.0#ItemCategoryCharacteristic:DefaultScalarValue[value=product, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']']
+
+
+ DefaultScalarValue[value=product, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']']
+
+
+
+
+ urn:bamm:io.catenax.part_as_specified:2.0.0#ItemCategoryCharacteristic:DefaultScalarValue[value=software, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']']
+
+
+ DefaultScalarValue[value=software, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']']
+
+
+
+
+ urn:bamm:io.catenax.part_as_specified:2.0.0#ItemCategoryCharacteristic:DefaultScalarValue[value=assembly, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']']
+
+
+ DefaultScalarValue[value=assembly, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']']
+
+
+
+
+ urn:bamm:io.catenax.part_as_specified:2.0.0#ItemCategoryCharacteristic:DefaultScalarValue[value=tool, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']']
+
+
+ DefaultScalarValue[value=tool, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']']
+
+
+
+
+ urn:bamm:io.catenax.part_as_specified:2.0.0#ItemCategoryCharacteristic:DefaultScalarValue[value=raw material, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']']
+
+
+ DefaultScalarValue[value=raw material, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']']
+
+
+
+
+
+
+ http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/2/0
+
+
+
+
+
+ Text
+
+ Text
+
+ urn:bamm:io.catenax.part_as_specified:2.0.0#partDescription
+
+
+
+
+ Part Description
+
+
+ partDescription
+
+ String
+
+ Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc.
+
+
+
+
+
+ http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/2/0
+
+
+
+
+
+ PartTypeInformationCharacteristic
+
+ Part Type Information Characteristic
+
+ urn:bamm:io.catenax.part_as_specified:2.0.0#partTypeInformation
+
+
+
+
+ Part Type Information
+
+
+ partTypeInformation
+
+ String
+
+ The characteristic of the part type.
+
+
+
+
+
+ http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/2/0
+
+
+
+
+
+ Timestamp
+
+ Timestamp
+
+ urn:bamm:io.catenax.part_as_specified:2.0.0#validFrom
+
+
+
+
+ Valid From
+
+
+ validFrom
+
+ String
+
+ Describes a Property which contains the date and time with an optional timezone.
+
+
+
+
+
+ http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/2/0
+
+
+
+
+
+ Timestamp
+
+ Timestamp
+
+ urn:bamm:io.catenax.part_as_specified:2.0.0#validTo
+
+
+
+
+ Valid To
+
+
+ validTo
+
+ String
+
+ Describes a Property which contains the date and time with an optional timezone.
+
+
+
+
+
+ http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/2/0
+
+
+
+
+
+ ValidityPeriodCharacteristic
+
+ Validity Period Characteristic
+
+ urn:bamm:io.catenax.part_as_specified:2.0.0#validityPeriod
+
+
+
+
+ Validity Period
+
+
+ validityPeriod
+
+ String
+
+ The characteristic of the validity period.
+
+
+
+
+
+ http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/2/0
+
+
+
+
+
+ CatenaXIdTrait
+ urn:bamm:io.catenax.part_as_specified:2.0.0#catenaXId
+
+
+
+
+ Catena-X ID
+
+
+ catenaXId
+
+ String
+
+
+
+
+ http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/2/0
+
+
+
+
+
+
+
+ PartAsSpecified
+
+ The aspect model PartAsSpecified belongs to the Part Catalogue. A PartAsSpecified represents a certain OEM catalog part on part number level. Providing a digital representation of the part as specified by the OEM. The link to the serialized part is done via the partId, this can only be done if the respective DT was provided by the supplier within the value chain.
+
+ Template
+
+
+ urn:bamm:io.catenax.part_as_specified:2.0.0#PartAsSpecified
+
+
+
+
+
+ PartTypeInformationEntity
+
+ Part Type Information Entity
+
+
+ Encapsulation for data related to the part type
+
+ false
+ false
+
+
+
+ partClassification
+
+ Part Classification
+
+
+ The classification of the part type.
+
+ false
+ false
+
+
+
+ PartClassificationEntity
+
+ Part Classification Entity
+
+
+ The entity encapsulating the properties of the part classification
+
+ false
+ false
+
+
+
+ key
+
+ Key
+
+
+ Key within the classification
+
+ Template
+
+
+ urn:bamm:io.catenax.part_as_specified:2.0.0#key
+
+
+ DefaultScalarValue[value=BMW:PartFamily, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']']
+ http://www.w3.org/2001/XMLSchema#string
+
+
+
+
+ value
+
+ Value
+
+
+ Value within the classification
+
+ Template
+
+
+ urn:bamm:io.catenax.part_as_specified:2.0.0#value
+
+
+ DefaultScalarValue[value=STEEWHL, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']']
+ http://www.w3.org/2001/XMLSchema#string
+
+
+
+
+
+
+
+
+
+
+ nameAtOwner
+
+ Name at Owner
+
+
+ Name of the part as assigned by the part owner.
+
+ Template
+
+
+ urn:bamm:io.catenax.part_as_specified:2.0.0#nameAtOwner
+
+
+ DefaultScalarValue[value=Steering Wheel, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']']
+ http://www.w3.org/2001/XMLSchema#string
+
+
+
+
+ ownerPartId
+
+ Owner PartId
+
+
+ PartID as assigned by the part owner. The PartID identifies the part in the part owner's data space. The PartId does not reference a specific instance of a part and thus should not be confused with the serial number.
+
+ Template
+
+
+ urn:bamm:io.catenax.part_as_specified:2.0.0#ownerPartId
+
+
+ DefaultScalarValue[value=94A2032, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']']
+ http://www.w3.org/2001/XMLSchema#string
+
+
+
+
+ partVersion
+
+ 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.
+
+ Template
+
+
+ urn:bamm:io.catenax.part_as_specified:2.0.0#partVersion
+
+
+ DefaultScalarValue[value=05, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']']
+ http://www.w3.org/2001/XMLSchema#string
+
+
+
+
+ itemCategory
+
+ Item Category
+
+
+ The item category (component, product, software, assembly, tool, raw material) the part belongs to
+
+ Template
+
+
+ urn:bamm:io.catenax.part_as_specified:2.0.0#itemCategory
+
+
+ DefaultScalarValue[value=product, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']']
+ http://www.w3.org/2001/XMLSchema#string
+
+
+
+
+ partDescription
+
+ Part Description
+
+
+ Description of the part of interest
+
+ Template
+
+
+ urn:bamm:io.catenax.part_as_specified:2.0.0#partDescription
+
+
+ DefaultScalarValue[value=The steering wheel is nice and round, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']']
+ http://www.w3.org/2001/XMLSchema#string
+
+
+
+
+
+
+
+ ValidityPeriodEntity
+
+ Validity Period Entity
+
+
+ Encapsulation for data related to the validity period.
+
+ false
+ false
+
+
+
+ validFrom
+
+ Valid From
+
+
+ Start date of the validity period.
+
+ Template
+
+
+ urn:bamm:io.catenax.part_as_specified:2.0.0#validFrom
+
+
+ DefaultScalarValue[value=2023-02-10T07:17:52.396Z, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#dateTime']']
+ http://www.w3.org/2001/XMLSchema#dateTime
+
+
+
+
+ validTo
+
+ Valid To
+
+
+ End date of the validity period.
+
+ Template
+
+
+ urn:bamm:io.catenax.part_as_specified:2.0.0#validTo
+
+
+ DefaultScalarValue[value=2023-02-10T07:17:52.396Z, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#dateTime']']
+ http://www.w3.org/2001/XMLSchema#dateTime
+
+
+
+
+
+
+
+ catenaXId
+
+ Catena-X ID
+
+
+ The unique ID within Catena-X
+
+ Template
+
+
+ urn:bamm:io.catenax.part_as_specified:2.0.0#catenaXId
+
+
+ DefaultScalarValue[value=urn:uuid:580d3adf-1981-44a0-a214-13d6ceed9379, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']']
+ http://www.w3.org/2001/XMLSchema#string
+
+
+
+
+
+
diff --git a/io.catenax.part_as_specified/2.0.0/gen/PartAsSpecified-schema.json b/io.catenax.part_as_specified/2.0.0/gen/PartAsSpecified-schema.json
new file mode 100644
index 00000000..3deb6403
--- /dev/null
+++ b/io.catenax.part_as_specified/2.0.0/gen/PartAsSpecified-schema.json
@@ -0,0 +1,111 @@
+{
+ "$schema" : "http://json-schema.org/draft-04/schema",
+ "description" : "The aspect model PartAsSpecified belongs to the Part Catalogue. A PartAsSpecified represents a certain OEM catalog part on part number level. Providing a digital representation of the part as specified by the OEM. The link to the serialized part is done via the partId, this can only be done if the respective DT was provided by the supplier within the value chain.",
+ "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.part_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" ]
+ },
+ "urn_bamm_io.catenax.part_as_specified_2.0.0_PartClassificationCharacteristic" : {
+ "description" : "The characteristic of the part classification",
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/urn_bamm_io.catenax.part_as_specified_2.0.0_PartClassificationEntity"
+ },
+ "uniqueItems" : true
+ },
+ "urn_bamm_io.catenax.part_as_specified_2.0.0_ItemCategoryCharacteristic" : {
+ "type" : "string",
+ "description" : "A part type must be placed into one of the following classes: 'component', 'product', 'software', ‘assembly’, 'tool', or 'raw material'.",
+ "enum" : [ "component", "product", "software", "assembly", "tool", "raw material" ]
+ },
+ "urn_bamm_io.catenax.part_as_specified_2.0.0_PartTypeInformationCharacteristic" : {
+ "description" : "The characteristic of the part type.",
+ "type" : "object",
+ "properties" : {
+ "partClassification" : {
+ "description" : "The classification of the part type.",
+ "$ref" : "#/components/schemas/urn_bamm_io.catenax.part_as_specified_2.0.0_PartClassificationCharacteristic"
+ },
+ "nameAtOwner" : {
+ "description" : "Name of the part as assigned by the part owner.",
+ "$ref" : "#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text"
+ },
+ "ownerPartId" : {
+ "description" : "PartID as assigned by the part owner. The PartID identifies the part in the part owner's data space. The PartId 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.openmanufacturing_characteristic_2.0.0_Text"
+ },
+ "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"
+ },
+ "itemCategory" : {
+ "description" : "The item category (component, product, software, assembly, tool, raw material) the part belongs to",
+ "$ref" : "#/components/schemas/urn_bamm_io.catenax.part_as_specified_2.0.0_ItemCategoryCharacteristic"
+ },
+ "partDescription" : {
+ "description" : "Description of the part of interest",
+ "$ref" : "#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text"
+ }
+ },
+ "required" : [ "partClassification", "nameAtOwner", "ownerPartId", "partVersion", "itemCategory", "partDescription" ]
+ },
+ "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_specified_2.0.0_ValidityPeriodCharacteristic" : {
+ "description" : "The characteristic of the validity period.",
+ "type" : "object",
+ "properties" : {
+ "validFrom" : {
+ "description" : "Start date of the validity period.",
+ "$ref" : "#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Timestamp"
+ },
+ "validTo" : {
+ "description" : "End date of the validity period.",
+ "$ref" : "#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Timestamp"
+ }
+ }
+ },
+ "urn_bamm_io.catenax.part_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}$)"
+ }
+ }
+ },
+ "properties" : {
+ "partTypeInformation" : {
+ "description" : "Encapsulation for data related to the part type.",
+ "$ref" : "#/components/schemas/urn_bamm_io.catenax.part_as_specified_2.0.0_PartTypeInformationCharacteristic"
+ },
+ "validityPeriod" : {
+ "description" : "Describes the validity period of a part, as some parts are just valid for a given period of time until newer versions of these parts are available",
+ "$ref" : "#/components/schemas/urn_bamm_io.catenax.part_as_specified_2.0.0_ValidityPeriodCharacteristic"
+ },
+ "catenaXId" : {
+ "description" : "The unique ID within Catena-X",
+ "$ref" : "#/components/schemas/urn_bamm_io.catenax.part_as_specified_2.0.0_CatenaXIdTrait"
+ }
+ },
+ "required" : [ "partTypeInformation", "catenaXId" ]
+}
\ No newline at end of file
diff --git a/io.catenax.part_as_specified/2.0.0/gen/PartAsSpecified.aasx b/io.catenax.part_as_specified/2.0.0/gen/PartAsSpecified.aasx
new file mode 100644
index 00000000..fcf348ed
Binary files /dev/null and b/io.catenax.part_as_specified/2.0.0/gen/PartAsSpecified.aasx differ
diff --git a/io.catenax.part_as_specified/2.0.0/gen/PartAsSpecified.html b/io.catenax.part_as_specified/2.0.0/gen/PartAsSpecified.html
new file mode 100644
index 00000000..fd05ab31
--- /dev/null
+++ b/io.catenax.part_as_specified/2.0.0/gen/PartAsSpecified.html
@@ -0,0 +1,1103 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Dokumentation Part as Specified
+
+
+
+
+
+
+
+
+ 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
+
+
+
+
+
+
+
+ 
+
+
+
+
+
+
+
+
+
+
\ 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
new file mode 100644
index 00000000..b0e461c2
--- /dev/null
+++ b/io.catenax.part_as_planned/1.0.1/gen/PartAsPlanned.json
@@ -0,0 +1,12 @@
+{
+ "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
new file mode 100644
index 00000000..6204e43a
--- /dev/null
+++ b/io.catenax.part_as_planned/1.0.1/gen/PartAsPlanned.yml
@@ -0,0 +1,171 @@
+---
+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_specified/2.0.0/gen/PartAsSpecified-aas.xml b/io.catenax.part_as_specified/2.0.0/gen/PartAsSpecified-aas.xml
new file mode 100644
index 00000000..e171475e
--- /dev/null
+++ b/io.catenax.part_as_specified/2.0.0/gen/PartAsSpecified-aas.xml
@@ -0,0 +1,720 @@
+
+
+
+
+Properties
+
+
+
+
+
+
+
+
+
+The fully anonymous Catena-X ID of the serialized part, valid for the Catena-X dataspace.
+
+ Catena-X ID
+
+
+
+
+
+ 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}$)+
+
+
+
+
+
+The part type from which the serialized part has been instantiated
+
+ Part Type Information
+
+
+
+
+
+ Name
+ partTypeInformation
+
+
+
+
+ Characteristic
+
+
+
+
+
+
+
+ SingleEntity
+
+
+
+ Optional
+
+ Nein
+
+
+
+ Im Payload
+
+ Ja
+
+
+
+
+Payload Schlüssel
+ partTypeInformation
+
+
+
+
+
+
+The period of time during which the Part is offered by the manufacturer and can be purchased by customers.
+
+ Validity Period
+
+
+
+
+
+ Name
+ validityPeriod
+
+
+
+
+ Characteristic
+
+
+
+
+
+
+
+ SingleEntity
+
+
+
+ Optional
+
+ Ja
+
+
+
+ Im Payload
+
+ Ja
+
+
+
+
+Payload Schlüssel
+ validityPeriod
+
+
+
+
+
+
+ Objekt
+
+
+
+
+ Part Type Information Entity
+
+ Encapsulation for data related to the part type
+
+
+
+
+Properties
+
+
+
+
+
+
+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.
+
+ Manufacturer Part ID
+
+
+
+
+
+ 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 of the part as assigned by the manufacturer
+
+ Name at manufacturer
+
+
+
+
+
+ Name
+ nameAtManufacturer
+
+
+
+ Characteristic
+
+
+
+
+
+
+
+ Typ http://www.w3.org/2001/XMLSchema#string
+
+
+
+
+
+ Beispiel
+ Mirror left
+
+
+
+ Optional
+
+ Nein
+
+
+
+ Im Payload
+
+ Ja
+
+
+
+
+Payload Schlüssel
+ nameAtManufacturer
+
+
+
+
+
+
+The classification of the part type according to STEP standard definition
+
+ Classifcation
+
+
+
+
+
+ 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
+
+
+
+
+
+
+Start date of validity period
+
+ Valid from
+
+
+
+
+
+ Name
+ validFrom
+
+
+
+ Characteristic
+
+
+
+
+
+
+
+
+
+
+ Beispiel
+ 2023-03-06T14:50:23.230+01:00
+
+
+
+ Optional
+
+ Ja
+
+
+
+ Im Payload
+
+ Ja
+
+
+
+
+Payload Schlüssel
+ validFrom
+
+
+
+
+
+
+End date of validity period
+
+ Valid to
+
+
+
+
+
+ Name
+ validTo
+
+
+
+ Characteristic
+
+
+
+
+
+
+
+
+
+
+ Beispiel
+ 2023-08-06T14:50:23.230+01:00
+
+
+
+ Optional
+
+ Ja
+
+
+
+ Im Payload
+
+ Ja
+
+
+
+
+Payload Schlüssel
+ validTo
+
+ Third party licenses
+
+
+
+
+
+
+
+ Aspect Model Part as Specified
+urn:bamm:io.catenax.part_as_specified:2.0.0#PartAsSpecified
+
+
+
+
+
+
+
+
+
+ defaultAdminShell
+
+
+
+
+ defaultAsset
+
+
+
+
+ Pcf
+
+ Product (Carbon) Footprint
+
+ APPLICATION_CLASS
+
+ Normative: Each Product (Carbon) Footprint represents the carbon footprint of a product with values in accordance with the WBCSD (World Business Council for Sustainable Development)/ Pathfinder framework. Non-normative: Each Product Footprint relates to a specific product, identified by one or more product identifiers. The Product Footprint is modeled as a multi purpose container for product-specific factors.
+
+ urn:bamm:io.catenax.pcf:3.0.0#Pcf
+
+
+
+
+ Product (Carbon) Footprint
+
+
+ Pcf
+
+
+ Normative: Each Product (Carbon) Footprint represents the carbon footprint of a product with values in accordance with the WBCSD (World Business Council for Sustainable Development)/ Pathfinder framework. Non-normative: Each Product Footprint relates to a specific product, identified by one or more product identifiers. The Product Footprint is modeled as a multi purpose container for product-specific factors.
+
+
+
+
+
+ http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/2/0
+
+
+
+
+
+ IdTrait
+ urn:bamm:io.catenax.pcf:3.0.0#id
+
+
+
+
+ Product Footprint Identifier
+
+
+ id
+
+ String
+
+
+
+
+ http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/2/0
+
+
+
+
+
+ SpecVersionTrait
+ urn:bamm:io.catenax.pcf:3.0.0#specVersion
+
+
+
+
+ Product Footprint Specification Version
+
+
+ specVersion
+
+ String
+
+
+
+
+ http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/2/0
+
+
+
+
+
+ ProductFootprintVersionCharacteristic
+
+ Product Footprint Version Characteristic
+
+ urn:bamm:io.catenax.pcf:3.0.0#productFootprintVersion
+
+
+
+
+ Product Footprint Version
+
+
+ productFootprintVersion
+
+ IntegerCount
+
+ Characteristic for defining a product footprint version as specified by the WBCSD (World Business Council for Sustainable Development) Pathfinder initiative.
+
+
+
+
+
+ http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/2/0
+
+
+
+
+
+ Timestamp
+
+ Timestamp
+
+ urn:bamm:io.catenax.pcf:3.0.0#updated
+
+
+
+
+ Updated
+
+
+ updated
+
+ String
+
+ Describes a Property which contains the date and time with an optional timezone.
+
+
+
+
+
+ http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/2/0
+
+
+
+
+
+ NonEmptyString
+
+ Non Empty String
+
+ urn:bamm:io.catenax.pcf:3.0.0#companyName
+
+
+
+
+ Company Name
+
+
+ companyName
+
+ String
+
+ String that contains at least one character.
+
+
+
+
+
+ http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/2/0
+
+
+
+
+
+ CompanyIdsCharacteristic
+
+ Company IDs Characteristic
+
+ urn:bamm:io.catenax.pcf:3.0.0#companyIds
+
+
+
+
+ Company IDs
+
+
+ companyIds
+
+ String
+
+ Characteristic for defining a list of company ids in context of a product footprint.
+
+
+
+
+
+ http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/2/0
+
+
+
+
+
+ Text
+
+ Text
+
+ urn:bamm:io.catenax.pcf:3.0.0#productDescription
+
+
+
+
+ Product Description
+
+
+ productDescription
+
+ String
+
+ Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc.
+
+
+
+
+
+ http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/2/0
+
+
+
+
+
+ ProductIdsCharacteristic
+
+ Product IDs Characteristic
+
+ urn:bamm:io.catenax.pcf:3.0.0#productIds
+
+
+
+
+ Product IDs
+
+
+ productIds
+
+ String
+
+ Characteristic for defining a lost of product ids in context of a product footprint.
+
+
+
+
+
+ http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/2/0
+
+
+
+
+
+ Text
+
+ Text
+
+ urn:bamm:io.catenax.pcf:3.0.0#productCategoryCpc
+
+
+
+
+ Product Category
+
+
+ productCategoryCpc
+
+ String
+
+ Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc.
+
+
+
+
+
+ http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/2/0
+
+
+
+
+
+ NonEmptyString
+
+ Non Empty String
+
+ urn:bamm:io.catenax.pcf:3.0.0#productNameCompany
+
+
+
+
+ Product Trade Name
+
+
+ productNameCompany
+
+ String
+
+ String that contains at least one character.
+
+
+
+
+
+ http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/2/0
+
+
+
+
+
+ Text
+
+ Text
+
+ urn:bamm:io.catenax.pcf:3.0.0#comment
+
+
+
+
+ Comment
+
+
+ comment
+
+ String
+
+ Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc.
+
+
+
+
+
+ http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/2/0
+
+
+
+
+
+ DeclaredUnit
+
+ Unit of Measurement
+
+ urn:bamm:io.catenax.pcf:3.0.0#declaredUnit
+
+
+
+
+ Unit of measurement
+
+
+ declaredUnit
+
+ String
+
+ Unit of analysis of the product with accepted values as specified by the WBCSD (World Business Council for Sustainable Development) Pathfinder initiative.
+
+
+
+
+
+ urn:bamm:io.catenax.pcf:3.0.0#DeclaredUnit:DefaultScalarValue[value=liter, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']']
+
+
+ DefaultScalarValue[value=liter, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']']
+
+
+
+
+ urn:bamm:io.catenax.pcf:3.0.0#DeclaredUnit:DefaultScalarValue[value=kilogram, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']']
+
+
+ DefaultScalarValue[value=kilogram, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']']
+
+
+
+
+ urn:bamm:io.catenax.pcf:3.0.0#DeclaredUnit:DefaultScalarValue[value=cubic meter, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']']
+
+
+ DefaultScalarValue[value=cubic meter, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']']
+
+
+
+
+ urn:bamm:io.catenax.pcf:3.0.0#DeclaredUnit:DefaultScalarValue[value=kilowatt hour, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']']
+
+
+ DefaultScalarValue[value=kilowatt hour, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']']
+
+
+
+
+ urn:bamm:io.catenax.pcf:3.0.0#DeclaredUnit:DefaultScalarValue[value=megajoule, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']']
+
+
+ DefaultScalarValue[value=megajoule, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']']
+
+
+
+
+ urn:bamm:io.catenax.pcf:3.0.0#DeclaredUnit:DefaultScalarValue[value=ton kilometer, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']']
+
+
+ DefaultScalarValue[value=ton kilometer, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']']
+
+
+
+
+ urn:bamm:io.catenax.pcf:3.0.0#DeclaredUnit:DefaultScalarValue[value=square meter, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']']
+
+
+ DefaultScalarValue[value=square meter, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']']
+
+
+
+
+
+
+ http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/2/0
+
+
+
+
+
+ StrictlyPositiveDecimal
+
+ Strictly Positive Decimal
+
+ urn:bamm:io.catenax.pcf:3.0.0#unitaryProductAmount
+
+
+
+
+ Package size of referred product
+
+
+ unitaryProductAmount
+
+ RealMeasure
+
+ A positive, non-zero decimal.
+
+
+
+
+
+ http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/2/0
+
+
+
+
+
+ EmissionsTrait
+
+ Emissions Trait
+
+ urn:bamm:io.catenax.pcf:3.0.0#fossilGhgEmissions
+
+
+
+
+ Fossil Emissions
+
+
+ fossilGhgEmissions
+
+ RealMeasure
+
+ Trait for emissions in context of a PCF (Product Carbon Footprint).
+
+
+
+
+
+ http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/2/0
+
+
+
+
+
+ EmissionsTrait
+
+ Emissions Trait
+
+ urn:bamm:io.catenax.pcf:3.0.0#landUseEmissions
+
+
+
+
+ Land Use Emissions
+
+
+ landUseEmissions
+
+ RealMeasure
+
+ Trait for emissions in context of a PCF (Product Carbon Footprint).
+
+
+
+
+
+ http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/2/0
+
+
+
+
+
+ EmissionsTrait
+
+ Emissions Trait
+
+ urn:bamm:io.catenax.pcf:3.0.0#otherEmissions
+
+
+
+
+ Other Emissions
+
+
+ otherEmissions
+
+ RealMeasure
+
+ Trait for emissions in context of a PCF (Product Carbon Footprint).
+
+
+
+
+
+ http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/2/0
+
+
+
+
+
+ EmissionsTrait
+
+ Emissions Trait
+
+ urn:bamm:io.catenax.pcf:3.0.0#landUseChangeEmissions
+
+
+
+
+ Land Use Change Emissions
+
+
+ landUseChangeEmissions
+
+ RealMeasure
+
+ Trait for emissions in context of a PCF (Product Carbon Footprint).
+
+
+
+
+
+ http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/2/0
+
+
+
+
+
+ BiogenicEmissionCharacteristic
+
+ Biogenic Emission Characteristic
+
+ urn:bamm:io.catenax.pcf:3.0.0#biogenicEmissions
+
+
+
+
+ Summary of land (change) emissions
+
+
+ biogenicEmissions
+
+ String
+
+ Characteristic for defining the biogenic emissions of a PCF (Product Carbon Footprint) as specified by the WBCSD (World Business Council for Sustainable Development) Pathfinder initiative.
+
+
+
+
+
+ http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/2/0
+
+
+
+
+
+ EmissionsTrait
+
+ Emissions Trait
+
+ urn:bamm:io.catenax.pcf:3.0.0#biogenicCarbonContent
+
+
+
+
+ Biogenic Carbon Content
+
+
+ biogenicCarbonContent
+
+ RealMeasure
+
+ Trait for emissions in context of a PCF (Product Carbon Footprint).
+
+
+
+
+
+ http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/2/0
+
+
+
+
+
+ Timestamp
+
+ Timestamp
+
+ urn:bamm:io.catenax.pcf:3.0.0#reportingPeriodStart
+
+
+
+
+ Reporting Period (Start)
+
+
+ reportingPeriodStart
+
+ String
+
+ Describes a Property which contains the date and time with an optional timezone.
+
+
+
+
+
+ http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/2/0
+
+
+
+
+
+ Timestamp
+
+ Timestamp
+
+ urn:bamm:io.catenax.pcf:3.0.0#reportingPeriodEnd
+
+
+
+
+ Reporting Period (End excl.)
+
+
+ reportingPeriodEnd
+
+ String
+
+ Describes a Property which contains the date and time with an optional timezone.
+
+
+
+
+
+ http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/2/0
+
+
+
+
+
+ PrimaryDataShareTrait
+ urn:bamm:io.catenax.pcf:3.0.0#primaryDataShare
+
+
+
+
+ Primary Data Share
+
+
+ primaryDataShare
+
+ RealMeasure
+
+
+
+
+ http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/2/0
+
+
+
+
+
+ NonEmptyString
+
+ Non Empty String
+
+ urn:bamm:io.catenax.pcf:3.0.0#name
+
+
+
+
+ Name of Secondary Data Source
+
+
+ name
+
+ String
+
+ String that contains at least one character.
+
+
+
+
+
+ http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/2/0
+
+
+
+
+
+ NonEmptyString
+
+ Non Empty String
+
+ urn:bamm:io.catenax.pcf:3.0.0#version
+
+
+
+
+ Version of Secondary Data Source
+
+
+ version
+
+ String
+
+ String that contains at least one character.
+
+
+
+
+
+ http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/2/0
+
+
+
+
+
+ EmissionFactorSourcesCharacteristic
+
+ Emission Factor Sources Characteristic
+
+ urn:bamm:io.catenax.pcf:3.0.0#emissionFactorSources
+
+
+
+
+ Emission Factor Data Sources
+
+
+ emissionFactorSources
+
+ String
+
+ Characteristic for defining a list of emission factor databases for a product footprint as specified by the WBCSD (World Business Council for Sustainable Development) Pathfinder initiative.
+
+
+
+
+
+ http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/2/0
+
+
+
+
+
+ GeographyCountrySubdivisionTrait
+ urn:bamm:io.catenax.pcf:3.0.0#geographyCountrySubdivision
+
+
+
+
+ Subdivision
+
+
+ geographyCountrySubdivision
+
+ String
+
+
+
+
+ http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/2/0
+
+
+
+
+
+ GeographyCountryTrait
+ urn:bamm:io.catenax.pcf:3.0.0#geographyCountry
+
+
+
+
+ Country
+
+
+ geographyCountry
+
+ String
+
+
+
+
+ http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/2/0
+
+
+
+
+
+ GeographyRegionOrSubregionCharacteristic
+
+ Region Characteristic
+
+ urn:bamm:io.catenax.pcf:3.0.0#geographyRegionOrSubregion
+
+
+
+
+ Region
+
+
+ geographyRegionOrSubregion
+
+ String
+
+ Characteristic for defining a list of valid regions as specified by the WBCSD (World Business Council for Sustainable Development) Pathfinder initiative.
+
+
+
+
+
+ urn:bamm:io.catenax.pcf:3.0.0#GeographyRegionOrSubregionCharacteristic:DefaultScalarValue[value=Africa, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']']
+
+
+ DefaultScalarValue[value=Africa, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']']
+
+
+
+
+ urn:bamm:io.catenax.pcf:3.0.0#GeographyRegionOrSubregionCharacteristic:DefaultScalarValue[value=Americas, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']']
+
+
+ DefaultScalarValue[value=Americas, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']']
+
+
+
+
+ urn:bamm:io.catenax.pcf:3.0.0#GeographyRegionOrSubregionCharacteristic:DefaultScalarValue[value=Asia, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']']
+
+
+ DefaultScalarValue[value=Asia, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']']
+
+
+
+
+ urn:bamm:io.catenax.pcf:3.0.0#GeographyRegionOrSubregionCharacteristic:DefaultScalarValue[value=Europe, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']']
+
+
+ DefaultScalarValue[value=Europe, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']']
+
+
+
+
+ urn:bamm:io.catenax.pcf:3.0.0#GeographyRegionOrSubregionCharacteristic:DefaultScalarValue[value=Oceania, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']']
+
+
+ DefaultScalarValue[value=Oceania, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']']
+
+
+
+
+ urn:bamm:io.catenax.pcf:3.0.0#GeographyRegionOrSubregionCharacteristic:DefaultScalarValue[value=Australia and New Zealand, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']']
+
+
+ DefaultScalarValue[value=Australia and New Zealand, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']']
+
+
+
+
+ urn:bamm:io.catenax.pcf:3.0.0#GeographyRegionOrSubregionCharacteristic:DefaultScalarValue[value=Central Asia, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']']
+
+
+ DefaultScalarValue[value=Central Asia, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']']
+
+
+
+
+ urn:bamm:io.catenax.pcf:3.0.0#GeographyRegionOrSubregionCharacteristic:DefaultScalarValue[value=Eastern Asia, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']']
+
+
+ DefaultScalarValue[value=Eastern Asia, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']']
+
+
+
+
+ urn:bamm:io.catenax.pcf:3.0.0#GeographyRegionOrSubregionCharacteristic:DefaultScalarValue[value=Eastern Europe, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']']
+
+
+ DefaultScalarValue[value=Eastern Europe, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']']
+
+
+
+
+ urn:bamm:io.catenax.pcf:3.0.0#GeographyRegionOrSubregionCharacteristic:DefaultScalarValue[value=Latin America and the Caribbean, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']']
+
+
+ DefaultScalarValue[value=Latin America and the Caribbean, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']']
+
+
+
+
+ urn:bamm:io.catenax.pcf:3.0.0#GeographyRegionOrSubregionCharacteristic:DefaultScalarValue[value=Melanesia, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']']
+
+
+ DefaultScalarValue[value=Melanesia, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']']
+
+
+
+
+ urn:bamm:io.catenax.pcf:3.0.0#GeographyRegionOrSubregionCharacteristic:DefaultScalarValue[value=Micronesia, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']']
+
+
+ DefaultScalarValue[value=Micronesia, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']']
+
+
+
+
+ urn:bamm:io.catenax.pcf:3.0.0#GeographyRegionOrSubregionCharacteristic:DefaultScalarValue[value=Northern Africa, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']']
+
+
+ DefaultScalarValue[value=Northern Africa, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']']
+
+
+
+
+ urn:bamm:io.catenax.pcf:3.0.0#GeographyRegionOrSubregionCharacteristic:DefaultScalarValue[value=Northern America, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']']
+
+
+ DefaultScalarValue[value=Northern America, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']']
+
+
+
+
+ urn:bamm:io.catenax.pcf:3.0.0#GeographyRegionOrSubregionCharacteristic:DefaultScalarValue[value=Northern Europe, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']']
+
+
+ DefaultScalarValue[value=Northern Europe, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']']
+
+
+
+
+ urn:bamm:io.catenax.pcf:3.0.0#GeographyRegionOrSubregionCharacteristic:DefaultScalarValue[value=Polynesia, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']']
+
+
+ DefaultScalarValue[value=Polynesia, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']']
+
+
+
+
+ urn:bamm:io.catenax.pcf:3.0.0#GeographyRegionOrSubregionCharacteristic:DefaultScalarValue[value=South-eastern Asia, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']']
+
+
+ DefaultScalarValue[value=South-eastern Asia, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']']
+
+
+
+
+ urn:bamm:io.catenax.pcf:3.0.0#GeographyRegionOrSubregionCharacteristic:DefaultScalarValue[value=Southern Asia, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']']
+
+
+ DefaultScalarValue[value=Southern Asia, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']']
+
+
+
+
+ urn:bamm:io.catenax.pcf:3.0.0#GeographyRegionOrSubregionCharacteristic:DefaultScalarValue[value=Southern Europe, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']']
+
+
+ DefaultScalarValue[value=Southern Europe, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']']
+
+
+
+
+ urn:bamm:io.catenax.pcf:3.0.0#GeographyRegionOrSubregionCharacteristic:DefaultScalarValue[value=Sub-Saharan Africa, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']']
+
+
+ DefaultScalarValue[value=Sub-Saharan Africa, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']']
+
+
+
+
+ urn:bamm:io.catenax.pcf:3.0.0#GeographyRegionOrSubregionCharacteristic:DefaultScalarValue[value=Western Asia, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']']
+
+
+ DefaultScalarValue[value=Western Asia, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']']
+
+
+
+
+ urn:bamm:io.catenax.pcf:3.0.0#GeographyRegionOrSubregionCharacteristic:DefaultScalarValue[value=Western Europe, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']']
+
+
+ DefaultScalarValue[value=Western Europe, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']']
+
+
+
+
+
+
+ http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/2/0
+
+
+
+
+
+ Text
+
+ Text
+
+ urn:bamm:io.catenax.pcf:3.0.0#boundaryProcessesDescription
+
+
+
+
+ Process Description
+
+
+ boundaryProcessesDescription
+
+ String
+
+ Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc.
+
+
+
+
+
+ http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/2/0
+
+
+
+
+
+ CrossSectoralStandardsUsedEnumerationCharacteristic
+
+ Cross Sectoral Standards Used Enumeration Characteristic
+
+ urn:bamm:io.catenax.pcf:3.0.0#crossSectoralStandard
+
+
+
+
+ Cross Sectoral Standard
+
+
+ crossSectoralStandard
+
+ String
+
+ Characteristic for defining the enumeration of valid accounting standards used for product carbon footprint calculation as specified by the WBCSD (World Business Council for Sustainable Development) Pathfinder initiative.
+
+
+
+
+
+ urn:bamm:io.catenax.pcf:3.0.0#CrossSectoralStandardsUsedEnumerationCharacteristic:DefaultScalarValue[value=GHG Protocol Product standard, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']']
+
+
+ DefaultScalarValue[value=GHG Protocol Product standard, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']']
+
+
+
+
+ urn:bamm:io.catenax.pcf:3.0.0#CrossSectoralStandardsUsedEnumerationCharacteristic:DefaultScalarValue[value=ISO Standard 14067, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']']
+
+
+ DefaultScalarValue[value=ISO Standard 14067, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']']
+
+
+
+
+ urn:bamm:io.catenax.pcf:3.0.0#CrossSectoralStandardsUsedEnumerationCharacteristic:DefaultScalarValue[value=ISO Standard 14044, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']']
+
+
+ DefaultScalarValue[value=ISO Standard 14044, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']']
+
+
+
+
+
+
+ http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/2/0
+
+
+
+
+
+ CrossSectoralStandardsUsedListCharacteristic
+
+ Cross Sectoral Standards Used Characteristic
+
+ urn:bamm:io.catenax.pcf:3.0.0#crossSectoralStandardsUsed
+
+
+
+
+ Cross Sectoral Standards Used
+
+
+ crossSectoralStandardsUsed
+
+ String
+
+ Characteristic for defining the list of valid accounting standards used for product carbon footprint calculation as specified by the WBCSD (World Business Council for Sustainable Development) Pathfinder initiative.
+
+
+
+
+
+ http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/2/0
+
+
+
+
+
+ ProductOrSectorSpecificRuleOperator
+
+ Product Or Sector Specific Rule Operator
+
+ urn:bamm:io.catenax.pcf:3.0.0#operator
+
+
+
+
+ Operator or Publisher of Sector Specific Rules
+
+
+ operator
+
+ String
+
+ Enumeration of PCR (Product Category Rule) operators as specified by the WBCSD (World Business Council for Sustainable Development) Pathfinder initiative.
+
+
+
+
+
+ urn:bamm:io.catenax.pcf:3.0.0#ProductOrSectorSpecificRuleOperator:DefaultScalarValue[value=PEF, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']']
+
+
+ DefaultScalarValue[value=PEF, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']']
+
+
+
+
+ urn:bamm:io.catenax.pcf:3.0.0#ProductOrSectorSpecificRuleOperator:DefaultScalarValue[value=EPD International, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']']
+
+
+ DefaultScalarValue[value=EPD International, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']']
+
+
+
+
+ urn:bamm:io.catenax.pcf:3.0.0#ProductOrSectorSpecificRuleOperator:DefaultScalarValue[value=Other, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']']
+
+
+ DefaultScalarValue[value=Other, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']']
+
+
+
+
+
+
+ http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/2/0
+
+
+
+
+
+ RuleNamesTrait
+
+ Rule Names Trait
+
+ urn:bamm:io.catenax.pcf:3.0.0#ruleNames
+
+
+
+
+ Product or Sector Specific Rule Names
+
+
+ ruleNames
+
+ String
+
+ Trait to ensure non-empty set of rule names.
+
+
+
+
+
+ http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/2/0
+
+
+
+
+
+ Text
+
+ Text
+
+ urn:bamm:io.catenax.pcf:3.0.0#otherOperatorName
+
+
+
+
+ Other Operator or Publisher of Sector Specific Rules
+
+
+ otherOperatorName
+
+ String
+
+ Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc.
+
+
+
+
+
+ http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/2/0
+
+
+
+
+
+ ProductOrSectorSpecificRuleSet
+
+ Product Or Sector Specific Rules Set
+
+ urn:bamm:io.catenax.pcf:3.0.0#productOrSectorSpecificRules
+
+
+
+
+ Product or Sector Specific Rules
+
+
+ productOrSectorSpecificRules
+
+ String
+
+ Characteristic for defining the set of product or sector specific rules of a product carbon footprint as specified by the WBCSD (World Business Council for Sustainable Development) Pathfinder initiative.
+
+
+
+
+
+ http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/2/0
+
+
+
+
+
+ Text
+
+ Text
+
+ urn:bamm:io.catenax.pcf:3.0.0#allocationRulesDescription
+
+
+
+
+ Allocation Rules Used
+
+
+ allocationRulesDescription
+
+ String
+
+ Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc.
+
+
+
+
+
+ http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/2/0
+
+
+
+
+
+ PcfCharacteristic
+
+ PCF (Product Carbon Footprint) Characteristic
+
+ urn:bamm:io.catenax.pcf:3.0.0#pcf
+
+
+
+
+ PCF (Product Carbon Footprint)
+
+
+ pcf
+
+ String
+
+ Characteristic for defining a PCF (Product Carbon Footprint) as specified by the WBCSD (World Business Council for Sustainable Development) Pathfinder initiative.
+
+
+
+
+
+ http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/2/0
+
+
+
+
+
+ Timestamp
+
+ Timestamp
+
+ urn:bamm:io.catenax.pcf:3.0.0#created
+
+
+
+
+ Validity Start
+
+
+ created
+
+ String
+
+ Describes a Property which contains the date and time with an optional timezone.
+
+
+
+
+
+ http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/2/0
+
+
+
+
+
+
+
+ Pcf
+
+ Normative: Each Product (Carbon) Footprint represents the carbon footprint of a product with values in accordance with the WBCSD (World Business Council for Sustainable Development)/ Pathfinder framework. Non-normative: Each Product Footprint relates to a specific product, identified by one or more product identifiers. The Product Footprint is modeled as a multi purpose container for product-specific factors.
+
+ Template
+
+
+ urn:bamm:io.catenax.pcf:3.0.0#Pcf
+
+
+
+
+
+ id
+
+ Product Footprint Identifier
+
+
+ The product footprint identifier as specified by the WBCSD (World Business Council for Sustainable Development) Pathfinder initiative.
+
+ Template
+
+
+ urn:bamm:io.catenax.pcf:3.0.0#id
+
+
+ DefaultScalarValue[value=3893bb5d-da16-4dc1-9185-11d97476c254, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']']
+ http://www.w3.org/2001/XMLSchema#string
+
+
+
+
+ specVersion
+
+ Product Footprint Specification Version
+
+
+ Version of the product footprint data specification. The value MUST be "1.0.0". Note: subsequent revisions of the product footprint data specification will update this value according to the rules of Semantic Versioning 2.0.0.
+
+ Template
+
+
+ urn:bamm:io.catenax.pcf:3.0.0#specVersion
+
+
+ DefaultScalarValue[value=1.0.0, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']']
+ http://www.w3.org/2001/XMLSchema#string
+
+
+
+
+ productFootprintVersion
+
+ Product Footprint Version
+
+
+ Whenever a data owner or a host system updates a product footprint it must set the version to be by strictly greater than the value of all preceding footprints.
+
+ Template
+
+
+ urn:bamm:io.catenax.pcf:3.0.0#productFootprintVersion
+
+
+ DefaultScalarValue[value=42, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#positiveInteger']']
+ http://www.w3.org/2001/XMLSchema#positiveInteger
+
+
+
+
+ updated
+
+ Updated
+
+
+ Timestamp of the product footprint update. A product footprint must not include this property if an update has never been performed. The timestamp must be in UTC (Universal Time Code).
+
+ Template
+
+
+ urn:bamm:io.catenax.pcf:3.0.0#updated
+
+
+ DefaultScalarValue[value=2022-05-22T21:47:35Z, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#dateTime']']
+ http://www.w3.org/2001/XMLSchema#dateTime
+
+
+
+
+ companyName
+
+ Company Name
+
+
+ Name of the company that is the ProductFootprint Data Owner.
+
+ Template
+
+
+ urn:bamm:io.catenax.pcf:3.0.0#companyName
+
+
+ DefaultScalarValue[value=My Corp, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']']
+ http://www.w3.org/2001/XMLSchema#string
+
+
+
+
+ companyIds
+
+ Company IDs
+
+
+ CompanyIds with value the non-empty set of Uniform Resource Names (URN)2. Each value of this set is supposed to uniquely identify the ProductFootprint Data Owner.
+
+ false
+ false
+
+
+
+ companyIds
+
+ Company IDs
+
+
+ CompanyIds with value the non-empty set of Uniform Resource Names (URN)2. Each value of this set is supposed to uniquely identify the ProductFootprint Data Owner.
+
+ Template
+
+
+ urn:bamm:io.catenax.pcf:3.0.0#companyIds
+
+
+ DefaultScalarValue[value=urn:uuid:51131FB5-42A2-4267-A402-0ECFEFAD1619, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']']
+ http://www.w3.org/2001/XMLSchema#string
+
+
+
+
+
+
+
+ productDescription
+
+ Product Description
+
+
+ Free-form description of the product plus other information related to it such as production technology or packaging.
+
+ Template
+
+
+ urn:bamm:io.catenax.pcf:3.0.0#productDescription
+
+
+ DefaultScalarValue[value=Cote’d Or Ethanol, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']']
+ http://www.w3.org/2001/XMLSchema#string
+
+
+
+
+ productIds
+
+ Product IDs
+
+
+ Each of the values in the set is supposed to uniquely identify the product.
+
+ false
+ false
+
+
+
+ productIds
+
+ Product IDs
+
+
+ Each of the values in the set is supposed to uniquely identify the product.
+
+ Template
+
+
+ urn:bamm:io.catenax.pcf:3.0.0#productIds
+
+
+ DefaultScalarValue[value=urn:gtin:4712345060507, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']']
+ http://www.w3.org/2001/XMLSchema#string
+
+
+
+
+
+
+
+ productCategoryCpc
+
+ Product Category
+
+
+ UN (United Nations) Product Classification Code (CPC - Central Classification Code) 3 that the given product belongs to.
+
+ Template
+
+
+ urn:bamm:io.catenax.pcf:3.0.0#productCategoryCpc
+
+
+ DefaultScalarValue[value=3342, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']']
+ http://www.w3.org/2001/XMLSchema#string
+
+
+
+
+ productNameCompany
+
+ Product Trade Name
+
+
+ Trade name of the product.
+
+ Template
+
+
+ urn:bamm:io.catenax.pcf:3.0.0#productNameCompany
+
+
+ DefaultScalarValue[value=Green Ethanol Volnay, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']']
+ http://www.w3.org/2001/XMLSchema#string
+
+
+
+
+ comment
+
+ Comment
+
+
+ Additional information and instructions related to the calculation of the footprint, or other information which informs the ability to interpret, to audit or to verify the Product Footprint.
+
+ Template
+
+
+ urn:bamm:io.catenax.pcf:3.0.0#comment
+
+
+ DefaultScalarValue[value=Comment for version 42., typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']']
+ http://www.w3.org/2001/XMLSchema#string
+
+
+
+
+ PcfEntity
+
+ PCF (Product Carbon Footprint) Entity
+
+
+ Entity for defining a PCF (Product Carbon Footprint) as specified by the WBCSD (World Business Council for Sustainable Development) Pathfinder initiative.
+
+ false
+ false
+
+
+
+ declaredUnit
+
+ Unit of measurement
+
+
+ unit of analysis of the product.
+
+ Template
+
+
+ urn:bamm:io.catenax.pcf:3.0.0#declaredUnit
+
+
+ Unknown
+ http://www.w3.org/2001/XMLSchema#string
+
+
+
+
+ unitaryProductAmount
+
+ Package size of referred product
+
+
+ Amount of units contained within the product the PCF (Product Carbon Footprint) is referring to.
+
+ Template
+
+
+ urn:bamm:io.catenax.pcf:3.0.0#unitaryProductAmount
+
+
+ DefaultScalarValue[value=1000.0, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#float']']
+ http://www.w3.org/2001/XMLSchema#float
+
+
+
+
+ fossilGhgEmissions
+
+ Fossil Emissions
+
+
+ Emissions from the combustion of fossil sources.
+
+ Template
+
+
+ urn:bamm:io.catenax.pcf:3.0.0#fossilGhgEmissions
+
+
+ Unknown
+ http://www.w3.org/2001/XMLSchema#float
+
+
+
+
+ BiogenicEmissionEntity
+
+ Biogenic Emission Entity
+
+
+ Entity for biogenic emissions of a PCF (Product Carbon Footprint) as specified by the WBCSD (World Business Council for Sustainable Development) Pathfinder initiative.
+
+ false
+ false
+
+
+
+ landUseEmissions
+
+ Land Use Emissions
+
+
+ Land use emissions (e.g. cultural practice).
+
+ Template
+
+
+ urn:bamm:io.catenax.pcf:3.0.0#landUseEmissions
+
+
+ DefaultScalarValue[value=0.001, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#float']']
+ http://www.w3.org/2001/XMLSchema#float
+
+
+
+
+ otherEmissions
+
+ Other Emissions
+
+
+ Other emissions (e.g. biogenic waste treatment).
+
+ Template
+
+
+ urn:bamm:io.catenax.pcf:3.0.0#otherEmissions
+
+
+ DefaultScalarValue[value=0.0, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#float']']
+ http://www.w3.org/2001/XMLSchema#float
+
+
+
+
+ landUseChangeEmissions
+
+ Land Use Change Emissions
+
+
+ Land use change emissions. As specified by WBCSD (World Business Council for Sustainable Development) this value must include direct land use change (dLUC) where available, otherwise statistical land use change (sLUC) can be used. If available, including indirect land use change (iLUC) to remain optional.
+
+ Template
+
+
+ urn:bamm:io.catenax.pcf:3.0.0#landUseChangeEmissions
+
+
+ DefaultScalarValue[value=200.3, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#float']']
+ http://www.w3.org/2001/XMLSchema#float
+
+
+
+
+
+
+
+ biogenicCarbonContent
+
+ Biogenic Carbon Content
+
+
+ Mass of biogenic carbon per given unit of exchange.
+
+ Template
+
+
+ urn:bamm:io.catenax.pcf:3.0.0#biogenicCarbonContent
+
+
+ DefaultScalarValue[value=0.0, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#float']']
+ http://www.w3.org/2001/XMLSchema#float
+
+
+
+
+ reportingPeriodStart
+
+ Reporting Period (Start)
+
+
+ Starting timestamp for the time scope of a PCF (Product Carbon Footprint).
+
+ Template
+
+
+ urn:bamm:io.catenax.pcf:3.0.0#reportingPeriodStart
+
+
+ DefaultScalarValue[value=2021-01-01T00:00:00Z, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#dateTime']']
+ http://www.w3.org/2001/XMLSchema#dateTime
+
+
+
+
+ reportingPeriodEnd
+
+ Reporting Period (End excl.)
+
+
+ Ending timestamp for the time scope of a product footprint as specified by the WBCSD (World Business Council for Sustainable Development) Pathfinder initiative.
+
+ Template
+
+
+ urn:bamm:io.catenax.pcf:3.0.0#reportingPeriodEnd
+
+
+ DefaultScalarValue[value=2022-01-01T00:00:00Z, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#dateTime']']
+ http://www.w3.org/2001/XMLSchema#dateTime
+
+
+
+
+ primaryDataShare
+
+ Primary Data Share
+
+
+ Share of primary data.
+
+ Template
+
+
+ urn:bamm:io.catenax.pcf:3.0.0#primaryDataShare
+
+
+ DefaultScalarValue[value=56.12, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#float']']
+ http://www.w3.org/2001/XMLSchema#float
+
+
+
+
+ emissionFactorSources
+
+ Emission Factor Data Sources
+
+
+ Emission factor databases accepted under Version 1 of the Pathfinder Framework (see the Pathfinder Framework Section 6.2).
+
+ false
+ false
+
+
+
+ EmissionFactorSourcesEntity
+
+ Emission Factor Sources Entity
+
+
+ Entity for defining a list of emission factor databases for a product footprint incl. their names and versions as specified by the WBCSD (World Business Council for Sustainable Development) Pathfinder initiative.
+
+ false
+ false
+
+
+
+ name
+
+ Name of Secondary Data Source
+
+
+ Secondary data sources used (mandatory if applicable) and information on which life cycle stages the sources were used for.
+
+ Template
+
+
+ urn:bamm:io.catenax.pcf:3.0.0#name
+
+
+ DefaultScalarValue[value=Ecoinvent, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']']
+ http://www.w3.org/2001/XMLSchema#string
+
+
+
+
+ version
+
+ Version of Secondary Data Source
+
+
+ Secondary data sources version (mandatory if applicable).
+
+ Template
+
+
+ urn:bamm:io.catenax.pcf:3.0.0#version
+
+
+ DefaultScalarValue[value=1.2.3, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']']
+ http://www.w3.org/2001/XMLSchema#string
+
+
+
+
+
+
+
+
+
+
+ geographyCountrySubdivision
+
+ Subdivision
+
+
+ Subdivision of a country. Value must be an ISO 3166-2 subdivision code as specified by the WBCSD (World Business Council for Sustainable Development) Pathfinder initiative.
+
+ Template
+
+
+ urn:bamm:io.catenax.pcf:3.0.0#geographyCountrySubdivision
+
+
+ DefaultScalarValue[value=US-NY, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']']
+ http://www.w3.org/2001/XMLSchema#string
+
+
+
+
+ geographyCountry
+
+ Country
+
+
+ Two letter country code. Value must conform to data type ISO 3166CC as specified by the WBCSD (World Business Council for Sustainable Development) Pathfinder initiative.
+
+ Template
+
+
+ urn:bamm:io.catenax.pcf:3.0.0#geographyCountry
+
+
+ DefaultScalarValue[value=DE, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']']
+ http://www.w3.org/2001/XMLSchema#string
+
+
+
+
+ geographyRegionOrSubregion
+
+ Region
+
+
+ Region according to list as specified by the WBCSD (World Business Council for Sustainable Development) Pathfinder initiative.
+
+ Template
+
+
+ urn:bamm:io.catenax.pcf:3.0.0#geographyRegionOrSubregion
+
+
+ Unknown
+ http://www.w3.org/2001/XMLSchema#string
+
+
+
+
+ boundaryProcessesDescription
+
+ Process Description
+
+
+ Processes attributable to each lifecycle stage as specified by the WBCSD (World Business Council for Sustainable Development) Pathfinder initiative.
+
+ Template
+
+
+ urn:bamm:io.catenax.pcf:3.0.0#boundaryProcessesDescription
+
+
+ DefaultScalarValue[value=End-of-life included, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']']
+ http://www.w3.org/2001/XMLSchema#string
+
+
+
+
+ crossSectoralStandardsUsed
+
+ Cross Sectoral Standards Used
+
+
+ Discloses the cross-sectoral standards applied for calculating or allocating GHG (Greenhouse Gas) emissions as specified by the WBCSD (World Business Council for Sustainable Development) Pathfinder initiative.
+
+ false
+ true
+
+
+
+ CrossSectoralStandardEntity
+
+ Cross Sectoral Standard Entity
+
+
+ Entity for defining an accounting standard used for product carbon footprint calculation as specified by the WBCSD (World Business Council for Sustainable Development) Pathfinder initiative.
+
+ false
+ false
+
+
+
+ crossSectoralStandard
+
+ Cross Sectoral Standard
+
+
+ Discloses a cross-sectoral standard applied for calculating or allocating GHG (Greenhouse Gas) emissions as specified by the WBCSD (World Business Council for Sustainable Development) Pathfinder initiative.
+
+ Template
+
+
+ urn:bamm:io.catenax.pcf:3.0.0#crossSectoralStandard
+
+
+ Unknown
+ http://www.w3.org/2001/XMLSchema#string
+
+
+
+
+
+
+
+
+
+
+ productOrSectorSpecificRules
+
+ 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. Specified by the WBCSD (World Business Council for Sustainable Development) Pathfinder initiative.
+
+ false
+ false
+
+
+
+ ProductOrSectorSpecificRulesEntity
+
+ Product Or Sector Specific Rules Entity
+
+
+ Entity for defining the set of values for the product or sector specific rules of a product carbon footprint as specified by the WBCSD (World Business Council for Sustainable Development) Pathfinder initiative.
+
+ false
+ false
+
+
+
+ operator
+
+ Operator or Publisher of Sector Specific Rules
+
+
+ Operator of PCR (Product Category Rule)/ PSR (Product Specific Rule) as specified by the WBCSD (World Business Council for Sustainable Development) Pathfinder initiative.
+
+ Template
+
+
+ urn:bamm:io.catenax.pcf:3.0.0#operator
+
+
+ Unknown
+ http://www.w3.org/2001/XMLSchema#string
+
+
+
+
+ ruleNames
+
+ 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. Property defined by the WBCSD (World Business Council for Sustainable Development) Pathfinder initiative.
+
+ Template
+
+
+ urn:bamm:io.catenax.pcf:3.0.0#ruleNames
+
+
+ DefaultScalarValue[value=ABC 2021, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']']
+ http://www.w3.org/2001/XMLSchema#string
+
+
+
+
+ otherOperatorName
+
+ Other Operator or Publisher of Sector Specific Rules
+
+
+ Other operator of PCR (Product Category Rule)/ PSR (Product Specific Rule) as specified by the WBCSD (World Business Council for Sustainable Development) Pathfinder initiative.
+
+ Template
+
+
+ urn:bamm:io.catenax.pcf:3.0.0#otherOperatorName
+
+
+ DefaultScalarValue[value=NSF, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']']
+ http://www.w3.org/2001/XMLSchema#string
+
+
+
+
+
+
+
+
+
+
+ allocationRulesDescription
+
+ Allocation Rules Used
+
+
+ Allocation rules used and underlying reasoning as specified by the WBCSD (World Business Council for Sustainable Development) Pathfinder initiative.
+
+ Template
+
+
+ urn:bamm:io.catenax.pcf:3.0.0#allocationRulesDescription
+
+
+ DefaultScalarValue[value=Physical allocation. Mass of different outputs used., typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']']
+ http://www.w3.org/2001/XMLSchema#string
+
+
+
+
+
+
+
+ created
+
+ Validity Start
+
+
+ Timestamp of the creation of the Product Footprint.
+
+ Template
+
+
+ urn:bamm:io.catenax.pcf:3.0.0#created
+
+
+ DefaultScalarValue[value=2022-05-22T21:47:32Z, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#dateTime']']
+ http://www.w3.org/2001/XMLSchema#dateTime
+
+
+
+
+
+
diff --git a/io.catenax.pcf/3.0.0/gen/Pcf-schema.json b/io.catenax.pcf/3.0.0/gen/Pcf-schema.json
new file mode 100644
index 00000000..6f7dd40d
--- /dev/null
+++ b/io.catenax.pcf/3.0.0/gen/Pcf-schema.json
@@ -0,0 +1,323 @@
+{
+ "$schema" : "http://json-schema.org/draft-04/schema",
+ "description" : "Normative: Each Product (Carbon) Footprint represents the carbon footprint of a product with values in accordance with the WBCSD (World Business Council for Sustainable Development)/ Pathfinder framework. Non-normative: Each Product Footprint relates to a specific product, identified by one or more product identifiers. The Product Footprint is modeled as a multi purpose container for product-specific factors.",
+ "type" : "object",
+ "components" : {
+ "schemas" : {
+ "urn_bamm_io.catenax.pcf_3.0.0_IdTrait" : {
+ "type" : "string",
+ "description" : "Constraint for defining a product footprint identifier as specified by the WBCSD (World Business Council for Sustainable Development) Pathfinder initiative.",
+ "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.pcf_3.0.0_SpecVersionTrait" : {
+ "type" : "string",
+ "description" : "Constraint for defining a version of an artefact (e.g. a specification version) belonging to a product footprint as specified by the WBCSD (World Business Council for Sustainable Development) Pathfinder initiative.",
+ "pattern" : "\\d+\\.\\d+\\.\\d+"
+ },
+ "urn_bamm_io.catenax.pcf_3.0.0_ProductFootprintVersionCharacteristic" : {
+ "type" : "number",
+ "minimum" : 1,
+ "description" : "Characteristic for defining a product footprint version as specified by the WBCSD (World Business Council for Sustainable Development) Pathfinder initiative."
+ },
+ "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.pcf_3.0.0_NonEmptyString" : {
+ "type" : "string",
+ "description" : "String that contains at least one character."
+ },
+ "urn_bamm_io.catenax.pcf_3.0.0_CompanyIdsCharacteristic" : {
+ "description" : "Characteristic for defining a list of company ids in context of a product footprint.",
+ "type" : "array",
+ "items" : {
+ "type" : "string"
+ },
+ "uniqueItems" : true
+ },
+ "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.pcf_3.0.0_ProductIdsCharacteristic" : {
+ "description" : "Characteristic for defining a lost of product ids in context of a product footprint.",
+ "type" : "array",
+ "items" : {
+ "type" : "string"
+ },
+ "uniqueItems" : true
+ },
+ "urn_bamm_io.catenax.pcf_3.0.0_DeclaredUnit" : {
+ "type" : "string",
+ "description" : "Unit of analysis of the product with accepted values as specified by the WBCSD (World Business Council for Sustainable Development) Pathfinder initiative.",
+ "enum" : [ "liter", "kilogram", "cubic meter", "kilowatt hour", "megajoule", "ton kilometer", "square meter" ]
+ },
+ "urn_bamm_io.catenax.pcf_3.0.0_StrictlyPositiveDecimal" : {
+ "type" : "number",
+ "description" : "A positive, non-zero decimal."
+ },
+ "urn_bamm_io.catenax.pcf_3.0.0_EmissionsTrait" : {
+ "type" : "number",
+ "description" : "Only positive emission values (>0) are valid ",
+ "minimum" : 0,
+ "exclusiveMinimum" : false
+ },
+ "urn_bamm_io.catenax.pcf_3.0.0_BiogenicEmissionEntity" : {
+ "description" : "Characteristic for defining the biogenic emissions of a PCF (Product Carbon Footprint) as specified by the WBCSD (World Business Council for Sustainable Development) Pathfinder initiative.",
+ "type" : "object",
+ "properties" : {
+ "landUseEmissions" : {
+ "description" : "Land use emissions (e.g. cultural practice).",
+ "$ref" : "#/components/schemas/urn_bamm_io.catenax.pcf_3.0.0_EmissionsTrait"
+ },
+ "otherEmissions" : {
+ "description" : "Other emissions (e.g. biogenic waste treatment).",
+ "$ref" : "#/components/schemas/urn_bamm_io.catenax.pcf_3.0.0_EmissionsTrait"
+ },
+ "landUseChangeEmissions" : {
+ "description" : "Land use change emissions. As specified by WBCSD (World Business Council for Sustainable Development) this value must include direct land use change (dLUC) where available, otherwise statistical land use change (sLUC) can be used. If available, including indirect land use change (iLUC) to remain optional. ",
+ "$ref" : "#/components/schemas/urn_bamm_io.catenax.pcf_3.0.0_EmissionsTrait"
+ }
+ }
+ },
+ "urn_bamm_io.catenax.pcf_3.0.0_PrimaryDataShareTrait" : {
+ "type" : "number",
+ "description" : "Constraint for a primary data share of a product footprint which limit values between 0.0 and 100.0 as specified by the WBCSD (World Business Council for Sustainable Development) Pathfinder initiative.",
+ "maximum" : 1E+2,
+ "exclusiveMaximum" : false,
+ "minimum" : 0,
+ "exclusiveMinimum" : false
+ },
+ "urn_bamm_io.catenax.pcf_3.0.0_EmissionFactorSourcesEntity" : {
+ "description" : "Entity for defining a list of emission factor databases for a product footprint incl. their names and versions as specified by the WBCSD (World Business Council for Sustainable Development) Pathfinder initiative.",
+ "type" : "object",
+ "properties" : {
+ "name" : {
+ "description" : "Secondary data sources used (mandatory if applicable) and information on which life cycle stages the sources were used for.",
+ "$ref" : "#/components/schemas/urn_bamm_io.catenax.pcf_3.0.0_NonEmptyString"
+ },
+ "version" : {
+ "description" : "Secondary data sources version (mandatory if applicable).",
+ "$ref" : "#/components/schemas/urn_bamm_io.catenax.pcf_3.0.0_NonEmptyString"
+ }
+ },
+ "required" : [ "name", "version" ]
+ },
+ "urn_bamm_io.catenax.pcf_3.0.0_EmissionFactorSourcesCharacteristic" : {
+ "description" : "Characteristic for defining a list of emission factor databases for a product footprint as specified by the WBCSD (World Business Council for Sustainable Development) Pathfinder initiative.",
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/urn_bamm_io.catenax.pcf_3.0.0_EmissionFactorSourcesEntity"
+ },
+ "uniqueItems" : true
+ },
+ "urn_bamm_io.catenax.pcf_3.0.0_GeographyCountrySubdivisionTrait" : {
+ "type" : "string",
+ "description" : "Constraint for defining a geography country subdivision in compliance to ISO 3166-2 as specified by the WBCSD (World Business Council for Sustainable Development) Pathfinder initiative.",
+ "pattern" : "([A-Z]{2}-[A-Z0-9]{1,3}|)"
+ },
+ "urn_bamm_io.catenax.pcf_3.0.0_GeographyCountryTrait" : {
+ "type" : "string",
+ "description" : "Constraint for defining a geography country conform to ISO 3166CC as specified by the WBCSD (World Business Council for Sustainable Development) Pathfinder initiative.",
+ "pattern" : "([A-Z]{2})"
+ },
+ "urn_bamm_io.catenax.pcf_3.0.0_GeographyRegionOrSubregionCharacteristic" : {
+ "type" : "string",
+ "description" : "Characteristic for defining a list of valid regions as specified by the WBCSD (World Business Council for Sustainable Development) Pathfinder initiative.",
+ "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" ]
+ },
+ "urn_bamm_io.catenax.pcf_3.0.0_CrossSectoralStandardsUsedEnumerationCharacteristic" : {
+ "type" : "string",
+ "description" : "Characteristic for defining the enumeration of valid accounting standards used for product carbon footprint calculation as specified by the WBCSD (World Business Council for Sustainable Development) Pathfinder initiative.",
+ "enum" : [ "GHG Protocol Product standard", "ISO Standard 14067", "ISO Standard 14044" ]
+ },
+ "urn_bamm_io.catenax.pcf_3.0.0_CrossSectoralStandardEntity" : {
+ "description" : "Entity for defining an accounting standard used for product carbon footprint calculation as specified by the WBCSD (World Business Council for Sustainable Development) Pathfinder initiative.",
+ "type" : "object",
+ "properties" : {
+ "crossSectoralStandard" : {
+ "description" : "Discloses a cross-sectoral standard applied for calculating or allocating GHG (Greenhouse Gas) emissions as specified by the WBCSD (World Business Council for Sustainable Development) Pathfinder initiative.",
+ "$ref" : "#/components/schemas/urn_bamm_io.catenax.pcf_3.0.0_CrossSectoralStandardsUsedEnumerationCharacteristic"
+ }
+ },
+ "required" : [ "crossSectoralStandard" ]
+ },
+ "urn_bamm_io.catenax.pcf_3.0.0_CrossSectoralStandardsUsedListCharacteristic" : {
+ "description" : "Characteristic for defining the list of valid accounting standards used for product carbon footprint calculation as specified by the WBCSD (World Business Council for Sustainable Development) Pathfinder initiative.",
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/urn_bamm_io.catenax.pcf_3.0.0_CrossSectoralStandardEntity"
+ }
+ },
+ "urn_bamm_io.catenax.pcf_3.0.0_ProductOrSectorSpecificRuleOperator" : {
+ "type" : "string",
+ "description" : "Enumeration of PCR (Product Category Rule) operators as specified by the WBCSD (World Business Council for Sustainable Development) Pathfinder initiative.",
+ "enum" : [ "PEF", "EPD International", "Other" ]
+ },
+ "urn_bamm_io.catenax.pcf_3.0.0_RuleNamesTrait" : {
+ "description" : "Constraint for defining a non-empty set of non-empty rule names as specified by the WBCSD (World Business Council for Sustainable Development) Pathfinder initiative.",
+ "type" : "array",
+ "items" : {
+ "type" : "string",
+ "description" : "String that contains at least one character."
+ },
+ "uniqueItems" : true,
+ "minItems" : 1
+ },
+ "urn_bamm_io.catenax.pcf_3.0.0_ProductOrSectorSpecificRulesEntity" : {
+ "description" : "Entity for defining the set of values for the product or sector specific rules of a product carbon footprint as specified by the WBCSD (World Business Council for Sustainable Development) Pathfinder initiative.",
+ "type" : "object",
+ "properties" : {
+ "operator" : {
+ "description" : "Operator of PCR (Product Category Rule)/ PSR (Product Specific Rule) as specified by the WBCSD (World Business Council for Sustainable Development) Pathfinder initiative.",
+ "$ref" : "#/components/schemas/urn_bamm_io.catenax.pcf_3.0.0_ProductOrSectorSpecificRuleOperator"
+ },
+ "ruleNames" : {
+ "description" : "Product-specific or sector-specific set of rules used for calculating or allocating GHG (Greenhouse Gas) emissions applied from the specified operator. Property defined by the WBCSD (World Business Council for Sustainable Development) Pathfinder initiative.",
+ "$ref" : "#/components/schemas/urn_bamm_io.catenax.pcf_3.0.0_RuleNamesTrait"
+ },
+ "otherOperatorName" : {
+ "description" : "Other operator of PCR (Product Category Rule)/ PSR (Product Specific Rule) as specified by the WBCSD (World Business Council for Sustainable Development) Pathfinder initiative.",
+ "$ref" : "#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text"
+ }
+ },
+ "required" : [ "operator", "ruleNames" ]
+ },
+ "urn_bamm_io.catenax.pcf_3.0.0_ProductOrSectorSpecificRuleSet" : {
+ "description" : "Characteristic for defining the set of product or sector specific rules of a product carbon footprint as specified by the WBCSD (World Business Council for Sustainable Development) Pathfinder initiative.",
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/urn_bamm_io.catenax.pcf_3.0.0_ProductOrSectorSpecificRulesEntity"
+ },
+ "uniqueItems" : true
+ },
+ "urn_bamm_io.catenax.pcf_3.0.0_PcfEntity" : {
+ "description" : "Characteristic for defining a PCF (Product Carbon Footprint) as specified by the WBCSD (World Business Council for Sustainable Development) Pathfinder initiative.",
+ "type" : "object",
+ "properties" : {
+ "declaredUnit" : {
+ "description" : "unit of analysis of the product.",
+ "$ref" : "#/components/schemas/urn_bamm_io.catenax.pcf_3.0.0_DeclaredUnit"
+ },
+ "unitaryProductAmount" : {
+ "description" : "Amount of units contained within the product the PCF (Product Carbon Footprint) is referring to.",
+ "$ref" : "#/components/schemas/urn_bamm_io.catenax.pcf_3.0.0_StrictlyPositiveDecimal"
+ },
+ "fossilGhgEmissions" : {
+ "description" : "Emissions from the combustion of fossil sources. ",
+ "$ref" : "#/components/schemas/urn_bamm_io.catenax.pcf_3.0.0_EmissionsTrait"
+ },
+ "biogenicEmissions" : {
+ "description" : "Biogenic emission factors.",
+ "$ref" : "#/components/schemas/urn_bamm_io.catenax.pcf_3.0.0_BiogenicEmissionEntity"
+ },
+ "biogenicCarbonContent" : {
+ "description" : "Mass of biogenic carbon per given unit of exchange.",
+ "$ref" : "#/components/schemas/urn_bamm_io.catenax.pcf_3.0.0_EmissionsTrait"
+ },
+ "reportingPeriodStart" : {
+ "description" : "Starting timestamp for the time scope of a PCF (Product Carbon Footprint).",
+ "$ref" : "#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Timestamp"
+ },
+ "reportingPeriodEnd" : {
+ "description" : "Ending timestamp for the time scope of a product footprint as specified by the WBCSD (World Business Council for Sustainable Development) Pathfinder initiative.",
+ "$ref" : "#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Timestamp"
+ },
+ "primaryDataShare" : {
+ "description" : "Share of primary data.",
+ "$ref" : "#/components/schemas/urn_bamm_io.catenax.pcf_3.0.0_PrimaryDataShareTrait"
+ },
+ "emissionFactorSources" : {
+ "description" : "Emission factor databases accepted under Version 1 of the Pathfinder Framework (see the Pathfinder Framework Section 6.2).",
+ "$ref" : "#/components/schemas/urn_bamm_io.catenax.pcf_3.0.0_EmissionFactorSourcesCharacteristic"
+ },
+ "geographyCountrySubdivision" : {
+ "description" : "Subdivision of a country. Value must be an ISO 3166-2 subdivision code as specified by the WBCSD (World Business Council for Sustainable Development) Pathfinder initiative.",
+ "$ref" : "#/components/schemas/urn_bamm_io.catenax.pcf_3.0.0_GeographyCountrySubdivisionTrait"
+ },
+ "geographyCountry" : {
+ "description" : "Two letter country code. Value must conform to data type ISO 3166CC as specified by the WBCSD (World Business Council for Sustainable Development) Pathfinder initiative.",
+ "$ref" : "#/components/schemas/urn_bamm_io.catenax.pcf_3.0.0_GeographyCountryTrait"
+ },
+ "geographyRegionOrSubregion" : {
+ "description" : "Region according to list as specified by the WBCSD (World Business Council for Sustainable Development) Pathfinder initiative.",
+ "$ref" : "#/components/schemas/urn_bamm_io.catenax.pcf_3.0.0_GeographyRegionOrSubregionCharacteristic"
+ },
+ "boundaryProcessesDescription" : {
+ "description" : "Processes attributable to each lifecycle stage as specified by the WBCSD (World Business Council for Sustainable Development) Pathfinder initiative.",
+ "$ref" : "#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text"
+ },
+ "crossSectoralStandardsUsed" : {
+ "description" : "Discloses the cross-sectoral standards applied for calculating or allocating GHG (Greenhouse Gas) emissions as specified by the WBCSD (World Business Council for Sustainable Development) Pathfinder initiative.",
+ "$ref" : "#/components/schemas/urn_bamm_io.catenax.pcf_3.0.0_CrossSectoralStandardsUsedListCharacteristic"
+ },
+ "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. Specified by the WBCSD (World Business Council for Sustainable Development) Pathfinder initiative.",
+ "$ref" : "#/components/schemas/urn_bamm_io.catenax.pcf_3.0.0_ProductOrSectorSpecificRuleSet"
+ },
+ "allocationRulesDescription" : {
+ "description" : "Allocation rules used and underlying reasoning as specified by the WBCSD (World Business Council for Sustainable Development) Pathfinder initiative.",
+ "$ref" : "#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text"
+ }
+ },
+ "required" : [ "declaredUnit", "unitaryProductAmount", "fossilGhgEmissions", "biogenicCarbonContent", "reportingPeriodStart", "reportingPeriodEnd", "primaryDataShare", "crossSectoralStandardsUsed", "productOrSectorSpecificRules" ]
+ }
+ }
+ },
+ "properties" : {
+ "id" : {
+ "description" : "The product footprint identifier as specified by the WBCSD (World Business Council for Sustainable Development) Pathfinder initiative.",
+ "$ref" : "#/components/schemas/urn_bamm_io.catenax.pcf_3.0.0_IdTrait"
+ },
+ "specVersion" : {
+ "description" : "Version of the product footprint data specification. The value MUST be \"1.0.0\". Note: subsequent revisions of the product footprint data specification will update this value according to the rules of Semantic Versioning 2.0.0.",
+ "$ref" : "#/components/schemas/urn_bamm_io.catenax.pcf_3.0.0_SpecVersionTrait"
+ },
+ "version" : {
+ "description" : "Whenever a data owner or a host system updates a product footprint it must set the version to be by strictly greater than the value of all preceding footprints.",
+ "$ref" : "#/components/schemas/urn_bamm_io.catenax.pcf_3.0.0_ProductFootprintVersionCharacteristic"
+ },
+ "updated" : {
+ "description" : "Timestamp of the product footprint update. A product footprint must not include this property if an update has never been performed. The timestamp must be in UTC (Universal Time Code).",
+ "$ref" : "#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Timestamp"
+ },
+ "companyName" : {
+ "description" : "Name of the company that is the ProductFootprint Data Owner.",
+ "$ref" : "#/components/schemas/urn_bamm_io.catenax.pcf_3.0.0_NonEmptyString"
+ },
+ "companyIds" : {
+ "description" : "CompanyIds with value the non-empty set of Uniform Resource Names (URN)2. Each value of this set is supposed to uniquely identify the ProductFootprint Data Owner.",
+ "$ref" : "#/components/schemas/urn_bamm_io.catenax.pcf_3.0.0_CompanyIdsCharacteristic"
+ },
+ "productDescription" : {
+ "description" : "Free-form description of the product plus other information related to it such as production technology or packaging.",
+ "$ref" : "#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text"
+ },
+ "productIds" : {
+ "description" : "Each of the values in the set is supposed to uniquely identify the product. ",
+ "$ref" : "#/components/schemas/urn_bamm_io.catenax.pcf_3.0.0_ProductIdsCharacteristic"
+ },
+ "productCategoryCpc" : {
+ "description" : "UN (United Nations) Product Classification Code (CPC - Central Classification Code) 3 that the given product belongs to.",
+ "$ref" : "#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text"
+ },
+ "productNameCompany" : {
+ "description" : "Trade name of the product.",
+ "$ref" : "#/components/schemas/urn_bamm_io.catenax.pcf_3.0.0_NonEmptyString"
+ },
+ "comment" : {
+ "description" : "Additional information and instructions related to the calculation of the footprint, or other information which informs the ability to interpret, to audit or to verify the Product Footprint.",
+ "$ref" : "#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text"
+ },
+ "pcf" : {
+ "description" : "A PCF (Product Carbon Footprint) represents the carbon footprint of a product and related data in accordance with the Pathfinder Framework.",
+ "$ref" : "#/components/schemas/urn_bamm_io.catenax.pcf_3.0.0_PcfEntity"
+ },
+ "created" : {
+ "description" : "Timestamp of the creation of the Product Footprint.",
+ "$ref" : "#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Timestamp"
+ }
+ },
+ "required" : [ "id", "specVersion", "version", "companyName", "companyIds", "productDescription", "productIds", "productCategoryCpc", "productNameCompany", "comment", "pcf", "created" ]
+}
\ No newline at end of file
diff --git a/io.catenax.pcf/3.0.0/gen/Pcf.aasx b/io.catenax.pcf/3.0.0/gen/Pcf.aasx
new file mode 100644
index 00000000..484fc59f
Binary files /dev/null and b/io.catenax.pcf/3.0.0/gen/Pcf.aasx differ
diff --git a/io.catenax.pcf/3.0.0/gen/Pcf.html b/io.catenax.pcf/3.0.0/gen/Pcf.html
new file mode 100644
index 00000000..fe8c50aa
--- /dev/null
+++ b/io.catenax.pcf/3.0.0/gen/Pcf.html
@@ -0,0 +1,3436 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Dokumentation Product (Carbon) Footprint
+
+
+
+
+
+
+
+
+ The aspect model PartAsSpecified belongs to the Part Catalogue. A PartAsSpecified represents a certain OEM catalog part on part number level. Providing a digital representation of the part as specified by the OEM. The link to the serialized part is done via the partId, this can only be done if the respective DT was provided by the supplier within the value chain.
+
+
+
+
+
+ Übersicht
+
+
+
+
+
+
+
+ 
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/io.catenax.part_as_specified/2.0.0/gen/PartAsSpecified.json b/io.catenax.part_as_specified/2.0.0/gen/PartAsSpecified.json
new file mode 100644
index 00000000..58c16f1c
--- /dev/null
+++ b/io.catenax.part_as_specified/2.0.0/gen/PartAsSpecified.json
@@ -0,0 +1,18 @@
+{
+ "partTypeInformation" : {
+ "partClassification" : [ {
+ "value" : "STEEWHL",
+ "key" : "BMW:PartFamily"
+ } ],
+ "ownerPartId" : "94A2032",
+ "partVersion" : "05",
+ "itemCategory" : "component",
+ "nameAtOwner" : "Steering Wheel",
+ "partDescription" : "The steering wheel is nice and round"
+ },
+ "validityPeriod" : {
+ "validFrom" : "2023-02-10T07:17:52.396Z",
+ "validTo" : "2023-02-10T07:17:52.396Z"
+ },
+ "catenaXId" : "urn:uuid:580d3adf-1981-44a0-a214-13d6ceed9379"
+}
\ No newline at end of file
diff --git a/io.catenax.part_as_specified/2.0.0/gen/PartAsSpecified.yml b/io.catenax.part_as_specified/2.0.0/gen/PartAsSpecified.yml
new file mode 100644
index 00000000..2cebe599
--- /dev/null
+++ b/io.catenax.part_as_specified/2.0.0/gen/PartAsSpecified.yml
@@ -0,0 +1,205 @@
+---
+openapi: 3.0.3
+info:
+ title: Part as Specified
+ version: v2
+servers:
+- url: catenax.io/api/v2
+ variables:
+ api-version:
+ default: v2
+paths:
+ /{tenant-id}/part-as-specified:
+ get:
+ tags:
+ - PartAsSpecified
+ operationId: getPartAsSpecified
+ 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/PartAsSpecified'
+ "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.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.part_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
+ urn_bamm_io.catenax.part_as_specified_2.0.0_PartClassificationCharacteristic:
+ description: The characteristic of the part classification
+ type: array
+ items:
+ $ref: '#/components/schemas/urn_bamm_io.catenax.part_as_specified_2.0.0_PartClassificationEntity'
+ uniqueItems: true
+ urn_bamm_io.catenax.part_as_specified_2.0.0_ItemCategoryCharacteristic:
+ type: string
+ description: "A part type must be placed into one of the following classes:\
+ \ 'component', 'product', 'software', ‘assembly’, 'tool', or 'raw material'."
+ enum:
+ - component
+ - product
+ - software
+ - assembly
+ - tool
+ - raw material
+ urn_bamm_io.catenax.part_as_specified_2.0.0_PartTypeInformationCharacteristic:
+ description: The characteristic of the part type.
+ type: object
+ properties:
+ partClassification:
+ description: The classification of the part type.
+ $ref: '#/components/schemas/urn_bamm_io.catenax.part_as_specified_2.0.0_PartClassificationCharacteristic'
+ nameAtOwner:
+ description: Name of the part as assigned by the part owner.
+ $ref: '#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text'
+ ownerPartId:
+ description: PartID as assigned by the part owner. The PartID identifies
+ the part in the part owner's data space. The PartId 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.openmanufacturing_characteristic_2.0.0_Text'
+ 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'
+ itemCategory:
+ description: "The item category (component, product, software, assembly,\
+ \ tool, raw material) the part belongs to"
+ $ref: '#/components/schemas/urn_bamm_io.catenax.part_as_specified_2.0.0_ItemCategoryCharacteristic'
+ partDescription:
+ description: Description of the part of interest
+ $ref: '#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text'
+ required:
+ - partClassification
+ - nameAtOwner
+ - ownerPartId
+ - partVersion
+ - itemCategory
+ - partDescription
+ 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_specified_2.0.0_ValidityPeriodCharacteristic:
+ description: The characteristic of the validity period.
+ type: object
+ properties:
+ validFrom:
+ description: Start date of the validity period.
+ $ref: '#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Timestamp'
+ validTo:
+ description: End date of the validity period.
+ $ref: '#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Timestamp'
+ urn_bamm_io.catenax.part_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}$)"
+ PartAsSpecified:
+ description: "The aspect model PartAsSpecified belongs to the Part Catalogue.\
+ \ A PartAsSpecified represents a certain OEM catalog part on part number level.\
+ \ Providing a digital representation of the part as specified by the OEM.\
+ \ The link to the serialized part is done via the partId, this can only be\
+ \ done if the respective DT was provided by the supplier within the value\
+ \ chain."
+ type: object
+ properties:
+ partTypeInformation:
+ description: Encapsulation for data related to the part type.
+ $ref: '#/components/schemas/urn_bamm_io.catenax.part_as_specified_2.0.0_PartTypeInformationCharacteristic'
+ validityPeriod:
+ description: "Describes the validity period of a part, as some parts are\
+ \ just valid for a given period of time until newer versions of these\
+ \ parts are available"
+ $ref: '#/components/schemas/urn_bamm_io.catenax.part_as_specified_2.0.0_ValidityPeriodCharacteristic'
+ catenaXId:
+ description: The unique ID within Catena-X
+ $ref: '#/components/schemas/urn_bamm_io.catenax.part_as_specified_2.0.0_CatenaXIdTrait'
+ required:
+ - partTypeInformation
+ - catenaXId
+ 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'
+ PartAsSpecified:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/PartAsSpecified'
+ description: The request was successful.
+ requestBodies:
+ PartAsSpecified:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/PartAsSpecified'
diff --git a/io.catenax.pcf/3.0.0/gen/Pcf-aas.xml b/io.catenax.pcf/3.0.0/gen/Pcf-aas.xml
new file mode 100644
index 00000000..457bb586
--- /dev/null
+++ b/io.catenax.pcf/3.0.0/gen/Pcf-aas.xml
@@ -0,0 +1,2161 @@
+
+
+
+
+Properties
+
+
+
+
+
+
+
+
+
+The unique ID within Catena-X
+
+ Catena-X ID
+
+
+
+
+
+ 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).+++ + + +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}$)+
+
+
+
+
+
+Encapsulation for data related to the part type.
+
+ Part Type Information
+
+
+
+
+
+ Name
+ partTypeInformation
+
+
+
+
+ Characteristic
+
+
+
+
+
+
+
+ SingleEntity
+
+
+
+ Optional
+
+ Nein
+
+
+
+ Im Payload
+
+ Ja
+
+
+
+
+Payload Schlüssel
+ partTypeInformation
+
+
+
+
+
+
+Describes the validity period of a part, as some parts are just valid for a given period of time until newer versions of these parts are available
+
+ Validity Period
+
+
+
+
+
+ Name
+ validityPeriod
+
+
+
+
+ Characteristic
+
+
+
+
+
+
+
+ SingleEntity
+
+
+
+ Optional
+
+ Ja
+
+
+
+ Im Payload
+
+ Ja
+
+
+
+
+Payload Schlüssel
+ validityPeriod
+
+
+
+
+
+
+ Objekt
+
+
+
+
+ Part Classification Entity
+
+ The entity encapsulating the properties of the part classification
+
+
+
+
+Properties
+
+
+
+
+
+
+Key within the classification
+
+ Key
+
+
+
+
+
+ Name
+ key
+
+
+
+ Characteristic
+
+
+
+
+
+
+
+ Typ http://www.w3.org/2001/XMLSchema#string
+
+
+
+
+
+ Beispiel
+ BMW:PartFamily
+
+
+
+ Optional
+
+ Nein
+
+
+
+ Im Payload
+
+ Ja
+
+
+
+
+Payload Schlüssel
+ key
+
+
+
+
+
+
+Value within the classification
+
+ Value
+
+
+
+
+
+ Name
+ value
+
+
+
+ Characteristic
+
+
+
+
+
+
+
+ Typ http://www.w3.org/2001/XMLSchema#string
+
+
+
+
+
+ Beispiel
+ STEEWHL
+
+
+
+ Optional
+
+ Nein
+
+
+
+ Im Payload
+
+ Ja
+
+
+
+
+Payload Schlüssel
+ value
+
+
+
+
+ Part Type Information Entity
+
+ Encapsulation for data related to the part type
+
+
+
+
+Properties
+
+
+
+
+
+
+The classification of the part type.
+
+ Part Classification
+
+
+
+
+
+ Name
+ partClassification
+
+
+
+
+ Characteristic
+
+
+
+
+
+
+ Set
+
+
+ Has no order
+
+
+
+ Duplicates not allowed
+
+
+
+ Optional
+
+ Nein
+
+
+
+ Im Payload
+
+ Ja
+
+
+
+
+Payload Schlüssel
+ partClassification
+
+
+
+
+
+
+Name of the part as assigned by the part owner.
+
+ Name at Owner
+
+
+
+
+
+ Name
+ nameAtOwner
+
+
+
+ Characteristic
+
+
+
+
+
+
+
+ Typ http://www.w3.org/2001/XMLSchema#string
+
+
+
+
+
+ Beispiel
+ Steering Wheel
+
+
+
+ Optional
+
+ Nein
+
+
+
+ Im Payload
+
+ Ja
+
+
+
+
+Payload Schlüssel
+ nameAtOwner
+
+
+
+
+
+
+PartID as assigned by the part owner. The PartID identifies the part in the part owner's data space. The PartId does not reference a specific instance of a part and thus should not be confused with the serial number.
+
+ Owner PartId
+
+
+
+
+
+ Name
+ ownerPartId
+
+
+
+ Characteristic
+
+
+
+
+
+
+
+ Typ http://www.w3.org/2001/XMLSchema#string
+
+
+
+
+
+ Beispiel
+ 94A2032
+
+
+
+ Optional
+
+ Nein
+
+
+
+ Im Payload
+
+ Ja
+
+
+
+
+Payload Schlüssel
+ ownerPartId
+
+
+
+
+
+
+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.
+
+ Part Version
+
+
+
+
+
+ Name
+ partVersion
+
+
+
+ Characteristic
+
+
+
+
+
+
+
+ Typ http://www.w3.org/2001/XMLSchema#string
+
+
+
+
+
+ Beispiel
+ 05
+
+
+
+ Optional
+
+ Nein
+
+
+
+ Im Payload
+
+ Ja
+
+
+
+
+Payload Schlüssel
+ partVersion
+
+
+
+
+
+
+The item category (component, product, software, assembly, tool, raw material) the part belongs to
+
+ Item Category
+
+
+
+
+
+ Name
+ itemCategory
+
+
+
+ Characteristic
+
+
+
+
+
+
+ Enumeration
+
+
+ Werte
+
+
+
+
+ -
+
- component +
- product +
- software +
- assembly +
- tool +
- raw material +
+
+
+ Typ http://www.w3.org/2001/XMLSchema#string
+
+
+
+
+
+ Beispiel
+ product
+
+
+
+ Optional
+
+ Nein
+
+
+
+ Im Payload
+
+ Ja
+
+
+
+
+Payload Schlüssel
+ itemCategory
+
+
+
+
+
+
+Description of the part of interest
+
+ Part Description
+
+
+
+
+
+ Name
+ partDescription
+
+
+
+ Characteristic
+
+
+
+
+
+
+
+ Typ http://www.w3.org/2001/XMLSchema#string
+
+
+
+
+
+ Beispiel
+ The steering wheel is nice and round
+
+
+
+ Optional
+
+ Nein
+
+
+
+ Im Payload
+
+ Ja
+
+
+
+
+Payload Schlüssel
+ partDescription
+
+
+
+
+ Validity Period Entity
+
+ Encapsulation for data related to the validity period.
+
+
+
+
+Properties
+
+
+
+
+
+
+Start date of the validity period.
+
+ Valid From
+
+
+
+
+
+ Name
+ validFrom
+
+
+
+ Characteristic
+
+
+
+
+
+
+
+
+
+
+ Beispiel
+ 2023-02-10T07:17:52.396Z
+
+
+
+ Optional
+
+ Ja
+
+
+
+ Im Payload
+
+ Ja
+
+
+
+
+Payload Schlüssel
+ validFrom
+
+
+
+
+
+
+End date of the validity period.
+
+ Valid To
+
+
+
+
+
+ Name
+ validTo
+
+
+
+ Characteristic
+
+
+
+
+
+
+
+
+
+
+ Beispiel
+ 2023-02-10T07:17:52.396Z
+
+
+
+ Optional
+
+ Ja
+
+
+
+ Im Payload
+
+ Ja
+
+
+
+
+Payload Schlüssel
+ validTo
+
+ Third party licenses
+
+
+
+
+
+
+
+ Aspect Model Product (Carbon) Footprint
+urn:bamm:io.catenax.pcf:3.0.0#Pcf
+
+
+
+
+
+
+
+ Normative: Each Product (Carbon) Footprint represents the carbon footprint of a product with values in accordance with the WBCSD (World Business Council for Sustainable Development)/ Pathfinder framework. Non-normative: Each Product Footprint relates to a specific product, identified by one or more product identifiers. The Product Footprint is modeled as a multi purpose container for product-specific factors.
+
+
+
+
+
+ Übersicht
+
+
+
+
+
+
+
+ 
+
+
+
+
+
+
+Properties
+
+
+
+
+
+
+Additional information and instructions related to the calculation of the footprint, or other information which informs the ability to interpret, to audit or to verify the Product Footprint.
+
+ Comment
+
+
+
+
+
+ Name
+ comment
+
+
+
+ Characteristic
+
+
+
+
+
+
+
+ Typ http://www.w3.org/2001/XMLSchema#string
+
+
+
+
+
+ Beispiel
+ Comment for version 42.
+
+
+
+ Optional
+
+ Nein
+
+
+
+ Im Payload
+
+ Ja
+
+
+
+ Payload Schlüssel
+ comment
+
+
+
+Referenz
+
+
+ -
+
- https://wbcsd.github.io/introduction/ +
+
+
+
+
+
+CompanyIds with value the non-empty set of Uniform Resource Names (URN)2. Each value of this set is supposed to uniquely identify the ProductFootprint Data Owner.
+
+ Company IDs
+
+
+
+
+
+ Name
+ companyIds
+
+
+
+ Characteristic
+
+
+
+
+
+
+ Set
+
+
+ Has no order
+
+
+ Duplicates not allowed
+
+
+
+ Referenz
+
+
+
+ -
+
- https://wbcsd.github.io/introduction/ +
+
+
+ Typ http://www.w3.org/2001/XMLSchema#string
+
+
+
+
+
+ Beispiel
+ urn:uuid:51131FB5-42A2-4267-A402-0ECFEFAD1619
+
+
+
+ Optional
+
+ Nein
+
+
+
+ Im Payload
+
+ Ja
+
+
+
+ Payload Schlüssel
+ companyIds
+
+
+
+Referenz
+
+
+ -
+
- https://wbcsd.github.io/introduction/ +
+
+
+
+
+
+Name of the company that is the ProductFootprint Data Owner.
+
+ Company Name
+
+
+
+
+
+ Name
+ companyName
+
+
+
+ Characteristic
+
+
+
+
+
+
+
+ Typ http://www.w3.org/2001/XMLSchema#string
+
+
+
+
+
+ Beispiel
+ My Corp
+
+
+
+ Optional
+
+ Nein
+
+
+
+ Im Payload
+
+ Ja
+
+
+
+ Payload Schlüssel
+ companyName
+
+
+
+Referenz
+
+
+ -
+
- https://wbcsd.github.io/introduction/ +
+
+
+
+
+
+A PCF (Product Carbon Footprint) represents the carbon footprint of a product and related data in accordance with the Pathfinder Framework.
+
+ PCF (Product Carbon Footprint)
+
+
+
+
+
+ Name
+ pcf
+
+
+
+
+ Characteristic
+
+
+
+
+
+
+ SingleEntity
+
+
+
+ Referenz
+
+
+
+ -
+
- https://wbcsd.github.io/introduction/ +
+
+
+ Typ urn:bamm:io.catenax.pcf:3.0.0#PcfEntity
+
+
+
+
+
+ Optional
+
+ Nein
+
+
+
+ Im Payload
+
+ Ja
+
+
+
+ Payload Schlüssel
+ pcf
+
+
+
+Referenz
+
+
+ -
+
- https://wbcsd.github.io/introduction/ +
+
+
+
+
+
+UN (United Nations) Product Classification Code (CPC - Central Classification Code) 3 that the given product belongs to.
+
+ Product Category
+
+
+
+
+
+ Name
+ productCategoryCpc
+
+
+
+ Characteristic
+
+
+
+
+
+
+
+ Typ http://www.w3.org/2001/XMLSchema#string
+
+
+
+
+
+ Beispiel
+ 3342
+
+
+
+ Optional
+
+ Nein
+
+
+
+ Im Payload
+
+ Ja
+
+
+
+ Payload Schlüssel
+ productCategoryCpc
+
+
+
+Referenz
+
+
+ -
+
- https://wbcsd.github.io/introduction/ +
+
+
+
+
+
+Free-form description of the product plus other information related to it such as production technology or packaging.
+
+ Product Description
+
+
+
+
+
+ Name
+ productDescription
+
+
+
+ Characteristic
+
+
+
+
+
+
+
+ Typ http://www.w3.org/2001/XMLSchema#string
+
+
+
+
+
+ Beispiel
+ Cote’d Or Ethanol
+
+
+
+ Optional
+
+ Nein
+
+
+
+ Im Payload
+
+ Ja
+
+
+
+ Payload Schlüssel
+ productDescription
+
+
+
+Referenz
+
+
+ -
+
- https://wbcsd.github.io/introduction/ +
+
+
+
+
+The product footprint identifier as specified by the WBCSD (World Business Council for Sustainable Development) Pathfinder initiative.
+
+ Product Footprint Identifier
+
+
+
+
+
+ Name
+ id
+
+
+
+ Characteristic
+
+
+
+
+
+
+ Trait
+
+
+
+ Typ http://www.w3.org/2001/XMLSchema#string
+
+
+
+
+
+ Beispiel
+ 3893bb5d-da16-4dc1-9185-11d97476c254
+
+
+
+ Optional
+
+ Nein
+
+
+
+ Im Payload
+
+ Ja
+
+
+
+ Payload Schlüssel
+ id
+
+
+
+ Referenz
+
+
+ -
+
- https://wbcsd.github.io/introduction/ +
+
+Bedingungen
+
+
+-
+
-
++ +++ ID Constraint ++ +++ +Beschreibung+Constraint for defining a product footprint identifier as specified by the WBCSD (World Business Council for Sustainable Development) Pathfinder initiative.+++ +Referenz+++++
-
+
- https://wbcsd.github.io/introduction/ +
++ + + +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}$+
+
+
+
+
+
+
+
+
+Version of the product footprint data specification. The value MUST be "1.0.0". Note: subsequent revisions of the product footprint data specification will update this value according to the rules of Semantic Versioning 2.0.0.
+
+ Product Footprint Specification Version
+
+
+
+
+
+ Name
+ specVersion
+
+
+
+ Characteristic
+
+
+
+
+
+
+ Trait
+
+
+
+ Typ http://www.w3.org/2001/XMLSchema#string
+
+
+
+
+
+ Beispiel
+ 1.0.0
+
+
+
+ Optional
+
+ Nein
+
+
+
+ Im Payload
+
+ Ja
+
+
+
+ Payload Schlüssel
+ specVersion
+
+
+
+ Referenz
+
+
+ -
+
- https://wbcsd.github.io/introduction/ +
+
+Bedingungen
+
+
+-
+
-
++ +++ Version Constraint ++ +++ +Beschreibung+Constraint for defining a version of an artefact (e.g. a specification version) belonging to a product footprint as specified by the WBCSD (World Business Council for Sustainable Development) Pathfinder initiative.+++ +Referenz+++++
-
+
- https://wbcsd.github.io/introduction/ +
++ + + +Regulärer Ausdruck+\d+\.\d+\.\d++
+
+
+
+
+
+Whenever a data owner or a host system updates a product footprint it must set the version to be by strictly greater than the value of all preceding footprints.
+
+ Product Footprint Version
+
+
+
+
+
+ Name
+ productFootprintVersion
+
+
+
+ Characteristic
+
+
+
+
+
+
+
+ Referenz
+
+
+
+ -
+
- https://wbcsd.github.io/introduction/ +
+
+
+
+
+
+ Beispiel
+ 42
+
+
+
+ Optional
+
+ Nein
+
+
+
+ Im Payload
+
+ Ja
+
+
+
+ Payload Schlüssel
+ version
+
+
+
+Referenz
+
+
+ -
+
- https://wbcsd.github.io/introduction/ +
+
+
+
+
+
+Each of the values in the set is supposed to uniquely identify the product.
+
+ Product IDs
+
+
+
+
+
+ Name
+ productIds
+
+
+
+ Characteristic
+
+
+
+
+
+
+ Set
+
+
+ Has no order
+
+
+ Duplicates not allowed
+
+
+
+ Referenz
+
+
+
+ -
+
- https://wbcsd.github.io/introduction/ +
+
+
+ Typ http://www.w3.org/2001/XMLSchema#string
+
+
+
+
+
+ Beispiel
+ urn:gtin:4712345060507
+
+
+
+ Optional
+
+ Nein
+
+
+
+ Im Payload
+
+ Ja
+
+
+
+ Payload Schlüssel
+ productIds
+
+
+
+Referenz
+
+
+ -
+
- https://wbcsd.github.io/introduction/ +
+
+
+
+
+
+Trade name of the product.
+
+ Product Trade Name
+
+
+
+
+
+ Name
+ productNameCompany
+
+
+
+ Characteristic
+
+
+
+
+
+
+
+ Typ http://www.w3.org/2001/XMLSchema#string
+
+
+
+
+
+ Beispiel
+ Green Ethanol Volnay
+
+
+
+ Optional
+
+ Nein
+
+
+
+ Im Payload
+
+ Ja
+
+
+
+ Payload Schlüssel
+ productNameCompany
+
+
+
+Referenz
+
+
+ -
+
- https://wbcsd.github.io/introduction/ +
+
+
+
+
+
+Timestamp of the product footprint update. A product footprint must not include this property if an update has never been performed. The timestamp must be in UTC (Universal Time Code).
+
+ Updated
+
+
+
+
+
+ Name
+ updated
+
+
+
+ Characteristic
+
+
+
+
+
+
+
+
+
+
+ Beispiel
+ 2022-05-22T21:47:35Z
+
+
+
+ Optional
+
+ Ja
+
+
+
+ Im Payload
+
+ Ja
+
+
+
+ Payload Schlüssel
+ updated
+
+
+
+Referenz
+
+
+ -
+
- https://wbcsd.github.io/introduction/ +
+
+
+
+
+
+Timestamp of the creation of the Product Footprint.
+
+ Validity Start
+
+
+
+
+
+ Name
+ created
+
+
+
+ Characteristic
+
+
+
+
+
+
+
+
+
+
+ Beispiel
+ 2022-05-22T21:47:32Z
+
+
+
+ Optional
+
+ Nein
+
+
+
+ Im Payload
+
+ Ja
+
+
+
+ Payload Schlüssel
+ created
+
+
+
+Referenz
+
+
+ -
+
- https://wbcsd.github.io/introduction/ +
+
+
+
+ Objekt
+
+
+
+ Biogenic Emission Entity
+
+ Entity for biogenic emissions of a PCF (Product Carbon Footprint) as specified by the WBCSD (World Business Council for Sustainable Development) Pathfinder initiative.
+
+
+ Referenz
+
+
+
+
+ -
+
- https://wbcsd.github.io/introduction/ +
+
+Properties
+
+
+
+
+
+Land use emissions (e.g. cultural practice).
+
+ Land Use Emissions
+
+
+
+
+
+ Name
+ landUseEmissions
+
+
+
+ Characteristic
+
+
+
+
+
+
+ Trait
+
+
+
+ Typ http://www.w3.org/2001/XMLSchema#float
+
+
+
+
+
+ Beispiel
+ 0.001
+
+
+
+ Optional
+
+ Ja
+
+
+
+ Im Payload
+
+ Ja
+
+
+
+ Payload Schlüssel
+ landUseEmissions
+
+
+
+ Referenz
+
+
+ -
+
- https://wbcsd.github.io/introduction/ +
+
Bedingungen
+
+
+-
+
-
++ +++ EmissionConstraint ++ +++ +Beschreibung+Only positive emission values (>0) are valid+++ +Referenz+++++
-
+
- https://wbcsd.github.io/introduction/ +
+++>= ++ + + ++ DefaultScalarValue[value=0.0, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#float']'] ++
+
+
+
+
+Other emissions (e.g. biogenic waste treatment).
+
+ Other Emissions
+
+
+
+
+
+ Name
+ otherEmissions
+
+
+
+ Characteristic
+
+
+
+
+
+
+ Trait
+
+
+
+ Typ http://www.w3.org/2001/XMLSchema#float
+
+
+
+
+
+ Beispiel
+ 0.0
+
+
+
+ Optional
+
+ Ja
+
+
+
+ Im Payload
+
+ Ja
+
+
+
+ Payload Schlüssel
+ otherEmissions
+
+
+
+ Referenz
+
+
+ -
+
- https://wbcsd.github.io/introduction/ +
+
Bedingungen
+
+
+-
+
-
++ +++ EmissionConstraint ++ +++ +Beschreibung+Only positive emission values (>0) are valid+++ +Referenz+++++
-
+
- https://wbcsd.github.io/introduction/ +
+++>= ++ + + ++ DefaultScalarValue[value=0.0, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#float']'] ++
+
+
+
+
+Land use change emissions. As specified by WBCSD (World Business Council for Sustainable Development) this value must include direct land use change (dLUC) where available, otherwise statistical land use change (sLUC) can be used. If available, including indirect land use change (iLUC) to remain optional.
+
+ Land Use Change Emissions
+
+
+
+
+
+ Name
+ landUseChangeEmissions
+
+
+
+ Characteristic
+
+
+
+
+
+
+ Trait
+
+
+
+ Typ http://www.w3.org/2001/XMLSchema#float
+
+
+
+
+
+ Beispiel
+ 200.3
+
+
+
+ Optional
+
+ Ja
+
+
+
+ Im Payload
+
+ Ja
+
+
+
+ Payload Schlüssel
+ landUseChangeEmissions
+
+
+
+ Referenz
+
+
+ -
+
- https://wbcsd.github.io/introduction/ +
+
+ Bedingungen
+
+
+ -
+
-
++ +++ EmissionConstraint ++ +++ +Beschreibung+Only positive emission values (>0) are valid+++ +Referenz+++++
-
+
- https://wbcsd.github.io/introduction/ +
+++>= ++ + + ++ DefaultScalarValue[value=0.0, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#float']'] ++
+
+
+
+ Cross Sectoral Standard Entity
+
+ Entity for defining an accounting standard used for product carbon footprint calculation as specified by the WBCSD (World Business Council for Sustainable Development) Pathfinder initiative.
+
+
+ Referenz
+
+
+
+
+ -
+
- https://wbcsd.github.io/introduction/ +
+
+Properties
+
+
+
+
+
+
+Discloses a cross-sectoral standard applied for calculating or allocating GHG (Greenhouse Gas) emissions as specified by the WBCSD (World Business Council for Sustainable Development) Pathfinder initiative.
+
+ Cross Sectoral Standard
+
+
+
+
+
+ Name
+ crossSectoralStandard
+
+
+
+
+ Characteristic
+
+
+
+
+
+
+ Enumeration
+
+
+ Werte
+
+
+
+
+ -
+
- GHG Protocol Product standard +
- ISO Standard 14067 +
- ISO Standard 14044 +
+
+
+ Referenz
+
+
+
+ -
+
- https://wbcsd.github.io/introduction/ +
+
+
+ Typ http://www.w3.org/2001/XMLSchema#string
+
+
+
+
+
+ Optional
+
+ Nein
+
+
+
+ Im Payload
+
+ Ja
+
+
+
+ Payload Schlüssel
+ crossSectoralStandard
+
+
+
+Referenz
+
+
+ -
+
- https://wbcsd.github.io/introduction/ +
+
+
+
+ Emission Factor Sources Entity
+
+ Entity for defining a list of emission factor databases for a product footprint incl. their names and versions as specified by the WBCSD (World Business Council for Sustainable Development) Pathfinder initiative.
+
+
+ Referenz
+
+
+
+
+ -
+
- https://wbcsd.github.io/introduction/ +
+
+Properties
+
+
+
+
+
+
+Secondary data sources used (mandatory if applicable) and information on which life cycle stages the sources were used for.
+
+ Name of Secondary Data Source
+
+
+
+
+
+ Name
+ name
+
+
+
+ Characteristic
+
+
+
+
+
+
+
+ Typ http://www.w3.org/2001/XMLSchema#string
+
+
+
+
+
+ Beispiel
+ Ecoinvent
+
+
+
+ Optional
+
+ Nein
+
+
+
+ Im Payload
+
+ Ja
+
+
+
+ Payload Schlüssel
+ name
+
+
+
+Referenz
+
+
+ -
+
- https://wbcsd.github.io/introduction/ +
+
+
+
+
+
+Secondary data sources version (mandatory if applicable).
+
+ Version of Secondary Data Source
+
+
+
+
+
+ Name
+ version
+
+
+
+ Characteristic
+
+
+
+
+
+
+
+ Typ http://www.w3.org/2001/XMLSchema#string
+
+
+
+
+
+ Beispiel
+ 1.2.3
+
+
+
+ Optional
+
+ Nein
+
+
+
+ Im Payload
+
+ Ja
+
+
+
+ Payload Schlüssel
+ version
+
+
+
+Referenz
+
+
+ -
+
- https://wbcsd.github.io/introduction/ +
+
+
+ PCF (Product Carbon Footprint) Entity
+
+ Entity for defining a PCF (Product Carbon Footprint) as specified by the WBCSD (World Business Council for Sustainable Development) Pathfinder initiative.
+
+
+ Referenz
+
+
+
+
+ -
+
- https://wbcsd.github.io/introduction/ +
+
+Properties
+
+
+
+
+
+
+unit of analysis of the product.
+
+ Unit of measurement
+
+
+
+
+
+ Name
+ declaredUnit
+
+
+
+
+ Characteristic
+
+
+
+
+
+
+ Enumeration
+
+
+ Werte
+
+
+
+
+ -
+
- liter +
- kilogram +
- cubic meter +
- kilowatt hour +
- megajoule +
- ton kilometer +
- square meter +
+
+
+ Referenz
+
+
+
+ -
+
- https://wbcsd.github.io/introduction/ +
+
+
+ Typ http://www.w3.org/2001/XMLSchema#string
+
+
+
+
+
+ Optional
+
+ Nein
+
+
+
+ Im Payload
+
+ Ja
+
+
+
+ Payload Schlüssel
+ declaredUnit
+
+
+
+Referenz
+
+
+ -
+
- https://wbcsd.github.io/introduction/ +
+
+
+
+
+
+Amount of units contained within the product the PCF (Product Carbon Footprint) is referring to.
+
+ Package size of referred product
+
+
+
+
+
+ Name
+ unitaryProductAmount
+
+
+
+ Characteristic
+
+
+
+
+
+
+
+ Typ http://www.w3.org/2001/XMLSchema#float
+
+
+
+
+
+ Beispiel
+ 1000.0
+
+
+
+ Optional
+
+ Nein
+
+
+
+ Im Payload
+
+ Ja
+
+
+
+ Payload Schlüssel
+ unitaryProductAmount
+
+
+
+Referenz
+
+
+ -
+
- https://wbcsd.github.io/introduction/ +
+
+
+
+
+Emissions from the combustion of fossil sources.
+
+ Fossil Emissions
+
+
+
+
+
+ Name
+ fossilGhgEmissions
+
+
+
+
+ Characteristic
+
+
+
+
+
+
+ Trait
+
+
+
+ Typ http://www.w3.org/2001/XMLSchema#float
+
+
+
+
+
+ Optional
+
+ Nein
+
+
+
+ Im Payload
+
+ Ja
+
+
+
+ Payload Schlüssel
+ fossilGhgEmissions
+
+
+
+ Referenz
+
+
+ -
+
- https://wbcsd.github.io/introduction/ +
+
Bedingungen
+
+
+-
+
-
++ +++ EmissionConstraint ++ +++ +Beschreibung+Only positive emission values (>0) are valid+++ +Referenz+++++
-
+
- https://wbcsd.github.io/introduction/ +
+++>= ++ + + ++ DefaultScalarValue[value=0.0, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#float']'] ++
+
+
+
+
+
+Biogenic emission factors.
+
+ Summary of land (change) emissions
+
+
+
+
+
+ Name
+ biogenicEmissions
+
+
+
+
+ Characteristic
+
+
+
+
+
+
+ SingleEntity
+
+
+
+ Referenz
+
+
+
+ -
+
- https://wbcsd.github.io/introduction/ +
+
+
+
+
+
+ Optional
+
+ Ja
+
+
+
+ Im Payload
+
+ Ja
+
+
+
+ Payload Schlüssel
+ biogenicEmissions
+
+
+
+Referenz
+
+
+ -
+
- https://wbcsd.github.io/introduction/ +
+
+
+
+
+Mass of biogenic carbon per given unit of exchange.
+
+ Biogenic Carbon Content
+
+
+
+
+
+ Name
+ biogenicCarbonContent
+
+
+
+ Characteristic
+
+
+
+
+
+
+ Trait
+
+
+
+ Typ http://www.w3.org/2001/XMLSchema#float
+
+
+
+
+
+ Beispiel
+ 0.0
+
+
+
+ Optional
+
+ Nein
+
+
+
+ Im Payload
+
+ Ja
+
+
+
+ Payload Schlüssel
+ biogenicCarbonContent
+
+
+
+ Referenz
+
+
+ -
+
- https://wbcsd.github.io/introduction/ +
+
Bedingungen
+
+
+-
+
-
++ +++ EmissionConstraint ++ +++ +Beschreibung+Only positive emission values (>0) are valid+++ +Referenz+++++
-
+
- https://wbcsd.github.io/introduction/ +
+++>= ++ + + ++ DefaultScalarValue[value=0.0, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#float']'] ++
+
+
+
+
+
+Starting timestamp for the time scope of a PCF (Product Carbon Footprint).
+
+ Reporting Period (Start)
+
+
+
+
+
+ Name
+ reportingPeriodStart
+
+
+
+ Characteristic
+
+
+
+
+
+
+
+
+
+
+ Beispiel
+ 2021-01-01T00:00:00Z
+
+
+
+ Optional
+
+ Nein
+
+
+
+ Im Payload
+
+ Ja
+
+
+
+ Payload Schlüssel
+ reportingPeriodStart
+
+
+
+Referenz
+
+
+ -
+
- https://wbcsd.github.io/introduction/ +
+
+
+
+
+
+Ending timestamp for the time scope of a product footprint as specified by the WBCSD (World Business Council for Sustainable Development) Pathfinder initiative.
+
+ Reporting Period (End excl.)
+
+
+
+
+
+ Name
+ reportingPeriodEnd
+
+
+
+ Characteristic
+
+
+
+
+
+
+
+
+
+
+ Beispiel
+ 2022-01-01T00:00:00Z
+
+
+
+ Optional
+
+ Nein
+
+
+
+ Im Payload
+
+ Ja
+
+
+
+ Payload Schlüssel
+ reportingPeriodEnd
+
+
+
+Referenz
+
+
+ -
+
- https://wbcsd.github.io/introduction/ +
+
+
+
+
+Share of primary data.
+
+ Primary Data Share
+
+
+
+
+
+ Name
+ primaryDataShare
+
+
+
+ Characteristic
+
+
+
+
+
+
+ Trait
+
+
+
+ Typ http://www.w3.org/2001/XMLSchema#float
+
+
+
+
+
+ Beispiel
+ 56.12
+
+
+
+ Optional
+
+ Nein
+
+
+
+ Im Payload
+
+ Ja
+
+
+
+ Payload Schlüssel
+ primaryDataShare
+
+
+
+ Referenz
+
+
+ -
+
- https://wbcsd.github.io/introduction/ +
+
Bedingungen
+
+
-
+
-
++ +++ Primary Data Share Constraint ++ +++ +Beschreibung+Constraint for a primary data share of a product footprint which limit values between 0.0 and 100.0 as specified by the WBCSD (World Business Council for Sustainable Development) Pathfinder initiative.+++ +Referenz+++++
-
+
- https://wbcsd.github.io/introduction/ +
+++>= +++ DefaultScalarValue[value=0.0, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#float']'] ++...++< + DefaultScalarValue[value=100.0, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#float']'] ++ + + ++ ++++ +Emission factor databases accepted under Version 1 of the Pathfinder Framework (see the Pathfinder Framework Section 6.2). + +Emission Factor Data Sources
+++ + + +Name+emissionFactorSources+++ + +Characteristic+++++++Set+++Has no order+++Duplicates not allowed+++ ++ Referenz ++++-
+
- https://wbcsd.github.io/introduction/ +
++ +Optional++ Ja+++ +Im Payload++ Ja+++ +Payload Schlüssel+emissionFactorSources+++ +Referenz+++-
+
- https://wbcsd.github.io/introduction/ +
+ ++ + + + + + \ No newline at end of file diff --git a/io.catenax.pcf/3.0.0/gen/Pcf.json b/io.catenax.pcf/3.0.0/gen/Pcf.json new file mode 100644 index 00000000..295f4a32 --- /dev/null +++ b/io.catenax.pcf/3.0.0/gen/Pcf.json @@ -0,0 +1,45 @@ +{ + "specVersion" : "1.0.0", + "companyIds" : [ "urn:uuid:51131FB5-42A2-4267-A402-0ECFEFAD1619" ], + "created" : "2022-05-22T21:47:32Z", + "companyName" : "My Corp", + "version" : 42, + "productCategoryCpc" : "3342", + "pcf" : { + "geographyRegionOrSubregion" : "Africa", + "emissionFactorSources" : [ { + "name" : "Ecoinvent", + "version" : "1.2.3" + } ], + "fossilGhgEmissions" : 2.4647926E38, + "biogenicCarbonContent" : 0.0, + "geographyCountry" : "DE", + "boundaryProcessesDescription" : "End-of-life included", + "geographyCountrySubdivision" : "US-NY", + "allocationRulesDescription" : "Physical allocation. Mass of different outputs used.", + "biogenicEmissions" : { + "landUseEmissions" : 0.001, + "landUseChangeEmissions" : 200.3, + "otherEmissions" : 0.0 + }, + "primaryDataShare" : 56.12, + "productOrSectorSpecificRules" : [ { + "operator" : "PEF", + "ruleNames" : "ABC 2021", + "otherOperatorName" : "NSF" + } ], + "crossSectoralStandardsUsed" : [ { + "crossSectoralStandard" : "GHG Protocol Product standard" + } ], + "reportingPeriodStart" : "2021-01-01T00:00:00Z", + "reportingPeriodEnd" : "2022-01-01T00:00:00Z", + "unitaryProductAmount" : 1000.0, + "declaredUnit" : "liter" + }, + "productNameCompany" : "Green Ethanol Volnay", + "productIds" : [ "urn:gtin:4712345060507" ], + "comment" : "Comment for version 42.", + "id" : "3893bb5d-da16-4dc1-9185-11d97476c254", + "updated" : "2022-05-22T21:47:35Z", + "productDescription" : "Cote’d Or Ethanol" +} \ No newline at end of file diff --git a/io.catenax.pcf/3.0.0/gen/Pcf.yml b/io.catenax.pcf/3.0.0/gen/Pcf.yml new file mode 100644 index 00000000..1f0e2338 --- /dev/null +++ b/io.catenax.pcf/3.0.0/gen/Pcf.yml @@ -0,0 +1,524 @@ +--- +openapi: 3.0.3 +info: + title: Product (Carbon) Footprint + version: v3 +servers: +- url: catenax.io/api/v3 + variables: + api-version: + default: v3 +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_bamm_io.catenax.pcf_3.0.0_IdTrait: + type: string + description: Constraint for defining a product footprint identifier as specified + by the WBCSD (World Business Council for Sustainable Development) Pathfinder + initiative. + 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.pcf_3.0.0_SpecVersionTrait: + type: string + description: Constraint for defining a version of an artefact (e.g. a specification + version) belonging to a product footprint as specified by the WBCSD (World + Business Council for Sustainable Development) Pathfinder initiative. + pattern: \d+\.\d+\.\d+ + urn_bamm_io.catenax.pcf_3.0.0_ProductFootprintVersionCharacteristic: + type: number + minimum: 1 + description: Characteristic for defining a product footprint version as specified + by the WBCSD (World Business Council for Sustainable Development) Pathfinder + initiative. + 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.pcf_3.0.0_NonEmptyString: + type: string + description: String that contains at least one character. + urn_bamm_io.catenax.pcf_3.0.0_CompanyIdsCharacteristic: + description: Characteristic for defining a list of company ids in context of + a product footprint. + type: array + items: + type: string + uniqueItems: true + 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.pcf_3.0.0_ProductIdsCharacteristic: + description: Characteristic for defining a lost of product ids in context of + a product footprint. + type: array + items: + type: string + uniqueItems: true + urn_bamm_io.catenax.pcf_3.0.0_DeclaredUnit: + type: string + description: Unit of analysis of the product with accepted values as specified + by the WBCSD (World Business Council for Sustainable Development) Pathfinder + initiative. + enum: + - liter + - kilogram + - cubic meter + - kilowatt hour + - megajoule + - ton kilometer + - square meter + urn_bamm_io.catenax.pcf_3.0.0_StrictlyPositiveDecimal: + type: number + description: "A positive, non-zero decimal." + urn_bamm_io.catenax.pcf_3.0.0_EmissionsTrait: + type: number + description: 'Only positive emission values (>0) are valid ' + minimum: 0 + exclusiveMinimum: false + urn_bamm_io.catenax.pcf_3.0.0_BiogenicEmissionEntity: + description: Characteristic for defining the biogenic emissions of a PCF (Product + Carbon Footprint) as specified by the WBCSD (World Business Council for Sustainable + Development) Pathfinder initiative. + type: object + properties: + landUseEmissions: + description: Land use emissions (e.g. cultural practice). + $ref: '#/components/schemas/urn_bamm_io.catenax.pcf_3.0.0_EmissionsTrait' + otherEmissions: + description: Other emissions (e.g. biogenic waste treatment). + $ref: '#/components/schemas/urn_bamm_io.catenax.pcf_3.0.0_EmissionsTrait' + landUseChangeEmissions: + description: "Land use change emissions. As specified by WBCSD (World Business\ + \ Council for Sustainable Development) this value must include direct\ + \ land use change (dLUC) where available, otherwise statistical land use\ + \ change (sLUC) can be used. If available, including indirect land use\ + \ change (iLUC) to remain optional. " + $ref: '#/components/schemas/urn_bamm_io.catenax.pcf_3.0.0_EmissionsTrait' + urn_bamm_io.catenax.pcf_3.0.0_PrimaryDataShareTrait: + type: number + description: Constraint for a primary data share of a product footprint which + limit values between 0.0 and 100.0 as specified by the WBCSD (World Business + Council for Sustainable Development) Pathfinder initiative. + maximum: 1E+2 + exclusiveMaximum: false + minimum: 0 + exclusiveMinimum: false + urn_bamm_io.catenax.pcf_3.0.0_EmissionFactorSourcesEntity: + description: Entity for defining a list of emission factor databases for a product + footprint incl. their names and versions as specified by the WBCSD (World + Business Council for Sustainable Development) Pathfinder initiative. + type: object + properties: + name: + description: Secondary data sources used (mandatory if applicable) and information + on which life cycle stages the sources were used for. + $ref: '#/components/schemas/urn_bamm_io.catenax.pcf_3.0.0_NonEmptyString' + version: + description: Secondary data sources version (mandatory if applicable). + $ref: '#/components/schemas/urn_bamm_io.catenax.pcf_3.0.0_NonEmptyString' + required: + - name + - version + urn_bamm_io.catenax.pcf_3.0.0_EmissionFactorSourcesCharacteristic: + description: Characteristic for defining a list of emission factor databases + for a product footprint as specified by the WBCSD (World Business Council + for Sustainable Development) Pathfinder initiative. + type: array + items: + $ref: '#/components/schemas/urn_bamm_io.catenax.pcf_3.0.0_EmissionFactorSourcesEntity' + uniqueItems: true + urn_bamm_io.catenax.pcf_3.0.0_GeographyCountrySubdivisionTrait: + type: string + description: Constraint for defining a geography country subdivision in compliance + to ISO 3166-2 as specified by the WBCSD (World Business Council for Sustainable + Development) Pathfinder initiative. + pattern: "([A-Z]{2}-[A-Z0-9]{1,3}|)" + urn_bamm_io.catenax.pcf_3.0.0_GeographyCountryTrait: + type: string + description: Constraint for defining a geography country conform to ISO 3166CC + as specified by the WBCSD (World Business Council for Sustainable Development) + Pathfinder initiative. + pattern: "([A-Z]{2})" + urn_bamm_io.catenax.pcf_3.0.0_GeographyRegionOrSubregionCharacteristic: + type: string + description: Characteristic for defining a list of valid regions as specified + by the WBCSD (World Business Council for Sustainable Development) Pathfinder + initiative. + 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 + urn_bamm_io.catenax.pcf_3.0.0_CrossSectoralStandardsUsedEnumerationCharacteristic: + type: string + description: Characteristic for defining the enumeration of valid accounting + standards used for product carbon footprint calculation as specified by the + WBCSD (World Business Council for Sustainable Development) Pathfinder initiative. + enum: + - GHG Protocol Product standard + - ISO Standard 14067 + - ISO Standard 14044 + urn_bamm_io.catenax.pcf_3.0.0_CrossSectoralStandardEntity: + description: Entity for defining an accounting standard used for product carbon + footprint calculation as specified by the WBCSD (World Business Council for + Sustainable Development) Pathfinder initiative. + type: object + properties: + crossSectoralStandard: + description: Discloses a cross-sectoral standard applied for calculating + or allocating GHG (Greenhouse Gas) emissions as specified by the WBCSD + (World Business Council for Sustainable Development) Pathfinder initiative. + $ref: '#/components/schemas/urn_bamm_io.catenax.pcf_3.0.0_CrossSectoralStandardsUsedEnumerationCharacteristic' + required: + - crossSectoralStandard + urn_bamm_io.catenax.pcf_3.0.0_CrossSectoralStandardsUsedListCharacteristic: + description: Characteristic for defining the list of valid accounting standards + used for product carbon footprint calculation as specified by the WBCSD (World + Business Council for Sustainable Development) Pathfinder initiative. + type: array + items: + $ref: '#/components/schemas/urn_bamm_io.catenax.pcf_3.0.0_CrossSectoralStandardEntity' + urn_bamm_io.catenax.pcf_3.0.0_ProductOrSectorSpecificRuleOperator: + type: string + description: Enumeration of PCR (Product Category Rule) operators as specified + by the WBCSD (World Business Council for Sustainable Development) Pathfinder + initiative. + enum: + - PEF + - EPD International + - Other + urn_bamm_io.catenax.pcf_3.0.0_RuleNamesTrait: + description: Constraint for defining a non-empty set of non-empty rule names + as specified by the WBCSD (World Business Council for Sustainable Development) + Pathfinder initiative. + type: array + items: + type: string + description: String that contains at least one character. + uniqueItems: true + minItems: 1 + urn_bamm_io.catenax.pcf_3.0.0_ProductOrSectorSpecificRulesEntity: + description: Entity for defining the set of values for the product or sector + specific rules of a product carbon footprint as specified by the WBCSD (World + Business Council for Sustainable Development) Pathfinder initiative. + type: object + properties: + operator: + description: Operator of PCR (Product Category Rule)/ PSR (Product Specific + Rule) as specified by the WBCSD (World Business Council for Sustainable + Development) Pathfinder initiative. + $ref: '#/components/schemas/urn_bamm_io.catenax.pcf_3.0.0_ProductOrSectorSpecificRuleOperator' + ruleNames: + description: Product-specific or sector-specific set of rules used for calculating + or allocating GHG (Greenhouse Gas) emissions applied from the specified + operator. Property defined by the WBCSD (World Business Council for Sustainable + Development) Pathfinder initiative. + $ref: '#/components/schemas/urn_bamm_io.catenax.pcf_3.0.0_RuleNamesTrait' + otherOperatorName: + description: Other operator of PCR (Product Category Rule)/ PSR (Product + Specific Rule) as specified by the WBCSD (World Business Council for Sustainable + Development) Pathfinder initiative. + $ref: '#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text' + required: + - operator + - ruleNames + urn_bamm_io.catenax.pcf_3.0.0_ProductOrSectorSpecificRuleSet: + description: Characteristic for defining the set of product or sector specific + rules of a product carbon footprint as specified by the WBCSD (World Business + Council for Sustainable Development) Pathfinder initiative. + type: array + items: + $ref: '#/components/schemas/urn_bamm_io.catenax.pcf_3.0.0_ProductOrSectorSpecificRulesEntity' + uniqueItems: true + urn_bamm_io.catenax.pcf_3.0.0_PcfEntity: + description: Characteristic for defining a PCF (Product Carbon Footprint) as + specified by the WBCSD (World Business Council for Sustainable Development) + Pathfinder initiative. + type: object + properties: + declaredUnit: + description: unit of analysis of the product. + $ref: '#/components/schemas/urn_bamm_io.catenax.pcf_3.0.0_DeclaredUnit' + unitaryProductAmount: + description: Amount of units contained within the product the PCF (Product + Carbon Footprint) is referring to. + $ref: '#/components/schemas/urn_bamm_io.catenax.pcf_3.0.0_StrictlyPositiveDecimal' + fossilGhgEmissions: + description: 'Emissions from the combustion of fossil sources. ' + $ref: '#/components/schemas/urn_bamm_io.catenax.pcf_3.0.0_EmissionsTrait' + biogenicEmissions: + description: Biogenic emission factors. + $ref: '#/components/schemas/urn_bamm_io.catenax.pcf_3.0.0_BiogenicEmissionEntity' + biogenicCarbonContent: + description: Mass of biogenic carbon per given unit of exchange. + $ref: '#/components/schemas/urn_bamm_io.catenax.pcf_3.0.0_EmissionsTrait' + reportingPeriodStart: + description: Starting timestamp for the time scope of a PCF (Product Carbon + Footprint). + $ref: '#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Timestamp' + reportingPeriodEnd: + description: Ending timestamp for the time scope of a product footprint + as specified by the WBCSD (World Business Council for Sustainable Development) + Pathfinder initiative. + $ref: '#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Timestamp' + primaryDataShare: + description: Share of primary data. + $ref: '#/components/schemas/urn_bamm_io.catenax.pcf_3.0.0_PrimaryDataShareTrait' + emissionFactorSources: + description: Emission factor databases accepted under Version 1 of the Pathfinder + Framework (see the Pathfinder Framework Section 6.2). + $ref: '#/components/schemas/urn_bamm_io.catenax.pcf_3.0.0_EmissionFactorSourcesCharacteristic' + geographyCountrySubdivision: + description: Subdivision of a country. Value must be an ISO 3166-2 subdivision + code as specified by the WBCSD (World Business Council for Sustainable + Development) Pathfinder initiative. + $ref: '#/components/schemas/urn_bamm_io.catenax.pcf_3.0.0_GeographyCountrySubdivisionTrait' + geographyCountry: + description: Two letter country code. Value must conform to data type ISO + 3166CC as specified by the WBCSD (World Business Council for Sustainable + Development) Pathfinder initiative. + $ref: '#/components/schemas/urn_bamm_io.catenax.pcf_3.0.0_GeographyCountryTrait' + geographyRegionOrSubregion: + description: Region according to list as specified by the WBCSD (World Business + Council for Sustainable Development) Pathfinder initiative. + $ref: '#/components/schemas/urn_bamm_io.catenax.pcf_3.0.0_GeographyRegionOrSubregionCharacteristic' + boundaryProcessesDescription: + description: Processes attributable to each lifecycle stage as specified + by the WBCSD (World Business Council for Sustainable Development) Pathfinder + initiative. + $ref: '#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text' + crossSectoralStandardsUsed: + description: Discloses the cross-sectoral standards applied for calculating + or allocating GHG (Greenhouse Gas) emissions as specified by the WBCSD + (World Business Council for Sustainable Development) Pathfinder initiative. + $ref: '#/components/schemas/urn_bamm_io.catenax.pcf_3.0.0_CrossSectoralStandardsUsedListCharacteristic' + 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. Specified\ + \ by the WBCSD (World Business Council for Sustainable Development) Pathfinder\ + \ initiative." + $ref: '#/components/schemas/urn_bamm_io.catenax.pcf_3.0.0_ProductOrSectorSpecificRuleSet' + allocationRulesDescription: + description: Allocation rules used and underlying reasoning as specified + by the WBCSD (World Business Council for Sustainable Development) Pathfinder + initiative. + $ref: '#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text' + required: + - declaredUnit + - unitaryProductAmount + - fossilGhgEmissions + - biogenicCarbonContent + - reportingPeriodStart + - reportingPeriodEnd + - primaryDataShare + - crossSectoralStandardsUsed + - productOrSectorSpecificRules + Pcf: + description: "Normative: Each Product (Carbon) Footprint represents the carbon\ + \ footprint of a product with values in accordance with the WBCSD (World Business\ + \ Council for Sustainable Development)/ Pathfinder framework. Non-normative:\ + \ Each Product Footprint relates to a specific product, identified by one\ + \ or more product identifiers. The Product Footprint is modeled as a multi\ + \ purpose container for product-specific factors." + type: object + properties: + id: + description: The product footprint identifier as specified by the WBCSD + (World Business Council for Sustainable Development) Pathfinder initiative. + $ref: '#/components/schemas/urn_bamm_io.catenax.pcf_3.0.0_IdTrait' + specVersion: + description: "Version of the product footprint data specification. The value\ + \ MUST be \"1.0.0\". Note: subsequent revisions of the product footprint\ + \ data specification will update this value according to the rules of\ + \ Semantic Versioning 2.0.0." + $ref: '#/components/schemas/urn_bamm_io.catenax.pcf_3.0.0_SpecVersionTrait' + version: + description: Whenever a data owner or a host system updates a product footprint + it must set the version to be by strictly greater than the value of all + preceding footprints. + $ref: '#/components/schemas/urn_bamm_io.catenax.pcf_3.0.0_ProductFootprintVersionCharacteristic' + updated: + description: Timestamp of the product footprint update. A product footprint + must not include this property if an update has never been performed. + The timestamp must be in UTC (Universal Time Code). + $ref: '#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Timestamp' + companyName: + description: Name of the company that is the ProductFootprint Data Owner. + $ref: '#/components/schemas/urn_bamm_io.catenax.pcf_3.0.0_NonEmptyString' + companyIds: + description: CompanyIds with value the non-empty set of Uniform Resource + Names (URN)2. Each value of this set is supposed to uniquely identify + the ProductFootprint Data Owner. + $ref: '#/components/schemas/urn_bamm_io.catenax.pcf_3.0.0_CompanyIdsCharacteristic' + productDescription: + description: Free-form description of the product plus other information + related to it such as production technology or packaging. + $ref: '#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text' + productIds: + description: 'Each of the values in the set is supposed to uniquely identify + the product. ' + $ref: '#/components/schemas/urn_bamm_io.catenax.pcf_3.0.0_ProductIdsCharacteristic' + productCategoryCpc: + description: UN (United Nations) Product Classification Code (CPC - Central + Classification Code) 3 that the given product belongs to. + $ref: '#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text' + productNameCompany: + description: Trade name of the product. + $ref: '#/components/schemas/urn_bamm_io.catenax.pcf_3.0.0_NonEmptyString' + comment: + description: "Additional information and instructions related to the calculation\ + \ of the footprint, or other information which informs the ability to\ + \ interpret, to audit or to verify the Product Footprint." + $ref: '#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text' + pcf: + description: A PCF (Product Carbon Footprint) represents the carbon footprint + of a product and related data in accordance with the Pathfinder Framework. + $ref: '#/components/schemas/urn_bamm_io.catenax.pcf_3.0.0_PcfEntity' + created: + description: Timestamp of the creation of the Product Footprint. + $ref: '#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Timestamp' + required: + - id + - specVersion + - version + - companyName + - companyIds + - productDescription + - productIds + - productCategoryCpc + - productNameCompany + - comment + - pcf + - created + 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.sealant.sealant_pass/1.0.0/gen/SealantPass-aas.xml b/io.catenax.sealant.sealant_pass/1.0.0/gen/SealantPass-aas.xml new file mode 100644 index 00000000..b3ed7323 --- /dev/null +++ b/io.catenax.sealant.sealant_pass/1.0.0/gen/SealantPass-aas.xml @@ -0,0 +1,4785 @@ + +++ +Subdivision of a country. Value must be an ISO 3166-2 subdivision code as specified by the WBCSD (World Business Council for Sustainable Development) Pathfinder initiative. + +Subdivision
+++ + + +Name+geographyCountrySubdivision+++ +Characteristic+++++++Trait++++ Typ http://www.w3.org/2001/XMLSchema#string + ++++ +Beispiel+US-NY+++ +Optional++ Ja+++ +Im Payload++ Ja+++ +Payload Schlüssel+geographyCountrySubdivision+++ +Referenz+++-
+
- https://wbcsd.github.io/introduction/ +
++Bedingungen+++-
+
-
++ +++ Subdivision Constraint ++ +++ +Beschreibung+Constraint for defining a geography country subdivision in compliance to ISO 3166-2 as specified by the WBCSD (World Business Council for Sustainable Development) Pathfinder initiative.+++ +Referenz+++++
-
+
- https://wbcsd.github.io/introduction/ +
++ + + +Regulärer Ausdruck+([A-Z]{2}-[A-Z0-9]{1,3}|)+
+ ++++ +Two letter country code. Value must conform to data type ISO 3166CC as specified by the WBCSD (World Business Council for Sustainable Development) Pathfinder initiative. + +Country
+++ + + +Name+geographyCountry+++ +Characteristic+++++++Trait++++ Typ http://www.w3.org/2001/XMLSchema#string + ++++ +Beispiel+DE+++ +Optional++ Ja+++ +Im Payload++ Ja+++ +Payload Schlüssel+geographyCountry+++ +Referenz+++-
+
- https://wbcsd.github.io/introduction/ +
++Bedingungen+++-
+
-
++ +++ Country Constraint ++ +++ +Beschreibung+Constraint for defining a geography country conform to ISO 3166CC as specified by the WBCSD (World Business Council for Sustainable Development) Pathfinder initiative.+++ +Referenz+++++
-
+
- https://wbcsd.github.io/introduction/ +
++ + + +Regulärer Ausdruck+([A-Z]{2})+
+ ++++ +Region according to list as specified by the WBCSD (World Business Council for Sustainable Development) Pathfinder initiative. + +Region
+++ + + +Name+geographyRegionOrSubregion+++ + +Characteristic+++++++Enumeration+++Werte+++++-
+
- 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 +
+++ Referenz ++++-
+
- https://wbcsd.github.io/introduction/ +
+++ Typ http://www.w3.org/2001/XMLSchema#string + ++++ +Optional++ Ja+++ +Im Payload++ Ja+++ +Payload Schlüssel+geographyRegionOrSubregion+++ +Referenz+++-
+
- https://wbcsd.github.io/introduction/ +
+ ++++ +Processes attributable to each lifecycle stage as specified by the WBCSD (World Business Council for Sustainable Development) Pathfinder initiative. + +Process Description
+++ + + +Name+boundaryProcessesDescription+++ +Characteristic++++++++ Typ http://www.w3.org/2001/XMLSchema#string + ++++ +Beispiel+End-of-life included+++ +Optional++ Ja+++ +Im Payload++ Ja+++ +Payload Schlüssel+boundaryProcessesDescription+++ +Referenz+++-
+
- https://wbcsd.github.io/introduction/ +
+ ++++ +Discloses the cross-sectoral standards applied for calculating or allocating GHG (Greenhouse Gas) emissions as specified by the WBCSD (World Business Council for Sustainable Development) Pathfinder initiative. + +Cross Sectoral Standards Used
+++ + + +Name+crossSectoralStandardsUsed+++ + +Characteristic+++++++List+++Sortierung+++Erlaubt Duplikate+++ ++ Referenz ++++-
+
- https://wbcsd.github.io/introduction/ +
++ +Optional++ Nein+++ +Im Payload++ Ja+++ +Payload Schlüssel+crossSectoralStandardsUsed+++ +Referenz+++-
+
- https://wbcsd.github.io/introduction/ +
+ ++++ +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. Specified by the WBCSD (World Business Council for Sustainable Development) Pathfinder initiative. + +Product or Sector Specific Rules
+++ + + +Name+productOrSectorSpecificRules+++ + +Characteristic+++++++Set+++Has no order+++Duplicates not allowed+++ ++ Referenz ++++-
+
- https://wbcsd.github.io/introduction/ +
++ +Optional++ Nein+++ +Im Payload++ Ja+++ +Payload Schlüssel+productOrSectorSpecificRules+++ +Referenz+++-
+
- https://wbcsd.github.io/introduction/ +
+ ++++ +Allocation rules used and underlying reasoning as specified by the WBCSD (World Business Council for Sustainable Development) Pathfinder initiative. + +Allocation Rules Used
+++ + + +Name+allocationRulesDescription+++ +Characteristic++++++++ Typ http://www.w3.org/2001/XMLSchema#string + ++++ +Beispiel+Physical allocation. Mass of different outputs used.+++ +Optional++ Ja+++ +Im Payload++ Ja+++ +Payload Schlüssel+allocationRulesDescription+++ +Referenz+++-
+
- https://wbcsd.github.io/introduction/ +
++ +++Product Or Sector Specific Rules Entity
++ Entity for defining the set of values for the product or sector specific rules of a product carbon footprint as specified by the WBCSD (World Business Council for Sustainable Development) Pathfinder initiative. +++ Referenz ++ +++-
+
- https://wbcsd.github.io/introduction/ +
++Properties
++ ++++ +Operator of PCR (Product Category Rule)/ PSR (Product Specific Rule) as specified by the WBCSD (World Business Council for Sustainable Development) Pathfinder initiative. + +Operator or Publisher of Sector Specific Rules
+++ + + +Name+operator+++ + +Characteristic+++++++Enumeration+++Werte+++++-
+
- PEF +
- EPD International +
- Other +
+++ Referenz ++++-
+
- https://wbcsd.github.io/introduction/ +
+++ Typ http://www.w3.org/2001/XMLSchema#string + ++++ +Optional++ Nein+++ +Im Payload++ Ja+++ +Payload Schlüssel+operator+++ +Referenz+++-
+
- https://wbcsd.github.io/introduction/ +
+ ++++ +Product-specific or sector-specific set of rules used for calculating or allocating GHG (Greenhouse Gas) emissions applied from the specified operator. Property defined by the WBCSD (World Business Council for Sustainable Development) Pathfinder initiative. + +Product or Sector Specific Rule Names
+++ + + +Name+ruleNames+++ +Characteristic+++++++Trait++++ Typ http://www.w3.org/2001/XMLSchema#string + ++++ +Beispiel+ABC 2021+++ +Optional++ Nein+++ +Im Payload++ Ja+++ +Payload Schlüssel+ruleNames+++ +Referenz+++-
+
- https://wbcsd.github.io/introduction/ +
++Bedingungen+++-
+
-
++ +++ Rule Names Constraint ++ +++ +Beschreibung+Constraint for defining a non-empty set of non-empty rule names as specified by the WBCSD (World Business Council for Sustainable Development) Pathfinder initiative.+++ +Referenz+++++
-
+
- https://wbcsd.github.io/introduction/ +
++ + + +Min. Zeichen+1+
+ ++++ +Other operator of PCR (Product Category Rule)/ PSR (Product Specific Rule) as specified by the WBCSD (World Business Council for Sustainable Development) Pathfinder initiative. + +Other Operator or Publisher of Sector Specific Rules
+++ + + +Name+otherOperatorName+++ +Characteristic++++++++ Typ http://www.w3.org/2001/XMLSchema#string + ++++ +Beispiel+NSF+++ +Optional++ Ja+++ +Im Payload++ Ja+++ +Payload Schlüssel+otherOperatorName+++ +Referenz+++-
+
- https://wbcsd.github.io/introduction/ +
+ Third party licenses + ++ +defaultAdminShell +defaultAsset +SealantPass +APPLICATION_CLASS +urn:bamm:io.catenax.sealant.sealant_pass:1.0.0#SealantPass +DocumentTitleTrait +urn:bamm:io.catenax.sealant.sealant_pass:1.0.0#documentTitle +Text +urn:bamm:io.catenax.sealant.sealant_pass:1.0.0#documentLocation +LocateCharacteristic +urn:bamm:io.catenax.sealant.sealant_pass:1.0.0#declarationOfConformity +DocumentTitleTrait +urn:bamm:io.catenax.sealant.sealant_pass:1.0.0#documentTitle +Text +urn:bamm:io.catenax.sealant.sealant_pass:1.0.0#documentLocation +LocateCharacteristic +urn:bamm:io.catenax.sealant.sealant_pass:1.0.0#removalProcedure +DocumentTitleTrait +urn:bamm:io.catenax.sealant.sealant_pass:1.0.0#documentTitle +Text +urn:bamm:io.catenax.sealant.sealant_pass:1.0.0#documentLocation +LocateCharacteristic +urn:bamm:io.catenax.sealant.sealant_pass:1.0.0#dueDiligence +DocumentTitleTrait +urn:bamm:io.catenax.sealant.sealant_pass:1.0.0#documentTitle +Text +urn:bamm:io.catenax.sealant.sealant_pass:1.0.0#documentLocation +LocateCharacteristic +urn:bamm:io.catenax.sealant.sealant_pass:1.0.0#technicalDocumentation +Language +urn:bamm:io.catenax.sealant.sealant_pass:1.0.0#documentLanguage +DocumentVersionCharacteristic +urn:bamm:io.catenax.sealant.sealant_pass:1.0.0#documentVersion +ProvisioningCountryTrait +urn:bamm:io.catenax.sealant.sealant_pass:1.0.0#provisioningCountry +Text +urn:bamm:io.catenax.sealant.sealant_pass:1.0.0#documentLocation +Text +urn:bamm:io.catenax.sealant.sealant_pass:1.0.0#indicationChanges +Text +urn:bamm:io.catenax.sealant.sealant_pass:1.0.0#authorSDS +OtherInformationCharacteristic +urn:bamm:io.catenax.sealant.sealant_pass:1.0.0#otherInformation +Text +urn:bamm:io.catenax.sealant.sealant_pass:1.0.0#manufactureId +SpecificsSDSCharacteristic +urn:bamm:io.catenax.sealant.sealant_pass:1.0.0#safetyDataSheet +DocumentTitleTrait +urn:bamm:io.catenax.sealant.sealant_pass:1.0.0#documentTitle +Text +urn:bamm:io.catenax.sealant.sealant_pass:1.0.0#documentLocation +LocateCharacteristic +urn:bamm:io.catenax.sealant.sealant_pass:1.0.0#sustainabilityReport +Document +urn:bamm:io.catenax.sealant.sealant_pass:1.0.0#documents +CuringTime +urn:bamm:io.catenax.sealant.sealant_pass:1.0.0#curingTime +PerformanceCharacteristic +urn:bamm:io.catenax.sealant.sealant_pass:1.0.0#performanceProperties +Text +urn:bamm:io.catenax.sealant.sealant_pass:1.0.0#tradeName +Text +urn:bamm:io.catenax.sealant.sealant_pass:1.0.0#productCode +ReachRegistrationTrait +urn:bamm:io.catenax.sealant.sealant_pass:1.0.0#reachRegistration +KeyCharacteristic +urn:bamm:io.catenax.serial_part_typization:2.0.0#key +ValueCharacteristic +urn:bamm:io.catenax.serial_part_typization:2.0.0#value +LocalIdentifierCharacteristic +urn:bamm:io.catenax.sealant.sealant_pass:1.0.0#localIdentifiers +Text +urn:bamm:io.catenax.sealant.sealant_pass:1.0.0#substanceName +CasNumberTrait +urn:bamm:io.catenax.sealant.sealant_pass:1.0.0#casNumber +EcNumberTrait +urn:bamm:io.catenax.sealant.sealant_pass:1.0.0#ecNumber +IndexNumberTrait +urn:bamm:io.catenax.sealant.sealant_pass:1.0.0#indexNumber +ProductIdentificationCharacteristic +urn:bamm:io.catenax.sealant.sealant_pass:1.0.0#productIdentification +Text +urn:bamm:io.catenax.sealant.sealant_pass:1.0.0#usage +Text +urn:bamm:io.catenax.sealant.sealant_pass:1.0.0#recommendedUse +ApplicationCharacteristic +urn:bamm:io.catenax.sealant.sealant_pass:1.0.0#application +UsageTrait +urn:bamm:io.catenax.sealant.sealant_pass:1.0.0#emergencyNumber +Text +urn:bamm:io.catenax.sealant.sealant_pass:1.0.0#supplierId +SupplierCharacteristic +urn:bamm:io.catenax.sealant.sealant_pass:1.0.0#supplier +Text +urn:bamm:io.catenax.sealant.sealant_pass:1.0.0#classificationGHS +Text +urn:bamm:io.catenax.sealant.sealant_pass:1.0.0#possibleHazards +Text +urn:bamm:io.catenax.sealant.sealant_pass:1.0.0#chemicalName +ChemicalPercentageTrait +urn:bamm:io.catenax.sealant.sealant_pass:1.0.0#chemicalPercentage +ListOfIngredients +urn:bamm:io.catenax.sealant.sealant_pass:1.0.0#hazardousIngredients +HazardsIdentification +urn:bamm:io.catenax.sealant.sealant_pass:1.0.0#hazardsIdentification +Text +urn:bamm:io.catenax.sealant.sealant_pass:1.0.0#chemicalName +ChemicalPercentageTrait +urn:bamm:io.catenax.sealant.sealant_pass:1.0.0#chemicalPercentage +ListOfIngredients +urn:bamm:io.catenax.sealant.sealant_pass:1.0.0#composition +Text +urn:bamm:io.catenax.sealant.sealant_pass:1.0.0#chemicalNature +ChemicalComposition +urn:bamm:io.catenax.sealant.sealant_pass:1.0.0#substance +Text +urn:bamm:io.catenax.sealant.sealant_pass:1.0.0#chemicalName +ChemicalPercentageTrait +urn:bamm:io.catenax.sealant.sealant_pass:1.0.0#chemicalPercentage +ListOfIngredients +urn:bamm:io.catenax.sealant.sealant_pass:1.0.0#composition +Text +urn:bamm:io.catenax.sealant.sealant_pass:1.0.0#chemicalNature +ChemicalComposition +urn:bamm:io.catenax.sealant.sealant_pass:1.0.0#mixture +ProductComposition +urn:bamm:io.catenax.sealant.sealant_pass:1.0.0#productComposition +Text +urn:bamm:io.catenax.sealant.sealant_pass:1.0.0#firstAid +Text +urn:bamm:io.catenax.sealant.sealant_pass:1.0.0#fireExtinguisher +Text +urn:bamm:io.catenax.sealant.sealant_pass:1.0.0#personalPrecaution +Text +urn:bamm:io.catenax.sealant.sealant_pass:1.0.0#technicalMeasures +Text +urn:bamm:io.catenax.sealant.sealant_pass:1.0.0#chemicalName +ChemicalPercentageTrait +urn:bamm:io.catenax.sealant.sealant_pass:1.0.0#chemicalPercentage +ListOfIngredients +urn:bamm:io.catenax.sealant.sealant_pass:1.0.0#exposureLimit +SafetyMeasureCharacteristic +urn:bamm:io.catenax.sealant.sealant_pass:1.0.0#safetyMeasure +PhysicalState +urn:bamm:io.catenax.sealant.sealant_pass:1.0.0#physicalState +Text +urn:bamm:io.catenax.sealant.sealant_pass:1.0.0#colour +Text +urn:bamm:io.catenax.sealant.sealant_pass:1.0.0#odour +PhCharacteristic +urn:bamm:io.catenax.sealant.sealant_pass:1.0.0#pH +Degree +urn:bamm:io.catenax.sealant.sealant_pass:1.0.0#phaseTransition +Degree +urn:bamm:io.catenax.sealant.sealant_pass:1.0.0#flashPoint +Density +urn:bamm:io.catenax.sealant.sealant_pass:1.0.0#density +Text +urn:bamm:io.catenax.sealant.sealant_pass:1.0.0#reactivity +ProductProperties +urn:bamm:io.catenax.sealant.sealant_pass:1.0.0#productProperties +Text +urn:bamm:io.catenax.sealant.sealant_pass:1.0.0#wasteManagement +Text +urn:bamm:io.catenax.sealant.sealant_pass:1.0.0#wasteInformation +ProductDisposal +urn:bamm:io.catenax.sealant.sealant_pass:1.0.0#productDisposal +Text +urn:bamm:io.catenax.sealant.sealant_pass:1.0.0#unNumber +Text +urn:bamm:io.catenax.sealant.sealant_pass:1.0.0#shippingName +Text +urn:bamm:io.catenax.sealant.sealant_pass:1.0.0#dgClass +Text +urn:bamm:io.catenax.sealant.sealant_pass:1.0.0#dgPack +TransportInformation +urn:bamm:io.catenax.sealant.sealant_pass:1.0.0#transportInformation +Text +urn:bamm:io.catenax.sealant.sealant_pass:1.0.0#limitations +RegulatoryInformationCharacteristic +urn:bamm:io.catenax.sealant.sealant_pass:1.0.0#regulatoryInformation +Co2Total +urn:bamm:io.catenax.sealant.sealant_pass:1.0.0#co2FootprintTotal +CrossSectoralStandardsUsedEnumerationCharacteristic +urn:bamm:io.catenax.pcf:3.0.0#crossSectoralStandard +CrossSectoralStandardsUsedListCharacteristic +urn:bamm:io.catenax.sealant.sealant_pass:1.0.0#crossSectoralStandardsUsed +ProductOrSectorSpecificRuleOperator +urn:bamm:io.catenax.pcf:3.0.0#operator +RuleNamesTrait +urn:bamm:io.catenax.pcf:3.0.0#ruleNames +Text +urn:bamm:io.catenax.pcf:3.0.0#otherOperatorName +ProductOrSectorSpecificRuleSet +urn:bamm:io.catenax.sealant.sealant_pass:1.0.0#productOrSectorSpecificRules +CarbonFootprint +urn:bamm:io.catenax.sealant.sealant_pass:1.0.0#carbonFootprint +SealantPass +Template ++ ++ +urn:bamm:io.catenax.sealant.sealant_pass:1.0.0#SealantPass +DocumentEntity +false +false +declarationOfConformity +false +false +LocateEntity +false +false +documentTitle +Template ++ ++ +urn:bamm:io.catenax.sealant.sealant_pass:1.0.0#documentTitle +DefaultScalarValue[value=Cobald Mine A, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']'] +http://www.w3.org/2001/XMLSchema#string +documentLocation +Template ++ ++ +urn:bamm:io.catenax.sealant.sealant_pass:1.0.0#documentLocation +DefaultScalarValue[value=ftp://www.company.com/MyCompliance/Compliant02.PDF, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']'] +http://www.w3.org/2001/XMLSchema#string +removalProcedure +false +false +LocateEntity +false +false +documentTitle +Template ++ ++ +urn:bamm:io.catenax.sealant.sealant_pass:1.0.0#documentTitle +DefaultScalarValue[value=Cobald Mine A, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']'] +http://www.w3.org/2001/XMLSchema#string +documentLocation +Template ++ ++ +urn:bamm:io.catenax.sealant.sealant_pass:1.0.0#documentLocation +DefaultScalarValue[value=ftp://www.company.com/MyCompliance/Compliant02.PDF, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']'] +http://www.w3.org/2001/XMLSchema#string +dueDiligence +false +false +LocateEntity +false +false +documentTitle +Template ++ ++ +urn:bamm:io.catenax.sealant.sealant_pass:1.0.0#documentTitle +DefaultScalarValue[value=Cobald Mine A, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']'] +http://www.w3.org/2001/XMLSchema#string +documentLocation +Template ++ ++ +urn:bamm:io.catenax.sealant.sealant_pass:1.0.0#documentLocation +DefaultScalarValue[value=ftp://www.company.com/MyCompliance/Compliant02.PDF, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']'] +http://www.w3.org/2001/XMLSchema#string +technicalDocumentation +false +false +LocateEntity +false +false +documentTitle +Template ++ ++ +urn:bamm:io.catenax.sealant.sealant_pass:1.0.0#documentTitle +DefaultScalarValue[value=Cobald Mine A, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']'] +http://www.w3.org/2001/XMLSchema#string +documentLocation +Template ++ ++ +urn:bamm:io.catenax.sealant.sealant_pass:1.0.0#documentLocation +DefaultScalarValue[value=ftp://www.company.com/MyCompliance/Compliant02.PDF, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']'] +http://www.w3.org/2001/XMLSchema#string +safetyDataSheet +false +false +SpecificsSDSEntity +false +false +documentLanguage +Template ++ ++ +urn:bamm:io.catenax.sealant.sealant_pass:1.0.0#documentLanguage +Unknown +http://www.w3.org/2001/XMLSchema#string +documentVersion +Template ++ ++ +urn:bamm:io.catenax.sealant.sealant_pass:1.0.0#documentVersion +Unknown +http://www.w3.org/2001/XMLSchema#string +provisioningCountry +Template ++ ++ +urn:bamm:io.catenax.sealant.sealant_pass:1.0.0#provisioningCountry +DefaultScalarValue[value=GER, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']'] +http://www.w3.org/2001/XMLSchema#string +documentLocation +Template ++ ++ +urn:bamm:io.catenax.sealant.sealant_pass:1.0.0#documentLocation +DefaultScalarValue[value=ftp://www.company.com/MyCompliance/Compliant02.PDF, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']'] +http://www.w3.org/2001/XMLSchema#string +otherInformation +false +false +OtherInformationEntity +false +false +indicationChanges +Template ++ ++ +urn:bamm:io.catenax.sealant.sealant_pass:1.0.0#indicationChanges +DefaultScalarValue[value=Created 1.1.2000, Updated 24.3.2019, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']'] +http://www.w3.org/2001/XMLSchema#string +authorSDS +Template ++ ++ +urn:bamm:io.catenax.sealant.sealant_pass:1.0.0#authorSDS +DefaultScalarValue[value=Max Mustermann, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']'] +http://www.w3.org/2001/XMLSchema#string +manufactureId +Template ++ ++ +urn:bamm:io.catenax.sealant.sealant_pass:1.0.0#manufactureId +DefaultScalarValue[value=BPNL1234567890ZZ, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']'] +http://www.w3.org/2001/XMLSchema#string +sustainabilityReport +false +false +LocateEntity +false +false +documentTitle +Template ++ ++ +urn:bamm:io.catenax.sealant.sealant_pass:1.0.0#documentTitle +DefaultScalarValue[value=Cobald Mine A, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']'] +http://www.w3.org/2001/XMLSchema#string +documentLocation +Template ++ ++ +urn:bamm:io.catenax.sealant.sealant_pass:1.0.0#documentLocation +DefaultScalarValue[value=ftp://www.company.com/MyCompliance/Compliant02.PDF, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']'] +http://www.w3.org/2001/XMLSchema#string +PerformanceEntity +false +false +curingTime +Template ++ ++ +urn:bamm:io.catenax.sealant.sealant_pass:1.0.0#curingTime +Unknown +http://www.w3.org/2001/XMLSchema#float +ProductIdentificationEntity +false +false +tradeName +Template ++ ++ +urn:bamm:io.catenax.sealant.sealant_pass:1.0.0#tradeName +DefaultScalarValue[value=METHYLENEDIPHENYL (4,4'-MDI), typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']'] +http://www.w3.org/2001/XMLSchema#string +productCode +Template ++ ++ +urn:bamm:io.catenax.sealant.sealant_pass:1.0.0#productCode +DefaultScalarValue[value=615-104-00-9-DE, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']'] +http://www.w3.org/2001/XMLSchema#string +reachRegistration +Template ++ ++ +urn:bamm:io.catenax.sealant.sealant_pass:1.0.0#reachRegistration +DefaultScalarValue[value=01-2119457558-25-1234, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']'] +http://www.w3.org/2001/XMLSchema#string +localIdentifiers +false +false +KeyValueList +false +false +key +Template ++ ++ +urn:bamm:io.catenax.serial_part_typization:2.0.0#key +DefaultScalarValue[value=PartInstanceID, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']'] +http://www.w3.org/2001/XMLSchema#string +value +Template ++ ++ +urn:bamm:io.catenax.serial_part_typization:2.0.0#value +DefaultScalarValue[value=SN12345678, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']'] +http://www.w3.org/2001/XMLSchema#string +substanceName +Template ++ ++ +urn:bamm:io.catenax.sealant.sealant_pass:1.0.0#substanceName +DefaultScalarValue[value=Sodium hypochlorite, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']'] +http://www.w3.org/2001/XMLSchema#string +casNumber +Template ++ ++ +urn:bamm:io.catenax.sealant.sealant_pass:1.0.0#casNumber +DefaultScalarValue[value=7681-52-9, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']'] +http://www.w3.org/2001/XMLSchema#string +ecNumber +Template ++ ++ +urn:bamm:io.catenax.sealant.sealant_pass:1.0.0#ecNumber +DefaultScalarValue[value=231-668-3, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']'] +http://www.w3.org/2001/XMLSchema#string +indexNumber +Template ++ ++ +urn:bamm:io.catenax.sealant.sealant_pass:1.0.0#indexNumber +DefaultScalarValue[value=011-002-00-6, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']'] +http://www.w3.org/2001/XMLSchema#string +ApplicationEntity +false +false +usage +Template ++ ++ +urn:bamm:io.catenax.sealant.sealant_pass:1.0.0#usage +DefaultScalarValue[value=Industrial use in polymer production, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']'] +http://www.w3.org/2001/XMLSchema#string +recommendedUse +Template ++ ++ +urn:bamm:io.catenax.sealant.sealant_pass:1.0.0#recommendedUse +DefaultScalarValue[value=Detergent, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']'] +http://www.w3.org/2001/XMLSchema#string +SupplierEntity +false +false +emergencyNumber +Template ++ ++ +urn:bamm:io.catenax.sealant.sealant_pass:1.0.0#emergencyNumber +DefaultScalarValue[value=+49 696 43508409, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']'] +http://www.w3.org/2001/XMLSchema#string +supplierId +Template ++ ++ +urn:bamm:io.catenax.sealant.sealant_pass:1.0.0#supplierId +DefaultScalarValue[value=BPNL1234567890ZZ, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']'] +http://www.w3.org/2001/XMLSchema#string +HazardsIdentificationEntity +false +false +classificationGHS +Template ++ ++ +urn:bamm:io.catenax.sealant.sealant_pass:1.0.0#classificationGHS +DefaultScalarValue[value=Flam. Liq. 2, H225, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']'] +http://www.w3.org/2001/XMLSchema#string +possibleHazards +Template ++ ++ +urn:bamm:io.catenax.sealant.sealant_pass:1.0.0#possibleHazards +DefaultScalarValue[value=Biohazard toxic to fish., typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']'] +http://www.w3.org/2001/XMLSchema#string +hazardousIngredients +false +false +IngredientsEntity +false +false +chemicalName +Template ++ ++ +urn:bamm:io.catenax.sealant.sealant_pass:1.0.0#chemicalName +DefaultScalarValue[value=Chemical A1, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']'] +http://www.w3.org/2001/XMLSchema#string +chemicalPercentage +Template ++ ++ +urn:bamm:io.catenax.sealant.sealant_pass:1.0.0#chemicalPercentage +DefaultScalarValue[value=32.3%, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']'] +http://www.w3.org/2001/XMLSchema#string +ProductCompositionEntity +false +false +substance +false +false +ChemicalCompositionEntity +false +false +composition +false +false +IngredientsEntity +false +false +chemicalName +Template ++ ++ +urn:bamm:io.catenax.sealant.sealant_pass:1.0.0#chemicalName +DefaultScalarValue[value=Chemical A1, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']'] +http://www.w3.org/2001/XMLSchema#string +chemicalPercentage +Template ++ ++ +urn:bamm:io.catenax.sealant.sealant_pass:1.0.0#chemicalPercentage +DefaultScalarValue[value=32.3%, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']'] +http://www.w3.org/2001/XMLSchema#string +chemicalNature +Template ++ ++ +urn:bamm:io.catenax.sealant.sealant_pass:1.0.0#chemicalNature +DefaultScalarValue[value=Mono constituent, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']'] +http://www.w3.org/2001/XMLSchema#string +mixture +false +false +ChemicalCompositionEntity +false +false +composition +false +false +IngredientsEntity +false +false +chemicalName +Template ++ ++ +urn:bamm:io.catenax.sealant.sealant_pass:1.0.0#chemicalName +DefaultScalarValue[value=Chemical A1, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']'] +http://www.w3.org/2001/XMLSchema#string +chemicalPercentage +Template ++ ++ +urn:bamm:io.catenax.sealant.sealant_pass:1.0.0#chemicalPercentage +DefaultScalarValue[value=32.3%, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']'] +http://www.w3.org/2001/XMLSchema#string +chemicalNature +Template ++ ++ +urn:bamm:io.catenax.sealant.sealant_pass:1.0.0#chemicalNature +DefaultScalarValue[value=Mono constituent, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']'] +http://www.w3.org/2001/XMLSchema#string +SafetyMeasureEntity +false +false +firstAid +Template ++ ++ +urn:bamm:io.catenax.sealant.sealant_pass:1.0.0#firstAid +DefaultScalarValue[value=(a) immediate medical attention is required and if delayed effects can be expected after exposure., typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']'] +http://www.w3.org/2001/XMLSchema#string +fireExtinguisher +Template ++ ++ +urn:bamm:io.catenax.sealant.sealant_pass:1.0.0#fireExtinguisher +DefaultScalarValue[value=High volume water jet, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']'] +http://www.w3.org/2001/XMLSchema#string +personalPrecaution +Template ++ ++ +urn:bamm:io.catenax.sealant.sealant_pass:1.0.0#personalPrecaution +DefaultScalarValue[value=Use personal protective equipment. Ensure adequate ventilation., typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']'] +http://www.w3.org/2001/XMLSchema#string +technicalMeasures +Template ++ ++ +urn:bamm:io.catenax.sealant.sealant_pass:1.0.0#technicalMeasures +DefaultScalarValue[value=Never contact with water or moisture. Avoid formation of aerosol., typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']'] +http://www.w3.org/2001/XMLSchema#string +exposureLimit +false +false +IngredientsEntity +false +false +chemicalName +Template ++ ++ +urn:bamm:io.catenax.sealant.sealant_pass:1.0.0#chemicalName +DefaultScalarValue[value=Chemical A1, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']'] +http://www.w3.org/2001/XMLSchema#string +chemicalPercentage +Template ++ ++ +urn:bamm:io.catenax.sealant.sealant_pass:1.0.0#chemicalPercentage +DefaultScalarValue[value=32.3%, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']'] +http://www.w3.org/2001/XMLSchema#string +ProductPropertyEntity +false +false +physicalState +Template ++ ++ +urn:bamm:io.catenax.sealant.sealant_pass:1.0.0#physicalState +DefaultScalarValue[value=liquid, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']'] +http://www.w3.org/2001/XMLSchema#string +colour +Template ++ ++ +urn:bamm:io.catenax.sealant.sealant_pass:1.0.0#colour +DefaultScalarValue[value=black, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']'] +http://www.w3.org/2001/XMLSchema#string +odour +Template ++ ++ +urn:bamm:io.catenax.sealant.sealant_pass:1.0.0#odour +DefaultScalarValue[value=none, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']'] +http://www.w3.org/2001/XMLSchema#string +pH +Template ++ ++ +urn:bamm:io.catenax.sealant.sealant_pass:1.0.0#pH +DefaultScalarValue[value=5, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#integer']'] +http://www.w3.org/2001/XMLSchema#integer +phaseTransition +Template ++ ++ +urn:bamm:io.catenax.sealant.sealant_pass:1.0.0#phaseTransition +DefaultScalarValue[value=80.0, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#decimal']'] +http://www.w3.org/2001/XMLSchema#decimal +flashPoint +Template ++ ++ +urn:bamm:io.catenax.sealant.sealant_pass:1.0.0#flashPoint +DefaultScalarValue[value=21.0, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#decimal']'] +http://www.w3.org/2001/XMLSchema#decimal +density +Template ++ ++ +urn:bamm:io.catenax.sealant.sealant_pass:1.0.0#density +DefaultScalarValue[value=1.15, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#decimal']'] +http://www.w3.org/2001/XMLSchema#decimal +reactivity +Template ++ ++ +urn:bamm:io.catenax.sealant.sealant_pass:1.0.0#reactivity +DefaultScalarValue[value=Vapors may form explosive mixture with air., typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']'] +http://www.w3.org/2001/XMLSchema#string +ProductDisposalEntity +false +false +wasteManagement +Template ++ ++ +urn:bamm:io.catenax.sealant.sealant_pass:1.0.0#wasteManagement +DefaultScalarValue[value=Contact waste disposal services., typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']'] +http://www.w3.org/2001/XMLSchema#string +wasteInformation +Template ++ ++ +urn:bamm:io.catenax.sealant.sealant_pass:1.0.0#wasteInformation +DefaultScalarValue[value=D003: Reactivity, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']'] +http://www.w3.org/2001/XMLSchema#string +TransportInformationEntity +false +false +unNumber +Template ++ ++ +urn:bamm:io.catenax.sealant.sealant_pass:1.0.0#unNumber +DefaultScalarValue[value=ADR - UN2320, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']'] +http://www.w3.org/2001/XMLSchema#string +shippingName +Template ++ ++ +urn:bamm:io.catenax.sealant.sealant_pass:1.0.0#shippingName +DefaultScalarValue[value=ADR - TETRAETHYLENEPENTAMINE, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']'] +http://www.w3.org/2001/XMLSchema#string +dgClass +Template ++ ++ +urn:bamm:io.catenax.sealant.sealant_pass:1.0.0#dgClass +DefaultScalarValue[value=ADR - 8, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']'] +http://www.w3.org/2001/XMLSchema#string +dgPack +Template ++ ++ +urn:bamm:io.catenax.sealant.sealant_pass:1.0.0#dgPack +DefaultScalarValue[value=ADR - III, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']'] +http://www.w3.org/2001/XMLSchema#string +RegulatoryInformationEntity +false +false +limitations +Template ++ ++ +urn:bamm:io.catenax.sealant.sealant_pass:1.0.0#limitations +DefaultScalarValue[value=Regulation (EC) No 1005/2009, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']'] +http://www.w3.org/2001/XMLSchema#string +CarbonFootprintEntity +false +false +co2FootprintTotal +Template ++ ++ +urn:bamm:io.catenax.sealant.sealant_pass:1.0.0#co2FootprintTotal +DefaultScalarValue[value=2.2, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#decimal']'] +http://www.w3.org/2001/XMLSchema#decimal +crossSectoralStandardsUsed +false +true +CrossSectoralStandardEntity +false +false +crossSectoralStandard +Template ++ ++ +urn:bamm:io.catenax.pcf:3.0.0#crossSectoralStandard +Unknown +http://www.w3.org/2001/XMLSchema#string +productOrSectorSpecificRules +false +false +ProductOrSectorSpecificRulesEntity +false +false +operator +Template ++ ++ +urn:bamm:io.catenax.pcf:3.0.0#operator +Unknown +http://www.w3.org/2001/XMLSchema#string +ruleNames +Template ++ ++ +urn:bamm:io.catenax.pcf:3.0.0#ruleNames +DefaultScalarValue[value=ABC 2021, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']'] +http://www.w3.org/2001/XMLSchema#string +otherOperatorName +Template ++ ++ +urn:bamm:io.catenax.pcf:3.0.0#otherOperatorName +DefaultScalarValue[value=NSF, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']'] +http://www.w3.org/2001/XMLSchema#string +Dokumentation Sealant Pass + + ++ + +++++Aspect Model Sealant Pass
+urn:bamm:io.catenax.sealant.sealant_pass:1.0.0#SealantPass++ +++ + + + ++ The Sealant Passport represents the needs from manufacturers of chemical substance and mixtures. It describes data required by the safety data sheet (SDS) - which is based on the REACH Regulation No 1907/2006 in the format of a DPP. ++ + +++Übersicht
+++ + +++++
+ ++ + + +++ +Properties
++ ++++ +Relevant identified uses of the substance or mixture and uses advised against. + +Application
+++ + + +Name+application+++ + +Characteristic+++++++ +SingleEntity+++ +Optional++ Nein+++ +Im Payload++ Ja+++ + +Payload Schlüssel+application++ ++++ +Describes the carbon footprint of the substance or mixture based on the Ecodesign. + +Carbon Footprint
+++ + + +Name+carbonFootprint+++ + +Characteristic+++++++ +SingleEntity+++ +Optional++ Nein+++ +Im Payload++ Ja+++ +Payload Schlüssel+carbonFootprint+++ +Referenz+++-
+
- https://commission.europa.eu/energy-climate-change-environment/standards-tools-and-labels/products-labelling-rules-and-requirements/sustainable-products/ecodesign-sustainable-products_en +
+ ++++ +Set of documents containing the description of components. + +Documents
+++ + + +Name+documents+++ + +Characteristic+++++++SingleEntity+++ ++ Referenz ++++-
+
- https://commission.europa.eu/energy-climate-change-environment/standards-tools-and-labels/products-labelling-rules-and-requirements/sustainable-products/ecodesign-sustainable-products_en +
++ +Optional++ Nein+++ +Im Payload++ Ja+++ + +Payload Schlüssel+documents++ ++++ +Describes the hazards of the substance or mixture and the appropriate warning information associated with those hazards. + +Hazards Identification
+++ + + +Name+hazardsIdentification+++ + +Characteristic+++++++ +SingleEntity+++ +Optional++ Nein+++ +Im Payload++ Ja+++ + +Payload Schlüssel+hazardsIdentification++ ++++ +Describes the performance and durability of a substance or mixture. + +Performance Properties
+++ + + +Name+performanceProperties+++ + +Characteristic+++++++ +SingleEntity+++ +Optional++ Nein+++ +Im Payload++ Ja+++ + +Payload Schlüssel+performanceProperties++ ++++ +Information on the ingredients. + +Product Composition
+++ + + +Name+productComposition+++ + +Characteristic+++++++ +SingleEntity+++ +Optional++ Nein+++ +Im Payload++ Ja+++ + +Payload Schlüssel+productComposition++ ++++ +Describes the proper disposal of the product. + +Product Disposal
+++ + + +Name+productDisposal+++ + +Characteristic+++++++ +SingleEntity+++ +Optional++ Nein+++ +Im Payload++ Ja+++ + +Payload Schlüssel+productDisposal++ ++++ +Identification of the substance/mixture and of the company/undertaking. + +Product Identification
+++ + + +Name+productIdentification+++ + +Characteristic+++++++ +SingleEntity+++ +Optional++ Nein+++ +Im Payload++ Ja+++ + +Payload Schlüssel+productIdentification++ ++++ +Describes the physical and chemical properties of the substance or mixture. + +Product Properties
+++ + + +Name+productProperties+++ + +Characteristic+++++++ +SingleEntity+++ +Optional++ Nein+++ +Im Payload++ Ja+++ + +Payload Schlüssel+productProperties++ ++++ +Describes the regulatory data points. + +Regulatory Information
+++ + + +Name+regulatoryInformation+++ + +Characteristic+++++++ +SingleEntity+++ +Optional++ Nein+++ +Im Payload++ Ja+++ + +Payload Schlüssel+regulatoryInformation++ ++++ +Describes measures related to the safe handling of the mixtures and substances. + +Safety Measure
+++ + + +Name+safetyMeasure+++ + +Characteristic+++++++ +SingleEntity+++ +Optional++ Nein+++ +Im Payload++ Ja+++ + +Payload Schlüssel+safetyMeasure++ ++++ +Supplier of the mixture or substance. + +Supplier
+++ + + +Name+supplier+++ + +Characteristic+++++++ +SingleEntity+++ +Optional++ Nein+++ +Im Payload++ Ja+++ + +Payload Schlüssel+supplier++ ++++ +Describes transport relevant information. + +Transport Information
+++ + + +Name+transportInformation+++ + +Characteristic+++++++ +SingleEntity+++ +Optional++ Nein+++ +Im Payload++ Ja+++ + +Payload Schlüssel+transportInformation++++ +Objekt
+++++Application Entity
++ Entity encapsulating the substance or mixtures application. ++ +++Properties
++ ++++ +Brief description of the identified uses of the substance or mixture relevant for the recipient(s). + +Usage
+++ + + +Name+usage+++ +Characteristic++++++++ Typ http://www.w3.org/2001/XMLSchema#string + ++++ +Beispiel+Industrial use in polymer production+++ +Optional++ Nein+++ +Im Payload++ Ja+++ + +Payload Schlüssel+usage++ ++++ +Recommended restrictions on use + +Recommended Use
+++ + + +Name+recommendedUse+++ +Characteristic++++++++ Typ http://www.w3.org/2001/XMLSchema#string + ++++ +Beispiel+Detergent+++ +Optional++ Nein+++ +Im Payload++ Ja+++ + +Payload Schlüssel+recommendedUse+++++Carbon Footprint Entity
++ Entity encapsulating the carbon footprint. ++ +++Properties
++ ++++ +The total carbon footprint, calculated as kg of carbon dioxide equivalent. + +CO2 Footprint Total
+++ + + +Name+co2FootprintTotal+++ +Characteristic+++++++Measurement+++Describes the amount of kg of the CO2 equivalent.+++Einheit+++++-
+
- + kilogram + +
- + Symbol kg + +
- + Code KGM + +
+++ Typ http://www.w3.org/2001/XMLSchema#decimal + ++++ +Beispiel+2.2+++ +Optional++ Nein+++ +Im Payload++ Ja+++ + +Payload Schlüssel+co2FootprintTotal++ ++++ +Discloses the cross-sectoral standards applied for calculating or allocating GHG (Greenhouse Gas) emissions as specified by the WBCSD (World Business Council for Sustainable Development) Pathfinder initiative. + +Cross Sectoral Standards Used
+++ + + +Name+crossSectoralStandardsUsed+++ + +Characteristic+++++++List+++Sortierung+++Erlaubt Duplikate+++ ++ Referenz ++++-
+
- https://wbcsd.github.io/introduction/ +
++ +Optional++ Nein+++ +Im Payload++ Ja+++ +Payload Schlüssel+crossSectoralStandardsUsed+++ +Referenz+++-
+
- https://wbcsd.github.io/introduction/ +
+ ++++ +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. Specified by the WBCSD (World Business Council for Sustainable Development) Pathfinder initiative. + +Product or Sector Specific Rules
+++ + + +Name+productOrSectorSpecificRules+++ + +Characteristic+++++++Set+++Has no order+++Duplicates not allowed+++ ++ Referenz ++++-
+
- https://wbcsd.github.io/introduction/ +
++ +Optional++ Nein+++ +Im Payload++ Ja+++ +Payload Schlüssel+productOrSectorSpecificRules+++ +Referenz+++-
+
- https://wbcsd.github.io/introduction/ +
++++Chemical Composition Entity
++ Entity encapsulating the chemical composition and nature. ++ +++Properties
++ ++++ +Describes the chemical identity of the ingredient(s) of the substance or mixture. + +Composition
+++ + + +Name+composition+++ + +Characteristic+++++++Set+++Has no order+++ +Duplicates not allowed+++ +Optional++ Nein+++ +Im Payload++ Ja+++ + +Payload Schlüssel+composition++ ++++ +Chemical nature of the mixture or substance. + +Chemical Nature
+++ + + +Name+chemicalNature+++ +Characteristic++++++++ Typ http://www.w3.org/2001/XMLSchema#string + ++++ +Beispiel+Mono constituent+++ +Optional++ Nein+++ +Im Payload++ Ja+++ + +Payload Schlüssel+chemicalNature+++++Cross Sectoral Standard Entity
++ Entity for defining an accounting standard used for product carbon footprint calculation as specified by the WBCSD (World Business Council for Sustainable Development) Pathfinder initiative. +++ Referenz ++ +++-
+
- https://wbcsd.github.io/introduction/ +
++Properties
++ ++++ +Discloses a cross-sectoral standard applied for calculating or allocating GHG (Greenhouse Gas) emissions as specified by the WBCSD (World Business Council for Sustainable Development) Pathfinder initiative. + +Cross Sectoral Standard
+++ + + +Name+crossSectoralStandard+++ + +Characteristic+++++++Enumeration+++Werte+++++-
+
- GHG Protocol Product standard +
- ISO Standard 14067 +
- ISO Standard 14044 +
+++ Referenz ++++-
+
- https://wbcsd.github.io/introduction/ +
+++ Typ http://www.w3.org/2001/XMLSchema#string + ++++ +Optional++ Nein+++ +Im Payload++ Ja+++ +Payload Schlüssel+crossSectoralStandard+++ +Referenz+++-
+
- https://wbcsd.github.io/introduction/ +
++++Document Entity
++ Entity encapsulating the details of a attachment for the chemical substances and mixtures of the pass. ++ +++Properties
++ ++++ +Declaration of conformity (CE) is describing a regulatory requirement from the EU. + +Declaration of Conformity
+++ + + +Name+declarationOfConformity+++ + +Characteristic+++++++Set+++Has no order+++ +Duplicates not allowed+++ +Optional++ Ja+++ +Im Payload++ Ja+++ + +Payload Schlüssel+declarationOfConformity++ ++++ +The documents explain the removal and possible recycling options of the product. + +Removal Procedure
+++ + + +Name+removalProcedure+++ + +Characteristic+++++++Set+++Has no order+++ +Duplicates not allowed+++ +Optional++ Ja+++ +Im Payload++ Ja+++ + +Payload Schlüssel+removalProcedure++ ++++ +Report on supply chain due diligence policies. Link to document or website on its supply chain due diligence policies. + +Due Diligence
+++ + + +Name+dueDiligence+++ + +Characteristic+++++++Set+++Has no order+++ +Duplicates not allowed+++ +Optional++ Ja+++ +Im Payload++ Ja+++ + +Payload Schlüssel+dueDiligence++ ++++ +Technical documentation refers to documents that explain the use, functionality, creation, or architecture of the product. + +Technical Documentation
+++ + + +Name+technicalDocumentation+++ + +Characteristic+++++++Set+++Has no order+++ +Duplicates not allowed+++ +Optional++ Ja+++ +Im Payload++ Ja+++ + +Payload Schlüssel+technicalDocumentation++ ++++ +A link to the full seafty data sheet of the material. A link to a SDS might be provided for several countries and possibly multiple languages for each country. The table includes: version, country name, language of the document and the link to the document. The documents should preferably be provided as PDF or Word document. + +Full Safety Data Sheet (SDS)
+++ + + +Name+safetyDataSheet+++ + +Characteristic+++++++Set+++Has no order+++ +Duplicates not allowed+++ +Optional++ Nein+++ +Im Payload++ Ja+++ + +Payload Schlüssel+safetyDataSheet++ ++++ +Link to public website or document. Reporting in accordance with the new European Sustainability Reporting Standards (ESRS) including the new ESG reporting standards. + +Sustainability Report
+++ + + +Name+sustainabilityReport+++ + +Characteristic+++++++Set+++Has no order+++ +Duplicates not allowed+++ +Optional++ Ja+++ +Im Payload++ Ja+++ + +Payload Schlüssel+sustainabilityReport+++++Hazards Identification Entity
++ Entity encapsulating the hazards on a substance or mixture. ++ +++Properties
++ ++++ +The classification of the substance or the mixture which results from the application of the classification criteria in Regulation (EC) No 1272/2008 shall be given. + +Classification GHS
+++ + + +Name+classificationGHS+++ +Characteristic++++++++ Typ http://www.w3.org/2001/XMLSchema#string + ++++ +Beispiel+Flam. Liq. 2, H225+++ +Optional++ Nein+++ +Im Payload++ Ja+++ + +Payload Schlüssel+classificationGHS++ ++++ +A description of the various toxicological (health) effects and the available data used to identify those effects (SDS Section 11.1). + +Possible Hazards
+++ + + +Name+possibleHazards+++ +Characteristic++++++++ Typ http://www.w3.org/2001/XMLSchema#string + ++++ +Beispiel+Biohazard toxic to fish.+++ +Optional++ Nein+++ +Im Payload++ Ja+++ + +Payload Schlüssel+possibleHazards++ ++++ +Ingredients classified as hazardous (SDS Section 12.1). + +Hazardous Ingredients
+++ + + +Name+hazardousIngredients+++ + +Characteristic+++++++Set+++Has no order+++ +Duplicates not allowed+++ +Optional++ Nein+++ +Im Payload++ Ja+++ + +Payload Schlüssel+hazardousIngredients++++Ingredients Entity
++ Entity encapsulating the ingredients. ++ +++Properties
++ ++++ +Name of the chemical. + +Chemical Name
+++ + + +Name+chemicalName+++ +Characteristic++++++++ Typ http://www.w3.org/2001/XMLSchema#string + ++++ +Beispiel+Chemical A1+++ +Optional++ Nein+++ +Im Payload++ Ja+++ + +Payload Schlüssel+chemicalName++ ++++ +Describes chemical distribution in percentage. It can include a percentage range. Either 10% or 5,5%-6% . Allowed are decimal values with a "," separator. Mandatory are no spaces between the values and the percentage character. + +Chemical Percentage
+++ + + +Name+chemicalPercentage+++ +Characteristic+++++++Trait++++ Typ http://www.w3.org/2001/XMLSchema#string + ++++ +Beispiel+32.3%+++ +Optional++ Nein+++ +Im Payload++ Ja+++ + +Payload Schlüssel+chemicalPercentage+++Bedingungen+++-
+
-
++ +++ Chemical Distribution Constraint ++ +++ + +Beschreibung+Describes chemical distribution in percentage. It can include a percentage range. Either 10% or 5.5%-6% . Allowed are decimal values with a dot as separator. Mandatory are no spaces between the values and the percentage character.+++ + + +Regulärer Ausdruck+^\d{1,2}(\.\d{0,2})?%(-\d{1,2}(\.\d{0,2})?%)?$+
++++Key Value List
++ A list of key value pairs for local identifiers, which are composed of a key and a corresponding value. ++ +++Properties
++ ++++ +The key of a local identifier. + +Identifier Key
+++ + + +Name+key+++ +Characteristic++++++++ Typ http://www.w3.org/2001/XMLSchema#string + ++++ +Beispiel+PartInstanceID+++ +Optional++ Nein+++ +Im Payload++ Ja+++ + +Payload Schlüssel+key++ ++++ +The value of an identifier. + +Identifier Value
+++ + + +Name+value+++ +Characteristic++++++++ Typ http://www.w3.org/2001/XMLSchema#string + ++++ +Beispiel+SN12345678+++ +Optional++ Nein+++ +Im Payload++ Ja+++ + +Payload Schlüssel+value++++Locate Entity
++ Entity encapsulating the details from the documents title and location. ++ +++Properties
++ ++++ +The header or title of the document. + +Document Title
+++ + + +Name+documentTitle+++ +Characteristic+++++++Trait++++ Typ http://www.w3.org/2001/XMLSchema#string + ++++ +Beispiel+Cobald Mine A+++ +Optional++ Nein+++ +Im Payload++ Ja+++ + +Payload Schlüssel+documentTitle+++Bedingungen+++-
+
-
++ +++ Max Title Character Constraint ++ +++ + +Beschreibung+Maximum title characters set to 60.+++Min. Zeichen+0+++ + + +Max. Zeichen+60+
+ ++++ +Location or link of and to the document. + +Document Location
+++ + + +Name+documentLocation+++ +Characteristic++++++++ Typ http://www.w3.org/2001/XMLSchema#string + ++++ +Beispiel+ftp://www.company.com/MyCompliance/Compliant02.PDF+++ +Optional++ Nein+++ +Im Payload++ Ja+++ + +Payload Schlüssel+documentLocation+++++Other iInformation Entity
++ Entity encapsulating the required information. ++ +++Properties
++ ++++ +in the case of a revised safety data sheet (SDS), a clear indication of where changes have been made to the previous version of the safety data sheet (SDS). + +Indication Changes
+++ + + +Name+indicationChanges+++ +Characteristic++++++++ Typ http://www.w3.org/2001/XMLSchema#string + ++++ +Beispiel+Created 1.1.2000, Updated 24.3.2019+++ +Optional++ Nein+++ +Im Payload++ Ja+++ + +Payload Schlüssel+indicationChanges++ ++++ +safety data sheet (SDS) author changing the document. + +Author SDS
+++ + + +Name+authorSDS+++ +Characteristic++++++++ Typ http://www.w3.org/2001/XMLSchema#string + ++++ +Beispiel+Max Mustermann+++ +Optional++ Nein+++ +Im Payload++ Ja+++ + +Payload Schlüssel+authorSDS+++++Performance Entity
++ Entity encapsulating the measures of the performance and durability. ++ +++Properties
++ ++++ +Cure time is the time that determines how long it will take for the material to fully cure. A number of chemical reactions occur during this time, for the material to harden. It can take a long time for a material to fully cure. + +Curing Time
+++ + + +Name+curingTime+++ + +Characteristic+++++++Duration+++Time in seconds needed for the curing of the substance or mixture.+++Einheit+++++-
+
- + second [unit of time] + +
- + Symbol s + +
- + Code SEC + +
+++ Typ http://www.w3.org/2001/XMLSchema#float + ++++ +Optional++ Nein+++ +Im Payload++ Ja+++ + +Payload Schlüssel+curingTime+++++Product Composition Entity
++ Entity encapsulating the product composition information. ++ +++Properties
++ ++++ +Property to describes a substance. + +Substance
+++ + + +Name+substance+++ + +Characteristic+++++++Set+++Has no order+++ +Duplicates not allowed+++ +Optional++ Nein+++ +Im Payload++ Ja+++ + +Payload Schlüssel+substance++ ++++ +Property to describes the mixture. + +Mixture
+++ + + +Name+mixture+++ + +Characteristic+++++++Set+++Has no order+++ +Duplicates not allowed+++ +Optional++ Nein+++ +Im Payload++ Ja+++ + +Payload Schlüssel+mixture+++++Product Disposal Entity
++ Entity encapsulating the information needed for the product disposal. ++ +++Properties
++ ++++ +Waste management of the substance or mixture and/or its container to assist in the determination of safe and environmentally preferred waste management options. + +Waste Management
+++ + + +Name+wasteManagement+++ +Characteristic++++++++ Typ http://www.w3.org/2001/XMLSchema#string + ++++ +Beispiel+Contact waste disposal services.+++ +Optional++ Nein+++ +Im Payload++ Ja+++ + +Payload Schlüssel+wasteManagement++ ++++ +Waste treatment-relevant information. + +Waste Information
+++ + + +Name+wasteInformation+++ +Characteristic++++++++ Typ http://www.w3.org/2001/XMLSchema#string + ++++ +Beispiel+D003: Reactivity+++ +Optional++ Nein+++ +Im Payload++ Ja+++ + +Payload Schlüssel+wasteInformation++++Product Identification Entity
++ Entity encapsulating the product identification. ++ +++Properties
++ ++++ +Trade name given to the chemical substance or mixture as part of the product identification. + +Trade Name
+++ + + +Name+tradeName+++ +Characteristic++++++++ Typ http://www.w3.org/2001/XMLSchema#string + ++++ +Beispiel+METHYLENEDIPHENYL (4,4'-MDI)+++ +Optional++ Nein+++ +Im Payload++ Ja+++ + +Payload Schlüssel+tradeName++ ++++ +Product Code given to the Substance/mixture as part of the product identification. + +Product Code
+++ + + +Name+productCode+++ +Characteristic++++++++ Typ http://www.w3.org/2001/XMLSchema#string + ++++ +Beispiel+615-104-00-9-DE+++ +Optional++ Nein+++ +Im Payload++ Ja+++ + +Payload Schlüssel+productCode++ +++ +A REACH registration number is an 18-digit number assigned by the European Chemicals Agency (ECHA). + +Reach Registration
+++ + + +Name+reachRegistration+++ +Characteristic+++++++Trait++++ Typ http://www.w3.org/2001/XMLSchema#string + ++++ +Beispiel+01-2119457558-25-1234+++ +Optional++ Nein+++ +Im Payload++ Ja+++ + +Payload Schlüssel+reachRegistration+++Bedingungen+++-
+
-
++ +++ Reach Registration Regex ++ +++ + +Beschreibung+Describes the regex expression for the Reach Registration number. Constraints the value to two digits followed by an - followed by ten digits followed by an - followed by two digits followed by an - and four digits.+++ + + +Regulärer Ausdruck+^\d{2}-\d{10}-\d{2}-\d{4}$+
+ ++++ +A local identifier enables identification of a part in a specific data space, but is not unique in Catena-X data space. Multiple local identifiers may exist. + +Local Identifiers
+++ + + +Name+localIdentifiers+++ + +Characteristic+++++++Set+++Has no order+++ +Duplicates not allowed+++ +Optional++ Nein+++ +Im Payload++ Ja+++ + +Payload Schlüssel+localIdentifiers++ ++++ +Name given to the substance. + +Substance Name
+++ + + +Name+substanceName+++ +Characteristic++++++++ Typ http://www.w3.org/2001/XMLSchema#string + ++++ +Beispiel+Sodium hypochlorite+++ +Optional++ Ja+++ +Im Payload++ Ja+++ + +Payload Schlüssel+substanceName++ +++ +A CAS registry number is a unique identification number assigned by the Chemical Abstracts Service (CAS). + +CAS Number
+++ + + +Name+casNumber+++ +Characteristic+++++++Trait++++ Typ http://www.w3.org/2001/XMLSchema#string + ++++ +Beispiel+7681-52-9+++ +Optional++ Nein+++ +Im Payload++ Ja+++ + +Payload Schlüssel+casNumber+++Bedingungen+++-
+
-
++ +++ CAS Number Constraint ++ +++ + +Beschreibung+Describes the Regex expression for the CAS number. Constraints the value to four digits followed by an - followed by two digits followed by an - and one digit.+++ + + +Regulärer Ausdruck+^\d{4}-\d{2}-\d$+
+ +++ +The European Commission number (EC number), is the code assigned to chemical substances that are commercially available within the European Union. + +EC Number
+++ + + +Name+ecNumber+++ +Characteristic+++++++Trait++++ Typ http://www.w3.org/2001/XMLSchema#string + ++++ +Beispiel+231-668-3+++ +Optional++ Ja+++ +Im Payload++ Ja+++ +Payload Schlüssel+ecNumber+++ +Referenz+++-
+
- https://echa.europa.eu/de/information-on-chemicals/ec-inventory +
++Bedingungen+++-
+
-
++ +++ EC Number Regex ++ +++ + +Beschreibung+Describes the regex expression for the EC number. Constraints the value to three digits followed by an - followed by three digits followed by an - and one digit.+++ + + +Regulärer Ausdruck+^\d{3}-\d{3}-\d$+
+ ++++ +The index number is used as an identifier. + +Index Number
+++ + + +Name+indexNumber+++ +Characteristic+++++++Trait++++ Typ http://www.w3.org/2001/XMLSchema#string + ++++ +Beispiel+011-002-00-6+++ +Optional++ Ja+++ +Im Payload++ Ja+++ + +Payload Schlüssel+indexNumber+++Bedingungen+++-
+
-
++ +++ Index Number Regex ++ +++ + +Beschreibung+Describes the regex expression for the Index number. Constraints the value to three digits followed by an - followed by three digits followed by an - followed by two digits followed by an - and one digit.+++ + + +Regulärer Ausdruck+^\d{3}-\d{3}-\d{2}-\d$+
+++Product Or Sector Specific Rules Entity
++ Entity for defining the set of values for the product or sector specific rules of a product carbon footprint as specified by the WBCSD (World Business Council for Sustainable Development) Pathfinder initiative. +++ Referenz ++ +++-
+
- https://wbcsd.github.io/introduction/ +
++Properties
++ ++++ +Operator of PCR (Product Category Rule)/ PSR (Product Specific Rule) as specified by the WBCSD (World Business Council for Sustainable Development) Pathfinder initiative. + +Operator or Publisher of Sector Specific Rules
+++ + + +Name+operator+++ + +Characteristic+++++++Enumeration+++Werte+++++-
+
- PEF +
- EPD International +
- Other +
+++ Referenz ++++-
+
- https://wbcsd.github.io/introduction/ +
+++ Typ http://www.w3.org/2001/XMLSchema#string + ++++ +Optional++ Nein+++ +Im Payload++ Ja+++ +Payload Schlüssel+operator+++ +Referenz+++-
+
- https://wbcsd.github.io/introduction/ +
+ ++++ +Product-specific or sector-specific set of rules used for calculating or allocating GHG (Greenhouse Gas) emissions applied from the specified operator. Property defined by the WBCSD (World Business Council for Sustainable Development) Pathfinder initiative. + +Product or Sector Specific Rule Names
+++ + + +Name+ruleNames+++ +Characteristic+++++++Trait++++ Typ http://www.w3.org/2001/XMLSchema#string + ++++ +Beispiel+ABC 2021+++ +Optional++ Nein+++ +Im Payload++ Ja+++ +Payload Schlüssel+ruleNames+++ +Referenz+++-
+
- https://wbcsd.github.io/introduction/ +
++Bedingungen+++-
+
-
++ +++ Rule Names Constraint ++ +++ +Beschreibung+Constraint for defining a non-empty set of non-empty rule names as specified by the WBCSD (World Business Council for Sustainable Development) Pathfinder initiative.+++ +Referenz+++++
-
+
- https://wbcsd.github.io/introduction/ +
++ + + +Min. Zeichen+1+
+ ++++ +Other operator of PCR (Product Category Rule)/ PSR (Product Specific Rule) as specified by the WBCSD (World Business Council for Sustainable Development) Pathfinder initiative. + +Other Operator or Publisher of Sector Specific Rules
+++ + + +Name+otherOperatorName+++ +Characteristic++++++++ Typ http://www.w3.org/2001/XMLSchema#string + ++++ +Beispiel+NSF+++ +Optional++ Ja+++ +Im Payload++ Ja+++ +Payload Schlüssel+otherOperatorName+++ +Referenz+++-
+
- https://wbcsd.github.io/introduction/ +
++++Product Property Entity
++ Entity encapsulating the product properties. ++ +++Properties
++ ++++ +Describes the physical state (gas, liquid or solid) at standard conditions of temperature and pressure. + +Physical State
+++ + + +Name+physicalState+++ +Characteristic+++++++Enumeration+++Werte+++++-
+
- gas +
- liquid +
- solid +
+++ Typ http://www.w3.org/2001/XMLSchema#string + ++++ +Beispiel+liquid+++ +Optional++ Nein+++ +Im Payload++ Ja+++ + +Payload Schlüssel+physicalState++ ++++ +The colour of the substance or mixture as supplied is indicated. + +Colour
+++ + + +Name+colour+++ +Characteristic++++++++ Typ http://www.w3.org/2001/XMLSchema#string + ++++ +Beispiel+black+++ +Optional++ Nein+++ +Im Payload++ Ja+++ + +Payload Schlüssel+colour++ ++++ +A qualitative description of the odour is shown if it is well-known or described in the literature. + +Odour
+++ + + +Name+odour+++ +Characteristic++++++++ Typ http://www.w3.org/2001/XMLSchema#string + ++++ +Beispiel+none+++ +Optional++ Ja+++ +Im Payload++ Ja+++ + +Payload Schlüssel+odour++ ++++ +The pH of the substance or mixture as supplied, or where the product is a solid, the pH of an aqueous liquid or solution at a given concentration, shall be indicated. + +pH
+++ + + +Name+pH+++ +Characteristic++++++++ Typ http://www.w3.org/2001/XMLSchema#integer + ++++ +Beispiel+5+++ +Optional++ Nein+++ +Im Payload++ Ja+++ + +Payload Schlüssel+pH++ ++++ +Phase Transition temperature from liquid to gas. + +Phase Transition
+++ + + +Name+phaseTransition+++ +Characteristic+++++++Measurement+++The temperature in its phase.+++Einheit+++++-
+
- + degree Celsius + +
- + Symbol °C + +
- + Code CEL + +
- + Überführungsfaktor 1 × K + +
+++ Typ http://www.w3.org/2001/XMLSchema#decimal + ++++ +Beispiel+80.0+++ +Optional++ Nein+++ +Im Payload++ Ja+++ + +Payload Schlüssel+phaseTransition++ ++++ +For mixtures, a value for the mixture shall be indicated, if available. Otherwise, the flash point of the substance with the lowest flash point shall be indicated. + +Flash Point
+++ + + +Name+flashPoint+++ +Characteristic+++++++Measurement+++The temperature in its phase.+++Einheit+++++-
+
- + degree Celsius + +
- + Symbol °C + +
- + Code CEL + +
- + Überführungsfaktor 1 × K + +
+++ Typ http://www.w3.org/2001/XMLSchema#decimal + ++++ +Beispiel+21.0+++ +Optional++ Ja+++ +Im Payload++ Ja+++ + +Payload Schlüssel+flashPoint++ ++++ +Density and relative density shall generally be indicated at standard conditions of temperature and pressure. + +Density
+++ + + +Name+density+++ +Characteristic+++++++Measurement+++Describes the density of the product.+++Einheit+++++-
+
- + gram per cubic centimetre + +
- + Symbol g/cm³ + +
- + Code 23 + +
- + Überführungsfaktor 10³ kg/m³ + +
+++ Typ http://www.w3.org/2001/XMLSchema#decimal + ++++ +Beispiel+1.15+++ +Optional++ Nein+++ +Im Payload++ Ja+++ + +Payload Schlüssel+density++ ++++ +Reactivity hazards of the substance or mixtures. + +Reactivity
+++ + + +Name+reactivity+++ +Characteristic++++++++ Typ http://www.w3.org/2001/XMLSchema#string + ++++ +Beispiel+Vapors may form explosive mixture with air.+++ +Optional++ Nein+++ +Im Payload++ Ja+++ + +Payload Schlüssel+reactivity+++++Regulatory Information Entity
++ Entity encapsulating the regulatory information. ++ +++Properties
++ ++++ +Information shall be provided regarding relevant Union safety, health and environmental provisions including the prohibitions and restrictions. + +Limitations
+++ + + +Name+limitations+++ +Characteristic++++++++ Typ http://www.w3.org/2001/XMLSchema#string + ++++ +Beispiel+Regulation (EC) No 1005/2009+++ +Optional++ Nein+++ +Im Payload++ Ja+++ + +Payload Schlüssel+limitations+++++Safety Measure Entity
++ Entity encapsulating the safety measures. ++ +++Properties
++ ++++ +First aid instructions are provided by relevant routes of exposure (SDS Section 4.1). + +First Aid
+++ + + +Name+firstAid+++ +Characteristic++++++++ Typ http://www.w3.org/2001/XMLSchema#string + ++++ +Beispiel+(a) immediate medical attention is required and if delayed effects can be expected after exposure.+++ +Optional++ Nein+++ +Im Payload++ Ja+++ + +Payload Schlüssel+firstAid++ ++++ +Suitable extinguishing media, for fighting a fire caused by the substance or mixture, or arising in its vicinity (SDS Section 5.1). + +Fire Extinguisher
+++ + + +Name+fireExtinguisher+++ +Characteristic++++++++ Typ http://www.w3.org/2001/XMLSchema#string + ++++ +Beispiel+High volume water jet+++ +Optional++ Nein+++ +Im Payload++ Ja+++ + +Payload Schlüssel+fireExtinguisher++ ++++ +Information about the appropriate response to spills, leaks, or releases, to prevent or minimize the adverse effects on persons, property and the environment (SDS Section 6.1). + +Personal Precaution
+++ + + +Name+personalPrecaution+++ +Characteristic++++++++ Typ http://www.w3.org/2001/XMLSchema#string + ++++ +Beispiel+Use personal protective equipment. Ensure adequate ventilation.+++ +Optional++ Nein+++ +Im Payload++ Ja+++ + +Payload Schlüssel+personalPrecaution++ ++++ +Information is provided concerning protective measures for safe handling and recommended technical measures (SDS Section 7.1). + +Technical Measures
+++ + + +Name+technicalMeasures+++ +Characteristic++++++++ Typ http://www.w3.org/2001/XMLSchema#string + ++++ +Beispiel+Never contact with water or moisture. Avoid formation of aerosol.+++ +Optional++ Nein+++ +Im Payload++ Ja+++ + +Payload Schlüssel+technicalMeasures++ ++++ +Information about the applicable exposure limits of the substances and mixtures (SDS Section 8.1). + +Exposure Limit
+++ + + +Name+exposureLimit+++ + +Characteristic+++++++Set+++Has no order+++ +Duplicates not allowed+++ +Optional++ Nein+++ +Im Payload++ Ja+++ + +Payload Schlüssel+exposureLimit+++ + + + + + \ No newline at end of file diff --git a/io.catenax.sealant.sealant_pass/1.0.0/gen/SealantPass.json b/io.catenax.sealant.sealant_pass/1.0.0/gen/SealantPass.json new file mode 100644 index 00000000..88e19f58 --- /dev/null +++ b/io.catenax.sealant.sealant_pass/1.0.0/gen/SealantPass.json @@ -0,0 +1,127 @@ +{ + "productProperties" : { + "colour" : "black", + "phaseTransition" : 80.0, + "reactivity" : "Vapors may form explosive mixture with air.", + "physicalState" : "gas", + "flashPoint" : 21.0, + "density" : 1.15, + "pH" : 5, + "odour" : "none" + }, + "transportInformation" : { + "dgClass" : "ADR - 8", + "dgPack" : "ADR - III", + "shippingName" : "ADR - TETRAETHYLENEPENTAMINE", + "unNumber" : "ADR - UN2320" + }, + "documents" : { + "dueDiligence" : [ { + "documentTitle" : "Cobald Mine A", + "documentLocation" : "ftp://www.company.com/MyCompliance/Compliant02.PDF" + } ], + "technicalDocumentation" : [ { + "documentTitle" : "Cobald Mine A", + "documentLocation" : "ftp://www.company.com/MyCompliance/Compliant02.PDF" + } ], + "removalProcedure" : [ { + "documentTitle" : "Cobald Mine A", + "documentLocation" : "ftp://www.company.com/MyCompliance/Compliant02.PDF" + } ], + "sustainabilityReport" : [ { + "documentTitle" : "Cobald Mine A", + "documentLocation" : "ftp://www.company.com/MyCompliance/Compliant02.PDF" + } ], + "safetyDataSheet" : [ { + "manufactureId" : "BPNL1234567890ZZ", + "documentLanguage" : "eOMtThyhVNLWUZNRcBaQKxI", + "documentLocation" : "ftp://www.company.com/MyCompliance/Compliant02.PDF", + "documentVersion" : "yedUsFwdkelQbxeTeQOvaScfqIOOmaa", + "otherInformation" : [ { + "indicationChanges" : "Created 1.1.2000, Updated 24.3.2019", + "authorSDS" : "Max Mustermann" + } ], + "provisioningCountry" : "GER" + } ], + "declarationOfConformity" : [ { + "documentTitle" : "Cobald Mine A", + "documentLocation" : "ftp://www.company.com/MyCompliance/Compliant02.PDF" + } ] + }, + "carbonFootprint" : { + "crossSectoralStandardsUsed" : [ { + "crossSectoralStandard" : "GHG Protocol Product standard" + } ], + "co2FootprintTotal" : 2.2, + "productOrSectorSpecificRules" : [ { + "operator" : "PEF", + "ruleNames" : "ABC 2021", + "otherOperatorName" : "NSF" + } ] + }, + "productComposition" : { + "mixture" : [ { + "composition" : [ { + "chemicalName" : "Chemical A1", + "chemicalPercentage" : "32.3%" + } ], + "chemicalNature" : "Mono constituent" + } ], + "substance" : [ { + "composition" : [ { + "chemicalName" : "Chemical A1", + "chemicalPercentage" : "32.3%" + } ], + "chemicalNature" : "Mono constituent" + } ] + }, + "productIdentification" : { + "localIdentifiers" : [ { + "value" : "SN12345678", + "key" : "PartInstanceID" + } ], + "tradeName" : "METHYLENEDIPHENYL (4,4'-MDI)", + "productCode" : "615-104-00-9-DE", + "substanceName" : "Sodium hypochlorite", + "ecNumber" : "231-668-3", + "indexNumber" : "011-002-00-6", + "casNumber" : "7681-52-9", + "reachRegistration" : "01-2119457558-25-1234" + }, + "performanceProperties" : { + "curingTime" : -1.0158939E38 + }, + "hazardsIdentification" : { + "hazardousIngredients" : [ { + "chemicalName" : "Chemical A1", + "chemicalPercentage" : "32.3%" + } ], + "classificationGHS" : "Flam. Liq. 2, H225", + "possibleHazards" : "Biohazard toxic to fish." + }, + "regulatoryInformation" : { + "limitations" : "Regulation (EC) No 1005/2009" + }, + "application" : { + "recommendedUse" : "Detergent", + "usage" : "Industrial use in polymer production" + }, + "supplier" : { + "emergencyNumber" : "+49 696 43508409", + "supplierId" : "BPNL1234567890ZZ" + }, + "safetyMeasure" : { + "personalPrecaution" : "Use personal protective equipment. Ensure adequate ventilation.", + "exposureLimit" : [ { + "chemicalName" : "Chemical A1", + "chemicalPercentage" : "32.3%" + } ], + "firstAid" : "(a) immediate medical attention is required and if delayed effects can be expected after exposure.", + "fireExtinguisher" : "High volume water jet", + "technicalMeasures" : "Never contact with water or moisture. Avoid formation of aerosol." + }, + "productDisposal" : { + "wasteManagement" : "Contact waste disposal services.", + "wasteInformation" : "D003: Reactivity" + } +} \ No newline at end of file diff --git a/io.catenax.sealant.sealant_pass/1.0.0/gen/SealantPass.yml b/io.catenax.sealant.sealant_pass/1.0.0/gen/SealantPass.yml new file mode 100644 index 00000000..c32211d9 --- /dev/null +++ b/io.catenax.sealant.sealant_pass/1.0.0/gen/SealantPass.yml @@ -0,0 +1,772 @@ +--- +openapi: 3.0.3 +info: + title: Sealant Pass + version: v1 +servers: +- url: catenax.io/api/v1 + variables: + api-version: + default: v1 +paths: + /{tenant-id}/sealant-pass: + get: + tags: + - SealantPass + operationId: getSealantPass + 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/SealantPass' + "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.sealant.sealant_pass_1.0.0_DocumentTitleTrait: + type: string + description: Maximum title characters set to 60. + maxLength: 60 + minLength: 0 + 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.sealant.sealant_pass_1.0.0_LocateEntity: + description: Entity encapsulating the details from the documents title and location. + type: object + properties: + documentTitle: + description: The header or title of the document. + $ref: '#/components/schemas/urn_bamm_io.catenax.sealant.sealant_pass_1.0.0_DocumentTitleTrait' + documentLocation: + description: Location or link of and to the document. + $ref: '#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text' + required: + - documentTitle + - documentLocation + urn_bamm_io.catenax.sealant.sealant_pass_1.0.0_LocateCharacteristic: + description: Connects the title and location of the document. + type: array + items: + $ref: '#/components/schemas/urn_bamm_io.catenax.sealant.sealant_pass_1.0.0_LocateEntity' + uniqueItems: true + urn_bamm_io.openmanufacturing_characteristic_2.0.0_Language: + type: string + description: "Describes a Property containing a language according to ISO 639-1,\ + \ for example \"de\"." + urn_bamm_io.catenax.sealant.sealant_pass_1.0.0_DocumentVersionCharacteristic: + type: string + description: Refers to the version of the safety data sheet (SDS) document. + urn_bamm_io.catenax.sealant.sealant_pass_1.0.0_ProvisioningCountryTrait: + type: string + description: Length of the text is capped to three letters based on the ISO + 3166 standard. + maxLength: 3 + minLength: 3 + urn_bamm_io.catenax.sealant.sealant_pass_1.0.0_OtherInformationEntity: + description: Entity encapsulating the required information. + type: object + properties: + indicationChanges: + description: "in the case of a revised safety data sheet (SDS), a clear\ + \ indication of where changes have been made to the previous version of\ + \ the safety data sheet (SDS)." + $ref: '#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text' + authorSDS: + description: safety data sheet (SDS) author changing the document. + $ref: '#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text' + required: + - indicationChanges + - authorSDS + urn_bamm_io.catenax.sealant.sealant_pass_1.0.0_OtherInformationCharacteristic: + description: "Describes additional information, in a set of values." + type: array + items: + $ref: '#/components/schemas/urn_bamm_io.catenax.sealant.sealant_pass_1.0.0_OtherInformationEntity' + uniqueItems: true + urn_bamm_io.catenax.sealant.sealant_pass_1.0.0_SpecificsSDSEntity: + description: Entity encapsulating the details from the safety data sheet (SDS) + documentation. + type: object + properties: + documentLanguage: + description: Language of the safety data sheet (SDS) document. + $ref: '#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Language' + documentVersion: + description: Version of the document. + $ref: '#/components/schemas/urn_bamm_io.catenax.sealant.sealant_pass_1.0.0_DocumentVersionCharacteristic' + provisioningCountry: + description: The country from where the documentation is issued from. + $ref: '#/components/schemas/urn_bamm_io.catenax.sealant.sealant_pass_1.0.0_ProvisioningCountryTrait' + documentLocation: + description: Location or link of and to the document. + $ref: '#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text' + otherInformation: + description: Additional information relevant to the safety data sheet (SDS) + document. + $ref: '#/components/schemas/urn_bamm_io.catenax.sealant.sealant_pass_1.0.0_OtherInformationCharacteristic' + manufactureId: + description: Unique BPN number. + $ref: '#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text' + required: + - documentLanguage + - documentVersion + - provisioningCountry + - documentLocation + - otherInformation + - manufactureId + urn_bamm_io.catenax.sealant.sealant_pass_1.0.0_SpecificsSDSCharacteristic: + description: "Connects the safety data sheet (SDS) version, language, and country." + type: array + items: + $ref: '#/components/schemas/urn_bamm_io.catenax.sealant.sealant_pass_1.0.0_SpecificsSDSEntity' + uniqueItems: true + urn_bamm_io.catenax.sealant.sealant_pass_1.0.0_Document: + description: Set of documents containing the description of chemical substances + and mixture components. + type: object + properties: + declarationOfConformity: + description: Declaration of conformity (CE) is describing a regulatory requirement + from the EU. + $ref: '#/components/schemas/urn_bamm_io.catenax.sealant.sealant_pass_1.0.0_LocateCharacteristic' + removalProcedure: + description: The documents explain the removal and possible recycling options + of the product. + $ref: '#/components/schemas/urn_bamm_io.catenax.sealant.sealant_pass_1.0.0_LocateCharacteristic' + dueDiligence: + description: Report on supply chain due diligence policies. Link to document + or website on its supply chain due diligence policies. + $ref: '#/components/schemas/urn_bamm_io.catenax.sealant.sealant_pass_1.0.0_LocateCharacteristic' + technicalDocumentation: + description: "Technical documentation refers to documents that explain the\ + \ use, functionality, creation, or architecture of the product." + $ref: '#/components/schemas/urn_bamm_io.catenax.sealant.sealant_pass_1.0.0_LocateCharacteristic' + safetyDataSheet: + description: "A link to the full seafty data sheet of the material. A link\ + \ to a SDS might be provided for several countries and possibly multiple\ + \ languages for each country. The table includes: version, country name,\ + \ language of the document and the link to the document. The documents\ + \ should preferably be provided as PDF or Word document." + $ref: '#/components/schemas/urn_bamm_io.catenax.sealant.sealant_pass_1.0.0_SpecificsSDSCharacteristic' + sustainabilityReport: + description: Link to public website or document. Reporting in accordance + with the new European Sustainability Reporting Standards (ESRS) including + the new ESG reporting standards. + $ref: '#/components/schemas/urn_bamm_io.catenax.sealant.sealant_pass_1.0.0_LocateCharacteristic' + required: + - safetyDataSheet + urn_bamm_io.catenax.sealant.sealant_pass_1.0.0_CuringTime: + type: number + description: Time in seconds needed for the curing of the substance or mixture. + urn_bamm_io.catenax.sealant.sealant_pass_1.0.0_PerformanceCharacteristic: + description: Set of measures linked to the performance and durability of the + mixtures and substances. + type: object + properties: + curingTime: + description: "Cure time is the time that determines how long it will take\ + \ for the material to fully cure. A number of chemical reactions occur\ + \ during this time, for the material to harden. It can take a long time\ + \ for a material to fully cure." + $ref: '#/components/schemas/urn_bamm_io.catenax.sealant.sealant_pass_1.0.0_CuringTime' + required: + - curingTime + urn_bamm_io.catenax.sealant.sealant_pass_1.0.0_ReachRegistrationTrait: + type: string + description: Describes the regex expression for the Reach Registration number. + Constraints the value to two digits followed by an - followed by ten digits + followed by an - followed by two digits followed by an - and four digits. + pattern: "^\\d{2}-\\d{10}-\\d{2}-\\d{4}$" + 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.catenax.sealant.sealant_pass_1.0.0_CasNumberTrait: + type: string + description: Describes the Regex expression for the CAS number. Constraints + the value to four digits followed by an - followed by two digits followed + by an - and one digit. + pattern: "^\\d{4}-\\d{2}-\\d$" + urn_bamm_io.catenax.sealant.sealant_pass_1.0.0_EcNumberTrait: + type: string + description: Describes the regex expression for the EC number. Constraints the + value to three digits followed by an - followed by three digits followed by + an - and one digit. + pattern: "^\\d{3}-\\d{3}-\\d$" + urn_bamm_io.catenax.sealant.sealant_pass_1.0.0_IndexNumberTrait: + type: string + description: Describes the regex expression for the Index number. Constraints + the value to three digits followed by an - followed by three digits followed + by an - followed by two digits followed by an - and one digit. + pattern: "^\\d{3}-\\d{3}-\\d{2}-\\d$" + urn_bamm_io.catenax.sealant.sealant_pass_1.0.0_ProductIdentificationCharacteristic: + description: Set of information to identify the product. + type: object + properties: + tradeName: + description: Trade name given to the chemical substance or mixture as part + of the product identification. + $ref: '#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text' + productCode: + description: Product Code given to the Substance/mixture as part of the + product identification. + $ref: '#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text' + reachRegistration: + description: A REACH registration number is an 18-digit number assigned + by the European Chemicals Agency (ECHA). + $ref: '#/components/schemas/urn_bamm_io.catenax.sealant.sealant_pass_1.0.0_ReachRegistrationTrait' + localIdentifiers: + description: "A local identifier enables identification of a part in a specific\ + \ data space, but is not unique in Catena-X data space. Multiple local\ + \ identifiers may exist." + $ref: '#/components/schemas/urn_bamm_io.catenax.serial_part_typization_2.0.0_LocalIdentifierCharacteristic' + substanceName: + description: Name given to the substance. + $ref: '#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text' + casNumber: + description: A CAS registry number is a unique identification number assigned + by the Chemical Abstracts Service (CAS). + $ref: '#/components/schemas/urn_bamm_io.catenax.sealant.sealant_pass_1.0.0_CasNumberTrait' + ecNumber: + description: "The European Commission number (EC number), is the code assigned\ + \ to chemical substances that are commercially available within the European\ + \ Union." + $ref: '#/components/schemas/urn_bamm_io.catenax.sealant.sealant_pass_1.0.0_EcNumberTrait' + indexNumber: + description: The index number is used as an identifier. + $ref: '#/components/schemas/urn_bamm_io.catenax.sealant.sealant_pass_1.0.0_IndexNumberTrait' + required: + - tradeName + - productCode + - reachRegistration + - localIdentifiers + - casNumber + urn_bamm_io.catenax.sealant.sealant_pass_1.0.0_ApplicationCharacteristic: + description: Set of information referring to the application of the substance + and mixture. + type: object + properties: + usage: + description: Brief description of the identified uses of the substance or + mixture relevant for the recipient(s). + $ref: '#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text' + recommendedUse: + description: Recommended restrictions on use + $ref: '#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text' + required: + - usage + - recommendedUse + urn_bamm_io.catenax.sealant.sealant_pass_1.0.0_UsageTrait: + type: string + description: "Constraint to allow only numbers, blanks and an optional leading\ + \ + sign." + pattern: "^[+]?[0-9 ]+$" + urn_bamm_io.catenax.sealant.sealant_pass_1.0.0_SupplierCharacteristic: + description: Set of information to identify the supplier. + type: object + properties: + emergencyNumber: + description: Suppliers emergency telephone number for information services. + $ref: '#/components/schemas/urn_bamm_io.catenax.sealant.sealant_pass_1.0.0_UsageTrait' + supplierId: + description: BPNL of the supplier. + $ref: '#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text' + required: + - emergencyNumber + - supplierId + urn_bamm_io.catenax.sealant.sealant_pass_1.0.0_ChemicalPercentageTrait: + type: string + description: Describes chemical distribution in percentage. It can include a + percentage range. Either 10% or 5.5%-6% . Allowed are decimal values with + a dot as separator. Mandatory are no spaces between the values and the percentage + character. + pattern: "^\\d{1,2}(\\.\\d{0,2})?%(-\\d{1,2}(\\.\\d{0,2})?%)?$" + urn_bamm_io.catenax.sealant.sealant_pass_1.0.0_IngredientsEntity: + description: Entity encapsulating the ingredients. + type: object + properties: + chemicalName: + description: Name of the chemical. + $ref: '#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text' + chemicalPercentage: + description: "Describes chemical distribution in percentage. It can include\ + \ a percentage range. Either 10% or 5,5%-6% . Allowed are decimal values\ + \ with a \",\" separator. Mandatory are no spaces between the values and\ + \ the percentage character." + $ref: '#/components/schemas/urn_bamm_io.catenax.sealant.sealant_pass_1.0.0_ChemicalPercentageTrait' + required: + - chemicalName + - chemicalPercentage + urn_bamm_io.catenax.sealant.sealant_pass_1.0.0_ListOfIngredients: + description: Describes the amount of each individual chemical. + type: array + items: + $ref: '#/components/schemas/urn_bamm_io.catenax.sealant.sealant_pass_1.0.0_IngredientsEntity' + uniqueItems: true + urn_bamm_io.catenax.sealant.sealant_pass_1.0.0_HazardsIdentification: + description: Set of information to identify the hazards. + type: object + properties: + classificationGHS: + description: The classification of the substance or the mixture which results + from the application of the classification criteria in Regulation (EC) + No 1272/2008 shall be given. + $ref: '#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text' + possibleHazards: + description: A description of the various toxicological (health) effects + and the available data used to identify those effects (SDS Section 11.1). + $ref: '#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text' + hazardousIngredients: + description: Ingredients classified as hazardous (SDS Section 12.1). + $ref: '#/components/schemas/urn_bamm_io.catenax.sealant.sealant_pass_1.0.0_ListOfIngredients' + required: + - classificationGHS + - possibleHazards + - hazardousIngredients + urn_bamm_io.catenax.sealant.sealant_pass_1.0.0_ChemicalCompositionEntity: + description: Entity encapsulating the chemical composition and nature. + type: object + properties: + composition: + description: Describes the chemical identity of the ingredient(s) of the + substance or mixture. + $ref: '#/components/schemas/urn_bamm_io.catenax.sealant.sealant_pass_1.0.0_ListOfIngredients' + chemicalNature: + description: Chemical nature of the mixture or substance. + $ref: '#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text' + required: + - composition + - chemicalNature + urn_bamm_io.catenax.sealant.sealant_pass_1.0.0_ChemicalComposition: + description: Characteristic combining the chemical composition for a mixture + and a substance. + type: array + items: + $ref: '#/components/schemas/urn_bamm_io.catenax.sealant.sealant_pass_1.0.0_ChemicalCompositionEntity' + uniqueItems: true + urn_bamm_io.catenax.sealant.sealant_pass_1.0.0_ProductComposition: + description: Set of information displaying the product composition. + type: object + properties: + substance: + description: Property to describes a substance. + $ref: '#/components/schemas/urn_bamm_io.catenax.sealant.sealant_pass_1.0.0_ChemicalComposition' + mixture: + description: Property to describes the mixture. + $ref: '#/components/schemas/urn_bamm_io.catenax.sealant.sealant_pass_1.0.0_ChemicalComposition' + required: + - substance + - mixture + urn_bamm_io.catenax.sealant.sealant_pass_1.0.0_SafetyMeasureCharacteristic: + description: Set of information referring to safety measures. + type: object + properties: + firstAid: + description: First aid instructions are provided by relevant routes of exposure + (SDS Section 4.1). + $ref: '#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text' + fireExtinguisher: + description: "Suitable extinguishing media, for fighting a fire caused\ + \ by the substance or mixture, or arising in its vicinity (SDS Section\ + \ 5.1)." + $ref: '#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text' + personalPrecaution: + description: "Information about the appropriate response to spills, leaks,\ + \ or releases, to prevent or minimize the adverse effects on persons,\ + \ property and the environment (SDS Section 6.1)." + $ref: '#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text' + technicalMeasures: + description: Information is provided concerning protective measures for + safe handling and recommended technical measures (SDS Section 7.1). + $ref: '#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text' + exposureLimit: + description: Information about the applicable exposure limits of the substances + and mixtures (SDS Section 8.1). + $ref: '#/components/schemas/urn_bamm_io.catenax.sealant.sealant_pass_1.0.0_ListOfIngredients' + required: + - firstAid + - fireExtinguisher + - personalPrecaution + - technicalMeasures + - exposureLimit + urn_bamm_io.catenax.sealant.sealant_pass_1.0.0_PhysicalState: + type: string + description: "Enumeration with three physical states: gas, liquid and solid." + enum: + - gas + - liquid + - solid + urn_bamm_io.catenax.sealant.sealant_pass_1.0.0_PhCharacteristic: + type: number + description: Provides a range or a pH value. + urn_bamm_io.catenax.sealant.sealant_pass_1.0.0_Degree: + type: number + description: The temperature in its phase. + urn_bamm_io.catenax.sealant.sealant_pass_1.0.0_Density: + type: number + description: Describes the density of the product. + urn_bamm_io.catenax.sealant.sealant_pass_1.0.0_ProductProperties: + description: Set of information describing the physical and chemical properties. + type: object + properties: + physicalState: + description: "Describes the physical state (gas, liquid or solid) at standard\ + \ conditions of temperature and pressure." + $ref: '#/components/schemas/urn_bamm_io.catenax.sealant.sealant_pass_1.0.0_PhysicalState' + colour: + description: The colour of the substance or mixture as supplied is indicated. + $ref: '#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text' + odour: + description: A qualitative description of the odour is shown if it is well-known + or described in the literature. + $ref: '#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text' + pH: + description: "The pH of the substance or mixture as supplied, or where the\ + \ product is a solid, the pH of an aqueous liquid or solution at a given\ + \ concentration, shall be indicated." + $ref: '#/components/schemas/urn_bamm_io.catenax.sealant.sealant_pass_1.0.0_PhCharacteristic' + phaseTransition: + description: Phase Transition temperature from liquid to gas. + $ref: '#/components/schemas/urn_bamm_io.catenax.sealant.sealant_pass_1.0.0_Degree' + flashPoint: + description: "For mixtures, a value for the mixture shall be indicated,\ + \ if available. Otherwise, the flash point of the substance with the lowest\ + \ flash point shall be indicated." + $ref: '#/components/schemas/urn_bamm_io.catenax.sealant.sealant_pass_1.0.0_Degree' + density: + description: Density and relative density shall generally be indicated at + standard conditions of temperature and pressure. + $ref: '#/components/schemas/urn_bamm_io.catenax.sealant.sealant_pass_1.0.0_Density' + reactivity: + description: Reactivity hazards of the substance or mixtures. + $ref: '#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text' + required: + - physicalState + - colour + - pH + - phaseTransition + - density + - reactivity + urn_bamm_io.catenax.sealant.sealant_pass_1.0.0_ProductDisposal: + description: Set of information describing the proper disposal of the product. + type: object + properties: + wasteManagement: + description: Waste management of the substance or mixture and/or its container + to assist in the determination of safe and environmentally preferred waste + management options. + $ref: '#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text' + wasteInformation: + description: Waste treatment-relevant information. + $ref: '#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text' + required: + - wasteManagement + - wasteInformation + urn_bamm_io.catenax.sealant.sealant_pass_1.0.0_TransportInformation: + description: Set of information describing the transport information. + type: object + properties: + unNumber: + description: "The UN number or the ID number (i.e. the four-figure identification\ + \ number of the substance, mixture or article preceded by the letters\ + \ ‘UN’ or ‘ID’) from the UN Model Regulations, IMDG, ADR, RID, ADN or\ + \ ICAO TI shall be provided." + $ref: '#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text' + shippingName: + description: A proper shipping name. + $ref: '#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text' + dgClass: + description: The transport hazard class (and subsidiary risks) assigned + to the substances or mixtures on the basis of the predominant hazard that + they present according to the UN Model Regulations shall be provided. + $ref: '#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text' + dgPack: + description: "The packing group number from the UN Model Regulations shall\ + \ be provided, if applicable, as required by the UN Model Regulations,\ + \ ADR, RID and ADN." + $ref: '#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text' + required: + - unNumber + - shippingName + - dgClass + - dgPack + urn_bamm_io.catenax.sealant.sealant_pass_1.0.0_RegulatoryInformationCharacteristic: + description: Set of information regarding the regulations. + type: object + properties: + limitations: + description: "Information shall be provided regarding relevant Union safety,\ + \ health and environmental provisions including the prohibitions and restrictions." + $ref: '#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text' + required: + - limitations + urn_bamm_io.catenax.sealant.sealant_pass_1.0.0_Co2Total: + type: number + description: Describes the amount of kg of the CO2 equivalent. + urn_bamm_io.catenax.pcf_3.0.0_CrossSectoralStandardsUsedEnumerationCharacteristic: + type: string + description: Characteristic for defining the enumeration of valid accounting + standards used for product carbon footprint calculation as specified by the + WBCSD (World Business Council for Sustainable Development) Pathfinder initiative. + enum: + - GHG Protocol Product standard + - ISO Standard 14067 + - ISO Standard 14044 + urn_bamm_io.catenax.pcf_3.0.0_CrossSectoralStandardEntity: + description: Entity for defining an accounting standard used for product carbon + footprint calculation as specified by the WBCSD (World Business Council for + Sustainable Development) Pathfinder initiative. + type: object + properties: + crossSectoralStandard: + description: Discloses a cross-sectoral standard applied for calculating + or allocating GHG (Greenhouse Gas) emissions as specified by the WBCSD + (World Business Council for Sustainable Development) Pathfinder initiative. + $ref: '#/components/schemas/urn_bamm_io.catenax.pcf_3.0.0_CrossSectoralStandardsUsedEnumerationCharacteristic' + required: + - crossSectoralStandard + urn_bamm_io.catenax.pcf_3.0.0_CrossSectoralStandardsUsedListCharacteristic: + description: Characteristic for defining the list of valid accounting standards + used for product carbon footprint calculation as specified by the WBCSD (World + Business Council for Sustainable Development) Pathfinder initiative. + type: array + items: + $ref: '#/components/schemas/urn_bamm_io.catenax.pcf_3.0.0_CrossSectoralStandardEntity' + urn_bamm_io.catenax.pcf_3.0.0_ProductOrSectorSpecificRuleOperator: + type: string + description: Enumeration of PCR (Product Category Rule) operators as specified + by the WBCSD (World Business Council for Sustainable Development) Pathfinder + initiative. + enum: + - PEF + - EPD International + - Other + urn_bamm_io.catenax.pcf_3.0.0_RuleNamesTrait: + description: Constraint for defining a non-empty set of non-empty rule names + as specified by the WBCSD (World Business Council for Sustainable Development) + Pathfinder initiative. + type: array + items: + type: string + description: String that contains at least one character. + uniqueItems: true + minItems: 1 + urn_bamm_io.catenax.pcf_3.0.0_ProductOrSectorSpecificRulesEntity: + description: Entity for defining the set of values for the product or sector + specific rules of a product carbon footprint as specified by the WBCSD (World + Business Council for Sustainable Development) Pathfinder initiative. + type: object + properties: + operator: + description: Operator of PCR (Product Category Rule)/ PSR (Product Specific + Rule) as specified by the WBCSD (World Business Council for Sustainable + Development) Pathfinder initiative. + $ref: '#/components/schemas/urn_bamm_io.catenax.pcf_3.0.0_ProductOrSectorSpecificRuleOperator' + ruleNames: + description: Product-specific or sector-specific set of rules used for calculating + or allocating GHG (Greenhouse Gas) emissions applied from the specified + operator. Property defined by the WBCSD (World Business Council for Sustainable + Development) Pathfinder initiative. + $ref: '#/components/schemas/urn_bamm_io.catenax.pcf_3.0.0_RuleNamesTrait' + otherOperatorName: + description: Other operator of PCR (Product Category Rule)/ PSR (Product + Specific Rule) as specified by the WBCSD (World Business Council for Sustainable + Development) Pathfinder initiative. + $ref: '#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text' + required: + - operator + - ruleNames + urn_bamm_io.catenax.pcf_3.0.0_ProductOrSectorSpecificRuleSet: + description: Characteristic for defining the set of product or sector specific + rules of a product carbon footprint as specified by the WBCSD (World Business + Council for Sustainable Development) Pathfinder initiative. + type: array + items: + $ref: '#/components/schemas/urn_bamm_io.catenax.pcf_3.0.0_ProductOrSectorSpecificRulesEntity' + uniqueItems: true + urn_bamm_io.catenax.sealant.sealant_pass_1.0.0_CarbonFootprint: + description: Set of information needed for the carbon footprint ecodesign regulations. + type: object + properties: + co2FootprintTotal: + description: "The total carbon footprint, calculated as kg of carbon dioxide\ + \ equivalent." + $ref: '#/components/schemas/urn_bamm_io.catenax.sealant.sealant_pass_1.0.0_Co2Total' + crossSectoralStandardsUsed: + description: Discloses the cross-sectoral standards applied for calculating + or allocating GHG (Greenhouse Gas) emissions as specified by the WBCSD + (World Business Council for Sustainable Development) Pathfinder initiative. + $ref: '#/components/schemas/urn_bamm_io.catenax.pcf_3.0.0_CrossSectoralStandardsUsedListCharacteristic' + 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. Specified\ + \ by the WBCSD (World Business Council for Sustainable Development) Pathfinder\ + \ initiative." + $ref: '#/components/schemas/urn_bamm_io.catenax.pcf_3.0.0_ProductOrSectorSpecificRuleSet' + required: + - co2FootprintTotal + - crossSectoralStandardsUsed + - productOrSectorSpecificRules + SealantPass: + description: The Sealant Passport represents the needs from manufacturers of + chemical substance and mixtures. It describes data required by the safety + data sheet (SDS) - which is based on the REACH Regulation No 1907/2006 in + the format of a DPP. + type: object + properties: + documents: + description: Set of documents containing the description of components. + $ref: '#/components/schemas/urn_bamm_io.catenax.sealant.sealant_pass_1.0.0_Document' + performanceProperties: + description: Describes the performance and durability of a substance or + mixture. + $ref: '#/components/schemas/urn_bamm_io.catenax.sealant.sealant_pass_1.0.0_PerformanceCharacteristic' + productIdentification: + description: Identification of the substance/mixture and of the company/undertaking. + $ref: '#/components/schemas/urn_bamm_io.catenax.sealant.sealant_pass_1.0.0_ProductIdentificationCharacteristic' + application: + description: Relevant identified uses of the substance or mixture and uses + advised against. + $ref: '#/components/schemas/urn_bamm_io.catenax.sealant.sealant_pass_1.0.0_ApplicationCharacteristic' + supplier: + description: Supplier of the mixture or substance. + $ref: '#/components/schemas/urn_bamm_io.catenax.sealant.sealant_pass_1.0.0_SupplierCharacteristic' + hazardsIdentification: + description: Describes the hazards of the substance or mixture and the appropriate + warning information associated with those hazards. + $ref: '#/components/schemas/urn_bamm_io.catenax.sealant.sealant_pass_1.0.0_HazardsIdentification' + productComposition: + description: Information on the ingredients. + $ref: '#/components/schemas/urn_bamm_io.catenax.sealant.sealant_pass_1.0.0_ProductComposition' + safetyMeasure: + description: Describes measures related to the safe handling of the mixtures + and substances. + $ref: '#/components/schemas/urn_bamm_io.catenax.sealant.sealant_pass_1.0.0_SafetyMeasureCharacteristic' + productProperties: + description: Describes the physical and chemical properties of the substance + or mixture. + $ref: '#/components/schemas/urn_bamm_io.catenax.sealant.sealant_pass_1.0.0_ProductProperties' + productDisposal: + description: Describes the proper disposal of the product. + $ref: '#/components/schemas/urn_bamm_io.catenax.sealant.sealant_pass_1.0.0_ProductDisposal' + transportInformation: + description: Describes transport relevant information. + $ref: '#/components/schemas/urn_bamm_io.catenax.sealant.sealant_pass_1.0.0_TransportInformation' + regulatoryInformation: + description: Describes the regulatory data points. + $ref: '#/components/schemas/urn_bamm_io.catenax.sealant.sealant_pass_1.0.0_RegulatoryInformationCharacteristic' + carbonFootprint: + description: Describes the carbon footprint of the substance or mixture + based on the Ecodesign. + $ref: '#/components/schemas/urn_bamm_io.catenax.sealant.sealant_pass_1.0.0_CarbonFootprint' + required: + - documents + - performanceProperties + - productIdentification + - application + - supplier + - hazardsIdentification + - productComposition + - safetyMeasure + - productProperties + - productDisposal + - transportInformation + - regulatoryInformation + - carbonFootprint + 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' + SealantPass: + content: + application/json: + schema: + $ref: '#/components/schemas/SealantPass' + description: The request was successful. + requestBodies: + SealantPass: + content: + application/json: + schema: + $ref: '#/components/schemas/SealantPass' 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 new file mode 100644 index 00000000..3c3845e7 --- /dev/null +++ b/io.catenax.serial_part_typization/2.0.0/gen/SerialPartTypization-aas.xml @@ -0,0 +1,730 @@ + +++Specifics SDS Entity
++ Entity encapsulating the details from the safety data sheet (SDS) documentation. ++ +++Properties
++ ++++ +Language of the safety data sheet (SDS) document. + +Document Language
+++ + + +Name+documentLanguage+++ + +Characteristic++++++++ Typ http://www.w3.org/2001/XMLSchema#string + ++++ +Optional++ Nein+++ +Im Payload++ Ja+++ + +Payload Schlüssel+documentLanguage++ ++++ +Version of the document. + +Document Version
+++ + + +Name+documentVersion+++ + +Characteristic+++++++Code++++ Typ http://www.w3.org/2001/XMLSchema#string + ++++ +Optional++ Nein+++ +Im Payload++ Ja+++ + +Payload Schlüssel+documentVersion++ ++++ +The country from where the documentation is issued from. + +Provisioning Country
+++ + + +Name+provisioningCountry+++ +Characteristic+++++++Trait++++ Typ http://www.w3.org/2001/XMLSchema#string + ++++ +Beispiel+GER+++ +Optional++ Nein+++ +Im Payload++ Ja+++ + +Payload Schlüssel+provisioningCountry+++Bedingungen+++-
+
-
++ +++ ISO Code Constraint ++ +++ + +Beschreibung+Length of the text is capped to three letters based on the ISO 3166 standard.+++Min. Zeichen+3+++ + + +Max. Zeichen+3+
+ ++++ +Location or link of and to the document. + +Document Location
+++ + + +Name+documentLocation+++ +Characteristic++++++++ Typ http://www.w3.org/2001/XMLSchema#string + ++++ +Beispiel+ftp://www.company.com/MyCompliance/Compliant02.PDF+++ +Optional++ Nein+++ +Im Payload++ Ja+++ + +Payload Schlüssel+documentLocation++ ++++ +Additional information relevant to the safety data sheet (SDS) document. + +Other Information
+++ + + +Name+otherInformation+++ + +Characteristic+++++++Set+++Has no order+++ +Duplicates not allowed+++ +Optional++ Nein+++ +Im Payload++ Ja+++ + +Payload Schlüssel+otherInformation++ ++++ +Unique BPN number. + +Manufacture ID
+++ + + +Name+manufactureId+++ +Characteristic++++++++ Typ http://www.w3.org/2001/XMLSchema#string + ++++ +Beispiel+BPNL1234567890ZZ+++ +Optional++ Nein+++ +Im Payload++ Ja+++ + +Payload Schlüssel+manufactureId+++ +++Supplier Entity
++ Entity encapsulating the information from the supplier. ++ +++Properties
++ ++++ +Suppliers emergency telephone number for information services. + +Emergency Number
+++ + + +Name+emergencyNumber+++ +Characteristic+++++++Trait++++ Typ http://www.w3.org/2001/XMLSchema#string + ++++ +Beispiel++49 696 43508409+++ +Optional++ Nein+++ +Im Payload++ Ja+++ + +Payload Schlüssel+emergencyNumber+++Bedingungen+++-
+
-
++ +++ Telephone Number Regex ++ +++ + +Beschreibung+Constraint to allow only numbers, blanks and an optional leading + sign.+++ + + +Regulärer Ausdruck+^[+]?[0-9 ]+$+
+ ++++ +BPNL of the supplier. + +Supplier ID
+++ + + +Name+supplierId+++ +Characteristic++++++++ Typ http://www.w3.org/2001/XMLSchema#string + ++++ +Beispiel+BPNL1234567890ZZ+++ +Optional++ Nein+++ +Im Payload++ Ja+++ + +Payload Schlüssel+supplierId+++++Transport Information Entity
++ Entity encapsulating the transport information data. ++ +++Properties
++ ++++ +The UN number or the ID number (i.e. the four-figure identification number of the substance, mixture or article preceded by the letters ‘UN’ or ‘ID’) from the UN Model Regulations, IMDG, ADR, RID, ADN or ICAO TI shall be provided. + +UN Number
+++ + + +Name+unNumber+++ +Characteristic++++++++ Typ http://www.w3.org/2001/XMLSchema#string + ++++ +Beispiel+ADR - UN2320+++ +Optional++ Nein+++ +Im Payload++ Ja+++ + +Payload Schlüssel+unNumber++ ++++ +A proper shipping name. + +Shipping Name
+++ + + +Name+shippingName+++ +Characteristic++++++++ Typ http://www.w3.org/2001/XMLSchema#string + ++++ +Beispiel+ADR - TETRAETHYLENEPENTAMINE+++ +Optional++ Nein+++ +Im Payload++ Ja+++ + +Payload Schlüssel+shippingName++ ++++ +The transport hazard class (and subsidiary risks) assigned to the substances or mixtures on the basis of the predominant hazard that they present according to the UN Model Regulations shall be provided. + +DG Class
+++ + + +Name+dgClass+++ +Characteristic++++++++ Typ http://www.w3.org/2001/XMLSchema#string + ++++ +Beispiel+ADR - 8+++ +Optional++ Nein+++ +Im Payload++ Ja+++ + +Payload Schlüssel+dgClass++ ++++ +The packing group number from the UN Model Regulations shall be provided, if applicable, as required by the UN Model Regulations, ADR, RID and ADN. + +DG Pack
+++ + + +Name+dgPack+++ +Characteristic++++++++ Typ http://www.w3.org/2001/XMLSchema#string + ++++ +Beispiel+ADR - III+++ +Optional++ Nein+++ +Im Payload++ Ja+++ + +Payload Schlüssel+dgPack++ Third party licenses + ++ +defaultAdminShell +defaultAsset +SerialPartTypization +APPLICATION_CLASS +urn:bamm:io.catenax.serial_part_typization:2.0.0#SerialPartTypization +CatenaXIdTrait +urn:bamm:io.catenax.serial_part_typization:2.0.0#catenaXId +KeyCharacteristic +urn:bamm:io.catenax.serial_part_typization:2.0.0#key +ValueCharacteristic +urn:bamm:io.catenax.serial_part_typization:2.0.0#value +LocalIdentifierCharacteristic +urn:bamm:io.catenax.serial_part_typization:2.0.0#localIdentifiers +Timestamp +urn:bamm:io.catenax.serial_part_typization:2.0.0#date +ProductionCountryCodeTrait +urn:bamm:io.catenax.serial_part_typization:2.0.0#country +ManufacturingCharacteristic +urn:bamm:io.catenax.serial_part_typization:2.0.0#manufacturingInformation +PartIdCharacteristic +urn:bamm:io.catenax.serial_part_typization:2.0.0#manufacturerPartId +PartIdCharacteristic +urn:bamm:io.catenax.serial_part_typization:2.0.0#customerPartId +PartNameCharacteristic +urn:bamm:io.catenax.serial_part_typization:2.0.0#nameAtManufacturer +PartNameCharacteristic +urn:bamm:io.catenax.serial_part_typization:2.0.0#nameAtCustomer +ClassificationCharacteristic +urn:bamm:io.catenax.serial_part_typization:2.0.0#classification +PartTypeInformationCharacteristic +urn:bamm:io.catenax.serial_part_typization:2.0.0#partTypeInformation +SerialPartTypization +Template ++ ++ +urn:bamm:io.catenax.serial_part_typization:2.0.0#SerialPartTypization +catenaXId +Template ++ ++ +urn:bamm:io.catenax.serial_part_typization:2.0.0#catenaXId +DefaultScalarValue[value=urn:uuid:580d3adf-1981-44a0-a214-13d6ceed9379, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']'] +http://www.w3.org/2001/XMLSchema#string +localIdentifiers +false +false +KeyValueList +false +false +key +Template ++ ++ +urn:bamm:io.catenax.serial_part_typization:2.0.0#key +DefaultScalarValue[value=PartInstanceID, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']'] +http://www.w3.org/2001/XMLSchema#string +value +Template ++ ++ +urn:bamm:io.catenax.serial_part_typization:2.0.0#value +DefaultScalarValue[value=SN12345678, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']'] +http://www.w3.org/2001/XMLSchema#string +ManufacturingEntity +false +false +date +Template ++ ++ +urn:bamm:io.catenax.serial_part_typization:2.0.0#date +DefaultScalarValue[value=2022-02-04T14:48:54, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#dateTime']'] +http://www.w3.org/2001/XMLSchema#dateTime +country +Template ++ ++ +urn:bamm:io.catenax.serial_part_typization:2.0.0#country +DefaultScalarValue[value=HUR, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']'] +http://www.w3.org/2001/XMLSchema#string +PartTypeInformationEntity +false +false +manufacturerPartId +Template ++ ++ +urn:bamm:io.catenax.serial_part_typization:2.0.0#manufacturerPartId +DefaultScalarValue[value=123-0.740-3434-A, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']'] +http://www.w3.org/2001/XMLSchema#string +customerPartId +Template ++ ++ +urn:bamm:io.catenax.serial_part_typization:2.0.0#customerPartId +DefaultScalarValue[value=PRT-12345, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']'] +http://www.w3.org/2001/XMLSchema#string +nameAtManufacturer +Template ++ ++ +urn:bamm:io.catenax.serial_part_typization:2.0.0#nameAtManufacturer +DefaultScalarValue[value=Mirror left, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']'] +http://www.w3.org/2001/XMLSchema#string +nameAtCustomer +Template ++ ++ +urn:bamm:io.catenax.serial_part_typization:2.0.0#nameAtCustomer +DefaultScalarValue[value=side element A, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']'] +http://www.w3.org/2001/XMLSchema#string +classification +Template ++ ++ +urn:bamm:io.catenax.serial_part_typization:2.0.0#classification +DefaultScalarValue[value=software, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']'] +http://www.w3.org/2001/XMLSchema#string +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
+++ + +++++
+ +++ +Properties
++ ++ + + +++ +The fully anonymous Catena-X ID of the serialized part, valid for the Catena-X dataspace. + +Catena-X Identifier
+++ + + +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}$)+
+ ++++ +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. + +Local Identifiers
+++ + + +Name+localIdentifiers+++ + +Characteristic+++++++Set+++Has no order+++ +Duplicates not allowed+++ +Optional++ Nein+++ +Im Payload++ Ja+++ + +Payload Schlüssel+localIdentifiers++ ++++ +Information from manufacturing process, such as manufacturing date and manufacturing country + +Manufacturing Information
+++ + + +Name+manufacturingInformation+++ + +Characteristic+++++++ +SingleEntity+++ +Optional++ Nein+++ +Im Payload++ Ja+++ + +Payload Schlüssel+manufacturingInformation++ ++++ +The part type from which the serialized part has been instantiated + +Part Type Information
+++ + + +Name+partTypeInformation+++ + +Characteristic+++++++ +SingleEntity+++ +Optional++ Nein+++ +Im Payload++ Ja+++ + +Payload Schlüssel+partTypeInformation+++ + + + + + \ 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 new file mode 100644 index 00000000..200d12e3 --- /dev/null +++ b/io.catenax.serial_part_typization/2.0.0/gen/SerialPartTypization.json @@ -0,0 +1,18 @@ +{ + "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 new file mode 100644 index 00000000..3178e06e --- /dev/null +++ b/io.catenax.serial_part_typization/2.0.0/gen/SerialPartTypization.yml @@ -0,0 +1,262 @@ +--- +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.shared.address_characteristic/2.0.0/gen/AddressAspect-aas.xml b/io.catenax.shared.address_characteristic/2.0.0/gen/AddressAspect-aas.xml new file mode 100644 index 00000000..00b93cfc --- /dev/null +++ b/io.catenax.shared.address_characteristic/2.0.0/gen/AddressAspect-aas.xml @@ -0,0 +1,1133 @@ + +++ +Objekt
+++++Key Value List
++ A list of key value pairs for local identifiers, which are composed of a key and a corresponding value. ++ +++Properties
++ ++++ +The key of a local identifier. + +Identifier Key
+++ + + +Name+key+++ +Characteristic++++++++ Typ http://www.w3.org/2001/XMLSchema#string + ++++ +Beispiel+PartInstanceID+++ +Optional++ Nein+++ +Im Payload++ Ja+++ + +Payload Schlüssel+key++ ++++ +The value of an identifier. + +Identifier Value
+++ + + +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
++ ++++ +Timestamp of the manufacturing date as the final step in production process (e.g. final quality check, ready-for-shipment event) + +Production Date
+++ + + +Name+date+++ +Characteristic++++++ ++++ +Beispiel+2022-02-04T14:48:54+++ +Optional++ Nein+++ +Im Payload++ Ja+++ + +Payload Schlüssel+date++ ++++ +Country code where the part was manufactured + +Country code
+++ + + +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
++ ++++ +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. + +Manufacturer Part ID
+++ + + +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++ ++++ +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. + +Customer Part ID
+++ + + +Name+customerPartId+++ +Characteristic++++++++ Typ http://www.w3.org/2001/XMLSchema#string + ++++ +Beispiel+PRT-12345+++ +Optional++ Ja+++ +Im Payload++ Ja+++ + +Payload Schlüssel+customerPartId++ ++++ +Name of the part as assigned by the manufacturer + +Name at 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 of the part as assigned by the customer + +Name at 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++ ++++ +The classification of the part type according to STEP standard definition + +Classifcation
+++ + + +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 + ++ +defaultAdminShell +defaultAsset +AddressAspect +APPLICATION_CLASS +urn:bamm:io.catenax.shared.address_characteristic:2.0.0#AddressAspect +ThoroughfareTechnicalKeyCharacteristic +urn:bamm:io.catenax.shared.address_characteristic:2.0.0#thoroughfareTechnicalKey +Text +urn:bamm:io.catenax.shared.address_characteristic:2.0.0#thoroughfareValue +Text +urn:bamm:io.catenax.shared.address_characteristic:2.0.0#thoroughfareNumber +ThoroughfareCharacteristic +urn:bamm:io.catenax.shared.address_characteristic:2.0.0#thoroughfare +LocalityTechnicalKeyCharacteristic +urn:bamm:io.catenax.shared.address_characteristic:2.0.0#localityTechnicalKey +Text +urn:bamm:io.catenax.shared.address_characteristic:2.0.0#localityValue +LocalityCharacteristic +urn:bamm:io.catenax.shared.address_characteristic:2.0.0#locality +PremiseTechnicalKeyCharacteristic +urn:bamm:io.catenax.shared.address_characteristic:2.0.0#premiseTechnicalKey +Text +urn:bamm:io.catenax.shared.address_characteristic:2.0.0#premiseValue +PremiseCharacteristic +urn:bamm:io.catenax.shared.address_characteristic:2.0.0#premise +PostalDeliveryPointTechnicalKeyCharacteristic +urn:bamm:io.catenax.shared.address_characteristic:2.0.0#postalDeliveryPointTechnicalKey +Text +urn:bamm:io.catenax.shared.address_characteristic:2.0.0#postalDeliveryPointValue +PostalDeliveryPointCharacteristic +urn:bamm:io.catenax.shared.address_characteristic:2.0.0#postalDeliveryPoint +CountryTrait +urn:bamm:io.catenax.shared.address_characteristic:2.0.0#countryShortName +CountryCharacteristic +urn:bamm:io.catenax.shared.address_characteristic:2.0.0#country +PostCodeTrait +urn:bamm:io.catenax.shared.address_characteristic:2.0.0#postCodeValue +PostCodeTechnicalKeyCharacteristic +urn:bamm:io.catenax.shared.address_characteristic:2.0.0#postCodeTechnicalKey +PostCodeCharacteristic +urn:bamm:io.catenax.shared.address_characteristic:2.0.0#postCode +PostalAddress +urn:bamm:io.catenax.shared.address_characteristic:2.0.0#address +AddressAspect +Template ++ ++ +urn:bamm:io.catenax.shared.address_characteristic:2.0.0#AddressAspect +AddressEntity +false +false +ThoroughfareEntity +false +false +thoroughfareTechnicalKey +Template ++ ++ +urn:bamm:io.catenax.shared.address_characteristic:2.0.0#thoroughfareTechnicalKey +DefaultScalarValue[value=STREET, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']'] +http://www.w3.org/2001/XMLSchema#string +thoroughfareValue +Template ++ ++ +urn:bamm:io.catenax.shared.address_characteristic:2.0.0#thoroughfareValue +DefaultScalarValue[value=Bernstraße, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']'] +http://www.w3.org/2001/XMLSchema#string +thoroughfareNumber +Template ++ ++ +urn:bamm:io.catenax.shared.address_characteristic:2.0.0#thoroughfareNumber +DefaultScalarValue[value=45, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']'] +http://www.w3.org/2001/XMLSchema#string +LocalityEntity +false +false +localityTechnicalKey +Template ++ ++ +urn:bamm:io.catenax.shared.address_characteristic:2.0.0#localityTechnicalKey +DefaultScalarValue[value=CITY, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']'] +http://www.w3.org/2001/XMLSchema#string +localityValue +Template ++ ++ +urn:bamm:io.catenax.shared.address_characteristic:2.0.0#localityValue +DefaultScalarValue[value=Mannheim, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']'] +http://www.w3.org/2001/XMLSchema#string +PremiseEntity +false +false +premiseTechnicalKey +Template ++ ++ +urn:bamm:io.catenax.shared.address_characteristic:2.0.0#premiseTechnicalKey +DefaultScalarValue[value=OTHER, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']'] +http://www.w3.org/2001/XMLSchema#string +premiseValue +Template ++ ++ +urn:bamm:io.catenax.shared.address_characteristic:2.0.0#premiseValue +DefaultScalarValue[value=Werk 1, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']'] +http://www.w3.org/2001/XMLSchema#string +PostalDeliveryPointEntity +false +false +postalDeliveryPointTechnicalKey +Template ++ ++ +urn:bamm:io.catenax.shared.address_characteristic:2.0.0#postalDeliveryPointTechnicalKey +DefaultScalarValue[value=OTHER, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']'] +http://www.w3.org/2001/XMLSchema#string +postalDeliveryPointValue +Template ++ ++ +urn:bamm:io.catenax.shared.address_characteristic:2.0.0#postalDeliveryPointValue +DefaultScalarValue[value=Tor 1, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']'] +http://www.w3.org/2001/XMLSchema#string +CountryEntity +false +false +countryShortName +Template ++ ++ +urn:bamm:io.catenax.shared.address_characteristic:2.0.0#countryShortName +Unknown +http://www.w3.org/2001/XMLSchema#string +PostCodeEntity +false +false +postCodeValue +Template ++ ++ +urn:bamm:io.catenax.shared.address_characteristic:2.0.0#postCodeValue +DefaultScalarValue[value=68161\12, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']'] +http://www.w3.org/2001/XMLSchema#string +postCodeTechnicalKey +Template ++ ++ +urn:bamm:io.catenax.shared.address_characteristic:2.0.0#postCodeTechnicalKey +Unknown +http://www.w3.org/2001/XMLSchema#string +Dokumentation Address Aspect + + ++ + +++++Aspect Model Address Aspect
+urn:bamm:io.catenax.shared.address_characteristic:2.0.0#AddressAspect++ +++ + + + ++ Aspect used for the Characteristic :PostalAddress to reference adress data ++ + +++Übersicht
+++ + +++++
+ ++ + + +++ +Properties
++ ++++ +the adress of the data provider + +Adress
+++ + + +Name+address+++ + +Characteristic+++++++ +SingleEntity+++ +Optional++ Nein+++ +Im Payload++ Ja+++ + +Payload Schlüssel+address++++ +Objekt
+++++Address Entity
++ Entity of an address. Model follows specification of BPDM (Business Partner Data Management). ++ +++Properties
++ ++++ +Street or thorough road name + +Thoroughfare
+++ + + +Name+thoroughfare+++ + +Characteristic+++++++ +SingleEntity+++ +Optional++ Nein+++ +Im Payload++ Ja+++ + +Payload Schlüssel+thoroughfare++ ++++ +Locality belonging to an address + +Locality
+++ + + +Name+locality+++ + +Characteristic+++++++ +SingleEntity+++ +Optional++ Nein+++ +Im Payload++ Ja+++ + +Payload Schlüssel+locality++ ++++ +Premise of an address, e.g. a specific "BUILDING" but can also be used for naming a particular site + +Premise
+++ + + +Name+premise+++ + +Characteristic+++++++ +SingleEntity+++ +Optional++ Ja+++ +Im Payload++ Ja+++ + +Payload Schlüssel+premise++ ++++ +Delivery point, e.g. designation of a gate + +Postal Delivery Point
+++ + + +Name+postalDeliveryPoint+++ + +Characteristic+++++++ +SingleEntity+++ +Optional++ Ja+++ +Im Payload++ Ja+++ + +Payload Schlüssel+postalDeliveryPoint++ ++++ +Country of an address + +Country
+++ + + +Name+country+++ + +Characteristic+++++++ +SingleEntity+++ +Optional++ Nein+++ +Im Payload++ Ja+++ + +Payload Schlüssel+country++ ++++ + +Post Code
+++ + + +Name+postCode+++ + +Characteristic+++++++ +SingleEntity+++ +Optional++ Nein+++ +Im Payload++ Ja+++ + +Payload Schlüssel+postCode+++ + + + + + \ No newline at end of file diff --git a/io.catenax.shared.address_characteristic/2.0.0/gen/AddressAspect.json b/io.catenax.shared.address_characteristic/2.0.0/gen/AddressAspect.json new file mode 100644 index 00000000..5496146b --- /dev/null +++ b/io.catenax.shared.address_characteristic/2.0.0/gen/AddressAspect.json @@ -0,0 +1,28 @@ +{ + "address" : { + "locality" : { + "value" : "Mannheim", + "technicalKey" : "BLOCK" + }, + "country" : { + "shortName" : "GA-H4" + }, + "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" + } + } +} \ No newline at end of file diff --git a/io.catenax.shared.address_characteristic/2.0.0/gen/AddressAspect.yml b/io.catenax.shared.address_characteristic/2.0.0/gen/AddressAspect.yml new file mode 100644 index 00000000..f3de3642 --- /dev/null +++ b/io.catenax.shared.address_characteristic/2.0.0/gen/AddressAspect.yml @@ -0,0 +1,280 @@ +--- +openapi: 3.0.3 +info: + title: Address Aspect + version: v2 +servers: +- url: catenax.io/api/v2 + variables: + api-version: + default: v2 +paths: + /{tenant-id}/address-aspect: + get: + tags: + - AddressAspect + operationId: getAddressAspect + 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/AddressAspect' + "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.shared.address_characteristic_2.0.0_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_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.shared.address_characteristic_2.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_bamm_io.catenax.shared.address_characteristic_2.0.0_ThoroughfareTechnicalKeyCharacteristic' + value: + description: "Value of a thoroughfare, e.g. name of a street." + $ref: '#/components/schemas/urn_bamm_io.catenax.shared.address_characteristic_2.0.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_bamm_io.catenax.shared.address_characteristic_2.0.0_Text' + required: + - technicalKey + - value + - number + urn_bamm_io.catenax.shared.address_characteristic_2.0.0_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_2.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_bamm_io.catenax.shared.address_characteristic_2.0.0_LocalityTechnicalKeyCharacteristic' + value: + description: "Value of a locality, e.g. name of a city (\"Mannheim\")." + $ref: '#/components/schemas/urn_bamm_io.catenax.shared.address_characteristic_2.0.0_Text' + required: + - technicalKey + - value + urn_bamm_io.catenax.shared.address_characteristic_2.0.0_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_2.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_bamm_io.catenax.shared.address_characteristic_2.0.0_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_2.0.0_Text' + required: + - technicalKey + - value + urn_bamm_io.catenax.shared.address_characteristic_2.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_bamm_io.catenax.shared.address_characteristic_2.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_bamm_io.catenax.shared.address_characteristic_2.0.0_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_2.0.0_Text' + required: + - technicalKey + - value + urn_bamm_io.catenax.shared.address_characteristic_2.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_bamm_io.catenax.shared.address_characteristic_2.0.0_CountryEntity: + description: Characteristic of a country belonging to an address + type: object + properties: + shortName: + $ref: '#/components/schemas/urn_bamm_io.catenax.shared.address_characteristic_2.0.0_CountryTrait' + required: + - shortName + urn_bamm_io.catenax.shared.address_characteristic_2.0.0_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_2.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_bamm_io.catenax.shared.address_characteristic_2.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. "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_2.0.0_PostCodeTrait' + technicalKey: + description: The technical key of a post code + $ref: '#/components/schemas/urn_bamm_io.catenax.shared.address_characteristic_2.0.0_PostCodeTechnicalKeyCharacteristic' + required: + - value + - technicalKey + urn_bamm_io.catenax.shared.address_characteristic_2.0.0_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_2.0.0_ThoroughfareEntity' + locality: + description: Locality belonging to an address + $ref: '#/components/schemas/urn_bamm_io.catenax.shared.address_characteristic_2.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_bamm_io.catenax.shared.address_characteristic_2.0.0_PremiseEntity' + postalDeliveryPoint: + description: "Delivery point, e.g. designation of a gate" + $ref: '#/components/schemas/urn_bamm_io.catenax.shared.address_characteristic_2.0.0_PostalDeliveryPointEntity' + country: + description: Country of an address + $ref: '#/components/schemas/urn_bamm_io.catenax.shared.address_characteristic_2.0.0_CountryEntity' + postCode: + $ref: '#/components/schemas/urn_bamm_io.catenax.shared.address_characteristic_2.0.0_PostCodeEntity' + required: + - thoroughfare + - locality + - country + - postCode + AddressAspect: + description: Aspect used for the Characteristic :PostalAddress to reference + adress data + type: object + properties: + address: + description: the adress of the data provider + $ref: '#/components/schemas/urn_bamm_io.catenax.shared.address_characteristic_2.0.0_PostalAddress' + required: + - address + 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' + AddressAspect: + content: + application/json: + schema: + $ref: '#/components/schemas/AddressAspect' + description: The request was successful. + requestBodies: + AddressAspect: + content: + application/json: + schema: + $ref: '#/components/schemas/AddressAspect' diff --git a/io.catenax.shared.contact_information/2.0.0/gen/ContactInformation-aas.xml b/io.catenax.shared.contact_information/2.0.0/gen/ContactInformation-aas.xml new file mode 100644 index 00000000..97ed032b --- /dev/null +++ b/io.catenax.shared.contact_information/2.0.0/gen/ContactInformation-aas.xml @@ -0,0 +1,275 @@ + +++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}|)+
++++Locality Entity
++ Entity for a locality which consists of a key and a value. ++ +++Properties
++ ++++ +Technical key of a locality + +Locality Technical Key
+++ + + +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++ ++++ +Value of a locality, e.g. name of a city ("Mannheim"). + +Locality Value
+++ + + +Name+localityValue+++ +Characteristic++++++++ Typ http://www.w3.org/2001/XMLSchema#string + ++++ +Beispiel+Mannheim+++ +Optional++ Nein+++ +Im Payload++ Ja+++ + +Payload Schlüssel+value+++ +++PostCode Entity
++ Entity for a postcode which consists of a type plus a value ++ +++Properties
++ ++++ +The value of a post code + +Post Code Value
+++ + + +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}$+
+ ++++ +The technical key of a post code + +Post Code Technical Key
+++ + + +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
++ ++++ +Technical key of a postal delivery point + +Postal Delivery Point Technical Key
+++ + + +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++ ++++ +Value of a postal delivery point, e.g. designation of a gate + +Postal Delivery Point Value
+++ + + +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
++ ++++ +Technical key of a premise + +Premise Technical Key
+++ + + +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++ ++++ +Value of a premise, e.g. name or designation of a particular site + +Premise Value
+++ + + +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
++ ++++ +Technical key of a thoroughfare. As specified by BPDM, this can be a "STREET" or a different type. + +Thoroughfare Technical Key
+++ + + +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 of a thoroughfare, e.g. name of a street. + +Value Thoroughfare
+++ + + +Name+thoroughfareValue+++ +Characteristic++++++++ Typ http://www.w3.org/2001/XMLSchema#string + ++++ +Beispiel+Bernstraße+++ +Optional++ Nein+++ +Im Payload++ Ja+++ + +Payload Schlüssel+value++ ++++ +Number of a thoroughfare. As used differently in international context, this number can contain both numerical and alphanumerical values + +Thoroughfare Number
+++ + + +Name+thoroughfareNumber+++ +Characteristic++++++++ Typ http://www.w3.org/2001/XMLSchema#string + ++++ +Beispiel+45+++ +Optional++ Nein+++ +Im Payload++ Ja+++ + +Payload Schlüssel+number++ Third party licenses + ++ +defaultAdminShell +defaultAsset +ContactInformation +APPLICATION_CLASS +urn:bamm:io.catenax.shared.contact_information:2.0.0#ContactInformation +WebsiteCharacteristic +urn:bamm:io.catenax.shared.contact_information:2.0.0#website +PhoneNumberTrait +urn:bamm:io.catenax.shared.contact_information:2.0.0#phoneNumber +EMailTrait +urn:bamm:io.catenax.shared.contact_information:2.0.0#email +PhoneNumberTrait +urn:bamm:io.catenax.shared.contact_information:2.0.0#faxNumber +ContactCharacteristic +urn:bamm:io.catenax.shared.contact_information:2.0.0#contactProperty +ContactInformation +Template ++ ++ +urn:bamm:io.catenax.shared.contact_information:2.0.0#ContactInformation +ContactEntity +false +false +website +Template ++ ++ +urn:bamm:io.catenax.shared.contact_information:2.0.0#website +DefaultScalarValue[value=https://www.samsung.com, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#anyURI']'] +http://www.w3.org/2001/XMLSchema#anyURI +phoneNumber +Template ++ ++ +urn:bamm:io.catenax.shared.contact_information:2.0.0#phoneNumber +DefaultScalarValue[value=+49 89 1234567890, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']'] +http://www.w3.org/2001/XMLSchema#string +email +Template ++ ++ +urn:bamm:io.catenax.shared.contact_information:2.0.0#email +DefaultScalarValue[value=test.mail@example.com, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']'] +http://www.w3.org/2001/XMLSchema#string +faxNumber +Template ++ ++ +urn:bamm:io.catenax.shared.contact_information:2.0.0#faxNumber +DefaultScalarValue[value=+49 89 0987654321, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']'] +http://www.w3.org/2001/XMLSchema#string +Dokumentation Contact information + + ++ + +++++Aspect Model Contact information
+urn:bamm:io.catenax.shared.contact_information:2.0.0#ContactInformation++ +++ + + + ++ Entity encapsulating the contact details ++ + +++Übersicht
+++ + +++++
+ ++ + + +++ +Properties
++ ++++ +Property describing contact information for an organization + +Contact Property
+++ + + +Name+contactProperty+++ + +Characteristic+++++++ +SingleEntity+++ +Optional++ Nein+++ +Im Payload++ Ja+++ + +Payload Schlüssel+contactProperty++++ +Objekt
++++Contact Entity
++ Entity to bundle the properties for the information on how to contact an organization ++ +++Properties
++ ++++ +Website of the contact. + +website
+++ + + +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++ ++ + + + + + \ No newline at end of file diff --git a/io.catenax.shared.contact_information/2.0.0/gen/ContactInformation.json b/io.catenax.shared.contact_information/2.0.0/gen/ContactInformation.json new file mode 100644 index 00000000..d3ed71fa --- /dev/null +++ b/io.catenax.shared.contact_information/2.0.0/gen/ContactInformation.json @@ -0,0 +1,8 @@ +{ + "contactProperty" : { + "faxNumber" : "+49 89 0987654321", + "website" : "https://www.samsung.com", + "phoneNumber" : "+49 89 1234567890", + "email" : "test.mail@example.com" + } +} \ No newline at end of file diff --git a/io.catenax.shared.contact_information/2.0.0/gen/ContactInformation.yml b/io.catenax.shared.contact_information/2.0.0/gen/ContactInformation.yml new file mode 100644 index 00000000..addf00a5 --- /dev/null +++ b/io.catenax.shared.contact_information/2.0.0/gen/ContactInformation.yml @@ -0,0 +1,128 @@ +--- +openapi: 3.0.3 +info: + title: Contact information + version: v2 +servers: +- url: catenax.io/api/v2 + variables: + api-version: + default: v2 +paths: + /{tenant-id}/contact-information: + get: + tags: + - ContactInformation + operationId: getContactInformation + 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/ContactInformation' + "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.shared.contact_information_2.0.0_WebsiteCharacteristic: + type: string + format: uri + description: Address of the website + urn_bamm_io.catenax.shared.contact_information_2.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_2.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_2.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_2.0.0_WebsiteCharacteristic' + phoneNumber: + description: Phone number with country and area code + $ref: '#/components/schemas/urn_bamm_io.catenax.shared.contact_information_2.0.0_PhoneNumberTrait' + email: + description: An email address + $ref: '#/components/schemas/urn_bamm_io.catenax.shared.contact_information_2.0.0_EMailTrait' + faxNumber: + description: Fax number with country and area code + $ref: '#/components/schemas/urn_bamm_io.catenax.shared.contact_information_2.0.0_PhoneNumberTrait' + ContactInformation: + description: Entity encapsulating the contact details + type: object + properties: + contactProperty: + description: Property describing contact information for an organization + $ref: '#/components/schemas/urn_bamm_io.catenax.shared.contact_information_2.0.0_ContactCharacteristic' + required: + - contactProperty + 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' + ContactInformation: + content: + application/json: + schema: + $ref: '#/components/schemas/ContactInformation' + description: The request was successful. + requestBodies: + ContactInformation: + content: + application/json: + schema: + $ref: '#/components/schemas/ContactInformation' diff --git a/io.catenax.shared.physical_dimension/2.0.0/gen/PhysicalDimensions-aas.xml b/io.catenax.shared.physical_dimension/2.0.0/gen/PhysicalDimensions-aas.xml new file mode 100644 index 00000000..5526fffb --- /dev/null +++ b/io.catenax.shared.physical_dimension/2.0.0/gen/PhysicalDimensions-aas.xml @@ -0,0 +1,345 @@ + +++ +Phone number with country and area code + +phone number
+++ + + +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 ]+$+
+ ++ +++ +An email address + +email
+++ + + +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-]+)*$+
+ ++++ +Fax number with country and area code + +faxNumber
+++ + + +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 ]+$+
+ Third party licenses + ++ +defaultAdminShell +defaultAsset +PhysicalDimensions +APPLICATION_CLASS +urn:bamm:io.catenax.shared.physical_dimension:2.0.0#PhysicalDimensions +KilogramCharacteristic +urn:bamm:io.catenax.shared.physical_dimension:2.0.0#weight +MillimetreCharacteristic +urn:bamm:io.catenax.shared.physical_dimension:2.0.0#diameter +MillimetreCharacteristic +urn:bamm:io.catenax.shared.physical_dimension:2.0.0#height +MillimetreCharacteristic +urn:bamm:io.catenax.shared.physical_dimension:2.0.0#width +MillimetreCharacteristic +urn:bamm:io.catenax.shared.physical_dimension:2.0.0#length +PhysicalDimensionsCharacteristic +urn:bamm:io.catenax.shared.physical_dimension:2.0.0#physicalDimensionsProperty +PhysicalDimensions +Template ++ ++ +urn:bamm:io.catenax.shared.physical_dimension:2.0.0#PhysicalDimensions +PhysicalDimensionsEntity +false +false +weight +Template ++ ++ +urn:bamm:io.catenax.shared.physical_dimension:2.0.0#weight +DefaultScalarValue[value=100.7, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#double']'] +http://www.w3.org/2001/XMLSchema#double +diameter +Template ++ ++ +urn:bamm:io.catenax.shared.physical_dimension:2.0.0#diameter +DefaultScalarValue[value=0.03, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#double']'] +http://www.w3.org/2001/XMLSchema#double +height +Template ++ ++ +urn:bamm:io.catenax.shared.physical_dimension:2.0.0#height +DefaultScalarValue[value=0.1, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#double']'] +http://www.w3.org/2001/XMLSchema#double +width +Template ++ ++ +urn:bamm:io.catenax.shared.physical_dimension:2.0.0#width +DefaultScalarValue[value=1000.0, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#double']'] +http://www.w3.org/2001/XMLSchema#double +length +Template ++ ++ +urn:bamm:io.catenax.shared.physical_dimension:2.0.0#length +DefaultScalarValue[value=20000.1, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#double']'] +http://www.w3.org/2001/XMLSchema#double +Dokumentation physical dimensions + + ++ + +++++Aspect Model physical dimensions
+urn:bamm:io.catenax.shared.physical_dimension:2.0.0#PhysicalDimensions++ +++ + + + + \ No newline at end of file diff --git a/io.catenax.shared.physical_dimension/2.0.0/gen/PhysicalDimensions.json b/io.catenax.shared.physical_dimension/2.0.0/gen/PhysicalDimensions.json new file mode 100644 index 00000000..028bf9b3 --- /dev/null +++ b/io.catenax.shared.physical_dimension/2.0.0/gen/PhysicalDimensions.json @@ -0,0 +1,9 @@ +{ + "physicalDimensionsProperty" : { + "width" : 1000.0, + "length" : 20000.1, + "weight" : 100.7, + "diameter" : 0.03, + "height" : 0.1 + } +} \ No newline at end of file diff --git a/io.catenax.shared.physical_dimension/2.0.0/gen/PhysicalDimensions.yml b/io.catenax.shared.physical_dimension/2.0.0/gen/PhysicalDimensions.yml new file mode 100644 index 00000000..6c909594 --- /dev/null +++ b/io.catenax.shared.physical_dimension/2.0.0/gen/PhysicalDimensions.yml @@ -0,0 +1,124 @@ +--- +openapi: 3.0.3 +info: + title: physical dimensions + version: v2 +servers: +- url: catenax.io/api/v2 + variables: + api-version: + default: v2 +paths: + /{tenant-id}/physical-dimensions: + get: + tags: + - PhysicalDimensions + operationId: getPhysicalDimensions + 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/PhysicalDimensions' + "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.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' + PhysicalDimensions: + description: Describes the physical dimensions of then entity. + type: object + properties: + physicalDimensionsProperty: + description: Describes the physical dimensions of then entity. + $ref: '#/components/schemas/urn_bamm_io.catenax.shared.physical_dimension_2.0.0_PhysicalDimensionsCharacteristic' + required: + - physicalDimensionsProperty + 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' + PhysicalDimensions: + content: + application/json: + schema: + $ref: '#/components/schemas/PhysicalDimensions' + description: The request was successful. + requestBodies: + PhysicalDimensions: + content: + application/json: + schema: + $ref: '#/components/schemas/PhysicalDimensions' 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 new file mode 100644 index 00000000..67515d11 --- /dev/null +++ b/io.catenax.single_level_bom_as_planned/1.1.0/gen/SingleLevelBomAsPlanned-aas.xml @@ -0,0 +1,589 @@ + ++ + ++ + ++ Describes the physical dimensions of then entity. ++ + +++Übersicht
+++ + +++++
+ ++ + + +++ +Properties
++ ++++ +Describes the physical dimensions of then entity. + +physical dimensions
+++ + + +Name+physicalDimensionsProperty+++ + +Characteristic+++++++ +SingleEntity+++ +Optional++ Nein+++ +Im Payload++ Ja+++ + +Payload Schlüssel+physicalDimensionsProperty+++ +++ +Objekt
+++++physical dimensions
++ Entity encapsulating the physical dimensions of an object. ++ +++Properties
++ ++++ +Weight of the item + +weight
+++ + + +Name+weight+++ +Characteristic+++++++Measurement+++a measurement value given in the unit kilogram+++Einheit+++++-
+
- + kilogram + +
- + Symbol kg + +
- + Code KGM + +
+++ Typ http://www.w3.org/2001/XMLSchema#double + ++++ +Beispiel+100.7+++ +Optional++ Ja+++ +Im Payload++ Ja+++ + +Payload Schlüssel+weight++ ++++ +Diameter of the item. + +diameter
+++ + + +Name+diameter+++ +Characteristic+++++++Measurement+++a measurement for a lenght given in the unit millimetre+++Einheit+++++-
+
- + millimetre + +
- + Symbol mm + +
- + Code MMT + +
- + Überführungsfaktor 10⁻³ m + +
+++ Typ http://www.w3.org/2001/XMLSchema#double + ++++ +Beispiel+0.03+++ +Optional++ Ja+++ +Im Payload++ Ja+++ + +Payload Schlüssel+diameter++ ++++ +Height of the item. + +height
+++ + + +Name+height+++ +Characteristic+++++++Measurement+++a measurement for a lenght given in the unit millimetre+++Einheit+++++-
+
- + millimetre + +
- + Symbol mm + +
- + Code MMT + +
- + Überführungsfaktor 10⁻³ m + +
+++ Typ http://www.w3.org/2001/XMLSchema#double + ++++ +Beispiel+0.1+++ +Optional++ Ja+++ +Im Payload++ Ja+++ + +Payload Schlüssel+height++ ++++ +Width of the item. + +width
+++ + + +Name+width+++ +Characteristic+++++++Measurement+++a measurement for a lenght given in the unit millimetre+++Einheit+++++-
+
- + millimetre + +
- + Symbol mm + +
- + Code MMT + +
- + Überführungsfaktor 10⁻³ m + +
+++ Typ http://www.w3.org/2001/XMLSchema#double + ++++ +Beispiel+1000.0+++ +Optional++ Ja+++ +Im Payload++ Ja+++ + +Payload Schlüssel+width++ ++++ +Length of the item. + +length
+++ + + +Name+length+++ +Characteristic+++++++Measurement+++a measurement for a lenght given in the unit millimetre+++Einheit+++++-
+
- + millimetre + +
- + Symbol mm + +
- + Code MMT + +
- + Überführungsfaktor 10⁻³ m + +
+++ Typ http://www.w3.org/2001/XMLSchema#double + ++++ +Beispiel+20000.1+++ +Optional++ Ja+++ +Im Payload++ Ja+++ + +Payload Schlüssel+length++ Third party licenses + ++ +defaultAdminShell +defaultAsset +SingleLevelBomAsPlanned +APPLICATION_CLASS +urn:bamm:io.catenax.single_level_bom_as_planned:1.1.0#SingleLevelBomAsPlanned +CatenaXIdTraitCharacteristic +urn:bamm:io.catenax.single_level_bom_as_planned:1.1.0#catenaXId +Timestamp +urn:bamm:io.catenax.single_level_bom_as_planned:1.1.0#createdOn +NumberofObjects +urn:bamm:io.catenax.single_level_bom_as_planned:1.1.0#quantityNumber +UnitReference +urn:bamm:io.catenax.single_level_bom_as_planned:1.1.0#measurementUnit +QuantityCharacteristic +urn:bamm:io.catenax.single_level_bom_as_planned:1.1.0#quantity +Timestamp +urn:bamm:io.catenax.single_level_bom_as_planned:1.1.0#lastModifiedOn +CatenaXIdTraitCharacteristic +urn:bamm:io.catenax.single_level_bom_as_planned:1.1.0#childCatenaXId +Timestamp +urn:bamm:io.catenax.single_level_bom_as_planned:1.1.0#validFrom +Timestamp +urn:bamm:io.catenax.single_level_bom_as_planned:1.1.0#validTo +ValidityPeriodCharacteristic +urn:bamm:io.catenax.single_level_bom_as_planned:1.1.0#validityPeriod +SetOfChildPartsCharacteristic +urn:bamm:io.catenax.single_level_bom_as_planned:1.1.0#childParts +SingleLevelBomAsPlanned +Template ++ ++ +urn:bamm:io.catenax.single_level_bom_as_planned:1.1.0#SingleLevelBomAsPlanned +catenaXId +Template ++ ++ +urn:bamm:io.catenax.single_level_bom_as_planned:1.1.0#catenaXId +DefaultScalarValue[value=urn:uuid:055c1128-0375-47c8-98de-7cf802c3241d, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']'] +http://www.w3.org/2001/XMLSchema#string +childParts +false +false +ChildData +false +false +createdOn +Template ++ ++ +urn:bamm:io.catenax.single_level_bom_as_planned:1.1.0#createdOn +DefaultScalarValue[value=2022-02-03T14:48:54.709Z, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#dateTime']'] +http://www.w3.org/2001/XMLSchema#dateTime +Quantity +false +false +quantityNumber +Template ++ ++ +urn:bamm:io.catenax.single_level_bom_as_planned:1.1.0#quantityNumber +DefaultScalarValue[value=2.5, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#double']'] +http://www.w3.org/2001/XMLSchema#double +measurementUnit +Template ++ ++ +urn:bamm:io.catenax.single_level_bom_as_planned:1.1.0#measurementUnit +DefaultScalarValue[value=unit:litre, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='urn:bamm:io.openmanufacturing:meta-model:2.0.0#curie']'] +urn:bamm:io.openmanufacturing:meta-model:2.0.0#curie +lastModifiedOn +Template ++ ++ +urn:bamm:io.catenax.single_level_bom_as_planned:1.1.0#lastModifiedOn +DefaultScalarValue[value=2022-02-03T14:48:54.709Z, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#dateTime']'] +http://www.w3.org/2001/XMLSchema#dateTime +childCatenaXId +Template ++ ++ +urn:bamm:io.catenax.single_level_bom_as_planned:1.1.0#childCatenaXId +Unknown +http://www.w3.org/2001/XMLSchema#string +ValidityPeriodEntity +false +false +validFrom +Template ++ ++ +urn:bamm:io.catenax.single_level_bom_as_planned:1.1.0#validFrom +DefaultScalarValue[value=2023-03-21T08:17:29.187+01:00, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#dateTime']'] +http://www.w3.org/2001/XMLSchema#dateTime +validTo +Template ++ ++ +urn:bamm:io.catenax.single_level_bom_as_planned:1.1.0#validTo +DefaultScalarValue[value=2024-07-01T16:10:00.000+01:00, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#dateTime']'] +http://www.w3.org/2001/XMLSchema#dateTime +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
+++ + +++++
+ +++ +Properties
++ ++ + + +++ +The Catena-X ID of the given part (e.g. the component), valid for the Catena-X dataspace. + +Catena-X Identifier
+++ + + +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}$)+
+ ++++ +Set of child parts in As-Planned lifecycle phase, of which the given parent object is assembled by (one structural level down). + +Child Parts
+++ + + +Name+childParts+++ + +Characteristic+++++++Set+++Has no order+++ +Duplicates not allowed+++ +Optional++ Nein+++ +Im Payload++ Ja+++ + +Payload Schlüssel+childParts+++ + + + + + \ 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 new file mode 100644 index 00000000..a753b3c9 --- /dev/null +++ b/io.catenax.single_level_bom_as_planned/1.1.0/gen/SingleLevelBomAsPlanned.json @@ -0,0 +1,16 @@ +{ + "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 new file mode 100644 index 00000000..f05e7ecc --- /dev/null +++ b/io.catenax.single_level_bom_as_planned/1.1.0/gen/SingleLevelBomAsPlanned.yml @@ -0,0 +1,226 @@ +--- +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.transmission.transmission_pass/1.0.0/gen/TransmissionPass-aas.xml b/io.catenax.transmission.transmission_pass/1.0.0/gen/TransmissionPass-aas.xml new file mode 100644 index 00000000..e1ccd5d0 --- /dev/null +++ b/io.catenax.transmission.transmission_pass/1.0.0/gen/TransmissionPass-aas.xml @@ -0,0 +1,4239 @@ + +++ +Objekt
+++ +++Child Data
++ Catena-X ID and meta data of the child part. ++ +++Properties
++ ++++ +Timestamp when the relation between the parent part and the child part was created + +Created on
+++ + + +Name+createdOn+++ +Characteristic++++++ ++++ +Beispiel+2022-02-03T14:48:54.709Z+++ +Optional++ Nein+++ +Im Payload++ Ja+++ + +Payload Schlüssel+createdOn++ ++++ +Quantity of which the child part is assembled into the parent part. + +Quantity
+++ + + +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.+++ +Optional++ Nein+++ +Im Payload++ Ja+++ + +Payload Schlüssel+quantity++ ++++ +Timestamp when the relationship between parent part and child part was last modified. + +Last Modified on
+++ + + +Name+lastModifiedOn+++ +Characteristic++++++ ++++ +Beispiel+2022-02-03T14:48:54.709Z+++ +Optional++ Ja+++ +Im Payload++ Ja+++ + +Payload Schlüssel+lastModifiedOn++ ++++ +The Catena-X ID of the child object which is assembled into the given parent part. + +Catena-X Child ID
+++ + + +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}$)+
+ ++++ +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. + +Validity Period
+++ + + +Name+validityPeriod+++ + +Characteristic+++++++ +SingleEntity+++ +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
++ ++++ +The number of objects related to the measurement unit + +Quantity Number
+++ + + +Name+quantityNumber+++ +Characteristic++++++++ Typ http://www.w3.org/2001/XMLSchema#double + ++++ +Beispiel+2.5+++ +Optional++ Nein+++ +Im Payload++ Ja+++ + +Payload Schlüssel+quantityNumber++ ++++ +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". + +Measurement Unit
+++ + + +Name+measurementUnit+++ +Characteristic++++++ ++++ +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
++ ++++ +Start date of validity period + +Valid from
+++ + + +Name+validFrom+++ +Characteristic++++++ ++++ +Beispiel+2023-03-21T08:17:29.187+01:00+++ +Optional++ Ja+++ +Im Payload++ Ja+++ + +Payload Schlüssel+validFrom++ ++++ +End date of validity period + +Valid to
+++ + + +Name+validTo+++ +Characteristic++++++ ++++ +Beispiel+2024-07-01T16:10:00.000+01:00+++ +Optional++ Ja+++ +Im Payload++ Ja+++ + +Payload Schlüssel+validTo++ Third party licenses + ++ +defaultAdminShell +defaultAsset +TransmissionPass +APPLICATION_CLASS +urn:bamm:io.catenax.transmission.transmission_pass:1.0.0#TransmissionPass +DocumentTitleTrait +urn:bamm:io.catenax.transmission.transmission_pass:1.0.0#documentTitle +Text +urn:bamm:io.catenax.transmission.transmission_pass:1.0.0#documentLink +DocumentsCharacteristic +urn:bamm:io.catenax.transmission.transmission_pass:1.0.0#responsibleSourcingDocument +Co2Total +urn:bamm:io.catenax.transmission.transmission_pass:1.0.0#co2FootprintTotal +ProductOrSectorSpecificRuleOperator +urn:bamm:io.catenax.pcf:3.0.0#operator +RuleNamesTrait +urn:bamm:io.catenax.pcf:3.0.0#ruleNames +Text +urn:bamm:io.catenax.pcf:3.0.0#otherOperatorName +ProductOrSectorSpecificRuleSet +urn:bamm:io.catenax.transmission.transmission_pass:1.0.0#productOrSectorSpecificRules +CrossSectoralStandardsUsedEnumerationCharacteristic +urn:bamm:io.catenax.pcf:3.0.0#crossSectoralStandard +CrossSectoralStandardsUsedListCharacteristic +urn:bamm:io.catenax.transmission.transmission_pass:1.0.0#crossSectoralStandardsUsed +CarbonFootprint +urn:bamm:io.catenax.transmission.transmission_pass:1.0.0#carbonFootprint +SubstancePercentage +urn:bamm:io.catenax.transmission.transmission_pass:1.0.0#substancePercentage +Text +urn:bamm:io.catenax.transmission.transmission_pass:1.0.0#substanceName +OtherSubstance +urn:bamm:io.catenax.transmission.transmission_pass:1.0.0#otherSubstance +SubstancePercentage +urn:bamm:io.catenax.transmission.transmission_pass:1.0.0#cobalt +SubstancePercentage +urn:bamm:io.catenax.transmission.transmission_pass:1.0.0#nickel +SubstancePercentage +urn:bamm:io.catenax.transmission.transmission_pass:1.0.0#lithium +RecyclateContent +urn:bamm:io.catenax.transmission.transmission_pass:1.0.0#recyclateContent +StringList +urn:bamm:io.catenax.transmission.transmission_pass:1.0.0#criticalRawMaterials +StringList +urn:bamm:io.catenax.transmission.transmission_pass:1.0.0#substancesOfConcern +Sustainability +urn:bamm:io.catenax.transmission.transmission_pass:1.0.0#sustainability +ProductDescription +urn:bamm:io.catenax.transmission.transmission_pass:1.0.0#productDescription +Text +urn:bamm:io.catenax.transmission.transmission_pass:1.0.0#productType +Text +urn:bamm:io.catenax.transmission.transmission_pass:1.0.0#additionalInformation +WarrantyPeriod +urn:bamm:io.catenax.transmission.transmission_pass:1.0.0#warrantyPeriod +KilogramCharacteristic +urn:bamm:io.catenax.shared.physical_dimension:2.0.0#weight +MillimetreCharacteristic +urn:bamm:io.catenax.shared.physical_dimension:2.0.0#diameter +MillimetreCharacteristic +urn:bamm:io.catenax.shared.physical_dimension:2.0.0#height +MillimetreCharacteristic +urn:bamm:io.catenax.shared.physical_dimension:2.0.0#width +MillimetreCharacteristic +urn:bamm:io.catenax.shared.physical_dimension:2.0.0#length +PhysicalDimensionsCharacteristic +urn:bamm:io.catenax.transmission.transmission_pass:1.0.0#physicalDimensionsProperty +GeneralInformation +urn:bamm:io.catenax.transmission.transmission_pass:1.0.0#generalInformation +ProductStatusEnumeration +urn:bamm:io.catenax.transmission.transmission_pass:1.0.0#productStatusValue +Timestamp +urn:bamm:io.catenax.transmission.transmission_pass:1.0.0#remanufacturingDate +Remanufacturing +urn:bamm:io.catenax.transmission.transmission_pass:1.0.0#remanufacturing +ServiceHistory +urn:bamm:io.catenax.transmission.transmission_pass:1.0.0#serviceHistory +ExpectedLifespan +urn:bamm:io.catenax.transmission.transmission_pass:1.0.0#expectedLifespan +StateOfHealth +urn:bamm:io.catenax.transmission.transmission_pass:1.0.0#stateOfHealth +WebsiteCharacteristic +urn:bamm:io.catenax.shared.contact_information:2.0.0#website +PhoneNumberTrait +urn:bamm:io.catenax.shared.contact_information:2.0.0#phoneNumber +EMailTrait +urn:bamm:io.catenax.shared.contact_information:2.0.0#email +PhoneNumberTrait +urn:bamm:io.catenax.shared.contact_information:2.0.0#faxNumber +ContactCharacteristic +urn:bamm:io.catenax.transmission.transmission_pass:1.0.0#supplierContact +Text +urn:bamm:io.catenax.transmission.transmission_pass:1.0.0#supplierId +Text +urn:bamm:io.catenax.transmission.transmission_pass:1.0.0#sparePartName +SparePartSupplier +urn:bamm:io.catenax.transmission.transmission_pass:1.0.0#sparePartSupplier +DriveTypeEnumeration +urn:bamm:io.catenax.transmission.transmission_pass:1.0.0#driveType +TorqueNewtonMetre +urn:bamm:io.catenax.transmission.transmission_pass:1.0.0#torque +PerformancePower +urn:bamm:io.catenax.transmission.transmission_pass:1.0.0#power +StringList +urn:bamm:io.catenax.transmission.transmission_pass:1.0.0#torqueConverter +GearTrait +urn:bamm:io.catenax.transmission.transmission_pass:1.0.0#gear +RevolutionsPerMinute +urn:bamm:io.catenax.transmission.transmission_pass:1.0.0#speed +SpeedResistance +urn:bamm:io.catenax.transmission.transmission_pass:1.0.0#speedResistance +GearTrait +urn:bamm:io.catenax.transmission.transmission_pass:1.0.0#gear +Ratio +urn:bamm:io.catenax.transmission.transmission_pass:1.0.0#ratio +StandardGearRatio +urn:bamm:io.catenax.transmission.transmission_pass:1.0.0#standardGearRatio +TransmissionSpreading +urn:bamm:io.catenax.transmission.transmission_pass:1.0.0#spreading +Capacity +urn:bamm:io.catenax.transmission.transmission_pass:1.0.0#oilCapacity +Text +urn:bamm:io.catenax.transmission.transmission_pass:1.0.0#oilType +StringList +urn:bamm:io.catenax.transmission.transmission_pass:1.0.0#electricPerformance +ProductSpecificParameters +urn:bamm:io.catenax.transmission.transmission_pass:1.0.0#productSpecificParameters +DocumentTitleTrait +urn:bamm:io.catenax.transmission.transmission_pass:1.0.0#documentTitle +Text +urn:bamm:io.catenax.transmission.transmission_pass:1.0.0#documentLink +DocumentsCharacteristic +urn:bamm:io.catenax.transmission.transmission_pass:1.0.0#dismantlingProcedure +DocumentTitleTrait +urn:bamm:io.catenax.transmission.transmission_pass:1.0.0#documentTitle +Text +urn:bamm:io.catenax.transmission.transmission_pass:1.0.0#documentLink +DocumentsCharacteristic +urn:bamm:io.catenax.transmission.transmission_pass:1.0.0#vehicleDismantlingProcedure +DocumentTitleTrait +urn:bamm:io.catenax.transmission.transmission_pass:1.0.0#documentTitle +Text +urn:bamm:io.catenax.transmission.transmission_pass:1.0.0#documentLink +DocumentsCharacteristic +urn:bamm:io.catenax.transmission.transmission_pass:1.0.0#packagingInstructions +DocumentTitleTrait +urn:bamm:io.catenax.transmission.transmission_pass:1.0.0#documentTitle +Text +urn:bamm:io.catenax.transmission.transmission_pass:1.0.0#documentLink +DocumentsCharacteristic +urn:bamm:io.catenax.transmission.transmission_pass:1.0.0#transportationInstructions +DocumentTitleTrait +urn:bamm:io.catenax.transmission.transmission_pass:1.0.0#documentTitle +Text +urn:bamm:io.catenax.transmission.transmission_pass:1.0.0#documentLink +DocumentsCharacteristic +urn:bamm:io.catenax.transmission.transmission_pass:1.0.0#safetyMeasures +Instructions +urn:bamm:io.catenax.transmission.transmission_pass:1.0.0#instructions +Text +urn:bamm:io.catenax.transmission.transmission_pass:1.0.0#dataMatrixCode +Text +urn:bamm:io.catenax.transmission.transmission_pass:1.0.0#manufacturerId +KeyCharacteristic +urn:bamm:io.catenax.serial_part_typization:2.0.0#key +ValueCharacteristic +urn:bamm:io.catenax.serial_part_typization:2.0.0#value +LocalIdentifierCharacteristic +urn:bamm:io.catenax.transmission.transmission_pass:1.0.0#localIdentifiers +Identification +urn:bamm:io.catenax.transmission.transmission_pass:1.0.0#identification +TransmissionPass +Template ++ ++ +urn:bamm:io.catenax.transmission.transmission_pass:1.0.0#TransmissionPass +SustainabilityDetails +false +false +responsibleSourcingDocument +false +true +Documents +false +false +documentTitle +Template ++ ++ +urn:bamm:io.catenax.transmission.transmission_pass:1.0.0#documentTitle +DefaultScalarValue[value=Title A, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']'] +http://www.w3.org/2001/XMLSchema#string +documentLink +Template ++ ++ +urn:bamm:io.catenax.transmission.transmission_pass:1.0.0#documentLink +DefaultScalarValue[value=https://www.xxx.pdf, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']'] +http://www.w3.org/2001/XMLSchema#string +CarbonFootprintEntity +false +false +co2FootprintTotal +Template ++ ++ +urn:bamm:io.catenax.transmission.transmission_pass:1.0.0#co2FootprintTotal +Unknown +http://www.w3.org/2001/XMLSchema#decimal +productOrSectorSpecificRules +false +false +ProductOrSectorSpecificRulesEntity +false +false +operator +Template ++ ++ +urn:bamm:io.catenax.pcf:3.0.0#operator +Unknown +http://www.w3.org/2001/XMLSchema#string +ruleNames +Template ++ ++ +urn:bamm:io.catenax.pcf:3.0.0#ruleNames +DefaultScalarValue[value=ABC 2021, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']'] +http://www.w3.org/2001/XMLSchema#string +otherOperatorName +Template ++ ++ +urn:bamm:io.catenax.pcf:3.0.0#otherOperatorName +DefaultScalarValue[value=NSF, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']'] +http://www.w3.org/2001/XMLSchema#string +crossSectoralStandardsUsed +false +true +CrossSectoralStandardEntity +false +false +crossSectoralStandard +Template ++ ++ +urn:bamm:io.catenax.pcf:3.0.0#crossSectoralStandard +Unknown +http://www.w3.org/2001/XMLSchema#string +RecyclateContentEntity +false +false +otherSubstance +false +true +OtherSubstanceEntity +false +false +substancePercentage +Template ++ ++ +urn:bamm:io.catenax.transmission.transmission_pass:1.0.0#substancePercentage +DefaultScalarValue[value=8.0, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#decimal']'] +http://www.w3.org/2001/XMLSchema#decimal +substanceName +Template ++ ++ +urn:bamm:io.catenax.transmission.transmission_pass:1.0.0#substanceName +DefaultScalarValue[value=Lead, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']'] +http://www.w3.org/2001/XMLSchema#string +cobalt +Template ++ ++ +urn:bamm:io.catenax.transmission.transmission_pass:1.0.0#cobalt +Unknown +http://www.w3.org/2001/XMLSchema#decimal +nickel +Template ++ ++ +urn:bamm:io.catenax.transmission.transmission_pass:1.0.0#nickel +Unknown +http://www.w3.org/2001/XMLSchema#decimal +lithium +Template ++ ++ +urn:bamm:io.catenax.transmission.transmission_pass:1.0.0#lithium +Unknown +http://www.w3.org/2001/XMLSchema#decimal +criticalRawMaterials +false +true +criticalRawMaterials +Template ++ ++ +urn:bamm:io.catenax.transmission.transmission_pass:1.0.0#criticalRawMaterials +Unknown +http://www.w3.org/2001/XMLSchema#string +substancesOfConcern +false +true +substancesOfConcern +Template ++ ++ +urn:bamm:io.catenax.transmission.transmission_pass:1.0.0#substancesOfConcern +Unknown +http://www.w3.org/2001/XMLSchema#string +GeneralInformationEntity +false +false +productDescription +Template ++ ++ +urn:bamm:io.catenax.transmission.transmission_pass:1.0.0#productDescription +Unknown +http://www.w3.org/2001/XMLSchema#string +productType +Template ++ ++ +urn:bamm:io.catenax.transmission.transmission_pass:1.0.0#productType +DefaultScalarValue[value=8HP60MH, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']'] +http://www.w3.org/2001/XMLSchema#string +additionalInformation +Template ++ ++ +urn:bamm:io.catenax.transmission.transmission_pass:1.0.0#additionalInformation +Unknown +http://www.w3.org/2001/XMLSchema#string +warrantyPeriod +Template ++ ++ +urn:bamm:io.catenax.transmission.transmission_pass:1.0.0#warrantyPeriod +DefaultScalarValue[value=60.0, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#decimal']'] +http://www.w3.org/2001/XMLSchema#decimal +PhysicalDimensionsEntity +false +false +weight +Template ++ ++ +urn:bamm:io.catenax.shared.physical_dimension:2.0.0#weight +DefaultScalarValue[value=100.7, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#double']'] +http://www.w3.org/2001/XMLSchema#double +diameter +Template ++ ++ +urn:bamm:io.catenax.shared.physical_dimension:2.0.0#diameter +DefaultScalarValue[value=0.03, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#double']'] +http://www.w3.org/2001/XMLSchema#double +height +Template ++ ++ +urn:bamm:io.catenax.shared.physical_dimension:2.0.0#height +DefaultScalarValue[value=0.1, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#double']'] +http://www.w3.org/2001/XMLSchema#double +width +Template ++ ++ +urn:bamm:io.catenax.shared.physical_dimension:2.0.0#width +DefaultScalarValue[value=1000.0, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#double']'] +http://www.w3.org/2001/XMLSchema#double +length +Template ++ ++ +urn:bamm:io.catenax.shared.physical_dimension:2.0.0#length +DefaultScalarValue[value=20000.1, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#double']'] +http://www.w3.org/2001/XMLSchema#double +StateOfHealthEntity +false +false +RemanufacturingStatus +false +false +productStatusValue +Template ++ ++ +urn:bamm:io.catenax.transmission.transmission_pass:1.0.0#productStatusValue +DefaultScalarValue[value=second life, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']'] +http://www.w3.org/2001/XMLSchema#string +remanufacturingDate +Template ++ ++ +urn:bamm:io.catenax.transmission.transmission_pass:1.0.0#remanufacturingDate +Unknown +http://www.w3.org/2001/XMLSchema#dateTime +serviceHistory +false +true +serviceHistory +Template ++ ++ +urn:bamm:io.catenax.transmission.transmission_pass:1.0.0#serviceHistory +Unknown +http://www.w3.org/2001/XMLSchema#dateTimeStamp +expectedLifespan +Template ++ ++ +urn:bamm:io.catenax.transmission.transmission_pass:1.0.0#expectedLifespan +DefaultScalarValue[value=500000, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#integer']'] +http://www.w3.org/2001/XMLSchema#integer +sparePartSupplier +false +true +SparePartEntity +false +false +ContactEntity +false +false +website +Template ++ ++ +urn:bamm:io.catenax.shared.contact_information:2.0.0#website +DefaultScalarValue[value=https://www.samsung.com, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#anyURI']'] +http://www.w3.org/2001/XMLSchema#anyURI +phoneNumber +Template ++ ++ +urn:bamm:io.catenax.shared.contact_information:2.0.0#phoneNumber +DefaultScalarValue[value=+49 89 1234567890, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']'] +http://www.w3.org/2001/XMLSchema#string +email +Template ++ ++ +urn:bamm:io.catenax.shared.contact_information:2.0.0#email +DefaultScalarValue[value=test.mail@example.com, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']'] +http://www.w3.org/2001/XMLSchema#string +faxNumber +Template ++ ++ +urn:bamm:io.catenax.shared.contact_information:2.0.0#faxNumber +DefaultScalarValue[value=+49 89 0987654321, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']'] +http://www.w3.org/2001/XMLSchema#string +supplierId +Template ++ ++ +urn:bamm:io.catenax.transmission.transmission_pass:1.0.0#supplierId +DefaultScalarValue[value=BPNL1234567890ZZ, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']'] +http://www.w3.org/2001/XMLSchema#string +sparePartName +Template ++ ++ +urn:bamm:io.catenax.transmission.transmission_pass:1.0.0#sparePartName +DefaultScalarValue[value=torque converter, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']'] +http://www.w3.org/2001/XMLSchema#string +ProductSpecificParametersEntity +false +false +driveType +Template ++ ++ +urn:bamm:io.catenax.transmission.transmission_pass:1.0.0#driveType +DefaultScalarValue[value=hybrid drive, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']'] +http://www.w3.org/2001/XMLSchema#string +torque +Template ++ ++ +urn:bamm:io.catenax.transmission.transmission_pass:1.0.0#torque +DefaultScalarValue[value=500.0, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#decimal']'] +http://www.w3.org/2001/XMLSchema#decimal +power +Template ++ ++ +urn:bamm:io.catenax.transmission.transmission_pass:1.0.0#power +DefaultScalarValue[value=300.0, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#decimal']'] +http://www.w3.org/2001/XMLSchema#decimal +torqueConverter +false +true +torqueConverter +Template ++ ++ +urn:bamm:io.catenax.transmission.transmission_pass:1.0.0#torqueConverter +Unknown +http://www.w3.org/2001/XMLSchema#string +SpeedResistanceEntity +false +false +gear +Template ++ ++ +urn:bamm:io.catenax.transmission.transmission_pass:1.0.0#gear +DefaultScalarValue[value=1, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']'] +http://www.w3.org/2001/XMLSchema#string +speed +Template ++ ++ +urn:bamm:io.catenax.transmission.transmission_pass:1.0.0#speed +DefaultScalarValue[value=7800, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#integer']'] +http://www.w3.org/2001/XMLSchema#integer +GearRatio +false +false +gear +Template ++ ++ +urn:bamm:io.catenax.transmission.transmission_pass:1.0.0#gear +DefaultScalarValue[value=1, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']'] +http://www.w3.org/2001/XMLSchema#string +ratio +Template ++ ++ +urn:bamm:io.catenax.transmission.transmission_pass:1.0.0#ratio +DefaultScalarValue[value=4.1567, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#double']'] +http://www.w3.org/2001/XMLSchema#double +spreading +Template ++ ++ +urn:bamm:io.catenax.transmission.transmission_pass:1.0.0#spreading +DefaultScalarValue[value=6.79, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#decimal']'] +http://www.w3.org/2001/XMLSchema#decimal +oilCapacity +Template ++ ++ +urn:bamm:io.catenax.transmission.transmission_pass:1.0.0#oilCapacity +DefaultScalarValue[value=8.9, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#decimal']'] +http://www.w3.org/2001/XMLSchema#decimal +oilType +Template ++ ++ +urn:bamm:io.catenax.transmission.transmission_pass:1.0.0#oilType +DefaultScalarValue[value=ZF Lifeguard Hybrid 2, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']'] +http://www.w3.org/2001/XMLSchema#string +electricPerformance +false +true +electricPerformance +Template ++ ++ +urn:bamm:io.catenax.transmission.transmission_pass:1.0.0#electricPerformance +Unknown +http://www.w3.org/2001/XMLSchema#string +InstructionEntity +false +false +dismantlingProcedure +false +true +Documents +false +false +documentTitle +Template ++ ++ +urn:bamm:io.catenax.transmission.transmission_pass:1.0.0#documentTitle +DefaultScalarValue[value=Title A, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']'] +http://www.w3.org/2001/XMLSchema#string +documentLink +Template ++ ++ +urn:bamm:io.catenax.transmission.transmission_pass:1.0.0#documentLink +DefaultScalarValue[value=https://www.xxx.pdf, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']'] +http://www.w3.org/2001/XMLSchema#string +vehicleDismantlingProcedure +false +true +Documents +false +false +documentTitle +Template ++ ++ +urn:bamm:io.catenax.transmission.transmission_pass:1.0.0#documentTitle +DefaultScalarValue[value=Title A, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']'] +http://www.w3.org/2001/XMLSchema#string +documentLink +Template ++ ++ +urn:bamm:io.catenax.transmission.transmission_pass:1.0.0#documentLink +DefaultScalarValue[value=https://www.xxx.pdf, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']'] +http://www.w3.org/2001/XMLSchema#string +packagingInstructions +false +true +Documents +false +false +documentTitle +Template ++ ++ +urn:bamm:io.catenax.transmission.transmission_pass:1.0.0#documentTitle +DefaultScalarValue[value=Title A, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']'] +http://www.w3.org/2001/XMLSchema#string +documentLink +Template ++ ++ +urn:bamm:io.catenax.transmission.transmission_pass:1.0.0#documentLink +DefaultScalarValue[value=https://www.xxx.pdf, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']'] +http://www.w3.org/2001/XMLSchema#string +transportationInstructions +false +true +Documents +false +false +documentTitle +Template ++ ++ +urn:bamm:io.catenax.transmission.transmission_pass:1.0.0#documentTitle +DefaultScalarValue[value=Title A, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']'] +http://www.w3.org/2001/XMLSchema#string +documentLink +Template ++ ++ +urn:bamm:io.catenax.transmission.transmission_pass:1.0.0#documentLink +DefaultScalarValue[value=https://www.xxx.pdf, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']'] +http://www.w3.org/2001/XMLSchema#string +safetyMeasures +false +true +Documents +false +false +documentTitle +Template ++ ++ +urn:bamm:io.catenax.transmission.transmission_pass:1.0.0#documentTitle +DefaultScalarValue[value=Title A, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']'] +http://www.w3.org/2001/XMLSchema#string +documentLink +Template ++ ++ +urn:bamm:io.catenax.transmission.transmission_pass:1.0.0#documentLink +DefaultScalarValue[value=https://www.xxx.pdf, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']'] +http://www.w3.org/2001/XMLSchema#string +IdentificationEntity +false +false +dataMatrixCode +Template ++ ++ +urn:bamm:io.catenax.transmission.transmission_pass:1.0.0#dataMatrixCode +Unknown +http://www.w3.org/2001/XMLSchema#string +manufacturerId +Template ++ ++ +urn:bamm:io.catenax.transmission.transmission_pass:1.0.0#manufacturerId +DefaultScalarValue[value=BPNL1234567890ZZ, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']'] +http://www.w3.org/2001/XMLSchema#string +localIdentifiers +false +false +KeyValueList +false +false +key +Template ++ ++ +urn:bamm:io.catenax.serial_part_typization:2.0.0#key +DefaultScalarValue[value=PartInstanceID, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']'] +http://www.w3.org/2001/XMLSchema#string +value +Template ++ ++ +urn:bamm:io.catenax.serial_part_typization:2.0.0#value +DefaultScalarValue[value=SN12345678, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']'] +http://www.w3.org/2001/XMLSchema#string +Dokumentation Transmission Pass + + ++ + +++++Aspect Model Transmission Pass
+urn:bamm:io.catenax.transmission.transmission_pass:1.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. ++ + +++Übersicht
+++ + +++++
+ ++ + + +++ +Properties
++ ++++ +Property describing general information about the transmission. + +General Information
+++ + + +Name+generalInformation+++ + +Characteristic+++++++ +SingleEntity+++ +Optional++ Nein+++ +Im Payload++ Ja+++ + +Payload Schlüssel+generalInformation++ ++++ +Identification parameters of the transmission. + +Identification
+++ + + +Name+identification+++ + +Characteristic+++++++ +SingleEntity+++ +Optional++ Nein+++ +Im Payload++ Ja+++ + +Payload Schlüssel+identification++ ++++ +Instructions concerning the transmission. + +Instructions
+++ + + +Name+instructions+++ + +Characteristic+++++++ +SingleEntity+++ +Optional++ Nein+++ +Im Payload++ Ja+++ + +Payload Schlüssel+instructions++ ++++ +Product specific parameters of the transmission. + +Product Specific Parameters
+++ + + +Name+productSpecificParameters+++ + +Characteristic+++++++ +SingleEntity+++ +Optional++ Nein+++ +Im Payload++ Ja+++ + +Payload Schlüssel+productSpecificParameters++ ++++ +Details of the spare parts and suppliers of replacement parts / spare parts. + +Spare Part Supplier
+++ + + +Name+sparePartSupplier+++ + +Characteristic+++++++List+++Sortierung+++ +Erlaubt Duplikate+++ +Optional++ Nein+++ +Im Payload++ Ja+++ + +Payload Schlüssel+sparePartSupplier++ ++++ +State of health property describing several properties. + +State of Health
+++ + + +Name+stateOfHealth+++ + +Characteristic+++++++ +SingleEntity+++ +Optional++ Nein+++ +Im Payload++ Ja+++ + +Payload Schlüssel+stateOfHealth++ ++++ +Sustainability details about the transmission. + +Sustainability
+++ + + +Name+sustainability+++ + +Characteristic+++++++ +SingleEntity+++ +Optional++ Nein+++ +Im Payload++ Ja+++ + +Payload Schlüssel+sustainability++++ +Objekt
+++++Carbon Footprint Entity
++ Entity encapsulating the carbon footprint. ++ +++Properties
++ ++++ +The total carbon footprint of the transmission, calculated as kg of carbon dioxide equivalent. + +CO2 Footprint Total
+++ + + +Name+co2FootprintTotal+++ + +Characteristic+++++++Quantifiable+++Duration+++Characteristic for the total carbon footprint of the transmission, calculated as kg of carbon dioxide equivalent.+++Einheit+++++-
+
- + kilogram + +
- + Symbol kg + +
- + Code KGM + +
+++ Typ http://www.w3.org/2001/XMLSchema#decimal + ++++ +Optional++ Nein+++ +Im Payload++ Ja+++ + +Payload Schlüssel+co2FootprintTotal++ ++++ +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. Specified by the WBCSD (World Business Council for Sustainable Development) Pathfinder initiative. + +Product or Sector Specific Rules
+++ + + +Name+productOrSectorSpecificRules+++ + +Characteristic+++++++Set+++Has no order+++Duplicates not allowed+++ ++ Referenz ++++-
+
- https://wbcsd.github.io/introduction/ +
++ +Optional++ Nein+++ +Im Payload++ Ja+++ +Payload Schlüssel+productOrSectorSpecificRules+++ +Referenz+++-
+
- https://wbcsd.github.io/introduction/ +
+ ++++ +Discloses the cross-sectoral standards applied for calculating or allocating GHG (Greenhouse Gas) emissions as specified by the WBCSD (World Business Council for Sustainable Development) Pathfinder initiative. + +Cross Sectoral Standards Used
+++ + + +Name+crossSectoralStandardsUsed+++ + +Characteristic+++++++List+++Sortierung+++Erlaubt Duplikate+++ ++ Referenz ++++-
+
- https://wbcsd.github.io/introduction/ +
++ +Optional++ Nein+++ +Im Payload++ Ja+++ +Payload Schlüssel+crossSectoralStandardsUsed+++ +Referenz+++-
+
- https://wbcsd.github.io/introduction/ +
+++Contact Entity
++ Entity to bundle the properties for the information on how to contact an organization ++ +++Properties
++ ++++ +Website of the contact. + +website
+++ + + +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 with country and area code + +phone number
+++ + + +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 ]+$+
+ +++ +An email address + +email
+++ + + +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-]+)*$+
+ ++++ +Fax number with country and area code + +faxNumber
+++ + + +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 ]+$+
++++Cross Sectoral Standard Entity
++ Entity for defining an accounting standard used for product carbon footprint calculation as specified by the WBCSD (World Business Council for Sustainable Development) Pathfinder initiative. +++ Referenz ++ +++-
+
- https://wbcsd.github.io/introduction/ +
++Properties
++ ++++ +Discloses a cross-sectoral standard applied for calculating or allocating GHG (Greenhouse Gas) emissions as specified by the WBCSD (World Business Council for Sustainable Development) Pathfinder initiative. + +Cross Sectoral Standard
+++ + + +Name+crossSectoralStandard+++ + +Characteristic+++++++Enumeration+++Werte+++++-
+
- GHG Protocol Product standard +
- ISO Standard 14067 +
- ISO Standard 14044 +
+++ Referenz ++++-
+
- https://wbcsd.github.io/introduction/ +
+++ Typ http://www.w3.org/2001/XMLSchema#string + ++++ +Optional++ Nein+++ +Im Payload++ Ja+++ +Payload Schlüssel+crossSectoralStandard+++ +Referenz+++-
+
- https://wbcsd.github.io/introduction/ +
+++Documents Entity
++ Entity describing a document. ++ +++Properties
++ ++++ +The header or title of the document + +Document Title
+++ + + +Name+documentTitle+++ +Characteristic+++++++Trait++++ Typ http://www.w3.org/2001/XMLSchema#string + ++++ +Beispiel+Title A+++ +Optional++ Ja+++ +Im Payload++ Ja+++ + +Payload Schlüssel+documentTitle+++Bedingungen+++-
+
-
++ +++ Max Title Characters Constraint ++ +++ + +Beschreibung+Maximum title characters set to 60.+++ + + +Max. Zeichen+60+
+ ++++ +A link referencing to the document. + +Document Link
+++ + + +Name+documentLink+++ +Characteristic++++++++ Typ http://www.w3.org/2001/XMLSchema#string + ++++ +Beispiel+https://www.xxx.pdf+++ +Optional++ Nein+++ +Im Payload++ Ja+++ + +Payload Schlüssel+documentLink++++Gear Ratio Entity
++ Entity for the ratio in the respective gear. Includes the gear and the ratio as separate properties. ++ +++Properties
++ ++++ +Respective gear for the speed resistance. + +Gear
+++ + + +Name+gear+++ +Characteristic+++++++Trait++++ Typ http://www.w3.org/2001/XMLSchema#string + ++++ +Beispiel+1+++ +Optional++ Nein+++ +Im Payload++ Ja+++ + +Payload Schlüssel+gear+++Bedingungen+++-
+
-
++ +++ Gear Constraint ++ +++ + +Beschreibung+Constraint to match a gear from 1 to 99 or R (reverse).+++ + + +Regulärer Ausdruck+^\d{1,2}|R$+
+ ++++ +The ratio in the respective gear (ratio between transmission input speed and transmission output speed). + +Ratio
+++ + + +Name+ratio+++ +Characteristic+++++++Quantifiable+++Duration+++The ratio in the respective gear.++++ Typ http://www.w3.org/2001/XMLSchema#double + ++++ +Beispiel+4.1567+++ +Optional++ Nein+++ +Im Payload++ Ja+++ + +Payload Schlüssel+ratio+++++General Information Entity
++ General Information Entity to describe several logical connected properties. ++ +++Properties
++ ++++ +The detailed description about the product type. + +Product Description
+++ + + +Name+productDescription+++ + +Characteristic+++++++Enumeration+++Werte+++++-
+
- manual transmission +
- automated manual transmission +
- automatic transmission +
- continuously variable automatic transmissions (CVT transmission) +
+++ Typ http://www.w3.org/2001/XMLSchema#string + ++++ +Optional++ Nein+++ +Im Payload++ Ja+++ +Payload Schlüssel+productDescription+++ +Referenz+++-
+
- https://eclass.eu/en/eclass-standard/search-content/show?tx_eclasssearch_ecsearch%5Bcc2prdat%5D=0173-1%2302-AAW338%23001&tx_eclasssearch_ecsearch%5Bdischarge%5D=0&tx_eclasssearch_ecsearch%5Bid%5D=-1&tx_eclasssearch_ecsearch%5Blanguage%5D=1&tx_eclasssearch_ecsearch%5Boption%5D=pr&tx_eclasssearch_ecsearch%5Bsearchtxt%5D=0173-1%2302-AAW338%23001&tx_eclasssearch_ecsearch%5Bversion%5D=12.0&cHash=5a17e1979515f3f8fbb7350e9f27a8f9 +
+ ++++ +Type of transmission for passenger cars. + +Product Type
+++ + + +Name+productType+++ +Characteristic++++++++ Typ http://www.w3.org/2001/XMLSchema#string + ++++ +Beispiel+8HP60MH+++ +Optional++ Nein+++ +Im Payload++ Ja+++ +Payload Schlüssel+productType+++ +Referenz+++-
+
- https://eclass.eu/en/eclass-standard/search-content/show?tx_eclasssearch_ecsearch%5Bcc2prdat%5D=0173-1%2302-AAW338%23001&tx_eclasssearch_ecsearch%5Bdischarge%5D=0&tx_eclasssearch_ecsearch%5Bid%5D=-1&tx_eclasssearch_ecsearch%5Blanguage%5D=1&tx_eclasssearch_ecsearch%5Boption%5D=pr&tx_eclasssearch_ecsearch%5Bsearchtxt%5D=0173-1%2302-AAW338%23001&tx_eclasssearch_ecsearch%5Bversion%5D=12.0&cHash=5a17e1979515f3f8fbb7350e9f27a8f9 +
+ ++++ +Open field for additional information such as a link. + +Additional Information
+++ + + +Name+additionalInformation+++ + +Characteristic++++++++ Typ http://www.w3.org/2001/XMLSchema#string + ++++ +Optional++ Nein+++ +Im Payload++ Ja+++ + +Payload Schlüssel+additionalInformation++ ++++ +Commercial warranty period of the transmission (coupled to the Vehicle) in months. + +Warranty Period
+++ + + +Name+warrantyPeriod+++ +Characteristic+++++++Measurement+++Commercial warranty period of the transmission (coupled to the Vehicle) in months as decimal.+++Einheit+++++-
+
- + month + +
- + Symbol mo + +
- + Code MON + +
- + Überführungsfaktor 2.629800 × 10⁶ s + +
+++ Typ http://www.w3.org/2001/XMLSchema#decimal + ++++ +Beispiel+60.0+++ +Optional++ Nein+++ +Im Payload++ Ja+++ +Payload Schlüssel+warrantyPeriod+++ +Referenz+++-
+
- https://eclass.eu/eclass-standard/content-suche/show?tx_eclasssearch_ecsearch%5Bdischarge%5D=0&tx_eclasssearch_ecsearch%5Bid%5D=25151705&tx_eclasssearch_ecsearch%5Blanguage%5D=1&tx_eclasssearch_ecsearch%5Bversion%5D=12.0&cHash=b331161d6c597f8648a931275fdc5c7f +
+ ++++ +Describes the physical dimensions of the entity. + +physical dimensions property
+++ + + +Name+physicalDimensionsProperty+++ + +Characteristic+++++++ +SingleEntity+++ +Optional++ Nein+++ +Im Payload++ Ja+++ + +Payload Schlüssel+physicalDimensionsProperty+++++Identification Entity
++ Identification parameters of the transmission with data matrix code, manufacturerID and serial number. ++ +++Properties
++ ++++ +Data Matrix Code (DMC) link to the public of the transmission as specified in section 31 / page 26. + +Data Matrix Code
+++ + + +Name+dataMatrixCode+++ + +Characteristic++++++++ Typ http://www.w3.org/2001/XMLSchema#string + ++++ +Optional++ Nein+++ +Im Payload++ Ja+++ +Payload Schlüssel+dataMatrixCode+++ +Referenz+++-
+
- https://eur-lex.europa.eu/resource.html?uri=cellar:bb8539b7-b1b5-11ec-9d96-01aa75ed71a1.0001.02/DOC_1&format=PDF +
+ ++++ +The ID of the transmission manufacturer in form of the unique BPN(L) number. + +Manufacturer ID
+++ + + +Name+manufacturerId+++ +Characteristic++++++++ Typ http://www.w3.org/2001/XMLSchema#string + ++++ +Beispiel+BPNL1234567890ZZ+++ +Optional++ Nein+++ +Im Payload++ Ja+++ + +Payload Schlüssel+manufacturerId++ ++++ +A local identifier enables identification of a part in a specific data space, but is not unique in Catena-X data space. Multiple local identifiers may exist. + +Local Identifiers
+++ + + +Name+localIdentifiers+++ + +Characteristic+++++++Set+++Has no order+++ +Duplicates not allowed+++ +Optional++ Nein+++ +Im Payload++ Ja+++ + +Payload Schlüssel+localIdentifiers+++++Instruction Entity
++ Instruction documents concerning the transmission. ++ +++Properties
++ ++++ +Document containing the transmission dismantling procedure. + +Dismantling Procedure
+++ + + +Name+dismantlingProcedure+++ + +Characteristic+++++++List+++Sortierung+++ +Erlaubt Duplikate+++ +Optional++ Nein+++ +Im Payload++ Ja+++ + +Payload Schlüssel+dismantlingProcedure++ ++++ +Document containing the dismantling procedure from the vehicle. + +Vehicle Dismantling Procedure
+++ + + +Name+vehicleDismantlingProcedure+++ + +Characteristic+++++++List+++Sortierung+++ +Erlaubt Duplikate+++ +Optional++ Nein+++ +Im Payload++ Ja+++ + +Payload Schlüssel+vehicleDismantlingProcedure++ ++++ +Instructions for safely packaging of the transmission. + +Packaging Instructions
+++ + + +Name+packagingInstructions+++ + +Characteristic+++++++List+++Sortierung+++ +Erlaubt Duplikate+++ +Optional++ Ja+++ +Im Payload++ Ja+++ + +Payload Schlüssel+packagingInstructions++ ++++ +Instructions for safely transporting of the transmission. + +Transportation Instructions
+++ + + +Name+transportationInstructions+++ + +Characteristic+++++++List+++Sortierung+++ +Erlaubt Duplikate+++ +Optional++ Ja+++ +Im Payload++ Ja+++ + +Payload Schlüssel+transportationInstructions++ ++++ +Includes all safety relevant documents for e.g. Dismantling. + +Safety Measures
+++ + + +Name+safetyMeasures+++ + +Characteristic+++++++List+++Sortierung+++ +Erlaubt Duplikate+++ +Optional++ Nein+++ +Im Payload++ Ja+++ +Payload Schlüssel+safetyMeasures+++ +Referenz+++-
+
- https://eclass.eu/eclass-standard/content-suche/show?tx_eclasssearch_ecsearch%5Bcc2prdat%5D=0173-1%2302-AAO190%23001&tx_eclasssearch_ecsearch%5Bdischarge%5D=0&tx_eclasssearch_ecsearch%5Bid%5D=-1&tx_eclasssearch_ecsearch%5Blanguage%5D=1&tx_eclasssearch_ecsearch%5Boption%5D=pr&tx_eclasssearch_ecsearch%5Bsearchtxt%5D=0173-1%2302-AAO190%23001&tx_eclasssearch_ecsearch%5Bversion%5D=12.0&cHash=ecd65dc92a134cdb1453556e4a1557ca +
++++Key Value List
++ A list of key value pairs for local identifiers, which are composed of a key and a corresponding value. ++ +++Properties
++ ++++ +The key of a local identifier. + +Identifier Key
+++ + + +Name+key+++ +Characteristic++++++++ Typ http://www.w3.org/2001/XMLSchema#string + ++++ +Beispiel+PartInstanceID+++ +Optional++ Nein+++ +Im Payload++ Ja+++ + +Payload Schlüssel+key++ ++++ +The value of an identifier. + +Identifier Value
+++ + + +Name+value+++ +Characteristic++++++++ Typ http://www.w3.org/2001/XMLSchema#string + ++++ +Beispiel+SN12345678+++ +Optional++ Nein+++ +Im Payload++ Ja+++ + +Payload Schlüssel+value+++++Other Substance Entity
++ Percentage and substance name of the other substances. ++ +++Properties
++ ++++ +Substance percentage of the recycled content. + +Substance Percentage
+++ + + +Name+substancePercentage+++ +Characteristic+++++++Quantifiable+++Duration+++Substance percentage of the recycled content.+++Einheit+++++-
+
- + percent + +
- + Symbol % + +
- + Code P1 + +
+++ Typ http://www.w3.org/2001/XMLSchema#decimal + ++++ +Beispiel+8.0+++ +Optional++ Nein+++ +Im Payload++ Ja+++ + +Payload Schlüssel+substancePercentage++ ++++ +The name of the substance such as lead or aluminium. + +Substance Name
+++ + + +Name+substanceName+++ +Characteristic++++++++ Typ http://www.w3.org/2001/XMLSchema#string + ++++ +Beispiel+Lead+++ +Optional++ Nein+++ +Im Payload++ Ja+++ + +Payload Schlüssel+substanceName+++ + + + + + \ No newline at end of file diff --git a/io.catenax.transmission.transmission_pass/1.0.0/gen/TransmissionPass.json b/io.catenax.transmission.transmission_pass/1.0.0/gen/TransmissionPass.json new file mode 100644 index 00000000..239ce546 --- /dev/null +++ b/io.catenax.transmission.transmission_pass/1.0.0/gen/TransmissionPass.json @@ -0,0 +1,109 @@ +{ + "productSpecificParameters" : { + "torqueConverter" : [ "RYtGKbgicZaHCBRQDSx" ], + "driveType" : "combustion engine", + "oilType" : "ZF Lifeguard Hybrid 2", + "spreading" : 6.79, + "torque" : 500.0, + "power" : 300.0, + "standardGearRatio" : { + "gear" : "1", + "ratio" : 4.1567 + }, + "oilCapacity" : 8.9, + "electricPerformance" : [ "VLhpfQGTMDYpsBZxvfBoeygjb" ], + "speedResistance" : { + "speed" : 7800, + "gear" : "1" + } + }, + "instructions" : { + "packagingInstructions" : [ { + "documentTitle" : "Title A", + "documentLink" : "https://www.xxx.pdf" + } ], + "transportationInstructions" : [ { + "documentTitle" : "Title A", + "documentLink" : "https://www.xxx.pdf" + } ], + "dismantlingProcedure" : [ { + "documentTitle" : "Title A", + "documentLink" : "https://www.xxx.pdf" + } ], + "safetyMeasures" : [ { + "documentTitle" : "Title A", + "documentLink" : "https://www.xxx.pdf" + } ], + "vehicleDismantlingProcedure" : [ { + "documentTitle" : "Title A", + "documentLink" : "https://www.xxx.pdf" + } ] + }, + "identification" : { + "manufacturerId" : "BPNL1234567890ZZ", + "localIdentifiers" : [ { + "value" : "SN12345678", + "key" : "PartInstanceID" + } ], + "dataMatrixCode" : "UMaAIKKIkknjWEXJUfPxxQHeWKEJ" + }, + "sparePartSupplier" : [ { + "supplierContact" : { + "faxNumber" : "+49 89 0987654321", + "website" : "https://www.samsung.com", + "phoneNumber" : "+49 89 1234567890", + "email" : "test.mail@example.com" + }, + "supplierId" : "BPNL1234567890ZZ", + "sparePartName" : "torque converter" + } ], + "stateOfHealth" : { + "serviceHistory" : [ "2023-05-22T13:16:47.239+02:00" ], + "expectedLifespan" : 500000, + "remanufacturing" : { + "remanufacturingDate" : "2023-05-22T13:16:47.239+02:00", + "productStatusValue" : "first life" + } + }, + "generalInformation" : { + "additionalInformation" : "JxkyvRnL", + "physicalDimensionsProperty" : { + "width" : 1000.0, + "length" : 20000.1, + "weight" : 100.7, + "diameter" : 0.03, + "height" : 0.1 + }, + "warrantyPeriod" : 60.0, + "productDescription" : "manual transmission", + "productType" : "8HP60MH" + }, + "sustainability" : { + "substancesOfConcern" : [ "yedUsFwdkelQbxeTeQOvaScfqIOOmaa" ], + "responsibleSourcingDocument" : [ { + "documentTitle" : "Title A", + "documentLink" : "https://www.xxx.pdf" + } ], + "recyclateContent" : { + "nickel" : -1.7976931348623157E+308, + "lithium" : -1.7976931348623157E+308, + "cobalt" : -1.7976931348623157E+308, + "otherSubstance" : [ { + "substancePercentage" : 8.0, + "substanceName" : "Lead" + } ] + }, + "criticalRawMaterials" : [ "eOMtThyhVNLWUZNRcBaQKxI" ], + "carbonFootprint" : { + "crossSectoralStandardsUsed" : [ { + "crossSectoralStandard" : "GHG Protocol Product standard" + } ], + "co2FootprintTotal" : -1.7976931348623157E+308, + "productOrSectorSpecificRules" : [ { + "operator" : "PEF", + "ruleNames" : "ABC 2021", + "otherOperatorName" : "NSF" + } ] + } + } +} \ No newline at end of file diff --git a/io.catenax.transmission.transmission_pass/1.0.0/gen/TransmissionPass.yml b/io.catenax.transmission.transmission_pass/1.0.0/gen/TransmissionPass.yml new file mode 100644 index 00000000..390a2d39 --- /dev/null +++ b/io.catenax.transmission.transmission_pass/1.0.0/gen/TransmissionPass.yml @@ -0,0 +1,735 @@ +--- +openapi: 3.0.3 +info: + title: Transmission Pass + version: v1 +servers: +- url: catenax.io/api/v1 + variables: + api-version: + default: v1 +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 + - 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/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 + PagingSchema: + type: object + properties: + items: + type: array + items: + $ref: '#/components/schemas/TransmissionPass' + totalItems: + type: number + totalPages: + type: number + pageSize: + type: number + currentPage: + type: number + urn_bamm_io.catenax.transmission.transmission_pass_1.0.0_DocumentTitleTrait: + type: string + description: Maximum title characters set to 60. + maxLength: 60 + 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.transmission.transmission_pass_1.0.0_Documents: + description: Entity describing a document. + type: object + properties: + documentTitle: + description: The header or title of the document + $ref: '#/components/schemas/urn_bamm_io.catenax.transmission.transmission_pass_1.0.0_DocumentTitleTrait' + documentLink: + description: A link referencing to the document. + $ref: '#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text' + required: + - documentLink + urn_bamm_io.catenax.transmission.transmission_pass_1.0.0_DocumentsCharacteristic: + description: Documents Characteristic with title and link. + type: array + items: + $ref: '#/components/schemas/urn_bamm_io.catenax.transmission.transmission_pass_1.0.0_Documents' + urn_bamm_io.catenax.transmission.transmission_pass_1.0.0_Co2Total: + type: number + description: "Characteristic for the total carbon footprint of the transmission,\ + \ calculated as kg of carbon dioxide equivalent." + urn_bamm_io.catenax.pcf_3.0.0_ProductOrSectorSpecificRuleOperator: + type: string + description: Enumeration of PCR (Product Category Rule) operators as specified + by the WBCSD (World Business Council for Sustainable Development) Pathfinder + initiative. + enum: + - PEF + - EPD International + - Other + urn_bamm_io.catenax.pcf_3.0.0_RuleNamesTrait: + description: Constraint for defining a non-empty set of non-empty rule names + as specified by the WBCSD (World Business Council for Sustainable Development) + Pathfinder initiative. + type: array + items: + type: string + description: String that contains at least one character. + uniqueItems: true + minItems: 1 + urn_bamm_io.catenax.pcf_3.0.0_ProductOrSectorSpecificRulesEntity: + description: Entity for defining the set of values for the product or sector + specific rules of a product carbon footprint as specified by the WBCSD (World + Business Council for Sustainable Development) Pathfinder initiative. + type: object + properties: + operator: + description: Operator of PCR (Product Category Rule)/ PSR (Product Specific + Rule) as specified by the WBCSD (World Business Council for Sustainable + Development) Pathfinder initiative. + $ref: '#/components/schemas/urn_bamm_io.catenax.pcf_3.0.0_ProductOrSectorSpecificRuleOperator' + ruleNames: + description: Product-specific or sector-specific set of rules used for calculating + or allocating GHG (Greenhouse Gas) emissions applied from the specified + operator. Property defined by the WBCSD (World Business Council for Sustainable + Development) Pathfinder initiative. + $ref: '#/components/schemas/urn_bamm_io.catenax.pcf_3.0.0_RuleNamesTrait' + otherOperatorName: + description: Other operator of PCR (Product Category Rule)/ PSR (Product + Specific Rule) as specified by the WBCSD (World Business Council for Sustainable + Development) Pathfinder initiative. + $ref: '#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text' + required: + - operator + - ruleNames + urn_bamm_io.catenax.pcf_3.0.0_ProductOrSectorSpecificRuleSet: + description: Characteristic for defining the set of product or sector specific + rules of a product carbon footprint as specified by the WBCSD (World Business + Council for Sustainable Development) Pathfinder initiative. + type: array + items: + $ref: '#/components/schemas/urn_bamm_io.catenax.pcf_3.0.0_ProductOrSectorSpecificRulesEntity' + uniqueItems: true + urn_bamm_io.catenax.pcf_3.0.0_CrossSectoralStandardsUsedEnumerationCharacteristic: + type: string + description: Characteristic for defining the enumeration of valid accounting + standards used for product carbon footprint calculation as specified by the + WBCSD (World Business Council for Sustainable Development) Pathfinder initiative. + enum: + - GHG Protocol Product standard + - ISO Standard 14067 + - ISO Standard 14044 + urn_bamm_io.catenax.pcf_3.0.0_CrossSectoralStandardEntity: + description: Entity for defining an accounting standard used for product carbon + footprint calculation as specified by the WBCSD (World Business Council for + Sustainable Development) Pathfinder initiative. + type: object + properties: + crossSectoralStandard: + description: Discloses a cross-sectoral standard applied for calculating + or allocating GHG (Greenhouse Gas) emissions as specified by the WBCSD + (World Business Council for Sustainable Development) Pathfinder initiative. + $ref: '#/components/schemas/urn_bamm_io.catenax.pcf_3.0.0_CrossSectoralStandardsUsedEnumerationCharacteristic' + required: + - crossSectoralStandard + urn_bamm_io.catenax.pcf_3.0.0_CrossSectoralStandardsUsedListCharacteristic: + description: Characteristic for defining the list of valid accounting standards + used for product carbon footprint calculation as specified by the WBCSD (World + Business Council for Sustainable Development) Pathfinder initiative. + type: array + items: + $ref: '#/components/schemas/urn_bamm_io.catenax.pcf_3.0.0_CrossSectoralStandardEntity' + urn_bamm_io.catenax.transmission.transmission_pass_1.0.0_CarbonFootprint: + description: Set of information needed for the carbon footprint ecodesign regulations. + type: object + properties: + co2FootprintTotal: + description: "The total carbon footprint of the transmission, calculated\ + \ as kg of carbon dioxide equivalent." + $ref: '#/components/schemas/urn_bamm_io.catenax.transmission.transmission_pass_1.0.0_Co2Total' + 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 publishers and according rule names.\ + \ Specified by the WBCSD (World Business Council for Sustainable Development)\ + \ Pathfinder initiative." + $ref: '#/components/schemas/urn_bamm_io.catenax.pcf_3.0.0_ProductOrSectorSpecificRuleSet' + crossSectoralStandardsUsed: + description: Discloses the cross-sectoral standards applied for calculating + or allocating GHG (Greenhouse Gas) emissions as specified by the WBCSD + (World Business Council for Sustainable Development) Pathfinder initiative. + $ref: '#/components/schemas/urn_bamm_io.catenax.pcf_3.0.0_CrossSectoralStandardsUsedListCharacteristic' + required: + - co2FootprintTotal + - productOrSectorSpecificRules + - crossSectoralStandardsUsed + urn_bamm_io.catenax.transmission.transmission_pass_1.0.0_SubstancePercentage: + type: number + description: Substance percentage of the recycled content. + urn_bamm_io.catenax.transmission.transmission_pass_1.0.0_OtherSubstanceEntity: + description: Percentage and substance name of the other substances. + type: object + properties: + substancePercentage: + description: Substance percentage of the recycled content. + $ref: '#/components/schemas/urn_bamm_io.catenax.transmission.transmission_pass_1.0.0_SubstancePercentage' + substanceName: + description: The name of the substance such as lead or aluminium. + $ref: '#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text' + required: + - substancePercentage + - substanceName + urn_bamm_io.catenax.transmission.transmission_pass_1.0.0_OtherSubstance: + description: Characteristic for the other optional substances. + type: array + items: + $ref: '#/components/schemas/urn_bamm_io.catenax.transmission.transmission_pass_1.0.0_OtherSubstanceEntity' + urn_bamm_io.catenax.transmission.transmission_pass_1.0.0_RecyclateContent: + description: Recyclate content in the transmission. + type: object + properties: + otherSubstance: + description: Details for the other optional substances. + $ref: '#/components/schemas/urn_bamm_io.catenax.transmission.transmission_pass_1.0.0_OtherSubstance' + cobalt: + description: Percentage of the recyclate content of cobalt. + $ref: '#/components/schemas/urn_bamm_io.catenax.transmission.transmission_pass_1.0.0_SubstancePercentage' + nickel: + description: Percentage of the recyclate content of nickel. + $ref: '#/components/schemas/urn_bamm_io.catenax.transmission.transmission_pass_1.0.0_SubstancePercentage' + lithium: + description: Percentage of the recyclate content of lithium. + $ref: '#/components/schemas/urn_bamm_io.catenax.transmission.transmission_pass_1.0.0_SubstancePercentage' + required: + - cobalt + - nickel + - lithium + urn_bamm_io.catenax.transmission.transmission_pass_1.0.0_StringList: + description: A list with the data types string. + type: array + items: + type: string + urn_bamm_io.catenax.transmission.transmission_pass_1.0.0_Sustainability: + description: Sustainability Characteristic to describe sustainability factors. + type: object + properties: + responsibleSourcingDocument: + description: Document/Certificates on organizations compliance to ethical + business practices. + $ref: '#/components/schemas/urn_bamm_io.catenax.transmission.transmission_pass_1.0.0_DocumentsCharacteristic' + carbonFootprint: + description: Describes the carbon footprint of the substance or mixture. + Based on the Ecodesign. + $ref: '#/components/schemas/urn_bamm_io.catenax.transmission.transmission_pass_1.0.0_CarbonFootprint' + recyclateContent: + description: "List of recovered recyclate content. The following materials\ + \ have to be reported on as a minimum: cobalt, lithium, nickel. Percentage\ + \ of how much of the material was recycled. This can be an aggregation\ + \ regarding the materials below. For example the amount of aluminium recovered\ + \ from waste present in in each transmission model." + $ref: '#/components/schemas/urn_bamm_io.catenax.transmission.transmission_pass_1.0.0_RecyclateContent' + criticalRawMaterials: + description: List of critical raw materials (CRM) as specified by EU in + a transmission. For example Magnesium; Cobalt; Palladium. + $ref: '#/components/schemas/urn_bamm_io.catenax.transmission.transmission_pass_1.0.0_StringList' + substancesOfConcern: + description: List of substances of concern. The name of the substances of + concern present in the product. For example Lead; Cadmium; Dibortrioxide. + $ref: '#/components/schemas/urn_bamm_io.catenax.transmission.transmission_pass_1.0.0_StringList' + required: + - carbonFootprint + - recyclateContent + - criticalRawMaterials + - substancesOfConcern + urn_bamm_io.catenax.transmission.transmission_pass_1.0.0_ProductDescription: + type: string + description: The detailed description about the product type as enumeration. + enum: + - manual transmission + - automated manual transmission + - automatic transmission + - continuously variable automatic transmissions (CVT transmission) + urn_bamm_io.catenax.transmission.transmission_pass_1.0.0_WarrantyPeriod: + type: number + description: Commercial warranty period of the transmission (coupled to the + Vehicle) in months as decimal. + 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.transmission.transmission_pass_1.0.0_GeneralInformation: + description: Characteristic for general information. + type: object + properties: + productDescription: + description: The detailed description about the product type. + $ref: '#/components/schemas/urn_bamm_io.catenax.transmission.transmission_pass_1.0.0_ProductDescription' + productType: + description: Type of transmission for passenger cars. + $ref: '#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text' + additionalInformation: + description: Open field for additional information such as a link. + $ref: '#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text' + warrantyPeriod: + description: Commercial warranty period of the transmission (coupled to + the Vehicle) in months. + $ref: '#/components/schemas/urn_bamm_io.catenax.transmission.transmission_pass_1.0.0_WarrantyPeriod' + physicalDimensionsProperty: + description: Describes the physical dimensions of the entity. + $ref: '#/components/schemas/urn_bamm_io.catenax.shared.physical_dimension_2.0.0_PhysicalDimensionsCharacteristic' + required: + - productDescription + - productType + - additionalInformation + - warrantyPeriod + - physicalDimensionsProperty + urn_bamm_io.catenax.transmission.transmission_pass_1.0.0_ProductStatusEnumeration: + type: string + description: Enumeration to describe the status of the transmission as first + life or second life. + enum: + - first life + - second life + 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.transmission.transmission_pass_1.0.0_Remanufacturing: + description: Status of the transmission (first life or second life) and remanufacturing + history. + type: object + properties: + productStatusValue: + description: Status of the transmission as first life or second life. + $ref: '#/components/schemas/urn_bamm_io.catenax.transmission.transmission_pass_1.0.0_ProductStatusEnumeration' + remanufacturingDate: + description: Date of the (re-)manufacturing + $ref: '#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Timestamp' + required: + - productStatusValue + - remanufacturingDate + urn_bamm_io.catenax.transmission.transmission_pass_1.0.0_ServiceHistory: + description: The dates of putting the transmission into service (service history) + as list. + type: array + items: + type: string + format: date-time + urn_bamm_io.catenax.transmission.transmission_pass_1.0.0_ExpectedLifespan: + type: number + description: Expected transmission lifespan in km. + urn_bamm_io.catenax.transmission.transmission_pass_1.0.0_StateOfHealth: + description: State of health characteristic describing several properties. + type: object + properties: + remanufacturing: + description: Status of the transmission (first life or second life). + $ref: '#/components/schemas/urn_bamm_io.catenax.transmission.transmission_pass_1.0.0_Remanufacturing' + serviceHistory: + description: The dates of putting the transmission into service (service + history). + $ref: '#/components/schemas/urn_bamm_io.catenax.transmission.transmission_pass_1.0.0_ServiceHistory' + expectedLifespan: + description: Expected transmission lifespan. + $ref: '#/components/schemas/urn_bamm_io.catenax.transmission.transmission_pass_1.0.0_ExpectedLifespan' + required: + - remanufacturing + - serviceHistory + - expectedLifespan + urn_bamm_io.catenax.shared.contact_information_2.0.0_WebsiteCharacteristic: + type: string + format: uri + description: Address of the website + urn_bamm_io.catenax.shared.contact_information_2.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_2.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_2.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_2.0.0_WebsiteCharacteristic' + phoneNumber: + description: Phone number with country and area code + $ref: '#/components/schemas/urn_bamm_io.catenax.shared.contact_information_2.0.0_PhoneNumberTrait' + email: + description: An email address + $ref: '#/components/schemas/urn_bamm_io.catenax.shared.contact_information_2.0.0_EMailTrait' + faxNumber: + description: Fax number with country and area code + $ref: '#/components/schemas/urn_bamm_io.catenax.shared.contact_information_2.0.0_PhoneNumberTrait' + urn_bamm_io.catenax.transmission.transmission_pass_1.0.0_SparePartEntity: + description: Entity for details of the spare parts and suppliers of replacement + parts / spare parts. + type: object + properties: + supplierContact: + description: Contact information of the supplier + $ref: '#/components/schemas/urn_bamm_io.catenax.shared.contact_information_2.0.0_ContactCharacteristic' + supplierId: + description: BPNL of the supplier. + $ref: '#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text' + sparePartName: + description: Name or Identification of the spare part. + $ref: '#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text' + required: + - supplierContact + - supplierId + - sparePartName + urn_bamm_io.catenax.transmission.transmission_pass_1.0.0_SparePartSupplier: + description: Characteristic for details of the spare parts and suppliers of + replacement parts / spare parts. + type: array + items: + $ref: '#/components/schemas/urn_bamm_io.catenax.transmission.transmission_pass_1.0.0_SparePartEntity' + urn_bamm_io.catenax.transmission.transmission_pass_1.0.0_DriveTypeEnumeration: + type: string + description: "Enumeration of the drive types with the values combustion engine,\ + \ hybrid drive and electric drive." + enum: + - combustion engine + - hybrid drive + - electric drive + urn_bamm_io.catenax.transmission.transmission_pass_1.0.0_TorqueNewtonMetre: + type: number + description: Characteristic to describe the maximum input torque in newton meters. + urn_bamm_io.catenax.transmission.transmission_pass_1.0.0_PerformancePower: + type: number + description: The performance power in kilowatt as decimal. + urn_bamm_io.catenax.transmission.transmission_pass_1.0.0_GearTrait: + type: string + description: Constraint to match a gear from 1 to 99 or R (reverse). + pattern: "^\\d{1,2}|R$" + urn_bamm_io.catenax.transmission.transmission_pass_1.0.0_RevolutionsPerMinute: + type: number + description: The permissible maximum input speed in revolutions per minute in + the respective gear. + urn_bamm_io.catenax.transmission.transmission_pass_1.0.0_SpeedResistance: + description: The speed resistance characteristic. + type: object + properties: + gear: + description: Respective gear for the speed resistance. + $ref: '#/components/schemas/urn_bamm_io.catenax.transmission.transmission_pass_1.0.0_GearTrait' + speed: + description: The permissible maximum input speed (rpm). + $ref: '#/components/schemas/urn_bamm_io.catenax.transmission.transmission_pass_1.0.0_RevolutionsPerMinute' + required: + - gear + - speed + urn_bamm_io.catenax.transmission.transmission_pass_1.0.0_Ratio: + type: number + description: The ratio in the respective gear. + urn_bamm_io.catenax.transmission.transmission_pass_1.0.0_StandardGearRatio: + description: The ratio in the respective gear. + type: object + properties: + gear: + description: Respective gear for the speed resistance. + $ref: '#/components/schemas/urn_bamm_io.catenax.transmission.transmission_pass_1.0.0_GearTrait' + ratio: + description: The ratio in the respective gear (ratio between transmission + input speed and transmission output speed). + $ref: '#/components/schemas/urn_bamm_io.catenax.transmission.transmission_pass_1.0.0_Ratio' + required: + - gear + - ratio + urn_bamm_io.catenax.transmission.transmission_pass_1.0.0_TransmissionSpreading: + type: number + description: The transmission spreading coefficient. The ratio between the smallest + (shortest gear) and the largest (longest gear) ratio as decimal with no unit. + urn_bamm_io.catenax.transmission.transmission_pass_1.0.0_Capacity: + type: number + description: The oil capacity in dm³. + urn_bamm_io.catenax.transmission.transmission_pass_1.0.0_ProductSpecificParameters: + description: The Characteristic to describe product specific parameters of the + transmission. + type: object + properties: + driveType: + description: "The type of transmission drive (combustion engine, hybrid\ + \ drive or purely electric drive)." + $ref: '#/components/schemas/urn_bamm_io.catenax.transmission.transmission_pass_1.0.0_DriveTypeEnumeration' + torque: + description: The maximum input torque in newton meters (the operating characteristics + of the transmission). + $ref: '#/components/schemas/urn_bamm_io.catenax.transmission.transmission_pass_1.0.0_TorqueNewtonMetre' + power: + description: The maximum power in kilowatt (the operating characteristics + of the transmission). + $ref: '#/components/schemas/urn_bamm_io.catenax.transmission.transmission_pass_1.0.0_PerformancePower' + 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_bamm_io.catenax.transmission.transmission_pass_1.0.0_StringList' + speedResistance: + description: "The permissible maximum input speed in the respective gear\ + \ (depending on the transmission type). For example 1 : max 7800min-1;\ + \ 2 : max 7800min-1; 3 : max 7800min-1; 4 : max 7800min-1; 5 : max 7800min-1;\ + \ 6 : max 7800min-1; 7 : max 6800min-1; 8 : max 5800min-1; R : max 2000min-1." + $ref: '#/components/schemas/urn_bamm_io.catenax.transmission.transmission_pass_1.0.0_SpeedResistance' + 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_bamm_io.catenax.transmission.transmission_pass_1.0.0_StandardGearRatio' + spreading: + description: The transmission spreading coefficient. The ratio between the + smallest (shortest gear) and the largest (longest gear) ratio. + $ref: '#/components/schemas/urn_bamm_io.catenax.transmission.transmission_pass_1.0.0_TransmissionSpreading' + oilCapacity: + description: The recomended oil volume in the transmission. + $ref: '#/components/schemas/urn_bamm_io.catenax.transmission.transmission_pass_1.0.0_Capacity' + oilType: + description: The suitable type of the oil for the transmission. + $ref: '#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text' + electricPerformance: + description: "The electric machine performance (the operating characteristics\ + \ of the electric motor). Values are the kilowatt, volt and newtonmetre.\ + \ An example could be 22 kW; 49 V and 150 Nm." + $ref: '#/components/schemas/urn_bamm_io.catenax.transmission.transmission_pass_1.0.0_StringList' + required: + - driveType + - torque + - power + - standardGearRatio + - spreading + - oilCapacity + - oilType + urn_bamm_io.catenax.transmission.transmission_pass_1.0.0_Instructions: + description: Instructions characteristic concerning the transmission. + type: object + properties: + dismantlingProcedure: + description: Document containing the transmission dismantling procedure. + $ref: '#/components/schemas/urn_bamm_io.catenax.transmission.transmission_pass_1.0.0_DocumentsCharacteristic' + vehicleDismantlingProcedure: + description: Document containing the dismantling procedure from the vehicle. + $ref: '#/components/schemas/urn_bamm_io.catenax.transmission.transmission_pass_1.0.0_DocumentsCharacteristic' + packagingInstructions: + description: Instructions for safely packaging of the transmission. + $ref: '#/components/schemas/urn_bamm_io.catenax.transmission.transmission_pass_1.0.0_DocumentsCharacteristic' + transportationInstructions: + description: Instructions for safely transporting of the transmission. + $ref: '#/components/schemas/urn_bamm_io.catenax.transmission.transmission_pass_1.0.0_DocumentsCharacteristic' + safetyMeasures: + description: Includes all safety relevant documents for e.g. Dismantling. + $ref: '#/components/schemas/urn_bamm_io.catenax.transmission.transmission_pass_1.0.0_DocumentsCharacteristic' + required: + - dismantlingProcedure + - vehicleDismantlingProcedure + - safetyMeasures + 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.catenax.transmission.transmission_pass_1.0.0_Identification: + description: Characteristic for the identification parameters of the transmission. + type: object + properties: + dataMatrixCode: + description: Data Matrix Code (DMC) link to the public of the transmission + as specified in section 31 / page 26. + $ref: '#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text' + manufacturerId: + description: The ID of the transmission manufacturer in form of the unique + BPN(L) number. + $ref: '#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text' + localIdentifiers: + description: "A local identifier enables identification of a part in a specific\ + \ data space, but is not unique in Catena-X data space. Multiple local\ + \ identifiers may exist." + $ref: '#/components/schemas/urn_bamm_io.catenax.serial_part_typization_2.0.0_LocalIdentifierCharacteristic' + required: + - dataMatrixCode + - manufacturerId + - localIdentifiers + 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: + sustainability: + description: Sustainability details about the transmission. + $ref: '#/components/schemas/urn_bamm_io.catenax.transmission.transmission_pass_1.0.0_Sustainability' + generalInformation: + description: Property describing general information about the transmission. + $ref: '#/components/schemas/urn_bamm_io.catenax.transmission.transmission_pass_1.0.0_GeneralInformation' + stateOfHealth: + description: State of health property describing several properties. + $ref: '#/components/schemas/urn_bamm_io.catenax.transmission.transmission_pass_1.0.0_StateOfHealth' + sparePartSupplier: + description: Details of the spare parts and suppliers of replacement parts + / spare parts. + $ref: '#/components/schemas/urn_bamm_io.catenax.transmission.transmission_pass_1.0.0_SparePartSupplier' + productSpecificParameters: + description: Product specific parameters of the transmission. + $ref: '#/components/schemas/urn_bamm_io.catenax.transmission.transmission_pass_1.0.0_ProductSpecificParameters' + instructions: + description: Instructions concerning the transmission. + $ref: '#/components/schemas/urn_bamm_io.catenax.transmission.transmission_pass_1.0.0_Instructions' + identification: + description: Identification parameters of the transmission. + $ref: '#/components/schemas/urn_bamm_io.catenax.transmission.transmission_pass_1.0.0_Identification' + required: + - sustainability + - generalInformation + - stateOfHealth + - sparePartSupplier + - productSpecificParameters + - instructions + - identification + 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/PagingSchema' + description: The request was successful. + requestBodies: + TransmissionPass: + content: + application/json: + schema: + $ref: '#/components/schemas/TransmissionPass'++Product Or Sector Specific Rules Entity
++ Entity for defining the set of values for the product or sector specific rules of a product carbon footprint as specified by the WBCSD (World Business Council for Sustainable Development) Pathfinder initiative. +++ Referenz ++ +++-
+
- https://wbcsd.github.io/introduction/ +
++Properties
++ ++++ +Operator of PCR (Product Category Rule)/ PSR (Product Specific Rule) as specified by the WBCSD (World Business Council for Sustainable Development) Pathfinder initiative. + +Operator or Publisher of Sector Specific Rules
+++ + + +Name+operator+++ + +Characteristic+++++++Enumeration+++Werte+++++-
+
- PEF +
- EPD International +
- Other +
+++ Referenz ++++-
+
- https://wbcsd.github.io/introduction/ +
+++ Typ http://www.w3.org/2001/XMLSchema#string + ++++ +Optional++ Nein+++ +Im Payload++ Ja+++ +Payload Schlüssel+operator+++ +Referenz+++-
+
- https://wbcsd.github.io/introduction/ +
+ ++++ +Product-specific or sector-specific set of rules used for calculating or allocating GHG (Greenhouse Gas) emissions applied from the specified operator. Property defined by the WBCSD (World Business Council for Sustainable Development) Pathfinder initiative. + +Product or Sector Specific Rule Names
+++ + + +Name+ruleNames+++ +Characteristic+++++++Trait++++ Typ http://www.w3.org/2001/XMLSchema#string + ++++ +Beispiel+ABC 2021+++ +Optional++ Nein+++ +Im Payload++ Ja+++ +Payload Schlüssel+ruleNames+++ +Referenz+++-
+
- https://wbcsd.github.io/introduction/ +
++Bedingungen+++-
+
-
++ +++ Rule Names Constraint ++ +++ +Beschreibung+Constraint for defining a non-empty set of non-empty rule names as specified by the WBCSD (World Business Council for Sustainable Development) Pathfinder initiative.+++ +Referenz+++++
-
+
- https://wbcsd.github.io/introduction/ +
++ + + +Min. Zeichen+1+
+ ++++ +Other operator of PCR (Product Category Rule)/ PSR (Product Specific Rule) as specified by the WBCSD (World Business Council for Sustainable Development) Pathfinder initiative. + +Other Operator or Publisher of Sector Specific Rules
+++ + + +Name+otherOperatorName+++ +Characteristic++++++++ Typ http://www.w3.org/2001/XMLSchema#string + ++++ +Beispiel+NSF+++ +Optional++ Ja+++ +Im Payload++ Ja+++ +Payload Schlüssel+otherOperatorName+++ +Referenz+++-
+
- https://wbcsd.github.io/introduction/ +
++++Product Specific Parameters Entity
++ The entity describing various product specific parameters of the transmission. ++ +++Properties
++ ++++ +The type of transmission drive (combustion engine, hybrid drive or purely electric drive). + +Drive Type
+++ + + +Name+driveType+++ +Characteristic+++++++Enumeration+++Werte+++++-
+
- combustion engine +
- hybrid drive +
- electric drive +
+++ Typ http://www.w3.org/2001/XMLSchema#string + ++++ +Beispiel+hybrid drive+++ +Optional++ Nein+++ +Im Payload++ Ja+++ + +Payload Schlüssel+driveType++ ++++ +The maximum input torque in newton meters (the operating characteristics of the transmission). + +Torque Performance
+++ + + +Name+torque+++ +Characteristic+++++++Measurement+++Characteristic to describe the maximum input torque in newton meters.+++Einheit+++++-
+
- + newton metre + +
- + Symbol N·m + +
- + Code NU + +
+++ Typ http://www.w3.org/2001/XMLSchema#decimal + ++++ +Beispiel+500.0+++ +Optional++ Nein+++ +Im Payload++ Ja+++ +Payload Schlüssel+torque+++ +Referenz+++-
+
- https://eclass.eu/eclass-standard/content-suche/show?tx_eclasssearch_ecsearch[cc2prdat]=0173-1#02-ABE835#001&tx_eclasssearch_ecsearch[discharge]=0&tx_eclasssearch_ecsearch[id]=-1&tx_eclasssearch_ecsearch[language]=1&tx_eclasssearch_ecsearch[option]=pr&tx_eclasssearch_ecsearch[searchtxt]=0173-1#02-ABE835#001&tx_eclasssearch_ecsearch[version]=12.0&cHash=4a7d386fbdca6eb1be51134bfeafeac7 +
+ ++++ +The maximum power in kilowatt (the operating characteristics of the transmission). + +Power
+++ + + +Name+power+++ +Characteristic+++++++Measurement+++The performance power in kilowatt as decimal.+++Einheit+++++-
+
- + kilowatt + +
- + Symbol kW + +
- + Code KWT + +
- + Überführungsfaktor 10³ W + +
+++ Typ http://www.w3.org/2001/XMLSchema#decimal + ++++ +Beispiel+300.0+++ +Optional++ Nein+++ +Im Payload++ Ja+++ + +Payload Schlüssel+power++ ++++ +A list of the used transmission damper technology (depending on the transmission type). For example NW 200 TTD and NW 200 ZDW + +Torque Converter
+++ + + +Name+torqueConverter+++ + +Characteristic+++++++List+++Sortierung+++Erlaubt Duplikate++++ Typ http://www.w3.org/2001/XMLSchema#string + ++++ +Optional++ Ja+++ +Im Payload++ Ja+++ + +Payload Schlüssel+torqueConverter++ ++++ +The permissible maximum input speed in the respective gear (depending on the transmission type). For example 1 : max 7800min-1; 2 : max 7800min-1; 3 : max 7800min-1; 4 : max 7800min-1; 5 : max 7800min-1; 6 : max 7800min-1; 7 : max 6800min-1; 8 : max 5800min-1; R : max 2000min-1. + +Speed Resistance
+++ + + +Name+speedResistance+++ + +Characteristic+++++++ +SingleEntity+++ +Optional++ Ja+++ +Im Payload++ Ja+++ + +Payload Schlüssel+speedResistance++ ++++ +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. + +Standard Gear Ratio
+++ + + +Name+standardGearRatio+++ + +Characteristic+++++++ +SingleEntity+++ +Optional++ Nein+++ +Im Payload++ Ja+++ +Payload Schlüssel+standardGearRatio+++ +Referenz+++-
+
- https://eclass.eu/en/eclass-standard/search-content/show?tx_eclasssearch_ecsearch[cc2prdat]=0173-1#02-AAO991#001&tx_eclasssearch_ecsearch[discharge]=0&tx_eclasssearch_ecsearch[id]=-1&tx_eclasssearch_ecsearch[language]=0&tx_eclasssearch_ecsearch[option]=pr&tx_eclasssearch_ecsearch[searchtxt]=Getriebe&tx_eclasssearch_ecsearch[version]=12.0&cHash=7a98266f172bac7785ef10714da390f9 +
+ ++++ +The transmission spreading coefficient. The ratio between the smallest (shortest gear) and the largest (longest gear) ratio. + +Spreading
+++ + + +Name+spreading+++ +Characteristic+++++++Quantifiable+++Duration+++The transmission spreading coefficient. The ratio between the smallest (shortest gear) and the largest (longest gear) ratio as decimal with no unit.++++ Typ http://www.w3.org/2001/XMLSchema#decimal + ++++ +Beispiel+6.79+++ +Optional++ Nein+++ +Im Payload++ Ja+++ + +Payload Schlüssel+spreading++ ++++ +The recomended oil volume in the transmission. + +Oil Capacity
+++ + + +Name+oilCapacity+++ +Characteristic+++++++Quantifiable+++Duration+++The oil capacity in dm³.+++Einheit+++++-
+
- + cubic decimetre + +
- + Symbol dm³ + +
- + Code DMQ + +
- + Überführungsfaktor 10⁻³ m³ + +
+++ Typ http://www.w3.org/2001/XMLSchema#decimal + ++++ +Beispiel+8.9+++ +Optional++ Nein+++ +Im Payload++ Ja+++ +Payload Schlüssel+oilCapacity+++ +Referenz+++-
+
- https://eclass.eu/eclass-standard/content-suche/show?tx_eclasssearch_ecsearch%5Bcc2prdat%5D=0173-1%2302-AAA593%23006&tx_eclasssearch_ecsearch%5Bdischarge%5D=0&tx_eclasssearch_ecsearch%5Bid%5D=-1&tx_eclasssearch_ecsearch%5Blanguage%5D=1&tx_eclasssearch_ecsearch%5Boption%5D=pr&tx_eclasssearch_ecsearch%5Bsearchtxt%5D=0173-1%2302-AAA593%23006%20&tx_eclasssearch_ecsearch%5Bversion%5D=12.0&cHash=caf252fbc0edd471b4b4678699683e3f +
+ ++++ +The suitable type of the oil for the transmission. + +Oil Type
+++ + + +Name+oilType+++ +Characteristic++++++++ Typ http://www.w3.org/2001/XMLSchema#string + ++++ +Beispiel+ZF Lifeguard Hybrid 2+++ +Optional++ Nein+++ +Im Payload++ Ja+++ + +Payload Schlüssel+oilType++ ++++ +The electric machine performance (the operating characteristics of the electric motor). Values are the kilowatt, volt and newtonmetre. An example could be 22 kW; 49 V and 150 Nm. + +Electric Performance
+++ + + +Name+electricPerformance+++ + +Characteristic+++++++List+++Sortierung+++Erlaubt Duplikate++++ Typ http://www.w3.org/2001/XMLSchema#string + ++++ +Optional++ Ja+++ +Im Payload++ Ja+++ + +Payload Schlüssel+electricPerformance+++++Recyclate Content Entity
++ Recyclate content in the transmission with mandatory input values for cobalt, nickel and lithium. ++ +++Properties
++ ++++ +Details for the other optional substances. + +Other Substance
+++ + + +Name+otherSubstance+++ + +Characteristic+++++++List+++Sortierung+++ +Erlaubt Duplikate+++ +Optional++ Ja+++ +Im Payload++ Ja+++ + +Payload Schlüssel+otherSubstance++ ++++ +Percentage of the recyclate content of cobalt. + +Cobalt
+++ + + +Name+cobalt+++ + +Characteristic+++++++Quantifiable+++Duration+++Substance percentage of the recycled content.+++Einheit+++++-
+
- + percent + +
- + Symbol % + +
- + Code P1 + +
+++ Typ http://www.w3.org/2001/XMLSchema#decimal + ++++ +Optional++ Nein+++ +Im Payload++ Ja+++ + +Payload Schlüssel+cobalt++ ++++ +Percentage of the recyclate content of nickel. + +Nickel
+++ + + +Name+nickel+++ + +Characteristic+++++++Quantifiable+++Duration+++Substance percentage of the recycled content.+++Einheit+++++-
+
- + percent + +
- + Symbol % + +
- + Code P1 + +
+++ Typ http://www.w3.org/2001/XMLSchema#decimal + ++++ +Optional++ Nein+++ +Im Payload++ Ja+++ + +Payload Schlüssel+nickel++ ++++ +Percentage of the recyclate content of lithium. + +Lithium
+++ + + +Name+lithium+++ + +Characteristic+++++++Quantifiable+++Duration+++Substance percentage of the recycled content.+++Einheit+++++-
+
- + percent + +
- + Symbol % + +
- + Code P1 + +
+++ Typ http://www.w3.org/2001/XMLSchema#decimal + ++++ +Optional++ Nein+++ +Im Payload++ Ja+++ + +Payload Schlüssel+lithium+++++Remanufacturing Status Entity
++ Status and Date of the (re-)manufacturing ++ +++Properties
++ ++++ +Status of the transmission as first life or second life. + +Product Status Value
+++ + + +Name+productStatusValue+++ +Characteristic+++++++Enumeration+++Werte+++++-
+
- first life +
- second life +
+++ Typ http://www.w3.org/2001/XMLSchema#string + ++++ +Beispiel+second life+++ +Optional++ Nein+++ +Im Payload++ Ja+++ + +Payload Schlüssel+productStatusValue++ ++++ +Date of the (re-)manufacturing + +Remanufacturing Date
+++ + + +Name+remanufacturingDate+++ + +Characteristic++++++ ++++ +Optional++ Nein+++ +Im Payload++ Ja+++ + +Payload Schlüssel+remanufacturingDate+++++Spare Part Entity
++ Entity for details of the spare parts and suppliers of replacement parts / spare parts. ++ +++Properties
++ ++++ +Contact information of the supplier + +Supplier Contact
+++ + + +Name+supplierContact+++ + +Characteristic+++++++ +SingleEntity+++ +Optional++ Nein+++ +Im Payload++ Ja+++ + +Payload Schlüssel+supplierContact++ ++++ +BPNL of the supplier. + +Supplier ID
+++ + + +Name+supplierId+++ +Characteristic++++++++ Typ http://www.w3.org/2001/XMLSchema#string + ++++ +Beispiel+BPNL1234567890ZZ+++ +Optional++ Nein+++ +Im Payload++ Ja+++ + +Payload Schlüssel+supplierId++ ++++ +Name or Identification of the spare part. + +Spare Part Name
+++ + + +Name+sparePartName+++ +Characteristic++++++++ Typ http://www.w3.org/2001/XMLSchema#string + ++++ +Beispiel+torque converter+++ +Optional++ Nein+++ +Im Payload++ Ja+++ + +Payload Schlüssel+sparePartName+++ +++Speed Resistance Entity
++ The speed resitance entity. Includes the gear and the speed as separate properties. ++ +++Properties
++ ++++ +Respective gear for the speed resistance. + +Gear
+++ + + +Name+gear+++ +Characteristic+++++++Trait++++ Typ http://www.w3.org/2001/XMLSchema#string + ++++ +Beispiel+1+++ +Optional++ Nein+++ +Im Payload++ Ja+++ + +Payload Schlüssel+gear+++Bedingungen+++-
+
-
++ +++ Gear Constraint ++ +++ + +Beschreibung+Constraint to match a gear from 1 to 99 or R (reverse).+++ + + +Regulärer Ausdruck+^\d{1,2}|R$+
+ ++++ +The permissible maximum input speed (rpm). + +Speed
+++ + + +Name+speed+++ +Characteristic+++++++Measurement+++The permissible maximum input speed in revolutions per minute in the respective gear.+++Einheit+++++-
+
- + revolutions per minute + +
- + Symbol r/min + +
- + Code RPM + +
+++ Typ http://www.w3.org/2001/XMLSchema#integer + ++++ +Beispiel+7800+++ +Optional++ Nein+++ +Im Payload++ Ja+++ + +Payload Schlüssel+speed+++++State of health entity
++ State of health entity describing several logically connected properties. ++ +++Properties
++ ++++ +Status of the transmission (first life or second life). + +Remanufacturing
+++ + + +Name+remanufacturing+++ + +Characteristic+++++++ +SingleEntity+++ +Optional++ Nein+++ +Im Payload++ Ja+++ + +Payload Schlüssel+remanufacturing++ ++++ +The dates of putting the transmission into service (service history). + +Service History
+++ + + +Name+serviceHistory+++ + +Characteristic+++++++List+++Sortierung+++Erlaubt Duplikate++ ++++ +Optional++ Nein+++ +Im Payload++ Ja+++ + +Payload Schlüssel+serviceHistory++ ++++ +Expected transmission lifespan. + +Expected Lifespan
+++ + + +Name+expectedLifespan+++ +Characteristic+++++++Measurement+++Expected transmission lifespan in km.+++Einheit+++++-
+
- + kilometre + +
- + Symbol km + +
- + Code KMT + +
- + Überführungsfaktor 10³ m + +
+++ Typ http://www.w3.org/2001/XMLSchema#integer + ++++ +Beispiel+500000+++ +Optional++ Nein+++ +Im Payload++ Ja+++ +Payload Schlüssel+expectedLifespan+++ +Referenz+++-
+
- https://eclass.eu/eclass-standard/content-suche/show?tx_eclasssearch_ecsearch%5Bcc2prdat%5D=0173-1%2302-AAF779%23003&tx_eclasssearch_ecsearch%5Bdischarge%5D=0&tx_eclasssearch_ecsearch%5Bid%5D=-1&tx_eclasssearch_ecsearch%5Blanguage%5D=1&tx_eclasssearch_ecsearch%5Boption%5D=pr&tx_eclasssearch_ecsearch%5Bsearchtxt%5D=0173-1%2302-AAF779%23003&tx_eclasssearch_ecsearch%5Bversion%5D=12.0&cHash=c3d9bc495a76d479c4f0123af3681c80 +
++++Sustainability Details Entity
++ Sustainability details for the transmission. ++ +++Properties
++ ++++ +Document/Certificates on organizations compliance to ethical business practices. + +Responsible Sourcing Document
+++ + + +Name+responsibleSourcingDocument+++ + +Characteristic+++++++List+++Sortierung+++ +Erlaubt Duplikate+++ +Optional++ Ja+++ +Im Payload++ Ja+++ + +Payload Schlüssel+responsibleSourcingDocument++ ++++ +Describes the carbon footprint of the substance or mixture. Based on the Ecodesign. + +Carbon Footprint
+++ + + +Name+carbonFootprint+++ + +Characteristic+++++++ +SingleEntity+++ +Optional++ Nein+++ +Im Payload++ Ja+++ + +Payload Schlüssel+carbonFootprint++ ++++ +List of recovered recyclate content. The following materials have to be reported on as a minimum: cobalt, lithium, nickel. Percentage of how much of the material was recycled. This can be an aggregation regarding the materials below. For example the amount of aluminium recovered from waste present in in each transmission model. + +Recyclate Content
+++ + + +Name+recyclateContent+++ + +Characteristic+++++++ +SingleEntity+++ +Optional++ Nein+++ +Im Payload++ Ja+++ + +Payload Schlüssel+recyclateContent++ ++++ +List of critical raw materials (CRM) as specified by EU in a transmission. For example Magnesium; Cobalt; Palladium. + +Critical Raw Materials
+++ + + +Name+criticalRawMaterials+++ + +Characteristic+++++++List+++Sortierung+++Erlaubt Duplikate++++ Typ http://www.w3.org/2001/XMLSchema#string + ++++ +Optional++ Nein+++ +Im Payload++ Ja+++ + +Payload Schlüssel+criticalRawMaterials++ ++++ +List of substances of concern. The name of the substances of concern present in the product. For example Lead; Cadmium; Dibortrioxide. + +Substances of Concern
+++ + + +Name+substancesOfConcern+++ + +Characteristic+++++++List+++Sortierung+++Erlaubt Duplikate++++ Typ http://www.w3.org/2001/XMLSchema#string + ++++ +Optional++ Nein+++ +Im Payload++ Ja+++ + +Payload Schlüssel+substancesOfConcern+++++physical dimensions
++ Entity encapsulating the physical dimensions of an object. ++ +++Properties
++ ++++ +Weight of the item + +weight
+++ + + +Name+weight+++ +Characteristic+++++++Measurement+++a measurement value given in the unit kilogram+++Einheit+++++-
+
- + kilogram + +
- + Symbol kg + +
- + Code KGM + +
+++ Typ http://www.w3.org/2001/XMLSchema#double + ++++ +Beispiel+100.7+++ +Optional++ Ja+++ +Im Payload++ Ja+++ + +Payload Schlüssel+weight++ ++++ +Diameter of the item. + +diameter
+++ + + +Name+diameter+++ +Characteristic+++++++Measurement+++a measurement for a lenght given in the unit millimetre+++Einheit+++++-
+
- + millimetre + +
- + Symbol mm + +
- + Code MMT + +
- + Überführungsfaktor 10⁻³ m + +
+++ Typ http://www.w3.org/2001/XMLSchema#double + ++++ +Beispiel+0.03+++ +Optional++ Ja+++ +Im Payload++ Ja+++ + +Payload Schlüssel+diameter++ ++++ +Height of the item. + +height
+++ + + +Name+height+++ +Characteristic+++++++Measurement+++a measurement for a lenght given in the unit millimetre+++Einheit+++++-
+
- + millimetre + +
- + Symbol mm + +
- + Code MMT + +
- + Überführungsfaktor 10⁻³ m + +
+++ Typ http://www.w3.org/2001/XMLSchema#double + ++++ +Beispiel+0.1+++ +Optional++ Ja+++ +Im Payload++ Ja+++ + +Payload Schlüssel+height++ ++++ +Width of the item. + +width
+++ + + +Name+width+++ +Characteristic+++++++Measurement+++a measurement for a lenght given in the unit millimetre+++Einheit+++++-
+
- + millimetre + +
- + Symbol mm + +
- + Code MMT + +
- + Überführungsfaktor 10⁻³ m + +
+++ Typ http://www.w3.org/2001/XMLSchema#double + ++++ +Beispiel+1000.0+++ +Optional++ Ja+++ +Im Payload++ Ja+++ + +Payload Schlüssel+width++ ++++ +Length of the item. + +length
+++ + + +Name+length+++ +Characteristic+++++++Measurement+++a measurement for a lenght given in the unit millimetre+++Einheit+++++-
+
- + millimetre + +
- + Symbol mm + +
- + Code MMT + +
- + Überführungsfaktor 10⁻³ m + +
+++ Typ http://www.w3.org/2001/XMLSchema#double + ++++ +Beispiel+20000.1+++ +Optional++ Ja+++ +Im Payload++ Ja+++ + +Payload Schlüssel+length++ Third party licenses + ++ +