{"info":{"_postman_id":"c29e94c1-0fbf-4e84-b3b7-9fc771c1a6ef","name":"Hubwatch API Documentation","description":"

Welcome to Hubwatch API Documentation.

\n

Using this API you can push your data to the blockchain in the form of Assets and Events.

\n

Authentication

\n

Before you can start interacting with API you need to create an account. An account is a pair: address and private key. Using this key pair, a web3 token can be created to call the API. For more details jump to Authentication - Token section

\n

Key points

\n

API URL

\n

The API is deployed as a part of the blockchain node, hence the URL changes dynamically in terms of IP address used. While implementing, the user must enter the IP address of the server on which the blockchain node is deployed, in order to successfully send data using the API. Highlighted in bold, below is the part which the user needs to replace with their own server IP.

\n

http://13.40.34.231/auth/getApiToken

\n

http://13.40.34.231/unova/api

\n

Unique ID

\n

This is the unique identifier of each asset in the system. It could be a barcode,GTIN number etc

\n

Assets Referenced Or Added

\n

An asset creation will have either of the three phases

\n
    \n
  1. Commission
    2. \n
  2. Transformation
    3. \n
  3. Aggregation
    4. \n
\n

In case of Transformation and Aggregation, it is necessary to establish a link between the assets involved in the action, so as to offer complete traceability. 'Assets Referenced Or Added' help in establishing this link.It refers to the UniqueIDs of the parent asset, or UniqueIDs of assets that went into the formation of the current asset.

\n

This field is not considered during the Commission phase as it is the first occurrence of the asset.

\n

Internal Operations Flow Mapper (IOFM)

\n

The purpose of the IOFM is to help you visualize, understand and create the events (or asset creations) that will occur inside your own company. This tool can also be considered as a settings page, that will be used in other aspects of the Hubwatch platform and impact the API. It is thus important to be attentive and mindful when mapping your internal flow, and be accurate with regards to the settings you select.

\n

In short, the IOFM lets you select and configure asset creations and events in a chronological order to form a chain/flow.

\n

Once you have added an event type (or asset creation type) to your flow, this will also be the place for testing, validating and visualizing the data you are creating (either via the API or via manual form input).

\n

Supply Chain Grouping

\n

A single network to which any (global or domestic) supply chain stakeholder can join requires privacy-enabled data distribution clusters and cross-cluster distribution capabilities. Essentially this means that each participant within the network needs to be able to control which stakeholder will receive specific bundles of data. This creates a network within which there will be clusters of supply chain partners, but at the same time, each participant in such a cluster may still receive data from outside this specific cluster (making it cross-cluster). It accommodates supply chain stakeholders being part of multiple supply chains.
The Unova privacy-enabled distribution protocol is specifically designed to attain the above goal.

\n

Implementation :

\n
    \n
  1. The Hubwatch Onboarding platform hosts a partner module, in which the user can add partners to whom data will be distributed to.
    2. \n
  2. While adding a partner, group number(s) needs to be assigned to the partner. This group number is indicative of a set of partners in a single supply chain. This grouping allows the user to create a cluster of relevant partners, and distribute data to that cluster. If there is no group number assigned, group number 1 will be assigned by default.
    3. \n
  3. While creating an asset or an event, the request body contains a parameter ‘groupNumbers’. The user assigns the correct group number(s) to this parameter, specifying to which group(s) this asset/event needs to be distributed to, and creates the data. During data distribution, all the participants in the specified group(s) receive the data for the particular asset/event.
    4. \n
\n

Supply chain grouping enables each participant to keep control over their data at a granular level and decide who they wish to share it with.

\n

Success Response

\n

Response consists of following blocks of information

\n
    \n
  1. Asset/Event Metadata from Blockchain
    2. \n
  2. Bundle Metadata from Blockchain
    3. \n
  3. Contents of data request
    4. \n
\n

Errors

\n

The majority of errors along to the error code provide additional information in body with following format
{
\"reason\": \"What happened\"
}

\n

Immutability

\n

Note:
All data is immutable, therefore, you will not find update or delete calls. However, things could change in a supply chain, which means in this case you may want to create another event in case an update of information is needed.

\n

Hashing

\n

Hashes are a very important part of proving the persistence and the immutability of the data. All hashes in the are computed using the ethereum standard hashMessage function as described in web3 docs. The underlying hash function is Keccak256.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Authentication","slug":"authentication"},{"content":"Key points","slug":"key-points"},{"content":"Success Response","slug":"success-response"},{"content":"Errors","slug":"errors"},{"content":"Immutability","slug":"immutability"},{"content":"Hashing","slug":"hashing"}],"owner":"19696378","collectionId":"c29e94c1-0fbf-4e84-b3b7-9fc771c1a6ef","publishedId":"2s8Z76vUaQ","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"399af2"},"publishDate":"2023-01-10T09:26:37.000Z"},"item":[{"name":"Authentication - Token","item":[{"name":"Get a token","id":"bd40bae1-ada3-4ebf-8bf3-9ce621c85d07","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"privateKey\":\"0xaf6331bbf1......5a44e0e0e2ba\"\n}","options":{"raw":{"language":"json"}}},"url":"http://13.40.34.231/auth/getApiToken","urlObject":{"protocol":"http","path":["auth","getApiToken"],"host":["13","40","34","231"],"query":[],"variable":[]}},"response":[{"id":"4b3c7e6f-39ff-4eb3-86cf-000bc97303fa","name":"Get a token","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"privateKey\":\"0xaf6331bbf1......5a44e0e0e2ba\"\n}","options":{"raw":{"language":"json"}}},"url":"http://13.40.34.231/auth/getApiToken"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"cache-control","value":"no-store"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"376"},{"key":"ETag","value":"W/\"178-j7PLqdi3gxItfPrcnZ+r5Z2tjls\""},{"key":"Date","value":"Fri, 03 Mar 2023 09:46:45 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"apiToken\": \"UNOVA_TOKEN eyJpZE......IxYyJ9\"\n },\n \"meta\": {\n \"code\": 200\n }\n}"}],"_postman_id":"bd40bae1-ada3-4ebf-8bf3-9ce621c85d07"}],"id":"879f606a-ee70-4826-8887-d24bb5d23c8c","description":"

This API uses web3 token based authentication and authorization.
The \"sign\" and \"privateKeyToAccount\" functions from the web3 library are used to generate a signature and the address respectively. This signature and address along with timestamp are used by the getapitoken function to create the token for authentication.

\n

The token is valid for 5 days.

\n

Never share your private key with anyone. This is a security risk.

