Skip to content

Get Script's Usage Count

Returns the number of objects and links that use a script with the specified ID.

Request

HTTP Request

GET /node/api/scripts/:id/usage/count

Permissions

manage-scripts

Path parameters

Parameter Type Description
id String
required
The ID of a script whose usage count should be retrieved.

Request body

The request body is empty.

Response

The response body contains the number of objects and links that use the script.

Examples

Request examples

login=<...>
password=<...>
saymon_hostname=<...>
script_id=<...>
url=https://$saymon_hostname/node/api/scripts/$script_id/usage/count

curl -X GET $url -u $login:$password
let login = <...>
let password = <...>
let saymonHostname = <...>
let scriptId = <...>
let path = "/node/api/scripts/" + scriptId + "/usage/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 scriptId = <...>
let path = "/node/api/scripts/" + scriptId + "/usage/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 = <...>
script_id = <...>
url = "https://" + saymon_hostname + "/node/api/scripts/" + \
    script_id + "/usage/count"

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

Response example

42