From 6e5e2826a5e96db6902e5c6fb7977c7f6c3c2320 Mon Sep 17 00:00:00 2001 From: GitHub Actions Bot Date: Wed, 28 Feb 2024 09:55:23 +0000 Subject: [PATCH] Adding auto-generated artifacts for new models --- .../3.0.0/gen/SingleLevelUsageAsBuilt-aas.xml | 1316 +++++++++++++++++ .../gen/SingleLevelUsageAsBuilt-schema.json | 116 ++ .../3.0.0/gen/SingleLevelUsageAsBuilt.aasx | Bin 0 -> 5963 bytes .../3.0.0/gen/SingleLevelUsageAsBuilt.html | 1255 ++++++++++++++++ .../3.0.0/gen/SingleLevelUsageAsBuilt.json | 15 + .../3.0.0/gen/SingleLevelUsageAsBuilt.yml | 280 ++++ 6 files changed, 2982 insertions(+) create mode 100644 io.catenax.single_level_usage_as_built/3.0.0/gen/SingleLevelUsageAsBuilt-aas.xml create mode 100644 io.catenax.single_level_usage_as_built/3.0.0/gen/SingleLevelUsageAsBuilt-schema.json create mode 100644 io.catenax.single_level_usage_as_built/3.0.0/gen/SingleLevelUsageAsBuilt.aasx create mode 100644 io.catenax.single_level_usage_as_built/3.0.0/gen/SingleLevelUsageAsBuilt.html create mode 100644 io.catenax.single_level_usage_as_built/3.0.0/gen/SingleLevelUsageAsBuilt.json create mode 100644 io.catenax.single_level_usage_as_built/3.0.0/gen/SingleLevelUsageAsBuilt.yml diff --git a/io.catenax.single_level_usage_as_built/3.0.0/gen/SingleLevelUsageAsBuilt-aas.xml b/io.catenax.single_level_usage_as_built/3.0.0/gen/SingleLevelUsageAsBuilt-aas.xml new file mode 100644 index 00000000..ec8e9e29 --- /dev/null +++ b/io.catenax.single_level_usage_as_built/3.0.0/gen/SingleLevelUsageAsBuilt-aas.xml @@ -0,0 +1,1316 @@ + + + + + defaultAdminShell + + + en + defaultAdminShell + + + + urn:samm:io.catenax.single_level_usage_as_built:3.0.0#SingleLevelUsageAsBuilt + + Type + + + + ModelReference + + + Submodel + urn:samm:io.catenax.single_level_usage_as_built:3.0.0#SingleLevelUsageAsBuilt/submodel + + + + + + + + + SingleLevelUsageAsBuilt + + + en + The aspect provides the information in which parent part(s)/product(s)the given item is assembled in. Could be a 1:1 relationship in terms of an e.g. a brake component or 1:n for e.g. coatings. The parent item must refer to an object from as-built lifecycle phase, i.e. a batch or a serialized part. + + + + urn:samm:io.catenax.single_level_usage_as_built:3.0.0#SingleLevelUsageAsBuilt/submodel + Template + + ModelReference + + + ConceptDescription + urn:samm:io.catenax.single_level_usage_as_built:3.0.0#SingleLevelUsageAsBuilt + + + + + + catenaXId + + + en + Catena-X Identifier + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.single_level_usage_as_built:3.0.0#catenaXId + + + + xs:string + + + + customers + + + en + Customers + + + + + en + A list of all customers of this item. If the parent items in which this item is assembled into are known, they should be listed as well. + +For serialized items the list should contain only one customer with one parent item. +As different subsets of a batch might be sold to different customers this is a list. + + + true + DataElement + + + customers + + + en + Customers + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.single_level_usage_as_built:3.0.0#customers + + + + xs:string + + + + + + parentItems + + + en + Parent Items + + + + + en + Set of parent items, in which the given child object is assembled in (one structural level up). + +For serialized items the list should contain only one parent item. +As different subsets of a batch might be used by a customer in different items this is a list. + + + true + DataElement + + + ParentData + + + en + Parent Data + + + + + en + Catena-X ID and meta data of the parent item. + + + + + ItemQuantityEntity + + + en + Item Quantity Entity + + + + + en + Entity for common measurements of an item (mass, count, linear, area, volume, misc) with an unit and a value. + + + + + quantityValue + + + en + Quantity Value + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.shared.quantity:2.0.0#quantityValue + + + + xs:float + + + + itemUnit + + + en + Item Unit + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.shared.quantity:2.0.0#itemUnit + + + + + + ExternalReference + + + GlobalReference + https://eclipse-esmf.github.io/samm-specification/2.1.0/index.html + + + + + xs:string + + + + + + createdOn + + + en + Created On + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.single_level_usage_as_built:3.0.0#createdOn + + + + xs:string + + + + lastModifiedOn + + + en + Last Modification Date + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.single_level_usage_as_built:3.0.0#lastModifiedOn + + + + xs:string + + + + isOnlyPotentialParent + + + en + Is Only Potential Parent + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.single_level_usage_as_built:3.0.0#isOnlyPotentialParent + + + + xs:boolean + + + + businessPartner + + + en + Business Partner + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.single_level_usage_as_built:3.0.0#businessPartner + + + + xs:string + + + + catenaXId + + + en + Catena-X Identifier + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.single_level_usage_as_built:3.0.0#catenaXId + + + + xs:string + + + + + + + + + + + + APPLICATION_CLASS + SingleLevelUsageAsBuilt + + + en + SingleLevelUsageAsBuilt + + + + + en + The aspect provides the information in which parent part(s)/product(s)the given item is assembled in. Could be a 1:1 relationship in terms of an e.g. a brake component or 1:n for e.g. coatings. The parent item must refer to an object from as-built lifecycle phase, i.e. a batch or a serialized part. + + + urn:samm:io.catenax.single_level_usage_as_built:3.0.0#SingleLevelUsageAsBuilt + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + SingleLevelUsageAsBuilt + + + + + en + SingleLevelUsageAsBuilt + + + + + en + The aspect provides the information in which parent part(s)/product(s)the given item is assembled in. Could be a 1:1 relationship in terms of an e.g. a brake component or 1:n for e.g. coatings. The parent item must refer to an object from as-built lifecycle phase, i.e. a batch or a serialized part. + + + + + + + + + catenaXId + + + en + Catena-X Identifier + + + urn:samm:io.catenax.single_level_usage_as_built:3.0.0#catenaXId + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Catena-X Identifier + + + + + en + catenaXId + + + STRING + + + en + The Catena-X ID of the given part (e.g. the component), valid for the Catena-X dataspace. + + + + + + + + + customers + + + en + Customers + + + urn:samm:io.catenax.single_level_usage_as_built:3.0.0#customers + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Customers + + + + + en + customers + + + STRING + + + en + A list of all customers of this item. If the parent items in which this item is assembled into are known, they should be listed as well. + +For serialized items the list should contain only one customer with one parent item. +As different subsets of a batch might be sold to different customers this is a list. + + + + + + + + + quantityValue + + + en + Quantity Value + + + urn:samm:io.catenax.shared.quantity:2.0.0#quantityValue + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Quantity Value + + + + + en + quantityValue + + + REAL_MEASURE + + + en + The quantity value associated with the unit. + + + + + + + + + itemUnit + + + en + Item Unit + + + urn:samm:io.catenax.shared.quantity:2.0.0#itemUnit + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Item Unit + + + + + en + itemUnit + + + STRING + + + en + The unit of an item. Common units may be related to mass, count, linear, area, volume or misc. + + + + + + unit:piece + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#ItemUnitEnumeration:unit:piece + + + + + + unit:set + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#ItemUnitEnumeration:unit:set + + + + + + unit:pair + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#ItemUnitEnumeration:unit:pair + + + + + + unit:page + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#ItemUnitEnumeration:unit:page + + + + + + unit:cycle + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#ItemUnitEnumeration:unit:cycle + + + + + + unit:kilowattHour + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#ItemUnitEnumeration:unit:kilowattHour + + + + + + unit:gram + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#ItemUnitEnumeration:unit:gram + + + + + + unit:kilogram + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#ItemUnitEnumeration:unit:kilogram + + + + + + unit:tonneMetricTon + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#ItemUnitEnumeration:unit:tonneMetricTon + + + + + + unit:tonUsOrShortTonUkorus + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#ItemUnitEnumeration:unit:tonUsOrShortTonUkorus + + + + + + unit:ounceAvoirdupois + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#ItemUnitEnumeration:unit:ounceAvoirdupois + + + + + + unit:pound + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#ItemUnitEnumeration:unit:pound + + + + + + unit:metre + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#ItemUnitEnumeration:unit:metre + + + + + + unit:centimetre + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#ItemUnitEnumeration:unit:centimetre + + + + + + unit:kilometre + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#ItemUnitEnumeration:unit:kilometre + + + + + + unit:inch + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#ItemUnitEnumeration:unit:inch + + + + + + unit:foot + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#ItemUnitEnumeration:unit:foot + + + + + + unit:yard + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#ItemUnitEnumeration:unit:yard + + + + + + unit:squareCentimetre + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#ItemUnitEnumeration:unit:squareCentimetre + + + + + + unit:squareMetre + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#ItemUnitEnumeration:unit:squareMetre + + + + + + unit:squareInch + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#ItemUnitEnumeration:unit:squareInch + + + + + + unit:squareFoot + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#ItemUnitEnumeration:unit:squareFoot + + + + + + unit:squareYard + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#ItemUnitEnumeration:unit:squareYard + + + + + + unit:cubicCentimetre + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#ItemUnitEnumeration:unit:cubicCentimetre + + + + + + unit:cubicMetre + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#ItemUnitEnumeration:unit:cubicMetre + + + + + + unit:cubicInch + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#ItemUnitEnumeration:unit:cubicInch + + + + + + unit:cubicFoot + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#ItemUnitEnumeration:unit:cubicFoot + + + + + + unit:cubicYard + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#ItemUnitEnumeration:unit:cubicYard + + + + + + unit:litre + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#ItemUnitEnumeration:unit:litre + + + + + + unit:millilitre + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#ItemUnitEnumeration:unit:millilitre + + + + + + unit:hectolitre + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#ItemUnitEnumeration:unit:hectolitre + + + + + + unit:secondUnitOfTime + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#ItemUnitEnumeration:unit:secondUnitOfTime + + + + + + unit:minuteUnitOfTime + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#ItemUnitEnumeration:unit:minuteUnitOfTime + + + + + + unit:hourUnitOfTime + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#ItemUnitEnumeration:unit:hourUnitOfTime + + + + + + unit:day + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.quantity:2.0.0#ItemUnitEnumeration:unit:day + + + + + + + + + + + + + quantity + + + en + Quantity + + + urn:samm:io.catenax.single_level_usage_as_built:3.0.0#quantity + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Quantity + + + + + en + quantity + + + STRING + + + en + Quantity of which the child part is assembled into the parent part. In general it is '1' for serialized parts. + + + + + + + + + createdOn + + + en + Created On + + + urn:samm:io.catenax.single_level_usage_as_built:3.0.0#createdOn + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Created On + + + + + en + createdOn + + + STRING + + + en + Timestamp when the relation between the parent part and the child part was created, e.g. when the given child part was assembled into the parent part. + + + + + + + + + lastModifiedOn + + + en + Last Modification Date + + + urn:samm:io.catenax.single_level_usage_as_built:3.0.0#lastModifiedOn + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Last Modification Date + + + + + en + lastModifiedOn + + + STRING + + + en + Timestamp when the assembly or usage relationship between parent part and child part was last modified. + + + + + + + + + isOnlyPotentialParent + + + en + Is Only Potential Parent + + + urn:samm:io.catenax.single_level_usage_as_built:3.0.0#isOnlyPotentialParent + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Is Only Potential Parent + + + + + en + isOnlyPotentialParent + + + BOOLEAN + + + en + Expresses the certainty whether the part has been used as component or input material in the produced item. If the value is false, it can be assumed that the part has been used. If the value is true, there are alternatives for that part, and it is unknown if this part item or an alternative part item has been used. +This is the case when, e.g. the same item is supplied by two suppliers, and the item is only tracked by a customer part ID during assembly. Thus, these items cannot be differentiated from each other. + + + + + + + + + + businessPartner + + + en + Business Partner + + + urn:samm:io.catenax.single_level_usage_as_built:3.0.0#businessPartner + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Business Partner + + + + + en + businessPartner + + + STRING + + + en + The supplier of the given child item. + + + + + + + + + catenaXId + + + en + Catena-X Identifier + + + urn:samm:io.catenax.single_level_usage_as_built:3.0.0#catenaXId + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Catena-X Identifier + + + + + en + catenaXId + + + STRING + + + en + The Catena-X ID of the given part (e.g. the component), valid for the Catena-X dataspace. + + + + + + + + + parentItems + + + en + Parent Items + + + urn:samm:io.catenax.single_level_usage_as_built:3.0.0#parentItems + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Parent Items + + + + + en + parentItems + + + STRING + + + en + Set of parent items, in which the given child object is assembled in (one structural level up). + +For serialized items the list should contain only one parent item. +As different subsets of a batch might be used by a customer in different items this is a list. + + + + + + + + + diff --git a/io.catenax.single_level_usage_as_built/3.0.0/gen/SingleLevelUsageAsBuilt-schema.json b/io.catenax.single_level_usage_as_built/3.0.0/gen/SingleLevelUsageAsBuilt-schema.json new file mode 100644 index 00000000..64163598 --- /dev/null +++ b/io.catenax.single_level_usage_as_built/3.0.0/gen/SingleLevelUsageAsBuilt-schema.json @@ -0,0 +1,116 @@ +{ + "$schema" : "http://json-schema.org/draft-04/schema", + "description" : "The aspect provides the information in which parent part(s)/product(s)the given item is assembled in. Could be a 1:1 relationship in terms of an e.g. a brake component or 1:n for e.g. coatings. The parent item must refer to an object from as-built lifecycle phase, i.e. a batch or a serialized part.", + "type" : "object", + "components" : { + "schemas" : { + "urn_samm_io.catenax.shared.uuid_2.0.0_UuidV4Trait" : { + "type" : "string", + "description" : "The provided regular expression ensures that the UUID is composed of five groups of characters separated by hyphens, in the form 8-4-4-4-12 for a total of 36 characters (32 hexadecimal characters and 4 hyphens), optionally prefixed by \"urn:uuid:\" to make it an IRI.", + "pattern" : "(^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$)|(^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$)" + }, + "urn_samm_io.catenax.single_level_usage_as_built_3.0.0_ListOfCustomersCharacteristic" : { + "description" : "A list of customers and their related parent items.", + "type" : "array", + "items" : { + "type" : "string", + "description" : "The provided regular expression ensures that the BPNL is composed of prefix 'BPNL', 10 digits and two alphanumeric letters.", + "pattern" : "^BPNL[a-zA-Z0-9]{12}$" + } + }, + "urn_samm_io.catenax.shared.quantity_2.0.0_QuantityValueCharacteristic" : { + "type" : "number", + "description" : "The quantity value associated with the unit expressed as float." + }, + "urn_samm_io.catenax.shared.quantity_2.0.0_ItemUnitEnumeration" : { + "type" : "string", + "pattern" : "[a-zA-Z]*:[a-zA-Z]+", + "description" : "Enumeration for common item units.", + "enum" : [ "unit:piece", "unit:set", "unit:pair", "unit:page", "unit:cycle", "unit:kilowattHour", "unit:gram", "unit:kilogram", "unit:tonneMetricTon", "unit:tonUsOrShortTonUkorus", "unit:ounceAvoirdupois", "unit:pound", "unit:metre", "unit:centimetre", "unit:kilometre", "unit:inch", "unit:foot", "unit:yard", "unit:squareCentimetre", "unit:squareMetre", "unit:squareInch", "unit:squareFoot", "unit:squareYard", "unit:cubicCentimetre", "unit:cubicMetre", "unit:cubicInch", "unit:cubicFoot", "unit:cubicYard", "unit:litre", "unit:millilitre", "unit:hectolitre", "unit:secondUnitOfTime", "unit:minuteUnitOfTime", "unit:hourUnitOfTime", "unit:day" ] + }, + "urn_samm_io.catenax.shared.quantity_2.0.0_ItemQuantityCharacteristic" : { + "description" : "Characteristic for measurements of an item (mass, count, linear, area, volume, misc).", + "type" : "object", + "properties" : { + "value" : { + "description" : "The quantity value associated with the unit.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.quantity_2.0.0_QuantityValueCharacteristic" + }, + "unit" : { + "description" : "The unit of an item. Common units may be related to mass, count, linear, area, volume or misc.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.quantity_2.0.0_ItemUnitEnumeration" + } + }, + "required" : [ "value", "unit" ] + }, + "urn_samm_io.catenax.single_level_usage_as_built_3.0.0_DateTimeTrait" : { + "type" : "string", + "description" : "Regular Expression to enable UTC and Timezone formats and the possibility to exclude time information.", + "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))?)?$" + }, + "urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Boolean" : { + "type" : "boolean", + "description" : "Represents a boolean value (i.e. a \"flag\")." + }, + "urn_samm_io.catenax.shared.business_partner_number_2.0.0_BpnlTrait" : { + "type" : "string", + "description" : "The provided regular expression ensures that the BPNL is composed of prefix 'BPNL', 10 digits and two alphanumeric letters.", + "pattern" : "^BPNL[a-zA-Z0-9]{12}$" + }, + "urn_samm_io.catenax.single_level_usage_as_built_3.0.0_ParentData" : { + "description" : "Catena-X ID and meta data of the parent item.", + "type" : "object", + "properties" : { + "quantity" : { + "description" : "Quantity of which the child part is assembled into the parent part. In general it is '1' for serialized parts.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.quantity_2.0.0_ItemQuantityCharacteristic" + }, + "createdOn" : { + "description" : "Timestamp when the relation between the parent part and the child part was created, e.g. when the given child part was assembled into the parent part.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.single_level_usage_as_built_3.0.0_DateTimeTrait" + }, + "lastModifiedOn" : { + "description" : "Timestamp when the assembly or usage relationship between parent part and child part was last modified.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.single_level_usage_as_built_3.0.0_DateTimeTrait" + }, + "isOnlyPotentialParent" : { + "description" : "Expresses the certainty whether the part has been used as component or input material in the produced item. If the value is false, it can be assumed that the part has been used. If the value is true, there are alternatives for that part, and it is unknown if this part item or an alternative part item has been used.\nThis is the case when, e.g. the same item is supplied by two suppliers, and the item is only tracked by a customer part ID during assembly. Thus, these items cannot be differentiated from each other.\n", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Boolean" + }, + "businessPartner" : { + "description" : "The supplier of the given child item.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.business_partner_number_2.0.0_BpnlTrait" + }, + "catenaXId" : { + "description" : "The Catena-X ID of the given part (e.g. the component), valid for the Catena-X dataspace.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.uuid_2.0.0_UuidV4Trait" + } + }, + "required" : [ "createdOn", "isOnlyPotentialParent", "businessPartner", "catenaXId" ] + }, + "urn_samm_io.catenax.single_level_usage_as_built_3.0.0_SetOfParentItemsCharacteristic" : { + "description" : "Set of parent items the given child object is assembled in (one structural level up).", + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/urn_samm_io.catenax.single_level_usage_as_built_3.0.0_ParentData" + }, + "uniqueItems" : true + } + } + }, + "properties" : { + "catenaXId" : { + "description" : "The Catena-X ID of the given part (e.g. the component), valid for the Catena-X dataspace.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.uuid_2.0.0_UuidV4Trait" + }, + "customers" : { + "description" : "A list of all customers of this item. If the parent items in which this item is assembled into are known, they should be listed as well.\n\nFor serialized items the list should contain only one customer with one parent item.\nAs different subsets of a batch might be sold to different customers this is a list.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.single_level_usage_as_built_3.0.0_ListOfCustomersCharacteristic" + }, + "parentItems" : { + "description" : "Set of parent items, in which the given child object is assembled in (one structural level up).\n\nFor serialized items the list should contain only one parent item.\nAs different subsets of a batch might be used by a customer in different items this is a list.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.single_level_usage_as_built_3.0.0_SetOfParentItemsCharacteristic" + } + }, + "required" : [ "catenaXId", "customers", "parentItems" ] +} \ No newline at end of file diff --git a/io.catenax.single_level_usage_as_built/3.0.0/gen/SingleLevelUsageAsBuilt.aasx b/io.catenax.single_level_usage_as_built/3.0.0/gen/SingleLevelUsageAsBuilt.aasx new file mode 100644 index 0000000000000000000000000000000000000000..4b2f50b5a518849b9f620423a83850b2157f140e GIT binary patch literal 5963 zcmaKw1yEeewuX`5?v@aO1qOG54>~Z&pg{*6+zIXk4elP?-QC?iBxnKz2n3e|&4b)` z>*Ss*YuE1DUDa!K_1}MY?fM{K#3zJssHmuLUlnyV;rqzAZ%RY8YAELZ{P{slKAZV%2CrSrr6%kcNL7re)Q(Jc3M=q^TgY?`ert|r? z`27QJ>}|lNwuFEWg}1aSFg_BI8pPKVy%d=#l5e9 zEzX7N4oU)JCB|vqCAHL{t>OvR;;3Jk>tTum(Nl#DRJ&&3yHGgTlJBio;R?CkLUOG> zshU^Ghc8r*b2C3Z^xhDp^K(z1|B5f8jO^JLX!S+6>`)aa-W%*2Bp&~fI~&KqCFLuk z%z?J#`=p}KPp;_qR`$lcBwR#{OlbpiX@`s5yseqJ)@DX6mDb5wpKjqGU=-B(O$ywL z2TeZ0!#(u>n`#&jBlI0%)=q4!k8LJoOtFt0_m;@&C@P-tUHIN*@H~b1S47^+!5WbD zSR>@-M+&7Mm7=bO_Qa&InQuEYmuFFe-Z6S>A(Au{WwTxV*u!T7Uz2qgYqBRkfC>mvcqwOg(LiSig!j3`R? zC?49Aehqd-B==byjl%I*aa?Umzi}YVPr~V*OkpNM3caEhLBSc(+F^2xJWoWQ*btf` zm~h(cJ+RL-7$EZPmwh?syPTSxrCQAW44>y>O5f*~C6HNd+Mp*L5WV21;?QtL4l0)u z_4=(8j;sI9$%77U|5GX4hY^N`PHt?E4U3(lg_(uz**KHz1k=d)6nK23L=7~-!ca1g z_`4=K$RLIIA%pPY{qO2i{Iljiw&0J-zjs4D8f^REUCAnHdp7XZ#~Q@3Pej9wARIBB zbCd=;AYs7Pr8=Kf$EJNZU*F~BlEz8?aJVZnb`Ubq_SnTC-oI)nq#S53Zsu?ih1nkV zzKQB|o#^Jqw$4 z5R*;oVZPtKqV3DQcXm%uaH4mgUC>;lTe^n?xEW+HkPRza9<#=RrQX+_V4uH6KWOA1 z;i|BzaSIx*^7da(+!8}9u2gUP)%yI=l7Z)B+~W^RrvINpKT7sn=!etGX8ex>{dkfO z^mOc&`H6j|s;Eq#FCm0wD*E?Or;Jc3%xM|N)2kMRAF2YuZ^pwUJtP5PKNgQ(I475+ z8^3HEPu9(sI6XcV-0{i>eOp}5^1>005ra(nc%J##-y-8}+b7qyt*?2t-Fcl)@pWZU z-oC5hfAQTPIpZo&_DMkszkgZR9e2DVt75Rk_v?gbVPq%m@LwgG`EJ>T?iq=_@wxGl zMuvuldNxDgaSnq;pFi(GAV zDndcE2&%!Ae9veIFv(^jD-#!&55{;ljBo~2E@R}gH8RFqL>Au@yj-Zh9 zaEn2=sw%1leCUR*axs1lxODCQwD6))PcFcAC4PDTl@I~*MuLIE{ehy>PmMa-Bz zV0nt|3QmwDIU&eVohIwHpp_4+8OQROMFe%UVpyHM5QAV}z*A}gs#ZPboV;mt>3}DM zp69;PC<~iCwldvu>xtrDI8?%RDYHULi)jcP3 z8e47?w5kCnHUIjj25nB=7v{Qdk|$Y?9&kr#@nWn=<%xk2#b)a=l^k*T z8>~d^rQvKJ`N){xR^l_rBm`(0tBpu2UJbWs9PJ8{w@eEP6wtD}Lre=j)QyxlT?_HE zq}cU@fcb{ajAa_z3wz_OB$&v11 z6uEMRCDLX9wi&*}ScW^sPoPTV3{4`JH(k-z=g;y~$%@V&{RDc^s{2E0`XhRZT)9f- z@t#_u1aW;ECsszuvC}4^$zg}@8NMhDl@b65*~=a$ifzG(iX;L_W!g5J=jJy>M}diD z15np%H1N}3nL)L5jCE6N#?uKOXVVWdUrBf+N>D)bzs|45>P!0OIi(LaaQ4o>a$mAl zZyh7tPdJ@5Dy&cLvS@AcxCW1jFd-3F*vb2+8cuv$PC>5|T=)QeL6;=3%1*$G-?JyL zoz5xva)ALgN)2;$vfhJ0>RU#z_gJ}c?wqBF8Rd4oDd&ZYDWQsz&@u}Qa;^d6hNB-} z?1S?Jc@m)S9BC+~lobp?#4zHKRzL)-YH5iI(J3Z5^JylyZu@VdlE;P=A z*cpts_#<_*$ym>-PIq=(gwm;e#Zy{_U*gk{jN>|N=Y}|QD8S%Kor2Vw-hKas6>Aap z#2X;;i>#CoKtghD#v(9x+JMRuA;u+#u~C7-%u*0pb?qM)mF=Z8Zkz{h3bdtPp58Y_ zrC?S?*>u*VuML9cI5!_TA^QzdW9AN2xH-R`I$XPsNy7#LOippBg=qNs)wqPbLMfX` zuD5XUgYDO(oH!VWIROpP2KisK_Oa>X7q9K(b@K1ZX_K(H(gPp?Kf8=^znxF-Vp^O? zhk)po1*LL8MPHP_dpV#x>cyfxj#-#svo!sBFLI=6e(q&vkzCM*x@uu9By;?%5E3L{ zS*XHw%;_2>=tTcIM!Gf}>#kaFlM@oKR91N$7nQtfDH zRZmZ;*;;k!&V~SJ9}?YZ&U5m!(5^3NtsZUsYSku2?mu z&y}Bnyc2eR&Bm7%HeW;(&yp&o(Tq3|jGU3IgzuI{Qervei5S(7P){9SHQujn?XP;x z^@&3rUfYCy)I#Y96v-|oP&QJ=aEnwG*)Om9Tu$Gt6@9Q(qo&Jc=g?QMG!ochKH|am z%#}7~4?|Ay?P*6%rIqbnqHYti>+*IF!K84&rw^^iv`?G}UUUb?(dpp1PPmH>W{L$t zHH&zf?&TD%B$pan_LE+&Y6((*JjYc;B}>z2Puh$1>~ zd-mo^yzKc2=ap?Z)q)5+tfyF`<$6;dMg%}qx`+xSZo}31mLS}8`EKU}bn6W(CZdDh zMrows<}FRcDX>JYhiQ@b!U>%%IdKyiF1}T zMC{d}`{HXkABp zHG%;32qQG0so0HAYD0(q;1eFOb1NisyDptg(KT%fY8!l3FRX0d67^N!BDZbWc`3_n zjjz`j6~0Q!qZ68;ci-H~PvLvxQ4>BdQxQbF9kJ${{Sm{pScJOZDlqr?9vvF*jve#P zBISn9$s2u7)Egu&?@s{Uk!4!_m#yKloeLN^mn>Z*&(NJE1g?-TO+UbiD9l*S1ndVXGd->sF%Jp*JE3g{yCqCz)!Ns9wwoXRRnz&hNjA^- zoPA4Zh4}hsXIN|y@7r>hq=kwfSZXxjA-=aI8o>*ZKd@A?Sa{Yk^R>w|_}2J9cZ;*< z6Jn)_hR&OJ{s{z%#l|hIGa^=+fFpCg3gA>XEY;%^w^i=~6yJH(X>4vr8n+>uThDc+ z_DwyW*a3~~;>J^wHJNYQ&4mbB4At-kx#%g1?9RJb-kwlCCq zC(d3h^i;Q=+>6QKhH$+m`|9BV_QojZVRLrj`K{e4BL-c~F(OKbhn8t6QoxkR>~yH)%E~ z68zEgz%UV=9=s%L6WIVdw8zT=e^0o|yyGqhjc&0?DCf+TvREmw|Nf~af?*osE}MW@ zow@iHO&HsDD17fYOI?@@Gen3u1mt@qP{Ddl?;_ji@1ZGD!zl8_@I_TK29`BWN%NCT zNWR*<)e{%D9y>{1e9XET=CNw#JjFL8TGF1cnYA5#NkbTkHJ56Tm+({rg04XcQN4_K zcw7QXBcRmKgwP;z%B`VIWB2}T5kAJs)TZVya$4^?D1-saz?aepjH{5+r=wO)M1i>< zJd$2(LX{uxg7(~SC1RTv(eYe*hIZnfpKjjX?hcnQ60*U82fD)$6q*D8QE|W=bABT0 zqQ=pogqe1e)4$US3}^;b7~A_!rc#r2OERQ~h%rzF6w6Q^+o`dCw%sjWz_`;JpHb6a z_#z?vGSx^aM&e?+zsHhH${~IF_4APoL#>%pM;1=h9Q*=iW&Ih+k8@u%XHj+&JTUXD zRC%6R(h~~jp?!Mzf5lW*r?`DC{9QRKGzdRip)zTuBNu?uR7xAE5P~$r%mV$Wyhybf zTTF!-W-s!?&n9OCVMONr?eoySHw6rMUjfL&aDqQ#`K1*ZXnzDl@2&C z@Of@r00EX&7T#L z1lK4HWK<<%uN8(9e7l}#lW0g0Uv;aYef@T?J;gXgGp?E=4p+EXwJ5#cWjfFtNc5F^ z3Ejt_Iv$3a^kP2jkXpk0v@`eaGK8GDrHc+lPl2Ca1uwwOEYwHZzWDvT$qw|?3eoG7 z#35<2E4xXIEG7oHI}FKmo57<9I&*#d_U+UF7u$>~s(O`7kfgyn?p{!RF(rr86u%nm zl{Yeq8MUXTza&4NBzgh2GyyXZoV7M_PJ?wvSo+ia31DKBK2iq9yjr8DHU*oxaF3EO zlF1B*`}6qX-ra8~F%ETKPU4n9}hEWH6 z)d(>(y@t}s6XTZ152UZA)CUABsD=>v+Zj0xQ>KY8H7Ke(kwOq;UeU`(Q5<2>^oJqS zx;oewQ*~M}wczOM5cCZQR{7^AyvIX(|9ZuV6M=?{-~>%8jLbsBnhzcT%tk~T6^!dg zyE^fxp1q?;N%-V$fAD?pM&ytro{d{>`0Q@APff&f!L1EW*W@KP0daE(IuhL3TeNsD zCZ+JPGRN@ngu=1VLgiN0Z?AMJG{yBfPnkp!qU~(Ltsn+3_xAl*dj+tv?+%dpY-Yx-2D~x|IGf+81L_e{&d_U?D{K4 o5dSm!`g?^x<$ZMKUjcn6_-{UifRT_Nhaf*Z0S^+@5k2<)4^{z+GXMYp literal 0 HcmV?d00001 diff --git a/io.catenax.single_level_usage_as_built/3.0.0/gen/SingleLevelUsageAsBuilt.html b/io.catenax.single_level_usage_as_built/3.0.0/gen/SingleLevelUsageAsBuilt.html new file mode 100644 index 00000000..3a1e5d8e --- /dev/null +++ b/io.catenax.single_level_usage_as_built/3.0.0/gen/SingleLevelUsageAsBuilt.html @@ -0,0 +1,1255 @@ + + + + + + + + + + + + + + Documentation SingleLevelUsageAsBuilt + + +
+
+
+
+

