文档首页/ 工业数字模型驱动引擎/ API参考/ API/ 数据建模引擎/ 结构化文档管理/ 批量删除结构化文档 - BatchDeleteStructuredDocument
更新时间：2026-07-28 GMT+08:00
查看PDF
分享

批量删除结构化文档 - BatchDeleteStructuredDocument

功能介绍

本接口用于批量删除指定数据模型下的结构化文档。当产品下线、项目归档或文档批量清理时，可调用本接口一次性删除多个结构化文档，提升数据管理效率。

  • 调用本接口时，需在ids中传入待删除文档的ID列表，系统将对列表中的文档执行批量删除操作。

  • 当is_check设置为true时，系统将在删除前检查当前用户是否具备文档删除权限，无权限的文档将被跳过删除。

  • 当is_check设置为false时，系统将直接执行删除，不做权限检查。

接口约束

目标数据模型已在应用设计态配置了“结构化文档管理”功能。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见权限和授权项。

URI

DELETE /rdm_{identifier}_app/publicservices/api/{modelName}/structured-doc/documents/batch

表1 路径参数

参数

是否必选

参数类型

描述

identifier

是

String

参数解释：

应用的唯一标识。

  • 于2023年06月01日之前创建的应用，其唯一标识为该应用的名称。

  • 于2023年06月01日之后创建的应用，其唯一标识为该应用的ID。

获取方法请参见获取运行服务清单 - ListEnvs。

约束限制：

不涉及。

取值范围：

  • 于2023年06月01日之前创建的应用：由英文字母和数字组成，长度为1-36个字符。

  • 于2023年06月01日之后创建的应用：由英文字母和数字组成，且长度为32个字符。

默认取值：

不涉及。

modelName

是

String

参数解释：

数据模型的英文名称。

约束限制：

不涉及。

取值范围：

以大写字母开头，只能包含字母、数字、“_”，且长度为1-60个字符。

默认取值：

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

IAM用户的token。

获取方法请参见获取IAM用户Token。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。
表3 请求Body参数

参数

是否必选

参数类型

描述

applicationId

否

String

参数解释：

应用ID，用于指定实例所属的应用。

当URL路径中已能明确应用上下文时，此参数可不传。

获取方法请参见获取租户下的应用清单 - ListApps。

约束限制：

不涉及。

取值范围：

  • 于2023年06月01日之前创建的应用：由英文字母和数字组成，长度为1-36个字符。

  • 于2023年06月01日之后创建的应用：由英文字母和数字组成，且长度为32个字符。

默认取值：

不涉及。

params

是

BatchDeleteDocRequestDto object

参数解释：

批量删除请求参数对象，包含待删除文档的标识列表和删除选项配置。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。
表4 BatchDeleteDocRequestDto

参数

是否必选

参数类型

描述

ids

否

Array of strings

参数解释：

文档ID列表，系统生成的文档主键唯一标识列表，用于指定待批量删除的目标文档。

若不传入，则不执行任何删除操作。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

model_name

否

String

参数解释：

模型名称，用于指定待删除文档所属的数据模型名称。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

is_check

否

Boolean

参数解释：

是否检查文档删除权限，用于控制删除前是否进行权限校验。

约束限制：

不涉及。

取值范围：

  • true：检查删除权限，当前用户无权限的文档将被跳过删除。

  • false：不检查删除权限，直接执行删除操作。

默认取值：

true。

响应参数

状态码：200

表5 响应Body参数

参数

参数类型

描述

result

String

参数解释：

请求处理结果状态。

取值范围：

  • SUCCESS：请求成功。

  • FAIL：请求失败。

data

Array of integers

参数解释：

请求数据，返回本次操作影响的记录数。

取值范围：

不涉及。

errors

Array of strings

参数解释：

异常信息列表。当result为FAIL时，返回具体的错误描述，包含失败原因及建议处理方式。

取值范围：

不涉及。

请求示例

示例：批量删除结构化文档（带权限检查）

批量删除模型StructuredDocableModel下ID为721008152111222784的结构化文档，删除前进行权限检查。

DELETE https://dme.cn-north-4.huaweicloud.com/rdm_04219627d6794f37ae26e8aba250415d_app/publicservices/api/StructuredDocableModel/structured-doc/documents/batch

{
  "params" : {
    "model_name" : "StructuredDocableModel",
    "ids" : [ "721008152111222784" ],
    "is_check" : true
  }
}

响应示例

状态码：200

OK，表示请求成功。

{
  "result" : "SUCCESS",
  "data" : [ ],
  "errors" : [ ]
}

状态码

状态码

描述

200

OK，表示请求成功。

错误码

请参见错误码。

父主题： 结构化文档管理

相关文档