视图执行(ViewController)¶
视图运行时接口:获取视图模板/数据、树形视图、查询表单模板、视图列提交/筛选、刷新行、打开权限判断。
- 接口类型:REST 资源
- 基址:
${myapps.context-path.runtime:}/api/runtime/{applicationId}(produces=APPLICATION_JSON_VALUE) - Tag:视图执行模块
公共说明¶
- 鉴权:基址在
/api/runtime/**,需登录态accessToken(query/header/Cookie),由前置过滤器与控制器内Security.getUserIdFromToken(request)校验(据源码)。 - 路径变量加密:
{applicationId}、{viewId}、{docid}等路径变量均为 DES 加密密文,服务端按当前用户解密。 - 响应:统一
Resource(见 ../index.md「统一响应结构」)。分页类端点(获取视图、树形视图数据)通过successWithPagination返回,Resource.data内含分页字段page/page_lines/row_count(注意:非pageNo/linesPerPage/rowCount,据源码)。
1. 获取视图模板¶
获取视图模板(按钮 Activity、列 Column、水印、权限只读态等,已按用户权限过滤)。
- 接口类型:REST 资源
- 请求方式:
GET - 请求路径:
/views/{viewId}/template - 鉴权:是(需 accessToken,据源码)
- Tag:视图执行模块
请求参数¶
| 参数名 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
| applicationId | path | string | 是 | 应用Id(DES 加密密文) |
| viewId | path | string | 是 | 视图Id(DES 加密密文) |
| parentId | query | string | 否 | 父Id(DES 加密密文) |
| isRelate | query | string | 否 | 是否父子关系("true" 视为关联) |
| isReadonly | query | boolean | 否 | 是否只读 |
响应¶
data:AbstractView(精简后,含 activities、columns 等)。
{ "errcode":0, "errmsg":"ok", "data":{ "id":"...", "activities":[...], "columns":[...] }, "errors":null }
2. 获取视图(分页数据)¶
获取视图的文档数据列表(支持搜索、排序、分页、小计/总计)。
- 接口类型:REST 资源
- 请求方式:
POST - 请求路径:
/views/{viewId}/documents - 鉴权:是(需 accessToken,据源码)
- Tag:视图执行模块
请求参数¶
| 参数名 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
| applicationId | path | string | 是 | 应用Id(DES 加密密文) |
| viewId | path | string | 是 | 视图Id(DES 加密密文) |
| parentId | query | string | 否 | 父Id |
| isRelate | query | string | 否 | 是否父子关系 |
| startDate | query | string | 否 | 日历视图开始时间 |
| endDate | query | string | 否 | 日历视图结束时间 |
| sortCol | query | string | 否 | 排序列字段 |
| sortStatus | query | string | 否 | 排序状态(DESC/ASC) |
| parentParam | query | string | 否 | 折叠视图上级参数 |
| lines | query | string | 否 | 每页条数(默认 10) |
| isQueryButton | query | boolean | 否 | 是否查询按钮触发(默认 false) |
| content | body | string(JSON) | 否 | 搜索条件包体(键值对,合并入查询参数) |
响应¶
data:List<Map>(视图行数据),并含分页字段 page/page_lines/row_count。
{ "errcode":0, "errmsg":"ok", "data":[{"id":"__SEALED__","items":{...}}], "page":1, "page_lines":10, "row_count":42, "errors":null }
3. 获取树形视图数据¶
获取树形视图(TreeView)的文档数据。
- 接口类型:REST 资源
- 请求方式:
POST - 请求路径:
/treeviews/{viewId}/documents - 鉴权:是(需 accessToken,据源码)
- Tag:视图执行模块
请求参数¶
| 参数名 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
| applicationId | path | string | 是 | 应用Id(DES 加密密文) |
| viewId | path | string | 是 | 视图Id(DES 加密密文) |
| parentId | query | string | 否 | 父Id |
| name | query | string | 否 | 本节点名称(按名称查询) |
| content | body | string(JSON) | 是 | 请求包体(搜索条件) |
| isQueryButton | query | boolean | 否 | 是否查询按钮触发(默认 false) |
响应¶
data:List<Map>,含分页字段 page/page_lines/row_count。
{ "errcode":0, "errmsg":"ok", "data":[...], "page":1, "page_lines":10, "row_count":5, "errors":null }
4. 获取查询表单模板¶
获取视图的查询表单(搜索表单)模板与字段属性。
- 接口类型:REST 资源
- 请求方式:
GET - 请求路径:
/views/{viewId}/searchformtemplate - 鉴权:是(需 accessToken,据源码)
- Tag:视图执行模块
请求参数¶
| 参数名 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
| applicationId | path | string | 是 | 应用Id(DES 加密密文) |
| viewId | path | string | 是 | 视图Id(DES 加密密文) |
响应¶
data:Map,含 fields(字段属性)、document、template(HTML 模板串)、style、showType。
{ "errcode":0, "errmsg":"ok", "data":{ "fields":[...], "document":{...}, "template":"<html>...", "style":"..." }, "errors":null }
5. 查询树形视图¶
按关键字搜索树形视图节点。
- 接口类型:REST 资源
- 请求方式:
GET - 请求路径:
/views/{viewId}/tree/search - 鉴权:是(需 accessToken,据源码)
- Tag:视图执行模块
请求参数¶
| 参数名 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
| applicationId | path | string | 是 | 应用Id(DES 加密密文) |
| viewId | path | string | 是 | 视图Id(DES 加密密文) |
| keyword | query | string | 否 | 搜索关键字 |
响应¶
data:JSONArray,命中节点。
6. 视图列的提交按钮(批量审批)¶
对视图列的提交按钮执行批量审批。
- 接口类型:REST 资源
- 请求方式:
POST - 请求路径:
/views/{viewId}/column/submit - 鉴权:是(需 accessToken,据源码)
- Tag:视图执行模块
请求参数¶
| 参数名 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
| applicationId | path | string | 是 | 应用Id(DES 加密密文) |
| viewId | path | string | 是 | 视图Id(DES 加密密文) |
| json | body | string(JSON) | 是 | 请求包体(见下) |
请求体¶
响应¶
data:string,批量审批结果内容。
7. 判断视图打开权限¶
判断当前用户对指定视图的打开权限(公开视图恒为 true;否则按角色校验 FORM_VIEW_ALLOW_OPEN)。
- 接口类型:REST 资源
- 请求方式:
GET - 请求路径:
/views/{viewId}/openable - 鉴权:是(需 accessToken,据源码)
- Tag:视图执行模块
请求参数¶
| 参数名 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
| applicationId | path | string | 是 | 应用Id(DES 加密密文) |
| viewId | path | string | 是 | 视图Id(DES 加密密文) |
响应¶
data:boolean。
8. 刷新一行数据¶
刷新视图中某一行的计算列(COLUMN_TYPE_SCRIPT)值。
- 接口类型:REST 资源
- 请求方式:
POST - 请求路径:
/views/{viewId}/documents/{docid}/refresh - 鉴权:是(需 accessToken,据源码)
- Tag:视图执行模块
请求参数¶
| 参数名 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
| applicationId | path | string | 是 | 应用Id(DES 加密密文) |
| viewId | path | string | 是 | 视图Id(DES 加密密文) |
| docid | path | string | 是 | 文档Id |
| content | body | string | 是 | 请求内容 |
响应¶
data:Map,含 docid、viewid、items(计算列结果数组,每项 {columnid, value})。
{ "errcode":0, "errmsg":"ok", "data":{ "docid":"...", "viewid":"...", "items":[{"columnid":"...","value":"..."}] }, "errors":null }
9. 获取视图列筛选数据¶
获取视图某列的筛选可选值(用于列筛选下拉)。
- 接口类型:REST 资源
- 请求方式:
POST - 请求路径:
/views/{viewId}/filterColumns - 鉴权:是(需 accessToken,据源码)
- Tag:视图执行模块
请求参数¶
| 参数名 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
| applicationId | path | string | 是 | 应用Id(DES 加密密文) |
| viewId | path | string | 是 | 视图Id(DES 加密密文) |
| parentId | query | string | 否 | 父Id |
| isRelate | query | string | 否 | 是否父子关系 |
| fieldName | query | string | 是 | 筛选字段名称 |
| content | body | string | 否 | 请求包体 |
响应¶
data:List,该列可选值集合。