Skip to content

dubnemo/Traceability-API

Repository files navigation

Traceability API

Scope

This Function application implements the AgGateway Traceability API particularly focused on

  • Traceability Resource Units (TRU) which represents the quantity and quality measurements of an item in a container at a point in time
  • Critical Tracking Events (CTE) particularly focused on the new Transfer Event where a TRU is transferred from one container into another container using a device resource, and potential having a remaining amount. Other CTEs are historically supported including the Transport Event, Change of Custody Event and the Change of Ownership Event. Another new event is the Identification Event, which is the act of identification and provision of a unique identifier to record the event, item, device, container, etc.
  • Key Data Elements including the shipment id, dock door id, trailer id, container id, field id, farmer id, farmer id, GLN, GTIN for product, etc. KDEs are most often identifiers and not measurements or observations. They help with the linkage of TRUs and CTEs.

Endpoints

The endpoints are defined by the OpenAPI specification generated from the NIST Score tool, and developed by the AgGateway Traceability Work Group.

Critical Tracking Event

POST /traceability/V2/critical-tracking-event POST /traceability/V2/critical-tracking-event-list GET /traceability/V2/critical-tracking-event-list GET /traceability/V2/critical-tracking-event/{id} PATCH /traceability/V2/critical-tracking-event/{id}

Field Operations

POST /traceability/V2/operation PATCH /traceability/V2/operation/{id} POST /traceability/V2/operator-party GET /traceability/V2/container/{id} GET /traceability/V2/container-list GET /traceability/V2/device-resource-list GET /traceability/V2/field/{id} GET /traceability/V2/field-list

Traceable Resource Unit

POST /traceability/V2/traceable-resource-unit GET /traceability/V2/traceable-resource-unit/{id} PATCH /traceability/V2/traceable-resource-unit/{id} GET /traceability/V2/traceable-resource-unit-list PATCH /traceability/V2/traceable-resource-unit/{id}/container-state

Planting Operations Scenario

The planting operations sequence diagram shows which Traceability API V2 endpoints are used for this scenario. This involves logging into an application, loading the planter box from a seed tender (transfer event of TRUs), planting the seed into the field (transfer event of TRUs), and iterating until the field is completely. There could also be another scenario focused on positioning the seed tender properly for the refilling operations, knowing the points on the map wehere this occurred (transport event of the TRUs). In these scenarios, the container will likely have a remaining amount as it is not convenient to move the seed tender to the middle of the field.

About

Implements the AgGateway Traceability API standard, focused on the linkage and definitions of Traceable Resource Unit

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages