YesApi接口文档 | 果创云_数据库API_500+免费接口(原名:小白接口)

YesApi 接口文档

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

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

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

接口参数若无特殊说明，接口参数同时支持GET和POST传递；推荐：查询/删除用GET，创建/更新用POST。

参数名字	参数类型	是否必须	默认值	备注	参数说明
app_key	字符串	必须		最小：32	公共参数开发者应用的app_key，点击查看，或免费注册。
sign	字符串	可选			公共参数接口签名，其中：关闭签名，默认，不需要签名，在接口签名设置关闭或开启接口签名。静态签名，简单，固定的签名，点击获取。动态签名，复杂，安全系数高，获取密钥，教程：如何生成签名，下载SDK开发包，在线测试对比签名。定制签名，支持个性化签名签名算法定制。
uuid	字符串	可选			公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token	字符串	可选			公共参数当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。
return_data	字符串	可选			公共参数数据返回结构，其中： return_data=0，返回完整的接口结果，示例：`{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi，欢迎使用小白开放接口！"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"}`； return_data=1，返回简洁的接口结果，只返回data字段，结构简化一级，更扁平，示例：`{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi，欢迎使用小白开放接口！"}`。
yesapi_allow_origin	整型	可选	0		公共参数是否允许跨域请求，1表示允许，0表示不允许。
model_name	字符串	可选			搜索表单名称(英文)，支持表单匹配
sort_type	整型	可选			排序，1表单名称升级(默认)，2表单名称降序，3添加时间升序，4添加时间降序

客户端请求示例

查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名

我的客户端是【XXX】，需求是【XXX】，app_key是【XXX】，请根据以下接口文档，完成API接入。


# 【 8601 获取我的表单列表】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=App.Platform_MyModels.GetMyModelsList`
**请求方式**: POST/GET

## 接口基本信息
- **功能描述**:  查 获取小白开放平台的全部表单列表
- **返回格式**: JSON

## 请求参数说明

### 系统参数（使用Query传递）
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名，固定为`App.Platform_MyModels.GetMyModelsList` |
| app_key | string | 必填 | 应用key，传入`你的app_key` |
| sign | string | 可选 | 公共参数接口签名，其中：                  关闭签名，默认，不需要签名，在接口签名设置关闭或开启接口签名。         静态签名，简单，固定的签名，点击获取。         动态签名，复杂，安全系数高，获取密钥，教程：如何生成签名，下载SDK开发包，在线测试对比签名。         定制签名，支持个性化签名签名算法定制。          |
| uuid | string | 可选 | 公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 |
| token | string | 可选 | 公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。 |
| return_data | string | 可选 | 公共参数 数据返回结构，其中：         return_data=0，返回完整的接口结果，示例：{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi，欢迎使用小白开放接口！"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"}；         return_data=1，返回简洁的接口结果，只返回data字段，结构简化一级，更扁平，示例：{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi，欢迎使用小白开放接口！"}。          |
| yesapi_allow_origin | int | 可选 | 公共参数 是否允许跨域请求，1表示允许，0表示不允许。 |


### 业务参数（使用POST或Query传递）
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| model_name | string | 可选 | 搜索表单名称(英文)，支持表单匹配 |
| sort_type | int | 可选 | 排序，1表单名称升级(默认)，2表单名称降序，3添加时间升序，4添加时间降序 |


## 返回字段

| 返回字段	| 类型	| 说明 |
|--------|------|------|
| ret	| int | 接口状态码，`200`表示成功，`4xx`表示客户端非法请求，`5xx`表示服务端异常 |
| data | object/array/混合 | 接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当`return_data=1`时，接口只会返回此`data`字段。|
| msg | 字符串 | 提示信息，面向技术人员的帮助或错误提示信息，成功返回时为空字符串 |
| data.err_code | int | 操作码，0表示成功，正数表示业务失败场景，负数表示系统失败场景|
| data.err_msg | string | 错误提示信息，err_code非0时参考此提示信息|
| data.models | array | 我的全部表单，没有时为空数组|
| data.models[].model_name | string | 表单名称(英文)|
| data.models[].model_desc | string | 表单描述(中文)|
| data.models[].add_time | string | 创建时间|
| data.models[].group_name | string | 分组名称|


## 请求示例

```bash
curl -X POST "http://`你的API接口域名`/?s=App.Platform_MyModels.GetMyModelsList&app_key=YOUR_APP_KEY" \
  -H "Content-Type: application/json;charset=UTF-8" \
  -d "YOUR_POST_DATA_JSON"
```

成功返回示例（ret=200表示成功请求，data为成功后的业务数据）：
```json
{
    "ret": 200,
    "data": `成功返回的业务数据`,
    "msg": ""
}
```

失败返回示例：
```json
{
    "ret": 400,
    "data": [],
    "msg": "客户端非法请求：xxx参数错误"
}
```

请求：
{你的接口域名}/?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"
}

