请求访问API

组件配置的requestAccessAPIs定义组件可以访问的后端API。

系统中包含的后端API包括：

1. queryItems，查询数据表/数据集数据。如下拉框可以按层次列出选择的数据集数据。
2. searchItems，搜索数据表/数据集数据。如快速搜索框可以使用关键字搜索指定的字段。
3. exportData，导出组件查询数据。如列表可以导出不分页的查询结果。
4. upload，上传附件。如附件组件可以上传附件。

配置支持直接使用类型和JSON配置两种方式。

1. 使用类型配置时，系统默认查找约定的属性名称构造API访问信息。
2. 使用JSON配置时，可以自定义API访问信息。

{
    "requestAccessAPIs": [ "queryItems", { "type": "searchItems", "searchFieldsProperty": "searchFields" } ]
}

queryItems

查询数据表/数据集数据。API包含如下能力：

• 按层次查询数据。
• 按关键字搜索数据。
• 通过ID查找数据。
• 通过文字查找数据。

配置信息如下：

{
    "type": "queryItems",
    "itemFilterProperty": "...",
    "showRootPathProperty": "...",
    "enableSearchProperty": "...",
    "showCountProperty": "...",
    "sortProperty": "..."
}

属性名	类型	描述
itemFilterProperty	string	选项过滤属性名，默认为itemFilter。
showRootPathProperty	string	显示根路径属性名，默认为showRootPath。
enableSearchProperty	string	启用搜索属性名，默认为enableSearch。
showCountProperty	string	显示统计数属性名，默认为showCount。
sortProperty	string	选项排序属性名，默认为sort。

参考

• 指南：选择列表。

searchItems

搜索数据表/数据集数据。API包含如下能力：

• 按关键字搜索指定的一个或多个字段。
• 搜索结果可以返回指定的一个或多个字段。

配置信息如下：

{
    "type": "searchItems",
    "searchFieldsProperty": "...",
    "outputFieldsProperty": "...",
    "limitProperty": "..."
}

属性名	类型	描述
searchFieldsProperty	string	搜索字段属性名，默认为searchFields。
showRootPathProperty	string	输出字段属性名，默认为showRootPath。
limitProperty	string	搜索结果条数属性名，默认为limit。

参考

• 指南：搜索框。

exportData

导出组件定义的查询数据为excel文件。如果组件有多个查询，则每个sheet一个查询结果。

参考

• 指南：D3柱形图。

upload

上传文件。

配置信息如下：

{
    "type": "upload",
    "saveTypeProperty": "...",
    "submitFieldProperty": "...",
    "genMD5Property": "...",
    "fileMaxSizeProperty": "...",
    "fileTypesProperty": "..."
}

属性名	类型	描述
saveTypeProperty	string	附件存储方式属性名，默认为saveType。
submitFieldProperty	string	提交字段属性名，默认为submitField。
genMD5Property	string	是否生成附件的MD5属性名，默认为genMD5。
fileMaxSizeProperty	string	附件大小属性名，默认为fileMaxSize。
fileTypesProperty	string	文件类型属性名，默认为fileTypes。

参考

• 指南：文件上传。