文档首页/ 工业数字模型驱动引擎/ API参考/ API/ 数据建模引擎/ 系统版本/ 对比数据实例
更新时间：2024-09-05 GMT+08:00
查看PDF
分享

对比数据实例

功能介绍

通过此接口可以对比某个模型数据实例的不同版本的属性和关系。建议使用数据建模引擎（xDM Foundation，简称xDM-F）新增的差异对比功能，即使用instance-attrs-comparison和instance-relation-comparison接口，更多内容可在应用运行态的“数据服务管理 > 全量数据服务 > 系统管理API > 属性对比API”中查看。在调用该接口前请确保数据模型具有“系统版本”功能。

接口约束

功能列表勾选了系统版本的模型可以使用该接口。

URI

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

表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

否

CompareVersionVO object

参数解释：

请求参数对象。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。
表4 CompareVersionVO

参数

是否必选

参数类型

描述

basicVersion

是

String

参数解释：

基础版本号。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

correlationVersion

是

String

参数解释：

对比版本号。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

id

是

String

参数解释：

实例ID。

约束限制：

不涉及。

取值范围：

-9223372036854775808到9223372036854775807的整数。

默认取值：

不涉及。

响应参数

状态码： 200

表5 响应Body参数

参数

参数类型

描述

result

String

参数解释：

请求结果。

取值范围：

  • SUCCESS：请求成功。

  • FAIL：请求失败。

默认取值：

不涉及。

data

Array of CompareVersionRespVo objects

参数解释：

请求数据。

取值范围：

不涉及。

默认取值：

不涉及。

errors

Array of strings

参数解释：

异常信息。

取值范围：

不涉及。

默认取值：

不涉及。
表6 CompareVersionRespVo

参数

参数类型

描述

basicVersion

Object

参数解释：

基础版本对象。

取值范围：

不涉及。

默认取值：

不涉及。

correlationVersion

Object

参数解释：

当前版本对象。

取值范围：

不涉及。

默认取值：

不涉及。

请求示例

POST https://dme.cn-north-4.huaweicloud.com/rdm_b3f9b7523a6141f4b2d76b92d6595281_app/publicservices/api/HistoryDataModel/compareVersion

{
  "applicationId" : "b3f9b7523a6141f4b2d76b92d6595281",
  "params" : {
    "basicVersion" : 1,
    "correlationVersion" : 2,
    "id" : "616714869831376896"
  }
}

响应示例

状态码： 200

OK

{
  "result" : "SUCCESS",
  "data" : [ {
    "id" : "616714869831376896",
    "creator" : "xdmAdmin",
    "createTime" : "2024-04-02T11:24:42.000+0000",
    "modifier" : "xdmAdmin",
    "lastUpdateTime" : "2024-04-02T11:24:42.000+0000",
    "rdmVersion" : 1,
    "rdmOperationType" : "CREATE",
    "rdmExtensionType" : "HistoryDataModel",
    "rdmDeleteFlag" : 0,
    "tenant" : {
      "id" : "-1",
      "creator" : "xdmAdmin",
      "createTime" : "2023-12-01T01:25:21.000+0000",
      "modifier" : "xdmAdmin",
      "lastUpdateTime" : "2023-12-01T01:25:21.000+0000",
      "rdmVersion" : 1,
      "rdmOperationType" : null,
      "rdmExtensionType" : "Tenant",
      "rdmDeleteFlag" : 0,
      "tenant" : null,
      "className" : "Tenant",
      "name" : "basicTenant",
      "description" : "默认租户",
      "kiaguid" : null,
      "securityLevel" : "internal",
      "nameEn" : null,
      "code" : "basicTenant",
      "disableFlag" : false,
      "dataSource" : "DefaultDataSource"
    },
    "className" : "HistoryDataModel"
  }, {
    "rdmVersion" : 2,
    "rdmOperationType" : "UPDATE",
    "modifier" : "xdmAdmin2",
    "id" : "616714869831376896"
  } ],
  "errors" : [ ]
}

状态码

状态码

描述

200

OK

错误码

请参见错误码。

父主题： 系统版本

相关文档