OkayAPI Docs


API Path: /api/App/DB_MsSQL_Data/GetDocx

API Description: sql server数据库中,根据数据库表ID,获取自定义数据表单中的数据,并生成可直接下载的word文档。HTML内容将会被作为普通文本序列化输出。注意,仅当成功时才可下载word文档,失败时依然以接口JSON结果返回。

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前请先添加新数据库连接配置
idIntRequiredMIN: 1数据ID,例如:1,2,3,……
titleStringOptaionword文档标题及文件名
tplStringOptaionword文档的模板,表单字段点位符为:{{字段名}}。例如:
ID为{{id}},更新时间为{{update_time}},创建时间{{add_time}},特别地,换行为{{\n}}
未设置模板时,默认显示全部字段,一行一个字段
font_styleArrayJSON FormatOptaion{"name":"Arial"}word文档的格式设置,JSON格式,示例:
{"name": "Microsoft Yahei UI", "size": 20, "color": "#ff6600", "bold": true}
格式配置:
  • name:字体,如微软雅黑为Microsoft Yahei UI,又如Arial
  • size:字体大小,例如14、20、22
  • color:字体颜色,如黑色为#000000
  • bgColor:字体背景色,例如#FF0000
  • bold:是否为粗体,布尔值
  • italic:是否为斜体,布尔值

API Debug

KEYREQUIREDVALUE
app_key *Required
model_name *Required
db_mark *Required
id *Required
title Option
tpl Option
font_style Option

API Response

KEYTypeDescription
err_codeInt状态操作码,0成功,注意,仅当成功时才可下载word文档,失败时依然以接口JSON结果返回。;1开发类错误,获取失败(符合表字段要求,或表字段不存在);3获取失败(数据已删除或不存在)
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