dp3.api.internal.entity_response_models

EntityState

Bases: BaseModel

Entity specification and current state

Merges (some) data from DP3's EntitySpec and state information from Database. Provides estimate count of master records in database.

EntityEidList

Bases: BaseModel

List of entity eids and their data based on latest snapshot

Includes timestamp of latest snapshot creation, count of returned documents and total count of documents available under specified filter.

Data does not include history of observations attributes and timeseries.

EntityEidCount

Bases: BaseModel

Total count of documents available under specified filter.

EntityEidData

Bases: BaseModel

Data of entity eid

Includes all snapshots and master record.

empty signalizes whether this eid includes any data.

EntityEidAttrValueOrHistory

Bases: BaseModel

Value and/or history of entity attribute for given eid

Depends on attribute type: - plain: just (current) value - observations: (current) value and history stored in master record (optionally filtered) - timeseries: just history stored in master record (optionally filtered)

EntityEidAttrValue

Bases: BaseModel

Value of entity attribute for given eid

The value is fetched from master record.