\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"c342cf3e-d23a-41fa-886c-defd1f2d40f1"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"6889c344-3b52-427d-8d18-123ebff85fab"}}],"_postman_id":"879f606a-ee70-4826-8887-d24bb5d23c8c"},{"name":"All about Assets","item":[{"name":"What is an Asset?","item":[],"id":"9fbc331f-68e8-4a70-b2a0-03f72c8f9f73","description":"

A digital entity for any physical conceptual element in your supply chain. Depending on the industry it can be a cow, box of apples, an apple, a piece of meat, a lasagna, a lot, batch or box etc. Every asset has a UniqueID that is crypto secured.

\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"3c784d8c-644d-4cef-93c9-9c8c2dc9570b"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"22ac836f-60e2-4a6c-bca0-b4dce8b15a6b"}}],"_postman_id":"9fbc331f-68e8-4a70-b2a0-03f72c8f9f73","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"92dae85d-d24a-4ac5-9e61-6d677e3773ca","id":"92dae85d-d24a-4ac5-9e61-6d677e3773ca","name":"All about Assets","type":"folder"}}},{"name":"Creating an Asset","item":[{"name":"Mandatory and Recommended Field Lists","item":[{"name":"Create Asset - Mandatory Fields Example","id":"5ca9cbac-4bbe-4d3e-9e4b-ee19fcfb3f91","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"UNOVA_TOKEN eyJpZE......IxYyJ9","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"requestbody","value":"{\"typeOfRequest\":\"asset\",\n\"privateKey\":\"0xaf6331bbf1......5a44e0e0e2ba\",\n\"companyIdentifier\":\"Primary producer/farm\",\n\"eventType\":\"Commission\",\n\"packagingID\":\"Serial\",\n\"assetType\":\"cow\",\n\"name\":\"Cow Birth\",\n\"uniqueID\":\"BE0956984520\",\n\"timestamp\":\"2022-02-01 09:20:27\",\n\"organizationName\":\"RL Facility\",\n\"streetAndNumber\":\"Koetsweg 207\",\n\"zipcodeAndCity\":\"3010 Leuven\",\n\"groupNumbers\":\"1,3\"\n}","type":"text"}]},"url":"http://13.40.34.231/unova/api","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"92dae85d-d24a-4ac5-9e61-6d677e3773ca","id":"92dae85d-d24a-4ac5-9e61-6d677e3773ca","name":"All about Assets","type":"folder"}},"urlObject":{"protocol":"http","path":["unova","api"],"host":["13","40","34","231"],"query":[],"variable":[]}},"response":[{"id":"e23ca4f2-e9dc-42c9-b8b2-b0acd12bb255","name":"Create Asset - Mandatory Fields Example","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"UNOVA_TOKEN eyJpZE......IxYyJ9","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"requestbody","value":"{\"typeOfRequest\":\"asset\",\n\"privateKey\":\"0xaf6331bbf1......5a44e0e0e2ba\",\n\"companyIdentifier\":\"Primary producer/farm\",\n\"eventType\":\"Commission\",\n\"packagingID\":\"Serial\",\n\"assetType\":\"cow\",\n\"name\":\"Cow Birth\",\n\"uniqueID\":\"BE0956984520\",\n\"timestamp\":\"2022-02-01 09:20:27\",\n\"organizationName\":\"RL Facility\",\n\"streetAndNumber\":\"Koetsweg 207\",\n\"zipcodeAndCity\":\"3010 Leuven\",\n\"groupNumbers\":\"1,3\"\n}","type":"text"}]},"url":"http://13.40.34.231/unova/api"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"cache-control","value":"no-store"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"1840"},{"key":"ETag","value":"W/\"730-FsAZbT2NqkKF1mYFroxqpBtFxV4\""},{"key":"Date","value":"Fri, 03 Mar 2023 09:55:49 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"Success\",\n \"message\": \"Asset created successfully\",\n \"response\": {\n \"data\": {\n \"_id\": \"6401c425de5af7001c5e4c49\",\n \"eventId\": \"0x82024c33d22d21b1013e66d81b758b0bec3fe40efd47820a5b0e33b1fdd917ff\",\n \"organizationId\": 1,\n \"metadata\": [\n {\n \"bundleId\": null,\n \"bundleUploadTimestamp\": 1677837349,\n \"group\": 1\n },\n {\n \"bundleId\": null,\n \"bundleUploadTimestamp\": 1677837349,\n \"group\": 3\n }\n ],\n \"content\": {\n \"idData\": {\n \"uniqueID\": \"BE0956984520\",\n \"timestamp\": 1677837349,\n \"createdBy\": \"0x320389eB491a48700Ca8DA35FC136a3C8dd9e5E8\",\n \"dataHash\": \"0xe5c11d33e93d4f361b6be0586cf405caf11e098e01bc795da0a61682af869bce\"\n },\n \"signature\": \"0x5a4141182c5925837d32b88bc1f4ab08bc1862972b6c15c19c94c547697660e16226bada84a41044f85c1f49d82ddde2416fd23c555a6ddfafe9c0b11a204c361b\",\n \"data\": [\n {\n \"identifiers\": {\n \"uniqueID\": [\n \"BE0956984520\"\n ]\n }\n },\n {\n \"name\": \"Cow Birth\",\n \"companyIdentifier\": \"Primary producer/farm\",\n \"eventType\": \"Commission\",\n \"packagingID\": \"Serial\",\n \"assetType\": \"cow\",\n \"creationTimestamp\": 1643707227,\n \"organizationName\": \"RL Facility\",\n \"streetAndNumber\": \"Koetsweg 207\",\n \"zipcodeAndCity\": \"3010 Leuven\",\n \"groupNumbers\": [\n {\n \"group\": 1,\n \"isBundled\": false\n },\n {\n \"group\": 3,\n \"isBundled\": false\n }\n ]\n },\n {}\n ]\n }\n },\n \"meta\": {\n \"code\": 200\n }\n }\n}"}],"_postman_id":"5ca9cbac-4bbe-4d3e-9e4b-ee19fcfb3f91"}],"id":"0f1ddd76-62d5-45f7-9a43-8759cda96e3b","description":"

