文档首页/ 工业数字模型驱动引擎/ API参考/ API/ 数据建模引擎/ 基础数据服务/ 查询实例的基础属性 - ListUsingPost
更新时间：2026-07-28 GMT+08:00
查看PDF
分享

查询实例的基础属性 - ListUsingPost

功能介绍

本接口用于根据查询条件，分页检索数据模型实例的基础属性与系统级元数据信息。

在调用本接口前，请确保目标数据模型已满足实例化条件：

  1. 已在应用设计态完成数据模型（数据实体或关系实体）的创建与发布。具体操作请参见创建数据实体、创建关系实体和应用发布。

  2. 已将对应应用成功部署至运行态。具体操作请参见部署应用。

接口约束

  • filter中的conditionName仅支持数据模型的基础属性与系统内置属性（如id、createTime、lifecycleState等），不支持使用扩展属性（自定义业务属性）作为查询条件。如需按扩展属性过滤，请使用分页查询实例 - ShowFindUsingPost接口。

  • 请求参数中QueryRequestVo下的conditions字段已废弃，请使用filter字段来构建查询条件。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见权限和授权项。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

pageSizePath

是

Integer

参数解释：

分页大小，即每页返回的实例数量。

约束限制：

不涉及。

取值范围：

1-1000。

默认取值：

不涉及。

curPagePath

是

Integer

参数解释：

当前页数，从1开始计数。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

1。

identifier

是

String

参数解释：

应用的唯一标识。

  • 于2023年06月01日之前创建的应用，其唯一标识为该应用的名称。

  • 于2023年06月01日之后创建的应用，其唯一标识为该应用的ID。

获取方法请参见获取运行服务清单 - ListEnvs。

约束限制：

不涉及。

取值范围：

  • 于2023年06月01日之前创建的应用：由英文字母和数字组成，长度为1-36个字符。

  • 于2023年06月01日之后创建的应用：由英文字母和数字组成，且长度为32个字符。

默认取值：

不涉及。

modelName

是

String

参数解释：

数据模型的英文名称。

约束限制：

不涉及。

取值范围：

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

默认取值：

不涉及。
表2 Query参数

参数

是否必选

参数类型

描述

curPage

否

Integer

参数解释：

当前页码，从1开始计数。当路径参数curPagePath未指定时生效。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

1。

endIndex

否

Integer

参数解释：

结束索引，用于指定查询结果的结束位置。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

0。

maxPageSize

否

Integer

参数解释：

最大分页数，用于限制返回的最大页数。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

1000。

pageSize

否

Integer

参数解释：

分页大小，即每页返回的实例数量。当路径参数pageSizePath未指定时生效。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

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，用于指定实例所属的应用。

当URL路径中已能明确应用上下文时，此参数可不传。

获取方法请参见获取租户下的应用清单 - ListApps。

约束限制：

不涉及。

取值范围：

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

默认取值：

不涉及。

params

是

QueryRequestVo object

参数解释：

请求参数对象。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。
表5 QueryRequestVo

参数

是否必选

参数类型

描述

characterSet

否

String

参数解释：

编码类型，用于指定查询的字符编码。

约束限制：

不涉及。

取值范围：

  • ASCII：ASCII

  • BINARY：BINARY

  • GB2312：GB2312

  • GBK：GBK

  • UTF8：UTF8

  • UTF16：UTF16

  • UTF32：UTF32

  • UTF8MB4：UTF8MB4

默认取值：

UTF8。

conditions

否

Array of QueryCondition objects

参数解释：

查询条件组。

此参数已废弃，不建议继续使用，建议使用替代参数filter。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

decrypt

否

Boolean

参数解释：

是否对查询结果进行加密。

约束限制：

不涉及。

取值范围：

  • true：加密。

  • false：不加密。

默认取值：

不涉及。

entityType

否

String

参数解释：

实体类型，用于指定查询的目标实体类型。

约束限制：

不涉及。

取值范围：

  • ENTITY：数据实体。

  • RRELATION：关系实体。

默认取值：

不涉及。

filter

否

QueryCondition object

参数解释：

指定条件的构建对象，用于定义实例的过滤条件。

约束限制：

filter的属性仅joiner和conditions生效。

取值范围：

不涉及。

默认取值：

不涉及。

isNeedTotal

否

Boolean

参数解释：

是否需要查询总记录数。

约束限制：

不涉及。

取值范围：

  • true：需要。

  • false：不需要。

默认取值：

false。

isPresentAll

否

Boolean

参数解释：

是否需要展示所有参考对象信息。

约束限制：

不涉及。

取值范围：

  • true：需要。

  • false：不需要。

默认取值：

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：表示降序。

默认取值：

ASC。

sorts

否

Array of SortInfoVo objects

参数解释：

多字段排序配置。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。
表6 QueryCondition

参数

是否必选

参数类型

描述

conditions

否

Array of QueryCondition objects

