Получить все связи

Возвращает список всех связей в системе.

NOTE

Этот запрос не возвращает все поля по умолчанию. Подробнее можно прочитать в разделе Ответ .

Запрос

HTTP Запрос

GET /node/api/links

Права

linkPermissions

Параметры пути

Параметры не требуются.

Параметры запроса

Параметр	Тип	Описание
fields	String	Список возвращаемых полей объектов. Поля перечисляются через запятую. Подробная информация о модели доступна в статье Связь.

Тело запроса

Тело запроса пустое.

Ответ

Ответ содержит массив всех связей в системе в формате JSON.

Поля, которые включены в ответ по умолчанию:

Поле	Тип	Описание
class_id	Integer	ID класса связи.
entityType	Integer	Тип сущности. Для связи, тип сущности – 2.
id	String	ID связи. Всегда возвращается.
last_state_update	Integer	Время последнего изменения состояния.
source	String	Исходный объект связи.
source_name	String	Имя исходного объекта связи.
state_id	Integer	ID текущего состояния связи.
target	String	Целевой объект связи.
target_name	String	Имя целевого объекта связи.

Вы можете получить любое поле связи, указав его в параметре запроса fields. В этом случае, только указанные поля и поле id будут включены в теле ответа.Подробная информация о модели доступна в статье Связь.

Примеры

Получить стандартные поля

Этот пример показывает как получить стандартный набор полей от каждой связи в системе.

Запрос

• Bash
• JavaScript
• NodeJS
• Python

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)

Ответ

[
  {
          "class_id": 35,
          "source": "56658fd721eed1df4a9ba5ef",
          "state_id": 3,
          "target": "566965ff6fddd44f472423ff",
          "last_state_update": 1660168711520,
          "source_name": "source obj",
          "target_name": "target obj",
          "id": "5669660b6fddd44f47242401"
  },
  {
          "class_id": 35,
          "source": "567030ad73c5248568ce7728",
          "state_id": 3,
          "target": "56702ff073c5248568ce771d",
          "last_state_update": 1660168703038,
          "source_name": "source obj",
          "target_name": "target obj",
          "id": "567031be73c5248568ce7733"
  },
  {
          "class_id": 35,
          "source": 127,
          "state_id": 9,
          "target": 112,
          "last_state_update": null,
          "source_name": "source obj",
          "target_name": "target obj",
          "id": "56fce71063c02bcb447943c6"
  }
  ...
]

Получить определённые поля

Этот пример показыват как указать поля, которые нужно получить в ответе.

Этот пример возвращает только поля name и parent_id из стандартного набора, а также поле properties, которое не входит в стандартный набор. Заметьте, что поле id не указано в списке полей, но всё равно включено в тело ответа.

Запрос

• Bash
• JavaScript
• NodeJS
• Python

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

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

let login = <...>
let password = <...>
let saymonHostname = <...>
let path = "/node/api/links?fields=source,target,properties"
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,properties',
  '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,properties'

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

print(response.text)

Ответ

[
    {
        "source": 131,
        "target": 130,
        "properties": [],
          "id": 17
        },
    {
        "source": 132,
        "target": 130,
        "properties": [
          {
              "type_id": 8,
              "name": "AgentId",
              "value": "",
              "id": "62e15d73361a5d7ec2768109",
              "owner_id": "62d7e5e456d203149a080038",
              "owner_type": 2
          },
          ...
        ],
        "id": 20
    },
...
]

Смотрите также

• Связь
• Получить связь по ID