Equipment

Разработчикам / REST API для BOOCO Meteor (v 1.x) / Общее API

В данном разделе описываются методы для работы с оборудованием.

Endpoint	Метод	Описание	Queries	Body (JSON)	Значение поля data	Права (ресурс)	Версия	Комментарий
/equipment	GET	Получение списка оборудования и его свойств	drivername	нет	`Equipment[]`	equipment:readAny
/equipment/:id	GET	Получение информации об устройстве по имени или по другому ключевому параметру	key	нет	`Equipment`	equipment:readAny
/equipment/:id	DELETE	Удаление устройства	key	нет		equipment:deleteAny
/equipment/	POST	Добавление устройства		`Equipment`	Данные (body): информация об устройстве в формате JSON	equipment:createAny
/equipment/:id	PUT	Обновление свойств устройства	key	`Equipment`		equipment:updateAny
/equipment/schema	GET	Получение схемы каналов и тегов устройств		нет		equipment:readAny
/equipment/schema	POST	Получение схемы каналов и тегов устройств		`Equipment`	Фильтр поиска	equipment:readAny
/equipment/schema	GET	Получение схемы каналов и тегов устройств		нет		equipment:readAny
/equipment/schema/:name	GET	Получение схемы каналов и тегов выбранного устройства		нет		equipment:readAny
/equipment/set/:name/:channel/:value	GET	Отправка команды на устройство (setChannel)		нет		equipment:executeAny
/equipment/get/:name	GET	Получение значений обратных связей для устройства		нет		equipment:readAny
/equipment/get/:name/:feedback	GET	Получение значения обратной связи		нет		equipment:readAny
/equipment/setFeedback/:name/:feedback/:value	GET	Установка обратной связи		нет		equipment:executeAny		Данную команду следует использовать только для устройств с типом `script`
/equipment/subscribe/	POST	Подписка на изменения в коллекции equipment		`SubscriptionInfo<Equipment>`	Параметры подписки	equipment:readAny
/equipment/channels/subscribe/	POST	Подписка на изменение каналов оборудования			Параметры подписки	equipment:executeAny		Данную команду следует использовать только для устройств с типом `script`

Queries	Описание	Тип значения	Обязательный	Значение по умолчанию	Комментарий
key	Определяет, по какому полю делается запрос. Формат: `key=<name>` или `key=<_id>`	string	нет	name
driver	Определяет, какой драйвер должен быть у устройств, по которым нужна информация
name	Имена устройств, по которым нужно отобразить информацию	string	нет		Пример: `/api/v1/equipment?name=["display1", "display2"]` (отобразить информацию по устройствам с именами `display1` и `display2`)

Name	Описание	Тип значения	Обязательный
id	Имя устройства или значение ключевого поля, если используется параметр `key`	string	да
name	Имя устройства	string	да
channel	Команда	string	да
value	Значение команды или обратной связи	string	нет
feedback	Имя обратной связи	string	да