Skip to content

批量删除记录

一次删除多条对象中的记录

请求

项目
HTTP URLhttps://open.feishu.cn/open-apis/apaas/v1/applications/:namespace/objects/:object_api_name/records/batch_delete
HTTP MethodDELETE
接口频率限制1000 次/分钟、50 次/秒
支持的应用类型custom,isv
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用app_engine:object.record:write 创建、更新、删除对象记录数据

请求头

名称类型必填描述
Authorizationstringtenant_access_token 值格式:"Bearer access_token" 示例值:"Bearer t-7f1bcd13fc57d46bac21793a18e560" 了解更多:如何选择与获取 access token
Content-Typestring固定值:"application/json; charset=utf-8"

路径参数

名称类型描述
namespacestring应用命名空间
示例值:"package_test__c"
数据校验规则
- 长度范围:0255 字符
object_api_namestring对象唯一标识
示例值:"user"
数据校验规则
- 长度范围:0256 字符

请求体

名称类型必填描述
idsstring\[\]记录 ID 列表,操作记录数上限为 500
示例值:["1801464965461024"]
数据校验规则
- 长度范围:0500

请求体示例

json
{
    "ids": [
        "1801464965461024"
    ]
}

响应

响应体

名称类型描述
codeint错误码,非 0 表示失败
msgstring错误描述
data\--
  └ itemsrecord_result\[\]处理结果
    └ successboolean是否成功
    └ idstring记录 ID
    └ errorsrecord_result_error\[\]权限错误时的细分 code
      └ codestring错误码
      └ messagestringsuccess
      └ sub_codestring权限错误时的细分 code
      └ fieldsstring\[\]权限错误时的涉及的字段 APIID 集合

响应体示例

json
{
    "code": 0,
    "msg": "success",
    "data": {
        "items": [
            {
                "success": true,
                "id": "1801464965461024",
                "errors": [
                    {
                        "code": "0",
                        "message": "success",
                        "sub_code": "k_ec_00001",
                        "fields": [
                            "_id"
                        ]
                    }
                ]
            }
        ]
    }
}

错误码

HTTP状态码错误码描述排查建议
4002320001param is invalid请检查输入参数

内容来源:飞书开放平台 · 自动爬取整理