From fc2255d7e05b6713364e9e7d8785e187e7df4ced Mon Sep 17 00:00:00 2001 From: Sahil Aggarwal Date: Fri, 2 Feb 2024 14:35:23 +0100 Subject: [PATCH] generated missing artifacts --- .../gen/SingleLevelUsageAsPlanned-aas.xml | 861 +++++++++++++ .../gen/SingleLevelUsageAsPlanned-schema.json | 103 ++ .../1.1.0/gen/SingleLevelUsageAsPlanned.aasx | Bin 0 -> 4877 bytes .../1.1.0/gen/SingleLevelUsageAsPlanned.html | 1081 +++++++++++++++++ .../1.1.0/gen/SingleLevelUsageAsPlanned.json | 16 + .../1.1.0/gen/SingleLevelUsageAsPlanned.yml | 225 ++++ 6 files changed, 2286 insertions(+) create mode 100644 io.catenax.single_level_usage_as_planned/1.1.0/gen/SingleLevelUsageAsPlanned-aas.xml create mode 100644 io.catenax.single_level_usage_as_planned/1.1.0/gen/SingleLevelUsageAsPlanned-schema.json create mode 100644 io.catenax.single_level_usage_as_planned/1.1.0/gen/SingleLevelUsageAsPlanned.aasx create mode 100644 io.catenax.single_level_usage_as_planned/1.1.0/gen/SingleLevelUsageAsPlanned.html create mode 100644 io.catenax.single_level_usage_as_planned/1.1.0/gen/SingleLevelUsageAsPlanned.json create mode 100644 io.catenax.single_level_usage_as_planned/1.1.0/gen/SingleLevelUsageAsPlanned.yml diff --git a/io.catenax.single_level_usage_as_planned/1.1.0/gen/SingleLevelUsageAsPlanned-aas.xml b/io.catenax.single_level_usage_as_planned/1.1.0/gen/SingleLevelUsageAsPlanned-aas.xml new file mode 100644 index 000000000..9101f2dba --- /dev/null +++ b/io.catenax.single_level_usage_as_planned/1.1.0/gen/SingleLevelUsageAsPlanned-aas.xml @@ -0,0 +1,861 @@ + + + + + defaultAdminShell + + + en + defaultAdminShell + + + + urn:samm:io.catenax.single_level_usage_as_planned:1.1.0#SingleLevelUsageAsPlanned + + Type + + + + ModelReference + + + Submodel + urn:samm:io.catenax.single_level_usage_as_planned:1.1.0#SingleLevelUsageAsPlanned/submodel + + + + + + + + + SingleLevelUsageAsPlanned + + + en + The aspect provides the information in which parent part(s)/product(s) the given item is assembled in. This could be a 1:1 relationship in terms of a e.g. a brake component or 1:n for e.g. coatings. The given item as well as the parent item must refer to an object from as-planned lifecycle phase. +If multiple versions of parent parts exist that the child part can be assembled into, all versions of the parent part are included in the usage list. + + + + urn:samm:io.catenax.single_level_usage_as_planned:1.1.0#SingleLevelUsageAsPlanned/submodel + Template + + ModelReference + + + ConceptDescription + urn:samm:io.catenax.single_level_usage_as_planned:1.1.0#SingleLevelUsageAsPlanned + + + + + + catenaXId + + + en + Catena-X Identifier + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.single_level_usage_as_planned:1.1.0#catenaXId + + + + xs:string + + + + parentParts + + + en + Parent Parts + + + + + en + Set of parent parts, in which the given child object is assembled in (one structural level up). + + + true + DataElement + + + ParentData + + + en + Parent Data + + + + + en + Catena-X ID and meta data of the parent part. + + + + + createdOn + + + en + Created on + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.single_level_usage_as_planned:1.1.0#createdOn + + + + xs:dateTime + + + + Quantity + + + en + Quantity + + + + + en + Comprises the number of objects and the unit of measurement for the respective child objects + + + + + quantityNumber + + + en + Quantity Number + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.single_level_usage_as_planned:1.1.0#quantityNumber + + + + xs:double + + + + measurementUnit + + + en + Measurement Unit + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.single_level_usage_as_planned:1.1.0#measurementUnit + + + + + + ExternalReference + + + GlobalReference + https://github.com/eclipse-esmf/esmf-semantic-aspect-meta-model/blob/main/esmf-semantic-aspect-meta-model/src/main/resources/samm/unit/2.0.0/units.ttl + + + + + xs:string + + + + + + lastModifiedOn + + + en + Last Modified on + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.single_level_usage_as_planned:1.1.0#lastModifiedOn + + + + xs:dateTime + + + + parentCatenaXId + + + en + Catena-X Parent ID + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.single_level_usage_as_planned:1.1.0#parentCatenaXId + + + + xs:string + + + + ValidityPeriodEntity + + + en + Validity Period Entity + + + + + en + If a validity period only has a start that means that the period is valid from the start date without a (yet) defined enddate and vice versa. + + + + + validFrom + + + en + Valid from + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.single_level_usage_as_planned:1.1.0#validFrom + + + + xs:dateTime + + + + validTo + + + en + Valid to + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.single_level_usage_as_planned:1.1.0#validTo + + + + xs:dateTime + + + + + + + + + + + + + + APPLICATION_CLASS + SingleLevelUsageAsPlanned + + + en + Single Level Usage as Planned + + + + + en + The aspect provides the information in which parent part(s)/product(s) the given item is assembled in. This could be a 1:1 relationship in terms of a e.g. a brake component or 1:n for e.g. coatings. The given item as well as the parent item must refer to an object from as-planned lifecycle phase. +If multiple versions of parent parts exist that the child part can be assembled into, all versions of the parent part are included in the usage list. + + + urn:samm:io.catenax.single_level_usage_as_planned:1.1.0#SingleLevelUsageAsPlanned + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Single Level Usage as Planned + + + + + en + SingleLevelUsageAsPlanned + + + + + en + The aspect provides the information in which parent part(s)/product(s) the given item is assembled in. This could be a 1:1 relationship in terms of a e.g. a brake component or 1:n for e.g. coatings. The given item as well as the parent item must refer to an object from as-planned lifecycle phase. +If multiple versions of parent parts exist that the child part can be assembled into, all versions of the parent part are included in the usage list. + + + + + + + + + catenaXId + + + en + Catena-X Identifier + + + urn:samm:io.catenax.single_level_usage_as_planned:1.1.0#catenaXId + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Catena-X Identifier + + + + + en + catenaXId + + + STRING + + + en + The Catena-X ID of the given part (e.g. the assembly), valid for the Catena-X dataspace. + + + + + + + + + createdOn + + + en + Created on + + + urn:samm:io.catenax.single_level_usage_as_planned:1.1.0#createdOn + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Created on + + + + + en + createdOn + + + STRING + + + en + Timestamp when the relation between the parent part and the child part was created. + + + + + + + + + quantityNumber + + + en + Quantity Number + + + urn:samm:io.catenax.single_level_usage_as_planned:1.1.0#quantityNumber + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Quantity Number + + + + + en + quantityNumber + + + REAL_MEASURE + + + en + The number of objects related to the measurement unit + + + + + + + + + measurementUnit + + + en + Measurement Unit + + + urn:samm:io.catenax.single_level_usage_as_planned:1.1.0#measurementUnit + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Measurement Unit + + + + + en + measurementUnit + + + STRING + + + en + Unit of measurement for the quantity of objects. +If possible, use units from the aspect meta model unit catalog, which is based on the UNECE Recommendation No. 20 "Codes for Units of Measure used in International Trade" + + + + + + + + + quantity + + + en + Quantity + + + urn:samm:io.catenax.single_level_usage_as_planned:1.1.0#quantity + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Quantity + + + + + en + quantity + + + STRING + + + en + Quantity of which the child part is assembled into the parent part. + + + + + + + + + lastModifiedOn + + + en + Last Modified on + + + urn:samm:io.catenax.single_level_usage_as_planned:1.1.0#lastModifiedOn + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Last Modified on + + + + + en + lastModifiedOn + + + STRING + + + en + Timestamp when the assembly relationship between parent part and child part was last modified. + + + + + + + + + parentCatenaXId + + + en + Catena-X Parent ID + + + urn:samm:io.catenax.single_level_usage_as_planned:1.1.0#parentCatenaXId + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Catena-X Parent ID + + + + + en + parentCatenaXId + + + STRING + + + en + The Catena-X ID of the parent object, into which the given child object is assembled in. + + + + + + + + + validFrom + + + en + Valid from + + + urn:samm:io.catenax.single_level_usage_as_planned:1.1.0#validFrom + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Valid from + + + + + en + validFrom + + + STRING + + + en + Start date of validity period + + + + + + + + + validTo + + + en + Valid to + + + urn:samm:io.catenax.single_level_usage_as_planned:1.1.0#validTo + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Valid to + + + + + en + validTo + + + STRING + + + en + End date of validity period + + + + + + + + + validityPeriod + + + en + Validity Period + + + urn:samm:io.catenax.single_level_usage_as_planned:1.1.0#validityPeriod + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Validity Period + + + + + en + validityPeriod + + + STRING + + + en + The period of time during which the parent-child relation is valid. This relates to whether a child part can be built into the parent part at a given time. +If no validity period is given the relation is considered valid at any point in time. + + + + + + + + + parentParts + + + en + Parent Parts + + + urn:samm:io.catenax.single_level_usage_as_planned:1.1.0#parentParts + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Parent Parts + + + + + en + parentParts + + + STRING + + + en + Set of parent parts, in which the given child object is assembled in (one structural level up). + + + + + + + + + diff --git a/io.catenax.single_level_usage_as_planned/1.1.0/gen/SingleLevelUsageAsPlanned-schema.json b/io.catenax.single_level_usage_as_planned/1.1.0/gen/SingleLevelUsageAsPlanned-schema.json new file mode 100644 index 000000000..a9c06d557 --- /dev/null +++ b/io.catenax.single_level_usage_as_planned/1.1.0/gen/SingleLevelUsageAsPlanned-schema.json @@ -0,0 +1,103 @@ +{ + "$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. This could be a 1:1 relationship in terms of a e.g. a brake component or 1:n for e.g. coatings. The given item as well as the parent item must refer to an object from as-planned lifecycle phase.\nIf multiple versions of parent parts exist that the child part can be assembled into, all versions of the parent part are included in the usage list.", + "type" : "object", + "components" : { + "schemas" : { + "urn_samm_io.catenax.single_level_usage_as_planned_1.1.0_CatenaXIdTraitCharacteristic" : { + "type" : "string", + "description" : "The provided regular expression ensures that the UUID is composed of five groups of characters separated by hyphens, in the form 8-4-4-4-12 for a total of 36 characters (32 hexadecimal characters and 4 hyphens), optionally prefixed by \"urn:uuid:\" to make it an IRI.", + "pattern" : "(^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$)|(^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$)" + }, + "urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Timestamp" : { + "type" : "string", + "pattern" : "-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T(([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](\\.[0-9]+)?|(24:00:00(\\.0+)?))(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?", + "description" : "Describes a Property which contains the date and time with an optional timezone." + }, + "urn_samm_io.catenax.single_level_usage_as_planned_1.1.0_NumberOfObjects" : { + "type" : "number", + "description" : "Quantifiable number of objects in reference to the measurementUnit" + }, + "urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_UnitReference" : { + "type" : "string", + "pattern" : "[a-zA-Z]*:[a-zA-Z]+", + "description" : "Describes a Property containing a reference to one of the units in the Unit Catalog." + }, + "urn_samm_io.catenax.single_level_usage_as_planned_1.1.0_QuantityCharacteristic" : { + "description" : "Describes the quantity in which the child part is assembled in the parent object by providing a quantity value and the measurement unit in which the quantity is measured.", + "type" : "object", + "properties" : { + "quantityNumber" : { + "description" : "The number of objects related to the measurement unit", + "$ref" : "#/components/schemas/urn_samm_io.catenax.single_level_usage_as_planned_1.1.0_NumberOfObjects" + }, + "measurementUnit" : { + "description" : "Unit of measurement for the quantity of objects.\nIf possible, use units from the aspect meta model unit catalog, which is based on the UNECE Recommendation No. 20 \"Codes for Units of Measure used in International Trade\"", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_UnitReference" + } + }, + "required" : [ "quantityNumber", "measurementUnit" ] + }, + "urn_samm_io.catenax.single_level_usage_as_planned_1.1.0_ValidityPeriodCharacteristic" : { + "description" : "Characteristic for a validity period defined by an (optional) start and an (optional) end timestamp.", + "type" : "object", + "properties" : { + "validFrom" : { + "description" : "Start date of validity period", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Timestamp" + }, + "validTo" : { + "description" : "End date of validity period", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Timestamp" + } + } + }, + "urn_samm_io.catenax.single_level_usage_as_planned_1.1.0_ParentData" : { + "description" : "Catena-X ID and meta data of the parent part.", + "type" : "object", + "properties" : { + "createdOn" : { + "description" : "Timestamp when the relation between the parent part and the child part was created.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Timestamp" + }, + "quantity" : { + "description" : "Quantity of which the child part is assembled into the parent part.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.single_level_usage_as_planned_1.1.0_QuantityCharacteristic" + }, + "lastModifiedOn" : { + "description" : "Timestamp when the assembly relationship between parent part and child part was last modified.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Timestamp" + }, + "parentCatenaXId" : { + "description" : "The Catena-X ID of the parent object, into which the given child object is assembled in.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.single_level_usage_as_planned_1.1.0_CatenaXIdTraitCharacteristic" + }, + "validityPeriod" : { + "description" : "The period of time during which the parent-child relation is valid. This relates to whether a child part can be built into the parent part at a given time.\nIf no validity period is given the relation is considered valid at any point in time.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.single_level_usage_as_planned_1.1.0_ValidityPeriodCharacteristic" + } + }, + "required" : [ "createdOn", "quantity", "parentCatenaXId" ] + }, + "urn_samm_io.catenax.single_level_usage_as_planned_1.1.0_SetOfParentPartsCharacteristic" : { + "description" : "Set of parent parts the given child object is assembled in (one structural level up).", + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/urn_samm_io.catenax.single_level_usage_as_planned_1.1.0_ParentData" + }, + "uniqueItems" : true + } + } + }, + "properties" : { + "catenaXId" : { + "description" : "The Catena-X ID of the given part (e.g. the assembly), valid for the Catena-X dataspace.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.single_level_usage_as_planned_1.1.0_CatenaXIdTraitCharacteristic" + }, + "parentParts" : { + "description" : "Set of parent parts, in which the given child object is assembled in (one structural level up).", + "$ref" : "#/components/schemas/urn_samm_io.catenax.single_level_usage_as_planned_1.1.0_SetOfParentPartsCharacteristic" + } + }, + "required" : [ "catenaXId", "parentParts" ] +} \ No newline at end of file diff --git a/io.catenax.single_level_usage_as_planned/1.1.0/gen/SingleLevelUsageAsPlanned.aasx b/io.catenax.single_level_usage_as_planned/1.1.0/gen/SingleLevelUsageAsPlanned.aasx new file mode 100644 index 0000000000000000000000000000000000000000..8c1991a5c18aa3d95eb341813c43d4edf134f562 GIT binary patch literal 4877 zcmaKwbyQT{7QhFFl#*^3x=R@x1Zn9QLO_u2ZUmIZ0fC`Qa-<}rq(MT5kP?PQTIrIO z=7Dd$_4&RR`>uP|y=$Gl?>fJG&L6)GRRLm<0dR0|0LLCO`hY)z^yb-6*2US=%GuLI z$Jf=$!-(I<$q}wOV2>2U4{9%O42Ur#ng!x0sHu`p>l-M|2Pmf_b*T=` z<60Tl6F0Yo30LIa_~R4Iq>@wJ;jfeMBzUQhUbdelGNrK^ca~V}1JRQsTO)iK={s*8nQFHUqqSiR38Y>*&H@UB zeZq4crnGGGsDE)%F#oB|8~rRs%hNNy5x!fY4@$nP_M@ELH_Jr8p-w! zV_FouCdu3Fc~WmcB*d-C@=+U6+vVOvjqh0&ALi_AOK32}e)Kd+Bl}J@cck*8V_f%R zz%!6fdzFDJxE^owQ83m>mNt;Df9XvSQyd~w@wcrX5 z#utCRc#n{=#+;w$<4H%ZAUdtSySj^Vm65G%xp^)$foq3$Wq7Ar*|yD%{YYzqqxRaS zJ)W!ltJL%HmTXTRjt?AD0bthia=WENKW97USuvw6=Z3)~f+X$Ut~joxl2JAv_OnEp z`cshaTd%U0IuRF;I~Osm93K!}()3rffxnsH_$7YpyIC>&|K)s3>^J9|vnycn&*OZ1 zj<<~rU8W%v0Y581O+-$?lj;xKO^Iu$G3=~O9n*Wd)KT?8DQjtlN}~}v{MP}#C?i%r z(W9~z721f^xbX1R{q=}^$;&-DtOa5=vc$E6=ETK4u^{Hy6Nul*#g6mY>cafbE69rj zTp7Q}T!qXyPB~&=CQt6Wi}lrdye@OUhcwcX9jG9F=v{mv>b*LYOWu!q>h=4bkxAMT zj~)@^1kffdnH}z(oLC-SZjN;rBJL8p%27v)cQkTJ6zngO?}12%`KWO-b2MOsqk%7u zu>f3x`D9fd($QQhmK>y?AodV+PCYA(VQ2DA}tl4MmT?NHo|_M3jx{j0_dM z&8ilDtw3~D4L zTRoJoU5zZmV;Z-o8&D#Vfty<$1iCKey!I_-=(VY}OZQ8-9P*?fVO+M>64w}_W1A5b zE(IN)JlUOD5uPGh)BT0*_jW9N`N!Fa{c55ryMI0AHVeMi;enoooCC5{bK^dhT_IFF zU+unQvDPDJ+tv@dSVXnjL(C+?V&xJeerH<9neuK8N*pN~me^njQ*2r+0aYMOC2=J% z^d06g1qk*UXX--oI6HvK4NLNrNaxUm zmQicBBUSA}fVFQaMa@i^I!+fzg(iq@c`PY(?kj^a54vx8cR_UD_+yZV0O&FD!4J_@ z0;-tPJl+8%J09h?fJYw4MGF~r>|=_wL49GgSR%GUV@*631pt*l@kqNK8x?#1T3eihVP^>#0#xU(!;Y$MI+%Xd(+;q+RbSuzz1JmR2|qk*JoV5 zE_Vj?gR5-c82inp+T~I)CZy6Qh}XkguiYt$8nYSfk4} z&nvX)<;tEwNZ)>|&_RaBwY|0BZp&9sS{Op<1eR2xab{gz*2kl__GY99TpC?A@J5-t zENsJUdd|z(y%Sl8V$p%N5kED5;Qw9TDl0N<(;bVi71a+7cQd|^#5ErX^VbQh$!d&sU5DHXu(5(JmD^{7&}Gg!0k?dil<{GPW&vA5W;n6tN64bTiM zf01*-&TBAfZCz+%0t%g)FZfkobf`XTTmd6}76)4Jb0~8{(kIp8Dn-vhzeV-12#Z+k zM_zer*Jt&MDF;t)zBhEpOZ=9ZpV`o(DNOo6w9kRVxUg4%j_({KhmW39Djli|=SOJ6 zQO!=}&@Y8*tQ4MFESyl~kdv*8HkMKX3P)YB_v^lmeB)ol1XMm1q{zP}iexPxYhGHn zO<~(kXf%*kGa5EtDC{Z$imIV&pKl=EbzLj(YS#;d4p<}CrJAKPe(J*OfB4M_yNqnb*uP0;EQ2C-ecG^&1JRiXL6_Y~!>89ZR&;Kf~-tl3rKw0a-v^}97J161hAr)(^=5^J1kRW zl{KcTYJ@*oo{K7&f9}xVyi)a8Q;cUbwhfY63vUIdju}jspE|CNwy-=IbrEcr2n=qM z#$~@+X3*0)cmn{FyRL7Pc8+$Nv&>qQBlNi<4LA6DN*hd2J%tG z=6Z%dU2Vr&$1FsdZww}TIX25F`5iIp?uF^ z_D{Q7{SNcCW&2EKAC<5bWmy$xixx|A4VL)uC6;9y*ws_y^;x$@60!P@?XV7G6`ZRtHsmlbF_K`|M4$HrI*>wHJ!VvIwNOk@TVZ!2)8hfv8PP6rUk z>2_{yk5%6p-)xwQ^O`D~9&rEkeFw!9?gJ_D?u`bggWZVuN-I<=+?*}VGz`lcQaRiW z9$2mEdirC0>p)w*W>#2!?k7jvWdJWBhapKO)6Y#0e{1mNL=cc^e3H?bd0=^*TP#IA z1JpLsx|6|OTN$7|51u1G7W?&;!0S~x$c@mRcLVz6=~BOXZ~9Wwre2cJLr-lj4yF4q zEz$#0ELI_(v%Gr)xfCag8B!wx8|57DeRsx6erMN`Mf16;{65f*ho7gZV9Fc!>2?|N z@axd>tK4bS5WEe~Q~b_Z(}N(rpvsgcx;1x1pL|m+qO{w0OA8(jtfdh$9T|!=OvCp| zT;D!9s~CpCZ9JZnL_ZM=bbxjJq>L<(~qmO7Dq4N9kHtgsv z#wMzNAP-|xvu`^%v@nGZ;=0f--;}z57!g_xMPhhOJWoSBU~gy2#fJ&`7$7*s)JyJg zn8GGWdl|+fv8LXPDxWUmYQ>ek3I#fZ0_oL}&UB=nkbx$!DPkg37MqZMQt=lt{UJm< z!1k^*B}UyVQfGm|ik&v&Y>gdffnOwiwm*yFg3w;Wy+|l@DvA_SGhMxX7QjA;KD1Lf zFoYj_rXGfaPva5SE{#sRE+G>lL8(SZ!#)H<(-U7S?Go!N&=K7#0bn-vFtI0ne;O1c zr94)vTO)3e>_i@4&(rJlabu2WCrl7Tq%b8xtojLG%j?TC*I6SI<7Xj;OYw103#H#X z!PFtK-3!~8#4pstbe_BO@~f{<%K#eJ&FFd%Jd>t?Lfk`?A-2J|QO6`fjd?TNdD9CI zTZ2yg^vR-9sso6KAmySuM4gTSrSr)rL7?J(#mholN4kMK6s2>sTl)byALkci^58bt z>dz^h2(Z?`EA2r*pvbU42C!v^P)t|{fd?d{y$FL7o-%ZwX~w^tkoD-6wWtr(C)do2 z>-%ns{AMbfnlUaCL)$c)SqEM)9eN{6NGN)XR`jqLxjTdi6}b!9+D#->x5Sb5pM_{0 zg-NvKu0WCBprM!PP4FL>=U@**BrYGHXxPHt5V$8Ju}nP=0}%nW@UwZdkU7f0r22Mu z$WVjXINNb8yEoE5$xwOo?3}eeV^oEpF= zHQCbm0s~37e7N6D<}FZLf4F?_W8bdGaLd51x4`?--F6ax7MzBcZOTfL*Wff!Q;1x< zM(1wwoz{|{L^`-_4dhJM(rH`cN?s@N=ugiTGWpP;9zs8OJJCj*MKPck0nuj$pryEX ztjxn_C>jY}d7YL#>A4rwnp+39Yc_h|*Muxz6)GE&?`@8~O*`6wHV{*K?qG%WNW9Wz z{YHF|i%J3t5PrNR^^y0Wt?7yoyRl|w{!_}F3H@CM<2(L3#)w&`X*3@V<~<&7rHv}# zV6-?P+Wb9iY!bg93~gGQfrqgSZZf&h$X|iCt~;pEhDnVN08nTDKiwj}Q432K3#hw` ztH+I6xLe(Ng;SiS$}2&-&bHpk=C8$a_(vq2@Z1K7;5-ew9jeFnOs(7y2ESZcgWwpsFq2i&6sp z`C!@LJUY_CjLW$5{XO3u=QwWcv}jD@&$lz?#V()!ho85g6M{Z%vI z899eADMbVJYxJPgo-n1>WLa~;)nb`bD@zWmedN0du?0ayXEwPoef!A3;_ zq)j-RH9^PCv^97mukM|0)0xa-o>m7O;oc&(iFbjL-I&^!-?oN^PIlw6|7yGZ*;=@5 zyZn3nmnIBU<=+eZsob|6h`&PQ=5v4aBmSQFr&r$^`Cnmz{-1vS_v}9n^wz!qit2x5 z|92Drd!aw~+pVzv72Ux9uCITu@F(8eefd`~->mCDb}3W^6YF*g*3A`igUIW5&OZQ6 CS#3@L literal 0 HcmV?d00001 diff --git a/io.catenax.single_level_usage_as_planned/1.1.0/gen/SingleLevelUsageAsPlanned.html b/io.catenax.single_level_usage_as_planned/1.1.0/gen/SingleLevelUsageAsPlanned.html new file mode 100644 index 000000000..d410f08e5 --- /dev/null +++ b/io.catenax.single_level_usage_as_planned/1.1.0/gen/SingleLevelUsageAsPlanned.html @@ -0,0 +1,1081 @@ + + + + + + + + + + + + + + Documentation Single Level Usage as Planned + + +
+
+
+
+

