Get Object by ID

GET /node/api/objects/:id

Returns a JSON representation of the object with the specified ID.
Permissions: objectPermissions.

Request parameters

Path parameters

Parameter
Type
Description
id
String
required
The ID or discovery ID of the object to be retrieved.

Response description

See the Object model.

Examples

Request examples

Bash
JavaScript
NodeJS
Python
1
login=<...>
2
password=<...>
3
saymon_hostname=<...>
4
object_id=<...>
5
url=https://$saymon_hostname/node/api/objects/$object_id
6
7
curl -X GET $url -u $login:$password
Copied!
1
let login = <...>
2
let password = <...>
3
let saymonHostname = <...>
4
let objectId = <...>
5
let path = "/node/api/objects/" + objectId;
6
let auth = "Basic " + btoa(login + ":" + password);
7
8
let headers = new Headers();
9
headers.append("Authorization", auth);
10
11
let requestOptions = {
12
method: "GET",
13
headers: headers
14
};
15
16
fetch(saymonHostname + path, requestOptions)
17
.then(response => response.text())
18
.then(result => console.log(result))
19
.catch(error => console.log("error", error));
Copied!
1
const http = require("http");
2
3
let login = <...>
4
let password = <...>
5
let saymonHostname = <...>
6
let objectId = <...>
7
let path = "/node/api/objects/" + objectId;
8
let auth = "Basic " + Buffer.from(login + ":" + password).toString("base64");
9
10
let options = {
11
"method": "GET",
12
"hostname": saymonHostname,
13
"headers": {
14
"Authorization": auth
15
},
16
"path": path
17
};
18
19
let req = http.request(options, function (res) {
20
let chunks = [];
21
22
res.on("data", function (chunk) {
23
chunks.push(chunk);
24
});
25
26
res.on("end", function (chunk) {
27
let body = Buffer.concat(chunks);
28
console.log(body.toString());
29
});
30
31
res.on("error", function (error) {
32
console.error(error);
33
});
34
});
35
36
req.end();
Copied!
1
import requests
2
3
login = <...>
4
password = <...>
5
saymon_hostname = <...>
6
object_id = <...>
7
url = "https://" + saymon_hostname + "/node/api/objects/" + object_id
8
9
response = requests.request("GET", url, auth=(login, password))
10
print(response.text)
Copied!

Response example

1
{
2
"name": "Updated Object",
3
"owner_id": "5e21b752308c3c66d64e072c",
4
"object_groups": [],
5
"geoposition": [],
6
"child_ref_ids": [],
7
"child_link_ids": [],
8
"child_ids": [],
9
"parent_id": "1",
10
"weight": 1,
11
"tags": [],
12
"last_state_update": 1585035085802,
13
"updated": 1585035988974,
14
"created": 1585035085802,
15
"state_id": 1,
16
"class_id": 13,
17
"_stateConditionRefs": [],
18
"operations": [],
19
"properties": [],
20
"client_data": "{...}",
21
"id": "5e79b74d6ec5ea28e5105c58"
22
}
Copied!