文档首页> 工业数字模型驱动引擎> API参考> API> 数据建模引擎> 基础数据服务> 根据“列表属性”为“是”的属性查询实例

更新时间：2024-03-15 GMT+08:00

根据“列表属性”为“是”的属性查询实例

功能介绍

当数据模型中存在“列表属性”为“是”的属性时，可通过此接口查询数据模型中的实例数据。

URI

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

表1 路径参数
参数	是否必选	参数类型	描述
identifier	是	String	应用ID。
modelName	是	String	数据模型的英文名称。
pageSizePath	是	Integer	分页大小（路径参数）。
curPagePath	是	Integer	当前页数（路径参数）。

表2 Query参数
参数	是否必选	参数类型	描述
curPage	否	Integer	当前页。
endIndex	否	Integer	结束索引。
maxPageSize	否	Integer	最大分页数。
pageSize	否	Integer	每页大小。
startIndex	否	Integer	起始索引。
totalPages	否	Integer	总页数。
totalRows	否	Integer	总行数。

请求参数

表3 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	IAM用户的token。获取方法请参见获取IAM用户Token。

表4 请求Body参数
参数	是否必选	参数类型	描述
applicationId	否	String	应用ID。
params	否	QueryRequestVo object	参数对象。

表5 QueryRequestVo
参数	是否必选	参数类型	描述
characterSet	否	CharacterSetEnum object	编码类型。
conditions	否	Array of QueryCondition objects	查询条件。
decrypt	否	Boolean	是否加密。 true：加密。 false：不加密。
entityType	否	String	实体类型。
filter	否	QueryCondition object	查询条件。
isNeedTotal	否	Boolean	是否需要查询总记录数。 true：需要。 false：不需要。
isPresentAll	否	Boolean	是否需要展示所有参考对象信息。 true：需要。 false：不需要。
needPresentDetail	否	Array of strings	需要展示详细信息的参考对象。
orderBy	否	String	按某个字段进行排序。
orderByTableAlias	否	String	排序字段的表别名。
publicData	否	String	多租查询参数。 EXCLUDE_PUBLIC_DATA：不包括公共数据。 INCLUDE_PUBLIC_DATA：包括公共数据。 ONLY_NEED_PUBLIC_DATA：只有公共数据。
sort	否	String	排序方向。 ASC：表示升序。 DESC：表示降序。
sorts	否	Array of SortInfoVo objects	排序。

表6 QueryCondition
参数	是否必选	参数类型	描述
conditionName	否	String	查询条件的名称（数据模型的属性英文名称）。
conditionValue	否	String	查询条件值（已过时）。
conditionValues	否	Array of strings	查询条件的值。operator为in时有多值，operator为其他操作符时均为单值。
conditions	否	Array of QueryCondition objects	查询条件列表。
ignoreStr	否	Boolean	是否忽略大小写。 true：表示忽略。 false：表示不忽略。
joinTableAlias	否	String	关联查询时被关联表的别名。
joiner	否	String	连接符。
operator	否	String	操作符。 =：等于查询。 like：模糊查询。 customLike：支持输入*或%的模糊查询。 in：包含查询。 <：小于查询。 >：大于查询。 >=：大于等于查询。 <=：小于等于查询。 <>：不等于查询。
preCondition	否	QueryCondition object	当前condition对象的上一层级。

表7 SortInfoVo
参数	是否必选	参数类型	描述
characterSet	否	CharacterSetEnum object	SQL编码类型。
orderBy	否	String	按某个字段进行排序。
sort	否	String	排序方向。 ASC：表示升序。 DESC：表示降序。
sortInfo	否	String	排序信息。
sortInfoOrderBy	否	String	排序信息字段。

表8 CharacterSetEnum
参数	是否必选	参数类型	描述
cnName	否	String	中文名。
code	否	String	编码。
enName	否	String	英文名。

响应参数

状态码： 200

表9 响应Body参数
参数	参数类型	描述
result	String	请求结果。
data	Array of PersistableModelQueryViewDTO objects	请求数据。
errors	Array of strings	异常信息。

**表10** PersistableModelQueryViewDTO
参数	参数类型	描述
className	String	类名。
createTime	String	创建时间。
creator	String	创建者。
disableFlag	Boolean	失效标识。 true：失效。 false：未失效。
extAttrMap	Object	扩展属性映射集。
extAttrs	Array of EXAValueViewDTO objects	扩展属性列表。
folder	FolderQueryViewDTO object	文件夹。
id	String	唯一标识。
lastUpdateTime	String	最后更新时间。
modifier	String	修改人。
rdmExtensionType	String	扩展类型。
tenant	TenantQueryViewDTO object	租户信息。

**表11** FolderQueryViewDTO
参数	参数类型	描述
businessCode	String	编码。
className	String	类名。
createTime	String	创建时间。
creator	String	创建者。
description	String	中文描述。
descriptionEn	String	英文描述。
disableFlag	Boolean	失效标识。 true：失效。 false：未失效。
extAttrMap	Object	扩展属性映射集。
extAttrs	Array of EXAValueViewDTO objects	扩展属性列表。
id	String	唯一标识。
lastUpdateTime	String	最后更新时间。
modifier	String	修改人。
name	String	中文名称。
nameEn	String	英文名称。
rdmExtensionType	String	扩展类型。
tenant	TenantQueryViewDTO object	租户信息。
type	String	类别。

