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

entity stringrequired

application/json

Body

required

id integer
ids integer[]

Responses

200

Returns 'EntityHistoryResult'

application/json

Schema

Schema

from date-time

Timestamp of first history entry

to date-time

Timestamp of last history entry

data

object[]

required

List of requested entity ids and a list of historical values (for each entity)

Array [

id number

The entity id

values object[]

The list of historical entity values, one for each step, with 'valid_from' and 'valid_to' interval properties

]

Example (from schema)

{
  "from": "2024-07-29T15:51:28.071Z",
  "to": "2024-07-29T15:51:28.071Z",
  "data": [
    {
      "id": 0,
      "values": [
        {}
      ]
    }
  ]
}

4XX

The request failed because invalid request parameters or data were supplied or access was denied.

application/json

Schema

Schema

code string
The error code describing the general error category.
Example: API_INVALID_INPUT_DATA
status integer

The HTTP status code.

message stringrequired

The actual error message describing the error in more detail.

reqid string

The request id for following up on specific errors.

Example (from schema)

{
  "code": "API_INVALID_INPUT_DATA",
  "status": 0,
  "message": "string",
  "reqid": "string"
}

5XX

The request failed because an error occurred during processing of the request.

application/json

Schema

Schema

code string
The error code describing the general error category.
Example: API_INVALID_INPUT_DATA
status integer

The HTTP status code.

message stringrequired

The actual error message describing the error in more detail.

reqid string

The request id for following up on specific errors.

Example (from schema)

{
  "code": "API_INVALID_INPUT_DATA",
  "status": 0,
  "message": "string",
  "reqid": "string"
}

Loading...