Below is a list of mandatory and recommended fields. The data request cannot be successfully sent without including all the mandatory fields, and will show errors until all of them are included. The recommended fields, which are related to organization information, are optional and can be left out of the data request. However to receive most accurate results out of the data down applications we recommend to include these fields in the mentioned format in the data request.

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Field NameDescription
typeOfRequest (mandatory)\"asset\"
privateKey (mandatory)Private Key of Account
name (mandatory)Name of asset creation specified in Your Chain via the Unova Chain Builder
eventType (mandatory)Type of asset creation specified in Your Chain via the Unova Chain Builder. Accepts only \"Commission\"/\"Transformation\"/\"Aggregation\"
packagingID (mandatory)Type of packaging of asset specified in Your Chain via the Unova Chain Builder. Accepts only \"Serial\"/\"Pallet\"/\"Lot\"
assetType (mandatory)Type of Asset being traced
uniqueID (mandatory)Unique ID of the asset - eg GTIN number
timestamp (mandatory)Timestamp of asset creation. Validated input. Format : \"yyyy-mm-dd hh:mm:ss\"
organizationName (recommended)Name of Organization
streetAndNumber (recommended)Location of Organization - Street Name & Street Number
zipcodeAndCity (recommended)Location of Organization - Zipcode & City
companyIdentifier (recommended)Type of Organization. Accepts only \"Primary producer/farm\"/\"Warehouse\"/\"Manufacturer of goods\"/\"Packaging\"/\"Distribution center\"/\"Store\"/\"Transporter\"
groupNumbers (recommended)Group numbers of partners to whom the asset data is to be distributed. Comma separated values (currently limited from 1 to 5). If not sent in request, default is group 1.
\n
","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"dc4ec400-7720-4f25-a1c3-7e90defc280f"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"40ccf823-a646-4912-8d43-b8c1d773bb89"}}],"_postman_id":"0f1ddd76-62d5-45f7-9a43-8759cda96e3b","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"92dae85d-d24a-4ac5-9e61-6d677e3773ca","id":"92dae85d-d24a-4ac5-9e61-6d677e3773ca","name":"All about Assets","type":"folder"}}},{"name":"Additional Field Lists","item":[{"name":"Create Asset - Additional Fields Example","id":"30bb316a-b1ba-4501-b330-a5145bcb4554","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"UNOVA_TOKEN eyJpZE......IxYyJ9","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"requestbody","value":"{\"typeOfRequest\":\"asset\",\n\"privateKey\":\"0xaf6331bbf1......5a44e0e0e2ba\",\n\"companyIdentifier\":\"Primary producer/farm\",\n\"eventType\":\"Commission\",\n\"packagingID\":\"Serial\",\n\"assetType\":\"cow\",\n\"name\":\"Cow Birth\",\n\"uniqueID\":\"BE0956984521\",\n\"timestamp\":\"2022-02-01 09:20:27\",\n\"organizationName\":\"RL Facility\",\n\"streetAndNumber\":\"Koetsweg 207\",\n\"zipcodeAndCity\":\"3010 Leuven\",\n\"herdCode\":\"HC1000\",\n\"race\":\"Limousin\",\n\"fur color\":\"brown\",\n\"groupNumbers\":\"1,3\"\n}","type":"text"}]},"url":"http://13.40.34.231/unova/api","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"92dae85d-d24a-4ac5-9e61-6d677e3773ca","id":"92dae85d-d24a-4ac5-9e61-6d677e3773ca","name":"All about Assets","type":"folder"}},"urlObject":{"protocol":"http","path":["unova","api"],"host":["13","40","34","231"],"query":[],"variable":[]}},"response":[{"id":"2c003510-9302-485c-a1ee-474b838e95e8","name":"Create Asset - Additional Fields Example","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"UNOVA_TOKEN eyJpZE......IxYyJ9","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"requestbody","value":"{\"typeOfRequest\":\"asset\",\n\"privateKey\":\"0xaf6331bbf1......5a44e0e0e2ba\",\n\"companyIdentifier\":\"Primary producer/farm\",\n\"eventType\":\"Commission\",\n\"packagingID\":\"Serial\",\n\"assetType\":\"cow\",\n\"name\":\"Cow Birth\",\n\"uniqueID\":\"BE0956984521\",\n\"timestamp\":\"2022-02-01 09:20:27\",\n\"organizationName\":\"RL Facility\",\n\"streetAndNumber\":\"Koetsweg 207\",\n\"zipcodeAndCity\":\"3010 Leuven\",\n\"herdCode\":\"HC1000\",\n\"race\":\"Limousin\",\n\"fur color\":\"brown\",\n\"groupNumbers\":\"1,3\"\n}","type":"text"}]},"url":"http://13.40.34.231/unova/api"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"cache-control","value":"no-store"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"1940"},{"key":"ETag","value":"W/\"794-3BY9/eoWWdR8EZtokhNqNe+hmZo\""},{"key":"Date","value":"Fri, 03 Mar 2023 10:39:32 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"Success\",\n \"message\": \"Asset created successfully\",\n \"response\": {\n \"data\": {\n \"_id\": \"6401ce648d47d4001c96c47d\",\n \"eventId\": \"0x8f260bb9729f40572df3f8bc220c843678411d742f6b65361be77ce8daa3d4ea\",\n \"organizationId\": 1,\n \"metadata\": [\n {\n \"bundleId\": null,\n \"bundleUploadTimestamp\": 1677839972,\n \"group\": 1\n },\n {\n \"bundleId\": null,\n \"bundleUploadTimestamp\": 1677839972,\n \"group\": 3\n }\n ],\n \"content\": {\n \"idData\": {\n \"uniqueID\": \"BE0956984521\",\n \"timestamp\": 1677839972,\n \"createdBy\": \"0x320389eB491a48700Ca8DA35FC136a3C8dd9e5E8\",\n \"dataHash\": \"0x85e994b44de5515d5a2fcb0380ef29e67c260c067ff9b5583acc84ddc159d003\"\n },\n \"signature\": \"0x27a7373f13f27ef1e28fec0fc002bac7fd14a12f1d1dcb1ffc7fd4fc66deb48f0987f25248de73c5abeb664c7e1b467f771ef80f0dfa66d693efc2c98644805f1b\",\n \"data\": [\n {\n \"identifiers\": {\n \"uniqueID\": [\n \"BE0956984521\"\n ]\n }\n },\n {\n \"name\": \"Cow Birth\",\n \"companyIdentifier\": \"Primary producer/farm\",\n \"eventType\": \"Commission\",\n \"packagingID\": \"Serial\",\n \"assetType\": \"cow\",\n \"creationTimestamp\": 1643707227,\n \"organizationName\": \"RL Facility\",\n \"streetAndNumber\": \"Koetsweg 207\",\n \"zipcodeAndCity\": \"3010 Leuven\",\n \"herdCode\": \"HC1000\",\n \"race\": \"Limousin\",\n \"fur color\": \"brown\",\n \"groupNumbers\": [\n {\n \"group\": 1,\n \"isBundled\": false\n },\n {\n \"group\": 3,\n \"isBundled\": false\n }\n ]\n },\n {}\n ]\n }\n },\n \"meta\": {\n \"code\": 200\n }\n }\n}"}],"_postman_id":"30bb316a-b1ba-4501-b330-a5145bcb4554"}],"id":"487dd6ec-e90d-4f89-9e5f-f71a05f98b14","description":"

Apart from the mandatory fields, each company needs to provide relevant data to the asset creations. The API accepts any number of additional fields that the company system might hold, and want to send to the blockchain. Here we use farm as an example and append additional fields with respect to the cow birth event.

