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.

  • For UTC time format, the application will query all the asset data by the unified start timestamp and end timestamp. Timezone information is required for the UTC time format: 2019-06-01T00:00:00+08:00.

  • For local time format, the application will query the asset data by the local time of where the device is located. Its format is: YYYY-MM-DD HH:MM:SS.

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. The total amount of data returned follows the constraint: (Number of devices * Number of measurement points * Pagesize) ≤ 640000.

localTimeAccuracy

Optional

Boolean

  • true = query returns data with millisecond time stamp

  • false (default) = query returns data without millisecond time stamp

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

  • true = the quality indicator is included in the response

  • false (default) = the quality indicator is not included in the response

orderBy

Optional

String

Specify whether to sort the response result according to a certain field. Only the field timestamp is supported for now.

  • timestamp asc (default): Sort result by ascending order

  • timestamp desc: Sort result by descending order.

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

This parameter is only valid for standard data. For boundaryType=sample, specify the time interval for generating the interpolated data records. The default value is 60, in seconds.

interpolation

Optional

String

This parameter is only valid for standard data. 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>>

type

Optional

String

Specify the TSDB storage type to query data from. Available options are: ai (query AI Raw Data only), ai_normalized (query AI Normalized Data only), di (query DI Data only), pi (query PI Data only), and generic (query Generic Data only). If not specified, query measurement point data from the AI Raw, DI, PI, and Generic storage by default.

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 localTimeFormat parameter determines whether the local time value includes the time zone information.

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<https://github.com/EnvisionIot/sample-code-java/tree/EnOS2.4/tsdbdata>`__for TSDB data service on Github.