查询记录列表
查询低代码应用下指定数据表的所有记录数据
请求说明
| 请求地址 | 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-Type | string | 是 | 使用:application/json |
| X-Kso-Date | string | 是 | RFC1123 格式的日期,例: Wed, 23 Jan 2013 06:43:08 GMT |
| X-Kso-Authorization | string | 是 | KSO-1 签名值,详见《签名方法》 |
| Authorization | string | 是 | 授权凭证,格式为:Bearer {access_token} |
路径参数(Path)
| 名称 | 参数类型 | 说明 |
|---|---|---|
| app_instance_id | string | |
| table_id | string |
请求体(Body)
| 名称 | 参数类型 | 是否必填 | 说明 |
|---|---|---|---|
| condition_list | array[object] | 否 | 筛选条件列表,默认全查 |
| ∟ field_id | string | 是 | 字段 id |
| ∟ func | string | 是 | 聚合函数,month、week、length |
| ∟ opt | string[enum] | 是 | 操作符 eq;ne;gt;ge;lt;le;contains;notContains;startsWith;endsWith;isNull;isNotNull;between;notBetween |
| ∟ value | object | 是 | 字段值 |
| ∟ var | boolean | 是 | 是否为表达式 |
| ∟ var_type | integer | 是 | 变量类型 |
| page_size | integer | 否 | 分页大小,默认值为 50 |
| page_token | string | 否 | 分页标记 |
| with_total | boolean | 否 | 是否返回 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
}响应体
| 名称 | 参数类型 | 说明 |
|---|---|---|
| code | integer | 响应代码。非 0 表示失败,参照《状态码说明》 |
| msg | string | 响应信息 |
| data | object | 响应数据 |
| ∟ items | array[object] | 查询记录列表 |
| ∟ ∟ row_data | object | 记录数据对象,格式为 field_id:field_value |
| ∟ next_page_token | string | 下次查询分页标记 |
| ∟ total | integer | 总数 |
| more | object | 更多的错误信息 |
响应体示例
json
{
"code": 0,
"data": {
"items": [
{
"row_data": "object"
}
],
"next_page_token": "string",
"total": 0
},
"msg": "string"
}