YesApi 接口文档

8601 获取我的表单列表

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

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

接口描述： 查 获取小白开放平台的全部表单列表

API Params

ParameterTypeRequiredDefaultNoteDescription
HTTP_APPKEYStringRequiredMIN: 32Common Put Your APPKEY
model_nameStringOptaion搜索表单名称(英文)，支持表单匹配
sort_typeIntOptaion排序，1表单名称升级(默认)，2表单名称降序，3添加时间升序，4添加时间降序

API Usage Demo

HTTP 
请求：
{OKAYAPI_API_HOST}/?s=App.Platform_MyModels.GetMyModelsList&app_key={你的app_key}&sign={动态签名}

返回：
{
    "ret": 200,
    "data": {
        "err_code": 0,
        "err_msg": "",
        "models": [
        {
            "model_name": "yesapi_lastest_news",
            "model_desc": "新闻动态",
            "group_name": "",
            "add_time": "2019-12-05 09:19:48"
        },
        {
            "model_name": "test",
            "model_desc": "测试",
            "group_name": "测试",
            "add_time": "2020-01-02 19:10:09"
        }
        ]
    },
    "msg": "V1.4.14 小白开放接口 App.Platform_MyModels.GetMyModelsList"
}

API Response

KEYTypeDescription
err_codeInt操作码，0表示成功，正数表示业务失败场景，负数表示系统失败场景
err_msgString错误提示信息，err_code非0时参考此提示信息
modelsArray我的全部表单，没有时为空数组
models[].model_nameString表单名称(英文)
models[].model_descString表单描述(中文)
models[].add_timeString创建时间
models[].group_nameString分组名称
YesApi 接口文档

8602 创建新表单

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

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

接口描述： 加 创建一个新表单，每个账号当前最多可创建的表单数量为200个。

API Params

ParameterTypeRequiredDefaultNoteDescription
HTTP_APPKEYStringRequiredMIN: 32Common Put Your APPKEY
model_nameStringRequiredMIN: 1；MAX: 50待创建的表单名称(英文)，用于数据库建表，由字母开头和数字的组成（如：demo），50个字符以内
model_descStringRequiredMIN: 1；MAX: 100用于页面展示，请起一个简短的中文名称（如：示例），100个字符以内
group_nameStringOptaion表单分组名称，不填为默认分组

API Usage Demo

HTTP 
请求：
{OKAYAPI_API_HOST}/?s=App.Platform_MyModels.CreateNewModel&model_name=test&model_desc=测试&app_key={你的app_key}&sign={动态签名}

返回：
{
    "ret": 200,
    "data": {
        "err_code": 0,
        "err_msg": ""
    },
    "msg": "V1.4.14 小白开放接口 App.Platform_MyModels.CreateNewModel"
}

API Response

KEYTypeDescription
err_codeInt操作码，0成功，1表单已存在，2表单数量已达到上限，3创建失败请重试，4接口创建失败
err_msgString错误提示信息，err_code非0时参考此提示信息
YesApi 接口文档

8603 添加表单字段

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

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

接口描述： 加 为表单添加新字段，每个表单最多可创建100个字段。

API Params

