数据查询
接口说明:通用数据查询接口,支持多条件筛选、分页、排序,需携带有效Token访问。
1. 接口信息
| 参数 |
说明 |
| 请求方式 |
POST |
| 接口地址 |
/api/v1/data/query |
| 是否需要授权 |
是 |
| 请求格式 |
JSON |
2. 请求参数
2.1 Header参数
| 参数名 |
必选 |
类型 |
说明 |
| Authorization |
是 |
string |
Bearer + Token |
| Content-Type |
是 |
string |
application/json |
2.2 Body参数
| 参数名 |
必选 |
类型 |
说明 |
| dataType |
是 |
string |
数据类型:user/order/dept等 |
| pageNum |
否 |
int |
页码,默认1 |
| pageSize |
否 |
int |
每页条数,默认20,最大100 |
| filters |
否 |
array |
筛选条件,格式:[{"field":"name","operator":"like","value":"张三"}]
|
| sorts |
否 |
array |
排序条件,格式:[{"field":"createTime","order":"desc"}] |
3. 请求示例
POST /api/v1/data/query HTTP/1.1
Host: eimsnext.example.com
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
Content-Type: application/json
{
"dataType": "order",
"pageNum": 1,
"pageSize": 20,
"filters": [
{"field": "createTime", "operator": "between", "value": ["2025-01-01", "2025-01-31"]},
{"field": "status", "operator": "eq", "value": 1}
],
"sorts": [
{"field": "createTime", "order": "desc"}
]
}
4. 响应结果
4.1 成功响应
200 OK
{
"code": 200,
"msg": "查询成功",
"data": {
"total": 50,
"pageNum": 1,
"pageSize": 20,
"list": [
{
"orderId": "O001",
"orderName": "订单1",
"amount": 1000.00,
"status": 1,
"createTime": "2025-01-30 10:00:00"
}
]
}
}
5. 错误码说明
| 错误码 |
说明 |
解决方案 |
| 401 |
Token无效或过期 |
重新获取Token |
| 403 |
无数据查询权限 |
分配对应权限 |
| 400 |
参数错误 |
检查filters/sorts格式是否正确 |
| 500 |
服务器内部错误 |
联系技术支持 |
6. 注意事项
-
operator支持:eq(等于)、ne(不等于)、like(模糊)、gt(大于)、lt(小于)、between(区间)
- 仅返回当前用户有权限查看的数据
- 接口调用频率限制:50次/分钟