Create a Talq Device

Create a list of devices

Request

Body Params application/json

array of:

address

string

required

Device TALQ address

name

string

required

Name of the device

<= 50 characters

class

string

required

The device class name

functions

array[object (TalqFunctionDto) {2}]

optional

The individual function models containing the data relating to this device. Each individual function must have a corresponding FunctionDesc at the DeviceClass referred by the 'class ' property.

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

[
    {
        "address": "string",
        "name": "string",
        "class": "string",
        "functions": [
            {
                "id": "string",
                "type": "BasicFunction"
            }
        ]
    }
]

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢201Created

application/json

The devices were successfully created.

Body

array of:

address

string

required

Device TALQ address

name

string

required

Name of the device

<= 50 characters

class

string

required

The device class name

functions

array[object (TalqFunctionDto) {2}]

optional

The individual function models containing the data relating to this device. Each individual function must have a corresponding FunctionDesc at the DeviceClass referred by the 'class ' property.

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:

Example

[
    {
        "address": "string",
        "name": "string",
        "class": "string",
        "functions": [
            {
                "id": "string",
                "type": "BasicFunction"
            }
        ]
    }
]

🟠400Bad Request

🟠404Record Not Found

🟠409409

🟠422Parameter Error