文档中心 > API类目 > 钉钉API

dingtalk.oapi.processinstance.get (获取单个审批实例详情)

根据审批实例id，获取审批实例详情，详情包括审批表单信息、操作记录列表、操作人、抄送人、审批任务列表

公共参数

环境	HTTP请求地址	HTTPS请求地址
正式环境	http://gw.api.taobao.com/router/rest	https://eco.taobao.com/router/rest

名称	类型	是否必须	描述
access_token	String	是	钉钉提供的授权Token，想了解详情，ISV开发者请点击这里，企业开发者请点击这里。若有疑问，咨询邮箱dingding_open_dingtalk#list.alibaba-inc.com。

请求参数

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

响应参数

名称	类型	示例值	描述
errcode	Number	0	errcode
errmsg	String	ok	errmsg
process_instance	ProcessInstanceTopVo		实例详情
└ title String 实例标题审批实例标题 └ create_time Date 1497249913000 开始时间 └ finish_time Date 1497249913000 结束时间 └ originator_userid String manager1 发起人 └ originator_dept_id String 1 发起部门 └ status String NEW 审批状态，分为NEW（刚创建）\|RUNNING（运行中）\|TERMINATED（被终止）\|COMPLETED（完成）\|CANCELED（取消） └ approver_userids String [] manager1 审批人 └ cc_userids String [] manager1 抄送人 └ result String agree 审批结果，分为agree和refuse └ business_id String 2017111111 审批实例业务编号 operation_records OperationRecordsVo [] 操作记录列表 └ userid String manager1 操作人 └ date Date 1497249913000 时间 └ operation_type String EXECUTE_TASK_NORMAL 操作类型，分为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 String AGREE 操作结果，分为AGREE（同意），REFUSE（拒绝） └ remark String 评论评论 attachments Attachment [] 评论附件 └ file_name String 附件名称附件名称 └ file_size String 大小大小 └ file_id String id id └ file_type String 类型类型 tasks TaskTopVo [] 任务列表 └ userid String manager1 任务处理人 └ task_status String NEW 任务状态，分为NEW（未启动），RUNNING（处理中），PAUSED（暂停），CANCELED（取消），COMPLETED（完成），TERMINATED（终止） └ task_result String REDIRECTED 结果，分为AGREE（同意），REFUSE（拒绝），REDIRECTED（转交） └ create_time Date 1497249913000 开始时间 └ finish_time Date 1497249913000 结束时间 └ taskid String 1497249 任务id └ url String https://www.dingtalk.com 任务url └ activity_id String 1234_abcd 节点id └ originator_dept_name String 测试发起部门 └ biz_action String MODIFY 审批实例业务动作,MODIFY表示该审批实例是基于原来的实例修改而来，REVOKE表示该审批实例是由原来的实例撤销后重新发起的,NONE表示正常发起 └ attached_process_instance_ids String [] instance1,instance2 审批附属实例列表，当已经通过的审批实例被修改或撤销，会生成一个新的实例，作为原有审批实例的附属。如果想知道当前已经通过的审批实例的状态，可以依次遍历它的附属列表，查询里面每个实例的biz_action form_component_values FormComponentValueVo [] 表单详情列表 └ name String 名称标签名 └ value String 示例值标签值 └ ext_value String 示例值标签扩展值 └ id String abcdefg 组件id └ component_type String DDSelectField 组件类型 └ main_process_instance_id String instance 主流程实例标识

请求示例

JAVA
.NET
PHP
CURL
Python
C/C++
NodeJS

DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/processinstance/get");
OapiProcessinstanceGetRequest req = new OapiProcessinstanceGetRequest();
req.setProcessInstanceId("1a2b-3e4d");
OapiProcessinstanceGetResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());

IDingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/processinstance/get");
OapiProcessinstanceGetRequest req = new OapiProcessinstanceGetRequest();
req.ProcessInstanceId = "1a2b-3e4d";
OapiProcessinstanceGetResponse rsp = client.Execute(req, access_token);
Console.WriteLine(rsp.Body);

include "TopSdk.php";
date_default_timezone_set('Asia/Shanghai');

