Отримати список пристроїв

GET 
/devices

.devices.get.description

Request

Query Parameters

show_hidden boolean

Включити приховані параметри

compact boolean

Якщо параметр compact встановлено на false, відповідь буде містити додаткову інформацію про параметри конфігурації та асоціації з шаблону пристрою.

with_actions boolean

Уключіть дії пристрою у відповідь

fields booleanrequired

Обмежте параметри, що повертаються у відповіді. all - поверне всі невидимі параметри, тоді як default - поверне лише параметри, потрібні для мобільного інтерфейсу.

Responses

200

Список пристроїв

application/json

Schema

Schema

successbooleanrequired

Прапорець, який показує, чи був запит успішним

devices

object[]

Перелік пристроїв

Array [

idinteger

Внутрішній ідентифікатор пристрою

typestring

Тип пристрою, див. Типи пристроїв

Possible values: [DevGateway, DevSwitch, DevDimmer, DevDimmerColor, DevShutter, DevBinarySensor, DevGenericSensor, DevThermostat, DevDoorLock, DevMeter, DevUnknown]

interfacesstring[]

Список інтерфейсів, реалізованих пристроєм

Example: ["ZWaveDevice","SwitchBinary"]

aliveboolean

Чи пристрій працює?

has_templateboolean

Пристрій має шаблон

params

object

Карта параметрів пристроїв

description

last_onlineint64

Відмітка часу останнього повідомлення від пристрою

Example: 1600000000

plugin_uuidstringnullable

Якщо пристрій створено за допомогою плагіна, це поле містить UUID плагіна

Example: 12345678-1234-1234-1234-123456789012

namestring

Назва пристрою

Example: Some Switch

room_idinteger

Ідентифікатор кімнати, де знаходиться пристрій.

rolestring

Роль пристрою

Possible values: [Control, Lighting, Shutters, ClimateThermostat, ClimateThermostatHeating, ClimateThermostatCooling, ClimateWarmFloor, ClimateFanSpeed1, ClimateFanSpeed2, ClimateFanSpeed3, MultilevelSensor, BinaryMotionSensor, BinaryGenericSensor, BinarySmokeSensor, BinaryDoorSensor, BinaryWindowSensor, BinaryLeakingSensor, Doorlock, DoorlockNO, NotAvailable]

Example: Control

iconstring

Ім'я значка, для списку значків дивіться Список значків

hiddenboolean

Пристрої приховані від інтерфейсу користувача.

orderinteger

Порядок розташування пристроїв у кімнаті

note_textstring

Примітка тексту

Example: Цей пристрій розташований у ​​електричній коробці десь.

note_imagestring

Примітка до назви файлу зображення

Example: someimage.png

favoriteboolean

Пристрій у списку обраних користувачем

]

Example (from schema)

{
  "success": true,
  "devices": [
    {
      "id": 0,
      "type": "DevGateway",
      "interfaces": [
        "ZWaveDevice",
        "SwitchBinary"
      ],
      "alive": true,
      "has_template": true,
      "params": {
        "nodeId": 12,
        "Status": true,
        "pulsable": false
      },
      "last_online": 1600000000,
      "plugin_uuid": "12345678-1234-1234-1234-123456789012",
      "name": "Some Switch",
      "room_id": 0,
      "role": "Control",
      "icon": "string",
      "hidden": true,
      "order": 0,
      "note_text": "Цей пристрій розташований у ​​електричній коробці десь.",
      "note_image": "someimage.png",
      "favorite": true
    }
  ]
}

401

Користувач не має дозволу.

application/json

Schema

Schema

successbooleanrequired

Прапорець, який показує, чи був запит успішним

errorCodeintegerrequired

Ціле число помилки, див. Помилки

errorMessagestringrequired

Опис помилки

errorParameters

Додаткові дані, що описують помилку

Example (from schema)

{
  "success": true,
  "errorCode": 0,
  "errorMessage": "string"
}

Example

{
  "success": false,
  "errorCode": 4131,
  "errorMessage": "User not authorized",
  "errorParameters": "Not authorized"
}