Get History Annotations
Returns an array of history annotation.
Request
HTTP Request
Path parameters
No parameters required.
Query parameters
Parameter | Type | Description |
---|---|---|
from | Integerrequired |
A lower bound timestamp for history records. |
to | Integerrequired |
An upper bound timestamp for history records. |
Request body
The request body is empty.
Response
Returns an array of History Annotations.
Warning
If both from
and to
query parameters weren't specified, this request returns an empty array.
Example
Request
let login = <...>
let password = <...>
let saymonHostname = <...>
let queryParams = "from=1577836800000&to=1580515200000";
let path = "/node/api/history-annotations" + "?" + queryParams;
let auth = "Basic " + btoa(login + ":" + password);
let headers = new Headers();
headers.append("Authorization", auth);
let requestOptions = {
method: "GET",
headers: headers
};
fetch(saymonHostname + path, requestOptions)
.then(response => response.text())
.then(result => console.log(result))
.catch(error => console.log("error", error));
const http = require("http");
let login = <...>
let password = <...>
let saymonHostname = <...>
let queryParams = "from=1577836800000&to=1580515200000";
let path = "/node/api/history-annotations/" + "?" + queryParams;
let auth = "Basic " + Buffer.from(login + ":" + password).toString("base64");
let options = {
"method": "GET",
"hostname": saymonHostname,
"headers": {
"Authorization": auth
},
"path": path
};
let req = http.request(options, function (res) {
let chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function (chunk) {
let body = Buffer.concat(chunks);
console.log(body.toString());
});
res.on("error", function (error) {
console.error(error);
});
});
req.end();
Response
[
{
"id": "5e4bf2a2b4d8992a386302ac",
"changed": 1582035618335,
"user": "5e21b752308c3c66d64e072c",
"timestamp": 1582032779825,
"content": "High load"
},
{
"id": "5e4bf2acb4d8992a386302ae",
"changed": 1582035641616,
"user": "5e21b752308c3c66d64e072c",
"timestamp": 1582032920409,
"content": "Low temperature"
}
]