接口返回

返回字段	类型	说明
ret	整型	接口状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务端异常，查看异常错误码
data	object/array/混合	接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当return_data=1时，接口只会返回此data字段。
data.err_code	整型	操作码，0表示成功，正数表示业务失败场景，负数表示系统失败场景
data.err_msg	字符串	错误提示信息，err_code非0时参考此提示信息
data.models	字符串	我的全部表单，没有时为空数组
data.models[].model_name	字符串	表单名称(英文)
data.models[].model_desc	字符串	表单描述(中文)
data.models[].add_time	字符串	创建时间
data.models[].group_name	字符串	分组名称
msg	字符串	提示信息，面向技术人员的帮助或错误提示信息
_t	整数	服务器当时Unix时间戳，例如：1657513450
_auth	字符串	反向数字签名，可用于客户端进行反向验证，防止数据篡改，例如：9bcd54ff53e71a1d80d37c52bdfabf76。验证算法：`_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串)`，若需要关闭或开启请提交工单

YesApi 接口文档

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

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

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

接口参数若无特殊说明，接口参数同时支持GET和POST传递；推荐：查询/删除用GET，创建/更新用POST。

参数名字	参数类型	是否必须	默认值	备注	参数说明
app_key	字符串	必须		最小：32	公共参数开发者应用的app_key，点击查看，或免费注册。
sign	字符串	可选			公共参数接口签名，其中：关闭签名，默认，不需要签名，在接口签名设置关闭或开启接口签名。静态签名，简单，固定的签名，点击获取。动态签名，复杂，安全系数高，获取密钥，教程：如何生成签名，下载SDK开发包，在线测试对比签名。定制签名，支持个性化签名签名算法定制。
uuid	字符串	可选			公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token	字符串	可选			公共参数当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。
return_data	字符串	可选			公共参数数据返回结构，其中： return_data=0，返回完整的接口结果，示例：`{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi，欢迎使用小白开放接口！"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"}`； return_data=1，返回简洁的接口结果，只返回data字段，结构简化一级，更扁平，示例：`{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi，欢迎使用小白开放接口！"}`。
yesapi_allow_origin	整型	可选	0		公共参数是否允许跨域请求，1表示允许，0表示不允许。
model_name	字符串	必须		最小：1；最大：50	待创建的表单名称(英文)，用于数据库建表，由字母开头和数字的组成（如：demo），50个字符以内
model_desc	字符串	必须		最小：1；最大：100	用于页面展示，请起一个简短的中文名称（如：示例），100个字符以内
group_name	字符串	可选			表单分组名称，不填为默认分组

客户端请求示例

查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名

我的客户端是【XXX】，需求是【XXX】，app_key是【XXX】，请根据以下接口文档，完成API接入。


# 【 8602 创建新表单】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=App.Platform_MyModels.CreateNewModel`
**请求方式**: POST/GET

## 接口基本信息
- **功能描述**:  加 创建一个新表单，每个账号当前最多可创建的表单数量为200个。
- **返回格式**: JSON

## 请求参数说明

