Skip to content

Update History Annotation

Updates a history annotation with data provided in a request body.

Request

HTTP Request

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

Permissions

manage-history

Path parameters

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

Body parameters

For a list of all possible fields, see the History Annotation model.

Request body

{
    "content": "Updated History Annotation"
}

Response

Returns the updated History Annotation. See the History Annotation model for all returned fields.

Example

Request

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

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));

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();

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

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

See Also