OkayAPI Docs | The No-Code CURD API Platform

YesApi 接口文档

接口路径(新)：http://api.okayapi.com/api/App/SuperTable/Create

接口路径(旧)：http://api.okayapi.com/?s=App.SuperTable.Create

接口描述：增在直连数据库表添加一条新数据。

API Params

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，不用传。如果需要配置多个数据库时，可与小白技术人员联系。重要事情说三遍，这是数据配置标识，不是数据库名称。使用此接口前，请先进入：数据库直连服务配置。
data	ArrayJSON Format	Optaion			创建时的初始化数据，需要JSON编码后传递。格式：data={"字段名1":"字段值1","字段名2":"字段值2"...}。数据中的uuid将优先于model_uuid参数。JSON Parser Online

API Usage Demo

请求（使用data的JSON格式传递，data和data_X二选一）：
{OKAYAPI_API_HOST}/?s=App.SuperTable.Create&model_name=article&data={"title":"123456"}&database=super&app_key={你的app_key}&sign={动态签名}

请求（使用data_X动态参数传递，data和data_X二选一）：
{OKAYAPI_API_HOST}/?s=App.SuperTable.Create&model_name=article&data_title=123456&database=super&app_key={你的app_key}&sign={动态签名}

返回：
{
    "ret": 200,
    "data": {
        "err_code": 0,
        "err_msg": "",
        "id": 4
    },
    "msg": ""
}

API Response

KEY	Type	Description
err_code	Int	状态操作码，0成功；1创建失败(不符合表字段要求，或表字段不存在)；
err_msg	String	错误提示信息，err_code非0时参考此提示信息
id	Int	新创建数据的自增ID

YesApi 接口文档

接口路径(新)：http://api.okayapi.com/api/App/SuperTable/CheckCreate

接口路径(旧)：http://api.okayapi.com/?s=App.SuperTable.CheckCreate

接口描述：增在直连数据库表添加一条【非重复】新数据。

API Params

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，不用传。如果需要配置多个数据库时，可与小白技术人员联系。重要事情说三遍，这是数据配置标识，不是数据库名称。使用此接口前，请先进入：数据库直连服务配置。
data	ArrayJSON Format	Optaion			创建时的初始化数据，需要JSON编码后传递。格式：data={"字段名1":"字段值1","字段名2":"字段值2"...}。数据中的uuid将优先于model_uuid参数。JSON Parser Online
check_field	ArraySeperated with ,	Required			待检测的字段。注意：data数据中必须包含此字段的数据，用作检测重复的依据。多个检测字段用英文逗号分割。例如：check_field=name,age，表示同时检测名字和年龄。请留意字段类型的相等性判断，如字符串类型的字段不能在data参数中传整型参数。
model_return_data	Boolean	Optaion	false		是否返回新创建或原来的数据，model_return_data=1 返回，model_return_data=0 不返回

API Usage Demo

请求（使用data的JSON格式传递，data和data_X二选一）：
{OKAYAPI_API_HOST}/?s=App.SuperTable.CheckCreate&model_name=article&data={"title":"abc","content":"something"}&check_field=title&database=super&app_key={你的app_key}&sign={动态签名}

请求（使用data_X动态参数传递，data和data_X二选一）：
{OKAYAPI_API_HOST}/?s=App.SuperTable.CheckCreate&model_name=article&data_title=abc&data_content=something&check_field=title&database=super&app_key={你的app_key}&sign={动态签名}

返回：
{
    "ret": 200,
    "data": {
        "err_code": 0,
        "err_msg": "",
        "id": 4
    },
    "msg": ""
}


如果数据已经存在，则返回：
{
    "ret": 200,
    "data": {
        "err_code": 3,
        "err_msg": "数据已存在，不再创建",
        "id": 11
    }
}

API Response

KEY	Type	Description
err_code	Int	状态操作码，0成功；1创建失败(不符合表字段要求，或表字段不存在)；3、数据已存在，不再创建
err_msg	String	错误提示信息，err_code非0时参考此提示信息
id	Int	新创建数据的自增ID/或原来数据的ID

YesApi 接口文档

接口路径(新)：http://api.okayapi.com/api/App/SuperTable/MultiCreate

接口路径(旧)：http://api.okayapi.com/?s=App.SuperTable.MultiCreate

接口描述：增批量导入多条新数据，导入完毕后会返回导入的概况

API Params

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，不用传。如果需要配置多个数据库时，可与小白技术人员联系。重要事情说三遍，这是数据配置标识，不是数据库名称。使用此接口前，请先进入：数据库直连服务配置。
datas	ArrayJSON Format	Required			批量导入的数据。特别注意！这是复数datas，即需要传递是的单个创建时的数组的数组。格式为JSON，即：datas=[单个创建时的数据1, 单个创建时的数据2, ...]。一次最多只允许导入1000条数据。数据中的uuid将优先于model_uuid参数。JSON Parser Online

API Usage Demo

请求：
{OKAYAPI_API_HOST}/?s=App.SuperTable.MultiCreate&model_name=article&datas=[{"title":"文章标题1"},{"title":"文章标题2"}]&database=super&app_key={你的app_key}&sign={动态签名}

返回：
{
    "ret": 200,
    "data": {
        "err_code": 0,
        "err_msg": "",
        "total": 2,
        "import_num": 2,
        "not_import_num": 0,
        "details": [
            {
                "id": 1,
                "new_id": 10,
                "msg": "导入成功"
            },
            {
                "id": 2,
                "new_id": 11,
                "msg": "导入成功"
            }
        ]
    },
    "msg": ""
}

API Response

KEY	Type	Description
err_code	Int	状态操作码，0导入成功；1导入失败(如表不存在)；
err_msg	String	错误提示信息，err_code非0时参考此提示信息
total	Int	本次导入的总数量
import_num	Int	成功导入的数量
not_import_num	Int	导入失败的数量
details	Array	导入过程中的操作纪录
details[].id	Int	导入的ID，从1开始
details[].new_id	Int	数据添加成功时的纪录ID，失败时为0
details[].msg	String	导入的结果

YesApi 接口文档

接口路径(新)：http://api.okayapi.com/api/App/SuperTable/MultiFastCreate

接口路径(旧)：http://api.okayapi.com/?s=App.SuperTable.MultiFastCreate

接口描述：增批量极速导入多条新数据，速度很快但无明细，此接口可用于批量导入数据，适用于数据初始化和还原。

API Params

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，不用传。如果需要配置多个数据库时，可与小白技术人员联系。重要事情说三遍，这是数据配置标识，不是数据库名称。使用此接口前，请先进入：数据库直连服务配置。
datas	ArrayJSON Format	Required			批量导入的数据。特别注意！这是复数datas，即需要传递是的单个创建时的数组的数组。格式为JSON，即：datas=[单个创建时的数据1, 单个创建时的数据2, ...]。一次最多只允许导入1000条数据。
is_ignore	Boolean	Optaion	true		是否启用IGNORE，1是0否，其中：若为是，则在创建时判断是否存在相同的数据，并且重复时忽略跳过，最终结果是部分或全部成功创建；若为若，则不管是否存均进行创建，如果有唯一索引或其他原因导致失败将会全部创建不成功。

API Usage Demo

API Response

KEY	Type	Description
err_code	Int	状态操作码，0导入成功；1导入失败(如表不存在)
err_msg	String	错误提示信息，err_code非0时参考此提示信息
total	Int	本次导入的总数量

YesApi 接口文档

接口路径(新)：http://api.okayapi.com/api/App/SuperTable/Update

接口路径(旧)：http://api.okayapi.com/?s=App.SuperTable.Update

接口描述：改根据ID，更新直连数据库表的数据，更新的字段需要先存在。

API Params

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，不用传。如果需要配置多个数据库时，可与小白技术人员联系。重要事情说三遍，这是数据配置标识，不是数据库名称。使用此接口前，请先进入：数据库直连服务配置。
id	Int	Required		MIN: 1	数据ID，例如：1，2，3，……
data	ArrayJSON Format	Optaion			待更新的数据，需要JSON编码后传递。格式：data={"字段名1":"字段值1","字段名2":"字段值2"...}。JSON Parser Online

API Usage Demo

请求（使用data的JSON格式传递，data和data_X二选一）：
{OKAYAPI_API_HOST}/?s=App.SuperTable.Update&model_name=article&id=5&data={"state":2}&database=super&app_key={你的app_key}&sign={动态签名}

请求（使用data_X动态参数传递，data和data_X二选一）：
{OKAYAPI_API_HOST}/?s=App.SuperTable.Update&model_name=article&id=5&data_state=2&database=super&app_key={你的app_key}&sign={动态签名}

返回：
{
    "ret": 200,
    "data": {
        "err_code": 0,
        "err_msg": ""
    },
    "msg": ""
}

API Response

KEY	Type	Description
err_code	Int	状态操作码，0成功；1开发类错误，更新失败(不符合表字段要求，或表字段不存在)；3更新失败(数据已删除或不存在)
err_msg	String	错误提示信息，err_code非0时参考此提示信息

YesApi 接口文档

接口路径(新)：http://api.okayapi.com/api/App/SuperTable/MultiUpdate

接口路径(旧)：http://api.okayapi.com/?s=App.SuperTable.MultiUpdate

接口描述：改根据多个ID，批量更新自定义数据表单中的数据，更新的字段需要先存在。对系统保留表字段（id, uuid, add_time, update_time, ext_data）的更新将会被忽略。

API Params

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，不用传。如果需要配置多个数据库时，可与小白技术人员联系。重要事情说三遍，这是数据配置标识，不是数据库名称。使用此接口前，请先进入：数据库直连服务配置。
ids	ids	Required		MAX: 500	多个ID，使用英文逗号分割，例如：ids=1,2,3
data	ArrayJSON Format	Optaion			待更新的数据，需要JSON编码后传递。格式：data={"字段名1":"字段值1","字段名2":"字段值2"...}。JSON Parser Online

API Usage Demo

请求：
{OKAYAPI_API_HOST}/?s=App.SuperTable.MultiUpdate&model_name=article&ids=36,37&database=super&app_key={你的app_key}&sign={动态签名}

返回：
{
    "ret": 200,
    "data": {
        "err_code": 0,
        "err_msg": "",
        "update_total": 2
    },
    "msg": "小白开放接口：App.SuperTable.MultiUpdate"
}

API Response

KEY	Type	Description
err_code	Int	状态操作码，0成功；1开发类错误，更新失败(不符合表字段要求，或表字段不存在)；2应用层规则拦截，拦截后可以小白开放平台查看日记；3更新失败(数据已删除或不存在)
err_msg	String	错误提示信息，err_code非0时参考此提示信息
update_total	Int	成功更新的数量

YesApi 接口文档

接口路径(新)：http://api.okayapi.com/api/App/SuperTable/FreeUpdate

