Получить все объекты
Получить список всех объектов в системе.
NOTE
По умолчанию, этот запрос возвращает не все поля объектов. Подробную информацию можно найти в разделе Ответ .
Запрос
HTTP Запрос
text
GET /node/api/objectsПрава
text
objectPermissionsПараметры пути
Параметры не требуются.
Параметры запроса
| Параметр | Тип | Описание |
|---|---|---|
| fields | String | Список возвращаемых полей объектов. Поля перечисляются через запятую. Подробная информация о модели доступна в статье Объект. |
Тело запроса
Тело запроса пустое.
Ответ
Ответ содержит массив всех объектов в системе в формате JSON.
Поля, которые включены в ответ по умолчанию:
| Поле | Тип | Описание |
|---|---|---|
| id | String | ID объекта. Всегда возвращается. |
| name | String | Имя объекта. |
| parent_id | Array<String> | ID родительских объектов. |
| class_id | Integer | ID класса объекта. |
| state_id | Integer | ID состояния объекта. |
| last_state_update | Integer | Время последнего обновления состояния объекта. |
| child_ids | Array<String> | Массив ID дочерних объектов. |
| child_link_ids | Array<String> | Массив ID дочерних связей. |
| child_ref_ids | Array<String> | Массив ID дочерних ссылок. |
| geoposition | Array<Float> | Позиция объекта на карте. Определяется как массив из двух элементов. Первый – широта, второй – долгота. |
Вы можете получить любое поле объекта, указав его в параметре запроса fields. В этом случае, только указанные поля и поле id будут включены в теле ответа. Подробная информация о модели доступна в статье Объект.
Пример
Получить стандартные поля
Этот пример показывает как получить стандартный набор полей от каждого объекта в системе.
Запрос
- Bash
- JavaScript
- NodeJS
- Python
bash
login=<...>
password=<...>
saymon_hostname=<...>
url=https://$saymon_hostname/node/api/objects
curl -X GET $url -u $login:$passwordjavascript
let login = <...>
let password = <...>
let saymonHostname = <...>
let path = "/node/api/objects";
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));javascript
const http = require("http");
let login = <...>
let password = <...>
let saymonHostname = <...>
let path = "/node/api/objects";
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();python
import requests
login = <...>
password = <...>
saymon_hostname = <...>
url = "https://" + saymon_hostname + "/node/api/objects"
response = requests.request("GET", url, auth=(login, password))
print(response.text)Ответ
json
[
{
"parent_id": [
"62d7e58056d203149a08001b"
],
"name": "Test Object",
"class_id": 24,
"geoposition": [],
"geopositionRadius": 0,
"state_id": 1,
"last_state_update": 1658316250338,
"child_ids": [],
"child_link_ids": [],
"child_ref_ids": [],
"id": "62d7e5da56d203149a08002f"
},
{
"parent_id": [
"626a438c4a7f8827220e0ed3"
],
"name": "wlan1",
"class_id": 11,
"state_id": 3,
"last_state_update": 1660514277761,
"child_ids": [],
"child_link_ids": [],
"child_ref_ids": [],
"geoposition": [],
"id": "626a438e4a7f8827220e0ede"
},
...
]Получить определённые поля
Этот пример показыват как указать поля, которые нужно получить в ответе.
Этот пример возвращает только поля name и parent_id из стандартного набора, а также поле properties, которое не входит в стандартный набор. Заметьте, что поле id не указано в списке полей, но всё равно включено в тело ответа.
Запрос
- Bash
- JavaScript
- NodeJS
- Python
bash
login=<...>
password=<...>
saymon_hostname=<...>
url=https://$saymon_hostname/node/api/objects?fields=name,parent_id,properties
curl -X GET $url -u $login:$passwordjavascript
let login = <...>
let password = <...>
let saymonHostname = <...>
let queryParams = "fields=name,parent_id,properties";
let path = "/node/api/objects" + "?" + queryParams;
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));javascript
const http = require("http");
let login = <...>
let password = <...>
let saymonHostname = <...>
let queryParams = "fields=name,parent_id,properties";
let path = "/node/api/objects" + "?" + queryParams;
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();python
import requests
login = <...>
password = <...>
saymon_hostname = <...>
url = "https://" + saymon_hostname + "/node/api/objects?fields=name,parent_id,properties"
response = requests.request("GET", url, auth=(login, password))
print(response.text)Ответ
json
[
{
"parent_id": [
"62d7e58056d203149a08001b"
],
"name": "Test Object",
"properties": [
{
"type_id": 1,
"name": "My Property",
"value": "My Value",
"id": "62f0f62293d1854858a1fa77",
"owner_id": "62d7e5da56d203149a08002f",
"owner_type": 1
},
...
],
"id": "62d7e5da56d203149a08002f"
},
{
"parent_id": [
"62d7e58056d203149a08001b"
],
"name": "Test Object",
"properties": [],
"id": "62d7e5da56d203149a08002f"
},
]