Update Class

PATCH /node/api/classes/:id

Updates a class according to data provided in a request body. Returns the updated class in the JSON format.
Permissions: modify-classes | manage-classes.

Request parameters

Path parameters

Parameter
Type
Description
id
string
required
The ID of a class to be updated.

Response description

...

Examples

Request examples

Bash
JavaScript
NodeJS
Python
1
login=<...>
2
password=<...>
3
saymon_hostname=<...>
4
class_id=<...>
5
url=https://$saymon_hostname/node/api/classes/$class_id
6
7
curl -X PATCH $url -u $login:$password \
8
-H "Content-Type: application/json" \
9
-d @- <<EOF
10
{
11
"name": "Host",
12
"description": "Physical/virtual host"
13
}
14
EOF
Copied!
1
let login = <...>
2
let password = <...>
3
let saymonHostname = <...>
4
let classId = <...>
5
let path = "/node/api/classes/" + classId;
6
let auth = "Basic " + btoa(login + ":" + password);
7
8
let headers = new Headers();
9
headers.append("Content-Type", "application/json");
10
headers.append("Authorization", auth);
11
12
let data = JSON.stringify({
13
"name": "Host",
14
"description": "Physical/virtual host"
15
});
16
17
let requestOptions = {
18
method: "PATCH",
19
headers: headers,
20
body: data
21
};
22
23
fetch(saymonHostname + path, requestOptions)
24
.then(response => response.text())
25
.then(result => console.log(result))
26
.catch(error => console.log("error", error));
Copied!
1
const http = require("http");
2
3
let login = <...>
4
let password = <...>
5
let saymonHostname = <...>
6
let classId = <...>
7
let path = "/node/api/classes/" + class_id;
8
let auth = "Basic " + Buffer.from(login + ":" + password).toString("base64");
9
10
let options = {
11
"method": "PATCH",
12
"hostname": saymonHostname,
13
"headers": {
14
"Authorization": auth,
15
"Content-Type": "application/json"
16
},
17
"path": path
18
};
19
20
let req = http.request(options, function (res) {
21
let chunks = [];
22
23
res.on("data", function (chunk) {
24
chunks.push(chunk);
25
});
26
27
res.on("end", function (chunk) {
28
let body = Buffer.concat(chunks);
29
console.log(body.toString());
30
});
31
32
res.on("error", function (error) {
33
console.error(error);
34
});
35
});
36
37
let data = JSON.stringify({
38
"description": "Physical/virtual host"
39
});
40
41
req.write(data);
42
req.end();
Copied!
1
import requests
2
3
login = <...>
4
password = <...>
5
saymon_hostname = <...>
6
class_id = <...>
7
url = "https://" + saymon_hostname + "/node/api/classes/" + class_id
8
9
body = {
10
"name": "Host",
11
"description": "Physical/virtual host"
12
}
13
14
response = requests.request("PATCH", url, json=body, auth=(login, password))
15
print(response.text)
Copied!

Response example

1
{
2
"id": "5e7b25e960250428b858f7ae",
3
"name": "Host",
4
"description": "Physical/virtual host",
5
"operations": [],
6
"properties": []
7
}
Copied!
Last modified 1yr ago