工作流模块

一、工作流查询代办列表

接口地址 https://www.yingxiongyun.com/workflow/api/v1/t/agent/getList

请求方式 GET

consumes ["application/json"]

produces ["*/*"]

接口描述 ``

请求参数

参数名称	参数说明	请求类型	是否必须	数据类型
keyword	搜索词	query	false	string
appId	应用id	query	false	string
type	代办类型 TODO:代办 COPY:抄送,可用值:START,TODO,COPY,BUS_NODE	query	false	string
handleStatus	处理状态(TODO:代办 TIME_OUT:已超时 URGE_HANDLE:催办 FALL_BACK:回退 STAGING:暂存),可用值:TODO,TIME_OUT,URGE_HANDLE,FALL_BACK,STAGING	query	false	string
status	代办状态(RUNNING:进行中 COMPLETE:已完成),可用值:RUNNING,COMPLETE,AUTO_COMPLETE,MANUAL_STOP	query	false	string
agentBusType	代办业务类型(ME:我的代办 STATR:我发起的 HANDLE:我处理的),可用值:ME,START,HANDLE	query	false	string
isRead	0 全部 1 已读 2 未读	query	false	integer

响应状态

状态码	说明	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
body	分页数据	array	代办响应数据
pageNum	当前页数	integer(int32)
pageSize	每页条数	integer(int32)
total	总条数	integer(int64)

代办响应数据

参数名称	参数说明	类型	schema
agentId	代办id	string
appId		string
busHistoryActivity	历史流程流转记录	流程运行记录详情	流程运行记录详情
commentList	代办评论	array	代办评论响应数据
content	内容	string
createdAt	创建时间	string(date-time)
dataId	数据id	string
formId	表单id	string
handleMember	处理人	成员响应数据	成员响应数据
handleMemberId	处理人id	array
handleMemberList	处理人列表	array	成员响应数据
handleStatus	代办处理状态,可用值:TODO,TIME_OUT,URGE_HANDLE,FALL_BACK,STAGING	string
id	代办id	string
isFullAudit	是否会审	boolean
nodeName	节点名称	string
preViewDataList	预览视图数据	array	Map«string,object»
processInstanceId	流程实例id	string
read	true 已读 false 未读	boolean
realHandleMember	实际处理人	成员响应数据	成员响应数据
realHandleMemberId	实际处理人id	array
realHandleMemberList	实际处理人	array	成员响应数据
startMember	发起人	成员响应数据	成员响应数据
startMemberId	发起人id	string
status	代办状态,可用值:RUNNING,COMPLETE,AUTO_COMPLETE,MANUAL_STOP	string
tableId	表单id	string
taskId	任务id	string
title	标题	string
type	代办类型,可用值:START,TODO,COPY,BUS_NODE	string
viewComponentResponse	预览视图数据	视图组件响应	视图组件响应

流程运行记录详情

参数名称	参数说明	类型	schema
busHistoricActivityInstanceList	历史流转节点	array	业务活动详情
consumeTime	花费时间	string
createdAt	开始时间	string(date-time)
currActivity	当前运行节点	业务活动详情	业务活动详情
durationTime	消耗时间	integer(int64)
finishAt	完成时间	string(date-time)
runtimeActivityList	运行节点	array	业务活动详情
status	流程状态	string

业务活动详情

参数名称	参数说明	类型	schema
activityId	活动id	string
activityName	活动名称	string
activityType	活动类型	string
auditMessageList	审批消息	array	审批消息响应数据
consumeTime	花费时间	string
durationInMillis	活动消耗时间	integer(int64)
endTime	结束时间	string(date-time)
handleMemberIdList	当前处理人	array
handleMemberList	处理人	array	成员响应数据
realHandleMemberId	实际处理人id	array
realHandleMemberList	实际处理人	array	成员响应数据
startTime	开始时间	string(date-time)
status	任务状态	string
taskId	任务id	string

审批消息响应数据