Aspect Model Single Level Usage as Planned

+
urn:samm:io.catenax.single_level_usage_as_planned:1.1.0#SingleLevelUsageAsPlanned
+
+
+
+
+
+
+
+ +
+ + +
+ The aspect provides the information in which parent part(s)/product(s) the given item is assembled in. This could be a 1:1 relationship in terms of a e.g. a brake component or 1:n for e.g. coatings. The given item as well as the parent item must refer to an object from as-planned lifecycle phase. +If multiple versions of parent parts exist that the child part can be assembled into, all versions of the parent part are included in the usage list. +
+ + +
+

Overview

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

Properties

+
+ +
+ +
+

Catena-X Identifier

+
+ +The Catena-X ID of the given part (e.g. the assembly), valid for the Catena-X dataspace. + +
+
Name
+
catenaXId
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
    +
  • https://datatracker.ietf.org/doc/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
+
+
    +
  • +
    + +
    + Catena-X ID 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}$)
    +
    + +
    • +
+
+
+
+
+ +
+

Parent Parts

+
+ +Set of parent parts, in which the given child object is assembled in (one structural level up). + +
+
Name
+
parentParts
+
+ + + +
+
Characteristic
+
+
+
+
Set
+
+
+
Has no order
+
+
+
Duplicates not allowed
+
+
+
+ Type urn:samm:io.catenax.single_level_usage_as_planned:1.1.0#ParentData + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
parentParts
+
+ + +
+
+ + + +
+
+