\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"18a184ff-bfe8-444f-aab4-2539502d75b1"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"20f7b258-8381-45b1-bb09-9262028403ec"}}],"_postman_id":"487dd6ec-e90d-4f89-9e5f-f71a05f98b14","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"92dae85d-d24a-4ac5-9e61-6d677e3773ca","id":"92dae85d-d24a-4ac5-9e61-6d677e3773ca","name":"All about Assets","type":"folder"}}},{"name":"Add documents","item":[{"name":"Add documents - Asset - Example","id":"da2b9b8f-a4c8-4501-a1f2-ba802621481d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"UNOVA_TOKEN eyJpZE......IxYyJ9","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"requestbody","value":"{\"typeOfRequest\":\"asset\",\n\"privateKey\":\"0xaf6331bbf1......5a44e0e0e2ba\",\n\"companyIdentifier\":\"Primary producer/farm\",\n\"eventType\":\"Commission\",\n\"packagingID\":\"Serial\",\n\"assetType\":\"cow\",\n\"name\":\"Cow Birth\",\n\"uniqueID\":\"BE0956984523\",\n\"timestamp\":\"2022-02-01 09:20:27\",\n\"organizationName\":\"RL Facility\",\n\"streetAndNumber\":\"Koetsweg 207\",\n\"zipcodeAndCity\":\"3010 Leuven\",\n\"herdCode\":\"HC1000\",\n\"race\":\"Limousin\",\n\"fur color\":\"brown\",\n\"groupNumbers\":\"1,3,5\"\n}","type":"text"},{"key":"files[]","type":"file","src":"/Users/madhuramansukh/Desktop/Sample Document.docx"}]},"url":"http://13.40.34.231/unova/api","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"92dae85d-d24a-4ac5-9e61-6d677e3773ca","id":"92dae85d-d24a-4ac5-9e61-6d677e3773ca","name":"All about Assets","type":"folder"}},"urlObject":{"protocol":"http","path":["unova","api"],"host":["13","40","34","231"],"query":[],"variable":[]}},"response":[{"id":"d4d212e7-083e-4084-a660-a33b6ad47297","name":"Add documents - Asset - Example","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"UNOVA_TOKEN eyJpZE......IxYyJ9","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"requestbody","value":"{\"typeOfRequest\":\"asset\",\n\"privateKey\":\"0xaf6331bbf1......5a44e0e0e2ba\",\n\"companyIdentifier\":\"Primary producer/farm\",\n\"eventType\":\"Commission\",\n\"packagingID\":\"Serial\",\n\"assetType\":\"cow\",\n\"name\":\"Cow Birth\",\n\"uniqueID\":\"BE0956984523\",\n\"timestamp\":\"2022-02-01 09:20:27\",\n\"organizationName\":\"RL Facility\",\n\"streetAndNumber\":\"Koetsweg 207\",\n\"zipcodeAndCity\":\"3010 Leuven\",\n\"herdCode\":\"HC1000\",\n\"race\":\"Limousin\",\n\"fur color\":\"brown\",\n\"groupNumbers\":\"1,3,5\"\n}","type":"text"},{"key":"files[]","type":"file","src":"/Users/madhuramansukh/Desktop/Sample Document.docx"}]},"url":"http://13.40.34.231/unova/api"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"cache-control","value":"no-store"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"2414"},{"key":"ETag","value":"W/\"96e-bmYyaQYCBcNmJ8gfDJLfrPn73BA\""},{"key":"Date","value":"Fri, 03 Mar 2023 10:44:56 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"Success\",\n \"message\": \"Asset created successfully\",\n \"response\": {\n \"data\": {\n \"_id\": \"6401cfa88d47d4001c96c480\",\n \"eventId\": \"0x3df5320b73e0fc28245235d8f6e0f4904e8e595330ee9affaa17e3bd4ed4d34b\",\n \"organizationId\": 1,\n \"metadata\": [\n {\n \"bundleId\": null,\n \"bundleUploadTimestamp\": 1677840296,\n \"group\": 1\n },\n {\n \"bundleId\": null,\n \"bundleUploadTimestamp\": 1677840296,\n \"group\": 3\n },\n {\n \"bundleId\": null,\n \"bundleUploadTimestamp\": 1677840296,\n \"group\": 5\n }\n ],\n \"content\": {\n \"idData\": {\n \"uniqueID\": \"BE0956984523\",\n \"timestamp\": 1677840295,\n \"createdBy\": \"0x320389eB491a48700Ca8DA35FC136a3C8dd9e5E8\",\n \"dataHash\": \"0xb90d991ce10416bcfcce34fc6039564a677be9c773774c5d49a7e5d6e4019506\"\n },\n \"signature\": \"0x5e549cec97eb812f2afd5e8239875cfb4e11bfcaee4fd674f776414e7c1a4eb15a402bfea10c39c4743b64f63fab371fd9d0fb61b72dc52758142cb60562b36a1b\",\n \"data\": [\n {\n \"identifiers\": {\n \"uniqueID\": [\n \"BE0956984523\"\n ]\n }\n },\n {\n \"name\": \"Cow Birth\",\n \"companyIdentifier\": \"Primary producer/farm\",\n \"eventType\": \"Commission\",\n \"packagingID\": \"Serial\",\n \"assetType\": \"cow\",\n \"creationTimestamp\": 1643707227,\n \"organizationName\": \"RL Facility\",\n \"streetAndNumber\": \"Koetsweg 207\",\n \"zipcodeAndCity\": \"3010 Leuven\",\n \"herdCode\": \"HC1000\",\n \"race\": \"Limousin\",\n \"fur color\": \"brown\",\n \"groupNumbers\": [\n {\n \"group\": 1,\n \"isBundled\": false\n },\n {\n \"group\": 3,\n \"isBundled\": false\n },\n {\n \"group\": 5,\n \"isBundled\": false\n }\n ]\n },\n {\n \"documents\": {\n \"Sample_Document_1677840295894_2023_3_3_10_44_55\": {\n \"url\": \"https://unova-chain-assets-event-files.s3.eu-west-3.amazonaws.com/Sample_Document_1677840295894.docx\"\n }\n }\n }\n ]\n }\n },\n \"meta\": {\n \"code\": 200\n }\n }\n}"}],"_postman_id":"da2b9b8f-a4c8-4501-a1f2-ba802621481d"}],"id":"26fab6ef-79ce-4fc7-a8a3-bfc5280a00c1","description":"

The API provides the functionality of adding documents to the asset creation. The API accepts form-data hence documents can be easily attached. However, if the asset is already created without attaching any documents, an event needs to be created to attach the said documents.

