Отримайте нові опитування.

GET 
/poll

Отримати нові події опитування

Request

Query Parameters

last integer

Індекс першої події опитування, включеної у список.

Responses

200

application/json

Schema

Schema

oneOf

DeviceChanged

timestampint64

Відмітка часу події

Example: 1600000000

typestringrequired

Тип події

Possible values: [DeviceChanged]

Example: DeviceChanged

device_idintegerrequired

Ідентифікатор пристрою

Example: 1

plugin_uuidstring

UUID плагіна, який створив це пристрій

Example: 12345678-1234-1234-1234-123456789012

note_textstring

Текст примітки

Example: Пристрій знаходиться десь

note_imagestring

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

Example: some_new_image.png

iconstring

Значок пристрою

Example: ch-door

aliveboolean

Пристрій живий

Example: true

hiddenboolean

Пристрій прихований

Example: false

rolestring

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

Example: Control

last_onlineint64

Час останньої активності пристрою (час UNIX)

Example: 1600000000

params

object[]

Змінені параметри

Array [

namestring

Змінено ім'я параметра

old_value

object

anyOf

MOD1

integer

MOD2

string

MOD3

number

MOD4

boolean

new_value

object

anyOf

MOD1

integer

MOD2

string

MOD3

number

MOD4

boolean

]

SystemStateChanged

timestampint64

Відмітка часу події

Example: 1600000000

typestring

Тип події

Possible values: [SystemStateChanged]

Example: SystemStateChanged

new_statusstring

Статус нової системи

Possible values: [SystemReady, SystemStarting, SystemFailure, SystemCatastrophicFailure, UpdateInProgress, DeviceInclusionWaiting, DeviceInclusionTimeout, DeviceInclusionFailed, DeviceInclusionDeviceFound, DeviceInclusionProtocolInterview, DeviceInclusionInterviewing, DeviceInclusionFinished, DeviceInclusionBatteryDevicePending, DeviceExclusionWaiting, DeviceExclusionTimeout, DeviceExclusionFailed, DeviceExclusionDeviceFound, DeviceExclusionFinished, NeighborRediscoveryStarted, NeighborRediscoveryFinished, DeviceReplacementCheckingNodeStatus, DeviceReplacementWaiting, DeviceReplacementTimeout, DeviceReplacementFailed, DeviceReplacementDeviceFound, DeviceReplacementRequestingDeviceIdentification, DeviceReplacementRestoringAssociations, DeviceReplacementFinished, DeviceReplacementFinishedWrongDevice, DeviceReplacementCancelled, DeviceReplacementBatteryDevicePending]

Example: SystemReady

DeviceListChanged

timestampint64

Відмітка часу події

Example: 1600000000

typestring

Тип події

Possible values: [DeviceListChanged]

Example: DeviceListChanged

removedinteger[]

Список видалених ідентифікаторів пристроїв

Example: [3,4,5]

added

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

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

]

ActionStatusReport

timestampint64

Відмітка часу події

Example: 1600000000

typestringrequired

Тип події

Possible values: [ActionStatusReport]

Example: ActionStatusReport

action_idintegerrequired

Ідентифікатор виклику дії

Example: 1

statusstringrequired

Статус виконання дії

Possible values: [NotStarted, Started, InProgress, FinishedError, FinishedTimeout, FinishedOk]

Example: FinishedOk

payload

object

Дані про прогрес

property name*any

Дані про прогрес

Example: {}

DeviceOrderChange

timestampint64

Відмітка часу події

Example: 1600000000

typestring

Тип події

Possible values: [DeviceOrderChange]

Example: DeviceOrderChange

device_idinteger

Ідентифікатор пристрою

Example: 3

room_idinteger

Новий ідентифікатор кімнати

Example: 1

orderinteger

Замовлення пристрою в кімнаті

Example: 7

RoomOrderChange

timestampint64

Відмітка часу події

Example: 1600000000

typestring

Тип події

Possible values: [RoomOrderChange]

Example: RoomOrderChange

room_idinteger

Ідентифікатор кімнати

Example: 3

section_idinteger

Ідентифікатор розділу батьків мережі

Example: 1

orderinteger

Порядок кімнати в розділі

Example: 2

SectionOrderChange

timestampint64

Відмітка часу події

Example: 1600000000

typestring

Тип події

Possible values: [SectionOrderChange]

Example: SectionOrderChange

section_idinteger

Розділ ID

Example: 2

orderinteger

Новий порядок розділів

Example: 2

MeshUpdateProgress

timestampint64

Відмітка часу події

Example: 1600000000

typestring

Тип події

Possible values: [MeshUpdateProgress]

