# API 完整参考 ## PortalAPI 方法清单 ### 门户 CRUD | AIBridge 方法 | HTTP | 路径 | 说明 | |---------------|------|------|------| | `get_list(data)` | GET | `/api/visualdev/Portal` | 获取门户列表 | | `get_info(portal_id)` | GET | `/api/visualdev/Portal/{id}` | 获取门户详情 | | `create(data)` | POST | `/api/visualdev/Portal` | 创建门户 | | `update(data)` | PUT | `/api/visualdev/Portal/{id}` | 更新门户 | | `delete(portal_id)` | DELETE | `/api/visualdev/Portal/{id}` | 删除门户 | ### 门户操作 | AIBridge 方法 | HTTP | 路径 | 说明 | |---------------|------|------|------| | `copy(portal_id)` | POST | `/api/visualdev/Portal/{id}/Actions/Copy` | 复制门户 | | `export_portal(portal_id)` | POST | `/api/visualdev/Portal/{id}/Actions/Export` | 导出门户 | | `release(portal_id, data)` | PUT | `/api/visualdev/Portal/Actions/release/{id}` | 发布门户 | | `set_default(portal_id)` | PUT | `/api/visualdev/Portal/{id}/Actions/SetDefault` | 设置默认门户 | | `get_auth_portal(portal_id, data)` | GET | `/api/visualdev/Portal/{id}/auth` | 获取权限数据 | | `update_custom_portal(portal_id, data)` | PUT | `/api/visualdev/Portal/Custom/Save/{id}` | 更新自定义布局 | ### 选择器 | AIBridge 方法 | HTTP | 路径 | 说明 | |---------------|------|------|------| | `get_selector(type_, system_id)` | GET | `/api/visualdev/Portal/Selector` | 获取下拉列表 | | `get_home_portal_list()` | GET | `/api/visualdev/Portal/Selector/Menu` | 获取首页门户 | | `get_system_filter(data, id_)` | GET | `/api/visualdev/Portal/systemFilter/{id}` | 获取系统过滤列表 | ### 仪表盘 | AIBridge 方法 | HTTP | 路径 | 说明 | |---------------|------|------|------| | `get_notice_list(data)` | POST | `/api/visualdev/Dashboard/Notice` | 获取通知公告 | | `get_email_list()` | GET | `/api/visualdev/Dashboard/Email` | 获取未读邮件 | ### 门户管理 | AIBridge 方法 | HTTP | 路径 | 说明 | |---------------|------|------|------| | `get_manage_list(data)` | GET | `/api/system/PortalManage/list/{systemId}` | 获取管理列表 | | `get_manage_selector(data)` | GET | `/api/visualdev/Portal/manage/Selector/{systemId}` | 获取名称列表 | | `get_manage_info(manage_id)` | GET | `/api/system/PortalManage/{id}` | 获取管理详情 | | `create_manage(data)` | POST | `/api/system/PortalManage` | 创建管理 | | `update_manage(data)` | PUT | `/api/system/PortalManage/{id}` | 更新管理 | | `delete_manage(manage_id)` | DELETE | `/api/system/PortalManage/{id}` | 删除管理 | ### 地图 | AIBridge 方法 | HTTP | 路径 | 说明 | |---------------|------|------|------| | `get_atlas()` | GET | `/api/system/atlas` | 获取全国省市区 | | `get_map_data(data)` | GET | `/api/system/atlas/geojson` | 获取地图JSON | --- ## 方法签名与示例 ### get_list(data: dict = None) ```python # 获取门户列表(分页) resp = client.portal.get_list({ "currentPage": 1, "pageSize": 20, "keyword": "", "type": "model", "systemId": "system_xxx" }) # GET /api/visualdev/Portal?currentPage=1&pageSize=20&keyword=&type=model&systemId=system_xxx ``` ### get_info(portal_id: str) ```python # 获取门户详情 resp = client.portal.get_info("584307160905678853") # GET /api/visualdev/Portal/584307160905678853 ``` ### create(data: dict) ```python # 创建门户 resp = client.portal.create({ "fullName": "销售看板", "enCode": "sales_dashboard", "type": 0, "systemId": "system_xxx", "state": 1, "category": "", "enabledLock": 0 }) # POST /api/visualdev/Portal ``` ### update(data: dict) ```python # 更新门户 resp = client.portal.update({ "id": "portal_xxx", "fullName": "销售看板(更新)", "formData": '{"layoutId":100,"layout":[]}' }) # PUT /api/visualdev/Portal/portal_xxx ``` ### delete(portal_id: str) ```python # 删除门户 resp = client.portal.delete("portal_xxx") # DELETE /api/visualdev/Portal/portal_xxx ``` ### copy(portal_id: str) ```python # 复制门户 resp = client.portal.copy("584307160905678853") # POST /api/visualdev/Portal/584307160905678853/Actions/Copy ``` ### export_portal(portal_id: str) ```python # 导出门户 resp = client.portal.export_portal("584307160905678853") # POST /api/visualdev/Portal/584307160905678853/Actions/Export ``` ### release(portal_id: str, data: dict = None) ```python # 发布门户 resp = client.portal.release("portal_xxx", { "systemId": "system_xxx" }) # PUT /api/visualdev/Portal/Actions/release/portal_xxx ``` ### set_default(portal_id: str) ```python # 设置默认门户 resp = client.portal.set_default("portal_xxx") # PUT /api/visualdev/Portal/portal_xxx/Actions/SetDefault?platform=Web ``` ### get_auth_portal(portal_id: str, data: dict = None) ```python # 获取权限数据 resp = client.portal.get_auth_portal("portal_xxx", { "platform": "Web" }) # GET /api/visualdev/Portal/portal_xxx/auth?platform=Web ``` ### update_custom_portal(portal_id: str, data: dict) ```python # 用户自定义保存 resp = client.portal.update_custom_portal("portal_xxx", { "formData": '{"layoutId":100,"layout":[]}' }) # PUT /api/visualdev/Portal/Custom/Save/portal_xxx ``` ### get_selector(type_: str = None, system_id: str = None) ```python # 获取门户下拉选项 resp = client.portal.get_selector(type_="model", system_id="system_xxx") # GET /api/visualdev/Portal/Selector?platform=Web&type=model&systemId=system_xxx ``` ### get_home_portal_list() ```python # 获取应用首页门户列表 resp = client.portal.get_home_portal_list() # GET /api/visualdev/Portal/Selector/Menu ``` ### get_system_filter(data: dict, id_: str) ```python # 获取应用列表(发布过滤) resp = client.portal.get_system_filter({"systemId": "system_xxx"}, "portal_xxx") # GET /api/visualdev/Portal/systemFilter/portal_xxx?systemId=system_xxx ``` ### get_notice_list(data: dict) ```python # 获取通知公告 resp = client.portal.get_notice_list({ "size": 5 }) # POST /api/visualdev/Dashboard/Notice ``` ### get_email_list() ```python # 获取未读邮件 resp = client.portal.get_email_list() # GET /api/visualdev/Dashboard/Email ``` ### get_manage_list(data: dict) ```python # 获取门户管理列表 resp = client.portal.get_manage_list({ "systemId": "system_xxx" }) # GET /api/system/PortalManage/list/system_xxx ``` ### get_manage_info(manage_id: str) ```python # 获取门户管理详情 resp = client.portal.get_manage_info("manage_xxx") # GET /api/system/PortalManage/manage_xxx ``` ### create_manage(data: dict) ```python # 创建门户管理 resp = client.portal.create_manage({ "portalId": "portal_xxx", "systemId": "system_xxx", "homeShow": 1, "defaultPortal": 0, "sort": 1, "enabled": 1 }) # POST /api/system/PortalManage ``` ### update_manage(data: dict) ```python # 更新门户管理 resp = client.portal.update_manage({ "id": "manage_xxx", "portalId": "portal_xxx", "systemId": "system_xxx", "homeShow": 1, "defaultPortal": 1 }) # PUT /api/system/PortalManage/manage_xxx ``` ### delete_manage(manage_id: str) ```python # 删除门户管理 resp = client.portal.delete_manage("manage_xxx") # DELETE /api/system/PortalManage/manage_xxx ``` ### get_atlas() ```python # 获取全国省市区 resp = client.portal.get_atlas() # GET /api/system/atlas ``` ### get_map_data(data: dict) ```python # 获取地图JSON resp = client.portal.get_map_data({ "code": "100000" }) # GET /api/system/atlas/geojson?code=100000 ``` --- ## 响应格式 所有方法返回 `APIResponse` 对象: ```python resp = client.portal.get_list() print(resp.code) # 200 print(resp.msg) # "操作成功" print(resp.data) # 实际数据 print(resp.success) # True ``` 分页数据: ```python { "code": 200, "data": { "list": [...], "pagination": { "currentPage": 1, "pageSize": 20, "total": 100 } }, "msg": "操作成功" } ```