- 1. MIX.IOT.2018.F.13.06-APIS API
- 1.1. 请求地址
- 1.2. 请求说明
- 1.3. 响应说明
- 1.4. 接口列表
- 1.4.1. 获取离线数据结果集
- 1.4.1.1. 功能描述
- 1.4.1.2. 请求参数
- 1.4.1.3. 响应参数
- 1.4.2. 获取统计计算数据
- 1.4.2.1. 功能描述
- 1.4.2.2. 请求参数
- 1.4.2.3. 响应参数
- 1.4.3. 获取统计计算数据根据日期
- 1.4.3.1. 功能描述
- 1.4.3.2. 请求参数
- 1.4.3.3. 响应参数
- 1.4.4. 获取一段周期内的统计结果集
- 1.4.4.1. 功能描述
- 1.4.4.2. 请求参数
- 1.4.4.3. 响应参数
- 1.4.5. 获取前N时间单位内的计算结果集
- 1.4.5.1. 功能描述
- 1.4.5.2. 请求参数
- 1.4.5.3. 响应参数
- 1.4.6. 获取累计结果
- 1.4.6.1. 功能描述
- 1.4.6.2. 请求参数
- 1.4.6.3. 响应参数
- 1.4.7. 统计数据excel导出
- 1.4.7.1. 功能描述
- 1.4.7.2. 请求参数
- 1.4.7.3. 响应参数
- 1.4.8. Excel文件下载
- 1.4.8.1. 功能描述
- 1.4.8.2. 请求参数
1. MIX.IOT.2018.F.13.06-APIS API
- 1. MIX.IOT.2018.F.13.06-APIS API
- 1.1. 请求地址
- 1.2. 请求说明
- 1.3. 响应说明
- 1.4. 接口列表
- 1.4.1. 获取离线数据结果集
- 1.4.1.1. 功能描述
- 1.4.1.2. 请求参数
- 1.4.1.3. 响应参数
- 1.4.2. 获取统计计算数据
- 1.4.2.1. 功能描述
- 1.4.2.2. 请求参数
- 1.4.2.3. 响应参数
- 1.4.3. 获取统计计算数据根据日期
- 1.4.3.1. 功能描述
- 1.4.3.2. 请求参数
- 1.4.3.3. 响应参数
- 1.4.4. 获取一段周期内的统计结果集
- 1.4.4.1. 功能描述
- 1.4.4.2. 请求参数
- 1.4.4.3. 响应参数
- 1.4.5. 获取前N时间单位内的计算结果集
- 1.4.5.1. 功能描述
- 1.4.5.2. 请求参数
- 1.4.5.3. 响应参数
- 1.4.6. 获取累计结果
- 1.4.6.1. 功能描述
- 1.4.6.2. 请求参数
- 1.4.6.3. 响应参数
- 1.4.7. 统计数据excel导出
- 1.4.7.1. 功能描述
- 1.4.7.2. 请求参数
- 1.4.7.3. 响应参数
- 1.4.8. Excel文件下载
- 1.4.8.1. 功能描述
- 1.4.8.2. 请求参数
1.1. 请求地址
HOST:http://xxx.com/(具体以系统部署地址为准)请求地址:HOST +下文接口中的url
1.2. 请求说明
固定传参
在 http header 中传入参数,该参数来源于用户登录后获得到的验证信息,用于鉴权
参考
Authorization: Bearer d6nAGWraBuRY4wkEo7KLK4d3N53A4i5gMnj1iiCZQujZS783WE1SfHNkBFjkns85
1.3. 响应说明
所有响应都提供了遵循如下响应规则,在后面的响应说明中不再做出说明
状态码说明:
1.4. 接口列表
1.4.1. 获取离线数据结果集
1.4.1.1. 功能描述
| 属性 | 值 |
|---|
| url | /api/apis/getCollect |
| http方法 | post |
| Content-Type | x-www-form-urlencode |
1.4.1.2. 请求参数
| 参数名称 | 数据类型 | 长度/字节 | 描述 | 是否必选 |
|---|
| equipment_id | string | | 设备标识 | 必选 |
| collect_id | string | | 采集结果标识,允许传多个值,用逗号分隔 | 必选 |
| start_time | datetime | | 开始时间 | 可选 |
| end_time | datetime | | 结束时间 | 可选 |
1.4.1.3. 响应参数
响应示例:
{ "code": 200, "msg": "操作成功", "result": { "data": { "PowerMeterRatio": [{ "collect_id": "PowerMeterRatio", "data": "1000" }, { "collect_id": "PowerMeterRatio", "data": "1000" }] } }}
1.4.2. 获取统计计算数据
1.4.2.1. 功能描述
| 属性 | 值 |
|---|
| url | /api/apis/getStatistic |
| http方法 | post |
| Content-Type | x-www-form-urlencode |
1.4.2.2. 请求参数
| 参数名称 | 数据类型 | 长度/字节 | 描述 | 是否必选 |
|---|
| statistics_id | string | | 采集结果标识 | 必选 |
| equipment_id | string | | 设备标识 | 必选 |
| start_time | datetime | | 开始时间 | 可选 |
| end_time | datetime | | 结束时间 | 可选 |
1.4.2.3. 响应参数
{ "code": 200, "msg": "操作成功", "result": { "data": { "TonnageFuel": [{ "sort": 1536303600, "year": 2018, "month": 9, "day": 7, "hour": 15, "data": "4.000", "statistics_id": "TonnageFuel" }, { "sort": 1536307200, "year": 2018, "month": 9, "day": 7, "hour": 16, "data": "1.089", "statistics_id": "TonnageFuel" }] } }}
1.4.3. 获取统计计算数据根据日期
1.4.3.1. 功能描述
根据日期 Y-m-d h 获取统计结果 ,当日期格式为为 Y 获取年的统计 当为 Y-m获取月的统计 以此类推。
| 属性 | 值 |
|---|
| url | /api/apis/getStatisticByDate |
| http方法 | post |
| Content-Type | x-www-form-urlencode |
1.4.3.2. 请求参数
| 参数名称 | 数据类型 | 长度/字节 | 描述 | 是否必选 |
|---|
| equipment_id | string | | 设备标识 | 必选 |
| statistics_id | string | | 统计id,通过逗号分隔成多个 | 必选 |
| datetime | datetime | | 时间点,通过逗号分隔成多个 | 必选 |
1.4.3.3. 响应参数
请求示例:
equipment_id:1014statistics_id:max,accumulatedatetime:2018-09-16,2018-09-17,2018-09-18
响应示例:
{ "code": 200, "msg": "操作成功", "result": { "data": [{ "accumulate": [{ "sort": 1537200000, "year": 2018, "month": 9, "day": 18, "data": "0.000", "statistics_id": "accumulate" }], "max": [{ "sort": 1537200000, "year": 2018, "month": 9, "day": 18, "data": "2500.000", "statistics_id": "max" }] }] }}
1.4.4. 获取一段周期内的统计结果集
1.4.4.1. 功能描述
可获取当月和上月| 当周和上周的统计数据结果集,如果timeFlag为month的话则取的是上月和本月每天的统计结果集,同理week 类似。
| 属性 | 值 |
|---|
| url | /api/apis/getStatisticByPeriod |
| http方法 | post |
| Content-Type | x-www-form-urlencode |
1.4.4.2. 请求参数
| 参数名称 | 数据类型 | 长度/字节 | 描述 | 是否必选 |
|---|
| statistics_id | string | | 统计计算标识 | 必选 |
| equipment_id | string | | 设备标识 | 必选 |
| timeFlag | string | | 月/周 month/week | 必选 |
1.4.4.3. 响应参数
| 参数名称 | 数据类型 | 长度/字节 | 描述 | 是否必选 |
|---|
| data | string | | 统计结果值 | 必选 |
| created | string | | 数据创建日期 | 必选 |
| last | array | | 上(月/周) | 必选 |
| current | array | | 当(月/周) | 必选 |
响应示例:
{ "code": 200, "msg": "操作成功", "result": { "last": [], "current": [{ "created": "7-1", "data": "6733.000" }, { "created": "7-2", "data": "711.000" }, { "created": "7-3", "data": "2446.000" }, { "created": "7-4", "data": "7944.000" }, { "created": "7-5", "data": "1208.000" }, { "created": "7-6", "data": "5793.000" }, { "created": "7-7", "data": "254.000" }, { "created": "7-14", "data": "3306.000" }] }}
1.4.5. 获取前N时间单位内的计算结果集
1.4.5.1. 功能描述
可获取除了当月|天.. 的数据之外,的数据结果集合,通过 timeValue 为1便可以获取上月上周.. 的统计结果,例如:timeFlag: month timeValue: 1 获取上月的数据
| 属性 | 值 |
|---|
| url | /api/apis/getStatisticByTimeFlag |
| http方法 | post |
| Content-Type | x-www-form-urlencode |
1.4.5.2. 请求参数
| 参数名称 | 数据类型 | 长度/字节 | 描述 | 是否必选 |
|---|
| statistics_id | string | | 统计计算标识 | 必选 |
| equipment_id | string | | 设备标识 | 必选 |
| timeValue | int | | 前N小时/天/周/… | 必选 |
| timeFlag | string | | year/month/week/day/hour(年/月/周/日/小时) | 必选 |
1.4.5.3. 响应参数
| 参数名称 | 数据类型 | 长度/字节 | 描述 | 是否必选 |
|---|
| data | string | | 统计结果值 | 必选 |
| created | string | | 日期 | 必选 |
响应示例:
{ "code": 200, "msg": "操作成功", "result": { "cumulativeflowhourly": [{ "year": 2018, "month": 7, "day": 23, "statistics_id": "cumulativeflowhourly", "data": "4,981.000" }] }}
1.4.6. 获取累计结果
1.4.6.1. 功能描述
获取天|月|年|总计的累计结果, 通过timeFlag传不同的值获取,即获取当天、当月、当年的累计结果
| 属性 | 值 |
|---|
| url | /api/apis/getAggregate |
| http方法 | post |
| Content-Type | x-www-form-urlencode |
1.4.6.2. 请求参数
| 参数名称 | 数据类型 | 长度/字节 | 描述 | 是否必选 |
|---|
| statistics_id | string | | 统计计算标识,允许多个值通过逗号分隔 | 必选 |
| equipment_id | String | | 设备标识 | 必选 |
| timeFlag | string | | day/month/year/total |
1.4.6.3. 响应参数
响应示例:
{ "code": 200, "msg": "操作成功", "result": { "data": { "FuelConsumption": "20.891", "PowerConsumption": "1378.000" } }}
1.4.7. 统计数据excel导出
1.4.7.1. 功能描述
| 属性 | 值 |
|---|
| url | /api/apis/getStatisticsExcel |
| http方法 | get |
1.4.7.2. 请求参数
| 参数名称 | 数据类型 | 长度/字节 | 描述 | 是否必选 |
|---|
| statistics_id | string | | 统计计算标识,允许多个值通过逗号分隔,如果查询该设备下所有的计算,则将 statistics_id 置为all | 必选 |
| equipment_id | String | | 设备标识 | 必选 |
| page_index | int | | 当前页数,只针对hour/day 类型 | |
| page_size | int | | 每页条数,只针对hour/day 类型 | |
| type | string | | 导出的数据类型,hour/day/month/year/currentDay/currentYear/currentMonth/total/all all :代表所有类型的数据 hour 代表小时统计数据.currentDay 代表当天统计数据.total 表示累计统计数据 以此类推 |
1.4.7.3. 响应参数
响应示例:
{ "code": 200, "msg": "操作成功", "result": { "data": "app\\\\exports\\\\statistics.xls" }}
1.4.8. Excel文件下载
1.4.8.1. 功能描述
| 属性 | 值 |
|---|
| url | /api/apis/downloadExcel |
| http方法 | get |
1.4.8.2. 请求参数
| 参数名称 | 数据类型 | 长度/字节 | 描述 | 是否必选 |
|---|
| path | string | | 文件路径 | 必选 |