Get Objects' Properties Names

Returns a list of properties' names of all objects.

Request

HTTP Request

GET /node/api/properties-name

Permissions

objectPermissions

Path parameters

Parameter Type Description

skip

Integer

The number of the first records to be skipped.

limit

Integer

The maximum number of history records in the response.

type_id

Array<Integer>

Comma-separated list of property types, that this request must return.

Request body

The request body is empty.

Response

Returns an array of IDs of all properties in the system.

Example

Request

  • Bash

  • JavaScript

  • NodeJS

  • Python

login=<...>
password=<...>
saymon_hostname=<...>
url=https://$saymon_hostname/node/api/properties-name

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

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

Response

[
    {
        "id": "Host name"
    },
    {
        "id": "IP"
    },
    ...
]