表单模块

一、查询单个表单

接口地址 https://www.yingxiongyun.com/worksheet/api/v1/t/app/{applicationId}/forms/{formId}

请求方式 GET

consumes ["application/json"]

produces ["*/*"]

接口描述 查询表单信息

请求参数

参数名称	参数说明	请求类型	是否必须	数据类型	schema
applicationId	applicationId	path	true	string
formId	formId	path	true	string

响应状态

状态码	说明	schema
200	OK	响应结果对象«表单响应体»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数

参数名称	参数说明	类型	schema
code	结果码	integer(int32)	integer(int32)
data	结果数据	表单响应体	表单响应体
message	结果描述	string
timestamp	时间戳	integer(int64)	integer(int64)

schema属性说明

表单响应体

参数名称	参数说明	类型	schema
applicationId	应用ID	string
authGroups	权限组	array	授权组响应体
button	按钮	string
color	颜色	string
components	组件集合	array	组件响应体
content	提交提示	string
defaultTemplate	默认标题字段	string
deletedFlag	删除标识	boolean
description	备注	string
entryId	入口ID	string
hasAddBthFlag	继续添加按钮	boolean
hasFlowFlag	是否包含工作流	boolean
hasLastContent	保留上次的内容	boolean
icon	图标	string
iconColor	颜色	string
id	主键ID	string
isAggregateFlag	聚合表标识	boolean
layout	表单布局	string
linkForms	关联表单	array	表单响应体
mode	类型（defaultTemplate（默认模板） or template（自定义模板））,可用值:DEFAULT_TEMPLATE,TEMPLATE	string
model	继续提交类型,可用值:SYSTEM,CUSTOM	string
name	入口名称	string
publicFlag	公开标识	boolean
showFields	显示组件集合	array
showHiddenRuleList	显隐规则JSON	array	BasicDBObject
subformFlag	是否为子表单	boolean
tabs	标签列表	array	组件标签
template	自定义标题字段	string
templateConfig	模板配置	object
validators	验证数据（Ps：表单提交校验）	array	校验者

授权组响应体

参数名称	参数说明	类型	schema
applicationId	应用ID	string
authPerms	授权内容	授权参数	授权参数
buttonIdList	选择的按钮id集合	array
departments	部门集合	array	部门响应数据
description	详情	string
displayButtonIdList	列表显示的按钮id	array
enable	启用状态	boolean
entryId	入口ID	string
fieldAuth	字段授权（K，V）（Ps：1：可查看 2：可编辑）	object
filters	组件筛选	统一过滤条件构建	统一过滤条件构建
id	主键ID	string
members	成员集合	array	成员响应数据
name	授权组名称	string
prints	打印模板集合	array
roles	角色集合	array	角色响应数据
type	类型,可用值:ADD_ONLY,ADD_AND_MANAGE_OWN,ADD_AND_SELECT_ALL,MANAGE_ALL,SELECT_ALL,TRIGGER_FLOW,MANAGE_ALL_FLOW,SELECT_ALL_FLOW,SELECT_PANEL,CUSTOM	string
views	视图集合ID	array	视图响应体

授权参数

参数名称	参数说明	类型
batchPrintFlag	批量打印	boolean
batchUpdateFlag	批量更新	boolean
copyFlag	复制标识	boolean
createFlag	创建标识	boolean
deleteFlag	删除标识	boolean
exportFlag	导出标志	boolean
flowActivate	触发工作流	boolean
importFlag	导入标志	boolean
readFlag	读取标识	boolean
updateFlag	修改标识	boolean

部门响应数据

参数名称	参数说明	类型	schema
children	子节点列表	array	部门响应数据
description	描述	string
disabled	禁止选择	boolean
enableReadOrManageFlag	可见可管理	boolean
id	主键ID	string
name	部门名称	string
parentId	父部门id	string
rootNode	是否根节点	boolean

统一过滤条件构建

参数名称	参数说明	类型	schema
cond	过滤条件	array	过滤条件实体


xxxxxxxxxx
        | type         |     过滤类型,可用值:ANY,AND      |  string   |      |

过滤条件实体

参数名称	参数说明	类型	schema
childFilter	子条件组构建	统一过滤条件构建	统一过滤条件构建
fieldId	字段ID	string
formId	表单ID	string
groupFlag	单	组	boolean
hasCurrentUserFlag	包含当前用户	boolean
hasEmptyFlag	包含空	boolean
method	方法类型,可用值:NOT_EMPTY,EMPTY,IN,NOT_IN,ADD,SUBTRACT,MULTIPLY,DIVIDE,EQ,NEQ,GT,LT,GTE,LTE,RANGE,FORMULA,PANEL_RANGE,START,END,CONTAINS,NO_CONTAINS,ALL	string
mode	数据联动 - 类型,可用值:DEPEND,CUSTOM	string
parentFieldId	父组件ID	string
parentFormId	父表单ID	string
type	组件类型,可用值:TEXT,MULTILINE_TEXT,NUMBER,DATETIME,SINGLE_SELECT,MULTIPLE_SELECT,SINGLE_DROP_DOWN,MULTIPLE_DROP_DOWN,DIVIDER,ADDRESS,LOCATION,FILE,IMAGE,SUBFORM,LINK_QUERY,LINK_FIELD,SIGNATURE,SERIAL_NUMBER,TELEPHONE,OCR,BUTTON,SINGLE_MEMBER,MULTIPLE_MEMBER,SINGLE_DEPARTMENT,MULTIPLE_DEPARTMENT,FLOW_STATE,TASK_NODE	string
value	条件值	object
values	条件值	array

