设计时全局搜索(GlobalSearchController)¶
按关键字在指定应用下全局检索设计元素(表单、视图、流程、脚本等),供设计器顶部全局搜索框使用。
- 接口类型:REST 资源
- 基址:
${myapps.context-path.designer:}/api/designtime/applications(类级@RequestMapping,produces = APPLICATION_JSON_VALUE) - Tag:设计时全局查询
公共说明¶
- 鉴权:是(需 designerToken)。控制器继承自
AbstractDesignTimeController(基类为@RestController)。鉴权机制详见 index.md「鉴权说明」。 - 路径变量:
{applicationId}为**明文设计时 ID**。 - 响应:统一
Resource(见 ../index.md「统一响应结构」)。成功errcode=0;keyword为空或非法参数返回errcode=40001;其他异常errcode=500。 - HTTP 方法:受
CommonSecurityFilter限制,仅允许GET/POST/HEAD/OPTIONS。
1. 软件内全局查询设计元素¶
按 keyword 在指定软件(应用)下全局检索设计元素,返回匹配结果集合。
- 接口类型:REST 资源
- 请求方式:
GET - 请求路径:
/{applicationId}/search(完整:{designer-context}/api/designtime/applications/{applicationId}/search) - 鉴权:是(需 designerToken)
- Tag:设计时全局查询
请求参数¶
| 参数名 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
| applicationId | path | string | 是 | 软件 id |
| keyword | query | string | 是 | 查询文本(为空返回 errcode=40001) |
请求示例¶
响应¶
结构:统一 Resource(见 ../index.md「统一响应结构」)。
data:搜索结果集合(由 GlobalSearchDesignTimeService.search 返回,结构视命中元素类型而定,含元素 id/名称/类型/所属模块等)。
成功示例:
{
"errcode": 0,
"errmsg": "ok",
"data": [
{ "id": "...", "name": "...", "type": "...", "...": "..." }
],
"errors": null
}