参数解释：

嵌套查询条件数组，用于构建多层级查询逻辑。其逻辑关系由同级的joiner属性决定。每个子条件可包含基础条件或嵌套条件：

  • 基础条件结构：由conditionName（属性英文名称）、operator（操作符）、conditionValues（条件值）组成单一查询条件。

  • 嵌套条件结构：包含子级joiner和conditions数组，支持多层级逻辑嵌套。

约束限制：

当一个对象同时符合基础条件和嵌套条件时，系统将优先考虑嵌套条件，并忽略基础条件。

取值范围：

不涉及。

默认取值：

不涉及。

conditionName

否

String

参数解释：

查询条件的名称（对应数据模型中属性的英文名称）。

约束限制：

该参数仅在conditions数组中生效。

取值范围：

不涉及。

默认取值：

不涉及。

operator

否

String

参数解释：

操作符，用于定义查询条件的匹配规则。

约束限制：

  • 仅在conditions数组中生效。

  • “多值”为“是”的属性支持使用contains、=、like、customLike、startWith、endWith、ISNULL。

  • “多值”为“否”的属性不支持使用contains。

取值范围：

  • =：等于查询。

  • <：小于查询。

  • >：大于查询。

  • >=：大于等于查询。

  • <=：小于等于查询。

  • <>：不等于查询。

  • startWith：头匹配查询。

  • endWith：尾匹配查询。

  • like：模糊查询。

  • customLike：支持输入*或%的模糊查询。

  • in：包含查询。

  • not in：排除查询。

  • ISNULL：值为空查询。

  • NOTNULL：值不为空查询。

  • contains：包含查询。

默认取值：

不涉及。

conditionValues

否

Array of strings

参数解释：

查询条件的值列表。

约束限制：

仅在conditions数组中生效。

取值范围：

  • 非多值约束属性：operator为in时有多个值，operator为其他操作符时均为单个值。

  • 多值约束属性：operator为contains或=时，取值为多个值。operator为其他操作符时均为单个值。

默认取值：

不涉及。

conditionValue

否

String

参数解释：

查询条件值（已过时）。

此参数已废弃，不建议继续使用，建议使用替代参数conditionValues。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

ignoreStr

否

Boolean

参数解释：

是否忽略大小写。

约束限制：

仅在conditions数组中生效。

取值范围：

  • true：表示忽略。

  • false：表示不忽略。

默认取值：

false。

joinTableAlias

否

String

参数解释：

关联查询时被关联表的别名。

约束限制：

仅在conditions数组中生效。

取值范围：

不涉及。

默认取值：

不涉及。

joiner

否

String

参数解释：

连接符，用于连接conditions中的条件对象，定义条件间的逻辑关系。

约束限制：

不涉及。

取值范围：

  • and：与连接。

  • or：或连接。

默认取值：

不涉及。

preCondition

否

QueryCondition object

参数解释：

当前condition对象的上一层级条件，用于构建条件层级关系。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。
表7 SortInfoVo

参数

是否必选

参数类型

描述

characterSet

否

CharacterSetEnum object

参数解释：

SQL编码类型，用于指定数据统计查询的字符编码格式。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

orderBy

否

String

参数解释：

排序字段，按指定字段对查询结果进行排序。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

sort

否

String

参数解释：

排序方向。

约束限制：

不涉及。

取值范围：

  • ASC：表示升序。

  • DESC：表示降序。

默认取值：

ASC。

sortInfo

否

String

参数解释：

排序信息。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

sortInfoOrderBy

否

String

参数解释：

排序信息字段。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。
表8 CharacterSetEnum

参数

是否必选

参数类型

描述

cnName

否

String

参数解释：

中文名称。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

code

否

String

参数解释：

编码值。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

enName

否

String

参数解释：

英文名称。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

响应参数

状态码：200

表9 响应Body参数

参数

参数类型

描述

result

String

参数解释：

请求处理结果状态。

取值范围：

  • SUCCESS：请求成功。

  • FAIL：请求失败。

data

Array of PersistableModelListViewDTO objects

参数解释：

请求数据。

取值范围：

不涉及。

errors

Array of strings

参数解释：

异常信息列表。当result为FAIL时，返回具体的错误描述，包含失败原因及建议处理方式。

取值范围：

不涉及。
表10 PersistableModelListViewDTO

参数

参数类型

描述

aclEntry

String

参数解释：

访问控制列表。

取值范围：

不涉及。

className

String

参数解释：

类名。

取值范围：

不涉及。

clsAttrs

Array of objects

参数解释：

分类属性。

取值范围：

不涉及。

createTime

String

参数解释：

创建时间。使用UTC+0时间格式，格式为yyyy-MM-ddTHH:mm:ss.SSSZ。

取值范围：

不涉及。

creator

String

参数解释：

创建者账号。

取值范围：

不涉及。

disableFlag

Boolean

参数解释：

失效标识。

