跳转至

表单辅助（FormHelperController）

表单运行时辅助接口：预览环境探测、PDF 存在判断、水印打印、控件修改历史、签章按钮字段。

  • 接口类型：REST 资源
  • 基址：${myapps.context-path.runtime:}/api/runtime（produces=APPLICATION_JSON_VALUE）
  • Tag：表单辅助

公共说明

  • 鉴权：基址在 /api/runtime/**，需登录态 accessToken（query/header/Cookie），由前置过滤器与控制器内 Security.getUserIdFromToken(request) 校验（据源码）。
  • 路径/参数加密：{applicationId}、{docId} 路径变量及 path/fileRealName 参数为 DES 加密密文，服务端按当前用户解密。
  • 响应：统一 Resource（见 ../index.md「统一响应结构」）。

1. 判断是否存在预览环境

判断系统是否配置了在线预览环境。

  • 接口类型：REST 资源
  • 请求方式：GET
  • 请求路径：/files/preview/environment
  • 鉴权：是（需 accessToken，据源码）
  • Tag：表单辅助

请求参数

无。

响应

data：boolean（当前实现固定返回 true）。

{ "errcode":0, "errmsg":"ok", "data":true, "errors":null }

2. 判断文件是否存在 PDF

判断指定路径下是否存在某文件的 PDF 版本。

  • 接口类型：REST 资源
  • 请求方式：GET
  • 请求路径：/files/hasPdf
  • 鉴权：是（需 accessToken，据源码）
  • Tag：表单辅助

请求参数

参数名 位置 类型 必填 说明
path query string 是 文件路径（DES 加密密文）
fileRealName query string 是 文件真实名称（DES 加密密文）

响应

data：boolean。

{ "errcode":0, "errmsg":"ok", "data":true, "errors":null }

3. 水印文件打印

对指定文档的附件进行带水印打印处理。

  • 接口类型：REST 资源
  • 请求方式：POST
  • 请求路径：/{applicationId}/documents/{docId}/files/watermark/print
  • 鉴权：是（需 accessToken，据源码）
  • Tag：表单辅助

请求参数

参数名 位置 类型 必填 说明
applicationId path string 是 应用Id（DES 加密密文）
docId path string 是 文档Id（DES 加密密文）
content body string(JSON) 是 请求包体（见下）

请求体

{ "path": "/uploads/...", "fileName": "<文件名>", "itemId": "<控件Id>" }

path 必须以 /uploads/ 开头，否则抛 ResourceNotFoundException（errcode 404）。

响应

data：string，处理结果信息。

{ "errcode":0, "errmsg":"ok", "data":"<结果>", "errors":null }

4. 获取控件修改历史

获取文档中控件（字段）的修改历史记录。

  • 接口类型：REST 资源
  • 请求方式：GET
  • 请求路径：/{applicationId}/documents/{docId}/formhelper/inputlog
  • 鉴权：是（需 accessToken，据源码）
  • Tag：表单辅助

请求参数

参数名 位置 类型 必填 说明
applicationId path string 是 应用Id（DES 加密密文）
docId path string 是 文档Id（DES 加密密文）
fieldName query string 否 字段名（限定单字段）

响应

data：JSONArray，修改历史记录集合。

{ "errcode":0, "errmsg":"ok", "data":[...], "errors":null }

5. 获取表单配置的签章按钮

获取文档所属表单中配置为签章类型（ActivityType.SIGNATURE）且未隐藏的按钮字段。

  • 接口类型：REST 资源
  • 请求方式：GET
  • 请求路径：/{applicationId}/documents/{docId}/signatureButtonFields
  • 鉴权：是（需 accessToken，据源码）
  • Tag：表单辅助

请求参数

参数名 位置 类型 必填 说明
applicationId path string 是 应用Id（DES 加密密文）
docId path string 是 文档Id（DES 加密密文）

响应

data：List<Map>，签章按钮字段属性集合；文档不存在时返回 null。

{ "errcode":0, "errmsg":"ok", "data":[ {"formField":"ButtonField","activityType":12,...} ], "errors":null }