Get a Talq Device Function

Request

Path Params

deviceAddress

string

required

Device TALQ address

functionId

string

required

Device class' function id

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

Responses

🟢200OK

application/json

Returns the device's function

Body

array of:

id

string

required

The unique identifier of the function inside a device or a device class. Matches the 'functionId' field of the FunctionDesc within the DeviceClass declared for the device containing this function.

<= 50 characters

type

enum<string>

required

Reference to the function type. This attribute can be used to announce vendor specific extensions for the device.

Allowed values:

BasicFunctionGatewayFunctionCommunicationFunctionTimeFunctionSimpleActuatorFunctionGenericActuatorFunctionLampActuatorFunctionLampMonitorFunctionElectricalMeterFunctionPhotocellFunctionLightSensorFunctionBinarySensorFunctionGenericSensorFunctionTemperatureSensorFunctionHumiditySensorFunctionParticulateMatterSensorFunctionPresenceSensorFunctionMovementSensorFunctionLocationSensorFunctionAccelerometerFunctionOrientationFunctionBatteryLevelSensorFunctionFillingLevelSensorFunctionSolarBatteryChargerFunctionBatteryManagementSystemFunctionTrafficCounterFunctionFluidLevelSensorFunctionWasteContainerFunctionWeightSensorFunctionGasSensorFunctionSegmentMonitorFunctionNoiseMonitoringSensorFunctionAtmosphericSensorFunctionWindSensorFunctionPrecipitationSensorFunctionSkySensorFunctionGullySensorFunctionWaterFlowSensorFunctionWaterQualitySensorFunctionTextDisplayActuatorFunctionParkingSensorFunctionParkingCameraSensorFunctionLuminaireAssetFunctionDriverAssetFunctionControllerAssetFunctionCabinetConfigurationFunctionCabinetMonitorFunction

Example

[
    {
        "id": "string",
        "type": "BasicFunction"
    }
]

🟠400Bad Request

🟠403Forbidden

🟠404Record Not Found