Example: MeshUpdateProgress

stagestring

Етап оновлення сітки

Possible values: [FindingControllerNeighbours, FindingDevicesNeighbours, FindingDistantDevicesNeighbours, FixingRoutingData]

total_devicesinteger

Поточна загальна кількість пристроїв, які будуть протестовані

Example: 10

tested_devicesinteger

Наразі тестовані пристрої.

Example: 5

progressinteger

Прогрес у відсотках

Example: 50

current_device_idinteger

Наразі розглядається ідентифікатор пристрою

Example: 3

current_device_namestring

В даний момент ведеться співбесіда для визначення імені пристрою

Example: Some Device Name

FavoritesUpdate

timestampint64

Відмітка часу події

Example: 1600000000

typestring

Тип події

Possible values: [FavoritesUpdate]

Example: FavoritesUpdate

useridinteger

Ідентифікатор користувача

Example: 1

usernamestring

Ім'я користувача

Example: user1

changes

object

Список улюблених змінено для користувача.

devicesinteger[]

Улюблені пристрої

Example: [1,2,3]

roomsinteger[]

Улюблені кімнати

Example: [1,2,3]

sectionsinteger[]

Улюблені розділи

Example: [1,2,3]

scenesinteger[]

Улюблені сцени

Example: [1,2,3]

PluginLoaded

timestampint64

Відмітка часу події

Example: 1600000000

typestring

Тип події

Possible values: [PluginLoaded]

Example: PluginLoaded

plugin_uuidstring

Плагін UUID

Example: 12345678-1234-1234-1234-123456789012

PluginMessage

timestampint64

Відмітка часу події

Example: 1600000000

typestring

Тип події

Possible values: [PluginMessage]

Example: PluginMessage

plugin_uuidstring

Плагін UUID

Example: 12345678-1234-1234-1234-123456789012

namestring

Назва плагіна

Example: Plugin Name

messagestring

Повідомлення

Example: Some message from the plugin

PluginLogMessage

timestampint64

Відмітка часу події

Example: 1600000000

typestring

Тип події

Possible values: [PluginLogMessage]

Example: PluginLogMessage

plugin_uuidstring

Плагін UUID

Example: 12345678-1234-1234-1234-123456789012

data

object

Запис журналу

date_timestring

Дата та час повідомлення журналу

Example: 2024-01-03 12:33:44

messagestring

Запис повідомлення

Example: 1234abcd

prioritystring

Пріоритет запису журналу

Possible values: [1, 2, 3, 4, 5, 6]

Example: 6

timestampstring

Часова відмітка повідомлення журналу

Example: 1704278024123456

PluginUnloaded

timestampint64

Відмітка часу події

Example: 1600000000

typestring

Тип події

Possible values: [PluginUnloaded]

Example: PluginUnloaded

plugin_uuidstring

Плагін UUID

Example: 12345678-1234-1234-1234-123456789012

ScheduleChanged

timestampint64

Відмітка часу події

Example: 1600000000

typestring

Тип події

Possible values: [ScheduleChanged]

Example: ScheduleChanged

schedule_idinteger

Ідентифікатор розкладу

Example: 1

schedule

object

activeboolean

Is schedule active

type

string

required

Possible values: [thermostat, actionCall, sceneInvoke]

Schedule type

thermostat

schedule_periods

object[]

Array of schedule periods

Array [

daystring

День

Possible values: [monday, tuesday, wednesday, thursday, friday, saturday, sunday]

timepoints

object[]

.schedules.period.thermostat.timepoints.description

Array [

timestring

.schedules.period.timepoints.time.description

Example: 12:00

setpointnumber

.schedules.period.thermostat.timepoints.setpoint.description

Example: 20.5

modestring

.schedules.period.thermostat.timepoints.mode.description

Possible values: [Off, Heat, Cool, Auto]

Example: Heat

]

]

actionCall

action_namestring

name of action to call

schedule_periods

object[]

Array of schedule periods

Array [

daystring

День

Possible values: [monday, tuesday, wednesday, thursday, friday, saturday, sunday]

timepoints

object[]

Array [

timestring

.schedules.period.timepoints.time.description

Example: 12:00

arguments

.schedules.period.timepoints.action_call.arguments.description

]

]

sceneInvoke

scene_idinteger

id of scene to call

schedule_periods

object[]

Array of schedule periods

Array [

daystring

День

Possible values: [monday, tuesday, wednesday, thursday, friday, saturday, sunday]

timepoints

object[]

Array [

timestring

.schedules.period.timepoints.time.description

Example: 12:00

]

]

target_typestring

Possible values: [device, room]

target_idsinteger[]

IDs of targets

