API Reference

Get device supported behaviors

Gets a list of the behaviors available to a device.

A behavior is composed of a name identifier and an optional list of parameters.
Each parameter contains:

  • name: This is the unique name of the parameter, and should be used as the key for sending a specific parameter value.
  • type: The data of the parameter, like number, string, date, etc. This indicates what data type is supported as the value of the parameter when sending a behavior.

Additionally, the parameter definition might include information about the range and other constraints for the supported values.

The example below, shows the definition of a behavior that adjusts the reporting frequency of a device:

{
  "name": "REPORT_FREQ",
  "description": "Change Reporting Frequency",
  "parameters": [
    {
      "name": "frequency",
      "type": "number",
      "min": 5,
      "max": 60
    }
  ]
}
Language
Authorization
OAuth2
URL
Click Try It! to start a request and see the response here!