OkayAPI Docs


API Path: /api/App/Platform_MyModels/AddNewField

API Description: 为表单添加新字段,每个表单最多可创建100个字段。

1
API Traffic
HTTP/HTTPS
Protocol
GET/POST
Method
UTF-8
Charset
JSON
Response

API Debug   


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 Debug

KEYREQUIREDVALUE
app_key *Required
model_name *Required
field_name *Required
field_desc *Required
field_type *Required
field_length Option
field_default Option
field_is_null Option
field_index Option
field_is_binary Option

API Response

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

HTTP Response Code

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