IoT Stadium

API Documentation

Telemetry Profile

Telemetry Profile - PUT Update Telemetry Profile Comparison

Updates comparison logic such as thresholds or condition values for an existing profile rule.

Put 
https://api.iotstadium.com/ext/telemetry-profile/:id
    {
      "key": "Content-Type",
      "value": "application/json"
    },
    {
      "key": "Authorization",
      "value": "Bearer {{token}}"
    }

Parameter

Field Type Description
unit String

Unit of your telemetry
conversion_properties Array

Contain the minimum and maximum value for you to convert
telemetry_profile_name String

The name for your telemetry profile
telemetry_profile_type_id Integer

ID for the telemetry profile

 
{
	"unit": "°K",
	"conversion_properties": [
	  {
		"label": "LOW",
  		"conditions": [
		{ "comparator": "<", "value": 10 }
		]
	},
	{
		"label": "HIGH",
		"conditions": [
      		{ "comparator": ">=", "value": 10 }
    	]
  	}
	]
	"telemetry_profile_name": "Kelvin Comparison",
	"telemetry_profile_type_id": 2
}                                            
{
    "message": "telemetry_profile updated",
    "data": {
        "id": 70
    },
    "code": 200
}
{
    "telemetry_profile_name": [
        "The telemetry profile name field is required."
    ],
    "telemetry_profile_type_id": [
        "The telemetry profile type id field is required."
    ],
    "conversion_properties": [
        "The conversion properties field is required."
    ],
    "unit": [
        "The unit field is required."
    ]
}