Погасить все аварии

Погасить все аварии в системе и переместить их в историю аварий.

Запрос

HTTP Запрос

POST /node/api/incidents/clear

Тело запроса

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

Фильтр указывается в поле search. Например, запрос со следующим телом погасит все аварии, которые были сгенерированы объектами с классом Антенна.

{
   "search": {
      "filter": [
         "classId",
         "34"
      ]
   }
}

Ответ

Тело ответа пустое.

При выполнении этого запроса, параметру state всех погашаемых аварий присваивается значение 3 (Погашена). Также, каждой аварии добавляется поле clearTimeStamp.

Этот запрос не перемещает аварии в историю. Он помечает аварии как погашенные и после этого сервер перемещает их в историю через определённый промежуток времени. Этот промежуток определяется параметром серверной конфигурации incident_timeout. Пока аварии находятся в этом состоянии, можно Отменить погашение аварии.

При переносе в историю аварии сохраняют свой ID.

Пример изменённой аварии:

До
После

{
    "id": "62ff3cca7d19dd1100f43d7f",
    "entityId": 112,
    "entityType": 1,
    "type": 1,
    "lastState": 4,
    "localTimestamp": 1660894410845,
    "parentChainId": 112,
    "reason": {
        "code": 10
    },
    "state": 4,
    "text": "No Data",
    "timestamp": 1660894410845
}

{
    "id": "62ff3cca7d19dd1100f43d7f",
    "entityId": 112,
    "entityType": 1,
    "type": 1,
    "lastState": 4,
    "localTimestamp": 1660894410845,
    "parentChainId": 112,
    "reason": {
        "code": 10
    },
    "state": 3,
    "text": "No Data",
    "timestamp": 1660894410845,
    "clearTimestamp": 1666687954577
}

Пример

Запрос

Bash
JavaScript
NodeJS
Python

login=<...>
password=<...>
saymon_hostname=<...>
url=https://$saymon_hostname/node/api/incidents/clear

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

let login = <...>
let password = <...>
let saymonHostname = <...>
let path = "/node/api/incidents/clear";
let auth = "Basic " + btoa(login + ":" + password);

let headers = new Headers();
headers.append("Authorization", auth);

let requestOptions = {
    method: "POST",
    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/incidents/clear";
let auth = "Basic " + Buffer.from(login + ":" + password).toString("base64");

let options = {
    "method": "POST",
    "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/incidents/clear"

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