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 00000000..4b2f50b5 Binary files /dev/null and b/io.catenax.single_level_usage_as_built/3.0.0/gen/SingleLevelUsageAsBuilt.aasx differ 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
  • +
+
+
+
+ +
+
+
+ +
+
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
+
+ +
+
+
+ +
+
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
+
+ +
+
+
+ + +
+
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.
+
+ +
+
+
+ +
+
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
  • +
+
+
+
+ +
+
+
+ +
+
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
+
+ +
+
+
+ + +
+
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 +
+
+
+
+ +
+
+
+ +
+
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 +
+
+
+
+ +
+
+
+ +
+
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
+ +
+ +
+
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
  • +
+
+
+
+ +
+
+
+ +
+
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
  • +
+
+
+
+ +
+
+
+ +
+
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'