Создать отчёт по параметрам

Создаёт Excel-отчёт по параметрам объектов, которые подходят под указанный критерий поиска.

Запрос

HTTP Запрос

POST /node/api/reports/prop-inventory/excel

Права

objectPermissions

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

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

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

Этот запрос использует такие же критерии, что и запрос Поиск объектов.

Тело запроса

Тело запроса содержит критерий поиска объектов, которые будут включены в отчёт.

{
    "name": {
        "$regex": "^test$",
        "$options": "i"
    },
    "class_id": 24
}

Ответ

Возвращает таблицу Excel, которая содержит отчёт свойств по объектам, которые подходят под указанный критерий поиска.

Таблица с отчётом имеет следующую структуру:

Object	Created	property_1	<...>	property_N
<Object Name 1>	DD.MM.YYYY, HH:MM:SS	value	<...>	value
<Object Name 2>	DD.MM.YYYY, HH:MM:SS	value	<...>	value

Список свойств включает в себя все свойства из всех объектов. Если у объекта нет определённого свойства, то ячейка со значением будет пустой.

Пример

Запрос

NOTE

Так как этот запрос возвращает файл XLSX, ответ нужно выводить сразу в файл, чтобы файл не был повреждён.

• Bash
• JavaScript
• NodeJS
• Python

login=<...>
password=<...>
saymon_hostname=<...>
url=https://$saymon_hostname/node/api/reports/prop-inventory/excel

curl -X POST $url +
    -H "Content-Type: application/json" +
-o report.xlsx +
    -d @- <<EOF
{
    "name": {
        "$regex": "{caret}CPU$",
        "$options": "i"
    },
    "class_id": 4,
    "parent_id": "62d7e58056d203149a08001b"
}
EOF

let login = <...>
let password = <...>
let saymonHostname = <...>
let path = "/node/api/reports/prop-inventory/excel";

let headers = new Headers();
headers.append("Content-Type", "application/json");

let data = JSON.stringify({
    "name": {
        "$regex": "^CPU$",
        "$options": "i"
    },
    "class_id": 4,
    "parent_id": "62d7e58056d203149a08001b"
});

let requestOptions = {
    method: "POST",
    headers: headers,
    body: data
};

fetch(saymonHostname + path, requestOptions)
    .then(response => response.blob())
    .then(blob => {
    var file = window.URL.createObjectURL(blob);
    window.location.assign(file);
  })
    .catch(error => console.log("error", error));

const http = require("http");
const fs = require("fs");

let login = <...>
let password = <...>
let saymonHostname = <...>
let path = "/node/api/reports/prop-inventory/excel";

let options = {
    "method": "POST",
    "hostname": saymonHostname,
    "headers": {
      "Content-Type": "application/json"
    },
    "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);

  fs.writeFile('report.xlsx', body.toString(), function (err) {
      if (err) return console.log(err);
      console.log('Saved report.xlsx');
    });
});

res.on("error", function (error) {
    console.error(error);
}); });
....

let data = JSON.stringify({
    "name": {
        "$regex": "{caret}CPU$",
        "$options": "i"
    },
    "class_id": 4,
    "parent_id": "62d7e58056d203149a08001b"
});

req.write(data);
req.end();

import requests

login = <...>
password = <...>
saymon_hostname = <...>
url = "http://" + saymon_hostname + "/node/api/reports/prop-inventory/excel"

json = {
    "name": {
        "$regex": "^CPU$",
        "$options": "i"
    },
    "class_id": 4,
    "parent_id": "62d7e58056d203149a08001b"
}

response = requests.request("POST", url, json=json, auth=(login, password))
f = open("report.xlsx", "w")
f.write(response.text)
f.close()

Ответ

Ответ содержит бинарный файл с отчётом в формате XLSX:

Object	Created	property1	property2
CPU	21.12.2016, 16:41:50	value1	value 3
CPU	11.04.2018, 17:10:38		value 4
CPU	23.07.2018, 13:46:45	value2

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

• Поиск объектов