Get Asset DI Data¶

Get the status change (DI) data of specified devices within a certain period.

The API captures the state of a particular asset over a period of time and returns only data that reflects changes in the state of the asset. For example, the raw data within a period is given as follows:

Time       Status
01:14    0
01:30    0
03:45    0
12:23    1
13:34    0
15:24    1
17:25    1

The returned results are as follows:

Time       Status
01:14    0
12:23    1
13:34    0
15:24    1

Note

The status data of specific assets may be represented by other integers. If there is no DI data at the start time of the request, it will trace back the last state value within the last 30 days from the start time. The data is returned with the timestamp of the request start time.

Request Format¶

POST https://{apigw-address}/tsdb-service/v2.1/di

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 >>

Request Parameters (Body)¶

Name	Required/Optional	Data Type	Description
modelId	Optional	String	The model ID. How to get model ID >>
assetIds	Required	String	The asset ID. Supports the query of multiple asset IDs, separated by commas. How to get asset ID >>
pointIds	Required	String	The measurement point ID. Supports the query of multiple measurement point IDs, separated by commas. How to get measurement point ID >>
startTime	Required	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	Required	String	The end time of the sampling data. Its format must be consistent with `startTime`.
localTimeAccuracy	Optional	Boolean	Specify whether the local time in the returned data should be in millisecond format. Only effective when `ifWithLocalTime=true`. `true` indicates that the local time should be returned in millisecond format, `false` indicates that millisecond format is not required, and the default value is `false`.
autoInterpolate	Optional	Boolean	true = query the latest status data in the past if no data is found at the query start time false (default) = do not query the latest status data in the past if no data is found at the query start time
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>>

Response Parameters¶

Name	Data Type	Description
items	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¶

Name	Data Type	Description
assetId	String	The asset ID.
timestamp	Long	The data timestamp (UNIX time, accurate to the second).
pointId	Integer	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.
localtime	String	The data timestamp in local time format (accurate to the second).

Sample 1¶

Request Sample¶

Local time format:

url: https://{apigw-address}/tsdb-service/v2.1/di?orgId=yourOrgId

method: POST

Content-Type: application/json

requestBody:
{
  "assetIds": "yourAssetIds",
  "pointIds": "yourPointIds",
  "startTime": "2020-03-01 00:00:00",
  "endTime": "2020-03-02 00:00:00",
  "localTimeAccuracy": false,
  "localTimeFormat": 1,
  "itemFormat": 0
}

Return Sample¶

{
  "code": 0,
  "msg": "OK",
  "submsg": null,
  "data": {
    "items": [
      {
        "assetId": "yourAssetId",
        "yourPointId": 1,
        "timestamp": 1582992000000,
        "localtime": "2020-03-01T00:00:00+08:00"
      }
    ]
  }
}

Sample 2¶

Request Sample¶

UTC time format:

url: https://{apigw-address}/tsdb-service/v2.1/di?orgId=yourOrgId

method: POST

Content-Type: application/json

requestBody:
{
  "assetIds": "yourAssetIds",
  "pointIds": "yourPointIds",
  "startTime": "2020-03-01T00:00:00+08:00",
  "endTime": "2020-03-02T00:00:00+08:00",
  "localTimeAccuracy": false,
  "localTimeFormat": 1,
  "itemFormat": 0
}

Return Sample¶

{
  "code": 0,
  "msg": "OK",
  "submsg": null,
  "data": {
    "items": [
      {
        "assetId": "yourAssetId",
        "yourPointId": 1,
        "timestamp": 1582992000000,
        "localtime": "2020-03-01T00:00:00+08: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.