文档首页/ 工业数字模型驱动引擎/ API参考/ API/ 数据建模引擎/ 版本服务/ 批量软删除最新大版本下的所有小版本 - BatchDeleteLogicalBranch
更新时间：2026-07-28 GMT+08:00
查看PDF
分享

批量软删除最新大版本下的所有小版本 - BatchDeleteLogicalBranch

功能介绍

本接口用于根据主对象ID（masterIds）列表，批量软删除指定M-V模型实例中最新分支（Branch）下的所有迭代版本（Iteration）。

软删除操作并非物理删除，而是将目标分支下的所有版本实例标记为已删除状态（rdmDeleteFlag置为1），并将数据转存至XDM应用的XDMLogicDeleteData内置模型中，以便在需要时进行数据恢复或归档查询。

在调用本接口前，请确保目标数据模型满足以下条件：

  1. 已在应用设计态完成M-V模型实体（即“父模型”为“VersionObject”的数据实体）的创建与发布。具体操作请参见创建数据实体、创建关系实体和应用发布。

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

接口约束

  • 本接口仅支持M-V模型数据实例，不支持普通单实体或关系实体。

  • 只能删除最新分支下的所有版本。每个待删除项会软删除指定版本号对应的整个分支（即该大版本下的所有小版本）。非最新分支无法通过此接口删除。

调试

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

授权信息

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

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

identifier

是

String

参数解释：

应用的唯一标识。

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

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

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

约束限制：

不涉及。

取值范围：

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

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

默认取值：

不涉及。

modelName

是

String

参数解释：

M-V模型的英文名称。

约束限制：

必须为已发布的M-V模型，单实体、关系实体不支持。

取值范围：

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

默认取值：

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

IAM用户的token。

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

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。
表3 请求Body参数

参数

是否必选

参数类型

描述

applicationId

否

String

参数解释：

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

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

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

约束限制：

不涉及。

取值范围：

由英文字母和数字组成，且长度固定为32个字符。

默认取值：

不涉及。

params

是

VersionMasterIdsDtoVersionModelVersionMasterDTO object

参数解释：

请求参数对象，包含待删除分支的主对象ID集合等关键信息。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。
表4 VersionMasterIdsDtoVersionModelVersionMasterDTO

参数

是否必选

参数类型

描述

masterIds

是

Array of VersionModelMasterIdsDTO objects

参数解释：

主对象集合，每个元素包含一个主对象ID及其对应的版本标识，用于批量定位待删除的分支。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

modifier

否

String

参数解释：

更新者账号，记录执行批量删除操作的用户标识。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。
表5 VersionModelMasterIdsDTO

参数

是否必选

参数类型

描述

masterId

是

String

参数解释：

主对象ID，用于定位待删除分支所属的主对象。

约束限制：

单次请求不超过1000个。

取值范围：

不涉及。

默认取值：

不涉及。

version

否

String

参数解释：

版本对象，用于指定待删除的分支版本标识。若未指定，则默认删除该主对象下的最新分支。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

响应参数

状态码：200

表6 响应Body参数

参数

参数类型

描述

result

String

参数解释：

M-V模型数据请求处理结果状态。

取值范围：

  • SUCCESS：请求成功。

  • FAIL：请求失败。

data

Array of integers

参数解释：

请求数据。

取值范围：

不涉及。

errors

Array of strings

参数解释：

更新异常信息数组，当result为FAIL时返回具体的错误描述。常见错误包括：实例不存在、实例处于检出状态、权限不足、密级校验失败等。

取值范围：

不涉及。

请求示例

示例：批量软删除指定分支下的所有迭代版本

批量软删除主对象ID为602425926667476992（版本A）和602425926667477000（版本B）的分支下的所有迭代版本，操作人为test1。

POST https://dme.cn-north-4.huaweicloud.com/rdm_04219627d6794f37ae26e8aba250415d_app/publicservices/api/VersionModel/batchLogicalDeleteBranch

{
  "applicationId" : "04219627d6794f37ae26e8aba250415d",
  "params" : {
    "modifier" : "test1",
    "masterIds" : [ {
      "masterId" : "602425926667476992",
      "version" : "A"
    }, {
      "masterId" : "602425926667477000",
      "version" : "B"
    } ]
  }
}

响应示例

状态码：200

OK，表示请求成功。

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

状态码

状态码

描述

200

OK，表示请求成功。

错误码

请参见错误码。

父主题： 版本服务

相关文档