清除单元格区域内数据

POST

/v1.0/doc/workbooks/{workbookId}/sheets/{sheetId}/ranges/{rangeAddress}/clearData

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

调用本接口，清除单元格内的数据，不包括格式。

调用本接口，清除某个区域内的数据，不包括格式。实现效果与下图操作一致。

权限

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

应用类型	是否支持	权限	API Explorer调试
企业内部应用	支持	钉钉表格写权限	API Explorer
第三方企业应用	支持	钉钉表格写权限	API Explorer
第三方个人应用	暂不支持	钉钉表格写权限	暂不支持

错误码

HttpCode	错误码	错误信息	说明
400	invalidRequest.inputArgs.invalid	%s	请求参数不合法，请查看错误信息。
400	invalidRequest.inputArgs.workbookIdIllegal	The workbookId is illegal.	workbookId不合法。
400	invalidRequest.resource.notWorkbook	%s	不支持的文档类型，请检查workbookId。
403	forbidden.accessDenied	The operator has no permission.	当前用户无此操作权限。
403	forbidden.acrossOrg	%s	请求不合法，请检查要访问的文档是否归属于accessToken指定的组织。
403	forbidden.operationIllegal	%s	请求操作不合法，请查看错误信息。
403	forbidden.document.sizeOverLimit	The document size is over limit and the server is unable to complete your request. Retry is unlikely to work unless the document size is decreased.	表格内容过大，请尝试缩减表格内容。
404	invalidRequest.resource.notFound	%s	请求失败，无法找到要访问的资源。
500	serviceBusy	The server is busy and unable to complete your request. Please try again later.	服务繁忙，请稍后重试。
500	internalError	The server encountered an internal error and was unable to complete your request. Please try again later.	服务内部错误，请稍后再试。

请求参数

Path 参数

Query 参数

Header 参数

返回响应

🟢200成功

application/json

Body

请求示例

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://api.dingtalk.com/v1.0/doc/workbooks//sheets//ranges//clearData?operatorId=String' \
--header 'x-acs-dingtalk-access-token;'

响应示例

{
    "a1Notation": "string"
}

修改于 2024-01-15 08:21:06

更新单元格区域

清除单元格区域内所有内容