| 参数名称 | 中文标题 | 描述 |
|---|---|---|
| status | 状态码 | 200：成功，300：错误，301：登陆超时，302：警告 |
| data | 数据集 | 后台返回数据结果集，数组[]，对象{} |
| massage | 信息描述 | 当 status 不等于 200 时此属性有内容 |
| layer | 树型数据层级 | 默认从 0 开始，不取子节点，只对树型表有有效 |
| pageno | 当前页码 | 默认从 1 开始 |
| pagesize | 每页数据集 | 默认每页 20 条 |
| fields | 需要返回的属性 | 1、返回表中字段集 A、指定返回字段：字段名 1,字段名 2,字段名 3,字段名 n B、不返回指定字段：-字段名 1,-字段名 2,-字段名 3,-字段名 n 2、返回子表内容 A、返回单条子表记录：子表1(子表字段1,子表字段2,子表字段n),子表2,子表n B、返回批量子表记录：子表1[子表字段1,子表字段2,子表字段n],子表2[],子表n[] |
| orderby | 排序字段 | 字段名，字段名- 默认为按指定字段升序排序，字段名后边跟“-”表示降序排序 |
| @api | 接口描述 | 返回接口对应的 API 描述，与数据库中的备注作息一致 |
| {fieldname} | 字段名称 |
按字段查询，所有字段的查询都是 “并且” 关系
1、精确匹配，{fieldname}=value
2、模糊匹配，只对字符串类型字段有效
{fieldname}=%value%，左右模糊匹配
{fieldname}=%value，左模糊匹配
{fieldname}=value%，右模糊匹配
{fieldname}=带“*”号，通配符模糊匹配，
a.如匹配所有地址为“体育西”的，eg:{fieldname}=*体育西*，可匹配“广东省广州市体育本路38号”
b.如匹配所有姓名为“陈”开始，“丰”结尾的所有人，eg:name=陈*丰，匹配到陈大丰，陈二丰，陈张三丰
3、大于查询：{fieldname}=>value，或者 {fieldname}=(value,]
4、小于查询：{fieldname}=<value，或者 {fieldname}=[,value)
5、不等查询：{fieldname}=!value
6、区间查询，{fieldname}=[value1,vaule2]，{fieldname}=(value1,vaule2)
[]表示fieldname>=value1 且 fieldname<=value2
()表示 fieldname>value1 且 fieldname<value2
7、不等于null：{fieldname}=!
8、不等于空字符串：{fieldname}=!''
9、多值查询：{fieldname}=value1,value2,value3,valueN
10、日期区间快捷查询：只对日期类型字段或时间戳类型字段有效
统一规则：(近|前|后)?(\\d+)?(分钟?|小?时|天|号|周|个?月份?|年度?)
近：只包含当前，当前日期单位（年、月、周、天、日、时、分）算1份，没有前缀时为指定单位日期
如：近1个月，当前日期为2022年9月20号，那么就只取9月1号凌晨到20号的数据，不包含8月份
前：不包含当前
后：包含当前时间（很少用到）
{fieldname}=value，value值参考如下：
当天：表示当天的00:00:00.000~23:59:59.999
当月：表示当月第一天的00:00:00.000~最后一天的23:59:59.999
本年：当前年
近n天：表示当前时间前多少天，包含当天
前n天：表示当前时间前多少天，不包含当天
后n天：表示当前时间后多少天
n号|日：表示当月的几号日期（某一天）
n天：默认为近n天
近n月：表示当前时间前几个月，包含当月
前n月：表示当前时间前几个月，不包含当月
后n月：表示当前时间后几个月
n月：表示当前年份的第几个月（某一个月）
近n年：表示当前时间前几年，包含本年
前n年：表示当前时间前几年，不包含本年
后n年：表示当前时间后几年
n年：指定年份，如：2022年表示为2022-1-1 00:00:00.000~2022-12-31 23:59:59.999
当n小于100时表示为最近n年
……
前|后n分钟，前|后n小时，前|后n周
注：大于、小于、区间只针对Number类型，日期类型有效。
|
使用系统自带API系统测试时，需要选中“使用JSON数据提交”，在“使用JSON数据提交：”内容中输入批量新增的内容，内容为数组，数组中每项数据项名称必须保持一致，当数组中的字段内容与数量不一致是，以第一个数组字段与数量为准。如下：
[
{"org_id":"abcd", "account_id":"account_id1"},
{"org_id":"abcd", "account_id":"account_id2"},
{"org_id":"abcd", "account_id":"account_id3"}
]
1）单条增加，如下，在user表中增加一第数据，同时在对应关系子表user_info中增加两条数据
{
"name":"batch_test",
"age":345,
"_create":{
"user_info":[{
"content":"131223123fds"
},{
"content":"131223123asdf"
}]
}
}
2）更新操作（_replace：全部替换，_create：只做新增操作），更新user表的同时更新或替换子表user_info中的数据
{
"user_id": "2C9B70D5C3DBFE101F0OE3DAD99908345F7439F8FFABDFFC4",
"_replace":{
"user_info":[{
"content":"中文1fds"
},{
"content":"中文人手动阀手动阀"
}]
}
}