接口路径(旧)：http://api.okayapi.com/?s=App.SuperTable.FreeUpdate

接口描述：改功能更强大的更新操作，可以根据自定义的多个条件（AND或者OR），更新指定的数据。为防止误更新全表数据，必须至少有一个有效条件。

API Params

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，不用传。如果需要配置多个数据库时，可与小白技术人员联系。重要事情说三遍，这是数据配置标识，不是数据库名称。使用此接口前，请先进入：数据库直连服务配置。
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优先）
data	ArrayJSON Format	Optaion			待更新的数据，需要JSON编码后传递。格式：data={"字段名1":"字段值1","字段名2":"字段值2"...}。JSON Parser Online

API Usage Demo

请求（使用data的JSON格式传递，data和data_X二选一）：
{OKAYAPI_API_HOST}/?s=App.SuperTable.FreeUpdate&model_name=article&where=[["title","=","123456"]]&data={"title":"654321"}&database=super&app_key={你的app_key}&sign={动态签名}

请求（使用data_X动态参数传递，data和data_X二选一）：
{OKAYAPI_API_HOST}/?s=App.SuperTable.FreeUpdate&model_name=article&where_title=123456&data_title=654321&database=super&app_key={你的app_key}&sign={动态签名}

返回：
{
    "ret": 200,
    "data": {
        "err_code": 0,
        "err_msg": "",
        "update_rows": 1
    },
    "msg": ""
}

API Response

KEY	Type	Description
err_code	Int	状态操作码，0成功；1开发类错误，更新失败(不符合表字段要求，或表字段不存在)；3无数据更新
err_msg	String	错误提示信息，err_code非0时参考此提示信息
update_rows	Int	更新的行数，0表示无任何更新

YesApi 接口文档

接口路径(新)：http://api.okayapi.com/api/App/SuperTable/Get

接口路径(旧)：http://api.okayapi.com/?s=App.SuperTable.Get

接口描述：查根据ID，获取直连数据库表中的数据

API Params

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，不用传。如果需要配置多个数据库时，可与小白技术人员联系。重要事情说三遍，这是数据配置标识，不是数据库名称。使用此接口前，请先进入：数据库直连服务配置。
id	Int	Required		MIN: 1	数据ID，例如：1，2，3，……

API Usage Demo

请求：
{OKAYAPI_API_HOST}/?s=App.SuperTable.Get&model_name=article&id=1&database=super&app_key={你的app_key}&sign={动态签名}

返回：
{
    "ret": 200,
    "data": {
        "err_code": 0,
        "err_msg": "",
        "data": {
            "id": 1,
            "uuid": "",
            "add_time": "2017-11-23 23:35:13",
            "update_time": "2018-06-27 22:27:18",
            "ext_data": null,
            "title": "PHP程序员历险记",
            "content": "PHP<a>test</a>（外文名:PHP: Hypertext Preprocessor，中文名：“超文本预处理器”）是一种通用开源脚本语言。PHP<a>test</a>（外文名:PHP: Hypertext Preprocessor，中文名：“超文本预处理器”）是一种通用开源脚本语言。PHP<a>test</a>（外文名:PHP: Hypertext Preprocessor，中文名：“超文本预处理器”）是一种通用开源脚本语言。",
            "post_time": "1970-01-01 00:00:00",
            "view_times": "5",
            "state": "1"
        }
    },
    "msg": ""
}

API Response

KEY	Type	Description
err_code	Int	状态操作码，0成功；1开发类错误，获取失败(符合表字段要求，或表字段不存在)；3获取失败(数据已删除或不存在)
err_msg	String	错误提示信息，err_code非0时参考此提示信息
data	Object	获取的数据，并返回全部字段的数据

YesApi 接口文档

接口路径(新)：http://api.okayapi.com/api/App/SuperTable/MultiGet

接口路径(旧)：http://api.okayapi.com/?s=App.SuperTable.MultiGet

接口描述：查根据批量ID，批量获取自定义数据表单中的数据

API Params

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，不用传。如果需要配置多个数据库时，可与小白技术人员联系。重要事情说三遍，这是数据配置标识，不是数据库名称。使用此接口前，请先进入：数据库直连服务配置。
ids	ids	Required		MAX: 500	多个ID，使用英文逗号分割，例如：ids=1,2,3

API Usage Demo

请求：
{OKAYAPI_API_HOST}/?s=App.SuperTable.MultiGet&model_name=article&ids=36,37&database=super&app_key={你的app_key}&sign={动态签名}

返回：
{
    "ret": 200,
    "data": {
        "err_code": 0,
        "err_msg": "",
        "list": [
        {
            "id": 36,
            "uuid": "",
            "add_time": "2019-04-06 17:25:13",
            "update_time": "2019-05-01 20:49:53",
            "ext_data": null,
            "title": "PHP程序员历险记223",
            "content": "<p><em>PHP</em>（外文名:<em>PHP</em>: Hypertext Preprocessor，中文名：“超文本预处理器”）</p>",
            "post_time": "2020-07-29 06:30:00",
            "view_times": "0",
            "state": "0",
            "test_time": "2019-04-06 17:25:13",
            "zhaiyao": ""
        },
        {
            "id": 37,
            "uuid": "",
            "add_time": "2019-06-07 10:00:23",
            "update_time": null,
            "ext_data": null,
            "title": "来吧~",
            "content": null,
            "post_time": "1970-01-01 00:00:00",
            "view_times": "0",
            "state": "0",
            "test_time": "2019-06-07 10:00:23",
            "zhaiyao": "来吧~"
        }
        ]
    },
    "msg": "小白开放接口：App.SuperTable.MultiGet"
}

API Response

KEY	Type	Description
err_code	Int	状态操作码，0成功；1开发类错误，获取失败(符合表字段要求，或表字段不存在)；2应用层规则拦截，拦截后可以小白开放平台查看日记
err_msg	String	错误提示信息，err_code非0时参考此提示信息
list	Array	获取的数据，没有任何数据时为空数组，如果未找到ID对应的数据则没有任何元素

YesApi 接口文档

接口路径(新)：http://api.okayapi.com/api/App/SuperTable/Delete

接口路径(旧)：http://api.okayapi.com/?s=App.SuperTable.Delete

接口描述：删根据ID，删除直连数据库表中的数据

API Params

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，不用传。如果需要配置多个数据库时，可与小白技术人员联系。重要事情说三遍，这是数据配置标识，不是数据库名称。使用此接口前，请先进入：数据库直连服务配置。
id	Int	Required		MIN: 1	数据ID，例如：1，2，3，……

API Usage Demo

请求：
{OKAYAPI_API_HOST}/?s=App.SuperTable.Delete&model_name=article&id=4&database=super&app_key={你的app_key}&sign={动态签名}

返回：
{
    "ret": 200,
    "data": {
        "err_code": 0,
        "err_msg": ""
    },
    "msg": ""
}

API Response

KEY	Type	Description
err_code	Int	状态操作码，0成功删除；1开发类错误，删除失败(表单不存在)；
err_msg	String	错误提示信息，err_code非0时参考此提示信息

YesApi 接口文档

接口路径(新)：http://api.okayapi.com/api/App/SuperTable/MultiDelete

接口路径(旧)：http://api.okayapi.com/?s=App.SuperTable.MultiDelete

接口描述：删根据多个ID，批量删除自定义数据表单中的数据

API Params

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，不用传。如果需要配置多个数据库时，可与小白技术人员联系。重要事情说三遍，这是数据配置标识，不是数据库名称。使用此接口前，请先进入：数据库直连服务配置。
ids	ids	Required		MAX: 500	多个ID，使用英文逗号分割，例如：ids=1,2,3

API Usage Demo

请求：
{OKAYAPI_API_HOST}/?s=App.SuperTable.MultiDelete&model_name=article&ids=36,37&database=super&app_key={你的app_key}&sign={动态签名}

返回：
{
    "ret": 200,
    "data": {
        "err_code": 0,
        "err_msg": ""
    },
    "msg": "小白开放接口：App.SuperTable.MultiDelete"
}

API Response

KEY	Type	Description
err_code	Int	状态操作码，0成功删除；1开发类错误，删除失败(表单不存在)；2应用层规则拦截，拦截后可以小白开放平台查看日记
err_msg	String	错误提示信息，err_code非0时参考此提示信息

YesApi 接口文档

接口路径(新)：http://api.okayapi.com/api/App/SuperTable/Count

接口路径(旧)：http://api.okayapi.com/?s=App.SuperTable.Count

接口描述：查获取直连数据库表中数据的总条目数量

API Params

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，不用传。如果需要配置多个数据库时，可与小白技术人员联系。重要事情说三遍，这是数据配置标识，不是数据库名称。使用此接口前，请先进入：数据库直连服务配置。

API Usage Demo

请求：
{OKAYAPI_API_HOST}/?s=App.SuperTable.Count&model_name=article&database=super&app_key={你的app_key}&sign={动态签名}

返回：
{
    "ret": 200,
    "data": {
        "err_code": 0,
        "err_msg": "",
        "total": 2
    },
    "msg": ""
}

API Response

KEY	Type	Description
err_code	Int	状态操作码，0成功；1开发类错误，获取失败(表单不存在)；
err_msg	String	错误提示信息，err_code非0时参考此提示信息
total	Int	数据的总条目数量

YesApi 接口文档

接口路径(新)：http://api.okayapi.com/api/App/SuperTable/FreeAF

接口路径(旧)：http://api.okayapi.com/?s=App.SuperTable.FreeAF

接口描述：查可以根据自定义的多个条件（AND或者OR），进行GROUP聚合操作运算

API Params

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，不用传。如果需要配置多个数据库时，可与小白技术人员联系。重要事情说三遍，这是数据配置标识，不是数据库名称。使用此接口前，请先进入：数据库直连服务配置。
op_fun	Enum	Required	SUM	Range: SUM/COUNT/MIN/MAX/AVG	聚合函数操作
op_field	String	Required			进行聚合的字段名称，例如：SUM(price)中的price价格字段
group_filed	ArraySeperated with ,	Required			分组字段，多个分组字段使用英文逗号分割，相当于：GROUP BY {group_filed}
sort_type	Int	Optaion	1		排序的类型：1是聚合结果升序（默认）；2是聚合结果逆序；3是分组字段升序；4是分组字段降序
page	Int	Optaion	1	MIN: 1	第几页
top_num	Int	Optaion	10	MIN: 1；MAX: 500	返回结果的数量，前面多少条
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优先）
select_more	ArraySeperated with ,	Optaion			需要选择的更多字段，默认已经固定返回{groupField}参数字段和聚合结果这两个字段。多个字段用英文逗号分割，如：select_more=id,uuid。如果需要再进行聚合运算，可以类似这样：select_more=id@MIN,uuid。即：字段@聚合运算。聚合运算主要有：SUM/COUNT/MIN/MAX/AVG。id@MIN 对应返回的字段名是 id_AT_MIN，name@COUNT 对应返回字段是 name_AT_COUNT，依次类似。即对应字段格式是：字段_AT_聚合运算。

