查询关系实体的数据实例
功能介绍
调用该接口输入数据实例的ID和对应的关系角色(源/目标模型),查询并返回对应关系实体的数据实例。 如果对应的关系实体存在“参考对象”类型属性,且参考的数据模型为抽象模型,返回信息仅返回对应模型的英文名称和ID。如果参考的数据模型为实体模型,返回空。
URI
POST /rdm_{identifier}_app/publicservices/api/{modelName}/queryRelationship/{pageSizePath}/{curPagePath}
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
identifier |
是 |
String |
应用ID。 |
modelName |
是 |
String |
数据模型的英文名称。 |
pageSizePath |
是 |
Integer |
分页大小(路径参数)。 |
curPagePath |
是 |
Integer |
当前页数(路径参数)。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
curPage |
否 |
Integer |
当前页。 |
endIndex |
否 |
Integer |
结束索引。 |
maxPageSize |
否 |
Integer |
最大分页数。 |
pageSize |
否 |
Integer |
每页大小。 |
startIndex |
否 |
Integer |
起始索引。 |
totalPages |
否 |
Integer |
总页数。 |
totalRows |
否 |
Integer |
总行数。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
IAM用户的token。 获取方法请参见获取IAM用户Token。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
applicationId |
否 |
String |
应用ID。 |
params |
否 |
GenericLinkQueryDTO object |
参数对象。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
isNeedTotal |
否 |
Boolean |
是否需要查询总记录数。
|
latestOnly |
否 |
Boolean |
是否返回源模型数据实例关联的最新版本目标模型数据实例。此参数仅对源/目标模型为M-V模型实体有效。
|
objectId |
否 |
String |
角色对应数据实例ID。 |
role |
否 |
String |
角色。
|
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
result |
String |
请求结果。 |
data |
Array of RelationModelViewDTO objects |
请求数据。 |
errors |
Array of strings |
异常信息。 |
pageInfo |
PageInfoViewDTO object |
分页信息。 |
参数 |
参数类型 |
描述 |
---|---|---|
className |
String |
类名。 |
createTime |
String |
创建时间。 |
creator |
String |
创建者。 |
description |
String |
实体描述。 |
id |
String |
唯一标识。 |
lastUpdateTime |
String |
最后更新时间。 |
modifier |
String |
修改人。 |
name |
String |
实体姓名。 |
rdmDeleteFlag |
Integer |
软删除标识,参数值为0或1。
|
rdmExtensionType |
String |
扩展类型。 |
rdmVersion |
Integer |
系统版本。 |
source |
ClassesViewDTO object |
源实体。 |
target |
StudentViewDTO object |
目标实体。 |
tenant |
TenantViewDTO object |
租户信息。 |
参数 |
参数类型 |
描述 |
---|---|---|
className |
String |
类名。 |
createTime |
String |
创建时间。 |
creator |
String |
创建者。 |
description |
String |
描述。 |
id |
String |
唯一标识。 |
kiaguid |
String |
关键信息资产ID。 |
lastUpdateTime |
String |
最新更新时间。 |
modifier |
String |
修改人。 |
name |
String |
名称。 |
rdmDeleteFlag |
Integer |
软删除标识,参数值为0或1。
|
rdmExtensionType |
String |
扩展类型。 |
rdmVersion |
Integer |
系统版本。 |
securityLevel |
String |
安全密级。
|
tenant |
TenantViewDTO object |
租户信息。 |
参数 |
参数类型 |
描述 |
---|---|---|
className |
String |
类名。 |
createTime |
String |
创建时间。 |
creator |
String |
创建者。 |
description |
String |
描述。 |
grade |
Number |
成绩。 |
id |
String |
唯一标识。 |
kiaguid |
String |
关键信息资产ID。 |
lastUpdateTime |
String |
最新更新时间。 |
modifier |
String |
修改人。 |
name |
String |
名称。 |
rdmDeleteFlag |
Integer |
软删除标识,参数值为0或1。
|
rdmExtensionType |
String |
扩展类型。 |
rdmVersion |
Integer |
系统版本。 |
securityLevel |
String |
安全密级。
|
tenant |
TenantViewDTO object |
租户信息。 |
参数 |
参数类型 |
描述 |
---|---|---|
className |
String |
类名。 |
code |
String |
租户编码。 |
createTime |
String |
创建时间。 |
creator |
String |
创建者。 |
dataSource |
String |
租户使用的数据源名称。 |
description |
String |
描述信息。 |
disableFlag |
Boolean |
失效标识。
|
id |
String |
唯一标识。 |
kiaguid |
String |
KIA密级。 |
lastUpdateTime |
String |
最后更新时间。 |
modifier |
String |
修改人。 |
name |
String |
中文名称。 |
rdmDeleteFlag |
Integer |
软删除标识,参数值为0或1。
|
rdmExtensionType |
String |
扩展类型。 |
rdmVersion |
Integer |
系统版本。 |
securityLevel |
String |
安全密级。
|
tenant |
TenantViewDTO object |
租户信息。 |
请求示例
POST https://dme.cn-north-4.huaweicloud.com/rdm_b3f9b7523a6141f4b2d76b92d6595281_app/publicservices/api/RelationModel/queryRelationship/10/1 { "params" : { "role" : "Target", "objectId" : "614786496192323584", "isNeedTotal" : true, "latestOnly" : false } }
响应示例
状态码: 200
OK
{ "result" : "SUCCESS", "data" : [ { "id" : "614786585191260160", "creator" : "xdmAdmin", "modifier" : "xdmAdmin", "createTime" : "2024-03-28T03:42:24.092+0000", "lastUpdateTime" : "2024-03-28T03:42:24.092+0000", "rdmVersion" : 1, "rdmDeleteFlag" : 0, "rdmExtensionType" : "RelationModel", "tenant" : { "id" : "-1", "creator" : "xdmAdmin", "modifier" : "xdmAdmin", "createTime" : "2024-03-28T03:28:34.795+0000", "lastUpdateTime" : "2024-03-28T03:28:34.795+0000", "rdmVersion" : 1, "rdmDeleteFlag" : 0, "rdmExtensionType" : "Tenant", "tenant" : null, "className" : "Tenant", "name" : "basicTenant", "description" : "默认租户", "kiaguid" : null, "securityLevel" : "internal", "nameEn" : null, "code" : "basicTenant", "disableFlag" : false, "dataSource" : "DefaultDataSource" }, "className" : "RelationModel", "source" : { "id" : "614786412419489792", "creator" : "xdmAdmin", "modifier" : "xdmAdmin", "createTime" : "2024-03-28T03:41:42.900+0000", "lastUpdateTime" : "2024-03-28T03:41:42.900+0000", "rdmVersion" : 1, "rdmDeleteFlag" : 0, "rdmExtensionType" : "Classes", "tenant" : { "id" : "-1", "creator" : "xdmAdmin", "modifier" : "xdmAdmin", "createTime" : "2024-03-28T03:28:34.795+0000", "lastUpdateTime" : "2024-03-28T03:28:34.795+0000", "rdmVersion" : 1, "rdmDeleteFlag" : 0, "rdmExtensionType" : "Tenant", "tenant" : null, "className" : "Tenant", "name" : "basicTenant", "description" : "默认租户", "kiaguid" : null, "securityLevel" : "internal", "nameEn" : null, "code" : "basicTenant", "disableFlag" : false, "dataSource" : "DefaultDataSource" }, "className" : "Classes", "name" : "初二四班", "description" : "初中二年级四班", "kiaguid" : null, "securityLevel" : "internal" }, "target" : { "id" : "614786496192323584", "creator" : "xdmAdmin", "modifier" : "xdmAdmin", "createTime" : "2024-03-28T03:42:02.873+0000", "lastUpdateTime" : "2024-03-28T03:42:02.873+0000", "rdmVersion" : 1, "rdmDeleteFlag" : 0, "rdmExtensionType" : "Student", "tenant" : { "id" : "-1", "creator" : "xdmAdmin", "modifier" : "xdmAdmin", "createTime" : "2024-03-28T03:28:34.795+0000", "lastUpdateTime" : "2024-03-28T03:28:34.795+0000", "rdmVersion" : 1, "rdmDeleteFlag" : 0, "rdmExtensionType" : "Tenant", "tenant" : null, "className" : "Tenant", "name" : "basicTenant", "description" : "默认租户", "kiaguid" : null, "securityLevel" : "internal", "nameEn" : null, "code" : "basicTenant", "disableFlag" : false, "dataSource" : "DefaultDataSource" }, "className" : "Student", "name" : "张三", "description" : null, "kiaguid" : null, "securityLevel" : "internal", "grade" : "98.99" }, "name" : null, "description" : null } ], "errors" : [ ], "pageInfo" : { "curPage" : 1, "pageSize" : 1000, "totalRows" : 1, "totalPages" : 1 } }
状态码
状态码 |
描述 |
---|---|
200 |
OK |
错误码
请参见错误码。