\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"bb87932b-a2c8-4672-8d3c-dbd5c7991b01"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"a3f31058-e845-4f76-b530-17167db25eda"}}],"_postman_id":"26fab6ef-79ce-4fc7-a8a3-bfc5280a00c1","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"92dae85d-d24a-4ac5-9e61-6d677e3773ca","id":"92dae85d-d24a-4ac5-9e61-6d677e3773ca","name":"All about Assets","type":"folder"}}},{"name":"Referencing","item":[{"name":"Create asset with reference - Example","id":"57f096ab-51da-4815-8ee4-edeb5558778c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"UNOVA_TOKEN eyJpZE......IxYyJ9","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"requestbody","value":"{\"typeOfRequest\":\"asset\",\n\"privateKey\":\"0xaf6331bbf1......5a44e0e0e2ba\",\n\"companyIdentifier\":\"Primary producer/farm\",\n\"eventType\":\"Transformation\",\n\"packagingID\":\"Serial\",\n\"assetType\":\"quarter\",\n\"name\":\"Slaughter of animal\",\n\"uniqueID\":\"BE0956984523.1\",\n\"timestamp\":\"2022-02-01 09:20:27\",\n\"organizationName\":\"RL Facility\",\n\"streetAndNumber\":\"Koetsweg 207\",\n\"zipcodeAndCity\":\"3010 Leuven\",\n\"herdCode\":\"HC1000\",\n\"race\":\"Limousin\",\n\"fur color\":\"brown\",\n\"groupNumbers\":\"1,3\",\n\"assetsReferencedOrAdded\":\"BE0956984523\"\n}","type":"text"}]},"url":"http://13.40.34.231/unova/api","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"92dae85d-d24a-4ac5-9e61-6d677e3773ca","id":"92dae85d-d24a-4ac5-9e61-6d677e3773ca","name":"All about Assets","type":"folder"}},"urlObject":{"protocol":"http","path":["unova","api"],"host":["13","40","34","231"],"query":[],"variable":[]}},"response":[{"id":"c62d28f1-2d47-44dd-ab57-4a909034f8c8","name":"Create asset with reference - Example","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"UNOVA_TOKEN eyJpZE......IxYyJ9","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"requestbody","value":"{\"typeOfRequest\":\"asset\",\n\"privateKey\":\"0xaf6331bbf1......5a44e0e0e2ba\",\n\"companyIdentifier\":\"Primary producer/farm\",\n\"eventType\":\"Transformation\",\n\"packagingID\":\"Serial\",\n\"assetType\":\"quarter\",\n\"name\":\"Slaughter of animal\",\n\"uniqueID\":\"BE0956984523.1\",\n\"timestamp\":\"2022-02-01 09:20:27\",\n\"organizationName\":\"RL Facility\",\n\"streetAndNumber\":\"Koetsweg 207\",\n\"zipcodeAndCity\":\"3010 Leuven\",\n\"herdCode\":\"HC1000\",\n\"race\":\"Limousin\",\n\"fur color\":\"brown\",\n\"groupNumbers\":\"1,3\",\n\"assetsReferencedOrAdded\":\"BE0956984523\"\n}","type":"text"}]},"url":"http://13.40.34.231/unova/api"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"cache-control","value":"no-store"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"2091"},{"key":"ETag","value":"W/\"82b-IP9eIwcTiaRlsXDTHIbwBBAw5xo\""},{"key":"Date","value":"Fri, 03 Mar 2023 10:49:54 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"Success\",\n \"message\": \"Asset created successfully\",\n \"response\": {\n \"data\": {\n \"_id\": \"6401d0d28d47d4001c96c483\",\n \"eventId\": \"0x2aa0838fdbd13c4c50baac5e0162f5b4d59b35ea2ac2a473b9232992e7e1f6f8\",\n \"organizationId\": 1,\n \"metadata\": [\n {\n \"bundleId\": null,\n \"bundleUploadTimestamp\": 1677840594,\n \"group\": 1\n },\n {\n \"bundleId\": null,\n \"bundleUploadTimestamp\": 1677840594,\n \"group\": 3\n }\n ],\n \"content\": {\n \"idData\": {\n \"uniqueID\": \"BE0956984523.1\",\n \"timestamp\": 1677840594,\n \"createdBy\": \"0x320389eB491a48700Ca8DA35FC136a3C8dd9e5E8\",\n \"dataHash\": \"0x9b1ca8ae706dbc554bda22c99d9b38886be4ab3d6e1622d3729fdb6961c15c58\"\n },\n \"signature\": \"0x84a5c9cdda3188d370b6a30d01a24ae7b365c0609ccdbcac5d08031dcd596ad05303eb7353ee1a562b2828a631e95afe3847ebc7435248127f81637c8da0673e1b\",\n \"data\": [\n {\n \"identifiers\": {\n \"uniqueID\": [\n \"BE0956984523.1\"\n ],\n \"referenceID\": [\n {\n \"uniqueId\": \"BE0956984523\"\n }\n ]\n }\n },\n {\n \"name\": \"Slaughter of animal\",\n \"companyIdentifier\": \"Primary producer/farm\",\n \"eventType\": \"Transformation\",\n \"packagingID\": \"Serial\",\n \"assetType\": \"quarter\",\n \"creationTimestamp\": 1643707227,\n \"organizationName\": \"RL Facility\",\n \"streetAndNumber\": \"Koetsweg 207\",\n \"zipcodeAndCity\": \"3010 Leuven\",\n \"herdCode\": \"HC1000\",\n \"race\": \"Limousin\",\n \"fur color\": \"brown\",\n \"groupNumbers\": [\n {\n \"group\": 1,\n \"isBundled\": false\n },\n {\n \"group\": 3,\n \"isBundled\": false\n }\n ]\n },\n {}\n ]\n }\n },\n \"meta\": {\n \"code\": 200\n }\n }\n}"}],"_postman_id":"57f096ab-51da-4815-8ee4-edeb5558778c"}],"id":"f1d91707-8ca0-432c-8194-86150151faff","description":"

Referencing (assetsReferencedOrAdded) is necessary to link the assets together and visualize the whole chain. Here we use slaughter house as an example, where of a piece of meat (asset) is being created with cow (asset) as the reference (assetsReferencedOrAdded)

\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"b3ebf327-2501-4434-b605-5fa0f5705567"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"764a9606-80fc-437d-afde-7df507739e84"}}],"_postman_id":"f1d91707-8ca0-432c-8194-86150151faff","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"92dae85d-d24a-4ac5-9e61-6d677e3773ca","id":"92dae85d-d24a-4ac5-9e61-6d677e3773ca","name":"All about Assets","type":"folder"}}}],"id":"6b3758bb-9f04-4264-91b6-7b76e8a8706b","description":"

To create an asset, the API expects a list of mandatory fields to be passed,with certain validations in place.In addition to the mandatory fields,the field list is open for use, and any number of data points can be posted to the API. For each company, a suggested list of fields is mentioned in the following sections.