API Usage Demo

请求（where和where_X二选一）：
{OKAYAPI_API_HOST}/?s=App.SuperTable.FreeAF&model_name=article&op_fun=SUM&op_field=view_times&group_filed=title&where=[["id",">",0]]&database=super&app_key={你的app_key}&sign={动态签名}

请求（where和where_X二选一）：
{OKAYAPI_API_HOST}/?s=App.SuperTable.FreeAF&model_name=article&op_fun=SUM&op_field=view_times&group_filed=title&where_id=GT-0&database=super&app_key={你的app_key}&sign={动态签名}

上面查询相当于，SELECT title, SUM(view_times) AS total_num FROM article WHERE id > 0 GROUP BY title ORDER BY total_num ASC LIMIT 0,10

返回：
{
    "ret": 200,
    "data": {
        "err_code": 0,
        "err_msg": "",
        "items": [
            {
                "title": "这是一篇文章标题",
                "total_num": "100"
            },
            {
                "title": "这又是另一篇文章标题",
                "total_num": "200"
            },
            // 略……
        ]
    },
    "msg": ""
}


示例2-附加更多选择字段select_more：
请求：
{OKAYAPI_API_HOST}/?s=App.SuperTable.FreeAF&model_name=article&op_fun=SUM&op_field=view_times&group_filed=title&where=[["id",">",0]]&select_more=post_time,state@COUNT&database=super&app_key={你的app_key}&sign={动态签名}

上面查询相当于：SELECT post_time, COUNT(state) AS state_AT_COUNT, title, SUM(view_times) AS total_num FROM pa_article_tbl WHERE AND (id > 0) GROUP BY title ORDER BY total_num ASC LIMIT 0,10

返回：
{
    "ret": 200,
    "data": {
        "err_code": 0,
        "err_msg": "",
        "items": [
            {
                "post_time": "1970-01-01 00:00:00",  // 对应参数：select_more=post_time
                "state_AT_COUNT": "1", // 对应参数：select_more=state@COUNT
                "title": "这是一篇文章标题",
                "total_num": "100"
            },
            {
                "post_time": "1970-01-01 00:00:00",
                "state_AT_COUNT": "1",
                "title": "这又是另一篇文章标题",
                "total_num": "200"
            },
            // 略……
        ]
    },
    "msg": ""
}

API Response

KEY	Type	Description
err_code	Int	状态操作码，0成功；1开发类错误，获取失败(表单不存在)；
err_msg	String	错误提示信息，err_code非0时参考此提示信息
items	Array	聚合运算的结果
items[].XXX	String	分组字段，由客户端传入的字段而定
items[].total_num	String	聚合运算的结果（固定为：total_num）

YesApi 接口文档

接口路径(新)：http://api.okayapi.com/api/App/SuperTable/FreeCount

接口路径(旧)：http://api.okayapi.com/?s=App.SuperTable.FreeCount

接口描述：查可以根据自定义的多个条件（AND或者OR），获取总数

API Params

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，不用传。如果需要配置多个数据库时，可与小白技术人员联系。重要事情说三遍，这是数据配置标识，不是数据库名称。使用此接口前，请先进入：数据库直连服务配置。
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优先）
count_by	String	Optaion			需要非重复计数的字段，默认统计全部行数，若传字段则按些字段的非重复数据进行统计，相当于：COUNT(DISTINCT {count_by})。

API Usage Demo

{
    "ret": 200,
    "data": {
        "err_code": 0,
        "err_msg": "",
        "total": 3
    },
    "msg": ""
}

API Response

KEY	Type	Description
err_code	Int	状态操作码，0成功；1开发类错误，获取失败(表单不存在)；
err_msg	String	错误提示信息，err_code非0时参考此提示信息
total	Int	数据的总条目数量

YesApi 接口文档

接口路径(新)：http://api.okayapi.com/api/App/SuperTable/FreeQuery

接口路径(旧)：http://api.okayapi.com/?s=App.SuperTable.FreeQuery

接口描述：查分页获取列表数据或全部数据，支持字段选择、排序、条件查询，功能强大，是最为常用的数据接口。

API Params

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	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 Usage Demo

请求（where和where_X二选一）：
{OKAYAPI_API_HOST}/?s=App.SuperTable.FreeQuery&model_name=article&select=id,title,view_times&where=[["id", ">", "36"]]&order=["view_times DESC"]

请求（where和where_X二选一）：
{OKAYAPI_API_HOST}/?s=App.SuperTable.FreeQuery&model_name=article&select=id,title,view_times&where_id=GT-36&order=["view_times DESC"]

返回：
{
    "ret": 200,
    "data": {
        "err_code": 0,
        "err_msg": "",
        "total": 2,
        "list": [
        {
            "id": 37,
            "title": "小白开放平台更新公告",
            "view_times": 300
        },
        {
            "id": 38,
            "title": "新接口上线通知",
            "view_times": 260
        }
        ],
            "page": 1,
            "perpage": 10
    },
    "msg": "小白开放接口：App.SuperTable.FreeQuery"
}

API Response

KEY	Type	Description
err_code	Int	状态操作码，0成功；1开发类错误，查询失败(表单不存在或查询错误)；
err_msg	String	错误提示信息，err_code非0时参考此提示信息
total	Int	数据的总条目数量
list	Array	查询的结果列表数据

YesApi 接口文档

接口路径(新)：http://api.okayapi.com/api/App/SuperTable/FreeExport

接口路径(旧)：http://api.okayapi.com/?s=App.SuperTable.FreeExport

接口描述：查可以根据自定义的多个条件（AND或者OR），进行数据导出。成功导出时，此接口会直接生成可供下载的txt或csv文件。个人免费版最多导出5000条，VIP版最多可导出1万条，SVIP版最多可导出2万条。

API Params

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	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格式。具体格式为：[第一组排序，第二组排序，……]，如：order = ["id DESC", "add_time ASC"]，表示 id DESC, add_time ASC。特别地，RAND表示随机排序，请慎用。
file_type	Enum	Optaion	txt	Range: csv/txt/excel	下载文件的类型，txt或csv或excel。
sep	String	Optaion	,		数据分割符，@TAB则表示水平制表符。
encoding	Enum	Optaion	UTF-8	Range: UTF-8/GB2312	导出的CSV/TXT/Excel文件编码，如果需要ANSI格式可使用encoding=GB2312。
page	Int	Optaion	1	MIN: 1	第几页
perpage	Int	Optaion	1000	MIN: 0；MAX: 150000	分页数量

API Usage Demo

API Response

KEY	Type	Description
err_code	Int	状态操作码，0成功；1开发类错误，查询失败(表单不存在或查询错误)；2应用层规则拦截，拦截后可以小白开放平台查看日记
err_msg	String	错误提示信息，err_code非0时参考此提示信息

YesApi 接口文档

接口路径(新)：http://api.okayapi.com/api/App/SuperTable/ChangeNumber

接口路径(旧)：http://api.okayapi.com/?s=App.SuperTable.ChangeNumber

接口描述：改根据ID，修改某个字段的数值，可增加或可减少。通过在服务端进行数值的叠加，尽量保持并发下的数据一致性。

API Params

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，不用传。如果需要配置多个数据库时，可与小白技术人员联系。重要事情说三遍，这是数据配置标识，不是数据库名称。使用此接口前，请先进入：数据库直连服务配置。
id	Int	Required		MIN: 1	数据ID
change_field	String	Required			待修改数值的字段名
change_value	String	Required			待叠加的数值，正数表示相加，负数表示相减，需要传递有效数值

API Usage Demo

请求：
{OKAYAPI_API_HOST}/?s=App.SuperTable.ChangeNumber&model_name=article&id=8&change_field=view_times&change_value=1&database=super&app_key={你的app_key}&sign={动态签名}

返回：
{
    "ret": 200,
    "data": {
        "err_code": 0,
        "err_msg": "",
        "change_value": "1",
        "after_value": "5"
    },
    "msg": ""
}

API Response

KEY	Type	Description
err_code	Int	状态操作码，0成功；1开发类错误，修改失败(表单不存在或字段类型不是数值类型)；3数据不存在或已被删除
err_msg	String	错误提示信息，err_code非0时参考此提示信息
change_value	String	回传客户端本次待更改的数值
after_value	String	本次更新后，最新的字段值

YesApi 接口文档

接口路径(新)：http://api.okayapi.com/api/App/SuperTable/FreeChangeNumber

接口路径(旧)：http://api.okayapi.com/?s=App.SuperTable.FreeChangeNumber

接口描述：改可以根据自定义的多个条件（AND或者OR），修改某个字段的数值，可增加或可减少。通过在服务端进行数值的叠加，尽量保持并发下的数据一致性。注意，此接口可更新多条数据。

API Params

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，不用传。如果需要配置多个数据库时，可与小白技术人员联系。重要事情说三遍，这是数据配置标识，不是数据库名称。使用此接口前，请先进入：数据库直连服务配置。
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优先）
change_field	ArraySeperated with ,	Required			待修改数值的字段名，多个字段名用英文逗号分割。change_value和change_field分割后的数量应当相同。
change_value	ArraySeperated with ,	Required			待叠加的数值，正数表示相加，负数表示相减，需要传递有效数值。多个数值用英文逗号分割。change_value和change_field分割后的数量应当相同。
try_add_data	ArrayJSON Format	Optaion			当无更新时尝试创建的数据，仅当无更新且有传此参数时才会进行数据创建。此参数可用于初始化等操作。此参数只用于初始化，不会再进行change_value的修改。

API Usage Demo

请求：
{OKAYAPI_API_HOST}/?s=App.SuperTable.FreeChangeNumber&model_name=article&where=[["id","=",8]]&change_field=view_times&change_value=1&database=super&app_key={你的app_key}&sign={动态签名}

返回：
{
    "ret": 200,
    "data": {
        "err_code": 0,
        "err_msg": "",
        "change_value": "1",
        "update_rows": 1
    },
    "msg": ""
}

如果想希望在更新失败时进行数据创建，可以使用try_add_data参数，从而减少多一次接口请求，以完成数据初始化操作。登录，请求：
{OKAYAPI_API_HOST}/?s=App.SuperTable.FreeChangeNumber&model_name=article&logic=and&where=[["id", "=", "404"]]&change_field=view_times&change_value=2&try_add_data={"view_times":1}&database=super&app_key={你的app_key}&sign={动态签名}

返回：
{
    "ret": 200,
    "data": {
        "err_code": 0,
        "err_msg": "",
        "change_value": "1",
        "update_rows": 1
    },
    "msg": "V1.3.16 小白开放接口 App.SuperTable.FreeChangeNumber"
}
这里接口结果返回的change_value对应本次try_add_data里面的初始化值。