Aspect Model SingleLevelUsageAsBuilt

+
urn:samm:io.catenax.single_level_usage_as_built:3.0.0#SingleLevelUsageAsBuilt
+
+
+
+
+
+
+
+ +
+ + +
+ The aspect provides the information in which parent part(s)/product(s)the given item is assembled in. Could be a 1:1 relationship in terms of an e.g. a brake component or 1:n for e.g. coatings. The parent item must refer to an object from as-built lifecycle phase, i.e. a batch or a serialized part. +
+ + +
+

Overview

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

Properties

+
+ +
+ +
+

Catena-X Identifier

+
+ +The Catena-X ID of the given part (e.g. the component), valid for the Catena-X dataspace. + +
+
Name
+
catenaXId
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
    +
  • https://tools.ietf.org/html/rfc4122
    • +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
urn:uuid:055c1128-0375-47c8-98de-7cf802c3241d
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
catenaXId
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + UUID v4 Regular Expression +
    + +
    +
    Description
    +
    The provided regular expression ensures that the UUID is composed of five groups of characters separated by hyphens, in the form 8-4-4-4-12 for a total of 36 characters (32 hexadecimal characters and 4 hyphens), optionally prefixed by "urn:uuid:" to make it an IRI.
    +
    + +
    +
    Reference
    +
    +
    +
      +
    • https://datatracker.ietf.org/doc/html/rfc4122
      • +
    +
    +
    +
    + +
    +
    Regular expression
    +
    (^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$)|(^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$)
    +
    + +
    • +
