2.3.0

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.

Operation Permissions¶

Required Authorization	Required Operation Permission
Asset	Read

For more information about resources and required permission, see Policies, Roles and Permissions>>

Using GET Method¶

Request Format¶

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

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>>
modelId	Query	Optional	String	The model ID. How to get model ID>>
assetIds	Query	Mandatory	String	The asset ID. Supports the query of multiple asset IDs, separated by commas. How to get asset ID>>
measurepoints	Query	Mandatory	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	true = query returns data with millisecond time stamp false (default) = query returns data without millisecond time stamp

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, representing the identifier and data of the measurement point. The data here is the daily aggregation of the sum of power sonsumption/production data.
localtime	String	Local time stamp of the returned data.

Error Codes¶

For description of error codes, see Common Error Codes.

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	Mandatory/Optional	Data Type	Description
orgId	Mandatory	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	Mandatory	String	Asset ID. Supports the query of multiple asset IDs, separated by commas. How to get asset ID>>
measurepoints	Mandatory	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	true = query returns data with millisecond time stamp false (default) = query returns data without millisecond time stamp

Response Parameters¶

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

Error Codes¶

For description of error codes, see Common Error Codes.

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"
      }
    ]
  }
}