Get Class’s State Conditions

Returns an array of class’s state condition.

Request

HTTP Request

GET /node/api/classes/:id/state-conditions

Permissions

modify-classes | manage-classes

Path parameters

Parameter Type Description

id

String
required

The ID of a class whose state conditions should be retrieved.

Request body

The request body is empty.

Response

Returns an array of state conditions in the specified class. See the State Condition model page for more information.

Example

Request

  • Bash

  • JavaScript

  • NodeJS

  • Python

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

curl -X GET $url -u $login:$password
let login = <...>
let password = <...>
let saymonHostname = <...>
let classId = <...>
let path = "/node/api/classes/" + classId + "/state-conditions";
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 + "/state-conditions";
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 + "/state-conditions";

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

Response

[
    {
        "condition": {
            "x": 10
        },
        "state": 5
    },
    {
        "condition": {
            "y": 20
        },
        "state": 6
    }
]

See Also