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

Java SDK Sample

import com.alibaba.fastjson.JSONObject;
import com.envision.apim.poseidon.config.PConfig;
import com.envision.apim.poseidon.core.Poseidon;
import com.envision.apim.poseidon.request.PoseidonRequest;

public class GetMethod {

     private static class Request extends PoseidonRequest {

          public void setQueryParam(String key, Object value){
               queryEncodeParams().put(key, value);
          }

          public void setMethod(String method) {
               this.method = method;
          }

          private String method;

          @Override
          public String baseUri() {
               return "";
          }

          @Override
          public String method() {
               return method;
          }

     }

     public static void main(String[] args){
          //1. Click Application Registration in the left navigation of the EnOS Management Console.
          //2. Click the application that needs to call the API, and click Basic Information. accessKey and secretKey correspond to AccessKey and SecretKey in EnOS.
          String accessKey = "AccessKey of your APP";
          String secretKey = "SecretKey of your APP";

          //Create a request and pass the required parameters into the map that exists in the query. The key is the parameter name and the value is the parameter value.
          Request request = new Request();
          request.setQueryParam("orgId", "yourOrgId");
          request.setQueryParam("modelId", "yourModelId");
          request.setQueryParam("assetIds","yourAssetIds");
          request.setQueryParam("measurepoints", "yourPointIds");

          request.setMethod("GET");

          try {
               JSONObject response =  Poseidon.config(PConfig.init().appKey(accessKey).appSecret(secretKey).debug())
                       .url("https://{apigw-address}/tsdb-service/v2.0/electric-power/current-day")
                       .getResponse(request, JSONObject.class);
               System.out.println(response);
          } catch (Exception e) {
               e.printStackTrace();
          }
     }
}

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

Java SDK Sample

import com.alibaba.fastjson.JSONObject;
import com.envision.apim.poseidon.config.PConfig;
import com.envision.apim.poseidon.core.Poseidon;
import com.envision.apim.poseidon.request.PoseidonRequest;

public class PostMethod {

     private static class Request extends PoseidonRequest {

          public void setFormParam(String key, String value){
               formParams().put(key, value);
          }

          public void setMethod(String method) {
               this.method = method;
          }

          private String method;

          @Override
          public String baseUri() {
               return "";
          }

          @Override
          public String method() {
               return method;
          }

     }

     public void GetAssetCurrentDayElectricPowerTest(){
          //1. Click Application Registration in the left navigation of the EnOS Management Console.
          //2. Click the application that needs to call the API, and click Basic Information. accessKey and secretKey correspond to AccessKey and SecretKey in EnOS.
          String accessKey = "AccessKey of your APP";
          String secretKey = "SecretKey of your APP";

          //Create a request and pass the required parameters into the map that exists in the form. The key is the parameter name and the value is the parameter value.
          Request request = new Request();
          request.setFormParam("orgId", "yourOrgId");
          request.setFormParam("modelId", "yourModelId");
          request.setFormParam("assetIds","yourAssetIds");
          request.setFormParam("measurepoints", "yourPointIds");

          request.setMethod("POST");

          try {
               JSONObject response =  Poseidon.config(PConfig.init().appKey(accessKey).appSecret(secretKey).debug())
                       .url("https://{apigw-address}/tsdb-service/v2.0/electric-power/current-day")
                       .getResponse(request, JSONObject.class);
               System.out.println(response);
          } catch (Exception e) {
               e.printStackTrace();
          }
     }
}