文档首页/ 工业数字模型驱动引擎/ API参考/ API/ 数据建模引擎/ 树形结构/ 获取根节点 - ShowGetRoot
更新时间：2026-07-28 GMT+08:00
查看PDF
分享

获取根节点 - ShowGetRoot

功能介绍

本接口用于获取指定数据实例所在树形结构的根节点信息。当需要追溯BOM（物料清单）的顶层装配节点、查找组织架构的顶层部门或定位产品分类的顶级类目时，可调用本接口获取目标节点的根节点。

调用本接口时，需在id中传入目标数据实例的ID，系统将沿树形结构向上遍历，返回该实例所在树的根节点。

接口约束

  • 目标数据模型已在应用设计态配置了“树形结构”功能。

  • 该节点必须拥有父节点。

调试

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

授权信息

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

URI

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

表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

是

PersistObjectIdDTO object

参数解释：

请求参数对象，包含待查询的目标实例ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。
表4 PersistObjectIdDTO

参数

是否必选

参数类型

描述

id

是

String

参数解释：

数据实例ID，用于指定待查询的数据实例。

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

约束限制：

不涉及。

取值范围：

-9223372036854775808到9223372036854775807的整数。

默认取值：

不涉及。

响应参数

状态码：200

表5 响应Body参数

参数

参数类型

描述

result

String

参数解释：

请求处理结果状态。

取值范围：

  • SUCCESS：请求成功。

  • FAIL：请求失败。

data

Array of BasicObjectQueryViewDTO objects

参数解释：

请求数据，返回目标数据实例所在树形结构的根节点信息列表。

数组按从直接父节点到根节点的顺序排列，包含各父节点的完整列表属性。

取值范围：

不涉及。

errors

Array of strings

参数解释：

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

取值范围：

不涉及。

pageInfo

PageInfoViewDTO object

参数解释：

分页信息，包含查询结果的分页参数。

取值范围：

不涉及。
表6 BasicObjectQueryViewDTO

参数

参数类型

描述

id

String

参数解释：

唯一标识，系统生成的根节点主键ID。

取值范围：

-9223372036854775808到9223372036854775807的整数。

creator

String

参数解释：

创建者账号，标识创建该根节点的用户。

取值范围：

不涉及。

createTime

String

参数解释：

创建时间。使用UTC+0时间格式，格式为yyyy-MM-ddTHH:mm:ss.SSSZ。

取值范围：

不涉及。

modifier

String

参数解释：

更新者账号，标识最后更新该根节点的用户。

取值范围：

不涉及。

lastUpdateTime

String

参数解释：

最后的修改时间。使用UTC+0时间格式，格式为yyyy-MM-ddTHH:mm:ss.SSSZ。

取值范围：

不涉及。

rdmExtensionType

String

参数解释：

扩展类型，标识对象的扩展类别。

取值范围：

不涉及。

tenant

TenantViewDTO object

参数解释：

租户信息，包含根节点所属租户的详细信息。

取值范围：

不涉及。

className

String

参数解释：

类名，标识对象的Java类名称。

取值范围：

不涉及。
表7 TenantViewDTO

参数

参数类型

描述

className

String

参数解释：

租户对象的类名。

取值范围：

不涉及。

code

String

参数解释：

租户编码，用于多租户场景下的租户唯一标识。

取值范围：

不涉及。

createTime

String

参数解释：

租户对象的创建时间。使用UTC+0时间格式，格式为yyyy-MM-ddTHH:mm:ss.SSSZ。

取值范围：

不涉及。

creator

String

参数解释：

租户对象的创建者账号。

取值范围：

不涉及。

dataSource

String

参数解释：

租户使用的数据源名称，用于多租户数据隔离。

取值范围：

不涉及。

description

String

参数解释：

租户描述信息。

取值范围：

不涉及。

disableFlag

Boolean

参数解释：

租户失效标识，用于标识租户是否已失效。

取值范围：

  • true：失效。

  • false：未失效（默认）。

id

String

参数解释：

租户的唯一标识。

取值范围：

-9223372036854775808到9223372036854775807的整数。

kiaguid

String

参数解释：

租户KIA密级。

取值范围：

不涉及。

lastUpdateTime

String

参数解释：

租户的最后更新时间。使用UTC+0时间格式，格式为yyyy-MM-ddTHH:mm:ss.SSSZ。

取值范围：

不涉及。

modifier

String

参数解释：

租户的更新者账号。

取值范围：

不涉及。

name

String

参数解释：

租户中文名称。

取值范围：

不涉及。

nameEn

String

参数解释：

租户英文名称。

取值范围：

不涉及。

rdmDeleteFlag

Integer

参数解释：

软删除标识。

取值范围：

  • 0：表示未删除。

  • 1：表示已删除。

rdmExtensionType

String

参数解释：

租户扩展类型。

取值范围：

不涉及。

rdmVersion

Integer

参数解释：

租户对象的系统版本号。

取值范围：

不涉及。

securityLevel

String

参数解释：

租户安全密级，用于标识租户信息的安全等级。

取值范围：

  • internal：内部公开。

  • secret：秘密。

  • confidential：机密。

  • top_secret：绝密。

tenant

TenantViewDTO object

参数解释：

租户信息，表示当前租户的父租户信息。

取值范围：

不涉及。
表8 PageInfoViewDTO

参数

参数类型

描述

curPage

Integer

参数解释：

当前页码，标识当前返回结果所在的页数。

取值范围：

不涉及。

pageSize

Integer

参数解释：

每页大小，标识每页返回的记录数量。

取值范围：

不涉及。

totalRows

Integer

参数解释：

总行数，标识符合查询条件的总记录数。

取值范围：

不涉及。

totalPages

Integer

参数解释：

总页数，标识符合查询条件的总页数。

取值范围：

不涉及。

请求示例

示例：获取指定数据实例的根节点

获取数据实例ID为616949021809840128所在树形结构的根节点。

POST https://dme.cn-north-4.huaweicloud.com/rdm_04219627d6794f37ae26e8aba250415d_app/publicservices/api/TreeableModel/getRoot

{
  "params" : {
    "id" : "616949021809840128"
  }
}

响应示例

状态码：200

OK，表示请求成功。

{
  "result": "SUCCESS",
  "data": [
    {
      "id": "616948972547739648",
      "creator": "xdmAdmin",
      "createTime": 2024-04-03T02:54:57.413+0000,
      "modifier": "xdmAdmin",
      "lastUpdateTime": 2024-04-03T02:54:57.413+0000,
      "rdmExtensionType": "TreeableModel",
      "tenant": {
        "id": "-1",
        "creator": "xdmAdmin",
        "createTime": 2023-12-01T01:25:21.000+0000,
        "modifier": "xdmAdmin",
        "lastUpdateTime": 2023-12-01T01:25:21.000+0000,
        "rdmExtensionType": "Tenant",
        "tenant": null,
        "className": "Tenant",
        "name": "basicTenant",
        "description": "默认租户",
        "code": "basicTenant",
        "disableFlag": false,
        "dataSource": "DefaultDataSource"
      },
      "className": "TreeableModel"
    }
  ],
  "errors": []
}

状态码

状态码

描述

200

OK，表示请求成功。

错误码

请参见错误码。

父主题： 树形结构

相关文档