Logic Commands

39min

Scenes
AddExecutorCollectionDTO
Add a scene.
Field
Data type
Description
executorCollection
Object
An ExecutorCollection DTO object.
The ID of the ExecutorCollection object is assigned by the server after the internal object has been created. If an ID has already been set, this is not used in the created object!
Add ExecutorCollection with 3 executors 
Add empty ExecutorCollection 
{
  "commandId" : "OwnCommandId",
  "executorCollection" : {
    "name" : "Executor Room 1",
    "description" : "Light and Dimmer Room1 Executor",
    "executors" : [ {
      "type" : "VALUE",
      "position" : 0,
      "type" : "VALUE",
      "thingId" : "91905b50-bf83-4584-a14b-d4c2800cec1e",
      "channelId" : "Dimmer",
      "value" : {
        "type" : "RAW",
        "type" : "RAW",
        "value" : 100.0
      }
    }, {
      "type" : "DELAY",
      "position" : 1,
      "type" : "DELAY",
      "delay" : 3000
    }, {
      "type" : "STATE",
      "position" : 2,
      "type" : "STATE",
      "thingId" : "thingIdFud14_2",
      "channelId" : "Valve",
      "state" : "OPEN"
    } ]
  }
}
{
  "commandId" : "OwnCommandId",
  "executorCollection" : {
    "name" : "Executor Room 1",
    "description" : "Light and Dimmer Room1 Executor",
    "executors" : [ {
      "type" : "VALUE",
      "position" : 0,
      "type" : "VALUE",
      "thingId" : "91905b50-bf83-4584-a14b-d4c2800cec1e",
      "channelId" : "Dimmer",
      "value" : {
        "type" : "RAW",
        "type" : "RAW",
        "value" : 100.0
      }
    }, {
      "type" : "DELAY",
      "position" : 1,
      "type" : "DELAY",
      "delay" : 3000
    }, {
      "type" : "STATE",
      "position" : 2,
      "type" : "STATE",
      "thingId" : "thingIdFud14_2",
      "channelId" : "Valve",
      "state" : "OPEN"
    } ]
  }
}
﻿
CreateExecutorThingDTO
Create a virtual device that can be used to control and display the connected scenes.
Field
Data type
Description
id
String
ID of the ExecutorCollection for which a virtual device is to be created.
name
String
The name of the device to be created.
Several virtual devices can be created for a scene.JSON Example
CreateExecutorThingDTO
{
  "commandId" : "OwnCommandId",
  "id" : "9ece616d-ffbb-432b-bfd7-4362a38f435a",
  "name" : "ExecutorThing 2"
}
{
  "commandId" : "OwnCommandId",
  "id" : "9ece616d-ffbb-432b-bfd7-4362a38f435a",
  "name" : "ExecutorThing 2"
}
﻿
DeleteExecutorCollectionDTO
Delete a scene.
Field
Data type
Description
id
String
ID of the ExecutorCollection to be deleted.
DeleteExecutorCollectionDTO
{
  "commandId" : "OwnCommandId",
  "id" : "9ece616d-ffbb-432b-bfd7-4362a38f435a"
}
{
  "commandId" : "OwnCommandId",
  "id" : "9ece616d-ffbb-432b-bfd7-4362a38f435a"
}
﻿
ExecuteExecutorCollectionDTO
Execute an existing scene once.
Field
Data type
Description
id
String
The ID of an existing scene.
ExecuteExecutorCollectionDTO
{
  "commandId" : "OwnCommandId",
  "id" : "9ece616d-ffbb-432b-bfd7-4362a38f435a"
}
{
  "commandId" : "OwnCommandId",
  "id" : "9ece616d-ffbb-432b-bfd7-4362a38f435a"
}
﻿
ExecuteExecutorCollectionObjectDTO
Execute an existing or temporary scene once.
Field
Data type
Description
executorCollection
Object
An ExecutorCollection DTO object that is to be executed.
The ExecutorCollection DTO object for the "executorCollection" field does not need to be added to the system beforehand. It is executed once and is not saved.
ExecuteExecutorCollectionObjectDTO
ExecuteExecutorCollectionObjectDTO Example 2
{
  "commandId" : "OwnCommandId",
  "executorCollection" : {
    "id" : "76dd6b1f-3f6a-4c02-b6d7-3539cd03201c",
    "name" : "TestExecutor",
    "description" : "",
    "executors" : [ {
      "position" : 0,
      "type" : "VALUE",
      "thingId" : "91905b50-bf83-4584-a14b-d4c2800cec1e",
      "channelId" : "Dimmer",
      "value" : {
        "type" : "RAW",
        "value" : 100.0
      }
    }, {
      "position" : 1,
      "type" : "DELAY",
      "delay" : 5000
    }, {
      "position" : 2,
      "type" : "VALUE",
      "thingId" : "f5a69feb-59f0-4a44-a243-d2420c84f562",
      "channelId" : "Dimmer",
      "value" : {
        "type" : "LINK",
        "foreignThingId" : "91905b50-bf83-4584-a14b-d4c2800cec1e",
        "foreignChannelId" : "Dimmer"
      }
    }, {
      "position" : 3,
      "type" : "DELAY",
      "delay" : 5000
    }, {
      "position" : 4,
      "type" : "VALUE",
      "thingId" : "f5a69feb-59f0-4a44-a243-d2420c84f562",
      "channelId" : "Dimmer",
      "value" : {
        "type" : "CALCULATED",
        "expression" : "a+b",
        "values" : {
          "a" : {
            "type" : "RAW",
            "value" : 5.0
          },
          "b" : {
            "type" : "RAW",
            "value" : 5.0
          }
        }
      }
    } ]
  }
}
{
  "commandId" : "OwnCommandId",
  "executorCollection" : {
    "id" : "76dd6b1f-3f6a-4c02-b6d7-3539cd03201c",
    "name" : "TestExecutor",
    "description" : "",
    "executors" : [ {
      "position" : 0,
      "type" : "VALUE",
      "thingId" : "91905b50-bf83-4584-a14b-d4c2800cec1e",
      "channelId" : "Dimmer",
      "value" : {
        "type" : "RAW",
        "value" : 100.0
      }
    }, {
      "position" : 1,
      "type" : "DELAY",
      "delay" : 5000
    }, {
      "position" : 2,
      "type" : "VALUE",
      "thingId" : "f5a69feb-59f0-4a44-a243-d2420c84f562",
      "channelId" : "Dimmer",
      "value" : {
        "type" : "LINK",
        "foreignThingId" : "91905b50-bf83-4584-a14b-d4c2800cec1e",
        "foreignChannelId" : "Dimmer"
      }
    }, {
      "position" : 3,
      "type" : "DELAY",
      "delay" : 5000
    }, {
      "position" : 4,
      "type" : "VALUE",
      "thingId" : "f5a69feb-59f0-4a44-a243-d2420c84f562",
      "channelId" : "Dimmer",
      "value" : {
        "type" : "CALCULATED",
        "expression" : "a+b",
        "values" : {
          "a" : {
            "type" : "RAW",
            "value" : 5.0
          },
          "b" : {
            "type" : "RAW",
            "value" : 5.0
          }
        }
      }
    } ]
  }
}
﻿
GetRunningExecutorCollectionsDTO
Retrieves all currently executed scenes.
Field
Data type
Description
searchString
String
Optional field for filtering the scenes. The name and description are searched. If the field does not exist or is empty, no filter is applied.
GetRunningExecutorCollectionsDTO 1
GetRunningExecutorCollectionsDTO 2
{
  "commandId" : "OwnCommandId"
}
{
  "commandId" : "OwnCommandId"
}
﻿
RunningExecutorCollectionsDTO
Sent as a return to the command request.
Field
Data type
Description
runningExecutorCollections
Array
An array of currently executed ExecutorCollectionDTOs.
RunningExecutorCollectionsDTO
[
  {
    "id": "6e092f8b-a897-460e-af40-d065a5a8d06d",
    "name": "ExecutorTEst",
    "description": "",
    "executors": [
      {
        "type": "VALUE",
        "position": 0,
        "thingId": "f5a69feb-59f0-4a44-a243-d2420c84f562",
        "channelId": "Dimmer",
        "value": {
          "type": "RAW",
          "value": 77
        }
      },
      {
        "type": "DELAY",
        "position": 1,
        "delay": 5000
      },
      {
        "type": "VALUE",
        "position": 2,
        "thingId": "f5a69feb-59f0-4a44-a243-d2420c84f562",
        "channelId": "Dimmer",
        "value": {
          "type": "LINK",
          "foreignThingId": "91905b50-bf83-4584-a14b-d4c2800cec1e",
          "foreignChannelId": "Dimmer"
        }
      }
    ]
  },
  {
    "id": "b8563612-6676-4e87-97f6-ac9fc80b8ecb",
    "name": "Executor1",
    "description": "",
    "executors": [
      {
        "type": "RANDOM",
        "position": 0,
        "thingId": "91905b50-bf83-4584-a14b-d4c2800cec1e",
        "channelId": "Dimmer"
      },
      {
        "type": "DELAY",
        "position": 1,
        "delay": 50000
      }
    ]
  }
]
[
  {
    "id": "6e092f8b-a897-460e-af40-d065a5a8d06d",
    "name": "ExecutorTEst",
    "description": "",
    "executors": [
      {
        "type": "VALUE",
        "position": 0,
        "thingId": "f5a69feb-59f0-4a44-a243-d2420c84f562",
        "channelId": "Dimmer",
        "value": {
          "type": "RAW",
          "value": 77
        }
      },
      {
        "type": "DELAY",
        "position": 1,
        "delay": 5000
      },
      {
        "type": "VALUE",
        "position": 2,
        "thingId": "f5a69feb-59f0-4a44-a243-d2420c84f562",
        "channelId": "Dimmer",
        "value": {
          "type": "LINK",
          "foreignThingId": "91905b50-bf83-4584-a14b-d4c2800cec1e",
          "foreignChannelId": "Dimmer"
        }
      }
    ]
  },
  {
    "id": "b8563612-6676-4e87-97f6-ac9fc80b8ecb",
    "name": "Executor1",
    "description": "",
    "executors": [
      {
        "type": "RANDOM",
        "position": 0,
        "thingId": "91905b50-bf83-4584-a14b-d4c2800cec1e",
        "channelId": "Dimmer"
      },
      {
        "type": "DELAY",
        "position": 1,
        "delay": 50000
      }
    ]
  }
]
﻿
StopExecutorCollectionDTO
Stops the execution of a scene.
Field
Data type
Description
id
String
ID of the ExecutorCollection to be stopped.
StopExecutorCollectionDTO
{
  "commandId" : "OwnCommandId",
  "id" : "9ece616d-ffbb-432b-bfd7-4362a38f435a"
}
{
  "commandId" : "OwnCommandId",
  "id" : "9ece616d-ffbb-432b-bfd7-4362a38f435a"
}
﻿
UpdateExecutorCollectionDTO
Change a scene.
Field
Data type
Description
ExecutorCollection
Object
An ExecutorCollection DTO object. The ID must be set correctly.
UpdateExecutorCollectionDTO
{
  "commandId" : "OwnCommandId",
  "executorCollection" : {
    "id" : "76dd6b1f-3f6a-4c02-b6d7-3539cd03201c",
    "name" : "New Name",
    "description" : "new Description",
    "executors" : [ {
      "type" : "STATE",
      "position" : 0,
      "thingId" : "thingIdFud14_2",
      "channelId" : "Valve",
      "state" : "CLOSE"
    }, {
      "type" : "DELAY",
      "position" : 1,
      "delay" : 5000
    }, {
      "type" : "STATE",
      "position" : 2,
      "thingId" : "thingIdFud14_2",
      "channelId" : "Valve",
      "state" : "OPEN"
    } ]
  }
}

