Initial

rest/db-browse-get.rst

@@ -0,0 +1,55 @@
+GET /rest/db/browse
+===================
+
+Returns the directory tree of the global model. Directories are always
+JSON objects (map/dictionary), and files are always arrays of
+modification time and size. The first integer is the files modification
+time, and the second integer is the file size.
+
+The call takes one mandatory ``folder`` parameter and two optional
+parameters. Optional parameter ``levels`` defines how deep within the
+tree we want to dwell down (0 based, defaults to unlimited depth)
+Optional parameter ``prefix`` defines a prefix within the tree where to
+start building the structure.
+
+.. code:: bash
+
+    $ curl -s http://localhost:8384/rest/db/browse?folder=default | json_pp
+    {
+       "directory": {
+          "file": ["2015-04-20T22:20:45+09:00", 130940928],
+          "subdirectory": {
+             "another file": ["2015-04-20T22:20:45+09:00", 130940928]
+          }
+       },
+       "rootfile": ["2015-04-20T22:20:45+09:00", 130940928]
+    }
+
+    $ curl -s http://localhost:8384/rest/db/browse?folder=default&levels=0 | json_pp
+    {
+       "directory": {},
+       "rootfile": ["2015-04-20T22:20:45+09:00", 130940928]
+    }
+
+    $ curl -s http://localhost:8384/rest/db/browse?folder=default&levels=1 | json_pp
+    {
+       "directory": {
+          "file": ["2015-04-20T22:20:45+09:00", 130940928],
+          "subdirectory": {}
+       },
+       "rootfile": ["2015-04-20T22:20:45+09:00", 130940928]
+    }
+
+    $ curl -s http://localhost:8384/rest/db/browse?folder=default&prefix=directory/subdirectory | json_pp
+    {
+       "another file": ["2015-04-20T22:20:45+09:00", 130940928]
+    }
+
+    $ curl -s http://localhost:8384/rest/db/browse?folder=default&prefix=directory&levels=0 | json_pp
+    {
+       "file": ["2015-04-20T22:20:45+09:00", 130940928],
+       "subdirectory": {}
+    }
+
+.. note::
+  This is an expensive call, increasing CPU and RAM usage on the device. Use sparingly.