Get Asset Latest Data¶
Get the latest data of all measurement points of specified devices.
Using GET Method¶
Request Format¶
GET https://{apigw-address}/tsdb-service/v2.0/latest
Request Parameters (URI)¶
Name |
Location (Path/Query) |
Required/Optional |
Data Type |
Description |
---|---|---|---|---|
orgId |
Query |
Required |
String |
The organization ID which the asset belongs to. How to get organization ID >> |
modelId |
Query |
Optional |
String |
The model ID. How to get model ID >> |
assetIds |
Query |
Required |
String |
The asset ID. Supports the query of multiple asset IDs, separated by commas. How to get asset ID >> |
measurepoints |
Query |
Required |
String |
The measurement point ID. Supports the query of multiple measurement point IDs, separated by commas. How to get measurement point ID >> |
timeWindow |
Query |
Optional |
Integer |
Specify the time window for querying the latest data (by minutes). The minimum value is 0. If not specified, no constrain is applied. For example: when timeWindow=n, the data within n minutes from the current time is returned. When timeWindow=0, if the latest data timestamp is later than the current time, the data of the latest timestamp will be returned. |
accessKey |
Query |
Optional |
String |
The service account for authentication purposes. How to get the accessKey>> |
ifWithLocalTime |
Query |
Optional |
Boolean |
|
localTimeAccuracy |
Query |
Optional |
Boolean |
Specify whether the local time in the returned data should be in millisecond format. Only effective when |
Response Parameters ¶
Name |
Data Type |
Description |
---|---|---|
data |
List<JSONObject> |
The list of asset data. The data returned for a single point of a single device is sorted by the data time stamp in ascending order. For more information, see items |
items¶
Sample¶
{
"assetId": "yourAssetId",
"yourPointId": 1.1236,
"timestamp": 1560249312446
}
Parameters¶
Name |
Data Type |
Description |
---|---|---|
assetId |
String |
The asset ID. |
timestamp |
Long |
The data timestamp (UNIX time, accurate to the second). |
pointId |
Double |
This parameter is a variable, where the parameter name in the returned structure represents the identifier of the measurement point, and the parameter value represents the data for that measurement point. The returned data for the same measurement point of the same device will be sorted in ascending order by time. |
#
Samples (GET Method)¶
Request Sample¶
url: https://{apigw-address}/tsdb-service/v2.0/latest?orgId=yourOrgId&assetIds=yourAssetIds&measurepoints=yourPointIds&timeWindow=&accessKey=accessKeyOfYourAPP
method: GET
Return Sample¶
{
"status": 0,
"requestId": null,
"msg": "success",
"submsg": null,
"data": {
"items": [
{
"assetId": "yourAssetId",
"yourPointId": 2.123,
"timestamp": 1560249532446
}
]
}
}
Using POST Method¶
Request Format¶
POST https://{apigw-address}/tsdb-service/v2.0/latest
Request Parameters (Body)¶
Name |
Required/Optional |
Data Type |
Description |
---|---|---|---|
orgId |
Required |
String |
The organization ID which the asset belongs to. How to get organization ID >> |
assetIds |
Required |
String |
The asset ID. Supports the query of multiple asset IDs, separated by commas. How to get asset ID >> |
measurepoints |
Required |
String |
The measurement point ID. Supports the query of multiple measurement point IDs, separated by commas. How to get measurement point ID >> |
timeWindow |
Optional |
String |
Specify the time window for querying the latest data (by minutes). The minimum value is 0. If not specified, no constrain is applied. |
accessKey |
Optional |
String |
The service account for authentication purposes. How to get the accessKey>> |
ifWithLocalTime |
Optional |
String |
|
localTimeAccuracy |
Optional |
String |
Specify whether the local time in the returned data should be in millisecond format. Only effective when |
Response Parameters¶
See description in Response Parameters of the Using GET Method section.
#
Sample (POST Method)¶
Request Sample¶
url: https://{apigw-address}/tsdb-service/v2.0/latest
method: POST
Content-Type: multipart/form-data;charset=UTF-8
requestBody:
{
"orgId": "yourOrgId",
"measurepoints": "yourPointIds",
"timeWindow": 10,
"assetIds": "yourAssetIds",
"accessKey": "accessKey of your APP"
}
Return Sample¶
{
"status": 0,
"requestId": null,
"msg": "success",
"submsg": null,
"data": {
"items": [
{
"assetId": "yourAssetId",
"yourPointId": 2.123,
"timestamp": 1560249532446
}
]
}
}
SDK Samples¶
You can access the `Java SDK Samples<https://github.com/EnvisionIot/sample-code-java/tree/EnOS2.4/tsdbdata>`__for TSDB data service on Github.