Delete Class Property

Deletes a property from a class with the specified ID.

Request

HTTP Request

DELETE /node/api/classes/:classId/props/:propId

Permissions

manage-properties | manage-classes

The manage-service-properties permission is required for service properties.

Path parameters

Parameter Type Description

class_id

String
required

The ID of a class whose property should be deleted.

prop_id

String
required

The ID of a property to be deleted.

Request body

The request body is empty.

Response

The response body is empty.

Example

Request

  • Bash

  • JavaScript

  • NodeJS

  • Python

login=<...>
password=<...>
saymon_hostname=<...>
class_id=<...>
prop_id=<...>
url=https://$saymon_hostname/node/api/classes/$class_id/props/$prop_id

curl -X DELETE $url -u $login:$password
let login = <...>
let password = <...>
let saymonHostname = <...>
let classId = <...>
let properyId = <...>
let path = "/node/api/classes/" + classId + "/props/" + properyId;
let auth = "Basic " + btoa(login + ":" + password);

let headers = new Headers();
headers.append("Content-Type", "application/json");
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 saymon_hostname = <...>
let classId = <...>
let propId = <...>
let path = "/node/api/classes/" + classId + "/props/" + propId;
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 = <...>
saymon_hostname = <...>
class_id = <...>
property_id = <...>
url = "https://" + saymon_hostname + "/node/api/classes/" + \
    class_id + "/props/" + property_id

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

See Also