成员响应数据

参数名称	参数说明	类型	schema
avatar	头像	string
code	编号	string
deptDetails	部门详情列表	array	部门响应数据
deptManagerFlag	是否是部门主管	boolean
email	邮箱	string
gender	性别：man男，woman女	string
id	主键ID	string
isOwner	创建者标识	boolean
maindepartmentId	主部门ID	string
manageDept	管理部门(部门主管)	array
mobile	手机号	string
modifyCode	是否可修改编码	boolean
name	成员名称	string
nickname	昵称（别名）	string
phonePrefix	手机号码前缀	string
roleDetails	角色详情列表	array	角色响应数据
status	邀请状态 PENDING: 邀请中 ACCEPT: 接受 REFUSE: 拒绝,可用值:PENDING,ACCEPT,REFUSE	string
type	成员状态-RESIGN、已离职-ENABLE、已启用-INVITING、未激活（只有企业微信同步成员时才有的状态）-INACTIVE、邀请中-（非企业同步成员才有的状态）-INVITING、已停用-DEACTIVATE,可用值:RESIGN,ENABLE,INACTIVE,INVITING,DEACTIVATE	string
userKey	关联用户ID	string

角色响应数据

参数名称	参数说明	类型
departmentIds	部门id集合	array
departments	部门列表	array
description	角色描述	string
enableManageFlag	可管理	boolean
groupId	角色组主键id	string
id	主键ID	string
name	角色名称	string
status	角色状态 normal正常，deactivate停用	string

视图响应体

参数名称	参数说明	类型	schema
applicationId	应用ID	string
authGroups	权限组响应集合	array	权限组样式
filter	过滤条件	统一过滤条件构建	统一过滤条件构建
formId	表单ID	string
id	主键ID	string
imageUrl	图片地址	string
name	视图名称	string
publicFlag	公开视图标识	boolean
showFields	显示字段	array
sort	组件排序	array	组件实体
viewConfig	扩展类型	表单视图配置	表单视图配置

权限组样式

参数名称	参数说明	类型	schema
id	主键ID	string
name	权限组名称	string

组件实体

参数名称	参数说明	类型	schema
componentId	组件Id	string
type	排序类型,可用值:DESC,ASC,DEFAULT	string

表单视图配置

参数名称	参数说明	类型
coverLayoutType	封面布局,可用值:TOP,LEFT,RIGHT	string
fillType	封面布局,可用值:FILL_NONE,FILL_COVER,FILL_ROUND,FILL_RECTANGLE	string
imageComponentId	图片组件ID	string
pcViewType	Pc端视图类型,可用值:CARD,TABLE,KANBAN,GANTT	string
rowHeight	行高,可用值:AUTO,UP,LOW,MIDDLE	string
showLabelFlag	显示标题标识	boolean
showType	视图类型,可用值:ALL,CUSTOM	string
viewCardSize	图片位置,可用值:SMALL,MIDDLE,BIG	string

组件响应体

参数名称	参数说明	类型
applicationId	应用ID	string
description	描述	string
formId	表单ID	string
hint	信息提示	string
id	组件ID	string
key	组件临时Key	string
lineWidth	线宽	integer(int32)
name	组件名称	string
tab	组件标签	string
titleFlag	是否为标题字段	boolean
type	类型,可用值:TEXT,MULTILINE_TEXT,NUMBER,DATETIME,SINGLE_SELECT,MULTIPLE_SELECT,SINGLE_DROP_DOWN,MULTIPLE_DROP_DOWN,DIVIDER,ADDRESS,LOCATION,FILE,IMAGE,SUBFORM,LINK_QUERY,LINK_FIELD,SIGNATURE,SERIAL_NUMBER,TELEPHONE,OCR,BUTTON,SINGLE_MEMBER,MULTIPLE_MEMBER,SINGLE_DEPARTMENT,MULTIPLE_DEPARTMENT,FLOW_STATE,TASK_NODE	string
widget	扩展	object

BasicDBObject

参数名称	参数说明	类型	schema

组件标签

参数名称	参数说明	类型	schema
name	标签ID	string
title	标签标题	string

校验者

参数名称	参数说明	类型	schema
formula	计算公式	计算公式	计算公式
original	原始计算公式	string
remind	校验提示语	string
widgets	字段ID集合	array

