Skip to content

Set Link's State

Sets a link's state.

Request

HTTP Request

PUT /node/api/links/:id/state

Permissions

linkPermissions & (modify-links | manage-links)

Path parameters

Parameter Type Description
id String
required
The ID of a link whose state should be set.

Request body

{
    "state_id": 4
}

Response

Work in Progress

This topic is a work in progress and may be incomplete.

Examples

Request examples

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

curl -X PUT $url -u $login:$password \
    -H "Content-Type: application/json" \
    -d @- <<EOF
{
    "state_id": 4
}
EOF
let login = <...>
let password = <...>
let saymonHostname = <...>
let linkId = <...>
let path = "/node/api/links/" + linkId + "/state";
let auth = "Basic " + btoa(login + ":" + password);

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

let data = JSON.stringify({
    "state_id": 4
});

let requestOptions = {
    method: "PUT",
    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 linkId = <...>
let path = "/node/api/links/" + linkId + "/state";
let auth = "Basic " + Buffer.from(login + ":" + password).toString("base64");

let options = {
    "method": "PUT",
    "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({
    "state_id": 4
});

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

login = <...>
password = <...>
saymon_hostname = <...>
link_id = <...>
url = "https://" + saymon_hostname + "/node/api/links/" + \
    link_id + "/state";

body = {
    "state_id": 4
}

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

Response example

{
    "entityId": "5e79fddb6ec5ea28e5105f65",
    "entityType": 2,
    "body": {
        "id": "5e79fddb6ec5ea28e5105f65",
        "source": "5e79baae6ec5ea28e5105caa",
        "target": "5e79bbe86ec5ea28e5105d04",
        "owner_id": "5e21b752308c3c66d64e072c",
        "weight": 42,
        "tags": [],
        "last_state_update": 1585060846999,
        "updated": 1585055698644,
        "created": 1585053147047,
        "state_id": 4,
        "class_id": 35,
        "_stateConditionRefs": [],
        "operations": [],
        "properties": [
            {
                "name": "Bus_(computing).pdf",
                "value": "upload_a81d451eeebde3da52f7f83a6b83f78f",
                "type_id": 7,
                "id": "5e7a04dc6ec5ea28e5105f7e"
            }
        ]
    }
}