diff --git a/docs/api/home.md b/docs/api/home.md index 224790d8..3824914b 100644 --- a/docs/api/home.md +++ b/docs/api/home.md @@ -2,16 +2,16 @@ ## API接口一览表 -| 接口分类 | 接口描述 | API接口 | 权限 | -|--------|-------------|------------------------------| ---------------------------- | -| 2.1 首页 | 2.1.1风场概况 | /api/home/windFarmOverview | | -| | 2.1.2今日运行状态 | /api/home/currentDayStatus | | -| | 2.1.3功率趋势 | /api/home/powerTrends | | -| | 2.1.4风机矩阵 | /api/home/windTurbineMatrix | | -| | 2.1.5发电量概况 | /api/home/generationOverview | | -| | 2.1.6发电量趋势 | /api/home/generationTrend | | -| | 2.1.7实时告警 | /api/home/realTimeAlert | | -| | 2.1.8实时告警确认 | /api/home/realTimeAlertConfirm | | +| 接口分类 | 接口描述 | 查询条件 | API接口 | 权限 | +|--------|-------------|------------------------------| ---------------------------- | ---------------------------- | +| 2.1 首页 | 2.1.1风场概况 | 实时数据,没有入参 | /api/home/windFarmOverview | | +| | 2.1.2今日运行状态 | 实时数据,没有入参 | /api/home/currentDayStatus | | +| | 2.1.3功率趋势 | 当天24小时数据,5分钟间隔 | /api/home/powerTrends | | +| | 2.1.4风机矩阵 | 实时数据,没有参数 | /api/home/windTurbineMatrix | | +| | 2.1.5发电量概况 | 昨日数据; | /api/home/generationOverview | | +| | 2.1.6发电量趋势 | 日: 当前月的每日数据;同期是去年数据;月:当年每月月数据,12个月; | /api/home/generationTrend | | +| | 2.1.7实时告警 | 近一个月内所有的报警数据,滚动显示;已确认的数据 按钮灰色;未确认的显示确认按钮 | /api/home/realTimeAlert | | +| | 2.1.8实时告警确认 | 告警记录ID | /api/home/realTimeAlertConfirm | | ### 2.1 首页相关接口 @@ -24,19 +24,9 @@ POST 请求接口 请求参数 +无 -```json -{ - "requestTime":"2024-10-16" -} -``` -入参描述 - -| 参数名 | 参数类型 | 可选 | 描述 | -| ------------ | -------- | ---- |------| -| requestTime | String | yes | 请求时间 | - -注:请求时间默认为:昨日时间 +注:实时数据,没有入参 返回报文 @@ -74,18 +64,9 @@ POST 请求接口 请求参数 +无 -```json -{ - "requestTime":"2024-10-16" -} -``` -入参描述 - -| 参数名 | 参数类型 | 可选 | 描述 | -| ------------ | -------- | ---- |------| -| requestTime | String | yes | 请求时间 | - +注:实时数据,没有入参 返回报文 @@ -133,20 +114,9 @@ POST 请求接口 请求参数 +无 -```json -{ - "requestTime":"2024-10-16" -} -``` - -入参描述 - -| 参数名 | 参数类型 | 可选 | 描述 | -| ------------ | -------- | ---- |------| -| requestTime | String | yes | 请求时间 | - -注:请求时间默认为:昨日时间 +注:当天24小时数据,5分钟间隔 返回报文 @@ -159,12 +129,12 @@ POST 请求接口 { "power": 12.6, "windSpeed": 56.3, - "windTurbine": "GDWT00001" + "dataTime": "2024-10-17 00:00:00" }, { "power": 10.6, "windSpeed": 16.3, - "windTurbine": "GDWT00002" + "dataTime": "2024-10-17 00:05:00" } ] } @@ -176,7 +146,7 @@ POST 请求接口 |-------------|--------| ---- |------| | power | Double | 否 | 功率 | | windSpeed | Double | 否 | 风速 | -| windTurbine | String | 否 | 风机编码 | +| dataTime | String | 否 | 数据时间 | #### 2.1.4 风机矩阵 @@ -186,20 +156,9 @@ POST 请求接口 请求参数 +无 -```json -{ - "requestTime":"2024-10-16" -} -``` - -入参描述 - -| 参数名 | 参数类型 | 可选 | 描述 | -| ------------ | -------- | ---- |------| -| requestTime | String | yes | 请求时间 | - -注:请求时间默认为:昨日时间 +注:实时数据 返回报文 @@ -272,6 +231,7 @@ POST 请求接口 "success": true, "data": { + "dailyGeneration": 63.2, "dayGeneration": 56.2, "monthGeneration": 60.2, "yearGeneration": 200.6, @@ -283,12 +243,13 @@ POST 请求接口 返参描述 -| 参数名 | 参数类型 | 可选 | 描述 | -|-------------|---------| ---- |------| -| dayGeneration | Double | 否 | 日发电量 | -| monthGeneration | Double | 否 | 月发电量 | -| yearGeneration | Double | 否 | 年发电量 | -| totalGeneration | Double | 否 | 总发电量 | +| 参数名 | 参数类型 | 可选 | 描述 | +|-------------|---------| ---- |-------| +| dailyGeneration | Double | 否 | 当日发电量 | +| dayGeneration | Double | 否 | 日发电量 | +| monthGeneration | Double | 否 | 月发电量 | +| yearGeneration | Double | 否 | 年发电量 | +| totalGeneration | Double | 否 | 总发电量 | #### 2.1.6 发电量趋势 @@ -304,6 +265,7 @@ POST 请求接口 "timeType":"日" } ``` +注: 日:当前月的每日数据;同期是去年数据;月:当年每月月数据,12个月; 入参描述 @@ -311,7 +273,6 @@ POST 请求接口 | ------------ | -------- | ---- |------| | timeType | String | yes | 时间类型 | -注:时间类型:日/月 返回报文 @@ -354,7 +315,7 @@ POST 请求接口 无 - +注:近一个月内所有的报警数据,滚动显示;已确认的数据 按钮灰色;未确认的显示确认按钮 返回报文 @@ -367,12 +328,16 @@ POST 请求接口 { "alertTime": "2024-10-16 12:16:42", "windTurbine": "SC-01", - "alertContent": "故障" + "alertContent": "故障", + "alertId": 4562366, + "confirmStatus": 0 }, { "alertTime": "2024-10-16 12:16:42", "windTurbine": "SC-01", - "alertContent": "待机" + "alertContent": "待机", + "alertId": 4562366555, + "confirmStatus": 1 } ] @@ -380,11 +345,13 @@ POST 请求接口 ``` 返参描述 -| 参数名 | 参数类型 | 可选 | 描述 | -|-------------|--------| ---- |------| -| alertTime | String | 否 | 告警时间 | -| windTurbine | String | 否 | 风机编码 | -| alertContent | String | 否 | 告警内容 | +| 参数名 | 参数类型 | 可选 | 描述 | +|-------------|---------| ---- |------| +| alertTime | String | 否 | 告警时间 | +| windTurbine | String | 否 | 风机编码 | +| alertContent | String | 否 | 告警内容 | +| alertId | Long | 否 | 告警id | +| confirmStatus | Integer | 否 | 确认状态 | #### 2.1.8 实时告警-确认 @@ -397,15 +364,15 @@ POST 请求接口 ```json { - "windTurbine":"SC-01" + "alertId":45566222 } ``` 入参描述 | 参数名 | 参数类型 | 可选 | 描述 | -| ------------ | -------- | ---- |------| -| windTurbine | String | yes | 风机编码 | +| ------------ |------| ---- |------| +| alertId | Long | yes | 告警id |