**表12** EXAValueViewDTO
参数	参数类型	描述
className	String	类名。
createTime	String	创建时间。
creator	String	创建者。
id	String	唯一标识。
lastUpdateTime	String	最后更新时间。
modifier	String	修改人。
name	String	中文名称。
rdmDeleteFlag	Integer	软删除标识，参数值为0或1。 0：表示未删除。 1：表示已删除。
rdmExtensionType	String	扩展类型。
rdmVersion	Integer	系统版本。
tenant	TenantViewDTO object	租户信息。
type	String	类型。
value	Object	值。

**表13** TenantViewDTO
参数	参数类型	描述
className	String	类名。
code	String	租户编码。
createTime	String	创建时间。
creator	String	创建者。
dataSource	String	租户使用的数据源名称。
description	String	描述信息。
disableFlag	Boolean	失效标识。 true：失效。 false：未失效。
id	String	唯一标识。
kiaguid	String	KIA密级。
lastUpdateTime	String	最后更新时间。
modifier	String	修改人。
name	String	中文名称。
rdmDeleteFlag	Integer	软删除标识，参数值为0或1。 0：表示未删除。 1：表示已删除。
rdmExtensionType	String	扩展类型。
rdmVersion	Integer	系统版本。
securityLevel	String	安全密级。 INTERNAL：内部公开。 SECRET：秘密。 CONFIDENTIAL：机密。 TOP_SECRET：绝密。
tenant	TenantViewDTO object	租户信息。

**表14** TenantQueryViewDTO
参数	参数类型	描述
className	String	类名。
code	String	租户编码。
createTime	String	创建时间。
creator	String	创建者。
dataSource	String	租户使用的数据源名称。
description	String	描述信息。
disableFlag	Boolean	失效标识。 true：失效。 false：未失效。
id	String	唯一标识。
lastUpdateTime	String	最后更新时间。
modifier	String	修改人。
name	String	中文名称。
rdmExtensionType	String	扩展类型。
tenant	TenantQueryViewDTO object	租户信息。

请求示例

POST https://dme.cn-north-4.huaweicloud.com/rdm_b3f9b7523a6141f4b2d76b92d6595281_app/publicservices/api/PersistableModel/query/10/1

{
  "applicationId" : "b3f9b7523a6141f4b2d76b92d6595281",
  "params" : {
    "characterSet" : "UTF8",
    "isNeedTotal" : true,
    "isPresentAll" : true,
    "publicData" : "INCLUDE_PUBLIC_DATA",
    "decrypt" : false,
    "filter" : {
      "joiner" : "and",
      "ignoreStr" : false,
      "conditions" : [ {
        "conditionName" : "rdmExtensionType",
        "conditionValues" : [ "PersistableModel" ],
        "operator" : "=",
        "ignoreStr" : false
      } ]
    },
    "sorts" : [ ]
  }
}

响应示例

状态码： 200

{
  "result" : "SUCCESS",
  "data" : [ {
    "id" : "123",
    "creator" : "test1",
    "createTime" : "2023-12-04T11:52:48.000+0000",
    "modifier" : "XDM_Developer xxx",
    "lastUpdateTime" : "2023-12-04T12:07:59.000+0000",
    "rdmExtensionType" : "PersistableModel",
    "tenant" : {
      "id" : "-1",
      "creator" : "xdmAdmin",
      "createTime" : "2023-12-01T01:25:21.000+0000",
      "modifier" : "xdmAdmin",
      "lastUpdateTime" : "2023-12-01T01:25:21.000+0000",
      "rdmExtensionType" : "Tenant",
      "tenant" : null,
      "className" : "Tenant",
      "name" : "basicTenant",
      "description" : "默认租户",
      "code" : "basicTenant",
      "disableFlag" : false,
      "dataSource" : "DefaultDataSource"
    },
    "className" : "PersistableModel"
  } ],
  "errors" : [ ],
  "pageInfo" : {
    "curPage" : 1,
    "pageSize" : 10,
    "totalRows" : 1,
    "totalPages" : 1
  }
}

状态码

状态码	描述
200	OK

错误码

请参见错误码。

父主题： 基础数据服务

上一篇：根据唯一键为“是”的属性查询实例

下一篇：查询实例的基础属性

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！您可在我的云声建议查看反馈及问题处理状态。

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消

如您有其它疑问，您也可以通过华为云社区问答频道来与我们联系探讨

智能客服提问云社区提问

根据“列表属性”为“是”的属性查询实例

功能介绍

URI

请求参数

响应参数

请求示例

响应示例

状态码

错误码

相关文档

相关产品

意见反馈

文档内容是否对您有帮助？

7*24

备案

专业服务

退订

建议反馈

售前咨询热线