ABCDEFG
1
Product TypeActionType
Action inbound Parameter
NotesExampleExample Parameter
2
3
Site basedCHECK_DEVICES (GET)get/api/v3/sites/{siteCd}/actions/getChanges
4
RUN_MACROpost/api/v3/sites/{siteCd}/rules/{ruleCd}/actions/run
5
DISCOVER (GET)getdiscover devices in a site/api/v3/sites/{siteCd}/actions/discover
6
7
8
All Devices
9
GET_STATUSgetdevice status changes/api/v3/sites/{siteCd}/actions/deviceStatus
10
UPDATEpostupdate gateway with latest device info/api/v3/sites/{siteCd}/actions/update
11
12
13
ThermostatGET_STATUSpost
14
HVAC_MODE_AUTONot all modes always supported
15
HVAC_MODE_COOLNot all modes always supported
16
HVAC_MODE_HEATNot all modes always supported
17
HVAC_MODE_OFFNot all modes always supported
18
APP_ADR_NONENot all modes always supported
19
APP_ADR_ACTIVENot all modes always supported
20
APP_ADR_FARNot all modes always supported
21
APP_ADR_NEARNot all modes always supported
22
HVAC_HOLD_ONNot all modes always supported
23
HVAC_HOLD_OFFNot all modes always supported
24
HVAC_DISPLAY_LOCK_ONNot all modes always supported
25
HVAC_DISPLAY_LOCK_OFFNot all modes always supported
26
HVAC_FAN_MODE_ON_LOWNot all modes always supported
27
HVAC_FAN_MODE_AUTO_LOWNot all modes always supported
28
HVAC_FAN_MODE_AUTO
29
HVAC_FAN_MODE_ON
30
HVAC_FAN_MODE_OCC_ON_UNOCC_AUTO
Not all modes always supported
31
HVAC_HEAT_SETPOINT
{parameters: number}
num between 40-96temp is in C (Heat setpoint must be lower than Cool setpoint)
/api/v3/sites/{siteCd}/devices/{deviceCd}/actions/HVAC_HEAT_SETPOINT
{"parameter":"75"}
32
HVAC_COOL_SETPOINT
{parameters: number}
num between 40-96temp is in C
33
HVAC_HEAT_SETPOINT_RELATIVE
{parameters: number}
num between 40-96temp is in C - moves the Heat setpoint relative to what it current is set to
34
HVAC_COOL_SETPOINT_RELATIVE
{parameters: number}
num between 40-96temp is in C - moves the Cool setpoint relative to what it current is set to
35
36
37
DimmerGET_STATUSpost
38
DIM
{parameters: number}
num between 0-100high/low should be dim 66/33
39
DIM_RELATIVE
{parameters: number}
pos/neg numberresulting dim between 0-100
40
POWER_ONSets dim to 0/api/v3/sites/{siteCd}/devices/{deviceCd}/actions/DIM{"parameter":"75"}
41
POWER_OFFSets dim to 100
42
43
44
LightGET_STATUSpost
45
POWER_ONSets dim to 0
46
POWER_OFFSets dim to 100
47
48
49
SensorGET_STATUSpost
50
SET_RECOVERYSensor, Alta specific recovery backoff period when attempting to join a network
51
SET_REPORT_INTERVALSeconds between sensor reports
52
SET_RETRY_COUNTSensor-specific count for transmission retries
53
54
55
Switch (non-lock)
GET_STATUSpost
56
POWER_ON
57
POWER_OFF
58
POWER_TOGGLE
59
60
61
Switch (toggled)GET_STATUSpost
62
POWER_ON
63
POWER_OFF
64
POWER_TOGGLE
65
DIM
{parameters: number}
num between 0-100high/low should be dim 66/33
66
DIM_RELATIVE
{parameters: number}
pos/neg numberresulting dim between 0-100
67
SCENE_SELECT
{parameters: number}
num from range 1-3
68
69
70
Switch (is lock)GET_STATUSpost
71
OPENED
72
CLOSED
73
POWER_TOGGLEsometimes
74
75
76
CameraGET_STATUSpost
77
MOVE_UP
78
MOVE_DOWN
79
MOVE_LEFT
80
MOVE_RIGHT
81
STREAM_LIVE_VIDEOReturns video URL, not always supported
82
STREAM_LIVE_IMAGEReturns image URL, not always supported
83
84
85
BACnetGET_STATUSpost
86
DISCOVERY_CONTINUOUSContinuous BACnet discovery
87
DISCOVERY_NOWBACnet discover now
88
89
90
Network
91
GET_NETWORK_TREEGet the neighbor network tree for Z-Wave or ZigBee
92
HEAL_NETWORKHeal the network connections between devices for Z-Wave and ZigBee
93
NETWORK_LINKNetwork inclusion and exclusion.
94
NETWORK_LINK_DEVICENetwork inclusion and exclusion. Exclusion is on a specific device.
95
SET_LINK_INTERVALSeconds between attempts to register with a network
96
SET_RECOVERYSensor, Alta specific recovery backoff period when attempting to join a network