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

分页查询实例

功能介绍

分页查询指定数据模型中的所有实例。

接口约束

不涉及。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

pageSizePath

是

Integer

参数解释：

分页大小（路径参数）。

约束限制：

不涉及。

取值范围：

1-1000。

默认取值：

不涉及。

curPagePath

是

Integer

参数解释：

当前页数（路径参数）。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

1。

identifier

是

String

参数解释：

应用唯一标识。

约束限制：

不涉及。

取值范围：

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

默认取值：

不涉及。

modelName

是

String

参数解释：

数据模型的英文名称。

约束限制：

不涉及。

取值范围：

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

默认取值：

不涉及。
表2 Query参数

参数

是否必选

参数类型

描述

curPage

否

Integer

参数解释：

当前页。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

1。

endIndex

否

Integer

参数解释：

结束索引。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

0。

maxPageSize

否

Integer

参数解释：

最大分页数。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

1000。

pageSize

否

Integer

参数解释：

每页大小。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

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。

约束限制：

不涉及。

取值范围：

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

默认取值：

不涉及。

params

否

QueryRequestVo object

参数解释：

请求参数对象。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。
表5 QueryRequestVo

参数

是否必选

参数类型

描述

characterSet

否

CharacterSetEnum object

参数解释：

编码类型。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

conditions

否

Array of QueryCondition objects

参数解释：

查询条件。

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

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

decrypt

否

Boolean

参数解释：

是否加密。

约束限制：

不涉及。

取值范围：

  • true：加密。

  • false：不加密。

默认取值：

不涉及。

entityType

否

String

参数解释：

实体类型。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

filter

否

QueryCondition object

参数解释：

查询条件。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

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

参数

是否必选

参数类型

描述

conditionName

否

String

参数解释：

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

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

conditionValue

否

String

参数解释：

查询条件值（已过时）。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

conditionValues

否

Array of strings

参数解释：

查询条件的值。operator为in时有多值，operator为其他操作符时均为单值。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

conditions

否

Array of QueryCondition objects

参数解释：

查询条件列表。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

ignoreStr

否

Boolean

参数解释：

是否忽略大小写。

约束限制：

不涉及。

取值范围：

  • true：表示忽略。

  • false：表示不忽略。

默认取值：

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

默认取值：

ASC。

sortInfo

否

String

参数解释：

排序信息。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

sortInfoOrderBy

否

String

参数解释：

排序信息字段。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。
表8 CharacterSetEnum

参数

是否必选

参数类型

描述

cnName

否

String

参数解释：

中文名。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

code

否

String

参数解释：

编码。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

enName

否

String

参数解释：

英文名。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

响应参数

状态码： 200

表9 响应Body参数

参数

参数类型

描述

result

String

参数解释：

请求结果。

取值范围：

  • SUCCESS：请求成功。

  • FAIL：请求失败。

默认取值：

不涉及。

data

Array of PersistableModelViewDTO objects

参数解释：

请求数据。

取值范围：

不涉及。

默认取值：

不涉及。

errors

Array of strings

参数解释：

异常信息。

取值范围：

不涉及。

默认取值：

不涉及。
表10 PersistableModelViewDTO

参数

参数类型

描述

className

String

参数解释：

类名。

取值范围：

不涉及。

默认取值：

不涉及。

createTime

String

参数解释：

创建时间。

取值范围：

不涉及。

默认取值：

不涉及。

creator

String

参数解释：

创建者。

取值范围：

不涉及。

默认取值：

不涉及。

id

String

参数解释：

唯一标识。

取值范围：

-9223372036854775808到9223372036854775807的整数。

默认取值：

不涉及。

rdmDeleteFlag

Integer

参数解释：

软删除标识。

取值范围：

  • 0：表示未删除。

  • 1：表示已删除。

默认取值：

0。

rdmExtensionType

String

参数解释：

扩展类型。

取值范围：

不涉及。

默认取值：

不涉及。

rdmVersion

Integer

参数解释：

系统版本。

取值范围：

不涉及。