$c = new DingTalkClient(DingTalkConstant::$CALL_TYPE_OAPI, DingTalkConstant::$METHOD_POST , DingTalkConstant::$FORMAT_JSON);
$req = new OapiProcessinstanceGetRequest;
$req->setProcessInstanceId("1a2b-3e4d");
$resp = $c->execute($req, $access_token, "https://oapi.dingtalk.com/topapi/processinstance/get");

curl -X POST "https://oapi.dingtalk.com/topapi/processinstance/get" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=e3cd721d-1131-4142-98e6-77d48c5db45d' \
-d 'process_instance_id=1a2b-3e4d'

# -*- coding: utf-8 -*-
import dingtalk.api

req=dingtalk.api.OapiProcessinstanceGetRequest("https://oapi.dingtalk.com/topapi/processinstance/get")

req.process_instance_id="1a2b-3e4d"
try:
	resp= req.getResponse(access_token)
	print(resp)
except Exception,e:
	print(e)

pTopRequest pRequest = alloc_top_request();
pTopResponse pResponse = NULL;
pTaobaoClient pClient = alloc_taobao_client(url, appkey, appsecret);
set_api_name(pRequest,"dingtalk.oapi.processinstance.get");
add_param(pRequest,"process_instance_id","1a2b-3e4d");
pResponse = top_execute(pClient,pRequest,sessionKey);
printf("ret code:%d\n",pResponse->code);
if(pResponse->code == 0){
	pTopResponseIterator ite = init_response_iterator(pResponse);
	pResultItem pResultItem = alloc_result_item();
	while(parseNext(ite, pResultItem) == 0){
		printf("%s:%s\n",pResultItem->key,pResultItem->value);
	}
	destroy_response_iterator(ite);
	destroy_result_item(pResultItem);
}
destroy_top_request(pRequest);
destroy_top_response(pResponse);
destroy_taobao_client(pClient);

TopClient = require('./topClient').TopClient;
var client = new TopClient({
	'appkey': 'appkey',
	'appsecret': 'secret',
	'REST_URL': 'http://gw.api.taobao.com/router/rest'
});

client.execute('dingtalk.oapi.processinstance.get', {
	'process_instance_id':'1a2b-3e4d'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

响应示例

JSON示例

{
    "errcode":0,
    "errmsg":"ok",
    "process_instance":{
        "title":"实例标题",
        "create_time":"1497249913000",
        "finish_time":"1497249913000",
        "originator_userid":"manager1",
        "originator_dept_id":"1",
        "status":"NEW",
        "approver_userids":{
            "string":[
                "manager1"
            ]
        },
        "cc_userids":{
            "string":[
                "manager1"
            ]
        },
        "result":"agree",
        "business_id":"2017111111",
        "operation_records":[
            {
                    "userid":"manager1",
                    "date":"1497249913000",
                    "operation_type":"EXECUTE_TASK_NORMAL",
                    "operation_result":"AGREE",
                    "remark":"评论",
                    "attachments":[
                        {
                                "file_name":"附件名称",
                                "file_size":"大小",
                                "file_id":"id",
                                "file_type":"类型"
                        }
                    ]
            }
        ],
        "tasks":[
            {
                    "userid":"manager1",
                    "task_status":"NEW",
                    "task_result":"REDIRECTED",
                    "create_time":"1497249913000",
                    "finish_time":"1497249913000",
                    "taskid":"1497249",
                    "url":"https:\/\/www.dingtalk.com",
                    "activity_id":"1234_abcd"
            }
        ],
        "originator_dept_name":"测试",
        "biz_action":"MODIFY",
        "attached_process_instance_ids":{
            "string":[
                "instance1",
                "instance2"
            ]
        },
        "form_component_values":[
            {
                    "name":"名称",
                    "value":"示例值",
                    "ext_value":"示例值",
                    "id":"abcdefg",
                    "component_type":"DDSelectField"
            }
        ],
        "main_process_instance_id":"instance"
    }
}

异常示例

JSON示例

{
	"errcode":88,
	"errmsg":"ding talk error"
}

错误码解释

错误码	错误描述	解决方案

API工具

API测试工具错误码查询工具 SDK下载

如何获得此API

FAQ

我要提问

返回
顶部

淘宝开放平台

钉钉API

dingtalk.oapi.processinstance.get (获取单个审批实例详情)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