任务相关接口(新)
1. 查询任务
- 请求地址: /wf/biz/task
- 请求方式:GET
- 输入参数:
参数名称 |
必选 |
类型 |
描述 |
filter |
否 |
String |
过滤条件,例如 SA_Task.sName='张三' AND SA_Task.sProcess='xx' |
offset |
否 |
Int |
偏移量,默认值是0 |
limit |
否 |
Int |
分页大小,默认值20,-1表示所有数据 |
distinct |
否 |
Boolean |
去除重复行,默认值false |
columns |
否 |
String |
返回列,默认所有列 |
orderBy |
否 |
String |
排序方式,例如 sName DESC,sProcess ASC |
variabels |
否 |
JSONObject |
变量,例如 {"justep.shard": "histroy"} |
** 返回头
Content-Type: application/json
Content-Range: 分页信息,例如0-19/100
** 返回体
[{
"id": "主键",
"sName": "名称",
...
}]
2. 根据组织查询任务
- 请求地址: /wf/biz/task/queryByOrg
- 请求方式:GET
- 输入参数:
参数名称 |
必选 |
类型 |
描述 |
filter |
否 |
String |
过滤条件,例如 SA_Task.sName='张三' AND SA_Task.sProcess='xx' |
offset |
否 |
Int |
偏移量,默认值是0 |
limit |
否 |
Int |
分页大小,默认值20,-1表示所有数据 |
distinct |
否 |
Boolean |
去除重复行,默认值false |
columns |
否 |
String |
返回列,默认所有列 |
orderBy |
否 |
String |
排序方式,例如 sName DESC,sProcess ASC |
variabels |
否 |
JSONObject |
变量,例如 {"justep.shard": "histroy"} |
status |
否 |
String |
任务状态,取值范围["waiting"、 "finished"、 "submited"],默认值"waiting";允许多值,使用“,”分隔 |
org |
否 |
String |
组织范围,可以是组织的ID或FID,默认是当前人;允许多值,使用“,”分隔 |
** 返回头
Content-Type: application/json
Content-Range: 分页信息,例如0-19/100
** 返回体
[{
"id": "主键",
"sName": "名称",
...
}]
3. 更新任务
- 请求地址: /wf/biz/task
- 请求方式:POST
- 输入参数:
参数名称 |
必选 |
类型 |
描述 |
请求体 |
是 |
JSONObject |
任务信息, id表示主键, 其它属性名参考任务概念的属性列表。有两个特殊的属性名executeCode, creatorCode |
{
"id": "主键",
"sName": "名称",
"executeCode": "xx"
}
4. 查询任务数
- 请求地址: /wf/biz/task/count
- 请求方式:GET
- 输入参数:
参数名称 |
必选 |
类型 |
描述 |
filter |
否 |
String |
过滤条件,例如 SA_Task.sName='张三' |
status |
否 |
String |
任务状态,取值范围["waiting"、 "finished"、 "submited"],默认值"waiting";允许多值,使用“,”分隔 |
org |
否 |
String |
组织范围,可以是组织的ID或FID,默认是当前人;允许多值,使用“,”分隔 |
5. 执行任务
- 请求地址: /wf/biz/task/execute
- 请求方式:POST
- 输入参数:
参数名称 |
必选 |
类型 |
描述 |
task |
是 |
String |
任务标识 |
executor |
是 |
String |
执行者信息,组织FID |
{
"task": "任务标识",
"executor": "组织FID"
}
6. 新建任务
- 请求地址: /wf/biz/task
- 请求方式:PUT
- 输入参数:
参数名称 |
必选 |
类型 |
描述 |
name |
是 |
String |
任务名称 |
executorFIDs |
是 |
List |
执行者信息,组织FID列表 |
data |
是 |
String |
业务数据标识 |
process |
是 |
String |
关联的流程 |
activity |
是 |
String |
关联的环节 |
curl |
是 |
String |
查看地址 |
eurl |
是 |
String |
处理地址 |
options |
否 |
JSONObject |
其它任务属性 |
kind |
是 |
String |
任务类型,取值范围["notice", "task"] |
mode |
否 |
String |
任务模式,取值范围["together", "singleness"],"together"表示有多个执行人时形成父子任务,"singleness"表示有多个执行人时形成独立的任务 |
{
"name": "",
"executorFIDs": [],
"data": "",
"process": "",
"activity": "",
"curl": "",
"eurl": "",
"options": {},
"kind": "notice",
"mode": "together"
}
7. 任务提醒
- 请求地址: /wf/biz/task/remind
- 请求方式:POST
- 输入参数:
参数名称 |
必选 |
类型 |
描述 |
task |
是 |
String |
任务标识 |
channel |
否 |
String |
提醒方式 |
templateCode |
否 |
String |
提醒使用的模板,默认使用"TASK_MANAGE" |