Skip to content

Create Flow Property

Create a property for a flow with the specified ID.

Request

HTTP Request

POST /node/api/flows/:id/props

Permissions

manage-properties | manage-flows

Path parameters

Parameter Type Description
id String
required		 The ID of a flow for which a property should be created.

Body parameters

This request uses the Property model:

Field Type Description
name Stringrequired Property's name.
value Stringrequired Property's value.
type_id Integer Property's type ID

Request body

{
    "name": "My Property",
    "value": "My Value"
}

Response

The response contains the ID of the created property.

Example

Request

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

curl -X POST $url -u $login:$password \
    -H "Content-Type: application/json" \
    -d @- <<EOF
{
    "name": "Property Name",
    "value": "Property Value"
}
EOF

let login = <...>
let password = <...>
let saymonHostname = <...>
let flowId = <...>
let path = "/node/api/flows/" + flowId + "/props";
let auth = "Basic " + btoa(login + ":" + password);

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

let data = JSON.stringify({
    "name": "My Property",
    "value": "My Value"
});

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 flowId = <...>
let path = "/node/api/flows/" + flowId + "/props";
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({
    "name": "Property Name",
    "value": "Property Value"
});

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

import requests

login = <...>
password = <...>
saymon_hostname = <...>
flow_id = <...>
url = "https://" + saymon_hostname + "/node/api/flows/" + \
    flow_id + "/props"

body = {
    "name": "Property Name",
    "value": "Property Value"
}

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

Response

{
    "id": "5e627211663abf27b84f8257"
}

See Also