Set Object's State

PUT /node/api/objects/:id/state

Sets object's state.

Permissions: objectPermissions & (modify-objects | manage-objects).

Request parameters

Path parameters

Parameter

Type

Description

id

string

required

The ID of an object whose state should be set.

Response description

The response body contains the updated object in the JSON format.

Examples

Request examples

Given below is an example of a request body representing an object's state in the JSON format:

body.json
{
"state_id": 4
}

Provided the content is saved in a file named body.json, a request can be like this:

Bash
NodeJS
Python
Bash
login=<your_login>
password=<your_password>
saymon_hostname=<your_saymon_hostname>
object_id=<your_object_id>
url=https://$saymon_hostname/node/api/objects/$object_id/state
curl -X PUT $url -u $login:$password \
-H "Content-Type: application/json" \
--data @/path/to/body.json
NodeJS
const http = require("http");
let login = <your_login>
let password = <your_password>
let saymon_hostname = <your_saymon_hostname>
let object_id = <your_object_id>
let path = "/node/api/objects/" + object_id + "/state";
let auth = "Basic " + Buffer.from(login + ":" + password).toString("base64");
let options = {
"method": "PUT",
"hostname": saymon_hostname,
"headers": {
"Authorization": auth,
"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);
console.log(body.toString());
});
res.on("error", function (error) {
console.error(error);
});
});
let data = JSON.stringify({
"state_id": 5
});
req.write(data);
req.end();
Python
import requests
import json
login = <your_login>
password = <your_password>
saymon_hostname = <your_saymon_hostname>
object_id = <your_object_id>
url = "https://" + saymon_hostname + "/node/api/objects/" + \
object_id + "/state";
with open("/path/to/body.json", "r") as f:
body = json.load(f)
response = requests.request("PUT", url, json=body, auth=(login, password))
print(response.text)

Response description

{
"entityId": "5e21b85b308c3c66d64e07d2",
"entityType": 1,
"body": {
"id": "5e21b85b308c3c66d64e07d2",
"name": "CPU",
"discovery_id": "192.168.1.82-CPU",
"object_groups": [],
"geoposition": [],
"child_ref_ids": [],
"child_link_ids": [],
"child_ids": [],
"parent_id": "5e21b85b308c3c66d64e07bc",
"weight": 1,
"tags": [],
"last_state_update": 1585045998154,
"updated": 1583916836283,
"created": 1579268187099,
"state_id": 5,
"class_id": 4,
"_stateConditionRefs": [],
"operations": [],
"properties": [],
"client_data": "...",
"manual_state": null,
"owner_id": "5e21b752308c3c66d64e072c"
}
}