### 系统参数（使用Query传递）
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名，固定为`App.Platform_MyModels.CreateNewModel` |
| app_key | string | 必填 | 应用key，传入`你的app_key` |
| sign | string | 可选 | 公共参数接口签名，其中：                  关闭签名，默认，不需要签名，在接口签名设置关闭或开启接口签名。         静态签名，简单，固定的签名，点击获取。         动态签名，复杂，安全系数高，获取密钥，教程：如何生成签名，下载SDK开发包，在线测试对比签名。         定制签名，支持个性化签名签名算法定制。          |
| uuid | string | 可选 | 公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 |
| token | string | 可选 | 公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。 |
| return_data | string | 可选 | 公共参数 数据返回结构，其中：         return_data=0，返回完整的接口结果，示例：{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi，欢迎使用小白开放接口！"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"}；         return_data=1，返回简洁的接口结果，只返回data字段，结构简化一级，更扁平，示例：{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi，欢迎使用小白开放接口！"}。          |
| yesapi_allow_origin | int | 可选 | 公共参数 是否允许跨域请求，1表示允许，0表示不允许。 |


### 业务参数（使用POST或Query传递）
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| model_name | string | 必填 | 待创建的表单名称(英文)，用于数据库建表，由字母开头和数字的组成（如：demo），50个字符以内 |
| model_desc | string | 必填 | 用于页面展示，请起一个简短的中文名称（如：示例），100个字符以内 |
| group_name | string | 可选 | 表单分组名称，不填为默认分组 |


## 返回字段

| 返回字段	| 类型	| 说明 |
|--------|------|------|
| ret	| int | 接口状态码，`200`表示成功，`4xx`表示客户端非法请求，`5xx`表示服务端异常 |
| data | object/array/混合 | 接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当`return_data=1`时，接口只会返回此`data`字段。|
| msg | 字符串 | 提示信息，面向技术人员的帮助或错误提示信息，成功返回时为空字符串 |
| data.err_code | int | 操作码，0成功，1表单已存在，2表单数量已达到上限，3创建失败请重试，4接口创建失败|
| data.err_msg | string | 错误提示信息，err_code非0时参考此提示信息|


## 请求示例

```bash
curl -X POST "http://`你的API接口域名`/?s=App.Platform_MyModels.CreateNewModel&app_key=YOUR_APP_KEY" \
  -H "Content-Type: application/json;charset=UTF-8" \
  -d "YOUR_POST_DATA_JSON"
```

成功返回示例（ret=200表示成功请求，data为成功后的业务数据）：
```json
{
    "ret": 200,
    "data": `成功返回的业务数据`,
    "msg": ""
}
```

失败返回示例：
```json
{
    "ret": 400,
    "data": [],
    "msg": "客户端非法请求：xxx参数错误"
}
```

请求：
{你的接口域名}/?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"
}

接口返回

返回字段	类型	说明
ret	整型	接口状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务端异常，查看异常错误码
data	object/array/混合	接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当return_data=1时，接口只会返回此data字段。
data.err_code	整型	操作码，0成功，1表单已存在，2表单数量已达到上限，3创建失败请重试，4接口创建失败
data.err_msg	字符串	错误提示信息，err_code非0时参考此提示信息
msg	字符串	提示信息，面向技术人员的帮助或错误提示信息
_t	整数	服务器当时Unix时间戳，例如：1657513450
_auth	字符串	反向数字签名，可用于客户端进行反向验证，防止数据篡改，例如：9bcd54ff53e71a1d80d37c52bdfabf76。验证算法：`_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串)`，若需要关闭或开启请提交工单

YesApi 接口文档

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

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

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

接口参数若无特殊说明，接口参数同时支持GET和POST传递；推荐：查询/删除用GET，创建/更新用POST。

参数名字	参数类型	是否必须	默认值	备注	参数说明
app_key	字符串	必须		最小：32	公共参数开发者应用的app_key，点击查看，或免费注册。
sign	字符串	可选			公共参数接口签名，其中：关闭签名，默认，不需要签名，在接口签名设置关闭或开启接口签名。静态签名，简单，固定的签名，点击获取。动态签名，复杂，安全系数高，获取密钥，教程：如何生成签名，下载SDK开发包，在线测试对比签名。定制签名，支持个性化签名签名算法定制。
uuid	字符串	可选			公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token	字符串	可选			公共参数当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。
return_data	字符串	可选			公共参数数据返回结构，其中： return_data=0，返回完整的接口结果，示例：`{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi，欢迎使用小白开放接口！"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"}`； return_data=1，返回简洁的接口结果，只返回data字段，结构简化一级，更扁平，示例：`{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi，欢迎使用小白开放接口！"}`。
yesapi_allow_origin	整型	可选	0		公共参数是否允许跨域请求，1表示允许，0表示不允许。
model_name	字符串	必须			表单名称(英文)
field_name	字符串	必须		最小：1；最大：50	字段名称(英文)，请填写有效的数据库表字段名称，如：demo
field_desc	字符串	必须		最小：1；最大：100	字段描述（中文），将会显示在各大菜单，如：示例数据
field_type	枚举类型	必须		范围：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_length	整型	可选	0		字段类型长度，重要提示：varchar时长度必填！
field_default	字符串	可选		最大：80	各类型的缺省默认值分别是：int为0、double为0、varchar为空字符串，datetime为19 70-01-01 00:00:00，date为1970-01-01。特别地，输入@NULL表示NULL
field_is_null	布尔型	可选	true		是否允许空值，1可为NULL，0不可为NULL(即字段必须)
field_index	枚举类型	可选	no	范围：no/normal/unique	索引，no无索引，normal普通索引，unique唯一索引。注意：如果需要添加唯一索引，请确保现有表数据无重复值，否则会添加失败。索引创建失败不会影响字段的创建。
field_is_binary	布尔型	可选	false

