md__2github_2workspace_2service_2http__server_2README.html - incubator-resilientdb-python-sdk - Git at Google

 <!-- HTML header for doxygen 1.9.8-->
 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
 <html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
 <head>
 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
 <meta http-equiv="X-UA-Compatible" content="IE=11"/>
 <meta name="generator" content="Doxygen 1.9.8"/>
 <meta name="viewport" content="width=device-width, initial-scale=1"/>
 <title>ResilientDB SDK: HTTP Server Endpoints</title>
 <link href="tabs.css" rel="stylesheet" type="text/css"/>
 <script type="text/javascript" src="jquery.js"></script>
 <script type="text/javascript" src="dynsections.js"></script>
 <link href="navtree.css" rel="stylesheet" type="text/css"/>
 <script type="text/javascript" src="resize.js"></script>
 <script type="text/javascript" src="navtreedata.js"></script>
 <script type="text/javascript" src="navtree.js"></script>
 <link href="search/search.css" rel="stylesheet" type="text/css"/>
 <script type="text/javascript" src="search/searchdata.js"></script>
 <script type="text/javascript" src="search/search.js"></script>
 <link href="doxygen.css" rel="stylesheet" type="text/css" />
 <link href="doxygen_html_style.css" rel="stylesheet" type="text/css"/>
 </head>
 <body>
 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
 <div id="titlearea">
 <table cellspacing="0" cellpadding="0">
  <tbody>
  <tr id="projectrow">
   <td id="projectlogo"><img alt="Logo" src="logo.png"/></td>
  </tr>
  </tbody>
 </table>
 </div>
 <!-- end header part -->
 <!-- Generated by Doxygen 1.9.8 -->
 <script type="text/javascript">
 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
 var searchBox = new SearchBox("searchBox", "search/",'.html');
 /* @license-end */
 </script>
 <script type="text/javascript" src="menudata.js"></script>
 <script type="text/javascript" src="menu.js"></script>
 <script type="text/javascript">
 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
 $(function() {
   initMenu('',true,false,'search.php','Search');
   $(document).ready(function() { init_search(); });
 });
 /* @license-end */
 </script>
 <div id="main-nav"></div>
 </div><!-- top -->
 <div id="side-nav" class="ui-resizable side-nav-resizable">
   <div id="nav-tree">
     <div id="nav-tree-contents">
       <div id="nav-sync" class="sync"></div>
     </div>
   </div>
   <div id="splitbar" style="-moz-user-select:none;"
        class="ui-resizable-handle">
   </div>
 </div>
 <script type="text/javascript">
 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
 $(document).ready(function(){initNavTree('md__2github_2workspace_2service_2http__server_2README.html',''); initResizable(); });
 /* @license-end */
 </script>
 <div id="doc-content">
 <!-- window showing the filter options -->
 <div id="MSearchSelectWindow"
      onmouseover="return searchBox.OnSearchSelectShow()"
      onmouseout="return searchBox.OnSearchSelectHide()"
      onkeydown="return searchBox.OnSearchSelectKey(event)">
 </div>

 <!-- iframe showing the search results (closed by default) -->
 <div id="MSearchResultsWindow">
 <div id="MSearchResults">
 <div class="SRPage">
 <div id="SRIndex">
 <div id="SRResults"></div>
 <div class="SRStatus" id="Loading">Loading...</div>
 <div class="SRStatus" id="Searching">Searching...</div>
 <div class="SRStatus" id="NoMatches">No Matches</div>
 </div>
 </div>
 </div>
 </div>

 <div><div class="header">
   <div class="headertitle"><div class="title">HTTP Server Endpoints</div></div>
 </div><!--header-->
 <div class="contents">
 <div class="textblock"><p><a class="anchor" id="autotoc_md25"></a> </p>
 <h1><a class="anchor" id="autotoc_md26"></a>
 Transactions</h1>
 <p>Note that key-value pairs committed to ResilientDB through the API store the JSON object as the value. To get the intended value of the pair, simply access the value of the JSON object.</p>
 <h2><a class="anchor" id="autotoc_md27"></a>
 GET /v1/transactions</h2>
 <p>Get all values</p>
 <h2><a class="anchor" id="autotoc_md28"></a>
 GET /v1/transactions/&lt;string&gt;</h2>
 <p>Get value of specific id</p>
 <h2><a class="anchor" id="autotoc_md29"></a>
 GET /v1/transactions/&lt;string&gt;/&lt;string&gt;</h2>
 <p>Get values based on key range</p>
 <h2><a class="anchor" id="autotoc_md30"></a>
 POST /v1/transactions/commit</h2>
 <p>Sets a new value for a key. Note that key-value pairs committed to ResilientDB through the API store the JSON object as the value. To get the intended value of the pair, simply access the value of the JSON object.</p>
 <p>Ex: &lsquo;curl -X POST -d &rsquo;{"id":"samplekey","value":"samplevalue"}' localhost:18000/v1/transactions/commit`</p>
 <h1><a class="anchor" id="autotoc_md31"></a>
 Blocks</h1>
 <h2><a class="anchor" id="autotoc_md32"></a>
 GET /v1/blocks</h2>
 <p>Retrieve all blocks</p>
 <h2><a class="anchor" id="autotoc_md33"></a>
 GET /v1/blocks/&lt;int&gt;</h2>
 <p>Retrieve all blocks, grouped in batch sizes of the int parameter</p>
 <h2><a class="anchor" id="autotoc_md34"></a>
 GET /v1/blocks/&lt;int&gt;/&lt;int&gt;</h2>
 <p>Retrieve list of blocks within a range</p>
 <h1><a class="anchor" id="autotoc_md35"></a>
 Miscellaneous</h1>
 <h2><a class="anchor" id="autotoc_md36"></a>
 GET /populatetable</h2>
 <p>Used for the Explorer webpage</p>
 <h1><a class="anchor" id="autotoc_md37"></a>
 Todo</h1>
 <p>Update endpoints to use URL query parameters </p>
 </div></div><!-- contents -->
 </div><!-- PageDoc -->
 </div><!-- doc-content -->
 <!-- start footer part -->
 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
   <ul>
     <li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8 </li>
   </ul>
 </div>
 </body>
 </html>
	<!-- HTML header for doxygen 1.9.8-->
	<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
	<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
	<head>
	<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
	<meta http-equiv="X-UA-Compatible" content="IE=11"/>
	<meta name="generator" content="Doxygen 1.9.8"/>
	<meta name="viewport" content="width=device-width, initial-scale=1"/>
	<title>ResilientDB SDK: HTTP Server Endpoints</title>
	<link href="tabs.css" rel="stylesheet" type="text/css"/>
	<script type="text/javascript" src="jquery.js"></script>
	<script type="text/javascript" src="dynsections.js"></script>
	<link href="navtree.css" rel="stylesheet" type="text/css"/>
	<script type="text/javascript" src="resize.js"></script>
	<script type="text/javascript" src="navtreedata.js"></script>
	<script type="text/javascript" src="navtree.js"></script>
	<link href="search/search.css" rel="stylesheet" type="text/css"/>
	<script type="text/javascript" src="search/searchdata.js"></script>
	<script type="text/javascript" src="search/search.js"></script>
	<link href="doxygen.css" rel="stylesheet" type="text/css" />
	<link href="doxygen_html_style.css" rel="stylesheet" type="text/css"/>
	</head>
	<body>
	<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
	<div id="titlearea">
	<table cellspacing="0" cellpadding="0">
	<tbody>
	<tr id="projectrow">
	<td id="projectlogo"><img alt="Logo" src="logo.png"/></td>
	</tr>
	</tbody>
	</table>
	</div>
	<!-- end header part -->
	<!-- Generated by Doxygen 1.9.8 -->
	<script type="text/javascript">
	/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
	var searchBox = new SearchBox("searchBox", "search/",'.html');
	/* @license-end */
	</script>
	<script type="text/javascript" src="menudata.js"></script>
	<script type="text/javascript" src="menu.js"></script>
	<script type="text/javascript">
	/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
	$(function() {
	initMenu('',true,false,'search.php','Search');
	$(document).ready(function() { init_search(); });
	});
	/* @license-end */
	</script>
	<div id="main-nav"></div>
	</div><!-- top -->
	<div id="side-nav" class="ui-resizable side-nav-resizable">
	<div id="nav-tree">
	<div id="nav-tree-contents">
	<div id="nav-sync" class="sync"></div>
	</div>
	</div>
	<div id="splitbar" style="-moz-user-select:none;"
	class="ui-resizable-handle">
	</div>
	</div>
	<script type="text/javascript">
	/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
	$(document).ready(function(){initNavTree('md__2github_2workspace_2service_2http__server_2README.html',''); initResizable(); });
	/* @license-end */
	</script>
	<div id="doc-content">
	<!-- window showing the filter options -->
	<div id="MSearchSelectWindow"
	onmouseover="return searchBox.OnSearchSelectShow()"
	onmouseout="return searchBox.OnSearchSelectHide()"
	onkeydown="return searchBox.OnSearchSelectKey(event)">
	</div>

	<!-- iframe showing the search results (closed by default) -->
	<div id="MSearchResultsWindow">
	<div id="MSearchResults">
	<div class="SRPage">
	<div id="SRIndex">
	<div id="SRResults"></div>
	<div class="SRStatus" id="Loading">Loading...</div>
	<div class="SRStatus" id="Searching">Searching...</div>
	<div class="SRStatus" id="NoMatches">No Matches</div>
	</div>
	</div>
	</div>
	</div>

	<div><div class="header">
	<div class="headertitle"><div class="title">HTTP Server Endpoints</div></div>
	</div><!--header-->
	<div class="contents">
	<div class="textblock"><p><a class="anchor" id="autotoc_md25"></a> </p>
	<h1><a class="anchor" id="autotoc_md26"></a>
	Transactions</h1>
	<p>Note that key-value pairs committed to ResilientDB through the API store the JSON object as the value. To get the intended value of the pair, simply access the value of the JSON object.</p>
	<h2><a class="anchor" id="autotoc_md27"></a>
	GET /v1/transactions</h2>
	<p>Get all values</p>
	<h2><a class="anchor" id="autotoc_md28"></a>
	GET /v1/transactions/<string></h2>
	<p>Get value of specific id</p>
	<h2><a class="anchor" id="autotoc_md29"></a>
	GET /v1/transactions/<string>/<string></h2>
	<p>Get values based on key range</p>
	<h2><a class="anchor" id="autotoc_md30"></a>
	POST /v1/transactions/commit</h2>
	<p>Sets a new value for a key. Note that key-value pairs committed to ResilientDB through the API store the JSON object as the value. To get the intended value of the pair, simply access the value of the JSON object.</p>
	<p>Ex: ‘curl -X POST -d ’{"id":"samplekey","value":"samplevalue"}' localhost:18000/v1/transactions/commit`</p>
	<h1><a class="anchor" id="autotoc_md31"></a>
	Blocks</h1>
	<h2><a class="anchor" id="autotoc_md32"></a>
	GET /v1/blocks</h2>
	<p>Retrieve all blocks</p>
	<h2><a class="anchor" id="autotoc_md33"></a>
	GET /v1/blocks/<int></h2>
	<p>Retrieve all blocks, grouped in batch sizes of the int parameter</p>
	<h2><a class="anchor" id="autotoc_md34"></a>
	GET /v1/blocks/<int>/<int></h2>
	<p>Retrieve list of blocks within a range</p>
	<h1><a class="anchor" id="autotoc_md35"></a>
	Miscellaneous</h1>
	<h2><a class="anchor" id="autotoc_md36"></a>
	GET /populatetable</h2>
	<p>Used for the Explorer webpage</p>
	<h1><a class="anchor" id="autotoc_md37"></a>
	Todo</h1>
	<p>Update endpoints to use URL query parameters </p>
	</div></div><!-- contents -->
	</div><!-- PageDoc -->
	</div><!-- doc-content -->
	<!-- start footer part -->
	<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
	<ul>
	<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8 </li>
	</ul>
	</div>
	</body>
	</html>