默认取值：

不涉及。

modifier

String

参数解释：

修改人。

取值范围：

不涉及。

默认取值：

不涉及。

lastUpdateTime

Object

参数解释：

最后更新时间。

取值范围：

不涉及。

默认取值：

不涉及。

tenant

TenantViewDTO object

参数解释：

租户信息。

取值范围：

不涉及。

默认取值：

不涉及。

uniqueKey

String

参数解释：

示例模型中定义的唯一键属性。

取值范围：

不涉及。

默认取值：

不涉及。
表11 TenantViewDTO

参数

参数类型

描述

className

String

参数解释：

类名。

取值范围：

不涉及。

默认取值：

不涉及。

code

String

参数解释：

租户编码。

取值范围：

不涉及。

默认取值：

不涉及。

createTime

String

参数解释：

创建时间。

取值范围：

不涉及。

默认取值：

不涉及。

creator

String

参数解释：

创建者。

取值范围：

不涉及。

默认取值：

不涉及。

dataSource

String

参数解释：

租户使用的数据源名称。

取值范围：

不涉及。

默认取值：

不涉及。

description

String

参数解释：

描述信息。

取值范围：

不涉及。

默认取值：

不涉及。

disableFlag

Boolean

参数解释：

失效标识。

取值范围：

  • true：失效。

  • false：未失效。

默认取值：

false。

id

String

参数解释：

唯一标识。

取值范围：

-9223372036854775808到9223372036854775807的整数。

默认取值：

不涉及。

kiaguid

String

参数解释：

KIA密级。

取值范围：

不涉及。

默认取值：

不涉及。

lastUpdateTime

String

参数解释：

最后更新时间。

取值范围：

不涉及。

默认取值：

不涉及。

modifier

String

参数解释：

修改人。

取值范围：

不涉及。

默认取值：

不涉及。

name

String

参数解释：

中文名称。

取值范围：

不涉及。

默认取值：

不涉及。

rdmDeleteFlag

Integer

参数解释：

软删除标识。

取值范围：

  • 0：表示未删除。

  • 1：表示已删除。

默认取值：

0。

rdmExtensionType

String

参数解释：

扩展类型。

取值范围：

不涉及。

默认取值：

不涉及。

rdmVersion

Integer

参数解释：

系统版本。

取值范围：

不涉及。

默认取值：

不涉及。

securityLevel

String

参数解释：

安全密级。

取值范围：

  • INTERNAL：内部公开。

  • SECRET：秘密。

  • CONFIDENTIAL：机密。

  • TOP_SECRET：绝密。

默认取值：

不涉及。

tenant

TenantViewDTO object

参数解释：

租户信息。

取值范围：

不涉及。

默认取值：

不涉及。

请求示例

POST https://dme.cn-north-4.huaweicloud.com/rdm_b3f9b7523a6141f4b2d76b92d6595281_app/publicservices/api/PersistableModel/find/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

OK

{
  "result" : "SUCCESS",
  "data" : [ {
    "id" : "572497983069757440",
    "creator" : "test1",
    "modifier" : "XDM_Developer xxx",
    "createTime" : "2023-12-02T11:02:36.000+0000",
    "lastUpdateTime" : "2023-12-04T03:54:44.000+0000",
    "rdmVersion" : 2,
    "rdmDeleteFlag" : 0,
    "rdmExtensionType" : "PersistableModel",
    "tenant" : {
      "id" : "-1",
      "creator" : "xdmAdmin",
      "modifier" : "xdmAdmin",
      "createTime" : "2023-12-01T01:25:21.000+0000",
      "lastUpdateTime" : "2023-12-01T01:25:21.000+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" : "PersistableModel",
    "uniqueKey" : null
  } ],
  "errors" : [ ],
  "pageInfo" : {
    "curPage" : 1,
    "pageSize" : 10,
    "totalRows" : 1,
    "totalPages" : 1
  }
}

状态码

状态码

描述

200

OK

错误码

请参见错误码。

父主题： 基础数据服务

相关文档