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
Bash
login=<...>
password=<...>
saymon_hostname=<...>
annotation_id=<...>
url=https://$saymon_hostname/node/api/history-annotations/$annotation_id
curl -X PATCH $url -u $login:$password \
-H "Content-Type: application/json" \
-d @- <<EOF
{
"content": "High Load"
}
EOF
JavaScript
let login = <...>
let password = <...>
let saymonHostname = <...>
let annotationId = <...>
let path = "/node/api/history-annotations/" + annotationId;
let auth = "Basic " + btoa(login + ":" + password);
let headers = new Headers();
headers.append("Content-Type", "application/json");
headers.append("Authorization", auth);
let data = JSON.stringify({
"content": "High load"
});
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 annotationId = <...>
let path = "/node/api/history-annotations/" + annotationId;
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({
"content": "High Load"
});
req.write(data);
req.end();
Python
import requests
login = <...>
password = <...>
saymon_hostname = <...>
annotation_id = <...>
url = "https://" + saymon_hostname + "/node/api/history-annotations/" + \
annotation_id
json = {
"content": "High Load"
}
response = requests.request("PATCH", url, json=json, auth=(login, password))
print(response.text)

Response example

{
"id": "5e57a883b701ac4dc9e0b67d",
"changed": 1582803217942,
"user": "5e21b752308c3c66d64e072c",
"timestamp": 1582803050000,
"content": "High Load"
}