客户端请求示例

查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名

我的客户端是【XXX】，需求是【XXX】，app_key是【XXX】，请根据以下接口文档，完成API接入。


# 【 8603 添加表单字段】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=App.Platform_MyModels.AddNewField`
**请求方式**: POST/GET

## 接口基本信息
- **功能描述**:  加 为表单添加新字段，每个表单最多可创建100个字段。
- **返回格式**: JSON

## 请求参数说明

### 系统参数（使用Query传递）
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名，固定为`App.Platform_MyModels.AddNewField` |
| app_key | string | 必填 | 应用key，传入`你的app_key` |
| sign | string | 可选 | 公共参数接口签名，其中：                  关闭签名，默认，不需要签名，在接口签名设置关闭或开启接口签名。         静态签名，简单，固定的签名，点击获取。         动态签名，复杂，安全系数高，获取密钥，教程：如何生成签名，下载SDK开发包，在线测试对比签名。         定制签名，支持个性化签名签名算法定制。          |
| uuid | string | 可选 | 公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 |
| token | string | 可选 | 公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。 |
| return_data | string | 可选 | 公共参数 数据返回结构，其中：         return_data=0，返回完整的接口结果，示例：{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi，欢迎使用小白开放接口！"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"}；         return_data=1，返回简洁的接口结果，只返回data字段，结构简化一级，更扁平，示例：{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi，欢迎使用小白开放接口！"}。          |
| yesapi_allow_origin | int | 可选 | 公共参数 是否允许跨域请求，1表示允许，0表示不允许。 |


### 业务参数（使用POST或Query传递）
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| model_name | string | 必填 | 表单名称(英文) |
| field_name | string | 必填 | 字段名称(英文)，请填写有效的数据库表字段名称，如：demo |
| field_desc | string | 必填 | 字段描述（中文），将会显示在各大菜单，如：示例数据 |
| field_type | enum | 必填 | 字段类型，可选字段类型如下：                                   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_length | int | 可选 | 字段类型长度，重要提示：varchar时长度必填！ |
| field_default | string | 可选 | 各类型的缺省默认值分别是：int为0、double为0、varchar为空字符串，datetime为19 70-01-01 00:00:00，date为1970-01-01。特别地，输入@NULL表示NULL |
| field_is_null | boolean | 可选 | 是否允许空值，1可为NULL，0不可为NULL(即字段必须) |
| field_index | enum | 可选 | 索引，no无索引，normal普通索引，unique唯一索引。注意：如果需要添加唯一索引，请确保现有表数据无重复值，否则会添加失败。索引创建失败不会影响字段的创建。 |
| field_is_binary | boolean | 可选 |  |


## 返回字段

| 返回字段	| 类型	| 说明 |
|--------|------|------|
| ret	| int | 接口状态码，`200`表示成功，`4xx`表示客户端非法请求，`5xx`表示服务端异常 |
| data | object/array/混合 | 接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当`return_data=1`时，接口只会返回此`data`字段。|
| msg | 字符串 | 提示信息，面向技术人员的帮助或错误提示信息，成功返回时为空字符串 |
| data.err_code | int | 操作码，0成功，1字段已存在，2字段数量已达到上限，3创建失败请重试，4接口创建失败 5表单不存在|
| data.err_msg | string | 错误提示信息，err_code非0时参考此提示信息|


## 请求示例

```bash
curl -X POST "http://`你的API接口域名`/?s=App.Platform_MyModels.AddNewField&app_key=YOUR_APP_KEY" \
  -H "Content-Type: application/json;charset=UTF-8" \
  -d "YOUR_POST_DATA_JSON"
```

成功返回示例（ret=200表示成功请求，data为成功后的业务数据）：
```json
{
    "ret": 200,
    "data": `成功返回的业务数据`,
    "msg": ""
}
```

失败返回示例：
```json
{
    "ret": 400,
    "data": [],
    "msg": "客户端非法请求：xxx参数错误"
}
```

请求：
{你的接口域名}/?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"
}

