Planon IoT : Axonize (stand-alone) : Products Endpoints : Products/Post : Request – Products/Post – serviceProperty Properties
Request – Products/Post – serviceProperty Properties
Property
Type
Description
Mandatory
commands/arguments/serviceProperty
Array
Defines an array of one or more properties of this Command’s argument contained within the serviceproperty property (described below).
commands/arguments/serviceProperty/displayName
String
The free-text name to be displayed for this argument in the IoT Platform Portal.
To use the command in the UI
commands/arguments/serviceProperty/name
String
The name of this property of the argument.
To use the command in the UI
commands/arguments/serviceProperty/dataType
String
The data type of this property of the argument. Valid values are –
Text
Integer
Decimal
Date
Boolean
Gps
To use the command in the UI
commands/arguments/serviceProperty/allowedValueRange
String
The values allowed to be entered for this argument. You can enter one or more sets of allowed value ranges as described below.
If the data type (dataType described above) of the argument property 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.
commands/arguments/serviceProperty/isUnique
Boolean
When enabled, it indicates that this property is unique for the application level. When this setting is enabled for a property, the IoT Platform API validats on property creation or update to ensure that they are infact unique.
commands/arguments/serviceProperty/required
String
This is the unique identifier of this event for translating the event name property (described above). For example, this unique identifier could be used by IoT Platform ’s localization service to translate the name property Temperature into French Température.