OkayAPI API: App.SuperTable.GetDocx

OkayAPI Docs

API Path: /api/App/SuperTable/GetDocx

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

API Traffic

HTTP/HTTPS

Protocol

GET/POST

Method

UTF-8

Charset

JSON

Response

Parameter	Type	Required	Default	Note	Description
HTTP_APPKEY	String	Required		MIN: 32	Common Put Your APPKEY
model_name	String	Required			数据库表名
database	String	Optaion	super		自己的数据库配置标记，注意！这是数据库的配置标识，不是数据库的名称。默认使用super，不用传。如果需要配置多个数据库时，可与小白技术人员联系。重要事情说三遍，这是数据配置标识，不是数据库名称。使用此接口前，请先进入：数据库直连服务配置。
id	Int	Required		MIN: 1	数据ID，例如：1，2，3，……
title	String	Optaion			word文档标题及文件名
tpl	String	Optaion			word文档的模板，表单字段点位符为：`{{字段名}}`。例如： ID为`{{id}}`，更新时间为`{{update_time}}`，创建时间`{{add_time}}`，特别地，换行为`{{\n}}`。未设置模板时，默认显示全部字段，一行一个字段
font_style	ArrayJSON Format	Optaion	{"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：是否为斜体，布尔值

Submit Type:

Form Data

JSON RAW(application/json;charset=UTF-8)

JSON RAW

KEY	Type	Description
err_code	Int	状态操作码，0成功，注意，仅当成功时才可下载word文档，失败时依然以接口JSON结果返回。；1开发类错误，获取失败(符合表字段要求，或表字段不存在)；2应用层规则拦截，拦截后可以小白开放平台查看日记；3获取失败(数据已删除或不存在)
err_msg	String	错误提示信息，err_code非0时参考此提示信息