Skip to content

Delete History Annotation

Deletes a history annotation.

Request

HTTP Request

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

Permissions

manage-history

Path parameters

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

Request body

The request body is empty.

Response

The response body is empty.

Examples

Request examples

login=<...>
password=<...>
saymon_hostname=<...>
annotation_id=<...>
url=https://$saymon_hostname/node/api/history-annotations/$annotation_id

curl -X DELETE $url -u $login:$password
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("Authorization", auth);

let requestOptions = {
    method: "DELETE",
    headers: headers
};

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": "DELETE",
    "hostname": saymonHostname,
    "headers": {
        "Authorization": auth
    },
    "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);
    });
});

req.end();
import requests

login = <...>
password = <...>
saymonHostname = <...>
annotationId = <...>
url = "https://" + saymonHostname + "/node/api/history-annotations/" \
    + annotationId

response = requests.request("DELETE", url, auth=(login, password))
print(response.text)