+
+
+
+
+ +
+

Customers

+
+ +A list of all customers of this item. If the parent items in which this item is assembled into are known, they should be listed as well. + +For serialized items the list should contain only one customer with one parent item. +As different subsets of a batch might be sold to different customers this is a list. + +
+
Name
+
customers
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
BPNL50096894aNXY
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
customers
+
+ + +
+
+ +
+

Parent Items

+
+ +Set of parent items, in which the given child object is assembled in (one structural level up). + +For serialized items the list should contain only one parent item. +As different subsets of a batch might be used by a customer in different items this is a list. + +
+
Name
+
parentItems
+
+ + + +
+
Characteristic
+
+
+
+
Set
+
+
+
Has no order
+
+
+
Duplicates not allowed
+
+
+
+ Type urn:samm:io.catenax.single_level_usage_as_built:3.0.0#ParentData + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
parentItems
+
+ + +
+
+ + + +
+
+

Entities

+
+ +
+
+

Item Quantity Entity

+
+
+ Entity for common measurements of an item (mass, count, linear, area, volume, misc) with an unit and a value. +
+ +
+

Properties

+
+
+ +
+
Quantity Value
+
+ +The quantity value associated with the unit. + +
+
Name
+
quantityValue
+
+ + + +
+
Characteristic
+
+
+
+
Quantifiable
+
+
+
Duration
+
+
+
The quantity value associated with the unit expressed as float.
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#float + +
+
+
+
+
+ +
+
Example
+
20.0
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
value
+
+ + +
+
+ +
+
Item Unit
+
+ +The unit of an item. Common units may be related to mass, count, linear, area, volume or misc. + +
+
Name
+
itemUnit
+
+ + + +
+
Characteristic
+
+
+
+
Enumeration
+
+
+
Values
+
+
+
+
    +
  • unit:piece
    • +
  • unit:set
    • +
  • unit:pair
    • +
  • unit:page
    • +
  • unit:cycle
    • +
  • unit:kilowattHour
    • +
  • unit:gram
    • +
  • unit:kilogram
    • +
  • unit:tonneMetricTon
    • +
  • unit:tonUsOrShortTonUkorus
    • +
  • unit:ounceAvoirdupois
    • +
  • unit:pound
    • +
  • unit:metre
    • +
  • unit:centimetre
    • +
  • unit:kilometre
    • +
  • unit:inch
    • +
  • unit:foot
    • +
  • unit:yard
    • +
  • unit:squareCentimetre
    • +
  • unit:squareMetre
    • +
  • unit:squareInch
    • +
  • unit:squareFoot
    • +
  • unit:squareYard
    • +
  • unit:cubicCentimetre
    • +
  • unit:cubicMetre
    • +
  • unit:cubicInch
    • +
  • unit:cubicFoot
    • +
  • unit:cubicYard
    • +
  • unit:litre
    • +
  • unit:millilitre
    • +
  • unit:hectolitre
    • +
  • unit:secondUnitOfTime
    • +
  • unit:minuteUnitOfTime
    • +
  • unit:hourUnitOfTime
    • +
  • unit:day
    • +
