文档首页/ 工业数字模型驱动引擎/ API参考/ API/ 数据建模引擎/ 关系实体服务/ 批量查询关系实体关联模型的信息 - ListBatchQueryRelatedObjects
更新时间：2026-07-28 GMT+08:00
查看PDF
分享

批量查询关系实体关联模型的信息 - ListBatchQueryRelatedObjects

功能介绍

本接口用于批量查询指定关系实体所关联的源模型或目标模型的所有实例信息，返回结果包含实例的具体属性。

接口约束

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

调试

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

授权信息

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

URI

POST /rdm_{identifier}_app/publicservices/api/{modelName}/batchQueryRelatedObjects/{pageSizePath}/{curPagePath}

表1 路径参数

参数

是否必选

参数类型

描述

pageSizePath

是

Integer

参数解释：

分页大小，即每页返回的实例数量。

约束限制：

不涉及。

取值范围：

1-1000。

默认取值：

不涉及。

curPagePath

是

Integer

参数解释：

当前页数，从1开始计数。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

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 Query参数

参数

是否必选

参数类型

描述

curPage

否

Integer

参数解释：

当前页码，从1开始计数。当路径参数curPagePath未指定时生效。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

1。

endIndex

否

Integer

参数解释：

结束索引，用于指定查询结果的结束位置。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

0。

maxPageSize

否

Integer

参数解释：

最大分页数，用于限制返回的最大页数。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

1000。

pageSize

否

Integer

参数解释：

分页大小，即每页返回的实例数量。当路径参数pageSizePath未指定时生效。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

1000。

startIndex

否

Integer

参数解释：

起始索引，用于指定查询结果的起始位置。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

0。

totalPages

否

Integer

参数解释：

总页数，用于指定查询的总页数。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

0。

totalRows

否

Integer

参数解释：

总行数，用于指定查询的总行数。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

0。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

IAM用户的token。

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

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。
表4 请求Body参数

参数

是否必选

参数类型

描述

applicationId

否

String

参数解释：

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

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

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

约束限制：

不涉及。

取值范围：

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

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

默认取值：

不涉及。

params

是

GenericLinkBatchQueryDTO object

参数解释：

请求参数对象，包含查询角色、对象标识列表及过滤条件等。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。
表5 GenericLinkBatchQueryDTO

参数

是否必选

参数类型

描述

role

否

String

参数解释：

查询角色，用于指定按哪种角色维度批量查询关联模型实例。

约束限制：

必须与objectIds配合使用。

取值范围：

  • TARGET：目标模型。

  • SOURCE：源模型。

  • TARGET_TYPE：目标模型对应的英文名称。

  • SOURCE_TYPE：源模型对应的英文名称。

默认取值：

不涉及。

objectIds

否

Array of strings

参数解释：

批量查询对象标识列表，与role参数配合使用。

约束限制：

  • 当role为SOURCE或TARGET时，值为角色对应数据实例ID列表。

  • 当role为SOURCE_TYPE或TARGET_TYPE时，值为角色对应的数据模型的英文名称列表。

取值范围：

  • role为SOURCE或TARGET时：-9223372036854775808~9223372036854775807的整数。

  • role为SOURCE_TYPE或TARGET_TYPE时：以大写字母开头，只能包含字母、数字、“_”，且长度为1-60个字符。

默认取值：

不涉及。

latestOnly

否

Boolean

参数解释：

是否仅返回关联的最新版本目标模型数据实例。此参数仅当源模型或目标模型为M-V模型实体时生效。

约束限制：

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

取值范围：

  • true：仅返回关联的最新版本目标模型数据实例。

  • false：返回关联的所有版本目标模型数据实例。

默认取值：

false。

isNeedTotal

否

Boolean

参数解释：

是否需要查询总记录数。开启后响应中的pageInfo将包含准确的totalRows和totalPages，但可能影响查询性能。

约束限制：

不涉及。

取值范围：

  • true：需要。

  • false：不需要。

默认取值：

false。

响应参数

状态码：200

表6 响应Body参数

参数

参数类型

描述

result

String

参数解释：

请求处理结果状态。

取值范围：

  • SUCCESS：请求成功。

  • FAIL：请求失败。

data

Array of RelatedObjectViewDTO objects

参数解释：

请求数据。

取值范围：

不涉及。

errors

Array of strings

参数解释：

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

取值范围：

不涉及。

pageInfo

PageInfoViewDTO object

参数解释：

分页信息。

取值范围：

不涉及。
表7 RelatedObjectViewDTO

参数

参数类型

描述

objectId

String

参数解释：

数据实例ID。

取值范围：

-9223372036854775808到9223372036854775807的整数。

relatedList

Array of BasicObjectQueryViewDTO objects

参数解释：

关联的数据传输对象列表。

取值范围：

不涉及。

relatedEntityList

Array of BasicObjectQueryViewDTO objects

参数解释：

关联的数据实体列表。

取值范围：

不涉及。
表8 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类名称。

取值范围：

不涉及。
表9 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

参数解释：

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

取值范围：

不涉及。
表10 PageInfoViewDTO

参数

参数类型

描述

curPage

Integer

参数解释：

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

取值范围：

不涉及。

pageSize

Integer

参数解释：

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

取值范围：

不涉及。

totalRows

Integer

参数解释：

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

取值范围：

不涉及。

totalPages

Integer

参数解释：

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

取值范围：

不涉及。

请求示例

示例：批量查询关系实体的关联模型信息

查询角色（role）为SOURCE，关联对象ID列表（objectIds）为614786412419489792，开启总记录数统计（isNeedTotal），不限制仅查询最新版本（latestOnly为false），分页查询第1页（每页10条）。

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

{
  "params" : {
    "role" : "SOURCE",
    "objectIds" : [ "614786412419489792" ],
    "isNeedTotal" : true,
    "latestOnly" : false
  }
}

响应示例

状态码：200

OK，表示请求成功。

{
  "result": "SUCCESS",
  "data": [
    {
      "objectId": "614786412419489792",
      "relatedList": [
        {
          "id": "614786496192323584",
          "creator": "xdmAdmin",
          "createTime": 2024-03-28T03:42:02.873+0000,
          "modifier": "xdmAdmin",
          "lastUpdateTime": 2024-03-28T03:42:02.873+0000,
          "rdmExtensionType": "Student",
          "tenant": {
            "id": "-1",
            "creator": "xdmAdmin",
            "createTime": 2024-03-28T03:28:34.795+0000,
            "modifier": "xdmAdmin",
            "lastUpdateTime": 2024-03-28T03:28:34.795+0000,
            "rdmExtensionType": "Tenant",
            "tenant": null,
            "className": "Tenant",
            "name": "basicTenant",
            "description": "默认租户",
            "code": "basicTenant",
            "disableFlag": false,
            "dataSource": "DefaultDataSource"
          },
          "className": "Student"
        }
      ],
      "relatedEntityList": null
    }
  ],
  "errors": [],
  "pageInfo": {
    "curPage": 1,
    "pageSize": 1000,
    "totalRows": 1,
    "totalPages": 1
  }
}

状态码

状态码

描述

200

OK，表示请求成功。

错误码

请参见错误码。

父主题： 关系实体服务

相关文档