取值范围：

  • true：失效。

  • false：未失效。

folder

ObjectReferenceViewDTO object

参数解释：

文件夹。

取值范围：

不涉及。

fullPath

String

参数解释：

用于存储当前节点全路径。

取值范围：

不涉及。

id

String

参数解释：

唯一标识。

取值范围：

-9223372036854775808到9223372036854775807的整数。

lastUpdateTime

String

参数解释：

最后更新时间。使用UTC+0时间格式，格式为yyyy-MM-ddTHH:mm:ss.SSSZ。

取值范围：

不涉及。

leafFlag

Boolean

参数解释：

是否为叶子节点。

取值范围：

  • true：是叶子节点。

  • false：不是叶子节点。

lifecycleState

ObjectReferenceViewDTO object

参数解释：

状态

取值范围：

不涉及。

lifecycleTemplate

ObjectReferenceViewDTO object

参数解释：

生命周期模板。

取值范围：

不涉及。

modifier

String

参数解释：

更新者账号。

取值范围：

不涉及。

owner

String

参数解释：

拥有者。

取值范围：

不涉及。

parentNode

ObjectReferenceViewDTO object

参数解释：

父节点。

取值范围：

不涉及。

rawFullPath

String

参数解释：

用于存储当前节点原始全路径。

取值范围：

不涉及。

rdmDeleteFlag

Integer

参数解释：

软删除标识。

取值范围：

  • 0：表示未删除。

  • 1：表示已删除。

rdmExtensionType

String

参数解释：

扩展类型。

取值范围：

不涉及。

rdmVersion

Integer

参数解释：

系统版本。

取值范围：

不涉及。

rootNode

ObjectReferenceViewDTO object

参数解释：

根节点。

取值范围：

不涉及。

tenant

ObjectReferenceViewDTO object

参数解释：

租户信息。

取值范围：

不涉及。

uniqueKey

String

参数解释：

数据模型的唯一键约束属性。

取值范围：

不涉及。
表11 ObjectReferenceViewDTO

参数

参数类型

描述

id

String

参数解释：

唯一标识，标识关联实例的主键ID。

clazz

String

参数解释：

类名，标识关联实例的类类型。

请求示例

示例：组合条件分页查询基础属性（ID范围+时间范围）

构建条件为：id在100到1000之间，且createTime在2025年7月1日至8月1日之间，按id升序排列，每页10条，返回第1页。

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

{
  "params" : {
    "characterSet" : "UTF8",
    "isNeedTotal" : true,
    "filter" : {
      "joiner" : "and",
      "conditions" : [ {
        "joiner" : "and",
        "conditions" : [ {
          "conditionName" : "id",
          "operator" : ">=",
          "conditionValues" : [ "100" ]
        }, {
          "conditionName" : "id",
          "operator" : "<=",
          "conditionValues" : [ "1000" ]
        } ]
      }, {
        "joiner" : "and",
        "conditions" : [ {
          "conditionName" : "createTime",
          "operator" : ">=",
          "conditionValues" : [ "2025-7-1 00:00:00" ]
        }, {
          "conditionName" : "createTime",
          "operator" : "<=",
          "conditionValues" : [ "2025-8-1 00:00:00" ]
        } ]
      } ]
    },
    "sorts" : [ {
      "sort" : "ASC",
      "orderBy" : "id"
    } ]
  }
}

响应示例

状态码：200

OK，表示请求成功。

{
  "result": "SUCCESS",
  "data": [
    {
      "aclEntry": "AclEntry",
      "className": "PersistableModel",
      "clsAttrs": [],
      "createTime": 2023-09-27T06:18:03.000+0000,
      "creator": "test1",
      "disableFlag": false,
      "folder": {
        "clazz": "PersistableModel",
        "id": "548451844855177200"
      },
      "fullPath": "/*/*/**",
      "id": "548451844855177200",
      "lastUpdateTime": 2023-09-27T06:18:03.000+0000,
      "leafFlag": false,
      "lifecycleState": {
        "clazz": "PersistableModel",
        "id": "548451844855177200"
      },
      "lifecycleTemplate": {
        "clazz": "PersistableModel",
        "id": "548451844855177200"
      },
      "modifier": "test1",
      "owner": "test1",
      "parentNode": {
        "clazz": "PersistableModel",
        "id": "548451844855177200"
      },
      "rawFullPath": "/**/**",
      "rdmDeleteFlag": 0,
      "rdmExtensionType": "PersistableModel",
      "rdmVersion": 1,
      "rootNode": {
        "clazz": "PersistableModel",
        "id": "548451844855177200"
      },
      "tenant": {
        "clazz": "PersistableModel",
        "id": "548451844855177200"
      },
      "uniqueKey": "id"
    }
  ],
  "errors": []
}

状态码

状态码

描述

200

OK，表示请求成功。

错误码

请参见错误码。

父主题： 基础数据服务

相关文档