Get All State History

GET /node/api/state-history

Returns all state history records.

Request parameters

Query parameters

Parameter
Type
Description
from
integer
optional
A lower-bound timestamp for state history records.
limit
string
optional
The maximum number of records to be retrieved.
skip
string
optional
The number of the first records to be skipped.
to
integer
optional
An upper-bound timestamp for state history records.

Response description

...

Examples

Request examples

Bash
JavaScript
NodeJS
Python
1
login=<...>
2
password=<...>
3
saymon_hostname=<...>
4
url=https://$saymon_hostname/node/api/state-history
5
6
curl -X GET $url -u $login:$password
Copied!
1
let login = <...>
2
let password = <...>
3
let saymonHostname = <...>
4
let path = "/node/api/state-history";
5
let auth = "Basic " + btoa(login + ":" + password);
6
7
let headers = new Headers();
8
headers.append("Authorization", auth);
9
10
let requestOptions = {
11
method: "GET",
12
headers: headers
13
};
14
15
fetch(saymonHostname + path, requestOptions)
16
.then(response => response.text())
17
.then(result => console.log(result))
18
.catch(error => console.log("error", error));
Copied!
1
const http = require("http");
2
3
let login = <...>
4
let password = <...>
5
let saymonHostname = <...>
6
let path = "/node/api/state-history";
7
let auth = "Basic " + Buffer.from(login + ":" + password).toString("base64");
8
9
let options = {
10
"method": "GET",
11
"hostname": saymonHostname,
12
"headers": {
13
"Authorization": auth
14
},
15
"path": path
16
};
17
18
let req = http.request(options, function (res) {
19
let chunks = [];
20
21
res.on("data", function (chunk) {
22
chunks.push(chunk);
23
});
24
25
res.on("end", function (chunk) {
26
let body = Buffer.concat(chunks);
27
console.log(body.toString());
28
});
29
30
res.on("error", function (error) {
31
console.error(error);
32
});
33
});
34
35
req.end();
Copied!
1
import requests
2
3
login = <...>
4
password = <...>
5
saymon_hostname = <...>
6
url = "https://" + saymon_hostname + "/node/api/state-history"
7
8
response = requests.request("GET", url, auth=(login, password))
9
print(response.text)
Copied!

Response example

1
[
2
{
3
"entityId": 1,
4
"entityType": 1,
5
"stateId": 1,
6
"timestamp": 1579267920651,
7
"entityName": "ROOT",
8
"entityClass": 1,
9
"skip": 0,
10
"id": "5e21b750308c3c66d64e071a"
11
},
12
{
13
"entityId": "5e21b85b308c3c66d64e07c8",
14
"entityType": 1,
15
"stateId": 1,
16
"timestamp": 1579268187090,
17
"entityName": "SAYMON Agent",
18
"entityClass": 2,
19
"skip": 2,
20
"id": "5e21b85b308c3c66d64e07cd"
21
},
22
...
23
]
Copied!