{
  "commandId" : "OwnCommandId",
  "executorCollection" : {
    "id" : "76dd6b1f-3f6a-4c02-b6d7-3539cd03201c",
    "name" : "New Name",
    "description" : "new Description",
    "executors" : [ {
      "type" : "STATE",
      "position" : 0,
      "thingId" : "thingIdFud14_2",
      "channelId" : "Valve",
      "state" : "CLOSE"
    }, {
      "type" : "DELAY",
      "position" : 1,
      "delay" : 5000
    }, {
      "type" : "STATE",
      "position" : 2,
      "thingId" : "thingIdFud14_2",
      "channelId" : "Valve",
      "state" : "OPEN"
    } ]
  }
}
﻿
RefreshExecutorCollectionsDTO
The data of the specified scenes is resent.
Field
Data type
Description
ExecutorCollectionIds
Array
A list of ExecutorCollection IDs that are to be updated. If the field does not exist or is empty, all ExecutorCollections are updated.
RefreshExecutorCollectionsDTO 1
RefreshExecutorCollectionsDTO 2
{
  "commandId" : "OwnCommandId",
  "executorCollectionIds" : [ "252afd4a-56d6-470d-ae87-cf0433eb15a5", "971c0c85-8f5d-45b6-894a-b8026f09d6ca" ]
}
{
  "commandId" : "OwnCommandId",
  "executorCollectionIds" : [ "252afd4a-56d6-470d-ae87-cf0433eb15a5", "971c0c85-8f5d-45b6-894a-b8026f09d6ca" ]
}
﻿
Rules
AddConditionCollectionDTO
Add a rule.
Field
Data type
Description
conditionCollection
Object
A ConditionCollection DTO object. 
The ID of the ConditionCollection object is assigned by the server after the internal object has been created. If an ID has already been set, this is not used in the created object!
Add ConditionCollection with 2 conditions
Add empty ConditionCollection
{
  "commandId" : "OwnCommandId"
}
{
  "commandId" : "OwnCommandId"
}
﻿
DeleteConditionCollectionDTO
Delete a rule.
Field
Data type
Description
id
String
ID of the ConditionCollection
DeleteConditionCollectionDTO
{
  "commandId" : "OwnCommandId",
  "id" : "7c6ba18c-d4ee-4254-91aa-9989bf581f68"
}
{
  "commandId" : "OwnCommandId",
  "id" : "7c6ba18c-d4ee-4254-91aa-9989bf581f68"
}
﻿
UpdateConditionCollectionDTO
Change a rule.
Dield
Data type
Description
conditionCollection
Object
A ConditionCollection DTO object. The ID must be set correctly  
UpdateConditionCollectionDTO
{
  "commandId" : "OwnCommandId",
  "conditionCollection" : {
    "type" : "COLLECTION",
    "position" : 0,
    "id" : "7c6ba18c-d4ee-4254-91aa-9989bf581f68",
    "name" : "Conditon1",
    "description" : "Controls Dimmer Bathroom",
    "conditions" : [ {
      "type" : "STATE",
      "position" : 0,
      "comparator" : "EQUAL",
      "thingId" : "d5da720e-2ad6-4c86-88c0-f84390f76570",
      "channelId" : "WindowHandle",
      "smartCheck" : false,
      "state" : "CLOSED"
    }, {
      "type" : "OPERATOR",
      "position" : 1,
      "comparator" : "OR"
    }, {
      "type" : "VALUE",
      "position" : 2,
      "comparator" : "GREATER",
      "thingId" : "f5a69feb-59f0-4a44-a243-d2420c84f562",
      "channelId" : "Dimmer",
      "smartCheck" : false,
      "value" : 45.0
    } ]
  }
}
{
  "commandId" : "OwnCommandId",
  "conditionCollection" : {
    "type" : "COLLECTION",
    "position" : 0,
    "id" : "7c6ba18c-d4ee-4254-91aa-9989bf581f68",
    "name" : "Conditon1",
    "description" : "Controls Dimmer Bathroom",
    "conditions" : [ {
      "type" : "STATE",
      "position" : 0,
      "comparator" : "EQUAL",
      "thingId" : "d5da720e-2ad6-4c86-88c0-f84390f76570",
      "channelId" : "WindowHandle",
      "smartCheck" : false,
      "state" : "CLOSED"
    }, {
      "type" : "OPERATOR",
      "position" : 1,
      "comparator" : "OR"
    }, {
      "type" : "VALUE",
      "position" : 2,
      "comparator" : "GREATER",
      "thingId" : "f5a69feb-59f0-4a44-a243-d2420c84f562",
      "channelId" : "Dimmer",
      "smartCheck" : false,
      "value" : 45.0
    } ]
  }
}
﻿
RefreshConditionCollectionsDTO
The data of the specified rules is sent again.
Field
Data type
Description
conditionCollectionIds
Array
A list of ConditionCollection IDs that are to be updated. If the field does not exist or is empty, all ConditionCollections are updated.
RefreshConditionCollectionsDTO 1
RefreshConditionCollectionsDTO 2
{
  "commandId" : "OwnCommandId",
  "conditionCollectionIds" : [ "0809bb46-4ce7-42a3-8c78-04cb7d24a30e", "e37b6aee-2e35-4b64-82a5-8dd7a822e861" ]
}
{
  "commandId" : "OwnCommandId",
  "conditionCollectionIds" : [ "0809bb46-4ce7-42a3-8c78-04cb7d24a30e", "e37b6aee-2e35-4b64-82a5-8dd7a822e861" ]
}
﻿
Connections
AddConnectionDTO
Add a connection.
Field
Data type
Description
connection
Object
A Connection DTO object.
The ID of the Connection object is assigned by the server after the internal object has been created. If an ID has already been set, this is not used in the created object!
Add Connection
Add empty Connection
{
  "commandId" : "OwnCommandId"
}
{
  "commandId" : "OwnCommandId"
}
﻿
DeleteConnectionDTO
Delete a connection.
Field
Data type
Description
id
String
ID of the Connection to be deleted.
DeleteConnectionDTO
{
  "commandId" : "OwnCommandId",
  "id" : "1ff100d2-d3ab-484f-b36f-1e84c6a7a4db"
}
{
  "commandId" : "OwnCommandId",
  "id" : "1ff100d2-d3ab-484f-b36f-1e84c6a7a4db"
}
﻿
SetConnectionEnabledDTO
Activates or deactivates a connection without deleting it.
Field
Data type
Description
id
String
ID of the Connection.
enabled
Boolean
Flag whether the link should be active or not.
SetConnectionEnabledDTO
{
  "commandId" : "OwnCommandId",
  "id" : "1ff100d2-d3ab-484f-b36f-1e84c6a7a4db",
  "enabled" : true
}
{
  "commandId" : "OwnCommandId",
  "id" : "1ff100d2-d3ab-484f-b36f-1e84c6a7a4db",
  "enabled" : true
}
﻿
UpdateConnectionDTO
Update a connection.
Field
Data type
Description
connection
Object
A Connection DTO object. The ID must be set correctly.
UpdateConnectionDTO
{
  "commandId" : "OwnCommandId",
  "connection" : {
    "id" : "2d46cc1b-5780-4d4e-b5de-293ec346d6b7",
    "active" : false,
    "conditionCollectionId" : "0809bb46-4ce7-42a3-8c78-04cb7d24a30e",
    "executorCollectionId" : "971c0c85-8f5d-45b6-894a-b8026f09d6ca",
    "name" : "Connection 1",
    "description" : "Connects cond1 and exec1"
  }
}
{
  "commandId" : "OwnCommandId",
  "connection" : {
    "id" : "2d46cc1b-5780-4d4e-b5de-293ec346d6b7",
    "active" : false,
    "conditionCollectionId" : "0809bb46-4ce7-42a3-8c78-04cb7d24a30e",
    "executorCollectionId" : "971c0c85-8f5d-45b6-894a-b8026f09d6ca",
    "name" : "Connection 1",
    "description" : "Connects cond1 and exec1"
  }
}
﻿
RefreshConnectionsDTO
The data of the specified connections is resent.
Field
Data type
Description
connectionIds
Array
A list of Connection IDs that are to be updated. If the field does not exist or is empty, all Connections are updated.
RefreshConnectionsDTO1
RefreshConnectionsDTO 2
{
  "commandId" : "OwnCommandId"
}
{
  "commandId" : "OwnCommandId"
}
﻿
Timer commands
CreateTimerDTO
Create a new timer with the desired name.
Field
Data type
Description
name
String
The name of the new timer.
CreateTimerDTO
{
  "commandId" : "OwnCommandId",
  "name" : "Azure timer"
}
{
  "commandId" : "OwnCommandId",
  "name" : "Azure timer"
}
﻿
UpdateTimerDTO
Change timer settings.
Field
Data type
Description
timer
Object
A SimpleIoTCoreTimer DTO object. The ID must be set correctly.
Only the timer-specific fields as described in SimpleIoTCoreTimerDTO﻿ are supported. The "channels" and "parameters" field is not evaluated!
UpdateTimerDTO
{
  "commandId" : "OwnCommandId",
  "timer" : {
    "id" : "7c6ba18c-d4ee-4254-91aa-9989bf581f68",
    "type" : "TIMER",
    "enabled" : true,
    "visible" : true,
    "time" : 0,
    "offset" : 0,
    "period" : 15,
    "selectedDays" : [ "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY" ]
  }
}
{
  "commandId" : "OwnCommandId",
  "timer" : {
    "id" : "7c6ba18c-d4ee-4254-91aa-9989bf581f68",
    "type" : "TIMER",
    "enabled" : true,
    "visible" : true,
    "time" : 0,
    "offset" : 0,
    "period" : 15,
    "selectedDays" : [ "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY" ]
  }
}
﻿
SetTimerEnabledDTO
Activate/deactivate timer.
Field
Data type
Description
id
String
The unique timer ID.
enabled
Boolean
Flag whether the timer is enabled or not.
SetTimerEnabledDTO
{
  "commandId" : "OwnCommandId",
  "id" : "7c6ba18c-d4ee-4254-91aa-9989bf581f68",
  "enabled" : false
}
{
  "commandId" : "OwnCommandId",
  "id" : "7c6ba18c-d4ee-4254-91aa-9989bf581f68",
  "enabled" : false
}
﻿
﻿

