@uncefact/untp-utils 0.2.0 → 0.4.0
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/README.md +40 -12
- package/artefacts/context/untp/0.6.0/dcc.json +1241 -0
- package/artefacts/context/untp/0.6.0/dfr.json +619 -0
- package/artefacts/context/untp/0.6.0/dia.json +162 -0
- package/artefacts/context/untp/0.6.0/dpp.json +1078 -0
- package/artefacts/context/untp/0.6.0/dte.json +1285 -0
- package/artefacts/context/untp/0.6.1/dcc.json +1388 -0
- package/artefacts/context/untp/0.6.1/dfr.json +690 -0
- package/artefacts/context/untp/0.6.1/dia.json +196 -0
- package/artefacts/context/untp/0.6.1/dpp.json +1164 -0
- package/artefacts/context/untp/0.6.1/dte.json +1340 -0
- package/artefacts/context/untp/0.7.0/untp.json +3493 -0
- package/artefacts/context/vcdm/2/credentials.json +301 -0
- package/artefacts/manifest.json +214 -0
- package/artefacts/schema/untp/0.6.0/dcc.json +1131 -0
- package/artefacts/schema/untp/0.6.0/dfr.json +1028 -0
- package/artefacts/schema/untp/0.6.0/dia.json +236 -0
- package/artefacts/schema/untp/0.6.0/dpp.json +1219 -0
- package/artefacts/schema/untp/0.6.0/dte.json +845 -0
- package/artefacts/schema/untp/0.6.1/dcc.json +1196 -0
- package/artefacts/schema/untp/0.6.1/dfr.json +1037 -0
- package/artefacts/schema/untp/0.6.1/dia.json +236 -0
- package/artefacts/schema/untp/0.6.1/dpp.json +1229 -0
- package/artefacts/schema/untp/0.6.1/dte.json +845 -0
- package/artefacts/schema/untp/0.7.0/cvc.json +701 -0
- package/artefacts/schema/untp/0.7.0/dcc.json +1133 -0
- package/artefacts/schema/untp/0.7.0/dfr.json +1245 -0
- package/artefacts/schema/untp/0.7.0/dia.json +443 -0
- package/artefacts/schema/untp/0.7.0/dpp.json +1300 -0
- package/artefacts/schema/untp/0.7.0/dte.json +1226 -0
- package/artefacts/schema/untp/0.7.0/linkset.json +119 -0
- package/artefacts/schema/vcdm/2/verifiable-credential.json +318 -0
- package/build/artefacts/detect-version-from-context.d.ts +7 -2
- package/build/artefacts/detect-version-from-context.js +17 -6
- package/build/artefacts/detect-version-from-context.js.map +1 -1
- package/build/artefacts/detect-version-from-context.test.js +59 -0
- package/build/artefacts/detect-version-from-context.test.js.map +1 -1
- package/build/artefacts/urls.d.ts +8 -1
- package/build/artefacts/urls.js +17 -5
- package/build/artefacts/urls.js.map +1 -1
- package/build/artefacts/urls.test.js +63 -1
- package/build/artefacts/urls.test.js.map +1 -1
- package/build/bundle/artefacts/context/untp/0.6.0/dcc.d.ts +2 -0
- package/build/bundle/artefacts/context/untp/0.6.0/dcc.js +1244 -0
- package/build/bundle/artefacts/context/untp/0.6.0/dcc.js.map +1 -0
- package/build/bundle/artefacts/context/untp/0.6.0/dfr.d.ts +2 -0
- package/build/bundle/artefacts/context/untp/0.6.0/dfr.js +622 -0
- package/build/bundle/artefacts/context/untp/0.6.0/dfr.js.map +1 -0
- package/build/bundle/artefacts/context/untp/0.6.0/dia.d.ts +2 -0
- package/build/bundle/artefacts/context/untp/0.6.0/dia.js +165 -0
- package/build/bundle/artefacts/context/untp/0.6.0/dia.js.map +1 -0
- package/build/bundle/artefacts/context/untp/0.6.0/dpp.d.ts +2 -0
- package/build/bundle/artefacts/context/untp/0.6.0/dpp.js +1081 -0
- package/build/bundle/artefacts/context/untp/0.6.0/dpp.js.map +1 -0
- package/build/bundle/artefacts/context/untp/0.6.0/dte.d.ts +2 -0
- package/build/bundle/artefacts/context/untp/0.6.0/dte.js +1288 -0
- package/build/bundle/artefacts/context/untp/0.6.0/dte.js.map +1 -0
- package/build/bundle/artefacts/context/untp/0.6.1/dcc.d.ts +2 -0
- package/build/bundle/artefacts/context/untp/0.6.1/dcc.js +1391 -0
- package/build/bundle/artefacts/context/untp/0.6.1/dcc.js.map +1 -0
- package/build/bundle/artefacts/context/untp/0.6.1/dfr.d.ts +2 -0
- package/build/bundle/artefacts/context/untp/0.6.1/dfr.js +693 -0
- package/build/bundle/artefacts/context/untp/0.6.1/dfr.js.map +1 -0
- package/build/bundle/artefacts/context/untp/0.6.1/dia.d.ts +2 -0
- package/build/bundle/artefacts/context/untp/0.6.1/dia.js +199 -0
- package/build/bundle/artefacts/context/untp/0.6.1/dia.js.map +1 -0
- package/build/bundle/artefacts/context/untp/0.6.1/dpp.d.ts +2 -0
- package/build/bundle/artefacts/context/untp/0.6.1/dpp.js +1167 -0
- package/build/bundle/artefacts/context/untp/0.6.1/dpp.js.map +1 -0
- package/build/bundle/artefacts/context/untp/0.6.1/dte.d.ts +2 -0
- package/build/bundle/artefacts/context/untp/0.6.1/dte.js +1343 -0
- package/build/bundle/artefacts/context/untp/0.6.1/dte.js.map +1 -0
- package/build/bundle/artefacts/context/untp/0.7.0/untp.d.ts +2 -0
- package/build/bundle/artefacts/context/untp/0.7.0/untp.js +3496 -0
- package/build/bundle/artefacts/context/untp/0.7.0/untp.js.map +1 -0
- package/build/bundle/artefacts/context/vcdm/2/credentials.d.ts +2 -0
- package/build/bundle/artefacts/context/vcdm/2/credentials.js +304 -0
- package/build/bundle/artefacts/context/vcdm/2/credentials.js.map +1 -0
- package/build/bundle/artefacts/schema/untp/0.6.0/dcc.d.ts +2 -0
- package/build/bundle/artefacts/schema/untp/0.6.0/dcc.js +1134 -0
- package/build/bundle/artefacts/schema/untp/0.6.0/dcc.js.map +1 -0
- package/build/bundle/artefacts/schema/untp/0.6.0/dfr.d.ts +2 -0
- package/build/bundle/artefacts/schema/untp/0.6.0/dfr.js +1031 -0
- package/build/bundle/artefacts/schema/untp/0.6.0/dfr.js.map +1 -0
- package/build/bundle/artefacts/schema/untp/0.6.0/dia.d.ts +2 -0
- package/build/bundle/artefacts/schema/untp/0.6.0/dia.js +239 -0
- package/build/bundle/artefacts/schema/untp/0.6.0/dia.js.map +1 -0
- package/build/bundle/artefacts/schema/untp/0.6.0/dpp.d.ts +2 -0
- package/build/bundle/artefacts/schema/untp/0.6.0/dpp.js +1222 -0
- package/build/bundle/artefacts/schema/untp/0.6.0/dpp.js.map +1 -0
- package/build/bundle/artefacts/schema/untp/0.6.0/dte.d.ts +2 -0
- package/build/bundle/artefacts/schema/untp/0.6.0/dte.js +848 -0
- package/build/bundle/artefacts/schema/untp/0.6.0/dte.js.map +1 -0
- package/build/bundle/artefacts/schema/untp/0.6.1/dcc.d.ts +2 -0
- package/build/bundle/artefacts/schema/untp/0.6.1/dcc.js +1199 -0
- package/build/bundle/artefacts/schema/untp/0.6.1/dcc.js.map +1 -0
- package/build/bundle/artefacts/schema/untp/0.6.1/dfr.d.ts +2 -0
- package/build/bundle/artefacts/schema/untp/0.6.1/dfr.js +1040 -0
- package/build/bundle/artefacts/schema/untp/0.6.1/dfr.js.map +1 -0
- package/build/bundle/artefacts/schema/untp/0.6.1/dia.d.ts +2 -0
- package/build/bundle/artefacts/schema/untp/0.6.1/dia.js +239 -0
- package/build/bundle/artefacts/schema/untp/0.6.1/dia.js.map +1 -0
- package/build/bundle/artefacts/schema/untp/0.6.1/dpp.d.ts +2 -0
- package/build/bundle/artefacts/schema/untp/0.6.1/dpp.js +1232 -0
- package/build/bundle/artefacts/schema/untp/0.6.1/dpp.js.map +1 -0
- package/build/bundle/artefacts/schema/untp/0.6.1/dte.d.ts +2 -0
- package/build/bundle/artefacts/schema/untp/0.6.1/dte.js +848 -0
- package/build/bundle/artefacts/schema/untp/0.6.1/dte.js.map +1 -0
- package/build/bundle/artefacts/schema/untp/0.7.0/cvc.d.ts +2 -0
- package/build/bundle/artefacts/schema/untp/0.7.0/cvc.js +704 -0
- package/build/bundle/artefacts/schema/untp/0.7.0/cvc.js.map +1 -0
- package/build/bundle/artefacts/schema/untp/0.7.0/dcc.d.ts +2 -0
- package/build/bundle/artefacts/schema/untp/0.7.0/dcc.js +1136 -0
- package/build/bundle/artefacts/schema/untp/0.7.0/dcc.js.map +1 -0
- package/build/bundle/artefacts/schema/untp/0.7.0/dfr.d.ts +2 -0
- package/build/bundle/artefacts/schema/untp/0.7.0/dfr.js +1248 -0
- package/build/bundle/artefacts/schema/untp/0.7.0/dfr.js.map +1 -0
- package/build/bundle/artefacts/schema/untp/0.7.0/dia.d.ts +2 -0
- package/build/bundle/artefacts/schema/untp/0.7.0/dia.js +446 -0
- package/build/bundle/artefacts/schema/untp/0.7.0/dia.js.map +1 -0
- package/build/bundle/artefacts/schema/untp/0.7.0/dpp.d.ts +2 -0
- package/build/bundle/artefacts/schema/untp/0.7.0/dpp.js +1303 -0
- package/build/bundle/artefacts/schema/untp/0.7.0/dpp.js.map +1 -0
- package/build/bundle/artefacts/schema/untp/0.7.0/dte.d.ts +2 -0
- package/build/bundle/artefacts/schema/untp/0.7.0/dte.js +1229 -0
- package/build/bundle/artefacts/schema/untp/0.7.0/dte.js.map +1 -0
- package/build/bundle/artefacts/schema/untp/0.7.0/linkset.d.ts +2 -0
- package/build/bundle/artefacts/schema/untp/0.7.0/linkset.js +122 -0
- package/build/bundle/artefacts/schema/untp/0.7.0/linkset.js.map +1 -0
- package/build/bundle/artefacts/schema/vcdm/2/verifiable-credential.d.ts +2 -0
- package/build/bundle/artefacts/schema/vcdm/2/verifiable-credential.js +321 -0
- package/build/bundle/artefacts/schema/vcdm/2/verifiable-credential.js.map +1 -0
- package/build/bundle/fallback.d.ts +41 -0
- package/build/bundle/fallback.js +62 -0
- package/build/bundle/fallback.js.map +1 -0
- package/build/bundle/fallback.test.d.ts +1 -0
- package/build/bundle/fallback.test.js +124 -0
- package/build/bundle/fallback.test.js.map +1 -0
- package/build/bundle/index.d.ts +4 -0
- package/build/bundle/index.js +77 -0
- package/build/bundle/index.js.map +1 -0
- package/build/bundle/lookup.d.ts +14 -0
- package/build/bundle/lookup.js +40 -0
- package/build/bundle/lookup.js.map +1 -0
- package/build/bundle/lookup.test.d.ts +1 -0
- package/build/bundle/lookup.test.js +70 -0
- package/build/bundle/lookup.test.js.map +1 -0
- package/build/bundle/public.d.ts +29 -0
- package/build/bundle/public.js +60 -0
- package/build/bundle/public.js.map +1 -0
- package/build/bundle/public.test.d.ts +1 -0
- package/build/bundle/public.test.js +41 -0
- package/build/bundle/public.test.js.map +1 -0
- package/build/bundle/refresh-classify.test.d.ts +1 -0
- package/build/bundle/refresh-classify.test.js +20 -0
- package/build/bundle/refresh-classify.test.js.map +1 -0
- package/build/bundle/refresh-main.test.d.ts +1 -0
- package/build/bundle/refresh-main.test.js +98 -0
- package/build/bundle/refresh-main.test.js.map +1 -0
- package/build/common/as-date-time.d.ts +13 -0
- package/build/common/as-date-time.js +44 -0
- package/build/common/as-date-time.js.map +1 -0
- package/build/common/as-date-time.test.d.ts +1 -0
- package/build/common/as-date-time.test.js +42 -0
- package/build/common/as-date-time.test.js.map +1 -0
- package/build/common/as-non-empty-string.d.ts +11 -4
- package/build/common/as-non-empty-string.js +15 -5
- package/build/common/as-non-empty-string.js.map +1 -1
- package/build/common/as-non-empty-string.test.js +7 -2
- package/build/common/as-non-empty-string.test.js.map +1 -1
- package/build/common/canonical-json.d.ts +10 -0
- package/build/common/canonical-json.js +29 -0
- package/build/common/canonical-json.js.map +1 -0
- package/build/common/canonical-json.test.d.ts +1 -0
- package/build/common/canonical-json.test.js +20 -0
- package/build/common/canonical-json.test.js.map +1 -0
- package/build/common/index.d.ts +5 -0
- package/build/common/index.js +6 -0
- package/build/common/index.js.map +1 -0
- package/build/common/validity-window.d.ts +45 -0
- package/build/common/validity-window.js +68 -0
- package/build/common/validity-window.js.map +1 -0
- package/build/common/validity-window.test.d.ts +1 -0
- package/build/common/validity-window.test.js +67 -0
- package/build/common/validity-window.test.js.map +1 -0
- package/build/conformity-vocabulary/codes.d.ts +4 -0
- package/build/conformity-vocabulary/codes.js +4 -0
- package/build/conformity-vocabulary/codes.js.map +1 -1
- package/build/conformity-vocabulary/parse-conformity-scheme.test.js +150 -0
- package/build/conformity-vocabulary/parse-conformity-scheme.test.js.map +1 -1
- package/build/conformity-vocabulary/parsers/v0-7-0.parser.js +225 -0
- package/build/conformity-vocabulary/parsers/v0-7-0.parser.js.map +1 -1
- package/build/conformity-vocabulary/types.d.ts +69 -15
- package/build/conformity-vocabulary/validate-conformity-claim.d.ts +17 -11
- package/build/conformity-vocabulary/validate-conformity-claim.js +118 -13
- package/build/conformity-vocabulary/validate-conformity-claim.js.map +1 -1
- package/build/conformity-vocabulary/validate-conformity-claim.test.js +265 -0
- package/build/conformity-vocabulary/validate-conformity-claim.test.js.map +1 -1
- package/build/loaders/index.d.ts +2 -0
- package/build/loaders/index.js +1 -0
- package/build/loaders/index.js.map +1 -1
- package/build/loaders/jsonld-document-loader.d.ts +7 -5
- package/build/loaders/jsonld-document-loader.js +11 -2
- package/build/loaders/jsonld-document-loader.js.map +1 -1
- package/build/loaders/jsonld-document-loader.test.js +41 -1
- package/build/loaders/jsonld-document-loader.test.js.map +1 -1
- package/build/loaders/schema-loader.d.ts +13 -3
- package/build/loaders/schema-loader.js +24 -8
- package/build/loaders/schema-loader.js.map +1 -1
- package/build/loaders/schema-loader.test.js +56 -1
- package/build/loaders/schema-loader.test.js.map +1 -1
- package/build/node/errors.d.ts +9 -3
- package/build/node/errors.js +9 -3
- package/build/node/errors.js.map +1 -1
- package/build/node/index.d.ts +1 -1
- package/build/node/index.js +1 -1
- package/build/node/index.js.map +1 -1
- package/build/node/is-private-ip.d.ts +8 -4
- package/build/node/is-private-ip.fail-closed.test.d.ts +1 -0
- package/build/node/is-private-ip.fail-closed.test.js +36 -0
- package/build/node/is-private-ip.fail-closed.test.js.map +1 -0
- package/build/node/is-private-ip.js +77 -12
- package/build/node/is-private-ip.js.map +1 -1
- package/build/node/is-private-ip.test.js +28 -0
- package/build/node/is-private-ip.test.js.map +1 -1
- package/build/node/validate-public-url.d.ts +43 -11
- package/build/node/validate-public-url.js +68 -34
- package/build/node/validate-public-url.js.map +1 -1
- package/build/node/validate-public-url.test.js +161 -14
- package/build/node/validate-public-url.test.js.map +1 -1
- package/build/resolvers/errors.d.ts +36 -6
- package/build/resolvers/errors.js +41 -7
- package/build/resolvers/errors.js.map +1 -1
- package/build/resolvers/resolve-document-if-changed.test.js +7 -0
- package/build/resolvers/resolve-document-if-changed.test.js.map +1 -1
- package/build/resolvers/resolve-document.d.ts +29 -9
- package/build/resolvers/resolve-document.integration.test.d.ts +1 -0
- package/build/resolvers/resolve-document.integration.test.js +108 -0
- package/build/resolvers/resolve-document.integration.test.js.map +1 -0
- package/build/resolvers/resolve-document.js +129 -49
- package/build/resolvers/resolve-document.js.map +1 -1
- package/build/resolvers/resolve-document.test.js +462 -12
- package/build/resolvers/resolve-document.test.js.map +1 -1
- package/build/resolvers/resolve-json-document.d.ts +11 -8
- package/build/resolvers/resolve-json-document.js +7 -6
- package/build/resolvers/resolve-json-document.js.map +1 -1
- package/build/resolvers/resolve-json-document.test.js +21 -4
- package/build/resolvers/resolve-json-document.test.js.map +1 -1
- package/build/validation/describe-jsonld-failure.d.ts +48 -8
- package/build/validation/describe-jsonld-failure.js +94 -27
- package/build/validation/describe-jsonld-failure.js.map +1 -1
- package/build/validation/describe-jsonld-failure.test.js +98 -13
- package/build/validation/describe-jsonld-failure.test.js.map +1 -1
- package/build/validation/index.d.ts +3 -2
- package/build/validation/index.js +2 -2
- package/build/validation/index.js.map +1 -1
- package/build/validation/validate-jsonld.d.ts +29 -3
- package/build/validation/validate-jsonld.js +49 -22
- package/build/validation/validate-jsonld.js.map +1 -1
- package/build/validation/validate-jsonld.test.js +62 -5
- package/build/validation/validate-jsonld.test.js.map +1 -1
- package/package.json +23 -3
|
@@ -0,0 +1,845 @@
|
|
|
1
|
+
{
|
|
2
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3
|
+
"type": "object",
|
|
4
|
+
"additionalProperties": true,
|
|
5
|
+
"properties": {
|
|
6
|
+
"type": {
|
|
7
|
+
"type": "array",
|
|
8
|
+
"readOnly": true,
|
|
9
|
+
"default": ["DigitalTraceabilityEvent", "VerifiableCredential"],
|
|
10
|
+
"items": {
|
|
11
|
+
"type": "string"
|
|
12
|
+
},
|
|
13
|
+
"allOf": [
|
|
14
|
+
{
|
|
15
|
+
"contains": {
|
|
16
|
+
"const": "DigitalTraceabilityEvent",
|
|
17
|
+
"minContains": 1
|
|
18
|
+
}
|
|
19
|
+
},
|
|
20
|
+
{
|
|
21
|
+
"contains": {
|
|
22
|
+
"const": "VerifiableCredential",
|
|
23
|
+
"minContains": 1
|
|
24
|
+
}
|
|
25
|
+
}
|
|
26
|
+
]
|
|
27
|
+
},
|
|
28
|
+
"id": {
|
|
29
|
+
"example": "https://example-company.com/credentials/2a423366-a0d6-4855-ba65-2e0c926d09b0",
|
|
30
|
+
"type": "string",
|
|
31
|
+
"format": "uri",
|
|
32
|
+
"description": "A unique identifier (URI) assigned to the product passport. May be a UUID"
|
|
33
|
+
},
|
|
34
|
+
"@context": {
|
|
35
|
+
"example": ["https://www.w3.org/ns/credentials/v2", "https://test.uncefact.org/vocabulary/untp/dte/0.6.1/"],
|
|
36
|
+
"type": "array",
|
|
37
|
+
"items": {
|
|
38
|
+
"type": "string"
|
|
39
|
+
},
|
|
40
|
+
"description": "A list of JSON-LD context URIs that define the semantic meaning of properties within the credential. ",
|
|
41
|
+
"readOnly": true,
|
|
42
|
+
"prefixItems": [
|
|
43
|
+
{
|
|
44
|
+
"const": "https://www.w3.org/ns/credentials/v2",
|
|
45
|
+
"type": "string"
|
|
46
|
+
},
|
|
47
|
+
{
|
|
48
|
+
"const": "https://test.uncefact.org/vocabulary/untp/dte/0.6.1/",
|
|
49
|
+
"type": "string"
|
|
50
|
+
}
|
|
51
|
+
],
|
|
52
|
+
"default": ["https://www.w3.org/ns/credentials/v2", "https://test.uncefact.org/vocabulary/untp/dte/0.6.1/"],
|
|
53
|
+
"minItems": 2,
|
|
54
|
+
"uniqueItems": true
|
|
55
|
+
},
|
|
56
|
+
"issuer": {
|
|
57
|
+
"$ref": "#/$defs/CredentialIssuer",
|
|
58
|
+
"description": "The organisation that is the issuer of this VC. Note that the \"id\" property MUST be a W3C DID. Other identifiers such as tax registration numbers can be listed in the \"otherIdentifiers\" property."
|
|
59
|
+
},
|
|
60
|
+
"validFrom": {
|
|
61
|
+
"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))$",
|
|
62
|
+
"example": "2024-03-15T12:00:00Z",
|
|
63
|
+
"type": "string",
|
|
64
|
+
"format": "date-time",
|
|
65
|
+
"description": "The date and time from which the credential is valid."
|
|
66
|
+
},
|
|
67
|
+
"credentialSubject": {
|
|
68
|
+
"type": "array",
|
|
69
|
+
"items": {
|
|
70
|
+
"$ref": "#/$defs/Event"
|
|
71
|
+
},
|
|
72
|
+
"description": "VC subject is the transaction event structure"
|
|
73
|
+
}
|
|
74
|
+
},
|
|
75
|
+
"description": "An array of Traceability Events as a VC",
|
|
76
|
+
"required": ["id", "@context", "issuer"],
|
|
77
|
+
"$defs": {
|
|
78
|
+
"CredentialIssuer": {
|
|
79
|
+
"type": "object",
|
|
80
|
+
"additionalProperties": false,
|
|
81
|
+
"properties": {
|
|
82
|
+
"type": {
|
|
83
|
+
"type": "array",
|
|
84
|
+
"readOnly": true,
|
|
85
|
+
"default": ["CredentialIssuer"],
|
|
86
|
+
"items": {
|
|
87
|
+
"type": "string"
|
|
88
|
+
},
|
|
89
|
+
"allOf": [
|
|
90
|
+
{
|
|
91
|
+
"contains": {
|
|
92
|
+
"const": "CredentialIssuer",
|
|
93
|
+
"minContains": 1
|
|
94
|
+
}
|
|
95
|
+
}
|
|
96
|
+
]
|
|
97
|
+
},
|
|
98
|
+
"id": {
|
|
99
|
+
"example": "did:web:identifiers.example-company.com:12345",
|
|
100
|
+
"type": "string",
|
|
101
|
+
"format": "uri",
|
|
102
|
+
"description": "The W3C DID of the issuer - should be a did:web or did:webvh"
|
|
103
|
+
},
|
|
104
|
+
"name": {
|
|
105
|
+
"example": "Example Company Pty Ltd",
|
|
106
|
+
"type": "string",
|
|
107
|
+
"description": "The name of the issuer person or organisation"
|
|
108
|
+
},
|
|
109
|
+
"issuerAlsoKnownAs": {
|
|
110
|
+
"type": "array",
|
|
111
|
+
"items": {
|
|
112
|
+
"type": "object",
|
|
113
|
+
"properties": {
|
|
114
|
+
"id": {
|
|
115
|
+
"example": "https://abr.business.gov.au/ABN/View?abn=90664869327",
|
|
116
|
+
"type": "string",
|
|
117
|
+
"format": "uri",
|
|
118
|
+
"description": "The globally unique ID of the party as a URI, ideally as a resolvable ID. "
|
|
119
|
+
},
|
|
120
|
+
"name": {
|
|
121
|
+
"example": "Sample Company Pty Ltd.",
|
|
122
|
+
"type": "string",
|
|
123
|
+
"description": "The registered name of the party within the identifier scheme."
|
|
124
|
+
},
|
|
125
|
+
"registeredId": {
|
|
126
|
+
"example": 90664869327,
|
|
127
|
+
"type": "string",
|
|
128
|
+
"description": "The registration number (alphanumeric) of the Party within the register. Unique within the register."
|
|
129
|
+
}
|
|
130
|
+
},
|
|
131
|
+
"required": ["id", "name"]
|
|
132
|
+
},
|
|
133
|
+
"description": "An optional list of other registered identifiers for this credential issuer "
|
|
134
|
+
}
|
|
135
|
+
},
|
|
136
|
+
"description": "The issuer party (person or organisation) of a verifiable credential.",
|
|
137
|
+
"required": ["id", "name"]
|
|
138
|
+
},
|
|
139
|
+
"TransformationEvent": {
|
|
140
|
+
"type": "object",
|
|
141
|
+
"additionalProperties": true,
|
|
142
|
+
"properties": {
|
|
143
|
+
"type": {
|
|
144
|
+
"type": "array",
|
|
145
|
+
"readOnly": true,
|
|
146
|
+
"default": ["TransformationEvent", "Event"],
|
|
147
|
+
"items": {
|
|
148
|
+
"type": "string"
|
|
149
|
+
},
|
|
150
|
+
"allOf": [
|
|
151
|
+
{
|
|
152
|
+
"contains": {
|
|
153
|
+
"const": "TransformationEvent",
|
|
154
|
+
"minContains": 1
|
|
155
|
+
}
|
|
156
|
+
},
|
|
157
|
+
{
|
|
158
|
+
"contains": {
|
|
159
|
+
"const": "Event",
|
|
160
|
+
"minContains": 1
|
|
161
|
+
}
|
|
162
|
+
}
|
|
163
|
+
]
|
|
164
|
+
},
|
|
165
|
+
"id": {
|
|
166
|
+
"readOnly": true,
|
|
167
|
+
"example": "https://events.sample.com/b681df10-c682-454a-b11b-d0b9374c01bd",
|
|
168
|
+
"type": "string",
|
|
169
|
+
"format": "uri",
|
|
170
|
+
"description": "The unique identifier of this event - SHOULD be a UUID"
|
|
171
|
+
},
|
|
172
|
+
"processType": {
|
|
173
|
+
"example": "Weaving",
|
|
174
|
+
"type": "string",
|
|
175
|
+
"description": "A human readable name for industry specific process represented by this event."
|
|
176
|
+
},
|
|
177
|
+
"eventTime": {
|
|
178
|
+
"example": "2024-09-01T12:00:00Z",
|
|
179
|
+
"type": "string",
|
|
180
|
+
"format": "date-time",
|
|
181
|
+
"description": "The ISO-8601 date time when the event occurred."
|
|
182
|
+
},
|
|
183
|
+
"action": {
|
|
184
|
+
"type": "string",
|
|
185
|
+
"enum": ["observe", "add", "delete"],
|
|
186
|
+
"example": "observe",
|
|
187
|
+
"description": "Code describing how an event relates to the life-cycle of the entity impacted by the event."
|
|
188
|
+
},
|
|
189
|
+
"disposition": {
|
|
190
|
+
"type": "string",
|
|
191
|
+
"x-external-enumeration": "https://ref.gs1.org/cbv/Disp-",
|
|
192
|
+
"description": "Disposition code describing the state of the item after the event. \n\n This is an enumerated value, but the list of valid values are too big, or change too often to include here. You can access the list of allowable values at this URL: https://ref.gs1.org/cbv/Disp-\n "
|
|
193
|
+
},
|
|
194
|
+
"bizStep": {
|
|
195
|
+
"type": "string",
|
|
196
|
+
"x-external-enumeration": "https://ref.gs1.org/cbv/BizStep-",
|
|
197
|
+
"description": "A business step code drawn from a controlled vocabulary.\n\n This is an enumerated value, but the list of valid values are too big, or change too often to include here. You can access the list of allowable values at this URL: https://ref.gs1.org/cbv/BizStep-\n "
|
|
198
|
+
},
|
|
199
|
+
"bizLocation": {
|
|
200
|
+
"example": "https://id.gs1.org/414/9520123456788",
|
|
201
|
+
"type": "string",
|
|
202
|
+
"format": "uri",
|
|
203
|
+
"description": "A Business Location is a uniquely identified and discretely recorded geospatial location that is meant to designate the specific place where an object is assumed to be following an event until it is reported to be at a different Business Location by a subsequent event. The bizLocation must be a resolvable URI that links to facility information and geo-location data."
|
|
204
|
+
},
|
|
205
|
+
"sensorElementList": {
|
|
206
|
+
"type": "array",
|
|
207
|
+
"items": {
|
|
208
|
+
"$ref": "#/$defs/SensorElement"
|
|
209
|
+
},
|
|
210
|
+
"description": "An array (one for each sensor) of sensor device data sets associated with the event. "
|
|
211
|
+
},
|
|
212
|
+
"outputEPCList": {
|
|
213
|
+
"type": "array",
|
|
214
|
+
"items": {
|
|
215
|
+
"$ref": "#/$defs/Item"
|
|
216
|
+
},
|
|
217
|
+
"description": "The list of uniquely identified items that are the output of this transformation event - for example a list of individually identified bolts of cloth that are the output of a weaving process."
|
|
218
|
+
},
|
|
219
|
+
"inputEPCList": {
|
|
220
|
+
"type": "array",
|
|
221
|
+
"items": {
|
|
222
|
+
"$ref": "#/$defs/Item"
|
|
223
|
+
},
|
|
224
|
+
"description": "The list of uniquely identified items that are the input of this transformation event - for example a list of individually identified bobbins of yarn that are the input of a weaving process."
|
|
225
|
+
},
|
|
226
|
+
"inputQuantityList": {
|
|
227
|
+
"type": "array",
|
|
228
|
+
"items": {
|
|
229
|
+
"$ref": "#/$defs/QuantityElement"
|
|
230
|
+
},
|
|
231
|
+
"description": "The quantified list of product classes that are the input of this transformation event - used when each item does not have a unique identity. for example the weight of raw cotton that is the input to a ginning process."
|
|
232
|
+
},
|
|
233
|
+
"outputQuantityList": {
|
|
234
|
+
"type": "array",
|
|
235
|
+
"items": {
|
|
236
|
+
"$ref": "#/$defs/QuantityElement"
|
|
237
|
+
},
|
|
238
|
+
"description": "The quantified list of product classes that are the output of this transformation event - used when each item does not have a unique identity. for example a count of the bales of cleaned cotton that are the output of a ginning process."
|
|
239
|
+
}
|
|
240
|
+
},
|
|
241
|
+
"description": "Transformation represents an event in which input objects are fully or partially consumed and output objects are produced, such that any of the input objects may have contributed to all of the output objects - for example consuming bales of cotton to produce yarn."
|
|
242
|
+
},
|
|
243
|
+
"SensorElement": {
|
|
244
|
+
"type": "object",
|
|
245
|
+
"additionalProperties": false,
|
|
246
|
+
"properties": {
|
|
247
|
+
"type": {
|
|
248
|
+
"type": "array",
|
|
249
|
+
"readOnly": true,
|
|
250
|
+
"default": ["SensorElement"],
|
|
251
|
+
"items": {
|
|
252
|
+
"type": "string"
|
|
253
|
+
},
|
|
254
|
+
"allOf": [
|
|
255
|
+
{
|
|
256
|
+
"contains": {
|
|
257
|
+
"const": "SensorElement",
|
|
258
|
+
"minContains": 1
|
|
259
|
+
}
|
|
260
|
+
}
|
|
261
|
+
]
|
|
262
|
+
},
|
|
263
|
+
"sensorMetadata": {
|
|
264
|
+
"$ref": "#/$defs/Sensor",
|
|
265
|
+
"description": "Data that describes the physical sensor that recorded the sensor data set."
|
|
266
|
+
},
|
|
267
|
+
"sensorReport": {
|
|
268
|
+
"type": "array",
|
|
269
|
+
"items": {
|
|
270
|
+
"$ref": "#/$defs/SensorData"
|
|
271
|
+
},
|
|
272
|
+
"description": "A list of sensor readings from the given sensor relevant to the traceability event context."
|
|
273
|
+
},
|
|
274
|
+
"sensorIntegrityProof": {
|
|
275
|
+
"type": "string",
|
|
276
|
+
"format": "uri",
|
|
277
|
+
"description": "An optional reference to a verifiable credential signed by the sensor device or device manufacturer that contains the digitally signed raw data associated with this sensor report."
|
|
278
|
+
}
|
|
279
|
+
},
|
|
280
|
+
"description": "A SensorElement is used to carry data related to an event that is captured one sensor such as an IoT device. Include one sensor property and an array of sensor data values."
|
|
281
|
+
},
|
|
282
|
+
"Sensor": {
|
|
283
|
+
"type": "object",
|
|
284
|
+
"additionalProperties": false,
|
|
285
|
+
"properties": {
|
|
286
|
+
"type": {
|
|
287
|
+
"type": "array",
|
|
288
|
+
"readOnly": true,
|
|
289
|
+
"default": ["Sensor"],
|
|
290
|
+
"items": {
|
|
291
|
+
"type": "string"
|
|
292
|
+
},
|
|
293
|
+
"allOf": [
|
|
294
|
+
{
|
|
295
|
+
"contains": {
|
|
296
|
+
"const": "Sensor",
|
|
297
|
+
"minContains": 1
|
|
298
|
+
}
|
|
299
|
+
}
|
|
300
|
+
]
|
|
301
|
+
},
|
|
302
|
+
"device": {
|
|
303
|
+
"$ref": "#/$defs/Item",
|
|
304
|
+
"description": "The device Identifier for the sensor as a URI (typically an EPC)"
|
|
305
|
+
},
|
|
306
|
+
"dataProcessingMethod": {
|
|
307
|
+
"example": "https://standards.org/sensorMethod#1234",
|
|
308
|
+
"type": "string",
|
|
309
|
+
"format": "uri",
|
|
310
|
+
"description": "The data processing method used by the sensor - should reference a documented standard criteria as a URI"
|
|
311
|
+
}
|
|
312
|
+
},
|
|
313
|
+
"description": "A physical sensor that records a sensor data set."
|
|
314
|
+
},
|
|
315
|
+
"Item": {
|
|
316
|
+
"type": "object",
|
|
317
|
+
"additionalProperties": false,
|
|
318
|
+
"properties": {
|
|
319
|
+
"type": {
|
|
320
|
+
"type": "array",
|
|
321
|
+
"readOnly": true,
|
|
322
|
+
"default": ["Item"],
|
|
323
|
+
"items": {
|
|
324
|
+
"type": "string"
|
|
325
|
+
},
|
|
326
|
+
"allOf": [
|
|
327
|
+
{
|
|
328
|
+
"contains": {
|
|
329
|
+
"const": "Item",
|
|
330
|
+
"minContains": 1
|
|
331
|
+
}
|
|
332
|
+
}
|
|
333
|
+
]
|
|
334
|
+
},
|
|
335
|
+
"id": {
|
|
336
|
+
"example": "https://id.gs1.org/01/09520123456788/21/12345",
|
|
337
|
+
"type": "string",
|
|
338
|
+
"format": "uri",
|
|
339
|
+
"description": "The globally unique ID of the product as a URI. Ideally as a resolvable URL according to ISO 18975. "
|
|
340
|
+
},
|
|
341
|
+
"name": {
|
|
342
|
+
"example": "EV battery 300Ah.",
|
|
343
|
+
"type": "string",
|
|
344
|
+
"description": "The name of the product class to which the product item belongs. "
|
|
345
|
+
}
|
|
346
|
+
},
|
|
347
|
+
"description": "A specific serialised trade item which is an instance of a more generic product. ",
|
|
348
|
+
"required": ["id", "name"]
|
|
349
|
+
},
|
|
350
|
+
"SensorData": {
|
|
351
|
+
"type": "object",
|
|
352
|
+
"additionalProperties": false,
|
|
353
|
+
"properties": {
|
|
354
|
+
"type": {
|
|
355
|
+
"type": "array",
|
|
356
|
+
"readOnly": true,
|
|
357
|
+
"default": ["SensorData"],
|
|
358
|
+
"items": {
|
|
359
|
+
"type": "string"
|
|
360
|
+
},
|
|
361
|
+
"allOf": [
|
|
362
|
+
{
|
|
363
|
+
"contains": {
|
|
364
|
+
"const": "SensorData",
|
|
365
|
+
"minContains": 1
|
|
366
|
+
}
|
|
367
|
+
}
|
|
368
|
+
]
|
|
369
|
+
},
|
|
370
|
+
"time": {
|
|
371
|
+
"example": "2024-07-24T12:00:00Z",
|
|
372
|
+
"type": "string",
|
|
373
|
+
"format": "date-time",
|
|
374
|
+
"description": "the timestamp at which the sensor reading was made."
|
|
375
|
+
},
|
|
376
|
+
"sensorType": {
|
|
377
|
+
"example": "https://samplesensors.com/model1234",
|
|
378
|
+
"type": "string",
|
|
379
|
+
"format": "uri",
|
|
380
|
+
"description": "the measurement type of the sensor reading, as a URI reference to a measurement method specification."
|
|
381
|
+
},
|
|
382
|
+
"value": {
|
|
383
|
+
"example": 25,
|
|
384
|
+
"type": "number",
|
|
385
|
+
"description": "the sensor reading"
|
|
386
|
+
},
|
|
387
|
+
"uom": {
|
|
388
|
+
"type": "string",
|
|
389
|
+
"x-external-enumeration": "https://vocabulary.uncefact.org/UnitMeasureCode#",
|
|
390
|
+
"description": "the unit of measure for the sensor reading, drawn from UNECE rec20 code list.\n\n This is an enumerated value, but the list of valid values are too big, or change too often to include here. You can access the list of allowable values at this URL: https://vocabulary.uncefact.org/UnitMeasureCode#\n "
|
|
391
|
+
}
|
|
392
|
+
},
|
|
393
|
+
"description": "A data point read by a sensor."
|
|
394
|
+
},
|
|
395
|
+
"QuantityElement": {
|
|
396
|
+
"type": "object",
|
|
397
|
+
"additionalProperties": false,
|
|
398
|
+
"properties": {
|
|
399
|
+
"type": {
|
|
400
|
+
"type": "array",
|
|
401
|
+
"readOnly": true,
|
|
402
|
+
"default": ["QuantityElement"],
|
|
403
|
+
"items": {
|
|
404
|
+
"type": "string"
|
|
405
|
+
},
|
|
406
|
+
"allOf": [
|
|
407
|
+
{
|
|
408
|
+
"contains": {
|
|
409
|
+
"const": "QuantityElement",
|
|
410
|
+
"minContains": 1
|
|
411
|
+
}
|
|
412
|
+
}
|
|
413
|
+
]
|
|
414
|
+
},
|
|
415
|
+
"productId": {
|
|
416
|
+
"example": "https://id.gs1.org/01/09520123456788/21/12345",
|
|
417
|
+
"type": "string",
|
|
418
|
+
"format": "uri",
|
|
419
|
+
"description": "THe identifier of a product class (as opposed to a product instance) such as a GTIN code for a manufactured product."
|
|
420
|
+
},
|
|
421
|
+
"productName": {
|
|
422
|
+
"example": "EV battery 300Ah.",
|
|
423
|
+
"type": "string",
|
|
424
|
+
"description": "The registered name of the product within the identifier scheme. "
|
|
425
|
+
},
|
|
426
|
+
"quantity": {
|
|
427
|
+
"example": 20,
|
|
428
|
+
"type": "number",
|
|
429
|
+
"description": "The numeric quantity of the product class (eg 100 kg of cotton)"
|
|
430
|
+
},
|
|
431
|
+
"uom": {
|
|
432
|
+
"type": "string",
|
|
433
|
+
"x-external-enumeration": "https://vocabulary.uncefact.org/UnitMeasureCode#",
|
|
434
|
+
"description": "The unit of measure for the quantity value (eg Kg or meters etc) using the UNECE Rec 20 unit of measure codelist.\n\n This is an enumerated value, but the list of valid values are too big, or change too often to include here. You can access the list of allowable values at this URL: https://vocabulary.uncefact.org/UnitMeasureCode#\n "
|
|
435
|
+
}
|
|
436
|
+
},
|
|
437
|
+
"description": "The quantity element is used to define the quantity (eg 100 kg of a product class. Used when serialised items are not applicable.",
|
|
438
|
+
"required": ["productId", "productName", "quantity"]
|
|
439
|
+
},
|
|
440
|
+
"ObjectEvent": {
|
|
441
|
+
"type": "object",
|
|
442
|
+
"additionalProperties": true,
|
|
443
|
+
"properties": {
|
|
444
|
+
"type": {
|
|
445
|
+
"type": "array",
|
|
446
|
+
"readOnly": true,
|
|
447
|
+
"default": ["ObjectEvent", "Event"],
|
|
448
|
+
"items": {
|
|
449
|
+
"type": "string"
|
|
450
|
+
},
|
|
451
|
+
"allOf": [
|
|
452
|
+
{
|
|
453
|
+
"contains": {
|
|
454
|
+
"const": "ObjectEvent",
|
|
455
|
+
"minContains": 1
|
|
456
|
+
}
|
|
457
|
+
},
|
|
458
|
+
{
|
|
459
|
+
"contains": {
|
|
460
|
+
"const": "Event",
|
|
461
|
+
"minContains": 1
|
|
462
|
+
}
|
|
463
|
+
}
|
|
464
|
+
]
|
|
465
|
+
},
|
|
466
|
+
"id": {
|
|
467
|
+
"readOnly": true,
|
|
468
|
+
"example": "https://events.sample.com/b681df10-c682-454a-b11b-d0b9374c01bd",
|
|
469
|
+
"type": "string",
|
|
470
|
+
"format": "uri",
|
|
471
|
+
"description": "The unique identifier of this event - SHOULD be a UUID"
|
|
472
|
+
},
|
|
473
|
+
"processType": {
|
|
474
|
+
"example": "Weaving",
|
|
475
|
+
"type": "string",
|
|
476
|
+
"description": "A human readable name for industry specific process represented by this event."
|
|
477
|
+
},
|
|
478
|
+
"eventTime": {
|
|
479
|
+
"example": "2024-09-01T12:00:00Z",
|
|
480
|
+
"type": "string",
|
|
481
|
+
"format": "date-time",
|
|
482
|
+
"description": "The ISO-8601 date time when the event occurred."
|
|
483
|
+
},
|
|
484
|
+
"action": {
|
|
485
|
+
"type": "string",
|
|
486
|
+
"enum": ["observe", "add", "delete"],
|
|
487
|
+
"example": "observe",
|
|
488
|
+
"description": "Code describing how an event relates to the life-cycle of the entity impacted by the event."
|
|
489
|
+
},
|
|
490
|
+
"disposition": {
|
|
491
|
+
"type": "string",
|
|
492
|
+
"x-external-enumeration": "https://ref.gs1.org/cbv/Disp-",
|
|
493
|
+
"description": "Disposition code describing the state of the item after the event. \n\n This is an enumerated value, but the list of valid values are too big, or change too often to include here. You can access the list of allowable values at this URL: https://ref.gs1.org/cbv/Disp-\n "
|
|
494
|
+
},
|
|
495
|
+
"bizStep": {
|
|
496
|
+
"type": "string",
|
|
497
|
+
"x-external-enumeration": "https://ref.gs1.org/cbv/BizStep-",
|
|
498
|
+
"description": "A business step code drawn from a controlled vocabulary.\n\n This is an enumerated value, but the list of valid values are too big, or change too often to include here. You can access the list of allowable values at this URL: https://ref.gs1.org/cbv/BizStep-\n "
|
|
499
|
+
},
|
|
500
|
+
"bizLocation": {
|
|
501
|
+
"example": "https://id.gs1.org/414/9520123456788",
|
|
502
|
+
"type": "string",
|
|
503
|
+
"format": "uri",
|
|
504
|
+
"description": "A Business Location is a uniquely identified and discretely recorded geospatial location that is meant to designate the specific place where an object is assumed to be following an event until it is reported to be at a different Business Location by a subsequent event. The bizLocation must be a resolvable URI that links to facility information and geo-location data."
|
|
505
|
+
},
|
|
506
|
+
"sensorElementList": {
|
|
507
|
+
"type": "array",
|
|
508
|
+
"items": {
|
|
509
|
+
"$ref": "#/$defs/SensorElement"
|
|
510
|
+
},
|
|
511
|
+
"description": "An array (one for each sensor) of sensor device data sets associated with the event. "
|
|
512
|
+
},
|
|
513
|
+
"epcList": {
|
|
514
|
+
"type": "array",
|
|
515
|
+
"items": {
|
|
516
|
+
"$ref": "#/$defs/Item"
|
|
517
|
+
},
|
|
518
|
+
"description": "A list of uniquely identified items (eg specific items serial numbers or tagged shipments / packages) that are the focus of this object event. "
|
|
519
|
+
},
|
|
520
|
+
"quantityList": {
|
|
521
|
+
"type": "array",
|
|
522
|
+
"items": {
|
|
523
|
+
"$ref": "#/$defs/QuantityElement"
|
|
524
|
+
},
|
|
525
|
+
"description": "A quantified list of product classes (eg GS1 GTINs) that are the focus of this object event"
|
|
526
|
+
}
|
|
527
|
+
},
|
|
528
|
+
"description": "Object represents an event that happened to one or more physical or digital objects - such as an inspection or certification of a product or shipment. The physical objects may be identified either as specific items (eg a unique consignment number) or as a quantified amount of a product class (eg 100Kg of cotton yarn)"
|
|
529
|
+
},
|
|
530
|
+
"AggregationEvent": {
|
|
531
|
+
"type": "object",
|
|
532
|
+
"additionalProperties": true,
|
|
533
|
+
"properties": {
|
|
534
|
+
"type": {
|
|
535
|
+
"type": "array",
|
|
536
|
+
"readOnly": true,
|
|
537
|
+
"default": ["AggregationEvent", "Event"],
|
|
538
|
+
"items": {
|
|
539
|
+
"type": "string"
|
|
540
|
+
},
|
|
541
|
+
"allOf": [
|
|
542
|
+
{
|
|
543
|
+
"contains": {
|
|
544
|
+
"const": "AggregationEvent",
|
|
545
|
+
"minContains": 1
|
|
546
|
+
}
|
|
547
|
+
},
|
|
548
|
+
{
|
|
549
|
+
"contains": {
|
|
550
|
+
"const": "Event",
|
|
551
|
+
"minContains": 1
|
|
552
|
+
}
|
|
553
|
+
}
|
|
554
|
+
]
|
|
555
|
+
},
|
|
556
|
+
"id": {
|
|
557
|
+
"readOnly": true,
|
|
558
|
+
"example": "https://events.sample.com/b681df10-c682-454a-b11b-d0b9374c01bd",
|
|
559
|
+
"type": "string",
|
|
560
|
+
"format": "uri",
|
|
561
|
+
"description": "The unique identifier of this event - SHOULD be a UUID"
|
|
562
|
+
},
|
|
563
|
+
"processType": {
|
|
564
|
+
"example": "Weaving",
|
|
565
|
+
"type": "string",
|
|
566
|
+
"description": "A human readable name for industry specific process represented by this event."
|
|
567
|
+
},
|
|
568
|
+
"eventTime": {
|
|
569
|
+
"example": "2024-09-01T12:00:00Z",
|
|
570
|
+
"type": "string",
|
|
571
|
+
"format": "date-time",
|
|
572
|
+
"description": "The ISO-8601 date time when the event occurred."
|
|
573
|
+
},
|
|
574
|
+
"action": {
|
|
575
|
+
"type": "string",
|
|
576
|
+
"enum": ["observe", "add", "delete"],
|
|
577
|
+
"example": "observe",
|
|
578
|
+
"description": "Code describing how an event relates to the life-cycle of the entity impacted by the event."
|
|
579
|
+
},
|
|
580
|
+
"disposition": {
|
|
581
|
+
"type": "string",
|
|
582
|
+
"x-external-enumeration": "https://ref.gs1.org/cbv/Disp-",
|
|
583
|
+
"description": "Disposition code describing the state of the item after the event. \n\n This is an enumerated value, but the list of valid values are too big, or change too often to include here. You can access the list of allowable values at this URL: https://ref.gs1.org/cbv/Disp-\n "
|
|
584
|
+
},
|
|
585
|
+
"bizStep": {
|
|
586
|
+
"type": "string",
|
|
587
|
+
"x-external-enumeration": "https://ref.gs1.org/cbv/BizStep-",
|
|
588
|
+
"description": "A business step code drawn from a controlled vocabulary.\n\n This is an enumerated value, but the list of valid values are too big, or change too often to include here. You can access the list of allowable values at this URL: https://ref.gs1.org/cbv/BizStep-\n "
|
|
589
|
+
},
|
|
590
|
+
"bizLocation": {
|
|
591
|
+
"example": "https://id.gs1.org/414/9520123456788",
|
|
592
|
+
"type": "string",
|
|
593
|
+
"format": "uri",
|
|
594
|
+
"description": "A Business Location is a uniquely identified and discretely recorded geospatial location that is meant to designate the specific place where an object is assumed to be following an event until it is reported to be at a different Business Location by a subsequent event. The bizLocation must be a resolvable URI that links to facility information and geo-location data."
|
|
595
|
+
},
|
|
596
|
+
"sensorElementList": {
|
|
597
|
+
"type": "array",
|
|
598
|
+
"items": {
|
|
599
|
+
"$ref": "#/$defs/SensorElement"
|
|
600
|
+
},
|
|
601
|
+
"description": "An array (one for each sensor) of sensor device data sets associated with the event. "
|
|
602
|
+
},
|
|
603
|
+
"parentEPC": {
|
|
604
|
+
"$ref": "#/$defs/Item",
|
|
605
|
+
"description": "The unique item identifier that is the result of this aggregation. Typically a packaging ID used in shipments that represents a box/ pallet / container of contained items."
|
|
606
|
+
},
|
|
607
|
+
"childEPCList": {
|
|
608
|
+
"type": "array",
|
|
609
|
+
"items": {
|
|
610
|
+
"$ref": "#/$defs/Item"
|
|
611
|
+
},
|
|
612
|
+
"description": "The list of child items that have been aggregated into the parent (or dis-aggregated from the parent). Maybe a list of package references (eg boxes on a pallet) or may be individual items (eg products in a box)."
|
|
613
|
+
},
|
|
614
|
+
"childQuantityList": {
|
|
615
|
+
"type": "array",
|
|
616
|
+
"items": {
|
|
617
|
+
"$ref": "#/$defs/QuantityElement"
|
|
618
|
+
},
|
|
619
|
+
"description": "List of quantified product classes that have been aggregated into the parent. Used when the child items do not have unique identifiers (eg 100 Kg of cotton bales)"
|
|
620
|
+
}
|
|
621
|
+
},
|
|
622
|
+
"description": "Aggregation represents an event that happened to one or more objects that are physically aggregated together (physically constrained to be in the same place at the same time, as when cases are aggregated to a pallet). This event is also used to represent de-aggregation (eg unpacking) when businessStepCode is unpacking."
|
|
623
|
+
},
|
|
624
|
+
"TransactionEvent": {
|
|
625
|
+
"type": "object",
|
|
626
|
+
"additionalProperties": true,
|
|
627
|
+
"properties": {
|
|
628
|
+
"type": {
|
|
629
|
+
"type": "array",
|
|
630
|
+
"readOnly": true,
|
|
631
|
+
"default": ["TransactionEvent", "Event"],
|
|
632
|
+
"items": {
|
|
633
|
+
"type": "string"
|
|
634
|
+
},
|
|
635
|
+
"allOf": [
|
|
636
|
+
{
|
|
637
|
+
"contains": {
|
|
638
|
+
"const": "TransactionEvent",
|
|
639
|
+
"minContains": 1
|
|
640
|
+
}
|
|
641
|
+
},
|
|
642
|
+
{
|
|
643
|
+
"contains": {
|
|
644
|
+
"const": "Event",
|
|
645
|
+
"minContains": 1
|
|
646
|
+
}
|
|
647
|
+
}
|
|
648
|
+
]
|
|
649
|
+
},
|
|
650
|
+
"id": {
|
|
651
|
+
"readOnly": true,
|
|
652
|
+
"example": "https://events.sample.com/b681df10-c682-454a-b11b-d0b9374c01bd",
|
|
653
|
+
"type": "string",
|
|
654
|
+
"format": "uri",
|
|
655
|
+
"description": "The unique identifier of this event - SHOULD be a UUID"
|
|
656
|
+
},
|
|
657
|
+
"processType": {
|
|
658
|
+
"example": "Weaving",
|
|
659
|
+
"type": "string",
|
|
660
|
+
"description": "A human readable name for industry specific process represented by this event."
|
|
661
|
+
},
|
|
662
|
+
"eventTime": {
|
|
663
|
+
"example": "2024-09-01T12:00:00Z",
|
|
664
|
+
"type": "string",
|
|
665
|
+
"format": "date-time",
|
|
666
|
+
"description": "The ISO-8601 date time when the event occurred."
|
|
667
|
+
},
|
|
668
|
+
"action": {
|
|
669
|
+
"type": "string",
|
|
670
|
+
"enum": ["observe", "add", "delete"],
|
|
671
|
+
"example": "observe",
|
|
672
|
+
"description": "Code describing how an event relates to the life-cycle of the entity impacted by the event."
|
|
673
|
+
},
|
|
674
|
+
"disposition": {
|
|
675
|
+
"type": "string",
|
|
676
|
+
"x-external-enumeration": "https://ref.gs1.org/cbv/Disp-",
|
|
677
|
+
"description": "Disposition code describing the state of the item after the event. \n\n This is an enumerated value, but the list of valid values are too big, or change too often to include here. You can access the list of allowable values at this URL: https://ref.gs1.org/cbv/Disp-\n "
|
|
678
|
+
},
|
|
679
|
+
"bizStep": {
|
|
680
|
+
"type": "string",
|
|
681
|
+
"x-external-enumeration": "https://ref.gs1.org/cbv/BizStep-",
|
|
682
|
+
"description": "A business step code drawn from a controlled vocabulary.\n\n This is an enumerated value, but the list of valid values are too big, or change too often to include here. You can access the list of allowable values at this URL: https://ref.gs1.org/cbv/BizStep-\n "
|
|
683
|
+
},
|
|
684
|
+
"bizLocation": {
|
|
685
|
+
"example": "https://id.gs1.org/414/9520123456788",
|
|
686
|
+
"type": "string",
|
|
687
|
+
"format": "uri",
|
|
688
|
+
"description": "A Business Location is a uniquely identified and discretely recorded geospatial location that is meant to designate the specific place where an object is assumed to be following an event until it is reported to be at a different Business Location by a subsequent event. The bizLocation must be a resolvable URI that links to facility information and geo-location data."
|
|
689
|
+
},
|
|
690
|
+
"sensorElementList": {
|
|
691
|
+
"type": "array",
|
|
692
|
+
"items": {
|
|
693
|
+
"$ref": "#/$defs/SensorElement"
|
|
694
|
+
},
|
|
695
|
+
"description": "An array (one for each sensor) of sensor device data sets associated with the event. "
|
|
696
|
+
},
|
|
697
|
+
"sourceParty": {
|
|
698
|
+
"type": "string",
|
|
699
|
+
"description": "The source party for this supply chain transaction - typically the seller party\nThis field is the identifier of Party (id). It's definition is:\n\nThe globally unique ID of the party as a URI, ideally as a resolvable ID. "
|
|
700
|
+
},
|
|
701
|
+
"destinationParty": {
|
|
702
|
+
"type": "string",
|
|
703
|
+
"description": "The destination party for this supply chain transaction - typically the buyer party.\nThis field is the identifier of Party (id). It's definition is:\n\nThe globally unique ID of the party as a URI, ideally as a resolvable ID. "
|
|
704
|
+
},
|
|
705
|
+
"bizTransaction": {
|
|
706
|
+
"type": "string",
|
|
707
|
+
"x-external-enumeration": "https://ref.gs1.org/cbv/BTT-",
|
|
708
|
+
"description": "The document type representing the trade transaction drawn from the business transaction type vocabulary.\n\n This is an enumerated value, but the list of valid values are too big, or change too often to include here. You can access the list of allowable values at this URL: https://ref.gs1.org/cbv/BTT-\n "
|
|
709
|
+
},
|
|
710
|
+
"epcList": {
|
|
711
|
+
"type": "array",
|
|
712
|
+
"items": {
|
|
713
|
+
"$ref": "#/$defs/Item"
|
|
714
|
+
},
|
|
715
|
+
"description": "The list of uniquely identified trade items included in this supply chain transaction."
|
|
716
|
+
},
|
|
717
|
+
"quantityList": {
|
|
718
|
+
"type": "array",
|
|
719
|
+
"items": {
|
|
720
|
+
"$ref": "#/$defs/QuantityElement"
|
|
721
|
+
},
|
|
722
|
+
"description": "List of quantified product classes that are included in this transaction. Used when the trade items do not have unique identifiers (eg 100 reels of yarn)"
|
|
723
|
+
}
|
|
724
|
+
},
|
|
725
|
+
"description": "Transaction represents an event in which one or more objects become associated or disassociated with one or more identified business transactions - such as the purchase / shipment of goods between buyer and seller.",
|
|
726
|
+
"required": ["sourceParty", "destinationParty"]
|
|
727
|
+
},
|
|
728
|
+
"AssociationEvent": {
|
|
729
|
+
"type": "object",
|
|
730
|
+
"additionalProperties": true,
|
|
731
|
+
"properties": {
|
|
732
|
+
"type": {
|
|
733
|
+
"type": "array",
|
|
734
|
+
"readOnly": true,
|
|
735
|
+
"default": ["AssociationEvent", "Event"],
|
|
736
|
+
"items": {
|
|
737
|
+
"type": "string"
|
|
738
|
+
},
|
|
739
|
+
"allOf": [
|
|
740
|
+
{
|
|
741
|
+
"contains": {
|
|
742
|
+
"const": "AssociationEvent",
|
|
743
|
+
"minContains": 1
|
|
744
|
+
}
|
|
745
|
+
},
|
|
746
|
+
{
|
|
747
|
+
"contains": {
|
|
748
|
+
"const": "Event",
|
|
749
|
+
"minContains": 1
|
|
750
|
+
}
|
|
751
|
+
}
|
|
752
|
+
]
|
|
753
|
+
},
|
|
754
|
+
"id": {
|
|
755
|
+
"readOnly": true,
|
|
756
|
+
"example": "https://events.sample.com/b681df10-c682-454a-b11b-d0b9374c01bd",
|
|
757
|
+
"type": "string",
|
|
758
|
+
"format": "uri",
|
|
759
|
+
"description": "The unique identifier of this event - SHOULD be a UUID"
|
|
760
|
+
},
|
|
761
|
+
"processType": {
|
|
762
|
+
"example": "Weaving",
|
|
763
|
+
"type": "string",
|
|
764
|
+
"description": "A human readable name for industry specific process represented by this event."
|
|
765
|
+
},
|
|
766
|
+
"eventTime": {
|
|
767
|
+
"example": "2024-09-01T12:00:00Z",
|
|
768
|
+
"type": "string",
|
|
769
|
+
"format": "date-time",
|
|
770
|
+
"description": "The ISO-8601 date time when the event occurred."
|
|
771
|
+
},
|
|
772
|
+
"action": {
|
|
773
|
+
"type": "string",
|
|
774
|
+
"enum": ["observe", "add", "delete"],
|
|
775
|
+
"example": "observe",
|
|
776
|
+
"description": "Code describing how an event relates to the life-cycle of the entity impacted by the event."
|
|
777
|
+
},
|
|
778
|
+
"disposition": {
|
|
779
|
+
"type": "string",
|
|
780
|
+
"x-external-enumeration": "https://ref.gs1.org/cbv/Disp-",
|
|
781
|
+
"description": "Disposition code describing the state of the item after the event. \n\n This is an enumerated value, but the list of valid values are too big, or change too often to include here. You can access the list of allowable values at this URL: https://ref.gs1.org/cbv/Disp-\n "
|
|
782
|
+
},
|
|
783
|
+
"bizStep": {
|
|
784
|
+
"type": "string",
|
|
785
|
+
"x-external-enumeration": "https://ref.gs1.org/cbv/BizStep-",
|
|
786
|
+
"description": "A business step code drawn from a controlled vocabulary.\n\n This is an enumerated value, but the list of valid values are too big, or change too often to include here. You can access the list of allowable values at this URL: https://ref.gs1.org/cbv/BizStep-\n "
|
|
787
|
+
},
|
|
788
|
+
"bizLocation": {
|
|
789
|
+
"example": "https://id.gs1.org/414/9520123456788",
|
|
790
|
+
"type": "string",
|
|
791
|
+
"format": "uri",
|
|
792
|
+
"description": "A Business Location is a uniquely identified and discretely recorded geospatial location that is meant to designate the specific place where an object is assumed to be following an event until it is reported to be at a different Business Location by a subsequent event. The bizLocation must be a resolvable URI that links to facility information and geo-location data."
|
|
793
|
+
},
|
|
794
|
+
"sensorElementList": {
|
|
795
|
+
"type": "array",
|
|
796
|
+
"items": {
|
|
797
|
+
"$ref": "#/$defs/SensorElement"
|
|
798
|
+
},
|
|
799
|
+
"description": "An array (one for each sensor) of sensor device data sets associated with the event. "
|
|
800
|
+
},
|
|
801
|
+
"parentEPC": {
|
|
802
|
+
"$ref": "#/$defs/Item",
|
|
803
|
+
"description": "The unique item identifier that is the parent of this association. Typically an assembled product ID such as a desktop computer that is built from the associated child components."
|
|
804
|
+
},
|
|
805
|
+
"childEPCList": {
|
|
806
|
+
"type": "array",
|
|
807
|
+
"items": {
|
|
808
|
+
"$ref": "#/$defs/Item"
|
|
809
|
+
},
|
|
810
|
+
"description": "The list of child items that have been assembled to create the parent - for example the power supply or hard drive components of a desktop computer."
|
|
811
|
+
},
|
|
812
|
+
"childQuantityList": {
|
|
813
|
+
"type": "array",
|
|
814
|
+
"items": {
|
|
815
|
+
"$ref": "#/$defs/QuantityElement"
|
|
816
|
+
},
|
|
817
|
+
"description": "List of quantified product classes that have been assembled into the parent. Used when the child items do not have unique identifiers (eg brackets and screws used in the assembly of a desktop computer)"
|
|
818
|
+
}
|
|
819
|
+
},
|
|
820
|
+
"description": "The association event represents the assembly of child sub-components to create a parent assembled item. For example a desktop computer assembled from power supply, hard drive, and motherboard. The association event is very similar in structure to the aggregation event but is used for physical assembly. An association event may represent a bill of materials used to assemble a product whilst an aggregation event may represent a packing list or items for transport. "
|
|
821
|
+
},
|
|
822
|
+
"Event": {
|
|
823
|
+
"type": "object",
|
|
824
|
+
"oneOf": [
|
|
825
|
+
{
|
|
826
|
+
"$ref": "#/$defs/TransformationEvent"
|
|
827
|
+
},
|
|
828
|
+
{
|
|
829
|
+
"$ref": "#/$defs/ObjectEvent"
|
|
830
|
+
},
|
|
831
|
+
{
|
|
832
|
+
"$ref": "#/$defs/AggregationEvent"
|
|
833
|
+
},
|
|
834
|
+
{
|
|
835
|
+
"$ref": "#/$defs/TransactionEvent"
|
|
836
|
+
},
|
|
837
|
+
{
|
|
838
|
+
"$ref": "#/$defs/AssociationEvent"
|
|
839
|
+
}
|
|
840
|
+
],
|
|
841
|
+
"description": "This abstract event structure provides a common language to describe supply chain events such as shipments, inspections, manufacturing processes, etc. There are four types of EPCIS event but this is an abstract class representing all common properties of an EPCIS event.",
|
|
842
|
+
"additionalProperties": true
|
|
843
|
+
}
|
|
844
|
+
}
|
|
845
|
+
}
|