Skip to content

Create Reference

Creates a new reference.

Request

HTTP Request

POST /node/api/refs

Permissions

objectPermissions & (modify-objects | manage-objects)

Path parameters

No parameters required.

Body parameters

Parameter Type Description
client_data string ... ...
owner String
required
The ID of an object that should be used as a root for the created reference.
target String
required
The ID of an object to which a reference should be created.

Request body

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

Response

Field Type Description
client_data string ... ...
id

string

required

The ID of the created reference.
owner

string

required

The ID of the object used as a root for the created reference.
target

string

required

The ID of the object to which the reference was created.

Examples

Request examples

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)

Response example

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