主题
创建待办任务 3.6.1.Beta2-
用于在应用下发起一个待办任务,可同时发起一条申请流程;
接口说明
请求URL:http[s]://{网关地址}/casp-tdc/task/add
请求方式: POST
请求内容类型: application/json
响应内容类型: application/json
请求说明
请求体
| 字段名 | 参数名称 | 必填 | 类型 | 描述 |
|---|---|---|---|---|
| 业务场景编码 | sceneCode | O | String(128) | 由英文、数字、下划线组成;用于关联对应的业务场景;可通过查询业务场景进行获取 |
| 第三方任务ID | taskId | M | String(64) | 任务业务主键,由第三方提供。业务系统唯一,由英文、数字、下划线组成,长度小于64位 |
| 任务主题 | subject | M | String(300) | 任务主题 |
| 紧急程度 | priority | M | integer | 1:特急 2:紧急 3:一般 用于展示标签在门户中,并快速筛选 |
| 任务类型 | taskType | M | integer | 1:待阅 2:分发 3:普通 4:内部待阅3.7.3.Beta1+ 5:内部分发3.7.3.Beta1+ 除普通类型外,待阅及分发流程办结后,任务继续保留待办(第三方业务特殊逻辑) |
| 过期时间 | expireTime | O | String | 过期时间(yyyy-MM-dd HH:mm:ss) |
| 发起人类型 | initiatorType | M | integer | 1:学工号 |
| 发起人ID | initiatorId | M | String(50) | 当initiatorType=1,传学工号 |
| 用户范围类型 | objectScope | O | integer | 1:校内用户(默认) 2:校外用户 |
| processors | M | Lis<Processor> | 处理人列表 | |
| 处理类型 | processType | O | integer | 1:只需要一个人处理 2:所有人都需处理 默认为1 |
| pc待办任务地址 | pcViewUrl | O | String(512) | pc待办任务地址,点击后的跳转地址,建议传入 |
| h5待办任务地址 | h5ViewUrl | O | String(512) | h5待办任务地址,点击后的跳转地址,建议传入 |
| 流程图地址 | processInstanceImgUrl | O | String(512) | 流程图地址,用于门户查看流程图,建议传入 |
| 流程记录地址 | processInstanceRecordUrl | O | String(512) | 流程记录地址,用于门户查看流转记录,建议传入 |
| 关联的申请主键 3.5.5.Beta1.SP1- | processInstanceWid | O | String(128) | 关联的申请主键(推送申请)接口返回的值 |
| 服务ID 3.4.3+ | serviceId | O | String(128) | 所属服务ID,用于统计和门户展示,建议传入 |
| 服务名称 3.4.3+ | serviceName | O | String(300) | 所属服务名称,用于统计和门户展示,建议传入 |
| 推送终端 3.5.2+ | terminalType | O | String | 0:不推送 1:钉钉 2:weLink (逗号隔开) 默认: 1,2 |
| 创建时间 3.5.5.Beta1+ | createTime | O | String | 任务创建时间,不填默认为系统当前时间 yyyy-MM-dd HH:mm:ss |
| applicationModel | O | ApplicationModel | 任务关联的申请信息 | |
| 任务主题多语言 3.5.5.Beta2+ | subjectMultiLangs | O | List<MultiLang> | 主题多语言 |
| 上一步处理人工号 3.5.4.SP6+ | prevProcessor | O | String(300) | 任务上一步处理人工号,多个以逗号隔开 (校内用户),用于门户展示,建议传入 |
| 上一步处理人工号 3.6.1.Beta2+ | outPrevProcessor | O | String(300) | 任务上一步处理人工号,多个以逗号隔开 (校外用户),用于门户展示,建议传入 |
| 字段名 | 参数名 | 必填 | 类型 | 描述 |
|---|---|---|---|---|
| 处理人类型 | processorType | M | integer | 1:学工号 |
| 处理人ID | processorId | M | String(50) | 当processorType=1,传学工号 |
| 用户范围类型 | objectScope | O | integer | 1:校内用户(默认) 2:校外用户 |
ApplicationModel(返回)
| 字段名 | 参数名 | 必填 | 类型 | 描述 |
|---|---|---|---|---|
| 第三方申请ID | processInstanceId | M | String(64) | 申请业务主键, 由第三方提供。业务系统唯一,由英文、数字、下划线组成,长度小于64位 |
| 发起人类型 | initiatorType | *M | integer | 1:学工号 |
| 发起人ID | initiatorId | *M | String(50) | 当initiatorType=1,传学工号 |
| 用户范围类型 | objectScope | O | integer | 1:校内用户(默认) 2:校外用户 |
| 申请主题 | subject | *M | String(300) | 申请主题 |
| 待处理人列表 | processors | *M | List<Processor> | 待处理人列表 (申请当前所在节点的处理人列表) |
| 当前节点名称 | nodeName | *M | String(40) | 当前节点名称 |
| 申请状态 | processInstanceStatus | *M | String | RUNNING(正常运行) COMPLETE(正常结束) ABORT(强行中止) DRAFT(草稿) REPLY(待重新提交) |
| 流程图地址 | processInstanceImgUrl | O | String(512) | 流程图地址,用于门户查看流程图,建议传入 |
| 流程记录地址 | processInstanceRecordUrl | O | String(512) | 流程记录地址,用于门户查看流转记录,建议传入 |
| pc申请任务地址 | pcViewUrl | O | String(512) | pc申请任务地址,点击后的跳转地址,建议传入 |
| h5申请任务地址 | h5ViewUrl | O | String(512) | h5申请任务地址,点击后的跳转地址,建议传入 |
| 服务ID | serviceId | O | String(128) | 所属服务ID,用于统计和门户展示,建议传入 |
| 服务名称 | serviceName | O | String(300) | 所属服务名称,用于统计和门户展示,建议传入 |
| 创建时间 3.5.5.Beta1+ | createTime | O | String | 申请创建时间,不填默认为系统当前时间 yyyy-MM-dd HH:mm:ss |
| 主题多语言 3.5.5.Beta2+ | subjectMultiLangs | O | List<MultiLang> | 主题多语言 |
提示
ApplicationModel中必填为*M的字段在首次创建申请任务时必填。后续创建待办任务时只需要传入processInstanceId字段用于关联此条申请任务和待办任务即可。
| 字段名 | 参数名称 | 必填 | 类型 | 描述 |
|---|---|---|---|---|
| 多语言国家 | langCountry | M | String | zh_CN(简体中文,默认) en(英文) ru(俄文) |
| 多语言值 | langValue | O | String | 多语言值 |
请求示例
json
{
"sceneCode": "testCode1",
"taskId": "taskExp01",
"subject": "taskSub01",
"priority": 3,
"taskType": 3,
"expireTime": "2022-07-30 14:00:00",
"initiatorType": 1,
"initiatorId": "user01",
"processors": [
{
"processorType": 1,
"processorId": "test-gh"
}
],
"processType": 1,
"applicationModel": {
"processInstanceId": "PIIDEXP0",
"initiatorType": 1,
"initiatorId": "test-gh",
"subject": "myExpSubj",
"processInstanceStatus": "RUNNING",
"nodeName": 666,
"processors": [
{
"processorType": 1,
"processorId": "test-gh"
}
],
"subjectMultiLangs": [
{
"langCountry": "en",
"langValue": "en-subject"
}
]
},
"subjectMultiLangs": [
{
"langCountry": "en",
"langValue": "en-subject"
}
],
"prevProcessor": "test_gh1,test_gh2"
}1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
响应说明
响应体
| 参数名 | 类型 | 描述 |
|---|---|---|
| errcode | String | 返回码 |
| errmsg | String | 返回描述 |
响应示例
json
{
"errcode": "0",
"errmsg": "success",
"traceId": null
}1
2
3
4
5
2
3
4
5
错误码
| 错误码 | 描述 |
|---|---|
| 371002 | 参数异常(详细描述信息参见接口返回) |
| 376999 | 系统异常,详细描述信息参见接口返回 |
| 999 | 统一错误码,详细描述信息参见接口返回 |
Demo
java
// 创建客户端
Client client = new DefaultClient(BASE_URL, APP_ID, APP_SECRET);
// 创建请求对象
TaskAddRequest request = new TaskAddRequest();
request.setTaskId("2024071501");
request.setInitiatorId("user01");
request.setInitiatorType(ProcessorType.USER_ACCOUNT);
request.setSubject("test主题");
request.setPriority(PriorityType.COMMON);
request.setTaskType(TaskType.COMMON);
request.setProcessors(Arrays.asList(new Processor("user02"), new Processor("user03")));
request.setProcessType(ProcessType.OR_SIGN);
request.setPcViewUrl("http://www.pc.url");
// 申请信息
ApplicationModel applicationModel = new ApplicationModel();
applicationModel.setProcessInstanceId("20240715");
applicationModel.setInitiatorType(ProcessorType.USER_ACCOUNT);
applicationModel.setInitiatorId("user01");
applicationModel.setSubject("test主题");
applicationModel.setProcessInstanceStatus(ProcessInstanceStatusType.RUNNING);
applicationModel.setNodeName("001");
applicationModel.setProcessors(Arrays.asList(new Processor("user02"), new Processor("user03")));
request.setApplicationModel(applicationModel);
BaseResponse response = client.execute(request);
//调用成功,则处理业务逻辑
if (response.isSuccess()) {
//.....
}1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29