+
+
+
+
+ Reference +
+
    +
  • https://eclipse-esmf.github.io/samm-specification/2.1.0/index.html
    • +
+
+
+
+
+
+ Type urn:samm:org.eclipse.esmf.samm:meta-model:2.1.0#curie + +
+
+
+
+
+ +
+
Example
+
unit:piece
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
unit
+
+ +
+
Reference
+
+
    +
  • https://eclipse-esmf.github.io/samm-specification/2.1.0/index.html
    • +
+
+
+ +
+
+
+
+

Parent Data

+
+
+ Catena-X ID and meta data of the parent item. +
+ +
+

Properties

+
+
+ +
+
Quantity
+
+ +Quantity of which the child part is assembled into the parent part. In general it is '1' for serialized parts. + +
+
Name
+
quantity
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.shared.quantity:2.0.0#ItemQuantityEntity + +
+
+
+
+
+ + +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
quantity
+
+ + +
+
+ +
+
Created On
+
+ +Timestamp when the relation between the parent part and the child part was created, e.g. when the given child part was assembled into the parent part. + +
+
Name
+
createdOn
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
2022-02-03T14:48:54.709Z
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
createdOn
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + Date Time Regular Expression +
    + +
    +
    Description
    +
    Regular Expression to enable UTC and Timezone formats and the possibility to exclude time information.
    +
    + + +
    +
    Regular expression
    +
    ^-?([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))?)?$
    +
    + +
    • +
