Skip to content

Get All Links

Returns a list of all links in the system (without properties).

Request

HTTP Request

GET /node/api/links

Permissions

linkPermissions

Path parameters

No parameters required.

Query parameters

Parameter Type Description
field String
optional
A comma-separated list of links' fields to
be retrieved.

Request body

The request body is empty.

Response

Field Type Description
links Array<Link> An array of links.

Examples

Request examples

Way to get links with all fields, except for properties:

login=<...>
password=<...>
saymon_hostname=<...>
url=https://$saymon_hostname/node/api/links

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

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

Way to get links with particular fields:

login=<...>
password=<...>
saymon_hostname=<...>
url=http://$saymon_hostname/node/api/links?fields=source,target

curl -X GET $url -u $login:$password
let login = <...>
let password = <...>
let saymonHostname = <...>
let path = "/node/api/links?fields=source,target"
let auth = "Basic " + btoa(login + ":" + password)
var myHeaders = new Headers();

myHeaders.append("Authorization", auth);

let requestOptions = {
  method: 'GET',
  headers: myHeaders,
  redirect: 'follow'
};

fetch(saymonHostname + path, requestOptions)
  .then(response => response.text())
  .then(result => console.log(result))
  .catch(error => console.log('error', error));
let http = require('follow-redirects').http;
let fs = require('fs');
let saymonHostname = <...>
let login = <...>;
let password = <...>;
let auth = 'Basic ' + Buffer.from(login + ':' + password).toString('base64');


let options = {
  'method': 'GET',
  'hostname': saymonHostname,
  'path': '/node/api/links?fields=source,target',
  'headers': {
    'Authorization': auth
  },
  'maxRedirects': 20
};

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 = <...>
url = 'http://' + saymon_hostname + '/node/api/links?fields=source,target'

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

print(response.text)

Response example

[
    {
        "source": "5e79baae6ec5ea28e5105caa",
        "target": "5e79bbe86ec5ea28e5105d04",
        "last_state_update": 1585053147047,
        "state_id": 1,
        "class_id": 35,
        "id": "5e79fddb6ec5ea28e5105f65"
    },
    ...
]