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

dingtalk.oapi.process.instance.terminate (通过实例id终止流程)

通过审批实例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。

请求参数

名称	类型	是否必须	示例值	更多限制	描述
request	TerminateProcessInstanceRequestV2	必须			终止审批请求
└ process_instance_id String 必须 a171de6c-2b8b-45e1-8c8b-515c1628ce02 审批实例 └ is_system Boolean 必须 false 是否系统调用 └ remark String 可选说明说明 └ operating_userid String 可选 133743186427339452 操作人工号

响应参数

名称	类型	示例值	描述
result	Boolean	true	终止成功
success	Boolean	true	调用成功
errcode	Number	820004	流程不存在code
errmsg	String	流程不存在	错误提示

请求示例

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

DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/process/instance/terminate");
OapiProcessInstanceTerminateRequest req = new OapiProcessInstanceTerminateRequest();
TerminateProcessInstanceRequestV2 obj1 = new TerminateProcessInstanceRequestV2();
obj1.setProcessInstanceId("a171de6c-2b8b-45e1-8c8b-515c1628ce02");
obj1.setIsSystem(false);
obj1.setRemark("说明");
obj1.setOperatingUserid("133743186427339452");
req.setRequest(obj1);
OapiProcessInstanceTerminateResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());

IDingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/process/instance/terminate");
OapiProcessInstanceTerminateRequest req = new OapiProcessInstanceTerminateRequest();
OapiProcessInstanceTerminateRequest.TerminateProcessInstanceRequestV2Domain obj1 = new OapiProcessInstanceTerminateRequest.TerminateProcessInstanceRequestV2Domain();
obj1.ProcessInstanceId = "a171de6c-2b8b-45e1-8c8b-515c1628ce02";
obj1.IsSystem = false;
obj1.Remark = "说明";
obj1.OperatingUserid = "133743186427339452";
req.Request_ = obj1;
OapiProcessInstanceTerminateResponse 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 OapiProcessInstanceTerminateRequest;
$request = new TerminateProcessInstanceRequestV2;
$request->process_instance_id="a171de6c-2b8b-45e1-8c8b-515c1628ce02";
$request->is_system="false";
$request->remark="说明";
$request->operating_userid="133743186427339452";
$req->setRequest($request);
$resp = $c->execute($req, $access_token, "https://oapi.dingtalk.com/topapi/process/instance/terminate");

curl -X POST "https://oapi.dingtalk.com/topapi/process/instance/terminate" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=bd847f9e-0c94-4ec7-a5bd-63ace4def3b6' \
-d 'request=null'

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

req=dingtalk.api.OapiProcessInstanceTerminateRequest("https://oapi.dingtalk.com/topapi/process/instance/terminate")

req.request=""
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.process.instance.terminate");
add_param(pRequest,"request","数据结构JSON示例");
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.process.instance.terminate', {
	'request':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

响应示例

JSON示例

{
    "result":true,
    "success":true,
    "errcode":820004,
    "errmsg":"流程不存在"
}

异常示例

JSON示例

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

错误码解释

错误码	错误描述	解决方案

API工具

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

如何获得此API

FAQ

我要提问

返回
顶部

淘宝开放平台

钉钉API

dingtalk.oapi.process.instance.terminate (通过实例id终止流程)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