API Response

KEY	Type	Description
err_code	Int	状态操作码，0成功；1开发类错误，修改失败(表单不存在或字段类型不是数值类型)；
err_msg	String	错误提示信息，err_code非0时参考此提示信息
change_value	String	回传客户端本次待更改的数值
update_rows	String	本次更新的条数，没有更新时为0

YesApi 接口文档

接口路径(新)：http://api.okayapi.com/api/App/SuperTable/FreeFindOne

接口路径(旧)：http://api.okayapi.com/?s=App.SuperTable.FreeFindOne

接口描述：查可以根据自定义的多个条件（AND或者OR），查找获取一条数据

API Params

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，不用传。如果需要配置多个数据库时，可与小白技术人员联系。重要事情说三遍，这是数据配置标识，不是数据库名称。使用此接口前，请先进入：数据库直连服务配置。
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优先）
fields	ArraySeperated with ,	Optaion			需要返回的字段名，多个字段用英文逗号分割，示例：fields=id,uuid,add_time

API Usage Demo

请求（where和where_X二选一）：
{OKAYAPI_API_HOST}/?s=App.SuperTable.FreeFindOne&model_name=article&where=[["title","=","123456"]]&database=super&app_key={你的app_key}&sign={动态签名}

请求（where和where_X二选一）：
{OKAYAPI_API_HOST}/?s=App.SuperTable.FreeFindOne&model_name=article&where_title=123456&database=super&app_key={你的app_key}&sign={动态签名}

返回：
{
    "ret": 200,
    "data": {
        "err_code": 0,
        "err_msg": "",
        "data": {
            "id": "5",
            "uuid": "",
            "add_time": "2018-06-27 22:13:28",
            "update_time": null,
            "ext_data": null,
            "title": "123456",
            "content": null,
            "post_time": "1970-01-01 00:00:00",
            "view_times": "0"
        }
    },
    "msg": "",
    "info": [
        "当前请求接口：App.SuperTable.FreeFindOne",
        "小白入门教程：a.okayapi.com/Aa5PH4"
    ]
}

API Response

KEY	Type	Description
err_code	Int	状态操作码，0成功；1开发类错误，获取失败(表单不存在)；3查无数据
err_msg	String	错误提示信息，err_code非0时参考此提示信息
data	Object	获取的数据，可以指定返回字段

YesApi 接口文档

接口路径(新)：http://api.okayapi.com/api/App/SuperTable/GetDataAfterChangeNum

接口路径(旧)：http://api.okayapi.com/?s=App.SuperTable.GetDataAfterChangeNum

接口描述：查改可以根据自定义的多个条件（AND或者OR），查找获取一条数据，然后对指定的字段进行加减操作，最后返回最新的数据。

API Params

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，不用传。如果需要配置多个数据库时，可与小白技术人员联系。重要事情说三遍，这是数据配置标识，不是数据库名称。使用此接口前，请先进入：数据库直连服务配置。
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优先）
fields	ArraySeperated with ,	Optaion			需要返回的字段名，多个字段用英文逗号分割，示例：fields=id,uuid,add_time
order	String	Optaion	id ASC		排序规则，格式：字段名+空格+ASC\|DESC，特别地，RAND表示随机排序。
change_field	String	Required			待加减的字段名
change_value	String	Required			待加减的数字，正数表示相加，负数表示相减，需要传递有效数值。例如：change_value=1

API Usage Demo

请求：
{OKAYAPI_API_HOST}/?s=App.SuperTable.GetDataAfterChangeNum&model_name=article&logic=and&where=[["id", ">", "1"]]&fields=add_time&order=id asc&change_field=view_times&change_value=1&database=super&app_key={你的app_key}&sign={动态签名}

返回：
{
    "ret": 200,
    "data": {
        "err_code": 0,
        "err_msg": "",
        "data": {
            "view_times": 204,
            "add_time": "2019-04-06 17:25:13"
        },
        "total": 23
    },
    "msg": "V2.1.0 果创云开放接口 App.SuperTable.GetDataAfterChangeNum"
}

以上会把article文章表单的某一篇文章的阅读数view_times加1，然后返回最新的数据。

API Response

KEY	Type	Description
err_code	Int	状态操作码，0成功；1开发类错误，获取失败(表单不存在)；3查无数据
err_msg	String	错误提示信息，err_code非0时参考此提示信息
data	Object	返回加减后的数据，没有数据时返回null；修改成功时固定会返回修改的字段更新后的最新值

YesApi 接口文档

接口路径(新)：http://api.okayapi.com/api/App/SuperTable/FreeRandOne

接口路径(旧)：http://api.okayapi.com/?s=App.SuperTable.FreeRandOne

接口描述：查可以根据自定义的多个条件（AND或者OR），随机获取一条数据。获取数据后不会修改或删除数据。

API Params

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，不用传。如果需要配置多个数据库时，可与小白技术人员联系。重要事情说三遍，这是数据配置标识，不是数据库名称。使用此接口前，请先进入：数据库直连服务配置。
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",">",0]]		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优先）
fields	ArraySeperated with ,	Optaion			需要返回的字段名，多个字段用英文逗号分割，示例：fields=id,uuid,add_time

API Usage Demo

API Response

KEY	Type	Description
err_code	Int	状态操作码，0成功；1开发类错误，获取失败(表单不存在)；3查无数据
err_msg	String	错误提示信息，err_code非0时参考此提示信息
data	Object	获取的数据，可以指定返回字段

YesApi 接口文档

接口路径(新)：http://api.okayapi.com/api/App/SuperTable/FreePopOne

接口路径(旧)：http://api.okayapi.com/?s=App.SuperTable.FreePopOne

接口描述：查改可以根据自定义的多个条件（AND或者OR），查找获取一条数据，并且在获取数据后更改字段，从而实现非重复数据的获取

API Params

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，不用传。如果需要配置多个数据库时，可与小白技术人员联系。重要事情说三遍，这是数据配置标识，不是数据库名称。使用此接口前，请先进入：数据库直连服务配置。
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优先）
fields	ArraySeperated with ,	Optaion			需要返回的字段名，多个字段用英文逗号分割，示例：fields=id,uuid,add_time
data	ArrayJSON Format	Optaion			待更新的数据（注意！获取到数据后将会进行此更新），需要JSON编码后传递。格式：data={"字段名1":"字段值1","字段名2":"字段值2"...}。JSON Parser Online
order_type	Int	Optaion	1		排序类型，默认order_type=1，表示按默认的顺序，即ID升序；order_type=2时表示ID降序；order_type=3表示随机排序，将能更好地实现高并发下的非重复获取（为保证接口质量，随机排序取的数据量超过10W，请联系小白客服进行定制化！）；order_type=4表示更新时间update_time升序；order_type=5表示更新时间update_time降序；

API Usage Demo

请求（使用data的JSON格式传递，data和data_X二选一）：
{OKAYAPI_API_HOST}/?s=App.SuperTable.FreePopOne&model_name=article&where=[["state", "=", 0]]&data={"state":1}&database=super&app_key={你的app_key}&sign={动态签名}

请求（使用data_X动态参数传递，data和data_X二选一）（where和where_X二选一）：
{OKAYAPI_API_HOST}/?s=App.SuperTable.FreePopOne&model_name=article&where_state=0&data_state=1&database=super&app_key={你的app_key}&sign={动态签名}

返回：
{
    "ret": 200,
    "data": {
        "err_code": 0,
        "err_msg": "",
        "data": {
            "id": "2",
            "uuid": "",
            "add_time": "2018-04-09 23:42:25",
            "update_time": ,
            "ext_data": ,
            "title": "xx",
            "content": "yy",
            "post_time": "1970-01-01 00:00:00",
            "view_times": "2",
            "state": "0"
        }
    },
    "msg": ""
}

API Response

KEY	Type	Description
err_code	Int	状态操作码，0成功；1开发类错误，获取失败(表单不存在)；3查无数据
err_msg	String	错误提示信息，err_code非0时参考此提示信息
data	Object	获取的数据，可以指定返回字段

YesApi 接口文档

接口路径(新)：http://api.okayapi.com/api/App/SuperTable/DropOneByOne

接口路径(旧)：http://api.okayapi.com/?s=App.SuperTable.DropOneByOne

接口描述：查删根据主键id从小到大依次获取数据，取完就立即删除，从而实现非重复数据的获取。

API Params

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，不用传。如果需要配置多个数据库时，可与小白技术人员联系。重要事情说三遍，这是数据配置标识，不是数据库名称。使用此接口前，请先进入：数据库直连服务配置。

API Usage Demo

请求：
{OKAYAPI_API_HOST}/?s=App.SuperTable.DropOneByOne&model_name=article&database=super&app_key={你的app_key}&sign={动态签名}

返回：
{
    "ret": 200,
    "data": {
        "err_code": 0,
        "err_msg": "",
        "data": {
            "id": "1",
            "uuid": "",
            "title": "小接口做大事情！",
            "add_time": "2019-01-26 18:04:30"
        }
    },
    "msg": ""
}

API Response

KEY	Type	Description
err_code	Int	状态操作码，0成功；1开发类错误，获取失败(表单不存在)；3查无数据；4并发太大，请稍候重试！
err_msg	String	错误提示信息，err_code非0时参考此提示信息
data	Object	获取到的非重复数据，即整条纪录数据。

YesApi 接口文档

接口路径(新)：http://api.okayapi.com/api/App/SuperTable/FreeMin

接口路径(旧)：http://api.okayapi.com/?s=App.SuperTable.FreeMin

接口描述：查可以根据自定义的多个条件（AND或者OR），获取某个字段的最小值

API Params

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，不用传。如果需要配置多个数据库时，可与小白技术人员联系。重要事情说三遍，这是数据配置标识，不是数据库名称。使用此接口前，请先进入：数据库直连服务配置。
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优先）
field	String	Required			取哪个字段的最小值，如：field=id

API Usage Demo

请求（where和where_X二选一）：
{OKAYAPI_API_HOST}/?s=App.SuperTable.FreeMin&model_name=article&where=[["id", "<", 3]]&field=view_times&database=super&app_key={你的app_key}&sign={动态签名}

请求（where和where_X二选一）：
{OKAYAPI_API_HOST}/?s=App.SuperTable.FreeMin&model_name=article&where_id=LT-3&field=view_times&database=super&app_key={你的app_key}&sign={动态签名}

返回：
{
    "ret": 200,
    "data": {
        "err_code": 0,
        "err_msg": "",
        "min": "2"
    },
    "msg": ""
}

API Response

KEY	Type	Description
err_code	Int	状态操作码，0成功；1开发类错误，获取失败(表单不存在)；3查无数据
err_msg	String	错误提示信息，err_code非0时参考此提示信息
min	String	获取的最小值