Field	Data type	Description
executorCollection	Object	An ExecutorCollection DTO object.

Field	Data type	Description
id	String	ID of the ExecutorCollection for which a virtual device is to be created.
name	String	The name of the device to be created.

Field	Data type	Description
id	String	ID of the ExecutorCollection to be deleted.

Field	Data type	Description
id	String	The ID of an existing scene.

Field	Data type	Description
executorCollection	Object	An ExecutorCollection DTO object that is to be executed.

Field	Data type	Description
searchString	String	Optional field for filtering the scenes. The name and description are searched. If the field does not exist or is empty, no filter is applied.

Field	Data type	Description
runningExecutorCollections	Array	An array of currently executed ExecutorCollectionDTOs.

Field	Data type	Description
id	String	ID of the ExecutorCollection to be stopped.

Field	Data type	Description
ExecutorCollection	Object	An ExecutorCollection DTO object. The ID must be set correctly.

Field	Data type	Description
ExecutorCollectionIds	Array	A list of ExecutorCollection IDs that are to be updated. If the field does not exist or is empty, all ExecutorCollections are updated.

Field	Data type	Description
conditionCollection	Object	A ConditionCollection DTO object.

Field	Data type	Description
id	String	ID of the ConditionCollection

Dield	Data type	Description
conditionCollection	Object	A ConditionCollection DTO object. The ID must be set correctly

Field	Data type	Description
conditionCollectionIds	Array	A list of ConditionCollection IDs that are to be updated. If the field does not exist or is empty, all ConditionCollections are updated.

Field	Data type	Description
connection	Object	A Connection DTO object.

Field	Data type	Description
id	String	ID of the Connection to be deleted.

Field	Data type	Description
id	String	ID of the Connection.
enabled	Boolean	Flag whether the link should be active or not.

Field	Data type	Description
connection	Object	A Connection DTO object. The ID must be set correctly.

Field	Data type	Description
connectionIds	Array	A list of Connection IDs that are to be updated. If the field does not exist or is empty, all Connections are updated.

Field	Data type	Description
name	String	The name of the new timer.

Field	Data type	Description
timer	Object	A SimpleIoTCoreTimer DTO object. The ID must be set correctly.

Field	Data type	Description
id	String	The unique timer ID.
enabled	Boolean	Flag whether the timer is enabled or not.

Updated 25 Mar 2024

Did this page help you?

Thing Commands

Template Commands