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

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

功能介绍

根据主对象ID,批量软删除最新大版本下的所有小版本。通过此接口进行删除操作时,系统会将当前删除的实例数据转存至XDM应用的XDMLogicDeleteData内置模型中。

接口约束

仅MV模型可以使用该接口。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

identifier

String

参数解释:

应用唯一标识。

约束限制:

不涉及。

取值范围:

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

默认取值:

不涉及。

modelName

String

参数解释:

数据模型的英文名称。

约束限制:

不涉及。

取值范围:

大写字母开头,只能包含字母、数字、"_",且长度为[1-60]个字符。

默认取值:

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

IAM用户的token。

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

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

表3 请求Body参数

参数

是否必选

参数类型

描述

applicationId

String

参数解释

应用ID。

约束限制

不涉及。

取值范围

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

默认取值

不涉及。

params

VersionMasterIdsDtoVersionModelVersionMasterDTO object

参数解释:

请求参数对象。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

表4 VersionMasterIdsDtoVersionModelVersionMasterDTO

参数

是否必选

参数类型

描述

masterIds

Array of VersionModelMasterIdsDTO objects

参数解释:

主对象集合。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

modifier

String

参数解释:

更新者。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

表5 VersionModelMasterIdsDTO

参数

是否必选

参数类型

描述

masterId

String

参数解释:

父模型ID。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

version

String

参数解释:

版本对象。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

响应参数

状态码: 200

表6 响应Body参数

参数

参数类型

描述

result

String

参数解释:

请求结果。

取值范围:

  • SUCCESS:请求成功。

  • FAIL:请求失败。

默认取值:

不涉及。

data

Array of integers

参数解释:

请求数据。

取值范围:

不涉及。

默认取值:

不涉及。

errors

Array of strings

参数解释:

异常信息。

取值范围:

不涉及。

默认取值:

不涉及。

请求示例

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

{
  "applicationId" : "b3f9b7523a6141f4b2d76b92d6595281",
  "params" : {
    "modifier" : "test1",
    "masterIds" : [ {
      "masterId" : "602425926667476992",
      "version" : "A"
    } ]
  }
}

响应示例

状态码: 200

OK

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

状态码

状态码

描述

200

OK

错误码

请参见错误码

相关文档