Update History Annotation

PATCH /node/api/history-annotations/:id

Updates an annotation with data provided in a request body.
Permissions: manage-history.

Request parameters

Path parameters

Parameter
Type
Description
id
string
required
The ID of an annotation to be updated.

Body parameters

See the History Annotation model.

Response description

See the History Annotation model.

Examples

Request examples

Bash
JavaScript
NodeJS
Python
1
login=<...>
2
password=<...>
3
saymon_hostname=<...>
4
annotation_id=<...>
5
url=https://$saymon_hostname/node/api/history-annotations/$annotation_id
6
7
curl -X PATCH $url -u $login:$password \
8
-H "Content-Type: application/json" \
9
-d @- <<EOF
10
{
11
"content": "High Load"
12
}
13
EOF
Copied!
1
let login = <...>
2
let password = <...>
3
let saymonHostname = <...>
4
let annotationId = <...>
5
let path = "/node/api/history-annotations/" + annotationId;
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
"content": "High load"
14
});
15
16
let requestOptions = {
17
method: "PATCH",
18
headers: headers,
19
body: data
20
};
21
22
fetch(saymonHostname + path, requestOptions)
23
.then(response => response.text())
24
.then(result => console.log(result))
25
.catch(error => console.log("error", error));
Copied!
1
const http = require("http");
2
3
let login = <...>
4
let password = <...>
5
let saymonHostname = <...>
6
let annotationId = <...>
7
let path = "/node/api/history-annotations/" + annotationId;
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
"content": "High Load"
39
});
40
41
req.write(data);
42
req.end();
Copied!
1
import requests
2
3
login = <...>
4
password = <...>
5
saymon_hostname = <...>
6
annotation_id = <...>
7
url = "https://" + saymon_hostname + "/node/api/history-annotations/" + \
8
annotation_id
9
10
json = {
11
"content": "High Load"
12
}
13
14
response = requests.request("PATCH", url, json=json, auth=(login, password))
15
print(response.text)
Copied!

Response example

1
{
2
"id": "5e57a883b701ac4dc9e0b67d",
3
"changed": 1582803217942,
4
"user": "5e21b752308c3c66d64e072c",
5
"timestamp": 1582803050000,
6
"content": "High Load"
7
}
Copied!
Last modified 1yr ago