\n","_postman_id":"6b3758bb-9f04-4264-91b6-7b76e8a8706b","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"92dae85d-d24a-4ac5-9e61-6d677e3773ca","id":"92dae85d-d24a-4ac5-9e61-6d677e3773ca","name":"All about Assets","type":"folder"}}}],"id":"92dae85d-d24a-4ac5-9e61-6d677e3773ca","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"4d3bcae0-aed9-4931-803b-062c2f555b14"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"35e0afa5-f10f-4627-850c-ea8032fb9ce8"}}],"_postman_id":"92dae85d-d24a-4ac5-9e61-6d677e3773ca","description":""},{"name":"All about Events","item":[{"name":"What is an Event? ","item":[],"id":"0c79b982-3ec5-4090-975e-61ed6641e78b","description":"

Events record any relevant and time-stamped information that happened to one or multiple assets. Examples are transports, observations, quality controls medicines administered etc...

\n

All events must contain the name of the event, uniqueID, location, (street & number, zipcode & city) and any additional data field. Events are always associated with an asset.

\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"259793d8-3c69-4db4-a804-3bb665840e43"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"24985434-13d7-4d14-b8a5-409859d06ed6"}}],"_postman_id":"0c79b982-3ec5-4090-975e-61ed6641e78b","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"99149bc5-f7a9-437a-83d5-276a1fd2e62e","id":"99149bc5-f7a9-437a-83d5-276a1fd2e62e","name":"All about Events","type":"folder"}}},{"name":"Creating an Event","item":[{"name":"Mandatory and Recommended Field Lists","item":[{"name":"Create Event - Mandatory Fields Example","id":"d0aecfc4-409c-4317-9528-d4055ed98823","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"UNOVA_TOKEN eyJpZE......IxYyJ9","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"requestbody","value":"{\"typeOfRequest\":\"event\",\n\"privateKey\":\"0xaf6331bbf1......5a44e0e0e2ba\",\n\"companyIdentifier\":\"Primary producer/farm\",\n\"eventType\":\"Outbound Transport\",\n\"name\":\"Outbound Transport\",\n\"uniqueID\":\"BE0956984523\",\n\"timestamp\":\"2022-02-01 09:20:27\",\n\"organizationName\":\"RL Facility\",\n\"streetAndNumber\":\"Koetsweg 207\",\n\"zipcodeAndCity\":\"3010 Leuven\",\n\"groupNumbers\":\"1,3\"\n}","type":"text"}]},"url":"http://13.40.34.231/unova/api","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"99149bc5-f7a9-437a-83d5-276a1fd2e62e","id":"99149bc5-f7a9-437a-83d5-276a1fd2e62e","name":"All about Events","type":"folder"}},"urlObject":{"protocol":"http","path":["unova","api"],"host":["13","40","34","231"],"query":[],"variable":[]}},"response":[{"id":"7d4e2178-9c4d-46f5-8e99-8653c1cffacd","name":"Create Event - Mandatory Fields Example","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"UNOVA_TOKEN eyJpZE......IxYyJ9","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"requestbody","value":"{\"typeOfRequest\":\"event\",\n\"privateKey\":\"0xaf6331bbf1......5a44e0e0e2ba\",\n\"companyIdentifier\":\"Primary producer/farm\",\n\"eventType\":\"Outbound Transport\",\n\"name\":\"Outbound Transport\",\n\"uniqueID\":\"BE0956984523\",\n\"timestamp\":\"2022-02-01 09:20:27\",\n\"organizationName\":\"RL Facility\",\n\"streetAndNumber\":\"Koetsweg 207\",\n\"zipcodeAndCity\":\"3010 Leuven\",\n\"groupNumbers\":\"1,3\"\n}","type":"text"}]},"url":"http://13.40.34.231/unova/api"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"cache-control","value":"no-store"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"1976"},{"key":"ETag","value":"W/\"7b8-COHQ/A8nUl1OW+iF0HJpqu2Mirw\""},{"key":"Date","value":"Fri, 03 Mar 2023 11:19:53 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"status\": \"Success\",\n \"message\": \"Event created successfully\",\n \"response\": {\n \"data\": {\n \"_id\": \"6401d7d93b3d7a001b401084\",\n \"eventId\": \"0x1906b82b4febe728a311aa6892ea3e095f2f4710299b269ed961fde902c77491\",\n \"organizationId\": 1,\n \"metadata\": [\n {\n \"bundleId\": null,\n \"bundleUploadTimestamp\": 1677842393,\n \"group\": 1\n },\n {\n \"bundleId\": null,\n \"bundleUploadTimestamp\": 1677842393,\n \"group\": 3\n }\n ],\n \"content\": {\n \"idData\": {\n \"uniqueID\": \"BE0956984523\",\n \"timestamp\": 1677842393,\n \"createdBy\": \"0x320389eB491a48700Ca8DA35FC136a3C8dd9e5E8\",\n \"dataHash\": \"0x9ea1413ab47231a34204f36b8d5dcbe3bd599c186f7d207af2864acaade74866\"\n },\n \"signature\": \"0x59ae0d1405f86fcc87fcb5504b654f08bb0472389b5e5b912b532913bd3be8516970d00b9b060334f64f5f428aa77555535e89378d18477f7c0d3d706caec86f1c\",\n \"data\": [\n {\n \"identifiers\": {\n \"uniqueID\": [\n \"BE0956984523\"\n ]\n }\n },\n {\n \"name\": \"Outbound Transport\",\n \"companyIdentifier\": \"Primary producer/farm\",\n \"eventType\": \"Outbound Transport\",\n \"type\": \"unova.event.Outbound Transport\",\n \"creationTimestamp\": 1643707227,\n \"organizationName\": \"RL Facility\",\n \"streetAndNumber\": \"Koetsweg 207\",\n \"zipcodeAndCity\": \"3010 Leuven\",\n \"groupNumbers\": [\n {\n \"group\": 1,\n \"isBundled\": false\n },\n {\n \"group\": 3,\n \"isBundled\": false\n }\n ]\n },\n {}\n ]\n }\n },\n \"meta\": {\n \"code\": 200\n }\n }\n }\n]"}],"_postman_id":"d0aecfc4-409c-4317-9528-d4055ed98823"}],"id":"07782424-6b91-4973-924b-e19e56d2f7a9","description":"

