Planon IoT : IoT Platform - Developer's Guide : Rules Endpoints : Rules/Post : Request – Rules/Post – additionalPropertyProperties
Request – Rules/Post – additionalPropertyProperties
Property
Type
Description
Mandatory
actions/additionalPropertyProperties
Object
Specifies that the value of an additionalProperty of a specific Device is updated to the value specified below. These additional properties are assigned by the Product to which the Device belongs.
For example, if the Product defines a property called Color, then all Devices of that Product have that property. A Rule can specify that if the temperature of a specific Device goes over 80 degrees, then the value of the additionalProperty named Color is changed to Red.
actions/additionalPropertyProperties/name
String
Specifies the name of a property to be updated. This must be the name of one of the additionalProperties defined for the Product of the Device to which this Rule applies belongs.
actions/additionalPropertyProperties/value
String
Specifies the value to which to update the property with the name described above.
actions/additionalPropertyProperties/deviceId
String
Specifies that the unique identifier of the Device whose property (of the Product) is to be updated, as described above.
actions/additionalPropertyProperties/propertyOperation
Object
Specifies the action that will be used on the additional property’s value. This action’s value ia relative to the previous value of the additional property.
For example, if the rule triggered it will increase the property by two.