@twin.org/standards-gs1 0.0.3-next.1 → 0.0.3-next.11
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/dist/es/dataTypes/epcisDataTypes.js +61 -0
- package/dist/es/dataTypes/epcisDataTypes.js.map +1 -0
- package/dist/es/dataTypes/gs1DataTypes.js +2 -2
- package/dist/es/dataTypes/gs1DataTypes.js.map +1 -1
- package/dist/es/entities/gs1Location.js.map +1 -1
- package/dist/es/index.js +39 -20
- package/dist/es/index.js.map +1 -1
- package/dist/es/models/epcis20/IEpcisAggregationEvent.js +2 -0
- package/dist/es/models/epcis20/IEpcisAggregationEvent.js.map +1 -0
- package/dist/es/models/epcis20/IEpcisAssociationEvent.js +2 -0
- package/dist/es/models/epcis20/IEpcisAssociationEvent.js.map +1 -0
- package/dist/es/models/epcis20/IEpcisAttribute.js +2 -0
- package/dist/es/models/epcis20/IEpcisAttribute.js.map +1 -0
- package/dist/es/models/epcis20/IEpcisBizTransaction.js +2 -0
- package/dist/es/models/epcis20/IEpcisBizTransaction.js.map +1 -0
- package/dist/es/models/epcis20/IEpcisDestination.js +2 -0
- package/dist/es/models/epcis20/IEpcisDestination.js.map +1 -0
- package/dist/es/models/epcis20/IEpcisDocument.js.map +1 -1
- package/dist/es/models/epcis20/IEpcisErrorDeclaration.js +2 -0
- package/dist/es/models/epcis20/IEpcisErrorDeclaration.js.map +1 -0
- package/dist/es/models/epcis20/IEpcisEvent.js.map +1 -1
- package/dist/es/models/epcis20/IEpcisHeader.js +2 -0
- package/dist/es/models/epcis20/IEpcisHeader.js.map +1 -0
- package/dist/es/models/epcis20/IEpcisIlmd.js +2 -0
- package/dist/es/models/epcis20/IEpcisIlmd.js.map +1 -0
- package/dist/es/models/epcis20/IEpcisLocation.js +2 -0
- package/dist/es/models/epcis20/IEpcisLocation.js.map +1 -0
- package/dist/es/models/epcis20/IEpcisObjectEvent.js +2 -0
- package/dist/es/models/epcis20/IEpcisObjectEvent.js.map +1 -0
- package/dist/es/models/epcis20/IEpcisPersistentDisposition.js +2 -0
- package/dist/es/models/epcis20/IEpcisPersistentDisposition.js.map +1 -0
- package/dist/es/models/epcis20/IEpcisQuantity.js +2 -0
- package/dist/es/models/epcis20/IEpcisQuantity.js.map +1 -0
- package/dist/es/models/epcis20/IEpcisQuery.js.map +1 -1
- package/dist/es/models/epcis20/IEpcisQueryDocument.js.map +1 -1
- package/dist/es/models/epcis20/IEpcisQueryDocumentBody.js +2 -0
- package/dist/es/models/epcis20/IEpcisQueryDocumentBody.js.map +1 -0
- package/dist/es/models/epcis20/IEpcisQueryResults.js +2 -0
- package/dist/es/models/epcis20/IEpcisQueryResults.js.map +1 -0
- package/dist/es/models/epcis20/IEpcisQueryResultsBody.js +2 -0
- package/dist/es/models/epcis20/IEpcisQueryResultsBody.js.map +1 -0
- package/dist/es/models/epcis20/IEpcisSensorElement.js +2 -0
- package/dist/es/models/epcis20/IEpcisSensorElement.js.map +1 -0
- package/dist/es/models/epcis20/IEpcisSensorMetadata.js +2 -0
- package/dist/es/models/epcis20/IEpcisSensorMetadata.js.map +1 -0
- package/dist/es/models/epcis20/IEpcisSensorReport.js +2 -0
- package/dist/es/models/epcis20/IEpcisSensorReport.js.map +1 -0
- package/dist/es/models/epcis20/IEpcisSource.js +2 -0
- package/dist/es/models/epcis20/IEpcisSource.js.map +1 -0
- package/dist/es/models/epcis20/IEpcisTransactionEvent.js +2 -0
- package/dist/es/models/epcis20/IEpcisTransactionEvent.js.map +1 -0
- package/dist/es/models/epcis20/IEpcisTransformationEvent.js +2 -0
- package/dist/es/models/epcis20/IEpcisTransformationEvent.js.map +1 -0
- package/dist/es/models/epcis20/IEpcisVocabulary.js +2 -0
- package/dist/es/models/epcis20/IEpcisVocabulary.js.map +1 -0
- package/dist/es/models/epcis20/IEpcisVocabularyElement.js +2 -0
- package/dist/es/models/epcis20/IEpcisVocabularyElement.js.map +1 -0
- package/dist/es/models/epcis20/epcisActionTypes.js +24 -0
- package/dist/es/models/epcis20/epcisActionTypes.js.map +1 -0
- package/dist/es/models/epcis20/epcisBizStepTypes.js +190 -0
- package/dist/es/models/epcis20/epcisBizStepTypes.js.map +1 -0
- package/dist/es/models/epcis20/epcisBizTransactionTypes.js +75 -0
- package/dist/es/models/epcis20/epcisBizTransactionTypes.js.map +1 -0
- package/dist/es/models/epcis20/epcisComponentTypes.js +77 -0
- package/dist/es/models/epcis20/epcisComponentTypes.js.map +1 -0
- package/dist/es/models/epcis20/epcisContextType.js +2 -0
- package/dist/es/models/epcis20/epcisContextType.js.map +1 -0
- package/dist/es/models/epcis20/epcisContexts.js +17 -0
- package/dist/es/models/epcis20/epcisContexts.js.map +1 -0
- package/dist/es/models/epcis20/epcisDispositionTypes.js +155 -0
- package/dist/es/models/epcis20/epcisDispositionTypes.js.map +1 -0
- package/dist/es/models/epcis20/epcisErrorReasonTypes.js +20 -0
- package/dist/es/models/epcis20/epcisErrorReasonTypes.js.map +1 -0
- package/dist/es/models/epcis20/epcisEventTypes.js +29 -0
- package/dist/es/models/epcis20/epcisEventTypes.js.map +1 -0
- package/dist/es/models/epcis20/epcisEvents.js +2 -0
- package/dist/es/models/epcis20/epcisEvents.js.map +1 -0
- package/dist/es/models/epcis20/epcisMeasurementTypes.js +301 -0
- package/dist/es/models/epcis20/epcisMeasurementTypes.js.map +1 -0
- package/dist/es/models/epcis20/epcisSensorAlertTypes.js +19 -0
- package/dist/es/models/epcis20/epcisSensorAlertTypes.js.map +1 -0
- package/dist/es/models/epcis20/epcisSourceDestTypes.js +26 -0
- package/dist/es/models/epcis20/epcisSourceDestTypes.js.map +1 -0
- package/dist/es/models/epcis20/epcisTypes.js +37 -0
- package/dist/es/models/epcis20/epcisTypes.js.map +1 -0
- package/dist/es/models/gs1/gs1Contexts.js +2 -2
- package/dist/es/models/gs1/gs1Contexts.js.map +1 -1
- package/dist/es/models/gs1/{subSiteAttributes.js → gs1SubSiteAttributes.js} +2 -2
- package/dist/es/models/gs1/gs1SubSiteAttributes.js.map +1 -0
- package/dist/es/models/gs1/{subSiteTypes.js → gs1SubSiteTypes.js} +2 -2
- package/dist/es/models/gs1/gs1SubSiteTypes.js.map +1 -0
- package/dist/es/schemas/EpcisAggregationEvent.json +273 -0
- package/dist/es/schemas/EpcisAssociationEvent.json +274 -0
- package/dist/es/schemas/EpcisDocument.json +204 -0
- package/dist/es/schemas/EpcisObjectEvent.json +277 -0
- package/dist/es/schemas/EpcisQueryDocument.json +173 -0
- package/dist/es/schemas/EpcisTransactionEvent.json +274 -0
- package/dist/es/schemas/EpcisTransformationEvent.json +290 -0
- package/dist/es/utils/gs1Validation.js +4 -4
- package/dist/es/utils/gs1Validation.js.map +1 -1
- package/dist/types/dataTypes/epcisDataTypes.d.ts +13 -0
- package/dist/types/entities/gs1Location.d.ts +4 -4
- package/dist/types/index.d.ts +39 -20
- package/dist/types/models/epcis20/IEpcisAggregationEvent.d.ts +81 -0
- package/dist/types/models/epcis20/IEpcisAssociationEvent.d.ts +80 -0
- package/dist/types/models/epcis20/IEpcisAttribute.d.ts +15 -0
- package/dist/types/models/epcis20/IEpcisBizTransaction.d.ts +20 -0
- package/dist/types/models/epcis20/IEpcisDestination.d.ts +21 -0
- package/dist/types/models/epcis20/IEpcisDocument.d.ts +35 -7
- package/dist/types/models/epcis20/IEpcisErrorDeclaration.d.ts +25 -0
- package/dist/types/models/epcis20/IEpcisEvent.d.ts +23 -22
- package/dist/types/models/epcis20/IEpcisHeader.d.ts +17 -0
- package/dist/types/models/epcis20/IEpcisIlmd.d.ts +8 -0
- package/dist/types/models/epcis20/IEpcisLocation.d.ts +12 -0
- package/dist/types/models/epcis20/IEpcisObjectEvent.d.ts +85 -0
- package/dist/types/models/epcis20/IEpcisPersistentDisposition.d.ts +17 -0
- package/dist/types/models/epcis20/IEpcisQuantity.d.ts +22 -0
- package/dist/types/models/epcis20/IEpcisQuery.d.ts +2 -1
- package/dist/types/models/epcis20/IEpcisQueryDocument.d.ts +10 -30
- package/dist/types/models/epcis20/IEpcisQueryDocumentBody.d.ts +12 -0
- package/dist/types/models/epcis20/IEpcisQueryResults.d.ts +20 -0
- package/dist/types/models/epcis20/IEpcisQueryResultsBody.d.ts +17 -0
- package/dist/types/models/epcis20/IEpcisSensorElement.d.ts +20 -0
- package/dist/types/models/epcis20/IEpcisSensorMetadata.d.ts +48 -0
- package/dist/types/models/epcis20/IEpcisSensorReport.d.ts +131 -0
- package/dist/types/models/epcis20/IEpcisSource.d.ts +20 -0
- package/dist/types/models/epcis20/IEpcisTransactionEvent.d.ts +78 -0
- package/dist/types/models/epcis20/IEpcisTransformationEvent.d.ts +96 -0
- package/dist/types/models/epcis20/IEpcisVocabulary.d.ts +16 -0
- package/dist/types/models/epcis20/IEpcisVocabularyElement.d.ts +21 -0
- package/dist/types/models/epcis20/epcisActionTypes.d.ts +25 -0
- package/dist/types/models/epcis20/epcisBizStepTypes.d.ts +193 -0
- package/dist/types/models/epcis20/epcisBizTransactionTypes.d.ts +74 -0
- package/dist/types/models/epcis20/epcisComponentTypes.d.ts +76 -0
- package/dist/types/models/epcis20/epcisContextType.d.ts +15 -0
- package/dist/types/models/epcis20/epcisContexts.d.ts +17 -0
- package/dist/types/models/epcis20/epcisDispositionTypes.d.ts +158 -0
- package/dist/types/models/epcis20/epcisErrorReasonTypes.d.ts +19 -0
- package/dist/types/models/epcis20/epcisEventTypes.d.ts +29 -0
- package/dist/types/models/epcis20/epcisEvents.d.ts +11 -0
- package/dist/types/models/epcis20/epcisMeasurementTypes.d.ts +303 -0
- package/dist/types/models/epcis20/epcisSensorAlertTypes.d.ts +19 -0
- package/dist/types/models/epcis20/epcisSourceDestTypes.d.ts +26 -0
- package/dist/types/models/epcis20/epcisTypes.d.ts +37 -0
- package/dist/types/models/gs1/gs1Contexts.d.ts +2 -2
- package/dist/types/models/gs1/{subSiteAttributes.d.ts → gs1SubSiteAttributes.d.ts} +2 -2
- package/dist/types/models/gs1/{subSiteTypes.d.ts → gs1SubSiteTypes.d.ts} +2 -2
- package/docs/changelog.md +71 -0
- package/docs/reference/classes/EpcisDataTypes.md +37 -0
- package/docs/reference/classes/Gs1Location.md +2 -2
- package/docs/reference/index.md +52 -27
- package/docs/reference/interfaces/IEpcisAggregationEvent.md +223 -0
- package/docs/reference/interfaces/IEpcisAssociationEvent.md +222 -0
- package/docs/reference/interfaces/IEpcisAttribute.md +31 -0
- package/docs/reference/interfaces/IEpcisBizTransaction.md +35 -0
- package/docs/reference/interfaces/IEpcisDestination.md +36 -0
- package/docs/reference/interfaces/IEpcisDocument.md +67 -3
- package/docs/reference/interfaces/IEpcisErrorDeclaration.md +44 -0
- package/docs/reference/interfaces/IEpcisEvent.md +46 -30
- package/docs/reference/interfaces/IEpcisHeader.md +31 -0
- package/docs/reference/interfaces/IEpcisIlmd.md +16 -0
- package/docs/reference/interfaces/IEpcisLocation.md +24 -0
- package/docs/reference/interfaces/IEpcisObjectEvent.md +228 -0
- package/docs/reference/interfaces/IEpcisPersistentDisposition.md +32 -0
- package/docs/reference/interfaces/IEpcisQuantity.md +42 -0
- package/docs/reference/interfaces/IEpcisQuery.md +5 -1
- package/docs/reference/interfaces/IEpcisQueryDocument.md +20 -34
- package/docs/reference/interfaces/IEpcisQueryDocumentBody.md +23 -0
- package/docs/reference/interfaces/IEpcisQueryResults.md +39 -0
- package/docs/reference/interfaces/IEpcisQueryResultsBody.md +31 -0
- package/docs/reference/interfaces/IEpcisSensorElement.md +34 -0
- package/docs/reference/interfaces/IEpcisSensorMetadata.md +88 -0
- package/docs/reference/interfaces/IEpcisSensorReport.md +232 -0
- package/docs/reference/interfaces/IEpcisSource.md +35 -0
- package/docs/reference/interfaces/IEpcisTransactionEvent.md +220 -0
- package/docs/reference/interfaces/IEpcisTransformationEvent.md +249 -0
- package/docs/reference/interfaces/IEpcisVocabulary.md +31 -0
- package/docs/reference/interfaces/IEpcisVocabularyElement.md +40 -0
- package/docs/reference/type-aliases/EpcisActionTypes.md +6 -0
- package/docs/reference/type-aliases/EpcisBizStepTypes.md +8 -0
- package/docs/reference/type-aliases/EpcisBizTransactionTypes.md +5 -0
- package/docs/reference/type-aliases/EpcisComponentTypes.md +5 -0
- package/docs/reference/type-aliases/EpcisContextType.md +6 -0
- package/docs/reference/type-aliases/EpcisContexts.md +5 -0
- package/docs/reference/type-aliases/EpcisDispositionTypes.md +9 -0
- package/docs/reference/type-aliases/EpcisErrorReasonTypes.md +5 -0
- package/docs/reference/type-aliases/EpcisEventTypes.md +5 -0
- package/docs/reference/type-aliases/EpcisEvents.md +6 -0
- package/docs/reference/type-aliases/EpcisMeasurementTypes.md +8 -0
- package/docs/reference/type-aliases/EpcisSensorAlertTypes.md +6 -0
- package/docs/reference/type-aliases/EpcisSourceDestTypes.md +6 -0
- package/docs/reference/type-aliases/Gs1SubSiteAttributes.md +7 -0
- package/docs/reference/type-aliases/Gs1SubSiteTypes.md +7 -0
- package/docs/reference/variables/EpcisActionTypes.md +28 -0
- package/docs/reference/variables/EpcisBizStepTypes.md +270 -0
- package/docs/reference/variables/EpcisBizTransactionTypes.md +98 -0
- package/docs/reference/variables/EpcisComponentTypes.md +102 -0
- package/docs/reference/variables/EpcisContexts.md +19 -0
- package/docs/reference/variables/{DispositionTypes.md → EpcisDispositionTypes.md} +81 -4
- package/docs/reference/variables/EpcisErrorReasonTypes.md +21 -0
- package/docs/reference/variables/{EventTypes.md → EpcisEventTypes.md} +8 -8
- package/docs/reference/variables/EpcisMeasurementTypes.md +442 -0
- package/docs/reference/variables/EpcisSensorAlertTypes.md +20 -0
- package/docs/reference/variables/EpcisSourceDestTypes.md +29 -0
- package/docs/reference/variables/GS1Contexts.md +3 -3
- package/docs/reference/variables/{SubSiteAttributes.md → Gs1SubSiteAttributes.md} +2 -2
- package/docs/reference/variables/{SubSiteTypes.md → Gs1SubSiteTypes.md} +2 -2
- package/package.json +1 -1
- package/dist/es/models/epcis20/IAggregationEvent.js +0 -2
- package/dist/es/models/epcis20/IAggregationEvent.js.map +0 -1
- package/dist/es/models/epcis20/IAssociationEvent.js +0 -2
- package/dist/es/models/epcis20/IAssociationEvent.js.map +0 -1
- package/dist/es/models/epcis20/IBaseAggregationEvent.js +0 -2
- package/dist/es/models/epcis20/IBaseAggregationEvent.js.map +0 -1
- package/dist/es/models/epcis20/IBizTransaction.js +0 -4
- package/dist/es/models/epcis20/IBizTransaction.js.map +0 -1
- package/dist/es/models/epcis20/IDestination.js +0 -4
- package/dist/es/models/epcis20/IDestination.js.map +0 -1
- package/dist/es/models/epcis20/IEpcisEventDetails.js +0 -2
- package/dist/es/models/epcis20/IEpcisEventDetails.js.map +0 -1
- package/dist/es/models/epcis20/IObjectEvent.js +0 -2
- package/dist/es/models/epcis20/IObjectEvent.js.map +0 -1
- package/dist/es/models/epcis20/IQuantity.js +0 -4
- package/dist/es/models/epcis20/IQuantity.js.map +0 -1
- package/dist/es/models/epcis20/ISensorElement.js +0 -2
- package/dist/es/models/epcis20/ISensorElement.js.map +0 -1
- package/dist/es/models/epcis20/ISensorMetadata.js +0 -4
- package/dist/es/models/epcis20/ISensorMetadata.js.map +0 -1
- package/dist/es/models/epcis20/ISensorReport.js +0 -4
- package/dist/es/models/epcis20/ISensorReport.js.map +0 -1
- package/dist/es/models/epcis20/ISimpleLocation.js +0 -4
- package/dist/es/models/epcis20/ISimpleLocation.js.map +0 -1
- package/dist/es/models/epcis20/ISource.js +0 -4
- package/dist/es/models/epcis20/ISource.js.map +0 -1
- package/dist/es/models/epcis20/actionTypes.js +0 -21
- package/dist/es/models/epcis20/actionTypes.js.map +0 -1
- package/dist/es/models/epcis20/bizStepTypes.js +0 -52
- package/dist/es/models/epcis20/bizStepTypes.js.map +0 -1
- package/dist/es/models/epcis20/dispositionTypes.js +0 -45
- package/dist/es/models/epcis20/dispositionTypes.js.map +0 -1
- package/dist/es/models/epcis20/epcisErrorTypes.js +0 -11
- package/dist/es/models/epcis20/epcisErrorTypes.js.map +0 -1
- package/dist/es/models/epcis20/epcisEventUnionType.js +0 -2
- package/dist/es/models/epcis20/epcisEventUnionType.js.map +0 -1
- package/dist/es/models/epcis20/eventTypes.js +0 -29
- package/dist/es/models/epcis20/eventTypes.js.map +0 -1
- package/dist/es/models/gs1/subSiteAttributes.js.map +0 -1
- package/dist/es/models/gs1/subSiteTypes.js.map +0 -1
- package/dist/types/models/epcis20/IAggregationEvent.d.ts +0 -10
- package/dist/types/models/epcis20/IAssociationEvent.d.ts +0 -10
- package/dist/types/models/epcis20/IBaseAggregationEvent.d.ts +0 -19
- package/dist/types/models/epcis20/IBizTransaction.d.ts +0 -13
- package/dist/types/models/epcis20/IDestination.d.ts +0 -13
- package/dist/types/models/epcis20/IEpcisEventDetails.d.ts +0 -35
- package/dist/types/models/epcis20/IObjectEvent.d.ts +0 -25
- package/dist/types/models/epcis20/IQuantity.d.ts +0 -13
- package/dist/types/models/epcis20/ISensorElement.d.ts +0 -15
- package/dist/types/models/epcis20/ISensorMetadata.d.ts +0 -21
- package/dist/types/models/epcis20/ISensorReport.d.ts +0 -17
- package/dist/types/models/epcis20/ISimpleLocation.d.ts +0 -9
- package/dist/types/models/epcis20/ISource.d.ts +0 -13
- package/dist/types/models/epcis20/actionTypes.d.ts +0 -21
- package/dist/types/models/epcis20/bizStepTypes.d.ts +0 -52
- package/dist/types/models/epcis20/dispositionTypes.d.ts +0 -44
- package/dist/types/models/epcis20/epcisErrorTypes.d.ts +0 -11
- package/dist/types/models/epcis20/epcisEventUnionType.d.ts +0 -7
- package/dist/types/models/epcis20/eventTypes.d.ts +0 -29
- package/docs/reference/interfaces/IAggregationEvent.md +0 -223
- package/docs/reference/interfaces/IAssociationEvent.md +0 -223
- package/docs/reference/interfaces/IBizTransaction.md +0 -19
- package/docs/reference/interfaces/IDestination.md +0 -19
- package/docs/reference/interfaces/IEpcisEventDetails.md +0 -167
- package/docs/reference/interfaces/IObjectEvent.md +0 -211
- package/docs/reference/interfaces/IQuantity.md +0 -19
- package/docs/reference/interfaces/ISensorElement.md +0 -19
- package/docs/reference/interfaces/ISensorMetadata.md +0 -35
- package/docs/reference/interfaces/ISensorReport.md +0 -27
- package/docs/reference/interfaces/ISimpleLocation.md +0 -11
- package/docs/reference/interfaces/ISource.md +0 -19
- package/docs/reference/type-aliases/ActionTypes.md +0 -5
- package/docs/reference/type-aliases/BizStepTypes.md +0 -5
- package/docs/reference/type-aliases/DispositionTypes.md +0 -5
- package/docs/reference/type-aliases/EpcisErrorTypes.md +0 -5
- package/docs/reference/type-aliases/EpcisEventUnionType.md +0 -5
- package/docs/reference/type-aliases/EventTypes.md +0 -5
- package/docs/reference/type-aliases/SubSiteAttributes.md +0 -7
- package/docs/reference/type-aliases/SubSiteTypes.md +0 -7
- package/docs/reference/variables/ActionTypes.md +0 -25
- package/docs/reference/variables/BizStepTypes.md +0 -173
- package/docs/reference/variables/EpcisErrorTypes.md +0 -15
|
@@ -1,34 +1,38 @@
|
|
|
1
1
|
# Interface: IEpcisEvent
|
|
2
2
|
|
|
3
|
-
EPCIS Event.
|
|
3
|
+
Base EPCIS 2.0 Event carrying shared fields across all event types.
|
|
4
4
|
|
|
5
|
-
##
|
|
5
|
+
## See
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
https://ref.gs1.org/epcis/Event
|
|
8
8
|
|
|
9
|
-
##
|
|
9
|
+
## Extends
|
|
10
10
|
|
|
11
|
-
|
|
11
|
+
- `IJsonLdNodeObject`
|
|
12
12
|
|
|
13
|
-
|
|
13
|
+
## Extended by
|
|
14
14
|
|
|
15
|
-
|
|
15
|
+
- [`IEpcisAggregationEvent`](IEpcisAggregationEvent.md)
|
|
16
|
+
- [`IEpcisAssociationEvent`](IEpcisAssociationEvent.md)
|
|
17
|
+
- [`IEpcisObjectEvent`](IEpcisObjectEvent.md)
|
|
18
|
+
- [`IEpcisTransactionEvent`](IEpcisTransactionEvent.md)
|
|
19
|
+
- [`IEpcisTransformationEvent`](IEpcisTransformationEvent.md)
|
|
16
20
|
|
|
17
|
-
|
|
21
|
+
## Indexable
|
|
18
22
|
|
|
19
|
-
|
|
23
|
+
\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `string`[] \| `IJsonLdContextDefinition` \| `IJsonLdNodeObject` \| `IJsonLdGraphObject` \| `object` & `object` \| `object` & `object` \| `object` & `object` \| `IJsonLdListObject` \| `IJsonLdSetObject` \| `IJsonLdNodePrimitive`[] \| `IJsonLdLanguageMap` \| `IJsonLdIndexMap` \| `IJsonLdNodeObject`[] \| `IJsonLdIdMap` \| `IJsonLdTypeMap` \| `IJsonLdContextDefinitionElement`[] \| `IJsonLdJsonObject` \| `IJsonLdJsonObject`[] \| \{\[`key`: `string`\]: `string`; \} \| `null` \| `undefined`
|
|
20
24
|
|
|
21
|
-
|
|
25
|
+
## Properties
|
|
22
26
|
|
|
23
|
-
|
|
27
|
+
### @context
|
|
24
28
|
|
|
25
|
-
|
|
29
|
+
> **@context**: [`EpcisContextType`](../type-aliases/EpcisContextType.md)
|
|
26
30
|
|
|
27
|
-
|
|
31
|
+
JSON-LD @context.
|
|
28
32
|
|
|
29
|
-
|
|
33
|
+
#### Overrides
|
|
30
34
|
|
|
31
|
-
|
|
35
|
+
`IJsonLdNodeObject.@context`
|
|
32
36
|
|
|
33
37
|
***
|
|
34
38
|
|
|
@@ -40,40 +44,52 @@ Type of Event.
|
|
|
40
44
|
|
|
41
45
|
***
|
|
42
46
|
|
|
43
|
-
###
|
|
47
|
+
### eventID?
|
|
44
48
|
|
|
45
|
-
> **
|
|
49
|
+
> `optional` **eventID**: `string`
|
|
46
50
|
|
|
47
|
-
|
|
51
|
+
URI identifier of a specific EPCIS event (alias of id in JSON or XML).
|
|
48
52
|
|
|
49
53
|
***
|
|
50
54
|
|
|
51
|
-
###
|
|
55
|
+
### certificationInfo?
|
|
52
56
|
|
|
53
|
-
> **
|
|
57
|
+
> `optional` **certificationInfo**: `string` \| `string`[]
|
|
54
58
|
|
|
55
|
-
|
|
59
|
+
(Optional) CertificationDetails relevant for Objects, Places and/or
|
|
60
|
+
Organizations mentioned in this Event.
|
|
56
61
|
|
|
57
62
|
***
|
|
58
63
|
|
|
59
|
-
###
|
|
64
|
+
### errorDeclaration?
|
|
60
65
|
|
|
61
|
-
> `optional` **
|
|
66
|
+
> `optional` **errorDeclaration**: [`IEpcisErrorDeclaration`](IEpcisErrorDeclaration.md)
|
|
67
|
+
|
|
68
|
+
Error declaration.
|
|
69
|
+
|
|
70
|
+
***
|
|
71
|
+
|
|
72
|
+
### eventTime
|
|
73
|
+
|
|
74
|
+
> **eventTime**: `string`
|
|
62
75
|
|
|
63
|
-
|
|
76
|
+
The date and time at which the EPCIS Capturing Applications asserts the event
|
|
77
|
+
occurred.
|
|
64
78
|
|
|
65
79
|
***
|
|
66
80
|
|
|
67
|
-
###
|
|
81
|
+
### eventTimeZoneOffset
|
|
68
82
|
|
|
69
|
-
>
|
|
83
|
+
> **eventTimeZoneOffset**: `string`
|
|
70
84
|
|
|
71
|
-
|
|
85
|
+
The time zone offset in effect at the time and place the event occurred,
|
|
86
|
+
expressed as an offset from UTC.
|
|
72
87
|
|
|
73
88
|
***
|
|
74
89
|
|
|
75
|
-
###
|
|
90
|
+
### recordTime?
|
|
76
91
|
|
|
77
|
-
> `optional` **
|
|
92
|
+
> `optional` **recordTime**: `string`
|
|
78
93
|
|
|
79
|
-
|
|
94
|
+
(Optional) The date and time at which this event was recorded by an EPCIS
|
|
95
|
+
Repository; ignored at capture and present on query results.
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
# Interface: IEpcisHeader
|
|
2
|
+
|
|
3
|
+
EPCIS 2.0 Header carrying optional master data alongside an EPCIS document.
|
|
4
|
+
|
|
5
|
+
## See
|
|
6
|
+
|
|
7
|
+
https://ref.gs1.org/epcis/EPCISHeader
|
|
8
|
+
|
|
9
|
+
## Extends
|
|
10
|
+
|
|
11
|
+
- `IJsonLdNodeObject`
|
|
12
|
+
|
|
13
|
+
## Indexable
|
|
14
|
+
|
|
15
|
+
\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `string`[] \| `IJsonLdContextDefinition` \| `IJsonLdNodeObject` \| `IJsonLdGraphObject` \| `object` & `object` \| `object` & `object` \| `object` & `object` \| `IJsonLdListObject` \| `IJsonLdSetObject` \| `IJsonLdNodePrimitive`[] \| `IJsonLdLanguageMap` \| `IJsonLdIndexMap` \| `IJsonLdNodeObject`[] \| `IJsonLdIdMap` \| `IJsonLdTypeMap` \| `IJsonLdContextDefinitionElement`[] \| `IJsonLdJsonObject` \| `IJsonLdJsonObject`[] \| \{\[`key`: `string`\]: `string`; \} \| `null` \| `undefined`
|
|
16
|
+
|
|
17
|
+
## Properties
|
|
18
|
+
|
|
19
|
+
### epcisMasterData?
|
|
20
|
+
|
|
21
|
+
> `optional` **epcisMasterData**: `IJsonLdNodeObject` & `object`
|
|
22
|
+
|
|
23
|
+
EPCIS master data.
|
|
24
|
+
|
|
25
|
+
#### Type Declaration
|
|
26
|
+
|
|
27
|
+
##### vocabularyList?
|
|
28
|
+
|
|
29
|
+
> `optional` **vocabularyList**: [`IEpcisVocabulary`](IEpcisVocabulary.md)[]
|
|
30
|
+
|
|
31
|
+
Vocabulary list.
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
# Interface: IEpcisIlmd
|
|
2
|
+
|
|
3
|
+
EPCIS 2.0 Instance/Lot Master Data (ILMD) container for event-level master
|
|
4
|
+
data extensions.
|
|
5
|
+
|
|
6
|
+
## See
|
|
7
|
+
|
|
8
|
+
https://ref.gs1.org/epcis/ILMD
|
|
9
|
+
|
|
10
|
+
## Extends
|
|
11
|
+
|
|
12
|
+
- `IJsonLdNodeObject`
|
|
13
|
+
|
|
14
|
+
## Indexable
|
|
15
|
+
|
|
16
|
+
\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `string`[] \| `IJsonLdContextDefinition` \| `IJsonLdNodeObject` \| `IJsonLdGraphObject` \| `object` & `object` \| `object` & `object` \| `object` & `object` \| `IJsonLdListObject` \| `IJsonLdSetObject` \| `IJsonLdNodePrimitive`[] \| `IJsonLdLanguageMap` \| `IJsonLdIndexMap` \| `IJsonLdNodeObject`[] \| `IJsonLdIdMap` \| `IJsonLdTypeMap` \| `IJsonLdContextDefinitionElement`[] \| `IJsonLdJsonObject` \| `IJsonLdJsonObject`[] \| \{\[`key`: `string`\]: `string`; \} \| `null` \| `undefined`
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# Interface: IEpcisLocation
|
|
2
|
+
|
|
3
|
+
EPCIS 2.0 Location reference (readPoint/bizLocation) that wraps a location
|
|
4
|
+
identifier.
|
|
5
|
+
|
|
6
|
+
## See
|
|
7
|
+
|
|
8
|
+
https://ref.gs1.org/epcis/ReadPoint
|
|
9
|
+
|
|
10
|
+
## Extends
|
|
11
|
+
|
|
12
|
+
- `IJsonLdNodeObject`
|
|
13
|
+
|
|
14
|
+
## Indexable
|
|
15
|
+
|
|
16
|
+
\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `string`[] \| `IJsonLdContextDefinition` \| `IJsonLdNodeObject` \| `IJsonLdGraphObject` \| `object` & `object` \| `object` & `object` \| `object` & `object` \| `IJsonLdListObject` \| `IJsonLdSetObject` \| `IJsonLdNodePrimitive`[] \| `IJsonLdLanguageMap` \| `IJsonLdIndexMap` \| `IJsonLdNodeObject`[] \| `IJsonLdIdMap` \| `IJsonLdTypeMap` \| `IJsonLdContextDefinitionElement`[] \| `IJsonLdJsonObject` \| `IJsonLdJsonObject`[] \| \{\[`key`: `string`\]: `string`; \} \| `null` \| `undefined`
|
|
17
|
+
|
|
18
|
+
## Properties
|
|
19
|
+
|
|
20
|
+
### id
|
|
21
|
+
|
|
22
|
+
> **id**: `string`
|
|
23
|
+
|
|
24
|
+
The location identifier (URI/IRI per EPCIS schema and SHACL).
|
|
@@ -0,0 +1,228 @@
|
|
|
1
|
+
# Interface: IEpcisObjectEvent
|
|
2
|
+
|
|
3
|
+
EPCIS 2.0 ObjectEvent describing one or more objects (instance- or class-level)
|
|
4
|
+
observed at a point in the business process.
|
|
5
|
+
|
|
6
|
+
## See
|
|
7
|
+
|
|
8
|
+
https://ref.gs1.org/epcis/ObjectEvent
|
|
9
|
+
|
|
10
|
+
## Extends
|
|
11
|
+
|
|
12
|
+
- [`IEpcisEvent`](IEpcisEvent.md)
|
|
13
|
+
|
|
14
|
+
## Indexable
|
|
15
|
+
|
|
16
|
+
\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `string`[] \| `IJsonLdContextDefinition` \| `IJsonLdNodeObject` \| `IJsonLdGraphObject` \| `object` & `object` \| `object` & `object` \| `object` & `object` \| `IJsonLdListObject` \| `IJsonLdSetObject` \| `IJsonLdNodePrimitive`[] \| `IJsonLdLanguageMap` \| `IJsonLdIndexMap` \| `IJsonLdNodeObject`[] \| `IJsonLdIdMap` \| `IJsonLdTypeMap` \| `IJsonLdContextDefinitionElement`[] \| `IJsonLdJsonObject` \| `IJsonLdJsonObject`[] \| \{\[`key`: `string`\]: `string`; \} \| `null` \| `undefined`
|
|
17
|
+
|
|
18
|
+
## Properties
|
|
19
|
+
|
|
20
|
+
### @context
|
|
21
|
+
|
|
22
|
+
> **@context**: [`EpcisContextType`](../type-aliases/EpcisContextType.md)
|
|
23
|
+
|
|
24
|
+
JSON-LD @context.
|
|
25
|
+
|
|
26
|
+
#### Inherited from
|
|
27
|
+
|
|
28
|
+
[`IEpcisEvent`](IEpcisEvent.md).[`@context`](IEpcisEvent.md#context)
|
|
29
|
+
|
|
30
|
+
***
|
|
31
|
+
|
|
32
|
+
### eventID?
|
|
33
|
+
|
|
34
|
+
> `optional` **eventID**: `string`
|
|
35
|
+
|
|
36
|
+
URI identifier of a specific EPCIS event (alias of id in JSON or XML).
|
|
37
|
+
|
|
38
|
+
#### Inherited from
|
|
39
|
+
|
|
40
|
+
[`IEpcisEvent`](IEpcisEvent.md).[`eventID`](IEpcisEvent.md#eventid)
|
|
41
|
+
|
|
42
|
+
***
|
|
43
|
+
|
|
44
|
+
### certificationInfo?
|
|
45
|
+
|
|
46
|
+
> `optional` **certificationInfo**: `string` \| `string`[]
|
|
47
|
+
|
|
48
|
+
(Optional) CertificationDetails relevant for Objects, Places and/or
|
|
49
|
+
Organizations mentioned in this Event.
|
|
50
|
+
|
|
51
|
+
#### Inherited from
|
|
52
|
+
|
|
53
|
+
[`IEpcisEvent`](IEpcisEvent.md).[`certificationInfo`](IEpcisEvent.md#certificationinfo)
|
|
54
|
+
|
|
55
|
+
***
|
|
56
|
+
|
|
57
|
+
### errorDeclaration?
|
|
58
|
+
|
|
59
|
+
> `optional` **errorDeclaration**: [`IEpcisErrorDeclaration`](IEpcisErrorDeclaration.md)
|
|
60
|
+
|
|
61
|
+
Error declaration.
|
|
62
|
+
|
|
63
|
+
#### Inherited from
|
|
64
|
+
|
|
65
|
+
[`IEpcisEvent`](IEpcisEvent.md).[`errorDeclaration`](IEpcisEvent.md#errordeclaration)
|
|
66
|
+
|
|
67
|
+
***
|
|
68
|
+
|
|
69
|
+
### eventTime
|
|
70
|
+
|
|
71
|
+
> **eventTime**: `string`
|
|
72
|
+
|
|
73
|
+
The date and time at which the EPCIS Capturing Applications asserts the event
|
|
74
|
+
occurred.
|
|
75
|
+
|
|
76
|
+
#### Inherited from
|
|
77
|
+
|
|
78
|
+
[`IEpcisEvent`](IEpcisEvent.md).[`eventTime`](IEpcisEvent.md#eventtime)
|
|
79
|
+
|
|
80
|
+
***
|
|
81
|
+
|
|
82
|
+
### eventTimeZoneOffset
|
|
83
|
+
|
|
84
|
+
> **eventTimeZoneOffset**: `string`
|
|
85
|
+
|
|
86
|
+
The time zone offset in effect at the time and place the event occurred,
|
|
87
|
+
expressed as an offset from UTC.
|
|
88
|
+
|
|
89
|
+
#### Inherited from
|
|
90
|
+
|
|
91
|
+
[`IEpcisEvent`](IEpcisEvent.md).[`eventTimeZoneOffset`](IEpcisEvent.md#eventtimezoneoffset)
|
|
92
|
+
|
|
93
|
+
***
|
|
94
|
+
|
|
95
|
+
### recordTime?
|
|
96
|
+
|
|
97
|
+
> `optional` **recordTime**: `string`
|
|
98
|
+
|
|
99
|
+
(Optional) The date and time at which this event was recorded by an EPCIS
|
|
100
|
+
Repository; ignored at capture and present on query results.
|
|
101
|
+
|
|
102
|
+
#### Inherited from
|
|
103
|
+
|
|
104
|
+
[`IEpcisEvent`](IEpcisEvent.md).[`recordTime`](IEpcisEvent.md#recordtime)
|
|
105
|
+
|
|
106
|
+
***
|
|
107
|
+
|
|
108
|
+
### type
|
|
109
|
+
|
|
110
|
+
> **type**: `"ObjectEvent"`
|
|
111
|
+
|
|
112
|
+
Fixed to ObjectEvent.
|
|
113
|
+
|
|
114
|
+
#### Overrides
|
|
115
|
+
|
|
116
|
+
[`IEpcisEvent`](IEpcisEvent.md).[`type`](IEpcisEvent.md#type)
|
|
117
|
+
|
|
118
|
+
***
|
|
119
|
+
|
|
120
|
+
### epcList?
|
|
121
|
+
|
|
122
|
+
> `optional` **epcList**: `string`[]
|
|
123
|
+
|
|
124
|
+
(Optional) Unordered list of one or more EPCs naming specific objects to which
|
|
125
|
+
the event pertained.
|
|
126
|
+
|
|
127
|
+
***
|
|
128
|
+
|
|
129
|
+
### quantityList?
|
|
130
|
+
|
|
131
|
+
> `optional` **quantityList**: [`IEpcisQuantity`](IEpcisQuantity.md)[]
|
|
132
|
+
|
|
133
|
+
Unordered list of one or more QuantityElements identifying contained objects at
|
|
134
|
+
the class level.
|
|
135
|
+
|
|
136
|
+
***
|
|
137
|
+
|
|
138
|
+
### action
|
|
139
|
+
|
|
140
|
+
> **action**: [`EpcisActionTypes`](../type-aliases/EpcisActionTypes.md)
|
|
141
|
+
|
|
142
|
+
How this event relates to the lifecycle of the EPCs named in this event.
|
|
143
|
+
|
|
144
|
+
***
|
|
145
|
+
|
|
146
|
+
### bizStep?
|
|
147
|
+
|
|
148
|
+
> `optional` **bizStep**: `string`
|
|
149
|
+
|
|
150
|
+
(Optional) The business step of which this event was a part.
|
|
151
|
+
|
|
152
|
+
***
|
|
153
|
+
|
|
154
|
+
### disposition?
|
|
155
|
+
|
|
156
|
+
> `optional` **disposition**: `string`
|
|
157
|
+
|
|
158
|
+
(Optional) The business condition of the objects associated with the EPCs,
|
|
159
|
+
presumed to hold true until contradicted by a subsequent event.
|
|
160
|
+
|
|
161
|
+
***
|
|
162
|
+
|
|
163
|
+
### persistentDisposition?
|
|
164
|
+
|
|
165
|
+
> `optional` **persistentDisposition**: [`IEpcisPersistentDisposition`](IEpcisPersistentDisposition.md)
|
|
166
|
+
|
|
167
|
+
Persistent disposition.
|
|
168
|
+
|
|
169
|
+
***
|
|
170
|
+
|
|
171
|
+
### readPoint?
|
|
172
|
+
|
|
173
|
+
> `optional` **readPoint**: [`IEpcisLocation`](IEpcisLocation.md)
|
|
174
|
+
|
|
175
|
+
(Optional) The read point at which the event took place.
|
|
176
|
+
|
|
177
|
+
***
|
|
178
|
+
|
|
179
|
+
### bizLocation?
|
|
180
|
+
|
|
181
|
+
> `optional` **bizLocation**: [`IEpcisLocation`](IEpcisLocation.md)
|
|
182
|
+
|
|
183
|
+
(Optional) The business location where the objects associated with the EPCs may
|
|
184
|
+
be found, until contradicted by a subsequent event.
|
|
185
|
+
|
|
186
|
+
***
|
|
187
|
+
|
|
188
|
+
### bizTransactionList?
|
|
189
|
+
|
|
190
|
+
> `optional` **bizTransactionList**: [`IEpcisBizTransaction`](IEpcisBizTransaction.md)[]
|
|
191
|
+
|
|
192
|
+
(Optional) Unordered list of business transactions that define the context of
|
|
193
|
+
this event.
|
|
194
|
+
|
|
195
|
+
***
|
|
196
|
+
|
|
197
|
+
### sourceList?
|
|
198
|
+
|
|
199
|
+
> `optional` **sourceList**: [`IEpcisSource`](IEpcisSource.md)[]
|
|
200
|
+
|
|
201
|
+
(Optional) Unordered list of Source elements that provide context about the
|
|
202
|
+
originating endpoint of a business transfer of which this event is a part.
|
|
203
|
+
|
|
204
|
+
***
|
|
205
|
+
|
|
206
|
+
### destinationList?
|
|
207
|
+
|
|
208
|
+
> `optional` **destinationList**: [`IEpcisDestination`](IEpcisDestination.md)[]
|
|
209
|
+
|
|
210
|
+
(Optional) Unordered list of Destination elements that provide context about the
|
|
211
|
+
terminating endpoint of a business transfer of which this event is a part.
|
|
212
|
+
|
|
213
|
+
***
|
|
214
|
+
|
|
215
|
+
### sensorElementList?
|
|
216
|
+
|
|
217
|
+
> `optional` **sensorElementList**: [`IEpcisSensorElement`](IEpcisSensorElement.md)[]
|
|
218
|
+
|
|
219
|
+
(Optional) Connects event to one or more SensorElements.
|
|
220
|
+
|
|
221
|
+
***
|
|
222
|
+
|
|
223
|
+
### ilmd?
|
|
224
|
+
|
|
225
|
+
> `optional` **ilmd**: [`IEpcisIlmd`](IEpcisIlmd.md)
|
|
226
|
+
|
|
227
|
+
(Optional) Instance/Lot master data that describes the objects created during
|
|
228
|
+
this event.
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
# Interface: IEpcisPersistentDisposition
|
|
2
|
+
|
|
3
|
+
EPCIS 2.0 PersistentDisposition indicating business conditions to set or unset
|
|
4
|
+
independently of event disposition.
|
|
5
|
+
|
|
6
|
+
## See
|
|
7
|
+
|
|
8
|
+
https://ref.gs1.org/epcis/PersistentDisposition
|
|
9
|
+
|
|
10
|
+
## Extends
|
|
11
|
+
|
|
12
|
+
- `IJsonLdNodeObject`
|
|
13
|
+
|
|
14
|
+
## Indexable
|
|
15
|
+
|
|
16
|
+
\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `string`[] \| `IJsonLdContextDefinition` \| `IJsonLdNodeObject` \| `IJsonLdGraphObject` \| `object` & `object` \| `object` & `object` \| `object` & `object` \| `IJsonLdListObject` \| `IJsonLdSetObject` \| `IJsonLdNodePrimitive`[] \| `IJsonLdLanguageMap` \| `IJsonLdIndexMap` \| `IJsonLdNodeObject`[] \| `IJsonLdIdMap` \| `IJsonLdTypeMap` \| `IJsonLdContextDefinitionElement`[] \| `IJsonLdJsonObject` \| `IJsonLdJsonObject`[] \| \{\[`key`: `string`\]: `string`; \} \| `null` \| `undefined`
|
|
17
|
+
|
|
18
|
+
## Properties
|
|
19
|
+
|
|
20
|
+
### set?
|
|
21
|
+
|
|
22
|
+
> `optional` **set**: `string`[]
|
|
23
|
+
|
|
24
|
+
(Optional) List of persistentDisposition URI values to be set.
|
|
25
|
+
|
|
26
|
+
***
|
|
27
|
+
|
|
28
|
+
### unset?
|
|
29
|
+
|
|
30
|
+
> `optional` **unset**: `string`[]
|
|
31
|
+
|
|
32
|
+
(Optional) List of persistentDisposition URI values to be unset (revoked).
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
# Interface: IEpcisQuantity
|
|
2
|
+
|
|
3
|
+
EPCIS 2.0 QuantityElement defining class-level identifiers and amounts.
|
|
4
|
+
|
|
5
|
+
## See
|
|
6
|
+
|
|
7
|
+
https://ref.gs1.org/epcis/QuantityElement
|
|
8
|
+
|
|
9
|
+
## Extends
|
|
10
|
+
|
|
11
|
+
- `IJsonLdNodeObject`
|
|
12
|
+
|
|
13
|
+
## Indexable
|
|
14
|
+
|
|
15
|
+
\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `string`[] \| `IJsonLdContextDefinition` \| `IJsonLdNodeObject` \| `IJsonLdGraphObject` \| `object` & `object` \| `object` & `object` \| `object` & `object` \| `IJsonLdListObject` \| `IJsonLdSetObject` \| `IJsonLdNodePrimitive`[] \| `IJsonLdLanguageMap` \| `IJsonLdIndexMap` \| `IJsonLdNodeObject`[] \| `IJsonLdIdMap` \| `IJsonLdTypeMap` \| `IJsonLdContextDefinitionElement`[] \| `IJsonLdJsonObject` \| `IJsonLdJsonObject`[] \| \{\[`key`: `string`\]: `string`; \} \| `null` \| `undefined`
|
|
16
|
+
|
|
17
|
+
## Properties
|
|
18
|
+
|
|
19
|
+
### epcClass
|
|
20
|
+
|
|
21
|
+
> **epcClass**: `string`
|
|
22
|
+
|
|
23
|
+
A class-level identifier for the class to which the specified quantity of
|
|
24
|
+
objects belongs.
|
|
25
|
+
|
|
26
|
+
***
|
|
27
|
+
|
|
28
|
+
### quantity?
|
|
29
|
+
|
|
30
|
+
> `optional` **quantity**: `number`
|
|
31
|
+
|
|
32
|
+
(Optional) A number that specifies how many or how much of the specified
|
|
33
|
+
EPCClass is denoted by this QuantityElement.
|
|
34
|
+
|
|
35
|
+
***
|
|
36
|
+
|
|
37
|
+
### uom?
|
|
38
|
+
|
|
39
|
+
> `optional` **uom**: `string`
|
|
40
|
+
|
|
41
|
+
(Optional) Unit of measure by which the specified value(s) of the property
|
|
42
|
+
specified by type should be interpreted.
|
|
@@ -1,15 +1,31 @@
|
|
|
1
1
|
# Interface: IEpcisQueryDocument
|
|
2
2
|
|
|
3
|
-
EPCIS
|
|
3
|
+
EPCIS 2.0 QueryDocument used to submit queries to an EPCIS repository.
|
|
4
|
+
|
|
5
|
+
## See
|
|
6
|
+
|
|
7
|
+
https://ref.gs1.org/epcis/EPCISQueryDocument
|
|
8
|
+
|
|
9
|
+
## Extends
|
|
10
|
+
|
|
11
|
+
- `IJsonLdNodeObject`
|
|
12
|
+
|
|
13
|
+
## Indexable
|
|
14
|
+
|
|
15
|
+
\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `string`[] \| `IJsonLdContextDefinition` \| `IJsonLdNodeObject` \| `IJsonLdGraphObject` \| `object` & `object` \| `object` & `object` \| `object` & `object` \| `IJsonLdListObject` \| `IJsonLdSetObject` \| `IJsonLdNodePrimitive`[] \| `IJsonLdLanguageMap` \| `IJsonLdIndexMap` \| `IJsonLdNodeObject`[] \| `IJsonLdIdMap` \| `IJsonLdTypeMap` \| `IJsonLdContextDefinitionElement`[] \| `IJsonLdJsonObject` \| `IJsonLdJsonObject`[] \| \{\[`key`: `string`\]: `string`; \} \| `null` \| `undefined`
|
|
4
16
|
|
|
5
17
|
## Properties
|
|
6
18
|
|
|
7
19
|
### @context
|
|
8
20
|
|
|
9
|
-
> **@context**: `
|
|
21
|
+
> **@context**: [`EpcisContextType`](../type-aliases/EpcisContextType.md)
|
|
10
22
|
|
|
11
23
|
The @context.
|
|
12
24
|
|
|
25
|
+
#### Overrides
|
|
26
|
+
|
|
27
|
+
`IJsonLdNodeObject.@context`
|
|
28
|
+
|
|
13
29
|
***
|
|
14
30
|
|
|
15
31
|
### id?
|
|
@@ -22,7 +38,7 @@ The JSON-LD document id.
|
|
|
22
38
|
|
|
23
39
|
### type
|
|
24
40
|
|
|
25
|
-
> **type**: `
|
|
41
|
+
> **type**: `"EPCISQueryDocument"`
|
|
26
42
|
|
|
27
43
|
JSON-LD Type.
|
|
28
44
|
|
|
@@ -46,36 +62,6 @@ Creation Date.
|
|
|
46
62
|
|
|
47
63
|
### epcisBody
|
|
48
64
|
|
|
49
|
-
> **epcisBody**: `
|
|
65
|
+
> **epcisBody**: [`IEpcisQueryDocumentBody`](IEpcisQueryDocumentBody.md)
|
|
50
66
|
|
|
51
67
|
The EPCIS Body.
|
|
52
|
-
|
|
53
|
-
#### queryResults
|
|
54
|
-
|
|
55
|
-
> **queryResults**: `object`
|
|
56
|
-
|
|
57
|
-
The results of the query.
|
|
58
|
-
|
|
59
|
-
##### queryResults.subscriptionID?
|
|
60
|
-
|
|
61
|
-
> `optional` **subscriptionID**: `string`
|
|
62
|
-
|
|
63
|
-
The concerned subscription.
|
|
64
|
-
|
|
65
|
-
##### queryResults.queryName
|
|
66
|
-
|
|
67
|
-
> **queryName**: `string`
|
|
68
|
-
|
|
69
|
-
The concerned query.
|
|
70
|
-
|
|
71
|
-
##### queryResults.resultsBody
|
|
72
|
-
|
|
73
|
-
> **resultsBody**: `object`
|
|
74
|
-
|
|
75
|
-
And now the results.
|
|
76
|
-
|
|
77
|
-
##### queryResults.resultsBody.eventList
|
|
78
|
-
|
|
79
|
-
> **eventList**: [`IEpcisEvent`](IEpcisEvent.md)[]
|
|
80
|
-
|
|
81
|
-
The list of events.
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# Interface: IEpcisQueryDocumentBody
|
|
2
|
+
|
|
3
|
+
EPCIS 2.0 QueryDocumentBody wrapper that carries query results.
|
|
4
|
+
|
|
5
|
+
## See
|
|
6
|
+
|
|
7
|
+
https://ref.gs1.org/epcis/QueryDocumentBody
|
|
8
|
+
|
|
9
|
+
## Extends
|
|
10
|
+
|
|
11
|
+
- `IJsonLdNodeObject`
|
|
12
|
+
|
|
13
|
+
## Indexable
|
|
14
|
+
|
|
15
|
+
\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `string`[] \| `IJsonLdContextDefinition` \| `IJsonLdNodeObject` \| `IJsonLdGraphObject` \| `object` & `object` \| `object` & `object` \| `object` & `object` \| `IJsonLdListObject` \| `IJsonLdSetObject` \| `IJsonLdNodePrimitive`[] \| `IJsonLdLanguageMap` \| `IJsonLdIndexMap` \| `IJsonLdNodeObject`[] \| `IJsonLdIdMap` \| `IJsonLdTypeMap` \| `IJsonLdContextDefinitionElement`[] \| `IJsonLdJsonObject` \| `IJsonLdJsonObject`[] \| \{\[`key`: `string`\]: `string`; \} \| `null` \| `undefined`
|
|
16
|
+
|
|
17
|
+
## Properties
|
|
18
|
+
|
|
19
|
+
### queryResults
|
|
20
|
+
|
|
21
|
+
> **queryResults**: [`IEpcisQueryResults`](IEpcisQueryResults.md)
|
|
22
|
+
|
|
23
|
+
The results of the query.
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
# Interface: IEpcisQueryResults
|
|
2
|
+
|
|
3
|
+
EPCIS 2.0 QueryResults payload returned from a repository query.
|
|
4
|
+
|
|
5
|
+
## See
|
|
6
|
+
|
|
7
|
+
https://ref.gs1.org/epcis/QueryResults
|
|
8
|
+
|
|
9
|
+
## Extends
|
|
10
|
+
|
|
11
|
+
- `IJsonLdNodeObject`
|
|
12
|
+
|
|
13
|
+
## Indexable
|
|
14
|
+
|
|
15
|
+
\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `string`[] \| `IJsonLdContextDefinition` \| `IJsonLdNodeObject` \| `IJsonLdGraphObject` \| `object` & `object` \| `object` & `object` \| `object` & `object` \| `IJsonLdListObject` \| `IJsonLdSetObject` \| `IJsonLdNodePrimitive`[] \| `IJsonLdLanguageMap` \| `IJsonLdIndexMap` \| `IJsonLdNodeObject`[] \| `IJsonLdIdMap` \| `IJsonLdTypeMap` \| `IJsonLdContextDefinitionElement`[] \| `IJsonLdJsonObject` \| `IJsonLdJsonObject`[] \| \{\[`key`: `string`\]: `string`; \} \| `null` \| `undefined`
|
|
16
|
+
|
|
17
|
+
## Properties
|
|
18
|
+
|
|
19
|
+
### subscriptionID?
|
|
20
|
+
|
|
21
|
+
> `optional` **subscriptionID**: `string`
|
|
22
|
+
|
|
23
|
+
The concerned subscription.
|
|
24
|
+
|
|
25
|
+
***
|
|
26
|
+
|
|
27
|
+
### queryName
|
|
28
|
+
|
|
29
|
+
> **queryName**: `string`
|
|
30
|
+
|
|
31
|
+
The concerned query.
|
|
32
|
+
|
|
33
|
+
***
|
|
34
|
+
|
|
35
|
+
### resultsBody
|
|
36
|
+
|
|
37
|
+
> **resultsBody**: [`IEpcisQueryResultsBody`](IEpcisQueryResultsBody.md)
|
|
38
|
+
|
|
39
|
+
The query results payload.
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
# Interface: IEpcisQueryResultsBody
|
|
2
|
+
|
|
3
|
+
EPCIS 2.0 QueryResultsBody containing events and optional master data.
|
|
4
|
+
|
|
5
|
+
## See
|
|
6
|
+
|
|
7
|
+
https://ref.gs1.org/epcis/QueryResultsBody
|
|
8
|
+
|
|
9
|
+
## Extends
|
|
10
|
+
|
|
11
|
+
- `IJsonLdNodeObject`
|
|
12
|
+
|
|
13
|
+
## Indexable
|
|
14
|
+
|
|
15
|
+
\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `string`[] \| `IJsonLdContextDefinition` \| `IJsonLdNodeObject` \| `IJsonLdGraphObject` \| `object` & `object` \| `object` & `object` \| `object` & `object` \| `IJsonLdListObject` \| `IJsonLdSetObject` \| `IJsonLdNodePrimitive`[] \| `IJsonLdLanguageMap` \| `IJsonLdIndexMap` \| `IJsonLdNodeObject`[] \| `IJsonLdIdMap` \| `IJsonLdTypeMap` \| `IJsonLdContextDefinitionElement`[] \| `IJsonLdJsonObject` \| `IJsonLdJsonObject`[] \| \{\[`key`: `string`\]: `string`; \} \| `null` \| `undefined`
|
|
16
|
+
|
|
17
|
+
## Properties
|
|
18
|
+
|
|
19
|
+
### eventList
|
|
20
|
+
|
|
21
|
+
> **eventList**: [`EpcisEvents`](../type-aliases/EpcisEvents.md)[]
|
|
22
|
+
|
|
23
|
+
The list of events.
|
|
24
|
+
|
|
25
|
+
***
|
|
26
|
+
|
|
27
|
+
### vocabularyList?
|
|
28
|
+
|
|
29
|
+
> `optional` **vocabularyList**: [`IEpcisVocabulary`](IEpcisVocabulary.md)[]
|
|
30
|
+
|
|
31
|
+
Optional master data.
|