参数名称	参数说明	类型
agentId	代办id	string
auditMember	审批成员	string
auditType	审批类型(PS: 1.成员 2.自动)	string
comment	审批评论	string
remark	审批备注	string
status	审批状态(YES：审批通过 NO：审批不通过),可用值:YES,NO,AUTO_AUDIT,AUTO_REJECT,ERROR_EXIT	string
statusName	审批状态-名称	string
taskId	任务id	string

成员响应数据

参数名称	参数说明	类型	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

部门响应数据

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

角色响应数据

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

代办评论响应数据

参数名称	参数说明	类型
agentId	代办id	string
comment	评论内容	string
createdAt	创建时间	string(date-time)

Map«string,object»

参数名称	参数说明	类型	schema

视图组件响应

参数名称	参数说明	类型	schema
buttonList	表单按钮	array	ButtonFormResponse
components	组件列表	array	组件响应体
form	表单	表单响应体	表单响应体
record	记录	object

ButtonFormResponse

参数名称	参数说明	类型
action	按钮执行动作	string
id	id	string
name	按钮名称	string
style	按钮样式	object
targetFormId	目标表单	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

表单响应体

参数名称	参数说明	类型	schema
applicationId	应用ID	string
authGroups	权限组	array	授权组响应体
button	按钮	string
color	颜色	string
components	组件集合	array	组件响应体
content	提交提示	string
defaultTemplate	默认标题字段	string
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
cond	过滤条件	array	过滤条件实体
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
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

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": {
        "body": [
            {
                "agentId": "",
                "appId": "",
                "busHistoryActivity": {
                    "busHistoricActivityInstanceList": [
                        {
                            "activityId": "",
                            "activityName": "",
                            "activityType": "",
                            "auditMessageList": [
                                {
                                    "agentId": "",
                                    "auditMember": "",
                                    "auditType": "",
                                    "comment": "",
                                    "remark": "",
                                    "status": "",
                                    "statusName": "",
                                    "taskId": ""
                                }
                            ],
                            "consumeTime": "",
                            "durationInMillis": 0,
                            "endTime": "",
                            "handleMemberIdList": [],
                            "handleMemberList": [
                                {
                                    "avatar": "",
                                    "code": "",
                                    "deptDetails": [
                                        {
                                            "children": [
                                                {
                                                    "children": [
                                                        {}
                                                    ],
                                                    "description": "",
                                                    "disabled": false,
                                                    "enableReadOrManageFlag": false,
                                                    "id": "",
                                                    "name": "",
                                                    "parentId": "",
                                                    "rootNode": false
                                                }
                                            ],
                                            "description": "",
                                            "disabled": false,
                                            "enableReadOrManageFlag": false,
                                            "id": "",
                                            "name": "",
                                            "parentId": "",
                                            "rootNode": false
                                        }
                                    ],
                                    "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": ""
                                }
                            ],
                            "realHandleMemberId": [],
                            "realHandleMemberList": [
                                {}
                            ],
                            "startTime": "",
                            "status": "",
                            "taskId": ""
                        }
                    ],
                    "consumeTime": "",
                    "createdAt": "",
                    "currActivity": {},
                    "durationTime": 0,
                    "finishAt": "",
                    "runtimeActivityList": [
                        {}
                    ],
                    "status": ""
                },
                "commentList": [
                    {
                        "agentId": "",
                        "comment": "",
                        "createdAt": ""
                    }
                ],
                "content": "",
                "createdAt": "",
                "dataId": "",
                "formId": "",
                "handleMember": {},
                "handleMemberId": [],
                "handleMemberList": [
                    {}
                ],
                "handleStatus": "",
                "id": "",
                "isFullAudit": false,
                "nodeName": "",
                "preViewDataList": [
                    {}
                ],
                "processInstanceId": "",
                "read": false,
                "realHandleMember": {},
                "realHandleMemberId": [],
                "realHandleMemberList": [
                    {}
                ],
                "startMember": {},
                "startMemberId": "",
                "status": "",
                "tableId": "",
                "taskId": "",
                "title": "",
                "type": "",
                "viewComponentResponse": {
                    "buttonList": [
                        {
                            "action": "",
                            "id": "",
                            "name": "",
                            "style": {},
                            "targetFormId": ""
                        }
                    ],
                    "components": [
                        {
                            "applicationId": "",
                            "description": "",
                            "formId": "",
                            "hint": "",
                            "id": "",
                            "key": "",
                            "lineWidth": 0,
                            "name": "",
                            "tab": "",
                            "titleFlag": false,
                            "type": "",
                            "widget": {}
                        }
                    ],
                    "form": {
                        "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": [
                                    {}
                                ],
                                "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": [
                                    {}
                                ],
                                "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": "",
                        "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": []
                            }
                        ]
                    },
                    "record": {}
                }
            }
        ],
        "pageNum": 0,
        "pageSize": 0,
        "total": 0
    },
    "message": "",
    "timestamp": 0
}

二、工作流单条查询

接口地址 https://www.yingxiongyun.com/workflow/api/v1/t/agent/queryDetail/{agentId}

请求方式 GET

consumes ["application/json"]

produces ["*/*"]

接口描述 获取一条记录

请求参数

参数名称	参数说明	请求类型	是否必须	数据类型	schema
agentId	agentId	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
agentId	代办id	string
appId		string
busHistoryActivity	历史流程流转记录	流程运行记录详情	流程运行记录详情
commentList	代办评论	array	代办评论响应数据
content	内容	string
createdAt	创建时间	string(date-time)
dataId	数据id	string
formId	表单id	string
handleMember	处理人	成员响应数据	成员响应数据
handleMemberId	处理人id	array
handleMemberList	处理人列表	array	成员响应数据
handleStatus	代办处理状态,可用值:TODO,TIME_OUT,URGE_HANDLE,FALL_BACK,STAGING	string
id	代办id	string
isFullAudit	是否会审	boolean
nodeName	节点名称	string
preViewDataList	预览视图数据	array	Map«string,object»
processInstanceId	流程实例id	string
read	true 已读 false 未读	boolean
realHandleMember	实际处理人	成员响应数据	成员响应数据
realHandleMemberId	实际处理人id	array
realHandleMemberList	实际处理人	array	成员响应数据
startMember	发起人	成员响应数据	成员响应数据
startMemberId	发起人id	string
status	代办状态,可用值:RUNNING,COMPLETE,AUTO_COMPLETE,MANUAL_STOP	string
tableId	表单id	string
taskId	任务id	string
title	标题	string
type	代办类型,可用值:START,TODO,COPY,BUS_NODE	string
viewComponentResponse	预览视图数据	视图组件响应	视图组件响应

流程运行记录详情

参数名称	参数说明	类型	schema
busHistoricActivityInstanceList	历史流转节点	array	业务活动详情
consumeTime	花费时间	string
createdAt	开始时间	string(date-time)
currActivity	当前运行节点	业务活动详情	业务活动详情
durationTime	消耗时间	integer(int64)
finishAt	完成时间	string(date-time)
runtimeActivityList	运行节点	array	业务活动详情
status	流程状态	string

业务活动详情

参数名称	参数说明	类型	schema
activityId	活动id	string
activityName	活动名称	string
activityType	活动类型	string
auditMessageList	审批消息	array	审批消息响应数据
consumeTime	花费时间	string
durationInMillis	活动消耗时间	integer(int64)
endTime	结束时间	string(date-time)
handleMemberIdList	当前处理人	array
handleMemberList	处理人	array	成员响应数据
realHandleMemberId	实际处理人id	array
realHandleMemberList	实际处理人	array	成员响应数据
startTime	开始时间	string(date-time)
status	任务状态	string
taskId	任务id	string

审批消息响应数据

参数名称	参数说明	类型
agentId	代办id	string
auditMember	审批成员	string
auditType	审批类型(PS: 1.成员 2.自动)	string
comment	审批评论	string
remark	审批备注	string
status	审批状态(YES：审批通过 NO：审批不通过),可用值:YES,NO,AUTO_AUDIT,AUTO_REJECT,ERROR_EXIT	string
statusName	审批状态-名称	string
taskId	任务id	string

成员响应数据

参数名称	参数说明	类型	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

部门响应数据

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

角色响应数据

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

代办评论响应数据

参数名称	参数说明	类型
agentId	代办id	string
comment	评论内容	string
createdAt	创建时间	string(date-time)

Map«string,object»

参数名称	参数说明	类型	schema

视图组件响应

参数名称	参数说明	类型	schema
buttonList	表单按钮	array	ButtonFormResponse
components	组件列表	array	组件响应体
form	表单	表单响应体	表单响应体
record	记录	object

ButtonFormResponse

参数名称	参数说明	类型
action	按钮执行动作	string
id	id	string
name	按钮名称	string
style	按钮样式	object
targetFormId	目标表单	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

表单响应体

参数名称	参数说明	类型	schema
applicationId	应用ID	string
authGroups	权限组	array	授权组响应体
button	按钮	string
color	颜色	string
components	组件集合	array	组件响应体
content	提交提示	string
defaultTemplate	默认标题字段	string
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
cond	过滤条件	array	过滤条件实体
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
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

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": {
        "agentId": "",
        "appId": "",
        "busHistoryActivity": {
            "busHistoricActivityInstanceList": [
                {
                    "activityId": "",
                    "activityName": "",
                    "activityType": "",
                    "auditMessageList": [
                        {
                            "agentId": "",
                            "auditMember": "",
                            "auditType": "",
                            "comment": "",
                            "remark": "",
                            "status": "",
                            "statusName": "",
                            "taskId": ""
                        }
                    ],
                    "consumeTime": "",
                    "durationInMillis": 0,
                    "endTime": "",
                    "handleMemberIdList": [],
                    "handleMemberList": [
                        {
                            "avatar": "",
                            "code": "",
                            "deptDetails": [
                                {
                                    "children": [
                                        {
                                            "children": [
                                                {}
                                            ],
                                            "description": "",
                                            "disabled": false,
                                            "enableReadOrManageFlag": false,
                                            "id": "",
                                            "name": "",
                                            "parentId": "",
                                            "rootNode": false
                                        }
                                    ],
                                    "description": "",
                                    "disabled": false,
                                    "enableReadOrManageFlag": false,
                                    "id": "",
                                    "name": "",
                                    "parentId": "",
                                    "rootNode": false
                                }
                            ],
                            "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": ""
                        }
                    ],
                    "realHandleMemberId": [],
                    "realHandleMemberList": [
                        {}
                    ],
                    "startTime": "",
                    "status": "",
                    "taskId": ""
                }
            ],
            "consumeTime": "",
            "createdAt": "",
            "currActivity": {},
            "durationTime": 0,
            "finishAt": "",
            "runtimeActivityList": [
                {}
            ],
            "status": ""
        },
        "commentList": [
            {
                "agentId": "",
                "comment": "",
                "createdAt": ""
            }
        ],
        "content": "",
        "createdAt": "",
        "dataId": "",
        "formId": "",
        "handleMember": {},
        "handleMemberId": [],
        "handleMemberList": [
            {}
        ],
        "handleStatus": "",
        "id": "",
        "isFullAudit": false,
        "nodeName": "",
        "preViewDataList": [
            {}
        ],
        "processInstanceId": "",
        "read": false,
        "realHandleMember": {},
        "realHandleMemberId": [],
        "realHandleMemberList": [
            {}
        ],
        "startMember": {},
        "startMemberId": "",
        "status": "",
        "tableId": "",
        "taskId": "",
        "title": "",
        "type": "",
        "viewComponentResponse": {
            "buttonList": [
                {
                    "action": "",
                    "id": "",
                    "name": "",
                    "style": {},
                    "targetFormId": ""
                }
            ],
            "components": [
                {
                    "applicationId": "",
                    "description": "",
                    "formId": "",
                    "hint": "",
                    "id": "",
                    "key": "",
                    "lineWidth": 0,
                    "name": "",
                    "tab": "",
                    "titleFlag": false,
                    "type": "",
                    "widget": {}
                }
            ],
            "form": {
                "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": [
                            {}
                        ],
                        "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": [
                            {}
                        ],
                        "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": "",
                "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": []
                    }
                ]
            },
            "record": {}
        }
    },
    "message": "",
    "timestamp": 0
}

三、工作流待办同意

接口地址 https://www.yingxiongyun.com/workflow/api/v1/t/audit/message/approved

请求方式 POST

consumes ["application/json"]

produces ["*/*"]

接口描述 审批通过（同意）

请求参数

参数名称	参数说明	请求类型	是否必须	数据类型	schema
body	body	body	true	审批消息创建请求体	审批消息创建请求体

schema属性说明

审批消息创建请求体

参数名称	参数说明	请求类型	是否必须	数据类型
agentId	代办id	body	false	string
auditMember	审批成员	body	false	string
auditType	审批类型(PS: 1.成员 2.自动)	body	false	string
comment	审批评论	body	false	string
fields	记录值	body	false	object
formId	工作表ID	body	false	string
recordId	记录id	body	false	string
remark	审批备注	body	false	string

响应状态

状态码	说明	schema
200	OK	响应结果对象«审批消息响应数据»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数

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

schema属性说明

审批消息响应数据

参数名称	参数说明	类型
agentId	代办id	string
auditMember	审批成员	string
auditType	审批类型(PS: 1.成员 2.自动)	string
comment	审批评论	string
remark	审批备注	string
status	审批状态(YES：审批通过 NO：审批不通过),可用值:YES,NO,AUTO_AUDIT,AUTO_REJECT,ERROR_EXIT	string
statusName	审批状态-名称	string
taskId	任务id	string

响应示例


xxxxxxxxxx
{
    "code": 0,
    "data": {
        "agentId": "",
        "auditMember": "",
        "auditType": "",
        "comment": "",
        "remark": "",
        "status": "",
        "statusName": "",
        "taskId": ""
    },
    "message": "",
    "timestamp": 0
}

四、工作流待办拒绝

接口地址 https://www.yingxiongyun.com/workflow/api/v1/t/audit/message/rejected

请求方式 POST

consumes ["application/json"]

produces ["*/*"]

接口描述 审批通过（同意）

请求参数

参数名称	参数说明	请求类型	是否必须	数据类型	schema
body	body	body	true	审批消息创建请求体	审批消息创建请求体

schema属性说明

审批消息创建请求体

参数名称	参数说明	请求类型	是否必须	数据类型
agentId	代办id	body	false	string
auditMember	审批成员	body	false	string
auditType	审批类型(PS: 1.成员 2.自动)	body	false	string
comment	审批评论	body	false	string
fields	记录值	body	false	object
formId	工作表ID	body	false	string
recordId	记录id	body	false	string
remark	审批备注	body	false	string
status	审批状态,可用值:YES,NO,AUTO_AUDIT,AUTO_REJECT,ERROR_EXIT	body	false	string
taskId	任务id	body	false	string

响应状态

状态码	说明	schema
200	OK	响应结果对象«审批消息响应数据»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数

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

schema属性说明

审批消息响应数据

参数名称	参数说明	类型
agentId	代办id	string
auditMember	审批成员	string
auditType	审批类型(PS: 1.成员 2.自动)	string
comment	审批评论	string
remark	审批备注	string
status	审批状态(YES：审批通过 NO：审批不通过),可用值:YES,NO,AUTO_AUDIT,AUTO_REJECT,ERROR_EXIT	string
statusName	审批状态-名称	string
taskId	任务id	string

响应示例


{
    "code": 0,
    "data": {
        "agentId": "",
        "auditMember": "",
        "auditType": "",
        "comment": "",
        "remark": "",
        "status": "",
        "statusName": "",
        "taskId": ""
    },
    "message": "",
    "timestamp": 0
}