Get Asset Unified Raw Data¶
Query Standard Data + Non-Standard Data. Supports interpolation of standard data (the interpolation parameters boundaryType, interval and interpolation only work with standard data).
Operation Permissions¶
Required Authorization |
Required Operation Permission |
|---|---|
Asset |
Read |
For more information about resources and required permission, see Policies, Roles and Permissions>>
Request Format¶
POST https://{apigw-address}/tsdb-service/v2.1/unified-raw
Request Parameters (URI)¶
Name |
Location (Path/Query) |
Mandatory/Optional |
Data Type |
Description |
|---|---|---|---|---|
orgId |
Query |
Mandatory |
String |
The organization ID which the asset belongs to. How to get organization ID>> |
Request Parameters (Body)¶
Name |
Mandatory/Optional |
Data Type |
Description |
|---|---|---|---|
modelId |
Optional |
String |
The model ID. How to get model ID>> |
assetIds |
Mandatory |
String |
The asset ID. Supports the query of multiple asset IDs, separated by commas. How to get asset ID>> |
pointIds |
Mandatory |
String |
The measurement point ID. Support multiple measurement points query, including standard and non-standard measurement points. Multiple measurement point IDs are separated by commas. Number of devices * Number of measurement points <= 3000. How to get asset ID pointId>> |
startTime |
Mandatory |
String |
The start time of the sampling data, where both UTC and local time formats are supported.
|
endTime |
Mandatory |
String |
The end time of the sampling data. Its format must be consistent with |
pageSize |
Optional |
Integer |
The upper limit of the returned records in a single page for a single measurement point of a single device, which is 1,000 by default. The total amount of data returned follows the constraint: (Number of devices * Number of measurement points * Pagesize) ≤ 640000. |
localTimeAccuracy |
Optional |
Boolean |
|
localTimeFormat |
Optional |
Integer |
Specify whether the local time value includes time zone information of devices. 0 (default): without time zone information; 1: with time zone information. |
itemFormat |
Optional |
Integer |
Specify the displaying format of the returned device data. Available options are 0, 1, and 2. 0 (default): without time zone information; 1: with time zone information.For the example of each displaying format, see Item Format Example>> |
withQuality |
Optional |
Boolean |
|
orderBy |
Optional |
String |
Specify whether to sort the response result according to a certain field. Only the field timestamp is supported for now.
|
boundaryType |
Optional |
String |
Specify the type/scope of data to be queried if data is stored after compression. Available options are: |
interval |
Optional |
Integer |
This parameter is only valid for standard data. For |
interpolation |
Optional |
String |
This parameter is only valid for standard data. For |
type |
Optional |
String |
Specify the TSDB storage type to query data from. Available options are: |
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,
"timestamp": 1657612800000,
"localtime": "2022-07-12T16:00:00.000+08:00",
"quality": null
}
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, representing the identifier and data of the measurement point. |
localtime |
String |
The data timestamp in local time format (accurate to the second). The value of the |
quality |
Integer |
The quality indicator. |
Error Codes¶
For description of error codes, see Common Error Codes.
Sample 1¶
Request Sample¶
Local time format:
url: https://{apigw-address}/tsdb-service/v2.1/unified-raw?orgId=yourOrgId
method: POST
Content-Type: application/json
requestBody:
{
"assetIds": "yourAssetIds",
"pointIds": "yourPointId,yourUnformattedPointId",
"startTime": "2022-07-12 15:50:00",
"endTime": "2022-07-12 16:10:00",
"pageSize": 10,
"localTimeAccuracy": true,
"localTimeFormat": 1,
"itemFormat": 0,
"orderBy": "timestamp asc"
}
Response Sample¶
{
"code": 0,
"msg": "OK",
"submsg": "",
"data": {
"items": [
{
"assetId": "yourAssetId",
"timestamp": 1657612200000,
"yourPointId": 1.1236,
"localtime": "2022-07-12T15:50:00.000+08:00"
},
{
"assetId": "yourAssetId",
"timestamp": 1657612800000,
"yourUnformattedPointId": "sfa",
"localtime": "2022-07-12T16:00:00.000+08:00"
}
]
}
}
Sample 2¶
Request Sample¶
UTC time format:
url: https://{apigw-address}/tsdb-service/v2.1/unified-raw?orgId=yourOrgId
method: POST
Content-Type: application/json
requestBody:
{
"assetIds": "yourAssetIds",
"pointIds": "yourPointId,yourUnformattedPointId",
"startTime": "2022-07-12T15:50:00+08:00",
"endTime": "2022-07-12T16:10:00+08:00",
"pageSize": 10,
"localTimeAccuracy": false,
"localTimeFormat": 0,
"itemFormat": 0,
"orderBy": "timestamp asc"
}
Return Sample¶
{
"code": 0,
"msg": "OK",
"submsg": "",
"data": {
"items": [
{
"assetId": "yourAssetId",
"timestamp": 1657612200000,
"yourPointId": 1.1236,
"localtime": "2022-07-12 15:50:00"
},
{
"assetId": "yourAssetId",
"timestamp": 1657612800000,
"yourUnformattedPointId": "sfa",
"localtime": "2022-07-12 16:00:00"
}
]
}
}
SDK Samples¶
You can access the Java SDK Samples for TSDB data service on Github.