钉钉开发文档

获取单个审批实例

更新时间: 2019-2-18

根据审批实例id调用此接口获取审批实例详情,详情包括审批表单信息、操作记录列表、操作人、抄送人、审批任务列表。

请求方式:POST(HTTPS)
请求地址https://oapi.dingtalk.com/topapi/processinstance/get?access_token=ACCESS_TOKEN
参数说明

名称 类型 是否必须 示例值 描述
process_instance_id String 必须 1a2b-3e4d 审批实例id

SDK请求示例(JAVA)

DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/processinstance/get");
OapiProcessinstanceGetRequest request = new OapiProcessinstanceGetRequest();
request.setProcessInstanceId("1a2b-3e4d");
OapiProcessinstanceGetResponse response = client.execute(request,accessToken);

返回结果

{
    "errcode":0,
    "errmsg":"成功",
    "process_instance":{
        "title":"实例标题",
        "create_time":"2018-11-21 12:00:00",
        "finish_time":"2018-11-21 12:00:00",
        "originator_userid":"manager1",
        "originator_dept_id":"1",
        "status":"NEW",
        "cc_userids":"manager1,manager2",
        "form_component_values":[
            {
                    "name":"名称",
                    "value":"示例值",
                    "ext_value":"示例值"
            }
        ],
        "result":"agree",
        "business_id":"2017111111",
        "operation_records":[
            {
                    "userid":"manager1",
                    "date":"2018-11-21 12:00:00",
                    "operation_type":"EXECUTE_TASK_NORMAL",
                    "operation_result":"AGREE",
                    "remark":"评论"
            }
        ],
        "tasks":[
            {
                    "userid":"manager1",
                    "task_status":"NEW",
                    "task_result":"REDIRECTED",
                    "create_time":"2018-11-21 12:00:00",
                    "finish_time":"2018-11-21 12:00:00",
                    "taskid":"1497249"
            }
        ],
        "originator_dept_name":"测试",
        "biz_action":"MODIFY",
        "attached_process_instance_ids":"instance1,instance2"
    }
}
参数
说明
errcode
返回码
errmsg
对返回码的文本描述内容
process_instance
实例详情
└ title
审批实例标题
└ create_time
开始时间。
└ finish_time
结束时间。
└ originator_userid
发起人
└ originator_dept_id
发起部门
└ status
审批状态,分为
NEW(刚创建)|RUNNING(运行中)|TERMINATED(被终止)|COMPLETED(完成)|CANCELED(取消)
└ cc_userids
抄送人
└ form_component_values
表单详情列表
└ name
标签名
└ value
标签值
└ ext_value
标签扩展值
└ result
审批结果,分为 agree 和 refuse
└ business_id
审批实例业务编号
└ operation_records
操作记录列表
└ userid
操作人
└ date
操作时间
└ operation_type
操作类型,分为
EXECUTE_TASK_NORMAL(正常执行任务),EXECUTE_TASK_AGENT(代理人执行任务),APPEND_TASK_BEFORE(前加签任务),APPEND_TASK_AFTER(后加签任务),REDIRECT_TASK(转交任务),START_PROCESS_INSTANCE(发起流程实例),TERMINATE_PROCESS_INSTANCE(终止(撤销)流程实例),FINISH_PROCESS_INSTANCE(结束流程实例),ADD_REMARK(添加评论)
└ operation_result
操作结果,分为
AGREE(同意),REFUSE(拒绝)
└ remark
评论
└ tasks
已审批任务列表,可以通过此列表获取已审批人
└ userid
任务处理人
└ task_status
任务状态,分为
NEW(未启动),RUNNING(处理中),PAUSED(暂停),CANCELED(取消),COMPLETED(完成),TERMINATED(终止)
└ task_result
结果,分为
AGREE(同意),REFUSE(拒绝),REDIRECTED(转交)
└ create_time
开始时间。yyyy-MM-dd HH:mm:ss格式
└ finish_time
结束时间。yyyy-MM-dd HH:mm:ss格式
└ taskid
任务节点id
└ originator_dept_name
发起部门
└ biz_action
审批实例业务动作,MODIFY表示该审批实例是基于原来的实例修改而来,REVOKE表示该审批实例对原来的实例进行撤销,NONE表示正常发起
└ attached_process_instance_ids
审批附属实例列表,当已经通过的审批实例被修改或撤销,会生成一个新的实例,作为原有审批实例的附属。如果想知道当前已经通过的审批实例的状态,可以依次遍历它的附属列表,查询里面每个实例的biz_action
以上内容是否对您有帮助:
在文档使用中是否遇到以下问题(多选):
  • 内容错误
  • 更新不及时
  • 链接错误
  • 缺少代码/图片示例
  • 太简单/步骤待完善
手机号
更多建议
提交成功,感谢您的反馈!