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

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

Запрос

HTTP Запрос

PATCH /node/api/classes/:class_id/props/:prop_id

Права

manage-properties | manage-classes

Права manage-service-properties нужны для работы с системными свойствами.

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

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

обязательный | ID класса. | | prop_id | String

обязательный | ID свойства. |

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

Этот запрос использует модель Свойство:

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

обязательный | Имя свойства. | | value | String

обязательный | Значение свойства. | | type_id | Integer | ID типа свойства. |

Тело запроса

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

Ответ

Этот запрос возвращает ID обновлённого свойства.

Пример

Запрос

• Bash
• JavaScript
• NodeJS
• Python

login=<...>
password=<...>
saymon_hostname=<...>
class_id=<...>
prop_id=<...>
url=https://$saymon_hostname/node/api/classes/$class_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 classId = <...>
let properyId = <...>
let path = "/node/api/classes/" + classId + "/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({
    "name": "New Property Name"
});

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 classId = <...>
let propId = <...>
let path = "/node/api/classes/" + classId + "/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 = <...>
class_id = <...>
property_id = <...>
url = "https://" + saymon_hostname + "/node/api/classes/" + \
    class_id + "/props/" + property_id

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

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

Ответ

{
    "id": "5e678b3678bcdb2837883491"
}

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

• ID типа свойства
• Свойство
• Создать свойство класса
• Удалить свойство класса