Skip to content

Create Link

Creates a link between two objects with optional data passed in a request body. Returns the created object in the JSON format.

Request

HTTP Request

POST /node/api/links

Permissions

create-links | manage-links

Path parameters

No parameters required.

Body parameters

Parameter Type Description
source String
required		 The ID of a source object.
target String
required		 The ID of a target object.

Request body

To create a link, you need to specify only a source and a target — objects that are connected by the link.

{
    "source": "5e79baae6ec5ea28e5105caa",
    "target": "5e79bbe86ec5ea28e5105d04"
}

You can also specify additional parameters alongside source and target. See the Link model page for all available parameters.

{
    "source": "5e79baae6ec5ea28e5105caa",
    "target": "5e79bbe86ec5ea28e5105d04",

    "operations":[
        {
            "name": "Link operation 1",
            "description": "Link operation description",
            "type": 1,  
            "popupResult": false
            "parameters": {
                "topic": "MQTT Topic",
                "message": "MQTT Message Text"
            }
        },
        {
            "name": "Link operation 2",
            ...
        }

    ],
    "properties":[
        {
            "name": "Link property 1",
            "value": "Value 1",
            "type_id": 1
        },
        {
            "name": "Link property2",
            ...
        },
    ],
    ...
    // Other optional parameters
}

Response

The response contains the created link in the JSON format. See the Link model page for more information.

Example

This example shows how to create a link that connects two objects and has no properties.

Request

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

curl -X POST $url -u $login:$password \
    -H "Content-Type: application/json" \
    -d @- <<EOF
{
    "source": "'$source_obj_id'",
    "target": "'$target_obj_id'"
}
EOF

let login = <...>
let password = <...>
let saymonHostname = <...>
let sourceObjId = <...>
let targetObjId = <...>
let path = "/node/api/links";
let auth = "Basic " + btoa(login + ":" + password);

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

let data = JSON.stringify({
    "source": sourceObjId,
    "target": targetObjId
});

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 sourceObjId = <...>
let targetObjId = <...>
let path = "/node/api/links";
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({
    source: sourceObjId,
    target: targetObjId
});

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

import requests

login = <...>
password = <...>
saymon_hostname = <...>
source_obj_id = <...>
target_obj_id = <...>
url = "https://" + saymon_hostname + "/node/api/links"

body = {
    "source": source_obj_id,
    "target": target_obj_id
}

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

Response

{
    "source": "5e79baae6ec5ea28e5105caa",
    "target": "5e79bbe86ec5ea28e5105d04",
    "owner_id": "5e21b752308c3c66d64e072c",
    "weight": 1,
    "tags": [],
    "last_state_update": 1585053147047,
    "updated": 1585053147046,
    "created": 1585053147047,
    "state_id": 1,
    "class_id": 35,
    "_stateConditionRefs": [],
    "operations": [],
    "properties": [],
    "id": "5e79fddb6ec5ea28e5105f65"
}

See Also