OkayAPI Docs


API Path: /api/App/Table/GetDocx

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

4
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_nameStringRequiredYour table Model Name
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
id *Required
title Option
tpl Option
font_style Option

API Response

KEYTypeDescription
err_codeInt状态操作码,0成功,注意,仅当成功时才可下载word文档,失败时依然以接口JSON结果返回。;1开发类错误,获取失败(符合表字段要求,或表字段不存在);2应用层规则拦截,拦截后可以小白开放平台查看日记;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