dingtalk.oapi.processinstance.list (获取审批实例列表)

企业可以根据审批流的唯一标识,分页获取该审批流对应的审批实例。只能取到权限范围内的相关部门的审批实例

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
process_code String 必须 PROC-FF6YR2IQO2-NP3LJ1J0SO4182NKX26K3-3N23J-PB 流程模板唯一标识,可在oa后台编辑审批表单部分查询
start_time Number 必须 1496678400000 审批实例开始时间,毫秒级
end_time Number 可选 1496678400000 审批实例结束时间,毫秒级,默认取当前值
size Number 可选 10
  • 默认值:10
  • 分页参数,每页大小,最多传10
    cursor Number 可选 0
  • 默认值:0
  • 分页查询的游标,最开始传0,后续传返回参数中的next_cursor值
    userid_list String [] 可选 manager1,manager2
  • 最大列表长度:20
  • 发起人用户id列表

    响应参数

    名称 类型 示例值 描述
    result PageResult result
    • list
    • ProcessInstanceTopVo []
    • list
    • └ process_instance_id
    • String
    • cbf290af-fc41-4368-bdd7-8b52a28bc
    • 审批实例id
    • └ title
    • String
    • 测试
    • 标题
    • └ create_time
    • Date
    • 1497249913000
    • 开始时间
    • └ finish_time
    • Date
    • 1497249913000
    • 结束时间
    • └ originator_userid
    • String
    • 08051744586
    • 发起人userid
    • └ originator_dept_id
    • String
    • -1
    • 发起人部门id
    • └ status
    • String
    • RUNNING
    • 审批状态,分为NEW(刚创建)|RUNNING(运行中)|TERMINATED(被终止)|COMPLETED(完成)|CANCELED(取消)
    • └ approver_userid_list
    • String []
    • 0874458646137
    • 审批人列表
    • └ cc_userid_list
    • String []
    • 0874458646137
    • 抄送人列表
    • └ process_instance_result
    • String
    • agree
    • 审批结果,分为agree和refuse
    • └ business_id
    • String
    • 201711111111
    • 流程实例业务编号
    • form_component_values
    • FormComponentValueVo []
    • 审批表单变量组
    • └ name
    • String
    • 测试标签
    • 表单标签名
    • └ value
    • String
    • 测试值
    • 表单标签值
    • └ id
    • String
    • 234
    • 组件id
    • └ ext_value
    • String
    • 123
    • 表单额外值
    • └ component_type
    • String
    • DDSelectField
    • 组件类型
    • └ next_cursor
    • Number
    • 2
    • 表示下次查询的游标,当返回结果没有该字段时表示没有更多数据了
    errcode Number 0 errcode
    errmsg String ok errmsg

    请求示例

    • JAVA
    • .NET
    • PHP
    • CURL
    • Python
    • C/C++
    • NodeJS
    DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/processinstance/list");
    OapiProcessinstanceListRequest req = new OapiProcessinstanceListRequest();
    req.setProcessCode("PROC-FF6YR2IQO2-NP3LJ1J0SO4182NKX26K3-3N23J-PB");
    req.setStartTime(1496678400000L);
    req.setEndTime(1496678400000L);
    req.setSize(10L);
    req.setCursor(0L);
    req.setUseridList("manager1,manager2");
    OapiProcessinstanceListResponse rsp = client.execute(req, access_token);
    System.out.println(rsp.getBody());

    响应示例

    • JSON示例
    {
        "result":{
            "list":[
                {
                        "process_instance_id":"cbf290af-fc41-4368-bdd7-8b52a28bc",
                        "title":"测试",
                        "create_time":"1497249913000",
                        "finish_time":"1497249913000",
                        "originator_userid":"08051744586",
                        "originator_dept_id":"-1",
                        "status":"RUNNING",
                        "approver_userid_list":{
                            "string":[
                                "0874458646137"
                            ]
                        },
                        "cc_userid_list":{
                            "string":[
                                "0874458646137"
                            ]
                        },
                        "process_instance_result":"agree",
                        "business_id":"201711111111",
                        "form_component_values":[
                            {
                                    "name":"测试标签",
                                    "value":"测试值",
                                    "id":"234",
                                    "ext_value":"123",
                                    "component_type":"DDSelectField"
                            }
                        ]
                }
            ],
            "next_cursor":2
        },
        "errcode":0,
        "errmsg":"ok"
    }

    异常示例

    • JSON示例
    {
    	"errcode":88,
    	"errmsg":"ding talk error"
    }

    错误码解释

    错误码 错误描述 解决方案

    API工具

    如何获得此API

    FAQ

    返回
    顶部