Home

Index

Library compatibility

This is a C++ based library intended for embbeded firmware development, however it can be easily ported and made compatible with any platform or operating systems.

To port the "Dataverse-API-C-library" to another environment, you only need to find replacement libraries for:

• the WIFI class can be found here: https://github.com/espressif/arduino-esp32/blob/master/libraries/WiFi/src/WiFi.h
• the HTTP related classes can be found here: https://github.com/espressif/arduino-esp32/tree/master/libraries/HTTPClient/src
• the arduino Json library is a library to parse JSON data and can be found here: https://github.com/bblanchon/ArduinoJson/tree/6.x
• the mserial class is a library to output string data to a UART serial data stream , this means you can replace it by printf statements (or any other ). The mserial class library can be found on this github repository, here: https://github.com/aeonSolutions/aeonlabs-ESP32-C-Base-Firmware-Libraries#readme

Library installation and initialization

• How to Install the Dataverse library
• Initialize the Dataverse Class Library

HTTP GET Requests

• Make a GET request to a Dataverse

HTTP POST Requests

• (soon: I start working on this again next month of November 2023)

There's an ongoing scientific project titled "Validation of Experimental Data Origins: A Swarm of DAQ devices able to Deliver Unique Experimental Data using Blockchain-like Fingerprint ID to a Data Repository" that utilizes this library. Here's the link for the documentation.

Library API Implementation Progress

Wiki?	Endpoint	URL	Implemented?	Notes
	Dataverses	POST 'api/dataverses/$id'	Y	-
✓	-	GET api/dataverses/$id	Y	-
✓	-	GET api/dataverses/$id/contents	Y	-
-	-	DELETE api/dataverses/$id	N	-
-	-	POST api/dataverses/$id/datasets	N	-
-	-	POST api/dataverses/$identifier/actions/:publish	N	-
	Datasets	GET api/datasets/$id/versions	Y	-
✓	-	GET /api/datasets/$id/locks	Y	-
-	-	DELETE api/datasets/$id	N	-
-	-	POST api/dataverses/$id	N	-
✓	-	GET PUT api/datasets/$id/versions/:draft?	Y	-
-	-	POST PUT api/datasets/$id/actions/:publish?type=$type	N	-
	MetadataBlocks	GET api/metadatablocks	Y	-
✓	-	GET api/metadatablocks/$identifier	Y	-
	Upload file	POST /api/datasets/:persistentId/add?persistentId=	Y	Add a file to a dataset