Получить все аварии

Возвращает список всех аварий доступных текущему пользователю.

Запрос

HTTP Запрос

GET /node/api/incidents

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

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

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

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

filter

Фильтры аварии

Набор фильтров. Больше информации доступно в разделе Фильтры.

parentFilter

String

ID родительского объекта.

limit

Integer

Максимальное количество возвращаемых записей.

owner

Boolean

Если true, то в ответ включается информация о владельце.

skip

Integer

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

sortDirection

String

Тип сортировки. asc сортировка по возрастанию, desc – по убыванию. По умолчанию – asc.

sortField

String

Имя поля, по которому нужно сортировать значения.

ownerFilter

String

Дополнительные фильтры для данных владельца.

Тело запроса

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

Фильтры

Для фильтрации по родителю, используйте параметр запроса parentFilter.

С помощью параметра filter можно фильтровать аварии.

body = {
    "filter": [
      [
        // фильтр
      ]
    ],
...
}

Также, можно использовать логические операторы И ($and) и ИЛИ ($or):

body = {
    "filter": [
  [
    "$and",
    [
      [
        "$or",
        [
          [
            // фильтр
          ],
          [
            // фильтр
          ]
        ]
      ],
      [
        // фильтр
      ],
      [
        // фильтр
      ]
    ]
  ]
],
...
}

Подробная информация о модели доступна в статье Фильтры аварии.

Ответ

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

Пример

Запрос

  • Bash

  • JavaScript

  • NodeJS

  • Python

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

curl -X GET $url -u $login:$password
let login = <...>
let password = <...>
let saymonHostname = <...>
let path = "/node/api/incidents";
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/incidents/";
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/incidents"

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

Ответ

[
    {
        "id": "58f9fe155be7187c551f1c5f",
        "entityId": 10,
        "entityType": 1,
        "type": 1,
        "state": 1,
        "localTimestamp": 0,
        "data": "{...}",
        "timestamp": 1493884332909,
        "text": "No data"
    },
    ...
]

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