Skip to content

Get All Flows

Returns an array of all existing flows.

Request

HTTP Request

GET /node/api/flows

Path parameters

No parameters required.

Request body

The request body is empty.

Response

Field Type Description
flows Array<Flow> An array of all existing flows.

Example

Request

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

curl -X GET $url -u $login:$password
let login = <...>
let password = <...>
let saymonHostname = <...>
let path = "/node/api/flows";
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 path = "/node/api/flows/";
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 = <...>
url = "https://" + saymon_hostname + "/node/api/flows"

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

Response

[
    {
        "owner_id": 1,
        "item_ids": [
            "5e4e84fa39438824a1046829",
            "5e552961d4511026d723154d",
            "5e6f477fd462c02529b06eb7"
        ],
        "properties": [
            {
                "name": "Bus_(computing).pdf",
                "value": "upload_a1cd2f7efb020a8b9d9ba58afac6b33b",
                "type_id": 7,
                "id": "5e7b491360250428b858f7c9"
            }
        ],
        "client_data": {
            "color": "#111111",
            "connectorStyle": "Bezier"
        },
        "id": "5e7b473e60250428b858f7c4"
    }
]

See Also