Below is a list of mandatory and recommended fields. The data request cannot be successfully sent without including all the mandatory fields, and will show errors until all of them are included. The recommended fields, which are related to organization information, are optional and can be left out of the data request. However to receive most accurate results out of the data down applications we recommend to include these fields in the mentioned format in the data request.

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Field NameDescription
typeOfRequest (mandatory)\"event\"
privateKey (mandatory)Private Key of Account
name (mandatory)Name of event specified in Your Chain via the Unova Chain Builder.
eventType (mandatory)Type of event specified in Your Chain via the Unova Chain Builder. Accepts only \"Transport Inbound\"/\"Transport Outbound\"/\"Observation\"/\"Others\"
uniqueID (mandatory)Unique ID of the asset - eg GTIN number
timestamp (mandatory)Timestamp of event creation. Validated input. Format : \"yyyy-mm-dd hh:mm:ss\"
organizationName (recommended)Name of Organization
streetAndNumber (recommended)Location of Organization - Street Name & Street Number
zipcodeAndCity (recommended)Location of Organization - Zipcode & City
companyIdentifier (recommended)Type of Organization. Accepts only \"Primary producer/farm\"/\"Warehouse\"/\"Manufacturer of goods\"/\"Packaging\"/\"Distribution center\"/\"Store\"/\"Transporter\"
groupNumbers (recommended)Group numbers of partners to whom the event data is to be distributed. Comma separated values (currently limited from 1 to 5). If not sent in request, default is group 1.
\n
","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"6ab3bf2b-43a3-45fa-bfe2-f2badab1cb91"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"b63b608b-ddc7-42a2-ac6c-d63a066228a5"}}],"_postman_id":"07782424-6b91-4973-924b-e19e56d2f7a9","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"99149bc5-f7a9-437a-83d5-276a1fd2e62e","id":"99149bc5-f7a9-437a-83d5-276a1fd2e62e","name":"All about Events","type":"folder"}}},{"name":"Additional Field Lists","item":[{"name":"Create Event - Additional Fields Example","id":"b4002ba9-f808-4583-9e4e-67b5b2e6f340","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"UNOVA_TOKEN eyJpZE......IxYyJ9","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"requestbody","value":"{\n\"typeOfRequest\":\"event\",\n\"privateKey\":\"0xaf6331bbf1......5a44e0e0e2ba\",\n\"companyIdentifier\":\"Primary producer/farm\",\n\"eventType\":\"Outbound Transport\",\n\"name\":\"Outbound Logistics\",\n\"uniqueID\":\"BE0956984523\",\n\"timestamp\":\"2021-01-01 17:50:28\",\n\"organizationName\":\"RL Facility\",\n\"streetAndNumber\":\"Koetsweg 207\",\n\"zipcodeAndCity\":\"3010 Leuven\",\n\"transporter\":\"Gheys Transports\",\n\"destinationCity\":\"Antwerp\",\n\"groupNumbers\":\"3\"\n}","type":"text"}]},"url":"http://13.40.34.231/unova/api","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"99149bc5-f7a9-437a-83d5-276a1fd2e62e","id":"99149bc5-f7a9-437a-83d5-276a1fd2e62e","name":"All about Events","type":"folder"}},"urlObject":{"protocol":"http","path":["unova","api"],"host":["13","40","34","231"],"query":[],"variable":[]}},"response":[{"id":"7e494cbe-4a53-4e38-8602-fab6a760c0b7","name":"Create Event - Additional Fields Example","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"UNOVA_TOKEN eyJpZE......IxYyJ9","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"requestbody","value":"{\n\"typeOfRequest\":\"event\",\n\"privateKey\":\"0xaf6331bbf1......5a44e0e0e2ba\",\n\"companyIdentifier\":\"Primary producer/farm\",\n\"eventType\":\"Outbound Transport\",\n\"name\":\"Outbound Logistics\",\n\"uniqueID\":\"BE0956984523\",\n\"timestamp\":\"2021-01-01 17:50:28\",\n\"organizationName\":\"RL Facility\",\n\"streetAndNumber\":\"Koetsweg 207\",\n\"zipcodeAndCity\":\"3010 Leuven\",\n\"transporter\":\"Gheys Transports\",\n\"destinationCity\":\"Antwerp\",\n\"groupNumbers\":\"3\"\n}","type":"text"}]},"url":"http://13.40.34.231/unova/api"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"cache-control","value":"no-store"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"1838"},{"key":"ETag","value":"W/\"72e-5Vd4h1crw5JlKSOSGG7voxJN1LA\""},{"key":"Date","value":"Fri, 03 Mar 2023 11:27:33 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"status\": \"Success\",\n \"message\": \"Event created successfully\",\n \"response\": {\n \"data\": {\n \"_id\": \"6401d9a53b3d7a001b401088\",\n \"eventId\": \"0x83e4133b65cf1dc332781a8d48cb6ec726b6c75e9b6bceacfa6c4839400b752d\",\n \"organizationId\": 1,\n \"metadata\": [\n {\n \"bundleId\": null,\n \"bundleUploadTimestamp\": 1677842853,\n \"group\": 3\n }\n ],\n \"content\": {\n \"idData\": {\n \"uniqueID\": \"BE0956984523\",\n \"timestamp\": 1677842853,\n \"createdBy\": \"0x320389eB491a48700Ca8DA35FC136a3C8dd9e5E8\",\n \"dataHash\": \"0xd3d50fed7c6524fd67982445cd4d5d45d77c6acb0092ae94450e08ac006aad5a\"\n },\n \"signature\": \"0x0223451975aa155cc938cfe6aea6794fbce7678164945527e1471e4a46afc005719c3f6e96e9d8b831328f7b70059c5826cbd7fd520de9e100b0a14daa3022ae1c\",\n \"data\": [\n {\n \"identifiers\": {\n \"uniqueID\": [\n \"BE0956984523\"\n ]\n }\n },\n {\n \"name\": \"Outbound Logistics\",\n \"companyIdentifier\": \"Primary producer/farm\",\n \"eventType\": \"Outbound Transport\",\n \"type\": \"unova.event.Outbound Transport\",\n \"creationTimestamp\": 1609523428,\n \"organizationName\": \"RL Facility\",\n \"streetAndNumber\": \"Koetsweg 207\",\n \"zipcodeAndCity\": \"3010 Leuven\",\n \"transporter\": \"Gheys Transports\",\n \"destinationCity\": \"Antwerp\",\n \"groupNumbers\": [\n {\n \"group\": 3,\n \"isBundled\": false\n }\n ]\n },\n {}\n ]\n }\n },\n \"meta\": {\n \"code\": 200\n }\n }\n }\n]"}],"_postman_id":"b4002ba9-f808-4583-9e4e-67b5b2e6f340"}],"id":"db938531-290a-4e6d-8c7b-990ffa16dced","description":"

Apart from the mandatory fields,each company needs to provide relevent data to the events. The API accepts any number of additional fields that the company system might hold, and want to send to the blockchain. Here we use farm as an example and append additional fields with respect to the veterinary event.

