Planon IoT : IoT Platform - Developer's Guide : Products Endpoints : Products/Post : Request – Products/Post – valueRange Properties
Request – Products/Post – valueRange Properties
The severity of the event, which can be one of the following values
• Warning
• Minor
• Major
• Critical
Property
Type
Description
Mandatory
events/valueRange
Object
If the data type is Number, then you can enter a minimum and maximum value, as well as set a Step for this value. For example, if the Minimum is 10, the Maximum is 20 and this Step is 2, then the following values can be entered ‒ 10, 12, 14, 16, 18, 20.
events/valueRange/allowedValues
Array of AdditionalProperties
Describes the allowed values for incoming event data.
events/valueRange/allowedValues/iconName
String
The name of the icon to represent this event value in the IoT Platform Portal.
events/valueRange/allowedValues/iconColor
String
The color of the icon to represent this event in the IoT Platform Portal.
events/valueRange/allowedValues/severity
String/ Enum
events/valueRange/allowedValues/key
String
Specifies the key of a property.
events/valueRange/allowedValues/value
String
Specifies the value of a property.
events/valueRange/minimum
String
Specifies the minimum value for the event.
events/valueRange/maximum
String
Specifies the maximum value for the event.
events/valueRange/precision
Integer
Specifies the number of decimal points to display.
events/valueRange/numericType
String/ Enum
Specifies the numeric type of the event, which can be one of the following values –
• INT
• Decimal
events/valueRange/step
String
A numeric value specifying the gaps between allowed values in the same event.
events/valueRange/ranges
Array of Range Objects
Ranges is an array of range objects. Each ranges property represents an IoT Platform Product object property to be modified in order to affect its functionality.
For example, if a value is between 1–5, then it is represented by a specific iconName, iconColor and severity, and if it is between 6–10, it is represented by a different ranges object.
events/valueRange/ranges/minimum
Integer
The minimum for the range.
events/valueRange/ranges/maximum
Integer
The maximum for the range.
events/valueRange/ranges/iconName
String
The name of the icon to represent this event value in the IoT Platform Portal.
events/valueRange/ranges/iconColor
String
The color of the icon to represent this event in the IoT Platform Portal.
events/valueRange/ranges/severity
String
The severity of the event.