Обновить свойство потока

Обновляет свойство потока данными, указанными в теле запроса.

Запрос

HTTP Запрос

PATCH /node/api/flows/:flow_id/props/:prop_id

Права

manage-properties | manage-flows

Параметры пути

Параметр Тип Описание

flow_id

String
обязательный

ID потока.

prop_id

String
обязательный

ID свойства.

Параметры тела запроса

Поле Тип Описание

name

String

Имя свойства.

value

String

Значение свойства.

type_id

Integer

ID типа свойства.

Тело запроса

 {
     "name": "New Property Name",
     "value": "New Property Value",
     "type_id": 2
 }

Ответ

В отличие от запросов Обновить свойство связи и Обновить свойство класса этот запрос возвращает только обновлённые свойства вместе с информацией о потоке, к которому относится это свойство (ID потока в поле owner_id и тип сущности в поле owner_type).

  • Обновление значения

  • Обновление имени и значения

Request Body:

{
    "value": "Updated Property Value"
}

Response body:

{
    "value": "Updated Property Value",
    "owner_id": "62f2854e18baa649c1d25a58",
    "owner_type": 3,
    "id": "62f2856218baa649c1d25a5a"
}

Request Body:

{
    "name": "Updated Property Name",
    "value": "Updated Property Value"
}

Response body:

{
    "name": "Updated Property Name",
    "value": "Updated Property Value",
    "owner_id": "62f2854e18baa649c1d25a58",
    "owner_type": 3,
    "id": "62f2856218baa649c1d25a5a"
}

Response can contain these fields:

Поле Тип Описание

id

String

ID свойства.

name

String

Имя свойства.

value

String

Значение свойства.

type_id

Integer

ID типа свойства.

owner_id

String

ID потока, к которому относится свойство.

owner_type

Integer

Тип сущности, к которой относится свойство. Для потока, это значение равно 3.

Пример

Запрос

  • Bash

  • JavaScript

  • NodeJS

  • Python

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

curl -X PATCH $url -u $login:$password \
    -H "Content-Type: application/json" \
    -d @- <<EOF
{
    "value": "New Property Value"
}
EOF
let login = <...>
let password = <...>
let saymonHostname = <...>
let flowId = <...>
let properyId = <...>
let path = "/node/api/flows/" + flowId + "/props/" + properyId;
let auth = "Basic " + btoa(login + ":" + password);

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

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

let requestOptions = {
    method: "PATCH",
    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 propId = <...>
let path = "/node/api/flows/" + flowId + "/props/" + propId;
let auth = "Basic " + Buffer.from(login + ":" + password).toString("base64");

let options = {
    "method": "PATCH",
    "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({
    "value": "New Property Value"
});

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

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

body = {
    "value": "New Property Value"
}

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

Ответ

 {
     "value": "New Property Value",
     "owner_id": "62f2854e18baa649c1d25a58",
     "owner_type": 3,
     "id": "62f2856218baa649c1d25a5a"
 }

Смотрите также