@twin.org/standards-gs1 0.0.3-next.55 → 0.0.3-next.56
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/docs/changelog.md +7 -0
- package/docs/reference/classes/Gs1Location.md +14 -14
- package/docs/reference/interfaces/IEpcisAggregationEvent.md +15 -15
- package/docs/reference/interfaces/IEpcisAssociationEvent.md +14 -14
- package/docs/reference/interfaces/IEpcisAttribute.md +1 -1
- package/docs/reference/interfaces/IEpcisBizTransaction.md +1 -1
- package/docs/reference/interfaces/IEpcisDocument.md +5 -5
- package/docs/reference/interfaces/IEpcisErrorDeclaration.md +2 -2
- package/docs/reference/interfaces/IEpcisEvent.md +4 -4
- package/docs/reference/interfaces/IEpcisHeader.md +2 -2
- package/docs/reference/interfaces/IEpcisObjectEvent.md +16 -16
- package/docs/reference/interfaces/IEpcisPersistentDisposition.md +2 -2
- package/docs/reference/interfaces/IEpcisQuantity.md +2 -2
- package/docs/reference/interfaces/IEpcisQuery.md +1 -1
- package/docs/reference/interfaces/IEpcisQueryDocument.md +3 -3
- package/docs/reference/interfaces/IEpcisQueryResults.md +1 -1
- package/docs/reference/interfaces/IEpcisQueryResultsBody.md +1 -1
- package/docs/reference/interfaces/IEpcisSensorElement.md +1 -1
- package/docs/reference/interfaces/IEpcisSensorMetadata.md +8 -8
- package/docs/reference/interfaces/IEpcisSensorReport.md +23 -23
- package/docs/reference/interfaces/IEpcisTransactionEvent.md +14 -14
- package/docs/reference/interfaces/IEpcisTransformationEvent.md +19 -19
- package/docs/reference/interfaces/IEpcisVocabulary.md +1 -1
- package/docs/reference/interfaces/IEpcisVocabularyElement.md +2 -2
- package/package.json +1 -1
package/docs/changelog.md
CHANGED
|
@@ -1,5 +1,12 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## [0.0.3-next.56](https://github.com/twinfoundation/standards/compare/standards-gs1-v0.0.3-next.55...standards-gs1-v0.0.3-next.56) (2026-03-20)
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
### Miscellaneous Chores
|
|
7
|
+
|
|
8
|
+
* **standards-gs1:** Synchronize repo versions
|
|
9
|
+
|
|
3
10
|
## [0.0.3-next.55](https://github.com/twinfoundation/standards/compare/standards-gs1-v0.0.3-next.54...standards-gs1-v0.0.3-next.55) (2026-03-19)
|
|
4
11
|
|
|
5
12
|
|
|
@@ -26,7 +26,7 @@ The GS1 sgln identifier.
|
|
|
26
26
|
|
|
27
27
|
### site? {#site}
|
|
28
28
|
|
|
29
|
-
> `optional` **site
|
|
29
|
+
> `optional` **site?**: `string`
|
|
30
30
|
|
|
31
31
|
Identifies the site in which the location is contained.
|
|
32
32
|
|
|
@@ -34,7 +34,7 @@ Identifies the site in which the location is contained.
|
|
|
34
34
|
|
|
35
35
|
### sst? {#sst}
|
|
36
36
|
|
|
37
|
-
> `optional` **sst
|
|
37
|
+
> `optional` **sst?**: [`Gs1SubSiteTypes`](../type-aliases/Gs1SubSiteTypes.md)
|
|
38
38
|
|
|
39
39
|
Sub site type describes the primary business function of the sub site location.
|
|
40
40
|
|
|
@@ -42,7 +42,7 @@ Sub site type describes the primary business function of the sub site location.
|
|
|
42
42
|
|
|
43
43
|
### ssa? {#ssa}
|
|
44
44
|
|
|
45
|
-
> `optional` **ssa
|
|
45
|
+
> `optional` **ssa?**: [`Gs1SubSiteAttributes`](../type-aliases/Gs1SubSiteAttributes.md)
|
|
46
46
|
|
|
47
47
|
Sub site attribute further qualifies the business function of the sub site location.
|
|
48
48
|
|
|
@@ -50,7 +50,7 @@ Sub site attribute further qualifies the business function of the sub site locat
|
|
|
50
50
|
|
|
51
51
|
### ssd? {#ssd}
|
|
52
52
|
|
|
53
|
-
> `optional` **ssd
|
|
53
|
+
> `optional` **ssd?**: `string`
|
|
54
54
|
|
|
55
55
|
Sub site detail provides additional proprietary information.
|
|
56
56
|
|
|
@@ -58,7 +58,7 @@ Sub site detail provides additional proprietary information.
|
|
|
58
58
|
|
|
59
59
|
### name? {#name}
|
|
60
60
|
|
|
61
|
-
> `optional` **name
|
|
61
|
+
> `optional` **name?**: `string`
|
|
62
62
|
|
|
63
63
|
The name of the location.
|
|
64
64
|
|
|
@@ -66,7 +66,7 @@ The name of the location.
|
|
|
66
66
|
|
|
67
67
|
### streetAddressOne? {#streetaddressone}
|
|
68
68
|
|
|
69
|
-
> `optional` **streetAddressOne
|
|
69
|
+
> `optional` **streetAddressOne?**: `string`
|
|
70
70
|
|
|
71
71
|
The street address line 1.
|
|
72
72
|
|
|
@@ -74,7 +74,7 @@ The street address line 1.
|
|
|
74
74
|
|
|
75
75
|
### streetAddressTwo? {#streetaddresstwo}
|
|
76
76
|
|
|
77
|
-
> `optional` **streetAddressTwo
|
|
77
|
+
> `optional` **streetAddressTwo?**: `string`
|
|
78
78
|
|
|
79
79
|
The street address line 2.
|
|
80
80
|
|
|
@@ -82,7 +82,7 @@ The street address line 2.
|
|
|
82
82
|
|
|
83
83
|
### streetAddressThree? {#streetaddressthree}
|
|
84
84
|
|
|
85
|
-
> `optional` **streetAddressThree
|
|
85
|
+
> `optional` **streetAddressThree?**: `string`
|
|
86
86
|
|
|
87
87
|
The street address line 3.
|
|
88
88
|
|
|
@@ -90,7 +90,7 @@ The street address line 3.
|
|
|
90
90
|
|
|
91
91
|
### city? {#city}
|
|
92
92
|
|
|
93
|
-
> `optional` **city
|
|
93
|
+
> `optional` **city?**: `string`
|
|
94
94
|
|
|
95
95
|
City.
|
|
96
96
|
|
|
@@ -98,7 +98,7 @@ City.
|
|
|
98
98
|
|
|
99
99
|
### state? {#state}
|
|
100
100
|
|
|
101
|
-
> `optional` **state
|
|
101
|
+
> `optional` **state?**: `string`
|
|
102
102
|
|
|
103
103
|
State.
|
|
104
104
|
|
|
@@ -106,7 +106,7 @@ State.
|
|
|
106
106
|
|
|
107
107
|
### postalCode? {#postalcode}
|
|
108
108
|
|
|
109
|
-
> `optional` **postalCode
|
|
109
|
+
> `optional` **postalCode?**: `string`
|
|
110
110
|
|
|
111
111
|
Postal Code.
|
|
112
112
|
|
|
@@ -114,7 +114,7 @@ Postal Code.
|
|
|
114
114
|
|
|
115
115
|
### countryCode? {#countrycode}
|
|
116
116
|
|
|
117
|
-
> `optional` **countryCode
|
|
117
|
+
> `optional` **countryCode?**: `string`
|
|
118
118
|
|
|
119
119
|
Country Code The ISO 3166-1 alpha-2 code specifying the country for the address.
|
|
120
120
|
|
|
@@ -122,7 +122,7 @@ Country Code The ISO 3166-1 alpha-2 code specifying the country for the address.
|
|
|
122
122
|
|
|
123
123
|
### latitude? {#latitude}
|
|
124
124
|
|
|
125
|
-
> `optional` **latitude
|
|
125
|
+
> `optional` **latitude?**: `number`
|
|
126
126
|
|
|
127
127
|
The latitude of the location in degrees.
|
|
128
128
|
|
|
@@ -130,6 +130,6 @@ The latitude of the location in degrees.
|
|
|
130
130
|
|
|
131
131
|
### longitude? {#longitude}
|
|
132
132
|
|
|
133
|
-
> `optional` **longitude
|
|
133
|
+
> `optional` **longitude?**: `number`
|
|
134
134
|
|
|
135
135
|
The longitude of the location in degrees.
|
|
@@ -27,7 +27,7 @@ The type.
|
|
|
27
27
|
|
|
28
28
|
### parentID? {#parentid}
|
|
29
29
|
|
|
30
|
-
> `optional` **parentID
|
|
30
|
+
> `optional` **parentID?**: `string`
|
|
31
31
|
|
|
32
32
|
(Optional when action is OBSERVE, required otherwise) Identifier of the parent
|
|
33
33
|
of the aggregation or association; use the pure identity URI when the parent is
|
|
@@ -37,7 +37,7 @@ an EPC.
|
|
|
37
37
|
|
|
38
38
|
### childEPCs? {#childepcs}
|
|
39
39
|
|
|
40
|
-
> `optional` **childEPCs
|
|
40
|
+
> `optional` **childEPCs?**: `string`[]
|
|
41
41
|
|
|
42
42
|
(Optional) Unordered list of contained objects identified at the instance
|
|
43
43
|
level; AggregationEvents normally include childEPCs or childQuantityList unless
|
|
@@ -47,7 +47,7 @@ action is DELETE.
|
|
|
47
47
|
|
|
48
48
|
### childQuantityList? {#childquantitylist}
|
|
49
49
|
|
|
50
|
-
> `optional` **childQuantityList
|
|
50
|
+
> `optional` **childQuantityList?**: [`IEpcisQuantity`](IEpcisQuantity.md)[]
|
|
51
51
|
|
|
52
52
|
Unordered list of one or more QuantityElements identifying contained objects
|
|
53
53
|
at the class level; may be empty only with action DELETE when disaggregating
|
|
@@ -65,7 +65,7 @@ How this event relates to the lifecycle of the EPCs named in this event.
|
|
|
65
65
|
|
|
66
66
|
### bizStep? {#bizstep}
|
|
67
67
|
|
|
68
|
-
> `optional` **bizStep
|
|
68
|
+
> `optional` **bizStep?**: `string`
|
|
69
69
|
|
|
70
70
|
(Optional) The business step of which this event was a part.
|
|
71
71
|
|
|
@@ -73,7 +73,7 @@ How this event relates to the lifecycle of the EPCs named in this event.
|
|
|
73
73
|
|
|
74
74
|
### disposition? {#disposition}
|
|
75
75
|
|
|
76
|
-
> `optional` **disposition
|
|
76
|
+
> `optional` **disposition?**: `string`
|
|
77
77
|
|
|
78
78
|
(Optional) The business condition of the objects associated with the EPCs,
|
|
79
79
|
presumed to hold true until contradicted by a subsequent event.
|
|
@@ -82,7 +82,7 @@ presumed to hold true until contradicted by a subsequent event.
|
|
|
82
82
|
|
|
83
83
|
### readPoint? {#readpoint}
|
|
84
84
|
|
|
85
|
-
> `optional` **readPoint
|
|
85
|
+
> `optional` **readPoint?**: [`IEpcisLocation`](IEpcisLocation.md)
|
|
86
86
|
|
|
87
87
|
(Optional) The read point at which the event took place.
|
|
88
88
|
|
|
@@ -90,7 +90,7 @@ presumed to hold true until contradicted by a subsequent event.
|
|
|
90
90
|
|
|
91
91
|
### bizLocation? {#bizlocation}
|
|
92
92
|
|
|
93
|
-
> `optional` **bizLocation
|
|
93
|
+
> `optional` **bizLocation?**: [`IEpcisLocation`](IEpcisLocation.md)
|
|
94
94
|
|
|
95
95
|
(Optional) The business location where the objects associated with the EPCs
|
|
96
96
|
may be found, until contradicted by a subsequent event.
|
|
@@ -99,7 +99,7 @@ may be found, until contradicted by a subsequent event.
|
|
|
99
99
|
|
|
100
100
|
### bizTransactionList? {#biztransactionlist}
|
|
101
101
|
|
|
102
|
-
> `optional` **bizTransactionList
|
|
102
|
+
> `optional` **bizTransactionList?**: [`IEpcisBizTransaction`](IEpcisBizTransaction.md)[]
|
|
103
103
|
|
|
104
104
|
(Optional) An unordered list of business transactions that define the context
|
|
105
105
|
of this event.
|
|
@@ -108,7 +108,7 @@ of this event.
|
|
|
108
108
|
|
|
109
109
|
### sourceList? {#sourcelist}
|
|
110
110
|
|
|
111
|
-
> `optional` **sourceList
|
|
111
|
+
> `optional` **sourceList?**: [`IEpcisSource`](IEpcisSource.md)[]
|
|
112
112
|
|
|
113
113
|
(Optional) Unordered list of Source elements that provide context about the
|
|
114
114
|
originating endpoint of a business transfer of which this event is a part.
|
|
@@ -117,7 +117,7 @@ originating endpoint of a business transfer of which this event is a part.
|
|
|
117
117
|
|
|
118
118
|
### destinationList? {#destinationlist}
|
|
119
119
|
|
|
120
|
-
> `optional` **destinationList
|
|
120
|
+
> `optional` **destinationList?**: [`IEpcisDestination`](IEpcisDestination.md)[]
|
|
121
121
|
|
|
122
122
|
(Optional) Unordered list of Destination elements that provide context about the
|
|
123
123
|
terminating endpoint of a business transfer of which this event is a part.
|
|
@@ -126,7 +126,7 @@ terminating endpoint of a business transfer of which this event is a part.
|
|
|
126
126
|
|
|
127
127
|
### sensorElementList? {#sensorelementlist}
|
|
128
128
|
|
|
129
|
-
> `optional` **sensorElementList
|
|
129
|
+
> `optional` **sensorElementList?**: [`IEpcisSensorElement`](IEpcisSensorElement.md)[]
|
|
130
130
|
|
|
131
131
|
(Optional) Connects event to one or more SensorElements.
|
|
132
132
|
|
|
@@ -146,7 +146,7 @@ JSON-LD @context.
|
|
|
146
146
|
|
|
147
147
|
### eventID? {#eventid}
|
|
148
148
|
|
|
149
|
-
> `optional` **eventID
|
|
149
|
+
> `optional` **eventID?**: `string`
|
|
150
150
|
|
|
151
151
|
URI identifier of a specific EPCIS event (alias of id in JSON or XML).
|
|
152
152
|
|
|
@@ -158,7 +158,7 @@ URI identifier of a specific EPCIS event (alias of id in JSON or XML).
|
|
|
158
158
|
|
|
159
159
|
### certificationInfo? {#certificationinfo}
|
|
160
160
|
|
|
161
|
-
> `optional` **certificationInfo
|
|
161
|
+
> `optional` **certificationInfo?**: `ObjectOrArray`\<`string`\>
|
|
162
162
|
|
|
163
163
|
(Optional) CertificationDetails relevant for Objects, Places and/or
|
|
164
164
|
Organizations mentioned in this Event.
|
|
@@ -171,7 +171,7 @@ Organizations mentioned in this Event.
|
|
|
171
171
|
|
|
172
172
|
### errorDeclaration? {#errordeclaration}
|
|
173
173
|
|
|
174
|
-
> `optional` **errorDeclaration
|
|
174
|
+
> `optional` **errorDeclaration?**: [`IEpcisErrorDeclaration`](IEpcisErrorDeclaration.md)
|
|
175
175
|
|
|
176
176
|
Error declaration.
|
|
177
177
|
|
|
@@ -209,7 +209,7 @@ expressed as an offset from UTC.
|
|
|
209
209
|
|
|
210
210
|
### recordTime? {#recordtime}
|
|
211
211
|
|
|
212
|
-
> `optional` **recordTime
|
|
212
|
+
> `optional` **recordTime?**: `string`
|
|
213
213
|
|
|
214
214
|
(Optional) The date and time at which this event was recorded by an EPCIS
|
|
215
215
|
Repository; ignored at capture and present on query results.
|
|
@@ -36,7 +36,7 @@ identity URI when the parent is an EPC.
|
|
|
36
36
|
|
|
37
37
|
### childEPCs? {#childepcs}
|
|
38
38
|
|
|
39
|
-
> `optional` **childEPCs
|
|
39
|
+
> `optional` **childEPCs?**: `string`[]
|
|
40
40
|
|
|
41
41
|
(Optional) Unordered list of contained objects identified at the instance
|
|
42
42
|
level; AssociationEvents normally include childEPCs or childQuantityList
|
|
@@ -46,7 +46,7 @@ unless action is DELETE.
|
|
|
46
46
|
|
|
47
47
|
### childQuantityList? {#childquantitylist}
|
|
48
48
|
|
|
49
|
-
> `optional` **childQuantityList
|
|
49
|
+
> `optional` **childQuantityList?**: [`IEpcisQuantity`](IEpcisQuantity.md)[]
|
|
50
50
|
|
|
51
51
|
Unordered list of one or more QuantityElements identifying contained objects
|
|
52
52
|
at the class level; may be empty only with action DELETE when disassociating
|
|
@@ -64,7 +64,7 @@ How this event relates to the lifecycle of the EPCs named in this event.
|
|
|
64
64
|
|
|
65
65
|
### bizStep? {#bizstep}
|
|
66
66
|
|
|
67
|
-
> `optional` **bizStep
|
|
67
|
+
> `optional` **bizStep?**: `string`
|
|
68
68
|
|
|
69
69
|
(Optional) The business step of which this event was a part.
|
|
70
70
|
|
|
@@ -72,7 +72,7 @@ How this event relates to the lifecycle of the EPCs named in this event.
|
|
|
72
72
|
|
|
73
73
|
### disposition? {#disposition}
|
|
74
74
|
|
|
75
|
-
> `optional` **disposition
|
|
75
|
+
> `optional` **disposition?**: `string`
|
|
76
76
|
|
|
77
77
|
(Optional) The business condition of the objects associated with the EPCs,
|
|
78
78
|
presumed to hold true until contradicted by a subsequent event.
|
|
@@ -81,7 +81,7 @@ presumed to hold true until contradicted by a subsequent event.
|
|
|
81
81
|
|
|
82
82
|
### readPoint? {#readpoint}
|
|
83
83
|
|
|
84
|
-
> `optional` **readPoint
|
|
84
|
+
> `optional` **readPoint?**: [`IEpcisLocation`](IEpcisLocation.md)
|
|
85
85
|
|
|
86
86
|
(Optional) The read point at which the event took place.
|
|
87
87
|
|
|
@@ -89,7 +89,7 @@ presumed to hold true until contradicted by a subsequent event.
|
|
|
89
89
|
|
|
90
90
|
### bizLocation? {#bizlocation}
|
|
91
91
|
|
|
92
|
-
> `optional` **bizLocation
|
|
92
|
+
> `optional` **bizLocation?**: [`IEpcisLocation`](IEpcisLocation.md)
|
|
93
93
|
|
|
94
94
|
(Optional) The business location where the objects associated with the EPCs
|
|
95
95
|
may be found, until contradicted by a subsequent event.
|
|
@@ -98,7 +98,7 @@ may be found, until contradicted by a subsequent event.
|
|
|
98
98
|
|
|
99
99
|
### bizTransactionList? {#biztransactionlist}
|
|
100
100
|
|
|
101
|
-
> `optional` **bizTransactionList
|
|
101
|
+
> `optional` **bizTransactionList?**: [`IEpcisBizTransaction`](IEpcisBizTransaction.md)[]
|
|
102
102
|
|
|
103
103
|
(Optional) An unordered list of business transactions that define the context
|
|
104
104
|
of this event.
|
|
@@ -107,7 +107,7 @@ of this event.
|
|
|
107
107
|
|
|
108
108
|
### sourceList? {#sourcelist}
|
|
109
109
|
|
|
110
|
-
> `optional` **sourceList
|
|
110
|
+
> `optional` **sourceList?**: [`IEpcisSource`](IEpcisSource.md)[]
|
|
111
111
|
|
|
112
112
|
(Optional) Unordered list of Source elements that provide context about the
|
|
113
113
|
originating endpoint of a business transfer of which this event is a part.
|
|
@@ -116,7 +116,7 @@ originating endpoint of a business transfer of which this event is a part.
|
|
|
116
116
|
|
|
117
117
|
### destinationList? {#destinationlist}
|
|
118
118
|
|
|
119
|
-
> `optional` **destinationList
|
|
119
|
+
> `optional` **destinationList?**: [`IEpcisDestination`](IEpcisDestination.md)[]
|
|
120
120
|
|
|
121
121
|
(Optional) Unordered list of Destination elements that provide context about
|
|
122
122
|
the terminating endpoint of a business transfer of which this event is a part.
|
|
@@ -125,7 +125,7 @@ the terminating endpoint of a business transfer of which this event is a part.
|
|
|
125
125
|
|
|
126
126
|
### sensorElementList? {#sensorelementlist}
|
|
127
127
|
|
|
128
|
-
> `optional` **sensorElementList
|
|
128
|
+
> `optional` **sensorElementList?**: [`IEpcisSensorElement`](IEpcisSensorElement.md)[]
|
|
129
129
|
|
|
130
130
|
(Optional) Connects event to one or more SensorElements.
|
|
131
131
|
|
|
@@ -145,7 +145,7 @@ JSON-LD @context.
|
|
|
145
145
|
|
|
146
146
|
### eventID? {#eventid}
|
|
147
147
|
|
|
148
|
-
> `optional` **eventID
|
|
148
|
+
> `optional` **eventID?**: `string`
|
|
149
149
|
|
|
150
150
|
URI identifier of a specific EPCIS event (alias of id in JSON or XML).
|
|
151
151
|
|
|
@@ -157,7 +157,7 @@ URI identifier of a specific EPCIS event (alias of id in JSON or XML).
|
|
|
157
157
|
|
|
158
158
|
### certificationInfo? {#certificationinfo}
|
|
159
159
|
|
|
160
|
-
> `optional` **certificationInfo
|
|
160
|
+
> `optional` **certificationInfo?**: `ObjectOrArray`\<`string`\>
|
|
161
161
|
|
|
162
162
|
(Optional) CertificationDetails relevant for Objects, Places and/or
|
|
163
163
|
Organizations mentioned in this Event.
|
|
@@ -170,7 +170,7 @@ Organizations mentioned in this Event.
|
|
|
170
170
|
|
|
171
171
|
### errorDeclaration? {#errordeclaration}
|
|
172
172
|
|
|
173
|
-
> `optional` **errorDeclaration
|
|
173
|
+
> `optional` **errorDeclaration?**: [`IEpcisErrorDeclaration`](IEpcisErrorDeclaration.md)
|
|
174
174
|
|
|
175
175
|
Error declaration.
|
|
176
176
|
|
|
@@ -208,7 +208,7 @@ expressed as an offset from UTC.
|
|
|
208
208
|
|
|
209
209
|
### recordTime? {#recordtime}
|
|
210
210
|
|
|
211
|
-
> `optional` **recordTime
|
|
211
|
+
> `optional` **recordTime?**: `string`
|
|
212
212
|
|
|
213
213
|
(Optional) The date and time at which this event was recorded by an EPCIS
|
|
214
214
|
Repository; ignored at capture and present on query results.
|
|
@@ -18,7 +18,7 @@ The @context.
|
|
|
18
18
|
|
|
19
19
|
### id? {#id}
|
|
20
20
|
|
|
21
|
-
> `optional` **id
|
|
21
|
+
> `optional` **id?**: `string`
|
|
22
22
|
|
|
23
23
|
The JSON-LD document id.
|
|
24
24
|
|
|
@@ -50,7 +50,7 @@ Creation Date.
|
|
|
50
50
|
|
|
51
51
|
### instanceIdentifier? {#instanceidentifier}
|
|
52
52
|
|
|
53
|
-
> `optional` **instanceIdentifier
|
|
53
|
+
> `optional` **instanceIdentifier?**: `string`
|
|
54
54
|
|
|
55
55
|
(Optional) The instance identifier of an EPCISDocument.
|
|
56
56
|
|
|
@@ -58,7 +58,7 @@ Creation Date.
|
|
|
58
58
|
|
|
59
59
|
### sender? {#sender}
|
|
60
60
|
|
|
61
|
-
> `optional` **sender
|
|
61
|
+
> `optional` **sender?**: `string`
|
|
62
62
|
|
|
63
63
|
(Optional) The sender of an EPCISDocument.
|
|
64
64
|
|
|
@@ -66,7 +66,7 @@ Creation Date.
|
|
|
66
66
|
|
|
67
67
|
### receiver? {#receiver}
|
|
68
68
|
|
|
69
|
-
> `optional` **receiver
|
|
69
|
+
> `optional` **receiver?**: `string`
|
|
70
70
|
|
|
71
71
|
(Optional) The intended receiver of an EPCISDocument.
|
|
72
72
|
|
|
@@ -74,7 +74,7 @@ Creation Date.
|
|
|
74
74
|
|
|
75
75
|
### epcisHeader? {#epcisheader}
|
|
76
76
|
|
|
77
|
-
> `optional` **epcisHeader
|
|
77
|
+
> `optional` **epcisHeader?**: [`IEpcisHeader`](IEpcisHeader.md)
|
|
78
78
|
|
|
79
79
|
EPCIS Header.
|
|
80
80
|
|
|
@@ -19,7 +19,7 @@ The date and time at which the declaration of error is made.
|
|
|
19
19
|
|
|
20
20
|
### reason? {#reason}
|
|
21
21
|
|
|
22
|
-
> `optional` **reason
|
|
22
|
+
> `optional` **reason?**: `string`
|
|
23
23
|
|
|
24
24
|
Reason for the error.
|
|
25
25
|
|
|
@@ -29,7 +29,7 @@ Use [EpcisErrorReasonTypes](../variables/EpcisErrorReasonTypes.md) for known val
|
|
|
29
29
|
|
|
30
30
|
### correctiveEventIDs? {#correctiveeventids}
|
|
31
31
|
|
|
32
|
-
> `optional` **correctiveEventIDs
|
|
32
|
+
> `optional` **correctiveEventIDs?**: `string`[]
|
|
33
33
|
|
|
34
34
|
(Optional) If present, indicates that the events having the specified URIs as
|
|
35
35
|
the value of their eventID fields are to be considered as "corrections" to
|
|
@@ -34,7 +34,7 @@ Type of Event.
|
|
|
34
34
|
|
|
35
35
|
### eventID? {#eventid}
|
|
36
36
|
|
|
37
|
-
> `optional` **eventID
|
|
37
|
+
> `optional` **eventID?**: `string`
|
|
38
38
|
|
|
39
39
|
URI identifier of a specific EPCIS event (alias of id in JSON or XML).
|
|
40
40
|
|
|
@@ -42,7 +42,7 @@ URI identifier of a specific EPCIS event (alias of id in JSON or XML).
|
|
|
42
42
|
|
|
43
43
|
### certificationInfo? {#certificationinfo}
|
|
44
44
|
|
|
45
|
-
> `optional` **certificationInfo
|
|
45
|
+
> `optional` **certificationInfo?**: `ObjectOrArray`\<`string`\>
|
|
46
46
|
|
|
47
47
|
(Optional) CertificationDetails relevant for Objects, Places and/or
|
|
48
48
|
Organizations mentioned in this Event.
|
|
@@ -51,7 +51,7 @@ Organizations mentioned in this Event.
|
|
|
51
51
|
|
|
52
52
|
### errorDeclaration? {#errordeclaration}
|
|
53
53
|
|
|
54
|
-
> `optional` **errorDeclaration
|
|
54
|
+
> `optional` **errorDeclaration?**: [`IEpcisErrorDeclaration`](IEpcisErrorDeclaration.md)
|
|
55
55
|
|
|
56
56
|
Error declaration.
|
|
57
57
|
|
|
@@ -77,7 +77,7 @@ expressed as an offset from UTC.
|
|
|
77
77
|
|
|
78
78
|
### recordTime? {#recordtime}
|
|
79
79
|
|
|
80
|
-
> `optional` **recordTime
|
|
80
|
+
> `optional` **recordTime?**: `string`
|
|
81
81
|
|
|
82
82
|
(Optional) The date and time at which this event was recorded by an EPCIS
|
|
83
83
|
Repository; ignored at capture and present on query results.
|
|
@@ -10,7 +10,7 @@ https://ref.gs1.org/epcis/EPCISHeader
|
|
|
10
10
|
|
|
11
11
|
### epcisMasterData? {#epcismasterdata}
|
|
12
12
|
|
|
13
|
-
> `optional` **epcisMasterData
|
|
13
|
+
> `optional` **epcisMasterData?**: `IJsonLdNodeObject` & `object`
|
|
14
14
|
|
|
15
15
|
EPCIS master data.
|
|
16
16
|
|
|
@@ -18,6 +18,6 @@ EPCIS master data.
|
|
|
18
18
|
|
|
19
19
|
##### vocabularyList?
|
|
20
20
|
|
|
21
|
-
> `optional` **vocabularyList
|
|
21
|
+
> `optional` **vocabularyList?**: [`IEpcisVocabulary`](IEpcisVocabulary.md)[]
|
|
22
22
|
|
|
23
23
|
Vocabulary list.
|
|
@@ -27,7 +27,7 @@ JSON-LD @context.
|
|
|
27
27
|
|
|
28
28
|
### eventID? {#eventid}
|
|
29
29
|
|
|
30
|
-
> `optional` **eventID
|
|
30
|
+
> `optional` **eventID?**: `string`
|
|
31
31
|
|
|
32
32
|
URI identifier of a specific EPCIS event (alias of id in JSON or XML).
|
|
33
33
|
|
|
@@ -39,7 +39,7 @@ URI identifier of a specific EPCIS event (alias of id in JSON or XML).
|
|
|
39
39
|
|
|
40
40
|
### certificationInfo? {#certificationinfo}
|
|
41
41
|
|
|
42
|
-
> `optional` **certificationInfo
|
|
42
|
+
> `optional` **certificationInfo?**: `ObjectOrArray`\<`string`\>
|
|
43
43
|
|
|
44
44
|
(Optional) CertificationDetails relevant for Objects, Places and/or
|
|
45
45
|
Organizations mentioned in this Event.
|
|
@@ -52,7 +52,7 @@ Organizations mentioned in this Event.
|
|
|
52
52
|
|
|
53
53
|
### errorDeclaration? {#errordeclaration}
|
|
54
54
|
|
|
55
|
-
> `optional` **errorDeclaration
|
|
55
|
+
> `optional` **errorDeclaration?**: [`IEpcisErrorDeclaration`](IEpcisErrorDeclaration.md)
|
|
56
56
|
|
|
57
57
|
Error declaration.
|
|
58
58
|
|
|
@@ -90,7 +90,7 @@ expressed as an offset from UTC.
|
|
|
90
90
|
|
|
91
91
|
### recordTime? {#recordtime}
|
|
92
92
|
|
|
93
|
-
> `optional` **recordTime
|
|
93
|
+
> `optional` **recordTime?**: `string`
|
|
94
94
|
|
|
95
95
|
(Optional) The date and time at which this event was recorded by an EPCIS
|
|
96
96
|
Repository; ignored at capture and present on query results.
|
|
@@ -115,7 +115,7 @@ Fixed to ObjectEvent.
|
|
|
115
115
|
|
|
116
116
|
### epcList? {#epclist}
|
|
117
117
|
|
|
118
|
-
> `optional` **epcList
|
|
118
|
+
> `optional` **epcList?**: `string`[]
|
|
119
119
|
|
|
120
120
|
(Optional) Unordered list of one or more EPCs naming specific objects to which
|
|
121
121
|
the event pertained.
|
|
@@ -124,7 +124,7 @@ the event pertained.
|
|
|
124
124
|
|
|
125
125
|
### quantityList? {#quantitylist}
|
|
126
126
|
|
|
127
|
-
> `optional` **quantityList
|
|
127
|
+
> `optional` **quantityList?**: [`IEpcisQuantity`](IEpcisQuantity.md)[]
|
|
128
128
|
|
|
129
129
|
Unordered list of one or more QuantityElements identifying contained objects at
|
|
130
130
|
the class level.
|
|
@@ -141,7 +141,7 @@ How this event relates to the lifecycle of the EPCs named in this event.
|
|
|
141
141
|
|
|
142
142
|
### bizStep? {#bizstep}
|
|
143
143
|
|
|
144
|
-
> `optional` **bizStep
|
|
144
|
+
> `optional` **bizStep?**: `string`
|
|
145
145
|
|
|
146
146
|
(Optional) The business step of which this event was a part.
|
|
147
147
|
|
|
@@ -149,7 +149,7 @@ How this event relates to the lifecycle of the EPCs named in this event.
|
|
|
149
149
|
|
|
150
150
|
### disposition? {#disposition}
|
|
151
151
|
|
|
152
|
-
> `optional` **disposition
|
|
152
|
+
> `optional` **disposition?**: `string`
|
|
153
153
|
|
|
154
154
|
(Optional) The business condition of the objects associated with the EPCs,
|
|
155
155
|
presumed to hold true until contradicted by a subsequent event.
|
|
@@ -158,7 +158,7 @@ presumed to hold true until contradicted by a subsequent event.
|
|
|
158
158
|
|
|
159
159
|
### persistentDisposition? {#persistentdisposition}
|
|
160
160
|
|
|
161
|
-
> `optional` **persistentDisposition
|
|
161
|
+
> `optional` **persistentDisposition?**: [`IEpcisPersistentDisposition`](IEpcisPersistentDisposition.md)
|
|
162
162
|
|
|
163
163
|
Persistent disposition.
|
|
164
164
|
|
|
@@ -166,7 +166,7 @@ Persistent disposition.
|
|
|
166
166
|
|
|
167
167
|
### readPoint? {#readpoint}
|
|
168
168
|
|
|
169
|
-
> `optional` **readPoint
|
|
169
|
+
> `optional` **readPoint?**: [`IEpcisLocation`](IEpcisLocation.md)
|
|
170
170
|
|
|
171
171
|
(Optional) The read point at which the event took place.
|
|
172
172
|
|
|
@@ -174,7 +174,7 @@ Persistent disposition.
|
|
|
174
174
|
|
|
175
175
|
### bizLocation? {#bizlocation}
|
|
176
176
|
|
|
177
|
-
> `optional` **bizLocation
|
|
177
|
+
> `optional` **bizLocation?**: [`IEpcisLocation`](IEpcisLocation.md)
|
|
178
178
|
|
|
179
179
|
(Optional) The business location where the objects associated with the EPCs may
|
|
180
180
|
be found, until contradicted by a subsequent event.
|
|
@@ -183,7 +183,7 @@ be found, until contradicted by a subsequent event.
|
|
|
183
183
|
|
|
184
184
|
### bizTransactionList? {#biztransactionlist}
|
|
185
185
|
|
|
186
|
-
> `optional` **bizTransactionList
|
|
186
|
+
> `optional` **bizTransactionList?**: [`IEpcisBizTransaction`](IEpcisBizTransaction.md)[]
|
|
187
187
|
|
|
188
188
|
(Optional) Unordered list of business transactions that define the context of
|
|
189
189
|
this event.
|
|
@@ -192,7 +192,7 @@ this event.
|
|
|
192
192
|
|
|
193
193
|
### sourceList? {#sourcelist}
|
|
194
194
|
|
|
195
|
-
> `optional` **sourceList
|
|
195
|
+
> `optional` **sourceList?**: [`IEpcisSource`](IEpcisSource.md)[]
|
|
196
196
|
|
|
197
197
|
(Optional) Unordered list of Source elements that provide context about the
|
|
198
198
|
originating endpoint of a business transfer of which this event is a part.
|
|
@@ -201,7 +201,7 @@ originating endpoint of a business transfer of which this event is a part.
|
|
|
201
201
|
|
|
202
202
|
### destinationList? {#destinationlist}
|
|
203
203
|
|
|
204
|
-
> `optional` **destinationList
|
|
204
|
+
> `optional` **destinationList?**: [`IEpcisDestination`](IEpcisDestination.md)[]
|
|
205
205
|
|
|
206
206
|
(Optional) Unordered list of Destination elements that provide context about the
|
|
207
207
|
terminating endpoint of a business transfer of which this event is a part.
|
|
@@ -210,7 +210,7 @@ terminating endpoint of a business transfer of which this event is a part.
|
|
|
210
210
|
|
|
211
211
|
### sensorElementList? {#sensorelementlist}
|
|
212
212
|
|
|
213
|
-
> `optional` **sensorElementList
|
|
213
|
+
> `optional` **sensorElementList?**: [`IEpcisSensorElement`](IEpcisSensorElement.md)[]
|
|
214
214
|
|
|
215
215
|
(Optional) Connects event to one or more SensorElements.
|
|
216
216
|
|
|
@@ -218,7 +218,7 @@ terminating endpoint of a business transfer of which this event is a part.
|
|
|
218
218
|
|
|
219
219
|
### ilmd? {#ilmd}
|
|
220
220
|
|
|
221
|
-
> `optional` **ilmd
|
|
221
|
+
> `optional` **ilmd?**: [`IEpcisIlmd`](IEpcisIlmd.md)
|
|
222
222
|
|
|
223
223
|
(Optional) Instance/Lot master data that describes the objects created during
|
|
224
224
|
this event.
|
|
@@ -11,7 +11,7 @@ https://ref.gs1.org/epcis/PersistentDisposition
|
|
|
11
11
|
|
|
12
12
|
### set? {#set}
|
|
13
13
|
|
|
14
|
-
> `optional` **set
|
|
14
|
+
> `optional` **set?**: `string`[]
|
|
15
15
|
|
|
16
16
|
(Optional) List of persistentDisposition URI values to be set.
|
|
17
17
|
|
|
@@ -19,6 +19,6 @@ https://ref.gs1.org/epcis/PersistentDisposition
|
|
|
19
19
|
|
|
20
20
|
### unset? {#unset}
|
|
21
21
|
|
|
22
|
-
> `optional` **unset
|
|
22
|
+
> `optional` **unset?**: `string`[]
|
|
23
23
|
|
|
24
24
|
(Optional) List of persistentDisposition URI values to be unset (revoked).
|