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

Получить путь иерархии от исходного объекта заданной связи, до корневого объекта.

Запрос

HTTP Запрос

GET /node/api/links/:id/paths

Права

linkPermissions

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

Параметр	Тип	Описание
id	String	ID связи.

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

Параметр	Тип	Описание
fields	String	Список полей, которые нужно вернуть в теле ответа. Перечисляются через запятую.

Тело запроса

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

Ответ

Ответ содержит два списка – пути (paths) и объекты (objects).

• paths содержит ID каждого родительского объекта (включая корневой объект и исходный объект ссылки). Первый элемент это исходный объект ссылки, последний – корневой объект.
• objects содержит информацию о каждом объекте в пути. Поля, возвращаемые в каждой записи можно настроить в настройках параметра fields. Все возможные поля можно посмотреть в статье Объект.

NOTE

Если у объекта есть несколько путей до корневого объекта (например, в пути есть объект с несколькими родителями), поле path будет содержать список всех путей. Значения в массиве objects не будут дублированы.

По умолчанию, каждая запись в поле objects включает следующие поля:

Поле	Тип	Описание
id	String	ID объекта.
name	String	Имя объекта.
class_id	String	ID класса объекта.
child_ids	Array<String>	Массив ID дочерних объектов.
child_link_ids	Array<String>	Массив ID дочерних связей.
child_ref_ids	Array<String>	Массив ID дочерних ссылок.
parent_id	Array<String>	ID родительских объектов.
geoposition	Array<Float>	Позиция объекта на карте. Определяется как массив из двух элементов. Первый – широта, второй – долгота.
geopositionRadius	Integer	Радиус геопозиции объекта на карте.
state_id	String	ID состояния объекта.
last_state_update	Integer	Время последнего обновления состояния объекта.

Примеры

Запрос

• Bash
• JavaScript
• NodeJS
• Python

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

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

let login = <...>
let password = <...>
let saymonHostname = <...>
let linkId = <...>
let path = "/node/api/links/" + linkId + "/paths";
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 + "/paths";
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 + "/paths"

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

Ответ

    {
      "paths": [
        [
          "601bfe12bcf92174b22ce4f2",
          "601bfdf804ab1a73eda8f1f8",
          1
        ]
      ],
      "objects": [
        {
          "name": "test",
          "state_id": 9,
          "id": "601bfe12bcf92174b22ce4f2"
        },
        {
          "name": "alex-test_2",
          "state_id": 9,
          "id": "601bfdf804ab1a73eda8f1f8"
        },
        {
          "name": "Staging",
          "state_id": 5,
          "id": 1
        }
      ]
    }