Skip to content

Delete Object's Document

Deletes an object's document by its ID.

Request

HTTP Request

DELETE /node/api/objects/:object_id/docs/:doc_id

Permissions

delete-documents | manage-documents | manage-properties | manage-objects

Path parameters

Parameter Type Description
doc_id

string

required

The ID of the document to be deleted.
object_id

string

required

The ID or discovery ID of the object whose document must be deleted.

Request body

The request body is empty.

Response

The response body is empty.

Examples

Request examples

login=<...>
password=<...>
object_id=<...>
document_id=<...>
saymon_hostname=<...>
url=https://$saymon_hostname/node/api/objects/$object_id/docs/$document_id

curl -X DELETE $url -u $login:$password
let login = <...>
let password = <...>
let saymonHostname = <...>
let objectId = <...>
let documentId = <...>
let path = "/node/api/objects/" + objectId + "/docs/" + documentId;
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 objectId = <...>
let documentId = <...>
let path = "/node/api/objects/" + objectId + "/docs/" + documentId;
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 = <...>
object_id = <...>
document_id = <...>
saymon_hostname = <...>
url = "https://" + saymon_hostname + "/node/api/objects/" + \
    object_id + "/docs/" + document_id

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