1.2.21 /api/v1/devicevars

Delivers the list of all variables a device defines

Supported HTTP methods: GET, HEAD, OPTIONS

GET /api/vi/devicevars/{mncName}/{deviceName}

Returns a DeviceVars document containing the requested list of variables. The backend evaluates the driver for the given device, compiled the device driver and gets the variable list from this. The returned DeviceVars document contains the Range definitions for all variables of the driver which may appear in a device preset. The messageId field in each Range object is set to the name of the variable.

The API call returns the variable list as it exists at compile time at system startup. Changes made dynamically to the list of variables or to some variable ranges are not contained in the list

Parameters:

Parameter Description
mncName The name of the M&C from which the variable list shall be loaded.
deviceName The name of the device for which the variable list shall be evaluated.

Return Codes:

Code Description
200 OK, returns a PresetVars document containing the requested variable list.
401 not logged in. In this case a ApiError document is returned, describing details of the error.
404 either no M&C with the given name exists, or at the known M&C there exists no device driver with the given name. In this case a ApiError document is returned, describing details of the error.