Get Asset AI Raw Data¶
Get the original AI data of specified measurement points of specified devices within a certain period.
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/ai
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. Supports the query of multiple measurement point IDs, separated by commas. How to get measurement point ID>> |
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 startTime . |
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. |
withQuality | Optional | Boolean |
|
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. For the example of each displaying format, see Item Format Example>> |
boundaryType | Optional | String | Specify the type/scope of data to be queried if data is stored after compression. Available options are: inside (query compressed raw data only, default), outside (query compressed raw data and data records before the specified start time and after the end time), interpolated (query compressed raw data and interpolated data records at the specified start time and end time), and sample (return interpolated data records by specified time interval and algorithm within the specified start time and end time). The interpolated data can be used for making data in TSDB complete based on business needs. |
interval | Optional | Integer | For boundaryType=sample , specify the time interval for generating the interpolated data records. The default value is 60, in seconds. |
interpolation | Optional | String | For boundaryType=sample , specify the algorithm for generating the interpolated data records. Available options are: linear (linear interpolation, default), previous (previous value interpolation), near (near value interpolation), after (next value interpolation). For detailed information about the algorithm, see Data Interpolation Algorithm>> |
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 timestamp in ascending order. For more information, see items |
items¶
Sample¶
{
"localtime":"2020-04-20T00:00:03+08:00",
"assetId": "yourAssetId",
"yourPointId": 1.1236,
"timestamp": 1587312003000
}
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 localTimeFormat parameter determines whether the local time value includes the time zone information. |
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/ai?orgId=yourOrgId
method: POST
Content-Type: application/json
requestBody:
{
"assetIds": "yourAssetIds",
"pointIds": "yourPointIds",
"startTime": "2020-04-20 00:00:00",
"endTime": "2020-04-21 00:00:000",
"pageSize": 10,
"localTimeAccuracy": true,
"localTimeFormat": 1,
"itemFormat": 0,
"withQuality": false
}
Return Sample¶
{
"code": 0,
"msg": "OK",
"submsg": null,
"data": {
"items": [
{
"assetId": "yourAssetId",
"timestamp": 1587312000000,
"yourPointId": 1.1236,
"localtime": "2020-04-20T00:00:00+08:00"
},
{
"assetId": "yourAssetId",
"timestamp": 1587312003000,
"yourPointId": 1.1236,
"localtime": "2020-04-20T00:00:03+08:00"
}
]
}
}
Sample 2¶
Request Sample¶
UTC time format:
url: https://{apigw-address}/tsdb-service/v2.1/ai?orgId=yourOrgId
method: POST
Content-Type: application/json
requestBody:
{
"assetIds": "yourAssetIds",
"pointIds": "yourPointIds",
"startTime": "2020-04-20T00:00:00+08:00",
"endTime": "2020-04-21T00:00:00+08:00",
"pageSize": 10,
"localTimeAccuracy": true,
"localTimeFormat": 0,
"itemFormat": 0,
"withQuality": false
}
Return Sample¶
{
"code": 0,
"msg": "OK",
"submsg": null,
"data": {
"items": [
{
"assetId": "yourAssetId",
"timestamp": 1587312000000,
"yourPointId": 1.1236,
"localtime": "2020-04-20 00:00:00"
},
{
"assetId": "yourAssetId",
"timestamp": 1587312003000,
"yourPointId": 1.1236,
"localtime": "2020-04-20 00:00:03"
}
]
}
}
Sample 3¶
Request Sample¶
Request with quality indicator:
url: https://{apigw-address}/tsdb-service/v2.1/ai?orgId=yourOrgId
method: POST
Content-Type: application/json
requestBody:
{
"assetIds": "yourAssetIds",
"pointIds": "yourPointIds",
"startTime": "2020-04-20T00:00:00+08:00",
"endTime": "2020-04-21T00:00:00+08:00",
"pageSize": 10,
"localTimeAccuracy": true,
"localTimeFormat": 0,
"itemFormat": 0,
"withQuality": true
}
Return Sample¶
{
"code": 0,
"msg": "OK",
"submsg": null,
"data": {
"items": [
{
"assetId": "Ps4PViva",
"timestamp": 1587312000000,
"ai_point": 1.1236,
"localtime": "2020-04-20 00:00:00",
"quality": 0
},
{
"assetId": "Ps4PViva",
"timestamp": 1587312003000,
"ai_point": 1.1236,
"localtime": "2020-04-20 00:00:03",
"quality": 0
}
]
}
}
Sample 4¶
Request Sample¶
Query compressed raw data and data records before the specified start time and after the specified end time.
url: https://{apigw-address}/tsdb-service/v2.1/ai?orgId=yourOrgId
method: POST
Content-Type: application/json
requestBody:
{
"assetIds": "yourAssetIds",
"pointIds": "yourPointIds",
"startTime": "2020-08-28T11:33:00+08:00",
"endTime": "2020-08-28T11:35:00+08:00",
"boundaryType", "outside"
}
Return Sample¶
{
"code": 0,
"msg": "OK",
"submsg": null,
"data": {
"items": [
{
"assetId": "yourAssetId",
"timestamp": 1598585576906,
"yourPointId": 0.8807087,
"localtime": "2020-08-28 11:32:56"
},
{
"assetId": "yourAssetId",
"timestamp": 1598585587039,
"yourPointId": 0.26798052,
"localtime": "2020-08-28 11:33:07"
},
{
"assetId": "yourAssetId",
"timestamp": 1598585597125,
"yourPointId": 0.65514636,
"localtime": "2020-08-28 11:33:17"
},
{
"assetId": "yourAssetId",
"timestamp": 1598585708013,
"yourPointId": 0.342161,
"localtime": "2020-08-28 11:35:08"
}
]
}
}