Word 文档字段(WordFieldController)¶
为表单「Word 字段」提供编辑占用检查与退出编辑能力:进入编辑前校验是否可独占编辑,编辑结束(或离开)时释放占用。
- 接口类型:REST 资源(
@Component+ 类级@RequestMapping(produces = APPLICATION_JSON_VALUE),继承自@RestController的AbstractRuntimeController,方法返回值由 Spring 以 JSON 序列化输出) - 基址:
${myapps.context-path.runtime:}/api/runtime/forms/wordfield - Tag:Word 文档字段执行模块
公共说明¶
- 鉴权(据源码
RuntimeMvcConfig+RestSecurityHandlerInterceptor):基址位于/api/runtime/**,不在豁免名单(豁免规则详见 login.md「公共说明 · 鉴权」)。拦截器走Security.getUserIdFromToken(request),未取到再尝试Security.getDebugUserIdFromToken(request),两者皆无则拒绝访问。所有端点均需 accessToken(或 debugToken),可通过 Cookie / 请求头 / query 参数任一方式传递。 - 响应结构:统一
Resource(见 ../index.md「统一响应结构」)。 - HTTP 状态码:所有端点类级标注
@ResponseStatus(HttpStatus.OK),成功统一返回 200。
1. 检查word文档是否可编辑¶
检查指定 Word 文档当前是否可被当前用户编辑(是否被他人占用)。
- 接口类型:REST 资源
- 请求方式:
GET - 请求路径:
/edit(完整:{runtime-context}/api/runtime/forms/wordfield/edit) - 鉴权:是(需 accessToken,据源码)
- Tag:Word 文档字段执行模块
请求参数¶
| 参数名 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
| wordid | query | string | 是 | Word 文档Id(方法签名无 @RequestParam,Spring 默认按名称绑定且必填) |
请求示例¶
GET /api/runtime/forms/wordfield/edit?wordid=__WORDID__ HTTP/1.1
Cookie: accessToken=eyJhbGciOiJIUzI1NiJ9...
响应¶
结构:统一 Resource。
data:JSONObject,可编辑性检查结果(结构由 WordFieldRunTimeService.checkWordFieldIsEdit 决定)。
2. 退出word文档编辑¶
释放当前用户对指定 Word 文档的编辑占用。
- 接口类型:REST 资源
- 请求方式:
PUT - 请求路径:
/exixtEdit(完整:{runtime-context}/api/runtime/forms/wordfield/exixtEdit) - 鉴权:是(需 accessToken,据源码)
- Tag:Word 文档字段执行模块
说明:路径
exixtEdit为源码原拼写(疑似exitEdit),按源码保留。
请求参数¶
| 参数名 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
| wordid | query | string | 是 | Word 文档Id(方法签名无 @RequestParam,Spring 默认按名称绑定且必填) |
请求示例¶
PUT /api/runtime/forms/wordfield/exixtEdit?wordid=__WORDID__ HTTP/1.1
Cookie: accessToken=eyJhbGciOiJIUzI1NiJ9...
响应¶
结构:统一 Resource。
data:null(控制器 success("ok", null))。