历史作业接口文档

root 发布于 3 天前 17 次阅读


📈 作业历史数据 API 文档

基础路径 (Base Path)

所有接口的基础路径为:/ysuwx/job-history


1. 获取所有历史数据 (周/月/年)

此接口用于获取所有作业类型(卸船、疏港、装车、精混)的周、月、年三个维度的完整历史统计数据,用于页面的默认展示。

  • 接口: GET /all
  • 别名: GET /test
  • 请求参数:

响应 (Success 200)

返回 R.ok() 包装的 data 对象,data 字段的结构为 JobHistoryDto

JSON

{
    "msg": "success",
    "code": 0,
    "data": { ... }
}

data 对象详解

data 对象包含四大模块,每个模块都有周、月、年数据:

1. 卸船数据 (xc)

字段类型说明示例值
xcTotalBigDecimal卸船: 周总作业量 (单位: 万吨)104.98
xcWeekXAxisList<String>卸船: 近7天X轴 (日期 "MM-dd")["10-28", ...]
xcWeekDataList<BigDecimal>卸船: 近7天Y轴 (作业量, 吨)[174147, ...]
xcMonthXAxisList<String>卸船: 近5月X轴 (日期 "yyyy-MM")["2025-07", ...]
xcMonthDataList<BigDecimal>卸船: 近5月Y轴 (作业量, 吨)[196243, ...]
xcMonthTotalBigDecimal卸船: 月总作业量 (单位: 万吨)10182987
xcYearXAxisList<String>卸船: 近5年X轴 (年份 "yyyy")["2021", ...]
xcYearDataList<BigDecimal>卸船: 近5年Y轴 (作业量, 吨)[0, ...]
xcYearTotalBigDecimal卸船: 年总作业量 (单位: 万吨)10182987

2. 疏港数据 (sg)

字段类型说明示例值
sgTotalBigDecimal疏港: 周总作业量 (单位: 万吨)34.8
sgWeekXAxisList<String>疏港: 近7天X轴 (日期 "MM-dd")["10-28", ...]
sgWeekDataList<BigDecimal>疏港: 近7天Y轴 (作业量, 吨)[44599.9, ...]
sgMonthXAxisList<String>疏港: 近5月X轴 (日期 "yyyy-MM")["2025-07", ...]
sgMonthDataList<BigDecimal>疏港: 近5月Y轴 (作业量, 吨)[1365099.85, ...]
sgMonthTotalBigDecimal疏港: 月总作业量 (单位: 万吨)7274917.55
sgYearXAxisList<String>疏港: 近5年X轴 (年份 "yyyy")["2021", ...]
sgYearDataList<BigDecimal>疏港: 近5年Y轴 (作业量, 吨)[0, ...]
sgYearTotalBigDecimal疏港: 年总作业量 (单位: 万吨)15564728.9

3. 装车数据 (zc)

字段类型说明示例值
zcTotalBigDecimal装车: 周总作业量 (单位: 万吨)0
zcWeekXAxisList<String>装车: 近7天X轴 (日期 "MM-dd")["10-28", ...]
zcWeekDataList<BigDecimal>装车: 近7天Y轴 (作业量, 吨)[0, ...]
zcMonthXAxisList<String>装车: 近5月X轴 (日期 "yyyy-MM")["2025-07", ...]
zcMonthDataList<BigDecimal>装车: 近5月Y轴 (作业量, 吨)[13749.62, ...]
zcMonthTotalBigDecimal装车: 月总作业量 (单位: 万吨)58934.54
zcYearXAxisList<String>装车: 近5年X轴 (年份 "yyyy")["2021", ...]
zcYearDataList<BigDecimal>装车: 近5年Y轴 (作业量, 吨)[0, ...]
zcYearTotalBigDecimal装车: 年总作业量 (单位: 万吨)58934.54

4. 精混数据 (jh)

字段类型说明示例值
jhTotalBigDecimal精混: 周总作业量 (单位: 万吨)0
jhWeekXAxisList<String>精混: 近7天X轴 (日期 "MM-dd")["10-28", ...]
jhWeekDataList<BigDecimal>精混: 近7天Y轴 (作业量, 吨)[0, ...]
jhMonthXAxisList<String>精混: 近5月X轴 (日期 "yyyy-MM")["2025-07", ...]
jhMonthDataList<BigDecimal>精混: 近5月Y轴 (作业量, 吨)[0, ...]
jhMonthTotalBigDecimal精混: 月总作业量 (单位: 万吨)1537266.19
jhYearXAxisList<String>精混: 近5年X轴 (年份 "yyyy")["2021", ...]
jhYearDataList<BigDecimal>精混: 近5年Y轴 (作业量, 吨)[0, ...]
jhYearTotalBigDecimal精混: 年总作业量 (单位: 万吨)1537266.19

2. 按自定义时间范围查询数据

此接口用于按自定义时间范围(例如 "2025-10-15" 到 "2025-11-03")查询所有作业类型的日度统计数据。

  • 接口: GET /by-time
  • 请求参数: (Query)
参数类型是否必填说明
startTimeString开始时间, 格式: "yyyy-MM-dd"
endTimeString结束时间, 格式: "yyyy-MM-dd"

响应 (Success 200)

返回 R.ok() 包装的 data 对象。

重要提示: 此接口的 data 对象是一个部分填充JobHistoryDto

  • 只会填充 ...Total...WeekXAxis...WeekData 字段。
  • ...Week... 字段在此处被复用,用于存储自定义时间范围的日度数据
  • 所有 ...Month......Year... 相关的字段将始终为 null

JSON

{
    "msg": "success",
    "code": 0,
    "data": { ... }
}

data 对象详解 (by-time 模式)

字段类型说明示例值
xcTotalBigDecimal卸船: 范围内总作业量2707719
xcWeekXAxisList<String>卸船: 范围内X轴 (日期 "yyyy-MM-dd")["2025-10-16", ...]
xcWeekDataList<BigDecimal>卸船: 范围内Y轴 (作业量, 吨)[192716, ...]
sgTotalBigDecimal疏港: 范围内总作业量900906.90
sgWeekXAxisList<String>疏港: 范围内X轴 (日期 "yyyy-MM-dd")["2025-10-15", ...]
sgWeekDataList<BigDecimal>疏港: 范围内Y轴 (作业量, 吨)[46315.7, ...]
zcTotalBigDecimal装车: 范围内总作业量0
zcWeekXAxisList<String>装车: 范围内X轴 (日期 "yyyy-MM-dd")[]
zcWeekDataList<BigDecimal>装车: 范围内Y轴 (作业量, 吨)[]
jhTotalBigDecimal精混: 范围内总作业量54071
jhWeekXAxisList<String>精混: 范围内X轴 (日期 "yyyy-MM-dd")["2025-10-15", ...]
jhWeekDataList<BigDecimal>精混: 范围内Y轴 (作业量, 吨)[9271, ...]
...Month...-(所有月度字段)null
...Year...-(所有年度字段)null

响应 (Error 500)

如果请求的时间范围不合法(例如超过30天限制,该限制在 JobHistoryServiceImpl.java 中定义),将返回错误信息。

JSON

{
    "msg": "查询时间范围不能超过30天,当前查询范围:35天(...)",
    "code": 500
}
此作者没有提供个人介绍。
最后更新于 2025-11-03