Planon IoT : IoT Platform - Developer's Guide : Products Endpoints : Products/Post : Request – Products/Post – additionalProperty Properties
Request – Products/Post – additionalProperty Properties
Property
Type
Description
Mandatory
additionalProperties
Array
The additionalProperties property enables you to extend the IoT Platform schema model by adding your own properties for each Device type. For example, you can add a property named Firmware Version that specifies the version of the Device’s firmware.
additionalProperties are defined per Product. Once defined, they are available in the IoT Platform API and IoT Platform Portal. These properties can also be used as keywords, as described on page 499.
additionalProperties/ displayName
String
The name to appear in the IoT Platform Portal for this additional property.
additionalProperties/name
String
The internal logical name to be used for this property. This name must match the additional property’s name on the Device itself.
Y
additionalProperties/extra
String
A free-text description of the additional property.
additionalProperties/ dataType
String
The data type of this property. Valid values are –
• Number
• Text
• Boolean
Y
additionalProperties/ allowedValueRange
String
If the data type (dataType described above) 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.
additionalProperties/allowedValueRange/allowedValues
String
The unique identifier of this event value to be used for converting how this value appears in the IoT Platform Portal.
If the data type is String, then you can specify the following ‒
• Key ‒ A unique key is associated with each Value.
• Value ‒ The value of a Key.
• iconName ‒ For each value, you can specify the name of the icon to represent this value.
For example, this identifier could be used to convert the value 0 so that it appears as Closed in the IoT Platform Portal and the value 1 as Open.
additionalProperties/defaultValue
String
The default value of the additional property.
additionalProperties/unit
String
The default unit of the additional property value. For example, Fahrenheit or Centigrade.
additionalProperties/uiType
String
See commands/arguments/uiType.
Y
additionalProperties/required
Boolean
True ‒ If this additional property is mandatory.
Example JSON Products/Post Request
curl -X POST \
https://api.stg.axonize.com/odata/products/ \
-H ‘Authorization: Token’ \
-H ‘Content-Type: application/json’ \
-H ‘appId: 801A048A-9F23-429F-BF0D-B6D35B22771E’ \
-d ‘{
{“name”:”ExampleFridge”,
“manufacturer”:”TheFridgeMakingCompany”,
“tooltip”:[],
“customIdDisplay”:false,
“serialNumberDisplay”:false,
“displayDeviceSDKDetails”:false,
“events”:[{“nameResourceKey”:””,
“name”:”HowColdIsItRightNow”,”typeCode”:7,”defaultRollupMethod”:”Avg”,”precision”:1,”displayType”:null,
”valueRange”:{“allowedValues”:[],”ranges”:[]},”aggregatedEventSettings”:null}]} { }
‘