Get Link’s State Conditions

Returns link’s state condition.

Request

HTTP Request

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

Permissions

linkPermissions & (modify-links | manage-links)

Path parameters

Parameter Type Description

id

String
required

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

Request body

The request body is empty.

Response

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

Example

Request

Bash
JavaScript
NodeJS
Python

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

curl -X GET $url -u $login:$password

let login = <...>
let password = <...>
let saymonHostname = <...>
let linkId = <...>
let path = "/node/api/links/" + linkId + "/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 linkId = <...>
let path = "/node/api/links/" + linkId + "/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 = <...>
link_id = <...>
url = "https://" + saymon_hostname + "/node/api/links/" + \
    link_id + "/state-conditions";

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

Response

[
    {
        "condition": {
            "_meta_error": {
                "_eq": "42"
            }
        },
        "state": 4,
        "description": ""
    }
]

See Also