YesApi 接口文档

接口路径(新)：http://api.okayapi.com/api/App/SuperTable/FreeMax

接口路径(旧)：http://api.okayapi.com/?s=App.SuperTable.FreeMax

接口描述：查可以根据自定义的多个条件（AND或者OR），获取某个字段的最大值

API Params

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，不用传。如果需要配置多个数据库时，可与小白技术人员联系。重要事情说三遍，这是数据配置标识，不是数据库名称。使用此接口前，请先进入：数据库直连服务配置。
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优先）
field	String	Required			取哪个字段的最大值，如：field=id

API Usage Demo

请求：
{OKAYAPI_API_HOST}/?s=App.SuperTable.FreeMax&model_name=article&where=[["id", "<", 3]]&field=view_times&database=super&app_key={你的app_key}&sign={动态签名}

返回：
{
    "ret": 200,
    "data": {
        "err_code": 0,
        "err_msg": "",
        "max": "5"
    },
    "msg": ""
}

API Response

KEY	Type	Description
err_code	Int	状态操作码，0成功；1开发类错误，获取失败(表单不存在)；3查无数据
err_msg	String	错误提示信息，err_code非0时参考此提示信息
min	String	获取的最大值

YesApi 接口文档

接口路径(新)：http://api.okayapi.com/api/App/SuperTable/FreeSum

接口路径(旧)：http://api.okayapi.com/?s=App.SuperTable.FreeSum

接口描述：查可以根据自定义的多个条件（AND或者OR），计算某个字段的总和

API Params

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，不用传。如果需要配置多个数据库时，可与小白技术人员联系。重要事情说三遍，这是数据配置标识，不是数据库名称。使用此接口前，请先进入：数据库直连服务配置。
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优先）
field	String	Required			取哪个字段的总和，如：field=money

API Usage Demo

请求（where和where_X二选一）：
{OKAYAPI_API_HOST}/?s=App.SuperTable.FreeSum&model_name=article&logic=or&where=[["id","=",1],["id","=",5]]&field=view_times&database=super&app_key={你的app_key}&sign={动态签名}

请求（where和where_X二选一）：
{OKAYAPI_API_HOST}/?s=App.SuperTable.FreeSum&model_name=article&logic=or&where_id=1||5&field=view_times&database=super&app_key={你的app_key}&sign={动态签名}

返回：
{
    "ret": 200,
    "data": {
        "err_code": 0,
        "err_msg": "",
        "sum": "5"
    },
    "msg": ""
}

API Response

KEY	Type	Description
err_code	Int	状态操作码，0成功；1开发类错误，获取失败(表单不存在)；3查无数据
err_msg	String	错误提示信息，err_code非0时参考此提示信息
sum	String	总和

YesApi 接口文档

接口路径(新)：http://api.okayapi.com/api/App/SuperTable/FreeDelete

接口路径(旧)：http://api.okayapi.com/?s=App.SuperTable.FreeDelete

接口描述：删可以根据自定义的多个条件（AND或者OR），删除多条数据。数据一旦删除，无法恢复，请谨慎操作！

API Params

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，不用传。如果需要配置多个数据库时，可与小白技术人员联系。重要事情说三遍，这是数据配置标识，不是数据库名称。使用此接口前，请先进入：数据库直连服务配置。
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优先）
max_delete_num	Int	Optaion	0	MIN: 0	最多删除多少条，0表示无限制，即全部删除

API Usage Demo

请求（where和where_X二选一）：
{OKAYAPI_API_HOST}/?s=App.SuperTable.FreeDelete&model_name=article&where=[["id","=",4]]&max_delete_num=1&database=super&app_key={你的app_key}&sign={动态签名}

请求（where和where_X二选一）：
{OKAYAPI_API_HOST}/?s=App.SuperTable.FreeDelete&model_name=article&where_id=4&max_delete_num=1&database=super&app_key={你的app_key}&sign={动态签名}

返回：
{
    "ret": 200,
    "data": {
        "err_code": 0,
        "err_msg": "",
        "delete_total": 0
    },
    "msg": ""
}

API Response

KEY	Type	Description
err_code	Int	状态操作码，0成功；1开发类错误，删除失败(表单不存在)；
err_msg	String	错误提示信息，err_code非0时参考此提示信息
delete_total	Int	删除的条目数量

YesApi 接口文档

接口路径(新)：http://api.okayapi.com/api/App/SuperTable/FreeMultiCal

接口路径(旧)：http://api.okayapi.com/?s=App.SuperTable.FreeMultiCal

接口描述：改根据条件，批量进行四则运算，即：加/减/乘/除。例如，field=x，op=add，number=1，组合起来表示：x=x+1。

API Params

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，不用传。如果需要配置多个数据库时，可与小白技术人员联系。重要事情说三遍，这是数据配置标识，不是数据库名称。使用此接口前，请先进入：数据库直连服务配置。
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优先）
field	String	Required			待更新的字段，如：field=money，此字段必须为数值类型
op	Enum	Required		Range: add/sub/mul/div	运算符号，加：add，减：sub，乘：mul，乘：div
number	String	Required			待运算的数字，例如加多少，减多少，乘多少，除多少。必须为合法的数字，可以是小数

API Usage Demo

请求：
{OKAYAPI_API_HOST}/?s=App.SuperTable.FreeMultiCal&model_name=article&where=[["id","=","1"]]&field=view_times&op=add&number=1&database=super&app_key={你的app_key}&sign={动态签名}

返回：
{
    "ret": 200,
    "data": {
        "err_code": 0,
        "err_msg": "",
        "update_rows": 1
    },
    "msg": ""
}

API Response

KEY	Type	Description
err_code	Int	状态操作码，0成功；1开发类错误，删除失败(表单不存在)；
err_msg	String	错误提示信息，err_code非0时参考此提示信息
update_rows	String	本次更新的条数，没有更新时为0

YesApi 接口文档

接口路径(新)：http://api.okayapi.com/api/App/SuperTable/Desc

接口路径(旧)：http://api.okayapi.com/?s=App.SuperTable.Desc

接口描述：查利用DESC命令查看某个表的结构

API Params

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，不用传。如果需要配置多个数据库时，可与小白技术人员联系。重要事情说三遍，这是数据配置标识，不是数据库名称。使用此接口前，请先进入：数据库直连服务配置。

API Usage Demo

请求：
{OKAYAPI_API_HOST}/?s=App.SuperTable.Desc&model_name=okayapi&app_key={你的app_key}&sign={动态签名}

返回：
{
    "ret": 200,
    "data": {
        "err_code": 0,
        "err_msg": "",
        "desc": [
            {
                "Field": "id",
                "Type": "int(11)",
                "Null": "NO",
                "Key": "PRI",
                "Default": ,
                "Extra": "auto_increment",
                "Collation": "",
                "Comment": "注释"
            },
            {
                "Field": "OKAYAPI",
                "Type": "varchar(1024)",
                "Null": "YES",
                "Key": "",
                "Default": ,
                "Extra": "",
                "Collation": "",
                "Comment": "注释"
            }
        ]
    },
    "msg": "当前请求接口：App.SuperTable.Desc"
}

API Response

KEY	Type	Description
err_code	Int	状态操作码，0成功；1开发类错误
err_msg	String	错误提示信息，err_code非0时参考此提示信息
desc	Array	表结构描述
desc[].Field	String	字段名称
desc[].Type	String	字段类型，例如：int(11)
desc[].Collation	String	字段编码，例如：utf8mb4_general_ci
desc[].Null	String	是否允许为空，YES/NO
desc[].Key	String	字段索引，空/PRI/NOR
desc[].Default	String	默认值
desc[].Extra	String	额外信息，例如：auto_increment
desc[].Comment	String	字段注释

YesApi 接口文档

接口路径(新)：http://api.okayapi.com/api/App/SuperTable/ICanDoIt

接口路径(旧)：http://api.okayapi.com/?s=App.SuperTable.ICanDoIt

接口描述：改可以执行原始的SQL语句进行数据库变更，例如建表、加字段、加索引、改字段等。你可以通过配置小白直连数据库账号的权限来控制允许进行哪些变更。

API Params

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，不用传。如果需要配置多个数据库时，可与小白技术人员联系。重要事情说三遍，这是数据配置标识，不是数据库名称。使用此接口前，请先进入：数据库直连服务配置。
sql	String	Required			待执行的任意SQL语句，须符合MySQL数据库语法，请谨慎操作

API Usage Demo

请求（注意sql参数的语法、编码和特殊字符，推荐用POST方式）：
{OKAYAPI_API_HOST}/?s=App.SuperTable.ICanDoIt&model_name=OKAYAPI&database=super&sql=ALTER TABLE okayapi ADD COLUMN test_name VARCHAR(10)&app_key={你的app_key}&sign={动态签名}

返回：
{
    "ret": 200,
    "data": {
        "err_code": 0,
        "err_msg": "",
        "sql": "ALTER TABLE okayapi ADD COLUMN test_name5 VARCHAR(10)"
    },
    "msg": "当前请求接口：App.SuperTable.ICanDoIt"
}

API Response

KEY	Type	Description
err_code	Int	状态操作码，0成功；1开发类错误
err_msg	String	错误提示信息，err_code非0时参考此提示信息
sql	Array	返回本次成功执行SQL语句

YesApi 接口文档

接口路径(新)：http://api.okayapi.com/api/App/SuperTable/SqlQuery

接口路径(旧)：http://api.okayapi.com/?s=App.SuperTable.SqlQuery

接口描述：查可以通过原始SQL语句，查询数据库，并返回全部结果集。你可以通过配置小白直连数据库账号的权限来控制允许查询哪些表。注意查询的结果不要过大，以免卡死！

API Params

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，不用传。如果需要配置多个数据库时，可与小白技术人员联系。重要事情说三遍，这是数据配置标识，不是数据库名称。使用此接口前，请先进入：数据库直连服务配置。
sql	String	Required			待查询的完整SQL语句，须符合MySQL数据库语法，只支持SELECT系列的操作。推荐此参数使用POST方式，若使用GET方式须进行URL编码，以免解析出错

API Usage Demo

请求（注意查询的结果不要过大，以免卡死！）：
{OKAYAPI_API_HOST}/?s=App.SuperTable.SqlQuery&model_name=okayapi&sql=select id,username,time from okayapi_test limit 0, 3&app_key={你的app_key}&sign={动态签名}

返回：
{
    "ret": 200,
    "data": {
        "err_code": 0,
        "err_msg": "",
        "sql": [
            {
                "id": "1",
                "username": "dogstar1",
                "time": "2018-04-09 20:40:20"
            },
            {
                "id": "2",
                "username": "dogstar2",
                "time": "2018-04-09 20:40:20"
            },
            {
                "id": "3",
                "username": "dogstar3",
                "time": "2018-04-09 20:40:20"
            }
        ]
    },
    "msg": "当前请求接口：App.SuperTable.SqlQuery"
}

