Update Object Property

PATCH /node/api/objects/:object_id/props/:prop_id

Update an object property with data provided in a request body.

Permissions: objectPermissions & (manage-properties | manage-objects). If a property is a service property, the manage-service-properties permission is required.

Request parameters

Path parameters

Parameter

Type

Description

object_id

string

required

The ID of an object whose property should be updated.

prop_id

string

required

The ID of a property to be updated.

Body parameters

...

Response description

...

Examples

Request examples

Bash
JavaScript
NodeJS
Python
Bash
login=<...>
password=<...>
saymon_hostname=<...>
object_id=<...>
prop_id=<...>
url=https://$saymon_hostname/node/api/objects/$object_id/props/$prop_id
curl -X PATCH $url -u $login:$password \
-H "Content-Type: application/json" \
-d @- <<EOF
{
"value": "New Property Value"
}
EOF
JavaScript
let login = <...>
let password = <...>
let saymonHostname = <...>
let objectId = <...>
let properyId = <...>
let path = "/node/api/objects/" + objectId + "/props/" + properyId;
let auth = "Basic " + btoa(login + ":" + password);
let headers = new Headers();
headers.append("Content-Type", "application/json");
headers.append("Authorization", auth);
let data = JSON.stringify({
"value": "New Property Value"
});
let requestOptions = {
method: "PATCH",
headers: headers,
body: data
};
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 propId = <...>
let path = "/node/api/objects/" + objectId + "/props/" + propId;
let auth = "Basic " + Buffer.from(login + ":" + password).toString("base64");
let options = {
"method": "PATCH",
"hostname": saymonHostname,
"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({
"value": "New Property Value"
});
req.write(data);
req.end();
Python
import requests
login = <...>
password = <...>
saymon_hostname = <...>
object_id = <...>
property_id = <...>
url = "https://" + saymon_hostname + "/node/api/objects/" + \
object_id + "/props/" + property_id
body = {
"value": "New Property Value"
}
response = requests.request("PATCH", url, json=body, auth=(login, password))
print(response.text)

Response description

{
"name": "1",
"value": "New Property Value",
"type_id": 1,
"id": "5e678b3678bcdb2837883491"
}