Files
baiyue-firstleg/firstleg/src/main/resources/openapi/dashboard-metrics-v1.yaml
T
2026-09-11 17:27:27 +08:00

65 lines
2.1 KiB
YAML

openapi: 3.0.3
info:
title: Platform dashboard operational metrics
version: 1.0.0
paths:
/api/platform/v1/first-leg/dashboard/operational-metrics:
get:
summary: 查询首页货柜与清关实时指标
description: >-
在途柜量按已实际开船且尚未到达海外仓的有效物理柜去重,TEU 按 20*=1、40*=2、45*=2.25
折算,未知箱型不计入 TEU;待清关票数按已进入整柜清关且清关未完成的去重订单统计。
本接口只返回当前时点事实,不提供历史环比。
responses:
'200':
description: 查询成功
content:
application/json:
schema:
$ref: '#/components/schemas/OperationalMetricsEnvelope'
'401': {description: 需要登录}
'403': {description: 需要货柜列表与报关列表权限}
components:
schemas:
OperationalMetricsEnvelope:
type: object
required: [code, message, data]
properties:
code: {type: string, example: '200'}
message: {type: string}
data: {$ref: '#/components/schemas/OperationalMetrics'}
OperationalMetrics:
type: object
required:
- inTransitContainerCount
- inTransitTeu
- unknownContainerTypeCount
- pendingCustomsOrderCount
properties:
inTransitContainerCount:
type: integer
format: int64
minimum: 0
description: 已开船未到海外仓的物理柜数
inTransitTeu:
type: number
format: decimal
multipleOf: 0.01
minimum: 0
description: 已知箱型的在途柜 TEU 合计
unknownContainerTypeCount:
type: integer
format: int64
minimum: 0
description: 未计入 TEU 的未知箱型在途柜数
pendingCustomsOrderCount:
type: integer
format: int64
minimum: 0
description: 已进入整柜清关且清关未完成的去重订单数
asOf:
type: string
format: date-time
nullable: true
description: 数据库统计时点