批量取消流程中心待处理任务

POST

/v1.0/workflow/processCentres/tasks/cancel

**
接口调用量说明**钉钉标准版接口累计可调用次数为1万次/月，当前接口会消耗调用次数。若该调用量无法满足需求，你可升级钉钉专业版(Open API调用量50万次/月)或钉钉专属版(Open API调用量500万次/月)扩容调用次数。

调用本接口，批量取消流程中心待处理任务。

接口功能介绍

例如，钉钉客户端进行中的待处理事项如下图所示。

调用本接口，批量将正在进行中的待处理事项设置为CANCELED后，对应的卡片会在钉钉待办里面消失，移到已完成列表中。接口调用成功后，效果如下图所示。

权限

要调用此API，需要以下权限之一。

应用类型	是否支持	权限	API Explorer调试
企业内部应用	支持	工作流实例写权限	API Explorer
第三方企业应用	支持	工作流实例写权限	API Explorer
第三方个人应用	暂不支持	工作流实例写权限	暂不支持

错误码

HttpCode	错误码	错误信息	说明
400	integrated.permission.error	非流程中心集成审批流，无权操作	非流程中心集成审批流，无权操作
400	integrated.permission.error	无操作审批流的权限，请检查审批实例或者模版是否正确	无操作审批流的权限，请检查审批实例或者模版是否正确
400	integrated.state.invalid	流程实例不存在	流程实例不存在
400	integrated.state.invalid	参数错误，请检查流程实例ID是否正确	参数错误，请检查流程实例ID是否正确
400	internalError	%s	系统内部异常
500	system.error	系统错误	系统错误

请求示例

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://api.dingtalk.com/v1.0/workflow/processCentres/tasks/cancel' \
--header 'x-acs-dingtalk-access-token;' \
--header 'Content-Type: application/json' \
--data-raw '{
  "processInstanceId" : "String",
  "activityId" : "String",
  "activityIds" : [ "String" ]
}'

响应示例

{
    "success": true
}

请求参数

Header 参数

x-acs-dingtalk-access-token

string

必需

调用该接口的访问凭证。

企业内部应用，调用获取企业内部应用的accessToken接口获取。

第三方企业应用，调用获取第三方应用授权企业的accessToken接口获取。

Body 参数application/json

processInstanceId

string

必需

OA审批流程实例ID。企业内部应用，调用创建实例接口获取processInstanceId参数值。第三方企业应用，调用创建实例接口获取processInstanceId参数值。

activityId

string

必需

待办组ID。说明需要在调用创建流程中心待处理任务接口时，主动设置该值。企业内部应用，调用创建流程中心待处理任务接口获取。第三方企业应用，调用创建流程中心待处理任务接口获取。

activityIds

array[string]

可选

待办组ID列表。企业内部应用，调用创建流程中心待处理任务接口获取。第三方企业应用，调用创建流程中心待处理任务接口获取。

示例

返回响应

🟢200成功

application/json

Body

success

boolean

必需

操作是否成功。 true表示成功。

修改于 2024-01-11 10:37:06

更新流程中心任务状态

官方OA审批

批量取消流程中心待处理任务

接口功能介绍#

权限#

错误码#

请求参数

返回响应

接口功能介绍

权限

错误码