API Response

KEY	Type	Description
err_code	Int	操作码，0表示成功，正数表示业务失败场景，负数表示系统失败场景
err_msg	String	错误提示信息，err_code非0时参考此提示信息
sql	Array	返回本次成功查询的结果

YesApi 接口文档

接口路径(新)：http://api.okayapi.com/api/App/SuperTable/MultiCheckCreate

接口路径(旧)：http://api.okayapi.com/?s=App.SuperTable.MultiCheckCreate

接口描述： PatchCUnique For batch operations, add multi distinct new data into table.

API Params

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，不用传。如果需要配置多个数据库时，可与小白技术人员联系。重要事情说三遍，这是数据配置标识，不是数据库名称。使用此接口前，请先进入：数据库直连服务配置。
datas	ArrayJSON Format	Required			批量创建时的初始化数据，注意是数组格式，需要JSON编码后传递。格式：datas=[{"字段名1":"字段值1","字段名2":"字段值2"...}]。数据中的uuid将优先于model_uuid参数。JSON Parser Online
check_field	ArraySeperated with ,	Required			待检测的字段。注意：data数据中必须包含此字段的数据，用作检测重复的依据。多个检测字段用英文逗号分割。例如：check_field=name,age，表示同时检测名字和年龄。请留意字段类型的相等性判断，如字符串类型的字段不能在data参数中传整型参数。

API Usage Demo

请求：
{OKAYAPI_API_HOST}/?s=App.SuperTable.MultiCheckCreate&model_name=article&datas=[{"title":"aaa"},{"title":"bbb"},{"title":"ccc"}]&check_field=title&database=super&app_key={你的app_key}&sign={动态签名}

返回：
{
    "ret": 200,
    "data": {
        "err_code": 0,
        "err_msg": "",
        "details": [
        {
            "id": 1,
            "msg": "创建成功",
            "data_id": 42,
            "create_status": 0
        },
        {
            "id": 2,
            "msg": "创建成功",
            "data_id": 43,
            "create_status": 0
        },
        {
            "id": 3,
            "msg": "创建成功",
            "data_id": 44,
            "create_status": 0
        }
        ]
    },
    "msg": "V1.3.4 小白开放接口 App.SuperTable.MultiCheckCreate"
}


再次请求：
{OKAYAPI_API_HOST}/?s=App.SuperTable.MultiCheckCreate&model_name=article&datas=[{"title":"aaa"},{"title":"123"},{"title":"456"}]&check_field=title&database=super&app_key={你的app_key}&sign={动态签名}

返回：
{
    "ret": 200,
    "data": {
        "err_code": 0,
        "err_msg": "",
        "details": [
        {
            "id": 1,
            "msg": "数据已存在，不再创建",
            "data_id": 42,
            "create_status": 2
        },
        {
            "id": 2,
            "msg": "创建成功",
            "data_id": 45,
            "create_status": 0
        },
        {
            "id": 3,
            "msg": "创建成功",
            "data_id": 46,
            "create_status": 0
        }
        ]
    },
    "msg": "V1.3.4 小白开放接口 App.SuperTable.MultiCheckCreate"
}

API Response

KEY	Type	Description
err_code	Int	状态操作码，0成功；1操作失败，2应用层规则拦截，拦截后可以小白开放平台查看日记
err_msg	String	错误提示信息，err_code非0时参考此提示信息
details	Array	创建的详情
details[].id	Int	客户端传递参数的序号，从1开始
details[].create_status	Int	服务端创建非重复数据的状态，0表示创建添加成功，1表示创建失败，2表示数据已存在
details[].data_id	Int	数据ID，创建成功时是新添加数据的ID，数据存在时是原来数据的ID
details[].msg	String	创建时的错误提示信息

YesApi 接口文档

接口路径(新)：http://api.okayapi.com/api/App/SuperTable/CheckCreateOrUpdate

接口路径(旧)：http://api.okayapi.com/?s=App.SuperTable.CheckCreateOrUpdate

接口描述： CUUnique Try to add an DISTINCT record when not exist, or update the existed record.

API Params

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，不用传。如果需要配置多个数据库时，可与小白技术人员联系。重要事情说三遍，这是数据配置标识，不是数据库名称。使用此接口前，请先进入：数据库直连服务配置。
data	ArrayJSON Format	Optaion			创建时的初始化数据，需要JSON编码后传递。格式：data={"字段名1":"字段值1","字段名2":"字段值2"...}。数据中的uuid将优先于model_uuid参数。JSON Parser Online
check_field	ArraySeperated with ,	Required			待检测的字段。注意：data数据中必须包含待检测的全部字段。即check_field可指定data数据中的一个或多个字段。多个检测字段用英文逗号分割。例如：check_field=name,age，表示同时检测名字和年龄。请留意字段类型的相等性判断，如字符串类型的字段不能在data参数中传整型参数。
logic	Enum	Optaion	and	Range: and/or	多个check_field的逻辑组合，logic=and表示逻辑且，logic=or表示逻辑或

API Usage Demo

请求（使用data的JSON格式传递，data和data_X二选一）：
{OKAYAPI_API_HOST}/?s=App.SuperTable.CheckCreateOrUpdate&model_name=article&data={"title":"abc"}&check_field=title&database=super&app_key={你的app_key}&sign={动态签名}

请求（使用data_X动态参数传递，data和data_X二选一）：
{OKAYAPI_API_HOST}/?s=App.SuperTable.CheckCreateOrUpdate&model_name=article&data_title=abc&check_field=title&database=super&app_key={你的app_key}&sign={动态签名}

返回（如果未存在就新建）：
{
    "ret": 200,
    "data": {
        "err_code": 0,
        "err_msg": "",
        "id": 4,
        "op_type": "insert"
    },
    "msg": ""
}


如果数据已经存在，则返回（存在则更新）：
{
    "ret": 200,
    "data": {
        "err_code": 0,
        "err_msg": "",
        "id": 4,
        "op_type": "update"
    },
    "msg": ""
}

以下示例演示了多个检测字段使用逻辑或的效果，请求：
{OKAYAPI_API_HOST}/?s=App.SuperTable.CheckCreateOrUpdate&model_name=article&data={"title":"abc","view_times":1}&check_field=title,view_times&logic=or

返回：
{
    "ret": 200,
    "data": {
        "err_code": 0,
        "err_msg": "",
        "id": 52,
        "op_type": "update"
    },
    "msg": "V1.4.2 小白开放接口 App.SuperTable.CheckCreateOrUpdate"
}

API Response

KEY	Type	Description
err_code	Int	状态操作码，0成功；1创建失败(不符合表字段要求，或表字段不存在)；2应用层规则拦截，拦截后可以小白开放平台查看日记；
err_msg	String	错误提示信息，err_code非0时参考此提示信息
id	Int	新创建数据的自增ID/或原来数据的ID
op_type	String	本次操作的具体类型，insert为插入，update为更新

YesApi 接口文档

接口路径(新)：http://api.okayapi.com/api/App/SuperTable/MultiCheckCreateOrUpdate

接口路径(旧)：http://api.okayapi.com/?s=App.SuperTable.MultiCheckCreateOrUpdate

接口描述： PatchCUUnique Try to add multi DISTINCT record when not exist, or multi update the existed record.

API Params

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，不用传。如果需要配置多个数据库时，可与小白技术人员联系。重要事情说三遍，这是数据配置标识，不是数据库名称。使用此接口前，请先进入：数据库直连服务配置。
datas	ArrayJSON Format	Required			需要批量创建的初始化数据，需要JSON编码后传递。格式：datas=[{第一组数据},{第二组数据},{第三组数据……}]。每一组的数据格式：{"字段名1":"字段值1","字段名2":"字段值2"...}。数据中的uuid将优先于model_uuid参数。JSON Parser Online
check_field	ArraySeperated with ,	Required			待检测的字段，非批量，全部检测的字段都应一致。注意：datas批量数据每一组数据中必须包含待检测的全部字段。即check_field可指定data数据中的一个或多个字段。多个检测字段用英文逗号分割。例如：check_field=name,age，表示同时检测名字和年龄。请留意字段类型的相等性判断，如字符串类型的字段不能在data参数中传整型参数。
logic	Enum	Optaion	and	Range: and/or	多个check_field的逻辑组合，非批量，全部检测的字段都应一致。logic=and表示逻辑且，logic=or表示逻辑或

API Usage Demo

请求：
{OKAYAPI_API_HOST}/?s=App.SuperTable.MultiCheckCreateOrUpdate&model_name=article&datas=[{"title":"aaa","state":1},{"title":"bbb","state":0}]&check_field=title&database=super&app_key={你的app_key}&sign={动态签名}

返回：
{
    "ret": 200,
    "data": {
        "err_code": 0,
        "err_msg": "",
        "details": [
        {
            "op_type": "update",
            "id": 42
        },
        {
            "op_type": "update",
            "id": 43
        }
        ]
    },
    "msg": "V1.3.20 小白开放接口 App.SuperTable.MultiCheckCreateOrUpdate"
}

以下是部分参数格式错误的请求示例：
{OKAYAPI_API_HOST}/?s=App.SuperTable.MultiCheckCreateOrUpdate&model_name=article&datas=[{"title":"aaa","state":1,"content":"文章内容"},{"title":"bbb"}]&check_field=title,state

返回：
{
    "ret": 200,
    "data": {
        "err_code": 3,
        "err_msg": "data参数中，缺少需要检测重复的state字段数据。",
        "details": [
        {
            "op_type": "insert",
            "id": "57"
        },
        {
            "op_type": "fail",
            "id": 0,
            "error": "data参数中，缺少需要检测重复的state字段数据",
            "data": {
                "title": "bbb"
            }
        }
        ]
    },
    "msg": "V1.3.22 小白开放接口 App.SuperTable.MultiCheckCreateOrUpdate"
}

以下示例演示在批量中使用逻辑或的效果，请求：
{OKAYAPI_API_HOST}/?s=App.SuperTable.MultiCheckCreateOrUpdate&model_name=article&datas=[{"title":"aaa","state":1,"content":"文章内容"},{"title":"bbb","state":0}]&check_field=title,state&logic=or

返回：
{
    "ret": 200,
    "data": {
        "err_code": 0,
        "err_msg": "",
        "details": [
        {
            "op_type": "update",
            "id": 42
        },
        {
            "op_type": "update",
            "id": 36
        }
        ]
    },
    "msg": "V1.4.2 小白开放接口 App.SuperTable.MultiCheckCreateOrUpdate"
}

API Response