+
+
+
+
+ +
+
Last Modification Date
+
+ +Timestamp when the assembly or usage relationship between parent part and child part was last modified. + +
+
Name
+
lastModifiedOn
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
2022-02-03T14:48:54.709Z
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
lastModifiedOn
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + Date Time Regular Expression +
    + +
    +
    Description
    +
    Regular Expression to enable UTC and Timezone formats and the possibility to exclude time information.
    +
    + + +
    +
    Regular expression
    +
    ^-?([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))?)?$
    +
    + +
    • +
+
+
+
+
+ +
+
Is Only Potential Parent
+
+ +Expresses the certainty whether the part has been used as component or input material in the produced item. If the value is false, it can be assumed that the part has been used. If the value is true, there are alternatives for that part, and it is unknown if this part item or an alternative part item has been used. +This is the case when, e.g. the same item is supplied by two suppliers, and the item is only tracked by a customer part ID during assembly. Thus, these items cannot be differentiated from each other. + + +
+
Name
+
isOnlyPotentialParent
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#boolean + +
+
+
+
+
+ +
+
Example
+
false
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
isOnlyPotentialParent
+
+ + +
+
+ +
+
Business Partner
+
+ +The supplier of the given child item. + +
+
Name
+
businessPartner
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
    +
  • https://catena-x.net/fileadmin/user_upload/Standard-Bibliothek/Update_PDF_Maerz/5_BPDM/CX_-_0010_BUSINESS_PARTNER_NUMBER_PlatformCapabilityBPDM_v_1.0.1.pdf
    • +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
