Создать ссылку

Создаёт новую ссылку.

Запрос

HTTP Запрос

POST /node/api/refs

Права

objectPermissions & (modify-objects | manage-objects)

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

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

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

Параметр Тип Описание

owner

String
обязательный

ID объекта, который станет родительским для ссылки.

target

String
обязательный

ID объекта, на который укажет созданная ссылка.

client_data

String

Клиентские данные созданной ссылки.

Тело запроса

{
    "target": "5e60d9db630502472925fe9f",
    "owner": "573cbfe6afcb6549545c81e6",
    "client_data": "{\"headlinePropIds\":[],\"custom_style\":{\"zIndex\":13,\"left\":\"825px\",\"top\":\"323px\"}}"
}

Ответ

Поле Тип Описание

id

String

ID ссылки.

owner

String

ID родительского объекта ссылки.

target

String

ID объекта.

client_data

String

Клиентские данные для созданной ссылки.

Пример

Запрос

  • Bash

  • JavaScript

  • NodeJS

  • Python

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

curl -X POST $url -u $login:$password \
    -H "Content-Type: application/json" \
    --data '{"target": "5e60d9db630502472925fe9f", "owner": "1"}'
let login = <...>
let password = <...>
let saymonHostname = <...>
let path = "/node/api/refs";
let auth = "Basic " + btoa(login + ":" + password);

let headers = new Headers();
headers.append("Content-Type", "application/json");
headers.append("Authorization", auth);

let data = JSON.stringify({
    "target": "5e60d9db630502472925fe9f",
    "owner": "1"
});

let requestOptions = {
    method: "POST",
    headers: headers,
    body: data
};

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/refs";
let auth = "Basic " + Buffer.from(login + ":" + password).toString("base64");

let options = {
    "method": "POST",
    "hostname": saymonHostname,
    "headers": {
        "Authorization": auth,
        "Content-Type": "application/json"
    },
    "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);
    });
});

let data = JSON.stringify({
    "target": "5e60d9db630502472925fe9f",
    "owner": "1"
});

req.write(data);
req.end();
import requests

login = <...>
password = <...>
saymon_hostname = <...>
url = "https://" + saymon_hostname + "/node/api/refs"

body = {
    "target": "5e60d9db630502472925fe9f",
    "owner": "1"
}

response = requests.request("POST", url, json=body, auth=(login, password))
print(response.text)

Ответ

{
    "target": "5e60d9db630502472925fe9f",
    "owner": "1",
    "id": "5e60dbdb630502472925febd"
}