文档首页/ 工业数字模型驱动引擎/ API参考/ API/ 数据建模引擎/ 基础数据服务/ 统计指定数据模型的实例总数
更新时间：2024-09-05 GMT+08:00
查看PDF
分享

统计指定数据模型的实例总数

功能介绍

根据指定的查询条件，统计指定数据模型中的实例总数。

接口约束

不涉及。

URI

POST /rdm_{identifier}_app/publicservices/api/{modelName}/count

表1 路径参数

参数

是否必选

参数类型

描述

identifier

是

String

参数解释：

应用唯一标识。

约束限制：

不涉及。

取值范围：

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

默认取值：

不涉及。

modelName

是

String

参数解释：

数据模型的英文名称。

约束限制：

不涉及。

取值范围：

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

默认取值：

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

IAM用户的token。

获取方法请参见获取IAM用户Token。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。
表3 请求Body参数

参数

是否必选

参数类型

描述

applicationId

否

String

参数解释：

应用ID。

约束限制：

不涉及。

取值范围：

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

默认取值：

不涉及。

params

否

QueryRequestCountVo object

参数解释：

请求参数对象。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。
表4 QueryRequestCountVo

参数

是否必选

参数类型

描述

characterSet

否

CharacterSetEnum object

参数解释：

编码类型。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

conditions

否

Array of QueryCondition objects

参数解释：

查询条件。

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

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

decrypt

否

Boolean

参数解释：

是否加密。

约束限制：

不涉及。

取值范围：

  • true：加密。

  • false：不加密。

默认取值：

false。

entityType

否

String

参数解释：

实体类型。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

filter

否

QueryCondition object

参数解释：

查询条件。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

isNeedTotal

否

Boolean

参数解释：

是否需要查询总记录数。

约束限制：

不涉及。

取值范围：

  • true：需要。

  • false：不需要。

默认取值：

false。

isPresentAll

否

Boolean

参数解释：

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

约束限制：

不涉及。

取值范围：

  • true：需要。

  • false：不需要。

默认取值：

false。

maxCount

否

Integer

参数解释：

指定数量上限，如果超过统计总数超过上限则返回上限。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

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

参数解释：

排序。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。
表5 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对象的上一层级。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。
表6 SortInfoVo

参数

是否必选

参数类型

描述

characterSet

否

CharacterSetEnum object

参数解释：

SQL编码类型。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

orderBy

否

String

参数解释：

按某个字段进行排序。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

sort

否

String

参数解释：

排序方向。

约束限制：

不涉及。

取值范围：

  • ASC：表示升序。

  • DESC：表示降序。

默认取值：

ASC。

sortInfo

否

String

参数解释：

排序信息。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

sortInfoOrderBy

否

String

参数解释：

排序信息字段。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。
表7 CharacterSetEnum

参数

是否必选

参数类型

描述

cnName

否

String

参数解释：

中文名。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

code

否

String

参数解释：

编码。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

enName

否

String

参数解释：

英文名。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

响应参数

状态码： 200

表8 响应Body参数

参数

参数类型

描述

result

String

参数解释：

请求结果。

取值范围：

  • SUCCESS：请求成功。

  • FAIL：请求失败。

默认取值：

不涉及。

data

Array of longs

参数解释：

请求数据。

取值范围：

不涉及。

默认取值：

不涉及。

errors

Array of strings

参数解释：

异常信息。

取值范围：

不涉及。

默认取值：

不涉及。

请求示例

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

{
  "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" : [ 14 ],
  "errors" : [ ]
}

状态码

状态码

描述

200

OK

错误码

请参见错误码。

父主题： 基础数据服务

相关文档