Planon IoT : Axonize (stand-alone) : Rules Endpoints : Rules/Post : Request – Rules/Post – commandProperties
Request – Rules/Post – commandProperties
Property
Type
Description
Mandatory
actions/commandProperties
Object
These are the actions properties to be filled out in order to send a command to a Device that activates operations on the Device.
“CommandProperties” : {
“commandId” : “54456c3e711206b0f932e4”,
“message” : null,
“commandArgument” : “{“name”:”Off”}”,
“deviceIds” : [
“5859b04442231f0111366a6a1”
]
}
actions/commandProperties/commandId
String
The identifier of the command to be sent to the device. Commands are defined in the Products/Post response.
actions/commandProperties/message
String
Free text that represents the method to be executed on the Device.
The Device software or the IoT Platform SDK on the Device must be listening for this command in order to execute it when it is received.
actions/commandProperties/commandArgument
String
The argument to be used in the command.
actions/commandProperties/deviceIds
Array of Strings
A list of the Devices on which to activate the command. deviceId is returned by the Devices/Post or Devices/Get endpoint.
actions/commandProperties/shouldExecuteOnTriggeringDevice
Boolean
When set to True, executes the command on all explicitly specified Device(s), as well as on the actual Device that triggered the Rule. The actually triggering Device does not need to be one of the Devices that you explicitly specify.
For example, let’s say that you have a Rule that applies to all refrigerators, which is to be triggered whenever the temperature of one of the refrigerators in the group exceeds 20°. This means that you do not need to create a comparable rule for each refrigerator individually. In this case, whenever the temperature of one of the refrigerators in the group exceeds 20° degrees, the command is executed on that device.
actions/commandProperties/value
String
The value to be used in the command.