OkayAPI Docs


API Path: /api/App/DB_MsSQL_Data/CheckCreate

API Description: 在自定义数据表单中添加一个【非重复】新数据,添加的字段应先要在表中已经存在。即当数据不存在时则创建,当数据已存在时不进行任何操作。

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数据库表名,表名规范如下:
  • 表主键:每应表必须都有一个自增主键,统一推荐为:id INT identity(1,1) NOT NULL PRIMARY KEY
  • 表名前缀:如果已经通过添加新数据库连接配置编辑数据库配置接口配置统一表前缀table_prefix,则表名参数不需要再手动添加表前缀,否则会重复。
  • 表名后缀:不能采用划线加数字为结尾的表名,因为下划线加数字的后缀会系统作为分库分表的配置而解析,如果有疑惑,请与技术客服联系。
db_markStringRequired直连数据库代号,注意!这是开发者添加的数据库代号,不是数据库的名称。使用API前请先添加新数据库连接配置
dataArrayJSON FormatOptaion创建时的初始化数据,需要JSON编码后传递。格式:data={"字段名1":"字段值1","字段名2":"字段值2"...}。数据中的uuid将优先于model_uuid参数。JSON Parser Online
check_fieldArraySeperated with ,Required待检测的字段。注意:data数据中必须包含此字段的数据,用作检测重复的依据。多个检测字段用英文逗号分割。例如:check_field=name,age,表示同时检测名字和年龄。请留意字段类型的相等性判断,如字符串类型的字段不能在data参数中传整型参数。
model_return_dataBooleanOptaionfalse是否返回新创建或原来的数据,model_return_data=1 返回,model_return_data=0 不返回

API Debug

KEYREQUIREDVALUE
app_key *Required
model_name *Required
db_mark *Required
data Option
check_field *Required
model_return_data Option

API Response

KEYTypeDescription
err_codeInt状态操作码,0成功;1创建失败(不符合表字段要求,或表字段不存在,数据已存在,不再创建)
err_msgString错误提示信息,err_code非0时参考此提示信息
idInt新创建数据的自增ID/或原来数据的ID
dataObject新创建或原来的数据,全部字段返回。默认不返回,return_data=1 才返回。

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