Получить класс свойства
Возвращает указанный класс свойства.
Запрос
HTTP Запрос
text
GET /node/api/property-classes/:idПараметры пути
| Параметр | Тип | Описание |
|---|---|---|
| id | String |
обязательно | ID класса свойств. |
Тело запроса
Тело запроса пустое.
Ответ
Тело ответа содержит указанный в параметре пути класс свойства.
| Поле | Тип | Описание |
|---|---|---|
| name | String | Имя класса свойств. |
| comment | String | Пользовательский комментарий к классу свойств. |
| description | String | Описание класса свойств. |
| value_type_id | String | ID типа значения, которое использует это свойство. |
| value | Object | Стандартное значение этого свойства. |
| multiple | Boolean | Использует ли этот класс несколько значений для каждого ключа. |
| source | String | ID словаря, которые используется как источник значений для типа значения dictionary. |
| mask | String | Регулярное выражение, которое фильтрует вводимые пользователем значения. |
| system | Boolean | Является ли этот класс системным. |
| id | String | ID класса свойств. |
| multiple_separator | String | Строка, которая разделяет выбранные значения при отображении в интерфейсе. |
| value_display_template | String | |
Шаблон отображения значений. Для получения значения свойства можно использовать макрос {{0}}. |
Словари используют следующую индексацию – ключ можно получить с помощью макроса {{0}}; {{1}} – {{N}} используются для получения соответствущих значений. |
Пример
Запрос
- Bash
- JavaScript
- NodeJS
- Python
bash
login=<...>
password=<...>
saymon_hostname=<...>
class_id=<...>
url=https://$saymon_hostname/node/api/property-classes/$class_id
curl -X GET $url -u $login:$passwordjavascript
let login = <...>
let password = <...>
let saymonHostname = <...>
let classID = <...>
let auth = "Basic " + btoa(login + ":" + password)
let path = "/node/api/property-classes/" + classID
let myHeaders = new Headers();
myHeaders.append("Authorization", auth);
let requestOptions = {
method: 'GET',
headers: myHeaders,
redirect: 'follow'
};
fetch(saymonHostname + path, requestOptions)
.then(response => response.text())
.then(result => console.log(result))
.catch(error => console.log('error', error));javascript
let http = require('follow-redirects').http;
let fs = require('fs');
let login = <...>
let password = <...>
let saymonHostname = <...>
let classId = <...>
let path = "/node/api/property-classes/" + classId;
let auth = "Basic " + Buffer.from(login + ":" + password).toString("base64");
let options = {
'method': 'GET',
'hostname': '192.168.1.101',
'path': '/node/api/property-classes/4',
'headers': {
'Authorization': auth
},
'maxRedirects': 20
};
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();python
import requests
login = <...>
password = <...>
saymon_hostname = <...>
class_id = <...>
url = "http://" + saymon_hostname + "/node/api/property-classes/" + class_id
response = requests.request("GET", url, auth=(login, password))
print(response.text)Ответ
json
{
"name": "Date",
"description": "",
"value_type_id": "date",
"value": null,
"multiple": false,
"source": "",
"mask": "",
"system": true,
"id": "66e05cc8eef8ab1269a88797"
}