配置用于构建 FastReport 在线设计器的 API(上)
配置用于构建 FastReport 在线设计器的 API(下)
| 设置 | |
| 值 | 说明 |
| features | 数据类型:数组 |
| 请参阅特征表中的值列表。 | |
| entryName | 数据类型:对象 |
{ "name": "index", "ext": "html" } | |
| publicPath | 数据类型:字符串。 |
| 服务器上应用程序的公共路径。 | |
| saveSuccessRedirect | 数据类型:对象。 |
{ "url": null, "blank": false, "useParent": false, "removeConfirmation": true } | |
| customFonts | 字体链接 |
| API | 数据类型:数组 |
请参阅 API 表中的值 列表。 | |
| 功能 | |
{ "name": "SHOW_BAND_TITLE", "enabled": true } | |
| 对象包含特征键和复选框 | |
| 值 | 描述 |
| SHOW_BAND_TITLE | 频段名称 |
| ADD_BANDS | 添加频段 |
| SORT_BANDS | 排序频段 |
| RESIZE_BANDS | 调整频段大小 |
| CONFIRM_BEFORE_EXIT | 退出前确认 |
| MOVABLE_POPUPS | 可移动弹出窗口 |
| REVISION_FILES | 文件名中的Hash值 |
| MINIFY | 代码最小化 |
| ENABLE_PREVIEW_BUTTON | 预览按钮 |
| READONLY_MODE | 禁用编辑 |
| AUTOSAVE | 自动保存 |
| API | |
{ "name": "API_SAVE_REPORT", "value": "../FastReport.Export.axd?putReport=#{id}" } | |
| 对象包含一个 API 密钥和一个链接 | |
| 值 | 描述 |
| API_SAVE_REPORT | 保存报告 |
| API_MAKE_PREVIEW | 报告预览 |
| API_GET_REPORT | 获取报告 |
| API_GET_FUNCTIONS | 获取功能 |
| API_GET_CUSTOM_CONFIG | 应用程序配置 |
| API_GET_CONNECTION_TYPES | 连接类型 |
| API_GET_CONNECTION_TABLES | 连接表 |
| API_GET_CONNECTION_STRING_PROPERTIES | 连接字符串属性 |
| API_MAKE_CONNECTION_STRING | 创建连接字符串 |
| API_GET_MSCHART_TEMPLATE | MSChart 模板 |
请求构建后,您将获得一个 UUID 以检查其状态。响应示例
{
"message": "Successfully queued",
"code": 0,
"payload": {
"UUID": "25d36576-c5e2-49f4-8ab0-73838c457336"
}
}
检查构建状态
要检查构建状态,请向以下地址发出 GET 请求:
https://dsg2014.fast-report.com:3000/builderAPI/checkBuild/{apiKey}/{buildUUID}
链接中应包含用于构建的 API 密钥和请求时获得的 UUID。
根据构建阶段的不同,您可以在响应中看到几种状态。
1 (QUEUED) -编译已排定,现在处于队列中。
2(PROCESSING)--构建已开始,但仍在处理中。
3 (BUILT) -已完成,可以下载。
响应示例:
{
"code": 0,
"payload": {
"statusCode": 2,
"statusText": "PROCESSING"
}
}
如果构建完成,您将在回复中收到一个下载链接。
下载最新版本
要下载已构建的应用程序,请向以下地址发出 GET 请求
https://dsg2014.fast-report.com:3000/builderAPI/download/{apiKey}
在链接中指定您的 API 密钥。收到请求后,您将收到一个包含已构建应用程序的压缩文件。
获取 FastReport Online Designer 的当前版本
发出 GET 请求以获取应用程序的当前版本:
https://dsg2014.fast-report.com:3000/builderAPI/designer-version/{apiKey}
在链接中指定您的 API 密钥。您将收到 FastReport Online Designer 当前版本的响应。响应示例:
{
"payload": {
"version": "2023.1.3"
},
"code": 0
}
我们的团队将继续改善客户使用 FastReport 产品的体验。如有任何问题,请联系我们的支持人员。
配置用于构建 FastReport 在线设计器的 API(上)
配置用于构建 FastReport 在线设计器的 API(下)
渝公网安备50010702505508