Entities

+
+ +
+
+

Parent Data

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

Properties

+
+
+ +
+
Created on
+
+ +Timestamp when the relation between the parent part and the child part was created. + +
+
Name
+
createdOn
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#dateTime + +
+
+
+
+
+ +
+
Example
+
2022-02-03T14:48:54.709Z
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
createdOn
+
+ + +
+
+ +
+
Quantity
+
+ +Quantity of which the child part is assembled into the parent part. + +
+
Name
+
quantity
+
+ + + +
+
Characteristic
+
+
+
+
Quantifiable
+
+
+
Duration
+
+
+
Describes the quantity in which the child part is assembled in the parent object by providing a quantity value and the measurement unit in which the quantity is measured.
+
+
+
+ Type urn:samm:io.catenax.single_level_usage_as_planned:1.1.0#Quantity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
quantity
+
+ + +
+
+ +
+
Last Modified on
+
+ +Timestamp when the assembly relationship between parent part and child part was last modified. + +
+
Name
+
lastModifiedOn
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#dateTime + +
+
+
+
+
+ +
+
Example
+
2022-02-03T14:48:54.709Z
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
lastModifiedOn
+
+ + +
+
+ +
+
Catena-X Parent ID
+
+ +The Catena-X ID of the parent object, into which the given child object is assembled in. + +
+
Name
+
parentCatenaXId
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
    +
  • https://datatracker.ietf.org/doc/html/rfc4122
    • +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
