文档首页/ 工业数字模型驱动引擎/ API参考/ API/ 数据建模引擎/ 基础数据服务/ 批量软删除实例 - BatchDeleteLogicalUsingPost
更新时间：2026-07-28 GMT+08:00
查看PDF
分享

批量软删除实例 - BatchDeleteLogicalUsingPost

功能介绍

本接口用于根据数据实例的唯一编码（id）列表，批量对指定数据模型下的多个数据实例执行软删除（逻辑删除）操作。

软删除操作不会从数据库中物理移除数据，而是将所有实例标记为已删除状态，并转存至XDM应用的XDMLogicDeleteData内置模型中。如需彻底删除数据，请使用批量删除实例 - BatchDeleteUsingPost接口。

在调用本接口前，请确保目标数据模型已满足实例化条件：

  1. 已在应用设计态完成数据模型（数据实体或关系实体）的创建与发布。具体操作请参见创建数据实体、创建关系实体和应用发布。

  2. 已将对应应用成功部署至运行态。具体操作请参见部署应用。

接口约束

  • 单次请求的ids数组中，最多允许传入1000个实例ID。若超出限制，请求将被直接拒绝。

  • 软删除后，实例的主键ID保持不变，但其状态标记（如rdmDeleteFlag）将被更新，且数据物理行将迁移至XDMLogicDeleteData模型。原业务视图的常规查询将自动过滤该实例。

  • 批量软删除支持“部分成功”。系统会尽力处理列表中的所有ID，实际成功转存至回收站的实例数量将在响应的data字段中返回，而因约束无法删除的实例原因将记录在errors字段中。

  • 建议在请求中传入modifier（更新者账号）参数，以便系统完整记录数据变更的审计日志，满足工业合规要求。

调试

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

授权信息

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

URI

POST /rdm_{identifier}_app/publicservices/api/{modelName}/batchLogicalDelete

表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

是

PersistObjectIdsModifierDTO object

参数解释：

请求参数对象，包含待失效的实例ID列表及操作人信息。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。
表4 PersistObjectIdsModifierDTO

参数

是否必选

参数类型

描述

ids

是

Array of strings

参数解释：

数据实例ID列表，用于指定待删除的多个实例。

获取方法请参见分页查询实例 - ShowFindUsingPost。

约束限制：

单次请求不超过1000个。

取值范围：

-9223372036854775808到9223372036854775807的整数。

默认取值：

不涉及。

modifier

否

String

参数解释：

更新者账号，用于记录执行删除操作的用户。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

响应参数

状态码：200

表5 响应Body参数

参数

参数类型

描述

result

String

参数解释：

请求处理结果状态。

取值范围：

  • SUCCESS：请求成功。

  • FAIL：请求失败。

data

Array of longs

参数解释：

请求操作影响的数据数量。

取值范围：

不涉及。

errors

Array of strings

参数解释：

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

取值范围：

不涉及。

请求示例

示例：批量软删除多个实例（指定操作人）

对PersistableModel模型中ID为777和888的两个数据实例执行批量软删除操作，操作人为test1。

POST https://dme.cn-north-4.huaweicloud.com/rdm_04219627d6794f37ae26e8aba250415d_app/publicservices/api/PersistableModel/batchLogicalDelete

{
  "applicationId" : "04219627d6794f37ae26e8aba250415d",
  "params" : {
    "ids" : [ "777", "888" ],
    "modifier" : "test1"
  }
}

响应示例

状态码：200

OK，表示请求成功。

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

状态码

状态码

描述

200

OK，表示请求成功。

错误码

请参见错误码。

父主题： 基础数据服务

相关文档