App.Table.FreeQuery API Docs | The No-Code CURD API Platform

OkayAPI Docs

API Path: /api/App/Table/FreeQuery

API Description: //请使用@desc 注释

1

API Traffic

HTTP/HTTPS

Protocol

GET/POST

Method

UTF-8

Charset

JSON

Response

API Params

Parameter	Type	Required	Default	Note	Description
HTTP_APPKEY	String	Required		MIN: 32	Common Put Your APPKEY
model_name	String	Required			Your table Model Name
select	ArraySeperated with ,	Optaion			SQL语句的SELECT部分，多个字段用英文逗号分割，如：select=id,uuid
logic	Enum	Optaion	and	Range: and/or	Where condition logic, logic=and for logical and, logic=or for logical or
where	ArrayJSON Format	Optaion	[["id", ">=", "1"]]		SQL WHERE condition, JSON format: [condition_1, condition_2, ...] EACH condition: ["FIELD", "OP", "COMPARE_VALUE"] FIELD: Table field name; OP: such as >、>=、<、<=、<>、!=、EQ、GT、GE、LT、LE、NE、LIKE、NLIKE、IN、NIN、BETWEEN、NBETWEEN COMPARE_VALUE: The values that need to be compared, the format of the comparison value will be different. If the field is a numeric type, pass the numeric type, not a string. Example: logic=and, where=[["id",">",9],["id","<=",10]], It means: id > 9 AND id <= 10
where_X	String	Optaion			动态条件，优先于where的JSON数据，简化的where条件，更易使用但只支持部分比较符。条件格式：`where_` + `X（X要换成你的字段名）` = `比较符（见下方）` + `中横线（-）` + `比较值`。支持的比较符和示例如下： EQ：等于（默认），如：where_year=EQ-2020，或：where_year=2020，表示年份year等于2020； GT：大于，如：where_year=GT-2020，表示年份year大于2020； GE：大于等于，如：where_year=GE-2020，表示年份year大于或等于2020； LT：小于，如：where_year=LT-2020，表示年份year小于2020； LE：大于等于，如：where_year=LE-2020，表示年份year小于或等于2020； NE：不等于，如：where_year=NE-2020，表示年份year不等于2020； LIKE：模糊匹配，如：where_name=LIKE-小白，表示名字name含有小白的； NLIKE：模糊匹配（排除），如：where_name=NLIKE-小白，表示名字name不包含小白的 IN：枚举查询，如：where_year=IN-2020,2021,2022，表示年份year在这三个年份，多个值用英文逗号分割 NIN：枚举查询（排除），如：where_year=NIN-2020,2021,2022，表示年份year不在这三个年份，多个值用英文逗号分割如果同一字段有多个条件，使用双竖线`\|\|`分割，如：where_year=GT-2000\|\|LT-2020，表示year年份大于2020（logic=and或logic=or）小于2020。（where和where_X二选一，不可混用，以where_X优先）
order	ArrayJSON Format	Optaion	[]		SQL语句的ORDER部分，JSON格式。具体格式为：[第一组排序，第二组排序，……]，可以单个或组合排序。每一组排序格式为："字段名 + 空格 + ASC\|DESC"，其中： ASC：为指定列按升序排列 DESC：为指定列按降序排列。例1：单个排序，order=["id DESC"]，表示按ID降序，即最新的在最前面。例2：组合排序，order=["id DESC", "add_time ASC"]，表示id DESC, add_time ASC，即先按ID从大到小，再按创建时间倒序排序。特别地，RAND表示随机排序，请慎用。
page	Int	Optaion	1	MIN: 1	第几页
perpage	Int	Optaion	10	MIN: 1；MAX: 10000	分页数量
is_real_total	Boolean	Optaion	true		是否需要真正的总数，1是0否，当表单数据过多时，如果不需要查询真正的总数，将能极大提升接口响应的速度。若为假总数，固定返回9999999。

API Debug

Submit Type:

Form Data

JSON RAW(application/json;charset=UTF-8)

JSON RAW

KEY	REQUIRED	VALUE
app_key	*Required
model_name	*Required
select	Option
logic	Option
where	Option
order	Option
page	Option
perpage	Option
is_real_total	Option

API Response

KEY	Type	Description
err_code	Int	操作码，0表示成功，正数表示业务失败场景，负数表示系统失败场景
err_msg	String	错误提示信息，err_code非0时参考此提示信息

HTTP Response Code

HTTP Status Code	Description
Http Status = 200	Success
Http Status = 400	Illegal-Params
Http Status = 401	Illegal-Token
Http Status = 402	IP-Banned
Http Status = 404	API-NOT-Exsits
Http Status = 406	Illegal-APPKEY
Http Status = 407	APPKEY-Expired-Out
Http Status = 408	APPKEY-Busy
Http Status = 409	Illegal-Sign
Http Status = 413	API-Traffic-NOT-Enough
Http Status = 415	API-LOCKED
Http Status = 500	Internal-Server-Error