跳转至

视图辅助(ViewHelperController)

视图运行时辅助接口:选择框回调/确定脚本执行、视图列按钮脚本(操作/跳转/执行前/执行后)、GPS 定位纠偏。

  • 接口类型:REST 资源
  • 基址${myapps.context-path.runtime:}/api/runtimeproduces=APPLICATION_JSON_VALUE
  • Tag:视图辅助

公共说明

  • 鉴权:基址在 /api/runtime/**,需登录态 accessToken(query/header/Cookie),由前置过滤器与控制器内 Security.getUserIdFromToken(request) 校验(据源码)。
  • 路径变量加密{applicationId}{viewId}{columnId} 路径变量为 DES 加密密文,服务端按当前用户解密。
  • 请求体:脚本类端点的 content 为 JSON,含 documentid/formId/applicationId/items,其中 id/applicationId/_selects 经 DES 加密)、fieldId、回调脚本名等。
  • 响应:统一 Resource(见 ../index.md「统一响应结构」)。

1. 执行视图选择框确定回调脚本

执行视图选择框的确定回调脚本(按 fieldId 或显式 callbackScript)。

  • 接口类型:REST 资源
  • 请求方式POST
  • 请求路径/views/selectbox/runViewDialogCallbackScript
  • 鉴权:是(需 accessToken,据源码)
  • Tag:视图辅助

请求参数

参数名 位置 类型 必填 说明
content body string(JSON) 请求包体(含 fieldId/document/callbackScript/_selects

响应

dataJSONObject,脚本执行结果。

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

2. 执行视图选择框确定脚本

执行视图选择框的确定(OK)脚本。

  • 接口类型:REST 资源
  • 请求方式POST
  • 请求路径/views/selectbox/runViewDialogConfirmScript
  • 鉴权:是(需 accessToken,据源码)
  • Tag:视图辅助

请求参数

参数名 位置 类型 必填 说明
content body string(JSON) 请求包体(含 fieldId/document/okScript/_selects

响应

datastring,脚本执行结果。

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

3. 执行视图列操作按钮的脚本

执行视图列操作按钮配置的动作脚本(actionScript)。

  • 接口类型:REST 资源
  • 请求方式PUT
  • 请求路径/{applicationId}/views/{viewId}/columns/{columnId}/runActionScript
  • 鉴权:是(需 accessToken,据源码)
  • Tag:视图辅助

请求参数

参数名 位置 类型 必填 说明
applicationId path string 应用Id(DES 加密密文)
viewId path string 视图Id(DES 加密密文)
columnId path string 视图列Id(DES 加密密文)
content body string(JSON) 请求包体(含 docIdcolumnName

响应

dataJSONObject,含 type/content(脚本返回的 JsMessage);脚本为空时为空对象。

{ "errcode":0, "errmsg":"ok", "data":{ "type":"success", "content":"<脚本输出>" }, "errors":null }

4. 执行视图列操作按钮的跳转脚本

执行视图列按钮配置的跳转(dispatcherUrl)脚本,返回跳转 URL。

  • 接口类型:REST 资源
  • 请求方式PUT
  • 请求路径/{applicationId}/views/{viewId}/columns/{columnId}/runDispatcherUrlScript
  • 鉴权:是(需 accessToken,据源码)
  • Tag:视图辅助

请求参数

参数名 位置 类型 必填 说明
applicationId path string 应用Id(DES 加密密文)
viewId path string 视图Id(DES 加密密文)
columnId path string 视图列Id(DES 加密密文)
content body string(JSON) 请求包体(含 docIdcolumnName

响应

data:脚本返回的跳转 URL(Object);脚本为空时为 null

{ "errcode":0, "errmsg":"ok", "data":"<跳转URL>", "errors":null }

5. 执行视图列操作按钮的执行前脚本

执行视图列按钮的执行前(beforeScript)校验脚本。

  • 接口类型:REST 资源
  • 请求方式PUT
  • 请求路径/{applicationId}/views/{viewId}/columns/{columnId}/beforescript
  • 鉴权:是(需 accessToken,据源码)
  • Tag:视图辅助

请求参数

参数名 位置 类型 必填 说明
applicationId path string 应用Id(DES 加密密文)
viewId path string 视图Id(DES 加密密文)
columnId path string 视图列Id(DES 加密密文)
content body string(JSON) 请求包体(含 docIdcolumnName

响应

dataJSONObject,含 type(如 danger)/content(校验提示);脚本为空时为空对象。

{ "errcode":0, "errmsg":"ok", "data":{ "type":"danger", "content":"<阻断提示>" }, "errors":null }

6. 执行视图列操作按钮的执行后脚本

执行视图列按钮的执行后(afterScript)脚本。

  • 接口类型:REST 资源
  • 请求方式PUT
  • 请求路径/{applicationId}/views/{viewId}/columns/{columnId}/afterscript
  • 鉴权:是(需 accessToken,据源码)
  • Tag:视图辅助

请求参数

参数名 位置 类型 必填 说明
applicationId path string 应用Id(DES 加密密文)
viewId path string 视图Id(DES 加密密文)
columnId path string 视图列Id(DES 加密密文)
content body string(JSON) 请求包体(含 docIdcolumnName

响应

dataJSONObject,含 type/content;脚本为空时为空对象。

{ "errcode":0, "errmsg":"ok", "data":{ "type":"danger", "content":"<提示>" }, "errors":null }

7. GPS 定位纠偏

将原始 GPS 坐标纠偏(调用百度坐标转换接口,from=0→to=4,返回 base64 解码后的坐标)。

  • 接口类型:REST 资源
  • 请求方式GET
  • 请求路径/gps/convert
  • 鉴权:是(需 accessToken,据源码)
  • Tag:视图辅助

请求参数

参数名 位置 类型 必填 说明
from query string 源坐标类型
x query string 经度
y query string 纬度

响应

dataJSONObject,含纠偏后的 x/y

{ "errcode":0, "errmsg":"ok", "data":{ "x":"<纠偏经度>", "y":"<纠偏纬度>" }, "errors":null }