Specifications for Accumulative Point APIs¶
APIs of the Accumulative Points
type provide the accumulative values of measurement points in the current day. Before registering the Accumulative Points
APIs as the data sources in Common Data Service, you need to standardize the APIs according to the following specifications.
HTTP Method¶
POST
Request Parameters¶
Name |
Mandatory/Optional |
Data Type |
Description |
---|---|---|---|
orgId |
Mandatory |
String |
The organization ID which the point belongs to. |
mdmIds |
Mandatory |
String |
The object instance ID which the point belongs to. Separate multiple IDs by commas. |
pointIds |
Mandatory |
String |
The point ID. Separate multiple IDs by commas. |
timeGroup |
Mandatory |
String |
The time granularity by which the point is aggregated. The following granularity is supported: D (Day). |
Response Parameters¶
Name |
To Return Definitely/Conditionally |
Data Type |
Description |
---|---|---|---|
data |
Definitely |
PointData Struct |
Describe the point data. See PointData Struct. |
PointData Struct ¶
Name |
To Return Definitely/Conditionally |
Data Type |
Description |
---|---|---|---|
pointId |
Definitely |
String |
The identifier of the point. |
value |
Definitely |
Integer/Double/String |
The value of the point. |
Request Content Type¶
application/x-www-form-urlencoded
Response Content Type¶
application/json; charset = UTF-8
Request Sample¶
POST {requestURL}?orgId=yourOrgId
Content-Type: application/x-www-form-urlencoded
Payload: mdmIds=yourMdmId&pointIds=yourPointIds&timeGroup=yourTimeGroup
Response Sample¶
{
"data": {
"EL***yP": {
"INV.a": 2213,
"INV.b": 2213
}
},
"code": 0,
"msg": "OK"
}