Get Asset Generic Data¶

Get the generic data of specified measurement points of specified devices within a certain period.

Operation Permissions¶

Required Authorization	Required Operation Permission
Asset	Read

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

Request Format¶

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

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

Request Parameters (Body)¶

Name	Mandatory/Optional	Data Type	Description
modelId	Optional	String	The model ID. How to get model ID>>
assetIds	Mandatory	String	The asset ID. Supports the query of multiple asset IDs, separated by commas. How to get asset ID>>
pointIds	Mandatory	String	The measurement point ID. Supports the query of multiple measurement point IDs, separated by commas. How to get measurement point ID>>
startTime	Mandatory	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	Mandatory	String	The end time of the sampling data. Its format must be consistent with `startTime`.
pageSize	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.
withQuality	Optional	Boolean	true = the quality indicator is included in the response false = default, the quality indicator is not included in the response
localTimeAccuracy	Optional	Boolean	true = query returns data with millisecond time stamp false (default) = query returns data without millisecond time stamp
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
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": "4DXYH7nS",
        "timestamp": 1560249312446,
        "opentsdb_generic_point": 1.1236,
        "localtime": "2019-06-11 18:35:12",
        "quality": "0"
}

Parameters¶

Name	Data Type	Description
assetId	String	The asset ID.
timestamp	Long	The data timestamp (UNIX time, accurate to the second).
pointId	Double	This parameter is a variable, representing the identifier and data of the measurement point.
localtime	String	The data timestamp in local time format (accurate to the second). The value of the `localTimeFormat` parameter determines whether the local time value includes the time zone information.
quality	String	The quality indicator of the measurement point data.

Error Codes¶

For description of error codes, see Common Error Codes.

Sample 1¶

Request Sample¶

Local time format:

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

method: POST

Content-Type: application/json

requestBody:
{
  "assetIds": "Ps4PViva,isj8Lj3U",
  "pointIds": "generic_point",
  "startTime": "2020-04-20 00:00:00",
  "endTime": "2020-04-21 00:00:00",
  "pageSize": 10,
  "localTimeAccuracy": "false",
  "localTimeFormat": 1,
  "itemFormat": 0
}

Return Sample¶

{
  "code": 0,
  "msg": "OK",
  "submsg": null,
  "data": {
    "items": [
      {
        "assetId": "Ps4PViva",
        "timestamp": 1587312000000,
        "localtime": "2020-04-20T00:00:00+08:00",
        "generic_point": 3.123
      },
      {
        "assetId": "isj8Lj3U",
        "timestamp": 1587312000000,
        "localtime": "2020-04-20T00:00:00+08:00",
        "generic_point": 3.123
      }
    ]
  }
}

Sample 2¶

Request Sample¶

UTC time format:

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

method: POST

Content-Type: application/json

requestBody:
{
  "assetIds": "Ps4PViva,isj8Lj3U",
  "pointIds": "generic_point",
  "startTime": "2020-04-20T00:00:00+08:00",
  "endTime": "2020-04-21T00:00:00+08:00",
  "pageSize": 10,
  "localTimeAccuracy": "false",
  "localTimeFormat": 1,
  "itemFormat": 0
}

Return Sample¶

{
  "code": 0,
  "msg": "OK",
  "submsg": null,
  "data": {
    "items": [
      {
        "assetId": "Ps4PViva",
        "timestamp": 1587312000000,
        "localtime": "2020-04-20T00:00:00+08:00",
        "generic_point": 3.123
      },
      {
        "assetId": "isj8Lj3U",
        "timestamp": 1587312000000,
        "localtime": "2020-04-20T00:00:00+08:00",
        "generic_point": 3.123
      }
    ]
  }
}

Sample 3¶

Request Sample¶

Request with quality indicator:

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

method: POST

Content-Type: application/json

requestBody:
{
  "assetIds": "Ps4PViva,isj8Lj3U",
  "pointIds": "generic_point",
  "startTime": "2020-04-20T00:00:00+08:00",
  "endTime": "2020-04-21T00:00:00+08:00",
  "pageSize": 10,
  "localTimeAccuracy": "false",
  "localTimeFormat": 1,
  "itemFormat": 0,
  "withQuality": "true"
}

Return Sample¶

{
  "code": 0,
  "msg": "OK",
  "submsg": null,
  "data": {
    "items": [
      {
        "assetId": "Ps4PViva",
        "timestamp": 1587312000000,
        "localtime": "2020-04-20T00:00:00+08:00",
        "generic_point": 3.123,
        "quality": "0"
      },
      {
        "assetId": "isj8Lj3U",
        "timestamp": 1587312000000,
        "localtime": "2020-04-20T00:00:00+08:00",
        "generic_point": 3.123,
        "quality": "0"
      }
    ]
  }
}

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;
import org.junit.Before;
import org.junit.Test;

public class Sample {
    private static final String API_Gateway_URL = "https://{domain_url}";
    private Poseidon poseidon;

    private static class Request extends PoseidonRequest {

        public void setBodyParams(String key, Object value) {
            bodyParams().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;
        }
    }

    @Before
    public void init() {
        poseidon = Poseidon.config(
                PConfig.init()
                        .appKey("AccessKey of your APP")
                        .appSecret("SecretKey of your APP")
        ).method("POST").header("Content-Type", "application/json");
    }

    @Test
    public void GetAssetGenericData() {
        Request request = new Request();
        request.setBodyParams("assetIds", "yourAssetId1,yourAssetId2");
        request.setBodyParams("pointIds", "generic_point");
        request.setBodyParams("startTime", "2020-04-20 00:00:00");
        request.setBodyParams("endTime", "2020-04-21 00:00:00");
        request.setBodyParams("pageSize", 10);
        request.setBodyParams("localTimeAccuracy", false);
        request.setBodyParams("localTimeFormat", 1);
        request.setBodyParams("itemFormat", 0);

        JSONObject response = poseidon
                .url(API_Gateway_URL + "/tsdb-service/v2.1/generic")
                .queryParam("orgId", "yourOrgId")
                .getResponse(request, JSONObject.class);
        System.out.println(response);
    }
}