42 lines
1.7 KiB
Markdown
42 lines
1.7 KiB
Markdown
# hr-roster 花名册字段体系 API 文档 (F03)
|
||
|
||
> 服务: hr_roster_field · 端口 9280 · ocai 模式 · 统一 JSON 返回
|
||
> 返回约定: {"code":0,"data":...} 成功; {"code":非0,"message":"..."} 失败
|
||
|
||
## 1. 字段分组
|
||
GET /api/roster/field-groups 列表
|
||
POST /api/roster/field-groups 新增 (group_code唯一, 正则校验)
|
||
PUT /api/roster/field-groups/{id} 更新
|
||
DELETE /api/roster/field-groups/{id} 删除(内置不可删/有字段不可删, 软删除)
|
||
|
||
## 2. 字段定义
|
||
GET /api/roster/field-defs?group_id= 列表
|
||
POST /api/roster/field-defs 新增 (field_type枚举, select需options)
|
||
PUT /api/roster/field-defs/{id} 更新
|
||
DELETE /api/roster/field-defs/{id} 删除(软删除)
|
||
POST /api/roster/field-defs/sort 拖拽排序 {"items":[{"id":1,"sort_order":10}]}
|
||
POST /api/roster/field-defs/toggle 启停 {"id":1,"is_enabled":true}
|
||
|
||
## 3. 员工类型规则
|
||
GET /api/roster/type-rules 列表
|
||
POST /api/roster/type-rules 新增 (rule_code唯一, required_field_codes数组)
|
||
PUT /api/roster/type-rules/{id} 更新
|
||
DELETE /api/roster/type-rules/{id} 删除
|
||
|
||
## 4. 工号生成规则
|
||
GET /api/roster/empno-rules 列表
|
||
POST /api/roster/empno-rules 新增 (subsidiary_code/prefix/date_format/seq_length)
|
||
PUT /api/roster/empno-rules/{id} 更新
|
||
DELETE /api/roster/empno-rules/{id} 删除
|
||
POST /api/roster/empno-rules/generate 生成工号(前缀+日期+流水号原子递增, 冲突报错)
|
||
|
||
## 5. options
|
||
GET /api/roster/options/{field_code} 下拉联动选项
|
||
|
||
## 审计
|
||
所有写操作(create/update/delete/sort/toggle/generate)落库 roster_op_log
|
||
|
||
## 自测记录（py_compile）
|
||
python -m py_compile apps/hr_roster_field.py → 通过（无语法错误）
|
||
端点 20 个与本文档、field_config.ui 的 api 配置一一对应。
|