Skip to content

Get Object Properties

Returns an array of object's properties.

Request

HTTP Request

/node/api/objects/:id/props

Permissions

objectPermissions

Path parameters

Parameter Type Description
id String
required
The ID of the object whose properties should be retrieved.

Request body

The request body is empty

Response

Response contains an array of all object's properties. See the Property model for a list of all returned fields.

Examples

Request

login=<...>
password=<...>
saymon_hostname=<...>
object_id=<...>
url=https://$saymon_hostname/node/api/objects/$object_id/props

curl -X GET $url -u $login:$password
let login = <...>
let password = <...>
let saymonHostname = <...>
let objectId = <...>
let path = "/node/api/objects/" + objectId + "/props";
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 objectId = <...>
let path = "/node/api/objects/" + objectId + "/props";
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 = <...>
object_id = <...>
url = "https://" + saymon_hostname + "/node/api/objects/" + object_id + "/props"

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

Response

[
  {
    "name": "AgentId",
    "type_id": 8,
    "value": "6392ecd59e5e644811f1005d",
    "id": "6392ef349e5e644811f1006a"
  },
  ...
  {
    "type_id": 1,
    "name": "hello",
    "value": "world",
    "id": "6396da5eb39b538d3b358e57"
  }
]