通过源模型实例ID查询关联的目标模型实例 - ListQueryTarget
功能介绍
调用该接口输入源模型的数据实例ID,查询并返回与该实例关联的目标模型数据实例的信息,实例信息包含对应数据实例的“列表属性”。
如果目标模型存在“参考对象”类型的属性,且参考的数据模型为抽象模型,返回信息仅返回对应模型的英文名称和ID。如果参考的数据模型为实体模型,返回空。
接口约束
关系模型可以使用该接口。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限,具体权限要求请参见权限和授权项。
URI
POST /rdm_{identifier}_app/publicservices/api/{modelName}/queryTarget/{pageSizePath}/{curPagePath}
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| pageSizePath | 是 | Integer | 参数解释: 分页大小(路径参数)。 约束限制: 不涉及。 取值范围: 1-1000。 默认取值: 不涉及。 |
| curPagePath | 是 | Integer | 参数解释: 当前页数(路径参数)。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 1。 |
| identifier | 是 | String | 参数解释: 应用唯一标识。 约束限制: 不涉及。 取值范围: 由英文字母和数字组成,且长度为32个字符。 默认取值: 不涉及。 |
| modelName | 是 | String | 参数解释: 数据模型的英文名称。 约束限制: 不涉及。 取值范围: 大写字母开头,只能包含字母、数字、“_”,且长度为[1-60]个字符。 默认取值: 不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| curPage | 否 | Integer | 参数解释: 当前页。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 1。 |
| endIndex | 否 | Integer | 参数解释: 结束索引。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 0。 |
| maxPageSize | 否 | Integer | 参数解释: 最大分页数。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 1000。 |
| pageSize | 否 | Integer | 参数解释: 每页大小。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 1000。 |
| startIndex | 否 | Integer | 参数解释: 起始索引。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 0。 |
| totalPages | 否 | Integer | 参数解释: 总页数。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 0。 |
| totalRows | 否 | Integer | 参数解释: 总行数。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 0。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: IAM用户的token。 获取方法请参见获取IAM用户Token。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| applicationId | 否 | String | 参数解释: 应用ID。 约束限制: 不涉及。 取值范围: 由英文字母和数字组成,且长度为32个字符。 默认取值: 不涉及。 |
| params | 是 | GenericLinkTypeDTO object | 参数解释: 请求参数对象。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| latestOnly | 否 | Boolean | 参数解释: 是否返回源模型数据实例关联的最新版本目标模型数据实例。此参数仅对源/目标模型为M-V模型实体有效。 约束限制: 不涉及。 取值范围: 默认取值: false。 |
| sourceId | 否 | String | 参数解释: 源模型数据实例的ID。 约束限制: 不涉及。 取值范围: -9223372036854775808到9223372036854775807的整数。 默认取值: 不涉及。 |
| targetType | 否 | String | 参数解释: 目标模型的英文名称。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| result | String | 参数解释: 请求结果。 取值范围: 默认取值: 不涉及。 |
| data | Array of StudentQueryViewDTO objects | 参数解释: 请求数据。 取值范围: 不涉及。 默认取值: 不涉及。 |
| errors | Array of strings | 参数解释: 异常信息。 取值范围: 不涉及。 默认取值: 不涉及。 |
| pageInfo | PageInfoViewDTO object | 参数解释: 分页信息。 取值范围: 不涉及。 默认取值: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| id | String | 参数解释: 唯一标识。 取值范围: -9223372036854775808到9223372036854775807的整数。 默认取值: 不涉及。 |
| creator | String | 参数解释: 创建者。 取值范围: 不涉及。 默认取值: 不涉及。 |
| createTime | String | 参数解释: 创建时间。 取值范围: 不涉及。 默认取值: 不涉及。 |
| modifier | String | 参数解释: 修改人。 取值范围: 不涉及。 默认取值: 不涉及。 |
| lastUpdateTime | String | 参数解释: 最后的修改时间。 取值范围: 不涉及。 默认取值: 不涉及。 |
| rdmExtensionType | String | 参数解释: 扩展类型。 取值范围: 不涉及。 默认取值: 不涉及。 |
| tenant | TenantViewDTO object | 参数解释: 租户信息。 取值范围: 不涉及。 默认取值: 不涉及。 |
| className | String | 参数解释: 类名。 取值范围: 不涉及。 默认取值: 不涉及。 |
| name | String | 参数解释: 名称。 取值范围: 不涉及。 默认取值: 不涉及。 |
| description | String | 参数解释: 描述。 取值范围: 不涉及。 默认取值: 不涉及。 |
| grade | Number | 参数解释: 成绩。 取值范围: 不涉及。 默认取值: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| className | String | 参数解释: 类名。 取值范围: 不涉及。 默认取值: 不涉及。 |
| code | String | 参数解释: 租户编码。 取值范围: 不涉及。 默认取值: 不涉及。 |
| createTime | String | 参数解释: 创建时间。 取值范围: 不涉及。 默认取值: 不涉及。 |
| creator | String | 参数解释: 创建者。 取值范围: 不涉及。 默认取值: 不涉及。 |
| dataSource | String | 参数解释: 租户使用的数据源名称。 取值范围: 不涉及。 默认取值: 不涉及。 |
| description | String | 参数解释: 描述信息。 取值范围: 不涉及。 默认取值: 不涉及。 |
| disableFlag | Boolean | 参数解释: 失效标识。 取值范围: 默认取值: false。 |
| id | String | 参数解释: 唯一标识。 取值范围: -9223372036854775808到9223372036854775807的整数。 默认取值: 不涉及。 |
| kiaguid | String | 参数解释: KIA密级。 取值范围: 不涉及。 默认取值: 不涉及。 |
| lastUpdateTime | String | 参数解释: 最后更新时间。 取值范围: 不涉及。 默认取值: 不涉及。 |
| modifier | String | 参数解释: 修改人。 取值范围: 不涉及。 默认取值: 不涉及。 |
| name | String | 参数解释: 中文名称。 取值范围: 不涉及。 默认取值: 不涉及。 |
| rdmDeleteFlag | Integer | 参数解释: 软删除标识。 取值范围: 默认取值: 0。 |
| rdmExtensionType | String | 参数解释: 扩展类型。 取值范围: 不涉及。 默认取值: 不涉及。 |
| rdmVersion | Integer | 参数解释: 系统版本。 取值范围: 不涉及。 默认取值: 不涉及。 |
| securityLevel | String | 参数解释: 安全密级。 取值范围: 默认取值: 不涉及。 |
| tenant | TenantViewDTO object | 参数解释: 租户信息。 取值范围: 不涉及。 默认取值: 不涉及。 |
请求示例
POST https://dme.cn-north-4.huaweicloud.com/rdm_b3f9b7523a6141f4b2d76b92d6595281_app/publicservices/api/RelationModel/queryTarget/10/1
{
"params" : {
"sourceId" : "614786412419489792",
"targetType" : "Student",
"latestOnly" : true
}
} 响应示例
状态码:200
OK
{
"result" : "SUCCESS",
"data" : [ {
"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"
} ],
"errors" : [ ],
"pageInfo" : {
"curPage" : 1,
"pageSize" : 10,
"totalRows" : 1,
"totalPages" : 1
}
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | OK |
错误码
请参见错误码。