diff --git a/docs/api/index.html b/docs/api/index.html
index 927291ff..e6b45699 100644
--- a/docs/api/index.html
+++ b/docs/api/index.html
@@ -114,7 +114,7 @@
Create an action group
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -238,40 +238,6 @@
Generated events on method call
-
- GatewaySynchronizationStartedEvent
-
- | Description |
- A data synchronization sequence between the gateway and the server has started |
-
-
-
- | JSON |
- {
- "timestamp" : 2,
- "owningPartner" : "an owning partner",
- "gatewayId" : "A gateway id (ex: 0101-1234-5678)",
- "name" : "GatewaySynchronizationStartedEvent"
-} |
-
-
- | Field name |
- Field description |
-
-
-
- | gatewayId |
- Gateway id |
-
-
-
- | owningPartner |
- Owning partner of the parent entity (gateway, setup group, ...)) . only available in event streams |
-
-
-
-
-
ActionGroupCreatedEvent
@@ -282,9 +248,10 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"actionGroupOID" : "an action group OID",
"actionGroupLabel" : "an action group label",
"metadata" : "some metadata",
@@ -300,7 +267,7 @@ Generated events on method call
} ]
} ]
} ],
- "name" : "ActionGroupCreatedEvent"
+ "type" : "ActionGroupCreatedEvent"
} |
@@ -328,6 +295,57 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
+
+
+
+
+ GatewaySynchronizationStartedEvent
+
+ | Description |
+ A data synchronization sequence between the gateway and the server has started |
+
+
+
+ | JSON |
+ {
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
+ "setupOID" : "a setup OID",
+ "owningPartner" : "an owning partner",
+ "gatewayId" : "A gateway id (ex: 0101-1234-5678)",
+ "type" : "GatewaySynchronizationStartedEvent"
+} |
+
+
+ | Field name |
+ Field description |
+
+
+
+ | gatewayId |
+ Gateway id |
+
+
+
+ | owningPartner |
+ Owning partner of the parent entity (gateway, setup group, ...)) . only available in event streams |
+
+
+
+ | setupOID |
+ Setup OID |
+
+
+
+ | siteOID |
+ Site OID |
+
+
@@ -341,10 +359,12 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
+ "setupOID" : "a setup OID",
"owningPartner" : "an owning partner",
"gatewayId" : "A gateway id (ex: 0101-1234-5678)",
- "name" : "GatewaySynchronizationEndedEvent"
+ "type" : "GatewaySynchronizationEndedEvent"
} |
@@ -362,6 +382,16 @@ Generated events on method call
Owning partner of the parent entity (gateway, setup group, ...)) . only available in event streams |
+
+ | setupOID |
+ Setup OID |
+
+
+
+ | siteOID |
+ Site OID |
+
+
@@ -427,7 +457,7 @@ Generated events on method call
Update an action group
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -539,19 +569,35 @@ Generated events on method call
Generated events on method call
- GatewaySynchronizationStartedEvent
+ ActionGroupUpdatedEvent
| Description |
- A data synchronization sequence between the gateway and the server has started |
+ An action group has been updated |
| JSON |
{
- "timestamp" : 2,
- "owningPartner" : "an owning partner",
- "gatewayId" : "A gateway id (ex: 0101-1234-5678)",
- "name" : "GatewaySynchronizationStartedEvent"
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
+ "setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
+ "actionGroupOID" : "an action group OID",
+ "actionGroupLabel" : "an action group label",
+ "metadata" : "some metadata",
+ "notificationCondition" : "a notification condition",
+ "actions" : [ {
+ "deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
+ "commands" : [ {
+ "name" : "an execution command entry name",
+ "delay" : 1,
+ "parameters" : [ {
+ "type" : 1,
+ "value" : "an execution command parameter entry value"
+ } ]
+ } ]
+ } ],
+ "type" : "ActionGroupUpdatedEvent"
} |
@@ -560,32 +606,49 @@ Generated events on method call
- | gatewayId |
- Gateway id |
+ actionGroupLabel |
+ Action group label |
- | owningPartner |
- Owning partner of the parent entity (gateway, setup group, ...)) . only available in event streams |
+ actionGroupOID |
+ Action group OID |
+
+
+
+ | owningPartners |
+ Owning partners of the parent entity (setup, ...)) . only available in event streams |
+
+
+
+ | setupOID |
+ Setup OID |
+
+
+
+ | siteOID |
+ Site OID |
- GatewaySynchronizationEndedEvent
+ GatewaySynchronizationStartedEvent
| Description |
- A data synchronization sequence between the gateway and the server has completed |
+ A data synchronization sequence between the gateway and the server has started |
| JSON |
{
- "timestamp" : 2,
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
+ "setupOID" : "a setup OID",
"owningPartner" : "an owning partner",
"gatewayId" : "A gateway id (ex: 0101-1234-5678)",
- "name" : "GatewaySynchronizationEndedEvent"
+ "type" : "GatewaySynchronizationStartedEvent"
} |
@@ -603,38 +666,35 @@ Generated events on method call
Owning partner of the parent entity (gateway, setup group, ...)) . only available in event streams |
+
+ | setupOID |
+ Setup OID |
+
+
+
+ | siteOID |
+ Site OID |
+
+
- ActionGroupUpdatedEvent
+ GatewaySynchronizationEndedEvent
| Description |
- An action group has been updated |
+ A data synchronization sequence between the gateway and the server has completed |
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
- "actionGroupOID" : "an action group OID",
- "actionGroupLabel" : "an action group label",
- "metadata" : "some metadata",
- "notificationCondition" : "a notification condition",
- "actions" : [ {
- "deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
- "commands" : [ {
- "name" : "an execution command entry name",
- "delay" : 1,
- "parameters" : [ {
- "type" : 1,
- "value" : "an execution command parameter entry value"
- } ]
- } ]
- } ],
- "name" : "ActionGroupUpdatedEvent"
+ "owningPartner" : "an owning partner",
+ "gatewayId" : "A gateway id (ex: 0101-1234-5678)",
+ "type" : "GatewaySynchronizationEndedEvent"
} |
@@ -643,23 +703,23 @@ Generated events on method call
- | actionGroupLabel |
- Action group label |
+ gatewayId |
+ Gateway id |
- | actionGroupOID |
- Action group OID |
+ owningPartner |
+ Owning partner of the parent entity (gateway, setup group, ...)) . only available in event streams |
- | owningPartners |
- Owning partners of the parent entity (setup, ...)) . only available in event streams |
+ setupOID |
+ Setup OID |
- | setupOID |
- Setup OID |
+ siteOID |
+ Site OID |
@@ -727,7 +787,7 @@ Generated events on method call
Retrieve a user-defined action group by OID
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -783,8 +843,8 @@ Generated events on method call
(JSON)
{
- "creationTime" : 1769503155441,
- "lastUpdateTime" : 1769503155442,
+ "creationTime" : 1785140822217,
+ "lastUpdateTime" : 1785140822217,
"label" : "a managed action group label",
"metadata" : "some metadata",
"shortcut" : true,
@@ -911,7 +971,7 @@ Generated events on method call
Delete an action group by OID
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
|
@@ -993,10 +1053,12 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
+ "setupOID" : "a setup OID",
"owningPartner" : "an owning partner",
"gatewayId" : "A gateway id (ex: 0101-1234-5678)",
- "name" : "GatewaySynchronizationEndedEvent"
+ "type" : "GatewaySynchronizationEndedEvent"
} |
@@ -1014,23 +1076,35 @@ Generated events on method call
Owning partner of the parent entity (gateway, setup group, ...)) . only available in event streams |
+
+ | setupOID |
+ Setup OID |
+
+
+
+ | siteOID |
+ Site OID |
+
+
- GatewaySynchronizationStartedEvent
+ ActionGroupDeletedEvent
| Description |
- A data synchronization sequence between the gateway and the server has started |
+ An action group has been deleted |
| JSON |
{
- "timestamp" : 2,
- "owningPartner" : "an owning partner",
- "gatewayId" : "A gateway id (ex: 0101-1234-5678)",
- "name" : "GatewaySynchronizationStartedEvent"
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
+ "setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
+ "actionGroupOID" : "an action group OID",
+ "type" : "ActionGroupDeletedEvent"
} |
@@ -1039,33 +1113,44 @@ Generated events on method call
- | gatewayId |
- Gateway id |
+ actionGroupOID |
+ Action group OID |
- | owningPartner |
- Owning partner of the parent entity (gateway, setup group, ...)) . only available in event streams |
+ owningPartners |
+ Owning partners of the parent entity (setup, ...)) . only available in event streams |
+
+
+
+ | setupOID |
+ Setup OID |
+
+
+
+ | siteOID |
+ Site OID |
- ActionGroupDeletedEvent
+ GatewaySynchronizationStartedEvent
| Description |
- An action group has been deleted |
+ A data synchronization sequence between the gateway and the server has started |
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
- "actionGroupOID" : "an action group OID",
- "name" : "ActionGroupDeletedEvent"
+ "owningPartner" : "an owning partner",
+ "gatewayId" : "A gateway id (ex: 0101-1234-5678)",
+ "type" : "GatewaySynchronizationStartedEvent"
} |
@@ -1074,13 +1159,13 @@ Generated events on method call
- | actionGroupOID |
- Action group OID |
+ gatewayId |
+ Gateway id |
- | owningPartners |
- Owning partners of the parent entity (setup, ...)) . only available in event streams |
+ owningPartner |
+ Owning partner of the parent entity (gateway, setup group, ...)) . only available in event streams |
@@ -1088,6 +1173,11 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
@@ -1153,7 +1243,7 @@ Generated events on method call
Retrieve all user-defined actions groups
Per-session rate-limit : 1 calls per 1d period for this particular operation (bulk-load)
- Access scope : Enduser Open API (enduser/o)
+ Access scope : enduser/o
> Test operation
@@ -1182,8 +1272,8 @@ Generated events on method call
(JSON)
[ {
- "creationTime" : 1769503155441,
- "lastUpdateTime" : 1769503155441,
+ "creationTime" : 1785140822217,
+ "lastUpdateTime" : 1785140822217,
"label" : "a managed action group label",
"metadata" : "some metadata",
"shortcut" : true,
@@ -1339,7 +1429,7 @@
Launch a persistent action group by OID
Per-session rate-limit : 1 calls per 28min 48s period for all operations of the same category (exec)
- Access scope : Enduser Open API (enduser/o)
+ Access scope : enduser/o
> Test operation
|
@@ -1441,25 +1531,21 @@
Generated events on method call
- DeviceStateChangedEvent
+ GatewaySynchronizationStartedEvent
| Description |
- One or more states of a device have changed (high-level) |
+ A data synchronization sequence between the gateway and the server has started |
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
- "deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
- "deviceStates" : [ {
- "name" : "a device state change item name",
- "type" : 1,
- "value" : "a device state change item value"
- } ],
- "name" : "DeviceStateChangedEvent"
+ "owningPartner" : "an owning partner",
+ "gatewayId" : "A gateway id (ex: 0101-1234-5678)",
+ "type" : "GatewaySynchronizationStartedEvent"
} |
@@ -1468,42 +1554,44 @@ Generated events on method call
- | deviceStates |
- Updated device states |
+ gatewayId |
+ Gateway id |
- | deviceURL |
- Device URL |
+ owningPartner |
+ Owning partner of the parent entity (gateway, setup group, ...)) . only available in event streams |
- | owningPartners |
- Owning partners of the parent entity (setup, ...)) . only available in event streams |
+ setupOID |
+ Setup OID |
- | setupOID |
- Setup OID |
+ siteOID |
+ Site OID |
- GatewaySynchronizationStartedEvent
+ GatewaySynchronizationEndedEvent
| Description |
- A data synchronization sequence between the gateway and the server has started |
+ A data synchronization sequence between the gateway and the server has completed |
| JSON |
{
- "timestamp" : 2,
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
+ "setupOID" : "a setup OID",
"owningPartner" : "an owning partner",
"gatewayId" : "A gateway id (ex: 0101-1234-5678)",
- "name" : "GatewaySynchronizationStartedEvent"
+ "type" : "GatewaySynchronizationEndedEvent"
} |
@@ -1521,6 +1609,16 @@ Generated events on method call
Owning partner of the parent entity (gateway, setup group, ...)) . only available in event streams |
+
+ | setupOID |
+ Setup OID |
+
+
+
+ | siteOID |
+ Site OID |
+
+
@@ -1534,27 +1632,33 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"execId" : "an exec id",
"newState" : "IN_PROGRESS",
"ownerKey" : "an owner key",
- "type" : 1,
+ "executionType" : 1,
"subType" : 1,
"oldState" : "TRANSMITTED",
"timeToNextState" : 2,
"failedCommands" : [ {
"deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
"detailedStatus" : {
+ "type" : "generic-error",
"message" : "a message",
"error" : true
},
"rank" : 1,
"failureType" : "NON_EXECUTING"
} ],
+ "relatedDevices" : [ {
+ "deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])"
+ } ],
+ "technical" : false,
"failureTypeCode" : 11,
- "name" : "ExecutionStateChangedEvent",
+ "type" : "ExecutionStateChangedEvent",
"failureType" : "NON_EXECUTING"
} |
@@ -1568,6 +1672,11 @@ Generated events on method call
Execution id |
+
+ | executionType |
+ Execution type |
+
+
| failedCommands |
List of failed commands |
@@ -1598,11 +1707,21 @@ Generated events on method call
Owning partners of the parent entity (setup, ...)) . only available in event streams |
+
+ | relatedDevices |
+ List of devices involved in this execution |
+
+
| setupOID |
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
| subType |
Execution sub type |
@@ -1613,28 +1732,30 @@ Generated events on method call
Remaining time until next execution state |
-
- | type |
- Execution type |
-
-
- GatewaySynchronizationEndedEvent
+ DeviceStateChangedEvent
| Description |
- A data synchronization sequence between the gateway and the server has completed |
+ One or more states of a device have changed (high-level) |
| JSON |
{
- "timestamp" : 2,
- "owningPartner" : "an owning partner",
- "gatewayId" : "A gateway id (ex: 0101-1234-5678)",
- "name" : "GatewaySynchronizationEndedEvent"
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
+ "setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
+ "deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
+ "deviceStates" : [ {
+ "name" : "a device state change item name",
+ "type" : 1,
+ "value" : "a device state change item value"
+ } ],
+ "type" : "DeviceStateChangedEvent"
} |
@@ -1643,13 +1764,28 @@ Generated events on method call
- | gatewayId |
- Gateway id |
+ deviceStates |
+ Updated device states |
- | owningPartner |
- Owning partner of the parent entity (gateway, setup group, ...)) . only available in event streams |
+ deviceURL |
+ Device URL |
+
+
+
+ | owningPartners |
+ Owning partners of the parent entity (setup, ...)) . only available in event streams |
+
+
+
+ | setupOID |
+ Setup OID |
+
+
+
+ | siteOID |
+ Site OID |
@@ -1717,7 +1853,7 @@ Generated events on method call
Launch a persistent action group by OID in geolocated mode
The action group execution will be flagged as geolocated.
Per-session rate-limit : 1 calls per 28min 48s period for all operations of the same category (exec)
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -1828,10 +1964,12 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
+ "setupOID" : "a setup OID",
"owningPartner" : "an owning partner",
"gatewayId" : "A gateway id (ex: 0101-1234-5678)",
- "name" : "GatewaySynchronizationStartedEvent"
+ "type" : "GatewaySynchronizationStartedEvent"
} |
@@ -1849,6 +1987,16 @@ Generated events on method call
Owning partner of the parent entity (gateway, setup group, ...)) . only available in event streams |
+
+ | setupOID |
+ Setup OID |
+
+
+
+ | siteOID |
+ Site OID |
+
+
@@ -1862,10 +2010,12 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
+ "setupOID" : "a setup OID",
"owningPartner" : "an owning partner",
"gatewayId" : "A gateway id (ex: 0101-1234-5678)",
- "name" : "GatewaySynchronizationEndedEvent"
+ "type" : "GatewaySynchronizationEndedEvent"
} |
@@ -1883,6 +2033,72 @@ Generated events on method call
Owning partner of the parent entity (gateway, setup group, ...)) . only available in event streams |
+
+ | setupOID |
+ Setup OID |
+
+
+
+ | siteOID |
+ Site OID |
+
+
+
+
+
+
+ DeviceStateChangedEvent
+
+ | Description |
+ One or more states of a device have changed (high-level) |
+
+
+
+ | JSON |
+ {
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
+ "setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
+ "deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
+ "deviceStates" : [ {
+ "name" : "a device state change item name",
+ "type" : 1,
+ "value" : "a device state change item value"
+ } ],
+ "type" : "DeviceStateChangedEvent"
+} |
+
+
+ | Field name |
+ Field description |
+
+
+
+ | deviceStates |
+ Updated device states |
+
+
+
+ | deviceURL |
+ Device URL |
+
+
+
+ | owningPartners |
+ Owning partners of the parent entity (setup, ...)) . only available in event streams |
+
+
+
+ | setupOID |
+ Setup OID |
+
+
+
+ | siteOID |
+ Site OID |
+
+
@@ -1896,27 +2112,33 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"execId" : "an exec id",
"newState" : "IN_PROGRESS",
"ownerKey" : "an owner key",
- "type" : 1,
+ "executionType" : 1,
"subType" : 1,
"oldState" : "TRANSMITTED",
"timeToNextState" : 2,
"failedCommands" : [ {
"deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
"detailedStatus" : {
+ "type" : "generic-error",
"message" : "a message",
"error" : true
},
"rank" : 1,
"failureType" : "NON_EXECUTING"
} ],
+ "relatedDevices" : [ {
+ "deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])"
+ } ],
+ "technical" : false,
"failureTypeCode" : 11,
- "name" : "ExecutionStateChangedEvent",
+ "type" : "ExecutionStateChangedEvent",
"failureType" : "NON_EXECUTING"
} |
@@ -1930,6 +2152,11 @@ Generated events on method call
Execution id |
+
+ | executionType |
+ Execution type |
+
+
| failedCommands |
List of failed commands |
@@ -1961,73 +2188,28 @@ Generated events on method call
- | setupOID |
- Setup OID |
-
-
-
- | subType |
- Execution sub type |
-
-
-
- | timeToNextState |
- Remaining time until next execution state |
-
-
-
- | type |
- Execution type |
+ relatedDevices |
+ List of devices involved in this execution |
-
-
-
-
- DeviceStateChangedEvent
-
- | Description |
- One or more states of a device have changed (high-level) |
-
-
-
- | JSON |
- {
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
- "setupOID" : "a setup OID",
- "deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
- "deviceStates" : [ {
- "name" : "a device state change item name",
- "type" : 1,
- "value" : "a device state change item value"
- } ],
- "name" : "DeviceStateChangedEvent"
-} |
-
-
- | Field name |
- Field description |
-
-
- | deviceStates |
- Updated device states |
+ setupOID |
+ Setup OID |
- | deviceURL |
- Device URL |
+ siteOID |
+ Site OID |
- | owningPartners |
- Owning partners of the parent entity (setup, ...)) . only available in event streams |
+ subType |
+ Execution sub type |
- | setupOID |
- Setup OID |
+ timeToNextState |
+ Remaining time until next execution state |
@@ -2096,7 +2278,7 @@ Generated events on method call
Launch a persistent action group by OID in internal mode
The action group execution will be flagged as internal and its result will not be stored in the setup execution history.
This is useful for automatic refresh operations that should not appear in the user history.
Per-session rate-limit : 1 calls per 28min 48s period for all operations of the same category (exec)
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -2197,103 +2379,6 @@ Generated events on method call
Generated events on method call
-
- ExecutionStateChangedEvent
-
- | Description |
- An execution state has changed |
-
-
-
- | JSON |
- {
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
- "setupOID" : "a setup OID",
- "execId" : "an exec id",
- "newState" : "IN_PROGRESS",
- "ownerKey" : "an owner key",
- "type" : 1,
- "subType" : 1,
- "oldState" : "TRANSMITTED",
- "timeToNextState" : 2,
- "failedCommands" : [ {
- "deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
- "detailedStatus" : {
- "message" : "a message",
- "error" : true
- },
- "rank" : 1,
- "failureType" : "NON_EXECUTING"
- } ],
- "failureTypeCode" : 11,
- "name" : "ExecutionStateChangedEvent",
- "failureType" : "NON_EXECUTING"
-} |
-
-
- | Field name |
- Field description |
-
-
-
- | execId |
- Execution id |
-
-
-
- | failedCommands |
- List of failed commands |
-
-
-
- | failureType |
- Failure type |
-
-
-
- | newState |
- Execution new state |
-
-
-
- | oldState |
- Execution previous state |
-
-
-
- | ownerKey |
- Execution owner key |
-
-
-
- | owningPartners |
- Owning partners of the parent entity (setup, ...)) . only available in event streams |
-
-
-
- | setupOID |
- Setup OID |
-
-
-
- | subType |
- Execution sub type |
-
-
-
- | timeToNextState |
- Remaining time until next execution state |
-
-
-
- | type |
- Execution type |
-
-
-
-
-
DeviceStateChangedEvent
@@ -2304,16 +2389,17 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
"deviceStates" : [ {
"name" : "a device state change item name",
"type" : 1,
"value" : "a device state change item value"
} ],
- "name" : "DeviceStateChangedEvent"
+ "type" : "DeviceStateChangedEvent"
} |
@@ -2341,6 +2427,11 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
@@ -2354,10 +2445,12 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
+ "setupOID" : "a setup OID",
"owningPartner" : "an owning partner",
"gatewayId" : "A gateway id (ex: 0101-1234-5678)",
- "name" : "GatewaySynchronizationStartedEvent"
+ "type" : "GatewaySynchronizationStartedEvent"
} |
@@ -2375,6 +2468,129 @@ Generated events on method call
Owning partner of the parent entity (gateway, setup group, ...)) . only available in event streams |
+
+ | setupOID |
+ Setup OID |
+
+
+
+ | siteOID |
+ Site OID |
+
+
+
+
+
+
+ ExecutionStateChangedEvent
+
+ | Description |
+ An execution state has changed |
+
+
+
+ | JSON |
+ {
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
+ "setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
+ "execId" : "an exec id",
+ "newState" : "IN_PROGRESS",
+ "ownerKey" : "an owner key",
+ "executionType" : 1,
+ "subType" : 1,
+ "oldState" : "TRANSMITTED",
+ "timeToNextState" : 2,
+ "failedCommands" : [ {
+ "deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
+ "detailedStatus" : {
+ "type" : "generic-error",
+ "message" : "a message",
+ "error" : true
+ },
+ "rank" : 1,
+ "failureType" : "NON_EXECUTING"
+ } ],
+ "relatedDevices" : [ {
+ "deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])"
+ } ],
+ "technical" : false,
+ "failureTypeCode" : 11,
+ "type" : "ExecutionStateChangedEvent",
+ "failureType" : "NON_EXECUTING"
+} |
+
+
+ | Field name |
+ Field description |
+
+
+
+ | execId |
+ Execution id |
+
+
+
+ | executionType |
+ Execution type |
+
+
+
+ | failedCommands |
+ List of failed commands |
+
+
+
+ | failureType |
+ Failure type |
+
+
+
+ | newState |
+ Execution new state |
+
+
+
+ | oldState |
+ Execution previous state |
+
+
+
+ | ownerKey |
+ Execution owner key |
+
+
+
+ | owningPartners |
+ Owning partners of the parent entity (setup, ...)) . only available in event streams |
+
+
+
+ | relatedDevices |
+ List of devices involved in this execution |
+
+
+
+ | setupOID |
+ Setup OID |
+
+
+
+ | siteOID |
+ Site OID |
+
+
+
+ | subType |
+ Execution sub type |
+
+
+
+ | timeToNextState |
+ Remaining time until next execution state |
+
+
@@ -2388,10 +2604,12 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
+ "setupOID" : "a setup OID",
"owningPartner" : "an owning partner",
"gatewayId" : "A gateway id (ex: 0101-1234-5678)",
- "name" : "GatewaySynchronizationEndedEvent"
+ "type" : "GatewaySynchronizationEndedEvent"
} |
@@ -2409,6 +2627,16 @@ Generated events on method call
Owning partner of the parent entity (gateway, setup group, ...)) . only available in event streams |
+
+ | setupOID |
+ Setup OID |
+
+
+
+ | siteOID |
+ Site OID |
+
+
@@ -2474,7 +2702,7 @@ Generated events on method call
Cancel a running setup-level execution
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -2556,27 +2784,33 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"execId" : "an exec id",
"newState" : "IN_PROGRESS",
"ownerKey" : "an owner key",
- "type" : 1,
+ "executionType" : 1,
"subType" : 1,
"oldState" : "TRANSMITTED",
"timeToNextState" : 2,
"failedCommands" : [ {
"deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
"detailedStatus" : {
+ "type" : "generic-error",
"message" : "a message",
"error" : true
},
"rank" : 1,
"failureType" : "NON_EXECUTING"
} ],
+ "relatedDevices" : [ {
+ "deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])"
+ } ],
+ "technical" : false,
"failureTypeCode" : 11,
- "name" : "ExecutionStateChangedEvent",
+ "type" : "ExecutionStateChangedEvent",
"failureType" : "NON_EXECUTING"
} |
@@ -2590,6 +2824,11 @@ Generated events on method call
Execution id |
+
+ | executionType |
+ Execution type |
+
+
| failedCommands |
List of failed commands |
@@ -2620,11 +2859,21 @@ Generated events on method call
Owning partners of the parent entity (setup, ...)) . only available in event streams |
+
+ | relatedDevices |
+ List of devices involved in this execution |
+
+
| setupOID |
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
| subType |
Execution sub type |
@@ -2635,11 +2884,6 @@ Generated events on method call
Remaining time until next execution state |
-
- | type |
- Execution type |
-
-
@@ -2705,7 +2949,7 @@ Generated events on method call
Get an action group execution currently running
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -2764,8 +3008,8 @@ Generated events on method call
"startTime" : 2,
"owner" : "an owner",
"actionGroup" : {
- "creationTime" : 1769503155438,
- "lastUpdateTime" : 1769503155438,
+ "creationTime" : 1785140822212,
+ "lastUpdateTime" : 1785140822213,
"label" : "a managed action group label",
"metadata" : "some metadata",
"shortcut" : true,
@@ -2899,7 +3143,7 @@ Generated events on method call
Cancel a running execution
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -2981,27 +3225,33 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"execId" : "an exec id",
"newState" : "IN_PROGRESS",
"ownerKey" : "an owner key",
- "type" : 1,
+ "executionType" : 1,
"subType" : 1,
"oldState" : "TRANSMITTED",
"timeToNextState" : 2,
"failedCommands" : [ {
"deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
"detailedStatus" : {
+ "type" : "generic-error",
"message" : "a message",
"error" : true
},
"rank" : 1,
"failureType" : "NON_EXECUTING"
} ],
+ "relatedDevices" : [ {
+ "deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])"
+ } ],
+ "technical" : false,
"failureTypeCode" : 11,
- "name" : "ExecutionStateChangedEvent",
+ "type" : "ExecutionStateChangedEvent",
"failureType" : "NON_EXECUTING"
} |
@@ -3015,6 +3265,11 @@ Generated events on method call
Execution id |
+
+ | executionType |
+ Execution type |
+
+
| failedCommands |
List of failed commands |
@@ -3045,11 +3300,21 @@ Generated events on method call
Owning partners of the parent entity (setup, ...)) . only available in event streams |
+
+ | relatedDevices |
+ List of devices involved in this execution |
+
+
| setupOID |
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
| subType |
Execution sub type |
@@ -3060,11 +3325,6 @@ Generated events on method call
Remaining time until next execution state |
-
- | type |
- Execution type |
-
-
@@ -3130,7 +3390,7 @@ Generated events on method call
Get action groups executions currently running
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -3162,8 +3422,8 @@ Generated events on method call
"startTime" : 2,
"owner" : "an owner",
"actionGroup" : {
- "creationTime" : 1769503155437,
- "lastUpdateTime" : 1769503155438,
+ "creationTime" : 1785140822212,
+ "lastUpdateTime" : 1785140822212,
"label" : "a managed action group label",
"metadata" : "some metadata",
"shortcut" : true,
@@ -3297,7 +3557,7 @@ Generated events on method call
Cancel all running executions
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -3352,27 +3612,33 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"execId" : "an exec id",
"newState" : "IN_PROGRESS",
"ownerKey" : "an owner key",
- "type" : 1,
+ "executionType" : 1,
"subType" : 1,
"oldState" : "TRANSMITTED",
"timeToNextState" : 2,
"failedCommands" : [ {
"deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
"detailedStatus" : {
+ "type" : "generic-error",
"message" : "a message",
"error" : true
},
"rank" : 1,
"failureType" : "NON_EXECUTING"
} ],
+ "relatedDevices" : [ {
+ "deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])"
+ } ],
+ "technical" : false,
"failureTypeCode" : 11,
- "name" : "ExecutionStateChangedEvent",
+ "type" : "ExecutionStateChangedEvent",
"failureType" : "NON_EXECUTING"
} |
@@ -3386,6 +3652,11 @@ Generated events on method call
Execution id |
+
+ | executionType |
+ Execution type |
+
+
| failedCommands |
List of failed commands |
@@ -3416,11 +3687,21 @@ Generated events on method call
Owning partners of the parent entity (setup, ...)) . only available in event streams |
+
+ | relatedDevices |
+ List of devices involved in this execution |
+
+
| setupOID |
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
| subType |
Execution sub type |
@@ -3431,11 +3712,6 @@ Generated events on method call
Remaining time until next execution state |
-
- | type |
- Execution type |
-
-
@@ -3501,7 +3777,7 @@ Generated events on method call
Cancel all running setup-level executions
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -3556,27 +3832,33 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"execId" : "an exec id",
"newState" : "IN_PROGRESS",
"ownerKey" : "an owner key",
- "type" : 1,
+ "executionType" : 1,
"subType" : 1,
"oldState" : "TRANSMITTED",
"timeToNextState" : 2,
"failedCommands" : [ {
"deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
"detailedStatus" : {
+ "type" : "generic-error",
"message" : "a message",
"error" : true
},
"rank" : 1,
"failureType" : "NON_EXECUTING"
} ],
+ "relatedDevices" : [ {
+ "deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])"
+ } ],
+ "technical" : false,
"failureTypeCode" : 11,
- "name" : "ExecutionStateChangedEvent",
+ "type" : "ExecutionStateChangedEvent",
"failureType" : "NON_EXECUTING"
} |
@@ -3590,6 +3872,11 @@ Generated events on method call
Execution id |
+
+ | executionType |
+ Execution type |
+
+
| failedCommands |
List of failed commands |
@@ -3620,11 +3907,21 @@ Generated events on method call
Owning partners of the parent entity (setup, ...)) . only available in event streams |
+
+ | relatedDevices |
+ List of devices involved in this execution |
+
+
| setupOID |
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
| subType |
Execution sub type |
@@ -3635,11 +3932,6 @@ Generated events on method call
Remaining time until next execution state |
-
- | type |
- Execution type |
-
-
@@ -3705,7 +3997,7 @@ Generated events on method call
Get action groups currently running
Allows fetching internal action group executions
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -3737,8 +4029,8 @@ Generated events on method call
"startTime" : 2,
"owner" : "an owner",
"actionGroup" : {
- "creationTime" : 1769503155437,
- "lastUpdateTime" : 1769503155438,
+ "creationTime" : 1785140822212,
+ "lastUpdateTime" : 1785140822212,
"label" : "a managed action group label",
"metadata" : "some metadata",
"shortcut" : true,
@@ -3872,7 +4164,7 @@ Generated events on method call
Cancel a running gateway-level execution. DEPRECATED : all executions started through the API are now attached to setup level
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -3969,27 +4261,33 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"execId" : "an exec id",
"newState" : "IN_PROGRESS",
"ownerKey" : "an owner key",
- "type" : 1,
+ "executionType" : 1,
"subType" : 1,
"oldState" : "TRANSMITTED",
"timeToNextState" : 2,
"failedCommands" : [ {
"deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
"detailedStatus" : {
+ "type" : "generic-error",
"message" : "a message",
"error" : true
},
"rank" : 1,
"failureType" : "NON_EXECUTING"
} ],
+ "relatedDevices" : [ {
+ "deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])"
+ } ],
+ "technical" : false,
"failureTypeCode" : 11,
- "name" : "ExecutionStateChangedEvent",
+ "type" : "ExecutionStateChangedEvent",
"failureType" : "NON_EXECUTING"
} |
@@ -4003,6 +4301,11 @@ Generated events on method call
Execution id |
+
+ | executionType |
+ Execution type |
+
+
| failedCommands |
List of failed commands |
@@ -4033,11 +4336,21 @@ Generated events on method call
Owning partners of the parent entity (setup, ...)) . only available in event streams |
+
+ | relatedDevices |
+ List of devices involved in this execution |
+
+
| setupOID |
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
| subType |
Execution sub type |
@@ -4048,11 +4361,6 @@ Generated events on method call
Remaining time until next execution state |
-
- | type |
- Execution type |
-
-
@@ -4119,7 +4427,7 @@ Generated events on method call
Cancel all running gateway-level executions. DEPRECATED : all executions started through the API are now attached to setup level
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -4201,27 +4509,33 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"execId" : "an exec id",
"newState" : "IN_PROGRESS",
"ownerKey" : "an owner key",
- "type" : 1,
+ "executionType" : 1,
"subType" : 1,
"oldState" : "TRANSMITTED",
"timeToNextState" : 2,
"failedCommands" : [ {
"deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
"detailedStatus" : {
+ "type" : "generic-error",
"message" : "a message",
"error" : true
},
"rank" : 1,
"failureType" : "NON_EXECUTING"
} ],
+ "relatedDevices" : [ {
+ "deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])"
+ } ],
+ "technical" : false,
"failureTypeCode" : 11,
- "name" : "ExecutionStateChangedEvent",
+ "type" : "ExecutionStateChangedEvent",
"failureType" : "NON_EXECUTING"
} |
@@ -4235,6 +4549,11 @@ Generated events on method call
Execution id |
+
+ | executionType |
+ Execution type |
+
+
| failedCommands |
List of failed commands |
@@ -4265,11 +4584,21 @@ Generated events on method call
Owning partners of the parent entity (setup, ...)) . only available in event streams |
+
+ | relatedDevices |
+ List of devices involved in this execution |
+
+
| setupOID |
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
| subType |
Execution sub type |
@@ -4280,11 +4609,6 @@ Generated events on method call
Remaining time until next execution state |
-
- | type |
- Execution type |
-
-
@@ -4350,7 +4674,7 @@ Generated events on method call
Get a scheduled execution of delayed trigger
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -4517,7 +4841,7 @@ Generated events on method call
Cancel a delayed trigger
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -4599,11 +4923,12 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"triggerId" : "a trigger id",
- "name" : "DelayedTriggerCancelledEvent"
+ "type" : "DelayedTriggerCancelledEvent"
} |
@@ -4621,6 +4946,11 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
| triggerId |
Trigger id |
@@ -4691,7 +5021,7 @@ Generated events on method call
Get the list of all scheduled executions of delayed trigger
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -4831,7 +5161,7 @@ Generated events on method call
Execute a non-persistent action group
The executed action group does not have to be persisted on the server before use.
Per-session rate-limit : 1 calls per 28min 48s period for all operations of the same category (exec)
- Access scope : Enduser Open API (enduser/o)
+ Access scope : enduser/o
> Test operation
@@ -4980,10 +5310,12 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
+ "setupOID" : "a setup OID",
"owningPartner" : "an owning partner",
"gatewayId" : "A gateway id (ex: 0101-1234-5678)",
- "name" : "GatewaySynchronizationEndedEvent"
+ "type" : "GatewaySynchronizationEndedEvent"
} |
@@ -5001,6 +5333,62 @@ Generated events on method call
Owning partner of the parent entity (gateway, setup group, ...)) . only available in event streams |
+
+ | setupOID |
+ Setup OID |
+
+
+
+ | siteOID |
+ Site OID |
+
+
+
+
+
+
+ GatewaySynchronizationStartedEvent
+
+ | Description |
+ A data synchronization sequence between the gateway and the server has started |
+
+
+
+ | JSON |
+ {
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
+ "setupOID" : "a setup OID",
+ "owningPartner" : "an owning partner",
+ "gatewayId" : "A gateway id (ex: 0101-1234-5678)",
+ "type" : "GatewaySynchronizationStartedEvent"
+} |
+
+
+ | Field name |
+ Field description |
+
+
+
+ | gatewayId |
+ Gateway id |
+
+
+
+ | owningPartner |
+ Owning partner of the parent entity (gateway, setup group, ...)) . only available in event streams |
+
+
+
+ | setupOID |
+ Setup OID |
+
+
+
+ | siteOID |
+ Site OID |
+
+
@@ -5014,27 +5402,33 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"execId" : "an exec id",
"newState" : "IN_PROGRESS",
"ownerKey" : "an owner key",
- "type" : 1,
+ "executionType" : 1,
"subType" : 1,
"oldState" : "TRANSMITTED",
"timeToNextState" : 2,
"failedCommands" : [ {
"deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
"detailedStatus" : {
+ "type" : "generic-error",
"message" : "a message",
"error" : true
},
"rank" : 1,
"failureType" : "NON_EXECUTING"
} ],
+ "relatedDevices" : [ {
+ "deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])"
+ } ],
+ "technical" : false,
"failureTypeCode" : 11,
- "name" : "ExecutionStateChangedEvent",
+ "type" : "ExecutionStateChangedEvent",
"failureType" : "NON_EXECUTING"
} |
@@ -5048,6 +5442,11 @@ Generated events on method call
Execution id |
+
+ | executionType |
+ Execution type |
+
+
| failedCommands |
List of failed commands |
@@ -5078,11 +5477,21 @@ Generated events on method call
Owning partners of the parent entity (setup, ...)) . only available in event streams |
+
+ | relatedDevices |
+ List of devices involved in this execution |
+
+
| setupOID |
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
| subType |
Execution sub type |
@@ -5093,11 +5502,6 @@ Generated events on method call
Remaining time until next execution state |
-
- | type |
- Execution type |
-
-
@@ -5111,16 +5515,17 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
"deviceStates" : [ {
"name" : "a device state change item name",
"type" : 1,
"value" : "a device state change item value"
} ],
- "name" : "DeviceStateChangedEvent"
+ "type" : "DeviceStateChangedEvent"
} |
@@ -5148,38 +5553,9 @@ Generated events on method call
Setup OID |
-
-
-
-
- GatewaySynchronizationStartedEvent
-
- | Description |
- A data synchronization sequence between the gateway and the server has started |
-
-
-
- | JSON |
- {
- "timestamp" : 2,
- "owningPartner" : "an owning partner",
- "gatewayId" : "A gateway id (ex: 0101-1234-5678)",
- "name" : "GatewaySynchronizationStartedEvent"
-} |
-
-
- | Field name |
- Field description |
-
-
- | gatewayId |
- Gateway id |
-
-
-
- | owningPartner |
- Owning partner of the parent entity (gateway, setup group, ...)) . only available in event streams |
+ siteOID |
+ Site OID |
@@ -5248,7 +5624,7 @@ Generated events on method call
Execute a non-persistent action group in geolocated mode
The executed action group does not have to be persisted on the server before use.
The action group execution will be flagged as geolocated.
Per-session rate-limit : 1 calls per 28min 48s period for all operations of the same category (exec)
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -5372,6 +5748,62 @@ Generated events on method call
Generated events on method call
+
+ DeviceStateChangedEvent
+
+ | Description |
+ One or more states of a device have changed (high-level) |
+
+
+
+ | JSON |
+ {
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
+ "setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
+ "deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
+ "deviceStates" : [ {
+ "name" : "a device state change item name",
+ "type" : 1,
+ "value" : "a device state change item value"
+ } ],
+ "type" : "DeviceStateChangedEvent"
+} |
+
+
+ | Field name |
+ Field description |
+
+
+
+ | deviceStates |
+ Updated device states |
+
+
+
+ | deviceURL |
+ Device URL |
+
+
+
+ | owningPartners |
+ Owning partners of the parent entity (setup, ...)) . only available in event streams |
+
+
+
+ | setupOID |
+ Setup OID |
+
+
+
+ | siteOID |
+ Site OID |
+
+
+
+
+
ExecutionStateChangedEvent
@@ -5382,27 +5814,33 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"execId" : "an exec id",
"newState" : "IN_PROGRESS",
"ownerKey" : "an owner key",
- "type" : 1,
+ "executionType" : 1,
"subType" : 1,
"oldState" : "TRANSMITTED",
"timeToNextState" : 2,
"failedCommands" : [ {
"deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
"detailedStatus" : {
+ "type" : "generic-error",
"message" : "a message",
"error" : true
},
"rank" : 1,
"failureType" : "NON_EXECUTING"
} ],
+ "relatedDevices" : [ {
+ "deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])"
+ } ],
+ "technical" : false,
"failureTypeCode" : 11,
- "name" : "ExecutionStateChangedEvent",
+ "type" : "ExecutionStateChangedEvent",
"failureType" : "NON_EXECUTING"
} |
@@ -5416,6 +5854,11 @@ Generated events on method call
Execution id |
+
+ | executionType |
+ Execution type |
+
+
| failedCommands |
List of failed commands |
@@ -5446,11 +5889,21 @@ Generated events on method call
Owning partners of the parent entity (setup, ...)) . only available in event streams |
+
+ | relatedDevices |
+ List of devices involved in this execution |
+
+
| setupOID |
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
| subType |
Execution sub type |
@@ -5461,34 +5914,25 @@ Generated events on method call
Remaining time until next execution state |
-
- | type |
- Execution type |
-
-
- DeviceStateChangedEvent
+ GatewaySynchronizationStartedEvent
| Description |
- One or more states of a device have changed (high-level) |
+ A data synchronization sequence between the gateway and the server has started |
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
- "deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
- "deviceStates" : [ {
- "name" : "a device state change item name",
- "type" : 1,
- "value" : "a device state change item value"
- } ],
- "name" : "DeviceStateChangedEvent"
+ "owningPartner" : "an owning partner",
+ "gatewayId" : "A gateway id (ex: 0101-1234-5678)",
+ "type" : "GatewaySynchronizationStartedEvent"
} |
@@ -5497,42 +5941,44 @@ Generated events on method call
- | deviceStates |
- Updated device states |
+ gatewayId |
+ Gateway id |
- | deviceURL |
- Device URL |
+ owningPartner |
+ Owning partner of the parent entity (gateway, setup group, ...)) . only available in event streams |
- | owningPartners |
- Owning partners of the parent entity (setup, ...)) . only available in event streams |
+ setupOID |
+ Setup OID |
- | setupOID |
- Setup OID |
+ siteOID |
+ Site OID |
- GatewaySynchronizationStartedEvent
+ GatewaySynchronizationEndedEvent
| Description |
- A data synchronization sequence between the gateway and the server has started |
+ A data synchronization sequence between the gateway and the server has completed |
| JSON |
{
- "timestamp" : 2,
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
+ "setupOID" : "a setup OID",
"owningPartner" : "an owning partner",
"gatewayId" : "A gateway id (ex: 0101-1234-5678)",
- "name" : "GatewaySynchronizationStartedEvent"
+ "type" : "GatewaySynchronizationEndedEvent"
} |
@@ -5550,38 +5996,14 @@ Generated events on method call
Owning partner of the parent entity (gateway, setup group, ...)) . only available in event streams |
-
-
-
-
- GatewaySynchronizationEndedEvent
-
- | Description |
- A data synchronization sequence between the gateway and the server has completed |
-
-
-
- | JSON |
- {
- "timestamp" : 2,
- "owningPartner" : "an owning partner",
- "gatewayId" : "A gateway id (ex: 0101-1234-5678)",
- "name" : "GatewaySynchronizationEndedEvent"
-} |
-
-
- | Field name |
- Field description |
-
-
- | gatewayId |
- Gateway id |
+ setupOID |
+ Setup OID |
- | owningPartner |
- Owning partner of the parent entity (gateway, setup group, ...)) . only available in event streams |
+ siteOID |
+ Site OID |
@@ -5650,7 +6072,7 @@ Generated events on method call
Execute a non-persistent action group in high-priority mode
The executed action group does not have to be persisted on the server before use.
The action group execution will have an higher priority, allowing to bypass some restrictions like forcing a blocked device.
Per-session rate-limit : 1 calls per 28min 48s period for all operations of the same category (exec)
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -5774,6 +6196,52 @@ Generated events on method call
Generated events on method call
+
+ GatewaySynchronizationStartedEvent
+
+ | Description |
+ A data synchronization sequence between the gateway and the server has started |
+
+
+
+ | JSON |
+ {
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
+ "setupOID" : "a setup OID",
+ "owningPartner" : "an owning partner",
+ "gatewayId" : "A gateway id (ex: 0101-1234-5678)",
+ "type" : "GatewaySynchronizationStartedEvent"
+} |
+
+
+ | Field name |
+ Field description |
+
+
+
+ | gatewayId |
+ Gateway id |
+
+
+
+ | owningPartner |
+ Owning partner of the parent entity (gateway, setup group, ...)) . only available in event streams |
+
+
+
+ | setupOID |
+ Setup OID |
+
+
+
+ | siteOID |
+ Site OID |
+
+
+
+
+
ExecutionStateChangedEvent
@@ -5784,27 +6252,33 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"execId" : "an exec id",
"newState" : "IN_PROGRESS",
"ownerKey" : "an owner key",
- "type" : 1,
+ "executionType" : 1,
"subType" : 1,
"oldState" : "TRANSMITTED",
"timeToNextState" : 2,
"failedCommands" : [ {
"deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
"detailedStatus" : {
+ "type" : "generic-error",
"message" : "a message",
"error" : true
},
"rank" : 1,
"failureType" : "NON_EXECUTING"
} ],
+ "relatedDevices" : [ {
+ "deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])"
+ } ],
+ "technical" : false,
"failureTypeCode" : 11,
- "name" : "ExecutionStateChangedEvent",
+ "type" : "ExecutionStateChangedEvent",
"failureType" : "NON_EXECUTING"
} |
@@ -5818,6 +6292,11 @@ Generated events on method call
Execution id |
+
+ | executionType |
+ Execution type |
+
+
| failedCommands |
List of failed commands |
@@ -5848,11 +6327,21 @@ Generated events on method call
Owning partners of the parent entity (setup, ...)) . only available in event streams |
+
+ | relatedDevices |
+ List of devices involved in this execution |
+
+
| setupOID |
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
| subType |
Execution sub type |
@@ -5863,11 +6352,6 @@ Generated events on method call
Remaining time until next execution state |
-
- | type |
- Execution type |
-
-
@@ -5881,10 +6365,12 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
+ "setupOID" : "a setup OID",
"owningPartner" : "an owning partner",
"gatewayId" : "A gateway id (ex: 0101-1234-5678)",
- "name" : "GatewaySynchronizationEndedEvent"
+ "type" : "GatewaySynchronizationEndedEvent"
} |
@@ -5902,6 +6388,16 @@ Generated events on method call
Owning partner of the parent entity (gateway, setup group, ...)) . only available in event streams |
+
+ | setupOID |
+ Setup OID |
+
+
+
+ | siteOID |
+ Site OID |
+
+
@@ -5915,16 +6411,17 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
"deviceStates" : [ {
"name" : "a device state change item name",
"type" : 1,
"value" : "a device state change item value"
} ],
- "name" : "DeviceStateChangedEvent"
+ "type" : "DeviceStateChangedEvent"
} |
@@ -5952,38 +6449,9 @@ Generated events on method call
Setup OID |
-
-
-
-
- GatewaySynchronizationStartedEvent
-
- | Description |
- A data synchronization sequence between the gateway and the server has started |
-
-
-
- | JSON |
- {
- "timestamp" : 2,
- "owningPartner" : "an owning partner",
- "gatewayId" : "A gateway id (ex: 0101-1234-5678)",
- "name" : "GatewaySynchronizationStartedEvent"
-} |
-
-
- | Field name |
- Field description |
-
-
-
- | gatewayId |
- Gateway id |
-
-
- | owningPartner |
- Owning partner of the parent entity (gateway, setup group, ...)) . only available in event streams |
+ siteOID |
+ Site OID |
@@ -6053,7 +6521,7 @@ Generated events on method call
The action group execution will be flagged as internal and its result will not be stored in the setup execution history.
This is useful for automatic refresh operations that should not appear in the user history.
Per-session rate-limit : 1 calls per 28min 48s period for all operations of the same category (exec)
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -6177,6 +6645,52 @@ Generated events on method call
Generated events on method call
+
+ GatewaySynchronizationStartedEvent
+
+ | Description |
+ A data synchronization sequence between the gateway and the server has started |
+
+
+
+ | JSON |
+ {
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
+ "setupOID" : "a setup OID",
+ "owningPartner" : "an owning partner",
+ "gatewayId" : "A gateway id (ex: 0101-1234-5678)",
+ "type" : "GatewaySynchronizationStartedEvent"
+} |
+
+
+ | Field name |
+ Field description |
+
+
+
+ | gatewayId |
+ Gateway id |
+
+
+
+ | owningPartner |
+ Owning partner of the parent entity (gateway, setup group, ...)) . only available in event streams |
+
+
+
+ | setupOID |
+ Setup OID |
+
+
+
+ | siteOID |
+ Site OID |
+
+
+
+
+
ExecutionStateChangedEvent
@@ -6187,27 +6701,33 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"execId" : "an exec id",
"newState" : "IN_PROGRESS",
"ownerKey" : "an owner key",
- "type" : 1,
+ "executionType" : 1,
"subType" : 1,
"oldState" : "TRANSMITTED",
"timeToNextState" : 2,
"failedCommands" : [ {
"deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
"detailedStatus" : {
+ "type" : "generic-error",
"message" : "a message",
"error" : true
},
"rank" : 1,
"failureType" : "NON_EXECUTING"
} ],
+ "relatedDevices" : [ {
+ "deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])"
+ } ],
+ "technical" : false,
"failureTypeCode" : 11,
- "name" : "ExecutionStateChangedEvent",
+ "type" : "ExecutionStateChangedEvent",
"failureType" : "NON_EXECUTING"
} |
@@ -6221,6 +6741,11 @@ Generated events on method call
Execution id |
+
+ | executionType |
+ Execution type |
+
+
| failedCommands |
List of failed commands |
@@ -6251,11 +6776,21 @@ Generated events on method call
Owning partners of the parent entity (setup, ...)) . only available in event streams |
+
+ | relatedDevices |
+ List of devices involved in this execution |
+
+
| setupOID |
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
| subType |
Execution sub type |
@@ -6266,28 +6801,25 @@ Generated events on method call
Remaining time until next execution state |
-
- | type |
- Execution type |
-
-
- GatewaySynchronizationStartedEvent
+ GatewaySynchronizationEndedEvent
| Description |
- A data synchronization sequence between the gateway and the server has started |
+ A data synchronization sequence between the gateway and the server has completed |
| JSON |
{
- "timestamp" : 2,
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
+ "setupOID" : "a setup OID",
"owningPartner" : "an owning partner",
"gatewayId" : "A gateway id (ex: 0101-1234-5678)",
- "name" : "GatewaySynchronizationStartedEvent"
+ "type" : "GatewaySynchronizationEndedEvent"
} |
@@ -6305,6 +6837,16 @@ Generated events on method call
Owning partner of the parent entity (gateway, setup group, ...)) . only available in event streams |
+
+ | setupOID |
+ Setup OID |
+
+
+
+ | siteOID |
+ Site OID |
+
+
@@ -6318,16 +6860,17 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
"deviceStates" : [ {
"name" : "a device state change item name",
"type" : 1,
"value" : "a device state change item value"
} ],
- "name" : "DeviceStateChangedEvent"
+ "type" : "DeviceStateChangedEvent"
} |
@@ -6355,38 +6898,9 @@ Generated events on method call
Setup OID |
-
-
-
-
- GatewaySynchronizationEndedEvent
-
- | Description |
- A data synchronization sequence between the gateway and the server has completed |
-
-
-
- | JSON |
- {
- "timestamp" : 2,
- "owningPartner" : "an owning partner",
- "gatewayId" : "A gateway id (ex: 0101-1234-5678)",
- "name" : "GatewaySynchronizationEndedEvent"
-} |
-
-
- | Field name |
- Field description |
-
-
-
- | gatewayId |
- Gateway id |
-
-
- | owningPartner |
- Owning partner of the parent entity (gateway, setup group, ...)) . only available in event streams |
+ siteOID |
+ Site OID |
@@ -6454,7 +6968,7 @@ Generated events on method call
Compute optimized version of a given execution: replace individual devices sharing the same command (name + parameters) by matching existing protocol groups to improve execution speed
Optimize action group
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -6533,8 +7047,8 @@ Generated events on method call
(JSON)
{
- "creationTime" : 1769503155441,
- "lastUpdateTime" : 1769503155441,
+ "creationTime" : 1785140822216,
+ "lastUpdateTime" : 1785140822216,
"label" : "a managed action group label",
"metadata" : "some metadata",
"shortcut" : true,
@@ -6664,7 +7178,7 @@ Generated events on method call
-> at a time of the current day of the weekly planning (executionType=?Weekly planning? executionSubType=?TIME_TRIGGER?)
-> at dawn or dusk of the current day (executionType=?Weekly planning? executionSubType=?DAWN_TRIGGER? or executionSubType=?DUSK_TRIGGER?)
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
|
@@ -6831,7 +7345,7 @@ Generated events on method call
Schedule an action group execution with a delay
Per-session rate-limit : 1 calls per 28min 48s period for all operations of the same category (exec)
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -6948,25 +7462,116 @@ Generated events on method call
Generated events on method call
- DeviceStateChangedEvent
+ GatewaySynchronizationStartedEvent
| Description |
- One or more states of a device have changed (high-level) |
+ A data synchronization sequence between the gateway and the server has started |
| JSON |
{
- "timestamp" : 2,
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
+ "setupOID" : "a setup OID",
+ "owningPartner" : "an owning partner",
+ "gatewayId" : "A gateway id (ex: 0101-1234-5678)",
+ "type" : "GatewaySynchronizationStartedEvent"
+} |
+
+
+ | Field name |
+ Field description |
+
+
+
+ | gatewayId |
+ Gateway id |
+
+
+
+ | owningPartner |
+ Owning partner of the parent entity (gateway, setup group, ...)) . only available in event streams |
+
+
+
+ | setupOID |
+ Setup OID |
+
+
+
+ | siteOID |
+ Site OID |
+
+
+
+
+
+
+ DelayedTriggerSetEvent
+
+ | Description |
+ A new delayed trigger has been scheduled |
+
+
+
+ | JSON |
+ {
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
+ "setupOID" : "a setup OID",
"owningPartners" : [ "some owning partners" ],
+ "triggerId" : "a trigger id",
+ "type" : "DelayedTriggerSetEvent"
+} |
+
+
+ | Field name |
+ Field description |
+
+
+
+ | owningPartners |
+ Owning partners of the parent entity (setup, ...)) . only available in event streams |
+
+
+
+ | setupOID |
+ Setup OID |
+
+
+
+ | siteOID |
+ Site OID |
+
+
+
+ | triggerId |
+ Trigger id |
+
+
+
+
+
+
+ GroupTriggeredEvent
+
+ | Description |
+ An action group has been triggered and is currently in execution |
+
+
+
+ | JSON |
+ {
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
- "deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
- "deviceStates" : [ {
- "name" : "a device state change item name",
- "type" : 1,
- "value" : "a device state change item value"
- } ],
- "name" : "DeviceStateChangedEvent"
+ "owningPartners" : [ "some owning partners" ],
+ "triggerId" : "a trigger id",
+ "triggerType" : "a trigger type",
+ "actionGroupOID" : "an action group OID",
+ "execId" : "an exec id",
+ "type" : "GroupTriggeredEvent"
} |
@@ -6975,13 +7580,13 @@ Generated events on method call
- | deviceStates |
- Updated device states |
+ actionGroupOID |
+ OID of the started action group |
- | deviceURL |
- Device URL |
+ execId |
+ Execution id |
@@ -6994,6 +7599,21 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
+
+ | triggerId |
+ Trigger id |
+
+
+
+ | triggerType |
+ Trigger type |
+
+
@@ -7007,10 +7627,12 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
+ "setupOID" : "a setup OID",
"owningPartner" : "an owning partner",
"gatewayId" : "A gateway id (ex: 0101-1234-5678)",
- "name" : "GatewaySynchronizationEndedEvent"
+ "type" : "GatewaySynchronizationEndedEvent"
} |
@@ -7028,6 +7650,16 @@ Generated events on method call
Owning partner of the parent entity (gateway, setup group, ...)) . only available in event streams |
+
+ | setupOID |
+ Setup OID |
+
+
+
+ | siteOID |
+ Site OID |
+
+
@@ -7041,27 +7673,33 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"execId" : "an exec id",
"newState" : "IN_PROGRESS",
"ownerKey" : "an owner key",
- "type" : 1,
+ "executionType" : 1,
"subType" : 1,
"oldState" : "TRANSMITTED",
"timeToNextState" : 2,
"failedCommands" : [ {
"deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
"detailedStatus" : {
+ "type" : "generic-error",
"message" : "a message",
"error" : true
},
"rank" : 1,
"failureType" : "NON_EXECUTING"
} ],
+ "relatedDevices" : [ {
+ "deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])"
+ } ],
+ "technical" : false,
"failureTypeCode" : 11,
- "name" : "ExecutionStateChangedEvent",
+ "type" : "ExecutionStateChangedEvent",
"failureType" : "NON_EXECUTING"
} |
@@ -7075,6 +7713,11 @@ Generated events on method call
Execution id |
+
+ | executionType |
+ Execution type |
+
+
| failedCommands |
List of failed commands |
@@ -7105,11 +7748,21 @@ Generated events on method call
Owning partners of the parent entity (setup, ...)) . only available in event streams |
+
+ | relatedDevices |
+ List of devices involved in this execution |
+
+
| setupOID |
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
| subType |
Execution sub type |
@@ -7120,86 +7773,30 @@ Generated events on method call
Remaining time until next execution state |
-
- | type |
- Execution type |
-
-
- GroupTriggeredEvent
+ DeviceStateChangedEvent
| Description |
- An action group has been triggered and is currently in execution |
+ One or more states of a device have changed (high-level) |
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
- "triggerId" : "a trigger id",
- "triggerType" : "a trigger type",
- "actionGroupOID" : "an action group OID",
- "execId" : "an exec id",
- "name" : "GroupTriggeredEvent"
-} |
-
-
- | Field name |
- Field description |
-
-
-
- | actionGroupOID |
- OID of the started action group |
-
-
-
- | execId |
- Execution id |
-
-
-
- | owningPartners |
- Owning partners of the parent entity (setup, ...)) . only available in event streams |
-
-
-
- | setupOID |
- Setup OID |
-
-
-
- | triggerId |
- Trigger id |
-
-
-
- | triggerType |
- Trigger type |
-
-
-
-
-
-
- GatewaySynchronizationStartedEvent
-
- | Description |
- A data synchronization sequence between the gateway and the server has started |
-
-
-
- | JSON |
- {
- "timestamp" : 2,
- "owningPartner" : "an owning partner",
- "gatewayId" : "A gateway id (ex: 0101-1234-5678)",
- "name" : "GatewaySynchronizationStartedEvent"
+ "owningPartners" : [ "some owning partners" ],
+ "deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
+ "deviceStates" : [ {
+ "name" : "a device state change item name",
+ "type" : 1,
+ "value" : "a device state change item value"
+ } ],
+ "type" : "DeviceStateChangedEvent"
} |
@@ -7208,40 +7805,15 @@ Generated events on method call
- | gatewayId |
- Gateway id |
+ deviceStates |
+ Updated device states |
- | owningPartner |
- Owning partner of the parent entity (gateway, setup group, ...)) . only available in event streams |
+ deviceURL |
+ Device URL |
-
-
-
-
- DelayedTriggerSetEvent
-
- | Description |
- A new delayed trigger has been scheduled |
-
-
-
- | JSON |
- {
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
- "setupOID" : "a setup OID",
- "triggerId" : "a trigger id",
- "name" : "DelayedTriggerSetEvent"
-} |
-
-
- | Field name |
- Field description |
-
-
| owningPartners |
Owning partners of the parent entity (setup, ...)) . only available in event streams |
@@ -7253,8 +7825,8 @@ Generated events on method call
- | triggerId |
- Trigger id |
+ siteOID |
+ Site OID |
@@ -7325,7 +7897,7 @@ Generated events on method call
-> at a time of the current day of the weekly planning (executionType=?Weekly planning? executionSubType=?TIME_TRIGGER?)
-> at dawn or dusk of the current day (executionType=?Weekly planning? executionSubType=?DAWN_TRIGGER? or executionSubType=?DUSK_TRIGGER?)
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -7494,7 +8066,7 @@
Get a list of all authorized applications for the current setup
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -7526,8 +8098,8 @@
"clientName" : "a client name",
"clientId" : "a client id",
"scopes" : "some scopes",
- "accessTokenNextExpirationTime" : 1769503155449,
- "refreshTokenNextExpirationTime" : 1769503155449,
+ "accessTokenNextExpirationTime" : 1785140822229,
+ "refreshTokenNextExpirationTime" : 1785140822229,
"enabled" : false
} ]
@@ -7632,7 +8204,7 @@
Revoke an authorized application
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
|
@@ -7763,7 +8335,7 @@
Disable an authorized application
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -7894,7 +8466,7 @@
Enable an authorized application
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -8025,7 +8597,7 @@
Get an OAuth2 authorization code
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -8331,7 +8903,7 @@
Create a condition group
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -8453,9 +9025,10 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"conditionGroupOID" : "a condition group OID",
"label" : "a condition group created event label",
"metadata" : "some metadata",
@@ -8467,7 +9040,7 @@ Generated events on method call
"controllableNames" : [ "some controllable names" ]
}
} ],
- "name" : "ConditionGroupCreatedEvent"
+ "type" : "ConditionGroupCreatedEvent"
} |
@@ -8490,6 +9063,11 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
@@ -8555,7 +9133,7 @@ Generated events on method call
Update a condition group
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -8649,9 +9227,10 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"conditionGroupOID" : "a condition group OID",
"label" : "a condition group updated event label",
"metadata" : "some metadata",
@@ -8663,7 +9242,7 @@ Generated events on method call
"controllableNames" : [ "some controllable names" ]
}
} ],
- "name" : "ConditionGroupUpdatedEvent"
+ "type" : "ConditionGroupUpdatedEvent"
} |
@@ -8686,6 +9265,11 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
@@ -8751,7 +9335,7 @@ Generated events on method call
Retrieve a condition group by OID
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -8807,8 +9391,8 @@ Generated events on method call
(JSON)
{
- "creationTime" : 1769503155097,
- "lastUpdateTime" : 1769503155101,
+ "creationTime" : 1785140821820,
+ "lastUpdateTime" : 1785140821825,
"label" : "a condition group label",
"metadata" : "some metadata",
"conditions" : [ {
@@ -8923,7 +9507,7 @@ Generated events on method call
Delete a condition group by OID
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
|
@@ -9005,11 +9589,12 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"conditionGroupOID" : "a condition group OID",
- "name" : "ConditionGroupDeletedEvent"
+ "type" : "ConditionGroupDeletedEvent"
} |
@@ -9032,6 +9617,11 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
@@ -9097,7 +9687,7 @@ Generated events on method call
Evaluate a condition group
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -9154,7 +9744,7 @@ Generated events on method call
{
"evaluationStatus" : "FAILED",
- "evaluationTime" : 1769503155103,
+ "evaluationTime" : 1785140821828,
"failedDevices" : [ "some failed devices" ],
"invalidatingDevices" : [ "some invalidating devices" ],
"ignoredControllables" : [ "some ignored controllables" ]
@@ -9261,7 +9851,7 @@ Generated events on method call
Retrieve all user-defined condition groups
Per-session rate-limit : 1 calls per 1d period for this particular operation (bulk-load)
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
|
@@ -9290,8 +9880,8 @@ Generated events on method call
(JSON)
[ {
- "creationTime" : 1769503155101,
- "lastUpdateTime" : 1769503155101,
+ "creationTime" : 1785140821825,
+ "lastUpdateTime" : 1785140821826,
"label" : "a condition group label",
"metadata" : "some metadata",
"conditions" : [ {
@@ -9481,7 +10071,7 @@
Return an URL to use for August authentication. At the end of the authentication process, the user will be redirected to the given {redirectURL}
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
|
@@ -9658,7 +10248,7 @@
Return the list of the gateways candidates
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -9713,10 +10303,11 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
- "name" : "AugustDiscoverHousesCandidatesFailedEvent",
+ "owningPartners" : [ "some owning partners" ],
+ "type" : "AugustDiscoverHousesCandidatesFailedEvent",
"failureType" : "NON_EXECUTING"
} |
@@ -9735,6 +10326,11 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
@@ -9748,9 +10344,10 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"houses" : [ {
"id" : "an id",
"name" : "an august house candidate name",
@@ -9759,7 +10356,7 @@ Generated events on method call
"name" : "an august lock candidate name"
} ]
} ],
- "name" : "AugustDiscoverHousesCandidatesCompletedEvent"
+ "type" : "AugustDiscoverHousesCandidatesCompletedEvent"
} |
@@ -9777,6 +10374,11 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
@@ -9842,7 +10444,7 @@ Generated events on method call
Refresh current access token if necessary
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -9888,7 +10490,7 @@ Generated events on method call
Generated events on method call
- AugustRefreshCurrentTokenCompletedEvent
+ AugustRefreshCurrentTokenFailedEvent
| Description |
|
@@ -9897,10 +10499,12 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
- "name" : "AugustRefreshCurrentTokenCompletedEvent"
+ "owningPartners" : [ "some owning partners" ],
+ "type" : "AugustRefreshCurrentTokenFailedEvent",
+ "failureType" : "NON_EXECUTING"
} |
@@ -9918,11 +10522,16 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
- AugustRefreshCurrentTokenFailedEvent
+ AugustRefreshCurrentTokenCompletedEvent
| Description |
|
@@ -9931,11 +10540,11 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
- "name" : "AugustRefreshCurrentTokenFailedEvent",
- "failureType" : "NON_EXECUTING"
+ "owningPartners" : [ "some owning partners" ],
+ "type" : "AugustRefreshCurrentTokenCompletedEvent"
} |
@@ -9953,6 +10562,11 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
@@ -10018,7 +10632,7 @@ Generated events on method call
Start a discover August gateway
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -10091,7 +10705,7 @@ Generated events on method call
Generated events on method call
- AugustGatewayDiscoverFailedEvent
+ AugustGatewayDiscoverCompletedEvent
| Description |
|
@@ -10100,12 +10714,12 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"gatewayId" : "a gateway id",
- "name" : "AugustGatewayDiscoverFailedEvent",
- "failureType" : "NON_EXECUTING"
+ "type" : "AugustGatewayDiscoverCompletedEvent"
} |
@@ -10113,6 +10727,11 @@ Generated events on method call
Field description |
+
+ | gatewayId |
+ gateway Id |
+
+
| owningPartners |
Owning partners of the parent entity (setup, ...)) . only available in event streams |
@@ -10123,11 +10742,16 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
- AugustGatewayDiscoverCompletedEvent
+ AugustGatewayDiscoverFailedEvent
| Description |
|
@@ -10136,11 +10760,13 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"gatewayId" : "a gateway id",
- "name" : "AugustGatewayDiscoverCompletedEvent"
+ "type" : "AugustGatewayDiscoverFailedEvent",
+ "failureType" : "NON_EXECUTING"
} |
@@ -10148,11 +10774,6 @@ Generated events on method call
Field description |
-
- | gatewayId |
- gateway Id |
-
-
| owningPartners |
Owning partners of the parent entity (setup, ...)) . only available in event streams |
@@ -10163,6 +10784,11 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
@@ -10228,7 +10854,7 @@ Generated events on method call
Start discover August devices
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -10310,12 +10936,14 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
+ "setupOID" : "a setup OID",
"owningPartner" : "an owning partner",
"gatewayId" : "A gateway id (ex: 0101-1234-5678)",
"protocolType" : 1,
"ref" : "a ref",
- "name" : "DiscoverCompleteEvent"
+ "type" : "DiscoverCompleteEvent"
} |
@@ -10343,6 +10971,16 @@ Generated events on method call
Reference |
+
+ | setupOID |
+ Setup OID |
+
+
+
+ | siteOID |
+ Site OID |
+
+
@@ -10356,12 +10994,14 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
+ "setupOID" : "a setup OID",
"owningPartner" : "an owning partner",
"gatewayId" : "A gateway id (ex: 0101-1234-5678)",
"protocolType" : 1,
"ref" : "a ref",
- "name" : "DiscoverFailedEvent",
+ "type" : "DiscoverFailedEvent",
"failureType" : "NON_EXECUTING"
} |
@@ -10395,6 +11035,16 @@ Generated events on method call
Reference |
+
+ | setupOID |
+ Setup OID |
+
+
+
+ | siteOID |
+ Site OID |
+
+
@@ -10408,9 +11058,10 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
"controllableName" : "a controllable name",
"label" : "a device created event label",
@@ -10421,7 +11072,7 @@ Generated events on method call
"type" : 1,
"value" : "a device attribute change item value"
} ],
- "name" : "DeviceCreatedEvent"
+ "type" : "DeviceCreatedEvent"
} |
@@ -10449,6 +11100,11 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
@@ -10543,7 +11199,7 @@
Pair and configure a camera
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -10680,9 +11336,10 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
"controllableName" : "a controllable name",
"label" : "a device created event label",
@@ -10693,7 +11350,7 @@ Generated events on method call
"type" : 1,
"value" : "a device attribute change item value"
} ],
- "name" : "DeviceCreatedEvent"
+ "type" : "DeviceCreatedEvent"
} |
@@ -10721,6 +11378,11 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
@@ -10734,11 +11396,13 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
+ "setupOID" : "a setup OID",
"owningPartner" : "an owning partner",
"gatewayId" : "A gateway id (ex: 0101-1234-5678)",
"cameraId" : "a camera id",
- "name" : "CameraDiscoveredEvent"
+ "type" : "CameraDiscoveredEvent"
} |
@@ -10761,6 +11425,16 @@ Generated events on method call
Owning partner of the parent entity (gateway, setup group, ...)) . only available in event streams |
+
+ | setupOID |
+ Setup OID |
+
+
+
+ | siteOID |
+ Site OID |
+
+
@@ -10826,7 +11500,7 @@ Generated events on method call
Delete discovered but unpaired cameras for a given gateway
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -10957,7 +11631,7 @@ Generated events on method call
Set Wifi settings of a paired camera
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -11134,27 +11808,33 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"execId" : "an exec id",
"newState" : "IN_PROGRESS",
"ownerKey" : "an owner key",
- "type" : 1,
+ "executionType" : 1,
"subType" : 1,
"oldState" : "TRANSMITTED",
"timeToNextState" : 2,
"failedCommands" : [ {
"deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
"detailedStatus" : {
+ "type" : "generic-error",
"message" : "a message",
"error" : true
},
"rank" : 1,
"failureType" : "NON_EXECUTING"
} ],
+ "relatedDevices" : [ {
+ "deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])"
+ } ],
+ "technical" : false,
"failureTypeCode" : 11,
- "name" : "ExecutionStateChangedEvent",
+ "type" : "ExecutionStateChangedEvent",
"failureType" : "NON_EXECUTING"
} |
@@ -11168,6 +11848,11 @@ Generated events on method call
Execution id |
+
+ | executionType |
+ Execution type |
+
+
| failedCommands |
List of failed commands |
@@ -11198,11 +11883,21 @@ Generated events on method call
Owning partners of the parent entity (setup, ...)) . only available in event streams |
+
+ | relatedDevices |
+ List of devices involved in this execution |
+
+
| setupOID |
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
| subType |
Execution sub type |
@@ -11213,11 +11908,6 @@ Generated events on method call
Remaining time until next execution state |
-
- | type |
- Execution type |
-
-
@@ -11290,7 +11980,7 @@ Generated events on method call
-> lockType: lock type. 0 stands for available (not locked), 1 for locked by an alarm system, 2 for locked by a gateway and 3 indicates that camera version is outdated
-> wifiEnabled: indicates if wifi is enabled on the camera
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -11496,7 +12186,7 @@
Get active commissioning codes on given protocol
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -11673,9 +12363,9 @@
|
- Add one or more device commissioning code(s) on given protocol for a future pairing procedure. The limit for zigbee protocol is 4
+ Add one or more device commissioning code(s) on given protocol for a future pairing procedure. The limit for zigbee protocol is 127
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
|
@@ -11840,7 +12530,7 @@
Remove all device commissioning codes on given protocol
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -11986,7 +12676,7 @@
Remove a device commissioning code on given protocol
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -12147,7 +12837,7 @@
Import saved device commissioning codes to the actual codes list
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -12293,7 +12983,7 @@
Get saved commissioning codes on given protocol
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -12472,7 +13162,7 @@
Add one or more device saved commissioning code(s) on given protocol for a future pairing procedure
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -12637,7 +13327,7 @@
Remove all saved device commissioning codes on given protocol
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -12783,7 +13473,7 @@
Remove a device saved commissioning code on given protocol
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -12944,7 +13634,7 @@
This operation allows to create a device. This operation is useful to add RTS devices, RTD alarm system and EnOcean actuators
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -13086,9 +13776,10 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
"controllableName" : "a controllable name",
"label" : "a device created event label",
@@ -13099,7 +13790,7 @@ Generated events on method call
"type" : 1,
"value" : "a device attribute change item value"
} ],
- "name" : "DeviceCreatedEvent"
+ "type" : "DeviceCreatedEvent"
} |
@@ -13127,6 +13818,11 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
@@ -13192,7 +13888,7 @@ Generated events on method call
Get addresses of partial devices on given protocol
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -13264,7 +13960,7 @@ Generated events on method call
[ {
"address" : "an address",
- "creationTime" : 1769503155454
+ "creationTime" : 1785140822239
} ] |
@@ -13368,7 +14064,7 @@ Generated events on method call
This operation allows to purge partially discovered raw devices (with status PARTIAL)
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
|
@@ -13465,12 +14161,14 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
+ "setupOID" : "a setup OID",
"owningPartner" : "an owning partner",
"gatewayId" : "A gateway id (ex: 0101-1234-5678)",
"protocolType" : 1,
"deletedRawDevicesCount" : 1,
- "name" : "PurgePartialRawDevicesEvent"
+ "type" : "PurgePartialRawDevicesEvent"
} |
@@ -13498,6 +14196,16 @@ Generated events on method call
Device protocol type |
+
+ | setupOID |
+ Setup OID |
+
+
+
+ | siteOID |
+ Site OID |
+
+
@@ -13563,7 +14271,7 @@ Generated events on method call
This operation allows to purge a partial raw device
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -13724,7 +14432,7 @@ Generated events on method call
Initialize the protocol, and create a stack if needed
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -13931,7 +14639,7 @@
Refresh current access token if necessary
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -13986,10 +14694,11 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
- "name" : "EliotRefreshCurrentTokenCompletedEvent"
+ "owningPartners" : [ "some owning partners" ],
+ "type" : "EliotRefreshCurrentTokenCompletedEvent"
} |
@@ -14007,6 +14716,11 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
@@ -14020,10 +14734,11 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
- "name" : "EliotRefreshCurrentTokenFailedEvent",
+ "owningPartners" : [ "some owning partners" ],
+ "type" : "EliotRefreshCurrentTokenFailedEvent",
"failureType" : "NON_EXECUTING"
} |
@@ -14042,6 +14757,11 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
@@ -14107,7 +14827,7 @@ Generated events on method call
Start a discover Eliot gateway
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -14180,7 +14900,7 @@ Generated events on method call
Generated events on method call
- EliotDiscoverGatewayCompletedEvent
+ EliotDiscoverGatewayFailedEvent
| Description |
|
@@ -14189,11 +14909,12 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
- "gatewayId" : "a gateway id",
- "name" : "EliotDiscoverGatewayCompletedEvent"
+ "owningPartners" : [ "some owning partners" ],
+ "type" : "EliotDiscoverGatewayFailedEvent",
+ "failureType" : "NON_EXECUTING"
} |
@@ -14201,11 +14922,6 @@ Generated events on method call
Field description |
-
- | gatewayId |
- Eliot gateway id |
-
-
| owningPartners |
Owning partners of the parent entity (setup, ...)) . only available in event streams |
@@ -14216,11 +14932,16 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
- EliotDiscoverGatewayFailedEvent
+ EliotDiscoverGatewayCompletedEvent
| Description |
|
@@ -14229,11 +14950,12 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
- "name" : "EliotDiscoverGatewayFailedEvent",
- "failureType" : "NON_EXECUTING"
+ "owningPartners" : [ "some owning partners" ],
+ "gatewayId" : "a gateway id",
+ "type" : "EliotDiscoverGatewayCompletedEvent"
} |
@@ -14241,6 +14963,11 @@ Generated events on method call
Field description |
+
+ | gatewayId |
+ Eliot gateway id |
+
+
| owningPartners |
Owning partners of the parent entity (setup, ...)) . only available in event streams |
@@ -14251,6 +14978,11 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
@@ -14316,7 +15048,7 @@ Generated events on method call
Send get a list of all user's gateways
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -14371,14 +15103,15 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"plants" : [ {
"id" : "an id",
"name" : "an eliot plant name"
} ],
- "name" : "EliotDiscoverGatewaysCompletedEvent"
+ "type" : "EliotDiscoverGatewaysCompletedEvent"
} |
@@ -14396,6 +15129,11 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
@@ -14409,10 +15147,11 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
- "name" : "EliotDiscoverGatewaysFailedEvent",
+ "owningPartners" : [ "some owning partners" ],
+ "type" : "EliotDiscoverGatewaysFailedEvent",
"failureType" : "NON_EXECUTING"
} |
@@ -14431,6 +15170,11 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
@@ -14496,7 +15240,7 @@ Generated events on method call
Start discover Eliot devices
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -14568,60 +15312,6 @@ Generated events on method call
Generated events on method call
-
- DeviceCreatedEvent
-
- | Description |
- A new device has been added to the setup |
-
-
-
- | JSON |
- {
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
- "setupOID" : "a setup OID",
- "deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
- "controllableName" : "a controllable name",
- "label" : "a device created event label",
- "placeOID" : "a place OID",
- "metadata" : "some metadata",
- "deviceAttributes" : [ {
- "name" : "a device attribute change item name",
- "type" : 1,
- "value" : "a device attribute change item value"
- } ],
- "name" : "DeviceCreatedEvent"
-} |
-
-
- | Field name |
- Field description |
-
-
-
- | deviceAttributes |
- Compatible device attributes |
-
-
-
- | deviceURL |
- Device URL |
-
-
-
- | owningPartners |
- Owning partners of the parent entity (setup, ...)) . only available in event streams |
-
-
-
- | setupOID |
- Setup OID |
-
-
-
-
-
DiscoverCompleteEvent
@@ -14632,12 +15322,14 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
+ "setupOID" : "a setup OID",
"owningPartner" : "an owning partner",
"gatewayId" : "A gateway id (ex: 0101-1234-5678)",
"protocolType" : 1,
"ref" : "a ref",
- "name" : "DiscoverCompleteEvent"
+ "type" : "DiscoverCompleteEvent"
} |
@@ -14665,6 +15357,16 @@ Generated events on method call
Reference |
+
+ | setupOID |
+ Setup OID |
+
+
+
+ | siteOID |
+ Site OID |
+
+
@@ -14678,12 +15380,14 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
+ "setupOID" : "a setup OID",
"owningPartner" : "an owning partner",
"gatewayId" : "A gateway id (ex: 0101-1234-5678)",
"protocolType" : 1,
"ref" : "a ref",
- "name" : "DiscoverFailedEvent",
+ "type" : "DiscoverFailedEvent",
"failureType" : "NON_EXECUTING"
} |
@@ -14717,6 +15421,76 @@ Generated events on method call
Reference |
+
+ | setupOID |
+ Setup OID |
+
+
+
+ | siteOID |
+ Site OID |
+
+
+
+
+
+
+ DeviceCreatedEvent
+
+ | Description |
+ A new device has been added to the setup |
+
+
+
+ | JSON |
+ {
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
+ "setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
+ "deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
+ "controllableName" : "a controllable name",
+ "label" : "a device created event label",
+ "placeOID" : "a place OID",
+ "metadata" : "some metadata",
+ "deviceAttributes" : [ {
+ "name" : "a device attribute change item name",
+ "type" : 1,
+ "value" : "a device attribute change item value"
+ } ],
+ "type" : "DeviceCreatedEvent"
+} |
+
+
+ | Field name |
+ Field description |
+
+
+
+ | deviceAttributes |
+ Compatible device attributes |
+
+
+
+ | deviceURL |
+ Device URL |
+
+
+
+ | owningPartners |
+ Owning partners of the parent entity (setup, ...)) . only available in event streams |
+
+
+
+ | setupOID |
+ Setup OID |
+
+
+
+ | siteOID |
+ Site OID |
+
+
@@ -14782,7 +15556,7 @@ Generated events on method call
Return an URL to use for Eliot authentication. At the end of the authentication process, the user will be redirected to the given {redirectURL}
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -14988,7 +15762,7 @@
Return next available EnOcean device address for a given device type
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -15165,7 +15939,7 @@
Start an EnOcean learning device procedure (pair a new device indicating the device reference). Useful for devices using generic profiles (require a manual specification).
DEPRECATED: use commands on enocean stack
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -15253,7 +16027,7 @@
Generated events on method call
- EnOceanBadDeviceStimulationEvent
+ EnOceanLearnModeTimeoutEvent
| Description |
|
@@ -15262,10 +16036,12 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
+ "setupOID" : "a setup OID",
"owningPartner" : "an owning partner",
"gatewayId" : "A gateway id (ex: 0101-1234-5678)",
- "name" : "EnOceanBadDeviceStimulationEvent"
+ "type" : "EnOceanLearnModeTimeoutEvent"
} |
@@ -15283,6 +16059,16 @@ Generated events on method call
Owning partner of the parent entity (gateway, setup group, ...)) . only available in event streams |
+
+ | setupOID |
+ Setup OID |
+
+
+
+ | siteOID |
+ Site OID |
+
+
@@ -15296,10 +16082,12 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
+ "setupOID" : "a setup OID",
"owningPartner" : "an owning partner",
"gatewayId" : "A gateway id (ex: 0101-1234-5678)",
- "name" : "EnOceanLearnStartedEvent"
+ "type" : "EnOceanLearnStartedEvent"
} |
@@ -15317,38 +16105,14 @@ Generated events on method call
Owning partner of the parent entity (gateway, setup group, ...)) . only available in event streams |
-
-
-
-
- EnOceanLearnModeTimeoutEvent
-
- | Description |
- |
-
-
-
- | JSON |
- {
- "timestamp" : 2,
- "owningPartner" : "an owning partner",
- "gatewayId" : "A gateway id (ex: 0101-1234-5678)",
- "name" : "EnOceanLearnModeTimeoutEvent"
-} |
-
-
- | Field name |
- Field description |
-
-
- | gatewayId |
- Gateway id |
+ setupOID |
+ Setup OID |
- | owningPartner |
- Owning partner of the parent entity (gateway, setup group, ...)) . only available in event streams |
+ siteOID |
+ Site OID |
@@ -15364,9 +16128,10 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
"controllableName" : "a controllable name",
"label" : "a device created event label",
@@ -15377,7 +16142,7 @@ Generated events on method call
"type" : 1,
"value" : "a device attribute change item value"
} ],
- "name" : "DeviceCreatedEvent"
+ "type" : "DeviceCreatedEvent"
} |
@@ -15405,6 +16170,57 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
+
+
+
+
+ EnOceanBadDeviceStimulationEvent
+
+ | Description |
+ |
+
+
+
+ | JSON |
+ {
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
+ "setupOID" : "a setup OID",
+ "owningPartner" : "an owning partner",
+ "gatewayId" : "A gateway id (ex: 0101-1234-5678)",
+ "type" : "EnOceanBadDeviceStimulationEvent"
+} |
+
+
+ | Field name |
+ Field description |
+
+
+
+ | gatewayId |
+ Gateway id |
+
+
+
+ | owningPartner |
+ Owning partner of the parent entity (gateway, setup group, ...)) . only available in event streams |
+
+
+
+ | setupOID |
+ Setup OID |
+
+
+
+ | siteOID |
+ Site OID |
+
+
@@ -15583,7 +16399,7 @@ Generated events on method call
Start an EnOcean learning procedure.
DEPRECATED: use commands on enocean stack
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -15673,6 +16489,52 @@ Generated events on method call
Generated events on method call
+
+ EnOceanLearnModeTimeoutEvent
+
+ | Description |
+ |
+
+
+
+ | JSON |
+ {
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
+ "setupOID" : "a setup OID",
+ "owningPartner" : "an owning partner",
+ "gatewayId" : "A gateway id (ex: 0101-1234-5678)",
+ "type" : "EnOceanLearnModeTimeoutEvent"
+} |
+
+
+ | Field name |
+ Field description |
+
+
+
+ | gatewayId |
+ Gateway id |
+
+
+
+ | owningPartner |
+ Owning partner of the parent entity (gateway, setup group, ...)) . only available in event streams |
+
+
+
+ | setupOID |
+ Setup OID |
+
+
+
+ | siteOID |
+ Site OID |
+
+
+
+
+
EnOceanLearnStartedEvent
@@ -15683,10 +16545,12 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
+ "setupOID" : "a setup OID",
"owningPartner" : "an owning partner",
"gatewayId" : "A gateway id (ex: 0101-1234-5678)",
- "name" : "EnOceanLearnStartedEvent"
+ "type" : "EnOceanLearnStartedEvent"
} |
@@ -15704,11 +16568,21 @@ Generated events on method call
Owning partner of the parent entity (gateway, setup group, ...)) . only available in event streams |
+
+ | setupOID |
+ Setup OID |
+
+
+
+ | siteOID |
+ Site OID |
+
+
- EnOceanLearnModeTimeoutEvent
+ EnOceanBadDeviceStimulationEvent
| Description |
|
@@ -15717,10 +16591,12 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
+ "setupOID" : "a setup OID",
"owningPartner" : "an owning partner",
"gatewayId" : "A gateway id (ex: 0101-1234-5678)",
- "name" : "EnOceanLearnModeTimeoutEvent"
+ "type" : "EnOceanBadDeviceStimulationEvent"
} |
@@ -15738,6 +16614,16 @@ Generated events on method call
Owning partner of the parent entity (gateway, setup group, ...)) . only available in event streams |
+
+ | setupOID |
+ Setup OID |
+
+
+
+ | siteOID |
+ Site OID |
+
+
@@ -15751,9 +16637,10 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
"controllableName" : "a controllable name",
"label" : "a device created event label",
@@ -15764,7 +16651,7 @@ Generated events on method call
"type" : 1,
"value" : "a device attribute change item value"
} ],
- "name" : "DeviceCreatedEvent"
+ "type" : "DeviceCreatedEvent"
} |
@@ -15792,38 +16679,9 @@ Generated events on method call
Setup OID |
-
-
-
-
- EnOceanBadDeviceStimulationEvent
-
- | Description |
- |
-
-
-
- | JSON |
- {
- "timestamp" : 2,
- "owningPartner" : "an owning partner",
- "gatewayId" : "A gateway id (ex: 0101-1234-5678)",
- "name" : "EnOceanBadDeviceStimulationEvent"
-} |
-
-
- | Field name |
- Field description |
-
-
-
- | gatewayId |
- Gateway id |
-
-
- | owningPartner |
- Owning partner of the parent entity (gateway, setup group, ...)) . only available in event streams |
+ siteOID |
+ Site OID |
@@ -15893,7 +16751,7 @@ Generated events on method call
Stop the EnOcean learning procedure.
DEPRECATED: use commands on enocean stack
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -15975,10 +16833,12 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
+ "setupOID" : "a setup OID",
"owningPartner" : "an owning partner",
"gatewayId" : "A gateway id (ex: 0101-1234-5678)",
- "name" : "EnOceanLearnStoppedEvent"
+ "type" : "EnOceanLearnStoppedEvent"
} |
@@ -15996,6 +16856,16 @@ Generated events on method call
Owning partner of the parent entity (gateway, setup group, ...)) . only available in event streams |
+
+ | setupOID |
+ Setup OID |
+
+
+
+ | siteOID |
+ Site OID |
+
+
@@ -16091,7 +16961,7 @@
Deprecated, use the discoverActuators command on the stack device. Start the IO actuators discover full procedure (discover actuators that share the same key and actuators that are in config state)
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -16202,9 +17072,10 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
"controllableName" : "a controllable name",
"label" : "a device created event label",
@@ -16215,7 +17086,7 @@ Generated events on method call
"type" : 1,
"value" : "a device attribute change item value"
} ],
- "name" : "DeviceCreatedEvent"
+ "type" : "DeviceCreatedEvent"
} |
@@ -16243,6 +17114,11 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
@@ -16256,27 +17132,33 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"execId" : "an exec id",
"newState" : "IN_PROGRESS",
"ownerKey" : "an owner key",
- "type" : 1,
+ "executionType" : 1,
"subType" : 1,
"oldState" : "TRANSMITTED",
"timeToNextState" : 2,
"failedCommands" : [ {
"deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
"detailedStatus" : {
+ "type" : "generic-error",
"message" : "a message",
"error" : true
},
"rank" : 1,
"failureType" : "NON_EXECUTING"
} ],
+ "relatedDevices" : [ {
+ "deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])"
+ } ],
+ "technical" : false,
"failureTypeCode" : 11,
- "name" : "ExecutionStateChangedEvent",
+ "type" : "ExecutionStateChangedEvent",
"failureType" : "NON_EXECUTING"
} |
@@ -16290,6 +17172,11 @@ Generated events on method call
Execution id |
+
+ | executionType |
+ Execution type |
+
+
| failedCommands |
List of failed commands |
@@ -16320,11 +17207,21 @@ Generated events on method call
Owning partners of the parent entity (setup, ...)) . only available in event streams |
+
+ | relatedDevices |
+ List of devices involved in this execution |
+
+
| setupOID |
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
| subType |
Execution sub type |
@@ -16335,11 +17232,6 @@ Generated events on method call
Remaining time until next execution state |
-
- | type |
- Execution type |
-
-
@@ -16353,16 +17245,17 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
"deviceStates" : [ {
"name" : "a device state change item name",
"type" : 1,
"value" : "a device state change item value"
} ],
- "name" : "DeviceStateChangedEvent"
+ "type" : "DeviceStateChangedEvent"
} |
@@ -16390,6 +17283,11 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
@@ -16456,7 +17354,7 @@ Generated events on method call
Deprecated, use discover/simple instead. Start the IO actuators discover simple procedure (discover only actuators that are in config state)
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -16557,56 +17455,6 @@ Generated events on method call
Generated events on method call
-
- DeviceStateChangedEvent
-
- | Description |
- One or more states of a device have changed (high-level) |
-
-
-
- | JSON |
- {
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
- "setupOID" : "a setup OID",
- "deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
- "deviceStates" : [ {
- "name" : "a device state change item name",
- "type" : 1,
- "value" : "a device state change item value"
- } ],
- "name" : "DeviceStateChangedEvent"
-} |
-
-
- | Field name |
- Field description |
-
-
-
- | deviceStates |
- Updated device states |
-
-
-
- | deviceURL |
- Device URL |
-
-
-
- | owningPartners |
- Owning partners of the parent entity (setup, ...)) . only available in event streams |
-
-
-
- | setupOID |
- Setup OID |
-
-
-
-
-
DeviceCreatedEvent
@@ -16617,9 +17465,10 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
"controllableName" : "a controllable name",
"label" : "a device created event label",
@@ -16630,7 +17479,7 @@ Generated events on method call
"type" : 1,
"value" : "a device attribute change item value"
} ],
- "name" : "DeviceCreatedEvent"
+ "type" : "DeviceCreatedEvent"
} |
@@ -16658,172 +17507,13 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- | POST |
-
-
-
- Actuators [DEPRECATED]
- since version 2020.6
-
-
-
- |
-
-
-
- /config/{gatewayId}/io/discover/inSystem
-
-
-
- |
- application/json |
-
-
- |
-
-
- Deprecated, use the discoverActuators command on the stack device. Start the IO actuators discover in system procedure (discover only actuators that share the same system key)
-
- Access scope : Full enduser API access (enduser/*)
- > Test operation
- |
-
-
- |
-
-
-
-
-
- Parameters
-
- | Type |
- Name |
- Value |
- Description |
-
-
-
- |
- Path Variable
- |
-
- gatewayId
- |
- "string value" |
-
-
-
- The gateway ID
- |
-
-
-
-
-
-
-
-
- Response
-
- | Type |
- Name |
- Value |
- Description |
-
-
-
- |
- Response Body
- |
-
- (JSON)
- |
- {
- "execId" : "string value"
-} |
-
-
-
-
- |
-
-
-
-
-
-
-
-
- HTTP Status Code
-
- | Code |
- Message |
- Meaning |
-
-
-
- |
- 200
- |
- OK |
-
- The request has succeeded
- |
-
-
-
-
-
-
-
-
- Generated events on method call
+ |
DeviceStateChangedEvent
@@ -16835,16 +17525,17 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
"deviceStates" : [ {
"name" : "a device state change item name",
"type" : 1,
"value" : "a device state change item value"
} ],
- "name" : "DeviceStateChangedEvent"
+ "type" : "DeviceStateChangedEvent"
} |
@@ -16872,58 +17563,9 @@ Generated events on method call
Setup OID |
-
-
-
-
- DeviceCreatedEvent
-
- | Description |
- A new device has been added to the setup |
-
-
-
- | JSON |
- {
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
- "setupOID" : "a setup OID",
- "deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
- "controllableName" : "a controllable name",
- "label" : "a device created event label",
- "placeOID" : "a place OID",
- "metadata" : "some metadata",
- "deviceAttributes" : [ {
- "name" : "a device attribute change item name",
- "type" : 1,
- "value" : "a device attribute change item value"
- } ],
- "name" : "DeviceCreatedEvent"
-} |
-
-
- | Field name |
- Field description |
-
-
- | deviceAttributes |
- Compatible device attributes |
-
-
-
- | deviceURL |
- Device URL |
-
-
-
- | owningPartners |
- Owning partners of the parent entity (setup, ...)) . only available in event streams |
-
-
-
- | setupOID |
- Setup OID |
+ siteOID |
+ Site OID |
@@ -16973,7 +17615,7 @@ Generated events on method call
- /config/{gatewayId}/io/discover/simple
+ /config/{gatewayId}/io/discover/inSystem
@@ -16990,10 +17632,10 @@ Generated events on method call
| |
- Deprecated, use the discoverActuators command on the stack device. Start the IO actuators discover simple procedure (discover only actuators that are in config state)
+ Deprecated, use the discoverActuators command on the stack device. Start the IO actuators discover in system procedure (discover only actuators that share the same system key)
- Access scope : Full enduser API access (enduser/*)
- > Test operation
+ Access scope : enduser/*
+ > Test operation
|
@@ -17103,16 +17745,17 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
"deviceStates" : [ {
"name" : "a device state change item name",
"type" : 1,
"value" : "a device state change item value"
} ],
- "name" : "DeviceStateChangedEvent"
+ "type" : "DeviceStateChangedEvent"
} |
@@ -17140,6 +17783,11 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
@@ -17153,9 +17801,10 @@ Generated events on method call
|
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
"controllableName" : "a controllable name",
"label" : "a device created event label",
@@ -17166,7 +17815,7 @@ Generated events on method call
"type" : 1,
"value" : "a device attribute change item value"
} ],
- "name" : "DeviceCreatedEvent"
+ "type" : "DeviceCreatedEvent"
} |
@@ -17194,6 +17843,11 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
@@ -17212,7 +17866,7 @@ Generated events on method call
-
+
Generated events on method call
">
+ Actuators [DEPRECATED]
+ since version 2020.6
- Actuators
|
+ /config/{gatewayId}/io/discover/simple
- /config/{gatewayId}/io/setConfigState
|
@@ -17257,10 +17912,10 @@ Generated events on method call
|
- This operation allows to set configuration state of one or more IO node
+ Deprecated, use the discoverActuators command on the stack device. Start the IO actuators discover simple procedure (discover only actuators that are in config state)
- Access scope : Full enduser API access (enduser/*)
- > Test operation
+ Access scope : enduser/*
+ > Test operation
|
@@ -17293,25 +17948,6 @@ Generated events on method call
-
- |
- Request Body
- |
-
- (JSON)
- |
- {
- "actuatorAddresses" : [ "some actuator addresses" ],
- "searchForController" : false,
- "state" : 1
-} |
-
-
-
- Options
- |
-
-
@@ -17377,6 +18013,125 @@ Generated events on method call
+ Generated events on method call
+
+
+ DeviceCreatedEvent
+
+ | Description |
+ A new device has been added to the setup |
+
+
+
+ | JSON |
+ {
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
+ "setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
+ "deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
+ "controllableName" : "a controllable name",
+ "label" : "a device created event label",
+ "placeOID" : "a place OID",
+ "metadata" : "some metadata",
+ "deviceAttributes" : [ {
+ "name" : "a device attribute change item name",
+ "type" : 1,
+ "value" : "a device attribute change item value"
+ } ],
+ "type" : "DeviceCreatedEvent"
+} |
+
+
+ | Field name |
+ Field description |
+
+
+
+ | deviceAttributes |
+ Compatible device attributes |
+
+
+
+ | deviceURL |
+ Device URL |
+
+
+
+ | owningPartners |
+ Owning partners of the parent entity (setup, ...)) . only available in event streams |
+
+
+
+ | setupOID |
+ Setup OID |
+
+
+
+ | siteOID |
+ Site OID |
+
+
+
+
+
+
+ DeviceStateChangedEvent
+
+ | Description |
+ One or more states of a device have changed (high-level) |
+
+
+
+ | JSON |
+ {
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
+ "setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
+ "deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
+ "deviceStates" : [ {
+ "name" : "a device state change item name",
+ "type" : 1,
+ "value" : "a device state change item value"
+ } ],
+ "type" : "DeviceStateChangedEvent"
+} |
+
+
+ | Field name |
+ Field description |
+
+
+
+ | deviceStates |
+ Updated device states |
+
+
+
+ | deviceURL |
+ Device URL |
+
+
+
+ | owningPartners |
+ Owning partners of the parent entity (setup, ...)) . only available in event streams |
+
+
+
+ | setupOID |
+ Setup OID |
+
+
+
+ | siteOID |
+ Site OID |
+
+
+
+
+
+
@@ -17412,7 +18167,7 @@ Generated events on method call
- Atlantic
+ Actuators
|
@@ -17420,7 +18175,7 @@ Generated events on method call
- /config/{gatewayId}/io/atlantic/twinningExit/{deviceAddress}
+ /config/{gatewayId}/io/setConfigState
@@ -17436,10 +18191,10 @@ Generated events on method call
|
- This operation forces a device to stop twinning procedure (only supported by Atlantic Electrical heater with adjustable temperature setpoint devices)
+ This operation allows to set configuration state of one or more IO node
- Access scope : Full enduser API access (enduser/*)
- > Test operation
+ Access scope : enduser/*
+ > Test operation
|
@@ -17474,16 +18229,20 @@ Generated events on method call
|
- Path Variable
+ Request Body
|
- deviceAddress
+ (JSON)
|
- "string value" |
+ {
+ "actuatorAddresses" : [ "some actuator addresses" ],
+ "searchForController" : false,
+ "state" : 1
+} |
- The device address (must be an Atlantic Electrical heater with adjustable temperature setpoint device)
+ Options
|
@@ -17587,7 +18346,7 @@ Generated events on method call
- Controller
+ Atlantic
@@ -17595,7 +18354,7 @@ Generated events on method call
- /config/{gatewayId}/io/controller/{controllerAddress}/sendSystemTable
+ /config/{gatewayId}/io/atlantic/twinningExit/{deviceAddress}
@@ -17611,10 +18370,10 @@ Generated events on method call
|
- This operation allows to send a system table to a controller
+ This operation forces a device to stop twinning procedure (only supported by Atlantic Electrical heater with adjustable temperature setpoint devices)
- Access scope : Full enduser API access (enduser/*)
- > Test operation
+ Access scope : enduser/*
+ > Test operation
|
@@ -17652,31 +18411,206 @@ Generated events on method call
Path Variable
- controllerAddress
+ deviceAddress
|
"string value" |
- Controller address (or an associated actuator address for multi-node systems)
- |
-
-
-
- |
- Request Body
- |
-
- (JSON)
- |
- {
- "actuatorAddresses" : [ "some actuator addresses" ],
- "sendStackMaster" : false
-} |
-
-
-
- Options
+ The device address (must be an Atlantic Electrical heater with adjustable temperature setpoint device)
+ |
+
+
+
+
+
+
+
+
+ Response
+
+ | Type |
+ Name |
+ Value |
+ Description |
+
+
+
+ |
+ Response Body
+ |
+
+ (JSON)
+ |
+ {
+ "execId" : "string value"
+} |
+
+
+
+
+ |
+
+
+
+
+
+
+
+
+ HTTP Status Code
+
+ | Code |
+ Message |
+ Meaning |
+
+
+
+ |
+ 200
+ |
+ OK |
+
+ The request has succeeded
+ |
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ | POST |
+
+
+
+
+ Controller
+
+
+ |
+
+
+
+
+ /config/{gatewayId}/io/controller/{controllerAddress}/sendSystemTable
+
+
+ |
+ application/json |
+
+
+ |
+
+
+ This operation allows to send a system table to a controller
+
+ Access scope : enduser/*
+ > Test operation
+ |
+
+
+ |
+
+
+
+
+
+ Parameters
+
+ | Type |
+ Name |
+ Value |
+ Description |
+
+
+
+ |
+ Path Variable
+ |
+
+ gatewayId
+ |
+ "string value" |
+
+
+
+ The gateway ID
+ |
+
+
+
+ |
+ Path Variable
+ |
+
+ controllerAddress
+ |
+ "string value" |
+
+
+
+ Controller address (or an associated actuator address for multi-node systems)
+ |
+
+
+
+ |
+ Request Body
+ |
+
+ (JSON)
+ |
+ {
+ "actuatorAddresses" : [ "some actuator addresses" ],
+ "sendStackMaster" : false
+} |
+
+
+
+ Options
|
@@ -17806,7 +18740,7 @@ Generated events on method call
This operation asks the device to open itself in RCM
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -17932,27 +18866,33 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"execId" : "an exec id",
"newState" : "IN_PROGRESS",
"ownerKey" : "an owner key",
- "type" : 1,
+ "executionType" : 1,
"subType" : 1,
"oldState" : "TRANSMITTED",
"timeToNextState" : 2,
"failedCommands" : [ {
"deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
"detailedStatus" : {
+ "type" : "generic-error",
"message" : "a message",
"error" : true
},
"rank" : 1,
"failureType" : "NON_EXECUTING"
} ],
+ "relatedDevices" : [ {
+ "deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])"
+ } ],
+ "technical" : false,
"failureTypeCode" : 11,
- "name" : "ExecutionStateChangedEvent",
+ "type" : "ExecutionStateChangedEvent",
"failureType" : "NON_EXECUTING"
} |
@@ -17966,6 +18906,11 @@ Generated events on method call
Execution id |
+
+ | executionType |
+ Execution type |
+
+
| failedCommands |
List of failed commands |
@@ -17996,11 +18941,21 @@ Generated events on method call
Owning partners of the parent entity (setup, ...)) . only available in event streams |
+
+ | relatedDevices |
+ List of devices involved in this execution |
+
+
| setupOID |
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
| subType |
Execution sub type |
@@ -18011,11 +18966,6 @@ Generated events on method call
Remaining time until next execution state |
-
- | type |
- Execution type |
-
-
@@ -18081,7 +19031,7 @@ Generated events on method call
Set the settings of a IO gas pulse sensor
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
|
@@ -18275,7 +19225,7 @@ Generated events on method call
Start the IO generic pulse sensor discover procedure
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -18406,56 +19356,6 @@ Generated events on method call
Generated events on method call
-
- DeviceStateChangedEvent
-
- | Description |
- One or more states of a device have changed (high-level) |
-
-
-
- | JSON |
- {
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
- "setupOID" : "a setup OID",
- "deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
- "deviceStates" : [ {
- "name" : "a device state change item name",
- "type" : 1,
- "value" : "a device state change item value"
- } ],
- "name" : "DeviceStateChangedEvent"
-} |
-
-
- | Field name |
- Field description |
-
-
-
- | deviceStates |
- Updated device states |
-
-
-
- | deviceURL |
- Device URL |
-
-
-
- | owningPartners |
- Owning partners of the parent entity (setup, ...)) . only available in event streams |
-
-
-
- | setupOID |
- Setup OID |
-
-
-
-
-
DeviceCreatedEvent
@@ -18466,9 +19366,10 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
"controllableName" : "a controllable name",
"label" : "a device created event label",
@@ -18479,7 +19380,7 @@ Generated events on method call
"type" : 1,
"value" : "a device attribute change item value"
} ],
- "name" : "DeviceCreatedEvent"
+ "type" : "DeviceCreatedEvent"
} |
@@ -18507,6 +19408,11 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
@@ -18520,27 +19426,33 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"execId" : "an exec id",
"newState" : "IN_PROGRESS",
"ownerKey" : "an owner key",
- "type" : 1,
+ "executionType" : 1,
"subType" : 1,
"oldState" : "TRANSMITTED",
"timeToNextState" : 2,
"failedCommands" : [ {
"deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
"detailedStatus" : {
+ "type" : "generic-error",
"message" : "a message",
"error" : true
},
"rank" : 1,
"failureType" : "NON_EXECUTING"
} ],
+ "relatedDevices" : [ {
+ "deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])"
+ } ],
+ "technical" : false,
"failureTypeCode" : 11,
- "name" : "ExecutionStateChangedEvent",
+ "type" : "ExecutionStateChangedEvent",
"failureType" : "NON_EXECUTING"
} |
@@ -18554,6 +19466,11 @@ Generated events on method call
Execution id |
+
+ | executionType |
+ Execution type |
+
+
| failedCommands |
List of failed commands |
@@ -18584,11 +19501,21 @@ Generated events on method call
Owning partners of the parent entity (setup, ...)) . only available in event streams |
+
+ | relatedDevices |
+ List of devices involved in this execution |
+
+
| setupOID |
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
| subType |
Execution sub type |
@@ -18599,9 +19526,60 @@ Generated events on method call
Remaining time until next execution state |
+
+
+
+
+ DeviceStateChangedEvent
+
+ | Description |
+ One or more states of a device have changed (high-level) |
+
+
+
+ | JSON |
+ {
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
+ "setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
+ "deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
+ "deviceStates" : [ {
+ "name" : "a device state change item name",
+ "type" : 1,
+ "value" : "a device state change item value"
+ } ],
+ "type" : "DeviceStateChangedEvent"
+} |
+
+
+ | Field name |
+ Field description |
+
+
- | type |
- Execution type |
+ deviceStates |
+ Updated device states |
+
+
+
+ | deviceURL |
+ Device URL |
+
+
+
+ | owningPartners |
+ Owning partners of the parent entity (setup, ...)) . only available in event streams |
+
+
+
+ | setupOID |
+ Setup OID |
+
+
+
+ | siteOID |
+ Site OID |
@@ -18745,7 +19723,7 @@ Generated events on method call
Deprecated : use POST on config/{gatewayId}/io/propagateTransferKey. This operation allows to retrieve the IO security key from a control point with feedback function and to send it to the entire installation
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -18845,27 +19823,33 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"execId" : "an exec id",
"newState" : "IN_PROGRESS",
"ownerKey" : "an owner key",
- "type" : 1,
+ "executionType" : 1,
"subType" : 1,
"oldState" : "TRANSMITTED",
"timeToNextState" : 2,
"failedCommands" : [ {
"deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
"detailedStatus" : {
+ "type" : "generic-error",
"message" : "a message",
"error" : true
},
"rank" : 1,
"failureType" : "NON_EXECUTING"
} ],
+ "relatedDevices" : [ {
+ "deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])"
+ } ],
+ "technical" : false,
"failureTypeCode" : 11,
- "name" : "ExecutionStateChangedEvent",
+ "type" : "ExecutionStateChangedEvent",
"failureType" : "NON_EXECUTING"
} |
@@ -18879,6 +19863,11 @@ Generated events on method call
Execution id |
+
+ | executionType |
+ Execution type |
+
+
| failedCommands |
List of failed commands |
@@ -18909,11 +19898,21 @@ Generated events on method call
Owning partners of the parent entity (setup, ...)) . only available in event streams |
+
+ | relatedDevices |
+ List of devices involved in this execution |
+
+
| setupOID |
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
| subType |
Execution sub type |
@@ -18924,11 +19923,6 @@ Generated events on method call
Remaining time until next execution state |
-
- | type |
- Execution type |
-
-
@@ -18995,7 +19989,7 @@ Generated events on method call
Deprecated, use the resetNetworkSecurity on the stack device. This operation allows to change the IO security key in the box unit and to send this new key to the entire installation
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
|
@@ -19106,27 +20100,33 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"execId" : "an exec id",
"newState" : "IN_PROGRESS",
"ownerKey" : "an owner key",
- "type" : 1,
+ "executionType" : 1,
"subType" : 1,
"oldState" : "TRANSMITTED",
"timeToNextState" : 2,
"failedCommands" : [ {
"deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
"detailedStatus" : {
+ "type" : "generic-error",
"message" : "a message",
"error" : true
},
"rank" : 1,
"failureType" : "NON_EXECUTING"
} ],
+ "relatedDevices" : [ {
+ "deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])"
+ } ],
+ "technical" : false,
"failureTypeCode" : 11,
- "name" : "ExecutionStateChangedEvent",
+ "type" : "ExecutionStateChangedEvent",
"failureType" : "NON_EXECUTING"
} |
@@ -19140,6 +20140,11 @@ Generated events on method call
Execution id |
+
+ | executionType |
+ Execution type |
+
+
| failedCommands |
List of failed commands |
@@ -19170,11 +20175,21 @@ Generated events on method call
Owning partners of the parent entity (setup, ...)) . only available in event streams |
+
+ | relatedDevices |
+ List of devices involved in this execution |
+
+
| setupOID |
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
| subType |
Execution sub type |
@@ -19185,11 +20200,6 @@ Generated events on method call
Remaining time until next execution state |
-
- | type |
- Execution type |
-
-
@@ -19255,7 +20265,7 @@ Generated events on method call
This operation allows to retrieve the IO security key from a control point with feedback function and to send it to the entire installation
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -19384,27 +20394,33 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"execId" : "an exec id",
"newState" : "IN_PROGRESS",
"ownerKey" : "an owner key",
- "type" : 1,
+ "executionType" : 1,
"subType" : 1,
"oldState" : "TRANSMITTED",
"timeToNextState" : 2,
"failedCommands" : [ {
"deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
"detailedStatus" : {
+ "type" : "generic-error",
"message" : "a message",
"error" : true
},
"rank" : 1,
"failureType" : "NON_EXECUTING"
} ],
+ "relatedDevices" : [ {
+ "deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])"
+ } ],
+ "technical" : false,
"failureTypeCode" : 11,
- "name" : "ExecutionStateChangedEvent",
+ "type" : "ExecutionStateChangedEvent",
"failureType" : "NON_EXECUTING"
} |
@@ -19418,6 +20434,11 @@ Generated events on method call
Execution id |
+
+ | executionType |
+ Execution type |
+
+
| failedCommands |
List of failed commands |
@@ -19448,11 +20469,21 @@ Generated events on method call
Owning partners of the parent entity (setup, ...)) . only available in event streams |
+
+ | relatedDevices |
+ List of devices involved in this execution |
+
+
| setupOID |
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
| subType |
Execution sub type |
@@ -19463,11 +20494,6 @@ Generated events on method call
Remaining time until next execution state |
-
- | type |
- Execution type |
-
-
@@ -19533,7 +20559,7 @@ Generated events on method call
This operation allows to send the current IO security key
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -19615,11 +20641,13 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
+ "setupOID" : "a setup OID",
"owningPartner" : "an owning partner",
"gatewayId" : "A gateway id (ex: 0101-1234-5678)",
"protocolType" : 1,
- "name" : "IOChangedKeyEvent"
+ "type" : "IOChangedKeyEvent"
} |
@@ -19642,6 +20670,16 @@ Generated events on method call
Device protocol type |
+
+ | setupOID |
+ Setup OID |
+
+
+
+ | siteOID |
+ Site OID |
+
+
@@ -19707,7 +20745,7 @@ Generated events on method call
This operation allows to send the current IO security key to specified devices
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -19833,27 +20871,33 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"execId" : "an exec id",
"newState" : "IN_PROGRESS",
"ownerKey" : "an owner key",
- "type" : 1,
+ "executionType" : 1,
"subType" : 1,
"oldState" : "TRANSMITTED",
"timeToNextState" : 2,
"failedCommands" : [ {
"deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
"detailedStatus" : {
+ "type" : "generic-error",
"message" : "a message",
"error" : true
},
"rank" : 1,
"failureType" : "NON_EXECUTING"
} ],
+ "relatedDevices" : [ {
+ "deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])"
+ } ],
+ "technical" : false,
"failureTypeCode" : 11,
- "name" : "ExecutionStateChangedEvent",
+ "type" : "ExecutionStateChangedEvent",
"failureType" : "NON_EXECUTING"
} |
@@ -19867,6 +20911,11 @@ Generated events on method call
Execution id |
+
+ | executionType |
+ Execution type |
+
+
| failedCommands |
List of failed commands |
@@ -19897,11 +20946,21 @@ Generated events on method call
Owning partners of the parent entity (setup, ...)) . only available in event streams |
+
+ | relatedDevices |
+ List of devices involved in this execution |
+
+
| setupOID |
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
| subType |
Execution sub type |
@@ -19912,11 +20971,6 @@ Generated events on method call
Remaining time until next execution state |
-
- | type |
- Execution type |
-
-
@@ -19983,7 +21037,7 @@ Generated events on method call
Deprecated, use the shareNetwork command on the stack device. This operation allows to send the installation IO security key to an IO control point with feedback function
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -20094,27 +21148,33 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"execId" : "an exec id",
"newState" : "IN_PROGRESS",
"ownerKey" : "an owner key",
- "type" : 1,
+ "executionType" : 1,
"subType" : 1,
"oldState" : "TRANSMITTED",
"timeToNextState" : 2,
"failedCommands" : [ {
"deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
"detailedStatus" : {
+ "type" : "generic-error",
"message" : "a message",
"error" : true
},
"rank" : 1,
"failureType" : "NON_EXECUTING"
} ],
+ "relatedDevices" : [ {
+ "deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])"
+ } ],
+ "technical" : false,
"failureTypeCode" : 11,
- "name" : "ExecutionStateChangedEvent",
+ "type" : "ExecutionStateChangedEvent",
"failureType" : "NON_EXECUTING"
} |
@@ -20128,6 +21188,11 @@ Generated events on method call
Execution id |
+
+ | executionType |
+ Execution type |
+
+
| failedCommands |
List of failed commands |
@@ -20158,11 +21223,21 @@ Generated events on method call
Owning partners of the parent entity (setup, ...)) . only available in event streams |
+
+ | relatedDevices |
+ List of devices involved in this execution |
+
+
| setupOID |
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
| subType |
Execution sub type |
@@ -20173,11 +21248,6 @@ Generated events on method call
Remaining time until next execution state |
-
- | type |
- Execution type |
-
-
@@ -20244,7 +21314,7 @@ Generated events on method call
This operation allows to send the installation IO security key to an IO control point with feedback function
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -20370,27 +21440,33 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"execId" : "an exec id",
"newState" : "IN_PROGRESS",
"ownerKey" : "an owner key",
- "type" : 1,
+ "executionType" : 1,
"subType" : 1,
"oldState" : "TRANSMITTED",
"timeToNextState" : 2,
"failedCommands" : [ {
"deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
"detailedStatus" : {
+ "type" : "generic-error",
"message" : "a message",
"error" : true
},
"rank" : 1,
"failureType" : "NON_EXECUTING"
} ],
+ "relatedDevices" : [ {
+ "deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])"
+ } ],
+ "technical" : false,
"failureTypeCode" : 11,
- "name" : "ExecutionStateChangedEvent",
+ "type" : "ExecutionStateChangedEvent",
"failureType" : "NON_EXECUTING"
} |
@@ -20404,6 +21480,11 @@ Generated events on method call
Execution id |
+
+ | executionType |
+ Execution type |
+
+
| failedCommands |
List of failed commands |
@@ -20434,11 +21515,21 @@ Generated events on method call
Owning partners of the parent entity (setup, ...)) . only available in event streams |
+
+ | relatedDevices |
+ List of devices involved in this execution |
+
+
| setupOID |
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
| subType |
Execution sub type |
@@ -20449,11 +21540,6 @@ Generated events on method call
Remaining time until next execution state |
-
- | type |
- Execution type |
-
-
@@ -20520,7 +21606,7 @@ Generated events on method call
Deprecated, use the discover1WayController command on the stack device. Start the IO 1-way remote controller discovery procedure
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -20649,9 +21735,10 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
"controllableName" : "a controllable name",
"label" : "a device created event label",
@@ -20662,7 +21749,7 @@ Generated events on method call
"type" : 1,
"value" : "a device attribute change item value"
} ],
- "name" : "DeviceCreatedEvent"
+ "type" : "DeviceCreatedEvent"
} |
@@ -20690,6 +21777,11 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
@@ -20703,16 +21795,17 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
"deviceStates" : [ {
"name" : "a device state change item name",
"type" : 1,
"value" : "a device state change item value"
} ],
- "name" : "DeviceStateChangedEvent"
+ "type" : "DeviceStateChangedEvent"
} |
@@ -20740,6 +21833,11 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
@@ -20806,7 +21904,7 @@ Generated events on method call
Deprecated, use the discoverSensors command on the stack device. Start the IO sensor discover full procedure (discover sensors that share the same key and sensors that are in config state)
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -20908,25 +22006,30 @@ Generated events on method call
Generated events on method call
- DeviceStateChangedEvent
+ DeviceCreatedEvent
| Description |
- One or more states of a device have changed (high-level) |
+ A new device has been added to the setup |
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
- "deviceStates" : [ {
- "name" : "a device state change item name",
+ "controllableName" : "a controllable name",
+ "label" : "a device created event label",
+ "placeOID" : "a place OID",
+ "metadata" : "some metadata",
+ "deviceAttributes" : [ {
+ "name" : "a device attribute change item name",
"type" : 1,
- "value" : "a device state change item value"
+ "value" : "a device attribute change item value"
} ],
- "name" : "DeviceStateChangedEvent"
+ "type" : "DeviceCreatedEvent"
} |
@@ -20935,8 +22038,8 @@ Generated events on method call
- | deviceStates |
- Updated device states |
+ deviceAttributes |
+ Compatible device attributes |
@@ -20954,33 +22057,35 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
- DeviceCreatedEvent
+ DeviceStateChangedEvent
| Description |
- A new device has been added to the setup |
+ One or more states of a device have changed (high-level) |
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
- "controllableName" : "a controllable name",
- "label" : "a device created event label",
- "placeOID" : "a place OID",
- "metadata" : "some metadata",
- "deviceAttributes" : [ {
- "name" : "a device attribute change item name",
+ "deviceStates" : [ {
+ "name" : "a device state change item name",
"type" : 1,
- "value" : "a device attribute change item value"
+ "value" : "a device state change item value"
} ],
- "name" : "DeviceCreatedEvent"
+ "type" : "DeviceStateChangedEvent"
} |
@@ -20989,8 +22094,8 @@ Generated events on method call
- | deviceAttributes |
- Compatible device attributes |
+ deviceStates |
+ Updated device states |
@@ -21008,6 +22113,11 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
@@ -21074,7 +22184,7 @@ Generated events on method call
Deprecated, use the discoverSensors command on the stack device. Start the IO sensor discover simple procedure (discover only sensors that are in config state)
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -21176,29 +22286,26 @@ Generated events on method call
Generated events on method call
- DeviceCreatedEvent
+ DeviceStateChangedEvent
| Description |
- A new device has been added to the setup |
+ One or more states of a device have changed (high-level) |
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
- "controllableName" : "a controllable name",
- "label" : "a device created event label",
- "placeOID" : "a place OID",
- "metadata" : "some metadata",
- "deviceAttributes" : [ {
- "name" : "a device attribute change item name",
+ "deviceStates" : [ {
+ "name" : "a device state change item name",
"type" : 1,
- "value" : "a device attribute change item value"
+ "value" : "a device state change item value"
} ],
- "name" : "DeviceCreatedEvent"
+ "type" : "DeviceStateChangedEvent"
} |
@@ -21207,8 +22314,8 @@ Generated events on method call
- | deviceAttributes |
- Compatible device attributes |
+ deviceStates |
+ Updated device states |
@@ -21226,29 +22333,39 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
- DeviceStateChangedEvent
+ DeviceCreatedEvent
| Description |
- One or more states of a device have changed (high-level) |
+ A new device has been added to the setup |
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
- "deviceStates" : [ {
- "name" : "a device state change item name",
+ "controllableName" : "a controllable name",
+ "label" : "a device created event label",
+ "placeOID" : "a place OID",
+ "metadata" : "some metadata",
+ "deviceAttributes" : [ {
+ "name" : "a device attribute change item name",
"type" : 1,
- "value" : "a device state change item value"
+ "value" : "a device attribute change item value"
} ],
- "name" : "DeviceStateChangedEvent"
+ "type" : "DeviceCreatedEvent"
} |
@@ -21257,8 +22374,8 @@ Generated events on method call
- | deviceStates |
- Updated device states |
+ deviceAttributes |
+ Compatible device attributes |
@@ -21276,6 +22393,11 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
@@ -21342,7 +22464,7 @@ Generated events on method call
Unsubscribe an IO sensor from the installation
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -21468,27 +22590,33 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"execId" : "an exec id",
"newState" : "IN_PROGRESS",
"ownerKey" : "an owner key",
- "type" : 1,
+ "executionType" : 1,
"subType" : 1,
"oldState" : "TRANSMITTED",
"timeToNextState" : 2,
"failedCommands" : [ {
"deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
"detailedStatus" : {
+ "type" : "generic-error",
"message" : "a message",
"error" : true
},
"rank" : 1,
"failureType" : "NON_EXECUTING"
} ],
+ "relatedDevices" : [ {
+ "deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])"
+ } ],
+ "technical" : false,
"failureTypeCode" : 11,
- "name" : "ExecutionStateChangedEvent",
+ "type" : "ExecutionStateChangedEvent",
"failureType" : "NON_EXECUTING"
} |
@@ -21502,6 +22630,11 @@ Generated events on method call
Execution id |
+
+ | executionType |
+ Execution type |
+
+
| failedCommands |
List of failed commands |
@@ -21532,11 +22665,21 @@ Generated events on method call
Owning partners of the parent entity (setup, ...)) . only available in event streams |
+
+ | relatedDevices |
+ List of devices involved in this execution |
+
+
| setupOID |
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
| subType |
Execution sub type |
@@ -21547,11 +22690,6 @@ Generated events on method call
Remaining time until next execution state |
-
- | type |
- Execution type |
-
-
@@ -21617,7 +22755,7 @@ Generated events on method call
Unsubscribe an IO sensor from the installation
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -21743,27 +22881,33 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"execId" : "an exec id",
"newState" : "IN_PROGRESS",
"ownerKey" : "an owner key",
- "type" : 1,
+ "executionType" : 1,
"subType" : 1,
"oldState" : "TRANSMITTED",
"timeToNextState" : 2,
"failedCommands" : [ {
"deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
"detailedStatus" : {
+ "type" : "generic-error",
"message" : "a message",
"error" : true
},
"rank" : 1,
"failureType" : "NON_EXECUTING"
} ],
+ "relatedDevices" : [ {
+ "deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])"
+ } ],
+ "technical" : false,
"failureTypeCode" : 11,
- "name" : "ExecutionStateChangedEvent",
+ "type" : "ExecutionStateChangedEvent",
"failureType" : "NON_EXECUTING"
} |
@@ -21777,6 +22921,11 @@ Generated events on method call
Execution id |
+
+ | executionType |
+ Execution type |
+
+
| failedCommands |
List of failed commands |
@@ -21807,11 +22956,21 @@ Generated events on method call
Owning partners of the parent entity (setup, ...)) . only available in event streams |
+
+ | relatedDevices |
+ List of devices involved in this execution |
+
+
| setupOID |
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
| subType |
Execution sub type |
@@ -21822,11 +22981,6 @@ Generated events on method call
Remaining time until next execution state |
-
- | type |
- Execution type |
-
-
@@ -21921,7 +23075,7 @@
Import KNX installation file
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -22125,7 +23279,7 @@
Start the Modbus actuators discover procedure
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -22213,21 +23367,24 @@
Generated events on method call
- DiscoverCompleteEvent
+ DiscoverFailedEvent
| Description |
- Discover is complete |
+ Discover has failed |
| JSON |
{
- "timestamp" : 2,
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
+ "setupOID" : "a setup OID",
"owningPartner" : "an owning partner",
"gatewayId" : "A gateway id (ex: 0101-1234-5678)",
"protocolType" : 1,
"ref" : "a ref",
- "name" : "DiscoverCompleteEvent"
+ "type" : "DiscoverFailedEvent",
+ "failureType" : "NON_EXECUTING"
} |
@@ -22235,6 +23392,11 @@ Generated events on method call
Field description |
+
+ | failureType |
+ Failure type |
+
+
| gatewayId |
Gateway id |
@@ -22255,26 +23417,37 @@ Generated events on method call
Reference |
+
+ | setupOID |
+ Setup OID |
+
+
+
+ | siteOID |
+ Site OID |
+
+
- DiscoverFailedEvent
+ DiscoverCompleteEvent
| Description |
- Discover has failed |
+ Discover is complete |
| JSON |
{
- "timestamp" : 2,
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
+ "setupOID" : "a setup OID",
"owningPartner" : "an owning partner",
"gatewayId" : "A gateway id (ex: 0101-1234-5678)",
"protocolType" : 1,
"ref" : "a ref",
- "name" : "DiscoverFailedEvent",
- "failureType" : "NON_EXECUTING"
+ "type" : "DiscoverCompleteEvent"
} |
@@ -22282,11 +23455,6 @@ Generated events on method call
Field description |
-
- | failureType |
- Failure type |
-
-
| gatewayId |
Gateway id |
@@ -22307,6 +23475,16 @@ Generated events on method call
Reference |
+
+ | setupOID |
+ Setup OID |
+
+
+
+ | siteOID |
+ Site OID |
+
+
@@ -22372,7 +23550,7 @@ Generated events on method call
Start the Modbus modules discover procedure
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -22576,7 +23754,7 @@
Return an URL to use for OAuth2 authorization workflow. At the end of the authentication process, the user will be redirected to the given {redirectUrl}
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -22754,7 +23932,7 @@
Start a discovery of a device. Device commissioning key must be passed in request body. Only works on clouds using device-level integration mode.
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -22868,12 +24046,13 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"cloudId" : "a cloud id",
"deviceId" : "a device id",
- "name" : "OGCPDiscoverDeviceCompletedEvent"
+ "type" : "OGCPDiscoverDeviceCompletedEvent"
} |
@@ -22891,6 +24070,11 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
@@ -22904,12 +24088,13 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"cloudId" : "a cloud id",
"deviceId" : "a device id",
- "name" : "OGCPDiscoverDeviceFailedEvent",
+ "type" : "OGCPDiscoverDeviceFailedEvent",
"failureType" : "NON_EXECUTING"
} |
@@ -22928,6 +24113,11 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
@@ -22993,7 +24183,7 @@ Generated events on method call
Start a discovery of a specific site. If multi-sites is not supported, siteId should be 'default'. Only works on clouds using site-level integration mode.
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -23090,12 +24280,13 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"cloudId" : "a cloud id",
"siteId" : "a site id",
- "name" : "OGCPDiscoverSiteFailedEvent",
+ "type" : "OGCPDiscoverSiteFailedEvent",
"failureType" : "NON_EXECUTING"
} |
@@ -23114,6 +24305,11 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
@@ -23127,12 +24323,13 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"cloudId" : "a cloud id",
"siteId" : "a site id",
- "name" : "OGCPDiscoverSiteCompletedEvent"
+ "type" : "OGCPDiscoverSiteCompletedEvent"
} |
@@ -23150,6 +24347,11 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
@@ -23215,7 +24417,7 @@ Generated events on method call
Start a discovery of available sites. Only works on clouds using site-level integration mode and supporting multi-sites per account.
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -23288,21 +24490,25 @@ Generated events on method call
Generated events on method call
- OGCPDiscoverSitesFailedEvent
+ OGCPDiscoverSitesCompletedEvent
| Description |
- A discovery operation of available sites has failed |
+ A discovery operation of available sites has successfully completed |
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"cloudId" : "a cloud id",
- "name" : "OGCPDiscoverSitesFailedEvent",
- "failureType" : "NON_EXECUTING"
+ "sites" : [ {
+ "siteId" : "a site id",
+ "label" : "a OGCPSite reference label"
+ } ],
+ "type" : "OGCPDiscoverSitesCompletedEvent"
} |
@@ -23320,28 +24526,31 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
- OGCPDiscoverSitesCompletedEvent
+ OGCPDiscoverSitesFailedEvent
| Description |
- A discovery operation of available sites has successfully completed |
+ A discovery operation of available sites has failed |
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"cloudId" : "a cloud id",
- "sites" : [ {
- "siteId" : "a site id",
- "label" : "a OGCPSite reference label"
- } ],
- "name" : "OGCPDiscoverSitesCompletedEvent"
+ "type" : "OGCPDiscoverSitesFailedEvent",
+ "failureType" : "NON_EXECUTING"
} |
@@ -23359,6 +24568,11 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
@@ -23424,7 +24638,7 @@ Generated events on method call
Get a list of all available OGCP instances on that server
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -23458,8 +24672,8 @@ Generated events on method call
"authMode" : "OAUTH2_PASSWORD_GRANT",
"eventSupport" : false,
"multiSiteSupport" : false,
- "offerName" : "an offer name",
- "cloudAdapter" : true
+ "cloudAdapter" : true,
+ "offerName" : "an offer name"
} ]
@@ -23563,7 +24777,7 @@ Generated events on method call
Get new oauth tokens from user credentials. Only works on clouds using site-level integration mode
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
|
@@ -23713,7 +24927,7 @@ Generated events on method call
Transmit device pairing informations to the third-party Cloud. Only works on clouds using device-level integration mode and supporting pairing requests.
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -23829,9 +25043,10 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"cloudId" : "a cloud id",
"deviceId" : "a device id",
"commissioningKey" : "a commissioning key",
@@ -23841,7 +25056,7 @@ Generated events on method call
"deviceMetaData" : {
"a device meta data" : "a device meta data"
},
- "name" : "OGCPDevicePairingCompletedEvent"
+ "type" : "OGCPDevicePairingCompletedEvent"
} |
@@ -23859,6 +25074,11 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
@@ -23872,12 +25092,13 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"cloudId" : "a cloud id",
"deviceId" : "a device id",
- "name" : "OGCPDevicePairingFailedEvent",
+ "type" : "OGCPDevicePairingFailedEvent",
"failureType" : "NON_EXECUTING"
} |
@@ -23896,6 +25117,11 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
@@ -23961,7 +25187,7 @@ Generated events on method call
Transmit device pairing informations to the third-party Cloud. Only works on clouds using device-level integration mode and supporting pairing requests.
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -24053,28 +25279,23 @@ Generated events on method call
Generated events on method call
- OGCPDevicePairingCompletedEvent
+ OGCPDevicePairingFailedEvent
| Description |
- A device pairing operation has successfully completed |
+ A device pairing operation has failed |
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"cloudId" : "a cloud id",
"deviceId" : "a device id",
- "commissioningKey" : "a commissioning key",
- "productMetaData" : {
- "a product meta data" : "a product meta data"
- },
- "deviceMetaData" : {
- "a device meta data" : "a device meta data"
- },
- "name" : "OGCPDevicePairingCompletedEvent"
+ "type" : "OGCPDevicePairingFailedEvent",
+ "failureType" : "NON_EXECUTING"
} |
@@ -24092,26 +25313,38 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
- OGCPDevicePairingFailedEvent
+ OGCPDevicePairingCompletedEvent
| Description |
- A device pairing operation has failed |
+ A device pairing operation has successfully completed |
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"cloudId" : "a cloud id",
"deviceId" : "a device id",
- "name" : "OGCPDevicePairingFailedEvent",
- "failureType" : "NON_EXECUTING"
+ "commissioningKey" : "a commissioning key",
+ "productMetaData" : {
+ "a product meta data" : "a product meta data"
+ },
+ "deviceMetaData" : {
+ "a device meta data" : "a device meta data"
+ },
+ "type" : "OGCPDevicePairingCompletedEvent"
} |
@@ -24129,6 +25362,11 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
@@ -24194,7 +25432,7 @@ Generated events on method call
Refresh OAuth2 tokens if necessary
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -24267,21 +25505,21 @@ Generated events on method call
Generated events on method call
- OGCPTokensRefreshFailedEvent
+ OGCPTokensRefreshCompletedEvent
| Description |
- OAuth2 tokens could not be refreshed |
+ OAuth2 tokens were successfully refreshed |
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"cloudId" : "a cloud id",
- "name" : "OGCPTokensRefreshFailedEvent",
- "failureType" : "NON_EXECUTING"
+ "type" : "OGCPTokensRefreshCompletedEvent"
} |
@@ -24299,24 +25537,31 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
- OGCPTokensRefreshCompletedEvent
+ OGCPTokensRefreshFailedEvent
| Description |
- OAuth2 tokens were successfully refreshed |
+ OAuth2 tokens could not be refreshed |
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"cloudId" : "a cloud id",
- "name" : "OGCPTokensRefreshCompletedEvent"
+ "type" : "OGCPTokensRefreshFailedEvent",
+ "failureType" : "NON_EXECUTING"
} |
@@ -24334,6 +25579,11 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
@@ -24428,7 +25678,7 @@
Generate OAuth2 tokens from credentials
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -24514,10 +25764,11 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
- "name" : "OpenDoorsGenerateOAuthTokensFailedEvent",
+ "owningPartners" : [ "some owning partners" ],
+ "type" : "OpenDoorsGenerateOAuthTokensFailedEvent",
"failureType" : "NON_EXECUTING"
} |
@@ -24536,6 +25787,11 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
@@ -24549,10 +25805,11 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
- "name" : "OpenDoorsGenerateOAuthTokensCompletedEvent"
+ "owningPartners" : [ "some owning partners" ],
+ "type" : "OpenDoorsGenerateOAuthTokensCompletedEvent"
} |
@@ -24570,6 +25827,11 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
@@ -24636,7 +25898,7 @@ Generated events on method call
Test an OpenDoors account, create and attach a cloud gateway to the current setup then discover devices on that gateway
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -24758,7 +26020,7 @@ Generated events on method call
Generated events on method call
- OpenDoorsDiscoverCompletedEvent
+ OpenDoorsDiscoverFailedEvent
| Description |
|
@@ -24767,16 +26029,13 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
- "gatewayId" : "a gateway id",
- "candidates" : [ {
- "deviceLabel" : "a device label",
- "deviceAddress" : "a device address",
- "deviceType" : 2
- } ],
- "name" : "OpenDoorsDiscoverCompletedEvent"
+ "owningPartners" : [ "some owning partners" ],
+ "userId" : "a user id",
+ "type" : "OpenDoorsDiscoverFailedEvent",
+ "failureType" : "NON_EXECUTING"
} |
@@ -24785,13 +26044,8 @@ Generated events on method call
- | candidates |
- List of user opendoors devices |
-
-
-
- | gatewayId |
- User login |
+ failureType |
+ Failure type |
@@ -24804,11 +26058,21 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
+
+ | userId |
+ User login |
+
+
- OpenDoorsDiscoverFailedEvent
+ OpenDoorsDiscoverCompletedEvent
| Description |
|
@@ -24817,12 +26081,17 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
- "userId" : "a user id",
- "name" : "OpenDoorsDiscoverFailedEvent",
- "failureType" : "NON_EXECUTING"
+ "owningPartners" : [ "some owning partners" ],
+ "gatewayId" : "a gateway id",
+ "candidates" : [ {
+ "deviceLabel" : "a device label",
+ "deviceAddress" : "a device address",
+ "deviceType" : 2
+ } ],
+ "type" : "OpenDoorsDiscoverCompletedEvent"
} |
@@ -24831,8 +26100,13 @@ Generated events on method call
- | failureType |
- Failure type |
+ candidates |
+ List of user opendoors devices |
+
+
+
+ | gatewayId |
+ User login |
@@ -24846,8 +26120,8 @@ Generated events on method call
- | userId |
- User login |
+ siteOID |
+ Site OID |
@@ -24915,7 +26189,7 @@ Generated events on method call
Test an OpenDoors account, create and attach a cloud gateway to the current setup then discover devices on that gateway
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -25007,7 +26281,7 @@ Generated events on method call
Generated events on method call
- OpenDoorsDiscoverFailedEvent
+ OpenDoorsDiscoverCompletedEvent
| Description |
|
@@ -25016,12 +26290,17 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
- "userId" : "a user id",
- "name" : "OpenDoorsDiscoverFailedEvent",
- "failureType" : "NON_EXECUTING"
+ "owningPartners" : [ "some owning partners" ],
+ "gatewayId" : "a gateway id",
+ "candidates" : [ {
+ "deviceLabel" : "a device label",
+ "deviceAddress" : "a device address",
+ "deviceType" : 2
+ } ],
+ "type" : "OpenDoorsDiscoverCompletedEvent"
} |
@@ -25030,8 +26309,13 @@ Generated events on method call
- | failureType |
- Failure type |
+ candidates |
+ List of user opendoors devices |
+
+
+
+ | gatewayId |
+ User login |
@@ -25045,15 +26329,15 @@ Generated events on method call
- | userId |
- User login |
+ siteOID |
+ Site OID |
- OpenDoorsDiscoverCompletedEvent
+ OpenDoorsDiscoverFailedEvent
| Description |
|
@@ -25062,16 +26346,13 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
- "gatewayId" : "a gateway id",
- "candidates" : [ {
- "deviceLabel" : "a device label",
- "deviceAddress" : "a device address",
- "deviceType" : 2
- } ],
- "name" : "OpenDoorsDiscoverCompletedEvent"
+ "owningPartners" : [ "some owning partners" ],
+ "userId" : "a user id",
+ "type" : "OpenDoorsDiscoverFailedEvent",
+ "failureType" : "NON_EXECUTING"
} |
@@ -25080,13 +26361,8 @@ Generated events on method call
- | candidates |
- List of user opendoors devices |
-
-
-
- | gatewayId |
- User login |
+ failureType |
+ Failure type |
@@ -25099,6 +26375,16 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
+
+ | userId |
+ User login |
+
+
@@ -25164,7 +26450,7 @@ Generated events on method call
Discover OpenDoors devices on given gateway
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -25280,16 +26566,17 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"gatewayId" : "a gateway id",
"candidates" : [ {
"deviceLabel" : "a device label",
"deviceAddress" : "a device address",
"deviceType" : 2
} ],
- "name" : "OpenDoorsDiscoverCompletedEvent"
+ "type" : "OpenDoorsDiscoverCompletedEvent"
} |
@@ -25317,6 +26604,11 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
@@ -25330,11 +26622,12 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"userId" : "a user id",
- "name" : "OpenDoorsDiscoverFailedEvent",
+ "type" : "OpenDoorsDiscoverFailedEvent",
"failureType" : "NON_EXECUTING"
} |
@@ -25358,6 +26651,11 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
| userId |
User login |
@@ -25428,7 +26726,7 @@ Generated events on method call
Return an URL to use for OpenDoors authentication. At the end of the authentication process, the user will be redirected to the given {redirectURL}
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -25634,7 +26932,7 @@
Start the OVP actuators discover full procedure (discover actuators that share the same key and actuators that are in config state)
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -25735,153 +27033,6 @@
Generated events on method call
-
- ExecutionStateChangedEvent
-
- | Description |
- An execution state has changed |
-
-
-
- | JSON |
- {
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
- "setupOID" : "a setup OID",
- "execId" : "an exec id",
- "newState" : "IN_PROGRESS",
- "ownerKey" : "an owner key",
- "type" : 1,
- "subType" : 1,
- "oldState" : "TRANSMITTED",
- "timeToNextState" : 2,
- "failedCommands" : [ {
- "deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
- "detailedStatus" : {
- "message" : "a message",
- "error" : true
- },
- "rank" : 1,
- "failureType" : "NON_EXECUTING"
- } ],
- "failureTypeCode" : 11,
- "name" : "ExecutionStateChangedEvent",
- "failureType" : "NON_EXECUTING"
-} |
-
-
- | Field name |
- Field description |
-
-
-
- | execId |
- Execution id |
-
-
-
- | failedCommands |
- List of failed commands |
-
-
-
- | failureType |
- Failure type |
-
-
-
- | newState |
- Execution new state |
-
-
-
- | oldState |
- Execution previous state |
-
-
-
- | ownerKey |
- Execution owner key |
-
-
-
- | owningPartners |
- Owning partners of the parent entity (setup, ...)) . only available in event streams |
-
-
-
- | setupOID |
- Setup OID |
-
-
-
- | subType |
- Execution sub type |
-
-
-
- | timeToNextState |
- Remaining time until next execution state |
-
-
-
- | type |
- Execution type |
-
-
-
-
-
-
- DeviceStateChangedEvent
-
- | Description |
- One or more states of a device have changed (high-level) |
-
-
-
- | JSON |
- {
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
- "setupOID" : "a setup OID",
- "deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
- "deviceStates" : [ {
- "name" : "a device state change item name",
- "type" : 1,
- "value" : "a device state change item value"
- } ],
- "name" : "DeviceStateChangedEvent"
-} |
-
-
- | Field name |
- Field description |
-
-
-
- | deviceStates |
- Updated device states |
-
-
-
- | deviceURL |
- Device URL |
-
-
-
- | owningPartners |
- Owning partners of the parent entity (setup, ...)) . only available in event streams |
-
-
-
- | setupOID |
- Setup OID |
-
-
-
-
-
DeviceCreatedEvent
@@ -25892,9 +27043,10 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
"controllableName" : "a controllable name",
"label" : "a device created event label",
@@ -25905,7 +27057,7 @@ Generated events on method call
"type" : 1,
"value" : "a device attribute change item value"
} ],
- "name" : "DeviceCreatedEvent"
+ "type" : "DeviceCreatedEvent"
} |
@@ -25933,6 +27085,180 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
+
+
+
+
+ DeviceStateChangedEvent
+
+ | Description |
+ One or more states of a device have changed (high-level) |
+
+
+
+ | JSON |
+ {
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
+ "setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
+ "deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
+ "deviceStates" : [ {
+ "name" : "a device state change item name",
+ "type" : 1,
+ "value" : "a device state change item value"
+ } ],
+ "type" : "DeviceStateChangedEvent"
+} |
+
+
+ | Field name |
+ Field description |
+
+
+
+ | deviceStates |
+ Updated device states |
+
+
+
+ | deviceURL |
+ Device URL |
+
+
+
+ | owningPartners |
+ Owning partners of the parent entity (setup, ...)) . only available in event streams |
+
+
+
+ | setupOID |
+ Setup OID |
+
+
+
+ | siteOID |
+ Site OID |
+
+
+
+
+
+
+ ExecutionStateChangedEvent
+
+ | Description |
+ An execution state has changed |
+
+
+
+ | JSON |
+ {
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
+ "setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
+ "execId" : "an exec id",
+ "newState" : "IN_PROGRESS",
+ "ownerKey" : "an owner key",
+ "executionType" : 1,
+ "subType" : 1,
+ "oldState" : "TRANSMITTED",
+ "timeToNextState" : 2,
+ "failedCommands" : [ {
+ "deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
+ "detailedStatus" : {
+ "type" : "generic-error",
+ "message" : "a message",
+ "error" : true
+ },
+ "rank" : 1,
+ "failureType" : "NON_EXECUTING"
+ } ],
+ "relatedDevices" : [ {
+ "deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])"
+ } ],
+ "technical" : false,
+ "failureTypeCode" : 11,
+ "type" : "ExecutionStateChangedEvent",
+ "failureType" : "NON_EXECUTING"
+} |
+
+
+ | Field name |
+ Field description |
+
+
+
+ | execId |
+ Execution id |
+
+
+
+ | executionType |
+ Execution type |
+
+
+
+ | failedCommands |
+ List of failed commands |
+
+
+
+ | failureType |
+ Failure type |
+
+
+
+ | newState |
+ Execution new state |
+
+
+
+ | oldState |
+ Execution previous state |
+
+
+
+ | ownerKey |
+ Execution owner key |
+
+
+
+ | owningPartners |
+ Owning partners of the parent entity (setup, ...)) . only available in event streams |
+
+
+
+ | relatedDevices |
+ List of devices involved in this execution |
+
+
+
+ | setupOID |
+ Setup OID |
+
+
+
+ | siteOID |
+ Site OID |
+
+
+
+ | subType |
+ Execution sub type |
+
+
+
+ | timeToNextState |
+ Remaining time until next execution state |
+
+
@@ -25998,7 +27324,7 @@ Generated events on method call
Start the OVP actuators discover in system procedure (discover only actuators that share the same system key)
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -26109,27 +27435,33 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"execId" : "an exec id",
"newState" : "IN_PROGRESS",
"ownerKey" : "an owner key",
- "type" : 1,
+ "executionType" : 1,
"subType" : 1,
"oldState" : "TRANSMITTED",
"timeToNextState" : 2,
"failedCommands" : [ {
"deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
"detailedStatus" : {
+ "type" : "generic-error",
"message" : "a message",
"error" : true
},
"rank" : 1,
"failureType" : "NON_EXECUTING"
} ],
+ "relatedDevices" : [ {
+ "deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])"
+ } ],
+ "technical" : false,
"failureTypeCode" : 11,
- "name" : "ExecutionStateChangedEvent",
+ "type" : "ExecutionStateChangedEvent",
"failureType" : "NON_EXECUTING"
} |
@@ -26143,6 +27475,11 @@ Generated events on method call
Execution id |
+
+ | executionType |
+ Execution type |
+
+
| failedCommands |
List of failed commands |
@@ -26173,11 +27510,21 @@ Generated events on method call
Owning partners of the parent entity (setup, ...)) . only available in event streams |
+
+ | relatedDevices |
+ List of devices involved in this execution |
+
+
| setupOID |
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
| subType |
Execution sub type |
@@ -26188,11 +27535,6 @@ Generated events on method call
Remaining time until next execution state |
-
- | type |
- Execution type |
-
-
@@ -26206,16 +27548,17 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
"deviceStates" : [ {
"name" : "a device state change item name",
"type" : 1,
"value" : "a device state change item value"
} ],
- "name" : "DeviceStateChangedEvent"
+ "type" : "DeviceStateChangedEvent"
} |
@@ -26243,6 +27586,11 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
@@ -26256,9 +27604,10 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
"controllableName" : "a controllable name",
"label" : "a device created event label",
@@ -26269,7 +27618,7 @@ Generated events on method call
"type" : 1,
"value" : "a device attribute change item value"
} ],
- "name" : "DeviceCreatedEvent"
+ "type" : "DeviceCreatedEvent"
} |
@@ -26297,6 +27646,11 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
@@ -26362,7 +27716,7 @@ Generated events on method call
Start the OVP actuators discover simple procedure (discover only actuators that are in config state)
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -26473,9 +27827,10 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
"controllableName" : "a controllable name",
"label" : "a device created event label",
@@ -26486,7 +27841,7 @@ Generated events on method call
"type" : 1,
"value" : "a device attribute change item value"
} ],
- "name" : "DeviceCreatedEvent"
+ "type" : "DeviceCreatedEvent"
} |
@@ -26514,101 +27869,9 @@ Generated events on method call
Setup OID |
-
-
-
-
- ExecutionStateChangedEvent
-
- | Description |
- An execution state has changed |
-
-
-
- | JSON |
- {
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
- "setupOID" : "a setup OID",
- "execId" : "an exec id",
- "newState" : "IN_PROGRESS",
- "ownerKey" : "an owner key",
- "type" : 1,
- "subType" : 1,
- "oldState" : "TRANSMITTED",
- "timeToNextState" : 2,
- "failedCommands" : [ {
- "deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
- "detailedStatus" : {
- "message" : "a message",
- "error" : true
- },
- "rank" : 1,
- "failureType" : "NON_EXECUTING"
- } ],
- "failureTypeCode" : 11,
- "name" : "ExecutionStateChangedEvent",
- "failureType" : "NON_EXECUTING"
-} |
-
-
- | Field name |
- Field description |
-
-
-
- | execId |
- Execution id |
-
-
-
- | failedCommands |
- List of failed commands |
-
-
-
- | failureType |
- Failure type |
-
-
-
- | newState |
- Execution new state |
-
-
-
- | oldState |
- Execution previous state |
-
-
-
- | ownerKey |
- Execution owner key |
-
-
-
- | owningPartners |
- Owning partners of the parent entity (setup, ...)) . only available in event streams |
-
-
-
- | setupOID |
- Setup OID |
-
-
- | subType |
- Execution sub type |
-
-
-
- | timeToNextState |
- Remaining time until next execution state |
-
-
-
- | type |
- Execution type |
+ siteOID |
+ Site OID |
@@ -26624,16 +27887,17 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
"deviceStates" : [ {
"name" : "a device state change item name",
"type" : 1,
"value" : "a device state change item value"
} ],
- "name" : "DeviceStateChangedEvent"
+ "type" : "DeviceStateChangedEvent"
} |
@@ -26661,6 +27925,124 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
+
+
+
+
+ ExecutionStateChangedEvent
+
+ | Description |
+ An execution state has changed |
+
+
+
+ | JSON |
+ {
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
+ "setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
+ "execId" : "an exec id",
+ "newState" : "IN_PROGRESS",
+ "ownerKey" : "an owner key",
+ "executionType" : 1,
+ "subType" : 1,
+ "oldState" : "TRANSMITTED",
+ "timeToNextState" : 2,
+ "failedCommands" : [ {
+ "deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
+ "detailedStatus" : {
+ "type" : "generic-error",
+ "message" : "a message",
+ "error" : true
+ },
+ "rank" : 1,
+ "failureType" : "NON_EXECUTING"
+ } ],
+ "relatedDevices" : [ {
+ "deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])"
+ } ],
+ "technical" : false,
+ "failureTypeCode" : 11,
+ "type" : "ExecutionStateChangedEvent",
+ "failureType" : "NON_EXECUTING"
+} |
+
+
+ | Field name |
+ Field description |
+
+
+
+ | execId |
+ Execution id |
+
+
+
+ | executionType |
+ Execution type |
+
+
+
+ | failedCommands |
+ List of failed commands |
+
+
+
+ | failureType |
+ Failure type |
+
+
+
+ | newState |
+ Execution new state |
+
+
+
+ | oldState |
+ Execution previous state |
+
+
+
+ | ownerKey |
+ Execution owner key |
+
+
+
+ | owningPartners |
+ Owning partners of the parent entity (setup, ...)) . only available in event streams |
+
+
+
+ | relatedDevices |
+ List of devices involved in this execution |
+
+
+
+ | setupOID |
+ Setup OID |
+
+
+
+ | siteOID |
+ Site OID |
+
+
+
+ | subType |
+ Execution sub type |
+
+
+
+ | timeToNextState |
+ Remaining time until next execution state |
+
+
@@ -26726,7 +28108,7 @@ Generated events on method call
Start an OVP sensors discover modules on a modbus gateway
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -26843,25 +28225,30 @@ Generated events on method call
Generated events on method call
- DeviceStateChangedEvent
+ DeviceCreatedEvent
| Description |
- One or more states of a device have changed (high-level) |
+ A new device has been added to the setup |
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
- "deviceStates" : [ {
- "name" : "a device state change item name",
+ "controllableName" : "a controllable name",
+ "label" : "a device created event label",
+ "placeOID" : "a place OID",
+ "metadata" : "some metadata",
+ "deviceAttributes" : [ {
+ "name" : "a device attribute change item name",
"type" : 1,
- "value" : "a device state change item value"
+ "value" : "a device attribute change item value"
} ],
- "name" : "DeviceStateChangedEvent"
+ "type" : "DeviceCreatedEvent"
} |
@@ -26870,8 +28257,8 @@ Generated events on method call
- | deviceStates |
- Updated device states |
+ deviceAttributes |
+ Compatible device attributes |
@@ -26889,33 +28276,35 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
- DeviceCreatedEvent
+ DeviceStateChangedEvent
| Description |
- A new device has been added to the setup |
+ One or more states of a device have changed (high-level) |
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
- "controllableName" : "a controllable name",
- "label" : "a device created event label",
- "placeOID" : "a place OID",
- "metadata" : "some metadata",
- "deviceAttributes" : [ {
- "name" : "a device attribute change item name",
+ "deviceStates" : [ {
+ "name" : "a device state change item name",
"type" : 1,
- "value" : "a device attribute change item value"
+ "value" : "a device state change item value"
} ],
- "name" : "DeviceCreatedEvent"
+ "type" : "DeviceStateChangedEvent"
} |
@@ -26924,8 +28313,8 @@ Generated events on method call
- | deviceAttributes |
- Compatible device attributes |
+ deviceStates |
+ Updated device states |
@@ -26943,6 +28332,11 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
@@ -27008,7 +28402,7 @@ Generated events on method call
Start the OVP sensors discover full procedure (discover sensors that share the same key and actuators that are in config state)
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -27119,16 +28513,17 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
"deviceStates" : [ {
"name" : "a device state change item name",
"type" : 1,
"value" : "a device state change item value"
} ],
- "name" : "DeviceStateChangedEvent"
+ "type" : "DeviceStateChangedEvent"
} |
@@ -27156,6 +28551,11 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
@@ -27169,9 +28569,10 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
"controllableName" : "a controllable name",
"label" : "a device created event label",
@@ -27182,7 +28583,7 @@ Generated events on method call
"type" : 1,
"value" : "a device attribute change item value"
} ],
- "name" : "DeviceCreatedEvent"
+ "type" : "DeviceCreatedEvent"
} |
@@ -27210,6 +28611,11 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
@@ -27275,7 +28681,7 @@ Generated events on method call
Start the OVP sensor discover simple procedure (discover only sensors that are in config state)
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -27377,25 +28783,30 @@ Generated events on method call
Generated events on method call
- DeviceStateChangedEvent
+ DeviceCreatedEvent
| Description |
- One or more states of a device have changed (high-level) |
+ A new device has been added to the setup |
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
- "deviceStates" : [ {
- "name" : "a device state change item name",
+ "controllableName" : "a controllable name",
+ "label" : "a device created event label",
+ "placeOID" : "a place OID",
+ "metadata" : "some metadata",
+ "deviceAttributes" : [ {
+ "name" : "a device attribute change item name",
"type" : 1,
- "value" : "a device state change item value"
+ "value" : "a device attribute change item value"
} ],
- "name" : "DeviceStateChangedEvent"
+ "type" : "DeviceCreatedEvent"
} |
@@ -27404,8 +28815,8 @@ Generated events on method call
- | deviceStates |
- Updated device states |
+ deviceAttributes |
+ Compatible device attributes |
@@ -27423,33 +28834,35 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
- DeviceCreatedEvent
+ DeviceStateChangedEvent
| Description |
- A new device has been added to the setup |
+ One or more states of a device have changed (high-level) |
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
- "controllableName" : "a controllable name",
- "label" : "a device created event label",
- "placeOID" : "a place OID",
- "metadata" : "some metadata",
- "deviceAttributes" : [ {
- "name" : "a device attribute change item name",
+ "deviceStates" : [ {
+ "name" : "a device state change item name",
"type" : 1,
- "value" : "a device attribute change item value"
+ "value" : "a device state change item value"
} ],
- "name" : "DeviceCreatedEvent"
+ "type" : "DeviceStateChangedEvent"
} |
@@ -27458,8 +28871,8 @@ Generated events on method call
- | deviceAttributes |
- Compatible device attributes |
+ deviceStates |
+ Updated device states |
@@ -27477,6 +28890,11 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
@@ -27571,7 +28989,7 @@
Create a bridge user on the Philips HUE bridge. Does nothing if the user already exists.
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -27746,7 +29164,7 @@
Start a discover for a Philips HUE bridge
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -27906,7 +29324,7 @@
Start a configuration discover on the target Philips HUE bridge
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -28110,7 +29528,7 @@
This operation give the next available address
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -28270,7 +29688,7 @@
Pair profalux device
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -28445,7 +29863,7 @@
Unpair profalux device
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -28658,7 +30076,7 @@
Retrieve all protocol groups and their devices present in a given setup
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -28793,7 +30211,7 @@
Create a group node for a protocol
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -28984,7 +30402,7 @@
Retrieve all controllables allowed in protocol group creation
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -29160,7 +30578,7 @@
Retrieve the urls of the devices present in a given protocol group
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -29377,7 +30795,7 @@
Return an available RTD device address
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -29537,7 +30955,7 @@
Start a RTD sensor discover procedure
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -29648,9 +31066,10 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
"controllableName" : "a controllable name",
"label" : "a device created event label",
@@ -29661,7 +31080,7 @@ Generated events on method call
"type" : 1,
"value" : "a device attribute change item value"
} ],
- "name" : "DeviceCreatedEvent"
+ "type" : "DeviceCreatedEvent"
} |
@@ -29689,6 +31108,11 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
@@ -29754,7 +31178,7 @@ Generated events on method call
This operation allows to retrieve the RTD key from an alarm system
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -29880,27 +31304,33 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"execId" : "an exec id",
"newState" : "IN_PROGRESS",
"ownerKey" : "an owner key",
- "type" : 1,
+ "executionType" : 1,
"subType" : 1,
"oldState" : "TRANSMITTED",
"timeToNextState" : 2,
"failedCommands" : [ {
"deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
"detailedStatus" : {
+ "type" : "generic-error",
"message" : "a message",
"error" : true
},
"rank" : 1,
"failureType" : "NON_EXECUTING"
} ],
+ "relatedDevices" : [ {
+ "deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])"
+ } ],
+ "technical" : false,
"failureTypeCode" : 11,
- "name" : "ExecutionStateChangedEvent",
+ "type" : "ExecutionStateChangedEvent",
"failureType" : "NON_EXECUTING"
} |
@@ -29914,6 +31344,11 @@ Generated events on method call
Execution id |
+
+ | executionType |
+ Execution type |
+
+
| failedCommands |
List of failed commands |
@@ -29944,11 +31379,21 @@ Generated events on method call
Owning partners of the parent entity (setup, ...)) . only available in event streams |
+
+ | relatedDevices |
+ List of devices involved in this execution |
+
+
| setupOID |
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
| subType |
Execution sub type |
@@ -29959,11 +31404,6 @@ Generated events on method call
Remaining time until next execution state |
-
- | type |
- Execution type |
-
-
@@ -30058,7 +31498,7 @@
This operation allows to retrieve an available RTS channel
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -30218,7 +31658,7 @@
This operation allows to retrieve the RTS key from a control point
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -30359,27 +31799,33 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"execId" : "an exec id",
"newState" : "IN_PROGRESS",
"ownerKey" : "an owner key",
- "type" : 1,
+ "executionType" : 1,
"subType" : 1,
"oldState" : "TRANSMITTED",
"timeToNextState" : 2,
"failedCommands" : [ {
"deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
"detailedStatus" : {
+ "type" : "generic-error",
"message" : "a message",
"error" : true
},
"rank" : 1,
"failureType" : "NON_EXECUTING"
} ],
+ "relatedDevices" : [ {
+ "deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])"
+ } ],
+ "technical" : false,
"failureTypeCode" : 11,
- "name" : "ExecutionStateChangedEvent",
+ "type" : "ExecutionStateChangedEvent",
"failureType" : "NON_EXECUTING"
} |
@@ -30393,6 +31839,11 @@ Generated events on method call
Execution id |
+
+ | executionType |
+ Execution type |
+
+
| failedCommands |
List of failed commands |
@@ -30423,11 +31874,21 @@ Generated events on method call
Owning partners of the parent entity (setup, ...)) . only available in event streams |
+
+ | relatedDevices |
+ List of devices involved in this execution |
+
+
| setupOID |
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
| subType |
Execution sub type |
@@ -30438,11 +31899,6 @@ Generated events on method call
Remaining time until next execution state |
-
- | type |
- Execution type |
-
-
@@ -30537,7 +31993,7 @@
This operation allows to discover a Ramses gateway
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -30663,12 +32119,14 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
+ "setupOID" : "a setup OID",
"owningPartner" : "an owning partner",
"gatewayId" : "A gateway id (ex: 0101-1234-5678)",
"protocolType" : 1,
"ref" : "a ref",
- "name" : "DiscoverCompleteEvent"
+ "type" : "DiscoverCompleteEvent"
} |
@@ -30696,6 +32154,16 @@ Generated events on method call
Reference |
+
+ | setupOID |
+ Setup OID |
+
+
+
+ | siteOID |
+ Site OID |
+
+
@@ -30709,12 +32177,14 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
+ "setupOID" : "a setup OID",
"owningPartner" : "an owning partner",
"gatewayId" : "A gateway id (ex: 0101-1234-5678)",
"protocolType" : 1,
"ref" : "a ref",
- "name" : "DiscoverFailedEvent",
+ "type" : "DiscoverFailedEvent",
"failureType" : "NON_EXECUTING"
} |
@@ -30748,6 +32218,16 @@ Generated events on method call
Reference |
+
+ | setupOID |
+ Setup OID |
+
+
+
+ | siteOID |
+ Site OID |
+
+
@@ -30761,9 +32241,10 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
"controllableName" : "a controllable name",
"label" : "a device created event label",
@@ -30774,7 +32255,7 @@ Generated events on method call
"type" : 1,
"value" : "a device attribute change item value"
} ],
- "name" : "DeviceCreatedEvent"
+ "type" : "DeviceCreatedEvent"
} |
@@ -30802,6 +32283,11 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
@@ -30867,7 +32353,7 @@ Generated events on method call
This operation allows to discover nodes of a Ramses master device, like an EvoHome
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -30984,22 +32470,30 @@ Generated events on method call
Generated events on method call
- DiscoverFailedEvent
+ DeviceCreatedEvent
| Description |
- Discover has failed |
+ A new device has been added to the setup |
| JSON |
{
- "timestamp" : 2,
- "owningPartner" : "an owning partner",
- "gatewayId" : "A gateway id (ex: 0101-1234-5678)",
- "protocolType" : 1,
- "ref" : "a ref",
- "name" : "DiscoverFailedEvent",
- "failureType" : "NON_EXECUTING"
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
+ "setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
+ "deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
+ "controllableName" : "a controllable name",
+ "label" : "a device created event label",
+ "placeOID" : "a place OID",
+ "metadata" : "some metadata",
+ "deviceAttributes" : [ {
+ "name" : "a device attribute change item name",
+ "type" : 1,
+ "value" : "a device attribute change item value"
+ } ],
+ "type" : "DeviceCreatedEvent"
} |
@@ -31008,57 +32502,52 @@ Generated events on method call
- | failureType |
- Failure type |
+ deviceAttributes |
+ Compatible device attributes |
- | gatewayId |
- Gateway id |
+ deviceURL |
+ Device URL |
- | owningPartner |
- Owning partner of the parent entity (gateway, setup group, ...)) . only available in event streams |
+ owningPartners |
+ Owning partners of the parent entity (setup, ...)) . only available in event streams |
- | protocolType |
- Device protocol type |
+ setupOID |
+ Setup OID |
- | ref |
- Reference |
+ siteOID |
+ Site OID |
- DeviceCreatedEvent
+ DiscoverFailedEvent
| Description |
- A new device has been added to the setup |
+ Discover has failed |
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
- "deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
- "controllableName" : "a controllable name",
- "label" : "a device created event label",
- "placeOID" : "a place OID",
- "metadata" : "some metadata",
- "deviceAttributes" : [ {
- "name" : "a device attribute change item name",
- "type" : 1,
- "value" : "a device attribute change item value"
- } ],
- "name" : "DeviceCreatedEvent"
+ "owningPartner" : "an owning partner",
+ "gatewayId" : "A gateway id (ex: 0101-1234-5678)",
+ "protocolType" : 1,
+ "ref" : "a ref",
+ "type" : "DiscoverFailedEvent",
+ "failureType" : "NON_EXECUTING"
} |
@@ -31067,18 +32556,28 @@ Generated events on method call
- | deviceAttributes |
- Compatible device attributes |
+ failureType |
+ Failure type |
- | deviceURL |
- Device URL |
+ gatewayId |
+ Gateway id |
- | owningPartners |
- Owning partners of the parent entity (setup, ...)) . only available in event streams |
+ owningPartner |
+ Owning partner of the parent entity (gateway, setup group, ...)) . only available in event streams |
+
+
+
+ | protocolType |
+ Device protocol type |
+
+
+
+ | ref |
+ Reference |
@@ -31086,6 +32585,11 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
@@ -31099,12 +32603,14 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
+ "setupOID" : "a setup OID",
"owningPartner" : "an owning partner",
"gatewayId" : "A gateway id (ex: 0101-1234-5678)",
"protocolType" : 1,
"ref" : "a ref",
- "name" : "DiscoverCompleteEvent"
+ "type" : "DiscoverCompleteEvent"
} |
@@ -31132,6 +32638,16 @@ Generated events on method call
Reference |
+
+ | setupOID |
+ Setup OID |
+
+
+
+ | siteOID |
+ Site OID |
+
+
@@ -31197,7 +32713,7 @@ Generated events on method call
This operation allows to test the Ramses master device address
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -31294,12 +32810,14 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
+ "setupOID" : "a setup OID",
"owningPartner" : "an owning partner",
"gatewayId" : "A gateway id (ex: 0101-1234-5678)",
"protocolType" : 1,
"address" : "an address",
- "name" : "ValidAddressEvent"
+ "type" : "ValidAddressEvent"
} |
@@ -31327,6 +32845,16 @@ Generated events on method call
Device protocol type |
+
+ | setupOID |
+ Setup OID |
+
+
+
+ | siteOID |
+ Site OID |
+
+
@@ -31392,7 +32920,7 @@ Generated events on method call
This operation allows to test the Ramses gateway address
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -31489,12 +33017,14 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
+ "setupOID" : "a setup OID",
"owningPartner" : "an owning partner",
"gatewayId" : "A gateway id (ex: 0101-1234-5678)",
"protocolType" : 1,
"address" : "an address",
- "name" : "ValidAddressEvent"
+ "type" : "ValidAddressEvent"
} |
@@ -31522,6 +33052,16 @@ Generated events on method call
Device protocol type |
+
+ | setupOID |
+ Setup OID |
+
+
+
+ | siteOID |
+ Site OID |
+
+
@@ -31616,7 +33156,7 @@
Generate OAuth2 tokens from credentials
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -31702,10 +33242,11 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
- "name" : "SomfyThermostatGenerateOAuthTokensCompletedEvent"
+ "owningPartners" : [ "some owning partners" ],
+ "type" : "SomfyThermostatGenerateOAuthTokensCompletedEvent"
} |
@@ -31723,6 +33264,11 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
@@ -31736,10 +33282,11 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
- "name" : "SomfyThermostatGenerateOAuthTokensFailedEvent",
+ "owningPartners" : [ "some owning partners" ],
+ "type" : "SomfyThermostatGenerateOAuthTokensFailedEvent",
"failureType" : "NON_EXECUTING"
} |
@@ -31758,6 +33305,11 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
@@ -31823,7 +33375,7 @@ Generated events on method call
Refresh current access token if necessary
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -31869,7 +33421,7 @@ Generated events on method call
Generated events on method call
- SomfyThermostatCurrentTokensCompletedEvent
+ SomfyThermostatCurrentTokensFailedEvent
| Description |
|
@@ -31878,10 +33430,12 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
- "name" : "SomfyThermostatCurrentTokensCompletedEvent"
+ "owningPartners" : [ "some owning partners" ],
+ "type" : "SomfyThermostatCurrentTokensFailedEvent",
+ "failureType" : "NON_EXECUTING"
} |
@@ -31899,11 +33453,16 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
- SomfyThermostatCurrentTokensFailedEvent
+ SomfyThermostatCurrentTokensCompletedEvent
| Description |
|
@@ -31912,11 +33471,11 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
- "name" : "SomfyThermostatCurrentTokensFailedEvent",
- "failureType" : "NON_EXECUTING"
+ "owningPartners" : [ "some owning partners" ],
+ "type" : "SomfyThermostatCurrentTokensCompletedEvent"
} |
@@ -31934,6 +33493,11 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
@@ -31999,7 +33563,7 @@ Generated events on method call
Start a SomfyThermostat discover devices procedure
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -32072,21 +33636,24 @@ Generated events on method call
Generated events on method call
- DiscoverCompleteEvent
+ DiscoverFailedEvent
| Description |
- Discover is complete |
+ Discover has failed |
| JSON |
{
- "timestamp" : 2,
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
+ "setupOID" : "a setup OID",
"owningPartner" : "an owning partner",
"gatewayId" : "A gateway id (ex: 0101-1234-5678)",
"protocolType" : 1,
"ref" : "a ref",
- "name" : "DiscoverCompleteEvent"
+ "type" : "DiscoverFailedEvent",
+ "failureType" : "NON_EXECUTING"
} |
@@ -32094,6 +33661,11 @@ Generated events on method call
Field description |
+
+ | failureType |
+ Failure type |
+
+
| gatewayId |
Gateway id |
@@ -32114,33 +33686,37 @@ Generated events on method call
Reference |
+
+ | setupOID |
+ Setup OID |
+
+
+
+ | siteOID |
+ Site OID |
+
+
- DeviceCreatedEvent
+ DiscoverCompleteEvent
| Description |
- A new device has been added to the setup |
+ Discover is complete |
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
- "deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
- "controllableName" : "a controllable name",
- "label" : "a device created event label",
- "placeOID" : "a place OID",
- "metadata" : "some metadata",
- "deviceAttributes" : [ {
- "name" : "a device attribute change item name",
- "type" : 1,
- "value" : "a device attribute change item value"
- } ],
- "name" : "DeviceCreatedEvent"
+ "owningPartner" : "an owning partner",
+ "gatewayId" : "A gateway id (ex: 0101-1234-5678)",
+ "protocolType" : 1,
+ "ref" : "a ref",
+ "type" : "DiscoverCompleteEvent"
} |
@@ -32149,18 +33725,23 @@ Generated events on method call
- | deviceAttributes |
- Compatible device attributes |
+ gatewayId |
+ Gateway id |
- | deviceURL |
- Device URL |
+ owningPartner |
+ Owning partner of the parent entity (gateway, setup group, ...)) . only available in event streams |
- | owningPartners |
- Owning partners of the parent entity (setup, ...)) . only available in event streams |
+ protocolType |
+ Device protocol type |
+
+
+
+ | ref |
+ Reference |
@@ -32168,26 +33749,39 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
- DiscoverFailedEvent
+ DeviceCreatedEvent
| Description |
- Discover has failed |
+ A new device has been added to the setup |
| JSON |
{
- "timestamp" : 2,
- "owningPartner" : "an owning partner",
- "gatewayId" : "A gateway id (ex: 0101-1234-5678)",
- "protocolType" : 1,
- "ref" : "a ref",
- "name" : "DiscoverFailedEvent",
- "failureType" : "NON_EXECUTING"
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
+ "setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
+ "deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
+ "controllableName" : "a controllable name",
+ "label" : "a device created event label",
+ "placeOID" : "a place OID",
+ "metadata" : "some metadata",
+ "deviceAttributes" : [ {
+ "name" : "a device attribute change item name",
+ "type" : 1,
+ "value" : "a device attribute change item value"
+ } ],
+ "type" : "DeviceCreatedEvent"
} |
@@ -32196,28 +33790,28 @@ Generated events on method call
- | failureType |
- Failure type |
+ deviceAttributes |
+ Compatible device attributes |
- | gatewayId |
- Gateway id |
+ deviceURL |
+ Device URL |
- | owningPartner |
- Owning partner of the parent entity (gateway, setup group, ...)) . only available in event streams |
+ owningPartners |
+ Owning partners of the parent entity (setup, ...)) . only available in event streams |
- | protocolType |
- Device protocol type |
+ setupOID |
+ Setup OID |
- | ref |
- Reference |
+ siteOID |
+ Site OID |
@@ -32285,7 +33879,7 @@ Generated events on method call
Start a discover gateways
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -32340,10 +33934,11 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
- "name" : "SomfyThermostatDiscoverCompletedEvent"
+ "owningPartners" : [ "some owning partners" ],
+ "type" : "SomfyThermostatDiscoverCompletedEvent"
} |
@@ -32361,11 +33956,16 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
- SomfyThermostatDiscoveredEvent
+ SomfyThermostatDiscoverFailedEvent
| Description |
|
@@ -32374,12 +33974,12 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
- "thermostatId" : "a thermostat id",
- "thermostatLabel" : "a thermostat label",
- "name" : "SomfyThermostatDiscoveredEvent"
+ "owningPartners" : [ "some owning partners" ],
+ "type" : "SomfyThermostatDiscoverFailedEvent",
+ "failureType" : "NON_EXECUTING"
} |
@@ -32398,20 +33998,15 @@ Generated events on method call
- | thermostatId |
- thermostat ID |
-
-
-
- | thermostatLabel |
- thermostat Label |
+ siteOID |
+ Site OID |
- SomfyThermostatDiscoverFailedEvent
+ SomfyThermostatDiscoveredEvent
| Description |
|
@@ -32420,11 +34015,13 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
- "name" : "SomfyThermostatDiscoverFailedEvent",
- "failureType" : "NON_EXECUTING"
+ "owningPartners" : [ "some owning partners" ],
+ "thermostatId" : "a thermostat id",
+ "thermostatLabel" : "a thermostat label",
+ "type" : "SomfyThermostatDiscoveredEvent"
} |
@@ -32442,6 +34039,21 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
+
+ | thermostatId |
+ thermostat ID |
+
+
+
+ | thermostatLabel |
+ thermostat Label |
+
+
@@ -32507,7 +34119,7 @@ Generated events on method call
discover the gateway corresponding to the gatewayId
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -32580,7 +34192,7 @@ Generated events on method call
Generated events on method call
- SomfyThermostatDiscoverCompletedEvent
+ SomfyThermostatDiscoveredEvent
| Description |
|
@@ -32589,10 +34201,13 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
- "name" : "SomfyThermostatDiscoverCompletedEvent"
+ "owningPartners" : [ "some owning partners" ],
+ "thermostatId" : "a thermostat id",
+ "thermostatLabel" : "a thermostat label",
+ "type" : "SomfyThermostatDiscoveredEvent"
} |
@@ -32610,11 +34225,26 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
+
+ | thermostatId |
+ thermostat ID |
+
+
+
+ | thermostatLabel |
+ thermostat Label |
+
+
- SomfyThermostatDiscoveredEvent
+ SomfyThermostatDiscoverCompletedEvent
| Description |
|
@@ -32623,12 +34253,11 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
- "thermostatId" : "a thermostat id",
- "thermostatLabel" : "a thermostat label",
- "name" : "SomfyThermostatDiscoveredEvent"
+ "owningPartners" : [ "some owning partners" ],
+ "type" : "SomfyThermostatDiscoverCompletedEvent"
} |
@@ -32647,13 +34276,8 @@ Generated events on method call
- | thermostatId |
- thermostat ID |
-
-
-
- | thermostatLabel |
- thermostat Label |
+ siteOID |
+ Site OID |
@@ -32669,10 +34293,11 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
- "name" : "SomfyThermostatDiscoverFailedEvent",
+ "owningPartners" : [ "some owning partners" ],
+ "type" : "SomfyThermostatDiscoverFailedEvent",
"failureType" : "NON_EXECUTING"
} |
@@ -32691,6 +34316,11 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
@@ -32756,7 +34386,7 @@ Generated events on method call
discover gateways candidates
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -32811,10 +34441,11 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
- "name" : "SomfyThermostatDiscoverCompletedEvent"
+ "owningPartners" : [ "some owning partners" ],
+ "type" : "SomfyThermostatDiscoverCompletedEvent"
} |
@@ -32832,6 +34463,11 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
@@ -32845,15 +34481,16 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"candidates" : [ {
"thermostatLabel" : "a thermostat label",
"gatewayId" : "a gateway id",
"thermostatId" : "a thermostat id"
} ],
- "name" : "SomfyThermostatsCandidatesDiscoveredEvent"
+ "type" : "SomfyThermostatsCandidatesDiscoveredEvent"
} |
@@ -32876,6 +34513,11 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
@@ -32889,10 +34531,11 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
- "name" : "SomfyThermostatDiscoverFailedEvent",
+ "owningPartners" : [ "some owning partners" ],
+ "type" : "SomfyThermostatDiscoverFailedEvent",
"failureType" : "NON_EXECUTING"
} |
@@ -32911,6 +34554,11 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
@@ -32976,7 +34624,7 @@ Generated events on method call
Return an URL to use for Somfy thermostat authentication. At the end of the authentication process, the user will be redirected to the given {redirectURL}
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -33155,7 +34803,7 @@ Generated events on method call
Register webhook for events
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -33252,11 +34900,12 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
- "name" : "SomfyThermostatRegisterWebhookSuccessEvent"
+ "type" : "SomfyThermostatRegisterWebhookSuccessEvent"
} |
@@ -33279,6 +34928,11 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
@@ -33292,11 +34946,12 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
- "name" : "SomfyThermostatRegisterWebhookFailedEvent",
+ "type" : "SomfyThermostatRegisterWebhookFailedEvent",
"failureType" : "NON_EXECUTING"
} |
@@ -33320,6 +34975,11 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
@@ -33385,7 +35045,7 @@ Generated events on method call
Delete webhook for events
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -33473,7 +35133,7 @@ Generated events on method call
Generated events on method call
- SomfyThermostatDeleteWebhookSuccessEvent
+ SomfyThermostatDeleteWebhookFailedEvent
| Description |
|
@@ -33482,12 +35142,13 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
- "webhookId" : 1,
- "name" : "SomfyThermostatDeleteWebhookSuccessEvent"
+ "type" : "SomfyThermostatDeleteWebhookFailedEvent",
+ "failureType" : "NON_EXECUTING"
} |
@@ -33511,15 +35172,15 @@ Generated events on method call
- | webhookId |
- Webhook id |
+ siteOID |
+ Site OID |
- SomfyThermostatDeleteWebhookFailedEvent
+ SomfyThermostatDeleteWebhookSuccessEvent
| Description |
|
@@ -33528,12 +35189,13 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
- "name" : "SomfyThermostatDeleteWebhookFailedEvent",
- "failureType" : "NON_EXECUTING"
+ "webhookId" : 1,
+ "type" : "SomfyThermostatDeleteWebhookSuccessEvent"
} |
@@ -33556,6 +35218,16 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
+
+ | webhookId |
+ Webhook id |
+
+
@@ -33650,7 +35322,7 @@
Generate OAuth2 tokens from credentials
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -33736,10 +35408,11 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
- "name" : "SomfyProtectGenerateOAuthTokensFailedEvent",
+ "owningPartners" : [ "some owning partners" ],
+ "type" : "SomfyProtectGenerateOAuthTokensFailedEvent",
"failureType" : "NON_EXECUTING"
} |
@@ -33763,6 +35436,11 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
@@ -33776,10 +35454,11 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
- "name" : "SomfyProtectGenerateOAuthTokensCompletedEvent"
+ "owningPartners" : [ "some owning partners" ],
+ "type" : "SomfyProtectGenerateOAuthTokensCompletedEvent"
} |
@@ -33797,6 +35476,11 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
@@ -33862,7 +35546,7 @@ Generated events on method call
Refresh current access token if necessary
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -33917,10 +35601,11 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
- "name" : "SomfyProtectCurrentTokenFailedEvent",
+ "owningPartners" : [ "some owning partners" ],
+ "type" : "SomfyProtectCurrentTokenFailedEvent",
"failureType" : "NON_EXECUTING"
} |
@@ -33939,6 +35624,11 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
@@ -33952,12 +35642,13 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"accessToken" : "an access token",
"refreshToken" : "a refresh token",
- "name" : "SomfyProtectCurrentTokenCompletedEvent"
+ "type" : "SomfyProtectCurrentTokenCompletedEvent"
} |
@@ -33985,6 +35676,11 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
@@ -34050,7 +35746,7 @@ Generated events on method call
Start a SomfyProtect discover devices procedure
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -34122,104 +35818,6 @@ Generated events on method call
Generated events on method call
-
- DiscoverFailedEvent
-
- | Description |
- Discover has failed |
-
-
-
- | JSON |
- {
- "timestamp" : 2,
- "owningPartner" : "an owning partner",
- "gatewayId" : "A gateway id (ex: 0101-1234-5678)",
- "protocolType" : 1,
- "ref" : "a ref",
- "name" : "DiscoverFailedEvent",
- "failureType" : "NON_EXECUTING"
-} |
-
-
- | Field name |
- Field description |
-
-
-
- | failureType |
- Failure type |
-
-
-
- | gatewayId |
- Gateway id |
-
-
-
- | owningPartner |
- Owning partner of the parent entity (gateway, setup group, ...)) . only available in event streams |
-
-
-
- | protocolType |
- Device protocol type |
-
-
-
- | ref |
- Reference |
-
-
-
-
-
-
- DiscoverCompleteEvent
-
- | Description |
- Discover is complete |
-
-
-
- | JSON |
- {
- "timestamp" : 2,
- "owningPartner" : "an owning partner",
- "gatewayId" : "A gateway id (ex: 0101-1234-5678)",
- "protocolType" : 1,
- "ref" : "a ref",
- "name" : "DiscoverCompleteEvent"
-} |
-
-
- | Field name |
- Field description |
-
-
-
- | gatewayId |
- Gateway id |
-
-
-
- | owningPartner |
- Owning partner of the parent entity (gateway, setup group, ...)) . only available in event streams |
-
-
-
- | protocolType |
- Device protocol type |
-
-
-
- | ref |
- Reference |
-
-
-
-
-
DeviceCreatedEvent
@@ -34230,9 +35828,10 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
"controllableName" : "a controllable name",
"label" : "a device created event label",
@@ -34243,7 +35842,7 @@ Generated events on method call
"type" : 1,
"value" : "a device attribute change item value"
} ],
- "name" : "DeviceCreatedEvent"
+ "type" : "DeviceCreatedEvent"
} |
@@ -34271,6 +35870,133 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
+
+
+
+
+ DiscoverFailedEvent
+
+ | Description |
+ Discover has failed |
+
+
+
+ | JSON |
+ {
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
+ "setupOID" : "a setup OID",
+ "owningPartner" : "an owning partner",
+ "gatewayId" : "A gateway id (ex: 0101-1234-5678)",
+ "protocolType" : 1,
+ "ref" : "a ref",
+ "type" : "DiscoverFailedEvent",
+ "failureType" : "NON_EXECUTING"
+} |
+
+
+ | Field name |
+ Field description |
+
+
+
+ | failureType |
+ Failure type |
+
+
+
+ | gatewayId |
+ Gateway id |
+
+
+
+ | owningPartner |
+ Owning partner of the parent entity (gateway, setup group, ...)) . only available in event streams |
+
+
+
+ | protocolType |
+ Device protocol type |
+
+
+
+ | ref |
+ Reference |
+
+
+
+ | setupOID |
+ Setup OID |
+
+
+
+ | siteOID |
+ Site OID |
+
+
+
+
+
+
+ DiscoverCompleteEvent
+
+ | Description |
+ Discover is complete |
+
+
+
+ | JSON |
+ {
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
+ "setupOID" : "a setup OID",
+ "owningPartner" : "an owning partner",
+ "gatewayId" : "A gateway id (ex: 0101-1234-5678)",
+ "protocolType" : 1,
+ "ref" : "a ref",
+ "type" : "DiscoverCompleteEvent"
+} |
+
+
+ | Field name |
+ Field description |
+
+
+
+ | gatewayId |
+ Gateway id |
+
+
+
+ | owningPartner |
+ Owning partner of the parent entity (gateway, setup group, ...)) . only available in event streams |
+
+
+
+ | protocolType |
+ Device protocol type |
+
+
+
+ | ref |
+ Reference |
+
+
+
+ | setupOID |
+ Setup OID |
+
+
+
+ | siteOID |
+ Site OID |
+
+
@@ -34336,7 +36062,7 @@ Generated events on method call
Start a discover of the gateway with the siteID
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -34409,7 +36135,7 @@ Generated events on method call
Generated events on method call
- SomfyProtectDiscoverFailedEvent
+ SomfyProtectDiscoverCompletedEvent
| Description |
|
@@ -34418,11 +36144,11 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
- "name" : "SomfyProtectDiscoverFailedEvent",
- "failureType" : "NON_EXECUTING"
+ "owningPartners" : [ "some owning partners" ],
+ "type" : "SomfyProtectDiscoverCompletedEvent"
} |
@@ -34430,11 +36156,6 @@ Generated events on method call
Field description |
-
- | failureType |
- Failure type |
-
-
| owningPartners |
Owning partners of the parent entity (setup, ...)) . only available in event streams |
@@ -34445,11 +36166,16 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
- SomfyProtectDiscoverCompletedEvent
+ SomfyProtectDiscoverFailedEvent
| Description |
|
@@ -34458,10 +36184,12 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
- "name" : "SomfyProtectDiscoverCompletedEvent"
+ "owningPartners" : [ "some owning partners" ],
+ "type" : "SomfyProtectDiscoverFailedEvent",
+ "failureType" : "NON_EXECUTING"
} |
@@ -34469,6 +36197,11 @@ Generated events on method call
Field description |
+
+ | failureType |
+ Failure type |
+
+
| owningPartners |
Owning partners of the parent entity (setup, ...)) . only available in event streams |
@@ -34479,6 +36212,11 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
@@ -34545,7 +36283,7 @@ Generated events on method call
Start a discover gateways @Deprecated: use discoverGatewaysCandidates and discoverGateway to discover a gateway
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -34629,10 +36367,11 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
- "name" : "SomfyProtectDiscoverFailedEvent",
+ "owningPartners" : [ "some owning partners" ],
+ "type" : "SomfyProtectDiscoverFailedEvent",
"failureType" : "NON_EXECUTING"
} |
@@ -34656,6 +36395,11 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
@@ -34669,12 +36413,13 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"siteId" : "a site id",
"siteLabel" : "a site label",
- "name" : "SomfyProtectSiteDiscoveredEvent"
+ "type" : "SomfyProtectSiteDiscoveredEvent"
} |
@@ -34702,6 +36447,11 @@ Generated events on method call
Site Label |
+
+ | siteOID |
+ Site OID |
+
+
@@ -34715,10 +36465,11 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
- "name" : "SomfyProtectDiscoverCompletedEvent"
+ "owningPartners" : [ "some owning partners" ],
+ "type" : "SomfyProtectDiscoverCompletedEvent"
} |
@@ -34736,6 +36487,11 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
@@ -34801,7 +36557,7 @@ Generated events on method call
Discover gateways candidates
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -34885,9 +36641,10 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"sites" : [ {
"siteId" : "a site id",
"securityLevel" : "a security level",
@@ -34904,7 +36661,7 @@ Generated events on method call
"shutterAutomaticEnabled" : false,
"label" : "a somfy protect site label"
} ],
- "name" : "SomfyProtectGetSitesCompletedEvent"
+ "type" : "SomfyProtectGetSitesCompletedEvent"
} |
@@ -34922,6 +36679,11 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
@@ -34935,10 +36697,11 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
- "name" : "SomfyProtectGetSitesFailedEvent",
+ "owningPartners" : [ "some owning partners" ],
+ "type" : "SomfyProtectGetSitesFailedEvent",
"failureType" : "NON_EXECUTING"
} |
@@ -34957,6 +36720,11 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
@@ -35023,7 +36791,7 @@ Generated events on method call
Send get sites @Deprecated: use discoverGatewaysCandidates
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -35107,9 +36875,10 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"sites" : [ {
"siteId" : "a site id",
"securityLevel" : "a security level",
@@ -35126,7 +36895,7 @@ Generated events on method call
"shutterAutomaticEnabled" : false,
"label" : "a somfy protect site label"
} ],
- "name" : "SomfyProtectGetSitesCompletedEvent"
+ "type" : "SomfyProtectGetSitesCompletedEvent"
} |
@@ -35144,6 +36913,11 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
@@ -35157,10 +36931,11 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
- "name" : "SomfyProtectGetSitesFailedEvent",
+ "owningPartners" : [ "some owning partners" ],
+ "type" : "SomfyProtectGetSitesFailedEvent",
"failureType" : "NON_EXECUTING"
} |
@@ -35179,6 +36954,11 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
@@ -35244,7 +37024,7 @@ Generated events on method call
Return an URL to use for SomfyProtect authentication. At the end of the authentication process, the user will be redirected to the given {redirectUrl}
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -35385,12 +37165,12 @@ Generated events on method call
- UPnP Control protocol
+ Wiser protocol
- Private tags : [ upnpcontrol-config ]
+ Private tags : [ wiser-config ]
|
@@ -35407,16 +37187,16 @@
- | GET |
+ POST |
- Topology
+ discover devices
|
@@ -35432,15 +37212,15 @@
- /config/{gatewayId}/upnpcontrol/sonos/checkActionGroups
+ /config/wiser/gateway/{gatewayId}/discoverDevices
| application/json |
|
- Check if action groups are consistent with the topology
+ Start a discover devices on a gateway
- Access scope : Full enduser API access (enduser/*)
- > Test operation
+ Access scope : enduser/*
+ > Test operation
|
@@ -35480,7 +37260,7 @@
- The gateway id
+ The gateway Id
|
@@ -35488,39 +37268,6 @@
-
-
- Response
-
- | Type |
- Name |
- Value |
- Description |
-
-
-
- |
- Response Body
- |
-
- (JSON)
- |
- {
- "impactedElements" : {
- "actionGroupsOID" : [ "some action groups OID" ],
- "calendarDaysOID" : [ "some calendar days OID" ],
- "setupTriggersOID" : [ "some setup triggers OID" ]
- }
-} |
-
-
-
-
- |
-
-
-
-
@@ -35588,7 +37335,7 @@
- Topology
+ wiser create authentication URL
@@ -35596,7 +37343,7 @@
- /config/{gatewayId}/upnpcontrol/sonos/topology/{deviceURL}
+ /config/wiser/createAuthenticationURL/{redirectURL}
@@ -35612,10 +37359,10 @@
|
- Get sonos topology
+ Return an URL to use for wiser authentication. At the end of the authentication process, the user will be redirected to the given {redirectURL}
- Access scope : Full enduser API access (enduser/*)
- > Test operation
+ Access scope : enduser/*
+ > Test operation
|
@@ -35638,490 +37385,65 @@
Path Variable
|
- gatewayId
+ redirectURL
|
"string value" |
- The gateway id
+ OAuth redirect URL
|
|
- Path Variable
+ Request Body
|
- deviceURL
+ (JSON)
|
- "string value" |
+ {
+ "applicationId" : "an application id"
+} |
+ (Optional)
-
- The device url
+
|
-
-
-
-
-
- HTTP Status Code
-
- | Code |
- Message |
- Meaning |
-
-
-
- |
- 200
- |
- OK |
-
- The request has succeeded
- |
-
-
-
-
-
-
-
-
-
- Generated events on method call
-
-
- SonosGetTopologySuccessEvent
-
- | Description |
- Sonos get topology successfully finished |
-
-
-
- | JSON |
- {
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
- "setupOID" : "a setup OID",
- "deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
- "name" : "SonosGetTopologySuccessEvent"
-} |
-
-
- | Field name |
- Field description |
-
-
-
- | deviceURL |
- Device URL |
-
-
-
- | owningPartners |
- Owning partners of the parent entity (setup, ...)) . only available in event streams |
-
-
-
- | setupOID |
- Setup OID |
-
-
-
-
-
-
- SonosGetTopologyFailedEvent
-
- | Description |
- Sonos get topology failed |
-
-
-
- | JSON |
- {
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
- "setupOID" : "a setup OID",
- "deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
- "name" : "SonosGetTopologyFailedEvent",
- "failureType" : "NON_EXECUTING"
-} |
-
-
- | Field name |
- Field description |
-
-
-
- | deviceURL |
- Device URL |
-
-
-
- | owningPartners |
- Owning partners of the parent entity (setup, ...)) . only available in event streams |
-
-
-
- | setupOID |
- Setup OID |
-
-
-
-
-
-
- SonosTopologyChangedEvent
-
- | Description |
- Sonos get topology changed |
-
-
-
- | JSON |
- {
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
- "setupOID" : "a setup OID",
- "actionGroupOIDsToUpdate" : [ "an action group OIDs to update" ],
- "name" : "SonosTopologyChangedEvent"
-} |
-
-
- | Field name |
- Field description |
-
-
-
- | owningPartners |
- Owning partners of the parent entity (setup, ...)) . only available in event streams |
-
-
-
- | setupOID |
- Setup OID |
-
-
-
-
-
-
-
-
-
-
-
-
- |
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Wiser protocol
-
-
-
-
- Private tags : [ wiser-config ]
-
- |
- |
- Expand commands |
-
-
-
-
-
-
-
-
-
-
-
-
- | POST |
-
-
-
-
- discover devices
-
-
- |
-
-
-
-
- /config/wiser/gateway/{gatewayId}/discoverDevices
-
-
- |
- application/json |
-
-
- |
-
-
- Start a discover devices on a gateway
-
- Access scope : Full enduser API access (enduser/*)
- > Test operation
- |
-
-
- |
-
-
-
-
-
- Parameters
-
- | Type |
- Name |
- Value |
- Description |
-
-
-
- |
- Path Variable
- |
-
- gatewayId
- |
- "string value" |
-
-
-
- The gateway Id
- |
-
-
-
-
-
-
-
-
-
-
- HTTP Status Code
-
- | Code |
- Message |
- Meaning |
-
-
-
- |
- 200
- |
- OK |
-
- The request has succeeded
- |
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- |
-
-
- |
-
-
-
-
-
-
-
-
- | POST |
-
-
-
-
- wiser create authentication URL
-
-
- |
-
-
-
-
- /config/wiser/createAuthenticationURL/{redirectURL}
-
-
- |
- application/json |
-
-
- |
-
-
- Return an URL to use for wiser authentication. At the end of the authentication process, the user will be redirected to the given {redirectURL}
-
- Access scope : Full enduser API access (enduser/*)
- > Test operation
- |
-
-
- |
-
-
-
-
-
- Parameters
-
- | Type |
- Name |
- Value |
- Description |
-
-
-
- |
- Path Variable
- |
-
- redirectURL
- |
- "string value" |
-
-
-
- OAuth redirect URL
- |
-
-
-
- |
- Request Body
- |
-
- (JSON)
- |
- {
- "applicationId" : "an application id"
-} |
-
- (Optional)
-
-
- |
-
-
-
-
-
-
-
-
- Response
-
- | Type |
- Name |
- Value |
- Description |
-
-
-
- |
- Response Body
- |
-
- (JSON)
- |
- {
- "authenticationURL" : "string value"
-} |
-
-
-
-
- |
-
-
-
+
+
+
+ Response
+
+ | Type |
+ Name |
+ Value |
+ Description |
+
+
+
+ |
+ Response Body
+ |
+
+ (JSON)
+ |
+ {
+ "authenticationURL" : "string value"
+} |
+
+
+
+
+ |
+
+
+
@@ -36216,7 +37538,7 @@
discover a site by id
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
|
@@ -36289,7 +37611,7 @@
Generated events on method call
- WiserGatewayDiscoveredFailedEvent
+ WiserGatewayDiscoveredEvent
| Description |
|
@@ -36298,12 +37620,13 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"gatewayId" : "a gateway id",
- "name" : "WiserGatewayDiscoveredFailedEvent",
- "failureType" : "NON_EXECUTING"
+ "label" : "a wiser gateway discovered event label",
+ "type" : "WiserGatewayDiscoveredEvent"
} |
@@ -36311,6 +37634,16 @@ Generated events on method call
Field description |
+
+ | gatewayId |
+ gateway Id |
+
+
+
+ | label |
+ label |
+
+
| owningPartners |
Owning partners of the parent entity (setup, ...)) . only available in event streams |
@@ -36321,11 +37654,16 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
- WiserGatewayDiscoveredEvent
+ WiserGatewayDiscoveredFailedEvent
| Description |
|
@@ -36334,12 +37672,13 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"gatewayId" : "a gateway id",
- "label" : "a wiser gateway discovered event label",
- "name" : "WiserGatewayDiscoveredEvent"
+ "type" : "WiserGatewayDiscoveredFailedEvent",
+ "failureType" : "NON_EXECUTING"
} |
@@ -36347,16 +37686,6 @@ Generated events on method call
Field description |
-
- | gatewayId |
- gateway Id |
-
-
-
- | label |
- label |
-
-
| owningPartners |
Owning partners of the parent entity (setup, ...)) . only available in event streams |
@@ -36367,6 +37696,11 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
@@ -36432,7 +37766,7 @@ Generated events on method call
Return the list of the gateways candidates
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -36487,14 +37821,15 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"candidates" : [ {
"id" : "an id",
"name" : "a wiser site name"
} ],
- "name" : "WiserSitesCandidatesDiscoveredEvent"
+ "type" : "WiserSitesCandidatesDiscoveredEvent"
} |
@@ -36517,6 +37852,11 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
@@ -36530,10 +37870,11 @@ Generated events on method call
|
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
- "name" : "WiserSitesCandidatesFailedEvent",
+ "owningPartners" : [ "some owning partners" ],
+ "type" : "WiserSitesCandidatesFailedEvent",
"failureType" : "NON_EXECUTING"
} |
@@ -36552,6 +37893,11 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
@@ -36647,7 +37993,7 @@
Get Z-Wave controller capability: Unknown (0), First config (1), Primary controller (2) or Secondary controller (3)
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -36809,7 +38155,7 @@
Set device wake up interval.
DEPRECATED: use command on the related node
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -37001,7 +38347,7 @@
Set device wake up interval and if set, assign the return route.
DEPRECATED: use command on the related node
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -37207,7 +38553,7 @@
Start a Z-Wave exclusion procedure.
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -37309,20 +38655,21 @@
Generated events on method call
- DeviceDisabledEvent
+ ZWaveSetModeCompleteEvent
| Description |
- Device is disabled |
+ |
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
- "deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
- "name" : "DeviceDisabledEvent"
+ "owningPartner" : "an owning partner",
+ "gatewayId" : "A gateway id (ex: 0101-1234-5678)",
+ "type" : "ZWaveSetModeCompleteEvent"
} |
@@ -37331,13 +38678,13 @@ Generated events on method call
- | deviceURL |
- Device URL |
+ gatewayId |
+ Gateway id |
- | owningPartners |
- Owning partners of the parent entity (setup, ...)) . only available in event streams |
+ owningPartner |
+ Owning partner of the parent entity (gateway, setup group, ...)) . only available in event streams |
@@ -37345,6 +38692,11 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
@@ -37358,10 +38710,12 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
+ "setupOID" : "a setup OID",
"owningPartner" : "an owning partner",
"gatewayId" : "A gateway id (ex: 0101-1234-5678)",
- "name" : "ZWaveSetModeFailedEvent",
+ "type" : "ZWaveSetModeFailedEvent",
"failureType" : "NON_EXECUTING"
} |
@@ -37380,23 +38734,35 @@ Generated events on method call
Owning partner of the parent entity (gateway, setup group, ...)) . only available in event streams |
+
+ | setupOID |
+ Setup OID |
+
+
+
+ | siteOID |
+ Site OID |
+
+
- ZWaveSetModeCompleteEvent
+ DeviceDisabledEvent
| Description |
- |
+ Device is disabled |
| JSON |
{
- "timestamp" : 2,
- "owningPartner" : "an owning partner",
- "gatewayId" : "A gateway id (ex: 0101-1234-5678)",
- "name" : "ZWaveSetModeCompleteEvent"
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
+ "setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
+ "deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
+ "type" : "DeviceDisabledEvent"
} |
@@ -37405,13 +38771,23 @@ Generated events on method call
- | gatewayId |
- Gateway id |
+ deviceURL |
+ Device URL |
- | owningPartner |
- Owning partner of the parent entity (gateway, setup group, ...)) . only available in event streams |
+ owningPartners |
+ Owning partners of the parent entity (setup, ...)) . only available in event streams |
+
+
+
+ | setupOID |
+ Setup OID |
+
+
+
+ | siteOID |
+ Site OID |
@@ -37480,7 +38856,7 @@ Generated events on method call
Start a Z-Wave exclusion procedure.
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -37606,10 +38982,12 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
+ "setupOID" : "a setup OID",
"owningPartner" : "an owning partner",
"gatewayId" : "A gateway id (ex: 0101-1234-5678)",
- "name" : "ZWaveSetModeCompleteEvent"
+ "type" : "ZWaveSetModeCompleteEvent"
} |
@@ -37627,24 +39005,35 @@ Generated events on method call
Owning partner of the parent entity (gateway, setup group, ...)) . only available in event streams |
+
+ | setupOID |
+ Setup OID |
+
+
+
+ | siteOID |
+ Site OID |
+
+
- ZWaveSetModeFailedEvent
+ DeviceDisabledEvent
| Description |
- |
+ Device is disabled |
| JSON |
{
- "timestamp" : 2,
- "owningPartner" : "an owning partner",
- "gatewayId" : "A gateway id (ex: 0101-1234-5678)",
- "name" : "ZWaveSetModeFailedEvent",
- "failureType" : "NON_EXECUTING"
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
+ "setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
+ "deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
+ "type" : "DeviceDisabledEvent"
} |
@@ -37653,33 +39042,45 @@ Generated events on method call
- | gatewayId |
- Gateway id |
+ deviceURL |
+ Device URL |
- | owningPartner |
- Owning partner of the parent entity (gateway, setup group, ...)) . only available in event streams |
+ owningPartners |
+ Owning partners of the parent entity (setup, ...)) . only available in event streams |
+
+
+
+ | setupOID |
+ Setup OID |
+
+
+
+ | siteOID |
+ Site OID |
- DeviceDisabledEvent
+ ZWaveSetModeFailedEvent
| Description |
- Device is disabled |
+ |
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
- "deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
- "name" : "DeviceDisabledEvent"
+ "owningPartner" : "an owning partner",
+ "gatewayId" : "A gateway id (ex: 0101-1234-5678)",
+ "type" : "ZWaveSetModeFailedEvent",
+ "failureType" : "NON_EXECUTING"
} |
@@ -37688,13 +39089,13 @@ Generated events on method call
- | deviceURL |
- Device URL |
+ gatewayId |
+ Gateway id |
- | owningPartners |
- Owning partners of the parent entity (setup, ...)) . only available in event streams |
+ owningPartner |
+ Owning partner of the parent entity (gateway, setup group, ...)) . only available in event streams |
@@ -37702,6 +39103,11 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
@@ -37768,7 +39174,7 @@ Generated events on method call
Stop a Z-Wave exclusion procedure.
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -37870,7 +39276,7 @@ Generated events on method call
Generated events on method call
- ZWaveSetModeCompleteEvent
+ ZWaveSetModeFailedEvent
| Description |
|
@@ -37879,10 +39285,13 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
+ "setupOID" : "a setup OID",
"owningPartner" : "an owning partner",
"gatewayId" : "A gateway id (ex: 0101-1234-5678)",
- "name" : "ZWaveSetModeCompleteEvent"
+ "type" : "ZWaveSetModeFailedEvent",
+ "failureType" : "NON_EXECUTING"
} |
@@ -37900,11 +39309,21 @@ Generated events on method call
Owning partner of the parent entity (gateway, setup group, ...)) . only available in event streams |
+
+ | setupOID |
+ Setup OID |
+
+
+
+ | siteOID |
+ Site OID |
+
+
- ZWaveSetModeFailedEvent
+ ZWaveSetModeCompleteEvent
| Description |
|
@@ -37913,11 +39332,12 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
+ "setupOID" : "a setup OID",
"owningPartner" : "an owning partner",
"gatewayId" : "A gateway id (ex: 0101-1234-5678)",
- "name" : "ZWaveSetModeFailedEvent",
- "failureType" : "NON_EXECUTING"
+ "type" : "ZWaveSetModeCompleteEvent"
} |
@@ -37935,6 +39355,16 @@ Generated events on method call
Owning partner of the parent entity (gateway, setup group, ...)) . only available in event streams |
+
+ | setupOID |
+ Setup OID |
+
+
+
+ | siteOID |
+ Site OID |
+
+
@@ -38001,7 +39431,7 @@ Generated events on method call
Start a Z-Wave exclusion procedure.
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -38121,7 +39551,7 @@ Generated events on method call
Generated events on method call
- ZWaveSetModeFailedEvent
+ ZWaveSetModeCompleteEvent
| Description |
|
@@ -38130,11 +39560,12 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
+ "setupOID" : "a setup OID",
"owningPartner" : "an owning partner",
"gatewayId" : "A gateway id (ex: 0101-1234-5678)",
- "name" : "ZWaveSetModeFailedEvent",
- "failureType" : "NON_EXECUTING"
+ "type" : "ZWaveSetModeCompleteEvent"
} |
@@ -38152,23 +39583,35 @@ Generated events on method call
Owning partner of the parent entity (gateway, setup group, ...)) . only available in event streams |
+
+ | setupOID |
+ Setup OID |
+
+
+
+ | siteOID |
+ Site OID |
+
+
- ZWaveSetModeCompleteEvent
+ DeviceDisabledEvent
| Description |
- |
+ Device is disabled |
| JSON |
{
- "timestamp" : 2,
- "owningPartner" : "an owning partner",
- "gatewayId" : "A gateway id (ex: 0101-1234-5678)",
- "name" : "ZWaveSetModeCompleteEvent"
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
+ "setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
+ "deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
+ "type" : "DeviceDisabledEvent"
} |
@@ -38177,33 +39620,45 @@ Generated events on method call
- | gatewayId |
- Gateway id |
+ deviceURL |
+ Device URL |
- | owningPartner |
- Owning partner of the parent entity (gateway, setup group, ...)) . only available in event streams |
+ owningPartners |
+ Owning partners of the parent entity (setup, ...)) . only available in event streams |
+
+
+
+ | setupOID |
+ Setup OID |
+
+
+
+ | siteOID |
+ Site OID |
- DeviceDisabledEvent
+ ZWaveSetModeFailedEvent
| Description |
- Device is disabled |
+ |
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
- "deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
- "name" : "DeviceDisabledEvent"
+ "owningPartner" : "an owning partner",
+ "gatewayId" : "A gateway id (ex: 0101-1234-5678)",
+ "type" : "ZWaveSetModeFailedEvent",
+ "failureType" : "NON_EXECUTING"
} |
@@ -38212,13 +39667,13 @@ Generated events on method call
- | deviceURL |
- Device URL |
+ gatewayId |
+ Gateway id |
- | owningPartners |
- Owning partners of the parent entity (setup, ...)) . only available in event streams |
+ owningPartner |
+ Owning partner of the parent entity (gateway, setup group, ...)) . only available in event streams |
@@ -38226,6 +39681,11 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
@@ -38239,10 +39699,12 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
+ "setupOID" : "a setup OID",
"owningPartner" : "an owning partner",
"gatewayId" : "A gateway id (ex: 0101-1234-5678)",
- "name" : "ZWaveExclusionInOtherNetworkEvent"
+ "type" : "ZWaveExclusionInOtherNetworkEvent"
} |
@@ -38260,6 +39722,16 @@ Generated events on method call
Owning partner of the parent entity (gateway, setup group, ...)) . only available in event streams |
+
+ | setupOID |
+ Setup OID |
+
+
+
+ | siteOID |
+ Site OID |
+
+
@@ -38326,7 +39798,7 @@ Generated events on method call
Stop a Z-Wave exclusion procedure.
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -38437,10 +39909,12 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
+ "setupOID" : "a setup OID",
"owningPartner" : "an owning partner",
"gatewayId" : "A gateway id (ex: 0101-1234-5678)",
- "name" : "ZWaveSetModeFailedEvent",
+ "type" : "ZWaveSetModeFailedEvent",
"failureType" : "NON_EXECUTING"
} |
@@ -38459,6 +39933,16 @@ Generated events on method call
Owning partner of the parent entity (gateway, setup group, ...)) . only available in event streams |
+
+ | setupOID |
+ Setup OID |
+
+
+
+ | siteOID |
+ Site OID |
+
+
@@ -38472,10 +39956,12 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
+ "setupOID" : "a setup OID",
"owningPartner" : "an owning partner",
"gatewayId" : "A gateway id (ex: 0101-1234-5678)",
- "name" : "ZWaveSetModeCompleteEvent"
+ "type" : "ZWaveSetModeCompleteEvent"
} |
@@ -38493,6 +39979,16 @@ Generated events on method call
Owning partner of the parent entity (gateway, setup group, ...)) . only available in event streams |
+
+ | setupOID |
+ Setup OID |
+
+
+
+ | siteOID |
+ Site OID |
+
+
@@ -38560,7 +40056,7 @@ Generated events on method call
Start a Z-Wave exclusion procedure.
DEPRECATED: Use startExclusionWithMode command on transceiver controller.
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -38689,11 +40185,12 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
- "name" : "DeviceDisabledEvent"
+ "type" : "DeviceDisabledEvent"
} |
@@ -38716,11 +40213,16 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
- ZWaveSetModeFailedEvent
+ ZWaveSetModeCompleteEvent
| Description |
|
@@ -38729,11 +40231,12 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
+ "setupOID" : "a setup OID",
"owningPartner" : "an owning partner",
"gatewayId" : "A gateway id (ex: 0101-1234-5678)",
- "name" : "ZWaveSetModeFailedEvent",
- "failureType" : "NON_EXECUTING"
+ "type" : "ZWaveSetModeCompleteEvent"
} |
@@ -38751,23 +40254,36 @@ Generated events on method call
Owning partner of the parent entity (gateway, setup group, ...)) . only available in event streams |
+
+ | setupOID |
+ Setup OID |
+
+
+
+ | siteOID |
+ Site OID |
+
+
- ZWaveExclusionInOtherNetworkEvent
+ ZWaveSetModeFailedEvent
| Description |
- A device is excluded from other zwave network |
+ |
| JSON |
{
- "timestamp" : 2,
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
+ "setupOID" : "a setup OID",
"owningPartner" : "an owning partner",
"gatewayId" : "A gateway id (ex: 0101-1234-5678)",
- "name" : "ZWaveExclusionInOtherNetworkEvent"
+ "type" : "ZWaveSetModeFailedEvent",
+ "failureType" : "NON_EXECUTING"
} |
@@ -38785,23 +40301,35 @@ Generated events on method call
Owning partner of the parent entity (gateway, setup group, ...)) . only available in event streams |
+
+ | setupOID |
+ Setup OID |
+
+
+
+ | siteOID |
+ Site OID |
+
+
- ZWaveSetModeCompleteEvent
+ ZWaveExclusionInOtherNetworkEvent
| Description |
- |
+ A device is excluded from other zwave network |
| JSON |
{
- "timestamp" : 2,
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
+ "setupOID" : "a setup OID",
"owningPartner" : "an owning partner",
"gatewayId" : "A gateway id (ex: 0101-1234-5678)",
- "name" : "ZWaveSetModeCompleteEvent"
+ "type" : "ZWaveExclusionInOtherNetworkEvent"
} |
@@ -38819,6 +40347,16 @@ Generated events on method call
Owning partner of the parent entity (gateway, setup group, ...)) . only available in event streams |
+
+ | setupOID |
+ Setup OID |
+
+
+
+ | siteOID |
+ Site OID |
+
+
@@ -38886,7 +40424,7 @@ Generated events on method call
Stop a Z-Wave exclusion procedure.
DEPRECATED: Use stopExclusion command on transceiver controller.
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -38997,10 +40535,12 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
+ "setupOID" : "a setup OID",
"owningPartner" : "an owning partner",
"gatewayId" : "A gateway id (ex: 0101-1234-5678)",
- "name" : "ZWaveSetModeFailedEvent",
+ "type" : "ZWaveSetModeFailedEvent",
"failureType" : "NON_EXECUTING"
} |
@@ -39019,6 +40559,16 @@ Generated events on method call
Owning partner of the parent entity (gateway, setup group, ...)) . only available in event streams |
+
+ | setupOID |
+ Setup OID |
+
+
+
+ | siteOID |
+ Site OID |
+
+
@@ -39032,10 +40582,12 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
+ "setupOID" : "a setup OID",
"owningPartner" : "an owning partner",
"gatewayId" : "A gateway id (ex: 0101-1234-5678)",
- "name" : "ZWaveSetModeCompleteEvent"
+ "type" : "ZWaveSetModeCompleteEvent"
} |
@@ -39053,6 +40605,16 @@ Generated events on method call
Owning partner of the parent entity (gateway, setup group, ...)) . only available in event streams |
+
+ | setupOID |
+ Setup OID |
+
+
+
+ | siteOID |
+ Site OID |
+
+
@@ -39120,7 +40682,7 @@ Generated events on method call
Check if device is failed.
DEPRECATED: Use isFailedDevice command on transceiver controller.
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -39296,7 +40858,7 @@ Generated events on method call
Delete a failed device
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -39473,7 +41035,7 @@ Generated events on method call
Z-Wave : replace a given failed node.
DEPRECATED: Use replaceFailedDevice command on transceiver controller.
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -39649,7 +41211,7 @@ Generated events on method call
Start a Z-Wave inclusion procedure.
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -39751,7 +41313,7 @@ Generated events on method call
Generated events on method call
- ZWaveSetModeFailedEvent
+ ZWaveSetModeCompleteEvent
| Description |
|
@@ -39760,11 +41322,12 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
+ "setupOID" : "a setup OID",
"owningPartner" : "an owning partner",
"gatewayId" : "A gateway id (ex: 0101-1234-5678)",
- "name" : "ZWaveSetModeFailedEvent",
- "failureType" : "NON_EXECUTING"
+ "type" : "ZWaveSetModeCompleteEvent"
} |
@@ -39782,11 +41345,21 @@ Generated events on method call
Owning partner of the parent entity (gateway, setup group, ...)) . only available in event streams |
+
+ | setupOID |
+ Setup OID |
+
+
+
+ | siteOID |
+ Site OID |
+
+
- ZWaveSetModeCompleteEvent
+ ZWaveSetModeFailedEvent
| Description |
|
@@ -39795,10 +41368,13 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
+ "setupOID" : "a setup OID",
"owningPartner" : "an owning partner",
"gatewayId" : "A gateway id (ex: 0101-1234-5678)",
- "name" : "ZWaveSetModeCompleteEvent"
+ "type" : "ZWaveSetModeFailedEvent",
+ "failureType" : "NON_EXECUTING"
} |
@@ -39816,6 +41392,16 @@ Generated events on method call
Owning partner of the parent entity (gateway, setup group, ...)) . only available in event streams |
+
+ | setupOID |
+ Setup OID |
+
+
+
+ | siteOID |
+ Site OID |
+
+
@@ -39882,7 +41468,7 @@ Generated events on method call
Start a Z-Wave inclusion procedure.
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -40008,10 +41594,12 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
+ "setupOID" : "a setup OID",
"owningPartner" : "an owning partner",
"gatewayId" : "A gateway id (ex: 0101-1234-5678)",
- "name" : "ZWaveSetModeCompleteEvent"
+ "type" : "ZWaveSetModeCompleteEvent"
} |
@@ -40029,6 +41617,16 @@ Generated events on method call
Owning partner of the parent entity (gateway, setup group, ...)) . only available in event streams |
+
+ | setupOID |
+ Setup OID |
+
+
+
+ | siteOID |
+ Site OID |
+
+
@@ -40042,10 +41640,12 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
+ "setupOID" : "a setup OID",
"owningPartner" : "an owning partner",
"gatewayId" : "A gateway id (ex: 0101-1234-5678)",
- "name" : "ZWaveSetModeFailedEvent",
+ "type" : "ZWaveSetModeFailedEvent",
"failureType" : "NON_EXECUTING"
} |
@@ -40064,6 +41664,16 @@ Generated events on method call
Owning partner of the parent entity (gateway, setup group, ...)) . only available in event streams |
+
+ | setupOID |
+ Setup OID |
+
+
+
+ | siteOID |
+ Site OID |
+
+
@@ -40130,7 +41740,7 @@ Generated events on method call
Stop a Z-Wave exclusion procedure.
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -40241,10 +41851,12 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
+ "setupOID" : "a setup OID",
"owningPartner" : "an owning partner",
"gatewayId" : "A gateway id (ex: 0101-1234-5678)",
- "name" : "ZWaveSetModeCompleteEvent"
+ "type" : "ZWaveSetModeCompleteEvent"
} |
@@ -40262,6 +41874,16 @@ Generated events on method call
Owning partner of the parent entity (gateway, setup group, ...)) . only available in event streams |
+
+ | setupOID |
+ Setup OID |
+
+
+
+ | siteOID |
+ Site OID |
+
+
@@ -40275,10 +41897,12 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
+ "setupOID" : "a setup OID",
"owningPartner" : "an owning partner",
"gatewayId" : "A gateway id (ex: 0101-1234-5678)",
- "name" : "ZWaveSetModeFailedEvent",
+ "type" : "ZWaveSetModeFailedEvent",
"failureType" : "NON_EXECUTING"
} |
@@ -40297,6 +41921,16 @@ Generated events on method call
Owning partner of the parent entity (gateway, setup group, ...)) . only available in event streams |
+
+ | setupOID |
+ Setup OID |
+
+
+
+ | siteOID |
+ Site OID |
+
+
@@ -40363,7 +41997,7 @@ Generated events on method call
Start a Z-Wave inclusion procedure.
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -40483,7 +42117,7 @@ Generated events on method call
Generated events on method call
- ZWaveSetModeFailedEvent
+ ZWaveSetModeCompleteEvent
| Description |
|
@@ -40492,11 +42126,12 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
+ "setupOID" : "a setup OID",
"owningPartner" : "an owning partner",
"gatewayId" : "A gateway id (ex: 0101-1234-5678)",
- "name" : "ZWaveSetModeFailedEvent",
- "failureType" : "NON_EXECUTING"
+ "type" : "ZWaveSetModeCompleteEvent"
} |
@@ -40514,11 +42149,21 @@ Generated events on method call
Owning partner of the parent entity (gateway, setup group, ...)) . only available in event streams |
+
+ | setupOID |
+ Setup OID |
+
+
+
+ | siteOID |
+ Site OID |
+
+
- ZWaveSetModeCompleteEvent
+ ZWaveSetModeFailedEvent
| Description |
|
@@ -40527,10 +42172,13 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
+ "setupOID" : "a setup OID",
"owningPartner" : "an owning partner",
"gatewayId" : "A gateway id (ex: 0101-1234-5678)",
- "name" : "ZWaveSetModeCompleteEvent"
+ "type" : "ZWaveSetModeFailedEvent",
+ "failureType" : "NON_EXECUTING"
} |
@@ -40548,6 +42196,16 @@ Generated events on method call
Owning partner of the parent entity (gateway, setup group, ...)) . only available in event streams |
+
+ | setupOID |
+ Setup OID |
+
+
+
+ | siteOID |
+ Site OID |
+
+
@@ -40614,7 +42272,7 @@ Generated events on method call
Stop a Z-Wave exclusion procedure.
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -40725,10 +42383,12 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
+ "setupOID" : "a setup OID",
"owningPartner" : "an owning partner",
"gatewayId" : "A gateway id (ex: 0101-1234-5678)",
- "name" : "ZWaveSetModeFailedEvent",
+ "type" : "ZWaveSetModeFailedEvent",
"failureType" : "NON_EXECUTING"
} |
@@ -40747,6 +42407,16 @@ Generated events on method call
Owning partner of the parent entity (gateway, setup group, ...)) . only available in event streams |
+
+ | setupOID |
+ Setup OID |
+
+
+
+ | siteOID |
+ Site OID |
+
+
@@ -40760,10 +42430,12 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
+ "setupOID" : "a setup OID",
"owningPartner" : "an owning partner",
"gatewayId" : "A gateway id (ex: 0101-1234-5678)",
- "name" : "ZWaveSetModeCompleteEvent"
+ "type" : "ZWaveSetModeCompleteEvent"
} |
@@ -40781,6 +42453,16 @@ Generated events on method call
Owning partner of the parent entity (gateway, setup group, ...)) . only available in event streams |
+
+ | setupOID |
+ Setup OID |
+
+
+
+ | siteOID |
+ Site OID |
+
+
@@ -40848,7 +42530,7 @@ Generated events on method call
Start a Z-Wave inclusion procedure.
DEPRECATED: Use startInclusionWithMode command on transceiver controller.
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -40978,10 +42660,12 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
+ "setupOID" : "a setup OID",
"owningPartner" : "an owning partner",
"gatewayId" : "A gateway id (ex: 0101-1234-5678)",
- "name" : "ZWaveSetModeCompleteEvent"
+ "type" : "ZWaveSetModeCompleteEvent"
} |
@@ -40999,6 +42683,16 @@ Generated events on method call
Owning partner of the parent entity (gateway, setup group, ...)) . only available in event streams |
+
+ | setupOID |
+ Setup OID |
+
+
+
+ | siteOID |
+ Site OID |
+
+
@@ -41012,10 +42706,12 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
+ "setupOID" : "a setup OID",
"owningPartner" : "an owning partner",
"gatewayId" : "A gateway id (ex: 0101-1234-5678)",
- "name" : "ZWaveSetModeFailedEvent",
+ "type" : "ZWaveSetModeFailedEvent",
"failureType" : "NON_EXECUTING"
} |
@@ -41034,6 +42730,16 @@ Generated events on method call
Owning partner of the parent entity (gateway, setup group, ...)) . only available in event streams |
+
+ | setupOID |
+ Setup OID |
+
+
+
+ | siteOID |
+ Site OID |
+
+
@@ -41047,11 +42753,13 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
+ "setupOID" : "a setup OID",
"owningPartner" : "an owning partner",
"gatewayId" : "A gateway id (ex: 0101-1234-5678)",
"deviceSecurityKey" : "28953-04992-55692-50731-21112-52062-29652-14707",
- "name" : "ZWaveNewClientSideAuthenticationDSKEvent"
+ "type" : "ZWaveNewClientSideAuthenticationDSKEvent"
} |
@@ -41074,6 +42782,16 @@ Generated events on method call
Owning partner of the parent entity (gateway, setup group, ...)) . only available in event streams |
+
+ | setupOID |
+ Setup OID |
+
+
+
+ | siteOID |
+ Site OID |
+
+
@@ -41141,7 +42859,7 @@ Generated events on method call
Stop a Z-Wave inclusion procedure.
DEPRECATED: Use stopInclusion command on transceiver controller.
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -41243,7 +42961,7 @@ Generated events on method call
Generated events on method call
- ZWaveSetModeFailedEvent
+ ZWaveSetModeCompleteEvent
| Description |
|
@@ -41252,11 +42970,12 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
+ "setupOID" : "a setup OID",
"owningPartner" : "an owning partner",
"gatewayId" : "A gateway id (ex: 0101-1234-5678)",
- "name" : "ZWaveSetModeFailedEvent",
- "failureType" : "NON_EXECUTING"
+ "type" : "ZWaveSetModeCompleteEvent"
} |
@@ -41274,11 +42993,21 @@ Generated events on method call
Owning partner of the parent entity (gateway, setup group, ...)) . only available in event streams |
+
+ | setupOID |
+ Setup OID |
+
+
+
+ | siteOID |
+ Site OID |
+
+
- ZWaveSetModeCompleteEvent
+ ZWaveSetModeFailedEvent
| Description |
|
@@ -41287,10 +43016,13 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
+ "setupOID" : "a setup OID",
"owningPartner" : "an owning partner",
"gatewayId" : "A gateway id (ex: 0101-1234-5678)",
- "name" : "ZWaveSetModeCompleteEvent"
+ "type" : "ZWaveSetModeFailedEvent",
+ "failureType" : "NON_EXECUTING"
} |
@@ -41308,6 +43040,16 @@ Generated events on method call
Owning partner of the parent entity (gateway, setup group, ...)) . only available in event streams |
+
+ | setupOID |
+ Setup OID |
+
+
+
+ | siteOID |
+ Site OID |
+
+
@@ -41375,7 +43117,7 @@ Generated events on method call
Z-Wave : start learning mode.
DEPRECATED: Use startLearnWithMode command on transceiver controller.
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -41555,7 +43297,7 @@ Generated events on method call
Z-Wave : stop learning mode.
DEPRECATED: Use stopLearn command on transceiver controller.
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -41715,7 +43457,7 @@ Generated events on method call
Launch the refresh operation on the corresponding association group.
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -41856,27 +43598,33 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"execId" : "an exec id",
"newState" : "IN_PROGRESS",
"ownerKey" : "an owner key",
- "type" : 1,
+ "executionType" : 1,
"subType" : 1,
"oldState" : "TRANSMITTED",
"timeToNextState" : 2,
"failedCommands" : [ {
"deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
"detailedStatus" : {
+ "type" : "generic-error",
"message" : "a message",
"error" : true
},
"rank" : 1,
"failureType" : "NON_EXECUTING"
} ],
+ "relatedDevices" : [ {
+ "deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])"
+ } ],
+ "technical" : false,
"failureTypeCode" : 11,
- "name" : "ExecutionStateChangedEvent",
+ "type" : "ExecutionStateChangedEvent",
"failureType" : "NON_EXECUTING"
} |
@@ -41890,6 +43638,11 @@ Generated events on method call
Execution id |
+
+ | executionType |
+ Execution type |
+
+
| failedCommands |
List of failed commands |
@@ -41920,11 +43673,21 @@ Generated events on method call
Owning partners of the parent entity (setup, ...)) . only available in event streams |
+
+ | relatedDevices |
+ List of devices involved in this execution |
+
+
| setupOID |
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
| subType |
Execution sub type |
@@ -41935,11 +43698,6 @@ Generated events on method call
Remaining time until next execution state |
-
- | type |
- Execution type |
-
-
@@ -42005,7 +43763,7 @@ Generated events on method call
Launch the refresh operation on all the association groups available on the node.
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -42131,27 +43889,33 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"execId" : "an exec id",
"newState" : "IN_PROGRESS",
"ownerKey" : "an owner key",
- "type" : 1,
+ "executionType" : 1,
"subType" : 1,
"oldState" : "TRANSMITTED",
"timeToNextState" : 2,
"failedCommands" : [ {
"deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
"detailedStatus" : {
+ "type" : "generic-error",
"message" : "a message",
"error" : true
},
"rank" : 1,
"failureType" : "NON_EXECUTING"
} ],
+ "relatedDevices" : [ {
+ "deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])"
+ } ],
+ "technical" : false,
"failureTypeCode" : 11,
- "name" : "ExecutionStateChangedEvent",
+ "type" : "ExecutionStateChangedEvent",
"failureType" : "NON_EXECUTING"
} |
@@ -42165,6 +43929,11 @@ Generated events on method call
Execution id |
+
+ | executionType |
+ Execution type |
+
+
| failedCommands |
List of failed commands |
@@ -42195,11 +43964,21 @@ Generated events on method call
Owning partners of the parent entity (setup, ...)) . only available in event streams |
+
+ | relatedDevices |
+ List of devices involved in this execution |
+
+
| setupOID |
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
| subType |
Execution sub type |
@@ -42210,11 +43989,6 @@ Generated events on method call
Remaining time until next execution state |
-
- | type |
- Execution type |
-
-
@@ -42280,7 +44054,7 @@ Generated events on method call
Start a Z-Wave reset procedure.
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -42362,10 +44136,12 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
+ "setupOID" : "a setup OID",
"owningPartner" : "an owning partner",
"gatewayId" : "A gateway id (ex: 0101-1234-5678)",
- "name" : "ZWaveResetCompleteEvent"
+ "type" : "ZWaveResetCompleteEvent"
} |
@@ -42383,6 +44159,16 @@ Generated events on method call
Owning partner of the parent entity (gateway, setup group, ...)) . only available in event streams |
+
+ | setupOID |
+ Setup OID |
+
+
+
+ | siteOID |
+ Site OID |
+
+
@@ -42396,10 +44182,12 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
+ "setupOID" : "a setup OID",
"owningPartner" : "an owning partner",
"gatewayId" : "A gateway id (ex: 0101-1234-5678)",
- "name" : "ZWaveResetFailedEvent",
+ "type" : "ZWaveResetFailedEvent",
"failureType" : "NON_EXECUTING"
} |
@@ -42418,6 +44206,16 @@ Generated events on method call
Owning partner of the parent entity (gateway, setup group, ...)) . only available in event streams |
+
+ | setupOID |
+ Setup OID |
+
+
+
+ | siteOID |
+ Site OID |
+
+
@@ -42431,11 +44229,12 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
- "name" : "DeviceDisabledEvent"
+ "type" : "DeviceDisabledEvent"
} |
@@ -42458,6 +44257,11 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
@@ -42523,7 +44327,7 @@ Generated events on method call
Retrieve the last association information sent by the product for the corresponding groupId. Be aware that this information might no be up to date. The 'Association refresh' APIs shall be called to explicitly retrieve the association information from the product.
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -42715,7 +44519,7 @@ Generated events on method call
Retrieve the last association information sent by the product. Be aware that this information might no be up to date. The 'Association refresh' APIs shall be called to explicitly retrieve the association information from the product.
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -42895,7 +44699,7 @@ Generated events on method call
Set the corresponding association group.
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -43051,27 +44855,33 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"execId" : "an exec id",
"newState" : "IN_PROGRESS",
"ownerKey" : "an owner key",
- "type" : 1,
+ "executionType" : 1,
"subType" : 1,
"oldState" : "TRANSMITTED",
"timeToNextState" : 2,
"failedCommands" : [ {
"deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
"detailedStatus" : {
+ "type" : "generic-error",
"message" : "a message",
"error" : true
},
"rank" : 1,
"failureType" : "NON_EXECUTING"
} ],
+ "relatedDevices" : [ {
+ "deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])"
+ } ],
+ "technical" : false,
"failureTypeCode" : 11,
- "name" : "ExecutionStateChangedEvent",
+ "type" : "ExecutionStateChangedEvent",
"failureType" : "NON_EXECUTING"
} |
@@ -43085,6 +44895,11 @@ Generated events on method call
Execution id |
+
+ | executionType |
+ Execution type |
+
+
| failedCommands |
List of failed commands |
@@ -43115,11 +44930,21 @@ Generated events on method call
Owning partners of the parent entity (setup, ...)) . only available in event streams |
+
+ | relatedDevices |
+ List of devices involved in this execution |
+
+
| setupOID |
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
| subType |
Execution sub type |
@@ -43130,11 +44955,6 @@ Generated events on method call
Remaining time until next execution state |
-
- | type |
- Execution type |
-
-
@@ -43229,7 +45049,7 @@
Bind all device state
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -43331,20 +45151,21 @@
Generated events on method call
- ZigbeeBindNetworkFailedEvent
+ ZigbeeBindNetworkCompletedEvent
| Description |
- When zigbee network cannot be bound |
+ When zigbee network is bound |
| JSON |
{
- "timestamp" : 2,
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
+ "setupOID" : "a setup OID",
"owningPartner" : "an owning partner",
"gatewayId" : "A gateway id (ex: 0101-1234-5678)",
- "name" : "ZigbeeBindNetworkFailedEvent",
- "failureType" : "NON_EXECUTING"
+ "type" : "ZigbeeBindNetworkCompletedEvent"
} |
@@ -43362,28 +45183,36 @@ Generated events on method call
Owning partner of the parent entity (gateway, setup group, ...)) . only available in event streams |
+
+ | setupOID |
+ Setup OID |
+
+
+
+ | siteOID |
+ Site OID |
+
+
- DeviceUpdatedEvent
+ ZigbeeBindNetworkFailedEvent
| Description |
- Device has been updated |
+ When zigbee network cannot be bound |
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
- "deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
- "controllableName" : "a controllable name",
- "label" : "a device updated event label",
- "placeOID" : "a place OID",
- "metadata" : "some metadata",
- "name" : "DeviceUpdatedEvent"
+ "owningPartner" : "an owning partner",
+ "gatewayId" : "A gateway id (ex: 0101-1234-5678)",
+ "type" : "ZigbeeBindNetworkFailedEvent",
+ "failureType" : "NON_EXECUTING"
} |
@@ -43392,13 +45221,13 @@ Generated events on method call
- | deviceURL |
- Device URL |
+ gatewayId |
+ Gateway id |
- | owningPartners |
- Owning partners of the parent entity (setup, ...)) . only available in event streams |
+ owningPartner |
+ Owning partner of the parent entity (gateway, setup group, ...)) . only available in event streams |
@@ -43406,23 +45235,34 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
- ZigbeeBindNetworkCompletedEvent
+ DeviceUpdatedEvent
| Description |
- When zigbee network is bound |
+ Device has been updated |
| JSON |
{
- "timestamp" : 2,
- "owningPartner" : "an owning partner",
- "gatewayId" : "A gateway id (ex: 0101-1234-5678)",
- "name" : "ZigbeeBindNetworkCompletedEvent"
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
+ "setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
+ "deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
+ "controllableName" : "a controllable name",
+ "label" : "a device updated event label",
+ "placeOID" : "a place OID",
+ "metadata" : "some metadata",
+ "type" : "DeviceUpdatedEvent"
} |
@@ -43431,13 +45271,23 @@ Generated events on method call
- | gatewayId |
- Gateway id |
+ deviceURL |
+ Device URL |
- | owningPartner |
- Owning partner of the parent entity (gateway, setup group, ...)) . only available in event streams |
+ owningPartners |
+ Owning partners of the parent entity (setup, ...)) . only available in event streams |
+
+
+
+ | setupOID |
+ Setup OID |
+
+
+
+ | siteOID |
+ Site OID |
@@ -43505,7 +45355,7 @@ Generated events on method call
Create a new network (leave any existing network before calling this api)
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -43607,29 +45457,21 @@ Generated events on method call
Generated events on method call
- DeviceCreatedEvent
+ ZigbeeCreateNetworkCompletedEvent
| Description |
- A new device has been added to the setup |
+ The new Zigbee network has been successfully created |
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
- "deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
- "controllableName" : "a controllable name",
- "label" : "a device created event label",
- "placeOID" : "a place OID",
- "metadata" : "some metadata",
- "deviceAttributes" : [ {
- "name" : "a device attribute change item name",
- "type" : 1,
- "value" : "a device attribute change item value"
- } ],
- "name" : "DeviceCreatedEvent"
+ "owningPartner" : "an owning partner",
+ "gatewayId" : "A gateway id (ex: 0101-1234-5678)",
+ "type" : "ZigbeeCreateNetworkCompletedEvent"
} |
@@ -43638,42 +45480,53 @@ Generated events on method call
- | deviceAttributes |
- Compatible device attributes |
+ gatewayId |
+ Gateway id |
- | deviceURL |
- Device URL |
+ owningPartner |
+ Owning partner of the parent entity (gateway, setup group, ...)) . only available in event streams |
- | owningPartners |
- Owning partners of the parent entity (setup, ...)) . only available in event streams |
+ setupOID |
+ Setup OID |
- | setupOID |
- Setup OID |
+ siteOID |
+ Site OID |
- ZigbeeCreateNetworkCompletedEvent
+ DeviceCreatedEvent
| Description |
- The new Zigbee network has been successfully created |
+ A new device has been added to the setup |
| JSON |
{
- "timestamp" : 2,
- "owningPartner" : "an owning partner",
- "gatewayId" : "A gateway id (ex: 0101-1234-5678)",
- "name" : "ZigbeeCreateNetworkCompletedEvent"
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
+ "setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
+ "deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
+ "controllableName" : "a controllable name",
+ "label" : "a device created event label",
+ "placeOID" : "a place OID",
+ "metadata" : "some metadata",
+ "deviceAttributes" : [ {
+ "name" : "a device attribute change item name",
+ "type" : 1,
+ "value" : "a device attribute change item value"
+ } ],
+ "type" : "DeviceCreatedEvent"
} |
@@ -43682,13 +45535,28 @@ Generated events on method call
- | gatewayId |
- Gateway id |
+ deviceAttributes |
+ Compatible device attributes |
- | owningPartner |
- Owning partner of the parent entity (gateway, setup group, ...)) . only available in event streams |
+ deviceURL |
+ Device URL |
+
+
+
+ | owningPartners |
+ Owning partners of the parent entity (setup, ...)) . only available in event streams |
+
+
+
+ | setupOID |
+ Setup OID |
+
+
+
+ | siteOID |
+ Site OID |
@@ -43704,10 +45572,12 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
+ "setupOID" : "a setup OID",
"owningPartner" : "an owning partner",
"gatewayId" : "A gateway id (ex: 0101-1234-5678)",
- "name" : "ZigbeeCreateNetworkFailedEvent",
+ "type" : "ZigbeeCreateNetworkFailedEvent",
"failureType" : "NON_EXECUTING"
} |
@@ -43726,6 +45596,16 @@ Generated events on method call
Owning partner of the parent entity (gateway, setup group, ...)) . only available in event streams |
+
+ | setupOID |
+ Setup OID |
+
+
+
+ | siteOID |
+ Site OID |
+
+
@@ -43791,7 +45671,7 @@ Generated events on method call
Create a new network on restricted channels (leave any existing network before calling this api)
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -43917,10 +45797,12 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
+ "setupOID" : "a setup OID",
"owningPartner" : "an owning partner",
"gatewayId" : "A gateway id (ex: 0101-1234-5678)",
- "name" : "ZigbeeCreateNetworkFailedEvent",
+ "type" : "ZigbeeCreateNetworkFailedEvent",
"failureType" : "NON_EXECUTING"
} |
@@ -43939,6 +45821,16 @@ Generated events on method call
Owning partner of the parent entity (gateway, setup group, ...)) . only available in event streams |
+
+ | setupOID |
+ Setup OID |
+
+
+
+ | siteOID |
+ Site OID |
+
+
@@ -43952,9 +45844,10 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
"controllableName" : "a controllable name",
"label" : "a device created event label",
@@ -43965,7 +45858,7 @@ Generated events on method call
"type" : 1,
"value" : "a device attribute change item value"
} ],
- "name" : "DeviceCreatedEvent"
+ "type" : "DeviceCreatedEvent"
} |
@@ -43993,6 +45886,11 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
@@ -44006,10 +45904,12 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
+ "setupOID" : "a setup OID",
"owningPartner" : "an owning partner",
"gatewayId" : "A gateway id (ex: 0101-1234-5678)",
- "name" : "ZigbeeCreateNetworkCompletedEvent"
+ "type" : "ZigbeeCreateNetworkCompletedEvent"
} |
@@ -44027,6 +45927,16 @@ Generated events on method call
Owning partner of the parent entity (gateway, setup group, ...)) . only available in event streams |
+
+ | setupOID |
+ Setup OID |
+
+
+
+ | siteOID |
+ Site OID |
+
+
@@ -44092,7 +46002,7 @@ Generated events on method call
Join a open network
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -44193,6 +46103,52 @@ Generated events on method call
Generated events on method call
+
+ ZigbeeJoinNetworkCompletedEvent
+
+ | Description |
+ When zigbee network is joined |
+
+
+
+ | JSON |
+ {
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
+ "setupOID" : "a setup OID",
+ "owningPartner" : "an owning partner",
+ "gatewayId" : "A gateway id (ex: 0101-1234-5678)",
+ "type" : "ZigbeeJoinNetworkCompletedEvent"
+} |
+
+
+ | Field name |
+ Field description |
+
+
+
+ | gatewayId |
+ Gateway id |
+
+
+
+ | owningPartner |
+ Owning partner of the parent entity (gateway, setup group, ...)) . only available in event streams |
+
+
+
+ | setupOID |
+ Setup OID |
+
+
+
+ | siteOID |
+ Site OID |
+
+
+
+
+
DeviceCreatedEvent
@@ -44203,9 +46159,10 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
"controllableName" : "a controllable name",
"label" : "a device created event label",
@@ -44216,7 +46173,7 @@ Generated events on method call
"type" : 1,
"value" : "a device attribute change item value"
} ],
- "name" : "DeviceCreatedEvent"
+ "type" : "DeviceCreatedEvent"
} |
@@ -44244,6 +46201,11 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
@@ -44257,10 +46219,12 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
+ "setupOID" : "a setup OID",
"owningPartner" : "an owning partner",
"gatewayId" : "A gateway id (ex: 0101-1234-5678)",
- "name" : "ZigbeeJoinNetworkFailedEvent",
+ "type" : "ZigbeeJoinNetworkFailedEvent",
"failureType" : "NON_EXECUTING"
} |
@@ -44279,38 +46243,14 @@ Generated events on method call
Owning partner of the parent entity (gateway, setup group, ...)) . only available in event streams |
-
-
-
-
- ZigbeeJoinNetworkCompletedEvent
-
- | Description |
- When zigbee network is joined |
-
-
-
- | JSON |
- {
- "timestamp" : 2,
- "owningPartner" : "an owning partner",
- "gatewayId" : "A gateway id (ex: 0101-1234-5678)",
- "name" : "ZigbeeJoinNetworkCompletedEvent"
-} |
-
-
- | Field name |
- Field description |
-
-
- | gatewayId |
- Gateway id |
+ setupOID |
+ Setup OID |
- | owningPartner |
- Owning partner of the parent entity (gateway, setup group, ...)) . only available in event streams |
+ siteOID |
+ Site OID |
@@ -44378,7 +46318,7 @@ Generated events on method call
Leave the network
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -44480,20 +46420,21 @@ Generated events on method call
Generated events on method call
- ZigbeeLeaveNetworkFailedEvent
+ ZigbeeLeaveNetworkCompletedEvent
| Description |
- When zigbee network cannot be left |
+ When zigbee network is left |
| JSON |
{
- "timestamp" : 2,
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
+ "setupOID" : "a setup OID",
"owningPartner" : "an owning partner",
"gatewayId" : "A gateway id (ex: 0101-1234-5678)",
- "name" : "ZigbeeLeaveNetworkFailedEvent",
- "failureType" : "NON_EXECUTING"
+ "type" : "ZigbeeLeaveNetworkCompletedEvent"
} |
@@ -44511,23 +46452,36 @@ Generated events on method call
Owning partner of the parent entity (gateway, setup group, ...)) . only available in event streams |
+
+ | setupOID |
+ Setup OID |
+
+
+
+ | siteOID |
+ Site OID |
+
+
- ZigbeeLeaveNetworkCompletedEvent
+ DeviceRemovedEvent
| Description |
- When zigbee network is left |
+ A device has been removed from the gateway |
| JSON |
{
- "timestamp" : 2,
- "owningPartner" : "an owning partner",
- "gatewayId" : "A gateway id (ex: 0101-1234-5678)",
- "name" : "ZigbeeLeaveNetworkCompletedEvent"
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
+ "setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
+ "deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
+ "controllableName" : "a controllable name",
+ "type" : "DeviceRemovedEvent"
} |
@@ -44536,34 +46490,45 @@ Generated events on method call
- | gatewayId |
- Gateway id |
+ deviceURL |
+ Device URL |
- | owningPartner |
- Owning partner of the parent entity (gateway, setup group, ...)) . only available in event streams |
+ owningPartners |
+ Owning partners of the parent entity (setup, ...)) . only available in event streams |
+
+
+
+ | setupOID |
+ Setup OID |
+
+
+
+ | siteOID |
+ Site OID |
- DeviceRemovedEvent
+ ZigbeeLeaveNetworkFailedEvent
| Description |
- A device has been removed from the gateway |
+ When zigbee network cannot be left |
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
- "deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
- "controllableName" : "a controllable name",
- "name" : "DeviceRemovedEvent"
+ "owningPartner" : "an owning partner",
+ "gatewayId" : "A gateway id (ex: 0101-1234-5678)",
+ "type" : "ZigbeeLeaveNetworkFailedEvent",
+ "failureType" : "NON_EXECUTING"
} |
@@ -44572,13 +46537,13 @@ Generated events on method call
- | deviceURL |
- Device URL |
+ gatewayId |
+ Gateway id |
- | owningPartners |
- Owning partners of the parent entity (setup, ...)) . only available in event streams |
+ owningPartner |
+ Owning partner of the parent entity (gateway, setup group, ...)) . only available in event streams |
@@ -44586,6 +46551,11 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
@@ -44651,7 +46621,7 @@ Generated events on method call
Refresh all device state
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -44752,41 +46722,6 @@ Generated events on method call
Generated events on method call
-
- ZigbeeRefreshNetworkFailedEvent
-
- | Description |
- When zigbee network cannot be refreshed |
-
-
-
- | JSON |
- {
- "timestamp" : 2,
- "owningPartner" : "an owning partner",
- "gatewayId" : "A gateway id (ex: 0101-1234-5678)",
- "name" : "ZigbeeRefreshNetworkFailedEvent",
- "failureType" : "NON_EXECUTING"
-} |
-
-
- | Field name |
- Field description |
-
-
-
- | gatewayId |
- Gateway id |
-
-
-
- | owningPartner |
- Owning partner of the parent entity (gateway, setup group, ...)) . only available in event streams |
-
-
-
-
-
DeviceStateChangedEvent
@@ -44797,16 +46732,17 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
"deviceStates" : [ {
"name" : "a device state change item name",
"type" : 1,
"value" : "a device state change item value"
} ],
- "name" : "DeviceStateChangedEvent"
+ "type" : "DeviceStateChangedEvent"
} |
@@ -44834,6 +46770,11 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
@@ -44847,9 +46788,10 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
"controllableName" : "a controllable name",
"label" : "a device created event label",
@@ -44860,7 +46802,7 @@ Generated events on method call
"type" : 1,
"value" : "a device attribute change item value"
} ],
- "name" : "DeviceCreatedEvent"
+ "type" : "DeviceCreatedEvent"
} |
@@ -44888,6 +46830,11 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
@@ -44901,10 +46848,12 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
+ "setupOID" : "a setup OID",
"owningPartner" : "an owning partner",
"gatewayId" : "A gateway id (ex: 0101-1234-5678)",
- "name" : "ZigbeeRefreshNetworkCompletedEvent"
+ "type" : "ZigbeeRefreshNetworkCompletedEvent"
} |
@@ -44922,6 +46871,63 @@ Generated events on method call
Owning partner of the parent entity (gateway, setup group, ...)) . only available in event streams |
+
+ | setupOID |
+ Setup OID |
+
+
+
+ | siteOID |
+ Site OID |
+
+
+
+
+
+
+ ZigbeeRefreshNetworkFailedEvent
+
+ | Description |
+ When zigbee network cannot be refreshed |
+
+
+
+ | JSON |
+ {
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
+ "setupOID" : "a setup OID",
+ "owningPartner" : "an owning partner",
+ "gatewayId" : "A gateway id (ex: 0101-1234-5678)",
+ "type" : "ZigbeeRefreshNetworkFailedEvent",
+ "failureType" : "NON_EXECUTING"
+} |
+
+
+ | Field name |
+ Field description |
+
+
+
+ | gatewayId |
+ Gateway id |
+
+
+
+ | owningPartner |
+ Owning partner of the parent entity (gateway, setup group, ...)) . only available in event streams |
+
+
+
+ | setupOID |
+ Setup OID |
+
+
+
+ | siteOID |
+ Site OID |
+
+
@@ -45208,7 +47214,7 @@
-> locale
-> extra emails
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -45303,13 +47309,14 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"userId" : "a user id",
"locked" : true,
"owner" : false,
- "templateName" : "a template name",
+ "roleName" : "a role name",
"setupLabel" : "a setup label",
"firstName" : "a first name",
"lastName" : "a last name",
@@ -45317,7 +47324,8 @@ Generated events on method call
"locale" : "a locale",
"mobilePhone" : "a mobile phone",
"phoneNumber" : "a phone number",
- "name" : "EndUserAccountUpdatedEvent"
+ "templateName" : "a role name",
+ "type" : "EndUserAccountUpdatedEvent"
} |
@@ -45335,6 +47343,11 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
@@ -45400,7 +47413,7 @@ Generated events on method call
Ask a single-use token for logged-in user email validation. A token can only be used once. Asking for a new token will cancel the previous one.
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -45664,7 +47677,7 @@ Generated events on method call
Create a short-lived Json Web Token representing the current user authority, to be used by external services to access the API on behalf of the user
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -45797,7 +47810,7 @@ Generated events on method call
Change logged-in user password, given the old password and a new password
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -46371,7 +48384,7 @@ Generated events on method call
Create a new setup and attach it to connected end user
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -46424,11 +48437,12 @@ Generated events on method call
}
},
"label" : "a new setup creation label",
- "templateName" : "a template name",
+ "roleName" : "a role name",
"applicationId" : "an application id",
"activationTimestamp" : 120123456790,
"expirationTimestamp" : 120123456791,
- "gatewayIds" : [ "some gateway ids" ]
+ "gatewayIds" : [ "some gateway ids" ],
+ "templateName" : "a role name"
}
@@ -46534,7 +48548,7 @@ Generated events on method call
Get default setup OID for the connected user
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
|
@@ -46667,7 +48681,7 @@ Generated events on method call
Set default setup OID for the connected user
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -46771,7 +48785,7 @@ Generated events on method call
Get setup label
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -46904,7 +48918,7 @@ Generated events on method call
Update setup label
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -47037,7 +49051,7 @@ Generated events on method call
Get all setup information for the connected user. Activation/Expiration timestamps are expressed as milliseconds since EPOCH.
Per-session rate-limit : 1 calls per 1d period for this particular operation (bulk-load)
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -47068,12 +49082,13 @@ Generated events on method call
[ {
"setupOID" : "a setup OID",
"userId" : "a user id",
- "templateName" : "a template name",
+ "roleName" : "a role name",
"owner" : false,
"defaultSetup" : true,
"label" : "a setup end user label",
- "activationTimestamp" : 1769503155136,
- "expirationTimestamp" : 1769503155135
+ "templateName" : "a role name",
+ "activationTimestamp" : 1785140821860,
+ "expirationTimestamp" : 1785140821860
} ] |
@@ -47181,7 +49196,7 @@ Generated events on method call
If a timestamp is omitted, the associated bound is not applied : one can set an activation date only, an expiration date only, or remove both by sending an empty object.
Deprecated : use PUT method
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
|
@@ -47332,7 +49347,7 @@ Generated events on method call
Activation/Expiration timestamps are optional and expressed as milliseconds since EPOCH.
If a timestamp is omitted, the associated bound is not applied : one can set an activation date only, an expiration date only, or remove both by sending an empty object.
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -47481,7 +49496,7 @@ Generated events on method call
Delete activation date and expiration date for user access on setup
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -47776,7 +49791,7 @@ Generated events on method call
-> locale
-> extra emails
Per-session rate-limit : 1 calls per 1d period for this particular operation (bulk-load)
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -47805,8 +49820,8 @@ Generated events on method call
(JSON)
{
- "creationTime" : 1769503155114,
- "lastUpdateTime" : 1769503155114,
+ "creationTime" : 1785140821853,
+ "lastUpdateTime" : 1785140821854,
"userId" : "a user id",
"title" : 1,
"firstName" : "a first name",
@@ -47986,7 +50001,7 @@ Generated events on method call
}
},
"label" : "a main enduser account label",
- "templateName" : "a template name",
+ "roleName" : "a role name",
"applicationId" : "an application id",
"activationTimestamp" : 120123456790,
"expirationTimestamp" : 120123456794,
@@ -48005,7 +50020,8 @@ Generated events on method call
"email" : "an email"
} ]
},
- "password" : "a password"
+ "password" : "a password",
+ "templateName" : "a role name"
} |
@@ -48115,7 +50131,7 @@ Generated events on method call
-> phone and mobile phone numbers
-> locale
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
|
@@ -48210,10 +50226,11 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
- "name" : "MainAccountUpdatedEvent"
+ "owningPartners" : [ "some owning partners" ],
+ "type" : "MainAccountUpdatedEvent"
} |
@@ -48231,6 +50248,11 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
@@ -48297,7 +50319,7 @@ Generated events on method call
Delete the main enduser account
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -48704,7 +50726,7 @@ Generated events on method call
Add a secondary enduser account
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -48747,9 +50769,10 @@ Generated events on method call
},
"password" : "a password",
"label" : "a secondary enduser account label",
- "templateName" : "a template name",
+ "roleName" : "a role name",
"activationTimestamp" : 120123456790,
- "expirationTimestamp" : 120123456794
+ "expirationTimestamp" : 120123456794,
+ "templateName" : "a role name"
}
@@ -48856,7 +50879,7 @@ Generated events on method call
Update a secondary enduser account
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
|
@@ -49000,7 +51023,7 @@ Generated events on method call
Get the secondary account for the given userId
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -49161,7 +51184,7 @@ Generated events on method call
Delete a secondary enduser account
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -49292,7 +51315,7 @@ Generated events on method call
Get secondary accounts
Per-session rate-limit : 1 calls per 1d period for this particular operation (bulk-load)
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -49454,7 +51477,7 @@
Get custom roles
Per-session rate-limit : 1 calls per 1d period for this particular operation (bulk-load)
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -49591,7 +51614,7 @@
Create or update custom role
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -49728,7 +51751,7 @@
Get custom role
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -49892,7 +51915,7 @@
Delete a custom role
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -50052,7 +52075,7 @@
Get end-user permissions
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -50186,7 +52209,7 @@
Get end-user device control permissions
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -50320,7 +52343,7 @@
Get end-user device view permissions
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -50454,7 +52477,7 @@
Get a secondary end-user permissions
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -50615,7 +52638,7 @@
Get a secondary end-user device control permissions
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -50776,7 +52799,7 @@
Add a secondary end-user device control permissions
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -50937,7 +52960,7 @@
Remove a secondary end-user device control permissions
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -51098,7 +53121,7 @@
Get a secondary end-user device view permissions
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -51259,7 +53282,7 @@
Add a secondary end-user device view permissions
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -51405,7 +53428,7 @@
Remove a secondary end-user device view permissions
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -51580,7 +53603,7 @@
Get user preferences
Per-session rate-limit : 1 calls per 1d period for this particular operation (bulk-load)
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -51715,7 +53738,7 @@
Create a user preference
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -51812,14 +53835,15 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"preferenceOID" : "a preference OID",
"userId" : "a user id",
"preferenceName" : "a preference name",
"preferenceValue" : "a preference value",
- "name" : "EndUserPreferenceCreatedEvent"
+ "type" : "EndUserPreferenceCreatedEvent"
} |
@@ -51852,6 +53876,11 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
| userId |
User id |
@@ -51922,7 +53951,7 @@ Generated events on method call
Get a user preference
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -52084,7 +54113,7 @@ Generated events on method call
Delete a user preference
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -52166,13 +54195,14 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"preferenceOID" : "a preference OID",
"userId" : "a user id",
"preferenceName" : "a preference name",
- "name" : "EndUserPreferenceDeletedEvent"
+ "type" : "EndUserPreferenceDeletedEvent"
} |
@@ -52200,6 +54230,11 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
| userId |
User id |
@@ -52270,7 +54305,7 @@ Generated events on method call
Update a user preference
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -52367,14 +54402,15 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"preferenceOID" : "a preference OID",
"userId" : "a user id",
"preferenceName" : "a preference name",
"preferenceValue" : "a preference value",
- "name" : "EndUserPreferenceUpdatedEvent"
+ "type" : "EndUserPreferenceUpdatedEvent"
} |
@@ -52407,6 +54443,11 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
| userId |
User id |
@@ -52524,7 +54565,7 @@
Register an event listener
Register a new setup event listener on the current session and return a new listener id. Only one listener may be registered on a given session. Registering an new listener will invalidate the previous one if any. Note that registering an event listener drastically reduces the session timeout : listening sessions are expected to call the /events/{listenerId}/fetch API on a regular basis.
- Access scope : Enduser Open API (enduser/o)
+ Access scope : enduser/o
> Test operation
@@ -52657,7 +54698,7 @@
Unregister an event listener
Register a new setup event listener on the current session and return a new listener id. Only one listener may be registered on a given session. Registering an new listener will invalidate the previous one if any. Default session timeout is restored.
- Access scope : Enduser Open API (enduser/o)
+ Access scope : enduser/o
> Test operation
@@ -52788,7 +54829,7 @@
Fetch new events
Fetch new events from a registered event listener. Fetched events are removed from the listener buffer. Return an empty response if no event is available.
Per-session rate-limit : 1 calls per 1s period for this particular operation (polling)
- Access scope : Enduser Open API (enduser/o)
+ Access scope : enduser/o
> Test operation
@@ -52844,27 +54885,33 @@
(JSON)
[ {
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"execId" : "an exec id",
"newState" : "IN_PROGRESS",
"ownerKey" : "an owner key",
- "type" : 1,
+ "executionType" : 1,
"subType" : 1,
"oldState" : "TRANSMITTED",
"timeToNextState" : 2,
"failedCommands" : [ {
"deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
"detailedStatus" : {
+ "type" : "generic-error",
"message" : "a message",
"error" : true
},
"rank" : 1,
"failureType" : "NON_EXECUTING"
} ],
+ "relatedDevices" : [ {
+ "deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])"
+ } ],
+ "technical" : false,
"failureTypeCode" : 11,
- "name" : "ExecutionStateChangedEvent",
+ "type" : "ExecutionStateChangedEvent",
"failureType" : "NON_EXECUTING"
} ] |
@@ -52972,7 +55019,7 @@
- Device event history
+ Data retention policy
|
@@ -52980,7 +55027,7 @@
- /history/devicesEvent/{eventId}
+ /history/dataRetentionPolicy
@@ -52996,10 +55043,10 @@
|
- Retrieve a device event by ID
Get a device event that occurred on an actuator or a sensor (fault or warning)
+ Retrieve data retention policy for executions and states in days
- Access scope : Full enduser API access (enduser/*)
- > Test operation
+ Access scope : enduser/*
+ > Test operation
|
@@ -53007,33 +55054,6 @@
-
-
- Parameters
-
- | Type |
- Name |
- Value |
- Description |
-
-
-
- |
- Path Variable
- |
-
- eventId
- |
- "string value" |
-
-
-
- The id of the event to display
- |
-
-
-
-
@@ -53054,14 +55074,8 @@
(JSON)
|
{
- "deviceEvent" : {
- "eventTime" : 1769503155160,
- "deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
- "value" : "a device event log value",
- "id" : "an event id",
- "type" : "FAULT",
- "subType" : "UNKNOWN_ERROR"
- }
+ "states" : 2,
+ "executions" : 2
} |
@@ -53139,7 +55153,7 @@
- Device events history
+ Device event history
|
@@ -53147,7 +55161,7 @@
- /history/devicesEvent
+ /history/devicesEvent/{eventId}
@@ -53163,10 +55177,10 @@
|
- Retrieve device events history
Get the history of all specific events that occurred on actuators or sensors (fault or warning)
- Per-session rate-limit : 1 calls per 28min 48s period for this particular operation (bulk-history)
- Access scope : Full enduser API access (enduser/*)
- > Test operation
+ Retrieve a device event by ID
Get a device event that occurred on an actuator or a sensor (fault or warning)
+
+ Access scope : enduser/*
+ > Test operation
|
@@ -53174,6 +55188,33 @@
+
+
+ Parameters
+
+ | Type |
+ Name |
+ Value |
+ Description |
+
+
+
+ |
+ Path Variable
+ |
+
+ eventId
+ |
+ "string value" |
+
+
+
+ The id of the event to display
+ |
+
+
+
+
@@ -53193,14 +55234,154 @@
|
(JSON)
|
- [ {
- "eventTime" : 1769503155159,
- "deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
- "value" : "a device event log value",
- "id" : "an event id",
- "type" : "FAULT",
- "subType" : "UNKNOWN_ERROR"
-} ] |
+ {
+ "deviceEvent" : {
+ "eventTime" : 1785140821886,
+ "deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
+ "value" : "a device event log value",
+ "id" : "an event id",
+ "type" : "FAULT",
+ "subType" : "UNKNOWN_ERROR"
+ }
+} |
+
+
+
+
+ |
+ |
+
+
+
+
+
+
+
+ HTTP Status Code
+
+ | Code |
+ Message |
+ Meaning |
+
+
+
+ |
+ 200
+ |
+ OK |
+
+ The request has succeeded
+ |
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ | GET |
+
+
+
+
+ Device events history
+
+
+ |
+
+
+
+
+ /history/devicesEvent
+
+
+ |
+ application/json |
+
+
+ |
+
+
+ Retrieve device events history
Get the history of all specific events that occurred on actuators or sensors (fault or warning)
+ Per-session rate-limit : 1 calls per 28min 48s period for this particular operation (bulk-history)
+ Access scope : enduser/*
+ > Test operation
+ |
+
+
+ |
+
+
+
+
+
+
+
+ Response
+
+ | Type |
+ Name |
+ Value |
+ Description |
+
+
+
+ |
+ Response Body
+ |
+
+ (JSON)
+ |
+ [ {
+ "eventTime" : 1785140821885,
+ "deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
+ "value" : "a device event log value",
+ "id" : "an event id",
+ "type" : "FAULT",
+ "subType" : "UNKNOWN_ERROR"
+} ] |
@@ -53303,7 +55484,7 @@
Retrieve a completed execution
Get a completed execution instance by ID
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
|
@@ -53360,36 +55541,37 @@
{
"execution" : {
- "eventTime" : 1769503155170,
+ "eventTime" : 1785140821890,
"actionGroupOID" : "an action group OID",
"actionGroupMetadata" : "an action group metadata",
"owner" : "an owner",
"source" : "a source",
- "endTime" : 1769503155179,
- "effectiveStartTime" : 1769503155170,
- "duration" : 9,
+ "endTime" : 1785140821897,
+ "effectiveStartTime" : 1785140821890,
+ "duration" : 7,
"id" : "an exec id",
"label" : "an action group label",
"metaData" : "an execution meta data",
"type" : "Immediate execution - MANUAL_CONTROL",
+ "state" : "COMPLETED",
+ "executionType" : "Immediate execution",
+ "executionSubType" : "MANUAL_CONTROL",
"failureType" : "UNKNOWN_ERROR",
"commands" : [ {
"deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
"command" : "a command",
"parameters" : [ "some parameters" ],
"detailedStatus" : {
+ "type" : "generic-error",
"message" : "a message",
"error" : true
},
"rank" : 1,
"dynamic" : false,
"delay" : 1,
- "failureType" : "UNKNOWN_ERROR",
- "state" : "COMPLETED"
- } ],
- "state" : "COMPLETED",
- "executionType" : "Immediate execution",
- "executionSubType" : "MANUAL_CONTROL"
+ "state" : "COMPLETED",
+ "failureType" : "UNKNOWN_ERROR"
+ } ]
}
} |
@@ -53495,7 +55677,7 @@
Retrieve completed executions
Get the history of all completed executions.
Per-session rate-limit : 1 calls per 28min 48s period for this particular operation (bulk-history)
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
|
@@ -53526,10 +55708,10 @@
[ {
"duration" : -1,
"type" : "? - -",
- "failureType" : "NO_FAILURE",
"state" : "INITIALIZED",
"executionType" : "?",
- "executionSubType" : "-"
+ "executionSubType" : "-",
+ "failureType" : "NO_FAILURE"
} ] |
@@ -53586,6 +55768,265 @@
+
+
+
+
+ | GET |
+
+
+
+
+ Executions history
+
+
+ |
+
+
+
+
+ /history/executions/daily/{year}/{month}/{day}
+
+
+ |
+ application/json |
+
+
+ |
+
+
+ Retrieve all executions for a given day.
Max executions query span is limited to 200 executions. If the wanted date is out of the history retention period, an error will occur.
+
+ Access scope : enduser/*
+ > Test operation
+ |
+
+
+ |
+
+
+
+
+
+ Parameters
+
+ | Type |
+ Name |
+ Value |
+ Description |
+
+
+
+ |
+ Path Variable
+ |
+
+ year
+ |
+ 1 |
+
+
+
+ Year of the history to retrieve
+ |
+
+
+
+ |
+ Path Variable
+ |
+
+ month
+ |
+ 1 |
+
+
+
+ Month of the history to retrieve (1-12)
+ |
+
+
+
+ |
+ Path Variable
+ |
+
+ day
+ |
+ 1 |
+
+
+
+ Day of the history to retrieve (1-31)
+ |
+
+
+
+ |
+ Request Parameter
+ |
+
+ executionCategory
+ |
+ "string value" |
+
+ (Optional)
+
+ (Default: any)
+
+ (Optional) Category of executions : manual, automation, any. (any by default)
+ |
+
+
+
+ |
+ Request Parameter
+ |
+
+ actionGroupCategory
+ |
+ "string value" |
+
+ (Optional)
+
+ (Default: any)
+
+ (Optional) Category of action group : persistent, nonPersistent, any. (any by default)
+ |
+
+
+
+
+
+
+
+
+ Response
+
+ | Type |
+ Name |
+ Value |
+ Description |
+
+
+
+ |
+ Response Body
+ |
+
+ (JSON)
+ |
+ {
+ "limitReached" : true,
+ "executions" : [ {
+ "execution" : {
+ "eventTime" : 1785201548433,
+ "actionGroupOID" : "an action group OID",
+ "actionGroupMetadata" : "an action group metadata",
+ "owner" : "an owner",
+ "source" : "a source",
+ "endTime" : 1785201548434,
+ "effectiveStartTime" : 1785201548434,
+ "duration" : 0,
+ "id" : "an exec id",
+ "label" : "an action group label",
+ "metaData" : "an execution meta data",
+ "type" : "Immediate execution - MANUAL_CONTROL",
+ "state" : "COMPLETED",
+ "executionType" : "Immediate execution",
+ "executionSubType" : "MANUAL_CONTROL",
+ "failureType" : "UNKNOWN_ERROR",
+ "commands" : [ {
+ "deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
+ "command" : "a command",
+ "parameters" : [ "some parameters" ],
+ "detailedStatus" : {
+ "type" : "generic-error",
+ "message" : "a message",
+ "error" : true
+ },
+ "rank" : 1,
+ "dynamic" : false,
+ "delay" : 1,
+ "state" : "COMPLETED",
+ "failureType" : "UNKNOWN_ERROR"
+ } ]
+ }
+ } ]
+} |
+
+
+
+
+ |
+
+
+
+
+
+
+
+
+ HTTP Status Code
+
+ | Code |
+ Message |
+ Meaning |
+
+
+
+ |
+ 200
+ |
+ OK |
+
+ The request has succeeded
+ |
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ |
+
+
+ |
+
+
+
+
@@ -53633,7 +56074,7 @@
Retrieve completed executions
Get the history of all completed executions .
Per-session rate-limit : 1 calls per 28min 48s period for this particular operation (bulk-history)
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -53662,36 +56103,37 @@
(JSON)
[ {
- "eventTime" : 1769503155179,
+ "eventTime" : 1785140821897,
"actionGroupOID" : "an action group OID",
"actionGroupMetadata" : "an action group metadata",
"owner" : "an owner",
"source" : "a source",
- "endTime" : 1769503155180,
- "effectiveStartTime" : 1769503155180,
+ "endTime" : 1785140821897,
+ "effectiveStartTime" : 1785140821897,
"duration" : 0,
"id" : "an exec id",
"label" : "an action group label",
"metaData" : "an execution meta data",
"type" : "Immediate execution - MANUAL_CONTROL",
+ "state" : "COMPLETED",
+ "executionType" : "Immediate execution",
+ "executionSubType" : "MANUAL_CONTROL",
"failureType" : "UNKNOWN_ERROR",
"commands" : [ {
"deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
"command" : "a command",
"parameters" : [ "some parameters" ],
"detailedStatus" : {
+ "type" : "generic-error",
"message" : "a message",
"error" : true
},
"rank" : 1,
"dynamic" : false,
"delay" : 1,
- "failureType" : "UNKNOWN_ERROR",
- "state" : "COMPLETED"
- } ],
- "state" : "COMPLETED",
- "executionType" : "Immediate execution",
- "executionSubType" : "MANUAL_CONTROL"
+ "state" : "COMPLETED",
+ "failureType" : "UNKNOWN_ERROR"
+ } ]
} ] |
@@ -53795,7 +56237,7 @@
Retrieve completed executions and device events history (mixed)
Get the history of all completed executions and specific events that occurred on an actuator or a sensor (fault or warning)
Per-session rate-limit : 1 calls per 28min 48s period for this particular operation (bulk-history)
- Access scope : Enduser Open API (enduser/o)
+ Access scope : enduser/o
> Test operation
|
@@ -53825,36 +56267,37 @@
[ {
"execution" : {
- "eventTime" : 1769503155180,
+ "eventTime" : 1785140821897,
"actionGroupOID" : "an action group OID",
"actionGroupMetadata" : "an action group metadata",
"owner" : "an owner",
"source" : "a source",
- "endTime" : 1769503155181,
- "effectiveStartTime" : 1769503155180,
+ "endTime" : 1785140821898,
+ "effectiveStartTime" : 1785140821897,
"duration" : 1,
"id" : "an exec id",
"label" : "an action group label",
"metaData" : "an execution meta data",
"type" : "Immediate execution - MANUAL_CONTROL",
+ "state" : "COMPLETED",
+ "executionType" : "Immediate execution",
+ "executionSubType" : "MANUAL_CONTROL",
"failureType" : "UNKNOWN_ERROR",
"commands" : [ {
"deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
"command" : "a command",
"parameters" : [ "some parameters" ],
"detailedStatus" : {
+ "type" : "generic-error",
"message" : "a message",
"error" : true
},
"rank" : 1,
"dynamic" : false,
"delay" : 1,
- "failureType" : "UNKNOWN_ERROR",
- "state" : "COMPLETED"
- } ],
- "state" : "COMPLETED",
- "executionType" : "Immediate execution",
- "executionSubType" : "MANUAL_CONTROL"
+ "state" : "COMPLETED",
+ "failureType" : "UNKNOWN_ERROR"
+ } ]
}
} ] |
@@ -53959,7 +56402,7 @@
Clear history
Clear all history. This includes all executions and device events.
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
|
@@ -54014,10 +56457,11 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
- "name" : "HistoryDeletedEvent"
+ "owningPartners" : [ "some owning partners" ],
+ "type" : "HistoryDeletedEvent"
} |
@@ -54035,6 +56479,11 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
@@ -54100,7 +56549,7 @@ Generated events on method call
Retrieve notification events history
Per-session rate-limit : 1 calls per 28min 48s period for this particular operation (bulk-history)
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
|
@@ -54129,7 +56578,7 @@ Generated events on method call
(JSON)
|
[ {
- "eventTime" : 1769503155162,
+ "eventTime" : 1785140821882,
"text" : "a text",
"originatorType" : "an originator type",
"originatorRef" : "TRIGGER/<triggerjsonClass> or PARTNER",
@@ -54239,7 +56688,7 @@ Generated events on method call
Retrieve enduser access history on a setup within a time range
History values
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
|
@@ -54588,7 +57037,7 @@
Get the current authenticated user name
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -54883,13 +57332,13 @@
(JSON)
{
- "success" : false,
"roles" : [ {
"name" : "a security role name"
} ],
"extraAttributes" : {
"some extra attributes" : "some extra attributes"
- }
+ },
+ "success" : true
} |
@@ -55390,7 +57839,7 @@
Get a controllable definition
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
|
@@ -55565,7 +58014,7 @@
Get details about all supported controllable types
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -55700,7 +58149,7 @@
Search devices references definitions
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -55824,11 +58273,11 @@
"type" : "SPEC"
} ]
} ],
+ "uiWidget" : "a widget name",
+ "controllableType" : "ACTUATOR",
"uiClassifiers" : [ "some ui classifiers" ],
"uiProfiles" : [ "some ui profiles" ],
"uiClass" : "a ui class",
- "uiWidget" : "a widget name",
- "controllableType" : "ACTUATOR",
"protocolType" : "IO"
} ]
}
@@ -55934,7 +58383,7 @@
Get details about supported protocol types on that server instance
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -56070,7 +58519,7 @@
Get timezones list
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -56205,7 +58654,7 @@
Get a list of all defined UI classes
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -56336,7 +58785,7 @@
Get a list of all defined UI classifiers
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -56467,7 +58916,7 @@
Get a description of a given UI profile (or form-factor variant)
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -56652,7 +59101,7 @@
Get a list of all defined UI profiles (and form-factor variants)
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -56783,7 +59232,7 @@
Get a list of all defined UI widgets
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -56954,7 +59403,7 @@
- Calendar Rule : enabled
- Setup Trigger : mode
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -57018,8 +59467,8 @@
"operationResponses" : [ {
"actionGroupResponse" : {
"managedActionGroupValue" : {
- "creationTime" : 1769533841268,
- "lastUpdateTime" : 1769533841268,
+ "creationTime" : 1785201548609,
+ "lastUpdateTime" : 1785201548610,
"label" : "a managed action group label",
"metadata" : "some metadata",
"shortcut" : true,
@@ -57375,7 +59824,7 @@
Get the current setup OID
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -57508,7 +59957,7 @@
Change the current setup for that session. Any existing event registration is automatically closed.
Per-session rate-limit : 1 calls per 1h period for this particular operation (switch)
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -57640,7 +60089,7 @@
Return dawn time of the current day based on the setup location
Response is composed of a dawnTime nodes; it has a utc time (in milliseconds) and hours and minutes calculated by taking the setup timezone into account.
If dawnTime cannot be defined, utc, hours and minutes are not set.
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -57776,7 +60225,7 @@
Return dawn time of the chosen day on the setup location
Response is composed of a dawnTime nodes; it has a utc time (in milliseconds) and hours and minutes calculated by taking the setup timezone into account.
If dawnTime cannot be defined, utc, hours and minutes are not set.
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -57968,7 +60417,7 @@
Private tags : [ disconnectionAlert ]
Get configuration for notification sent on gateway disconnect
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -58104,7 +60553,7 @@
Private tags : [ disconnectionAlert ]
Update configuration for notification sent on gateway disconnect
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -58241,7 +60690,7 @@
Return dusk time of the current day based on the setup location
Response is composed of a duskTime nodes; it has a utc time (in milliseconds) and hours and minutes calculated by taking the setup timezone into account.
If duskTime cannot be defined, utc, hours and minutes are not set.
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -58377,7 +60826,7 @@
Return dusk time of the chosen day based on the setup location
Response is composed of a duskTime nodes; it has a utc time (in milliseconds) and hours and minutes calculated by taking the setup timezone into account.
If duskTime cannot be defined, utc, hours and minutes are not set.
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -58569,7 +61018,7 @@
Add an existing enduser to setup
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -58598,10 +61047,11 @@
{
"userId" : "a user id",
"label" : "a setup end user wrapper label",
- "templateName" : "a template name",
- "activationDate" : 1769533841296,
- "expirationDate" : 1769533841296,
- "defaultSetup" : false
+ "roleName" : "a role name",
+ "activationDate" : 1785201548634,
+ "expirationDate" : 1785201548634,
+ "defaultSetup" : false,
+ "templateName" : "a role name"
} |
@@ -58707,7 +61157,7 @@
Remove an existing enduser from setup
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
|
@@ -58838,7 +61288,7 @@
Get setup location
Per-session rate-limit : 1 calls per 1d period for this particular operation (bulk-load)
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -58867,8 +61317,8 @@
(JSON)
{
- "creationTime" : 1769503155380,
- "lastUpdateTime" : 1769503155381,
+ "creationTime" : 1785140822120,
+ "lastUpdateTime" : 1785140822120,
"city" : "a city",
"country" : "a country",
"postalCode" : "a postal code",
@@ -58995,7 +61445,7 @@
Update setup location of user
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
|
@@ -59101,9 +61551,10 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"city" : "a city",
"country" : "a country",
"postalCode" : "a postal code",
@@ -59117,7 +61568,7 @@ Generated events on method call
"twilightMode" : "a twilight mode",
"twilightCity" : "a twilight city",
"twilightAngle" : "a twilight angle",
- "name" : "LocationUpdatedEvent"
+ "type" : "LocationUpdatedEvent"
} |
@@ -59135,6 +61586,11 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
@@ -59211,7 +61667,7 @@ Generated events on method call
Data of one or several devices can be also get by setting the device(s) url as request parameter.
Per-session rate-limit : 1 calls per 1d period for this particular operation (bulk-load)
- Access scope : Enduser Open API (enduser/o)
+ Access scope : enduser/o
> Test operation
|
@@ -59269,12 +61725,12 @@ Generated events on method call
(JSON)
{
- "creationTime" : 1769503155362,
- "lastUpdateTime" : 1769503155366,
+ "creationTime" : 1785140822076,
+ "lastUpdateTime" : 1785140822096,
"id" : "an id",
"location" : {
- "creationTime" : 1769503155366,
- "lastUpdateTime" : 1769503155366,
+ "creationTime" : 1785140822090,
+ "lastUpdateTime" : 1785140822096,
"city" : "a city",
"country" : "a country",
"postalCode" : "a postal code",
@@ -59284,18 +61740,21 @@ Generated events on method call
"longitude" : 0.12345,
"latitude" : 0.12345,
"twilightMode" : 1,
- "twilightAngle" : "SOLAR",
+ "twilightAngle" : "NAUTICAL",
"twilightCity" : "a twilight city",
"summerSolsticeDuskMinutes" : 1,
"winterSolsticeDuskMinutes" : 1,
- "twilightOffsetEnabled" : true,
+ "twilightOffsetEnabled" : false,
"dawnOffset" : 1,
"duskOffset" : 1,
"tariffSettings" : {
- "tariffMode" : "offPeakHours",
+ "tariffMode" : "offPeakWeekDays",
"tariffs" : [ {
- "name" : "tariff0",
- "startTime" : "00:01"
+ "dayTariffs" : [ {
+ "name" : "tariff0",
+ "startTime" : "00:01"
+ } ],
+ "dayWeekName" : "SAT"
} ]
}
},
@@ -59304,30 +61763,32 @@ Generated events on method call
"type" : 1,
"subType" : 1,
"placeOID" : "a place OID",
- "autoUpdateEnabled" : true,
+ "autoUpdateEnabled" : false,
+ "updateDeferralEnabled" : true,
"alive" : false,
- "timeReliable" : true,
+ "timeReliable" : false,
"connectivity" : {
- "status" : "PARTIAL",
+ "status" : "DISCONNECTED",
"problems" : [ "NO_NTP" ],
"protocolVersion" : "a protocol version"
},
- "upToDate" : true,
- "updateStatus" : "UPDATING",
- "syncInProgress" : false,
- "updateCriticityLevel" : "BLOCKING",
- "automaticUpdate" : false,
+ "upToDate" : false,
+ "updateStatus" : "UNKNOWN",
+ "syncInProgress" : true,
+ "updateCriticityLevel" : "DEVICES_CONTROL_ONLY",
+ "automaticUpdate" : true,
"mode" : "ACTIVE",
"functions" : "some function names"
} ],
"devices" : [ {
- "creationTime" : 1769503155362,
- "lastUpdateTime" : 1769503155363,
- "label" : "a device label",
+ "label" : "a device response label",
+ "uiClass" : "a ui class",
"deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
"shortcut" : true,
- "controllableName" : "core:StatefulClosableActuator",
+ "controllableName" : "a controllable name",
"metadata" : "some metadata",
+ "creationTime" : 1785140822076,
+ "lastUpdateTime" : 1785140822077,
"definition" : {
"commands" : [ {
"commandName" : "a command name",
@@ -59350,7 +61811,7 @@ Generated events on method call
"name" : "a device state name",
"type" : 1,
"value" : "a device state value",
- "lastUpdateTime" : 120123456804
+ "lastUpdateTime" : 120123456806
} ],
"attributes" : [ {
"name" : "a device attribute name",
@@ -59361,17 +61822,44 @@ Generated events on method call
"name" : "a device manufacturer data name",
"value" : "a device manufacturer data value"
} ],
- "available" : true,
+ "localDeviceData" : [ {
+ "key" : "a key",
+ "value" : "a local device attribute value",
+ "category" : "a category",
+ "localDeviceOID" : "a local device OID"
+ } ],
+ "available" : false,
"enabled" : false,
"placeOID" : "a place OID",
+ "oid" : "the device response UUID",
"widget" : "a widget name",
- "type" : 1,
- "oid" : "the device UUID",
- "uiClass" : "a ui class"
+ "type" : 1
+ } ],
+ "localDevices" : [ {
+ "label" : "a local device response label",
+ "placeOID" : "a place OID",
+ "mapped" : false,
+ "model" : {
+ "type" : "a OGPNode model type",
+ "subType" : "a sub type",
+ "features" : [ {
+ "name" : "a OGPFeature name",
+ "commandLess" : true,
+ "eventBased" : true,
+ "authenticationRestrictedCommands" : [ "some authentication restricted commands" ]
+ } ]
+ },
+ "attributes" : {
+ "some attributes" : "some attributes"
+ },
+ "localDeviceData" : {
+ "a local device data" : "a local device data"
+ },
+ "oid" : "the local device response UUID"
} ],
"zones" : [ {
- "creationTime" : 1769503155364,
- "lastUpdateTime" : 1769503155364,
+ "creationTime" : 1785140822080,
+ "lastUpdateTime" : 1785140822080,
"label" : "a zone label",
"type" : 0,
"items" : [ {
@@ -59383,8 +61871,8 @@ Generated events on method call
"metadata" : "some metadata",
"oid" : "the zone UUID"
} ],
- "resellerDelegationType" : "ALWAYS",
- "resellerDelegationEndDate" : 1769503155366,
+ "resellerDelegationType" : "DATE",
+ "resellerDelegationEndDate" : 1785140822090,
"metadata" : "some metadata",
"disconnectionConfiguration" : {
"notificationTitle" : "a notification title",
@@ -59392,24 +61880,24 @@ Generated events on method call
"targetPushSubscriptions" : [ "some target push subscriptions" ],
"notificationType" : "PUSH"
},
- "oid" : "the setup UUID",
+ "partnerId" : "a partner id",
"rootPlace" : {
- "creationTime" : 1769503155366,
- "lastUpdateTime" : 1769503155366,
+ "creationTime" : 1785140822096,
+ "lastUpdateTime" : 1785140822096,
"label" : "a place label",
"type" : 1,
"metadata" : "some metadata",
"oid" : "the place UUID",
"subPlaces" : [ {
- "creationTime" : 1769503155366,
- "lastUpdateTime" : 1769503155366,
+ "creationTime" : 1785140822096,
+ "lastUpdateTime" : 1785140822096,
"label" : "a place label",
"type" : 1,
"metadata" : "some metadata",
"oid" : "the place UUID",
"subPlaces" : [ {
- "creationTime" : 1769503155366,
- "lastUpdateTime" : 1769503155366,
+ "creationTime" : 1785140822096,
+ "lastUpdateTime" : 1785140822096,
"label" : "a place label",
"type" : 1,
"metadata" : "some metadata",
@@ -59421,7 +61909,9 @@ Generated events on method call
"features" : [ {
"name" : "a setup feature name",
"source" : "a source"
- } ]
+ } ],
+ "siteOID" : "a site OID",
+ "oid" : "the setup response UUID"
} |
@@ -59525,7 +62015,7 @@ Generated events on method call
Get the list of uploaded files on the setup
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
|
@@ -59556,7 +62046,7 @@ Generated events on method call
[ {
"filename" : "a filename",
"size" : 2,
- "uploadTime" : 1769503155356,
+ "uploadTime" : 1785140822114,
"metadata" : "some metadata",
"comments" : "some comments",
"oid" : "the setup file UUID"
@@ -59663,7 +62153,7 @@ Generated events on method call
Get upload url for setup file
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
|
@@ -59838,7 +62328,7 @@ Generated events on method call
Get download url for setup file
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -59998,7 +62488,7 @@ Generated events on method call
Get additional information
This operation returns setup additional information.
Per-session rate-limit : 1 calls per 1d period for this particular operation (bulk-load)
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -60136,7 +62626,7 @@ Generated events on method call
Get additional information
This operation returns setup additional information.
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -60301,7 +62791,7 @@ Generated events on method call
Delete setup additional information
This operation deletes setup additional information.
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -60432,7 +62922,7 @@ Generated events on method call
Add setup additional information
This operation adds setup additional information.
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -60578,7 +63068,7 @@ Generated events on method call
Get setup features
Retrieve all setup features of a setup
Per-session rate-limit : 1 calls per 1d period for this particular operation (bulk-load)
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -60712,7 +63202,7 @@ Generated events on method call
Update setup metadata
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -60845,7 +63335,7 @@ Generated events on method call
This operation returns all subscribed options of a given setup.
Per-session rate-limit : 1 calls per 1d period for this particular operation (bulk-load)
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -60874,11 +63364,11 @@ Generated events on method call
(JSON)
[ {
- "creationTime" : 1769503155378,
- "lastUpdateTime" : 1769503155378,
+ "creationTime" : 1785140822116,
+ "lastUpdateTime" : 1785140822117,
"optionId" : "an option id",
- "startDate" : 1769503155378,
- "endDate" : 1769503155378,
+ "startDate" : 1785140822117,
+ "endDate" : 1785140822116,
"parameters" : [ {
"name" : "a setup option parameter name",
"value" : "a setup option parameter value"
@@ -60986,7 +63476,7 @@ Generated events on method call
This operation returns the selected subscribed option of a given setup.
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
|
@@ -61042,11 +63532,11 @@ Generated events on method call
(JSON)
{
- "creationTime" : 1769503155378,
- "lastUpdateTime" : 1769503155379,
+ "creationTime" : 1785140822117,
+ "lastUpdateTime" : 1785140822117,
"optionId" : "an option id",
- "startDate" : 1769503155379,
- "endDate" : 1769503155378,
+ "startDate" : 1785140822117,
+ "endDate" : 1785140822117,
"parameters" : [ {
"name" : "a setup option parameter name",
"value" : "a setup option parameter value"
@@ -61154,7 +63644,7 @@ Generated events on method call
This operation returns all subscribed options of a given setup.
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
|
@@ -61330,7 +63820,7 @@ Generated events on method call
This operation returns remaining quotas value.
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -61466,7 +63956,7 @@ Generated events on method call
This operation returns a quota.
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -61666,7 +64156,7 @@
Get all calendar days for setup.
Per-session rate-limit : 1 calls per 1d period for this particular operation (bulk-load)
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -61695,8 +64185,8 @@
(JSON)
[ {
- "creationTime" : 1769503155350,
- "lastUpdateTime" : 1769503155350,
+ "creationTime" : 1785140822009,
+ "lastUpdateTime" : 1785140822043,
"label" : "a calendar day label",
"type" : "WORK_DAY",
"dayTimeTriggers" : [ {
@@ -61716,8 +64206,8 @@
"alwaysAfterMinutes" : 9,
"actionGroupOID" : "an action group OID",
"localActionGroup" : {
- "creationTime" : 1769503155350,
- "lastUpdateTime" : 1769503155350,
+ "creationTime" : 1785140822035,
+ "lastUpdateTime" : 1785140822043,
"label" : "a managed action group label",
"metadata" : "some metadata",
"shortcut" : true,
@@ -61849,7 +64339,7 @@
Create a calendar day.
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
|
@@ -62005,10 +64495,12 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
+ "setupOID" : "a setup OID",
"owningPartner" : "an owning partner",
"gatewayId" : "A gateway id (ex: 0101-1234-5678)",
- "name" : "GatewaySynchronizationStartedEvent"
+ "type" : "GatewaySynchronizationStartedEvent"
} |
@@ -62026,38 +64518,14 @@ Generated events on method call
Owning partner of the parent entity (gateway, setup group, ...)) . only available in event streams |
-
-
-
-
- GatewaySynchronizationEndedEvent
-
- | Description |
- A data synchronization sequence between the gateway and the server has completed |
-
-
-
- | JSON |
- {
- "timestamp" : 2,
- "owningPartner" : "an owning partner",
- "gatewayId" : "A gateway id (ex: 0101-1234-5678)",
- "name" : "GatewaySynchronizationEndedEvent"
-} |
-
-
- | Field name |
- Field description |
-
-
- | gatewayId |
- Gateway id |
+ setupOID |
+ Setup OID |
- | owningPartner |
- Owning partner of the parent entity (gateway, setup group, ...)) . only available in event streams |
+ siteOID |
+ Site OID |
@@ -62073,13 +64541,14 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"calendarDayOID" : "a calendar day OID",
"label" : "a calendar day created event label",
"metadata" : "some metadata",
- "type" : "a calendar day created event type",
+ "dayType" : "a day type",
"dayTimeTriggers" : [ {
"startActionGroupTimeTrigger" : {
"triggerType" : "DAWN",
@@ -62097,8 +64566,8 @@ Generated events on method call
"alwaysAfterMinutes" : 7,
"actionGroupOID" : "an action group OID",
"localActionGroup" : {
- "creationTime" : 1769533841240,
- "lastUpdateTime" : 1769533841240,
+ "creationTime" : 1785201548584,
+ "lastUpdateTime" : 1785201548584,
"label" : "a managed action group label",
"metadata" : "some metadata",
"shortcut" : true,
@@ -62125,7 +64594,7 @@ Generated events on method call
}
}
} ],
- "name" : "CalendarDayCreatedEvent"
+ "type" : "CalendarDayCreatedEvent"
} |
@@ -62148,6 +64617,57 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
+
+
+
+
+ GatewaySynchronizationEndedEvent
+
+ | Description |
+ A data synchronization sequence between the gateway and the server has completed |
+
+
+
+ | JSON |
+ {
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
+ "setupOID" : "a setup OID",
+ "owningPartner" : "an owning partner",
+ "gatewayId" : "A gateway id (ex: 0101-1234-5678)",
+ "type" : "GatewaySynchronizationEndedEvent"
+} |
+
+
+ | Field name |
+ Field description |
+
+
+
+ | gatewayId |
+ Gateway id |
+
+
+
+ | owningPartner |
+ Owning partner of the parent entity (gateway, setup group, ...)) . only available in event streams |
+
+
+
+ | setupOID |
+ Setup OID |
+
+
+
+ | siteOID |
+ Site OID |
+
+
@@ -62213,7 +64733,7 @@ Generated events on method call
Update a calendar day.
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
|
@@ -62332,40 +64852,6 @@ Generated events on method call
Generated events on method call
-
- GatewaySynchronizationStartedEvent
-
- | Description |
- A data synchronization sequence between the gateway and the server has started |
-
-
-
- | JSON |
- {
- "timestamp" : 2,
- "owningPartner" : "an owning partner",
- "gatewayId" : "A gateway id (ex: 0101-1234-5678)",
- "name" : "GatewaySynchronizationStartedEvent"
-} |
-
-
- | Field name |
- Field description |
-
-
-
- | gatewayId |
- Gateway id |
-
-
-
- | owningPartner |
- Owning partner of the parent entity (gateway, setup group, ...)) . only available in event streams |
-
-
-
-
-
CalendarDayUpdatedEvent
@@ -62376,13 +64862,14 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"calendarDayOID" : "a calendar day OID",
"label" : "a calendar day updated event label",
"metadata" : "some metadata",
- "type" : "a calendar day updated event type",
+ "dayType" : "a day type",
"dayTimeTriggers" : [ {
"startActionGroupTimeTrigger" : {
"triggerType" : "DAWN",
@@ -62400,8 +64887,8 @@ Generated events on method call
"alwaysAfterMinutes" : 7,
"actionGroupOID" : "an action group OID",
"localActionGroup" : {
- "creationTime" : 1769533841246,
- "lastUpdateTime" : 1769533841246,
+ "creationTime" : 1785201548590,
+ "lastUpdateTime" : 1785201548590,
"label" : "a managed action group label",
"metadata" : "some metadata",
"shortcut" : true,
@@ -62428,7 +64915,7 @@ Generated events on method call
}
}
} ],
- "name" : "CalendarDayUpdatedEvent"
+ "type" : "CalendarDayUpdatedEvent"
} |
@@ -62451,6 +64938,57 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
+
+
+
+
+ GatewaySynchronizationStartedEvent
+
+ | Description |
+ A data synchronization sequence between the gateway and the server has started |
+
+
+
+ | JSON |
+ {
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
+ "setupOID" : "a setup OID",
+ "owningPartner" : "an owning partner",
+ "gatewayId" : "A gateway id (ex: 0101-1234-5678)",
+ "type" : "GatewaySynchronizationStartedEvent"
+} |
+
+
+ | Field name |
+ Field description |
+
+
+
+ | gatewayId |
+ Gateway id |
+
+
+
+ | owningPartner |
+ Owning partner of the parent entity (gateway, setup group, ...)) . only available in event streams |
+
+
+
+ | setupOID |
+ Setup OID |
+
+
+
+ | siteOID |
+ Site OID |
+
+
@@ -62464,10 +65002,12 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
+ "setupOID" : "a setup OID",
"owningPartner" : "an owning partner",
"gatewayId" : "A gateway id (ex: 0101-1234-5678)",
- "name" : "GatewaySynchronizationEndedEvent"
+ "type" : "GatewaySynchronizationEndedEvent"
} |
@@ -62485,6 +65025,16 @@ Generated events on method call
Owning partner of the parent entity (gateway, setup group, ...)) . only available in event streams |
+
+ | setupOID |
+ Setup OID |
+
+
+
+ | siteOID |
+ Site OID |
+
+
@@ -62550,7 +65100,7 @@ Generated events on method call
Get a calendar day.
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -62606,8 +65156,8 @@ Generated events on method call
(JSON)
{
- "creationTime" : 1769503155345,
- "lastUpdateTime" : 1769503155346,
+ "creationTime" : 1785140822061,
+ "lastUpdateTime" : 1785140822062,
"label" : "a calendar day label",
"type" : "WORK_DAY",
"dayTimeTriggers" : [ {
@@ -62627,8 +65177,8 @@ Generated events on method call
"alwaysAfterMinutes" : 9,
"actionGroupOID" : "an action group OID",
"localActionGroup" : {
- "creationTime" : 1769503155345,
- "lastUpdateTime" : 1769503155346,
+ "creationTime" : 1785140822061,
+ "lastUpdateTime" : 1785140822062,
"label" : "a managed action group label",
"metadata" : "some metadata",
"shortcut" : true,
@@ -62760,7 +65310,7 @@ Generated events on method call
Delete a calendar day.
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
|
@@ -62833,19 +65383,21 @@ Generated events on method call
Generated events on method call
- GatewaySynchronizationEndedEvent
+ CalendarDayDeletedEvent
| Description |
- A data synchronization sequence between the gateway and the server has completed |
+ A calendar day has been deleted |
| JSON |
{
- "timestamp" : 2,
- "owningPartner" : "an owning partner",
- "gatewayId" : "A gateway id (ex: 0101-1234-5678)",
- "name" : "GatewaySynchronizationEndedEvent"
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
+ "setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
+ "calendarDayOID" : "a calendar day OID",
+ "type" : "CalendarDayDeletedEvent"
} |
@@ -62854,33 +65406,44 @@ Generated events on method call
- | gatewayId |
- Gateway id |
+ calendarDayOID |
+ Calendar day OID |
- | owningPartner |
- Owning partner of the parent entity (gateway, setup group, ...)) . only available in event streams |
+ owningPartners |
+ Owning partners of the parent entity (setup, ...)) . only available in event streams |
+
+
+
+ | setupOID |
+ Setup OID |
+
+
+
+ | siteOID |
+ Site OID |
- CalendarDayDeletedEvent
+ GatewaySynchronizationEndedEvent
| Description |
- A calendar day has been deleted |
+ A data synchronization sequence between the gateway and the server has completed |
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
- "calendarDayOID" : "a calendar day OID",
- "name" : "CalendarDayDeletedEvent"
+ "owningPartner" : "an owning partner",
+ "gatewayId" : "A gateway id (ex: 0101-1234-5678)",
+ "type" : "GatewaySynchronizationEndedEvent"
} |
@@ -62889,13 +65452,13 @@ Generated events on method call
- | calendarDayOID |
- Calendar day OID |
+ gatewayId |
+ Gateway id |
- | owningPartners |
- Owning partners of the parent entity (setup, ...)) . only available in event streams |
+ owningPartner |
+ Owning partner of the parent entity (gateway, setup group, ...)) . only available in event streams |
@@ -62903,6 +65466,11 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
@@ -62916,10 +65484,12 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
+ "setupOID" : "a setup OID",
"owningPartner" : "an owning partner",
"gatewayId" : "A gateway id (ex: 0101-1234-5678)",
- "name" : "GatewaySynchronizationStartedEvent"
+ "type" : "GatewaySynchronizationStartedEvent"
} |
@@ -62937,6 +65507,16 @@ Generated events on method call
Owning partner of the parent entity (gateway, setup group, ...)) . only available in event streams |
+
+ | setupOID |
+ Setup OID |
+
+
+
+ | siteOID |
+ Site OID |
+
+
@@ -63002,7 +65582,7 @@ Generated events on method call
Get all calendar objects applicable for the given startDate and endDate. All the
Per-session rate-limit : 1 calls per 1d period for this particular operation (bulk-load)
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -63180,7 +65760,7 @@ Generated events on method call
Get all calendar objects applicable for the given
Per-session rate-limit : 1 calls per 1d period for this particular operation (bulk-load)
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -63371,7 +65951,7 @@ Generated events on method call
Create a calendar day according to calendar days/rules to be removed
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -63482,8 +66062,8 @@ Generated events on method call
(JSON)
{
- "creationTime" : 1769503155345,
- "lastUpdateTime" : 1769503155346,
+ "creationTime" : 1785140822061,
+ "lastUpdateTime" : 1785140822062,
"label" : "a calendar day label",
"type" : "WORK_DAY",
"dayTimeTriggers" : [ {
@@ -63503,8 +66083,8 @@ Generated events on method call
"alwaysAfterMinutes" : 9,
"actionGroupOID" : "an action group OID",
"localActionGroup" : {
- "creationTime" : 1769503155345,
- "lastUpdateTime" : 1769503155346,
+ "creationTime" : 1785140822061,
+ "lastUpdateTime" : 1785140822062,
"label" : "a managed action group label",
"metadata" : "some metadata",
"shortcut" : true,
@@ -63636,7 +66216,7 @@ Generated events on method call
Get all calendar rules for setup.
Per-session rate-limit : 1 calls per 1d period for this particular operation (bulk-load)
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
|
@@ -63666,8 +66246,8 @@ Generated events on method call
[ {
"weeklyCalendarRule" : {
- "creationTime" : 1769503155322,
- "lastUpdateTime" : 1769503155341,
+ "creationTime" : 1785140822056,
+ "lastUpdateTime" : 1785140822057,
"priority" : 1,
"calendarDayOID" : "a calendar day OID",
"finalRule" : true,
@@ -63680,8 +66260,8 @@ Generated events on method call
"endTimeHours" : 1,
"endTimeMinutes" : 1,
"localCalendarDay" : {
- "creationTime" : 1769503155324,
- "lastUpdateTime" : 1769503155341,
+ "creationTime" : 1785140822056,
+ "lastUpdateTime" : 1785140822056,
"label" : "a calendar day label",
"type" : "DAY_OFF_AT_HOME",
"dayTimeTriggers" : [ {
@@ -63701,8 +66281,8 @@ Generated events on method call
"alwaysAfterMinutes" : 10,
"actionGroupOID" : "an action group OID",
"localActionGroup" : {
- "creationTime" : 1769503155336,
- "lastUpdateTime" : 1769503155341,
+ "creationTime" : 1785140822056,
+ "lastUpdateTime" : 1785140822056,
"label" : "a managed action group label",
"metadata" : "some metadata",
"shortcut" : false,
@@ -63846,7 +66426,7 @@ Generated events on method call
Create a calendar rule.
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
|
@@ -64035,38 +66615,21 @@ Generated events on method call
Generated events on method call
- CalendarRuleCreatedEvent
+ GatewaySynchronizationEndedEvent
| Description |
- A calendar rule has been created |
+ A data synchronization sequence between the gateway and the server has completed |
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
- "calendarRuleOID" : "a calendar rule OID",
- "calendarRuleId" : "a calendar rule id",
- "type" : "a calendar rule created event type",
- "priority" : 1,
- "calendarDayOID" : "a calendar day OID",
- "dayType" : "a day type",
- "metadata" : "some metadata",
- "finalRule" : false,
- "randomTimeRange" : 1,
- "startDay" : 4,
- "startMonth" : 3,
- "startYear" : 5,
- "startTimeHours" : 6,
- "startTimeMinutes" : 10,
- "endDay" : 9,
- "endMonth" : 11,
- "endYear" : 7,
- "endTimeHours" : 2,
- "endTimeMinutes" : 8,
- "name" : "CalendarRuleCreatedEvent"
+ "owningPartner" : "an owning partner",
+ "gatewayId" : "A gateway id (ex: 0101-1234-5678)",
+ "type" : "GatewaySynchronizationEndedEvent"
} |
@@ -64075,23 +66638,23 @@ Generated events on method call
- | calendarRuleId |
- Calendar rule Id |
+ gatewayId |
+ Gateway id |
- | calendarRuleOID |
- Calendar rule OID |
+ owningPartner |
+ Owning partner of the parent entity (gateway, setup group, ...)) . only available in event streams |
- | owningPartners |
- Owning partners of the parent entity (setup, ...)) . only available in event streams |
+ setupOID |
+ Setup OID |
- | setupOID |
- Setup OID |
+ siteOID |
+ Site OID |
@@ -64107,10 +66670,12 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
+ "setupOID" : "a setup OID",
"owningPartner" : "an owning partner",
"gatewayId" : "A gateway id (ex: 0101-1234-5678)",
- "name" : "GatewaySynchronizationStartedEvent"
+ "type" : "GatewaySynchronizationStartedEvent"
} |
@@ -64128,23 +66693,52 @@ Generated events on method call
Owning partner of the parent entity (gateway, setup group, ...)) . only available in event streams |
+
+ | setupOID |
+ Setup OID |
+
+
+
+ | siteOID |
+ Site OID |
+
+
- GatewaySynchronizationEndedEvent
+ CalendarRuleCreatedEvent
| Description |
- A data synchronization sequence between the gateway and the server has completed |
+ A calendar rule has been created |
| JSON |
{
- "timestamp" : 2,
- "owningPartner" : "an owning partner",
- "gatewayId" : "A gateway id (ex: 0101-1234-5678)",
- "name" : "GatewaySynchronizationEndedEvent"
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
+ "setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
+ "calendarRuleOID" : "a calendar rule OID",
+ "calendarRuleId" : "a calendar rule id",
+ "priority" : 1,
+ "calendarDayOID" : "a calendar day OID",
+ "dayType" : "a day type",
+ "metadata" : "some metadata",
+ "finalRule" : false,
+ "randomTimeRange" : 1,
+ "startDay" : 7,
+ "startMonth" : 3,
+ "startYear" : 8,
+ "startTimeHours" : 4,
+ "startTimeMinutes" : 10,
+ "endDay" : 6,
+ "endMonth" : 11,
+ "endYear" : 5,
+ "endTimeHours" : 2,
+ "endTimeMinutes" : 9,
+ "type" : "CalendarRuleCreatedEvent"
} |
@@ -64153,13 +66747,28 @@ Generated events on method call
- | gatewayId |
- Gateway id |
+ calendarRuleId |
+ Calendar rule Id |
- | owningPartner |
- Owning partner of the parent entity (gateway, setup group, ...)) . only available in event streams |
+ calendarRuleOID |
+ Calendar rule OID |
+
+
+
+ | owningPartners |
+ Owning partners of the parent entity (setup, ...)) . only available in event streams |
+
+
+
+ | setupOID |
+ Setup OID |
+
+
+
+ | siteOID |
+ Site OID |
@@ -64227,7 +66836,7 @@ Generated events on method call
Update a calendar rule.
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -64398,29 +67007,29 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"calendarRuleOID" : "a calendar rule OID",
"calendarRuleId" : "a calendar rule id",
- "type" : "a calendar rule updated event type",
"priority" : 1,
"calendarDayOID" : "a calendar day OID",
"dayType" : "a day type",
"metadata" : "some metadata",
"finalRule" : false,
"randomTimeRange" : 1,
- "startDay" : 4,
+ "startDay" : 7,
"startMonth" : 3,
- "startYear" : 5,
- "startTimeHours" : 6,
+ "startYear" : 8,
+ "startTimeHours" : 4,
"startTimeMinutes" : 10,
- "endDay" : 9,
+ "endDay" : 6,
"endMonth" : 11,
- "endYear" : 7,
+ "endYear" : 5,
"endTimeHours" : 2,
- "endTimeMinutes" : 8,
- "name" : "CalendarRuleUpdatedEvent"
+ "endTimeMinutes" : 9,
+ "type" : "CalendarRuleUpdatedEvent"
} |
@@ -64448,23 +67057,30 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
- GatewaySynchronizationStartedEvent
+ GatewaySynchronizationEndedEvent
| Description |
- A data synchronization sequence between the gateway and the server has started |
+ A data synchronization sequence between the gateway and the server has completed |
| JSON |
{
- "timestamp" : 2,
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
+ "setupOID" : "a setup OID",
"owningPartner" : "an owning partner",
"gatewayId" : "A gateway id (ex: 0101-1234-5678)",
- "name" : "GatewaySynchronizationStartedEvent"
+ "type" : "GatewaySynchronizationEndedEvent"
} |
@@ -64482,23 +67098,35 @@ Generated events on method call
Owning partner of the parent entity (gateway, setup group, ...)) . only available in event streams |
+
+ | setupOID |
+ Setup OID |
+
+
+
+ | siteOID |
+ Site OID |
+
+
- GatewaySynchronizationEndedEvent
+ GatewaySynchronizationStartedEvent
| Description |
- A data synchronization sequence between the gateway and the server has completed |
+ A data synchronization sequence between the gateway and the server has started |
| JSON |
{
- "timestamp" : 2,
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
+ "setupOID" : "a setup OID",
"owningPartner" : "an owning partner",
"gatewayId" : "A gateway id (ex: 0101-1234-5678)",
- "name" : "GatewaySynchronizationEndedEvent"
+ "type" : "GatewaySynchronizationStartedEvent"
} |
@@ -64516,6 +67144,16 @@ Generated events on method call
Owning partner of the parent entity (gateway, setup group, ...)) . only available in event streams |
+
+ | setupOID |
+ Setup OID |
+
+
+
+ | siteOID |
+ Site OID |
+
+
@@ -64581,7 +67219,7 @@ Generated events on method call
Get a calendar rule.
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -64638,8 +67276,8 @@ Generated events on method call
{
"weeklyCalendarRule" : {
- "creationTime" : 1769503155347,
- "lastUpdateTime" : 1769503155348,
+ "creationTime" : 1785140822063,
+ "lastUpdateTime" : 1785140822065,
"priority" : 1,
"calendarDayOID" : "a calendar day OID",
"finalRule" : true,
@@ -64652,8 +67290,8 @@ Generated events on method call
"endTimeHours" : 1,
"endTimeMinutes" : 1,
"localCalendarDay" : {
- "creationTime" : 1769503155347,
- "lastUpdateTime" : 1769503155348,
+ "creationTime" : 1785140822064,
+ "lastUpdateTime" : 1785140822064,
"label" : "a calendar day label",
"type" : "DAY_OFF_AT_HOME",
"dayTimeTriggers" : [ {
@@ -64673,8 +67311,8 @@ Generated events on method call
"alwaysAfterMinutes" : 10,
"actionGroupOID" : "an action group OID",
"localActionGroup" : {
- "creationTime" : 1769503155347,
- "lastUpdateTime" : 1769503155348,
+ "creationTime" : 1785140822064,
+ "lastUpdateTime" : 1785140822064,
"label" : "a managed action group label",
"metadata" : "some metadata",
"shortcut" : false,
@@ -64818,7 +67456,7 @@ Generated events on method call
Delete a calendar rule.
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
|
@@ -64891,19 +67529,21 @@ Generated events on method call
Generated events on method call
- GatewaySynchronizationStartedEvent
+ CalendarRuleDeletedEvent
| Description |
- A data synchronization sequence between the gateway and the server has started |
+ A calendar rule has been deleted |
| JSON |
{
- "timestamp" : 2,
- "owningPartner" : "an owning partner",
- "gatewayId" : "A gateway id (ex: 0101-1234-5678)",
- "name" : "GatewaySynchronizationStartedEvent"
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
+ "setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
+ "calendarRuleOID" : "a calendar rule OID",
+ "type" : "CalendarRuleDeletedEvent"
} |
@@ -64912,13 +67552,23 @@ Generated events on method call
- | gatewayId |
- Gateway id |
+ calendarRuleOID |
+ Calendar rule OID |
- | owningPartner |
- Owning partner of the parent entity (gateway, setup group, ...)) . only available in event streams |
+ owningPartners |
+ Owning partners of the parent entity (setup, ...)) . only available in event streams |
+
+
+
+ | setupOID |
+ Setup OID |
+
+
+
+ | siteOID |
+ Site OID |
@@ -64934,10 +67584,12 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
+ "setupOID" : "a setup OID",
"owningPartner" : "an owning partner",
"gatewayId" : "A gateway id (ex: 0101-1234-5678)",
- "name" : "GatewaySynchronizationEndedEvent"
+ "type" : "GatewaySynchronizationEndedEvent"
} |
@@ -64955,24 +67607,35 @@ Generated events on method call
Owning partner of the parent entity (gateway, setup group, ...)) . only available in event streams |
+
+ | setupOID |
+ Setup OID |
+
+
+
+ | siteOID |
+ Site OID |
+
+
- CalendarRuleDeletedEvent
+ GatewaySynchronizationStartedEvent
| Description |
- A calendar rule has been deleted |
+ A data synchronization sequence between the gateway and the server has started |
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
- "calendarRuleOID" : "a calendar rule OID",
- "name" : "CalendarRuleDeletedEvent"
+ "owningPartner" : "an owning partner",
+ "gatewayId" : "A gateway id (ex: 0101-1234-5678)",
+ "type" : "GatewaySynchronizationStartedEvent"
} |
@@ -64981,13 +67644,13 @@ Generated events on method call
- | calendarRuleOID |
- Calendar rule OID |
+ gatewayId |
+ Gateway id |
- | owningPartners |
- Owning partners of the parent entity (setup, ...)) . only available in event streams |
+ owningPartner |
+ Owning partner of the parent entity (gateway, setup group, ...)) . only available in event streams |
@@ -64995,6 +67658,11 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
@@ -65060,7 +67728,7 @@ Generated events on method call
Create a set of calendar rules.
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -65258,10 +67926,12 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
+ "setupOID" : "a setup OID",
"owningPartner" : "an owning partner",
"gatewayId" : "A gateway id (ex: 0101-1234-5678)",
- "name" : "GatewaySynchronizationStartedEvent"
+ "type" : "GatewaySynchronizationStartedEvent"
} |
@@ -65279,38 +67949,14 @@ Generated events on method call
Owning partner of the parent entity (gateway, setup group, ...)) . only available in event streams |
-
-
-
-
- GatewaySynchronizationEndedEvent
-
- | Description |
- A data synchronization sequence between the gateway and the server has completed |
-
-
-
- | JSON |
- {
- "timestamp" : 2,
- "owningPartner" : "an owning partner",
- "gatewayId" : "A gateway id (ex: 0101-1234-5678)",
- "name" : "GatewaySynchronizationEndedEvent"
-} |
-
-
- | Field name |
- Field description |
-
-
- | gatewayId |
- Gateway id |
+ setupOID |
+ Setup OID |
- | owningPartner |
- Owning partner of the parent entity (gateway, setup group, ...)) . only available in event streams |
+ siteOID |
+ Site OID |
@@ -65326,29 +67972,29 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"calendarRuleOID" : "a calendar rule OID",
"calendarRuleId" : "a calendar rule id",
- "type" : "a calendar rule created event type",
"priority" : 1,
"calendarDayOID" : "a calendar day OID",
"dayType" : "a day type",
"metadata" : "some metadata",
"finalRule" : false,
"randomTimeRange" : 1,
- "startDay" : 4,
+ "startDay" : 7,
"startMonth" : 3,
- "startYear" : 5,
- "startTimeHours" : 6,
+ "startYear" : 8,
+ "startTimeHours" : 4,
"startTimeMinutes" : 10,
- "endDay" : 9,
+ "endDay" : 6,
"endMonth" : 11,
- "endYear" : 7,
+ "endYear" : 5,
"endTimeHours" : 2,
- "endTimeMinutes" : 8,
- "name" : "CalendarRuleCreatedEvent"
+ "endTimeMinutes" : 9,
+ "type" : "CalendarRuleCreatedEvent"
} |
@@ -65376,6 +68022,57 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
+
+
+
+
+ GatewaySynchronizationEndedEvent
+
+ | Description |
+ A data synchronization sequence between the gateway and the server has completed |
+
+
+
+ | JSON |
+ {
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
+ "setupOID" : "a setup OID",
+ "owningPartner" : "an owning partner",
+ "gatewayId" : "A gateway id (ex: 0101-1234-5678)",
+ "type" : "GatewaySynchronizationEndedEvent"
+} |
+
+
+ | Field name |
+ Field description |
+
+
+
+ | gatewayId |
+ Gateway id |
+
+
+
+ | owningPartner |
+ Owning partner of the parent entity (gateway, setup group, ...)) . only available in event streams |
+
+
+
+ | setupOID |
+ Setup OID |
+
+
+
+ | siteOID |
+ Site OID |
+
+
@@ -65441,7 +68138,7 @@ Generated events on method call
Update a set of calendar rules.
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -65602,6 +68299,52 @@ Generated events on method call
Generated events on method call
+
+ GatewaySynchronizationStartedEvent
+
+ | Description |
+ A data synchronization sequence between the gateway and the server has started |
+
+
+
+ | JSON |
+ {
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
+ "setupOID" : "a setup OID",
+ "owningPartner" : "an owning partner",
+ "gatewayId" : "A gateway id (ex: 0101-1234-5678)",
+ "type" : "GatewaySynchronizationStartedEvent"
+} |
+
+
+ | Field name |
+ Field description |
+
+
+
+ | gatewayId |
+ Gateway id |
+
+
+
+ | owningPartner |
+ Owning partner of the parent entity (gateway, setup group, ...)) . only available in event streams |
+
+
+
+ | setupOID |
+ Setup OID |
+
+
+
+ | siteOID |
+ Site OID |
+
+
+
+
+
CalendarRuleUpdatedEvent
@@ -65612,29 +68355,29 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"calendarRuleOID" : "a calendar rule OID",
"calendarRuleId" : "a calendar rule id",
- "type" : "a calendar rule updated event type",
"priority" : 1,
"calendarDayOID" : "a calendar day OID",
"dayType" : "a day type",
"metadata" : "some metadata",
"finalRule" : false,
"randomTimeRange" : 1,
- "startDay" : 4,
+ "startDay" : 7,
"startMonth" : 3,
- "startYear" : 5,
- "startTimeHours" : 6,
+ "startYear" : 8,
+ "startTimeHours" : 4,
"startTimeMinutes" : 10,
- "endDay" : 9,
+ "endDay" : 6,
"endMonth" : 11,
- "endYear" : 7,
+ "endYear" : 5,
"endTimeHours" : 2,
- "endTimeMinutes" : 8,
- "name" : "CalendarRuleUpdatedEvent"
+ "endTimeMinutes" : 9,
+ "type" : "CalendarRuleUpdatedEvent"
} |
@@ -65662,23 +68405,30 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
- GatewaySynchronizationStartedEvent
+ GatewaySynchronizationEndedEvent
| Description |
- A data synchronization sequence between the gateway and the server has started |
+ A data synchronization sequence between the gateway and the server has completed |
| JSON |
{
- "timestamp" : 2,
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
+ "setupOID" : "a setup OID",
"owningPartner" : "an owning partner",
"gatewayId" : "A gateway id (ex: 0101-1234-5678)",
- "name" : "GatewaySynchronizationStartedEvent"
+ "type" : "GatewaySynchronizationEndedEvent"
} |
@@ -65696,38 +68446,14 @@ Generated events on method call
Owning partner of the parent entity (gateway, setup group, ...)) . only available in event streams |
-
-
-
-
- GatewaySynchronizationEndedEvent
-
- | Description |
- A data synchronization sequence between the gateway and the server has completed |
-
-
-
- | JSON |
- {
- "timestamp" : 2,
- "owningPartner" : "an owning partner",
- "gatewayId" : "A gateway id (ex: 0101-1234-5678)",
- "name" : "GatewaySynchronizationEndedEvent"
-} |
-
-
- | Field name |
- Field description |
-
-
- | gatewayId |
- Gateway id |
+ setupOID |
+ Setup OID |
- | owningPartner |
- Owning partner of the parent entity (gateway, setup group, ...)) . only available in event streams |
+ siteOID |
+ Site OID |
@@ -65795,7 +68521,7 @@ Generated events on method call
Delete a set of calendar rules.
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -65868,19 +68594,21 @@ Generated events on method call
Generated events on method call
- GatewaySynchronizationEndedEvent
+ GatewaySynchronizationStartedEvent
| Description |
- A data synchronization sequence between the gateway and the server has completed |
+ A data synchronization sequence between the gateway and the server has started |
| JSON |
{
- "timestamp" : 2,
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
+ "setupOID" : "a setup OID",
"owningPartner" : "an owning partner",
"gatewayId" : "A gateway id (ex: 0101-1234-5678)",
- "name" : "GatewaySynchronizationEndedEvent"
+ "type" : "GatewaySynchronizationStartedEvent"
} |
@@ -65898,6 +68626,16 @@ Generated events on method call
Owning partner of the parent entity (gateway, setup group, ...)) . only available in event streams |
+
+ | setupOID |
+ Setup OID |
+
+
+
+ | siteOID |
+ Site OID |
+
+
@@ -65911,11 +68649,12 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"calendarRuleOID" : "a calendar rule OID",
- "name" : "CalendarRuleDeletedEvent"
+ "type" : "CalendarRuleDeletedEvent"
} |
@@ -65938,23 +68677,30 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
- GatewaySynchronizationStartedEvent
+ GatewaySynchronizationEndedEvent
| Description |
- A data synchronization sequence between the gateway and the server has started |
+ A data synchronization sequence between the gateway and the server has completed |
| JSON |
{
- "timestamp" : 2,
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
+ "setupOID" : "a setup OID",
"owningPartner" : "an owning partner",
"gatewayId" : "A gateway id (ex: 0101-1234-5678)",
- "name" : "GatewaySynchronizationStartedEvent"
+ "type" : "GatewaySynchronizationEndedEvent"
} |
@@ -65972,6 +68718,16 @@ Generated events on method call
Owning partner of the parent entity (gateway, setup group, ...)) . only available in event streams |
+
+ | setupOID |
+ Setup OID |
+
+
+
+ | siteOID |
+ Site OID |
+
+
@@ -66037,7 +68793,7 @@ Generated events on method call
Get calendar status.
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -66170,7 +68926,7 @@ Generated events on method call
Update calendar status.
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -66254,12 +69010,14 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
+ "setupOID" : "a setup OID",
"owningPartner" : "an owning partner",
"gatewayId" : "A gateway id (ex: 0101-1234-5678)",
"functionType" : 1,
"enabled" : false,
- "name" : "GatewayFunctionChangedEvent"
+ "type" : "GatewayFunctionChangedEvent"
} |
@@ -66287,6 +69045,16 @@ Generated events on method call
Owning partner of the parent entity (gateway, setup group, ...)) . only available in event streams |
+
+ | setupOID |
+ Setup OID |
+
+
+
+ | siteOID |
+ Site OID |
+
+
@@ -66381,7 +69149,7 @@
Delete a list of pictures.
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -66536,7 +69304,7 @@
Note that the sessionId timeout is 30 seconds.
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -66718,7 +69486,7 @@
Delete a picture
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -66864,7 +69632,7 @@
Get url of a picture of a camera
Url contains a session id available for 30 seconds.
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -67039,7 +69807,7 @@
Delete every picture
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -67170,7 +69938,7 @@
Get a url where pictures can be exported within a zip file. Url contains a session id available for 30 seconds
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -67343,7 +70111,7 @@
Note that the sessionId timeout is 30 seconds.
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -67542,7 +70310,7 @@
Get pictures of a camera in a time range and pictures range
Same as getPictures operation but within a range of pictures.
This operation is useful to render a paginated pictures library.
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -67799,7 +70567,7 @@
Get a particular setup device definition
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -67872,13 +70640,14 @@
(JSON)
{
- "creationTime" : 1769503155248,
- "lastUpdateTime" : 1769503155269,
- "label" : "a device label",
+ "label" : "a device response label",
+ "uiClass" : "a ui class",
"deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
- "shortcut" : false,
- "controllableName" : "core:StatefulClosableActuator",
+ "shortcut" : true,
+ "controllableName" : "a controllable name",
"metadata" : "some metadata",
+ "creationTime" : 1785140821935,
+ "lastUpdateTime" : 1785140821958,
"definition" : {
"commands" : [ {
"commandName" : "a command name",
@@ -67901,7 +70670,7 @@
"name" : "a device state name",
"type" : 1,
"value" : "a device state value",
- "lastUpdateTime" : 120123456793
+ "lastUpdateTime" : 120123456794
} ],
"attributes" : [ {
"name" : "a device attribute name",
@@ -67912,13 +70681,18 @@
"name" : "a device manufacturer data name",
"value" : "a device manufacturer data value"
} ],
+ "localDeviceData" : [ {
+ "key" : "a key",
+ "value" : "a local device attribute value",
+ "category" : "a category",
+ "localDeviceOID" : "a local device OID"
+ } ],
"available" : false,
- "enabled" : true,
+ "enabled" : false,
"placeOID" : "a place OID",
+ "oid" : "the device response UUID",
"widget" : "a widget name",
- "type" : 1,
- "oid" : "the device UUID",
- "uiClass" : "a ui class"
+ "type" : 1
} |
@@ -68023,7 +70797,7 @@
This operation allows to delete a device
This operation is useful to delete IO actuators, RTS devices, RTD alarm system and sensors, EnOcean actuators and Ramses devices.
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
|
@@ -68125,11 +70899,12 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
- "name" : "DeviceDeletionFailedEvent",
+ "type" : "DeviceDeletionFailedEvent",
"failureType" : "NON_EXECUTING"
} |
@@ -68158,6 +70933,11 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
@@ -68171,12 +70951,13 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
"controllableName" : "a controllable name",
- "name" : "DeviceRemovedEvent"
+ "type" : "DeviceRemovedEvent"
} |
@@ -68199,6 +70980,11 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
@@ -68265,7 +71051,7 @@ Generated events on method call
This operation allows to delete a device
This operation is useful to delete IO actuators, RTS devices, RTD alarm system and sensors, EnOcean actuators and Ramses devices.
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -68358,21 +71144,22 @@ Generated events on method call
Generated events on method call
- DeviceRemovedEvent
+ DeviceDeletionFailedEvent
| Description |
- A device has been removed from the gateway |
+ Device deletion from the gateway has failed |
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
- "controllableName" : "a controllable name",
- "name" : "DeviceRemovedEvent"
+ "type" : "DeviceDeletionFailedEvent",
+ "failureType" : "NON_EXECUTING"
} |
@@ -68385,6 +71172,11 @@ Generated events on method call
Device URL |
+
+ | failureType |
+ Failure type |
+
+
| owningPartners |
Owning partners of the parent entity (setup, ...)) . only available in event streams |
@@ -68395,25 +71187,31 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
- DeviceDeletionFailedEvent
+ DeviceRemovedEvent
| Description |
- Device deletion from the gateway has failed |
+ A device has been removed from the gateway |
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
- "name" : "DeviceDeletionFailedEvent",
- "failureType" : "NON_EXECUTING"
+ "controllableName" : "a controllable name",
+ "type" : "DeviceRemovedEvent"
} |
@@ -68426,11 +71224,6 @@ Generated events on method call
Device URL |
-
- | failureType |
- Failure type |
-
-
| owningPartners |
Owning partners of the parent entity (setup, ...)) . only available in event streams |
@@ -68441,6 +71234,11 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
@@ -68506,7 +71304,7 @@ Generated events on method call
This operation allows to delete a device
This operation starts an asynchronous workflow to delete a device, updating action groups, triggers and calendar days if necessary. If device protocol allows it, the device is also unpaired from the gateway. Only one device deletion workflow may be run at a time. Use the returned jobId and events to determine when the workflow is complete.
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -68637,12 +71435,13 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
"controllableName" : "a controllable name",
- "name" : "DeviceRemovedEvent"
+ "type" : "DeviceRemovedEvent"
} |
@@ -68665,24 +71464,31 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
- SetupJobFailedEvent
+ DeviceDeletionFailedEvent
| Description |
- An asynchronous job has failed |
+ Device deletion from the gateway has failed |
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
- "jobId" : "a job id",
- "name" : "SetupJobFailedEvent"
+ "owningPartners" : [ "some owning partners" ],
+ "deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
+ "type" : "DeviceDeletionFailedEvent",
+ "failureType" : "NON_EXECUTING"
} |
@@ -68690,6 +71496,16 @@ Generated events on method call
Field description |
+
+ | deviceURL |
+ Device URL |
+
+
+
+ | failureType |
+ Failure type |
+
+
| owningPartners |
Owning partners of the parent entity (setup, ...)) . only available in event streams |
@@ -68700,25 +71516,30 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
- DeviceDeletionFailedEvent
+ SetupJobCompletedEvent
| Description |
- Device deletion from the gateway has failed |
+ An asynchronous job has completed successfully |
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
- "deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
- "name" : "DeviceDeletionFailedEvent",
- "failureType" : "NON_EXECUTING"
+ "owningPartners" : [ "some owning partners" ],
+ "jobId" : "a job id",
+ "type" : "SetupJobCompletedEvent"
} |
@@ -68726,16 +71547,6 @@ Generated events on method call
Field description |
-
- | deviceURL |
- Device URL |
-
-
-
- | failureType |
- Failure type |
-
-
| owningPartners |
Owning partners of the parent entity (setup, ...)) . only available in event streams |
@@ -68746,24 +71557,30 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
- SetupJobCompletedEvent
+ SetupJobFailedEvent
| Description |
- An asynchronous job has completed successfully |
+ An asynchronous job has failed |
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"jobId" : "a job id",
- "name" : "SetupJobCompletedEvent"
+ "type" : "SetupJobFailedEvent"
} |
@@ -68781,6 +71598,11 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
@@ -68846,7 +71668,7 @@ Generated events on method call
Get a particular setup device controllable definition
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -69003,7 +71825,7 @@ Generated events on method call
- /setup/devices/{deviceURL}/relocate/{placeOID}
+ /setup/devices/{deviceURL}/label/{label}
@@ -69019,10 +71841,10 @@ Generated events on method call
|
- Relocate a device in an existing place
+ Update the name of a device
- Access scope : Full enduser API access (enduser/*)
- > Test operation
+ Access scope : enduser/*
+ > Test operation
|
@@ -69051,7 +71873,7 @@ Generated events on method call
- Device URL to relocate
+ Device URL to update
|
@@ -69060,13 +71882,30 @@ Generated events on method call
Path Variable
- placeOID
+ label
|
"string value" |
- Existing place OID where device is relocated
+ New device label
+ |
+
+
+
+ |
+ Request Parameter
+ |
+
+ updateDeviceName
+ |
+ false |
+
+ (Optional)
+
+ (Default: false)
+
+ If true, device name will also be updated
|
@@ -69074,6 +71913,35 @@ Generated events on method call
+
+
+ Response
+
+ | Type |
+ Name |
+ Value |
+ Description |
+
+
+
+ |
+ Response Body
+ |
+
+ (JSON)
+ |
+ {
+ "execId" : "string value"
+} |
+
+
+
+
+ |
+
+
+
+
@@ -69118,15 +71986,16 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
"controllableName" : "a controllable name",
"label" : "a device updated event label",
"placeOID" : "a place OID",
"metadata" : "some metadata",
- "name" : "DeviceUpdatedEvent"
+ "type" : "DeviceUpdatedEvent"
} |
@@ -69149,6 +72018,11 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
@@ -69196,7 +72070,7 @@ Generated events on method call
- /setup/devices/{deviceURL}/{label}
+ /setup/devices/{deviceURL}/relocate/{placeOID}
@@ -69212,10 +72086,10 @@ Generated events on method call
|
- Update the name of a device
+ Relocate a device in an existing place
- Access scope : Full enduser API access (enduser/*)
- > Test operation
+ Access scope : enduser/*
+ > Test operation
|
@@ -69244,7 +72118,7 @@ Generated events on method call
- Device URL to update
+ Device URL to relocate
|
@@ -69253,30 +72127,13 @@ Generated events on method call
Path Variable
- label
+ placeOID
|
"string value" |
- New device label
- |
-
-
-
- |
- Request Parameter
- |
-
- updateDeviceName
- |
- false |
-
- (Optional)
-
- (Default: false)
-
- If true, device name will also be updated
+ Existing place OID where device is relocated
|
@@ -69284,35 +72141,6 @@ Generated events on method call
-
-
- Response
-
- | Type |
- Name |
- Value |
- Description |
-
-
-
- |
- Response Body
- |
-
- (JSON)
- |
- {
- "execId" : "string value"
-} |
-
-
-
-
- |
-
-
-
-
@@ -69357,15 +72185,16 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
"controllableName" : "a controllable name",
"label" : "a device updated event label",
"placeOID" : "a place OID",
"metadata" : "some metadata",
- "name" : "DeviceUpdatedEvent"
+ "type" : "DeviceUpdatedEvent"
} |
@@ -69388,6 +72217,11 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
@@ -69406,7 +72240,7 @@ Generated events on method call
-
+
Generated events on method call
">
+ Device [DEPRECATED]
+ since version 2026.2.1
- Device
|
+ /setup/devices/{deviceURL}/{label}
- /setup/devices/{deviceURL}/{label}/subSystems
|
@@ -69451,10 +72286,10 @@ Generated events on method call
|
- Update the name of a device
Rename all subsystems at once like newLabel-1, newLabel-2, ... Set to true by default.
+ Update the name of a device
- Access scope : Full enduser API access (enduser/*)
- > Test operation
+ Access scope : enduser/*
+ > Test operation
|
@@ -69502,10 +72337,56 @@ Generated events on method call
+
+ |
+ Request Parameter
+ |
+
+ updateDeviceName
+ |
+ false |
+
+ (Optional)
+
+ (Default: false)
+
+ If true, device name will also be updated
+ |
+
+
+
+
+ Response
+
+ | Type |
+ Name |
+ Value |
+ Description |
+
+
+
+ |
+ Response Body
+ |
+
+ (JSON)
+ |
+ {
+ "execId" : "string value"
+} |
+
+
+
+
+ |
+
+
+
+
@@ -69550,15 +72431,16 @@ Generated events on method call
|
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
"controllableName" : "a controllable name",
"label" : "a device updated event label",
"placeOID" : "a place OID",
"metadata" : "some metadata",
- "name" : "DeviceUpdatedEvent"
+ "type" : "DeviceUpdatedEvent"
} |
@@ -69581,6 +72463,11 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
@@ -69628,7 +72515,7 @@ Generated events on method call
- /setup/devices/{deviceURL}/{label}/{category}
+ /setup/devices/{deviceURL}/{label}/subSystems
@@ -69644,12 +72531,10 @@ Generated events on method call
|
- Update the name of a device and its measurement category
This will set the device attribute core:MeasurementCategory to the set newCategory parameter (See Appendix for details about supported measurement category values).
-
-This operation is only supported by sensor device that has measurement behavior.
+ Update the name of a device
Rename all subsystems at once like newLabel-1, newLabel-2, ... Set to true by default.
- Access scope : Full enduser API access (enduser/*)
- > Test operation
+ Access scope : enduser/*
+ > Test operation
|
@@ -69697,71 +72582,10 @@ Generated events on method call
-
- |
- Path Variable
- |
-
- category
- |
- "string value" |
-
-
-
- New device measurement category
- |
-
-
-
- |
- Request Parameter
- |
-
- updateDeviceName
- |
- false |
-
- (Optional)
-
- (Default: false)
-
- If true, device name will also be updated
- |
-
-
-
-
- Response
-
- | Type |
- Name |
- Value |
- Description |
-
-
-
- |
- Response Body
- |
-
- (JSON)
- |
- {
- "execId" : "string value"
-} |
-
-
-
-
- |
-
-
-
-
@@ -69806,15 +72630,16 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
"controllableName" : "a controllable name",
"label" : "a device updated event label",
"placeOID" : "a place OID",
"metadata" : "some metadata",
- "name" : "DeviceUpdatedEvent"
+ "type" : "DeviceUpdatedEvent"
} |
@@ -69837,6 +72662,11 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
@@ -69876,7 +72706,7 @@ Generated events on method call
- Device Type
+ Device
@@ -69884,7 +72714,7 @@ Generated events on method call
- /setup/devices/{deviceURL}/deviceType/{newDeviceType}
+ /setup/devices/{deviceURL}/{label}/{category}
@@ -69900,10 +72730,12 @@ Generated events on method call
|
- Update device type with new device type
+ Update the name of a device and its measurement category
This will set the device attribute core:MeasurementCategory to the set newCategory parameter (See Appendix for details about supported measurement category values).
- Access scope : Full enduser API access (enduser/*)
- > Test operation
+This operation is only supported by sensor device that has measurement behavior.
+
+ Access scope : enduser/*
+ > Test operation
|
@@ -69932,7 +72764,7 @@ Generated events on method call
- Device URL
+ Device URL to update
|
@@ -69941,13 +72773,45 @@ Generated events on method call
Path Variable
- newDeviceType
+ label
|
- 2 |
+ "string value" |
- New device type
+ New device label
+ |
+
+
+
+ |
+ Path Variable
+ |
+
+ category
+ |
+ "string value" |
+
+
+
+ New device measurement category
+ |
+
+
+
+ |
+ Request Parameter
+ |
+
+ updateDeviceName
+ |
+ false |
+
+ (Optional)
+
+ (Default: false)
+
+ If true, device name will also be updated
|
@@ -69955,6 +72819,35 @@ Generated events on method call
+
+
+ Response
+
+ | Type |
+ Name |
+ Value |
+ Description |
+
+
+
+ |
+ Response Body
+ |
+
+ (JSON)
+ |
+ {
+ "execId" : "string value"
+} |
+
+
+
+
+ |
+
+
+
+
@@ -69999,15 +72892,16 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
"controllableName" : "a controllable name",
"label" : "a device updated event label",
"placeOID" : "a place OID",
"metadata" : "some metadata",
- "name" : "DeviceUpdatedEvent"
+ "type" : "DeviceUpdatedEvent"
} |
@@ -70030,6 +72924,11 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
@@ -70052,24 +72951,24 @@ Generated events on method call
- | GET |
+ PUT |
- Device additional information
+ Device Type
|
@@ -70077,26 +72976,26 @@ Generated events on method call
- /setup/devices/additionalInformation
+ /setup/devices/{deviceURL}/deviceType/{newDeviceType}
application/json |
|
- Get additional information
This operation returns additional information.
+ Update device type with new device type
- Access scope : Full enduser API access (enduser/*)
- > Test operation
+ Access scope : enduser/*
+ > Test operation
|
@@ -70104,11 +73003,9 @@ Generated events on method call
-
-
-
-
- Response
+
+
+ Parameters
| Type |
Name |
@@ -70118,30 +73015,39 @@ Generated events on method call
|
- Response Body
+ Path Variable
|
- (JSON)
+ deviceURL
|
- [ {
- "templateId" : "a template id",
- "type" : "SERIAL_NUMBER",
- "label" : "a device additional info label",
- "value" : "a device additional info value",
- "rank" : 1,
- "unsafe" : true,
- "deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])"
-} ] |
+ "string value" |
+ Device URL
+ |
+
+
+
+ |
+ Path Variable
+ |
+
+ newDeviceType
+ |
+ 2 |
+
+
+ New device type
|
+
+
@@ -70173,6 +73079,59 @@ Generated events on method call
+ Generated events on method call
+
+
+ DeviceUpdatedEvent
+
+ | Description |
+ Device has been updated |
+
+
+
+ | JSON |
+ {
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
+ "setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
+ "deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
+ "controllableName" : "a controllable name",
+ "label" : "a device updated event label",
+ "placeOID" : "a place OID",
+ "metadata" : "some metadata",
+ "type" : "DeviceUpdatedEvent"
+} |
+
+
+ | Field name |
+ Field description |
+
+
+
+ | deviceURL |
+ Device URL |
+
+
+
+ | owningPartners |
+ Owning partners of the parent entity (setup, ...)) . only available in event streams |
+
+
+
+ | setupOID |
+ Setup OID |
+
+
+
+ | siteOID |
+ Site OID |
+
+
+
+
+
+
@@ -70216,7 +73175,7 @@ Generated events on method call
- /setup/devices/{deviceURL}/additionalInformation
+ /setup/devices/additionalInformation
@@ -70232,10 +73191,10 @@ Generated events on method call
|
- Get additional information
This operation returns device additional information.
+ Get additional information
This operation returns additional information.
- Access scope : Full enduser API access (enduser/*)
- > Test operation
+ Access scope : enduser/*
+ > Test operation
|
@@ -70243,33 +73202,6 @@ Generated events on method call
-
-
- Parameters
-
- | Type |
- Name |
- Value |
- Description |
-
-
-
- |
- Path Variable
- |
-
- deviceURL
- |
- "string value" |
-
-
-
- The url of the device
- |
-
-
-
-
@@ -70382,7 +73314,7 @@ Generated events on method call
- /setup/devices/{deviceURL}/additionalInformation/{templateId}
+ /setup/devices/{deviceURL}/additionalInformation
|
@@ -70400,8 +73332,8 @@ Generated events on method call
Get additional information
This operation returns device additional information.
- Access scope : Full enduser API access (enduser/*)
- > Test operation
+ Access scope : enduser/*
+ > Test operation
@@ -70434,21 +73366,6 @@ Generated events on method call
-
- |
- Path Variable
- |
-
- templateId
- |
- "string value" |
-
-
-
- Additional information template id
- |
-
-
@@ -70470,7 +73387,7 @@ Generated events on method call
(JSON)
|
- {
+ [ {
"templateId" : "a template id",
"type" : "SERIAL_NUMBER",
"label" : "a device additional info label",
@@ -70478,7 +73395,7 @@ Generated events on method call
"rank" : 1,
"unsafe" : true,
"deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])"
-} |
+} ] |
@@ -70555,7 +73472,7 @@ Generated events on method call
- Device attribute
+ Device additional information
|
@@ -70563,7 +73480,7 @@ Generated events on method call
- /setup/devices/{deviceURL}/attributes/{name}
+ /setup/devices/{deviceURL}/additionalInformation/{templateId}
@@ -70579,10 +73496,10 @@ Generated events on method call
|
- Get a particular attribute of a requested product
+ Get additional information
This operation returns device additional information.
- Access scope : Full enduser API access (enduser/*)
- > Test operation
+ Access scope : enduser/*
+ > Test operation
|
@@ -70620,13 +73537,13 @@ Generated events on method call
Path Variable
- name
+ templateId
|
"string value" |
- The name of the attribute
+ Additional information template id
|
@@ -70652,9 +73569,13 @@ Generated events on method call
(JSON)
{
- "name" : "a device attribute name",
- "type" : 1,
- "value" : "a device attribute value"
+ "templateId" : "a template id",
+ "type" : "SERIAL_NUMBER",
+ "label" : "a device additional info label",
+ "value" : "a device additional info value",
+ "rank" : 1,
+ "unsafe" : true,
+ "deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])"
} |
@@ -70732,7 +73653,7 @@ Generated events on method call
- Device attributes
+ Device attribute
|
@@ -70740,7 +73661,7 @@ Generated events on method call
- /setup/devices/{deviceURL}/attributes
+ /setup/devices/{deviceURL}/attributes/{name}
@@ -70756,10 +73677,10 @@ Generated events on method call
|
- Retrieve attributes of requested products
+ Get a particular attribute of a requested product
- Access scope : Full enduser API access (enduser/*)
- > Test operation
+ Access scope : enduser/*
+ > Test operation
|
@@ -70792,6 +73713,21 @@ Generated events on method call
+
+ |
+ Path Variable
+ |
+
+ name
+ |
+ "string value" |
+
+
+
+ The name of the attribute
+ |
+
+
@@ -70813,11 +73749,11 @@ Generated events on method call
|
(JSON)
|
- [ {
+ {
"name" : "a device attribute name",
"type" : 1,
"value" : "a device attribute value"
-} ] |
+} |
@@ -70877,24 +73813,24 @@ Generated events on method call
|
- | PUT |
+ GET |
- Device controllable
+ Device attributes
|
@@ -70902,26 +73838,26 @@ Generated events on method call
- /setup/devices/{deviceURL}/alternativeControllables/{newControllableName}
+ /setup/devices/{deviceURL}/attributes
application/json |
|
- Update device controllable with equivalent controllable
+ Retrieve attributes of requested products
- Access scope : Full enduser API access (enduser/*)
- > Test operation
+ Access scope : enduser/*
+ > Test operation
|
@@ -70950,30 +73886,192 @@ Generated events on method call
- Device URL
+ The url of the device
|
+
+
+
+
+
+
+ Response
+
+ | Type |
+ Name |
+ Value |
+ Description |
+
+
|
- Path Variable
+ Response Body
|
- newControllableName
+ (JSON)
|
- "string value" |
+ [ {
+ "name" : "a device attribute name",
+ "type" : 1,
+ "value" : "a device attribute value"
+} ] |
- New controllable name
+
|
-
-
+
+
+
+ HTTP Status Code
+
+ | Code |
+ Message |
+ Meaning |
+
+
+
+ |
+ 200
+ |
+ OK |
+
+ The request has succeeded
+ |
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ |
+
+
+ |
+
+
+
+
+
+
+
+
+ | PUT |
+
+
+
+
+ Device controllable
+
+
+ |
+
+
+
+
+ /setup/devices/{deviceURL}/alternativeControllables/{newControllableName}
+
+
+ |
+ application/json |
+
+
+ |
+
+
+ Update device controllable with equivalent controllable
+
+ Access scope : enduser/*
+ > Test operation
+ |
+
+
+ |
+
+
+
+
+
+ Parameters
+
+ | Type |
+ Name |
+ Value |
+ Description |
+
+
+
+ |
+ Path Variable
+ |
+
+ deviceURL
+ |
+ "string value" |
+
+
+
+ Device URL
+ |
+
+
+
+ |
+ Path Variable
+ |
+
+ newControllableName
+ |
+ "string value" |
+
+
+
+ New controllable name
+ |
+
+
+
+
+
+
+
@@ -71017,15 +74115,16 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
"controllableName" : "a controllable name",
"label" : "a device updated event label",
"placeOID" : "a place OID",
"metadata" : "some metadata",
- "name" : "DeviceUpdatedEvent"
+ "type" : "DeviceUpdatedEvent"
} |
@@ -71048,6 +74147,11 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
@@ -71114,7 +74218,7 @@ Generated events on method call
Update device controllable with equivalent controllable
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
|
@@ -71211,15 +74315,16 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
"controllableName" : "a controllable name",
"label" : "a device updated event label",
"placeOID" : "a place OID",
"metadata" : "some metadata",
- "name" : "DeviceUpdatedEvent"
+ "type" : "DeviceUpdatedEvent"
} |
@@ -71242,6 +74347,11 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
@@ -71307,7 +74417,7 @@ Generated events on method call
Get all equivalent controllables to another one
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
|
@@ -71466,7 +74576,7 @@ Generated events on method call
Get all equivalent controllables to another one
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -71624,7 +74734,7 @@ Generated events on method call
Check if device firmware is up-to-date
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -71787,7 +74897,7 @@ Generated events on method call
Check if device supports firmware update feature
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -71947,7 +75057,7 @@ Generated events on method call
Update The device firmware to the next available version
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -72020,20 +75130,22 @@ Generated events on method call
Generated events on method call
- DeviceFirmwareUpdateCompletedEvent
+ DeviceFirmwareUpdateStartedEvent
| Description |
- Device firmware update is completed |
+ A firmware update started on the given device |
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
+ "gatewayId" : "a gateway id",
"deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
- "name" : "DeviceFirmwareUpdateCompletedEvent"
+ "type" : "DeviceFirmwareUpdateStartedEvent"
} |
@@ -72043,7 +75155,12 @@ Generated events on method call
| deviceURL |
- Device URL |
+ The device address |
+
+
+
+ | gatewayId |
+ The gateway id |
@@ -72056,24 +75173,31 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
- DeviceFirmwareUpdateFailedEvent
+ GatewayFirmwareUpdateFailedEvent
| Description |
- Device firmware update failed |
+ Gateway firmware update failed |
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
- "deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
- "name" : "DeviceFirmwareUpdateFailedEvent",
+ "owningPartners" : [ "some owning partners" ],
+ "gatewayId" : "a gateway id",
+ "firmwareType" : "a firmware type",
+ "type" : "GatewayFirmwareUpdateFailedEvent",
"failureType" : "NON_EXECUTING"
} |
@@ -72082,11 +75206,6 @@ Generated events on method call
Field description |
-
- | deviceURL |
- Device URL |
-
-
| owningPartners |
Owning partners of the parent entity (setup, ...)) . only available in event streams |
@@ -72097,26 +75216,30 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
- GatewayFirmwareUpdateFailedEvent
+ DeviceFirmwareUpdateCompletedEvent
| Description |
- Gateway firmware update failed |
+ Device firmware update is completed |
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
- "gatewayId" : "a gateway id",
- "firmwareType" : "a firmware type",
- "name" : "GatewayFirmwareUpdateFailedEvent",
- "failureType" : "NON_EXECUTING"
+ "owningPartners" : [ "some owning partners" ],
+ "deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
+ "type" : "DeviceFirmwareUpdateCompletedEvent"
} |
@@ -72124,6 +75247,11 @@ Generated events on method call
Field description |
+
+ | deviceURL |
+ Device URL |
+
+
| owningPartners |
Owning partners of the parent entity (setup, ...)) . only available in event streams |
@@ -72134,24 +75262,31 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
- GatewayFirmwareUpdateStartedEvent
+ GatewayFirmwareUpdateCompletedEvent
| Description |
- A firmware update started on the given gateway |
+ Gateway firmware update is completed |
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"gatewayId" : "a gateway id",
- "name" : "GatewayFirmwareUpdateStartedEvent"
+ "firmwareType" : "a firmware type",
+ "type" : "GatewayFirmwareUpdateCompletedEvent"
} |
@@ -72159,11 +75294,6 @@ Generated events on method call
Field description |
-
- | gatewayId |
- The gateway id |
-
-
| owningPartners |
Owning partners of the parent entity (setup, ...)) . only available in event streams |
@@ -72174,25 +75304,31 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
- DeviceFirmwareUpdateStartedEvent
+ DeviceFirmwareUpdateFailedEvent
| Description |
- A firmware update started on the given device |
+ Device firmware update failed |
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
- "gatewayId" : "a gateway id",
+ "owningPartners" : [ "some owning partners" ],
"deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
- "name" : "DeviceFirmwareUpdateStartedEvent"
+ "type" : "DeviceFirmwareUpdateFailedEvent",
+ "failureType" : "NON_EXECUTING"
} |
@@ -72202,12 +75338,7 @@ Generated events on method call
| deviceURL |
- The device address |
-
-
-
- | gatewayId |
- The gateway id |
+ Device URL |
@@ -72220,25 +75351,30 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
- GatewayFirmwareUpdateCompletedEvent
+ GatewayFirmwareUpdateStartedEvent
| Description |
- Gateway firmware update is completed |
+ A firmware update started on the given gateway |
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"gatewayId" : "a gateway id",
- "firmwareType" : "a firmware type",
- "name" : "GatewayFirmwareUpdateCompletedEvent"
+ "type" : "GatewayFirmwareUpdateStartedEvent"
} |
@@ -72246,6 +75382,11 @@ Generated events on method call
Field description |
+
+ | gatewayId |
+ The gateway id |
+
+
| owningPartners |
Owning partners of the parent entity (setup, ...)) . only available in event streams |
@@ -72256,6 +75397,11 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
@@ -72321,7 +75467,7 @@ Generated events on method call
Get all manufacturer references for the device
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -72484,7 +75630,7 @@ Generated events on method call
Update device metadata
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -72583,15 +75729,16 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
"controllableName" : "a controllable name",
"label" : "a device updated event label",
"placeOID" : "a place OID",
"metadata" : "some metadata",
- "name" : "DeviceUpdatedEvent"
+ "type" : "DeviceUpdatedEvent"
} |
@@ -72614,6 +75761,11 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
@@ -72679,7 +75831,7 @@ Generated events on method call
Get a particular state of a requested device
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -72858,7 +76010,7 @@ Generated events on method call
Update a device persistent state
Update the value of a given device state.
This operation is only supported on some specific device states (called 'persistent' device states') that may be modified directly from the API.
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -72985,16 +76137,17 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
"deviceStates" : [ {
"name" : "a device state change item name",
"type" : 1,
"value" : "a device state change item value"
} ],
- "name" : "DeviceStateChangedEvent"
+ "type" : "DeviceStateChangedEvent"
} |
@@ -73022,6 +76175,11 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
@@ -73087,7 +76245,7 @@ Generated events on method call
Retrieve states of requested device
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -73248,9 +76406,9 @@ Generated events on method call
|
- Get setup definition
+ Get setup definition
Per-session rate-limit : 1 calls per 1d period for this particular operation (bulk-load)
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
|
@@ -73308,13 +76466,14 @@ Generated events on method call
(JSON)
[ {
- "creationTime" : 1769503155271,
- "lastUpdateTime" : 1769503155272,
- "label" : "a device label",
+ "label" : "a device response label",
+ "uiClass" : "a ui class",
"deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
- "shortcut" : false,
- "controllableName" : "core:StatefulClosableActuator",
+ "shortcut" : true,
+ "controllableName" : "a controllable name",
"metadata" : "some metadata",
+ "creationTime" : 1785140821960,
+ "lastUpdateTime" : 1785140821961,
"definition" : {
"commands" : [ {
"commandName" : "a command name",
@@ -73337,7 +76496,7 @@ Generated events on method call
"name" : "a device state name",
"type" : 1,
"value" : "a device state value",
- "lastUpdateTime" : 120123456793
+ "lastUpdateTime" : 120123456794
} ],
"attributes" : [ {
"name" : "a device attribute name",
@@ -73348,13 +76507,18 @@ Generated events on method call
"name" : "a device manufacturer data name",
"value" : "a device manufacturer data value"
} ],
+ "localDeviceData" : [ {
+ "key" : "a key",
+ "value" : "a local device attribute value",
+ "category" : "a category",
+ "localDeviceOID" : "a local device OID"
+ } ],
"available" : false,
- "enabled" : true,
+ "enabled" : false,
"placeOID" : "a place OID",
+ "oid" : "the device response UUID",
"widget" : "a widget name",
- "type" : 1,
- "oid" : "the device UUID",
- "uiClass" : "a ui class"
+ "type" : 1
} ] |
@@ -73458,7 +76622,7 @@ Generated events on method call
Link devices by adding a groupId
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
|
@@ -73571,15 +76735,16 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
"controllableName" : "a controllable name",
"label" : "a device updated event label",
"placeOID" : "a place OID",
"metadata" : "some metadata",
- "name" : "DeviceUpdatedEvent"
+ "type" : "DeviceUpdatedEvent"
} |
@@ -73602,6 +76767,11 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
@@ -73668,7 +76838,7 @@ Generated events on method call
Unlink devices by removing groupId
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -73752,15 +76922,16 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
"controllableName" : "a controllable name",
"label" : "a device updated event label",
"placeOID" : "a place OID",
"metadata" : "some metadata",
- "name" : "DeviceUpdatedEvent"
+ "type" : "DeviceUpdatedEvent"
} |
@@ -73783,6 +76954,11 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
@@ -73842,17 +77018,17 @@ Generated events on method call
- fh" style="display: none;">
+ fh" style="">
|
Unlink devices by removing groupId
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
|
-
+
|
@@ -73932,15 +77108,16 @@ Generated events on method call
|
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
"controllableName" : "a controllable name",
"label" : "a device updated event label",
"placeOID" : "a place OID",
"metadata" : "some metadata",
- "name" : "DeviceUpdatedEvent"
+ "type" : "DeviceUpdatedEvent"
} |
@@ -73963,6 +77140,11 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
@@ -74028,7 +77210,7 @@ Generated events on method call
Ask the box to refresh all devices availabilities for protocols that support this operation
Per-session rate-limit : 1 calls per 1d period for this particular operation (bulk-load)
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -74083,16 +77265,17 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
"deviceStates" : [ {
"name" : "a device state change item name",
"type" : 1,
"value" : "a device state change item value"
} ],
- "name" : "DeviceStateChangedEvent"
+ "type" : "DeviceStateChangedEvent"
} |
@@ -74120,6 +77303,11 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
@@ -74185,7 +77373,7 @@ Generated events on method call
Get all devices urls which have that controllable name
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -74343,7 +77531,7 @@ Generated events on method call
Get all device urls and sort them by their controllables names
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -74476,7 +77664,7 @@ Generated events on method call
Retrieve devices URLs which are not up-to-date
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -74607,7 +77795,7 @@ Generated events on method call
Update the given devices firmwares to the next available version
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -74680,21 +77868,22 @@ Generated events on method call
Generated events on method call
- GatewayFirmwareUpdateCompletedEvent
+ DeviceFirmwareUpdateStartedEvent
| Description |
- Gateway firmware update is completed |
+ A firmware update started on the given device |
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"gatewayId" : "a gateway id",
- "firmwareType" : "a firmware type",
- "name" : "GatewayFirmwareUpdateCompletedEvent"
+ "deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
+ "type" : "DeviceFirmwareUpdateStartedEvent"
} |
@@ -74702,6 +77891,16 @@ Generated events on method call
Field description |
+
+ | deviceURL |
+ The device address |
+
+
+
+ | gatewayId |
+ The gateway id |
+
+
| owningPartners |
Owning partners of the parent entity (setup, ...)) . only available in event streams |
@@ -74712,24 +77911,31 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
- GatewayFirmwareUpdateStartedEvent
+ GatewayFirmwareUpdateCompletedEvent
| Description |
- A firmware update started on the given gateway |
+ Gateway firmware update is completed |
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"gatewayId" : "a gateway id",
- "name" : "GatewayFirmwareUpdateStartedEvent"
+ "firmwareType" : "a firmware type",
+ "type" : "GatewayFirmwareUpdateCompletedEvent"
} |
@@ -74737,11 +77943,6 @@ Generated events on method call
Field description |
-
- | gatewayId |
- The gateway id |
-
-
| owningPartners |
Owning partners of the parent entity (setup, ...)) . only available in event streams |
@@ -74752,25 +77953,30 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
- DeviceFirmwareUpdateStartedEvent
+ DeviceFirmwareUpdateCompletedEvent
| Description |
- A firmware update started on the given device |
+ Device firmware update is completed |
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
- "gatewayId" : "a gateway id",
+ "owningPartners" : [ "some owning partners" ],
"deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
- "name" : "DeviceFirmwareUpdateStartedEvent"
+ "type" : "DeviceFirmwareUpdateCompletedEvent"
} |
@@ -74780,12 +77986,7 @@ Generated events on method call
| deviceURL |
- The device address |
-
-
-
- | gatewayId |
- The gateway id |
+ Device URL |
@@ -74798,26 +77999,30 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
- GatewayFirmwareUpdateFailedEvent
+ GatewayFirmwareUpdateStartedEvent
| Description |
- Gateway firmware update failed |
+ A firmware update started on the given gateway |
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"gatewayId" : "a gateway id",
- "firmwareType" : "a firmware type",
- "name" : "GatewayFirmwareUpdateFailedEvent",
- "failureType" : "NON_EXECUTING"
+ "type" : "GatewayFirmwareUpdateStartedEvent"
} |
@@ -74825,6 +78030,11 @@ Generated events on method call
Field description |
+
+ | gatewayId |
+ The gateway id |
+
+
| owningPartners |
Owning partners of the parent entity (setup, ...)) . only available in event streams |
@@ -74835,6 +78045,11 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
@@ -74848,11 +78063,12 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
- "name" : "DeviceFirmwareUpdateFailedEvent",
+ "type" : "DeviceFirmwareUpdateFailedEvent",
"failureType" : "NON_EXECUTING"
} |
@@ -74876,24 +78092,32 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
- DeviceFirmwareUpdateCompletedEvent
+ GatewayFirmwareUpdateFailedEvent
| Description |
- Device firmware update is completed |
+ Gateway firmware update failed |
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
- "deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
- "name" : "DeviceFirmwareUpdateCompletedEvent"
+ "owningPartners" : [ "some owning partners" ],
+ "gatewayId" : "a gateway id",
+ "firmwareType" : "a firmware type",
+ "type" : "GatewayFirmwareUpdateFailedEvent",
+ "failureType" : "NON_EXECUTING"
} |
@@ -74901,11 +78125,6 @@ Generated events on method call
Field description |
-
- | deviceURL |
- Device URL |
-
-
| owningPartners |
Owning partners of the parent entity (setup, ...)) . only available in event streams |
@@ -74916,6 +78135,11 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
@@ -74981,7 +78205,7 @@ Generated events on method call
Get growing indexes values variations on a given time slot
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -75010,8 +78234,8 @@ Generated events on method call
[ {
"deviceUrl" : "a device url",
"stateName" : "a state name",
- "from" : 1769533841155,
- "to" : 1769533841155
+ "from" : 1785201548486,
+ "to" : 1785201548486
} ] |
@@ -75148,7 +78372,7 @@ Generated events on method call
Ask the box to refresh all or given devices states for protocols supporting that operation
Per-session rate-limit : 1 calls per 1d period for this particular operation (bulk-load)
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
|
@@ -75221,25 +78445,23 @@ Generated events on method call
Generated events on method call
- DeviceStateChangedEvent
+ RefreshAllDevicesStatesFailedEvent
| Description |
- One or more states of a device have changed (high-level) |
+ Devices states could not be refreshed |
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
- "deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
- "deviceStates" : [ {
- "name" : "a device state change item name",
- "type" : 1,
- "value" : "a device state change item value"
- } ],
- "name" : "DeviceStateChangedEvent"
+ "owningPartner" : "an owning partner",
+ "gatewayId" : "A gateway id (ex: 0101-1234-5678)",
+ "protocolType" : 1,
+ "type" : "RefreshAllDevicesStatesFailedEvent",
+ "failureType" : "NON_EXECUTING"
} |
@@ -75248,23 +78470,23 @@ Generated events on method call
- | deviceStates |
- Updated device states |
+ gatewayId |
+ Gateway id |
- | deviceURL |
- Device URL |
+ owningPartner |
+ Owning partner of the parent entity (gateway, setup group, ...)) . only available in event streams |
- | owningPartners |
- Owning partners of the parent entity (setup, ...)) . only available in event streams |
+ setupOID |
+ Setup OID |
- | setupOID |
- Setup OID |
+ siteOID |
+ Site OID |
@@ -75280,11 +78502,13 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
+ "setupOID" : "a setup OID",
"owningPartner" : "an owning partner",
"gatewayId" : "A gateway id (ex: 0101-1234-5678)",
"protocolType" : 1,
- "name" : "RefreshAllDevicesStatesCompletedEvent"
+ "type" : "RefreshAllDevicesStatesCompletedEvent"
} |
@@ -75302,25 +78526,40 @@ Generated events on method call
Owning partner of the parent entity (gateway, setup group, ...)) . only available in event streams |
+
+ | setupOID |
+ Setup OID |
+
+
+
+ | siteOID |
+ Site OID |
+
+
- RefreshAllDevicesStatesFailedEvent
+ DeviceStateChangedEvent
| Description |
- Devices states could not be refreshed |
+ One or more states of a device have changed (high-level) |
| JSON |
{
- "timestamp" : 2,
- "owningPartner" : "an owning partner",
- "gatewayId" : "A gateway id (ex: 0101-1234-5678)",
- "protocolType" : 1,
- "name" : "RefreshAllDevicesStatesFailedEvent",
- "failureType" : "NON_EXECUTING"
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
+ "setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
+ "deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
+ "deviceStates" : [ {
+ "name" : "a device state change item name",
+ "type" : 1,
+ "value" : "a device state change item value"
+ } ],
+ "type" : "DeviceStateChangedEvent"
} |
@@ -75329,13 +78568,28 @@ Generated events on method call
- | gatewayId |
- Gateway id |
+ deviceStates |
+ Updated device states |
- | owningPartner |
- Owning partner of the parent entity (gateway, setup group, ...)) . only available in event streams |
+ deviceURL |
+ Device URL |
+
+
+
+ | owningPartners |
+ Owning partners of the parent entity (setup, ...)) . only available in event streams |
+
+
+
+ | setupOID |
+ Setup OID |
+
+
+
+ | siteOID |
+ Site OID |
@@ -75404,7 +78658,7 @@ Generated events on method call
Ask the box to refresh all devices states for protocols supporting that operation - Deprecated : use POST method
Per-session rate-limit : 1 calls per 1d period for this particular operation (bulk-load)
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -75459,11 +78713,13 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
+ "setupOID" : "a setup OID",
"owningPartner" : "an owning partner",
"gatewayId" : "A gateway id (ex: 0101-1234-5678)",
"protocolType" : 1,
- "name" : "RefreshAllDevicesStatesFailedEvent",
+ "type" : "RefreshAllDevicesStatesFailedEvent",
"failureType" : "NON_EXECUTING"
} |
@@ -75482,6 +78738,16 @@ Generated events on method call
Owning partner of the parent entity (gateway, setup group, ...)) . only available in event streams |
+
+ | setupOID |
+ Setup OID |
+
+
+
+ | siteOID |
+ Site OID |
+
+
@@ -75495,16 +78761,17 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
"deviceStates" : [ {
"name" : "a device state change item name",
"type" : 1,
"value" : "a device state change item value"
} ],
- "name" : "DeviceStateChangedEvent"
+ "type" : "DeviceStateChangedEvent"
} |
@@ -75532,6 +78799,11 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
@@ -75545,11 +78817,13 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
+ "setupOID" : "a setup OID",
"owningPartner" : "an owning partner",
"gatewayId" : "A gateway id (ex: 0101-1234-5678)",
"protocolType" : 1,
- "name" : "RefreshAllDevicesStatesCompletedEvent"
+ "type" : "RefreshAllDevicesStatesCompletedEvent"
} |
@@ -75567,6 +78841,16 @@ Generated events on method call
Owning partner of the parent entity (gateway, setup group, ...)) . only available in event streams |
+
+ | setupOID |
+ Setup OID |
+
+
+
+ | siteOID |
+ Site OID |
+
+
@@ -75632,7 +78916,7 @@ Generated events on method call
Ask the box to refresh all states on given device
Per-session rate-limit : 1 calls per 1d period for this particular operation (bulk-load)
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -75705,21 +78989,22 @@ Generated events on method call
Generated events on method call
- RefreshAllDevicesStatesFailedEvent
+ RefreshAllDevicesStatesCompletedEvent
| Description |
- Devices states could not be refreshed |
+ Refresh all states query for given protocol type is completed |
| JSON |
{
- "timestamp" : 2,
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
+ "setupOID" : "a setup OID",
"owningPartner" : "an owning partner",
"gatewayId" : "A gateway id (ex: 0101-1234-5678)",
"protocolType" : 1,
- "name" : "RefreshAllDevicesStatesFailedEvent",
- "failureType" : "NON_EXECUTING"
+ "type" : "RefreshAllDevicesStatesCompletedEvent"
} |
@@ -75737,6 +79022,16 @@ Generated events on method call
Owning partner of the parent entity (gateway, setup group, ...)) . only available in event streams |
+
+ | setupOID |
+ Setup OID |
+
+
+
+ | siteOID |
+ Site OID |
+
+
@@ -75750,16 +79045,17 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
"deviceStates" : [ {
"name" : "a device state change item name",
"type" : 1,
"value" : "a device state change item value"
} ],
- "name" : "DeviceStateChangedEvent"
+ "type" : "DeviceStateChangedEvent"
} |
@@ -75787,24 +79083,32 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
- RefreshAllDevicesStatesCompletedEvent
+ RefreshAllDevicesStatesFailedEvent
| Description |
- Refresh all states query for given protocol type is completed |
+ Devices states could not be refreshed |
| JSON |
{
- "timestamp" : 2,
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
+ "setupOID" : "a setup OID",
"owningPartner" : "an owning partner",
"gatewayId" : "A gateway id (ex: 0101-1234-5678)",
"protocolType" : 1,
- "name" : "RefreshAllDevicesStatesCompletedEvent"
+ "type" : "RefreshAllDevicesStatesFailedEvent",
+ "failureType" : "NON_EXECUTING"
} |
@@ -75822,6 +79126,16 @@ Generated events on method call
Owning partner of the parent entity (gateway, setup group, ...)) . only available in event streams |
+
+ | setupOID |
+ Setup OID |
+
+
+
+ | siteOID |
+ Site OID |
+
+
@@ -75840,6 +79154,169 @@ Generated events on method call
+
+
+
+
+ | PUT |
+
+
+
+
+ LocalDevice localDeviceData
+
+
+ |
+
+
+
+
+ /setup/devices/{deviceURL}/localDeviceData/{key}
+
+
+ |
+ application/json |
+
+
+ |
+
+
+ Update device's local device data
+
+ Access scope : enduser/*
+ > Test operation
+ |
+
+
+ |
+
+
+
+
+
+ Parameters
+
+ | Type |
+ Name |
+ Value |
+ Description |
+
+
+
+ |
+ Path Variable
+ |
+
+ deviceURL
+ |
+ "string value" |
+
+
+
+ The device url
+ |
+
+
+
+ |
+ Path Variable
+ |
+
+ key
+ |
+ "string value" |
+
+
+
+ The local device data key
+ |
+
+
+
+ |
+ Request Body
+ |
+
+ (JSON)
+ |
+ {
+ "value" : "an object value request body value"
+} |
+
+
+
+ The local device data value
+ |
+
+
+
+
+
+
+
+
+
+
+ HTTP Status Code
+
+ | Code |
+ Message |
+ Meaning |
+
+
+
+ |
+ 204
+ |
+ NO_CONTENT |
+
+ The server has fulfilled the request but does not need to return an entity-body, and might want to return updated metainformation
+ |
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ |
+
+
+ |
+
+
+
+
@@ -75888,7 +79365,7 @@ Generated events on method call
Get hidden devices
Hidden devices are devices that cannot be unpaired because of technical limitations but have been removed from the user interface
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -75917,13 +79394,14 @@ Generated events on method call
(JSON)
[ {
- "creationTime" : 1769503155271,
- "lastUpdateTime" : 1769503155272,
- "label" : "a device label",
+ "label" : "a device response label",
+ "uiClass" : "a ui class",
"deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
- "shortcut" : false,
- "controllableName" : "core:StatefulClosableActuator",
+ "shortcut" : true,
+ "controllableName" : "a controllable name",
"metadata" : "some metadata",
+ "creationTime" : 1785140821960,
+ "lastUpdateTime" : 1785140821961,
"definition" : {
"commands" : [ {
"commandName" : "a command name",
@@ -75946,7 +79424,7 @@ Generated events on method call
"name" : "a device state name",
"type" : 1,
"value" : "a device state value",
- "lastUpdateTime" : 120123456793
+ "lastUpdateTime" : 120123456794
} ],
"attributes" : [ {
"name" : "a device attribute name",
@@ -75957,13 +79435,18 @@ Generated events on method call
"name" : "a device manufacturer data name",
"value" : "a device manufacturer data value"
} ],
+ "localDeviceData" : [ {
+ "key" : "a key",
+ "value" : "a local device attribute value",
+ "category" : "a category",
+ "localDeviceOID" : "a local device OID"
+ } ],
"available" : false,
- "enabled" : true,
+ "enabled" : false,
"placeOID" : "a place OID",
+ "oid" : "the device response UUID",
"widget" : "a widget name",
- "type" : 1,
- "oid" : "the device UUID",
- "uiClass" : "a ui class"
+ "type" : 1
} ] |
@@ -76117,7 +79600,7 @@
Retrieve annual state history of a device within a time range
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
|
@@ -76223,7 +79706,7 @@
"min" : 3,
"max" : 4,
"samples" : 2,
- "when" : 1769503155291
+ "when" : 1785140821977
} ],
"historizationMethod" : 1,
"deviceUnit" : "core:LinearSpeedInMeterPerSecond"
@@ -76330,7 +79813,7 @@
Retrieve annual state history of a device within a time range with stacked values of other devices of the same type
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -76436,7 +79919,7 @@
"minValues" : [ 4 ],
"maxValues" : [ 6 ],
"samples" : [ 2 ],
- "when" : 1769503155286
+ "when" : 1785140821982
} ],
"stackLevels" : [ "some stack levels" ],
"deviceCounts" : [ 1 ],
@@ -76545,7 +80028,7 @@
Retrieve annual states history of a device within a time range with stacked values of other devices of the same type
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -76636,7 +80119,7 @@
"minValues" : [ 4 ],
"maxValues" : [ 6 ],
"samples" : [ 2 ],
- "when" : 1769503155286
+ "when" : 1785140821982
} ],
"stackLevels" : [ "some stack levels" ],
"deviceCounts" : [ 1 ],
@@ -76745,7 +80228,7 @@
Retrieve annual state history of a device within a time range
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -76836,7 +80319,7 @@
"min" : 3,
"max" : 4,
"samples" : 2,
- "when" : 1769503155291
+ "when" : 1785140821978
} ],
"historizationMethod" : 1,
"deviceUnit" : "core:LinearSpeedInMeterPerSecond"
@@ -76943,7 +80426,7 @@
Retrieve daily state history of a device within a time range
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -77049,7 +80532,7 @@
"min" : 3,
"max" : 4,
"samples" : 2,
- "when" : 1769503155291
+ "when" : 1785140821977
} ],
"historizationMethod" : 1,
"deviceUnit" : "core:LinearSpeedInMeterPerSecond"
@@ -77156,7 +80639,7 @@
Retrieve daily state history of a device within a time range with stacked values of other devices of the same type
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -77262,7 +80745,7 @@
"minValues" : [ 4 ],
"maxValues" : [ 6 ],
"samples" : [ 2 ],
- "when" : 1769503155286
+ "when" : 1785140821982
} ],
"stackLevels" : [ "some stack levels" ],
"deviceCounts" : [ 1 ],
@@ -77371,7 +80854,7 @@
Export daily stacked history values in CSV format
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -77547,7 +81030,7 @@
Retrieve daily states history of a device within a time range with stacked values of other devices of the same type
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -77638,7 +81121,7 @@
"minValues" : [ 4 ],
"maxValues" : [ 6 ],
"samples" : [ 2 ],
- "when" : 1769503155286
+ "when" : 1785140821982
} ],
"stackLevels" : [ "some stack levels" ],
"deviceCounts" : [ 1 ],
@@ -77747,7 +81230,7 @@
Retrieve daily states history of a device within a time range
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -77838,7 +81321,7 @@
"min" : 3,
"max" : 4,
"samples" : 2,
- "when" : 1769503155291
+ "when" : 1785140821978
} ],
"historizationMethod" : 1,
"deviceUnit" : "core:LinearSpeedInMeterPerSecond"
@@ -77945,7 +81428,7 @@
Export all state values in CSV format - limited in time and in number of values - Contact support to know these limits
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -78001,6 +81484,29 @@
+
+ HTTP Status Code
+
+ | Code |
+ Message |
+ Meaning |
+
+
+
+ |
+ 200
+ |
+ OK |
+
+ The request has succeeded
+ |
+
+
+
@@ -78068,7 +81574,7 @@
Retrieve overall state history of a device within a time range
Max history query span is limited to 3 days if limit parameter is not set.
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -78189,7 +81695,7 @@
"min" : 3,
"max" : 4,
"samples" : 2,
- "when" : 1769503155291
+ "when" : 1785140821977
} ],
"historizationMethod" : 1,
"deviceUnit" : "core:LinearSpeedInMeterPerSecond"
@@ -78296,7 +81802,7 @@
Export state values in history CSV format
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -78472,7 +81978,7 @@
Retrieve monthly state history of a device within a time range
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -78578,7 +82084,7 @@
"min" : 3,
"max" : 4,
"samples" : 2,
- "when" : 1769503155291
+ "when" : 1785140821977
} ],
"historizationMethod" : 1,
"deviceUnit" : "core:LinearSpeedInMeterPerSecond"
@@ -78686,7 +82192,7 @@
Retrieve monthly state history of a device within a time range
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -78792,7 +82298,7 @@
"min" : 3,
"max" : 4,
"samples" : 2,
- "when" : 1769503155291
+ "when" : 1785140821977
} ],
"historizationMethod" : 1,
"deviceUnit" : "core:LinearSpeedInMeterPerSecond"
@@ -78899,7 +82405,7 @@
Retrieve monthly state history of a device in a time range with stacked values of other devices of the same type
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -79005,7 +82511,7 @@
"minValues" : [ 4 ],
"maxValues" : [ 6 ],
"samples" : [ 2 ],
- "when" : 1769503155286
+ "when" : 1785140821982
} ],
"stackLevels" : [ "some stack levels" ],
"deviceCounts" : [ 1 ],
@@ -79114,7 +82620,7 @@
Retrieve monthly states history of a device in a time range with stacked values of other devices of the same type
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -79205,7 +82711,7 @@
"minValues" : [ 4 ],
"maxValues" : [ 6 ],
"samples" : [ 2 ],
- "when" : 1769503155286
+ "when" : 1785140821982
} ],
"stackLevels" : [ "some stack levels" ],
"deviceCounts" : [ 1 ],
@@ -79314,7 +82820,7 @@
Retrieve monthly states history of a device within a time range
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -79405,7 +82911,7 @@
"min" : 3,
"max" : 4,
"samples" : 2,
- "when" : 1769503155291
+ "when" : 1785140821978
} ],
"historizationMethod" : 1,
"deviceUnit" : "core:LinearSpeedInMeterPerSecond"
@@ -79512,7 +83018,7 @@
Retrieve overall state history of a device within a time range with stacked values of other devices of the same type
Max history query span is limited to 3 days.
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -79618,7 +83124,7 @@
"minValues" : [ 4 ],
"maxValues" : [ 6 ],
"samples" : [ 2 ],
- "when" : 1769503155286
+ "when" : 1785140821982
} ],
"stackLevels" : [ "some stack levels" ],
"deviceCounts" : [ 1 ],
@@ -79727,7 +83233,7 @@
Retrieve overall states history of a device within a time range with stacked values of other devices of the same type
Max history query span is limited to 3 days.
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -79818,7 +83324,7 @@
"minValues" : [ 4 ],
"maxValues" : [ 6 ],
"samples" : [ 2 ],
- "when" : 1769503155286
+ "when" : 1785140821982
} ],
"stackLevels" : [ "some stack levels" ],
"deviceCounts" : [ 1 ],
@@ -79927,7 +83433,7 @@
Retrieve overall states history of a device within a time range
Max history query span is limited to 3 days if limit parameter is not set.
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -80033,7 +83539,7 @@
"min" : 3,
"max" : 4,
"samples" : 2,
- "when" : 1769503155291
+ "when" : 1785140821978
} ],
"historizationMethod" : 1,
"deviceUnit" : "core:LinearSpeedInMeterPerSecond"
@@ -80169,7 +83675,7 @@
Activate developer mode for a gateway
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -80300,7 +83806,7 @@
activate a module for a gateway
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -80446,7 +83952,7 @@
Private tags : [ disconnectionAlert ]
Get configuration for notification sent after gateway disconnection
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -80606,7 +84112,7 @@
Private tags : [ disconnectionAlert ]
Update configuration for notification sent after gateway disconnection
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -80705,11 +84211,13 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
+ "setupOID" : "a setup OID",
"owningPartner" : "an owning partner",
"gatewayId" : "A gateway id (ex: 0101-1234-5678)",
"timeout" : 1,
- "name" : "GatewayDownOptionsChangedEvent"
+ "type" : "GatewayDownOptionsChangedEvent"
} |
@@ -80727,6 +84235,16 @@ Generated events on method call
Owning partner of the parent entity (gateway, setup group, ...)) . only available in event streams |
+
+ | setupOID |
+ Setup OID |
+
+
+
+ | siteOID |
+ Site OID |
+
+
| timeout |
New timer between disconnection and notification (in seconds) |
@@ -80797,7 +84315,7 @@ Generated events on method call
Enabled or disabled gateway's auto update
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -80943,7 +84461,7 @@ Generated events on method call
Get a particular gateway of a connected user setup
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -81000,30 +84518,31 @@ Generated events on method call
{
"partners" : [ {
- "status" : "OWNER",
"activated" : true,
+ "status" : "OWNER",
"name" : "a business partner name",
"id" : "a partner id"
} ],
- "functions" : "some function names",
- "mode" : "ACTIVE",
+ "updateDeferralEnabled" : true,
"subType" : 1,
+ "firmwareVersion" : "2023.1.4-1:30ccca5e458c342a95d28cd2667f431e:07029280615154e81c8205c83c8324e7",
+ "mode" : "ACTIVE",
+ "functions" : "some function names",
"gatewayId" : "a gateway id",
"placeOID" : "a place OID",
+ "autoUpdateEnabled" : false,
"alive" : false,
- "autoUpdateEnabled" : true,
- "firmwareVersion" : "2023.1.4-1:30ccca5e458c342a95d28cd2667f431e:07029280615154e81c8205c83c8324e7",
- "timeReliable" : true,
- "upToDate" : true,
- "updateStatus" : "UPDATING",
- "updateCriticityLevel" : "BLOCKING",
- "automaticUpdate" : false,
+ "timeReliable" : false,
+ "upToDate" : false,
+ "updateCriticityLevel" : "DEVICES_CONTROL_ONLY",
+ "automaticUpdate" : true,
+ "updateStatus" : "UNKNOWN",
"connectivity" : {
- "status" : "PARTIAL",
+ "status" : "DISCONNECTED",
"problems" : [ "NO_NTP" ],
"protocolVersion" : "a protocol version"
},
- "syncInProgress" : false,
+ "syncInProgress" : true,
"type" : 1
} |
@@ -81128,7 +84647,7 @@ Generated events on method call
Return the protocols activated on the gateway
Active protocol means that protocol can be used by the gateway.
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
|
@@ -81286,7 +84805,7 @@ Generated events on method call
Attaches a new gateway to the user's setup
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -81435,7 +84954,7 @@ Generated events on method call
Return the protocols available on the gateway
Available protocol means that protocol is fully functional. Native protocol is available as soon as it is activated.
A protocol that needs a USB key plugged to the gateway is available only when USB key is plugged.
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -81593,7 +85112,7 @@ Generated events on method call
Return the protocols supported by the gateway
Supported protocol means protocol does not work currently but could work as soon protocol becomes active.
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -81751,7 +85270,7 @@ Generated events on method call
Update gateway if necessary
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -81916,7 +85435,7 @@ Generated events on method call
Return the protocols activated on the gateway that were available at least once
Active protocol means that protocol can be used by the gateway. A protocol is considered as being used if it was available at least once in the past.
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -82074,7 +85593,7 @@ Generated events on method call
Migrates the complete configuration of a gateway to another gateway. Server-side only : the target gateway is not updated yet.
This is usually useful when replacing a defective hardware
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -82235,7 +85754,7 @@ Generated events on method call
Migrates the complete configuration of a gateway to another gateway and start updating the target gateway.
This is usually useful when replacing a defective hardware
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -82397,7 +85916,7 @@ Generated events on method call
Return the gateway status
This operation allows testing and validating connectivity between a gateway and backend servers.
It returns true if the gateway is ready and alive.
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -82559,7 +86078,7 @@ Generated events on method call
Note that this operation may return true even though a call to /setup/gateways/{gatewayId}/synchronization/inProgress returned false
because failed synchronization tasks may still exist.
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -82719,7 +86238,7 @@ Generated events on method call
Get a list of object categories containing failed synchronization tasks exist for a given gateway
See /setup/gateways/{gatewayId}/synchronization/failedTasks
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -82881,7 +86400,7 @@ Generated events on method call
Note that even if this operation returns false, failed synchronization tasks may still exist if a connectivity loss or gateway crash occured.
To make sure the gateway is fully in sync with the server, see the /setup/gateways/{gatewayId}/synchronization/failedTasks operation
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -83043,7 +86562,7 @@ Generated events on method call
Note that this operation may return true even though a call to /setup/gateways/{gatewayId}/synchronized returned true
because failed synchronization tasks may still exist.
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -83204,7 +86723,7 @@ Generated events on method call
Return the gateways synchronization status
DEPRECATED : use /setup/gateways/{gatewayId}/aliveAndReady
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -83364,7 +86883,7 @@ Generated events on method call
Activate a partner offer by partner offer Id
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -83510,7 +87029,7 @@ Generated events on method call
Get additional informations
This operation returns gateway additional informations.
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -83676,7 +87195,7 @@ Generated events on method call
Get additional information
This operation returns gateway additional information.
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -83857,7 +87376,7 @@ Generated events on method call
Deactivate a partner offer by partner offer Id
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -84003,7 +87522,7 @@ Generated events on method call
Detach gateway from setup
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -84151,7 +87670,7 @@ Generated events on method call
Get gateway functionalities
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -84309,7 +87828,7 @@ Generated events on method call
Update gateway functionality
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -84472,7 +87991,7 @@ Generated events on method call
Get gateway version
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -84632,7 +88151,7 @@ Generated events on method call
Get every gateways of a connected user setup
Per-session rate-limit : 1 calls per 1d period for this particular operation (bulk-load)
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -84662,30 +88181,31 @@ Generated events on method call
[ {
"partners" : [ {
- "status" : "OWNER",
"activated" : true,
+ "status" : "OWNER",
"name" : "a business partner name",
"id" : "a partner id"
} ],
- "functions" : "some function names",
- "mode" : "ACTIVE",
+ "updateDeferralEnabled" : true,
"subType" : 1,
+ "firmwareVersion" : "2023.1.4-1:30ccca5e458c342a95d28cd2667f431e:07029280615154e81c8205c83c8324e7",
+ "mode" : "ACTIVE",
+ "functions" : "some function names",
"gatewayId" : "a gateway id",
"placeOID" : "a place OID",
+ "autoUpdateEnabled" : false,
"alive" : false,
- "autoUpdateEnabled" : true,
- "firmwareVersion" : "2023.1.4-1:30ccca5e458c342a95d28cd2667f431e:07029280615154e81c8205c83c8324e7",
- "timeReliable" : true,
- "upToDate" : true,
- "updateStatus" : "UPDATING",
- "updateCriticityLevel" : "BLOCKING",
- "automaticUpdate" : false,
+ "timeReliable" : false,
+ "upToDate" : false,
+ "updateCriticityLevel" : "DEVICES_CONTROL_ONLY",
+ "automaticUpdate" : true,
+ "updateStatus" : "UNKNOWN",
"connectivity" : {
- "status" : "PARTIAL",
+ "status" : "DISCONNECTED",
"problems" : [ "NO_NTP" ],
"protocolVersion" : "a protocol version"
},
- "syncInProgress" : false,
+ "syncInProgress" : true,
"type" : 1
} ] |
@@ -84790,7 +88310,7 @@ Generated events on method call
Get all partner offers ids
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
|
@@ -84948,7 +88468,7 @@ Generated events on method call
Get the status of developer mode for a gateway
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -85108,7 +88628,7 @@ Generated events on method call
This sends a keepAlive message to the given protocol
Per-session rate-limit : 1 calls per 1s period for this particular operation (keep-alive)
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -85254,7 +88774,7 @@ Generated events on method call
Refresh all devices states of given gateway
Per-session rate-limit : 1 calls per 1d period for this particular operation (bulk-load)
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -85336,16 +88856,17 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
"deviceStates" : [ {
"name" : "a device state change item name",
"type" : 1,
"value" : "a device state change item value"
} ],
- "name" : "DeviceStateChangedEvent"
+ "type" : "DeviceStateChangedEvent"
} |
@@ -85373,25 +88894,31 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
- RefreshAllDevicesStatesFailedEvent
+ RefreshAllDevicesStatesCompletedEvent
| Description |
- Devices states could not be refreshed |
+ Refresh all states query for given protocol type is completed |
| JSON |
{
- "timestamp" : 2,
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
+ "setupOID" : "a setup OID",
"owningPartner" : "an owning partner",
"gatewayId" : "A gateway id (ex: 0101-1234-5678)",
"protocolType" : 1,
- "name" : "RefreshAllDevicesStatesFailedEvent",
- "failureType" : "NON_EXECUTING"
+ "type" : "RefreshAllDevicesStatesCompletedEvent"
} |
@@ -85409,24 +88936,37 @@ Generated events on method call
Owning partner of the parent entity (gateway, setup group, ...)) . only available in event streams |
+
+ | setupOID |
+ Setup OID |
+
+
+
+ | siteOID |
+ Site OID |
+
+
- RefreshAllDevicesStatesCompletedEvent
+ RefreshAllDevicesStatesFailedEvent
| Description |
- Refresh all states query for given protocol type is completed |
+ Devices states could not be refreshed |
| JSON |
{
- "timestamp" : 2,
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
+ "setupOID" : "a setup OID",
"owningPartner" : "an owning partner",
"gatewayId" : "A gateway id (ex: 0101-1234-5678)",
"protocolType" : 1,
- "name" : "RefreshAllDevicesStatesCompletedEvent"
+ "type" : "RefreshAllDevicesStatesFailedEvent",
+ "failureType" : "NON_EXECUTING"
} |
@@ -85444,6 +88984,16 @@ Generated events on method call
Owning partner of the parent entity (gateway, setup group, ...)) . only available in event streams |
+
+ | setupOID |
+ Setup OID |
+
+
+
+ | siteOID |
+ Site OID |
+
+
@@ -85509,7 +89059,7 @@ Generated events on method call
Refresh all devices states of given gateway and protocol
Per-session rate-limit : 1 calls per 1d period for this particular operation (bulk-load)
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
|
@@ -85606,11 +89156,13 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
+ "setupOID" : "a setup OID",
"owningPartner" : "an owning partner",
"gatewayId" : "A gateway id (ex: 0101-1234-5678)",
"protocolType" : 1,
- "name" : "RefreshAllDevicesStatesFailedEvent",
+ "type" : "RefreshAllDevicesStatesFailedEvent",
"failureType" : "NON_EXECUTING"
} |
@@ -85629,6 +89181,16 @@ Generated events on method call
Owning partner of the parent entity (gateway, setup group, ...)) . only available in event streams |
+
+ | setupOID |
+ Setup OID |
+
+
+
+ | siteOID |
+ Site OID |
+
+
@@ -85642,16 +89204,17 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
"deviceStates" : [ {
"name" : "a device state change item name",
"type" : 1,
"value" : "a device state change item value"
} ],
- "name" : "DeviceStateChangedEvent"
+ "type" : "DeviceStateChangedEvent"
} |
@@ -85679,6 +89242,11 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
@@ -85692,11 +89260,13 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
+ "setupOID" : "a setup OID",
"owningPartner" : "an owning partner",
"gatewayId" : "A gateway id (ex: 0101-1234-5678)",
"protocolType" : 1,
- "name" : "RefreshAllDevicesStatesCompletedEvent"
+ "type" : "RefreshAllDevicesStatesCompletedEvent"
} |
@@ -85714,6 +89284,16 @@ Generated events on method call
Owning partner of the parent entity (gateway, setup group, ...)) . only available in event streams |
+
+ | setupOID |
+ Setup OID |
+
+
+
+ | siteOID |
+ Site OID |
+
+
@@ -85779,7 +89359,7 @@ Generated events on method call
deactivate a module for a gateway
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -85954,7 +89534,7 @@
Return an InteractiveNotification
This operation returns an InteractiveNotification object to be displayed.
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -86014,8 +89594,8 @@
"text" : "a text",
"subject" : "a subject",
"oid" : "a notification OID",
- "date" : 1769503155190,
- "expirationDate" : 1769503155190
+ "date" : 1785140821904,
+ "expirationDate" : 1785140821904
}
@@ -86120,7 +89700,7 @@
Complete an interactive notification
When the user clicks a button (except for cancel), this method should be called with the flag value of the clicked button.
The notification state is then changed on the server-side and the notification is moved to history
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
|
@@ -86266,7 +89846,7 @@
Return a collection of interactive notification waiting for validation
This operation returns a collection of InteractiveNotification objects to be displayed one after the other.
Per-session rate-limit : 1 calls per 1d period for this particular operation (bulk-load)
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -86299,8 +89879,1697 @@
"text" : "a text",
"subject" : "a subject",
"oid" : "a notification OID",
- "date" : 1769503155190,
- "expirationDate" : 1769503155190
+ "date" : 1785140821904,
+ "expirationDate" : 1785140821904
+} ]
+ |
+
+
+
+ |
+
+
+
+
+
+
+
+
+ HTTP Status Code
+
+ | Code |
+ Message |
+ Meaning |
+
+
+
+ |
+ 200
+ |
+ OK |
+
+ The request has succeeded
+ |
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ | GET |
+
+
+
+
+ Setup interactive notifications history
+
+
+ |
+
+
+
+
+ /setup/interactiveNotifications/history
+
+
+ |
+ application/json |
+
+
+ |
+
+
+ Return a collection of interactive notification that were validated in the past
This operation returns a collection of InteractiveNotification objects to be displayed one after the other.
+ Per-session rate-limit : 1 calls per 1d period for this particular operation (bulk-load)
+ Access scope : enduser/*
+ > Test operation
+ |
+
+
+ |
+
+
+
+
+
+
+
+ Response
+
+ | Type |
+ Name |
+ Value |
+ Description |
+
+
+
+ |
+ Response Body
+ |
+
+ (JSON)
+ |
+ [ {
+ "actionMask" : 1,
+ "text" : "a text",
+ "subject" : "a subject",
+ "oid" : "a notification OID",
+ "date" : 1785140821904,
+ "expirationDate" : 1785140821904
+} ] |
+
+
+
+
+ |
+
+
+
+
+
+
+
+
+ HTTP Status Code
+
+ | Code |
+ Message |
+ Meaning |
+
+
+
+ |
+ 200
+ |
+ OK |
+
+ The request has succeeded
+ |
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ |
+
+
+ |
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Local Devices
+
+
+
+
+
+
+ |
+ |
+ Expand commands |
+
+
+
+
+
+
+
+
+
+
+
+
+ | POST |
+
+
+
+
+ Local Device
+
+
+ |
+
+
+
+
+ /setup/localDevices
+
+
+ |
+ application/json |
+
+
+ |
+
+
+ Create a new local device
+
+ Access scope : enduser/*
+ > Test operation
+ |
+
+
+ |
+
+
+
+
+
+ Parameters
+
+ | Type |
+ Name |
+ Value |
+ Description |
+
+
+
+ |
+ Request Body
+ |
+
+ (JSON)
+ |
+ {
+ "label" : "a local device request label",
+ "placeOID" : "a place OID",
+ "model" : {
+ "type" : "a OGPNode model type",
+ "subType" : "a sub type",
+ "features" : [ {
+ "name" : "a OGPFeature name",
+ "stateLess" : true,
+ "authenticationRestrictedCommands" : [ "some authentication restricted commands" ]
+ } ]
+ },
+ "attributes" : {
+ "some attributes" : "some attributes"
+ },
+ "localDeviceData" : {
+ "a local device data" : "a local device data"
+ }
+} |
+
+
+
+ The new local device to create
+ |
+
+
+
+
+
+
+
+
+ Response
+
+ | Type |
+ Name |
+ Value |
+ Description |
+
+
+
+ |
+ Response Body
+ |
+
+ (JSON)
+ |
+ {
+ "label" : "a local device response label",
+ "placeOID" : "a place OID",
+ "mapped" : false,
+ "model" : {
+ "type" : "a OGPNode model type",
+ "subType" : "a sub type",
+ "features" : [ {
+ "name" : "a OGPFeature name",
+ "commandLess" : true,
+ "eventBased" : true,
+ "authenticationRestrictedCommands" : [ "some authentication restricted commands" ]
+ } ]
+ },
+ "attributes" : {
+ "some attributes" : "some attributes"
+ },
+ "localDeviceData" : {
+ "a local device data" : "a local device data"
+ },
+ "oid" : "the local device response UUID"
+} |
+
+
+
+
+ |
+
+
+
+
+
+
+
+
+ HTTP Status Code
+
+ | Code |
+ Message |
+ Meaning |
+
+
+
+ |
+ 201
+ |
+ CREATED |
+
+ The request has been fulfilled and resulted in a new resource being created
+ |
+
+
+
+
+
+
+
+
+
+ Generated events on method call
+
+
+ LocalDeviceCreatedEvent
+
+ | Description |
+ Event sent when a new local device is created |
+
+
+
+ | JSON |
+ {
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
+ "setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
+ "localDeviceOID" : "a local device OID",
+ "label" : "a local device created event label",
+ "placeOID" : "a place OID",
+ "model" : {
+ "type" : "a OGPNode model type",
+ "subType" : "a sub type",
+ "features" : [ {
+ "name" : "a OGPFeature name",
+ "stateLess" : true,
+ "authenticationRestrictedCommands" : [ "some authentication restricted commands" ]
+ } ]
+ },
+ "attributes" : {
+ "some attributes" : "some attributes"
+ },
+ "localDeviceData" : {
+ "a local device data" : "a local device data"
+ },
+ "type" : "LocalDeviceCreatedEvent"
+} |
+
+
+ | Field name |
+ Field description |
+
+
+
+ | localDeviceOID |
+ Local device OID |
+
+
+
+ | owningPartners |
+ Owning partners of the parent entity (setup, ...)) . only available in event streams |
+
+
+
+ | setupOID |
+ Setup OID |
+
+
+
+ | siteOID |
+ Site OID |
+
+
+
+
+
+
+
+
+
+
+
+
+ |
+
+
+ |
+
+
+
+
+
+
+
+
+ | GET |
+
+
+
+
+ Local Device
+
+
+ |
+
+
+
+
+ /setup/localDevices/{localDeviceOID}
+
+
+ |
+ application/json |
+
+
+ |
+
+
+ Get a specific local device by OID
+
+ Access scope : enduser/*
+ > Test operation
+ |
+
+
+ |
+
+
+
+
+
+ Parameters
+
+ | Type |
+ Name |
+ Value |
+ Description |
+
+
+
+ |
+ Path Variable
+ |
+
+ localDeviceOID
+ |
+ "string value" |
+
+
+
+ The OID of the local device
+ |
+
+
+
+
+
+
+
+
+ Response
+
+ | Type |
+ Name |
+ Value |
+ Description |
+
+
+
+ |
+ Response Body
+ |
+
+ (JSON)
+ |
+ {
+ "label" : "a local device response label",
+ "placeOID" : "a place OID",
+ "mapped" : false,
+ "model" : {
+ "type" : "a OGPNode model type",
+ "subType" : "a sub type",
+ "features" : [ {
+ "name" : "a OGPFeature name",
+ "commandLess" : true,
+ "eventBased" : true,
+ "authenticationRestrictedCommands" : [ "some authentication restricted commands" ]
+ } ]
+ },
+ "attributes" : {
+ "some attributes" : "some attributes"
+ },
+ "localDeviceData" : {
+ "a local device data" : "a local device data"
+ },
+ "oid" : "the local device response UUID"
+} |
+
+
+
+
+ |
+
+
+
+
+
+
+
+
+ HTTP Status Code
+
+ | Code |
+ Message |
+ Meaning |
+
+
+
+ |
+ 200
+ |
+ OK |
+
+ The request has succeeded
+ |
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ |
+
+
+ |
+
+
+
+
+
+
+
+
+ | DELETE |
+
+
+
+
+ Local Device
+
+
+ |
+
+
+
+
+ /setup/localDevices/{localDeviceOID}
+
+
+ |
+ application/json |
+
+
+ |
+
+
+ Delete a local device
+
+ Access scope : enduser/*
+ > Test operation
+ |
+
+
+ |
+
+
+
+
+
+ Parameters
+
+ | Type |
+ Name |
+ Value |
+ Description |
+
+
+
+ |
+ Path Variable
+ |
+
+ localDeviceOID
+ |
+ "string value" |
+
+
+
+ The OID of the local device to delete
+ |
+
+
+
+ |
+ Request Parameter
+ |
+
+ forced
+ |
+ false |
+
+ (Optional)
+
+ (Default: false)
+
+ true to allow deletion of a mapped device
+ |
+
+
+
+
+
+
+
+
+ Response
+
+ | Type |
+ Name |
+ Value |
+ Description |
+
+
+
+ |
+ Response Body
+ |
+
+ (JSON)
+ |
+
|
+
+
+
+
+ |
+
+
+
+
+
+
+
+
+ HTTP Status Code
+
+ | Code |
+ Message |
+ Meaning |
+
+
+
+ |
+ 204
+ |
+ NO_CONTENT |
+
+ The server has fulfilled the request but does not need to return an entity-body, and might want to return updated metainformation
+ |
+
+
+
+
+
+
+
+
+
+ Generated events on method call
+
+
+ LocalDeviceDeletedEvent
+
+ | Description |
+ Event sent when a local device is deleted |
+
+
+
+ | JSON |
+ {
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
+ "setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
+ "localDeviceOID" : "a local device OID",
+ "type" : "LocalDeviceDeletedEvent"
+} |
+
+
+ | Field name |
+ Field description |
+
+
+
+ | localDeviceOID |
+ Local device OID |
+
+
+
+ | owningPartners |
+ Owning partners of the parent entity (setup, ...)) . only available in event streams |
+
+
+
+ | setupOID |
+ Setup OID |
+
+
+
+ | siteOID |
+ Site OID |
+
+
+
+
+
+
+
+
+
+
+
+
+ |
+
+
+ |
+
+
+
+
+
+
+
+
+ | PUT |
+
+
+
+
+ Local Device
+
+
+ |
+
+
+
+
+ /setup/localDevices/{localDeviceOID}/label/{newLabel}
+
+
+ |
+ application/json |
+
+
+ |
+
+
+ Update the name of a local device
+
+ Access scope : enduser/*
+ > Test operation
+ |
+
+
+ |
+
+
+
+
+
+ Parameters
+
+ | Type |
+ Name |
+ Value |
+ Description |
+
+
+
+ |
+ Path Variable
+ |
+
+ localDeviceOID
+ |
+ "string value" |
+
+
+
+ The OID of the local device
+ |
+
+
+
+ |
+ Path Variable
+ |
+
+ newLabel
+ |
+ "string value" |
+
+
+
+ New local device label
+ |
+
+
+
+
+
+
+
+
+ Response
+
+ | Type |
+ Name |
+ Value |
+ Description |
+
+
+
+ |
+ Response Body
+ |
+
+ (JSON)
+ |
+
|
+
+
+
+
+ |
+
+
+
+
+
+
+
+
+ HTTP Status Code
+
+ | Code |
+ Message |
+ Meaning |
+
+
+
+ |
+ 204
+ |
+ NO_CONTENT |
+
+ The server has fulfilled the request but does not need to return an entity-body, and might want to return updated metainformation
+ |
+
+
+
+
+
+
+
+
+
+ Generated events on method call
+
+
+ LocalDeviceUpdatedEvent
+
+ | Description |
+ Event sent when a local device changes (label, place) |
+
+
+
+ | JSON |
+ {
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
+ "setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
+ "localDeviceOID" : "a local device OID",
+ "label" : "a local device updated event label",
+ "placeOID" : "a place OID",
+ "type" : "LocalDeviceUpdatedEvent"
+} |
+
+
+ | Field name |
+ Field description |
+
+
+
+ | localDeviceOID |
+ Local device OID |
+
+
+
+ | owningPartners |
+ Owning partners of the parent entity (setup, ...)) . only available in event streams |
+
+
+
+ | setupOID |
+ Setup OID |
+
+
+
+ | siteOID |
+ Site OID |
+
+
+
+
+
+
+
+
+
+
+
+
+ |
+
+
+ |
+
+
+
+
+
+
+
+
+ | PUT |
+
+
+
+
+ Local Device
+
+
+ |
+
+
+
+
+ /setup/localDevices/{localDeviceOID}/localDeviceData
+
+
+ |
+ application/json |
+
+
+ |
+
+
+ Update local device data of a local device
+
+ Access scope : enduser/*
+ > Test operation
+ |
+
+
+ |
+
+
+
+
+
+ Parameters
+
+ | Type |
+ Name |
+ Value |
+ Description |
+
+
+
+ |
+ Path Variable
+ |
+
+ localDeviceOID
+ |
+ "string value" |
+
+
+
+ The OID of the local device
+ |
+
+
+
+ |
+ Request Body
+ |
+
+ (JSON)
+ |
+ {
+ "string value" : "object or primitive"
+} |
+
+
+
+ The local device data to update
+ |
+
+
+
+
+
+
+
+
+ Response
+
+ | Type |
+ Name |
+ Value |
+ Description |
+
+
+
+ |
+ Response Body
+ |
+
+ (JSON)
+ |
+
|
+
+
+
+
+ |
+
+
+
+
+
+
+
+
+ HTTP Status Code
+
+ | Code |
+ Message |
+ Meaning |
+
+
+
+ |
+ 204
+ |
+ NO_CONTENT |
+
+ The server has fulfilled the request but does not need to return an entity-body, and might want to return updated metainformation
+ |
+
+
+
+
+
+
+
+
+
+ Generated events on method call
+
+
+ LocalDeviceDataUpdatedEvent
+
+ | Description |
+ Event sent when some local device data changes |
+
+
+
+ | JSON |
+ {
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
+ "setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
+ "localDeviceOID" : "a local device OID",
+ "localDeviceData" : {
+ "a local device data" : "a local device data"
+ },
+ "type" : "LocalDeviceDataUpdatedEvent"
+} |
+
+
+ | Field name |
+ Field description |
+
+
+
+ | localDeviceOID |
+ Local device OID |
+
+
+
+ | owningPartners |
+ Owning partners of the parent entity (setup, ...)) . only available in event streams |
+
+
+
+ | setupOID |
+ Setup OID |
+
+
+
+ | siteOID |
+ Site OID |
+
+
+
+
+
+
+
+
+
+
+
+
+ |
+
+
+ |
+
+
+
+
+
+
+
+
+ | PUT |
+
+
+
+
+ Local Device
+
+
+ |
+
+
+
+
+ /setup/localDevices/{localDeviceOID}/relocate/{placeOID}
+
+
+ |
+ application/json |
+
+
+ |
+
+
+ Relocate a local device in an existing place
+
+ Access scope : enduser/*
+ > Test operation
+ |
+
+
+ |
+
+
+
+
+
+ Parameters
+
+ | Type |
+ Name |
+ Value |
+ Description |
+
+
+
+ |
+ Path Variable
+ |
+
+ localDeviceOID
+ |
+ "string value" |
+
+
+
+ The OID of the local device
+ |
+
+
+
+ |
+ Path Variable
+ |
+
+ placeOID
+ |
+ "string value" |
+
+
+
+ Existing place OID where local device is relocated
+ |
+
+
+
+
+
+
+
+
+ Response
+
+ | Type |
+ Name |
+ Value |
+ Description |
+
+
+
+ |
+ Response Body
+ |
+
+ (JSON)
+ |
+
|
+
+
+
+
+ |
+
+
+
+
+
+
+
+
+ HTTP Status Code
+
+ | Code |
+ Message |
+ Meaning |
+
+
+
+ |
+ 204
+ |
+ NO_CONTENT |
+
+ The server has fulfilled the request but does not need to return an entity-body, and might want to return updated metainformation
+ |
+
+
+
+
+
+
+
+
+
+ Generated events on method call
+
+
+ LocalDeviceUpdatedEvent
+
+ | Description |
+ Event sent when a local device changes (label, place) |
+
+
+
+ | JSON |
+ {
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
+ "setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
+ "localDeviceOID" : "a local device OID",
+ "label" : "a local device updated event label",
+ "placeOID" : "a place OID",
+ "type" : "LocalDeviceUpdatedEvent"
+} |
+
+
+ | Field name |
+ Field description |
+
+
+
+ | localDeviceOID |
+ Local device OID |
+
+
+
+ | owningPartners |
+ Owning partners of the parent entity (setup, ...)) . only available in event streams |
+
+
+
+ | setupOID |
+ Setup OID |
+
+
+
+ | siteOID |
+ Site OID |
+
+
+
+
+
+
+
+
+
+
+
+
+ |
+
+
+ |
+
+
+
+
+
+
+
+
+ | GET |
+
+
+
+
+ Local Devices
+
+
+ |
+
+
+
+
+ /setup/localDevices
+
+
+ |
+ application/json |
+
+
+ |
+
+
+ Get all local devices
+ Per-session rate-limit : 1 calls per 1d period for this particular operation (bulk-load)
+ Access scope : enduser/*
+ > Test operation
+ |
+
+
+ |
+
+
+
+
+
+ Parameters
+
+ | Type |
+ Name |
+ Value |
+ Description |
+
+
+
+ |
+ Request Parameter
+ |
+
+ includeMapped
+ |
+ false |
+
+ (Optional)
+
+ (Default: false)
+
+ true to include mapped devices
+ |
+
+
+
+
+
+
+
+
+ Response
+
+ | Type |
+ Name |
+ Value |
+ Description |
+
+
+
+ |
+ Response Body
+ |
+
+ (JSON)
+ |
+ [ {
+ "label" : "a local device response label",
+ "placeOID" : "a place OID",
+ "mapped" : false,
+ "model" : {
+ "type" : "a OGPNode model type",
+ "subType" : "a sub type",
+ "features" : [ {
+ "name" : "a OGPFeature name",
+ "commandLess" : true,
+ "eventBased" : true,
+ "authenticationRestrictedCommands" : [ "some authentication restricted commands" ]
+ } ]
+ },
+ "attributes" : {
+ "some attributes" : "some attributes"
+ },
+ "localDeviceData" : {
+ "a local device data" : "a local device data"
+ },
+ "oid" : "the local device response UUID"
} ] |
@@ -86357,6 +91626,35 @@
+ |
+
+
+
+
+
+
+
+
+
+
+ Place
+
+
+
+
+
+
+ |
+ |
+ Expand commands |
+
+
+
+
+
+
+
+
@@ -86378,7 +91676,7 @@
- Setup interactive notifications history
+ Place
@@ -86386,7 +91684,7 @@
- /setup/interactiveNotifications/history
+ /setup/places
@@ -86402,10 +91700,10 @@
|
- Return a collection of interactive notification that were validated in the past
This operation returns a collection of InteractiveNotification objects to be displayed one after the other.
+ Get setup places starting from root
Per-session rate-limit : 1 calls per 1d period for this particular operation (bulk-load)
- Access scope : Full enduser API access (enduser/*)
- > Test operation
+ Access scope : enduser/*
+ > Test operation
|
@@ -86432,14 +91730,31 @@
|
(JSON)
|
- [ {
- "actionMask" : 1,
- "text" : "a text",
- "subject" : "a subject",
- "oid" : "a notification OID",
- "date" : 1769503155190,
- "expirationDate" : 1769503155190
-} ] |
+ {
+ "creationTime" : 1785140821994,
+ "lastUpdateTime" : 1785140821994,
+ "label" : "a place label",
+ "type" : 1,
+ "metadata" : "some metadata",
+ "oid" : "the place UUID",
+ "subPlaces" : [ {
+ "creationTime" : 1785140821994,
+ "lastUpdateTime" : 1785140821994,
+ "label" : "a place label",
+ "type" : 1,
+ "metadata" : "some metadata",
+ "oid" : "the place UUID",
+ "subPlaces" : [ {
+ "creationTime" : 1785140821994,
+ "lastUpdateTime" : 1785140821994,
+ "label" : "a place label",
+ "type" : 1,
+ "metadata" : "some metadata",
+ "oid" : "the place UUID",
+ "subPlaces" : [ ]
+ } ]
+ } ]
+} |
@@ -86495,49 +91810,20 @@
- |
-
-
-
-
-
-
-
-
-
-
- Place
-
-
-
-
-
-
- |
- |
- Expand commands |
-
-
-
-
-
-
-
-
- | GET |
+ POST |
- /setup/places
+ /setup/places/{parentPlaceOID}/subPlaces
|
application/json |
|
- Get setup places starting from root
- Per-session rate-limit : 1 calls per 1d period for this particular operation (bulk-load)
- Access scope : Full enduser API access (enduser/*)
- > Test operation
+ Create place in user setup
+
+ Access scope : enduser/*
+ > Test operation
|
@@ -86580,6 +91866,52 @@
+
+
+ Parameters
+
+ | Type |
+ Name |
+ Value |
+ Description |
+
+
+
+ |
+ Path Variable
+ |
+
+ parentPlaceOID
+ |
+ "string value" |
+
+
+
+ The parent place of the new place
+ |
+
+
+
+ |
+ Request Body
+ |
+
+ (JSON)
+ |
+ {
+ "type" : "a place request type",
+ "label" : "a place request label",
+ "metadata" : "some metadata"
+} |
+
+
+
+ Place settings : type, label and metadata
+ |
+
+
+
+
@@ -86600,29 +91932,7 @@
(JSON)
|
{
- "creationTime" : 1769503155309,
- "lastUpdateTime" : 1769503155309,
- "label" : "a place label",
- "type" : 1,
- "metadata" : "some metadata",
- "oid" : "the place UUID",
- "subPlaces" : [ {
- "creationTime" : 1769503155309,
- "lastUpdateTime" : 1769503155309,
- "label" : "a place label",
- "type" : 1,
- "metadata" : "some metadata",
- "oid" : "the place UUID",
- "subPlaces" : [ {
- "creationTime" : 1769503155309,
- "lastUpdateTime" : 1769503155309,
- "label" : "a place label",
- "type" : 1,
- "metadata" : "some metadata",
- "oid" : "the place UUID",
- "subPlaces" : [ ]
- } ]
- } ]
+ "placeOID" : "string value"
} |
@@ -86646,15 +91956,15 @@
|
- 200
+ 201
|
- OK |
+ CREATED |
- The request has succeeded
+ The request has been fulfilled and resulted in a new resource being created
|
|
@@ -86665,6 +91975,59 @@
+ Generated events on method call
+
+
+ PlaceCreatedEvent
+
+ | Description |
+ A new place has been created |
+
+
+
+ | JSON |
+ {
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
+ "setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
+ "placeOID" : "a place OID",
+ "parentPlaceOID" : "a parent place OID",
+ "placeType" : 1,
+ "label" : "a place created event label",
+ "metadata" : "some metadata",
+ "type" : "PlaceCreatedEvent"
+} |
+
+
+ | Field name |
+ Field description |
+
+
+
+ | owningPartners |
+ Owning partners of the parent entity (setup, ...)) . only available in event streams |
+
+
+
+ | placeOID |
+ Place OID |
+
+
+
+ | setupOID |
+ Setup OID |
+
+
+
+ | siteOID |
+ Site OID |
+
+
+
+
+
+
@@ -86679,7 +92042,7 @@
-
+
">
+ Place [DEPRECATED]
+ since version 2018.3.3
- Place
|
+ /setup/places/{parentPlaceOID}/{label}/{type}
- /setup/places/{parentPlaceOID}/subPlaces
|
@@ -86726,8 +92090,8 @@
Create place in user setup
- Access scope : Full enduser API access (enduser/*)
- > Test operation
+ Access scope : enduser/*
+ > Test operation
@@ -86762,57 +92126,39 @@
|
- Request Body
+ Path Variable
|
- (JSON)
+ label
|
- {
- "type" : "a place settings type",
- "label" : "a place settings label",
- "metadata" : "some metadata"
-} |
+ "string value" |
- Place settings : type, label and metadata
+ The name of the place
|
-
-
-
-
-
-
- Response
-
- | Type |
- Name |
- Value |
- Description |
-
-
|
- Response Body
+ Path Variable
|
- (JSON)
+ type
|
- {
- "placeOID" : "string value"
-} |
+ "string value" |
-
+ The type of the place (Could be an integer or a string)
|
+
+
@@ -86856,15 +92202,16 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"placeOID" : "a place OID",
"parentPlaceOID" : "a parent place OID",
- "type" : 1,
+ "placeType" : 1,
"label" : "a place created event label",
"metadata" : "some metadata",
- "name" : "PlaceCreatedEvent"
+ "type" : "PlaceCreatedEvent"
} |
@@ -86887,213 +92234,9 @@ Generated events on method call
Setup OID |
-
-
-
-
-
-
-
-
-
-
- |
-
- |
- |
-
-
-
-
-
-
-
-
- | POST |
-
-
-
- Place [DEPRECATED]
- since version 2018.3.3
-
-
-
- |
-
-
-
- /setup/places/{parentPlaceOID}/{label}/{type}
-
-
-
- |
- application/json |
-
-
- |
-
-
- Create place in user setup
-
- Access scope : Full enduser API access (enduser/*)
- > Test operation
- |
-
-
- |
-
-
-
-
-
- Parameters
-
- | Type |
- Name |
- Value |
- Description |
-
-
-
- |
- Path Variable
- |
-
- parentPlaceOID
- |
- "string value" |
-
-
-
- The parent place of the new place
- |
-
-
-
- |
- Path Variable
- |
-
- label
- |
- "string value" |
-
-
-
- The name of the place
- |
-
-
-
- |
- Path Variable
- |
-
- type
- |
- "string value" |
-
-
-
- The type of the place (Could be an integer or a string)
- |
-
-
-
-
-
-
-
-
-
-
- HTTP Status Code
-
- | Code |
- Message |
- Meaning |
-
-
-
- |
- 201
- |
- CREATED |
-
- The request has been fulfilled and resulted in a new resource being created
- |
-
-
-
-
-
-
-
-
-
- Generated events on method call
-
-
- PlaceCreatedEvent
-
- | Description |
- A new place has been created |
-
-
-
- | JSON |
- {
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
- "setupOID" : "a setup OID",
- "placeOID" : "a place OID",
- "parentPlaceOID" : "a parent place OID",
- "type" : 1,
- "label" : "a place created event label",
- "metadata" : "some metadata",
- "name" : "PlaceCreatedEvent"
-} |
-
-
- | Field name |
- Field description |
-
-
- | owningPartners |
- Owning partners of the parent entity (setup, ...)) . only available in event streams |
-
-
-
- | placeOID |
- Place OID |
-
-
-
- | setupOID |
- Setup OID |
+ siteOID |
+ Site OID |
@@ -87161,7 +92304,7 @@ Generated events on method call
Get places starting from a given place OID
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -87217,22 +92360,22 @@ Generated events on method call
(JSON)
{
- "creationTime" : 1769503155309,
- "lastUpdateTime" : 1769503155309,
+ "creationTime" : 1785140821994,
+ "lastUpdateTime" : 1785140821994,
"label" : "a place label",
"type" : 1,
"metadata" : "some metadata",
"oid" : "the place UUID",
"subPlaces" : [ {
- "creationTime" : 1769503155309,
- "lastUpdateTime" : 1769503155309,
+ "creationTime" : 1785140821994,
+ "lastUpdateTime" : 1785140821994,
"label" : "a place label",
"type" : 1,
"metadata" : "some metadata",
"oid" : "the place UUID",
"subPlaces" : [ {
- "creationTime" : 1769503155309,
- "lastUpdateTime" : 1769503155309,
+ "creationTime" : 1785140821994,
+ "lastUpdateTime" : 1785140821994,
"label" : "a place label",
"type" : 1,
"metadata" : "some metadata",
@@ -87343,7 +92486,7 @@ Generated events on method call
Update place settings : type, label and metadata
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
|
@@ -87385,8 +92528,8 @@ Generated events on method call
(JSON)
{
- "type" : "a place settings type",
- "label" : "a place settings label",
+ "type" : "a place request type",
+ "label" : "a place request label",
"metadata" : "some metadata"
} |
@@ -87444,15 +92587,16 @@ Generated events on method call
|
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"placeOID" : "a place OID",
"parentPlaceOID" : "a parent place OID",
- "type" : 1,
+ "placeType" : 1,
"label" : "a place updated event label",
"metadata" : "some metadata",
- "name" : "PlaceUpdatedEvent"
+ "type" : "PlaceUpdatedEvent"
} |
@@ -87475,6 +92619,11 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
@@ -87540,7 +92689,7 @@ Generated events on method call
Delete a place from user setup
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
|
@@ -87622,11 +92771,12 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"placeOID" : "a place OID",
- "name" : "PlaceDeletedEvent"
+ "type" : "PlaceDeletedEvent"
} |
@@ -87649,6 +92799,11 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
@@ -87714,7 +92869,7 @@ Generated events on method call
Relocate an existing place in another parent place
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
|
@@ -87811,15 +92966,16 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"placeOID" : "a place OID",
"parentPlaceOID" : "a parent place OID",
- "type" : 1,
+ "placeType" : 1,
"label" : "a place updated event label",
"metadata" : "some metadata",
- "name" : "PlaceUpdatedEvent"
+ "type" : "PlaceUpdatedEvent"
} |
@@ -87842,6 +92998,11 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
@@ -87908,7 +93069,7 @@ Generated events on method call
Relocate an existing place in another floor
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
|
@@ -87953,7 +93114,7 @@ Generated events on method call
- The new parrent place
+ The new parent place OID
|
@@ -88005,15 +93166,16 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"placeOID" : "a place OID",
"parentPlaceOID" : "a parent place OID",
- "type" : 1,
+ "placeType" : 1,
"label" : "a place updated event label",
"metadata" : "some metadata",
- "name" : "PlaceUpdatedEvent"
+ "type" : "PlaceUpdatedEvent"
} |
@@ -88036,6 +93198,11 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
@@ -88130,7 +93297,7 @@
Ask the box to refresh all devices states of given protocol
Per-session rate-limit : 1 calls per 1d period for this particular operation (bulk-load)
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
|
@@ -88203,20 +93370,23 @@
Generated events on method call
- RefreshAllDevicesStatesCompletedEvent
+ RefreshAllDevicesStatesFailedEvent
| Description |
- Refresh all states query for given protocol type is completed |
+ Devices states could not be refreshed |
| JSON |
{
- "timestamp" : 2,
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
+ "setupOID" : "a setup OID",
"owningPartner" : "an owning partner",
"gatewayId" : "A gateway id (ex: 0101-1234-5678)",
"protocolType" : 1,
- "name" : "RefreshAllDevicesStatesCompletedEvent"
+ "type" : "RefreshAllDevicesStatesFailedEvent",
+ "failureType" : "NON_EXECUTING"
} |
@@ -88234,40 +93404,14 @@ Generated events on method call
Owning partner of the parent entity (gateway, setup group, ...)) . only available in event streams |
-
-
-
-
- RefreshAllDevicesStatesFailedEvent
-
- | Description |
- Devices states could not be refreshed |
-
-
-
- | JSON |
- {
- "timestamp" : 2,
- "owningPartner" : "an owning partner",
- "gatewayId" : "A gateway id (ex: 0101-1234-5678)",
- "protocolType" : 1,
- "name" : "RefreshAllDevicesStatesFailedEvent",
- "failureType" : "NON_EXECUTING"
-} |
-
-
- | Field name |
- Field description |
-
-
- | gatewayId |
- Gateway id |
+ setupOID |
+ Setup OID |
- | owningPartner |
- Owning partner of the parent entity (gateway, setup group, ...)) . only available in event streams |
+ siteOID |
+ Site OID |
@@ -88283,16 +93427,17 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
"deviceStates" : [ {
"name" : "a device state change item name",
"type" : 1,
"value" : "a device state change item value"
} ],
- "name" : "DeviceStateChangedEvent"
+ "type" : "DeviceStateChangedEvent"
} |
@@ -88320,6 +93465,58 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
+
+
+
+
+ RefreshAllDevicesStatesCompletedEvent
+
+ | Description |
+ Refresh all states query for given protocol type is completed |
+
+
+
+ | JSON |
+ {
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
+ "setupOID" : "a setup OID",
+ "owningPartner" : "an owning partner",
+ "gatewayId" : "A gateway id (ex: 0101-1234-5678)",
+ "protocolType" : 1,
+ "type" : "RefreshAllDevicesStatesCompletedEvent"
+} |
+
+
+ | Field name |
+ Field description |
+
+
+
+ | gatewayId |
+ Gateway id |
+
+
+
+ | owningPartner |
+ Owning partner of the parent entity (gateway, setup group, ...)) . only available in event streams |
+
+
+
+ | setupOID |
+ Setup OID |
+
+
+
+ | siteOID |
+ Site OID |
+
+
@@ -88415,7 +93612,7 @@
Deprecated, use the new android firebase infrastructure. Subscribe an Android device to the notification service
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -88523,11 +93720,12 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"pushSubscriptionOID" : "a push subscription OID",
- "name" : "PushSubscriptionCreatedEvent"
+ "type" : "PushSubscriptionCreatedEvent"
} |
@@ -88545,6 +93743,11 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
@@ -88611,7 +93814,7 @@ Generated events on method call
Deprecated, use the new android firebase infrastructure. Update an Android device subscription
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -88770,7 +93973,7 @@ Generated events on method call
Deprecated, use the new android firebase infrastructure. Get the current subscription configuration for a device (Android)
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -88842,8 +94045,8 @@ Generated events on method call
{
"device" : {
- "creationTime" : 1769503155215,
- "lastUpdateTime" : 1769503155215,
+ "creationTime" : 1785140821910,
+ "lastUpdateTime" : 1785140821910,
"udid" : "a udid",
"model" : "a model",
"version" : "a version",
@@ -88958,7 +94161,7 @@ Generated events on method call
Deprecated, use DELETE on {subscriberOID} instead. Unsubscribe an Android device
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
|
@@ -89055,11 +94258,12 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"pushSubscriptionOID" : "a push subscription OID",
- "name" : "PushSubscriptionDeletedEvent"
+ "type" : "PushSubscriptionDeletedEvent"
} |
@@ -89077,6 +94281,11 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
@@ -89142,7 +94351,7 @@ Generated events on method call
Subscribe an Android device to the firebase notification service
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -89249,11 +94458,12 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"pushSubscriptionOID" : "a push subscription OID",
- "name" : "PushSubscriptionCreatedEvent"
+ "type" : "PushSubscriptionCreatedEvent"
} |
@@ -89271,6 +94481,11 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
@@ -89336,7 +94551,7 @@ Generated events on method call
Update an Android firebase device subscription
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -89493,7 +94708,7 @@ Generated events on method call
Get the current subscription configuration for a device (Android firebase)
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -89565,8 +94780,8 @@ Generated events on method call
{
"device" : {
- "creationTime" : 1769503155198,
- "lastUpdateTime" : 1769503155198,
+ "creationTime" : 1785140821912,
+ "lastUpdateTime" : 1785140821912,
"udid" : "a udid",
"model" : "a model",
"version" : "a version",
@@ -89679,7 +94894,7 @@ Generated events on method call
Subscribe an Apple device to the notification service
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
|
@@ -89789,11 +95004,12 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"pushSubscriptionOID" : "a push subscription OID",
- "name" : "PushSubscriptionCreatedEvent"
+ "type" : "PushSubscriptionCreatedEvent"
} |
@@ -89811,6 +95027,11 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
@@ -89876,7 +95097,7 @@ Generated events on method call
Update an Apple device subscription
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -90036,7 +95257,7 @@ Generated events on method call
Get the current subscription configuration for a device (Apple)
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -90108,8 +95329,8 @@ Generated events on method call
{
"device" : {
- "creationTime" : 1769503155213,
- "lastUpdateTime" : 1769503155213,
+ "creationTime" : 1785140821914,
+ "lastUpdateTime" : 1785140821914,
"udid" : "a udid",
"model" : "a model",
"version" : "a version",
@@ -90226,7 +95447,7 @@ Generated events on method call
Deprecated, use DELETE on {subscriberOID} instead. Unsubscribe an Apple device
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
|
@@ -90323,11 +95544,12 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"pushSubscriptionOID" : "a push subscription OID",
- "name" : "PushSubscriptionDeletedEvent"
+ "type" : "PushSubscriptionDeletedEvent"
} |
@@ -90345,6 +95567,11 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
@@ -90410,7 +95637,7 @@ Generated events on method call
Get all push devices for connected endUser from functional application id
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -90471,8 +95698,8 @@ Generated events on method call
"appleDevices" : [ {
"subscriberOID" : "a subscriber OID",
"device" : {
- "creationTime" : 1769503155209,
- "lastUpdateTime" : 1769503155209,
+ "creationTime" : 1785140821921,
+ "lastUpdateTime" : 1785140821922,
"udid" : "a udid",
"model" : "a model",
"version" : "a version",
@@ -90483,8 +95710,8 @@ Generated events on method call
"androidDevices" : [ {
"subscriberOID" : "a subscriber OID",
"device" : {
- "creationTime" : 1769503155209,
- "lastUpdateTime" : 1769503155209,
+ "creationTime" : 1785140821922,
+ "lastUpdateTime" : 1785140821922,
"udid" : "a udid",
"model" : "a model",
"version" : "a version",
@@ -90495,8 +95722,8 @@ Generated events on method call
"androidFcmDevices" : [ {
"subscriberOID" : "a subscriber OID",
"device" : {
- "creationTime" : 1769503155210,
- "lastUpdateTime" : 1769503155210,
+ "creationTime" : 1785140821922,
+ "lastUpdateTime" : 1785140821922,
"udid" : "a udid",
"model" : "a model",
"version" : "a version",
@@ -90507,8 +95734,8 @@ Generated events on method call
"windowsDevices" : [ {
"subscriberOID" : "a subscriber OID",
"device" : {
- "creationTime" : 1769503155209,
- "lastUpdateTime" : 1769503155209,
+ "creationTime" : 1785140821922,
+ "lastUpdateTime" : 1785140821922,
"udid" : "a udid",
"model" : "a model",
"version" : "a version",
@@ -90620,7 +95847,7 @@ Generated events on method call
Unsubscribe a user from the notification service for authenticated setup
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -90702,11 +95929,12 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"pushSubscriptionOID" : "a push subscription OID",
- "name" : "PushSubscriptionDeletedEvent"
+ "type" : "PushSubscriptionDeletedEvent"
} |
@@ -90724,6 +95952,11 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
@@ -90789,7 +96022,7 @@ Generated events on method call
Unsubscribe a device from the notification service
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -90871,11 +96104,217 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
+ "setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
+ "pushSubscriptionOID" : "a push subscription OID",
+ "type" : "PushSubscriptionDeletedEvent"
+} |
+
+
+ | Field name |
+ Field description |
+
+
+
+ | owningPartners |
+ Owning partners of the parent entity (setup, ...)) . only available in event streams |
+
+
+
+ | setupOID |
+ Setup OID |
+
+
+
+ | siteOID |
+ Site OID |
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ | DELETE |
+
+
+
+
+ Notifications
+
+
+ |
+
+
+
+
+ /setup/subscribe/notification/all
+
+
+ |
+ application/json |
+
+
+ |
+
+
+ Unsubscribe a user from notification service for all the setups on his device
+
+ Access scope : enduser/*
+ > Test operation
+ |
+
+
+ |
+
+
+
+
+
+ Parameters
+
+ | Type |
+ Name |
+ Value |
+ Description |
+
+
+
+ |
+ Request Parameter
+ |
+
+ deviceUdid
+ |
+ "string value" |
+
+
+
+ The device Udid
+ |
+
+
+
+ |
+ Request Parameter
+ |
+
+ pushProvider
+ |
+ "string value" |
+
+
+
+ The device provider
+ |
+
+
+
+ |
+ Request Parameter
+ |
+
+ applicationId
+ |
+ "string value" |
+
+
+
+ The client application id
+ |
+
+
+
+
+
+
+
+
+
+
+ HTTP Status Code
+
+ | Code |
+ Message |
+ Meaning |
+
+
+
+ |
+ 204
+ |
+ NO_CONTENT |
+
+ The server has fulfilled the request but does not need to return an entity-body, and might want to return updated metainformation
+ |
+
+
+
+
+
+
+
+
+
+ Generated events on method call
+
+
+ PushSubscriptionDeletedEvent
+
+ | Description |
+ A push subscription has been deleted |
+
+
+
+ | JSON |
+ {
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"pushSubscriptionOID" : "a push subscription OID",
- "name" : "PushSubscriptionDeletedEvent"
+ "type" : "PushSubscriptionDeletedEvent"
} |
@@ -90893,203 +96332,9 @@ Generated events on method call
Setup OID |
-
-
-
-
-
-
-
-
-
-
- |
-
-
- |
-
-
-
-
-
-
-
-
- | DELETE |
-
-
-
-
- Notifications
-
-
- |
-
-
-
-
- /setup/subscribe/notification/all
-
-
- |
- application/json |
-
-
- |
-
-
- Unsubscribe a user from notification service for all the setups on his device
-
- Access scope : Full enduser API access (enduser/*)
- > Test operation
- |
-
-
- |
-
-
-
-
-
- Parameters
-
- | Type |
- Name |
- Value |
- Description |
-
-
-
- |
- Request Parameter
- |
-
- deviceUdid
- |
- "string value" |
-
-
-
- The device Udid
- |
-
-
-
- |
- Request Parameter
- |
-
- pushProvider
- |
- "string value" |
-
-
-
- The device provider
- |
-
-
-
- |
- Request Parameter
- |
-
- applicationId
- |
- "string value" |
-
-
-
- The client application id
- |
-
-
-
-
-
-
-
-
-
-
- HTTP Status Code
-
- | Code |
- Message |
- Meaning |
-
-
-
- |
- 204
- |
- NO_CONTENT |
-
- The server has fulfilled the request but does not need to return an entity-body, and might want to return updated metainformation
- |
-
-
-
-
-
-
-
-
-
- Generated events on method call
-
-
- PushSubscriptionDeletedEvent
-
- | Description |
- A push subscription has been deleted |
-
-
-
- | JSON |
- {
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
- "setupOID" : "a setup OID",
- "pushSubscriptionOID" : "a push subscription OID",
- "name" : "PushSubscriptionDeletedEvent"
-} |
-
-
- | Field name |
- Field description |
-
-
-
- | owningPartners |
- Owning partners of the parent entity (setup, ...)) . only available in event streams |
-
-
- | setupOID |
- Setup OID |
+ siteOID |
+ Site OID |
@@ -91157,7 +96402,7 @@ Generated events on method call
Subscribe a Windows device to the notification service
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -91267,11 +96512,12 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"pushSubscriptionOID" : "a push subscription OID",
- "name" : "PushSubscriptionCreatedEvent"
+ "type" : "PushSubscriptionCreatedEvent"
} |
@@ -91289,6 +96535,11 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
@@ -91533,7 +96784,7 @@ Generated events on method call
Update a Windows device subscription
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
|
@@ -91872,7 +97123,7 @@ Generated events on method call
Get the current subscription configuration for a device (Windows)
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -91944,8 +97195,8 @@ Generated events on method call
{
"device" : {
- "creationTime" : 1769503155201,
- "lastUpdateTime" : 1769503155201,
+ "creationTime" : 1785140821916,
+ "lastUpdateTime" : 1785140821916,
"udid" : "a udid",
"model" : "a model",
"version" : "a version",
@@ -92062,7 +97313,7 @@ Generated events on method call
Deprecated, use DELETE on {subscriberOID} instead. Unsubscribe a Windows device
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
|
@@ -92159,11 +97410,12 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"pushSubscriptionOID" : "a push subscription OID",
- "name" : "PushSubscriptionDeletedEvent"
+ "type" : "PushSubscriptionDeletedEvent"
} |
@@ -92181,6 +97433,11 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
@@ -92275,7 +97532,7 @@
Create a secret
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
|
@@ -92442,7 +97699,7 @@
Update a secret
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -92596,7 +97853,7 @@
Delete a secret
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -92727,7 +97984,7 @@
Update a secret value
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -92873,7 +98130,7 @@
List secrets
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -93069,7 +98326,7 @@
Fetch an URL for the user's MyTahoma account
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -93124,12 +98381,13 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"serviceId" : "a service id",
"url" : "a url",
- "name" : "ExternalServiceURLEvent"
+ "type" : "ExternalServiceURLEvent"
} |
@@ -93152,6 +98410,11 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
| url |
The requested URL |
@@ -93251,7 +98514,7 @@
Get the activated third party model for current setup
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -93281,8 +98544,8 @@
{
"thirdPartyModelSetupUsers" : [ {
- "creationTime" : 1769503155472,
- "lastUpdateTime" : 1769503155472,
+ "creationTime" : 1785140822262,
+ "lastUpdateTime" : 1785140822262,
"userId" : "a user id",
"setupOID" : "a setup OID",
"modelType" : 1,
@@ -93398,7 +98661,7 @@
Get the security status of a third party model
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
|
@@ -93559,7 +98822,7 @@
Unlock security actions of a third party model
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -93720,7 +98983,7 @@
Add items to a zone in user setup
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -93812,15 +99075,16 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"zoneOID" : "a zone OID",
- "type" : 1,
+ "zoneType" : 1,
"label" : "a zone updated event label",
"deviceURLs" : [ "some device URLs" ],
"placeOIDs" : [ "some place OIDs" ],
- "name" : "ZoneUpdatedEvent"
+ "type" : "ZoneUpdatedEvent"
} |
@@ -93838,6 +99102,11 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
| zoneOID |
Zone OID |
@@ -93909,7 +99178,7 @@ Generated events on method call
Remove items from a zone in user setup
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -94002,15 +99271,16 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"zoneOID" : "a zone OID",
- "type" : 1,
+ "zoneType" : 1,
"label" : "a zone updated event label",
"deviceURLs" : [ "some device URLs" ],
"placeOIDs" : [ "some place OIDs" ],
- "name" : "ZoneUpdatedEvent"
+ "type" : "ZoneUpdatedEvent"
} |
@@ -94028,6 +99298,11 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
| zoneOID |
Zone OID |
@@ -94098,7 +99373,7 @@ Generated events on method call
Relocate items to another zone in user setup
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -94214,15 +99489,16 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"zoneOID" : "a zone OID",
- "type" : 1,
+ "zoneType" : 1,
"label" : "a zone updated event label",
"deviceURLs" : [ "some device URLs" ],
"placeOIDs" : [ "some place OIDs" ],
- "name" : "ZoneUpdatedEvent"
+ "type" : "ZoneUpdatedEvent"
} |
@@ -94240,6 +99516,11 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
| zoneOID |
Zone OID |
@@ -94310,7 +99591,7 @@ Generated events on method call
Get the items of a zone
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -94472,7 +99753,7 @@ Generated events on method call
Add items to a zone in user setup
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -94573,15 +99854,16 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"zoneOID" : "a zone OID",
- "type" : 1,
+ "zoneType" : 1,
"label" : "a zone updated event label",
"deviceURLs" : [ "some device URLs" ],
"placeOIDs" : [ "some place OIDs" ],
- "name" : "ZoneUpdatedEvent"
+ "type" : "ZoneUpdatedEvent"
} |
@@ -94599,6 +99881,11 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
| zoneOID |
Zone OID |
@@ -94670,7 +99957,7 @@ Generated events on method call
Relocate items to a zone in user setup
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -94778,15 +100065,16 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"zoneOID" : "a zone OID",
- "type" : 1,
+ "zoneType" : 1,
"label" : "a zone updated event label",
"deviceURLs" : [ "some device URLs" ],
"placeOIDs" : [ "some place OIDs" ],
- "name" : "ZoneUpdatedEvent"
+ "type" : "ZoneUpdatedEvent"
} |
@@ -94804,6 +100092,11 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
| zoneOID |
Zone OID |
@@ -94875,7 +100168,7 @@ Generated events on method call
Remove items from a zone in user setup
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -94976,15 +100269,16 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"zoneOID" : "a zone OID",
- "type" : 1,
+ "zoneType" : 1,
"label" : "a zone updated event label",
"deviceURLs" : [ "some device URLs" ],
"placeOIDs" : [ "some place OIDs" ],
- "name" : "ZoneUpdatedEvent"
+ "type" : "ZoneUpdatedEvent"
} |
@@ -95002,6 +100296,11 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
| zoneOID |
Zone OID |
@@ -95072,7 +100371,7 @@ Generated events on method call
Remove items from a zone in user setup
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -95173,15 +100472,16 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"zoneOID" : "a zone OID",
- "type" : 1,
+ "zoneType" : 1,
"label" : "a zone updated event label",
"deviceURLs" : [ "some device URLs" ],
"placeOIDs" : [ "some place OIDs" ],
- "name" : "ZoneUpdatedEvent"
+ "type" : "ZoneUpdatedEvent"
} |
@@ -95199,6 +100499,11 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
| zoneOID |
Zone OID |
@@ -95269,7 +100574,7 @@ Generated events on method call
Create zone in user setup
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -95361,15 +100666,16 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"zoneOID" : "a zone OID",
- "type" : 1,
+ "zoneType" : 1,
"label" : "a zone created event label",
"deviceURLs" : [ "some device URLs" ],
"placeOIDs" : [ "some place OIDs" ],
- "name" : "ZoneCreatedEvent"
+ "type" : "ZoneCreatedEvent"
} |
@@ -95387,6 +100693,11 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
| zoneOID |
Zone OID |
@@ -95458,7 +100769,7 @@ Generated events on method call
Update zone
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -95600,7 +100911,7 @@ Generated events on method call
Get a zone of a user setup
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -95656,8 +100967,8 @@ Generated events on method call
(JSON)
{
- "creationTime" : 1769503155311,
- "lastUpdateTime" : 1769503155314,
+ "creationTime" : 1785140821999,
+ "lastUpdateTime" : 1785140822003,
"label" : "a zone label",
"type" : 0,
"items" : [ {
@@ -95771,7 +101082,7 @@ Generated events on method call
Update zone
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
|
@@ -95928,7 +101239,7 @@ Generated events on method call
Delete a zone from user setup.
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -96010,11 +101321,12 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"zoneOID" : "a zone OID",
- "name" : "ZoneDeletedEvent"
+ "type" : "ZoneDeletedEvent"
} |
@@ -96032,6 +101344,11 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
| zoneOID |
Zone OID |
@@ -96102,7 +101419,7 @@ Generated events on method call
Update zone type and label
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -96214,15 +101531,16 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"zoneOID" : "a zone OID",
- "type" : 1,
+ "zoneType" : 1,
"label" : "a zone updated event label",
"deviceURLs" : [ "some device URLs" ],
"placeOIDs" : [ "some place OIDs" ],
- "name" : "ZoneUpdatedEvent"
+ "type" : "ZoneUpdatedEvent"
} |
@@ -96240,6 +101558,11 @@ Generated events on method call
Setup OID |
+
+ | siteOID |
+ Site OID |
+
+
| zoneOID |
Zone OID |
@@ -96310,7 +101633,7 @@ Generated events on method call
Get all zones of a user setup
Per-session rate-limit : 1 calls per 1d period for this particular operation (bulk-load)
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -96339,8 +101662,8 @@ Generated events on method call
(JSON)
[ {
- "creationTime" : 1769503155315,
- "lastUpdateTime" : 1769503155315,
+ "creationTime" : 1785140822004,
+ "lastUpdateTime" : 1785140822004,
"label" : "a zone label",
"type" : 0,
"items" : [ {
@@ -96525,7 +101848,7 @@
Create a new setup trigger : see asset-specs for scheduling Intervals composition (exhaustive but non-functional example)
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
|
@@ -96728,10 +102051,12 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
+ "setupOID" : "a setup OID",
"owningPartner" : "an owning partner",
"gatewayId" : "A gateway id (ex: 0101-1234-5678)",
- "name" : "GatewaySynchronizationStartedEvent"
+ "type" : "GatewaySynchronizationStartedEvent"
} |
@@ -96749,26 +102074,35 @@ Generated events on method call
Owning partner of the parent entity (gateway, setup group, ...)) . only available in event streams |
+
+ | setupOID |
+ Setup OID |
+
+
+
+ | siteOID |
+ Site OID |
+
+
- SetupTriggerCreationFailedEvent
+ GatewaySynchronizationEndedEvent
| Description |
- A setup trigger could not be created |
+ A data synchronization sequence between the gateway and the server has completed |
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
- "setupTriggerType" : 1,
- "setupTriggerOID" : "a setup trigger OID",
- "setupTriggerId" : "a setup trigger id",
- "name" : "SetupTriggerCreationFailedEvent"
+ "owningPartner" : "an owning partner",
+ "gatewayId" : "A gateway id (ex: 0101-1234-5678)",
+ "type" : "GatewaySynchronizationEndedEvent"
} |
@@ -96777,47 +102111,46 @@ Generated events on method call
- | owningPartners |
- Owning partners of the parent entity (setup, ...)) . only available in event streams |
-
-
-
- | setupOID |
- Setup OID |
+ gatewayId |
+ Gateway id |
- | setupTriggerId |
- Setup trigger Id |
+ owningPartner |
+ Owning partner of the parent entity (gateway, setup group, ...)) . only available in event streams |
- | setupTriggerOID |
- Setup trigger OID |
+ setupOID |
+ Setup OID |
- | setupTriggerType |
- Setup trigger type |
+ siteOID |
+ Site OID |
- GatewaySynchronizationEndedEvent
+ SetupTriggerCreationFailedEvent
| Description |
- A data synchronization sequence between the gateway and the server has completed |
+ A setup trigger could not be created |
| JSON |
{
- "timestamp" : 2,
- "owningPartner" : "an owning partner",
- "gatewayId" : "A gateway id (ex: 0101-1234-5678)",
- "name" : "GatewaySynchronizationEndedEvent"
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
+ "setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
+ "setupTriggerType" : 1,
+ "setupTriggerOID" : "a setup trigger OID",
+ "setupTriggerId" : "a setup trigger id",
+ "type" : "SetupTriggerCreationFailedEvent"
} |
@@ -96826,13 +102159,33 @@ Generated events on method call
- | gatewayId |
- Gateway id |
+ owningPartners |
+ Owning partners of the parent entity (setup, ...)) . only available in event streams |
- | owningPartner |
- Owning partner of the parent entity (gateway, setup group, ...)) . only available in event streams |
+ setupOID |
+ Setup OID |
+
+
+
+ | setupTriggerId |
+ Setup trigger Id |
+
+
+
+ | setupTriggerOID |
+ Setup trigger OID |
+
+
+
+ | setupTriggerType |
+ Setup trigger type |
+
+
+
+ | siteOID |
+ Site OID |
@@ -96848,9 +102201,10 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"setupTriggerType" : 1,
"setupTriggerOID" : "a setup trigger OID",
"setupTriggerId" : "a setup trigger id",
@@ -96859,34 +102213,36 @@ Generated events on method call
"mode" : 1,
"sourceDeviceURLs" : [ "some source device URLs" ],
"effects" : [ {
- "id" : "an id",
- "actionGroupOID" : "an action group OID",
- "localActionGroup" : {
- "creationTime" : 1769533841499,
- "lastUpdateTime" : 1769533841499,
- "label" : "a managed action group label",
- "metadata" : "some metadata",
- "shortcut" : true,
- "notificationTypeMask" : 1,
- "notificationCondition" : "ALWAYS",
- "notificationText" : "a notification text",
- "notificationTitle" : "a notification title",
- "targetEmailAddresses" : [ "some target email addresses" ],
- "targetPhoneNumbers" : [ "some target phone numbers" ],
- "targetPushSubscriptions" : [ "some target push subscriptions" ],
- "actions" : [ {
- "deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
- "commands" : [ {
- "type" : 1,
- "name" : "a command name",
- "parameters" : [ "some parameters" ],
- "sensitiveParametersIndexes" : [ 1 ],
- "authentication" : "an authentication",
- "delay" : 1,
- "lockLevel" : 13
- } ]
- } ],
- "oid" : "the managed action group UUID"
+ "actionGroupEffect" : {
+ "id" : "an id",
+ "actionGroupOID" : "an action group OID",
+ "localActionGroup" : {
+ "creationTime" : 1785201548769,
+ "lastUpdateTime" : 1785201548769,
+ "label" : "a managed action group label",
+ "metadata" : "some metadata",
+ "shortcut" : true,
+ "notificationTypeMask" : 1,
+ "notificationCondition" : "ALWAYS",
+ "notificationText" : "a notification text",
+ "notificationTitle" : "a notification title",
+ "targetEmailAddresses" : [ "some target email addresses" ],
+ "targetPhoneNumbers" : [ "some target phone numbers" ],
+ "targetPushSubscriptions" : [ "some target push subscriptions" ],
+ "actions" : [ {
+ "deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
+ "commands" : [ {
+ "type" : 1,
+ "name" : "a command name",
+ "parameters" : [ "some parameters" ],
+ "sensitiveParametersIndexes" : [ 1 ],
+ "authentication" : "an authentication",
+ "delay" : 1,
+ "lockLevel" : 13
+ } ]
+ } ],
+ "oid" : "the managed action group UUID"
+ }
}
} ],
"rootConditionBlock" : {
@@ -96921,7 +102277,7 @@ Generated events on method call
"stopDay" : 6
}
} ],
- "name" : "SetupTriggerCreatedEvent"
+ "type" : "SetupTriggerCreatedEvent"
} |
@@ -96954,6 +102310,11 @@ Generated events on method call
Setup trigger type |
+
+ | siteOID |
+ Site OID |
+
+
@@ -97803,7 +103164,7 @@ Generated events on method call
Update an existing setup trigger : see asset-specs for scheduling Intervals composition (exhaustive but non-functional example)
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -97984,19 +103345,21 @@ Generated events on method call
Generated events on method call
- GatewaySynchronizationStartedEvent
+ GatewaySynchronizationEndedEvent
| Description |
- A data synchronization sequence between the gateway and the server has started |
+ A data synchronization sequence between the gateway and the server has completed |
| JSON |
{
- "timestamp" : 2,
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
+ "setupOID" : "a setup OID",
"owningPartner" : "an owning partner",
"gatewayId" : "A gateway id (ex: 0101-1234-5678)",
- "name" : "GatewaySynchronizationStartedEvent"
+ "type" : "GatewaySynchronizationEndedEvent"
} |
@@ -98014,23 +103377,35 @@ Generated events on method call
Owning partner of the parent entity (gateway, setup group, ...)) . only available in event streams |
+
+ | setupOID |
+ Setup OID |
+
+
+
+ | siteOID |
+ Site OID |
+
+
- GatewaySynchronizationEndedEvent
+ GatewaySynchronizationStartedEvent
| Description |
- A data synchronization sequence between the gateway and the server has completed |
+ A data synchronization sequence between the gateway and the server has started |
| JSON |
{
- "timestamp" : 2,
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
+ "setupOID" : "a setup OID",
"owningPartner" : "an owning partner",
"gatewayId" : "A gateway id (ex: 0101-1234-5678)",
- "name" : "GatewaySynchronizationEndedEvent"
+ "type" : "GatewaySynchronizationStartedEvent"
} |
@@ -98048,6 +103423,16 @@ Generated events on method call
Owning partner of the parent entity (gateway, setup group, ...)) . only available in event streams |
+
+ | setupOID |
+ Setup OID |
+
+
+
+ | siteOID |
+ Site OID |
+
+
@@ -98061,9 +103446,10 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"setupTriggerType" : 1,
"setupTriggerOID" : "a setup trigger OID",
"setupTriggerId" : "a setup trigger id",
@@ -98072,34 +103458,36 @@ Generated events on method call
"mode" : 1,
"sourceDeviceURLs" : [ "some source device URLs" ],
"effects" : [ {
- "id" : "an id",
- "actionGroupOID" : "an action group OID",
- "localActionGroup" : {
- "creationTime" : 1769533841510,
- "lastUpdateTime" : 1769533841511,
- "label" : "a managed action group label",
- "metadata" : "some metadata",
- "shortcut" : true,
- "notificationTypeMask" : 1,
- "notificationCondition" : "ALWAYS",
- "notificationText" : "a notification text",
- "notificationTitle" : "a notification title",
- "targetEmailAddresses" : [ "some target email addresses" ],
- "targetPhoneNumbers" : [ "some target phone numbers" ],
- "targetPushSubscriptions" : [ "some target push subscriptions" ],
- "actions" : [ {
- "deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
- "commands" : [ {
- "type" : 1,
- "name" : "a command name",
- "parameters" : [ "some parameters" ],
- "sensitiveParametersIndexes" : [ 1 ],
- "authentication" : "an authentication",
- "delay" : 1,
- "lockLevel" : 13
- } ]
- } ],
- "oid" : "the managed action group UUID"
+ "actionGroupEffect" : {
+ "id" : "an id",
+ "actionGroupOID" : "an action group OID",
+ "localActionGroup" : {
+ "creationTime" : 1785201548778,
+ "lastUpdateTime" : 1785201548778,
+ "label" : "a managed action group label",
+ "metadata" : "some metadata",
+ "shortcut" : true,
+ "notificationTypeMask" : 1,
+ "notificationCondition" : "ALWAYS",
+ "notificationText" : "a notification text",
+ "notificationTitle" : "a notification title",
+ "targetEmailAddresses" : [ "some target email addresses" ],
+ "targetPhoneNumbers" : [ "some target phone numbers" ],
+ "targetPushSubscriptions" : [ "some target push subscriptions" ],
+ "actions" : [ {
+ "deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
+ "commands" : [ {
+ "type" : 1,
+ "name" : "a command name",
+ "parameters" : [ "some parameters" ],
+ "sensitiveParametersIndexes" : [ 1 ],
+ "authentication" : "an authentication",
+ "delay" : 1,
+ "lockLevel" : 13
+ } ]
+ } ],
+ "oid" : "the managed action group UUID"
+ }
}
} ],
"rootConditionBlock" : {
@@ -98134,7 +103522,7 @@ Generated events on method call
"stopDay" : 6
}
} ],
- "name" : "SetupTriggerUpdatedEvent"
+ "type" : "SetupTriggerUpdatedEvent"
} |
@@ -98167,6 +103555,11 @@ Generated events on method call
Setup trigger type |
+
+ | siteOID |
+ Site OID |
+
+
@@ -98900,7 +104293,7 @@ Generated events on method call
Test a setup trigger definition, executing its effects : see asset-specs for scheduling Intervals composition (exhaustive but non-functional example)
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -99107,7 +104500,7 @@ Generated events on method call
test a single discrete trigger effect
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -99923,7 +105316,7 @@ Generated events on method call
Get a setup trigger by type and OID
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -99995,8 +105388,8 @@ Generated events on method call
{
"ifThenSetupTrigger" : {
- "creationTime" : 1769503155415,
- "lastUpdateTime" : 1769503155432,
+ "creationTime" : 1785140822181,
+ "lastUpdateTime" : 1785140822203,
"label" : "an if then setup trigger label",
"serverSide" : true,
"mode" : 1,
@@ -100048,8 +105441,8 @@ Generated events on method call
"id" : "an id",
"actionGroupOID" : "an action group OID",
"localActionGroup" : {
- "creationTime" : 1769503155432,
- "lastUpdateTime" : 1769503155432,
+ "creationTime" : 1785140822203,
+ "lastUpdateTime" : 1785140822203,
"label" : "a managed action group label",
"metadata" : "some metadata",
"shortcut" : false,
@@ -100329,7 +105722,7 @@ Generated events on method call
Delete a setup trigger
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
|
@@ -100426,10 +105819,12 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
+ "setupOID" : "a setup OID",
"owningPartner" : "an owning partner",
"gatewayId" : "A gateway id (ex: 0101-1234-5678)",
- "name" : "GatewaySynchronizationEndedEvent"
+ "type" : "GatewaySynchronizationEndedEvent"
} |
@@ -100447,6 +105842,16 @@ Generated events on method call
Owning partner of the parent entity (gateway, setup group, ...)) . only available in event streams |
+
+ | setupOID |
+ Setup OID |
+
+
+
+ | siteOID |
+ Site OID |
+
+
@@ -100460,10 +105865,12 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
+ "setupOID" : "a setup OID",
"owningPartner" : "an owning partner",
"gatewayId" : "A gateway id (ex: 0101-1234-5678)",
- "name" : "GatewaySynchronizationStartedEvent"
+ "type" : "GatewaySynchronizationStartedEvent"
} |
@@ -100481,6 +105888,16 @@ Generated events on method call
Owning partner of the parent entity (gateway, setup group, ...)) . only available in event streams |
+
+ | setupOID |
+ Setup OID |
+
+
+
+ | siteOID |
+ Site OID |
+
+
@@ -100494,12 +105911,13 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"setupTriggerType" : 1,
"setupTriggerOID" : "a setup trigger OID",
- "name" : "SetupTriggerDeletedEvent"
+ "type" : "SetupTriggerDeletedEvent"
} |
@@ -100527,6 +105945,11 @@ Generated events on method call
Setup trigger type |
+
+ | siteOID |
+ Site OID |
+
+
@@ -100739,7 +106162,7 @@ Generated events on method call
Update a setup trigger activation mode
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -100860,21 +106283,23 @@ Generated events on method call
Generated events on method call
- SetupTriggerModeChangeFailedEvent
+ SetupTriggerModeChangedEvent
| Description |
- The scheduling mode of a setup trigger could not be changed |
+ The scheduling mode of a setup trigger has changed |
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"setupTriggerType" : 1,
"setupTriggerOID" : "a setup trigger OID",
- "name" : "SetupTriggerModeChangeFailedEvent"
+ "newMode" : 1,
+ "type" : "SetupTriggerModeChangedEvent"
} |
@@ -100902,26 +106327,31 @@ Generated events on method call
Setup trigger type |
+
+ | siteOID |
+ Site OID |
+
+
- SetupTriggerModeChangedEvent
+ SetupTriggerModeChangeFailedEvent
| Description |
- The scheduling mode of a setup trigger has changed |
+ The scheduling mode of a setup trigger could not be changed |
| JSON |
{
- "timestamp" : 2,
- "owningPartners" : [ "some owning partners" ],
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
"setupOID" : "a setup OID",
+ "owningPartners" : [ "some owning partners" ],
"setupTriggerType" : 1,
"setupTriggerOID" : "a setup trigger OID",
- "newMode" : 1,
- "name" : "SetupTriggerModeChangedEvent"
+ "type" : "SetupTriggerModeChangeFailedEvent"
} |
@@ -100949,6 +106379,11 @@ Generated events on method call
Setup trigger type |
+
+ | siteOID |
+ Site OID |
+
+
@@ -101161,7 +106596,7 @@ Generated events on method call
Get a setup trigger status
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -101490,7 +106925,7 @@ Generated events on method call
Get all setup triggers
Per-session rate-limit : 1 calls per 1d period for this particular operation (bulk-load)
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -101520,8 +106955,8 @@ Generated events on method call
[ {
"ifThenSetupTrigger" : {
- "creationTime" : 1769503155434,
- "lastUpdateTime" : 1769503155434,
+ "creationTime" : 1785140822206,
+ "lastUpdateTime" : 1785140822207,
"label" : "an if then setup trigger label",
"serverSide" : true,
"mode" : 1,
@@ -101573,8 +107008,8 @@ Generated events on method call
"id" : "an id",
"actionGroupOID" : "an action group OID",
"localActionGroup" : {
- "creationTime" : 1769503155434,
- "lastUpdateTime" : 1769503155434,
+ "creationTime" : 1785140822207,
+ "lastUpdateTime" : 1785140822207,
"label" : "a managed action group label",
"metadata" : "some metadata",
"shortcut" : false,
@@ -101707,7 +107142,7 @@ Generated events on method call
Get all setup triggers of a given type
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
|
@@ -101764,8 +107199,8 @@ Generated events on method call
[ {
"ifThenSetupTrigger" : {
- "creationTime" : 1769503155434,
- "lastUpdateTime" : 1769503155434,
+ "creationTime" : 1785140822206,
+ "lastUpdateTime" : 1785140822207,
"label" : "an if then setup trigger label",
"serverSide" : true,
"mode" : 1,
@@ -101817,8 +107252,8 @@ Generated events on method call
"id" : "an id",
"actionGroupOID" : "an action group OID",
"localActionGroup" : {
- "creationTime" : 1769503155434,
- "lastUpdateTime" : 1769503155434,
+ "creationTime" : 1785140822207,
+ "lastUpdateTime" : 1785140822207,
"label" : "a managed action group label",
"metadata" : "some metadata",
"shortcut" : false,
@@ -102098,7 +107533,7 @@ Generated events on method call
Get all setup triggers status
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
|
@@ -102412,7 +107847,7 @@ Generated events on method call
Get trigger status.
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -102545,7 +107980,7 @@ Generated events on method call
Update trigger status.
- Access scope : Full enduser API access (enduser/*)
+ Access scope : enduser/*
> Test operation
@@ -102629,12 +108064,14 @@ Generated events on method call
| JSON |
{
- "timestamp" : 2,
+ "eventTime" : 2,
+ "siteOID" : "a site OID",
+ "setupOID" : "a setup OID",
"owningPartner" : "an owning partner",
"gatewayId" : "A gateway id (ex: 0101-1234-5678)",
"functionType" : 1,
"enabled" : false,
- "name" : "GatewayFunctionChangedEvent"
+ "type" : "GatewayFunctionChangedEvent"
} |
@@ -102662,6 +108099,16 @@ Generated events on method call
Owning partner of the parent entity (gateway, setup group, ...)) . only available in event streams |
+
+ | setupOID |
+ Setup OID |
+
+
+
+ | siteOID |
+ Site OID |
+
+
@@ -103236,7 +108683,7 @@