period_typestring

Schedule repeat period

Possible values: [yearly, monthly, weekly, daily, hourly, interval]

idinteger

Schedule ID

ScheduleListChanged

timestampint64

Відмітка часу події

Example: 1600000000

typestring

Тип події

Possible values: [ScheduleListChanged]

Example: ScheduleListChanged

removedinteger[]

Список видалених ідентифікаторів розкладів

Example: [3,4,5]

added

object[]

Список недавно створених розкладів

Array [

activeboolean

Is schedule active

type

string

required

Possible values: [thermostat, actionCall, sceneInvoke]

Schedule type

thermostat

schedule_periods

object[]

Array of schedule periods

Array [

daystring

День

Possible values: [monday, tuesday, wednesday, thursday, friday, saturday, sunday]

timepoints

object[]

.schedules.period.thermostat.timepoints.description

Array [

timestring

.schedules.period.timepoints.time.description

Example: 12:00

setpointnumber

.schedules.period.thermostat.timepoints.setpoint.description

Example: 20.5

modestring

.schedules.period.thermostat.timepoints.mode.description

Possible values: [Off, Heat, Cool, Auto]

Example: Heat

]

]

actionCall

action_namestring

name of action to call

schedule_periods

object[]

Array of schedule periods

Array [

daystring

День

Possible values: [monday, tuesday, wednesday, thursday, friday, saturday, sunday]

timepoints

object[]

Array [

timestring

.schedules.period.timepoints.time.description

Example: 12:00

arguments

.schedules.period.timepoints.action_call.arguments.description

]

]

sceneInvoke

scene_idinteger

id of scene to call

schedule_periods

object[]

Array of schedule periods

Array [

daystring

День

Possible values: [monday, tuesday, wednesday, thursday, friday, saturday, sunday]

timepoints

object[]

Array [

timestring

.schedules.period.timepoints.time.description

Example: 12:00

]

]

target_typestring

Possible values: [device, room]

target_idsinteger[]

IDs of targets

period_typestring

Schedule repeat period

Possible values: [yearly, monthly, weekly, daily, hourly, interval]

idinteger

Schedule ID

]

UpgradeStatusChanged

timestampint64

Відмітка часу події

Example: 1600000000

typestring

Тип події

Possible values: [UpgradeStatusChanged]

Example: UpgradeStatusChanged

statusstring

Статус оновлення

Possible values: [None, Idle, InProgress, Available]

Example: Idle

BackupStarted

timestampint64

Відмітка часу події

Example: 1600000000

typestring

Тип події

Possible values: [BackupStarted]

Example: BackupStarted

BackupWaitingForData

timestampint64

Відмітка часу події

Example: 1600000000

typestring

Тип події

Possible values: [BackupWaitingForData]

Example: BackupWaitingForData

BackupStoppingServices

timestampint64

Відмітка часу події

Example: 1600000000

typestring

Тип події

Possible values: [BackupStoppingServices]

Example: BackupStoppingServices

BackupPacking

timestampint64

Відмітка часу події

Example: 1600000000

typestring

Тип події

Possible values: [BackupPacking]

Example: BackupPacking

progressinteger

Процес упаковки

Example: 50

BackupStartingServices

timestampint64

Відмітка часу події

Example: 1600000000

typestring

Тип події

Possible values: [BackupStartingServices]

Example: BackupStartingServices

BackupFinished

timestampint64

Відмітка часу події

Example: 1600000000

typestring

Тип події

Possible values: [BackupFinished]

Example: BackupFinished

RestoreStarted

timestampint64

Відмітка часу події

Example: 1600000000

typestring

Тип події

Possible values: [RestoreStarted]

Example: RestoreStarted

RestoreWaitingForData

timestampint64

Відмітка часу події

Example: 1600000000

typestring

Тип події

Possible values: [RestoreWaitingForData]

Example: RestoreWaitingForData

RestoreStoppingServices

timestampint64

Відмітка часу події

Example: 1600000000

typestring

Тип події

Possible values: [RestoreStoppingServices]

Example: RestoreStoppingServices

RestoreUnpacking

timestampint64

Відмітка часу події

Example: 1600000000

typestring

Тип події

Possible values: [RestoreUnpacking]

Example: RestoreUnpacking

progressinteger

Процес упаковки

Example: 50

RestoreStartingServices

timestampint64

Відмітка часу події

Example: 1600000000

typestring

Тип події

Possible values: [RestoreStartingServices]

Example: RestoreStartingServices

RestoreFinished

timestampint64

Відмітка часу події

Example: 1600000000

typestring

Тип події

Possible values: [RestoreFinished]

Example: RestoreFinished

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"
}