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

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

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

公共参数

请求地址：

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

公共请求参数：

名称	类型	是否必须	描述
method	String	是	API接口名称。
app_key	String	是	TOP分配给应用的AppKey。
target_app_key	String	否	被调用的目标AppKey，仅当被调用的API为第三方ISV提供时有效。
sign_method	String	是	签名的摘要算法，可选值为：hmac，md5。
sign	String	是	API输入参数签名结果，签名算法介绍请点击这里。
session	String	否	用户登录授权成功后，TOP颁发给应用的授权信息，详细介绍请点击这里。当此API的标签上注明：“需要授权”，则此参数必传；“不需要授权”，则此参数不需要传；“可选授权”，则此参数为可选。
timestamp	String	是	时间戳，格式为yyyy-MM-dd HH:mm:ss，时区为GMT+8，例如：2015-01-01 12:00:00。淘宝API服务端允许客户端请求最大时间误差为10分钟。
format	String	否	响应格式。默认为xml格式，可选值：xml，json。
v	String	是	API协议版本，可选值：2.0。
partner_id	String	否	合作伙伴身份标识。
simplify	Boolean	否	是否采用精简JSON返回格式，仅当format=json时有效，默认值为：false。

请求参数

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

响应参数

名称	类型	示例值	描述
result	DingOpenResult		result
└ ding_open_errcode Number 0 dingOpenErrcode └ error_msg String 成功 errorMsg └ success Boolean true success 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 评论评论 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 └ 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 示例值标签扩展值 └ component_type String DDSelectField 组件类型 └ id String 12344 组件id

请求示例

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

DingTalkClient client = new DefaultDingTalkClient("https://eco.taobao.com/router/rest");
SmartworkBpmsProcessinstanceGetRequest req = new SmartworkBpmsProcessinstanceGetRequest();
req.setProcessInstanceId("1a2b-3e4d");
SmartworkBpmsProcessinstanceGetResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());

IDingTalkClient client = new DefaultDingTalkClient("https://eco.taobao.com/router/rest");
SmartworkBpmsProcessinstanceGetRequest req = new SmartworkBpmsProcessinstanceGetRequest();
req.ProcessInstanceId = "1a2b-3e4d";
SmartworkBpmsProcessinstanceGetResponse 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_TOP, DingTalkConstant::$METHOD_POST , DingTalkConstant::$FORMAT_JSON);
$req = new SmartworkBpmsProcessinstanceGetRequest;
$req->setProcessInstanceId("1a2b-3e4d");
$resp = $c->execute($req, $access_token, "https://eco.taobao.com/router/rest");

curl -X POST "https://eco.taobao.com/router/rest" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'format=json' \
-d 'method=dingtalk.smartwork.bpms.processinstance.get' \
-d 'partner_id=apidoc' \
-d 'session=40b4c094-e018-4c2d-a3f2-565432ae2a13' \
-d 'timestamp=2025-04-24+15%3A31%3A32' \
-d 'v=2.0' \
-d 'process_instance_id=1a2b-3e4d'

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

req=dingtalk.api.SmartworkBpmsProcessinstanceGetRequest("https://eco.taobao.com/router/rest")

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.smartwork.bpms.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.smartwork.bpms.processinstance.get', {
	'process_instance_id':'1a2b-3e4d'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

响应示例

XML示例
JSON示例

<dingtalk_smartwork_bpms_processinstance_get_response>
    <result>
        <ding_open_errcode>0</ding_open_errcode>
        <error_msg>成功</error_msg>
        <success>true</success>
        <process_instance>
            <title>实例标题</title>
            <create_time>1497249913000</create_time>
            <finish_time>1497249913000</finish_time>
            <originator_userid>manager1</originator_userid>
            <originator_dept_id>1</originator_dept_id>
            <status>NEW</status>
            <approver_userids>
                <string>manager1</string>
            </approver_userids>
            <cc_userids>
                <string>manager1</string>
            </cc_userids>
            <result>agree</result>
            <business_id>2017111111</business_id>
            <operation_records>
                <operation_records_vo>
                    <userid>manager1</userid>
                    <date>1497249913000</date>
                    <operation_type>EXECUTE_TASK_NORMAL</operation_type>
                    <operation_result>AGREE</operation_result>
                    <remark>评论</remark>
                </operation_records_vo>
            </operation_records>
            <tasks>
                <task_top_vo>
                    <userid>manager1</userid>
                    <task_status>NEW</task_status>
                    <task_result>REDIRECTED</task_result>
                    <create_time>1497249913000</create_time>
                    <finish_time>1497249913000</finish_time>
                    <taskid>1497249</taskid>
                </task_top_vo>
            </tasks>
            <originator_dept_name>测试</originator_dept_name>
            <biz_action>MODIFY</biz_action>
            <attached_process_instance_ids>
                <string>instance1</string>
                <string>instance2</string>
            </attached_process_instance_ids>
            <form_component_values>
                <form_component_value_vo>
                    <name>名称</name>
                    <value>示例值</value>
                    <ext_value>示例值</ext_value>
                    <component_type>DDSelectField</component_type>
                    <id>12344</id>
                </form_component_value_vo>
            </form_component_values>
        </process_instance>
    </result>
</dingtalk_smartwork_bpms_processinstance_get_response>

{
    "dingtalk_smartwork_bpms_processinstance_get_response":{
        "result":{
            "ding_open_errcode":0,
            "error_msg":"成功",
            "success":true,
            "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":{
                    "operation_records_vo":[
                        {
                            "userid":"manager1",
                            "date":"1497249913000",
                            "operation_type":"EXECUTE_TASK_NORMAL",
                            "operation_result":"AGREE",
                            "remark":"评论"
                        }
                    ]
                },
                "tasks":{
                    "task_top_vo":[
                        {
                            "userid":"manager1",
                            "task_status":"NEW",
                            "task_result":"REDIRECTED",
                            "create_time":"1497249913000",
                            "finish_time":"1497249913000",
                            "taskid":"1497249"
                        }
                    ]
                },
                "originator_dept_name":"测试",
                "biz_action":"MODIFY",
                "attached_process_instance_ids":{
                    "string":[
                        "instance1",
                        "instance2"
                    ]
                },
                "form_component_values":{
                    "form_component_value_vo":[
                        {
                            "name":"名称",
                            "value":"示例值",
                            "ext_value":"示例值",
                            "component_type":"DDSelectField",
                            "id":"12344"
                        }
                    ]
                }
            }
        }
    }
}

异常示例

XML示例
JSON示例

<error_response>
    <code>50</code>
    <msg>Remote service error</msg>
    <sub_code>isv.invalid-parameter</sub_code>
    <sub_msg>非法参数</sub_msg>
</error_response>

{
	"error_response":{
		"msg":"Remote service error",
		"code":50,
		"sub_msg":"非法参数",
		"sub_code":"isv.invalid-parameter"
	}
}

错误码解释

错误码	错误描述	解决方案

API工具

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

如何获得此API

FAQ

我要提问

返回
顶部

钉钉API

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

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ

用户导航

用户反馈

用户反馈

用户反馈