BPNL50096894aNXY
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
businessPartner
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + BPNL Regular Expression +
    + +
    +
    Description
    +
    The provided regular expression ensures that the BPNL is composed of prefix 'BPNL', 10 digits and two alphanumeric letters.
    +
    + + +
    +
    Regular expression
    +
    ^BPNL[a-zA-Z0-9]{12}$
    +
    + +
    • +
+
+
+
+
+ +
+
Catena-X Identifier
+
+ +The Catena-X ID of the given part (e.g. the component), valid for the Catena-X dataspace. + +
+
Name
+
catenaXId
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
    +
  • https://tools.ietf.org/html/rfc4122
    • +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
urn:uuid:055c1128-0375-47c8-98de-7cf802c3241d
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
catenaXId
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + UUID v4 Regular Expression +
    + +
    +
    Description
    +
    The provided regular expression ensures that the UUID is composed of five groups of characters separated by hyphens, in the form 8-4-4-4-12 for a total of 36 characters (32 hexadecimal characters and 4 hyphens), optionally prefixed by "urn:uuid:" to make it an IRI.
    +
    + +
    +
    Reference
    +
    +
    +
      +
    • https://datatracker.ietf.org/doc/html/rfc4122
      • +
    +
    +
    +
    + +
    +
    Regular expression
    +
    (^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$)|(^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$)
    +
    + +
    • +
