OkayAPI API: App.SuperTable.Query

OkayAPI Docs

API Path: /api/App/SuperTable/Query

API Description: 「即将弃用，请改用App.SuperTable.FreeQuery」根据查询字段、查询条件、排序规则、分页查询数据。是最为灵活的查询，但只能单表查询，并符合安全规范。为保障数据安全，部分关键字会被转义，如select会被自动改为se1ect。

API Traffic

HTTP/HTTPS

Protocol

GET/POST

Method

UTF-8

Charset

JSON

Response

Parameter	Type	Required	Default	Note	Description
HTTP_APPKEY	String	Required		MIN: 32	Common Put Your APPKEY
model_name	String	Required			数据库表名
database	String	Optaion	super		自己的数据库配置标记，注意！这是数据库的配置标识，不是数据库的名称。默认使用super，不用传。如果需要配置多个数据库时，可与小白技术人员联系。重要事情说三遍，这是数据配置标识，不是数据库名称。使用此接口前，请先进入：数据库直连服务配置。
select	String	Optaion	*		SQL语句的SELECT部分，如：select=id,uuid
where	String	Optaion			SQL语句的WHERE部分，如：where=id > 1
order	String	Optaion	id DESC		SQL语句的ORDER部分，如：order=id DESC
page	Int	Optaion	1	MIN: 1	第几页
perpage	Int	Optaion	10	MIN: 1；MAX: 10000	分页数量
return_sql	Boolean	Optaion	false		是否需要返回当前查询的sql片段，默认不返回，调试时可开启

Submit Type:

Form Data

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

JSON RAW

KEY	Type	Description
err_code	Int	状态操作码，0成功；1开发类错误，查询失败(表单不存在或查询错误)；2应用层规则拦截，拦截后可以小白开放平台查看日记
err_msg	String	错误提示信息，err_code非0时参考此提示信息
total	Int	数据的总条目数量
list	Array	查询的结果列表数据
sql	Object	经过解析后的SQL语句片段，便于开发人进行校对（return_sql为true时才返回）
sql.select	String	解析后的查询字段
sql.where	String	解析后的查询条件
sql.order	String	解析后的排序规则