查询实例的指定属性
功能介绍
根据查询条件及指定属性分页返回(不支持扩展属性作为选定属性列)。
URI
POST /rdm_{identifier}_app/publicservices/api/{modelName}/select/{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 |
否 |
QueryRequestSelectedVo object |
参数对象。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
characterSet |
否 |
CharacterSetEnum object |
编码类型。 |
conditions |
否 |
Array of QueryCondition objects |
查询条件。 |
decrypt |
否 |
Boolean |
是否加密。
|
entityType |
否 |
String |
实体类型。 |
filter |
否 |
QueryCondition object |
查询条件。 |
isNeedTotal |
否 |
Boolean |
是否需要查询总记录数。
|
isPresentAll |
否 |
Boolean |
是否需要展示所有参考对象信息。
|
needPresentDetail |
否 |
Array of strings |
需要展示详细信息的参考对象。 |
orderBy |
否 |
String |
按某个字段进行排序。 |
orderByTableAlias |
否 |
String |
排序字段的表别名。 |
publicData |
否 |
String |
多租查询参数。
|
selectedField |
是 |
Array of SelectedField objects |
指定需返回的属性。 |
sort |
否 |
String |
排序方向。
|
sorts |
否 |
Array of SortInfoVo objects |
排序。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
conditionName |
否 |
String |
查询条件的名称(数据模型的属性英文名称)。 |
conditionValue |
否 |
String |
查询条件值(已过时)。 |
conditionValues |
否 |
Array of strings |
查询条件的值。operator为in时有多值,operator为其他操作符时均为单值。 |
conditions |
否 |
Array of QueryCondition objects |
查询条件列表。 |
ignoreStr |
否 |
Boolean |
是否忽略大小写。
|
joinTableAlias |
否 |
String |
关联查询时被关联表的别名。 |
joiner |
否 |
String |
连接符。 |
operator |
否 |
String |
操作符。
|
preCondition |
否 |
QueryCondition object |
当前condition对象的上一层级。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
name |
是 |
String |
字段名称,如果是子参考对象的属性,则为“参考对象.属性名称”,例如:“master.name” |
nameAs |
否 |
String |
字段别名。如果不填,默认使用name参数的值。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
characterSet |
否 |
CharacterSetEnum object |
SQL编码类型。 |
orderBy |
否 |
String |
按某个字段进行排序。 |
sort |
否 |
String |
排序方向。
|
sortInfo |
否 |
String |
排序信息。 |
sortInfoOrderBy |
否 |
String |
排序信息字段。 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
result |
String |
请求结果。 |
data |
Array of objects |
请求数据。 |
errors |
Array of strings |
异常信息。 |
请求示例
POST https://dme.cn-north-4.huaweicloud.com/rdm_b3f9b7523a6141f4b2d76b92d6595281_app/publicservices/api/PersistableModel/select/10/1 { "applicationId" : "b3f9b7523a6141f4b2d76b92d6595281", "params" : { "selectedField" : [ { "name" : "rdmExtensionType", "nameAs" : "nameAsRdmExtensionType" } ], "characterSet" : "UTF8", "isNeedTotal" : true, "isPresentAll" : true, "publicData" : "INCLUDE_PUBLIC_DATA", "sorts" : [ ], "decrypt" : false, "filter" : { "joiner" : "and", "ignoreStr" : false, "conditions" : [ { "conditionName" : "rdmExtensionType", "operator" : "=", "conditionValues" : [ "PersistableModel" ], "ignoreStr" : false } ] } } }
响应示例
状态码: 200
OK
{ "result" : "SUCCESS", "data" : [ { "nameAsRdmExtensionType" : "PersistableModel" } ], "errors" : [ ], "pageInfo" : { "curPage" : 1, "pageSize" : 10, "totalRows" : 1, "totalPages" : 1 } }
状态码
状态码 |
描述 |
---|---|
200 |
OK |
错误码
请参见错误码。