接口返回

返回字段	类型	说明
ret	整型	接口状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务端异常，查看异常错误码
data	object/array/混合	接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当return_data=1时，接口只会返回此data字段。
data.err_code	整型	操作码，0成功，1字段已存在，2字段数量已达到上限，3创建失败请重试，4接口创建失败 5表单不存在
data.err_msg	字符串	错误提示信息，err_code非0时参考此提示信息
msg	字符串	提示信息，面向技术人员的帮助或错误提示信息
_t	整数	服务器当时Unix时间戳，例如：1657513450
_auth	字符串	反向数字签名，可用于客户端进行反向验证，防止数据篡改，例如：9bcd54ff53e71a1d80d37c52bdfabf76。验证算法：`_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串)`，若需要关闭或开启请提交工单

YesApi 接口文档

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

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

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

接口参数若无特殊说明，接口参数同时支持GET和POST传递；推荐：查询/删除用GET，创建/更新用POST。

参数名字	参数类型	是否必须	默认值	备注	参数说明
app_key	字符串	必须		最小：32	公共参数开发者应用的app_key，点击查看，或免费注册。
sign	字符串	可选			公共参数接口签名，其中：关闭签名，默认，不需要签名，在接口签名设置关闭或开启接口签名。静态签名，简单，固定的签名，点击获取。动态签名，复杂，安全系数高，获取密钥，教程：如何生成签名，下载SDK开发包，在线测试对比签名。定制签名，支持个性化签名签名算法定制。
uuid	字符串	可选			公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token	字符串	可选			公共参数当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。
return_data	字符串	可选			公共参数数据返回结构，其中： return_data=0，返回完整的接口结果，示例：`{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi，欢迎使用小白开放接口！"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"}`； return_data=1，返回简洁的接口结果，只返回data字段，结构简化一级，更扁平，示例：`{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi，欢迎使用小白开放接口！"}`。
yesapi_allow_origin	整型	可选	0		公共参数是否允许跨域请求，1表示允许，0表示不允许。
model_name	字符串	必须			表单名称(英文)
field_name	字符串	必须		最小：1；最大：50	待删除的字段名称(英文)，删除后不可恢复，请确认后再删除

客户端请求示例

查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名

我的客户端是【XXX】，需求是【XXX】，app_key是【XXX】，请根据以下接口文档，完成API接入。


# 【 8604 删除表单字段】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=App.Platform_MyModels.DropField`
**请求方式**: POST/GET

## 接口基本信息
- **功能描述**:  删 删除表单已经存在的字段，注意删除后该字段的全部数据列将会被同步删除，不可恢复。
- **返回格式**: JSON

## 请求参数说明

### 系统参数（使用Query传递）
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名，固定为`App.Platform_MyModels.DropField` |
| app_key | string | 必填 | 应用key，传入`你的app_key` |
| sign | string | 可选 | 公共参数接口签名，其中：                  关闭签名，默认，不需要签名，在接口签名设置关闭或开启接口签名。         静态签名，简单，固定的签名，点击获取。         动态签名，复杂，安全系数高，获取密钥，教程：如何生成签名，下载SDK开发包，在线测试对比签名。         定制签名，支持个性化签名签名算法定制。          |
| uuid | string | 可选 | 公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 |
| token | string | 可选 | 公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。 |
| return_data | string | 可选 | 公共参数 数据返回结构，其中：         return_data=0，返回完整的接口结果，示例：{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi，欢迎使用小白开放接口！"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"}；         return_data=1，返回简洁的接口结果，只返回data字段，结构简化一级，更扁平，示例：{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi，欢迎使用小白开放接口！"}。          |
| yesapi_allow_origin | int | 可选 | 公共参数 是否允许跨域请求，1表示允许，0表示不允许。 |


### 业务参数（使用POST或Query传递）
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| model_name | string | 必填 | 表单名称(英文) |
| field_name | string | 必填 | 待删除的字段名称(英文)，删除后不可恢复，请确认后再删除 |


## 返回字段

| 返回字段	| 类型	| 说明 |
|--------|------|------|
| ret	| int | 接口状态码，`200`表示成功，`4xx`表示客户端非法请求，`5xx`表示服务端异常 |
| data | object/array/混合 | 接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当`return_data=1`时，接口只会返回此`data`字段。|
| msg | 字符串 | 提示信息，面向技术人员的帮助或错误提示信息，成功返回时为空字符串 |
| data.err_code | int | 操作码，0成功，1表单不存在，2字段不存在，4接口删除失败|
| data.err_msg | string | 错误提示信息，err_code非0时参考此提示信息|


## 请求示例

```bash
curl -X POST "http://`你的API接口域名`/?s=App.Platform_MyModels.DropField&app_key=YOUR_APP_KEY" \
  -H "Content-Type: application/json;charset=UTF-8" \
  -d "YOUR_POST_DATA_JSON"
```

成功返回示例（ret=200表示成功请求，data为成功后的业务数据）：
```json
{
    "ret": 200,
    "data": `成功返回的业务数据`,
    "msg": ""
}
```

失败返回示例：
```json
{
    "ret": 400,
    "data": [],
    "msg": "客户端非法请求：xxx参数错误"
}
```

请求：
{你的接口域名}/?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"
}

