查询流程实例信息 - 简道云

查询流程实例信息调试

1. 简介

1.1 接口简介

该接口用来查询流程实例信息。

1.2 接口版本

接口版本	更新时间	版本说明
v1	2022.10.28	原始接口
V2	2023.03.02	调整部分参数名：新增应用 id：app_id；表单 id 的参数由entry_id 变更为form_id。
V3	2023.04.17	1）新增实例访问链接和待办列表参数名：实例访问链接：url；应用 id：tasks[].app_id；表单 id：tasks[].form_id；表单名称：tasks[].form_title；实例 id：tasks[].instance_id；待办 id：tasks[].task_id；待办访问链接：tasks[].url；实例创建者信息：tasks[].creator。 2）调整待办列表信息参数名待办列表参数由原来的 node_list 变更为 tasks；当前处理人信息 assignee_list 变更为待办人信息 tasks[].assignee；待办列表中，节点名称 node_list[].name 变更为 tasks[].flow_name；待办列表中，节点id node_list[].flow_id 变更为 tasks[].flow_id。 3）取消节点类型参数 node_list[].type。
V4	2023.09.18	1）新增请求参数返回待办种类：tasks_type； 2）新增响应参数，如下所示：结束时间：finish_time 待办名称：tasks[].title 待办开始时间：tasks[].create_time 待办结束时间：tasks[].finish_time 待办状态：tasks[].status
V5	2023.12.01	新增 2 个响应参数，如下所示：创建待办的流程动作：tasks[].create_action 完成待办的流程动作：tasks[].finish_action

2. 接口调用

该接口用来查询流程实例信息。

请求地址：https://api.jiandaoyun.com/api/v5/workflow/instance/get

请求频率：30 次/秒

请求方式：POST

请求参数:

参数	必须	类型	说明
instance_id	是	String	实例 id，同 data_id
tasks_type	否	number	返回待办种类，0 表示不返回；1 表示全部返回

请求示例：

{
    "instance_id": "63ff32d918fbc20007a4a082",
    "tasks_type":1
}

响应参数：

参数	类型	说明
url	String	实例访问链接
instance_id	String	实例 id
app_id	String	应用 id
form_id	String	表单 id
form_title	String	表单名称
update_time	String	实例修改时间
create_time	String	创建时间
finish_time	String	结束时间
creator	Object	创建者信息同成员实体结构
status	Number	实例状态，枚举： 0 - 进行中 1 - 流转完成 2 - 手动结束
tasks	Object	待办任务列表
tasks[].app_id	String	应用 id
tasks[].form_id	String	表单 id
tasks[].form_title	String	表单名称
tasks[].title	String	待办名称
tasks[].instance_id	String	实例 id
tasks[].task_id	String	待办 id
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	创建待办的流程动作，枚举： auto_approve：去重审批 forward：提交 back：回退 transfer：转交 revoke：撤回 activate：激活 auto_forward：超时自动提交 auto_back：超时自动回退 batch_forward：批量提交 batch_transfer：批量调整负责人 sign_before：前加签 sign_after：后加签 sign_parallel：并加签 invoke_plugin：插件执行
tasks[].finish_time	String	待办结束时间
tasks[].finish_action	String	完成待办的流程动作，枚举： auto_approve：去重审批 forward：提交 back：回退 close：关闭 transfer：转交 batch_forward：批量提交 sign_after：后加签
tasks[].status	Number	待办状态 0-进行中 1-已完成 2-手动结束 4-被激活 5-任务被暂停

响应示例：

{
    "app_id": "628d8c0d73544c0006a54bfd",
    "form_id": "63f31ae8144f4a09ec197163",
    "form_title": "物品信息借用",
    "instance_id": "63ff32d918fbc20007a4a082",
    "url": "https://www.jiandaoyun.com/workflow/process_instance/63ff32d918fbc20007a4a082",
    "update_time": "2022-10-26T13:18:57.605Z",
    "create_time": "2022-10-26T13:11:45.087Z",
    "finish_time": null,
    "status": 0,
    "creator": {
        "username": "xiaojian",
        "name": "小简",
        "departments": [
            1
        ],
        "type": 0,
        "status": 1
    },
    "tasks": [
        {
            "app_id": "628d8c0d73544c0006a54bfd",
            "form_id": "63f31ae8144f4a09ec197163",
            "form_title": "物品信息借用",
            "title": "流程发起节点",
            "instance_id": "63ff32d918fbc20007a4a082",
            "task_id": "63f31ae8144f4a09ec197162",
            "flow_id": 0,
            "flow_name": "流程发起节点",
            "url": "https://www.jiandaoyun.com/workflow/process_instance/63ff32d918fbc20007a4a082/task/63f31ae8144f4a09ec197162",
            "assignee": {
                "username": "xiaoyun",
                "name": "小云",
                "departments": [
                    1
                ],
                "type": 0,
                "status": 1
            },
            "creator": {
                "username": "xiaojian",
                "name": "小简",
                "departments": [
                    1
                ],
                "type": 0,
                "status": 1
            },
            "create_time": "2022-10-26T13:11:45.087Z",
            "create_action": "forward",
            "finish_time": 2022-10-26T13:11:45.087Z,
            "finish_action": "forward",
            "status": 1
         },
        {
            "app_id": "628d8c0d73544c0006a54bfd",
            "form_id": "63f31ae8144f4a09ec197163",
            "form_title": "物品信息借用",
            "title": "审批",
            "instance_id": "63ff32d918fbc20007a4a082",
            "task_id": "63f31ae8144f4a09ec197163",
            "flow_id": 2,
            "flow_name": "审批",
            "url": "https://www.jiandaoyun.com/workflow/process_instance/63ff32d918fbc20007a4a082/task/63f31ae8144f4a09ec197163",
            "assignee": {
                "username": "xiaoyun",
                "name": "小云",
                "departments": [
                    1
                ],
                "type": 0,
                "status": 1
            },
            "creator": {
                "username": "xiaojian",
                "name": "小简",
                "departments": [
                    1
                ],
                "type": 0,
                "status": 1
            },
            "create_time": "2022-10-26T13:18:57.605Z",
            "create_action": "forward",
            "finish_time": null,
            "finish_action": null,
            "status": 0
        }
    ]
}

3. 注意事项

部分流程动态，如子流程、插件节点以及抄送节点，不可获取该接口。