文档首页/ 工业数字模型驱动引擎/ API参考/ API/ 数据建模引擎/ 关系实体服务/ 通过目标模型删除关系实体的数据实例 - DeleteTarget
更新时间：2026-07-28 GMT+08:00
查看PDF
分享

通过目标模型删除关系实体的数据实例 - DeleteTarget

功能介绍

本接口用于通过目标模型删除关系实体的数据实例，即解除源模型实例与目标模型实例之间的关联关系。

  • 调用本接口时，需在sourceId中指定源模型实例ID，在targetType中指定目标模型的英文名称，系统将删除该源实例与指定目标模型之间的所有关联关系实例。

  • 当latestOnly设置为true时，仅删除源实例关联的最新版本目标模型实例的关系（仅对M-V模型实体生效）。

  • 当latestOnly设置为false时，删除源实例关联的所有版本目标模型实例的关系。

  • 本接口仅执行关系表的DELETE操作，目标端实体的业务数据不受任何影响。

接口约束

  • 目标数据模型必须是关系实体。

  • 系统仅执行关系表的DELETE操作，目标端实体的业务数据不受任何影响。

调试

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

授权信息

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

URI

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

表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

是

GenericLinkTypeModifierDTO object

参数解释：

请求参数对象，包含源实例ID、目标模型名称及删除范围控制等。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。
表4 GenericLinkTypeModifierDTO

参数

是否必选

参数类型

描述

sourceId

否

String

参数解释：

源模型数据实例的ID，用于指定删除哪个源实例与目标模型的关联关系。

约束限制：

如不传入，将删除该源模型下所有实例与目标模型的关联关系，请谨慎使用。

取值范围：

-9223372036854775808到9223372036854775807的整数。

默认取值：

不涉及。

targetType

否

String

参数解释：

目标模型的英文名称，用于指定删除源实例与哪个目标模型的关联关系。

约束限制：

如不传入，将删除源实例与所有目标模型的关联关系，请谨慎使用。

取值范围：

不涉及。

默认取值：

不涉及。

latestOnly

否

Boolean

参数解释：

是否仅删除源实例关联的最新版本目标模型数据实例的关系。此参数仅当源模型或目标模型为M-V（Master-View）模型实体时生效。

约束限制：

仅对M-V模型实体有效。

取值范围：

  • true：仅删除源实例关联的最新版本目标模型数据实例的关系。

  • false：删除源实例关联的所有版本目标模型数据实例的关系。

默认取值：

false。

modifier

否

String

参数解释：

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

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

响应参数

状态码：200

表5 响应Body参数

参数

参数类型

描述

result

String

参数解释：

请求处理结果状态。

取值范围：

  • SUCCESS：请求成功。

  • FAIL：请求失败。

data

Array of integers

参数解释：

请求数据。

取值范围：

不涉及。

errors

Array of strings

参数解释：

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

取值范围：

不涉及。

请求示例

示例：删除指定源实例与目标模型的关联关系（仅删除最新版本）

删除源实例ID为614786412419489792与目标模型Student的关联关系，仅删除最新版本。

POST https://dme.cn-north-4.huaweicloud.com/rdm_04219627d6794f37ae26e8aba250415d_app/publicservices/api/RelationModel/deleteTarget

{
  "params" : {
    "sourceId" : "614786412419489792",
    "targetType" : "Student",
    "latestOnly" : true
  }
}

响应示例

状态码：200

OK，表示请求成功。

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

状态码

状态码

描述

200

OK，表示请求成功。

错误码

请参见错误码。

父主题： 关系实体服务

相关文档