+
+
+
+
+
+ +
+ Third party licenses + +
+ +
+ + +
+ + + \ No newline at end of file diff --git a/io.catenax.single_level_usage_as_built/3.0.0/gen/SingleLevelUsageAsBuilt.json b/io.catenax.single_level_usage_as_built/3.0.0/gen/SingleLevelUsageAsBuilt.json new file mode 100644 index 00000000..d11accf0 --- /dev/null +++ b/io.catenax.single_level_usage_as_built/3.0.0/gen/SingleLevelUsageAsBuilt.json @@ -0,0 +1,15 @@ +{ + "catenaXId" : "urn:uuid:055c1128-0375-47c8-98de-7cf802c3241d", + "parentItems" : [ { + "catenaXId" : "urn:uuid:055c1128-0375-47c8-98de-7cf802c3241d", + "isOnlyPotentialParent" : false, + "quantity" : { + "value" : 20.0, + "unit" : "unit:piece" + }, + "createdOn" : "2022-02-03T14:48:54.709Z", + "businessPartner" : "BPNL50096894aNXY", + "lastModifiedOn" : "2022-02-03T14:48:54.709Z" + } ], + "customers" : [ "BPNL50096894aNXY" ] +} \ No newline at end of file diff --git a/io.catenax.single_level_usage_as_built/3.0.0/gen/SingleLevelUsageAsBuilt.yml b/io.catenax.single_level_usage_as_built/3.0.0/gen/SingleLevelUsageAsBuilt.yml new file mode 100644 index 00000000..bea310b8 --- /dev/null +++ b/io.catenax.single_level_usage_as_built/3.0.0/gen/SingleLevelUsageAsBuilt.yml @@ -0,0 +1,280 @@ +--- +openapi: 3.0.3 +info: + title: SingleLevelUsageAsBuilt + version: v3 +servers: +- url: catenax.io/api/v3 + variables: + api-version: + default: v3 +paths: + /{tenant-id}/single-level-usage-as-built: + get: + tags: + - SingleLevelUsageAsBuilt + operationId: getSingleLevelUsageAsBuilt + parameters: + - name: tenant-id + in: path + description: The ID of the tenant owning the requested Twin. + required: true + schema: + type: string + format: uuid + - name: start + in: query + description: Starting index which is starting by 0 + required: false + schema: + type: number + - name: count + in: query + description: Number of items to return per call. + required: false + schema: + type: number + - name: totalItemCount + in: query + description: Flag that indicates that the total counts should be returned. + required: false + schema: + type: boolean + responses: + "200": + $ref: '#/components/responses/SingleLevelUsageAsBuilt' + "401": + $ref: '#/components/responses/ClientError' + "402": + $ref: '#/components/responses/Unauthorized' + "403": + $ref: '#/components/responses/Forbidden' + "404": + $ref: '#/components/responses/NotFoundError' +components: + schemas: + ErrorResponse: + type: object + required: + - error + properties: + error: + $ref: '#/components/schemas/Error' + Error: + type: object + required: + - details + properties: + message: + type: string + minLength: 1 + path: + type: string + minLength: 1 + details: + type: object + minLength: 1 + additionalProperties: + type: object + code: + type: string + nullable: true + PagingSchema: + type: object + properties: + items: + type: array + items: + $ref: '#/components/schemas/SingleLevelUsageAsBuilt' + totalItems: + type: number + totalPages: + type: number + pageSize: + type: number + currentPage: + type: number + urn_samm_io.catenax.shared.uuid_2.0.0_UuidV4Trait: + type: string + description: "The provided regular expression ensures that the UUID is composed\ + \ of five groups of characters separated by hyphens, in the form 8-4-4-4-12\ + \ for a total of 36 characters (32 hexadecimal characters and 4 hyphens),\ + \ optionally prefixed by \"urn:uuid:\" to make it an IRI." + pattern: "(^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$)|(^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$)" + urn_samm_io.catenax.single_level_usage_as_built_3.0.0_ListOfCustomersCharacteristic: + description: A list of customers and their related parent items. + type: array + items: + type: string + description: "The provided regular expression ensures that the BPNL is composed\ + \ of prefix 'BPNL', 10 digits and two alphanumeric letters." + pattern: "^BPNL[a-zA-Z0-9]{12}$" + urn_samm_io.catenax.shared.quantity_2.0.0_QuantityValueCharacteristic: + type: number + description: The quantity value associated with the unit expressed as float. + urn_samm_io.catenax.shared.quantity_2.0.0_ItemUnitEnumeration: + type: string + pattern: "[a-zA-Z]*:[a-zA-Z]+" + description: Enumeration for common item units. + enum: + - unit:piece + - unit:set + - unit:pair + - unit:page + - unit:cycle + - unit:kilowattHour + - unit:gram + - unit:kilogram + - unit:tonneMetricTon + - unit:tonUsOrShortTonUkorus + - unit:ounceAvoirdupois + - unit:pound + - unit:metre + - unit:centimetre + - unit:kilometre + - unit:inch + - unit:foot + - unit:yard + - unit:squareCentimetre + - unit:squareMetre + - unit:squareInch + - unit:squareFoot + - unit:squareYard + - unit:cubicCentimetre + - unit:cubicMetre + - unit:cubicInch + - unit:cubicFoot + - unit:cubicYard + - unit:litre + - unit:millilitre + - unit:hectolitre + - unit:secondUnitOfTime + - unit:minuteUnitOfTime + - unit:hourUnitOfTime + - unit:day + urn_samm_io.catenax.shared.quantity_2.0.0_ItemQuantityCharacteristic: + description: "Characteristic for measurements of an item (mass, count, linear,\ + \ area, volume, misc)." + type: object + properties: + value: + description: The quantity value associated with the unit. + $ref: '#/components/schemas/urn_samm_io.catenax.shared.quantity_2.0.0_QuantityValueCharacteristic' + unit: + description: "The unit of an item. Common units may be related to mass,\ + \ count, linear, area, volume or misc." + $ref: '#/components/schemas/urn_samm_io.catenax.shared.quantity_2.0.0_ItemUnitEnumeration' + required: + - value + - unit + urn_samm_io.catenax.single_level_usage_as_built_3.0.0_DateTimeTrait: + type: string + description: Regular Expression to enable UTC and Timezone formats and the possibility + to exclude time information. + 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))?)?$" + urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Boolean: + type: boolean + description: Represents a boolean value (i.e. a "flag"). + urn_samm_io.catenax.shared.business_partner_number_2.0.0_BpnlTrait: + type: string + description: "The provided regular expression ensures that the BPNL is composed\ + \ of prefix 'BPNL', 10 digits and two alphanumeric letters." + pattern: "^BPNL[a-zA-Z0-9]{12}$" + urn_samm_io.catenax.single_level_usage_as_built_3.0.0_ParentData: + description: Catena-X ID and meta data of the parent item. + type: object + properties: + quantity: + description: Quantity of which the child part is assembled into the parent + part. In general it is '1' for serialized parts. + $ref: '#/components/schemas/urn_samm_io.catenax.shared.quantity_2.0.0_ItemQuantityCharacteristic' + createdOn: + description: "Timestamp when the relation between the parent part and the\ + \ child part was created, e.g. when the given child part was assembled\ + \ into the parent part." + $ref: '#/components/schemas/urn_samm_io.catenax.single_level_usage_as_built_3.0.0_DateTimeTrait' + lastModifiedOn: + description: Timestamp when the assembly or usage relationship between parent + part and child part was last modified. + $ref: '#/components/schemas/urn_samm_io.catenax.single_level_usage_as_built_3.0.0_DateTimeTrait' + isOnlyPotentialParent: + description: | + Expresses the certainty whether the part has been used as component or input material in the produced item. If the value is false, it can be assumed that the part has been used. If the value is true, there are alternatives for that part, and it is unknown if this part item or an alternative part item has been used. + This is the case when, e.g. the same item is supplied by two suppliers, and the item is only tracked by a customer part ID during assembly. Thus, these items cannot be differentiated from each other. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Boolean' + businessPartner: + description: The supplier of the given child item. + $ref: '#/components/schemas/urn_samm_io.catenax.shared.business_partner_number_2.0.0_BpnlTrait' + catenaXId: + description: "The Catena-X ID of the given part (e.g. the component), valid\ + \ for the Catena-X dataspace." + $ref: '#/components/schemas/urn_samm_io.catenax.shared.uuid_2.0.0_UuidV4Trait' + required: + - createdOn + - isOnlyPotentialParent + - businessPartner + - catenaXId + urn_samm_io.catenax.single_level_usage_as_built_3.0.0_SetOfParentItemsCharacteristic: + description: Set of parent items the given child object is assembled in (one + structural level up). + type: array + items: + $ref: '#/components/schemas/urn_samm_io.catenax.single_level_usage_as_built_3.0.0_ParentData' + uniqueItems: true + SingleLevelUsageAsBuilt: + description: "The aspect provides the information in which parent part(s)/product(s)the\ + \ given item is assembled in. Could be a 1:1 relationship in terms of an e.g.\ + \ a brake component or 1:n for e.g. coatings. The parent item must refer to\ + \ an object from as-built lifecycle phase, i.e. a batch or a serialized part." + type: object + properties: + catenaXId: + description: "The Catena-X ID of the given part (e.g. the component), valid\ + \ for the Catena-X dataspace." + $ref: '#/components/schemas/urn_samm_io.catenax.shared.uuid_2.0.0_UuidV4Trait' + customers: + description: |- + A list of all customers of this item. If the parent items in which this item is assembled into are known, they should be listed as well. + + For serialized items the list should contain only one customer with one parent item. + As different subsets of a batch might be sold to different customers this is a list. + $ref: '#/components/schemas/urn_samm_io.catenax.single_level_usage_as_built_3.0.0_ListOfCustomersCharacteristic' + parentItems: + description: |- + Set of parent items, in which the given child object is assembled in (one structural level up). + + For serialized items the list should contain only one parent item. + As different subsets of a batch might be used by a customer in different items this is a list. + $ref: '#/components/schemas/urn_samm_io.catenax.single_level_usage_as_built_3.0.0_SetOfParentItemsCharacteristic' + required: + - catenaXId + - customers + - parentItems + responses: + Unauthorized: + description: The requesting user or client is not authenticated. + Forbidden: + description: The requesting user or client is not authorized to access resources + for the given tenant. + NotFoundError: + description: The requested Twin has not been found. + ClientError: + description: Payload or user input is invalid. See error details in the payload + for more. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + SingleLevelUsageAsBuilt: + content: + application/json: + schema: + $ref: '#/components/schemas/PagingSchema' + description: The request was successful. + requestBodies: + SingleLevelUsageAsBuilt: + content: + application/json: + schema: + $ref: '#/components/schemas/SingleLevelUsageAsBuilt'