ParameterTypeRequiredDefaultNoteDescription
HTTP_APPKEYStringRequiredMIN: 32Common Put Your APPKEY
model_nameStringRequired表单名称(英文)
field_nameStringRequiredMIN: 1；MAX: 50字段名称(英文)，请填写有效的数据库表字段名称，如：demo
field_descStringRequiredMIN: 1；MAX: 100字段描述（中文），将会显示在各大菜单，如：示例数据
field_typeEnumRequiredRange: tinyint/smallint/mediumint/int/bigint/float/double/char/varchar/tinytext/text/mediumtext/longtext/date/time/year/datetime/timestamp字段类型，可选字段类型如下：
  • tinyint：数值 - tinyint - 小整数值（-128~127）
  • smallint：数值 - smallint - 大整数值（-32768~32767）
  • mediumint：数值 - mediumint - 大整数值（-8388608~8388607）
  • int：数值 - int - 大整数值（-2^31~2^31-1）
  • bigint：数值 - bigint - 极大整数值（-2^63~2^63-1）
  • float：数值 - float - 单精度浮点数值（-3.4E+38~3.4E+38）
  • double：数值 - double - 双精度浮点数值（-1.79E+308~1.79E+308(）
  • char：字符串 - char - 定长字符串（1~255 个字节）
  • varchar：字符串 - varchar - 变长字符串（1~255 个字节）
  • tinytext：字符串 - tinytext - 短文本字符串（最大长度255个字节）
  • text：字符串 - text - 长文本数据（最大长度65535个字节）
  • mediumtext：字符串 - mediumtext - 中等长度文本数据（最大长度 16777215 个字节）
  • longtext：字符串 - longtext - 极大文本数据（最大长度4294967295个字节）
  • date：日期时间 - date - 日期值（yyyy-mm-dd）
  • time：日期时间 - time - 时间值或持续时间（hh:mm:ss）
  • year：日期时间 - year - 年份值（yyyy）
  • datetime：日期时间 - datetime - 混合日期和时间值（yyyymmddhhmmss）
  • timestamp：日期时间 - timestamp - 时间戳
field_lengthIntOptaion0字段类型长度，重要提示：varchar时长度必填！
field_defaultStringOptaionMAX: 80各类型的缺省默认值分别是：int为0、double为0、varchar为空字符串，datetime为19 70-01-01 00:00:00，date为1970-01-01。特别地，输入@NULL表示NULL
field_is_nullBooleanOptaiontrue是否允许空值，1可为NULL，0不可为NULL(即字段必须)
field_indexEnumOptaionnoRange: no/normal/unique索引，no无索引，normal普通索引，unique唯一索引。注意：如果需要添加唯一索引，请确保现有表数据无重复值，否则会添加失败。索引创建失败不会影响字段的创建。
field_is_binaryBooleanOptaionfalse

API Usage Demo

HTTP 
请求：
{OKAYAPI_API_HOST}/?s=App.Platform_MyModels.AddNewField&model_name=test&field_name=test_name&field_desc=字段说明&field_type=varchar&field_length=100&field_is_null=1&field_index=no&app_key={你的app_key}&sign={动态签名}

返回：
{
    "ret": 200,
    "data": {
        "err_code": 0,
        "err_msg": ""
    },
    "msg": "V1.4.14 小白开放接口 App.Platform_MyModels.AddNewField"
}

API Response

KEYTypeDescription
err_codeInt操作码，0成功，1字段已存在，2字段数量已达到上限，3创建失败请重试，4接口创建失败 5表单不存在
err_msgString错误提示信息，err_code非0时参考此提示信息
YesApi 接口文档

8604 删除表单字段

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

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

接口描述： 删 删除表单已经存在的字段，注意删除后该字段的全部数据列将会被同步删除，不可恢复。

API Params

ParameterTypeRequiredDefaultNoteDescription
HTTP_APPKEYStringRequiredMIN: 32Common Put Your APPKEY
model_nameStringRequired表单名称(英文)
field_nameStringRequiredMIN: 1；MAX: 50待删除的字段名称(英文)，删除后不可恢复，请确认后再删除

API Usage Demo

HTTP 
请求：
{OKAYAPI_API_HOST}/?s=App.Platform_MyModels.DropField&model_name=test&field_name=test_name&app_key={你的app_key}&sign={动态签名}

返回：
{
    "ret": 200,
    "data": {
        "err_code": 0,
        "err_msg": ""
    },
    "msg": "V1.4.14 小白开放接口 App.Platform_MyModels.DropField"
}

API Response

KEYTypeDescription
err_codeInt操作码，0成功，1表单不存在，2字段不存在，4接口删除失败
err_msgString错误提示信息，err_code非0时参考此提示信息
YesApi 接口文档

8605 删除表单

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

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

接口描述： 删 清空表单数据，同时可以同时彻底删除表单结构。注意数据清空后不可恢复！彻底删除表单结构后不可恢复！请再三确认！！

API Params

ParameterTypeRequiredDefaultNoteDescription
HTTP_APPKEYStringRequiredMIN: 32Common Put Your APPKEY
model_nameStringRequiredMIN: 1；MAX: 50待清空数据或彻底删除的表单名称(英文)，删除后不可恢复，请三思后确认再删除！
is_drop_tableBooleanOptaionfalse是否同时彻底删除表单结构及其全部表单字段，删除后表单结构将不再存在，需要重新创建并添加字段

API Usage Demo

HTTP 
请求：
{OKAYAPI_API_HOST}/?s=App.Platform_MyModels.DangerClear&model_name=test&app_key={你的app_key}&sign={动态签名}

返回：
{
    "ret": 200,
    "data": {
        "err_code": 0,
        "err_msg": ""
    },
    "msg": "V1.4.15 小白开放接口 App.Platform_MyModels.DangerClear"
}

API Response

KEYTypeDescription
err_codeInt操作码，0成功，1表单不存在，4接口删除失败
err_msgString错误提示信息，err_code非0时参考此提示信息

Power by OkayAPI.com Contact us (WA: okayapi OR Email: chanzonghuang@gmail.com).
Timezone: America/New_York May/10/2025 21:55:27