BPAPI Methods

BPAPI method Device/Refresh

Device/Refresh

Updates the BPAPI database with current device-information from the Gateway for Device identified by {id} (fetches updated data from gateway)

Authorization required: Yes

HTTP methods allowed: GET

Syntax: Device/{id}/Refresh/  Details 

Syntax: Device/{id}/Refresh/{quick}/  Details 

Updates the BPAPI database with current device-information from the Gateway for Device identified by {id} (fetches updated data from gateway)

In principle the database should be automatically updated through the BPAPI Listener mechanism.
Use this method if there are indications that the database has not been properly updated.
Note that updating values through this call will bypass the BPAPI Listener's filtering mechanism against improbable values. No aggregations will be calculated either.



{id} may be any of node_id, user_defined_name, user_defined_group_name and bpapi_device_id
See Device for more information about what kind of id's that can be used

Note: This call may take a while to execute (especially if {id} refers to multiple devices). It is mostly designated for internal use when new devices are discovered (DeviceAdded-events)

The optional parameter {quick} may be set to TRUE or COMMON in order to refresh only properties most commonly needed to be updated on the server.
The optional parameter {quick} may be set to UNCOMMON in order to refresh properties NOT commonly needed to be updated on the server.
The optional parameter {quick} may be set to ALL or left empty in order to refresh ALL properties updated on the server.
For Sikom gateways this typically entails sending only ordinary S-requests for known devices.

See also -Property/{id}/Refresh- which may be used to refresh a single existing property.

See also Gateway/Refresh which is used for discovering devices at gateway.
Gateway/Refresh (and not Device/Refresh) is necessary to use if the properties 'Vendor' and 'vendor_type' is not known for a device.
The documentation for -Property/{id}/Refresh- does also contain more information about how properties are returned by the gateway and updated in the database


Unit-tests: 2 test(s)

Popularity: 486108 (number of times method has been accessed)

Documentation and tests automatically generated from source-code 2020-04-09 21:17