From d37ae5e5ba9e8999ee9805f52be0175fcd5dde89 Mon Sep 17 00:00:00 2001 From: Kseniya Shychko Date: Sun, 3 Mar 2024 13:58:07 +0100 Subject: [PATCH] chore: cleanup json schemas --- AggregationEvent.json | 2 +- Event.json | 2 +- ObjectEvent.json | 2 +- TransactionEvent.json | 2 +- TransformationEvent.json | 2 +- 5 files changed, 5 insertions(+), 5 deletions(-) diff --git a/AggregationEvent.json b/AggregationEvent.json index cefe3e0a3..ed5fd192f 100644 --- a/AggregationEvent.json +++ b/AggregationEvent.json @@ -1 +1 @@ -{"type":"object","additionalProperties":false,"properties":{"parentItem":{"$ref":"#/$defs/Item","description":"The unique item identifier that is the result of this aggreation. Typcially a packaging ID used in shipments that represents a box/ pallet / container of contained items."},"childItems":{"type":"array","items":{"$ref":"#/$defs/Item"},"description":"The list of child items that have been aggreated into the parent (or disaggregated from the parent). Maybe a list of pckage referneces (eg boxes on a pallet) or may be individual items (eg products in a box)."},"childQuantityList":{"type":"array","items":{"$ref":"#/$defs/QuantityElement"},"description":"List of quantified product classes that have been aggregated into the parent. Used whwn the child items do not have unique identifiers (eg 100 Kg of cotton bales)"},"eventID":{"x-jargon-isKey":true,"readOnly":true,"type":"string","description":"The unique identifier of this event - SHOULD be a UUID"},"eventType":{"type":"string","enum":["object","transaction","aggregation","transformation"],"example":"object","description":"The event type - object, aggregation, transformation, transaction."},"eventTime":{"type":"string","description":"The ISO-8601 date time when the event occured."},"actionCode":{"type":"string","enum":["observe","add","delete"],"example":"observe","description":"The Action type says how an event relates to the lifecycle of the entity being described. For example, AggregationEvent is used to capture events related to aggregations of objects, such as cases aggregated to a pallet. Throughout its life, the pallet load participates in many business process steps, each of which may generate an EPCIS event. The action field of each event says how the aggregation itself has changed during the event: have objects been added to the aggregation, have objects been removed from the aggregation, or has the aggregation simply been observed without change to its membership? The action is independent of the bizStep (of type BusinessStepID) which identifies the specific business process step in which the action took place. allowed values are: - ADD (The entity in question has been created or added to.) - OBSERVE (Theentityinquestionhasnotbeenchanged:ithasneitherbeencreated,addedto,destroyed,orremovedfrom.) - DELETE (The entity in question has been removed from or destroyed altogether.)"},"dispositionCode":{"type":"string","enum":["active","expired","disposed","conformant","non_conformant","in-transit","dispensed"],"example":"active","description":"Disposition code is a vocabulary whose elements denote a business state of an object. An example is a code that denotes “recalled\". The disposition field of an event specifies the business condition of the event’s objects, subsequent to the event. The disposition is assumed to hold true until another event indicates a change of disposition. Intervening events that do not specify a disposition field have no effect on the presumed disposition of the object. The GS1 vocabulary (CBV v2.0) defines 33 possible disposition codes but this specification restricts the options to the minimum set of values that are relevant for supply chain traceability. "},"businessStepCode":{"type":"string","enum":["commissioning","inspecting","shipping","packing","unpacking"],"example":"commissioning","description":"BusinessStepID is a vocabulary whose elements denote steps in business processes. An example is an identifier that denotes “shipping.” The business step field of an event specifies the business context of an event: what business process step was taking place that caused the event to be captured? This specification has chosena 5 of the 41 possible bizstep values defined by GS1 that are appropriate for the sustainbility use case."},"readPointId":{"type":"string","description":"A Read Point is a discretely recorded location that is meant to identify the most specific place at which an EPCIS event took place. Read Points are determined by the EPCIS Capturing Application, perhaps inferred as a function of logical reader if stationary readers are used, perhaps determined overtly by reading a location tag if the reader is mobile, or in general determined by any other means the EPCIS Capturing Application chooses to use. Conceptually, the Read Point is designed to identify “where objects were at the time of the EPCIS event.”"},"locationId":{"type":"string","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 EPCIS event until it is reported to be at a different Business Location by a subsequent EPCIS event. This specification requires the use of https://maps.google.com/pluscodes/ as geospatial identifiers rather than identifier schemes that cannot be reolved to a geogrpahic point or area."},"certification":{"type":"array","items":{"$ref":"#/$defs/CertificationInfo"},"description":"Any test result or certification related to this EPCIS event.Could be self-assessed or independent and has asssociated sustainabiloity claims from the ITC vocabulary."}},"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.","$schema":"https://json-schema.org/draft/2020-12/schema","$defs":{"Item":{"type":"object","additionalProperties":false,"properties":{"itemID":{"x-jargon-isKey":true,"type":"string","format":"uri","description":"The globally unique identifier (eg GS1 GTIN or digital link) of the product item. "},"name":{"type":"string","description":"The name of the product class to which the product item belongs. "}},"description":"A specific trade item /product code which could be either a product serial number or a consignment identifier "},"QuantityElement":{"type":"object","additionalProperties":false,"properties":{"productClass":{"type":"string","description":"THe identifier of a product class (as opposed to a product instance) such as a GTIN code for a manufactured product."},"quantity":{"type":"string","description":"The numeric quantity of the product class (eg 100 kg of cotton)"},"uom":{"type":"string","x-external-enumeration":"https://api.sustainability.unece.org/referenceData/unitOfMeasureCode","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://api.sustainability.unece.org/referenceData/unitOfMeasureCode\n "}},"description":"The quantity elment is used to define the quantities (eg 100), units of measure (eg Kg) and product class (eg GTIN or other class identifier) of products that are inputs or outputs or the subject of supply chain events. ","required":["quantity"]},"CertificationInfo":{"type":"object","additionalProperties":false,"properties":{"certificateID":{"x-jargon-isKey":true,"type":"string","format":"uri","description":"The ID of the certificate document"},"referenceStandard":{"type":"string","format":"uri","description":"The identifier (as a URI) of the sustainability standard against whichthe certificate is issued. For example abvtex.org.br/v4.0"},"evidenceURL":{"type":"string","format":"uri","description":"The URL of the certificate document. For privacy and integrity reasons, it is recommended (but not required) that * the documentURL is a hashlink (https://w3c-ccg.github.io/hashlink/) so that if the document the URL is changed then the hash verification will fail.* the document is encrypted for privacy reasons and that the symmetric key for decruption is provided as a URL parameter.* the document filename is a GUID so that there is no leakage of possibly identifying information in the URL.https://domain/GUID?h1={document_hash}&key={decryption_key}For examplehttps://docstore.com/ef1e69fbbeaf47b4af97e29c69dc09cf.pdf?h1=zQmWvQxTqbG2Z9HPJgG57jjwR154cKhbtJenbyYTWkjgF3e&key=462D4A614E645267556B587032733576"},"criteriaList":{"type":"array","items":{"type":"string","format":"uri"},"description":"Optional list of specific sustainability criteria that the certificate claims are met."},"assessmentLevel":{"type":"string","enum":["self-assessed","independent-certifier"],"example":"self-assessed","description":"The integrity level of the sustainability claims. Self asssed or independently certified. "},"responsibleAgency":{"$ref":"#/$defs/Party","description":"The issuing authority of the certificate."}},"description":"Details of a self asssessed or independently verified set of sustainability claims about a product or an establishment."},"Party":{"type":"object","additionalProperties":false,"properties":{"partyID":{"x-jargon-isKey":true,"type":"string","format":"uri","description":"The globally unique identifier of the party. This must be expressed as a URI that is (preferably) resolvable to an entity register such as a national business register - eg https://abr.business.gov.au/ABN/View?abn=41161080146 "},"name":{"type":"string","description":"The entity name of the identified party - usually the business anme from the corresponding natinal registery -eg ACME LTD"}},"description":"A trade party "}}} \ No newline at end of file +{"type":"object","additionalProperties":false,"properties":{"parentItem":{"$ref":"#/$defs/Item","description":"The unique item identifier that is the result of this aggreation. Typcially a packaging ID used in shipments that represents a box/ pallet / container of contained items."},"childItems":{"type":"array","items":{"$ref":"#/$defs/Item"},"description":"The list of child items that have been aggreated into the parent (or disaggregated from the parent). Maybe a list of pckage referneces (eg boxes on a pallet) or may be individual items (eg products in a box)."},"childQuantityList":{"type":"array","items":{"$ref":"#/$defs/QuantityElement"},"description":"List of quantified product classes that have been aggregated into the parent. Used whwn the child items do not have unique identifiers (eg 100 Kg of cotton bales)"},"eventID":{"readOnly":true,"type":"string","description":"The unique identifier of this event - SHOULD be a UUID"},"eventType":{"type":"string","enum":["object","transaction","aggregation","transformation"],"example":"object","description":"The event type - object, aggregation, transformation, transaction."},"eventTime":{"type":"string","description":"The ISO-8601 date time when the event occured."},"actionCode":{"type":"string","enum":["observe","add","delete"],"example":"observe","description":"The Action type says how an event relates to the lifecycle of the entity being described. For example, AggregationEvent is used to capture events related to aggregations of objects, such as cases aggregated to a pallet. Throughout its life, the pallet load participates in many business process steps, each of which may generate an EPCIS event. The action field of each event says how the aggregation itself has changed during the event: have objects been added to the aggregation, have objects been removed from the aggregation, or has the aggregation simply been observed without change to its membership? The action is independent of the bizStep (of type BusinessStepID) which identifies the specific business process step in which the action took place. allowed values are: - ADD (The entity in question has been created or added to.) - OBSERVE (Theentityinquestionhasnotbeenchanged:ithasneitherbeencreated,addedto,destroyed,orremovedfrom.) - DELETE (The entity in question has been removed from or destroyed altogether.)"},"dispositionCode":{"type":"string","enum":["active","expired","disposed","conformant","non_conformant","in-transit","dispensed"],"example":"active","description":"Disposition code is a vocabulary whose elements denote a business state of an object. An example is a code that denotes “recalled\". The disposition field of an event specifies the business condition of the event’s objects, subsequent to the event. The disposition is assumed to hold true until another event indicates a change of disposition. Intervening events that do not specify a disposition field have no effect on the presumed disposition of the object. The GS1 vocabulary (CBV v2.0) defines 33 possible disposition codes but this specification restricts the options to the minimum set of values that are relevant for supply chain traceability. "},"businessStepCode":{"type":"string","enum":["commissioning","inspecting","shipping","packing","unpacking"],"example":"commissioning","description":"BusinessStepID is a vocabulary whose elements denote steps in business processes. An example is an identifier that denotes “shipping.” The business step field of an event specifies the business context of an event: what business process step was taking place that caused the event to be captured? This specification has chosena 5 of the 41 possible bizstep values defined by GS1 that are appropriate for the sustainbility use case."},"readPointId":{"type":"string","description":"A Read Point is a discretely recorded location that is meant to identify the most specific place at which an EPCIS event took place. Read Points are determined by the EPCIS Capturing Application, perhaps inferred as a function of logical reader if stationary readers are used, perhaps determined overtly by reading a location tag if the reader is mobile, or in general determined by any other means the EPCIS Capturing Application chooses to use. Conceptually, the Read Point is designed to identify “where objects were at the time of the EPCIS event.”"},"locationId":{"type":"string","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 EPCIS event until it is reported to be at a different Business Location by a subsequent EPCIS event. This specification requires the use of https://maps.google.com/pluscodes/ as geospatial identifiers rather than identifier schemes that cannot be reolved to a geogrpahic point or area."},"certification":{"type":"array","items":{"$ref":"#/$defs/CertificationInfo"},"description":"Any test result or certification related to this EPCIS event.Could be self-assessed or independent and has asssociated sustainabiloity claims from the ITC vocabulary."}},"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.","$schema":"https://json-schema.org/draft/2020-12/schema","$defs":{"Item":{"type":"object","additionalProperties":false,"properties":{"itemID":{"type":"string","format":"uri","description":"The globally unique identifier (eg GS1 GTIN or digital link) of the product item. "},"name":{"type":"string","description":"The name of the product class to which the product item belongs. "}},"description":"A specific trade item /product code which could be either a product serial number or a consignment identifier "},"QuantityElement":{"type":"object","additionalProperties":false,"properties":{"productClass":{"type":"string","description":"THe identifier of a product class (as opposed to a product instance) such as a GTIN code for a manufactured product."},"quantity":{"type":"string","description":"The numeric quantity of the product class (eg 100 kg of cotton)"},"uom":{"type":"string","x-external-enumeration":"https://api.sustainability.unece.org/referenceData/unitOfMeasureCode","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://api.sustainability.unece.org/referenceData/unitOfMeasureCode\n "}},"description":"The quantity elment is used to define the quantities (eg 100), units of measure (eg Kg) and product class (eg GTIN or other class identifier) of products that are inputs or outputs or the subject of supply chain events. ","required":["quantity"]},"CertificationInfo":{"type":"object","additionalProperties":false,"properties":{"certificateID":{"type":"string","format":"uri","description":"The ID of the certificate document"},"referenceStandard":{"type":"string","format":"uri","description":"The identifier (as a URI) of the sustainability standard against whichthe certificate is issued. For example abvtex.org.br/v4.0"},"evidenceURL":{"type":"string","format":"uri","description":"The URL of the certificate document. For privacy and integrity reasons, it is recommended (but not required) that * the documentURL is a hashlink (https://w3c-ccg.github.io/hashlink/) so that if the document the URL is changed then the hash verification will fail.* the document is encrypted for privacy reasons and that the symmetric key for decruption is provided as a URL parameter.* the document filename is a GUID so that there is no leakage of possibly identifying information in the URL.https://domain/GUID?h1={document_hash}&key={decryption_key}For examplehttps://docstore.com/ef1e69fbbeaf47b4af97e29c69dc09cf.pdf?h1=zQmWvQxTqbG2Z9HPJgG57jjwR154cKhbtJenbyYTWkjgF3e&key=462D4A614E645267556B587032733576"},"criteriaList":{"type":"array","items":{"type":"string","format":"uri"},"description":"Optional list of specific sustainability criteria that the certificate claims are met."},"assessmentLevel":{"type":"string","enum":["self-assessed","independent-certifier"],"example":"self-assessed","description":"The integrity level of the sustainability claims. Self asssed or independently certified. "},"responsibleAgency":{"$ref":"#/$defs/Party","description":"The issuing authority of the certificate."}},"description":"Details of a self asssessed or independently verified set of sustainability claims about a product or an establishment."},"Party":{"type":"object","additionalProperties":false,"properties":{"partyID":{"type":"string","format":"uri","description":"The globally unique identifier of the party. This must be expressed as a URI that is (preferably) resolvable to an entity register such as a national business register - eg https://abr.business.gov.au/ABN/View?abn=41161080146 "},"name":{"type":"string","description":"The entity name of the identified party - usually the business anme from the corresponding natinal registery -eg ACME LTD"}},"description":"A trade party "}}} \ No newline at end of file diff --git a/Event.json b/Event.json index c0d7375c3..161f48050 100644 --- a/Event.json +++ b/Event.json @@ -1 +1 @@ -{"type":"object","additionalProperties":false,"properties":{"eventID":{"x-jargon-isKey":true,"readOnly":true,"type":"string","description":"The unique identifier of this event - SHOULD be a UUID"},"eventType":{"type":"string","enum":["object","transaction","aggregation","transformation"],"example":"object","description":"The event type - object, aggregation, transformation, transaction."},"eventTime":{"type":"string","description":"The ISO-8601 date time when the event occured."},"actionCode":{"type":"string","enum":["observe","add","delete"],"example":"observe","description":"The Action type says how an event relates to the lifecycle of the entity being described. For example, AggregationEvent is used to capture events related to aggregations of objects, such as cases aggregated to a pallet. Throughout its life, the pallet load participates in many business process steps, each of which may generate an EPCIS event. The action field of each event says how the aggregation itself has changed during the event: have objects been added to the aggregation, have objects been removed from the aggregation, or has the aggregation simply been observed without change to its membership? The action is independent of the bizStep (of type BusinessStepID) which identifies the specific business process step in which the action took place. allowed values are: - ADD (The entity in question has been created or added to.) - OBSERVE (Theentityinquestionhasnotbeenchanged:ithasneitherbeencreated,addedto,destroyed,orremovedfrom.) - DELETE (The entity in question has been removed from or destroyed altogether.)"},"dispositionCode":{"type":"string","enum":["active","expired","disposed","conformant","non_conformant","in-transit","dispensed"],"example":"active","description":"Disposition code is a vocabulary whose elements denote a business state of an object. An example is a code that denotes “recalled\". The disposition field of an event specifies the business condition of the event’s objects, subsequent to the event. The disposition is assumed to hold true until another event indicates a change of disposition. Intervening events that do not specify a disposition field have no effect on the presumed disposition of the object. The GS1 vocabulary (CBV v2.0) defines 33 possible disposition codes but this specification restricts the options to the minimum set of values that are relevant for supply chain traceability. "},"businessStepCode":{"type":"string","enum":["commissioning","inspecting","shipping","packing","unpacking"],"example":"commissioning","description":"BusinessStepID is a vocabulary whose elements denote steps in business processes. An example is an identifier that denotes “shipping.” The business step field of an event specifies the business context of an event: what business process step was taking place that caused the event to be captured? This specification has chosena 5 of the 41 possible bizstep values defined by GS1 that are appropriate for the sustainbility use case."},"readPointId":{"type":"string","description":"A Read Point is a discretely recorded location that is meant to identify the most specific place at which an EPCIS event took place. Read Points are determined by the EPCIS Capturing Application, perhaps inferred as a function of logical reader if stationary readers are used, perhaps determined overtly by reading a location tag if the reader is mobile, or in general determined by any other means the EPCIS Capturing Application chooses to use. Conceptually, the Read Point is designed to identify “where objects were at the time of the EPCIS event.”"},"locationId":{"type":"string","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 EPCIS event until it is reported to be at a different Business Location by a subsequent EPCIS event. This specification requires the use of https://maps.google.com/pluscodes/ as geospatial identifiers rather than identifier schemes that cannot be reolved to a geogrpahic point or area."},"certification":{"type":"array","items":{"$ref":"#/$defs/CertificationInfo"},"description":"Any test result or certification related to this EPCIS event.Could be self-assessed or independent and has asssociated sustainabiloity claims from the ITC vocabulary."}},"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 represenitng all common properties of an EPCIS event. ","$schema":"https://json-schema.org/draft/2020-12/schema","$defs":{"CertificationInfo":{"type":"object","additionalProperties":false,"properties":{"certificateID":{"x-jargon-isKey":true,"type":"string","format":"uri","description":"The ID of the certificate document"},"referenceStandard":{"type":"string","format":"uri","description":"The identifier (as a URI) of the sustainability standard against whichthe certificate is issued. For example abvtex.org.br/v4.0"},"evidenceURL":{"type":"string","format":"uri","description":"The URL of the certificate document. For privacy and integrity reasons, it is recommended (but not required) that * the documentURL is a hashlink (https://w3c-ccg.github.io/hashlink/) so that if the document the URL is changed then the hash verification will fail.* the document is encrypted for privacy reasons and that the symmetric key for decruption is provided as a URL parameter.* the document filename is a GUID so that there is no leakage of possibly identifying information in the URL.https://domain/GUID?h1={document_hash}&key={decryption_key}For examplehttps://docstore.com/ef1e69fbbeaf47b4af97e29c69dc09cf.pdf?h1=zQmWvQxTqbG2Z9HPJgG57jjwR154cKhbtJenbyYTWkjgF3e&key=462D4A614E645267556B587032733576"},"criteriaList":{"type":"array","items":{"type":"string","format":"uri"},"description":"Optional list of specific sustainability criteria that the certificate claims are met."},"assessmentLevel":{"type":"string","enum":["self-assessed","independent-certifier"],"example":"self-assessed","description":"The integrity level of the sustainability claims. Self asssed or independently certified. "},"responsibleAgency":{"$ref":"#/$defs/Party","description":"The issuing authority of the certificate."}},"description":"Details of a self asssessed or independently verified set of sustainability claims about a product or an establishment."},"Party":{"type":"object","additionalProperties":false,"properties":{"partyID":{"x-jargon-isKey":true,"type":"string","format":"uri","description":"The globally unique identifier of the party. This must be expressed as a URI that is (preferably) resolvable to an entity register such as a national business register - eg https://abr.business.gov.au/ABN/View?abn=41161080146 "},"name":{"type":"string","description":"The entity name of the identified party - usually the business anme from the corresponding natinal registery -eg ACME LTD"}},"description":"A trade party "}}} \ No newline at end of file +{"type":"object","additionalProperties":false,"properties":{"eventID":{"readOnly":true,"type":"string","description":"The unique identifier of this event - SHOULD be a UUID"},"eventType":{"type":"string","enum":["object","transaction","aggregation","transformation"],"example":"object","description":"The event type - object, aggregation, transformation, transaction."},"eventTime":{"type":"string","description":"The ISO-8601 date time when the event occured."},"actionCode":{"type":"string","enum":["observe","add","delete"],"example":"observe","description":"The Action type says how an event relates to the lifecycle of the entity being described. For example, AggregationEvent is used to capture events related to aggregations of objects, such as cases aggregated to a pallet. Throughout its life, the pallet load participates in many business process steps, each of which may generate an EPCIS event. The action field of each event says how the aggregation itself has changed during the event: have objects been added to the aggregation, have objects been removed from the aggregation, or has the aggregation simply been observed without change to its membership? The action is independent of the bizStep (of type BusinessStepID) which identifies the specific business process step in which the action took place. allowed values are: - ADD (The entity in question has been created or added to.) - OBSERVE (Theentityinquestionhasnotbeenchanged:ithasneitherbeencreated,addedto,destroyed,orremovedfrom.) - DELETE (The entity in question has been removed from or destroyed altogether.)"},"dispositionCode":{"type":"string","enum":["active","expired","disposed","conformant","non_conformant","in-transit","dispensed"],"example":"active","description":"Disposition code is a vocabulary whose elements denote a business state of an object. An example is a code that denotes “recalled\". The disposition field of an event specifies the business condition of the event’s objects, subsequent to the event. The disposition is assumed to hold true until another event indicates a change of disposition. Intervening events that do not specify a disposition field have no effect on the presumed disposition of the object. The GS1 vocabulary (CBV v2.0) defines 33 possible disposition codes but this specification restricts the options to the minimum set of values that are relevant for supply chain traceability. "},"businessStepCode":{"type":"string","enum":["commissioning","inspecting","shipping","packing","unpacking"],"example":"commissioning","description":"BusinessStepID is a vocabulary whose elements denote steps in business processes. An example is an identifier that denotes “shipping.” The business step field of an event specifies the business context of an event: what business process step was taking place that caused the event to be captured? This specification has chosena 5 of the 41 possible bizstep values defined by GS1 that are appropriate for the sustainbility use case."},"readPointId":{"type":"string","description":"A Read Point is a discretely recorded location that is meant to identify the most specific place at which an EPCIS event took place. Read Points are determined by the EPCIS Capturing Application, perhaps inferred as a function of logical reader if stationary readers are used, perhaps determined overtly by reading a location tag if the reader is mobile, or in general determined by any other means the EPCIS Capturing Application chooses to use. Conceptually, the Read Point is designed to identify “where objects were at the time of the EPCIS event.”"},"locationId":{"type":"string","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 EPCIS event until it is reported to be at a different Business Location by a subsequent EPCIS event. This specification requires the use of https://maps.google.com/pluscodes/ as geospatial identifiers rather than identifier schemes that cannot be reolved to a geogrpahic point or area."},"certification":{"type":"array","items":{"$ref":"#/$defs/CertificationInfo"},"description":"Any test result or certification related to this EPCIS event.Could be self-assessed or independent and has asssociated sustainabiloity claims from the ITC vocabulary."}},"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 represenitng all common properties of an EPCIS event. ","$schema":"https://json-schema.org/draft/2020-12/schema","$defs":{"CertificationInfo":{"type":"object","additionalProperties":false,"properties":{"certificateID":{"type":"string","format":"uri","description":"The ID of the certificate document"},"referenceStandard":{"type":"string","format":"uri","description":"The identifier (as a URI) of the sustainability standard against whichthe certificate is issued. For example abvtex.org.br/v4.0"},"evidenceURL":{"type":"string","format":"uri","description":"The URL of the certificate document. For privacy and integrity reasons, it is recommended (but not required) that * the documentURL is a hashlink (https://w3c-ccg.github.io/hashlink/) so that if the document the URL is changed then the hash verification will fail.* the document is encrypted for privacy reasons and that the symmetric key for decruption is provided as a URL parameter.* the document filename is a GUID so that there is no leakage of possibly identifying information in the URL.https://domain/GUID?h1={document_hash}&key={decryption_key}For examplehttps://docstore.com/ef1e69fbbeaf47b4af97e29c69dc09cf.pdf?h1=zQmWvQxTqbG2Z9HPJgG57jjwR154cKhbtJenbyYTWkjgF3e&key=462D4A614E645267556B587032733576"},"criteriaList":{"type":"array","items":{"type":"string","format":"uri"},"description":"Optional list of specific sustainability criteria that the certificate claims are met."},"assessmentLevel":{"type":"string","enum":["self-assessed","independent-certifier"],"example":"self-assessed","description":"The integrity level of the sustainability claims. Self asssed or independently certified. "},"responsibleAgency":{"$ref":"#/$defs/Party","description":"The issuing authority of the certificate."}},"description":"Details of a self asssessed or independently verified set of sustainability claims about a product or an establishment."},"Party":{"type":"object","additionalProperties":false,"properties":{"partyID":{"type":"string","format":"uri","description":"The globally unique identifier of the party. This must be expressed as a URI that is (preferably) resolvable to an entity register such as a national business register - eg https://abr.business.gov.au/ABN/View?abn=41161080146 "},"name":{"type":"string","description":"The entity name of the identified party - usually the business anme from the corresponding natinal registery -eg ACME LTD"}},"description":"A trade party "}}} \ No newline at end of file diff --git a/ObjectEvent.json b/ObjectEvent.json index 53fe3da23..17e60235a 100644 --- a/ObjectEvent.json +++ b/ObjectEvent.json @@ -1 +1 @@ -{"type":"object","additionalProperties":false,"properties":{"itemList":{"type":"array","items":{"$ref":"#/$defs/Item"},"description":"A list of uniquely identified items (eg specific items serial numbers or tagged shipments / packages) that are the focus of this object event. "},"quantityList":{"type":"array","items":{"$ref":"#/$defs/QuantityElement"},"description":"A quantified list of product classes (eg GS1 GTINs) that are the focus of this object event"},"eventID":{"x-jargon-isKey":true,"readOnly":true,"type":"string","description":"The unique identifier of this event - SHOULD be a UUID"},"eventType":{"type":"string","enum":["object","transaction","aggregation","transformation"],"example":"object","description":"The event type - object, aggregation, transformation, transaction."},"eventTime":{"type":"string","description":"The ISO-8601 date time when the event occured."},"actionCode":{"type":"string","enum":["observe","add","delete"],"example":"observe","description":"The Action type says how an event relates to the lifecycle of the entity being described. For example, AggregationEvent is used to capture events related to aggregations of objects, such as cases aggregated to a pallet. Throughout its life, the pallet load participates in many business process steps, each of which may generate an EPCIS event. The action field of each event says how the aggregation itself has changed during the event: have objects been added to the aggregation, have objects been removed from the aggregation, or has the aggregation simply been observed without change to its membership? The action is independent of the bizStep (of type BusinessStepID) which identifies the specific business process step in which the action took place. allowed values are: - ADD (The entity in question has been created or added to.) - OBSERVE (Theentityinquestionhasnotbeenchanged:ithasneitherbeencreated,addedto,destroyed,orremovedfrom.) - DELETE (The entity in question has been removed from or destroyed altogether.)"},"dispositionCode":{"type":"string","enum":["active","expired","disposed","conformant","non_conformant","in-transit","dispensed"],"example":"active","description":"Disposition code is a vocabulary whose elements denote a business state of an object. An example is a code that denotes “recalled\". The disposition field of an event specifies the business condition of the event’s objects, subsequent to the event. The disposition is assumed to hold true until another event indicates a change of disposition. Intervening events that do not specify a disposition field have no effect on the presumed disposition of the object. The GS1 vocabulary (CBV v2.0) defines 33 possible disposition codes but this specification restricts the options to the minimum set of values that are relevant for supply chain traceability. "},"businessStepCode":{"type":"string","enum":["commissioning","inspecting","shipping","packing","unpacking"],"example":"commissioning","description":"BusinessStepID is a vocabulary whose elements denote steps in business processes. An example is an identifier that denotes “shipping.” The business step field of an event specifies the business context of an event: what business process step was taking place that caused the event to be captured? This specification has chosena 5 of the 41 possible bizstep values defined by GS1 that are appropriate for the sustainbility use case."},"readPointId":{"type":"string","description":"A Read Point is a discretely recorded location that is meant to identify the most specific place at which an EPCIS event took place. Read Points are determined by the EPCIS Capturing Application, perhaps inferred as a function of logical reader if stationary readers are used, perhaps determined overtly by reading a location tag if the reader is mobile, or in general determined by any other means the EPCIS Capturing Application chooses to use. Conceptually, the Read Point is designed to identify “where objects were at the time of the EPCIS event.”"},"locationId":{"type":"string","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 EPCIS event until it is reported to be at a different Business Location by a subsequent EPCIS event. This specification requires the use of https://maps.google.com/pluscodes/ as geospatial identifiers rather than identifier schemes that cannot be reolved to a geogrpahic point or area."},"certification":{"type":"array","items":{"$ref":"#/$defs/CertificationInfo"},"description":"Any test result or certification related to this EPCIS event.Could be self-assessed or independent and has asssociated sustainabiloity claims from the ITC vocabulary."}},"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 physucal 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)","$schema":"https://json-schema.org/draft/2020-12/schema","$defs":{"Item":{"type":"object","additionalProperties":false,"properties":{"itemID":{"x-jargon-isKey":true,"type":"string","format":"uri","description":"The globally unique identifier (eg GS1 GTIN or digital link) of the product item. "},"name":{"type":"string","description":"The name of the product class to which the product item belongs. "}},"description":"A specific trade item /product code which could be either a product serial number or a consignment identifier "},"QuantityElement":{"type":"object","additionalProperties":false,"properties":{"productClass":{"type":"string","description":"THe identifier of a product class (as opposed to a product instance) such as a GTIN code for a manufactured product."},"quantity":{"type":"string","description":"The numeric quantity of the product class (eg 100 kg of cotton)"},"uom":{"type":"string","x-external-enumeration":"https://api.sustainability.unece.org/referenceData/unitOfMeasureCode","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://api.sustainability.unece.org/referenceData/unitOfMeasureCode\n "}},"description":"The quantity elment is used to define the quantities (eg 100), units of measure (eg Kg) and product class (eg GTIN or other class identifier) of products that are inputs or outputs or the subject of supply chain events. ","required":["quantity"]},"CertificationInfo":{"type":"object","additionalProperties":false,"properties":{"certificateID":{"x-jargon-isKey":true,"type":"string","format":"uri","description":"The ID of the certificate document"},"referenceStandard":{"type":"string","format":"uri","description":"The identifier (as a URI) of the sustainability standard against whichthe certificate is issued. For example abvtex.org.br/v4.0"},"evidenceURL":{"type":"string","format":"uri","description":"The URL of the certificate document. For privacy and integrity reasons, it is recommended (but not required) that * the documentURL is a hashlink (https://w3c-ccg.github.io/hashlink/) so that if the document the URL is changed then the hash verification will fail.* the document is encrypted for privacy reasons and that the symmetric key for decruption is provided as a URL parameter.* the document filename is a GUID so that there is no leakage of possibly identifying information in the URL.https://domain/GUID?h1={document_hash}&key={decryption_key}For examplehttps://docstore.com/ef1e69fbbeaf47b4af97e29c69dc09cf.pdf?h1=zQmWvQxTqbG2Z9HPJgG57jjwR154cKhbtJenbyYTWkjgF3e&key=462D4A614E645267556B587032733576"},"criteriaList":{"type":"array","items":{"type":"string","format":"uri"},"description":"Optional list of specific sustainability criteria that the certificate claims are met."},"assessmentLevel":{"type":"string","enum":["self-assessed","independent-certifier"],"example":"self-assessed","description":"The integrity level of the sustainability claims. Self asssed or independently certified. "},"responsibleAgency":{"$ref":"#/$defs/Party","description":"The issuing authority of the certificate."}},"description":"Details of a self asssessed or independently verified set of sustainability claims about a product or an establishment."},"Party":{"type":"object","additionalProperties":false,"properties":{"partyID":{"x-jargon-isKey":true,"type":"string","format":"uri","description":"The globally unique identifier of the party. This must be expressed as a URI that is (preferably) resolvable to an entity register such as a national business register - eg https://abr.business.gov.au/ABN/View?abn=41161080146 "},"name":{"type":"string","description":"The entity name of the identified party - usually the business anme from the corresponding natinal registery -eg ACME LTD"}},"description":"A trade party "}}} \ No newline at end of file +{"type":"object","additionalProperties":false,"properties":{"itemList":{"type":"array","items":{"$ref":"#/$defs/Item"},"description":"A list of uniquely identified items (eg specific items serial numbers or tagged shipments / packages) that are the focus of this object event. "},"quantityList":{"type":"array","items":{"$ref":"#/$defs/QuantityElement"},"description":"A quantified list of product classes (eg GS1 GTINs) that are the focus of this object event"},"eventID":{"readOnly":true,"type":"string","description":"The unique identifier of this event - SHOULD be a UUID"},"eventType":{"type":"string","enum":["object","transaction","aggregation","transformation"],"example":"object","description":"The event type - object, aggregation, transformation, transaction."},"eventTime":{"type":"string","description":"The ISO-8601 date time when the event occured."},"actionCode":{"type":"string","enum":["observe","add","delete"],"example":"observe","description":"The Action type says how an event relates to the lifecycle of the entity being described. For example, AggregationEvent is used to capture events related to aggregations of objects, such as cases aggregated to a pallet. Throughout its life, the pallet load participates in many business process steps, each of which may generate an EPCIS event. The action field of each event says how the aggregation itself has changed during the event: have objects been added to the aggregation, have objects been removed from the aggregation, or has the aggregation simply been observed without change to its membership? The action is independent of the bizStep (of type BusinessStepID) which identifies the specific business process step in which the action took place. allowed values are: - ADD (The entity in question has been created or added to.) - OBSERVE (Theentityinquestionhasnotbeenchanged:ithasneitherbeencreated,addedto,destroyed,orremovedfrom.) - DELETE (The entity in question has been removed from or destroyed altogether.)"},"dispositionCode":{"type":"string","enum":["active","expired","disposed","conformant","non_conformant","in-transit","dispensed"],"example":"active","description":"Disposition code is a vocabulary whose elements denote a business state of an object. An example is a code that denotes “recalled\". The disposition field of an event specifies the business condition of the event’s objects, subsequent to the event. The disposition is assumed to hold true until another event indicates a change of disposition. Intervening events that do not specify a disposition field have no effect on the presumed disposition of the object. The GS1 vocabulary (CBV v2.0) defines 33 possible disposition codes but this specification restricts the options to the minimum set of values that are relevant for supply chain traceability. "},"businessStepCode":{"type":"string","enum":["commissioning","inspecting","shipping","packing","unpacking"],"example":"commissioning","description":"BusinessStepID is a vocabulary whose elements denote steps in business processes. An example is an identifier that denotes “shipping.” The business step field of an event specifies the business context of an event: what business process step was taking place that caused the event to be captured? This specification has chosena 5 of the 41 possible bizstep values defined by GS1 that are appropriate for the sustainbility use case."},"readPointId":{"type":"string","description":"A Read Point is a discretely recorded location that is meant to identify the most specific place at which an EPCIS event took place. Read Points are determined by the EPCIS Capturing Application, perhaps inferred as a function of logical reader if stationary readers are used, perhaps determined overtly by reading a location tag if the reader is mobile, or in general determined by any other means the EPCIS Capturing Application chooses to use. Conceptually, the Read Point is designed to identify “where objects were at the time of the EPCIS event.”"},"locationId":{"type":"string","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 EPCIS event until it is reported to be at a different Business Location by a subsequent EPCIS event. This specification requires the use of https://maps.google.com/pluscodes/ as geospatial identifiers rather than identifier schemes that cannot be reolved to a geogrpahic point or area."},"certification":{"type":"array","items":{"$ref":"#/$defs/CertificationInfo"},"description":"Any test result or certification related to this EPCIS event.Could be self-assessed or independent and has asssociated sustainabiloity claims from the ITC vocabulary."}},"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 physucal 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)","$schema":"https://json-schema.org/draft/2020-12/schema","$defs":{"Item":{"type":"object","additionalProperties":false,"properties":{"itemID":{"type":"string","format":"uri","description":"The globally unique identifier (eg GS1 GTIN or digital link) of the product item. "},"name":{"type":"string","description":"The name of the product class to which the product item belongs. "}},"description":"A specific trade item /product code which could be either a product serial number or a consignment identifier "},"QuantityElement":{"type":"object","additionalProperties":false,"properties":{"productClass":{"type":"string","description":"THe identifier of a product class (as opposed to a product instance) such as a GTIN code for a manufactured product."},"quantity":{"type":"string","description":"The numeric quantity of the product class (eg 100 kg of cotton)"},"uom":{"type":"string","x-external-enumeration":"https://api.sustainability.unece.org/referenceData/unitOfMeasureCode","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://api.sustainability.unece.org/referenceData/unitOfMeasureCode\n "}},"description":"The quantity elment is used to define the quantities (eg 100), units of measure (eg Kg) and product class (eg GTIN or other class identifier) of products that are inputs or outputs or the subject of supply chain events. ","required":["quantity"]},"CertificationInfo":{"type":"object","additionalProperties":false,"properties":{"certificateID":{"type":"string","format":"uri","description":"The ID of the certificate document"},"referenceStandard":{"type":"string","format":"uri","description":"The identifier (as a URI) of the sustainability standard against whichthe certificate is issued. For example abvtex.org.br/v4.0"},"evidenceURL":{"type":"string","format":"uri","description":"The URL of the certificate document. For privacy and integrity reasons, it is recommended (but not required) that * the documentURL is a hashlink (https://w3c-ccg.github.io/hashlink/) so that if the document the URL is changed then the hash verification will fail.* the document is encrypted for privacy reasons and that the symmetric key for decruption is provided as a URL parameter.* the document filename is a GUID so that there is no leakage of possibly identifying information in the URL.https://domain/GUID?h1={document_hash}&key={decryption_key}For examplehttps://docstore.com/ef1e69fbbeaf47b4af97e29c69dc09cf.pdf?h1=zQmWvQxTqbG2Z9HPJgG57jjwR154cKhbtJenbyYTWkjgF3e&key=462D4A614E645267556B587032733576"},"criteriaList":{"type":"array","items":{"type":"string","format":"uri"},"description":"Optional list of specific sustainability criteria that the certificate claims are met."},"assessmentLevel":{"type":"string","enum":["self-assessed","independent-certifier"],"example":"self-assessed","description":"The integrity level of the sustainability claims. Self asssed or independently certified. "},"responsibleAgency":{"$ref":"#/$defs/Party","description":"The issuing authority of the certificate."}},"description":"Details of a self asssessed or independently verified set of sustainability claims about a product or an establishment."},"Party":{"type":"object","additionalProperties":false,"properties":{"partyID":{"type":"string","format":"uri","description":"The globally unique identifier of the party. This must be expressed as a URI that is (preferably) resolvable to an entity register such as a national business register - eg https://abr.business.gov.au/ABN/View?abn=41161080146 "},"name":{"type":"string","description":"The entity name of the identified party - usually the business anme from the corresponding natinal registery -eg ACME LTD"}},"description":"A trade party "}}} \ No newline at end of file diff --git a/TransactionEvent.json b/TransactionEvent.json index 7a4aa8057..b15d1771b 100644 --- a/TransactionEvent.json +++ b/TransactionEvent.json @@ -1 +1 @@ -{"type":"object","additionalProperties":false,"properties":{"sourceParty":{"$ref":"#/$defs/Party","description":"The source party for this supply chain transaction - typcially the seller party"},"destinationParty":{"$ref":"#/$defs/Party","description":"The destination party for this supply chain transaction - typcially the buyer party."},"transaction":{"$ref":"#/$defs/TradeTransaction","description":"The supply chain transaction reference for this transaction event - eg the invoice, order, or despatch advice"},"itemList":{"type":"array","items":{"$ref":"#/$defs/Item"},"description":"The list of uniquely identified trade items included in this supply chain transaction."},"quantityList":{"type":"array","items":{"$ref":"#/$defs/QuantityElement"},"description":"List of quantified product classes that are included in theis transaction. Used whwn the trade items do not have unique identifiers (eg 100 reels of yarn)"},"eventID":{"x-jargon-isKey":true,"readOnly":true,"type":"string","description":"The unique identifier of this event - SHOULD be a UUID"},"eventType":{"type":"string","enum":["object","transaction","aggregation","transformation"],"example":"object","description":"The event type - object, aggregation, transformation, transaction."},"eventTime":{"type":"string","description":"The ISO-8601 date time when the event occured."},"actionCode":{"type":"string","enum":["observe","add","delete"],"example":"observe","description":"The Action type says how an event relates to the lifecycle of the entity being described. For example, AggregationEvent is used to capture events related to aggregations of objects, such as cases aggregated to a pallet. Throughout its life, the pallet load participates in many business process steps, each of which may generate an EPCIS event. The action field of each event says how the aggregation itself has changed during the event: have objects been added to the aggregation, have objects been removed from the aggregation, or has the aggregation simply been observed without change to its membership? The action is independent of the bizStep (of type BusinessStepID) which identifies the specific business process step in which the action took place. allowed values are: - ADD (The entity in question has been created or added to.) - OBSERVE (Theentityinquestionhasnotbeenchanged:ithasneitherbeencreated,addedto,destroyed,orremovedfrom.) - DELETE (The entity in question has been removed from or destroyed altogether.)"},"dispositionCode":{"type":"string","enum":["active","expired","disposed","conformant","non_conformant","in-transit","dispensed"],"example":"active","description":"Disposition code is a vocabulary whose elements denote a business state of an object. An example is a code that denotes “recalled\". The disposition field of an event specifies the business condition of the event’s objects, subsequent to the event. The disposition is assumed to hold true until another event indicates a change of disposition. Intervening events that do not specify a disposition field have no effect on the presumed disposition of the object. The GS1 vocabulary (CBV v2.0) defines 33 possible disposition codes but this specification restricts the options to the minimum set of values that are relevant for supply chain traceability. "},"businessStepCode":{"type":"string","enum":["commissioning","inspecting","shipping","packing","unpacking"],"example":"commissioning","description":"BusinessStepID is a vocabulary whose elements denote steps in business processes. An example is an identifier that denotes “shipping.” The business step field of an event specifies the business context of an event: what business process step was taking place that caused the event to be captured? This specification has chosena 5 of the 41 possible bizstep values defined by GS1 that are appropriate for the sustainbility use case."},"readPointId":{"type":"string","description":"A Read Point is a discretely recorded location that is meant to identify the most specific place at which an EPCIS event took place. Read Points are determined by the EPCIS Capturing Application, perhaps inferred as a function of logical reader if stationary readers are used, perhaps determined overtly by reading a location tag if the reader is mobile, or in general determined by any other means the EPCIS Capturing Application chooses to use. Conceptually, the Read Point is designed to identify “where objects were at the time of the EPCIS event.”"},"locationId":{"type":"string","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 EPCIS event until it is reported to be at a different Business Location by a subsequent EPCIS event. This specification requires the use of https://maps.google.com/pluscodes/ as geospatial identifiers rather than identifier schemes that cannot be reolved to a geogrpahic point or area."},"certification":{"type":"array","items":{"$ref":"#/$defs/CertificationInfo"},"description":"Any test result or certification related to this EPCIS event.Could be self-assessed or independent and has asssociated sustainabiloity claims from the ITC vocabulary."}},"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.","$schema":"https://json-schema.org/draft/2020-12/schema","$defs":{"Party":{"type":"object","additionalProperties":false,"properties":{"partyID":{"x-jargon-isKey":true,"type":"string","format":"uri","description":"The globally unique identifier of the party. This must be expressed as a URI that is (preferably) resolvable to an entity register such as a national business register - eg https://abr.business.gov.au/ABN/View?abn=41161080146 "},"name":{"type":"string","description":"The entity name of the identified party - usually the business anme from the corresponding natinal registery -eg ACME LTD"}},"description":"A trade party "},"TradeTransaction":{"type":"object","additionalProperties":false,"properties":{"type":{"type":"string","enum":["bol","cert","desadv","inv","po"],"example":"bol","description":"The document type representing the trade transaciton. This profile for supply chain traceability defines a simple subset of 5 document types that may be referenced by a transaction event."},"identifier":{"type":"string","description":"The identifier of the trade transaction document - eg an invoice number or bill of lading number. Must be unique for a given source party"},"documentURL":{"type":"string","format":"uri","description":"The URL of the referenced trade document. For privacy and integrity reasons, it is recommended (but not required) that * the documentURL is a hashlink (https://w3c-ccg.github.io/hashlink/) so that if the document the URL is changed then the hash verification will fail.* the document is encrypted for privacy reasons and that the hex encoded symmetric key for decruption is provided as a URL parameter.* the document filename is a GUID so that there is no leakage of possibly identifying information in the URL.https://domain/GUID?h1={document_hash}&key={decryption_key}For examplehttps://docstore.com/ef1e69fbbeaf47b4af97e29c69dc09cf.pdf?h1=zQmWvQxTqbG2Z9HPJgG57jjwR154cKhbtJenbyYTWkjgF3e&key=462D4A614E645267556B587032733576"}},"description":"A trade transaction between two parties such as an invoice, purchase order, or shipping notificaiotn."},"Item":{"type":"object","additionalProperties":false,"properties":{"itemID":{"x-jargon-isKey":true,"type":"string","format":"uri","description":"The globally unique identifier (eg GS1 GTIN or digital link) of the product item. "},"name":{"type":"string","description":"The name of the product class to which the product item belongs. "}},"description":"A specific trade item /product code which could be either a product serial number or a consignment identifier "},"QuantityElement":{"type":"object","additionalProperties":false,"properties":{"productClass":{"type":"string","description":"THe identifier of a product class (as opposed to a product instance) such as a GTIN code for a manufactured product."},"quantity":{"type":"string","description":"The numeric quantity of the product class (eg 100 kg of cotton)"},"uom":{"type":"string","x-external-enumeration":"https://api.sustainability.unece.org/referenceData/unitOfMeasureCode","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://api.sustainability.unece.org/referenceData/unitOfMeasureCode\n "}},"description":"The quantity elment is used to define the quantities (eg 100), units of measure (eg Kg) and product class (eg GTIN or other class identifier) of products that are inputs or outputs or the subject of supply chain events. ","required":["quantity"]},"CertificationInfo":{"type":"object","additionalProperties":false,"properties":{"certificateID":{"x-jargon-isKey":true,"type":"string","format":"uri","description":"The ID of the certificate document"},"referenceStandard":{"type":"string","format":"uri","description":"The identifier (as a URI) of the sustainability standard against whichthe certificate is issued. For example abvtex.org.br/v4.0"},"evidenceURL":{"type":"string","format":"uri","description":"The URL of the certificate document. For privacy and integrity reasons, it is recommended (but not required) that * the documentURL is a hashlink (https://w3c-ccg.github.io/hashlink/) so that if the document the URL is changed then the hash verification will fail.* the document is encrypted for privacy reasons and that the symmetric key for decruption is provided as a URL parameter.* the document filename is a GUID so that there is no leakage of possibly identifying information in the URL.https://domain/GUID?h1={document_hash}&key={decryption_key}For examplehttps://docstore.com/ef1e69fbbeaf47b4af97e29c69dc09cf.pdf?h1=zQmWvQxTqbG2Z9HPJgG57jjwR154cKhbtJenbyYTWkjgF3e&key=462D4A614E645267556B587032733576"},"criteriaList":{"type":"array","items":{"type":"string","format":"uri"},"description":"Optional list of specific sustainability criteria that the certificate claims are met."},"assessmentLevel":{"type":"string","enum":["self-assessed","independent-certifier"],"example":"self-assessed","description":"The integrity level of the sustainability claims. Self asssed or independently certified. "},"responsibleAgency":{"$ref":"#/$defs/Party","description":"The issuing authority of the certificate."}},"description":"Details of a self asssessed or independently verified set of sustainability claims about a product or an establishment."}}} \ No newline at end of file +{"type":"object","additionalProperties":false,"properties":{"sourceParty":{"$ref":"#/$defs/Party","description":"The source party for this supply chain transaction - typcially the seller party"},"destinationParty":{"$ref":"#/$defs/Party","description":"The destination party for this supply chain transaction - typcially the buyer party."},"transaction":{"$ref":"#/$defs/TradeTransaction","description":"The supply chain transaction reference for this transaction event - eg the invoice, order, or despatch advice"},"itemList":{"type":"array","items":{"$ref":"#/$defs/Item"},"description":"The list of uniquely identified trade items included in this supply chain transaction."},"quantityList":{"type":"array","items":{"$ref":"#/$defs/QuantityElement"},"description":"List of quantified product classes that are included in theis transaction. Used whwn the trade items do not have unique identifiers (eg 100 reels of yarn)"},"eventID":{"readOnly":true,"type":"string","description":"The unique identifier of this event - SHOULD be a UUID"},"eventType":{"type":"string","enum":["object","transaction","aggregation","transformation"],"example":"object","description":"The event type - object, aggregation, transformation, transaction."},"eventTime":{"type":"string","description":"The ISO-8601 date time when the event occured."},"actionCode":{"type":"string","enum":["observe","add","delete"],"example":"observe","description":"The Action type says how an event relates to the lifecycle of the entity being described. For example, AggregationEvent is used to capture events related to aggregations of objects, such as cases aggregated to a pallet. Throughout its life, the pallet load participates in many business process steps, each of which may generate an EPCIS event. The action field of each event says how the aggregation itself has changed during the event: have objects been added to the aggregation, have objects been removed from the aggregation, or has the aggregation simply been observed without change to its membership? The action is independent of the bizStep (of type BusinessStepID) which identifies the specific business process step in which the action took place. allowed values are: - ADD (The entity in question has been created or added to.) - OBSERVE (Theentityinquestionhasnotbeenchanged:ithasneitherbeencreated,addedto,destroyed,orremovedfrom.) - DELETE (The entity in question has been removed from or destroyed altogether.)"},"dispositionCode":{"type":"string","enum":["active","expired","disposed","conformant","non_conformant","in-transit","dispensed"],"example":"active","description":"Disposition code is a vocabulary whose elements denote a business state of an object. An example is a code that denotes “recalled\". The disposition field of an event specifies the business condition of the event’s objects, subsequent to the event. The disposition is assumed to hold true until another event indicates a change of disposition. Intervening events that do not specify a disposition field have no effect on the presumed disposition of the object. The GS1 vocabulary (CBV v2.0) defines 33 possible disposition codes but this specification restricts the options to the minimum set of values that are relevant for supply chain traceability. "},"businessStepCode":{"type":"string","enum":["commissioning","inspecting","shipping","packing","unpacking"],"example":"commissioning","description":"BusinessStepID is a vocabulary whose elements denote steps in business processes. An example is an identifier that denotes “shipping.” The business step field of an event specifies the business context of an event: what business process step was taking place that caused the event to be captured? This specification has chosena 5 of the 41 possible bizstep values defined by GS1 that are appropriate for the sustainbility use case."},"readPointId":{"type":"string","description":"A Read Point is a discretely recorded location that is meant to identify the most specific place at which an EPCIS event took place. Read Points are determined by the EPCIS Capturing Application, perhaps inferred as a function of logical reader if stationary readers are used, perhaps determined overtly by reading a location tag if the reader is mobile, or in general determined by any other means the EPCIS Capturing Application chooses to use. Conceptually, the Read Point is designed to identify “where objects were at the time of the EPCIS event.”"},"locationId":{"type":"string","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 EPCIS event until it is reported to be at a different Business Location by a subsequent EPCIS event. This specification requires the use of https://maps.google.com/pluscodes/ as geospatial identifiers rather than identifier schemes that cannot be reolved to a geogrpahic point or area."},"certification":{"type":"array","items":{"$ref":"#/$defs/CertificationInfo"},"description":"Any test result or certification related to this EPCIS event.Could be self-assessed or independent and has asssociated sustainabiloity claims from the ITC vocabulary."}},"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.","$schema":"https://json-schema.org/draft/2020-12/schema","$defs":{"Party":{"type":"object","additionalProperties":false,"properties":{"partyID":{"type":"string","format":"uri","description":"The globally unique identifier of the party. This must be expressed as a URI that is (preferably) resolvable to an entity register such as a national business register - eg https://abr.business.gov.au/ABN/View?abn=41161080146 "},"name":{"type":"string","description":"The entity name of the identified party - usually the business anme from the corresponding natinal registery -eg ACME LTD"}},"description":"A trade party "},"TradeTransaction":{"type":"object","additionalProperties":false,"properties":{"type":{"type":"string","enum":["bol","cert","desadv","inv","po"],"example":"bol","description":"The document type representing the trade transaciton. This profile for supply chain traceability defines a simple subset of 5 document types that may be referenced by a transaction event."},"identifier":{"type":"string","description":"The identifier of the trade transaction document - eg an invoice number or bill of lading number. Must be unique for a given source party"},"documentURL":{"type":"string","format":"uri","description":"The URL of the referenced trade document. For privacy and integrity reasons, it is recommended (but not required) that * the documentURL is a hashlink (https://w3c-ccg.github.io/hashlink/) so that if the document the URL is changed then the hash verification will fail.* the document is encrypted for privacy reasons and that the hex encoded symmetric key for decruption is provided as a URL parameter.* the document filename is a GUID so that there is no leakage of possibly identifying information in the URL.https://domain/GUID?h1={document_hash}&key={decryption_key}For examplehttps://docstore.com/ef1e69fbbeaf47b4af97e29c69dc09cf.pdf?h1=zQmWvQxTqbG2Z9HPJgG57jjwR154cKhbtJenbyYTWkjgF3e&key=462D4A614E645267556B587032733576"}},"description":"A trade transaction between two parties such as an invoice, purchase order, or shipping notificaiotn."},"Item":{"type":"object","additionalProperties":false,"properties":{"itemID":{"type":"string","format":"uri","description":"The globally unique identifier (eg GS1 GTIN or digital link) of the product item. "},"name":{"type":"string","description":"The name of the product class to which the product item belongs. "}},"description":"A specific trade item /product code which could be either a product serial number or a consignment identifier "},"QuantityElement":{"type":"object","additionalProperties":false,"properties":{"productClass":{"type":"string","description":"THe identifier of a product class (as opposed to a product instance) such as a GTIN code for a manufactured product."},"quantity":{"type":"string","description":"The numeric quantity of the product class (eg 100 kg of cotton)"},"uom":{"type":"string","x-external-enumeration":"https://api.sustainability.unece.org/referenceData/unitOfMeasureCode","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://api.sustainability.unece.org/referenceData/unitOfMeasureCode\n "}},"description":"The quantity elment is used to define the quantities (eg 100), units of measure (eg Kg) and product class (eg GTIN or other class identifier) of products that are inputs or outputs or the subject of supply chain events. ","required":["quantity"]},"CertificationInfo":{"type":"object","additionalProperties":false,"properties":{"certificateID":{"type":"string","format":"uri","description":"The ID of the certificate document"},"referenceStandard":{"type":"string","format":"uri","description":"The identifier (as a URI) of the sustainability standard against whichthe certificate is issued. For example abvtex.org.br/v4.0"},"evidenceURL":{"type":"string","format":"uri","description":"The URL of the certificate document. For privacy and integrity reasons, it is recommended (but not required) that * the documentURL is a hashlink (https://w3c-ccg.github.io/hashlink/) so that if the document the URL is changed then the hash verification will fail.* the document is encrypted for privacy reasons and that the symmetric key for decruption is provided as a URL parameter.* the document filename is a GUID so that there is no leakage of possibly identifying information in the URL.https://domain/GUID?h1={document_hash}&key={decryption_key}For examplehttps://docstore.com/ef1e69fbbeaf47b4af97e29c69dc09cf.pdf?h1=zQmWvQxTqbG2Z9HPJgG57jjwR154cKhbtJenbyYTWkjgF3e&key=462D4A614E645267556B587032733576"},"criteriaList":{"type":"array","items":{"type":"string","format":"uri"},"description":"Optional list of specific sustainability criteria that the certificate claims are met."},"assessmentLevel":{"type":"string","enum":["self-assessed","independent-certifier"],"example":"self-assessed","description":"The integrity level of the sustainability claims. Self asssed or independently certified. "},"responsibleAgency":{"$ref":"#/$defs/Party","description":"The issuing authority of the certificate."}},"description":"Details of a self asssessed or independently verified set of sustainability claims about a product or an establishment."}}} \ No newline at end of file diff --git a/TransformationEvent.json b/TransformationEvent.json index be22b407c..d46fd8a79 100644 --- a/TransformationEvent.json +++ b/TransformationEvent.json @@ -1 +1 @@ -{"type":"object","additionalProperties":false,"properties":{"outputItemList":{"type":"array","items":{"$ref":"#/$defs/Item"},"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."},"inputItemList":{"type":"array","items":{"$ref":"#/$defs/Item"},"description":"The list of uniquely identified items that are the intput of this transformation event - for example a list of individually identified bobbins of yarn that are the input of a weaving process."},"inputQuantityList":{"type":"array","items":{"$ref":"#/$defs/QuantityElement"},"description":"The quantified list of product classes that are the input of this transformation event - usend when each item does not have a unique identity. for example the weight of raw cotton that is the input to a ginning process."},"outputQuantityList":{"type":"array","items":{"$ref":"#/$defs/QuantityElement"},"description":"The quantified list of product classes that are the output of this transformation event - usend 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."},"processType":{"type":"string","x-external-enumeration":"undefined","description":"An industry specific process type code. \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: undefined\n "},"eventID":{"x-jargon-isKey":true,"readOnly":true,"type":"string","description":"The unique identifier of this event - SHOULD be a UUID"},"eventType":{"type":"string","enum":["object","transaction","aggregation","transformation"],"example":"object","description":"The event type - object, aggregation, transformation, transaction."},"eventTime":{"type":"string","description":"The ISO-8601 date time when the event occured."},"actionCode":{"type":"string","enum":["observe","add","delete"],"example":"observe","description":"The Action type says how an event relates to the lifecycle of the entity being described. For example, AggregationEvent is used to capture events related to aggregations of objects, such as cases aggregated to a pallet. Throughout its life, the pallet load participates in many business process steps, each of which may generate an EPCIS event. The action field of each event says how the aggregation itself has changed during the event: have objects been added to the aggregation, have objects been removed from the aggregation, or has the aggregation simply been observed without change to its membership? The action is independent of the bizStep (of type BusinessStepID) which identifies the specific business process step in which the action took place. allowed values are: - ADD (The entity in question has been created or added to.) - OBSERVE (Theentityinquestionhasnotbeenchanged:ithasneitherbeencreated,addedto,destroyed,orremovedfrom.) - DELETE (The entity in question has been removed from or destroyed altogether.)"},"dispositionCode":{"type":"string","enum":["active","expired","disposed","conformant","non_conformant","in-transit","dispensed"],"example":"active","description":"Disposition code is a vocabulary whose elements denote a business state of an object. An example is a code that denotes “recalled\". The disposition field of an event specifies the business condition of the event’s objects, subsequent to the event. The disposition is assumed to hold true until another event indicates a change of disposition. Intervening events that do not specify a disposition field have no effect on the presumed disposition of the object. The GS1 vocabulary (CBV v2.0) defines 33 possible disposition codes but this specification restricts the options to the minimum set of values that are relevant for supply chain traceability. "},"businessStepCode":{"type":"string","enum":["commissioning","inspecting","shipping","packing","unpacking"],"example":"commissioning","description":"BusinessStepID is a vocabulary whose elements denote steps in business processes. An example is an identifier that denotes “shipping.” The business step field of an event specifies the business context of an event: what business process step was taking place that caused the event to be captured? This specification has chosena 5 of the 41 possible bizstep values defined by GS1 that are appropriate for the sustainbility use case."},"readPointId":{"type":"string","description":"A Read Point is a discretely recorded location that is meant to identify the most specific place at which an EPCIS event took place. Read Points are determined by the EPCIS Capturing Application, perhaps inferred as a function of logical reader if stationary readers are used, perhaps determined overtly by reading a location tag if the reader is mobile, or in general determined by any other means the EPCIS Capturing Application chooses to use. Conceptually, the Read Point is designed to identify “where objects were at the time of the EPCIS event.”"},"locationId":{"type":"string","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 EPCIS event until it is reported to be at a different Business Location by a subsequent EPCIS event. This specification requires the use of https://maps.google.com/pluscodes/ as geospatial identifiers rather than identifier schemes that cannot be reolved to a geogrpahic point or area."},"certification":{"type":"array","items":{"$ref":"#/$defs/CertificationInfo"},"description":"Any test result or certification related to this EPCIS event.Could be self-assessed or independent and has asssociated sustainabiloity claims from the ITC vocabulary."}},"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.","$schema":"https://json-schema.org/draft/2020-12/schema","$defs":{"Item":{"type":"object","additionalProperties":false,"properties":{"itemID":{"x-jargon-isKey":true,"type":"string","format":"uri","description":"The globally unique identifier (eg GS1 GTIN or digital link) of the product item. "},"name":{"type":"string","description":"The name of the product class to which the product item belongs. "}},"description":"A specific trade item /product code which could be either a product serial number or a consignment identifier "},"QuantityElement":{"type":"object","additionalProperties":false,"properties":{"productClass":{"type":"string","description":"THe identifier of a product class (as opposed to a product instance) such as a GTIN code for a manufactured product."},"quantity":{"type":"string","description":"The numeric quantity of the product class (eg 100 kg of cotton)"},"uom":{"type":"string","x-external-enumeration":"https://api.sustainability.unece.org/referenceData/unitOfMeasureCode","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://api.sustainability.unece.org/referenceData/unitOfMeasureCode\n "}},"description":"The quantity elment is used to define the quantities (eg 100), units of measure (eg Kg) and product class (eg GTIN or other class identifier) of products that are inputs or outputs or the subject of supply chain events. ","required":["quantity"]},"CertificationInfo":{"type":"object","additionalProperties":false,"properties":{"certificateID":{"x-jargon-isKey":true,"type":"string","format":"uri","description":"The ID of the certificate document"},"referenceStandard":{"type":"string","format":"uri","description":"The identifier (as a URI) of the sustainability standard against whichthe certificate is issued. For example abvtex.org.br/v4.0"},"evidenceURL":{"type":"string","format":"uri","description":"The URL of the certificate document. For privacy and integrity reasons, it is recommended (but not required) that * the documentURL is a hashlink (https://w3c-ccg.github.io/hashlink/) so that if the document the URL is changed then the hash verification will fail.* the document is encrypted for privacy reasons and that the symmetric key for decruption is provided as a URL parameter.* the document filename is a GUID so that there is no leakage of possibly identifying information in the URL.https://domain/GUID?h1={document_hash}&key={decryption_key}For examplehttps://docstore.com/ef1e69fbbeaf47b4af97e29c69dc09cf.pdf?h1=zQmWvQxTqbG2Z9HPJgG57jjwR154cKhbtJenbyYTWkjgF3e&key=462D4A614E645267556B587032733576"},"criteriaList":{"type":"array","items":{"type":"string","format":"uri"},"description":"Optional list of specific sustainability criteria that the certificate claims are met."},"assessmentLevel":{"type":"string","enum":["self-assessed","independent-certifier"],"example":"self-assessed","description":"The integrity level of the sustainability claims. Self asssed or independently certified. "},"responsibleAgency":{"$ref":"#/$defs/Party","description":"The issuing authority of the certificate."}},"description":"Details of a self asssessed or independently verified set of sustainability claims about a product or an establishment."},"Party":{"type":"object","additionalProperties":false,"properties":{"partyID":{"x-jargon-isKey":true,"type":"string","format":"uri","description":"The globally unique identifier of the party. This must be expressed as a URI that is (preferably) resolvable to an entity register such as a national business register - eg https://abr.business.gov.au/ABN/View?abn=41161080146 "},"name":{"type":"string","description":"The entity name of the identified party - usually the business anme from the corresponding natinal registery -eg ACME LTD"}},"description":"A trade party "}}} \ No newline at end of file +{"type":"object","additionalProperties":false,"properties":{"outputItemList":{"type":"array","items":{"$ref":"#/$defs/Item"},"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."},"inputItemList":{"type":"array","items":{"$ref":"#/$defs/Item"},"description":"The list of uniquely identified items that are the intput of this transformation event - for example a list of individually identified bobbins of yarn that are the input of a weaving process."},"inputQuantityList":{"type":"array","items":{"$ref":"#/$defs/QuantityElement"},"description":"The quantified list of product classes that are the input of this transformation event - usend when each item does not have a unique identity. for example the weight of raw cotton that is the input to a ginning process."},"outputQuantityList":{"type":"array","items":{"$ref":"#/$defs/QuantityElement"},"description":"The quantified list of product classes that are the output of this transformation event - usend 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."},"processType":{"type":"string","x-external-enumeration":"undefined","description":"An industry specific process type code. \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: undefined\n "},"eventID":{"readOnly":true,"type":"string","description":"The unique identifier of this event - SHOULD be a UUID"},"eventType":{"type":"string","enum":["object","transaction","aggregation","transformation"],"example":"object","description":"The event type - object, aggregation, transformation, transaction."},"eventTime":{"type":"string","description":"The ISO-8601 date time when the event occured."},"actionCode":{"type":"string","enum":["observe","add","delete"],"example":"observe","description":"The Action type says how an event relates to the lifecycle of the entity being described. For example, AggregationEvent is used to capture events related to aggregations of objects, such as cases aggregated to a pallet. Throughout its life, the pallet load participates in many business process steps, each of which may generate an EPCIS event. The action field of each event says how the aggregation itself has changed during the event: have objects been added to the aggregation, have objects been removed from the aggregation, or has the aggregation simply been observed without change to its membership? The action is independent of the bizStep (of type BusinessStepID) which identifies the specific business process step in which the action took place. allowed values are: - ADD (The entity in question has been created or added to.) - OBSERVE (Theentityinquestionhasnotbeenchanged:ithasneitherbeencreated,addedto,destroyed,orremovedfrom.) - DELETE (The entity in question has been removed from or destroyed altogether.)"},"dispositionCode":{"type":"string","enum":["active","expired","disposed","conformant","non_conformant","in-transit","dispensed"],"example":"active","description":"Disposition code is a vocabulary whose elements denote a business state of an object. An example is a code that denotes “recalled\". The disposition field of an event specifies the business condition of the event’s objects, subsequent to the event. The disposition is assumed to hold true until another event indicates a change of disposition. Intervening events that do not specify a disposition field have no effect on the presumed disposition of the object. The GS1 vocabulary (CBV v2.0) defines 33 possible disposition codes but this specification restricts the options to the minimum set of values that are relevant for supply chain traceability. "},"businessStepCode":{"type":"string","enum":["commissioning","inspecting","shipping","packing","unpacking"],"example":"commissioning","description":"BusinessStepID is a vocabulary whose elements denote steps in business processes. An example is an identifier that denotes “shipping.” The business step field of an event specifies the business context of an event: what business process step was taking place that caused the event to be captured? This specification has chosena 5 of the 41 possible bizstep values defined by GS1 that are appropriate for the sustainbility use case."},"readPointId":{"type":"string","description":"A Read Point is a discretely recorded location that is meant to identify the most specific place at which an EPCIS event took place. Read Points are determined by the EPCIS Capturing Application, perhaps inferred as a function of logical reader if stationary readers are used, perhaps determined overtly by reading a location tag if the reader is mobile, or in general determined by any other means the EPCIS Capturing Application chooses to use. Conceptually, the Read Point is designed to identify “where objects were at the time of the EPCIS event.”"},"locationId":{"type":"string","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 EPCIS event until it is reported to be at a different Business Location by a subsequent EPCIS event. This specification requires the use of https://maps.google.com/pluscodes/ as geospatial identifiers rather than identifier schemes that cannot be reolved to a geogrpahic point or area."},"certification":{"type":"array","items":{"$ref":"#/$defs/CertificationInfo"},"description":"Any test result or certification related to this EPCIS event.Could be self-assessed or independent and has asssociated sustainabiloity claims from the ITC vocabulary."}},"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.","$schema":"https://json-schema.org/draft/2020-12/schema","$defs":{"Item":{"type":"object","additionalProperties":false,"properties":{"itemID":{"type":"string","format":"uri","description":"The globally unique identifier (eg GS1 GTIN or digital link) of the product item. "},"name":{"type":"string","description":"The name of the product class to which the product item belongs. "}},"description":"A specific trade item /product code which could be either a product serial number or a consignment identifier "},"QuantityElement":{"type":"object","additionalProperties":false,"properties":{"productClass":{"type":"string","description":"THe identifier of a product class (as opposed to a product instance) such as a GTIN code for a manufactured product."},"quantity":{"type":"string","description":"The numeric quantity of the product class (eg 100 kg of cotton)"},"uom":{"type":"string","x-external-enumeration":"https://api.sustainability.unece.org/referenceData/unitOfMeasureCode","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://api.sustainability.unece.org/referenceData/unitOfMeasureCode\n "}},"description":"The quantity elment is used to define the quantities (eg 100), units of measure (eg Kg) and product class (eg GTIN or other class identifier) of products that are inputs or outputs or the subject of supply chain events. ","required":["quantity"]},"CertificationInfo":{"type":"object","additionalProperties":false,"properties":{"certificateID":{"type":"string","format":"uri","description":"The ID of the certificate document"},"referenceStandard":{"type":"string","format":"uri","description":"The identifier (as a URI) of the sustainability standard against whichthe certificate is issued. For example abvtex.org.br/v4.0"},"evidenceURL":{"type":"string","format":"uri","description":"The URL of the certificate document. For privacy and integrity reasons, it is recommended (but not required) that * the documentURL is a hashlink (https://w3c-ccg.github.io/hashlink/) so that if the document the URL is changed then the hash verification will fail.* the document is encrypted for privacy reasons and that the symmetric key for decruption is provided as a URL parameter.* the document filename is a GUID so that there is no leakage of possibly identifying information in the URL.https://domain/GUID?h1={document_hash}&key={decryption_key}For examplehttps://docstore.com/ef1e69fbbeaf47b4af97e29c69dc09cf.pdf?h1=zQmWvQxTqbG2Z9HPJgG57jjwR154cKhbtJenbyYTWkjgF3e&key=462D4A614E645267556B587032733576"},"criteriaList":{"type":"array","items":{"type":"string","format":"uri"},"description":"Optional list of specific sustainability criteria that the certificate claims are met."},"assessmentLevel":{"type":"string","enum":["self-assessed","independent-certifier"],"example":"self-assessed","description":"The integrity level of the sustainability claims. Self asssed or independently certified. "},"responsibleAgency":{"$ref":"#/$defs/Party","description":"The issuing authority of the certificate."}},"description":"Details of a self asssessed or independently verified set of sustainability claims about a product or an establishment."},"Party":{"type":"object","additionalProperties":false,"properties":{"partyID":{"type":"string","format":"uri","description":"The globally unique identifier of the party. This must be expressed as a URI that is (preferably) resolvable to an entity register such as a national business register - eg https://abr.business.gov.au/ABN/View?abn=41161080146 "},"name":{"type":"string","description":"The entity name of the identified party - usually the business anme from the corresponding natinal registery -eg ACME LTD"}},"description":"A trade party "}}} \ No newline at end of file