About TSDB Data Service API V2.0¶
This is an older version of the API. For the latest version, see V2.1.
The EnOS Time Series Database (TSDB) data service provides the interfaces listed below for developers to invoke for data and application development. EnOS TSDB provides efficient and stable storage management for time series data that is ingested from devices or generated by the stream processing engine. Currently, EnOS TSDB can store the following types of asset data:
- Original data of AI measurement points
- Minute-level normalized data of AI measurement points
- Device status (DI) data
- Device status duration data
- Generic data
- Power consumption/production data
For more information about TSDB storage, see Time Series Data Management.
Refer to the table below for the list of APIs, and whether they can be used by EnOS Cloud and EnOS Edge.
API List¶
| API Name | Description | EnOS Cloud | EnOS Edge |
|---|---|---|---|
| Filter Asset Latest Data | Filter and query the latest data of a single measurement point for multiple devices. | √ | √ |
| Get Asset AI Data with Aggregation Logic | Get the original AI data (or aggregated data) of a specified measurement point of a specified device within a certain period. | √ | √ |
| Get Asset AI Raw Data | Get the original AI data of a specified measurement point of a specified device within a certain period. | √ | √ |
| Get Asset Current Day Electric Power | Get the accumulated power consumption/production data of a specified device from 00:00 (local time) to current time. | √ | √ |
| Get Asset DI Data | Get the status (DI) data of a specified device within a certain period. | √ | √ |
| Get Asset DI Data Duration | Get the duration of different status (DI) data of a specified device within a certain period. | √ | √ |
| Get Asset Electric Power Data | Get the power consumption/production data of a specified device within a certain period. | √ | √ |
| Get Asset Generic Data | Get the generic data of a specified measurement point of a specified device within a certain period. | √ | √ |
| Get Asset Latest Data | Get the latest data of all measurement points of a specified device. | √ | √ |
| Get Asset Raw Data By Time Range | Get the original data of a specified measurement point of a specified device within a certain period (including AI, DI, and Generic data types). | √ | √ |
| Get Asset Unified Raw Data | Query Standard Data and Non-Standard Data. | √ | x |
API Editions¶
The following table lists the API services included in TSDB Data Service Enterprise and Lightweight editions.
| Operation Name | Enterprise | Lightweight |
|---|---|---|
| Filter Asset Latest Data | √ | √ |
| Get Asset AI Data with Aggregation Logic | √ | √ |
| Get Asset AI Raw Data | √ | √ |
| Get Asset Current Day Electric Power | √ | √ |
| Get Asset DI Data | √ | √ |
| Get Asset DI Data Duration | √ | √ |
| Get Asset Electric Power Data | √ | √ |
| Get Asset Generic Data | √ | √ |
| Get Asset Latest Data | √ | √ |
| Get Asset Raw Data By Time Range | √ | √ |
| Get Asset Unified Raw Data | √ | √ |
Request Method¶
TSDB Data Service supports both the GET and POST methods:
- GET: The request parameters are included in the request URL, which can be used for requests with less parameters.
- POST: The request parameters are included in the request body, which can be used for requests with long parameters (e.g., when querying data of multiple assets).
The API documentation provides reference for both the GET and POST methods.
Recommend Poseidon version:
<dependency>
<groupId>com.envisioniot</groupId>
<artifactId>apim-poseidon</artifactId>
<version>0.1.14</version>
</dependency>
Common Error Codes¶
| Code | Error Information | Description |
|---|---|---|
| 0 | Success | API request is successful. |
| 400 | Invalid param error | Parameters or parameter values are not valid. For details, refer to the error messages. |
| 701 | Sata service ERROR | An exception occurs with the data service. |
| 702 | An error occurred when execute query in data service. | Data query failed due to error of the data service. Please try again later. |