\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"403dcf5d-a738-4415-bdb0-35b00d7bf18a"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"dc05cfb4-a3c1-4903-ba34-1a159004bbba"}}],"_postman_id":"db938531-290a-4e6d-8c7b-990ffa16dced","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"99149bc5-f7a9-437a-83d5-276a1fd2e62e","id":"99149bc5-f7a9-437a-83d5-276a1fd2e62e","name":"All about Events","type":"folder"}}},{"name":"Add Documents","item":[{"name":"Add documents - Event - Example","id":"92b4087f-3f28-4b54-955b-262b1a158ac5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"UNOVA_TOKEN eyJpZE......IxYyJ9","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"requestbody","value":"{\n\"typeOfRequest\":\"event\",\n\"privateKey\":\"0xaf6331bbf1......5a44e0e0e2ba\",\n\"companyIdentifier\":\"Primary producer/farm\",\n\"eventType\":\"outbound transport\",\n\"name\":\"outbound logistics\",\n\"uniqueID\":\"BE0956984523\",\n\"timestamp\":\"2021-01-01 17:50:28\",\n\"organizationName\":\"RL Facility\",\n\"streetAndNumber\":\"Koetsweg 207\",\n\"zipcodeAndCity\":\"3010 Leuven\",\n\"transporter\":\"Gheys Transports\",\n\"destinationCity\":\"Antwerp\"\n}","type":"text"},{"key":"files[]","type":"file","src":"/Users/madhuramansukh/Desktop/Sample Document.docx"}]},"url":"http://13.40.34.231/unova/api","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"99149bc5-f7a9-437a-83d5-276a1fd2e62e","id":"99149bc5-f7a9-437a-83d5-276a1fd2e62e","name":"All about Events","type":"folder"}},"urlObject":{"protocol":"http","path":["unova","api"],"host":["13","40","34","231"],"query":[],"variable":[]}},"response":[{"id":"7b22ce4a-ba16-4e18-a8b1-2340a0d2f9e8","name":"Add documents - Event - Example","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"UNOVA_TOKEN eyJpZE......IxYyJ9","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"requestbody","value":"{\n\"typeOfRequest\":\"event\",\n\"privateKey\":\"0xaf6331bbf1......5a44e0e0e2ba\",\n\"companyIdentifier\":\"Primary producer/farm\",\n\"eventType\":\"outbound transport\",\n\"name\":\"outbound logistics\",\n\"uniqueID\":\"BE0956984523\",\n\"timestamp\":\"2021-01-01 17:50:28\",\n\"organizationName\":\"RL Facility\",\n\"streetAndNumber\":\"Koetsweg 207\",\n\"zipcodeAndCity\":\"3010 Leuven\",\n\"transporter\":\"Gheys Transports\",\n\"destinationCity\":\"Antwerp\"\n}","type":"text"},{"key":"files[]","type":"file","src":"/Users/madhuramansukh/Desktop/Sample Document.docx"}]},"url":"http://13.40.34.231/unova/api"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"cache-control","value":"no-store"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"2111"},{"key":"ETag","value":"W/\"83f-w11EkYEy0PjpzMw4wXRto0kUJq4\""},{"key":"Date","value":"Fri, 03 Mar 2023 11:31:21 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"status\": \"Success\",\n \"message\": \"Event created successfully\",\n \"response\": {\n \"data\": {\n \"_id\": \"6401da893b3d7a001b40108a\",\n \"eventId\": \"0xdcf2d0af825e92ffe75f640ca607f0082d14353ebffb6e5672bfc161fdeb67b1\",\n \"organizationId\": 1,\n \"metadata\": [\n {\n \"bundleId\": null,\n \"bundleUploadTimestamp\": 1677843081,\n \"group\": 1\n }\n ],\n \"content\": {\n \"idData\": {\n \"uniqueID\": \"BE0956984523\",\n \"timestamp\": 1677843081,\n \"createdBy\": \"0x320389eB491a48700Ca8DA35FC136a3C8dd9e5E8\",\n \"dataHash\": \"0x029069ccc87c24403d4d76aadd5c00f6cbe9302304a24d910c033468942d1107\"\n },\n \"signature\": \"0x92fa318f232997ae31e456daf2534de43bc463318886d2365f1551e84d1d195e687a22fb727b5c9d997f5975410c1a0d05eb3953b36b48fdb35f39fb7078bdc11b\",\n \"data\": [\n {\n \"identifiers\": {\n \"uniqueID\": [\n \"BE0956984523\"\n ]\n }\n },\n {\n \"name\": \"outbound logistics\",\n \"companyIdentifier\": \"Primary producer/farm\",\n \"eventType\": \"outbound transport\",\n \"type\": \"unova.event.outbound transport\",\n \"creationTimestamp\": 1609523428,\n \"organizationName\": \"RL Facility\",\n \"streetAndNumber\": \"Koetsweg 207\",\n \"zipcodeAndCity\": \"3010 Leuven\",\n \"transporter\": \"Gheys Transports\",\n \"destinationCity\": \"Antwerp\",\n \"groupNumbers\": [\n {\n \"group\": 1,\n \"isBundled\": false\n }\n ]\n },\n {\n \"documents\": {\n \"Sample_Document_1677843081393_2023_3_3_11_31_21\": {\n \"url\": \"https://unova-chain-assets-event-files.s3.eu-west-3.amazonaws.com/Sample_Document_1677843081393.docx\"\n }\n }\n }\n ]\n }\n },\n \"meta\": {\n \"code\": 200\n }\n }\n }\n]"}],"_postman_id":"92b4087f-3f28-4b54-955b-262b1a158ac5"}],"id":"9d92345e-e5d4-4f11-b1f2-066819a12acb","description":"

The API provides the functionality of adding documents to the event. The API accepts form-data hence documents can be easily attached.

\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"73acb43b-030d-46fc-81d5-e68d087f2f38"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"1b88f28a-0672-4374-8696-10b48df1404e"}}],"_postman_id":"9d92345e-e5d4-4f11-b1f2-066819a12acb","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"99149bc5-f7a9-437a-83d5-276a1fd2e62e","id":"99149bc5-f7a9-437a-83d5-276a1fd2e62e","name":"All about Events","type":"folder"}}}],"id":"f1cc4161-da44-414a-8c74-4d14f31ddfbb","description":"

To create an event, the API expects a list of mandatory fields to be passed,with certain validations in place.In addition to the mandatory fields,the field list is open for use, and any number of data points can be posted to the API. For each company, a suggested list of events and corresponding fields is mentioned in the following sections.

\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"2ad635d2-c079-427b-985d-ac33ac02410f"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"b61ee108-dd2f-48cb-b5be-23e529e25d6c"}}],"_postman_id":"f1cc4161-da44-414a-8c74-4d14f31ddfbb","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"99149bc5-f7a9-437a-83d5-276a1fd2e62e","id":"99149bc5-f7a9-437a-83d5-276a1fd2e62e","name":"All about Events","type":"folder"}}}],"id":"99149bc5-f7a9-437a-83d5-276a1fd2e62e","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"3df17a92-3946-4c5d-ac83-0407f07ea682"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"8f1fcac4-0b41-4b2e-85d0-39f8e65c8dfe"}}],"_postman_id":"99149bc5-f7a9-437a-83d5-276a1fd2e62e","description":""}],"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"02b2f1cf-2bc0-4871-bdad-4da621a131b4"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"8d644817-127e-4381-9da8-005656083648"}}]}