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

dingtalk.oapi.process.instance.cancel (作废已通过的审批单)

审批单通过以后，企业自有系统可以通过系统行为对该审批单置为作废状态

公共参数

环境	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	CancelProcessInstanceRequest	可选			入参
└ process_instance_id String 必须 abcd_1234 审批实例id └ remark String 可选请假系统操作了作废本次作废操作的系统描述，会在审批操作记录里已操作备注的形式展示出来 └ operator_name String 可选请假系统本次作废操作的发起者名字，通常指代系统名称

响应参数

名称	类型	示例值	描述
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/cancel");
OapiProcessInstanceCancelRequest req = new OapiProcessInstanceCancelRequest();
CancelProcessInstanceRequest obj1 = new CancelProcessInstanceRequest();
obj1.setProcessInstanceId("abcd_1234");
obj1.setRemark("请假系统操作了作废");
obj1.setOperatorName("请假系统");
req.setRequest(obj1);
OapiProcessInstanceCancelResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());

IDingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/process/instance/cancel");
OapiProcessInstanceCancelRequest req = new OapiProcessInstanceCancelRequest();
OapiProcessInstanceCancelRequest.CancelProcessInstanceRequestDomain obj1 = new OapiProcessInstanceCancelRequest.CancelProcessInstanceRequestDomain();
obj1.ProcessInstanceId = "abcd_1234";
obj1.Remark = "请假系统操作了作废";
obj1.OperatorName = "请假系统";
req.Request_ = obj1;
OapiProcessInstanceCancelResponse 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 OapiProcessInstanceCancelRequest;
$request = new CancelProcessInstanceRequest;
$request->process_instance_id="abcd_1234";
$request->remark="请假系统操作了作废";
$request->operator_name="请假系统";
$req->setRequest($request);
$resp = $c->execute($req, $access_token, "https://oapi.dingtalk.com/topapi/process/instance/cancel");

curl -X POST "https://oapi.dingtalk.com/topapi/process/instance/cancel" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=9a3075d3-3963-4f4e-9bac-e32c9a91c144' \
-d 'request=null'

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

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

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.cancel");
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.cancel', {
	'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.cancel (作废已通过的审批单)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