Skip to content
开发文档
能力中心
应用市场
WebOffice
开发者后台

查询记录列表

查询低代码应用下指定数据表的所有记录数据

请求说明

请求地址https://openapi.wps.cn/v7/low_code_app/app_instance/{app_instance_id}/table/{table_id}/records/search
请求方法POST
签名方式KSO-1
权限要求查询低代码应用数据(应用授权) kso.low_code_app.read
读写低代码应用数据(应用授权) kso.low_code_app.readwrite

请求头(Header)

Header 名称参数类型是否必填说明
Content-Typestring使用:application/json
X-Kso-DatestringRFC1123 格式的日期,例: Wed, 23 Jan 2013 06:43:08 GMT
X-Kso-AuthorizationstringKSO-1 签名值,详见《签名方法》
Authorizationstring授权凭证,格式为:Bearer {access_token}

路径参数(Path)

名称参数类型说明
app_instance_idstring
table_idstring

请求体(Body)

名称参数类型是否必填说明
condition_listarray[object]筛选条件列表,默认全查
∟ field_idstring字段 id
∟ funcstring聚合函数,month、week、length
∟ optstring[enum]操作符
eqnegtgeltlecontainsnotContainsstartsWithendsWithisNullisNotNullbetweennotBetween
∟ valueobject字段值
∟ varboolean是否为表达式
∟ var_typeinteger变量类型
page_sizeinteger分页大小,默认值为 50
page_tokenstring分页标记
with_totalboolean是否返回 total 字段 默认不返回

请求地址示例

[POST] https://openapi.wps.cn/v7/low_code_app/app_instance/{app_instance_id}/table/{table_id}/records/search

请求体示例

json
{
  "condition_list": [
    {
      "field_id": "string",
      "func": "string",
      "opt": "string[enum]",
      "value": "object",
      "var": false,
      "var_type": 0
    }
  ],
  "page_size": 0,
  "page_token": "string",
  "with_total": false
}

响应体

名称参数类型说明
codeinteger响应代码。非 0 表示失败,参照《状态码说明》
msgstring响应信息
dataobject响应数据
∟ itemsarray[object]查询记录列表
∟ ∟ row_dataobject记录数据对象,格式为 field_id:field_value
∟ next_page_tokenstring下次查询分页标记
∟ totalinteger总数
moreobject更多的错误信息

响应体示例

json
{
  "code": 0,
  "data": {
    "items": [
      {
        "row_data": "object"
      }
    ],
    "next_page_token": "string",
    "total": 0
  },
  "msg": "string"
}
回到旧版