接口返回

返回字段	类型	说明
ret	整型	接口状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务端异常，查看异常错误码
data	object/array/混合	接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当return_data=1时，接口只会返回此data字段。
data.err_code	整型	操作码，0成功，1表单不存在，2字段不存在，4接口删除失败
data.err_msg	字符串	错误提示信息，err_code非0时参考此提示信息
msg	字符串	提示信息，面向技术人员的帮助或错误提示信息
_t	整数	服务器当时Unix时间戳，例如：1657513450
_auth	字符串	反向数字签名，可用于客户端进行反向验证，防止数据篡改，例如：9bcd54ff53e71a1d80d37c52bdfabf76。验证算法：`_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串)`，若需要关闭或开启请提交工单

YesApi 接口文档

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

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

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

接口参数若无特殊说明，接口参数同时支持GET和POST传递；推荐：查询/删除用GET，创建/更新用POST。

参数名字	参数类型	是否必须	默认值	备注	参数说明
app_key	字符串	必须		最小：32	公共参数开发者应用的app_key，点击查看，或免费注册。
sign	字符串	可选			公共参数接口签名，其中：关闭签名，默认，不需要签名，在接口签名设置关闭或开启接口签名。静态签名，简单，固定的签名，点击获取。动态签名，复杂，安全系数高，获取密钥，教程：如何生成签名，下载SDK开发包，在线测试对比签名。定制签名，支持个性化签名签名算法定制。
uuid	字符串	可选			公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token	字符串	可选			公共参数当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。
return_data	字符串	可选			公共参数数据返回结构，其中： return_data=0，返回完整的接口结果，示例：`{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi，欢迎使用小白开放接口！"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"}`； return_data=1，返回简洁的接口结果，只返回data字段，结构简化一级，更扁平，示例：`{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi，欢迎使用小白开放接口！"}`。
yesapi_allow_origin	整型	可选	0		公共参数是否允许跨域请求，1表示允许，0表示不允许。
model_name	字符串	必须		最小：1；最大：50	待清空数据或彻底删除的表单名称(英文)，删除后不可恢复，请三思后确认再删除！
is_drop_table	布尔型	可选	false		是否同时彻底删除表单结构及其全部表单字段，删除后表单结构将不再存在，需要重新创建并添加字段

客户端请求示例

查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名

我的客户端是【XXX】，需求是【XXX】，app_key是【XXX】，请根据以下接口文档，完成API接入。


# 【 8605 删除表单】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=App.Platform_MyModels.DangerClear`
**请求方式**: POST/GET

## 接口基本信息
- **功能描述**:  删 清空表单数据，同时可以同时彻底删除表单结构。注意数据清空后不可恢复！彻底删除表单结构后不可恢复！请再三确认！！
- **返回格式**: JSON

## 请求参数说明

