Skip to content

Update Class Property

Update a class property with data provided in a request body.

Request

HTTP Request

PATCH /node/api/classes/:class_id/props/:prop_id

Permissions

manage-properties | manage-classes 

The manage-service-properties permission is required for service properties.

Path parameters

Parameter Type Description
class_id String
required
The ID of a class whose property should be updated.
pro_id String
required
The ID of a property to be updated.

Body parameters

This request uses the Property model:

Field Type Description
name Stringrequired Property's name.
value Stringrequired Property's value.
type_id Integer Property's type ID

Request body

{
    "name": "New Property Name",
    "value": "New Property Value"
}

Response

This request returns the ID of the updated property.

Example

Request

login=<...>
password=<...>
saymon_hostname=<...>
class_id=<...>
prop_id=<...>
url=https://$saymon_hostname/node/api/classes/$class_id/props/$prop_id

curl -X PATCH $url -u $login:$password \
    -H "Content-Type: application/json" \
    -d @- <<EOF
   {
       "value": "New Property Value"
   }
EOF
let login = <...>
let password = <...>
let saymonHostname = <...>
let classId = <...>
let properyId = <...>
let path = "/node/api/classes/" + classId + "/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({
    "name": "New Property Name"
});

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));
const http = require("http");

let login = <...>
let password = <...>
let saymonHostname = <...>
let classId = <...>
let propId = <...>
let path = "/node/api/classes/" + classId + "/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();
import requests

login = <...>
password = <...>
saymon_hostname = <...>
class_id = <...>
property_id = <...>
url = "https://" + saymon_hostname + "/node/api/classes/" + \
    class_id + "/props/" + property_id

body = {
    "value": "New Property Value"
}

response = requests.request("PATCH", url, json=body, auth=(login, password))
print(response.text)

Response

{
    "id": "5e678b3678bcdb2837883491"
}

See Also