BPAPI Methods

BPAPI method Property/History


Shows historical values for property identified by {id}

Authorization required: Yes

HTTP methods allowed: GET

Syntax: Property/{id}/History/  Details 

Syntax: Property/{id}/History/{limit}/{no_filter}/  Details 

Syntax: Property/{id}/History/{limit}/  Details   Details   Details   Details 

Shows historical values for property identified by {id}
{id} is usually found as the current property for a Device for instance.
The actual {id} does not necessarily have to be that of the last "current" property. The id of any old no-longer-current property may also be used.

The optional parameter {limit} may be used to narrow the result. {limit} may be set to:
A) A maximum count of history records returned like '42' or
B) A relative time interval like '5min', '7hours' or similar (only newer records will be returned) or
C) An absolute point-in-time like '2014-08-01 10:00' (only newer records will be returned. Note that _COLON_ must be used instead of ':' if HTTP GET syntax 1 is used

The optional parameter {no_filter} may be set to 'True' if absolutely all records are desired.
This is applicable for 'notification'-properties for which notifications deactivated by the customer himself / herself are usually not shown.
In other words {no_filter} is useful when you want to see the customer's notification-history, even messages that has been deleted from a corresponding app.

Note that if Property/SetNoLongerCurrent has been called earlier with credentials corresponding to the CustomerId1 of a property with Name 'notification', that property will not be included.

See also Device/Aggregation, Customer/History, Gateway/History and Device/History

Unit-tests: 6 test(s)

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

Documentation and tests automatically generated from source-code 2020-04-05 01:17