### 系统参数（使用Query传递）
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名，固定为`App.Platform_MyModels.DangerClear` |
| app_key | string | 必填 | 应用key，传入`你的app_key` |
| sign | string | 可选 | 公共参数接口签名，其中：                  关闭签名，默认，不需要签名，在接口签名设置关闭或开启接口签名。         静态签名，简单，固定的签名，点击获取。         动态签名，复杂，安全系数高，获取密钥，教程：如何生成签名，下载SDK开发包，在线测试对比签名。         定制签名，支持个性化签名签名算法定制。          |
| uuid | string | 可选 | 公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 |
| token | string | 可选 | 公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。 |
| return_data | string | 可选 | 公共参数 数据返回结构，其中：         return_data=0，返回完整的接口结果，示例：{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi，欢迎使用小白开放接口！"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"}；         return_data=1，返回简洁的接口结果，只返回data字段，结构简化一级，更扁平，示例：{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi，欢迎使用小白开放接口！"}。          |
| yesapi_allow_origin | int | 可选 | 公共参数 是否允许跨域请求，1表示允许，0表示不允许。 |


### 业务参数（使用POST或Query传递）
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| model_name | string | 必填 | 待清空数据或彻底删除的表单名称(英文)，删除后不可恢复，请三思后确认再删除！ |
| is_drop_table | boolean | 可选 | 是否同时彻底删除表单结构及其全部表单字段，删除后表单结构将不再存在，需要重新创建并添加字段 |


## 返回字段

| 返回字段	| 类型	| 说明 |
|--------|------|------|
| ret	| int | 接口状态码，`200`表示成功，`4xx`表示客户端非法请求，`5xx`表示服务端异常 |
| data | object/array/混合 | 接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当`return_data=1`时，接口只会返回此`data`字段。|
| msg | 字符串 | 提示信息，面向技术人员的帮助或错误提示信息，成功返回时为空字符串 |
| data.err_code | int | 操作码，0成功，1表单不存在，4接口删除失败|
| data.err_msg | string | 错误提示信息，err_code非0时参考此提示信息|


## 请求示例

```bash
curl -X POST "http://`你的API接口域名`/?s=App.Platform_MyModels.DangerClear&app_key=YOUR_APP_KEY" \
  -H "Content-Type: application/json;charset=UTF-8" \
  -d "YOUR_POST_DATA_JSON"
```

成功返回示例（ret=200表示成功请求，data为成功后的业务数据）：
```json
{
    "ret": 200,
    "data": `成功返回的业务数据`,
    "msg": ""
}
```

失败返回示例：
```json
{
    "ret": 400,
    "data": [],
    "msg": "客户端非法请求：xxx参数错误"
}
```

请求：
{你的接口域名}/?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"
}

接口返回

返回字段	类型	说明
ret	整型	接口状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务端异常，查看异常错误码
data	object/array/混合	接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当return_data=1时，接口只会返回此data字段。
data.err_code	整型	操作码，0成功，1表单不存在，4接口删除失败
data.err_msg	字符串	错误提示信息，err_code非0时参考此提示信息
msg	字符串	提示信息，面向技术人员的帮助或错误提示信息
_t	整数	服务器当时Unix时间戳，例如：1657513450
_auth	字符串	反向数字签名，可用于客户端进行反向验证，防止数据篡改，例如：9bcd54ff53e71a1d80d37c52bdfabf76。验证算法：`_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串)`，若需要关闭或开启请提交工单

8601 获取我的表单列表

接口参数 若无特殊说明，接口参数同时支持GET和POST传递；推荐：查询/删除用GET，创建/更新用POST。

8602 创建新表单

接口参数 若无特殊说明，接口参数同时支持GET和POST传递；推荐：查询/删除用GET，创建/更新用POST。

8603 添加表单字段

接口参数 若无特殊说明，接口参数同时支持GET和POST传递；推荐：查询/删除用GET，创建/更新用POST。

8604 删除表单字段

接口参数 若无特殊说明，接口参数同时支持GET和POST传递；推荐：查询/删除用GET，创建/更新用POST。

8605 删除表单

接口参数 若无特殊说明，接口参数同时支持GET和POST传递；推荐：查询/删除用GET，创建/更新用POST。

接口参数若无特殊说明，接口参数同时支持GET和POST传递；推荐：查询/删除用GET，创建/更新用POST。

接口参数若无特殊说明，接口参数同时支持GET和POST传递；推荐：查询/删除用GET，创建/更新用POST。

接口参数若无特殊说明，接口参数同时支持GET和POST传递；推荐：查询/删除用GET，创建/更新用POST。

接口参数若无特殊说明，接口参数同时支持GET和POST传递；推荐：查询/删除用GET，创建/更新用POST。

接口参数若无特殊说明，接口参数同时支持GET和POST传递；推荐：查询/删除用GET，创建/更新用POST。