更新时间:2024-12-23 GMT+08:00
分享

查询满足条件的实例数据

功能介绍

应用设计态完成模型的构建、发布(模型发布和应用发布),以及控制台部署应用后,会在应用运行态自动生成相应的CRUD接口。其中,find接口用于分页查询实例信息。

更多API信息请参见全量数据服务

URI

  • URI格式:

    POST http://{Endpoint}/rdm_{appID}_app/services/dynamic/api/{entityName}/find/{pageSize}/{curPage}

  • 参数说明:
    表1 URI参数说明

    参数

    是否必填

    参数类型

    描述

    Endpoint

    String

    承载REST服务端点的服务器域名或IP地址。

    appID

    String

    应用ID。

    entityName

    String

    实体的英文名称。

    pageSize

    String

    分页查询时,每页最多展示的记录数。

    curPage

    String

    分页查询的页数。

请求参数

根据实体类型、功能的不同,请求body参数不同,您可以在全量数据服务查看API具体参数。为篇幅起见,这里只展示部分内容。

表2 请求body参数

参数

是否必填

参数类型

描述

sorts

List

排序。

sort

String

排序方式(asc/desc)。

orderBy

String

排序字段,可填写模型自身属性、参考对象的属性、扩展属性及分类属性。

filter

Object

查询条件。

isNeedTotal

Boolean

是否需要查询总记录数(false/true)。

响应参数

返回模型所有属性、直接关联的参考对象、扩展属性、分类属性、级联的数据等。

请求示例

示例背景

  • 已在设计态构建一个名称为“employee”的数据实体,该实体自定义了“age”gender两个属性,并完成了实体发布、应用发布和应用部署。
  • 已在运行态通过控制台或API的方式创建多个数据实例。

需要查询“gender”“男性”的数据实例,且结果需要先按名称倒序排序,再按年龄倒序排序。

示例代码

{
    "params": {
        "sorts": [
            {
                "sort": "DESC",
                "orderBy": "name"
            },
            {
                "sort": "DESC",
                "orderBy": "age"
            }
        ],
        "filter": {
            "joiner": "and",
            "conditions": [
                {
                    "conditionName": "gender",
                    "operator": "=",
                    "conditionValues": [
                        ""
                    ]
                }
            ]
        },
        "isNeedTotal": true
    }
}

响应示例

{
    "result": "SUCCESS",
    "data": [
        {
            "id": "455304645330341888",
            "creator": "test1 3c03e719256a427eb9277b64fcXXXXXX",
            "createTime": "2023-01-13T01:38:07.000+00:00",
            "modifier": "test1 3c03e719256a427eb9277b64fcXXXXXX",
            "lastUpdateTime": "2023-01-13T01:38:07.000+00:00",
            "rdmVersion": 1,
            "rdmExtensionType": "People",
            "rdmDeleteFlag": 0,
            "tenant": {
                "id": "-1",
                "clazz": "Tenant"
            },
            "className": "People",
            "name": "李四",
            "description": null,
            "kiaguid": null,
            "securityLevel": "internal",
            "gender": "",
            "age": 20
        },
        {
            "id": "455304534248394752",
            "creator": "test1 3c03e719256a427eb9277b64fcXXXXXX",
            "createTime": "2023-01-13T01:37:40.000+00:00",
            "modifier": "test1 3c03e719256a427eb9277b64fcXXXXXX",
            "lastUpdateTime": "2023-01-13T01:37:40.000+00:00",
            "rdmVersion": 1,
            "rdmExtensionType": "People",
            "rdmDeleteFlag": 0,
            "tenant": {
                "id": "-1",
                "clazz": "Tenant"
            },
            "className": "People",
            "name": "张三",
            "description": null,
            "kiaguid": null,
            "securityLevel": "internal",
            "gender": "",
            "age": 18
        }
    ],
    "errors": [],
    "pageInfo": {
        "curPage": 1,
        "pageSize": 20,
        "totalRows": 2,
        "totalPages": 1
    }
}

相关文档