Get Link’s State Triggers

Request

HTTP Request

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

Permissions

linkPermissions & (modify-links | manage-links)

Path parameters

Parameter Type Description

id

String
required

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

Request body

The request body is empty.

Response

Returns an array of link’s state triggers. See the State Trigger model for more information.

If the specified link doesn’t have state triggers, this request will return the following response with the code 404:

{
    "code": "ResourceNotFound",
    "message": "Entity not found: StateTriggers(65e5b703a325401c444b455e, Link(65e5b703a325401c444b455a))"
}
If this link previously had state triggers, but at the time of the request it doesn’t, the request will return the response with the code 200 and an empty response body.

Example

Request

  • Bash

  • JavaScript

  • NodeJS

  • Python

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

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

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

Response

[
    {
        "type": "e-mail",
        "payload": {
            "to": "recepient@example.com",
            "cc": "recepient_copy@example.com"
        },
        "states": [
            3,
            4
        ]
    }
]

See Also