查询我的待办调试
1. 简介
1.1 接口简介
该接口可以获取用户当前的流程待办信息。
1.2 接口版本
接口版本 | 更新时间 | 版本说明 |
v1 | 2022.10.12 | 原始接口 |
v1 | 2022.10.28 | 接口频率由 5 次/秒调整为 30 次/秒 |
v2 | 2023.03.02 | 调整部分参数名:
|
V3 | 2023.03.17 | 新增 flow_id、flow_name 两个响应参数。 |
V4 | 2023.09.18 | 新增 3 个响应参数,如下所示:
|
V5 | 2023.12.01 | 新增 2 个响应参数,如下所示:
|
2. 接口调用
该接口用来获取用户当前待办信息。
请求地址:https://api.jiandaoyun.com/api/v5/workflow/task/list
请求频率:30 次/秒
请求方式:POST
请求参数:
参数 | 必须 | 类型 | 说明 |
username | 是 | String | 用户名,即成员编号 |
limit | 否 | Number | 分页参数,页大小 默认 10 最大 100 |
skip | 否 | Number | 分页参数,跳过前面数据条数 默认 0 |
请求示例:
{
"username": "xiaoyun",
"skip": 0,
"limit": 10
}
响应参数:
参数 | 类型 | 说明 |
has_more | Boolean | 后面是否还有数据 |
tasks | Object[] | 待办列表 |
tasks[].app_id | String | 应用 id |
tasks[].form_id | String | 表单 id |
tasks[].task_id | String | 待办 id |
tasks[].instance_id | String | 实例 id,同 data_id |
tasks[].form_title | String | 表单名称 |
tasks[].title | String | 待办名称 |
tasks[].flow_id | Number | 节点 id |
tasks[].flow_name | String | 节点名称 |
tasks[].url | String | 待办访问链接 |
tasks[].assignee | Object | 待办人信息同 成员实体结构 |
tasks[].creator | Object | 待办创建者信息同 成员实体结构 |
tasks[].create_time | String | 待办开始时间 |
tasks[].create_action | String | 创建待办的流程动作,枚举:
|
tasks[].finish_time | String | 待办结束时间 |
tasks[].finish_action | String | 完成待办的流程动作,恒为 null |
tasks[].status | Number | 待办状态,恒为 0(进行中) |
响应示例:
{
"has_more": false,
"tasks": [
{
"app_id": "628d8c0d73544c0006a54bfd",
"task_id": "63f31ae8144f4a09ec197163",
"form_id": "63ff33531c2f7e5fe8789b4b",
"instance_id": "628d8c0d73544c0006a54bfc",
"form_title": "待办测试表单标题",
"title": "待办标题",
"flow_id": 1,
"flow_name": "节点1"
"url": "",
"assignee": {
"username": "xiaoyun",
"name": "小云",
"departments": [
1,
3
],
"type": 0,
"status": 1,
"integrate_id": "xiaoyun"
},
"creator": {
"username": "xiaojian",
"name": "小简",
"departments": [
1,
3
],
"type": 0,
"status": 1,
"integrate_id": "xiaojian"
},
"create_time": "2022-10-26T13:18:57.605Z",
"create_action": "forward",
"finish_time": null,
"finish_action": null,
"status": 0
}
]
}