Retrieve a list of historic values for the specified entity id/ids.
POST/history/entity/:entity
Retrieves a list of historic values for entities specified with the given id value. The entity type needs to support history tracking.
Request
Path Parameters
- application/json
Body
required
Responses
- 200
- 4XX
- 5XX
Returns 'EntityHistoryResult'
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- ]
Timestamp of first history entry
Timestamp of last history entry
data object[]required
List of requested entity ids and a list of historical values (for each entity)
The entity id
The list of historical entity values, one for each step, with 'valid_from' and 'valid_to' interval properties
{
"from": "2024-08-14T20:19:46.154Z",
"to": "2024-08-14T20:19:46.154Z",
"data": [
{
"id": 0,
"values": [
{}
]
}
]
}
The request failed because invalid request parameters or data were supplied or access was denied.
- application/json
- Schema
- Example (from schema)
Schema
The error code describing the general error category.
The HTTP status code.
The actual error message describing the error in more detail.
The request id for following up on specific errors.
{
"code": "API_INVALID_INPUT_DATA",
"status": 0,
"message": "string",
"reqid": "string"
}
The request failed because an error occurred during processing of the request.
- application/json
- Schema
- Example (from schema)
Schema
The error code describing the general error category.
The HTTP status code.
The actual error message describing the error in more detail.
The request id for following up on specific errors.
{
"code": "API_INVALID_INPUT_DATA",
"status": 0,
"message": "string",
"reqid": "string"
}