Count Class’s Objects

Returns a number of objects of a specified class.

Request

HTTP Request

GET /node/api/classes/:id/entity-count

Path parameters

Parameter Type Description

id

String
required

The ID of a class whose objects should be counted.

Request body

The request body is empty.

Response

The response body contains the integer value that represents the number of objects of a specified class.

If the class with the specified ID doesn’t exist, this request will return 0, same as if the class existed, but there weren’t any objects of that class in the system.

Example

Request

  • Bash

  • JavaScript

  • NodeJS

  • Python

login=<...>
password=<...>
saymon_hostname=<...>
class_id=<...>
url=https://$saymon_hostname/node/api/classes/$class_id/entity-count

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

let headers = new Headers();
headers.append("Authorization", auth);

let requestOptions = {
    method: "GET",
    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 classId = <...>
let path = "/node/api/classes/" + classId + "/entity-count";
let auth = "Basic " + Buffer.from(login + ":" + password).toString("base64");

let options = {
    "method": "GET",
    "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 = <...>
url = "https://" + saymon_hostname + "/node/api/classes/" + \
    class_id + "/entity-count"

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

Response

274