-
Notifications
You must be signed in to change notification settings - Fork 47
/
SingleLevelUsageAsBuilt-schema.json
116 lines (116 loc) · 8.2 KB
/
SingleLevelUsageAsBuilt-schema.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
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" ]
}