查询待办列表

用于获取单个用户的任务列表数据；

接口说明

请求URL：http[s]://{网关地址}/casp-tdc/task/search

请求方式： POST

请求内容类型： application/json

响应内容类型： application/json

请求说明

请求体

字段名	参数名	必填	类型	描述
查询类型	type	M	integer	1：待办 2: 已办
每页数量	pageSize	M	integer	每页数量（默认10）
页码	pageNumber	M	integer	页码（默认1）
用户工号	userId	M	String(50)	用户工号
应用ID	appId	O	String(128)	应用ID
业务场景编码	bizSceneCode	O	String(128)	业务场景编码
业务场景编码列表3.9.1.SP6+	bizSceneCodeList	O	List<String>	业务场景编码列表，当此字段有值时bizSceneCode字段不生效
主题关键字	subject	O	String(300)	主题关键字
任务类型	taskType	O	integer	1：待阅 2：分发 3：普通 4：内部待阅3.7.3.Beta1+ 5：内部分发3.7.3.Beta1+
紧急程度	priority	O	integer	1：特急 2：紧急 3：一般
开始时间	startTime	O	String	开始时间（yyyy-MM-dd HH:mm:ss）
结束时间	endTime	O	String	结束时间（yyyy-MM-dd HH:mm:ss）
服务ID 3.4.3+	serviceId	O	String(128)	服务ID
是否忽略	isIgnore	O	integer	0：正常 1：忽略
是否过期	isExpire	O	integer	0：正常 1：已过期
多语言 3.5.5.Beta2+	langCountry	O	String	zh_CN（简体中文，默认） en（英文） ru（俄文）
任务类型列表 3.5.4.SP6+	taskTypeList	O	List<Integer>	1：待阅 2：分发 3：普通 4：内部待阅3.7.3.Beta1+ 5：内部分发3.7.3.Beta1+

请求示例

{
    "type":1,
    "pageSize":100,
    "pageNumber":1,
    "userId":"test-gh",
    "langCountry":"en",
    "taskTypeList":[1,2]
}

响应说明

响应体

字段名	参数名	类型	描述
返回码	errcode	String	返回码
返回描述	errmsg	String	返回描述
任务列表	datas	List<Task>	任务列表
页码	pageNumber	Long	页码
每页记录数	pageSize	Long	每页记录数
总页数	pages	Long	总页数
总记录数	total	Long	总记录数

Task

字段名	参数名	类型	描述
应用ID	appId	String	应用ID
应用名称	appName	String	应用名称
待办任务技术主键	taskId	String	由待办中心生成的任务表主键字段，taskWid
第三方任务ID 3.4.1+	realTaskId	String	待办任务业务主键，由第三方提供
任务主题	subject	String	任务主题
任务类型代码	taskTypeCode	integer	1：待阅 2：分发 3：普通 4：内部待阅3.7.3.Beta1+ 5：内部分发3.7.3.Beta1+
任务类型	taskType	String	待阅 分发 普通 4：内部待阅3.7.3.Beta1+ 5：内部分发3.7.3.Beta1+
紧急程度代码	priorityCode	integer	1：特急 2：紧急 3：一般
紧急程度	priority	String	一般 紧急 特急
pc待办任务链接	pcViewUrl	String	pc待办任务链接
h5待办任务链接	h5ViewUrl	String	h5待办任务链接
发起人工号	initiatorId	String	发起人工号
发起人姓名	initiatorName	String	发起人姓名
发起人部门	initiatorDept	String	发起人部门
业务场景名称	sceneName	String	业务场景名称
接收时间	createTime	String	接收时间
流程图URL地址	processInstanceImgUrl	String	流程图URL地址
是否忽略状态	isIgnoreStatus	integer	0（正常） 1（忽略）
是否忽略文字	isIgnore	integer	正常（0） 忽略（1）
是否过期状态	isExpireStatus	integer	0（已过期） 1（正常）
是否过期文字	isExpire	String	已过期（0） 正常（1）
过期时间	expireTime	String	过期时间
是否已读	isRead	integer	0：未读 1：已读
是否置顶 3.4.3+	isTop	integer	0：未置顶 1：置顶
服务ID 3.4.3+	serviceId	String	服务ID
服务名称 3.4.3+	serviceName	String	服务名称
消息ID 3.7.4.SP9+	msgId	String	任务关联的消息ID（可用于同步消息已读状态）

响应示例

{
    "pageNumber": 1,
    "pageSize": 100,
    "total": 1,
    "pages": 1,
    "errcode": "0",
    "errmsg": "success",
    "traceId": null,
    "datas": [
        {
            "appName": "newAppPg0",
            "appId": "998543444844220416",
            "realTaskId": "taskExp02",
            "taskId": "1551482168826753026",
            "subject": "taskSub02",
            "taskType": "普通",
            "taskTypeCode": "3",
            "priority": "一般",
            "isIgnore": "正常",
            "initiatorId": "01111178",
            "initiatorName": "彭涛(01111178)",
            "initiatorDept": null,
            "isIgnoreStatus": "0",
            "isExpire": "正常",
            "isExpireStatus": "1",
            "sceneName": "testRe1",
            "status": "进行中",
            "expireTime": "2022-07-30T14:00:00",
            "createTime": "2022-07-25T16:19:08.813",
            "updateTime": "2022-07-25T16:19:08.854",
            "pcViewUrl": null,
            "h5ViewUrl": null,
            "processInstanceImgUrl": null,
            "sourceType": "1",
            "bizDomain": null,
            "priorityCode": "3",
            "statusCode": "ACTIVE",
            "isRead": "0",
            "isTop": "0",
            "serviceId": null,
            "serviceName": null,
            "msgId": "1111"
        }
    ]
}

错误码

错误码	描述
376999	系统异常，详细描述信息参见接口返回
999	统一错误码，详细描述信息参见接口返回

Demo

java

// 创建客户端
Client client = new DefaultClient(BASE_URL, APP_ID, APP_SECRET);
// 创建请求对象
TaskSearchRequest request = new TaskSearchRequest();
request.setType(TaskSearchType.TODO_TASK);
request.setUserId("xxx");
request.setPageNumber(1);
request.setPageSize(10);
TaskSearchResponse response = client.execute(request);
//调用成功，则处理业务逻辑
if (response.isSuccess()) {
    //.....
}