Move API 1 docs here
This commit is contained in:
Dominik Werder
159
httpret/static/documentation/api4.html
Normal file
159
httpret/static/documentation/api4.html
Normal file
@@ -0,0 +1,159 @@
|
||||
<!doctype html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="utf-8"/>
|
||||
<title>Databuffer API 4 Documentation</title>
|
||||
<meta name="keywords" content="PSI, DAQ, Databuffer">
|
||||
<meta name="author" content="Dominik Werder">
|
||||
<link rel="shortcut icon" href="about:blank"/>
|
||||
<link rel="stylesheet" href="style.css"/>
|
||||
</head>
|
||||
|
||||
<body>
|
||||
|
||||
<h1>Databuffer API 4 Documentation</h1>
|
||||
|
||||
<p>Documented here are the endpoints for databuffer API 4. The endpoints of the "original" unversioned API is documented at
|
||||
<a href="https://git.psi.ch/sf_daq/ch.psi.daq.databuffer/blob/master/ch.psi.daq.queryrest/Readme.md">this location</a>.</p>
|
||||
|
||||
<h2>Available backends</h2>
|
||||
Currently available:
|
||||
<ul>
|
||||
<li>sf-databuffer</li>
|
||||
</ul>
|
||||
|
||||
|
||||
<h2>API functions</h2>
|
||||
<p>Currently available functionality:</p>
|
||||
<ul>
|
||||
<li><a href="#query-binned">Query binned data</a></li>
|
||||
<li><a href="#search-channel">Search channel</a></li>
|
||||
</ul>
|
||||
|
||||
<a id="query-binned"></a>
|
||||
<h2>Query binned data</h2>
|
||||
<p><strong>Method:</strong> GET</p>
|
||||
<p><strong>URL:</strong> https://data-api.psi.ch/api/4/binned</p>
|
||||
<p><strong>Query parameters:</strong></p>
|
||||
<ul>
|
||||
<li>channelBackend (e.g. "sf-databuffer")</li>
|
||||
<li>channelName (e.g. "SLAAR-LSCP4-LAS6891:CH7:1")</li>
|
||||
<li>begDate (e.g. "2021-05-26T07:10:00.000Z")</li>
|
||||
<li>endDate (e.g. "2021-05-26T07:16:00.000Z")</li>
|
||||
<li>binCount (e.g. "6")</li>
|
||||
</ul>
|
||||
<p><strong>Request header:</strong> "Accept" must be "application/json"</p>
|
||||
|
||||
<h4>CURL example:</h4>
|
||||
<pre>
|
||||
curl -H 'Accept: application/json' 'https://data-api.psi.ch/api/4/binned?channelBackend=sf-databuffer
|
||||
&channelName=SLAAR-LSCP4-LAS6891:CH7:1&begDate=2021-05-25T00:00:00.000Z&endDate=2021-05-26T00:00:00.000Z&binCount=3'
|
||||
</pre>
|
||||
|
||||
<h4>Partial result</h4>
|
||||
<p>If the requested range takes longer time to retrieve, then a partial result with at least one bin is returned.</p>
|
||||
<p>The partial result will contain the necessary information to send another request with a range that
|
||||
starts with the first not-yet-retrieved bin.</p>
|
||||
<p>This information is provided by the <strong>continueAt</strong> and <strong>missingBins</strong> fields.</p>
|
||||
<p>This enables the user agent to start the presentation to the user while updating the user interface
|
||||
as new bins are received.</p>
|
||||
<p>Example:</p>
|
||||
<pre>
|
||||
{
|
||||
"continueAt": "2021-05-25T16:00:00.000Z",
|
||||
"missingBins": 2,
|
||||
"avgs": [
|
||||
340.87640380859375,
|
||||
340.7442321777344,
|
||||
340.58685302734375,
|
||||
341.04608154296875
|
||||
],
|
||||
"counts": [
|
||||
143076,
|
||||
143077,
|
||||
143076,
|
||||
143076
|
||||
],
|
||||
"maxs": [
|
||||
452,
|
||||
452,
|
||||
459,
|
||||
458
|
||||
],
|
||||
"mins": [
|
||||
231,
|
||||
240,
|
||||
239,
|
||||
239
|
||||
],
|
||||
"tsBinEdges": [
|
||||
"2021-05-25T00:00:00.000Z",
|
||||
"2021-05-25T04:00:00.000Z",
|
||||
"2021-05-25T08:00:00.000Z",
|
||||
"2021-05-25T12:00:00.000Z",
|
||||
"2021-05-25T16:00:00.000Z"
|
||||
]
|
||||
}
|
||||
</pre>
|
||||
|
||||
<h4>Complete result</h4>
|
||||
<p>If the result does not contain a <strong>continueAt</strong> key then the result is complete.</p>
|
||||
|
||||
<h4>Finalised range</h4>
|
||||
<p>If the server can determine that no more data will be added to the requested time range
|
||||
then it will add the flag <strong>finalisedRange: true</strong> to the response.</p>
|
||||
|
||||
|
||||
<a id="search-channel"></a>
|
||||
<h2>Search channel</h2>
|
||||
<p><strong>Method:</strong> GET</p>
|
||||
<p><strong>URL:</strong> https://data-api.psi.ch/api/4/search/channel</p>
|
||||
<p><strong>Query parameters:</strong></p>
|
||||
<ul>
|
||||
<li>nameRegex (e.g. "LSCP.*6")</li>
|
||||
<li>sourceRegex (e.g. "178:9999")</li>
|
||||
<li>descriptionRegex (e.g. "celsius")</li>
|
||||
</ul>
|
||||
<p><strong>Request header:</strong> "Accept" must be "application/json"</p>
|
||||
|
||||
<h4>CURL example:</h4>
|
||||
<pre>
|
||||
curl -H 'Accept: application/json' 'https://data-api.psi.ch/api/4/search/channel?sourceRegex=CV.E.+37&nameRegex=120.+y2$'
|
||||
</pre>
|
||||
|
||||
<h4>Example result</h4>
|
||||
<pre>
|
||||
{
|
||||
"channels": [
|
||||
{
|
||||
"name": "S10MA01-DBPM120:Y2",
|
||||
"backend": "sf-databuffer",
|
||||
"source": "tcp://S20-CVME-DBPM2371:9000",
|
||||
"type": "Float32",
|
||||
"shape": [],
|
||||
"unit": "",
|
||||
"description": ""
|
||||
},
|
||||
{
|
||||
"name": "S20SY02-DBPM120:Y2",
|
||||
"backend": "sf-databuffer",
|
||||
"source": "tcp://S20-CVME-DBPM2371:9000",
|
||||
"type": "Float32",
|
||||
"shape": [],
|
||||
"unit": "",
|
||||
"description": ""
|
||||
}
|
||||
]
|
||||
}
|
||||
</pre>
|
||||
<p>The search constraints are AND'd.</p>
|
||||
|
||||
|
||||
<h2>Feedback and comments very much appreciated!</h2>
|
||||
<p>dominik.werder@psi.ch</p>
|
||||
<p>or please assign me a JIRA ticket.</p>
|
||||
|
||||
<div id="footer"></div>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
Reference in New Issue
Block a user