KEY	Type	Description
err_code	Int	状态操作码，0成功；1创建失败(不符合表字段要求，或表字段不存在)；2应用层规则拦截，拦截后可以小白开放平台查看日记；3存在部分失败的情况
err_msg	String	错误提示信息，err_code非0时参考此提示信息
details	Array	批量的结果
details[].id	Int	新创建数据的自增ID/或原来数据的ID
details[].op_type	String	本次操作的具体类型，insert为插入，update为更新，fail为失败（参数错误）
model_name	String	当前表单名称

YesApi 接口文档

接口路径(新)：http://api.okayapi.com/api/App/SuperTable/Pagination

接口路径(旧)：http://api.okayapi.com/?s=App.SuperTable.Pagination

接口描述： R The most HOT API, powerful to query data or list all data in pagination, support field selection, sorting, and conditional query.

API Params

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	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 Usage Demo

API Response

KEY	Type	Description
err_code	Int	状态操作码，0成功；1开发类错误，查询失败(表单不存在或查询错误)；2应用层规则拦截，拦截后可以小白开放平台查看日记
err_msg	String	错误提示信息，err_code非0时参考此提示信息
total	Int	数据的总条目数量
list	Array	查询的结果列表数据
page	Int	当前第几页
perpage	Int	当前分页数量

YesApi 接口文档

接口路径(新)：http://api.okayapi.com/api/App/SuperTable/FreeLeftJoinQuery

接口路径(旧)：http://api.okayapi.com/?s=App.SuperTable.FreeLeftJoinQuery

接口描述： R关联 A little complicated, very powerful to JOIN query with another table.

API Params

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，不用传。如果需要配置多个数据库时，可与小白技术人员联系。重要事情说三遍，这是数据配置标识，不是数据库名称。使用此接口前，请先进入：数据库直连服务配置。
join_model_name	String	Required			需要关联的表单名称，目前只支持关联一个表
select	ArraySeperated with ,	Optaion			针对主表的SQL语句的SELECT部分，多个字段用英文逗号分割，如：select=id,uuid。
join_select	ArraySeperated with ,	Required		MIN: 1	针对关联表的SQL语句的SELECT部分，至少需要指定获取一个字段，多个字段用英文逗号分割，如：select=id,uuid。注意：为避免字段名称冲突，关联表字段在接口返回的结果中的名称为：{关联表单名称}_{关联字段名称}。
on	ArrayJSON Format	Required	[]		用于指定表单关联关系的ON部分，JSON格式，key-value对，key为主表字段名，value为关联表字段名，支持多组。例如：model_name.name = join_model_name.name AND model_name.age = join_model_name.other_age，则接口传递参数为：on={"name":"name","age":"other_age"}
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 Usage Demo

假设，当前有两个表单，分别是：文章内容表单（article）、文章分类表单（category），其中：

文章内容表单（article）数据如下：
+----+----------------------+----------------------------------------------------------------+------------+---------+
| id | title                | content                                                        | view_times | cate_id |
+----+----------------------+----------------------------------------------------------------+------------+---------+
| 36 | PHP程序员历险记223   | <p>PHP（中文名：“超文本预处理器”）是一种通用开源脚本语言。</p> |        200 |       3 |
| 37 | 小白开放平台更新公告 | <p>1.推出四大优惠券 2.新增#修改会员分组#接口</p>               |        300 |       1 |
| 38 | 我改了标题           | <p>创建或更新非重复新数据接口</p>                              |        260 |       2 |
| 39 | 标签                 | <p>我爱你，中国</p>                                            |        100 |       0 |
+----+----------------------+----------------------------------------------------------------+------------+---------+
4 rows in set

文章分类表单（category）数据如下：
+----+-----------+---------+
| id | cate_name | is_show |
+----+-----------+---------+
|  1 | 大数据    |       0 |
|  2 | 人工智能  |       1 |
|  3 | 编程开发  |       1 |
+----+-----------+---------+
3 rows in set

并且，article.cate_id字段表示分类ID。那么，下面将演示如何进行关联查询。

【关联查询示例1】查询文章内容id = 36的文章信息以及关联的分类信息。

请求：
{OKAYAPI_API_HOST}/?s=App.SuperTable.FreeLeftJoinQuery&model_name=article&join_model_name=category&select=id,title,content,view_times,cate_id&join_select=cate_name&on={"cate_id":"id"}&logic=and&where=[["id", "=", "36"]]&database=super&app_key={你的app_key}&sign={动态签名}

返回：
{
    "ret": 200,
    "data": {
        "err_code": 0,
        "err_msg": "",
        "total": 1,
        "list": [
        {
            "id": 36,
            "title": "PHP程序员历险记223",
            "content": "<p>PHP（中文名：“超文本预处理器”）是一种通用开源脚本语言。</p>",
            "view_times": 200,
            "cate_id": 3,
            "category_cate_name": "编程开发"
        }
        ],
            "page": 1,
            "perpage": 10
    },
    "msg": "V1.2.28 小白开放接口 App.SuperTable.FreeLeftJoinQuery"
}

【关联查询示例2】查询访问量大于等于100且分类为显示的文章数据。
需要注意，where参数的三元组写法（如上面示例1）默认全部作用于主表单。如果需要对关联表单进行条件判断，需要改用MySQL条件字符串。同时约定：主表单别名为TL（表示Table Left）、关联表单别名为TR（表示Table Right）。下面示例将进行演示。

请求：
{OKAYAPI_API_HOST}/?s=App.SuperTable.FreeLeftJoinQuery&model_name=article&join_model_name=category&select=id,title,content,view_times,cate_id&join_select=cate_name&on={"cate_id":"id"}&logic=and&where=["TL.view_times >= 100", "TR.is_show = 1"]&page=1&perpage=10&database=super&app_key={你的app_key}&sign={动态签名}

返回：
{
    "ret": 200,
    "data": {
        "err_code": 0,
        "err_msg": "",
        "total": 2,
        "list": [
        {
            "id": 36,
            "title": "PHP程序员历险记223",
            "content": "<p>PHP（中文名：“超文本预处理器”）是一种通用开源脚本语言。</p>",
            "view_times": 200,
            "cate_id": 3,
            "category_cate_name": "编程开发"
        },
        {
            "id": 38,
            "title": "我改了标题",
            "content": "<p>创建或更新非重复新数据接口</p>",
            "view_times": 260,
            "cate_id": 2,
            "category_cate_name": "人工智能"
        }
        ],
            "page": 1,
            "perpage": 10
    },
    "msg": "V1.2.28 小白开放接口 App.SuperTable.FreeLeftJoinQuery"
}

API Response

KEY	Type	Description
err_code	Int	状态操作码，0成功；1开发类错误，查询失败(表单不存在或查询错误)；2应用层规则拦截，拦截后可以小白开放平台查看日记
err_msg	String	错误提示信息，err_code非0时参考此提示信息
total	Int	数据的总条目数量
list	Array	查询的结果列表数据
page	Int	当前第几页
perpage	Int	当前分页数量

YesApi 接口文档

接口路径(新)：http://api.okayapi.com/api/App/SuperTable/MultiFreeChangeNumber

接口路径(旧)：http://api.okayapi.com/?s=App.SuperTable.MultiFreeChangeNumber

接口描述： Patch U 可The value of one or more fields can be modified IN BATCHES according to multiple customized conditions (AND or OR), which can be increased or decreased. Note that this API can update multiple data rows.

API Params

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，不用传。如果需要配置多个数据库时，可与小白技术人员联系。重要事情说三遍，这是数据配置标识，不是数据库名称。使用此接口前，请先进入：数据库直连服务配置。
logic	Enum	Optaion	and	Range: and/or	Where condition logic, logic=and for logical and, logic=or for logical or
wheres	ArrayJSON Format	Required			批量条件，格式为：wheres=[第一组,第二组,……]。每一组where参数格式如下： 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
change_field	ArraySeperated with ,	Required			待修改数值的字段名，多个字段名用英文逗号分割。change_value和change_field分割后的数量应当相同。
change_values	ArrayJSON Format	Required			批量待叠加的数值，格式是：change_values=["第一组","第二组","……"]。每一组格式为：正数表示相加，负数表示相减，需要传递有效数值。多个数值用英文逗号分割。每一组和change_field分割后的数量应当相同。示例：change_values=["1","2"]，更新多个值时的示例：["1,11","2,22"]
try_add_datas	ArrayJSON Format	Optaion			批量的初始化数据，格式为：try_add_datas=[第一组，第二组，……]。当无更新时尝试创建的数据，仅当无更新且有传此参数时才会进行数据创建。此参数可用于初始化等操作。try_add_datas要么不传，要么需要和change_values的数量保持一致，对于不需要初始化的可以设置为NULL。此参数只用于初始化，不会再进行change_value的修改。

API Usage Demo

请求：
{OKAYAPI_API_HOST}/?s=App.SuperTable.MultiFreeChangeNumber&model_name=article&logic=and&wheres=[[["id", "=", "404"]],[["id", "=", "405"]]]&change_field=view_times&change_values=["2","3"]&try_add_datas=[{"view_times":"1"},{"view_times":"3"}]&database=super&app_key={你的app_key}&sign={动态签名}

返回：
{
    "ret": 200,
    "data": {
        "err_code": 0,
        "err_msg": "",
        "details": [
        {
            "err_code": 0,
            "err_msg": "",
            "change_value": "2",
            "update_rows": 1
        },
        {
            "err_code": 0,
            "err_msg": "",
            "change_value": "3",
            "update_rows": 1
        }
        ]
    },
    "msg": "V1.3.22 小白开放接口 App.SuperTable.MultiFreeChangeNumber"
}

API Response

KEY	Type	Description
err_code	Int	状态操作码，0成功；1开发类错误，修改失败(表单不存在或字段类型不是数值类型)；2应用层规则拦截，拦截后可以小白开放平台查看日记，3表示部分失败，具体查看details批量结果
err_msg	String	错误提示信息，err_code非0时参考此提示信息
details	Array	批量结果
details[].change_value	String	回传客户端本次待更改的数值
details[].update_rows	Int	每组数据的更新结果，对应更新的条目数量。没有更新或没有创建时为0，如果进行更新或初始化创建则为1，其他情况为对应更新的条目数量
details[].err_code	Int	单次操作的操作码，当err_code为0时才表示正确执行，最终更新结果再看update_rows的返回
details[].err_msg	String	单次操作的错误提示信息

YesApi 接口文档

接口路径(新)：http://api.okayapi.com/api/App/SuperTable/FreeConcact

接口路径(旧)：http://api.okayapi.com/?s=App.SuperTable.FreeConcact

接口描述： U You can modify the string content of one field based on multiple customized conditions (AND or OR), and you can append it to the front or splice it to the back. Delimiters are also supported.

