LogggerAuthtimeController(操作日志开关)¶
注:源码类名拼写为
LogggerAuthtimeController(三个g),保留源码拼写。
按企业域读取 / 设置「操作日志是否记录」开关(写入 DomainVO.log 字段持久化)。
- 类级基址:
${myapps.context-path.manager:}/api/authtime(完整路径:{manager-context}/api/authtime<相对路径>) - Tag:日记操作模块(源码
@Tag(name = "日记操作模块")) - 控制器源码:
obpm-manager/src/main/java/cn/myapps/manager/authtime/controller/logger/LogggerAuthtimeController.java - 公共说明:
- 类继承
BaseAuthTimeController,通过其success(errmsg, data)/error(errcode, errmsg, errors)返回统一Resource(字段errcode/errmsg/data/errors,结构见 ../index.md「统一响应结构」)。 - 两端点均在
try/catch内捕获Exception并e.printStackTrace()后返回errcode=500、errmsg=e.getMessage()、data=null(HTTP 状态码 200)。 - 鉴权说明见 index.md「鉴权说明」(adminToken JWT)。
- 路径变量
domainid为企业域 id。
1. 更新操作日记是否记录¶
把企业域的 DomainVO.log 字段更新为请求体中的 isLog(布尔),并 doUpdate 持久化。
- 接口类型:REST 资源
- 请求方式:
PUT - 请求路径:
/domain/{domainid}/logger(完整:{manager-context}/api/authtime/domain/{domainid}/logger) - 鉴权:是(需管理员 adminToken,详见 index.md「鉴权说明」)
- Tag:日记操作模块
请求参数¶
| 参数名 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
| domainid | path | string | 是 | 企业域 id |
| jsonObj | body | JSON | 是 | 请求包体(字段见下) |
请求体¶
JSON 对象(application/json):
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| isLog | string/boolean | 是 | 是否记录操作日记,控制器以 Boolean.parseBoolean(jsonObj.getString("isLog")) 解析(字符串 "true" 才为真) |
请求示例¶
PUT /api/authtime/domain/__P1UD2yVWpnFpUedONr/logger HTTP/1.1
Content-Type: application/json
{ "isLog": true }
响应¶
结构:统一 Resource。
data:字符串 "保存成功"。
| 条件 | errcode | errmsg | data |
|---|---|---|---|
| 成功 | 0 | ok | 保存成功 |
| 抛异常 | 500 | <异常信息> |
null |
成功示例:
失败示例:2. 查询操作日记是否记录¶
按企业域读取 DomainVO.log 字段并字符串化返回。
- 接口类型:REST 资源
- 请求方式:
GET - 请求路径:
/domain/{domainid}/logger(完整:{manager-context}/api/authtime/domain/{domainid}/logger) - 鉴权:是
- Tag:日记操作模块
请求参数¶
| 参数名 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
| domainid | path | string | 是 | 企业域 id |
请求示例¶
响应¶
结构:统一 Resource。
data:字符串("true" / "false")。
| 条件 | errcode | errmsg | data |
|---|---|---|---|
| 成功 | 0 | ok | "true" 或 "false" |
| 抛异常 | 500 | <异常信息> |
null |
成功示例:
失败示例: