API开发文档 - 道一云

开发说明

开发说明

功能说明：根据页面参数paramSearchType和通讯录账号，获取该用户应用数据列表，包括待办，已办，相关，抄送，我提交等。
请求方式：POST（HTTPS）
请求地址：https://qwif.do1.com.cn/qwcgi/api/apiForm/getWorkOrderListByType.do?token=token&wxUserId=wxUserId&page=1&pageSize=10&status=1&paramSearchType=3&corpId=corpId

请求包体：

{
	"auditEndTime":"2023-06-01 12:00:00",
	"auditStartTime":"2022-12-01 12:00:00",
	"commentStatus":"HAS_NOT_READ",
	"createaEndTime":"2023-06-01 12:00:00",
	"createaStartTime":"2022-12-01 12:00:00",
	"definitionVersionsId":"form表单id",
	"departId":"提单人部门id",
	"formTitle":"表单标题",
	"orderBy":2
}

请求参数说明：

参数名	释义	类型	是否必须	描述
token	用于验证	String	是	参考获取token接口
corpId	公司唯一标识	String	是
wxUserId	通讯录账号	String	是
page	页码	Integer	否
pageSize	分页大小	Integer	否
workOrderSearchVOJson	高级查询参数	FormWorkOrderSearchVO	否	格式参考请求包体
status	工单提交状态	Integer	否	仅对"我提交列表"有效，0:草稿,1:已提交(默认)
paramSearchType	页面参数	Integer	是	0: 我相关的外部单 1: 我负责的外部单 2：我提交的 3：总待办 4：相关（相关+负责+抄送-我提交） 5：待处理 6：已处理 7：抄送我 8：未阅抄送 10: 可见明细 11：我负责的（负责+抄送） 12：我相关的

FormWorkOrderSearchVO类型说明：

参数名	释义	类型	是否必须	描述
formTitle	标题，模糊搜索	String	否
createaStartTime	提单时间（始）	String	否	yyyy-MM-dd HH:mm:ss
createaEndTime	提单时间（终）	String	否	yyyy-MM-dd HH:mm:ss
auditStartTime	最后修改时间（始）	String	否	yyyy-MM-dd HH:mm:ss
auditEndTime	最后修改时间（终）	String	否	yyyy-MM-dd HH:mm:ss
isFinish	完成状态，仅对我提交列表生效	Integer	否	0:未完成，1:已完成
isTask	表单类型	String	否	0:普通单,1:任务单,2:流程单,3:外部单
auditStatus	审批状态	Integer	否	1:审批中，2:已审批，3:退审，5:已关闭
departId	提单人部门id	String	否
commentStatus	阅读状态	CommentStatusEnum	否	HAS_NOT_READ:未读,HAS_READ:已读
definitionVersionsId	form表单id	String	否
orderBy	排序	Integer	否	1:最早处理，2:最新处理

SDK调用示例：

		FormApi api = QwSdkUtil.getInter(FormApi.class);
		FormWorkOrderSearchVO formWorkOrderSearchVO = new FormWorkOrderSearchVO();
        formWorkOrderSearchVO.setFormTitle("表单标题");
		// 排序
		formWorkOrderSearchVO.setOrderBy(2);
        formWorkOrderSearchVO.setDepartId("提单人部门id");
		formWorkOrderSearchVO.setAuditStartTime("2022-12-01 12:00:00");
		formWorkOrderSearchVO.setAuditEndTime("2023-06-01 12:00:00");
		// form表单id
		formWorkOrderSearchVO.setDefinitionVersionsId("form表单id");
		// 阅读状态
		formWorkOrderSearchVO.setCommentStatus(CommentStatusEnum.HAS_NOT_READ);
		// 提单时间范围
		formWorkOrderSearchVO.setCreateaStartTime("2022-12-01 12:00:00");
		formWorkOrderSearchVO.setCreateaEndTime("2023-06-01 12:00:00");
		GetWorkOrderListByTypeResultVO resultVO = api.getWorkOrderListByType(QwSdkUtil.getCacheToken(),
				"通讯录账号",
				1,
				10,
				formWorkOrderSearchVO,
				1,
				5
		);

		System.out.println(JSONUtil.objectToString(resultVO));

返回结果：

{
	"code": "0",
	"desc": "成功",
	"data": {
		"maxPage": 1,
		"currPage": 1,
		"totalRows": 1,
		"pageSize": 10,
		"pageData": [{
			"approvers": "当前负责人姓名",
			"createaTime": "2023-05-12 11:15:44",
			"creator": "提单人userId",
			"currentNode": "当前节点",
			"currentNodeId": "当前节点id",
			"definitionId": "版本id",
			"entrust": false,
			"formTitle": "标题",
			"headPic": "提单人头像",
			"id": "work工单明细id",
			"instanceTitle": "明细标题",
			"isAnonymous": 0,
			"isClose": "0",
			"isRead": 0,
			"isTask": "2",
			"isover": "审批状态",
			"orderVersion": 1,
			"personName": "提单人姓名",
			"status": 1,
			"detailUrl": "https://..."
			"wxUserId": "提单人通讯录账号"
		}]
	}
}

返回参数说明：

参数名	释义	类型	是否必须
maxPage	总页数	Integer	是
currPage	当前页码	Integer	是
totalRows	总行数	Integer	是
pageSize	分页大小	Integer	是
pageData	分页数据	TBFormWorkOrderVO[]	是

TBFormWorkOrderVO类型说明：

参数名	释义	类型	是否必须	描述
id	work工单明细id	String	是
definitionId	defn表单版本id	String	是
status	提交状态	Integer	是	0:草稿,1:已提交
creator	提单人userId	String	否
wxUserId	提单人通讯录账号	String	否
personName	提单人姓名	String	否
headPic	提单人头像URL	String	否
departmentName	提单人部门名称	String	否
deptFullName	提单人部门全称	String	否
createaTime	提单时间	String	是	yyyy-MM-dd HH:mm:ss
closePerson	最后处理人	String	否
closePersonName	最后处理人姓名	String	否
closeTime	最后更新时间	String	否	yyyy-MM-dd HH:mm:ss
formName	表单名称	String	否
title	表单标题	String	是
isClose	关闭状态	Integer	是	0:未关闭,1:已关闭
versions	表单版本号	Integer	是
isover	审批状态	String	是	-1:关闭;0:退审;1:全部审核通过;2:流转中
instanceTitle	明细标题	String	否
approvers	当前处理人	String	否
isTask	表单类型	String	是	0:普通单,1:任务单,2:流程单,3:外部单
currentNode	当前节点名称	String	否	并行流程处理中处于多个节点中时，多个用英文逗号隔开
currentNodeId	当前节点id	String	否	并行流程处理中处于多个节点中时，多个用英文逗号隔开
isAnonymous	提单人是否匿名提交	Integer	否	0:否,1:是
wxNickname	微信昵称，外部单授权获取	String	否
openId	公众号openid，外部单授权获取	String	否
orderVersion	工单版本号	Integer	是	每修改一次数据，该版本号自增1
isFree	流程类型	String	否	1:表示自由流程 2:表示固定流程 3:表示分支流程
detailUrl	应用端详情明细地址	String	是
isRead	是否已阅	Integer	否	抄送列表返回，0：已阅 1：未阅

企业微信

获取应用填写详细数据（待办、已办等）

开发说明