dev

3.0.0
2.4.4
2.4.0
2.3.0
2.2.0
2.1.0
preview

English

English
简体中文

Get Asset Current Day Electric Power¶

Get the accumulated power consumption/production data of specified devices from 00:00 (local time) of the current day.

Using GET Method¶

Request Format¶

GET https://{apigw-address}/tsdb-service/v2.0/electric-power/current-day

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 >>
accessKey	Query	Optional	String	The service account for authentication purposes. How to get the accessKey>>
localTimeAccuracy	Query	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`.

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¶

{
        "assetId": "yourAssetId",
        "timestamp": 1590076800000,
        "sum(yourPointId)": 10.615000000000002,
        "localtime": "2020-05-22 00:00:00"
}

Parameters¶

Name	Data Type	Description
assetId	String	The asset ID.
timestamp	Long	The data timestamp (UNIX time, accurate to the second).
sum(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. The data here is the daily aggregation of the sum of power consumption/production data.
localtime	String	Local time stamp of the returned data.

#

Samples (GET Method)¶

Request Sample¶

url: https://{apigw-address}/tsdb-service/v2.0/electric-power/current-day?orgId=yourOrgId&modelId=&assetIds=yourAssetIds&measurepoints=yourPointIds&accessKey=accessKeyOfYourAPP

method: GET

Return Sample¶

{
  "status": 0,
  "requestId": null,
  "msg": "success",
  "submsg": null,
  "data": {
    "items": [
      {
        "assetId": "yourAssetId",
        "timestamp": 1590076800000,
        "sum(yourPointId)": 10.615000000000002,
        "localtime": "2020-05-22 00:00:00"
      }
    ]
  }
}

Using POST Method¶

Request Format¶

POST https://{apigw-address}/tsdb-service/v2.0/electric-power/current-day

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 >>
modelId	Optional	String	The model ID. How to get model ID >>
assetIds	Required	String	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 >>
accessKey	Optional	String	The service account for authentication purposes. How to get the accessKey>>
localTimeAccuracy	Optional	String	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`.

Response Parameters¶

See description in Response Parameters of the Using GET Method section.

#

Samples (POST Method)¶

Request Sample¶

url: https://{apigw-address}/tsdb-service/v2.0/electric-power/current-day

method: POST

Content-Type: multipart/form-data;charset=UTF-8

requestBody:
{
  "orgId": "yourOrgId",
  "assetIds": "yourAssetIds",
  "measurepoints": "yourPointIds",
  "accessKey": "accessKey of your APP"
}

Return Sample¶

{
  "status": 0,
  "requestId": null,
  "msg": "success",
  "submsg": null,
  "data": {
    "items": [
      {
        "assetId": "yourAssetId",
        "timestamp": 1590076800000,
        "sum(yourPointId)": 10.615000000000002,
        "localtime": "2020-05-22 00: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.

On this page

Get Asset Current Day Electric Power