Получить историю состояний

Возвращает все записи истории состояний для объектов и связей. Этот запрос возвращает только те записи, которые относятся к объектам, к которым у пользователя есть доступ.

Запрос

HTTP Запрос

GET /node/api/state-history-log

Параметры пути

Параметры не требуются.

Параметры запроса

Параметр Тип Описание

from

Integer

От какой даты искать записи. Unix-время в миллисекундах.

Integer

До какой даты искать записи. Unix-время в миллисекундах.

limit

String

Максимальное количество возвращаемых записей. Отсчёт начинается с 0. Если не указать этот параметр, то этот запрос вернёт всю историю в заданном промежутку времени.

skip

String

Сколько записей с начала списка нужно пропустить. Значение по умолчанию 0.

inverse

Boolean

true чтобы вернуть записи в обратном порядке – от самых старых до самых недавних. Значение по умолчанию false.

downsample

Boolean

true чтобы вкючить даунсэмплинг. Значение по умолчанию false.

stateId

String | Array<String>

ID состояния, по которому фильтровать историю состояний.

classId

String | Array<String>

ID состояния или массив ID состояний, по которому фильтровать историю состояний. Запрос вернёт только те записи, которые относятся к объектам этого класса.

tagId

String | Array<String>

ID тега или массив ID тегов, по которому фильтровать историю состояний. Запрос вернёт только те записи, которые относятся к объектам с указанными тегами.

entityId

String | Array<String>

ID сущности или массив ID сущностей, по которому фильтровать историю состояний. Запрос вернёт только те записи, которые относятся к объектам с указанными ID.

entityType

Integer

Фильтр по типу сущности. 1 – объект, 2 – связь.

entityName

String

Фильтр истории по имени сущности.

Временной промежуток, указанный в параметрах должен быть не больше промежутка, указанного в серверной конфигурации.

Тело запроса

Тело запроса пустое.

Ответ

Возвращает массив записей, которые подходят по критериям, указанным в параметрах. Подробная информация о модели доступна в статье История состояний.

Пример

Запрос

Bash
JavaScript
NodeJS
Python

login=<...>
password=<...>
saymon_hostname=<...>
url=https://$saymon_hostname/node/api/state-history-log

curl -X GET $url -u $login:$password

let login = <...>
let password = <...>
let saymonHostname = <...>
let path = "/node/api/state-history-log";
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 path = "/node/api/state-history-log";
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();

import requests

login = <...>
password = <...>
saymon_hostname = <...>
url = "https://" + saymon_hostname + "/node/api/state-history-log"

response = requests.request("GET", url, auth=(login, password))
print(response.text)

Ответ

[
    {
        "entityId": 1,
        "entityType": 1,
        "stateId": 1,
        "timestamp": 1579267920651,
        "entityName": "ROOT",
        "entityClass": 1,
        "skip": 0,
        "id": "5e21b750308c3c66d64e071a"
    },
    {
        "entityId": "5e21b85b308c3c66d64e07c8",
        "entityType": 1,
        "stateId": 1,
        "timestamp": 1579268187090,
        "entityName": "SAYMON Agent",
        "entityClass": 2,
        "skip": 2,
        "id": "5e21b85b308c3c66d64e07cd"
    },
    ...
]

Смотрите также

История состояний