API Params

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，不用传。如果需要配置多个数据库时，可与小白技术人员联系。重要事情说三遍，这是数据配置标识，不是数据库名称。使用此接口前，请先进入：数据库直连服务配置。
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优先）
change_field	String	Required			待修改字符串的字段名，如果不希望在前后出现多余的分割符，可将字段的默认值设置为NULL。
concact_str	String	Required			待追加的字符串
seperator	String	Optaion			分割符，默认为空字符串
side	Enum	Optaion	right	Range: right/left	新增的追加在哪边，其中： right表示右边，即后面； left表示左边，即前面。

API Usage Demo

请求（where和where_X二选一）：
{OKAYAPI_API_HOST}/?s=App.SuperTable.FreeConcact&model_name=article&where=[["id", "=", 41]]&change_field=tag&concact_str=接口&seperator=,&side=right&database=super&app_key={你的app_key}&sign={动态签名}

请求（where和where_X二选一）：
{OKAYAPI_API_HOST}/?s=App.SuperTable.FreeConcact&model_name=article&where_id=41&change_field=tag&concact_str=接口&seperator=,&side=right&database=super&app_key={你的app_key}&sign={动态签名}

返回：
{
    "ret": 200,
    "data": {
        "err_code": 0,
        "err_msg": "",
        "update_rows": 1
    },
    "msg": "小白开放接口：App.SuperTable.FreeConcact"
}

假设id=41的数据，标签字段tag最初的默认值为NULL，那么第一次请求后，tag变成：接口。  

当再次请求时，tag此时原来的内容是：接口。则会变成：接口,接口。中间有分割符逗号。

API Response

KEY	Type	Description
err_code	Int	状态操作码，0成功；1开发类错误，修改失败(表单不存在或字段类型不是数值类型)；2应用层规则拦截，拦截后可以小白开放平台查看日记
err_msg	String	错误提示信息，err_code非0时参考此提示信息
update_rows	String	本次更新的条数，没有更新时为0

YesApi 接口文档

接口路径(新)：http://api.okayapi.com/api/App/SuperTable/FreeAggregation

接口路径(旧)：http://api.okayapi.com/?s=App.SuperTable.FreeAggregation

接口描述： RStat Perform aggregation operations such as SUM/COUNT/MIN/MAX/AVG based on multiple customized conditions (AND or OR), and supports aggregation operations on multiple fields.

API Params

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，不用传。如果需要配置多个数据库时，可与小白技术人员联系。重要事情说三遍，这是数据配置标识，不是数据库名称。使用此接口前，请先进入：数据库直连服务配置。
op_funs	ArraySeperated with ,	Required		MIN: 1	聚合函数操作，支持多个聚合运算，目前支持：SUM/COUNT/MIN/MAX/AVG，分别表示：求和/数目/最小/最大/平均数，注意全部大写，多个用英文逗号分割。
op_fields	ArraySeperated with ,	Required			进行聚合的字段名称，需要和op_funs的运算一一对应，，多个用英文逗号分割。例如：假设op_funs=SUM,COUNT，同时op_fields=price,id，那么最终相当于：SUM(price), COUNT(id)，返回结果字段是：SUM_price, COUNT_id
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优先）

API Usage Demo

请求：
{OKAYAPI_API_HOST}/?s=App.SuperTable.FreeAggregation&model_name=article&op_funs=COUNT,SUM&op_fields=id,view_times&logic=and&where=[["git_author", "=", "dogstar"]]&database=super&app_key={你的app_key}&sign={动态签名}

返回（计算某位作者共发表多少张文章，以及合计的阅读数量）：
{
    "ret": 200,
    "data": {
        "err_code": 0,
        "err_msg": "",
        "report": {
            "COUNT_id": 5,
            "SUM_view_times": "760"
        }
    },
    "msg": "小白开放接口：App.SuperTable.FreeAggregation"
}

API Response

KEY	Type	Description
err_code	Int	状态操作码，0成功；1开发类错误，获取失败(表单不存在)；2应用层规则拦截，拦截后可以小白开放平台查看日记；3No-data-found
err_msg	String	错误提示信息，err_code非0时参考此提示信息
report	Object	聚合运算的表格数据
report.SUM_field	mixed	返回的字段是动态的名称，字段名是：聚合运算名+下划线+字段名，例如：SUM_field。失败时返回 NULL，根据运算和字段类型不同，返回结果可能是int，也可能是string类型，或浮点数。

YesApi 接口文档

接口路径(新)：http://api.okayapi.com/api/App/SuperTable/GetOneDataByOneField

接口路径(旧)：http://api.okayapi.com/?s=App.SuperTable.GetOneDataByOneField

接口描述： R Get one record data by one filed.

API Params

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，不用传。如果需要配置多个数据库时，可与小白技术人员联系。重要事情说三遍，这是数据配置标识，不是数据库名称。使用此接口前，请先进入：数据库直连服务配置。
field_name	String	Required			需要匹配的表单字段名称
field_value	String	Required			需要查找和对比的字段值
select	ArraySeperated with ,	Optaion			需要返回的字段，默认返回全部字段，多个字段用英文逗号分割，如：select=id,uuid

API Usage Demo

请求：
{OKAYAPI_API_HOST}/?s=App.SuperTable.GetOneDataByOneField&model_name=article&field_name=title&field_value=aaa&select=title,view_times,add_time&database=super&app_key={你的app_key}&sign={动态签名}

返回：
{
    "ret": 200,
    "data": {
        "err_code": 0,
        "err_msg": "",
        "data": {
            "id": 42,
            "title": "aaa",
            "view_times": 0,
            "add_time": "2019-11-29 15:25:16"
        }
    },
    "msg": "V1.3.22 小白开放接口 App.SuperTable.GetOneDataByOneField"
}

API Response

KEY	Type	Description
err_code	Int	状态操作码，0成功；1开发类错误，修改失败(表单不存在或字段类型不是数值类型)；2应用层规则拦截，拦截后可以小白开放平台查看日记，3数据不存在或已删除
err_msg	String	错误提示信息，err_code非0时参考此提示信息
data	Object	查找到的数据，如果未找到则为null。其中，id字段固定返回。

YesApi 接口文档

接口路径(新)：http://api.okayapi.com/api/App/SuperTable/GetMoreDataByMoreField

接口路径(旧)：http://api.okayapi.com/?s=App.SuperTable.GetMoreDataByMoreField

接口描述： R Get more data with more fields.

API Params

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，不用传。如果需要配置多个数据库时，可与小白技术人员联系。重要事情说三遍，这是数据配置标识，不是数据库名称。使用此接口前，请先进入：数据库直连服务配置。
logic	Enum	Optaion	and	Range: and/or	Where condition logic, logic=and for logical and, logic=or for logical or
field_name_list	ArraySeperated with ,	Required		MIN: 1	需要匹配的表单字段名称列表，多个字段用英文逗号分割，如：`field_name_list=title,name`
field_value_list	ArraySeperated with ,	Required		MIN: 1	需要查找和对比的字段值列表，多个值用英文逗号分割，如：`field_value_list=标题,小白`。字段值不能含有英文逗号。field_value_list数量必须和field_name_list数量保持一致。
select	ArraySeperated with ,	Optaion			需要返回的字段，默认返回全部字段，多个字段用英文逗号分割，如：select=id,uuid
page	Int	Optaion	1	MIN: 1	第几页
perpage	Int	Optaion	20	MIN: 1；MAX: 10000	分页数量

API Usage Demo

请求：
{OKAYAPI_API_HOST}/?s=App.SuperTable.GetMoreDataByMoreField&model_name=article&logic=and&field_name_list=title,view_times&field_value_list=aaa,0&select=title,view_times,add_time&database=super&app_key={你的app_key}&sign={动态签名}

返回：
{
    "ret": 200,
    "data": {
        "err_code": 0,
        "err_msg": "",
        "items": [
        {
            "title": "aaa",
            "view_times": 0,
            "add_time": "2019-11-29 15:25:16"
        },
        {
            "title": "aaa",
            "view_times": 0,
            "add_time": "2019-12-15 22:03:40"
        }
        ]
    },
    "msg": "V1.3.22 小白开放接口 App.SuperTable.GetMoreDataByMoreField"
}

API Response

KEY	Type	Description
err_code	Int	状态操作码，0成功；1开发类错误；2应用层规则拦截，拦截后可以小白开放平台查看日记
err_msg	String	错误提示信息，err_code非0时参考此提示信息
items	Object	查找到的数据列表，如果未找到则为空数组。默认返回20条，ID升序获取。

YesApi 接口文档

接口路径(新)：http://api.okayapi.com/api/App/SuperTable/FreeReplace

接口路径(旧)：http://api.okayapi.com/?s=App.SuperTable.FreeReplace

接口描述： Patch U Replace the field from one string to other string.

API Params

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，不用传。如果需要配置多个数据库时，可与小白技术人员联系。重要事情说三遍，这是数据配置标识，不是数据库名称。使用此接口前，请先进入：数据库直连服务配置。
field_name	String	Required			字段名称，需要替换的字段名
from_str	String	Required			要替换的子字符串
to_str	String	Required			新的替换子字符串，不能和from_str一样
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优先）

API Usage Demo

API Response

KEY	Type	Description
err_code	Int	操作状态码，0表示成功，1表示更新失败，2表示表单规则不通过
err_msg	String	错误提示信息，err_code非0时参考此提示信息
update_total	Int	成功更新的数量

1701 创建新数据接口[直连版]

API Params

API Usage Demo

API Response

1702 创建非重复新数据接口[直连版]

API Params

API Usage Demo

API Response

1703 批量创建新数据接口[直连版]

API Params

API Usage Demo

API Response

1704 批量极速创建新数据接口[直连版]

API Params

API Usage Demo

API Response

1705 精确更新数据接口[直连版]

API Params

API Usage Demo

API Response

1706 批量ID更新数据接口[直连版]

API Params

API Usage Demo

API Response

1707 自由更新数据接口[直连版]

API Params

API Usage Demo

API Response

1708 精确取数据接口[直连版]

API Params

API Usage Demo

API Response

1709 批量ID取数据接口[直连版]

API Params

API Usage Demo

API Response

1710 精确删除数据接口[直连版]

API Params

API Usage Demo

API Response

1711 批量ID删除数据接口[直连版]

API Params

API Usage Demo

API Response

1712 获取总数接口[直连版]

API Params

API Usage Demo

API Response

1713 分组聚合接口[直连版]

API Params

API Usage Demo

API Response

1714 自由获取总数接口[直连版]

API Params

API Usage Demo

API Response

1715 分页查询列表数据接口[直连版]

API Params

API Usage Demo

API Response

1716 全量数据导出TXT或CSV接口[直连版]

API Params

API Usage Demo

API Response

1717 精确更改数值接口(可加可减)[直连版]

API Params

API Usage Demo

API Response

1718 自由更改数值接口(可加可减)[直连版]

API Params

API Usage Demo

API Response

1719 自由获取一条数据接口[直连版]

API Params

API Usage Demo

API Response

1720 加减后返回数据[直连版]

API Params

API Usage Demo

API Response