urn:uuid:43364d8c-cf38-423c-b907-6e68e0f0fe2f
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
parentCatenaXId
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + Catena-X ID 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}$)
    +
    + +
    • +
+
+
+
+
+ +
+
Validity Period
+
+ +The period of time during which the parent-child relation is valid. This relates to whether a child part can be built into the parent part at a given time. +If no validity period is given the relation is considered valid at any point in time. + +
+
Name
+
validityPeriod
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.single_level_usage_as_planned:1.1.0#ValidityPeriodEntity + +
+
+
+
+
+ + +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
validityPeriod
+
+ + +
+
+
+
+

Quantity

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

Properties

+
+
+ +
+
Quantity Number
+
+ +The number of objects related to the measurement unit + +
+
Name
+
quantityNumber
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#double + +
+
+
+
+
+ +
+
Example
+
2.5
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
quantityNumber
+
+ + +
+
+ +
+
Measurement Unit
+
+ +Unit of measurement for the quantity of objects. +If possible, use units from the aspect meta model unit catalog, which is based on the UNECE Recommendation No. 20 "Codes for Units of Measure used in International Trade" + +
+
Name
+
measurementUnit
+
+ + + +
+
Characteristic
+
+
+
+
+ Type urn:samm:org.eclipse.esmf.samm:meta-model:2.1.0#curie + +
+
+
+
+
+ +
+
Example
+
unit:litre
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
measurementUnit
+
+ +
+
Reference
+
+
    +
  • https://github.com/eclipse-esmf/esmf-semantic-aspect-meta-model/blob/main/esmf-semantic-aspect-meta-model/src/main/resources/samm/unit/2.0.0/units.ttl
    • +
