Get Object by ID

GET /node/api/objects/:id

Returns a JSON representation of an object with the specified ID.

Request parameters

Path parameters

Parameter

Type

Description

id

string

required

The ID of an object to be retrieved.

Response description

...

Examples

Request examples

Bash
JavaScript
NodeJS
Python
Bash
login=<...>
password=<...>
saymon_hostname=<...>
object_id=<...>
url=https://$saymon_hostname/node/api/objects/$object_id
curl -X GET $url -u $login:$password
JavaScript
let login = <...>
let password = <...>
let saymonHostname = <...>
let objectId = <...>
let path = "/node/api/objects/" + objectId;
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));
NodeJS
const http = require("http");
let login = <...>
let password = <...>
let saymonHostname = <...>
let objectId = <...>
let path = "/node/api/objects/" + objectId;
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();
Python
import requests
login = <...>
password = <...>
saymon_hostname = <...>
object_id = <...>
url = "https://" + saymon_hostname + "/node/api/objects/" + object_id
response = requests.request("GET", url, auth=(login, password))
print(response.text)

Response example

{
"name": "Updated Object",
"owner_id": "5e21b752308c3c66d64e072c",
"object_groups": [],
"geoposition": [],
"child_ref_ids": [],
"child_link_ids": [],
"child_ids": [],
"parent_id": "1",
"weight": 1,
"tags": [],
"last_state_update": 1585035085802,
"updated": 1585035988974,
"created": 1585035085802,
"state_id": 1,
"class_id": 13,
"_stateConditionRefs": [],
"operations": [],
"properties": [],
"client_data": "{...}",
"id": "5e79b74d6ec5ea28e5105c58"
}