Delete Object's Document

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

Deletes an object's document by its ID.

Permissions: delete-documents | manage-documents | manage-properties | manage-objects.

Request parameters

Path parameters

Parameter

Type

Description

object_id

string

required

The ID of an object whose document should be deleted.

doc_id

string

required

The ID of a document to be deleted.

Response description

The response body is empty.

Request examples

Bash
NodeJS
Python
Bash
login=<your_login>
password=<your_password>
object_id=<your_object_id>
document_id=<your_document_id>
saymon_hostname=<your_saymon_hostname>
url=https://$saymon_hostname/node/api/objects/$object_id/docs/$document_id
curl -X DELETE $url -u $login:$password
NodeJS
const http = require("http");
let login = <your_login>
let password = <your_password>
let saymon_hostname = <your_saymon_hostname>
let object_id = <your_object_id>
let document_id = <your_document_id>
let path = "/node/api/objects/" + object_id + "/docs/" + document_id;
let auth = "Basic " + Buffer.from(login + ":" + password).toString("base64");
let options = {
"method": "DELETE",
"hostname": saymon_hostname,
"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();
Python
import requests
login = <your_login>
password = <your_password>
object_id = <your_object_id>
document_id = <your_document_id>
saymon_hostname = <your_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)