+
+
+ +
+
+
+
+

Validity Period Entity

+
+
+ If a validity period only has a start that means that the period is valid from the start date without a (yet) defined enddate and vice versa. +
+ +
+

Properties

+
+
+ +
+
Valid from
+
+ +Start date of validity period + +
+
Name
+
validFrom
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#dateTime + +
+
+
+
+
+ +
+
Example
+
2023-03-21T08:47:14.438+01:00
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
validFrom
+
+ + +
+
+ +
+
Valid to
+
+ +End date of validity period + +
+
Name
+
validTo
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#dateTime + +
+
+
+
+
+ +
+
Example
+
2024-08-02T09:00:00.000+01:00
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
validTo
+
+ + +
+
+
+ +
+ Third party licenses + +
+ +
+ + +
+ + + \ No newline at end of file diff --git a/io.catenax.single_level_usage_as_planned/1.1.0/gen/SingleLevelUsageAsPlanned.json b/io.catenax.single_level_usage_as_planned/1.1.0/gen/SingleLevelUsageAsPlanned.json new file mode 100644 index 000000000..332c9fdda --- /dev/null +++ b/io.catenax.single_level_usage_as_planned/1.1.0/gen/SingleLevelUsageAsPlanned.json @@ -0,0 +1,16 @@ +{ + "parentParts" : [ { + "validityPeriod" : { + "validFrom" : "2023-03-21T08:47:14.438+01:00", + "validTo" : "2024-08-02T09:00:00.000+01:00" + }, + "parentCatenaXId" : "urn:uuid:43364d8c-cf38-423c-b907-6e68e0f0fe2f", + "quantity" : { + "quantityNumber" : 2.5, + "measurementUnit" : "unit:litre" + }, + "createdOn" : "2022-02-03T14:48:54.709Z", + "lastModifiedOn" : "2022-02-03T14:48:54.709Z" + } ], + "catenaXId" : "urn:uuid:055c1128-0375-47c8-98de-7cf802c3241d" +} \ No newline at end of file diff --git a/io.catenax.single_level_usage_as_planned/1.1.0/gen/SingleLevelUsageAsPlanned.yml b/io.catenax.single_level_usage_as_planned/1.1.0/gen/SingleLevelUsageAsPlanned.yml new file mode 100644 index 000000000..2d2596698 --- /dev/null +++ b/io.catenax.single_level_usage_as_planned/1.1.0/gen/SingleLevelUsageAsPlanned.yml @@ -0,0 +1,225 @@ +--- +openapi: 3.0.3 +info: + title: Single Level Usage as Planned + version: v1 +servers: +- url: catenax.io/api/v1 + variables: + api-version: + default: v1 +paths: + /{tenant-id}/single-level-usage-as-planned: + get: + tags: + - SingleLevelUsageAsPlanned + operationId: getSingleLevelUsageAsPlanned + parameters: + - name: tenant-id + in: path + description: The ID of the tenant owning the requested Twin. + required: true + schema: + type: string + format: uuid + - name: start + in: query + description: Starting index which is starting by 0 + required: false + schema: + type: number + - name: count + in: query + description: Number of items to return per call. + required: false + schema: + type: number + - name: totalItemCount + in: query + description: Flag that indicates that the total counts should be returned. + required: false + schema: + type: boolean + responses: + "200": + $ref: '#/components/responses/SingleLevelUsageAsPlanned' + "401": + $ref: '#/components/responses/ClientError' + "402": + $ref: '#/components/responses/Unauthorized' + "403": + $ref: '#/components/responses/Forbidden' + "404": + $ref: '#/components/responses/NotFoundError' +components: + schemas: + ErrorResponse: + type: object + required: + - error + properties: + error: + $ref: '#/components/schemas/Error' + Error: + type: object + required: + - details + properties: + message: + type: string + minLength: 1 + path: + type: string + minLength: 1 + details: + type: object + minLength: 1 + additionalProperties: + type: object + code: + type: string + nullable: true + PagingSchema: + type: object + properties: + items: + type: array + items: + $ref: '#/components/schemas/SingleLevelUsageAsPlanned' + totalItems: + type: number + totalPages: + type: number + pageSize: + type: number + currentPage: + type: number + urn_samm_io.catenax.single_level_usage_as_planned_1.1.0_CatenaXIdTraitCharacteristic: + type: string + description: "The provided regular expression ensures that the UUID is composed\ + \ of five groups of characters separated by hyphens, in the form 8-4-4-4-12\ + \ for a total of 36 characters (32 hexadecimal characters and 4 hyphens),\ + \ optionally prefixed by \"urn:uuid:\" to make it an IRI." + pattern: "(^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$)|(^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$)" + urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Timestamp: + type: string + pattern: "-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T(([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](\\\ + .[0-9]+)?|(24:00:00(\\.0+)?))(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?" + description: Describes a Property which contains the date and time with an optional + timezone. + urn_samm_io.catenax.single_level_usage_as_planned_1.1.0_NumberOfObjects: + type: number + description: Quantifiable number of objects in reference to the measurementUnit + urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_UnitReference: + type: string + pattern: "[a-zA-Z]*:[a-zA-Z]+" + description: Describes a Property containing a reference to one of the units + in the Unit Catalog. + urn_samm_io.catenax.single_level_usage_as_planned_1.1.0_QuantityCharacteristic: + description: Describes the quantity in which the child part is assembled in + the parent object by providing a quantity value and the measurement unit in + which the quantity is measured. + type: object + properties: + quantityNumber: + description: The number of objects related to the measurement unit + $ref: '#/components/schemas/urn_samm_io.catenax.single_level_usage_as_planned_1.1.0_NumberOfObjects' + measurementUnit: + description: |- + Unit of measurement for the quantity of objects. + If possible, use units from the aspect meta model unit catalog, which is based on the UNECE Recommendation No. 20 "Codes for Units of Measure used in International Trade" + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_UnitReference' + required: + - quantityNumber + - measurementUnit + urn_samm_io.catenax.single_level_usage_as_planned_1.1.0_ValidityPeriodCharacteristic: + description: Characteristic for a validity period defined by an (optional) + start and an (optional) end timestamp. + type: object + properties: + validFrom: + description: Start date of validity period + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Timestamp' + validTo: + description: End date of validity period + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Timestamp' + urn_samm_io.catenax.single_level_usage_as_planned_1.1.0_ParentData: + description: Catena-X ID and meta data of the parent part. + type: object + properties: + createdOn: + description: Timestamp when the relation between the parent part and the + child part was created. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Timestamp' + quantity: + description: Quantity of which the child part is assembled into the parent + part. + $ref: '#/components/schemas/urn_samm_io.catenax.single_level_usage_as_planned_1.1.0_QuantityCharacteristic' + lastModifiedOn: + description: Timestamp when the assembly relationship between parent part + and child part was last modified. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Timestamp' + parentCatenaXId: + description: "The Catena-X ID of the parent object, into which the given\ + \ child object is assembled in." + $ref: '#/components/schemas/urn_samm_io.catenax.single_level_usage_as_planned_1.1.0_CatenaXIdTraitCharacteristic' + validityPeriod: + description: |- + The period of time during which the parent-child relation is valid. This relates to whether a child part can be built into the parent part at a given time. + If no validity period is given the relation is considered valid at any point in time. + $ref: '#/components/schemas/urn_samm_io.catenax.single_level_usage_as_planned_1.1.0_ValidityPeriodCharacteristic' + required: + - createdOn + - quantity + - parentCatenaXId + urn_samm_io.catenax.single_level_usage_as_planned_1.1.0_SetOfParentPartsCharacteristic: + description: Set of parent parts the given child object is assembled in (one + structural level up). + type: array + items: + $ref: '#/components/schemas/urn_samm_io.catenax.single_level_usage_as_planned_1.1.0_ParentData' + uniqueItems: true + SingleLevelUsageAsPlanned: + description: |- + The aspect provides the information in which parent part(s)/product(s) the given item is assembled in. This could be a 1:1 relationship in terms of a e.g. a brake component or 1:n for e.g. coatings. The given item as well as the parent item must refer to an object from as-planned lifecycle phase. + If multiple versions of parent parts exist that the child part can be assembled into, all versions of the parent part are included in the usage list. + type: object + properties: + catenaXId: + description: "The Catena-X ID of the given part (e.g. the assembly), valid\ + \ for the Catena-X dataspace." + $ref: '#/components/schemas/urn_samm_io.catenax.single_level_usage_as_planned_1.1.0_CatenaXIdTraitCharacteristic' + parentParts: + description: "Set of parent parts, in which the given child object is assembled\ + \ in (one structural level up)." + $ref: '#/components/schemas/urn_samm_io.catenax.single_level_usage_as_planned_1.1.0_SetOfParentPartsCharacteristic' + required: + - catenaXId + - parentParts + responses: + Unauthorized: + description: The requesting user or client is not authenticated. + Forbidden: + description: The requesting user or client is not authorized to access resources + for the given tenant. + NotFoundError: + description: The requested Twin has not been found. + ClientError: + description: Payload or user input is invalid. See error details in the payload + for more. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + SingleLevelUsageAsPlanned: + content: + application/json: + schema: + $ref: '#/components/schemas/PagingSchema' + description: The request was successful. + requestBodies: + SingleLevelUsageAsPlanned: + content: + application/json: + schema: + $ref: '#/components/schemas/SingleLevelUsageAsPlanned'