计算公式

参数名称	参数说明	类型
formula	计算公式	string
text	计算公式	string
type	类型	string

响应示例


xxxxxxxxxx
{
    "code": 0,
    "data": {
        "applicationId": "",
        "authGroups": [
            {
                "applicationId": "",
                "authPerms": {
                    "batchPrintFlag": false,
                    "batchUpdateFlag": false,
                    "copyFlag": false,
                    "createFlag": false,
                    "deleteFlag": false,
                    "exportFlag": false,
                    "flowActivate": false,
                    "importFlag": false,
                    "readFlag": false,
                    "updateFlag": false
                },
                "buttonIdList": [],
                "departments": [
                    {
                        "children": [
                            {
                                "children": [
                                    {}
                                ],
                                "description": "",
                                "disabled": false,
                                "enableReadOrManageFlag": false,
                                "id": "",
                                "name": "",
                                "parentId": "",
                                "rootNode": false
                            }
                        ],
                        "description": "",
                        "disabled": false,
                        "enableReadOrManageFlag": false,
                        "id": "",
                        "name": "",
                        "parentId": "",
                        "rootNode": false
                    }
                ],
                "description": "",
                "displayButtonIdList": [],
                "enable": false,
                "entryId": "",
                "fieldAuth": {},
                "filters": {
                    "cond": [
                        {
                            "childFilter": {},
                            "fieldId": "",
                            "formId": "",
                            "groupFlag": false,
                            "hasCurrentUserFlag": false,
                            "hasEmptyFlag": false,
                            "method": "",
                            "mode": "",
                            "parentFieldId": "",
                            "parentFormId": "",
                            "type": "",
                            "value": {},
                            "values": []
                        }
                    ],
                    "type": ""
                },
                "id": "",
                "members": [
                    {
                        "avatar": "",
                        "code": "",
                        "deptDetails": [
                            {}
                        ],
                        "deptManagerFlag": false,
                        "email": "",
                        "gender": "",
                        "id": "",
                        "isOwner": false,
                        "maindepartmentId": "",
                        "manageDept": [],
                        "mobile": "",
                        "modifyCode": false,
                        "name": "",
                        "nickname": "",
                        "phonePrefix": "",
                        "roleDetails": [
                            {
                                "departmentIds": [],
                                "departments": [],
                                "description": "",
                                "enableManageFlag": false,
                                "groupId": "",
                                "id": "",
                                "name": "",
                                "status": ""
                            }
                        ],
                        "status": "",
                        "type": "",
                        "userKey": ""
                    }
                ],
                "name": "",
                "prints": [],
                "roles": [
                    {
                        "departmentIds": [],
                        "departments": [],
                        "description": "",
                        "enableManageFlag": false,
                        "groupId": "",
                        "id": "",
                        "name": "",
                        "status": ""
                    }
                ],
                "type": "",
                "views": [
                    {
                        "applicationId": "",
                        "authGroups": [
                            {
                                "id": "",
                                "name": ""
                            }
                        ],
                        "filter": {},
                        "formId": "",
                        "id": "",
                        "imageUrl": "",
                        "name": "",
                        "publicFlag": false,
                        "showFields": [],
                        "sort": [
                            {
                                "componentId": "",
                                "type": ""
                            }
                        ],
                        "viewConfig": {
                            "coverLayoutType": "",
                            "fillType": "",
                            "imageComponentId": "",
                            "pcViewType": "",
                            "rowHeight": "",
                            "showLabelFlag": false,
                            "showType": "",
                            "viewCardSize": ""
                        }
                    }
                ]
            }
        ],
        "button": "",
        "color": "",
        "components": [
            {
                "applicationId": "",
                "description": "",
                "formId": "",
                "hint": "",
                "id": "",
                "key": "",
                "lineWidth": 0,
                "name": "",
                "tab": "",
                "titleFlag": false,
                "type": "",
                "widget": {}
            }
        ],
        "content": "",
        "defaultTemplate": "",
        "deletedFlag": false,
        "description": "",
        "entryId": "",
        "hasAddBthFlag": false,
        "hasFlowFlag": false,
        "hasLastContent": false,
        "icon": "",
        "iconColor": "",
        "id": "",
        "isAggregateFlag": false,
        "layout": "",
        "linkForms": [
            {}
        ],
        "mode": "",
        "model": "",
        "name": "",
        "publicFlag": false,
        "showFields": [],
        "showHiddenRuleList": [
            {}
        ],
        "subformFlag": false,
        "tabs": [
            {
                "name": "",
                "title": ""
            }
        ],
        "template": "",
        "templateConfig": {},
        "validators": [
            {
                "formula": {
                    "formula": "",
                    "text": "",
                    "type": ""
                },
                "original": "",
                "remind": "",
                "widgets": []
            }
        ]
    },
    "message": "",
    "timestamp": 0
}