Dev:API - Supply

The Supply API provides functionality to support the ownership transfer requirements typical of a supply chain process. Items in the supply chain can be given a value and this value can be updated over time. The supply API supports the readonly, raw, basic and JSON formats and the user is required to specify the format.

The readonly and raw formats are useful when developers wish to store arbitrary data, without incurring the overhead of defining an object. The value will be provided with the data parameter. The readonly format cannot be updated and is stored in a readonly register. The raw format is stored in a raw register and allows the data to be updated.

The basic format allows callers to define an asset in terms of simple key=value pairs. It assumes all values are stored using the string data type. The key=value pairs can be updated. . The JSON format allows callers to provide a detailed definition of the supply data structure, with each field defined with a specific data type and mutability. Items defined with one of the complex formats can be updated after their initial creation.

The supply API also provides a history of changes to the values, as well as the history of ownership of the item.

The full supported endpoint of the supply URI is as follows:

supply/verb/noun/filter/operator

The minimum required components of the URI are:

supply/verb/noun