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

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

功能介绍

调用该接口批量查询指定关系实体所关联的源/目标模型的所有实例信息，包含具体的属性。

接口约束

关系模型可以使用该接口。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

pageSizePath

是

Integer

参数解释：

分页大小（路径参数）。

约束限制：

不涉及。

取值范围：

1-1000。

默认取值：

不涉及。

curPagePath

是

Integer

参数解释：

当前页数（路径参数）。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

1。

identifier

是

String

参数解释：

应用唯一标识。

约束限制：

不涉及。

取值范围：

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

默认取值：

不涉及。

modelName

是

String

参数解释：

数据模型的英文名称。

约束限制：

不涉及。

取值范围：

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

默认取值：

不涉及。
表2 Query参数

参数

是否必选

参数类型

描述

curPage

否

Integer

参数解释：

当前页。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

1。

endIndex

否

Integer

参数解释：

结束索引。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

0。

maxPageSize

否

Integer

参数解释：

最大分页数。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

1000。

pageSize

否

Integer

参数解释：

每页大小。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

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。

约束限制：

不涉及。

取值范围：

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

默认取值：

不涉及。

params

否

GenericLinkBatchQueryDTO object

参数解释：

请求参数对象。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。
表5 GenericLinkBatchQueryDTO

参数

是否必选

参数类型

描述

latestOnly

否

Boolean

参数解释：

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

约束限制：

不涉及。

取值范围：

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

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

默认取值：

false。

objectIds

否

Array of strings

参数解释：

角色对应的数据实例ID列表。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

role

否

String

参数解释：

角色。

约束限制：

不涉及。

取值范围：

  • TARGET：目标模型。

  • SOURCE：源模型。

默认取值：

不涉及。

响应参数

状态码： 200

表6 响应Body参数

参数

参数类型

描述

result

String

参数解释：

请求结果。

取值范围：

  • SUCCESS：请求成功。

  • FAIL：请求失败。

默认取值：

不涉及。

data

Array of RelatedObjectViewDTO objects

参数解释：

请求数据。

取值范围：

不涉及。

默认取值：

不涉及。

errors

Array of strings

参数解释：

异常信息。

取值范围：

不涉及。

默认取值：

不涉及。

pageInfo

PageInfoViewDTO object

参数解释：

分页信息。

取值范围：

不涉及。

默认取值：

不涉及。
表7 RelatedObjectViewDTO

参数

参数类型

描述

objectId

String

参数解释：

数据实例ID。

取值范围：

-9223372036854775808到9223372036854775807的整数。

默认取值：

不涉及。

relatedList

Array of BasicObjectQueryViewDTO objects

参数解释：

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

取值范围：

不涉及。

默认取值：

不涉及。

relatedEntityList

Array of BasicObjectQueryViewDTO objects

参数解释：

关联的数据实体列表。

取值范围：

不涉及。

默认取值：

不涉及。
表8 BasicObjectQueryViewDTO

参数

参数类型

描述

id

String

参数解释：

唯一标识。

取值范围：

-9223372036854775808到9223372036854775807的整数。

默认取值：

不涉及。

creator

String

参数解释：

创建者。

取值范围：

不涉及。

默认取值：

不涉及。

createTime

String

参数解释：

创建时间。

取值范围：

不涉及。

默认取值：

不涉及。

modifier

String

参数解释：

修改人。

取值范围：

不涉及。

默认取值：

不涉及。

lastUpdateTime

String

参数解释：

最后的修改时间。

取值范围：

不涉及。

默认取值：

不涉及。

rdmExtensionType

String

参数解释：

扩展类型。

取值范围：

不涉及。

默认取值：

不涉及。

tenant

TenantViewDTO object

参数解释：

租户信息。

取值范围：

不涉及。

默认取值：

不涉及。

className

String

参数解释：

类名。

取值范围：

不涉及。

默认取值：

不涉及。
表9 TenantViewDTO

参数

参数类型

描述

className

String

参数解释：

类名。

取值范围：

不涉及。

默认取值：

不涉及。

code

String

参数解释：

租户编码。

取值范围：

不涉及。

默认取值：

不涉及。

createTime

String

参数解释：

创建时间。

取值范围：

不涉及。

默认取值：

不涉及。

creator

String

参数解释：

创建者。

取值范围：

不涉及。

默认取值：

不涉及。

dataSource

String

参数解释：

租户使用的数据源名称。

取值范围：

不涉及。

默认取值：

不涉及。

description

String

参数解释：

描述信息。

取值范围：

不涉及。

默认取值：

不涉及。

disableFlag

Boolean

参数解释：

失效标识。

取值范围：

  • true：失效。

  • false：未失效。

默认取值：

false。

id

String

参数解释：

唯一标识。

取值范围：

-9223372036854775808到9223372036854775807的整数。

默认取值：

不涉及。

kiaguid

String

参数解释：

KIA密级。

取值范围：

不涉及。

默认取值：

不涉及。

lastUpdateTime

String

参数解释：

最后更新时间。

取值范围：

不涉及。

默认取值：

不涉及。

modifier

String

参数解释：

修改人。

取值范围：

不涉及。

默认取值：

不涉及。

name

String

参数解释：

中文名称。

取值范围：

不涉及。

默认取值：

不涉及。

rdmDeleteFlag

Integer

参数解释：

软删除标识。

取值范围：

  • 0：表示未删除。

  • 1：表示已删除。

默认取值：

0。

rdmExtensionType

String

参数解释：

扩展类型。

取值范围：

不涉及。

默认取值：

不涉及。

rdmVersion

Integer

参数解释：

系统版本。

取值范围：

不涉及。

默认取值：

不涉及。

securityLevel

String

参数解释：

安全密级。

取值范围：

  • INTERNAL：内部公开。

  • SECRET：秘密。

  • CONFIDENTIAL：机密。

  • TOP_SECRET：绝密。

默认取值：

不涉及。

tenant

TenantViewDTO object

参数解释：

租户信息。

取值范围：

不涉及。

默认取值：

不涉及。
表10 PageInfoViewDTO

参数

参数类型

描述

curPage

Integer

参数解释：

当前页。

取值范围：

不涉及。

默认取值：

不涉及。

pageSize

Integer

参数解释：

每页大小。

取值范围：

不涉及。

默认取值：

不涉及。

totalRows

Integer

参数解释：

总行数。

取值范围：

不涉及。

默认取值：

不涉及。

totalPages

Integer

参数解释：

总页数。

取值范围：

不涉及。

默认取值：

不涉及。

请求示例

POST https://dme.cn-north-4.huaweicloud.com/rdm_b3f9b7523a6141f4b2d76b92d6595281_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",
      "name" : "张三",
      "description" : null,
      "grade" : "98.99"
    } ],
    "relatedEntityList" : null
  } ],
  "errors" : [ ],
  "pageInfo" : {
    "curPage" : 1,
    "pageSize" : 1000,
    "totalRows" : 1,
    "totalPages" : 1
  }
}

状态码

状态码

描述

200

OK

错误码

请参见错误码。

父主题： 关系实体服务

相关文档