Get Asset Electric Power Data¶

Get the power consumption/production data of specified devices within a certain period.

Using GET Method¶

Request Format¶

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

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 >>
measurepointsWithLogic	Query	Required	String	The aggregation logic with measurement point ID. The supported aggregation calculation methods include count, avg, sum, max, min, first, and last. The time range for the aggregation query is `[startTime, endTime)`, that is, the aggregation operand contains the data at the time of `startTime`, but does not contain the data at the time of `endTime`. Format: `Function(pointId)`, supporting multiple measurement points e.g. `sum(pointId1),sum(pointId2)`. How to get measurement point ID >>
interval	Query	Required	Integer	The time interval for the aggregation algorithm to work. The effective value is 0-1440, calculated in minutes. If the interval value is 0, the measurement point has no aggregation logic; if the interval value is greater than 0, the measurement point must have the aggregation logic.
startTime	Query	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	Query	Required	String	The end time of the sampling data. Its format must be consistent with `startTime`.
pageSize	Query	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.
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 time stamp in ascending order. For more information, see items

items¶

Sample¶

{
       "assetId": "yourAssetId",
       "timestamp": 1560249300000,
       "sum(yourPointId)": 4.246,
       "localtime": "6/11/2019 6:35:00 PM"

}

Parameters¶

Name	Data Type	Description
pointIdWithLogic	Double	This parameter is a variable, representing the identifier and data of the measurement point (with or without aggregation logic). The data here is the daily aggregation of the sum of power consumption/production data.
assetId	String	The asset ID.
timestamp	Long	The data timestamp (UNIX time, accurate to the second).
localtime	String	The data timestamp in local time format (accurate to the second). If UTC time format is used when specifying the `statTime` and `endtime`, this value will be null.

#

Sample 1 (GET Method)¶

Request Sample¶

Local time format:

url: https://{apigw-address}/tsdb-service/v2.0/electric-power?orgId=yourOrgId&modelId=&assetIds=yourAssetIds&measurepointsWithLogic=sum(yourPointId)&interval=2&startTime=2019-06-01%2000:00:00&endTime=2019-06-11%2023:00:00&pageSize=&accessKey=accessKeyOfYourAPP

method: GET

Return Sample¶

{
  "status": 0,
  "requestId": null,
  "msg": "success",
  "submsg": null,
  "data": {
    "items": [
      {
        "assetId": "yourAssetId",
        "timestamp": 1560249300000,
        "sum(yourPointId)": 6.853,
        "localtime": "6/11/2019 6:35:00 PM"
      },
      {
        "assetId": "yourAssetId",
        "timestamp": 1560249420000,
        "sum(yourPointId)": 4.246,
        "localtime": "6/11/2019 6:37:00 PM"
      }
    ]
  }
}

Sample 2 (GET Method)¶

Request Sample¶

UTC time format:

url: https://{apigw-address}/tsdb-service/v2.0/electric-power?orgId=yourOrgId&modelId=&assetIds=yourAssetIds&measurepointsWithLogic=sum(yourPointId)&interval=2&startTime=2019-06-01%2B00:00:00&endTime=2019-06-11%2B23:00:00&pageSize=&accessKey=accessKeyOfYourAPP

method: GET

Return Sample¶

{
    "status": 0,
    "requestId": null,
    "msg": "success",
    "submsg": null,
    "data": {
        "items": [
            {
                "localtime": null,
                "sum(yourPointId)": 6.853,
                "assetId": "yourAssetId",
                "timestamp": 1560249300000
            },
            {
                "localtime": null,
                "sum(yourPointId)": 4.246,
                "assetId": "yourAssetId",
                "timestamp": 1560249420000
            }
        ]
    }
}

Using POST Method¶

Request Format¶

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

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	The asset ID. Supports the query of multiple asset IDs, separated by commas. How to get asset ID >>
measurepointsWithLogic	Required	String	The aggregation logic with measurement point ID. The supported aggregation calculation methods include count, avg, sum, max, min, first, and last. The time range for the aggregation query is `[startTime, endTime)`, that is, the aggregation operand contains the data at the time of `startTime`, but does not contain the data at the time of `endTime`. Format: `Function(pointId)`, supporting multiple measurement points e.g. sum(pointId1),sum(pointId2). How to get measurement point ID >>
interval	Required	String	The time interval for the aggregation algorithm to work. The effective value is 0-1440, calculated in minutes. If the interval value is 0, the measurement point has no aggregation logic; if the interval value is greater than 0, the measurement point must have the aggregation logic.
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`.
pageSize	Optional	String	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.
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.

#

Sample 1 (POST Method)¶

Request Sample¶

Local time format:

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

method: POST

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

requestBody:
{
  "orgId": "yourOrgId",
  "assetIds": "yourAssetIds",
  "measurepointsWithLogic": "sum(yourPointId)",
  "startTime": "2020-03-01 00:00:00",
  "endTime": "2020-03-01 00:15:00",
  "accessKey": "accessKey of your APP"
}

Return Sample¶

{
  "status": 0,
  "requestId": null,
  "msg": "success",
  "submsg": null,
  "data": {
    "items": [
      {
        "assetId": "yourAssetId",
        "timestamp": 1560249300000,
        "sum(yourPointId)": 6.853,
        "localtime": "6/11/2019 6:35:00 PM"
      },
      {
        "assetId": "yourAssetId",
        "timestamp": 1560249420000,
        "sum(yourPointId)": 4.246,
        "localtime": "6/11/2019 6:37:00 PM"
      }
    ]
  }
}

Sample 2 (POST Method)¶

Request Sample¶

UTC time format:

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

method: POST

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

requestBody:
{
  "orgId": "yourOrgId",
  "assetIds": "yourAssetIds",
  "measurepointsWithLogic": "sum(yourPointId)",
  "startTime": "2019-06-01T10:00:00%2B08:00",
  "endTime": "2019-06-11T23:00:00%2B08:00",
  "pageSize": 1000,
  "accessKey": "accessKey of your APP"
}

Return Sample¶

{
    "status": 0,
    "requestId": null,
    "msg": "success",
    "submsg": null,
    "data": {
        "items": [
            {
                "localtime": null,
                "sum(yourPointId)": 6.853,
                "assetId": "yourAssetId",
                "timestamp": 1560249300000
            },
            {
                "localtime": null,
                "sum(yourPointId)": 4.246,
                "assetId": "yourAssetId",
                "timestamp": 1560249420000
            }
        ]
    }
}