选择应用类型
企业内部应用开发
学习地图
动态与公告
应用开发平台简介(新版)
应用开发平台简介
开发应用(新版)
开发应用
服务端API
开发指南
API总览
身份验证(免登)
获取访问凭证
通讯录管理
上下游组织(原合作空间)
上下级组织(原关联组织)
考勤
日志
日程
签到
公告
音视频
钉工牌
工作台
服务窗
OA审批
即时通信IM
智能人事
智能填表
智能交互
组织大脑
待办任务
文档/文件
权限申请
知识库
钉盘
群文件
媒体文件
文档
概述
表格
工作表
行列
单元格区域
获取单元格区域
更新单元格区域
清除单元格区域内数据
清除单元格区域内所有内容
搜索
存储管理
钉钉客联
互动卡片
应用管理
企业文化
专属开放
生态开放
智能硬件
行业开放
HCM 主数据
宜搭应用开发
客户管理(官方CRM)
Teambition 项目管理
钉钉快办
Agoal
炼丹炉(模型服务)
AI 助理
365会员
附录
客户端API
事件订阅
参考
常见问题
历史文档

清除单元格区域内所有内容新版SDK

更新于 2024-12-27

接口调用量说明钉钉标准版接口累计可调用次数为1万次/月,当前接口会消耗调用次数。若该调用量无法满足需求,你可升级钉钉专业版(Open API调用量50万次/月)钉钉专属版(Open API调用量500万次/月)扩容调用次数。
清除所有内容,包括单元格内容和样式

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

权限

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

应用类型

是否支持

权限

API Explorer调试

企业内部应用支持钉钉表格写权限API Explorer
第三方企业应用支持钉钉表格写权限API Explorer
第三方个人应用暂不支持暂不支持暂不支持

请求方法

Loading...

Header参数

名称

类型

是否必填

描述

x-acs-dingtalk-access-token

String

调用该接口的访问凭证。

Path参数

名称

类型

是否必填

描述

workbookId

String

表格文件 ID ,知识库 API 返回的nodeId(dentryUuid)即是表格workbookId,可通过调用获取节点创建知识库文档接口获取。

sheetId

String

工作表的ID或标题。

  • 企业内部应用,可调用获取所有工作表接口获取id或者传工作表的标题。
  • 第三方企业应用,建议传递工作表的标题。

工作表的标题查看步骤如下图。

rangeAddress

String

需要清除的单元格范围,格式为区域内左上角单元格:区域内右下角单元格

例如:B2:C3,表示的区域如下图所示。

Query参数

名称

类型

是否必填

描述

operatorId

String

操作人unionId。

返回参数

名称

类型

描述

a1Notation

String

单元格地址。

示例

请求示例

Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...

返回示例

Loading...

错误码

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.

服务内部错误,请稍后再试。

点击纠错