{ "components": { "schemas": { "AccessContextResponse": { "properties": { "is_system_admin": { "title": "Is System Admin", "type": "boolean" }, "permissions": { "items": { "type": "string" }, "title": "Permissions", "type": "array" }, "project_id": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ], "title": "Project Id" }, "project_role": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Project Role" }, "system_role": { "title": "System Role", "type": "string" }, "user_id": { "format": "uuid", "title": "User Id", "type": "string" }, "username": { "title": "Username", "type": "string" } }, "required": [ "user_id", "username", "system_role", "is_system_admin", "permissions" ], "title": "AccessContextResponse", "type": "object" }, "AdminProjectCreateRequest": { "properties": { "code": { "maxLength": 50, "minLength": 1, "title": "Code", "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "gs_workspace": { "maxLength": 100, "minLength": 1, "title": "Gs Workspace", "type": "string" }, "map_extent": { "anyOf": [ { "type": "object" }, { "type": "null" } ], "title": "Map Extent" }, "name": { "maxLength": 100, "minLength": 1, "title": "Name", "type": "string" }, "status": { "default": "active", "enum": [ "active", "inactive", "archived" ], "title": "Status", "type": "string" } }, "required": [ "name", "code", "gs_workspace" ], "title": "AdminProjectCreateRequest", "type": "object" }, "AdminProjectResponse": { "properties": { "code": { "title": "Code", "type": "string" }, "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "gs_workspace": { "title": "Gs Workspace", "type": "string" }, "map_extent": { "anyOf": [ { "type": "object" }, { "type": "null" } ], "title": "Map Extent" }, "name": { "title": "Name", "type": "string" }, "project_id": { "format": "uuid", "title": "Project Id", "type": "string" }, "status": { "title": "Status", "type": "string" }, "updated_at": { "format": "date-time", "title": "Updated At", "type": "string" } }, "required": [ "project_id", "name", "code", "gs_workspace", "status", "created_at", "updated_at" ], "title": "AdminProjectResponse", "type": "object" }, "AdminProjectUpdateRequest": { "properties": { "code": { "anyOf": [ { "maxLength": 50, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Code" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "gs_workspace": { "anyOf": [ { "maxLength": 100, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Gs Workspace" }, "map_extent": { "anyOf": [ { "type": "object" }, { "type": "null" } ], "title": "Map Extent" }, "name": { "anyOf": [ { "maxLength": 100, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Name" }, "status": { "anyOf": [ { "enum": [ "active", "inactive", "archived" ], "type": "string" }, { "type": "null" } ], "title": "Status" } }, "title": "AdminProjectUpdateRequest", "type": "object" }, "AgentAuthContextResponse": { "properties": { "is_superuser": { "title": "Is Superuser", "type": "boolean" }, "keycloak_sub": { "title": "Keycloak Sub", "type": "string" }, "network": { "title": "Network", "type": "string" }, "permissions": { "items": { "type": "string" }, "title": "Permissions", "type": "array" }, "project_id": { "title": "Project Id", "type": "string" }, "project_role": { "title": "Project Role", "type": "string" }, "role": { "title": "Role", "type": "string" }, "token_expires_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Token Expires At" }, "user_id": { "title": "User Id", "type": "string" }, "username": { "title": "Username", "type": "string" } }, "required": [ "user_id", "keycloak_sub", "username", "role", "is_superuser", "project_id", "network", "project_role", "permissions" ], "title": "AgentAuthContextResponse", "type": "object" }, "AuditLogResponse": { "description": "审计日志响应", "properties": { "action": { "title": "Action", "type": "string" }, "id": { "format": "uuid", "title": "Id", "type": "string" }, "ip_address": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ip Address" }, "project_id": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ], "title": "Project Id" }, "request_data": { "anyOf": [ { "type": "object" }, { "type": "null" } ], "title": "Request Data" }, "request_method": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Request Method" }, "request_path": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Request Path" }, "resource_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Resource Id" }, "resource_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Resource Type" }, "response_status": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Response Status" }, "timestamp": { "format": "date-time", "title": "Timestamp", "type": "string" }, "user_id": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ], "title": "User Id" } }, "required": [ "id", "user_id", "project_id", "action", "resource_type", "resource_id", "ip_address", "request_method", "request_path", "request_data", "response_status", "timestamp" ], "title": "AuditLogResponse", "type": "object" }, "Body_patch_admin_projects_project_id_model_imports": { "properties": { "file": { "description": "桌面端导出的 INP 模型文件", "format": "binary", "title": "File", "type": "string" } }, "required": [ "file" ], "title": "Body_patch_admin_projects_project_id_model_imports", "type": "object" }, "Body_post_admin_projects_project_id_model_imports": { "properties": { "file": { "description": "桌面端导出的 INP 模型文件", "format": "binary", "title": "File", "type": "string" } }, "required": [ "file" ], "title": "Body_post_admin_projects_project_id_model_imports", "type": "object" }, "Body_post_timeseries_realtime_simulation_results": { "properties": { "link_result_list": { "description": "管道模拟结果列表", "items": { "type": "object" }, "title": "Link Result List", "type": "array" }, "node_result_list": { "description": "节点模拟结果列表", "items": { "type": "object" }, "title": "Node Result List", "type": "array" } }, "required": [ "node_result_list", "link_result_list" ], "title": "Body_post_timeseries_realtime_simulation_results", "type": "object" }, "Body_post_timeseries_schemes_simulation_results": { "properties": { "link_result_list": { "description": "管道模拟结果列表", "items": { "type": "object" }, "title": "Link Result List", "type": "array" }, "node_result_list": { "description": "节点模拟结果列表", "items": { "type": "object" }, "title": "Node Result List", "type": "array" } }, "required": [ "node_result_list", "link_result_list" ], "title": "Body_post_timeseries_schemes_simulation_results", "type": "object" }, "BurstDetectionRequestRest": { "properties": { "data_source": { "default": "monitoring", "description": "数据来源:monitoring(监测)或simulation(模拟)", "title": "Data Source", "type": "string" }, "iforest_params": { "anyOf": [ { "type": "object" }, { "type": "null" } ], "description": "隔离森林算法参数", "title": "Iforest Params" }, "mu": { "default": 100, "description": "异常值检测的参数", "title": "Mu", "type": "integer" }, "observed_pressure_data": { "anyOf": [ { "additionalProperties": { "items": {}, "type": "array" }, "type": "object" }, { "items": { "type": "object" }, "type": "array" }, { "items": { "items": {}, "type": "array" }, "type": "array" }, { "type": "null" } ], "description": "压力观测数据。支持列式字典 {sensor_id: [values,...]}、逐时刻对象数组 [{sensor_id: value,...}, ...]、或二维数组 [[t1_s1, t1_s2], [t2_s1, t2_s2], ...]。", "title": "Observed Pressure Data" }, "points_per_day": { "default": 1440, "description": "每天的数据点数", "title": "Points Per Day", "type": "integer" }, "sampling_interval_minutes": { "anyOf": [ { "maximum": 1440.0, "minimum": 1.0, "type": "integer" }, { "type": "null" } ], "description": "采样间隔(分钟);为空时根据压力 SCADA 传输频率自动推断", "title": "Sampling Interval Minutes" }, "scada_end": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "SCADA数据结束时间", "title": "Scada End" }, "scada_start": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "SCADA数据起始时间", "title": "Scada Start" }, "scheme_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "方案名称", "title": "Scheme Name" }, "sensor_nodes": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "传感器节点列表", "title": "Sensor Nodes" }, "simulation_scheme_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "模拟方案名称", "title": "Simulation Scheme Name" }, "simulation_scheme_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "模拟方案类型", "title": "Simulation Scheme Type" }, "target_time": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "目标侦测时刻;为空时自动使用最近一个完整的监测时刻", "title": "Target Time" } }, "title": "BurstDetectionRequestRest", "type": "object" }, "BurstLocationRequestRest": { "properties": { "basic_pressure": { "default": 10.0, "description": "基准压力(bar)", "title": "Basic Pressure", "type": "number" }, "burst_flow": { "anyOf": [ { "additionalProperties": { "type": "number" }, "type": "object" }, { "items": { "type": "object" }, "type": "array" }, { "type": "null" } ], "description": "爆管时的流量数据", "title": "Burst Flow" }, "burst_leakage": { "description": "爆管时的漏水量", "title": "Burst Leakage", "type": "number" }, "burst_pressure": { "anyOf": [ { "additionalProperties": { "type": "number" }, "type": "object" }, { "items": { "type": "object" }, "type": "array" }, { "type": "null" } ], "description": "爆管时的压力数据", "title": "Burst Pressure" }, "data_source": { "default": "monitoring", "description": "数据来源:monitoring(监测)或simulation(模拟)", "enum": [ "monitoring", "simulation" ], "title": "Data Source", "type": "string" }, "flow_scada_ids": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "流量SCADA传感器ID列表", "title": "Flow Scada Ids" }, "min_dpressure": { "default": 2.0, "description": "最小压力差(bar)", "title": "Min Dpressure", "type": "number" }, "normal_flow": { "anyOf": [ { "additionalProperties": { "type": "number" }, "type": "object" }, { "items": { "type": "object" }, "type": "array" }, { "type": "null" } ], "description": "正常时的流量数据", "title": "Normal Flow" }, "normal_pressure": { "anyOf": [ { "additionalProperties": { "type": "number" }, "type": "object" }, { "items": { "type": "object" }, "type": "array" }, { "type": "null" } ], "description": "正常时的压力数据", "title": "Normal Pressure" }, "pressure_scada_ids": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "压力SCADA传感器ID列表", "title": "Pressure Scada Ids" }, "scada_burst_end": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "爆管/模拟方案结束时间", "title": "Scada Burst End" }, "scada_burst_start": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "爆管/模拟方案开始时间", "title": "Scada Burst Start" }, "scada_normal_end": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "监测数据正常工况结束时间", "title": "Scada Normal End" }, "scada_normal_start": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "监测数据正常工况开始时间", "title": "Scada Normal Start" }, "scheme_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "方案名称", "title": "Scheme Name" }, "simulation_scheme_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "模拟方案名称", "title": "Simulation Scheme Name" }, "simulation_scheme_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "模拟方案类型", "title": "Simulation Scheme Type" }, "use_scada_flow": { "default": false, "description": "是否使用SCADA流量数据", "title": "Use Scada Flow", "type": "boolean" } }, "required": [ "burst_leakage" ], "title": "BurstLocationRequestRest", "type": "object" }, "DailySchedulingAnalysisRest": { "properties": { "pump_control": { "description": "泵控制策略", "title": "Pump Control", "type": "object" }, "reservoir_id": { "description": "水库ID", "title": "Reservoir Id", "type": "string" }, "start_time": { "description": "开始时间", "title": "Start Time", "type": "string" }, "tank_id": { "description": "水箱ID", "title": "Tank Id", "type": "string" }, "time_delta": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": 300, "description": "时间步长 (秒)", "title": "Time Delta" }, "water_plant_output_id": { "description": "水厂出水ID", "title": "Water Plant Output Id", "type": "string" } }, "required": [ "start_time", "pump_control", "reservoir_id", "tank_id", "water_plant_output_id" ], "title": "DailySchedulingAnalysisRest", "type": "object" }, "JsonValue": {}, "LeakageIdentifyRequestRest": { "properties": { "dma_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "DMA区域数量", "title": "Dma Count" }, "duration": { "default": 24, "description": "持续时间(小时)", "title": "Duration", "type": "number" }, "max_gen": { "default": 100, "description": "最大代数", "title": "Max Gen", "type": "integer" }, "n_workers": { "default": 4, "description": "工作线程数", "title": "N Workers", "type": "integer" }, "observed_pressure_data": { "anyOf": [ { "type": "string" }, { "additionalProperties": { "items": {}, "type": "array" }, "type": "object" }, { "items": { "type": "object" }, "type": "array" }, { "type": "null" } ], "description": "观测的压力数据", "title": "Observed Pressure Data" }, "output_dir": { "default": "db_inp", "description": "输出目录", "title": "Output Dir", "type": "string" }, "output_flow_unit": { "default": "m3/s", "description": "输出流量单位", "title": "Output Flow Unit", "type": "string" }, "pop_size": { "default": 50, "description": "种群大小", "title": "Pop Size", "type": "integer" }, "q_sum": { "default": 0.2, "description": "总流量(m3/s)", "title": "Q Sum", "type": "number" }, "q_sum_unit": { "default": "m3/s", "description": "流量单位", "title": "Q Sum Unit", "type": "string" }, "scada_end": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "SCADA数据结束时间", "title": "Scada End" }, "scada_start": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "SCADA数据起始时间", "title": "Scada Start" }, "scheme_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "方案名称", "title": "Scheme Name" }, "sensor_nodes": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "传感器节点列表", "title": "Sensor Nodes" }, "start_time": { "default": 0, "description": "起始时间(小时)", "title": "Start Time", "type": "number" }, "timestep": { "default": 5, "description": "时间步长(分钟)", "title": "Timestep", "type": "number" } }, "title": "LeakageIdentifyRequestRest", "type": "object" }, "MetadataUserResponse": { "properties": { "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "email": { "title": "Email", "type": "string" }, "id": { "format": "uuid", "title": "Id", "type": "string" }, "is_active": { "title": "Is Active", "type": "boolean" }, "is_superuser": { "title": "Is Superuser", "type": "boolean" }, "keycloak_id": { "format": "uuid", "title": "Keycloak Id", "type": "string" }, "last_login_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Last Login At" }, "role": { "title": "Role", "type": "string" }, "updated_at": { "format": "date-time", "title": "Updated At", "type": "string" }, "username": { "title": "Username", "type": "string" } }, "required": [ "id", "keycloak_id", "username", "email", "role", "is_active", "is_superuser", "created_at", "updated_at" ], "title": "MetadataUserResponse", "type": "object" }, "MetadataUserSyncRequest": { "properties": { "email": { "maxLength": 100, "minLength": 1, "title": "Email", "type": "string" }, "is_active": { "default": true, "title": "Is Active", "type": "boolean" }, "keycloak_id": { "format": "uuid", "title": "Keycloak Id", "type": "string" }, "role": { "default": "user", "enum": [ "admin", "user" ], "title": "Role", "type": "string" }, "username": { "maxLength": 50, "minLength": 1, "title": "Username", "type": "string" } }, "required": [ "keycloak_id", "username", "email" ], "title": "MetadataUserSyncRequest", "type": "object" }, "MetadataUserSyncResult": { "properties": { "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error" }, "keycloak_id": { "format": "uuid", "title": "Keycloak Id", "type": "string" }, "success": { "title": "Success", "type": "boolean" }, "user": { "anyOf": [ { "$ref": "#/components/schemas/MetadataUserResponse" }, { "type": "null" } ] } }, "required": [ "keycloak_id", "success" ], "title": "MetadataUserSyncResult", "type": "object" }, "MetadataUserUpdateRequest": { "properties": { "is_active": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Active" }, "role": { "anyOf": [ { "enum": [ "admin", "user" ], "type": "string" }, { "type": "null" } ], "title": "Role" } }, "title": "MetadataUserUpdateRequest", "type": "object" }, "MetadataUsersBatchSyncRequest": { "properties": { "users": { "items": { "$ref": "#/components/schemas/MetadataUserSyncRequest" }, "maxItems": 500, "minItems": 1, "title": "Users", "type": "array" } }, "required": [ "users" ], "title": "MetadataUsersBatchSyncRequest", "type": "object" }, "Page_AdminProjectResponse_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/AdminProjectResponse" }, "title": "Items", "type": "array" }, "limit": { "title": "Limit", "type": "integer" }, "offset": { "title": "Offset", "type": "integer" }, "total": { "title": "Total", "type": "integer" } }, "required": [ "items", "total", "limit", "offset" ], "title": "Page[AdminProjectResponse]", "type": "object" }, "Page_AuditLogResponse_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/AuditLogResponse" }, "title": "Items", "type": "array" }, "limit": { "title": "Limit", "type": "integer" }, "offset": { "title": "Offset", "type": "integer" }, "total": { "title": "Total", "type": "integer" } }, "required": [ "items", "total", "limit", "offset" ], "title": "Page[AuditLogResponse]", "type": "object" }, "Page_MetadataUserResponse_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/MetadataUserResponse" }, "title": "Items", "type": "array" }, "limit": { "title": "Limit", "type": "integer" }, "offset": { "title": "Offset", "type": "integer" }, "total": { "title": "Total", "type": "integer" } }, "required": [ "items", "total", "limit", "offset" ], "title": "Page[MetadataUserResponse]", "type": "object" }, "Page_MetadataUserSyncResult_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/MetadataUserSyncResult" }, "title": "Items", "type": "array" }, "limit": { "title": "Limit", "type": "integer" }, "offset": { "title": "Offset", "type": "integer" }, "total": { "title": "Total", "type": "integer" } }, "required": [ "items", "total", "limit", "offset" ], "title": "Page[MetadataUserSyncResult]", "type": "object" }, "Page_ProjectDatabaseResponse_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/ProjectDatabaseResponse" }, "title": "Items", "type": "array" }, "limit": { "title": "Limit", "type": "integer" }, "offset": { "title": "Offset", "type": "integer" }, "total": { "title": "Total", "type": "integer" } }, "required": [ "items", "total", "limit", "offset" ], "title": "Page[ProjectDatabaseResponse]", "type": "object" }, "Page_ProjectMemberResponse_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/ProjectMemberResponse" }, "title": "Items", "type": "array" }, "limit": { "title": "Limit", "type": "integer" }, "offset": { "title": "Offset", "type": "integer" }, "total": { "title": "Total", "type": "integer" } }, "required": [ "items", "total", "limit", "offset" ], "title": "Page[ProjectMemberResponse]", "type": "object" }, "Page_ProjectSummaryResponse_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/ProjectSummaryResponse" }, "title": "Items", "type": "array" }, "limit": { "title": "Limit", "type": "integer" }, "offset": { "title": "Offset", "type": "integer" }, "total": { "title": "Total", "type": "integer" } }, "required": [ "items", "total", "limit", "offset" ], "title": "Page[ProjectSummaryResponse]", "type": "object" }, "Page_dict_Any__Any__": { "properties": { "items": { "items": { "type": "object" }, "title": "Items", "type": "array" }, "limit": { "title": "Limit", "type": "integer" }, "offset": { "title": "Offset", "type": "integer" }, "total": { "title": "Total", "type": "integer" } }, "required": [ "items", "total", "limit", "offset" ], "title": "Page[dict[Any, Any]]", "type": "object" }, "Page_dict_str__Any__": { "properties": { "items": { "items": { "type": "object" }, "title": "Items", "type": "array" }, "limit": { "title": "Limit", "type": "integer" }, "offset": { "title": "Offset", "type": "integer" }, "total": { "title": "Total", "type": "integer" } }, "required": [ "items", "total", "limit", "offset" ], "title": "Page[dict[str, Any]]", "type": "object" }, "Page_dict_str__list_str___": { "properties": { "items": { "items": { "additionalProperties": { "items": { "type": "string" }, "type": "array" }, "type": "object" }, "title": "Items", "type": "array" }, "limit": { "title": "Limit", "type": "integer" }, "offset": { "title": "Offset", "type": "integer" }, "total": { "title": "Total", "type": "integer" } }, "required": [ "items", "total", "limit", "offset" ], "title": "Page[dict[str, list[str]]]", "type": "object" }, "Page_list_str__": { "properties": { "items": { "items": { "items": { "type": "string" }, "type": "array" }, "title": "Items", "type": "array" }, "limit": { "title": "Limit", "type": "integer" }, "offset": { "title": "Offset", "type": "integer" }, "total": { "title": "Total", "type": "integer" } }, "required": [ "items", "total", "limit", "offset" ], "title": "Page[list[str]]", "type": "object" }, "Page_str_": { "properties": { "items": { "items": { "type": "string" }, "title": "Items", "type": "array" }, "limit": { "title": "Limit", "type": "integer" }, "offset": { "title": "Offset", "type": "integer" }, "total": { "title": "Total", "type": "integer" } }, "required": [ "items", "total", "limit", "offset" ], "title": "Page[str]", "type": "object" }, "Page_tuple_int__str__": { "properties": { "items": { "items": { "maxItems": 2, "minItems": 2, "prefixItems": [ { "type": "integer" }, { "type": "string" } ], "type": "array" }, "title": "Items", "type": "array" }, "limit": { "title": "Limit", "type": "integer" }, "offset": { "title": "Offset", "type": "integer" }, "total": { "title": "Total", "type": "integer" } }, "required": [ "items", "total", "limit", "offset" ], "title": "Page[tuple[int, str]]", "type": "object" }, "PressureRegulationRest": { "properties": { "duration": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": 900, "description": "持续时间 (秒)", "title": "Duration" }, "pump_control": { "description": "泵控制策略", "title": "Pump Control", "type": "object" }, "scheme_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "方案名称", "title": "Scheme Name" }, "start_time": { "description": "开始时间", "title": "Start Time", "type": "string" }, "tank_init_level": { "anyOf": [ { "type": "object" }, { "type": "null" } ], "description": "水箱初始水位", "title": "Tank Init Level" } }, "required": [ "start_time", "pump_control" ], "title": "PressureRegulationRest", "type": "object" }, "PressureSensorPlacement": { "properties": { "min_diameter": { "default": 0, "description": "最小管径限制", "title": "Min Diameter", "type": "integer" }, "name": { "description": "管网名称(或数据库名称)", "title": "Name", "type": "string" }, "scheme_name": { "description": "方案名称", "title": "Scheme Name", "type": "string" }, "sensor_number": { "description": "传感器数量", "title": "Sensor Number", "type": "integer" }, "username": { "description": "用户名", "title": "Username", "type": "string" } }, "required": [ "name", "scheme_name", "sensor_number", "username" ], "title": "PressureSensorPlacement", "type": "object" }, "ProblemDetails": { "description": "RFC 9457 compatible error response used by the REST contract.", "properties": { "code": { "title": "Code", "type": "string" }, "detail": { "title": "Detail", "type": "string" }, "errors": { "items": { "type": "object" }, "title": "Errors", "type": "array" }, "instance": { "title": "Instance", "type": "string" }, "status": { "title": "Status", "type": "integer" }, "title": { "title": "Title", "type": "string" }, "trace_id": { "title": "Trace Id", "type": "string" }, "type": { "title": "Type", "type": "string" } }, "required": [ "type", "title", "status", "detail", "instance", "code", "trace_id" ], "title": "ProblemDetails", "type": "object" }, "ProjectDatabaseHealthRequest": { "properties": { "dsn": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Dsn" } }, "title": "ProjectDatabaseHealthRequest", "type": "object" }, "ProjectDatabaseHealthResponse": { "properties": { "db_role": { "title": "Db Role", "type": "string" }, "db_type": { "title": "Db Type", "type": "string" }, "detail": { "title": "Detail", "type": "string" }, "ok": { "title": "Ok", "type": "boolean" }, "project_id": { "format": "uuid", "title": "Project Id", "type": "string" } }, "required": [ "project_id", "db_role", "db_type", "ok", "detail" ], "title": "ProjectDatabaseHealthResponse", "type": "object" }, "ProjectDatabaseResponse": { "properties": { "db_role": { "title": "Db Role", "type": "string" }, "db_type": { "title": "Db Type", "type": "string" }, "has_dsn": { "title": "Has Dsn", "type": "boolean" }, "id": { "format": "uuid", "title": "Id", "type": "string" }, "pool_max_size": { "title": "Pool Max Size", "type": "integer" }, "pool_min_size": { "title": "Pool Min Size", "type": "integer" }, "project_id": { "format": "uuid", "title": "Project Id", "type": "string" } }, "required": [ "id", "project_id", "db_role", "db_type", "pool_min_size", "pool_max_size", "has_dsn" ], "title": "ProjectDatabaseResponse", "type": "object" }, "ProjectDatabaseUpsertRequest": { "properties": { "db_role": { "enum": [ "biz_data", "iot_data" ], "title": "Db Role", "type": "string" }, "dsn": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Dsn" }, "pool_max_size": { "default": 10, "minimum": 1.0, "title": "Pool Max Size", "type": "integer" }, "pool_min_size": { "default": 2, "minimum": 1.0, "title": "Pool Min Size", "type": "integer" } }, "required": [ "db_role" ], "title": "ProjectDatabaseUpsertRequest", "type": "object" }, "ProjectManagementRest": { "properties": { "pump_control": { "description": "泵控制策略", "title": "Pump Control", "type": "object" }, "region_demand": { "anyOf": [ { "type": "object" }, { "type": "null" } ], "description": "区域需水量控制", "title": "Region Demand" }, "start_time": { "description": "开始时间", "title": "Start Time", "type": "string" }, "tank_init_level": { "anyOf": [ { "type": "object" }, { "type": "null" } ], "description": "水箱初始水位", "title": "Tank Init Level" } }, "required": [ "start_time", "pump_control" ], "title": "ProjectManagementRest", "type": "object" }, "ProjectMemberCreateRequest": { "properties": { "project_role": { "default": "viewer", "enum": [ "member", "viewer" ], "title": "Project Role", "type": "string" }, "user_id": { "format": "uuid", "title": "User Id", "type": "string" } }, "required": [ "user_id" ], "title": "ProjectMemberCreateRequest", "type": "object" }, "ProjectMemberResponse": { "properties": { "email": { "title": "Email", "type": "string" }, "id": { "format": "uuid", "title": "Id", "type": "string" }, "is_active": { "title": "Is Active", "type": "boolean" }, "project_id": { "format": "uuid", "title": "Project Id", "type": "string" }, "project_role": { "title": "Project Role", "type": "string" }, "user_id": { "format": "uuid", "title": "User Id", "type": "string" }, "username": { "title": "Username", "type": "string" } }, "required": [ "id", "user_id", "project_id", "project_role", "username", "email", "is_active" ], "title": "ProjectMemberResponse", "type": "object" }, "ProjectMemberUpdateRequest": { "properties": { "project_role": { "enum": [ "member", "viewer" ], "title": "Project Role", "type": "string" } }, "required": [ "project_role" ], "title": "ProjectMemberUpdateRequest", "type": "object" }, "ProjectMetaResponse": { "properties": { "code": { "title": "Code", "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "gs_workspace": { "title": "Gs Workspace", "type": "string" }, "map_extent": { "anyOf": [ { "type": "object" }, { "type": "null" } ], "title": "Map Extent" }, "name": { "title": "Name", "type": "string" }, "project_id": { "format": "uuid", "title": "Project Id", "type": "string" }, "project_role": { "title": "Project Role", "type": "string" }, "status": { "title": "Status", "type": "string" } }, "required": [ "project_id", "name", "code", "gs_workspace", "status", "project_role" ], "title": "ProjectMetaResponse", "type": "object" }, "ProjectSummaryResponse": { "properties": { "code": { "title": "Code", "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "gs_workspace": { "title": "Gs Workspace", "type": "string" }, "name": { "title": "Name", "type": "string" }, "project_id": { "format": "uuid", "title": "Project Id", "type": "string" }, "project_role": { "title": "Project Role", "type": "string" }, "status": { "title": "Status", "type": "string" } }, "required": [ "project_id", "name", "code", "gs_workspace", "status", "project_role" ], "title": "ProjectSummaryResponse", "type": "object" }, "PumpFailureState": { "properties": { "pump_status": { "description": "泵状态字典", "title": "Pump Status", "type": "object" }, "time": { "description": "故障发生时间", "title": "Time", "type": "string" } }, "required": [ "time", "pump_status" ], "title": "PumpFailureState", "type": "object" }, "RunSimulationManuallyByDateRest": { "properties": { "duration": { "description": "持续时间 (分钟)", "exclusiveMinimum": 0.0, "title": "Duration", "type": "integer" }, "start_time": { "description": "开始时间 (ISO 8601 / RFC3339,必须显式带时区)", "title": "Start Time", "type": "string" } }, "required": [ "start_time", "duration" ], "title": "RunSimulationManuallyByDateRest", "type": "object" }, "SchedulingAnalysisRest": { "properties": { "pump_control": { "description": "泵控制策略", "title": "Pump Control", "type": "object" }, "start_time": { "description": "开始时间", "title": "Start Time", "type": "string" }, "tank_id": { "description": "水箱ID", "title": "Tank Id", "type": "string" }, "time_delta": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": 300, "description": "时间步长 (秒)", "title": "Time Delta" }, "water_plant_output_id": { "description": "水厂出水ID", "title": "Water Plant Output Id", "type": "string" } }, "required": [ "start_time", "pump_control", "tank_id", "water_plant_output_id" ], "title": "SchedulingAnalysisRest", "type": "object" }, "SensorPlacementExportRequest": { "properties": { "adjustment_status": { "additionalProperties": { "enum": [ "current", "original", "added", "replaced" ], "type": "string" }, "maxProperties": 200, "title": "Adjustment Status", "type": "object" }, "sensor_location": { "items": { "type": "string" }, "maxItems": 200, "minItems": 1, "title": "Sensor Location", "type": "array" } }, "required": [ "sensor_location" ], "title": "SensorPlacementExportRequest", "type": "object" }, "SensorPlacementOptimizeRequestRest": { "properties": { "method": { "enum": [ "sensitivity", "kmeans" ], "title": "Method", "type": "string" }, "min_diameter": { "default": 0, "minimum": 0.0, "title": "Min Diameter", "type": "integer" }, "scheme_name": { "maxLength": 32, "minLength": 1, "title": "Scheme Name", "type": "string" }, "sensor_count": { "exclusiveMinimum": 0.0, "maximum": 200.0, "title": "Sensor Count", "type": "integer" }, "sensor_type": { "const": "pressure", "title": "Sensor Type", "type": "string" } }, "required": [ "scheme_name", "sensor_type", "method", "sensor_count" ], "title": "SensorPlacementOptimizeRequestRest", "type": "object" }, "SensorPlacementSchemeResponse": { "properties": { "can_edit": { "default": false, "title": "Can Edit", "type": "boolean" }, "create_time": { "format": "date-time", "title": "Create Time", "type": "string" }, "id": { "title": "Id", "type": "integer" }, "min_diameter": { "title": "Min Diameter", "type": "integer" }, "scheme_name": { "title": "Scheme Name", "type": "string" }, "sensor_location": { "items": { "type": "string" }, "title": "Sensor Location", "type": "array" }, "sensor_number": { "title": "Sensor Number", "type": "integer" }, "sensor_points": { "items": { "$ref": "#/components/schemas/SensorPointResponse" }, "title": "Sensor Points", "type": "array" }, "username": { "title": "Username", "type": "string" } }, "required": [ "id", "scheme_name", "sensor_number", "min_diameter", "username", "create_time", "sensor_location", "sensor_points" ], "title": "SensorPlacementSchemeResponse", "type": "object" }, "SensorPlacementUpdateRequest": { "properties": { "expected_sensor_location": { "items": { "type": "string" }, "maxItems": 200, "minItems": 1, "title": "Expected Sensor Location", "type": "array" }, "sensor_location": { "items": { "type": "string" }, "maxItems": 200, "minItems": 1, "title": "Sensor Location", "type": "array" } }, "required": [ "expected_sensor_location", "sensor_location" ], "title": "SensorPlacementUpdateRequest", "type": "object" }, "SensorPointResponse": { "properties": { "elevation": { "title": "Elevation", "type": "number" }, "latitude": { "title": "Latitude", "type": "number" }, "longitude": { "title": "Longitude", "type": "number" }, "map_x": { "title": "Map X", "type": "number" }, "map_y": { "title": "Map Y", "type": "number" }, "node_id": { "title": "Node Id", "type": "string" }, "project_x": { "title": "Project X", "type": "number" }, "project_y": { "title": "Project Y", "type": "number" } }, "required": [ "node_id", "project_x", "project_y", "map_x", "map_y", "longitude", "latitude", "elevation" ], "title": "SensorPointResponse", "type": "object" }, "SessionAuditEventRequest": { "properties": { "event": { "enum": [ "login", "logout" ], "title": "Event", "type": "string" } }, "required": [ "event" ], "title": "SessionAuditEventRequest", "type": "object" }, "TiandituGeocodeRequest": { "properties": { "keyword": { "description": "地理编码地址关键字", "minLength": 1, "title": "Keyword", "type": "string" } }, "required": [ "keyword" ], "title": "TiandituGeocodeRequest", "type": "object" }, "WebSearchRequest": { "properties": { "count": { "default": 10, "description": "返回结果数量", "maximum": 50.0, "minimum": 1.0, "title": "Count", "type": "integer" }, "exclude": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "排除搜索域名", "title": "Exclude" }, "freshness": { "anyOf": [ { "enum": [ "noLimit", "oneDay", "oneWeek", "oneMonth", "oneYear" ], "type": "string" }, { "type": "string" } ], "default": "noLimit", "description": "时间范围:noLimit、oneDay、oneWeek、oneMonth、oneYear 或日期范围", "title": "Freshness" }, "include": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "限定搜索域名", "title": "Include" }, "query": { "description": "搜索关键词", "minLength": 1, "title": "Query", "type": "string" }, "summary": { "default": true, "description": "是否返回网页摘要", "title": "Summary", "type": "boolean" } }, "required": [ "query" ], "title": "WebSearchRequest", "type": "object" } }, "securitySchemes": { "OAuth2PasswordBearer": { "flows": { "password": { "scopes": {}, "tokenUrl": "keycloak" } }, "type": "oauth2" } } }, "info": { "description": "TJWater Server - 供水管网智能管理系统", "title": "TJWater Server", "version": "1.0.0" }, "openapi": "3.1.0", "paths": { "/api/v1/access-context": { "get": { "operationId": "get_access_context", "parameters": [ { "in": "header", "name": "X-Project-Id", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Project-Id" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessContextResponse" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "Get Access Context", "tags": [ "Access Control" ] } }, "/api/v1/admin/projects": { "get": { "operationId": "get_admin_projects", "parameters": [ { "in": "query", "name": "limit", "required": false, "schema": { "default": 100, "maximum": 1000, "minimum": 1, "title": "Limit", "type": "integer" } }, { "in": "query", "name": "offset", "required": false, "schema": { "default": 0, "minimum": 0, "title": "Offset", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_AdminProjectResponse_" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "List Admin Projects", "tags": [ "Metadata Admin" ] }, "post": { "operationId": "post_admin_projects", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminProjectCreateRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminProjectResponse" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "Create Admin Project", "tags": [ "Metadata Admin" ] } }, "/api/v1/admin/projects/{project_id}": { "patch": { "operationId": "patch_admin_projects_project_id", "parameters": [ { "in": "path", "name": "project_id", "required": true, "schema": { "format": "uuid", "title": "Project Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminProjectUpdateRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminProjectResponse" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "Update Admin Project", "tags": [ "Metadata Admin" ] } }, "/api/v1/admin/projects/{project_id}/databases": { "get": { "operationId": "get_admin_projects_project_id_databases", "parameters": [ { "in": "path", "name": "project_id", "required": true, "schema": { "format": "uuid", "title": "Project Id", "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 100, "maximum": 1000, "minimum": 1, "title": "Limit", "type": "integer" } }, { "in": "query", "name": "offset", "required": false, "schema": { "default": 0, "minimum": 0, "title": "Offset", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_ProjectDatabaseResponse_" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "List Project Databases", "tags": [ "Metadata Admin" ] }, "put": { "operationId": "put_admin_projects_project_id_databases", "parameters": [ { "in": "path", "name": "project_id", "required": true, "schema": { "format": "uuid", "title": "Project Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectDatabaseUpsertRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectDatabaseResponse" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "Upsert Project Database", "tags": [ "Metadata Admin" ] } }, "/api/v1/admin/projects/{project_id}/databases/{db_role}": { "delete": { "operationId": "delete_admin_projects_project_id_databases_db_role", "parameters": [ { "in": "path", "name": "project_id", "required": true, "schema": { "format": "uuid", "title": "Project Id", "type": "string" } }, { "in": "path", "name": "db_role", "required": true, "schema": { "enum": [ "biz_data", "iot_data" ], "title": "Db Role", "type": "string" } } ], "responses": { "204": { "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "Delete Project Database", "tags": [ "Metadata Admin" ] } }, "/api/v1/admin/projects/{project_id}/databases/{db_role}/health-checks": { "post": { "operationId": "post_admin_projects_project_id_databases_db_role_health_checks", "parameters": [ { "in": "path", "name": "project_id", "required": true, "schema": { "format": "uuid", "title": "Project Id", "type": "string" } }, { "in": "path", "name": "db_role", "required": true, "schema": { "enum": [ "biz_data", "iot_data" ], "title": "Db Role", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ProjectDatabaseHealthRequest" }, { "type": "null" } ], "title": "Payload" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectDatabaseHealthResponse" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "Check Project Database Health", "tags": [ "Metadata Admin" ] } }, "/api/v1/admin/projects/{project_id}/members": { "get": { "operationId": "get_admin_projects_project_id_members", "parameters": [ { "in": "path", "name": "project_id", "required": true, "schema": { "format": "uuid", "title": "Project Id", "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 100, "maximum": 1000, "minimum": 1, "title": "Limit", "type": "integer" } }, { "in": "query", "name": "offset", "required": false, "schema": { "default": 0, "minimum": 0, "title": "Offset", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_ProjectMemberResponse_" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "List Project Members", "tags": [ "Metadata Admin" ] }, "post": { "operationId": "post_admin_projects_project_id_members", "parameters": [ { "in": "path", "name": "project_id", "required": true, "schema": { "format": "uuid", "title": "Project Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectMemberCreateRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectMemberResponse" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "Add Project Member", "tags": [ "Metadata Admin" ] } }, "/api/v1/admin/projects/{project_id}/members/{user_id}": { "delete": { "operationId": "delete_admin_projects_project_id_members_user_id", "parameters": [ { "in": "path", "name": "project_id", "required": true, "schema": { "format": "uuid", "title": "Project Id", "type": "string" } }, { "in": "path", "name": "user_id", "required": true, "schema": { "format": "uuid", "title": "User Id", "type": "string" } } ], "responses": { "204": { "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "Remove Project Member", "tags": [ "Metadata Admin" ] }, "patch": { "operationId": "patch_admin_projects_project_id_members_user_id", "parameters": [ { "in": "path", "name": "project_id", "required": true, "schema": { "format": "uuid", "title": "Project Id", "type": "string" } }, { "in": "path", "name": "user_id", "required": true, "schema": { "format": "uuid", "title": "User Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectMemberUpdateRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectMemberResponse" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "Update Project Member", "tags": [ "Metadata Admin" ] } }, "/api/v1/admin/projects/{project_id}/model-imports": { "patch": { "operationId": "patch_admin_projects_project_id_model_imports", "parameters": [ { "in": "path", "name": "project_id", "required": true, "schema": { "format": "uuid", "title": "Project Id", "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_patch_admin_projects_project_id_model_imports" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "title": "Response Patch Admin Projects Project Id Model Imports", "type": "object" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "更新桌面端水力模型", "tags": [ "Model Administration" ] }, "post": { "operationId": "post_admin_projects_project_id_model_imports", "parameters": [ { "in": "path", "name": "project_id", "required": true, "schema": { "format": "uuid", "title": "Project Id", "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_post_admin_projects_project_id_model_imports" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "title": "Response Post Admin Projects Project Id Model Imports", "type": "object" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "导入桌面端水力模型", "tags": [ "Model Administration" ] } }, "/api/v1/admin/user-syncs": { "post": { "operationId": "post_admin_user_syncs", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetadataUserSyncRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetadataUserResponse" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "Sync Metadata User", "tags": [ "Metadata Admin" ] } }, "/api/v1/admin/user-syncs/batches": { "post": { "operationId": "post_admin_user_syncs_batches", "parameters": [ { "in": "query", "name": "limit", "required": false, "schema": { "default": 100, "maximum": 1000, "minimum": 1, "title": "Limit", "type": "integer" } }, { "in": "query", "name": "offset", "required": false, "schema": { "default": 0, "minimum": 0, "title": "Offset", "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetadataUsersBatchSyncRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_MetadataUserSyncResult_" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "Sync Metadata Users Batch", "tags": [ "Metadata Admin" ] } }, "/api/v1/admin/users": { "get": { "operationId": "get_admin_users", "parameters": [ { "in": "query", "name": "skip", "required": false, "schema": { "default": 0, "minimum": 0, "title": "Skip", "type": "integer" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 100, "maximum": 1000, "minimum": 1, "title": "Limit", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_MetadataUserResponse_" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "List Metadata Users", "tags": [ "Metadata Admin" ] } }, "/api/v1/admin/users/me": { "get": { "operationId": "get_admin_users_me", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetadataUserResponse" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "Get Metadata Admin Me", "tags": [ "Metadata Admin" ] } }, "/api/v1/admin/users/{user_id}": { "get": { "operationId": "get_admin_users_user_id", "parameters": [ { "in": "path", "name": "user_id", "required": true, "schema": { "format": "uuid", "title": "User Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetadataUserResponse" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "Get Metadata User", "tags": [ "Metadata Admin" ] }, "patch": { "operationId": "patch_admin_users_user_id", "parameters": [ { "in": "path", "name": "user_id", "required": true, "schema": { "format": "uuid", "title": "User Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetadataUserUpdateRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetadataUserResponse" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "Update Metadata User", "tags": [ "Metadata Admin" ] } }, "/api/v1/agent-auth-context": { "get": { "operationId": "get_agent_auth_context", "parameters": [ { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentAuthContextResponse" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "Get Agent Auth Context", "tags": [ "Agent Auth" ] } }, "/api/v1/all-extension-data-keys": { "get": { "description": "获取指定网络的所有扩展数据的键列表", "operationId": "get_all_extension_data_keys", "parameters": [ { "in": "query", "name": "limit", "required": false, "schema": { "default": 100, "maximum": 1000, "minimum": 1, "title": "Limit", "type": "integer" } }, { "in": "query", "name": "offset", "required": false, "schema": { "default": 0, "minimum": 0, "title": "Offset", "type": "integer" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_str_" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取所有扩展数据键", "tags": [ "Extension" ] } }, "/api/v1/all-extension-datas": { "get": { "description": "获取指定网络的所有扩展数据", "operationId": "get_all_extension_datas", "parameters": [ { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "title": "Response Get All Extension Datas", "type": "object" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取所有扩展数据", "tags": [ "Extension" ] } }, "/api/v1/all-redis": { "delete": { "description": "清空整个Redis数据库的所有缓存", "operationId": "delete_all_redis", "parameters": [ { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "204": { "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "清除所有缓存", "tags": [ "Cache" ] } }, "/api/v1/all-scada-properties": { "get": { "description": "获取指定水网中所有SCADA点的属性信息", "operationId": "get_all_scada_properties", "parameters": [ { "in": "query", "name": "limit", "required": false, "schema": { "default": 100, "maximum": 1000, "minimum": 1, "title": "Limit", "type": "integer" } }, { "in": "query", "name": "offset", "required": false, "schema": { "default": 0, "minimum": 0, "title": "Offset", "type": "integer" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_dict_str__Any__" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取所有SCADA点属性", "tags": [ "Network General" ] } }, "/api/v1/all-vertices": { "get": { "description": "获取网络中的所有图形元素详细信息", "operationId": "get_all_vertices", "parameters": [ { "in": "query", "name": "limit", "required": false, "schema": { "default": 100, "maximum": 1000, "minimum": 1, "title": "Limit", "type": "integer" } }, { "in": "query", "name": "offset", "required": false, "schema": { "default": 0, "minimum": 0, "title": "Offset", "type": "integer" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "text/plain": { "schema": { "type": "string" } } }, "description": "Successful Response" }, "401": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取所有图形元素", "tags": [ "Visuals" ] } }, "/api/v1/audit-events": { "post": { "operationId": "post_audit_events", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionAuditEventRequest" } } }, "required": true }, "responses": { "204": { "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "Record Session Event", "tags": [ "Audit Logs" ] } }, "/api/v1/audit-logs": { "get": { "description": "查询审计日志(仅管理员)", "operationId": "get_audit_logs", "parameters": [ { "description": "按用户ID过滤", "in": "query", "name": "user_id", "required": false, "schema": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ], "description": "按用户ID过滤", "title": "User Id" } }, { "description": "按项目ID过滤", "in": "query", "name": "project_id", "required": false, "schema": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ], "description": "按项目ID过滤", "title": "Project Id" } }, { "description": "按操作类型过滤", "in": "query", "name": "action", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "按操作类型过滤", "title": "Action" } }, { "description": "按资源类型过滤", "in": "query", "name": "resource_type", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "按资源类型过滤", "title": "Resource Type" } }, { "description": "开始时间", "in": "query", "name": "start_time", "required": false, "schema": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "开始时间", "title": "Start Time" } }, { "description": "结束时间", "in": "query", "name": "end_time", "required": false, "schema": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "结束时间", "title": "End Time" } }, { "description": "跳过记录数", "in": "query", "name": "skip", "required": false, "schema": { "default": 0, "description": "跳过记录数", "minimum": 0, "title": "Skip", "type": "integer" } }, { "description": "限制记录数", "in": "query", "name": "limit", "required": false, "schema": { "default": 100, "description": "限制记录数", "maximum": 1000, "minimum": 1, "title": "Limit", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_AuditLogResponse_" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "查询审计日志", "tags": [ "Audit Logs" ] } }, "/api/v1/audit-logs/count": { "get": { "description": "获取审计日志总数(仅管理员)", "operationId": "get_audit_logs_count", "parameters": [ { "description": "按用户ID过滤", "in": "query", "name": "user_id", "required": false, "schema": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ], "description": "按用户ID过滤", "title": "User Id" } }, { "description": "按项目ID过滤", "in": "query", "name": "project_id", "required": false, "schema": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ], "description": "按项目ID过滤", "title": "Project Id" } }, { "description": "按操作类型过滤", "in": "query", "name": "action", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "按操作类型过滤", "title": "Action" } }, { "description": "按资源类型过滤", "in": "query", "name": "resource_type", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "按资源类型过滤", "title": "Resource Type" } }, { "description": "开始时间", "in": "query", "name": "start_time", "required": false, "schema": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "开始时间", "title": "Start Time" } }, { "description": "结束时间", "in": "query", "name": "end_time", "required": false, "schema": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "结束时间", "title": "End Time" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "title": "Response Get Audit Logs Count", "type": "object" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取审计日志总数", "tags": [ "Audit Logs" ] } }, "/api/v1/audit-logs/mine": { "get": { "description": "查询当前用户的审计日志", "operationId": "get_audit_logs_mine", "parameters": [ { "description": "按操作类型过滤", "in": "query", "name": "action", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "按操作类型过滤", "title": "Action" } }, { "description": "开始时间", "in": "query", "name": "start_time", "required": false, "schema": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "开始时间", "title": "Start Time" } }, { "description": "结束时间", "in": "query", "name": "end_time", "required": false, "schema": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "结束时间", "title": "End Time" } }, { "description": "跳过记录数", "in": "query", "name": "skip", "required": false, "schema": { "default": 0, "description": "跳过记录数", "minimum": 0, "title": "Skip", "type": "integer" } }, { "description": "限制记录数", "in": "query", "name": "limit", "required": false, "schema": { "default": 100, "description": "限制记录数", "maximum": 1000, "minimum": 1, "title": "Limit", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_AuditLogResponse_" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "查询我的审计日志", "tags": [ "Audit Logs" ] } }, "/api/v1/backdrops/properties": { "get": { "description": "获取指定网络的背景属性信息", "operationId": "get_backdrops_properties", "parameters": [ { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "title": "Response Get Backdrops Properties", "type": "object" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取背景属性", "tags": [ "Visuals" ] }, "patch": { "description": "更新指定网络的背景属性", "operationId": "patch_backdrops_properties", "parameters": [ { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "设置背景属性", "tags": [ "Visuals" ] } }, "/api/v1/burst-analyses": { "post": { "description": "高级版本的爆管分析,支持在指定时间点修改泵控制模式和阀门开度,以分析这些改变对爆管影响的作用。支持固定泵和变速泵的独立控制。", "operationId": "post_burst_analyses", "parameters": [ { "description": "模式修改开始时间(ISO 8601格式)", "in": "query", "name": "modify_pattern_start_time", "required": true, "schema": { "description": "模式修改开始时间(ISO 8601格式)", "title": "Modify Pattern Start Time", "type": "string" } }, { "description": "爆管节点/管段ID列表", "in": "query", "name": "burst_id", "required": true, "schema": { "description": "爆管节点/管段ID列表", "items": { "type": "string" }, "title": "Burst Id", "type": "array" } }, { "description": "对应各爆管点的爆管流量大小列表(L/s)", "in": "query", "name": "burst_size", "required": true, "schema": { "description": "对应各爆管点的爆管流量大小列表(L/s)", "items": { "type": "number" }, "title": "Burst Size", "type": "array" } }, { "description": "模拟总时长(秒)", "in": "query", "name": "modify_total_duration", "required": true, "schema": { "description": "模拟总时长(秒)", "title": "Modify Total Duration", "type": "integer" } }, { "description": "分析方案名称", "in": "query", "name": "scheme_name", "required": true, "schema": { "description": "分析方案名称", "title": "Scheme Name", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "title": "Response Post Burst Analyses", "type": "string" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "爆管分析(高级)", "tags": [ "Simulation Control" ] } }, "/api/v1/burst-detections": { "post": { "description": "基于压力观测数据和其他参数执行爆管检测分析", "operationId": "post_burst_detections", "parameters": [ { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BurstDetectionRequestRest", "description": "爆管检测请求数据" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "title": "Response Post Burst Detections", "type": "object" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "执行爆管检测", "tags": [ "Burst Detection" ] } }, "/api/v1/burst-locations": { "get": { "description": "获取网络中所有爆管定位的分析结果", "operationId": "get_burst_locations", "parameters": [ { "in": "query", "name": "limit", "required": false, "schema": { "default": 100, "maximum": 1000, "minimum": 1, "title": "Limit", "type": "integer" } }, { "in": "query", "name": "offset", "required": false, "schema": { "default": 0, "minimum": 0, "title": "Offset", "type": "integer" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_dict_Any__Any__" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取所有爆管定位结果", "tags": [ "Misc" ] }, "post": { "description": "基于压力和流量数据定位管网中的爆管位置", "operationId": "post_burst_locations", "parameters": [ { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BurstLocationRequestRest", "description": "爆管定位请求数据" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "title": "Response Post Burst Locations", "type": "object" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "执行爆管定位", "tags": [ "Burst Location" ] } }, "/api/v1/burst-locations/database-view": { "get": { "description": "使用连接池查询所有爆管定位结果", "operationId": "get_burst_locations_database_view", "parameters": [ { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取爆管定位结果", "tags": [ "Project Data" ] } }, "/api/v1/burst-locations/{burst_incident}": { "get": { "description": "根据爆管事件ID查询对应的爆管定位结果", "operationId": "get_burst_locations_burst_incident", "parameters": [ { "description": "爆管事件ID", "in": "path", "name": "burst_incident", "required": true, "schema": { "description": "爆管事件ID", "title": "Burst Incident", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "按事件查询爆管定位结果", "tags": [ "Project Data" ] } }, "/api/v1/contaminant-simulations": { "post": { "description": "对管网中的污染物扩散进行模拟,评估污染源对管网的影响范围和浓度分布。支持指定污染源位置、污染浓度和扩散模式。", "operationId": "post_contaminant_simulations", "parameters": [ { "description": "污染开始时间(ISO 8601格式)", "in": "query", "name": "start_time", "required": true, "schema": { "description": "污染开始时间(ISO 8601格式)", "title": "Start Time", "type": "string" } }, { "description": "污染源节点ID", "in": "query", "name": "source", "required": true, "schema": { "description": "污染源节点ID", "title": "Source", "type": "string" } }, { "description": "污染浓度(mg/L)", "in": "query", "name": "concentration", "required": true, "schema": { "description": "污染浓度(mg/L)", "title": "Concentration", "type": "number" } }, { "description": "模拟持续时间(秒)", "in": "query", "name": "duration", "required": true, "schema": { "description": "模拟持续时间(秒)", "title": "Duration", "type": "integer" } }, { "description": "模拟方案名称", "in": "query", "name": "scheme_name", "required": true, "schema": { "description": "模拟方案名称", "title": "Scheme Name", "type": "string" } }, { "description": "污染源模式ID(可选)", "in": "query", "name": "pattern", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "污染源模式ID(可选)", "title": "Pattern" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "text/plain": { "schema": { "type": "string" } } }, "description": "Successful Response" }, "401": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "污染物模拟", "tags": [ "Simulation Control" ] } }, "/api/v1/controls/properties": { "get": { "description": "获取指定网络中的控制属性信息", "operationId": "get_controls_properties", "parameters": [ { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "title": "Response Get Controls Properties", "type": "object" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取控制属性", "tags": [ "Controls & Rules" ] }, "patch": { "description": "更新指定网络中的控制属性", "operationId": "patch_controls_properties", "parameters": [ { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "设置控制属性", "tags": [ "Controls & Rules" ] } }, "/api/v1/current-operation-ids": { "get": { "description": "获取网络当前的操作ID", "operationId": "get_current_operation_ids", "parameters": [ { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "title": "Response Get Current Operation Ids", "type": "integer" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取当前操作ID", "tags": [ "Snapshots" ] } }, "/api/v1/curves": { "delete": { "description": "从网络中删除指定的曲线", "operationId": "delete_curves", "parameters": [ { "description": "曲线ID", "in": "query", "name": "curve", "required": true, "schema": { "description": "曲线ID", "title": "Curve", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "204": { "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "删除曲线", "tags": [ "Curves" ] }, "get": { "description": "获取网络中的所有曲线列表", "operationId": "get_curves", "parameters": [ { "in": "query", "name": "limit", "required": false, "schema": { "default": 100, "maximum": 1000, "minimum": 1, "title": "Limit", "type": "integer" } }, { "in": "query", "name": "offset", "required": false, "schema": { "default": 0, "minimum": 0, "title": "Offset", "type": "integer" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_str_" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取所有曲线", "tags": [ "Curves" ] }, "post": { "description": "在网络中添加一条新的曲线", "operationId": "post_curves", "parameters": [ { "description": "曲线ID", "in": "query", "name": "curve", "required": true, "schema": { "description": "曲线ID", "title": "Curve", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "添加曲线", "tags": [ "Curves" ] } }, "/api/v1/curves/existence": { "get": { "description": "检查指定的曲线是否存在", "operationId": "get_curves_existence", "parameters": [ { "description": "曲线ID", "in": "query", "name": "curve", "required": true, "schema": { "description": "曲线ID", "title": "Curve", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "title": "Response Get Curves Existence", "type": "boolean" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "检查曲线存在性", "tags": [ "Curves" ] } }, "/api/v1/curves/properties": { "get": { "description": "获取指定曲线的属性信息", "operationId": "get_curves_properties", "parameters": [ { "description": "曲线ID", "in": "query", "name": "curve", "required": true, "schema": { "description": "曲线ID", "title": "Curve", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "title": "Response Get Curves Properties", "type": "object" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取曲线属性", "tags": [ "Curves" ] }, "patch": { "description": "更新指定曲线的属性", "operationId": "patch_curves_properties", "parameters": [ { "description": "曲线ID", "in": "query", "name": "curve", "required": true, "schema": { "description": "曲线ID", "title": "Curve", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "设置曲线属性", "tags": [ "Curves" ] } }, "/api/v1/daily-scheduling-analyses": { "post": { "description": "对管网的每日供水排程进行分析,优化水库、水厂、水箱和用户需求的协调,制定合理的每日排程方案。", "operationId": "post_daily_scheduling_analyses", "parameters": [ { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DailySchedulingAnalysisRest", "description": "日排程分析参数" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "title": "Response Post Daily Scheduling Analyses", "type": "string" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "日排程分析", "tags": [ "Simulation Control" ] } }, "/api/v1/demands/properties": { "get": { "description": "获取指定水网中节点的需水量属性信息", "operationId": "get_demands_properties", "parameters": [ { "description": "节点ID", "in": "query", "name": "junction", "required": true, "schema": { "description": "节点ID", "title": "Junction", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "title": "Response Get Demands Properties", "type": "object" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取需水量属性", "tags": [ "Demands" ] }, "patch": { "description": "设置指定水网中节点的需水量属性信息", "operationId": "patch_demands_properties", "parameters": [ { "description": "节点ID", "in": "query", "name": "junction", "required": true, "schema": { "description": "节点ID", "title": "Junction", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "设置需水量属性", "tags": [ "Demands" ] } }, "/api/v1/demands/to-network": { "post": { "description": "将需水量均匀分配到整个水网的所有需水节点", "operationId": "post_demands_to_network", "parameters": [ { "description": "总需水量(m³/h)", "in": "query", "name": "demand", "required": true, "schema": { "description": "总需水量(m³/h)", "exclusiveMinimum": 0.0, "title": "Demand", "type": "number" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": { "type": "number" }, "title": "Response Post Demands To Network", "type": "object" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "计算需水量到整网分配", "tags": [ "Demands" ] } }, "/api/v1/demands/to-nodes": { "post": { "description": "将总需水量按指定方式分配到多个节点", "operationId": "post_demands_to_nodes", "parameters": [ { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": { "type": "number" }, "title": "Response Post Demands To Nodes", "type": "object" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "计算需水量到节点分配", "tags": [ "Demands" ] } }, "/api/v1/demands/to-region": { "post": { "description": "将总需水量按区域特征分配到该区域内的节点", "operationId": "post_demands_to_region", "parameters": [ { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": { "type": "number" }, "title": "Response Post Demands To Region", "type": "object" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "计算需水量到区域分配", "tags": [ "Demands" ] } }, "/api/v1/district-metering-area-generation-runs": { "post": { "description": "根据参数自动生成水网的DMA分区方案", "operationId": "post_district_metering_area_generation_runs", "parameters": [ { "description": "分区数量", "in": "query", "name": "part_count", "required": true, "schema": { "description": "分区数量", "exclusiveMinimum": 0, "title": "Part Count", "type": "integer" } }, { "description": "分区类型", "in": "query", "name": "part_type", "required": true, "schema": { "description": "分区类型", "title": "Part Type", "type": "integer" } }, { "description": "膨胀参数", "in": "query", "name": "inflate_delta", "required": true, "schema": { "description": "膨胀参数", "title": "Inflate Delta", "type": "number" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "生成DMA分区", "tags": [ "Regions & DMAs" ] } }, "/api/v1/district-metering-areas": { "delete": { "description": "删除指定的区域计量(DMA)", "operationId": "delete_district_metering_areas", "parameters": [ { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "204": { "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "删除DMA", "tags": [ "Regions & DMAs" ] }, "get": { "description": "获取指定水网中所有DMA的详细信息", "operationId": "get_district_metering_areas", "parameters": [ { "in": "query", "name": "limit", "required": false, "schema": { "default": 100, "maximum": 1000, "minimum": 1, "title": "Limit", "type": "integer" } }, { "in": "query", "name": "offset", "required": false, "schema": { "default": 0, "minimum": 0, "title": "Offset", "type": "integer" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_dict_str__Any__" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取所有DMA", "tags": [ "Regions & DMAs" ] }, "patch": { "description": "修改指定DMA的属性信息", "operationId": "patch_district_metering_areas", "parameters": [ { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "设置DMA属性", "tags": [ "Regions & DMAs" ] }, "post": { "description": "向水网添加一个新的区域计量(DMA)", "operationId": "post_district_metering_areas", "parameters": [ { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "添加新DMA", "tags": [ "Regions & DMAs" ] } }, "/api/v1/district-metering-areas/detail": { "get": { "description": "获取指定ID的区域计量(DMA)详细信息", "operationId": "get_district_metering_areas_detail", "parameters": [ { "description": "DMA ID", "in": "query", "name": "id", "required": true, "schema": { "description": "DMA ID", "title": "Id", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "title": "Response Get District Metering Areas Detail", "type": "object" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取DMA信息", "tags": [ "Regions & DMAs" ] } }, "/api/v1/district-metering-areas/for-network": { "post": { "description": "为整个水网计算区域计量(DMA)分区方案", "operationId": "post_district_metering_areas_for_network", "parameters": [ { "in": "query", "name": "limit", "required": false, "schema": { "default": 100, "maximum": 1000, "minimum": 1, "title": "Limit", "type": "integer" } }, { "in": "query", "name": "offset", "required": false, "schema": { "default": 0, "minimum": 0, "title": "Offset", "type": "integer" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_list_str__" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "计算整网DMA分区", "tags": [ "Regions & DMAs" ] } }, "/api/v1/district-metering-areas/for-nodes": { "post": { "description": "为指定节点集计算区域计量(DMA)分区方案", "operationId": "post_district_metering_areas_for_nodes", "parameters": [ { "in": "query", "name": "limit", "required": false, "schema": { "default": 100, "maximum": 1000, "minimum": 1, "title": "Limit", "type": "integer" } }, { "in": "query", "name": "offset", "required": false, "schema": { "default": 0, "minimum": 0, "title": "Offset", "type": "integer" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_list_str__" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "计算节点DMA分区", "tags": [ "Regions & DMAs" ] } }, "/api/v1/district-metering-areas/for-region": { "post": { "description": "为指定区域计算区域计量(DMA)分区方案", "operationId": "post_district_metering_areas_for_region", "parameters": [ { "in": "query", "name": "limit", "required": false, "schema": { "default": 100, "maximum": 1000, "minimum": 1, "title": "Limit", "type": "integer" } }, { "in": "query", "name": "offset", "required": false, "schema": { "default": 0, "minimum": 0, "title": "Offset", "type": "integer" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_list_str__" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "计算区域内DMA分区", "tags": [ "Regions & DMAs" ] } }, "/api/v1/district-metering-areas/ids": { "get": { "description": "获取指定水网中所有DMA的ID列表", "operationId": "get_district_metering_areas_ids", "parameters": [ { "in": "query", "name": "limit", "required": false, "schema": { "default": 100, "maximum": 1000, "minimum": 1, "title": "Limit", "type": "integer" } }, { "in": "query", "name": "offset", "required": false, "schema": { "default": 0, "minimum": 0, "title": "Offset", "type": "integer" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_str_" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取所有DMA ID", "tags": [ "Regions & DMAs" ] } }, "/api/v1/element-properties": { "get": { "description": "获取指定元素的属性信息", "operationId": "get_element_properties", "parameters": [ { "description": "元素ID", "in": "query", "name": "element", "required": true, "schema": { "description": "元素ID", "title": "Element", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "title": "Response Get Element Properties", "type": "object" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取元素属性", "tags": [ "Network General" ] } }, "/api/v1/element-properties-with-types": { "get": { "description": "获取指定类型的元素属性信息", "operationId": "get_element_properties_with_types", "parameters": [ { "description": "元素类型", "in": "query", "name": "elementtype", "required": true, "schema": { "description": "元素类型", "title": "Elementtype", "type": "string" } }, { "description": "元素ID", "in": "query", "name": "element", "required": true, "schema": { "description": "元素ID", "title": "Element", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "title": "Response Get Element Properties With Types", "type": "object" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取指定类型元素属性", "tags": [ "Network General" ] } }, "/api/v1/element-type-values": { "get": { "description": "获取指定元素的类型数值标识", "operationId": "get_element_type_values", "parameters": [ { "description": "元素ID", "in": "query", "name": "element", "required": true, "schema": { "description": "元素ID", "title": "Element", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "title": "Response Get Element Type Values", "type": "integer" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取元素类型值", "tags": [ "Network General" ] } }, "/api/v1/element-types": { "get": { "description": "获取指定元素的类型(节点或管线)", "operationId": "get_element_types", "parameters": [ { "description": "元素ID", "in": "query", "name": "element", "required": true, "schema": { "description": "元素ID", "title": "Element", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "title": "Response Get Element Types", "type": "string" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取元素类型", "tags": [ "Network General" ] } }, "/api/v1/emitters/properties": { "get": { "description": "获取指定连接点的发射器属性信息", "operationId": "get_emitters_properties", "parameters": [ { "description": "连接点ID", "in": "query", "name": "junction", "required": true, "schema": { "description": "连接点ID", "title": "Junction", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "title": "Response Get Emitters Properties", "type": "object" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取发射器属性", "tags": [ "Quality" ] }, "patch": { "description": "更新指定连接点的发射器属性", "operationId": "patch_emitters_properties", "parameters": [ { "description": "连接点ID", "in": "query", "name": "junction", "required": true, "schema": { "description": "连接点ID", "title": "Junction", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "设置发射器属性", "tags": [ "Quality" ] } }, "/api/v1/energy-properties": { "patch": { "description": "更新指定网络中的能耗选项属性", "operationId": "patch_energy_properties", "parameters": [ { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "设置能耗选项属性", "tags": [ "Options" ] } }, "/api/v1/extension-datas": { "get": { "description": "获取指定网络中指定键的扩展数据值", "operationId": "get_extension_datas", "parameters": [ { "description": "扩展数据键", "in": "query", "name": "key", "required": true, "schema": { "description": "扩展数据键", "title": "Key", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Response Get Extension Datas" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取指定扩展数据", "tags": [ "Extension" ] }, "patch": { "description": "设置指定网络中的扩展数据", "operationId": "patch_extension_datas", "parameters": [ { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "设置扩展数据", "tags": [ "Extension" ] } }, "/api/v1/flushing-analyses": { "post": { "description": "高级版本的冲洗分析,支持同时开启多个阀门进行冲洗,指定排污节点,并设置固定的冲洗流量。返回纯文本格式的分析结果。", "operationId": "post_flushing_analyses", "parameters": [ { "description": "冲洗开始时间(ISO 8601格式)", "in": "query", "name": "start_time", "required": true, "schema": { "description": "冲洗开始时间(ISO 8601格式)", "title": "Start Time", "type": "string" } }, { "description": "要开启的阀门ID列表", "in": "query", "name": "valves", "required": true, "schema": { "description": "要开启的阀门ID列表", "items": { "type": "string" }, "title": "Valves", "type": "array" } }, { "description": "对应各阀门的开度列表(0-1)", "in": "query", "name": "valves_k", "required": true, "schema": { "description": "对应各阀门的开度列表(0-1)", "items": { "type": "number" }, "title": "Valves K", "type": "array" } }, { "description": "排污节点ID", "in": "query", "name": "drainage_node_id", "required": true, "schema": { "description": "排污节点ID", "title": "Drainage Node Id", "type": "string" } }, { "description": "冲洗流量(L/s),0表示自动计算", "in": "query", "name": "flush_flow", "required": false, "schema": { "default": 0, "description": "冲洗流量(L/s),0表示自动计算", "title": "Flush Flow", "type": "number" } }, { "description": "模拟持续时间(秒),默认900秒", "in": "query", "name": "duration", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "模拟持续时间(秒),默认900秒", "title": "Duration" } }, { "description": "冲洗方案名称", "in": "query", "name": "scheme_name", "required": true, "schema": { "description": "冲洗方案名称", "title": "Scheme Name", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "text/plain": { "schema": { "type": "string" } } }, "description": "Successful Response" }, "401": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "冲洗分析(高级)", "tags": [ "Simulation Control" ] } }, "/api/v1/geocoding-requests": { "post": { "description": "调用天地图地理编码服务,将结构化地址转换为经纬度", "operationId": "post_geocoding_requests", "parameters": [ { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TiandituGeocodeRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "title": "Response Post Geocoding Requests", "type": "object" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "Tianditu Geocoding", "tags": [ "Geocoding" ] } }, "/api/v1/inp-runs": { "post": { "description": "运行指定INP文件格式的管网模型进行水力模拟。INP文件应该放在inp文件夹中,参数为文件名不含扩展名。", "operationId": "post_inp_runs", "parameters": [ { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "title": "Response Post Inp Runs", "type": "string" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "运行INP文件", "tags": [ "Simulation Control" ] } }, "/api/v1/junctions": { "delete": { "description": "从供水网络中删除指定的节点。", "operationId": "delete_junctions", "parameters": [ { "description": "节点 ID", "in": "query", "name": "junction", "required": true, "schema": { "description": "节点 ID", "title": "Junction", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "204": { "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "删除节点", "tags": [ "Junctions" ] }, "get": { "description": "获取指定项目中所有节点的属性信息。", "operationId": "get_junctions", "parameters": [ { "in": "query", "name": "limit", "required": false, "schema": { "default": 100, "maximum": 1000, "minimum": 1, "title": "Limit", "type": "integer" } }, { "in": "query", "name": "offset", "required": false, "schema": { "default": 0, "minimum": 0, "title": "Offset", "type": "integer" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_dict_str__Any__" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取所有节点属性", "tags": [ "Junctions" ] }, "post": { "description": "在供水网络中添加新的节点,指定节点ID和空间坐标。", "operationId": "post_junctions", "parameters": [ { "description": "节点 ID", "in": "query", "name": "junction", "required": true, "schema": { "description": "节点 ID", "title": "Junction", "type": "string" } }, { "description": "X 坐标", "in": "query", "name": "x", "required": true, "schema": { "description": "X 坐标", "title": "X", "type": "number" } }, { "description": "Y 坐标", "in": "query", "name": "y", "required": true, "schema": { "description": "Y 坐标", "title": "Y", "type": "number" } }, { "description": "标高(海拔高度)", "in": "query", "name": "z", "required": true, "schema": { "description": "标高(海拔高度)", "title": "Z", "type": "number" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "添加节点", "tags": [ "Junctions" ] } }, "/api/v1/junctions/coord": { "get": { "description": "获取指定节点的 X 和 Y 坐标。", "operationId": "get_junctions_coord", "parameters": [ { "description": "节点 ID", "in": "query", "name": "junction", "required": true, "schema": { "description": "节点 ID", "title": "Junction", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": { "type": "number" }, "title": "Response Get Junctions Coord", "type": "object" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取节点坐标", "tags": [ "Junctions" ] }, "patch": { "description": "设置指定节点的 X 和 Y 坐标。", "operationId": "patch_junctions_coord", "parameters": [ { "description": "节点 ID", "in": "query", "name": "junction", "required": true, "schema": { "description": "节点 ID", "title": "Junction", "type": "string" } }, { "description": "X 坐标值", "in": "query", "name": "x", "required": true, "schema": { "description": "X 坐标值", "title": "X", "type": "number" } }, { "description": "Y 坐标值", "in": "query", "name": "y", "required": true, "schema": { "description": "Y 坐标值", "title": "Y", "type": "number" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "设置节点坐标", "tags": [ "Junctions" ] } }, "/api/v1/junctions/demand": { "get": { "description": "获取指定节点的需水量。", "operationId": "get_junctions_demand", "parameters": [ { "description": "节点 ID", "in": "query", "name": "junction", "required": true, "schema": { "description": "节点 ID", "title": "Junction", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "title": "Response Get Junctions Demand", "type": "number" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取节点需水量", "tags": [ "Junctions" ] }, "patch": { "description": "设置指定节点的需水量。", "operationId": "patch_junctions_demand", "parameters": [ { "description": "节点 ID", "in": "query", "name": "junction", "required": true, "schema": { "description": "节点 ID", "title": "Junction", "type": "string" } }, { "description": "需水量值", "in": "query", "name": "demand", "required": true, "schema": { "description": "需水量值", "title": "Demand", "type": "number" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "设置节点需水量", "tags": [ "Junctions" ] } }, "/api/v1/junctions/elevation": { "get": { "description": "获取指定节点的标高(海拔高度)。", "operationId": "get_junctions_elevation", "parameters": [ { "description": "节点 ID", "in": "query", "name": "junction", "required": true, "schema": { "description": "节点 ID", "title": "Junction", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "title": "Response Get Junctions Elevation", "type": "number" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取节点标高", "tags": [ "Junctions" ] }, "patch": { "description": "设置指定节点的标高值。", "operationId": "patch_junctions_elevation", "parameters": [ { "description": "节点 ID", "in": "query", "name": "junction", "required": true, "schema": { "description": "节点 ID", "title": "Junction", "type": "string" } }, { "description": "标高(海拔高度)", "in": "query", "name": "elevation", "required": true, "schema": { "description": "标高(海拔高度)", "title": "Elevation", "type": "number" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "设置节点标高", "tags": [ "Junctions" ] } }, "/api/v1/junctions/existence": { "get": { "description": "检查指定ID是否为水网中的接点(需求点)", "operationId": "get_junctions_existence", "parameters": [ { "description": "节点ID", "in": "query", "name": "node", "required": true, "schema": { "description": "节点ID", "title": "Node", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "title": "Response Get Junctions Existence", "type": "boolean" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "检查是否为接点", "tags": [ "Network General" ] } }, "/api/v1/junctions/pattern": { "get": { "description": "获取指定节点的需水模式标识。", "operationId": "get_junctions_pattern", "parameters": [ { "description": "节点 ID", "in": "query", "name": "junction", "required": true, "schema": { "description": "节点 ID", "title": "Junction", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "title": "Response Get Junctions Pattern", "type": "string" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取节点需水模式", "tags": [ "Junctions" ] }, "patch": { "description": "设置指定节点的需水模式标识。", "operationId": "patch_junctions_pattern", "parameters": [ { "description": "节点 ID", "in": "query", "name": "junction", "required": true, "schema": { "description": "节点 ID", "title": "Junction", "type": "string" } }, { "description": "需水模式标识", "in": "query", "name": "pattern", "required": true, "schema": { "description": "需水模式标识", "title": "Pattern", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "设置节点需水模式", "tags": [ "Junctions" ] } }, "/api/v1/junctions/properties": { "get": { "description": "获取指定节点的所有属性信息。", "operationId": "get_junctions_properties", "parameters": [ { "description": "节点 ID", "in": "query", "name": "junction", "required": true, "schema": { "description": "节点 ID", "title": "Junction", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "title": "Response Get Junctions Properties", "type": "object" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取节点属性", "tags": [ "Junctions" ] }, "patch": { "description": "批量设置指定节点的多个属性。", "operationId": "patch_junctions_properties", "parameters": [ { "description": "节点 ID", "in": "query", "name": "junction", "required": true, "schema": { "description": "节点 ID", "title": "Junction", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "批量设置节点属性", "tags": [ "Junctions" ] } }, "/api/v1/junctions/x": { "get": { "description": "获取指定节点的 X 坐标值。", "operationId": "get_junctions_x", "parameters": [ { "description": "节点 ID", "in": "query", "name": "junction", "required": true, "schema": { "description": "节点 ID", "title": "Junction", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "title": "Response Get Junctions X", "type": "number" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取节点 X 坐标", "tags": [ "Junctions" ] }, "patch": { "description": "设置指定节点的 X 坐标值。", "operationId": "patch_junctions_x", "parameters": [ { "description": "节点 ID", "in": "query", "name": "junction", "required": true, "schema": { "description": "节点 ID", "title": "Junction", "type": "string" } }, { "description": "X 坐标值", "in": "query", "name": "x", "required": true, "schema": { "description": "X 坐标值", "title": "X", "type": "number" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "设置节点 X 坐标", "tags": [ "Junctions" ] } }, "/api/v1/junctions/y": { "get": { "description": "获取指定节点的 Y 坐标值。", "operationId": "get_junctions_y", "parameters": [ { "description": "节点 ID", "in": "query", "name": "junction", "required": true, "schema": { "description": "节点 ID", "title": "Junction", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "title": "Response Get Junctions Y", "type": "number" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取节点 Y 坐标", "tags": [ "Junctions" ] }, "patch": { "description": "设置指定节点的 Y 坐标值。", "operationId": "patch_junctions_y", "parameters": [ { "description": "节点 ID", "in": "query", "name": "junction", "required": true, "schema": { "description": "节点 ID", "title": "Junction", "type": "string" } }, { "description": "Y 坐标值", "in": "query", "name": "y", "required": true, "schema": { "description": "Y 坐标值", "title": "Y", "type": "number" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "设置节点 Y 坐标", "tags": [ "Junctions" ] } }, "/api/v1/labels": { "delete": { "description": "从网络中删除指定的标签", "operationId": "delete_labels", "parameters": [ { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "204": { "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "删除标签", "tags": [ "Visuals" ] }, "post": { "description": "在网络中添加一个新的标签", "operationId": "post_labels", "parameters": [ { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "添加标签", "tags": [ "Visuals" ] } }, "/api/v1/labels/properties": { "get": { "description": "获取指定坐标处的标签属性信息", "operationId": "get_labels_properties", "parameters": [ { "description": "X坐标", "in": "query", "name": "x", "required": true, "schema": { "description": "X坐标", "title": "X", "type": "number" } }, { "description": "Y坐标", "in": "query", "name": "y", "required": true, "schema": { "description": "Y坐标", "title": "Y", "type": "number" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "title": "Response Get Labels Properties", "type": "object" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取标签属性", "tags": [ "Visuals" ] }, "patch": { "description": "更新指定标签的属性", "operationId": "patch_labels_properties", "parameters": [ { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "设置标签属性", "tags": [ "Visuals" ] } }, "/api/v1/leakage-identifications": { "post": { "description": "基于压力观测数据和遗传算法识别管网中的漏损位置和大小", "operationId": "post_leakage_identifications", "parameters": [ { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LeakageIdentifyRequestRest", "description": "漏损识别请求数据" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "title": "Response Post Leakage Identifications", "type": "object" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "执行漏损识别", "tags": [ "Leakage" ] } }, "/api/v1/link-properties": { "get": { "description": "获取指定管线的所有属性信息", "operationId": "get_link_properties", "parameters": [ { "description": "管线ID", "in": "query", "name": "link", "required": true, "schema": { "description": "管线ID", "title": "Link", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "title": "Response Get Link Properties", "type": "object" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取管线属性", "tags": [ "Network General" ] } }, "/api/v1/link-types": { "get": { "description": "获取指定管线的类型(管道/泵/阀门)", "operationId": "get_link_types", "parameters": [ { "description": "管线ID", "in": "query", "name": "link", "required": true, "schema": { "description": "管线ID", "title": "Link", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "title": "Response Get Link Types", "type": "string" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取管线类型", "tags": [ "Network General" ] } }, "/api/v1/links": { "delete": { "description": "删除指定的管线(管道/泵/阀门)", "operationId": "delete_links", "parameters": [ { "description": "管线ID", "in": "query", "name": "link", "required": true, "schema": { "description": "管线ID", "title": "Link", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "204": { "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "删除管线", "tags": [ "Network General" ] }, "get": { "description": "获取指定水网中的所有管线ID列表", "operationId": "get_links", "parameters": [ { "in": "query", "name": "limit", "required": false, "schema": { "default": 100, "maximum": 1000, "minimum": 1, "title": "Limit", "type": "integer" } }, { "in": "query", "name": "offset", "required": false, "schema": { "default": 0, "minimum": 0, "title": "Offset", "type": "integer" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_str_" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取所有管线", "tags": [ "Network General" ] } }, "/api/v1/links/existence": { "get": { "description": "检查指定ID是否为水网中的有效管线", "operationId": "get_links_existence", "parameters": [ { "description": "管线ID", "in": "query", "name": "link", "required": true, "schema": { "description": "管线ID", "title": "Link", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "title": "Response Get Links Existence", "type": "boolean" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "检查管线有效性", "tags": [ "Network General" ] } }, "/api/v1/major-pipe-nodes": { "get": { "description": "获取直径大于等于指定值的管道的节点ID", "operationId": "get_major_pipe_nodes", "parameters": [ { "description": "最小直径(mm)", "in": "query", "name": "diameter", "required": true, "schema": { "description": "最小直径(mm)", "exclusiveMinimum": 0, "title": "Diameter", "type": "integer" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Response Get Major Pipe Nodes" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取主要管道节点", "tags": [ "Geometry & Coordinates" ] } }, "/api/v1/majornode-coords": { "get": { "description": "获取直径大于等于指定值的节点坐标", "operationId": "get_majornode_coords", "parameters": [ { "description": "最小直径(mm)", "in": "query", "name": "diameter", "required": true, "schema": { "description": "最小直径(mm)", "exclusiveMinimum": 0, "title": "Diameter", "type": "integer" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": { "additionalProperties": { "type": "number" }, "type": "object" }, "title": "Response Get Majornode Coords", "type": "object" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取主要节点坐标", "tags": [ "Geometry & Coordinates" ] } }, "/api/v1/mixing-configurations": { "delete": { "description": "从网络中删除指定的混合", "operationId": "delete_mixing_configurations", "parameters": [ { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "204": { "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "删除混合", "tags": [ "Quality" ] }, "patch": { "description": "更新指定水池的混合属性", "operationId": "patch_mixing_configurations", "parameters": [ { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "设置混合属性", "tags": [ "Quality" ] }, "post": { "description": "在网络中添加一个新的混合", "operationId": "post_mixing_configurations", "parameters": [ { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "添加混合", "tags": [ "Quality" ] } }, "/api/v1/mixing-configurations/detail": { "get": { "description": "获取指定水池的混合属性信息", "operationId": "get_mixing_configurations_detail", "parameters": [ { "description": "水池ID", "in": "query", "name": "tank", "required": true, "schema": { "description": "水池ID", "title": "Tank", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "title": "Response Get Mixing Configurations Detail", "type": "object" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取混合属性", "tags": [ "Quality" ] } }, "/api/v1/network-command-batches": { "post": { "description": "执行多个网络操作命令", "operationId": "post_network_command_batches", "parameters": [ { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "执行批量命令", "tags": [ "Snapshots" ] } }, "/api/v1/network-command-batches/compressed": { "post": { "description": "执行压缩的批量命令", "operationId": "post_network_command_batches_compressed", "parameters": [ { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "执行压缩批量命令", "tags": [ "Snapshots" ] } }, "/api/v1/network-in-extents": { "get": { "description": "获取指定地理范围内的网络节点和管线", "operationId": "get_network_in_extents", "parameters": [ { "description": "范围左下角X坐标", "in": "query", "name": "x1", "required": true, "schema": { "description": "范围左下角X坐标", "title": "X1", "type": "number" } }, { "description": "范围左下角Y坐标", "in": "query", "name": "y1", "required": true, "schema": { "description": "范围左下角Y坐标", "title": "Y1", "type": "number" } }, { "description": "范围右上角X坐标", "in": "query", "name": "x2", "required": true, "schema": { "description": "范围右上角X坐标", "title": "X2", "type": "number" } }, { "description": "范围右上角Y坐标", "in": "query", "name": "y2", "required": true, "schema": { "description": "范围右上角Y坐标", "title": "Y2", "type": "number" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "title": "Response Get Network In Extents", "type": "object" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取范围内的网络元素", "tags": [ "Geometry & Coordinates" ] } }, "/api/v1/network-link-nodes": { "get": { "description": "获取指定水网所有管线的起点和终点节点", "operationId": "get_network_link_nodes", "parameters": [ { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Response Get Network Link Nodes" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取网络管线节点", "tags": [ "Geometry & Coordinates" ] } }, "/api/v1/network-options": { "get": { "description": "获取指定网络中的选项属性信息", "operationId": "get_network_options", "parameters": [ { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "title": "Response Get Network Options", "type": "object" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取选项属性", "tags": [ "Options" ] }, "patch": { "description": "更新指定网络中的选项属性", "operationId": "patch_network_options", "parameters": [ { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "设置选项属性", "tags": [ "Options" ] } }, "/api/v1/network-options/energy": { "get": { "description": "获取指定网络中的能耗选项属性信息", "operationId": "get_network_options_energy", "parameters": [ { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "title": "Response Get Network Options Energy", "type": "object" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取能耗选项属性", "tags": [ "Options" ] } }, "/api/v1/network-options/pump-energy": { "get": { "description": "获取指定泵的能耗属性信息", "operationId": "get_network_options_pump_energy", "parameters": [ { "description": "泵ID", "in": "query", "name": "pump", "required": true, "schema": { "description": "泵ID", "title": "Pump", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "title": "Response Get Network Options Pump Energy", "type": "object" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取泵能耗属性", "tags": [ "Options" ] }, "patch": { "description": "更新指定泵的能耗属性", "operationId": "patch_network_options_pump_energy", "parameters": [ { "description": "泵ID", "in": "query", "name": "pump", "required": true, "schema": { "description": "泵ID", "title": "Pump", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "设置泵能耗属性", "tags": [ "Options" ] } }, "/api/v1/network-options/time": { "get": { "description": "获取指定网络中的时间选项属性信息", "operationId": "get_network_options_time", "parameters": [ { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "title": "Response Get Network Options Time", "type": "object" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取时间选项属性", "tags": [ "Options" ] } }, "/api/v1/network-pipe-risk-probability-nows": { "get": { "description": "获取指定网络中所有管道的当前风险概率值", "operationId": "get_network_pipe_risk_probability_nows", "parameters": [ { "in": "query", "name": "limit", "required": false, "schema": { "default": 100, "maximum": 1000, "minimum": 1, "title": "Limit", "type": "integer" } }, { "in": "query", "name": "offset", "required": false, "schema": { "default": 0, "minimum": 0, "title": "Offset", "type": "integer" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_dict_str__Any__" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取整个网络的管道风险概率", "tags": [ "Risk" ] } }, "/api/v1/network-schemas/backdrop": { "get": { "description": "获取网络中背景对象的架构定义", "operationId": "get_network_schemas_backdrop", "parameters": [ { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": { "type": "object" }, "title": "Response Get Network Schemas Backdrop", "type": "object" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取背景架构", "tags": [ "Visuals" ] } }, "/api/v1/network-schemas/control": { "get": { "description": "获取网络中控制对象的架构定义", "operationId": "get_network_schemas_control", "parameters": [ { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": { "type": "object" }, "title": "Response Get Network Schemas Control", "type": "object" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取控制架构", "tags": [ "Controls & Rules" ] } }, "/api/v1/network-schemas/curve": { "get": { "description": "获取网络中曲线对象的架构定义", "operationId": "get_network_schemas_curve", "parameters": [ { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": { "type": "object" }, "title": "Response Get Network Schemas Curve", "type": "object" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取曲线架构", "tags": [ "Curves" ] } }, "/api/v1/network-schemas/demand": { "get": { "description": "获取指定水网中需水量(Demand)的属性架构定义", "operationId": "get_network_schemas_demand", "parameters": [ { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": { "type": "object" }, "title": "Response Get Network Schemas Demand", "type": "object" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取需水量属性架构", "tags": [ "Demands" ] } }, "/api/v1/network-schemas/district-metering-area": { "get": { "description": "获取指定水网的区域计量(DMA)属性架构定义", "operationId": "get_network_schemas_district_metering_area", "parameters": [ { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": { "type": "object" }, "title": "Response Get Network Schemas District Metering Area", "type": "object" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取DMA属性架构", "tags": [ "Regions & DMAs" ] } }, "/api/v1/network-schemas/emitter": { "get": { "description": "获取网络中发射器对象的架构定义", "operationId": "get_network_schemas_emitter", "parameters": [ { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": { "type": "object" }, "title": "Response Get Network Schemas Emitter", "type": "object" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取发射器架构", "tags": [ "Quality" ] } }, "/api/v1/network-schemas/energy": { "get": { "description": "获取网络中能耗选项的架构定义", "operationId": "get_network_schemas_energy", "parameters": [ { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": { "type": "object" }, "title": "Response Get Network Schemas Energy", "type": "object" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取能耗选项架构", "tags": [ "Options" ] } }, "/api/v1/network-schemas/junction": { "get": { "description": "获取指定项目的节点属性架构和数据类型定义。", "operationId": "get_network_schemas_junction", "parameters": [ { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": { "type": "object" }, "title": "Response Get Network Schemas Junction", "type": "object" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取节点架构", "tags": [ "Junctions" ] } }, "/api/v1/network-schemas/label": { "get": { "description": "获取网络中标签对象的架构定义", "operationId": "get_network_schemas_label", "parameters": [ { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": { "type": "object" }, "title": "Response Get Network Schemas Label", "type": "object" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取标签架构", "tags": [ "Visuals" ] } }, "/api/v1/network-schemas/mixing": { "get": { "description": "获取网络中混合对象的架构定义", "operationId": "get_network_schemas_mixing", "parameters": [ { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": { "type": "object" }, "title": "Response Get Network Schemas Mixing", "type": "object" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取混合架构", "tags": [ "Quality" ] } }, "/api/v1/network-schemas/option": { "get": { "description": "获取网络中选项对象的架构定义", "operationId": "get_network_schemas_option", "parameters": [ { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": { "type": "object" }, "title": "Response Get Network Schemas Option", "type": "object" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取选项架构", "tags": [ "Options" ] } }, "/api/v1/network-schemas/pattern": { "get": { "description": "获取网络中模式对象的架构定义", "operationId": "get_network_schemas_pattern", "parameters": [ { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": { "type": "object" }, "title": "Response Get Network Schemas Pattern", "type": "object" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取模式架构", "tags": [ "Patterns" ] } }, "/api/v1/network-schemas/pipe": { "get": { "description": "获取管道对象的模式定义,包含所有可用字段及其类型", "operationId": "get_network_schemas_pipe", "parameters": [ { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": { "type": "object" }, "title": "Response Get Network Schemas Pipe", "type": "object" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取管道模式", "tags": [ "Pipes" ] } }, "/api/v1/network-schemas/pipe-reaction": { "get": { "description": "获取网络中管道反应对象的架构定义", "operationId": "get_network_schemas_pipe_reaction", "parameters": [ { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": { "type": "object" }, "title": "Response Get Network Schemas Pipe Reaction", "type": "object" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取管道反应架构", "tags": [ "Quality" ] } }, "/api/v1/network-schemas/pump": { "get": { "description": "获取水泵对象的模式定义,包含所有可用字段及其类型", "operationId": "get_network_schemas_pump", "parameters": [ { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": { "type": "object" }, "title": "Response Get Network Schemas Pump", "type": "object" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取水泵模式", "tags": [ "Pumps" ] } }, "/api/v1/network-schemas/pump-energy": { "get": { "description": "获取网络中泵能耗选项的架构定义", "operationId": "get_network_schemas_pump_energy", "parameters": [ { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": { "type": "object" }, "title": "Response Get Network Schemas Pump Energy", "type": "object" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取泵能耗选项架构", "tags": [ "Options" ] } }, "/api/v1/network-schemas/quality": { "get": { "description": "获取网络中水质对象的架构定义", "operationId": "get_network_schemas_quality", "parameters": [ { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": { "type": "object" }, "title": "Response Get Network Schemas Quality", "type": "object" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取水质架构", "tags": [ "Quality" ] } }, "/api/v1/network-schemas/reaction": { "get": { "description": "获取网络中反应对象的架构定义", "operationId": "get_network_schemas_reaction", "parameters": [ { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": { "type": "object" }, "title": "Response Get Network Schemas Reaction", "type": "object" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取反应架构", "tags": [ "Quality" ] } }, "/api/v1/network-schemas/region": { "get": { "description": "获取指定水网的区域属性架构定义", "operationId": "get_network_schemas_region", "parameters": [ { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": { "type": "object" }, "title": "Response Get Network Schemas Region", "type": "object" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取区域属性架构", "tags": [ "Regions & DMAs" ] } }, "/api/v1/network-schemas/reservoir": { "get": { "description": "获取指定供水网络中所有水库的模式/属性字段定义", "operationId": "get_network_schemas_reservoir", "parameters": [ { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": { "type": "object" }, "title": "Response Get Network Schemas Reservoir", "type": "object" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取水库模式", "tags": [ "Reservoirs" ] } }, "/api/v1/network-schemas/scada-device": { "get": { "description": "获取SCADA设备的数据架构\n\n返回SCADA设备表的字段定义和类型信息。\n\nArgs:\n network: 管网名称(或数据库名称)\n \nReturns:\n SCADA设备的字段架构信息", "operationId": "get_network_schemas_scada_device", "parameters": [ { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": { "type": "object" }, "title": "Response Get Network Schemas Scada Device", "type": "object" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取SCADA设备架构", "tags": [ "SCADA设备" ] } }, "/api/v1/network-schemas/scada-device-data": { "get": { "description": "获取SCADA设备数据的表结构\n\n返回SCADA设备数据表的字段定义和类型信息。\n\nArgs:\n network: 管网名称(或数据库名称)\n \nReturns:\n SCADA设备数据的字段架构信息", "operationId": "get_network_schemas_scada_device_data", "parameters": [ { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": { "type": "object" }, "title": "Response Get Network Schemas Scada Device Data", "type": "object" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取SCADA设备数据架构", "tags": [ "SCADA设备数据" ] } }, "/api/v1/network-schemas/scada-element": { "get": { "description": "获取SCADA元素映射的表结构\n\n返回SCADA元素映射表的字段定义和类型信息。\n\nArgs:\n network: 管网名称(或数据库名称)\n \nReturns:\n SCADA元素映射的字段架构信息", "operationId": "get_network_schemas_scada_element", "parameters": [ { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": { "type": "object" }, "title": "Response Get Network Schemas Scada Element", "type": "object" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取SCADA元素架构", "tags": [ "SCADA元素映射" ] } }, "/api/v1/network-schemas/scheme": { "get": { "description": "获取指定网络的方案模式定义", "operationId": "get_network_schemas_scheme", "parameters": [ { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": { "type": "object" }, "title": "Response Get Network Schemas Scheme", "type": "object" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取方案模式", "tags": [ "Schemes" ] } }, "/api/v1/network-schemas/service-area": { "get": { "description": "获取指定水网的服务区属性架构定义", "operationId": "get_network_schemas_service_area", "parameters": [ { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": { "type": "object" }, "title": "Response Get Network Schemas Service Area", "type": "object" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取服务区属性架构", "tags": [ "Regions & DMAs" ] } }, "/api/v1/network-schemas/source": { "get": { "description": "获取网络中水源对象的架构定义", "operationId": "get_network_schemas_source", "parameters": [ { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": { "type": "object" }, "title": "Response Get Network Schemas Source", "type": "object" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取水源架构", "tags": [ "Quality" ] } }, "/api/v1/network-schemas/tag": { "get": { "description": "获取指定水网的标签(Tag)属性架构定义", "operationId": "get_network_schemas_tag", "parameters": [ { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": { "type": "object" }, "title": "Response Get Network Schemas Tag", "type": "object" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取标签属性架构", "tags": [ "Tags" ] } }, "/api/v1/network-schemas/tank": { "get": { "description": "获取指定网络的水箱数据结构模式定义", "operationId": "get_network_schemas_tank", "parameters": [ { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": { "type": "object" }, "title": "Response Get Network Schemas Tank", "type": "object" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取水箱模式", "tags": [ "Tanks" ] } }, "/api/v1/network-schemas/tank-reaction": { "get": { "description": "获取网络中水池反应对象的架构定义", "operationId": "get_network_schemas_tank_reaction", "parameters": [ { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": { "type": "object" }, "title": "Response Get Network Schemas Tank Reaction", "type": "object" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取水池反应架构", "tags": [ "Quality" ] } }, "/api/v1/network-schemas/time": { "get": { "description": "获取网络中时间选项的架构定义", "operationId": "get_network_schemas_time", "parameters": [ { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": { "type": "object" }, "title": "Response Get Network Schemas Time", "type": "object" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取时间选项架构", "tags": [ "Options" ] } }, "/api/v1/network-schemas/user": { "get": { "description": "获取指定网络的用户模式定义", "operationId": "get_network_schemas_user", "parameters": [ { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": { "type": "object" }, "title": "Response Get Network Schemas User", "type": "object" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取用户模式", "tags": [ "Users" ] } }, "/api/v1/network-schemas/valve": { "get": { "description": "获取指定水网中所有阀门的架构和字段定义", "operationId": "get_network_schemas_valve", "parameters": [ { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": { "type": "object" }, "title": "Response Get Network Schemas Valve", "type": "object" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取阀门架构", "tags": [ "Valves" ] } }, "/api/v1/network-schemas/vertex": { "get": { "description": "获取网络中图形元素对象的架构定义", "operationId": "get_network_schemas_vertex", "parameters": [ { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": { "type": "object" }, "title": "Response Get Network Schemas Vertex", "type": "object" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取图形元素架构", "tags": [ "Visuals" ] } }, "/api/v1/network-schemas/virtual-district": { "get": { "description": "获取指定水网的虚拟分区属性架构定义", "operationId": "get_network_schemas_virtual_district", "parameters": [ { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": { "type": "object" }, "title": "Response Get Network Schemas Virtual District", "type": "object" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取虚拟分区属性架构", "tags": [ "Regions & DMAs" ] } }, "/api/v1/node-coords": { "get": { "description": "获取指定节点的地理坐标(X, Y)", "operationId": "get_node_coords", "parameters": [ { "description": "节点ID", "in": "query", "name": "node", "required": true, "schema": { "description": "节点ID", "title": "Node", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "anyOf": [ { "additionalProperties": { "type": "number" }, "type": "object" }, { "type": "null" } ], "title": "Response Get Node Coords" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取节点坐标", "tags": [ "Geometry & Coordinates" ] } }, "/api/v1/node-links": { "get": { "description": "获取指定节点连接的所有管线ID列表", "operationId": "get_node_links", "parameters": [ { "description": "节点ID", "in": "query", "name": "node", "required": true, "schema": { "description": "节点ID", "title": "Node", "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 100, "maximum": 1000, "minimum": 1, "title": "Limit", "type": "integer" } }, { "in": "query", "name": "offset", "required": false, "schema": { "default": 0, "minimum": 0, "title": "Offset", "type": "integer" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_str_" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取节点的关联管线", "tags": [ "Network General" ] } }, "/api/v1/node-properties": { "get": { "description": "获取指定节点的所有属性信息", "operationId": "get_node_properties", "parameters": [ { "description": "节点ID", "in": "query", "name": "node", "required": true, "schema": { "description": "节点ID", "title": "Node", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "title": "Response Get Node Properties", "type": "object" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取节点属性", "tags": [ "Network General" ] } }, "/api/v1/node-types": { "get": { "description": "获取指定节点的类型(接点/水源/蓄水池)", "operationId": "get_node_types", "parameters": [ { "description": "节点ID", "in": "query", "name": "node", "required": true, "schema": { "description": "节点ID", "title": "Node", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "title": "Response Get Node Types", "type": "string" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取节点类型", "tags": [ "Network General" ] } }, "/api/v1/nodes": { "delete": { "description": "删除指定的节点(接点/水源/蓄水池)", "operationId": "delete_nodes", "parameters": [ { "description": "节点ID", "in": "query", "name": "node", "required": true, "schema": { "description": "节点ID", "title": "Node", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "204": { "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "删除节点", "tags": [ "Network General" ] }, "get": { "description": "获取指定水网中的所有节点ID列表", "operationId": "get_nodes", "parameters": [ { "in": "query", "name": "limit", "required": false, "schema": { "default": 100, "maximum": 1000, "minimum": 1, "title": "Limit", "type": "integer" } }, { "in": "query", "name": "offset", "required": false, "schema": { "default": 0, "minimum": 0, "title": "Offset", "type": "integer" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_str_" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取所有节点", "tags": [ "Network General" ] } }, "/api/v1/nodes/existence": { "get": { "description": "检查指定ID是否为水网中的有效节点", "operationId": "get_nodes_existence", "parameters": [ { "description": "节点ID", "in": "query", "name": "node", "required": true, "schema": { "description": "节点ID", "title": "Node", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "title": "Response Get Nodes Existence", "type": "boolean" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "检查节点有效性", "tags": [ "Network General" ] } }, "/api/v1/operations": { "patch": { "description": "选择并恢复到指定的操作", "operationId": "patch_operations", "parameters": [ { "description": "操作ID", "in": "query", "name": "operation", "required": true, "schema": { "description": "操作ID", "title": "Operation", "type": "integer" } }, { "description": "是否丢弃当前更改", "in": "query", "name": "discard", "required": false, "schema": { "default": false, "description": "是否丢弃当前更改", "title": "Discard", "type": "boolean" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "选择操作", "tags": [ "Snapshots" ] } }, "/api/v1/outputs": { "get": { "description": "导出指定路径的模拟输出文件内容。参数应为绝对路径。", "operationId": "get_outputs", "parameters": [ { "description": "模拟输出文件的绝对路径", "in": "query", "name": "output", "required": true, "schema": { "description": "模拟输出文件的绝对路径", "title": "Output", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "title": "Response Get Outputs", "type": "string" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "导出模拟输出", "tags": [ "Simulation Control" ] } }, "/api/v1/patterns": { "delete": { "description": "从网络中删除指定的模式", "operationId": "delete_patterns", "parameters": [ { "description": "模式ID", "in": "query", "name": "pattern", "required": true, "schema": { "description": "模式ID", "title": "Pattern", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "204": { "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "删除模式", "tags": [ "Patterns" ] }, "get": { "description": "获取网络中的所有模式列表", "operationId": "get_patterns", "parameters": [ { "in": "query", "name": "limit", "required": false, "schema": { "default": 100, "maximum": 1000, "minimum": 1, "title": "Limit", "type": "integer" } }, { "in": "query", "name": "offset", "required": false, "schema": { "default": 0, "minimum": 0, "title": "Offset", "type": "integer" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_str_" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取所有模式", "tags": [ "Patterns" ] }, "post": { "description": "在网络中添加一个新的模式", "operationId": "post_patterns", "parameters": [ { "description": "模式ID", "in": "query", "name": "pattern", "required": true, "schema": { "description": "模式ID", "title": "Pattern", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "添加模式", "tags": [ "Patterns" ] } }, "/api/v1/patterns/existence": { "get": { "description": "检查指定的模式是否存在", "operationId": "get_patterns_existence", "parameters": [ { "description": "模式ID", "in": "query", "name": "pattern", "required": true, "schema": { "description": "模式ID", "title": "Pattern", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "title": "Response Get Patterns Existence", "type": "boolean" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "检查模式存在性", "tags": [ "Patterns" ] } }, "/api/v1/patterns/properties": { "get": { "description": "获取指定模式的属性信息", "operationId": "get_patterns_properties", "parameters": [ { "description": "模式ID", "in": "query", "name": "pattern", "required": true, "schema": { "description": "模式ID", "title": "Pattern", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "title": "Response Get Patterns Properties", "type": "object" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取模式属性", "tags": [ "Patterns" ] }, "patch": { "description": "更新指定模式的属性", "operationId": "patch_patterns_properties", "parameters": [ { "description": "模式ID", "in": "query", "name": "pattern", "required": true, "schema": { "description": "模式ID", "title": "Pattern", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "设置模式属性", "tags": [ "Patterns" ] } }, "/api/v1/pipe-reactions": { "patch": { "description": "更新指定管道的反应属性", "operationId": "patch_pipe_reactions", "parameters": [ { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "设置管道反应属性", "tags": [ "Quality" ] } }, "/api/v1/pipe-reactions/detail": { "get": { "description": "获取指定管道的反应属性信息", "operationId": "get_pipe_reactions_detail", "parameters": [ { "description": "管道ID", "in": "query", "name": "pipe", "required": true, "schema": { "description": "管道ID", "title": "Pipe", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "title": "Response Get Pipe Reactions Detail", "type": "object" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取管道反应属性", "tags": [ "Quality" ] } }, "/api/v1/pipeline-health-predictions": { "get": { "description": "预测管道健康状况\n\n根据管网名称和当前时间,查询管道信息和实时数据,\n使用随机生存森林模型预测管道的生存概率。\n\nArgs:\n query_time: 查询时间\n network_name: 管网名称(或数据库名称)\n timescale_conn: TimescaleDB连接\n\nReturns:\n 预测结果列表,每个元素包含 link_id 和对应的生存函数\n\nRaises:\n HTTPException: 当模型文件不存在返回404错误,其他错误返回400或500错误", "operationId": "get_pipeline_health_predictions", "parameters": [ { "description": "查询时间", "in": "query", "name": "query_time", "required": true, "schema": { "description": "查询时间", "format": "date-time", "title": "Query Time", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "预测管道健康状况", "tags": [ "TimescaleDB - Composite" ] } }, "/api/v1/pipes": { "delete": { "description": "从网络中删除指定的管道", "operationId": "delete_pipes", "parameters": [ { "description": "要删除的管道ID", "in": "query", "name": "pipe", "required": true, "schema": { "description": "要删除的管道ID", "title": "Pipe", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "204": { "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "删除管道", "tags": [ "Pipes" ] }, "get": { "description": "获取网络中所有管道的属性信息列表", "operationId": "get_pipes", "parameters": [ { "in": "query", "name": "limit", "required": false, "schema": { "default": 100, "maximum": 1000, "minimum": 1, "title": "Limit", "type": "integer" } }, { "in": "query", "name": "offset", "required": false, "schema": { "default": 0, "minimum": 0, "title": "Offset", "type": "integer" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_dict_str__Any__" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取所有管道属性", "tags": [ "Pipes" ] }, "post": { "description": "向网络中添加新的管道,需要提供管道的基本参数如长度、管径、粗糙度等", "operationId": "post_pipes", "parameters": [ { "description": "管道标识符", "in": "query", "name": "pipe", "required": true, "schema": { "description": "管道标识符", "title": "Pipe", "type": "string" } }, { "description": "管道起始节点ID", "in": "query", "name": "node1", "required": true, "schema": { "description": "管道起始节点ID", "title": "Node1", "type": "string" } }, { "description": "管道终止节点ID", "in": "query", "name": "node2", "required": true, "schema": { "description": "管道终止节点ID", "title": "Node2", "type": "string" } }, { "description": "管道长度(单位:米)", "in": "query", "name": "length", "required": false, "schema": { "default": 0, "description": "管道长度(单位:米)", "title": "Length", "type": "number" } }, { "description": "管道管径(单位:毫米)", "in": "query", "name": "diameter", "required": false, "schema": { "default": 0, "description": "管道管径(单位:毫米)", "title": "Diameter", "type": "number" } }, { "description": "管道粗糙度", "in": "query", "name": "roughness", "required": false, "schema": { "default": 0, "description": "管道粗糙度", "title": "Roughness", "type": "number" } }, { "description": "管道局部阻力系数", "in": "query", "name": "minor_loss", "required": false, "schema": { "default": 0, "description": "管道局部阻力系数", "title": "Minor Loss", "type": "number" } }, { "description": "管道状态(开启/关闭)", "in": "query", "name": "status", "required": false, "schema": { "default": "OPEN", "description": "管道状态(开启/关闭)", "title": "Status", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "添加管道", "tags": [ "Pipes" ] } }, "/api/v1/pipes-risk-probabilities": { "get": { "description": "批量获取多条管道的风险概率值", "operationId": "get_pipes_risk_probabilities", "parameters": [ { "description": "逗号分隔的管道ID列表", "in": "query", "name": "pipe_ids", "required": true, "schema": { "description": "逗号分隔的管道ID列表", "title": "Pipe Ids", "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 100, "maximum": 1000, "minimum": 1, "title": "Limit", "type": "integer" } }, { "in": "query", "name": "offset", "required": false, "schema": { "default": 0, "minimum": 0, "title": "Offset", "type": "integer" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_dict_str__Any__" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "批量获取多条管道风险概率", "tags": [ "Risk" ] } }, "/api/v1/pipes/diameter": { "get": { "description": "获取指定管道的管径", "operationId": "get_pipes_diameter", "parameters": [ { "description": "管道ID", "in": "query", "name": "pipe", "required": true, "schema": { "description": "管道ID", "title": "Pipe", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Response Get Pipes Diameter" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取管道管径", "tags": [ "Pipes" ] }, "patch": { "description": "设置指定管道的管径", "operationId": "patch_pipes_diameter", "parameters": [ { "description": "管道ID", "in": "query", "name": "pipe", "required": true, "schema": { "description": "管道ID", "title": "Pipe", "type": "string" } }, { "description": "新的管道管径(单位:毫米)", "in": "query", "name": "diameter", "required": true, "schema": { "description": "新的管道管径(单位:毫米)", "title": "Diameter", "type": "number" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "设置管道管径", "tags": [ "Pipes" ] } }, "/api/v1/pipes/existence": { "get": { "description": "检查指定ID是否为水网中的管道", "operationId": "get_pipes_existence", "parameters": [ { "description": "管线ID", "in": "query", "name": "link", "required": true, "schema": { "description": "管线ID", "title": "Link", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "title": "Response Get Pipes Existence", "type": "boolean" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "检查是否为管道", "tags": [ "Network General" ] } }, "/api/v1/pipes/length": { "get": { "description": "获取指定管道的长度", "operationId": "get_pipes_length", "parameters": [ { "description": "管道ID", "in": "query", "name": "pipe", "required": true, "schema": { "description": "管道ID", "title": "Pipe", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Response Get Pipes Length" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取管道长度", "tags": [ "Pipes" ] }, "patch": { "description": "设置指定管道的长度", "operationId": "patch_pipes_length", "parameters": [ { "description": "管道ID", "in": "query", "name": "pipe", "required": true, "schema": { "description": "管道ID", "title": "Pipe", "type": "string" } }, { "description": "新的管道长度(单位:米)", "in": "query", "name": "length", "required": true, "schema": { "description": "新的管道长度(单位:米)", "title": "Length", "type": "number" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "设置管道长度", "tags": [ "Pipes" ] } }, "/api/v1/pipes/minor-loss": { "get": { "description": "获取指定管道的局部阻力系数", "operationId": "get_pipes_minor_loss", "parameters": [ { "description": "管道ID", "in": "query", "name": "pipe", "required": true, "schema": { "description": "管道ID", "title": "Pipe", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Response Get Pipes Minor Loss" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取管道局部阻力系数", "tags": [ "Pipes" ] }, "patch": { "description": "设置指定管道的局部阻力系数", "operationId": "patch_pipes_minor_loss", "parameters": [ { "description": "管道ID", "in": "query", "name": "pipe", "required": true, "schema": { "description": "管道ID", "title": "Pipe", "type": "string" } }, { "description": "新的局部阻力系数值", "in": "query", "name": "minor_loss", "required": true, "schema": { "description": "新的局部阻力系数值", "title": "Minor Loss", "type": "number" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "设置管道局部阻力系数", "tags": [ "Pipes" ] } }, "/api/v1/pipes/node1": { "get": { "description": "获取指定管道的起始节点ID", "operationId": "get_pipes_node1", "parameters": [ { "description": "管道ID", "in": "query", "name": "pipe", "required": true, "schema": { "description": "管道ID", "title": "Pipe", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Response Get Pipes Node1" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取管道起始节点", "tags": [ "Pipes" ] }, "patch": { "description": "设置指定管道的起始节点", "operationId": "patch_pipes_node1", "parameters": [ { "description": "管道ID", "in": "query", "name": "pipe", "required": true, "schema": { "description": "管道ID", "title": "Pipe", "type": "string" } }, { "description": "新的起始节点ID", "in": "query", "name": "node1", "required": true, "schema": { "description": "新的起始节点ID", "title": "Node1", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "设置管道起始节点", "tags": [ "Pipes" ] } }, "/api/v1/pipes/node2": { "get": { "description": "获取指定管道的终止节点ID", "operationId": "get_pipes_node2", "parameters": [ { "description": "管道ID", "in": "query", "name": "pipe", "required": true, "schema": { "description": "管道ID", "title": "Pipe", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Response Get Pipes Node2" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取管道终止节点", "tags": [ "Pipes" ] }, "patch": { "description": "设置指定管道的终止节点", "operationId": "patch_pipes_node2", "parameters": [ { "description": "管道ID", "in": "query", "name": "pipe", "required": true, "schema": { "description": "管道ID", "title": "Pipe", "type": "string" } }, { "description": "新的终止节点ID", "in": "query", "name": "node2", "required": true, "schema": { "description": "新的终止节点ID", "title": "Node2", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "设置管道终止节点", "tags": [ "Pipes" ] } }, "/api/v1/pipes/properties": { "get": { "description": "获取指定管道的所有属性信息", "operationId": "get_pipes_properties", "parameters": [ { "description": "管道ID", "in": "query", "name": "pipe", "required": true, "schema": { "description": "管道ID", "title": "Pipe", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "title": "Response Get Pipes Properties", "type": "object" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取管道属性", "tags": [ "Pipes" ] }, "patch": { "description": "批量设置指定管道的多个属性", "operationId": "patch_pipes_properties", "parameters": [ { "description": "管道ID", "in": "query", "name": "pipe", "required": true, "schema": { "description": "管道ID", "title": "Pipe", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "设置管道属性", "tags": [ "Pipes" ] } }, "/api/v1/pipes/risk-probability": { "get": { "description": "获取指定管道的风险概率历史数据", "operationId": "get_pipes_risk_probability", "parameters": [ { "description": "管道ID", "in": "query", "name": "pipe_id", "required": true, "schema": { "description": "管道ID", "title": "Pipe Id", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "title": "Response Get Pipes Risk Probability", "type": "object" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取管道风险概率历史", "tags": [ "Risk" ] } }, "/api/v1/pipes/risk-probability-geometries": { "get": { "description": "获取指定网络中管道的风险相关几何数据", "operationId": "get_pipes_risk_probability_geometries", "parameters": [ { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "title": "Response Get Pipes Risk Probability Geometries", "type": "object" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取管道风险几何信息", "tags": [ "Risk" ] } }, "/api/v1/pipes/risk-probability-now": { "get": { "description": "获取指定管道当前时刻的风险概率值", "operationId": "get_pipes_risk_probability_now", "parameters": [ { "description": "管道ID", "in": "query", "name": "pipe_id", "required": true, "schema": { "description": "管道ID", "title": "Pipe Id", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "title": "Response Get Pipes Risk Probability Now", "type": "object" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取管道当前风险概率", "tags": [ "Risk" ] } }, "/api/v1/pipes/roughness": { "get": { "description": "获取指定管道的粗糙度", "operationId": "get_pipes_roughness", "parameters": [ { "description": "管道ID", "in": "query", "name": "pipe", "required": true, "schema": { "description": "管道ID", "title": "Pipe", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Response Get Pipes Roughness" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取管道粗糙度", "tags": [ "Pipes" ] }, "patch": { "description": "设置指定管道的粗糙度", "operationId": "patch_pipes_roughness", "parameters": [ { "description": "管道ID", "in": "query", "name": "pipe", "required": true, "schema": { "description": "管道ID", "title": "Pipe", "type": "string" } }, { "description": "新的管道粗糙度值", "in": "query", "name": "roughness", "required": true, "schema": { "description": "新的管道粗糙度值", "title": "Roughness", "type": "number" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "设置管道粗糙度", "tags": [ "Pipes" ] } }, "/api/v1/pipes/status": { "get": { "description": "获取指定管道的状态(开启或关闭)", "operationId": "get_pipes_status", "parameters": [ { "description": "管道ID", "in": "query", "name": "pipe", "required": true, "schema": { "description": "管道ID", "title": "Pipe", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Response Get Pipes Status" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取管道状态", "tags": [ "Pipes" ] }, "patch": { "description": "设置指定管道的状态(开启或关闭)", "operationId": "patch_pipes_status", "parameters": [ { "description": "管道ID", "in": "query", "name": "pipe", "required": true, "schema": { "description": "管道ID", "title": "Pipe", "type": "string" } }, { "description": "新的管道状态(开启/关闭)", "in": "query", "name": "status", "required": true, "schema": { "description": "新的管道状态(开启/关闭)", "title": "Status", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "设置管道状态", "tags": [ "Pipes" ] } }, "/api/v1/pressure-regulation-analyses": { "post": { "description": "高级版本的压力调节分析,通过JSON请求体提供详细的控制参数,包括固定泵和变速泵的独立控制、水箱初始水位等。", "operationId": "post_pressure_regulation_analyses", "parameters": [ { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PressureRegulationRest", "description": "压力调节控制参数" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "title": "Response Post Pressure Regulation Analyses", "type": "string" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "压力调节(高级)", "tags": [ "Simulation Control" ] } }, "/api/v1/pressure-regulation-calculations": { "post": { "description": "对管网的压力进行调节分析,通过控制泵的运行来维持目标节点的目标压力。此为基础版本。", "operationId": "post_pressure_regulation_calculations", "parameters": [ { "description": "目标节点ID", "in": "query", "name": "target_node", "required": true, "schema": { "description": "目标节点ID", "title": "Target Node", "type": "string" } }, { "description": "目标压力值(kPa)", "in": "query", "name": "target_pressure", "required": true, "schema": { "description": "目标压力值(kPa)", "title": "Target Pressure", "type": "number" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "压力调节(基础)", "tags": [ "Simulation Control" ] } }, "/api/v1/pressure-sensor-placement-kmeans": { "post": { "description": "高级版本的压力传感器放置分析,通过JSON请求体提供详细参数。基于KMeans聚类算法确定最优放置位置。", "operationId": "post_pressure_sensor_placement_kmeans", "parameters": [ { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PressureSensorPlacement", "description": "传感器放置分析参数" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "压力传感器放置-KMeans聚类分析(高级)", "tags": [ "Simulation Control" ] } }, "/api/v1/pressure-sensor-placement-kmeans-calculations": { "post": { "description": "基于KMeans聚类算法,为指定管网项目确定压力传感器的最优放置位置。此为基础版本。", "operationId": "post_pressure_sensor_placement_kmeans_calculations", "parameters": [ { "description": "放置方案名称", "in": "query", "name": "scheme_name", "required": true, "schema": { "description": "放置方案名称", "title": "Scheme Name", "type": "string" } }, { "description": "传感器数量", "in": "query", "name": "sensor_number", "required": true, "schema": { "description": "传感器数量", "title": "Sensor Number", "type": "integer" } }, { "description": "最小管径限制(毫米)", "in": "query", "name": "min_diameter", "required": true, "schema": { "description": "最小管径限制(毫米)", "title": "Min Diameter", "type": "integer" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "压力传感器放置-KMeans聚类分析(基础)", "tags": [ "Simulation Control" ] } }, "/api/v1/pressure-sensor-placement-sensitivities": { "post": { "description": "高级版本的压力传感器放置分析,通过JSON请求体提供详细参数。基于灵敏度分析方法确定最优放置位置。", "operationId": "post_pressure_sensor_placement_sensitivities", "parameters": [ { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PressureSensorPlacement", "description": "传感器放置分析参数" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "压力传感器放置-灵敏度分析(高级)", "tags": [ "Simulation Control" ] } }, "/api/v1/pressure-sensor-placement-sensitivity-calculations": { "post": { "description": "基于灵敏度分析方法,为指定管网项目确定最优的压力传感器放置位置。此为基础版本。", "operationId": "post_pressure_sensor_placement_sensitivity_calculations", "parameters": [ { "description": "放置方案名称", "in": "query", "name": "scheme_name", "required": true, "schema": { "description": "放置方案名称", "title": "Scheme Name", "type": "string" } }, { "description": "传感器数量", "in": "query", "name": "sensor_number", "required": true, "schema": { "description": "传感器数量", "title": "Sensor Number", "type": "integer" } }, { "description": "最小管径限制(毫米)", "in": "query", "name": "min_diameter", "required": true, "schema": { "description": "最小管径限制(毫米)", "title": "Min Diameter", "type": "integer" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "压力传感器放置-灵敏度分析(基础)", "tags": [ "Simulation Control" ] } }, "/api/v1/project-codes": { "get": { "description": "获取服务器上所有可用的供水管网项目名称列表。", "operationId": "get_project_codes", "parameters": [ { "in": "query", "name": "limit", "required": false, "schema": { "default": 100, "maximum": 1000, "minimum": 1, "title": "Limit", "type": "integer" } }, { "in": "query", "name": "offset", "required": false, "schema": { "default": 0, "minimum": 0, "title": "Offset", "type": "integer" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_str_" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取项目列表", "tags": [ "Project" ] } }, "/api/v1/project-conversions": { "post": { "description": "将 EPANET 3.0 格式的 INP 内容转换为 2.x 格式。", "operationId": "post_project_conversions", "parameters": [ { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "转换 INP V3 为 V2", "tags": [ "Project" ] } }, "/api/v1/project-copies": { "post": { "description": "将现有项目复制为新项目。", "operationId": "post_project_copies", "parameters": [ { "description": "管网名称(或数据库名称)", "in": "query", "name": "source", "required": true, "schema": { "description": "管网名称(或数据库名称)", "title": "Source", "type": "string" } }, { "description": "管网名称(或数据库名称)", "in": "query", "name": "target", "required": true, "schema": { "description": "管网名称(或数据库名称)", "title": "Target", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "复制项目", "tags": [ "Project" ] } }, "/api/v1/project-managements": { "post": { "description": "高级版本的项目管理,通过JSON请求体提供详细的控制参数,包括泵控制策略、水箱初始水位和区域需水量控制。", "operationId": "post_project_managements", "parameters": [ { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectManagementRest", "description": "项目管理控制参数" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "title": "Response Post Project Managements", "type": "string" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "项目管理(高级)", "tags": [ "Simulation Control" ] } }, "/api/v1/project-return-dict-runs": { "post": { "description": "基于指定的管网项目运行标准水力模拟,返回JSON格式的字典,包含输出数据和报告文本。", "operationId": "post_project_return_dict_runs", "parameters": [ { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "title": "Response Post Project Return Dict Runs", "type": "object" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "运行项目模拟(返回字典)", "tags": [ "Simulation Control" ] } }, "/api/v1/project-runs": { "post": { "description": "基于指定的管网项目运行标准水力模拟,返回纯文本格式的模拟报告。", "operationId": "post_project_runs", "parameters": [ { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "text/plain": { "schema": { "type": "string" } } }, "description": "Successful Response" }, "401": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "运行项目模拟", "tags": [ "Simulation Control" ] } }, "/api/v1/projects": { "delete": { "description": "永久删除指定的供水管网项目。此操作不可恢复。", "operationId": "delete_projects", "parameters": [ { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "204": { "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "删除项目", "tags": [ "Project" ] }, "get": { "description": "获取当前用户有权限的所有项目列表", "operationId": "get_projects", "parameters": [ { "in": "query", "name": "limit", "required": false, "schema": { "default": 100, "maximum": 1000, "minimum": 1, "title": "Limit", "type": "integer" } }, { "in": "query", "name": "offset", "required": false, "schema": { "default": 0, "minimum": 0, "title": "Offset", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_ProjectSummaryResponse_" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "列出用户项目", "tags": [ "Metadata" ] }, "post": { "description": "创建一个新的供水管网项目。如果项目已存在,可能会覆盖或报错(取决于底层实现)。", "operationId": "post_projects", "parameters": [ { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "创建新项目", "tags": [ "Project" ] } }, "/api/v1/projects/current": { "delete": { "description": "将指定项目从内存中卸载,释放资源。", "operationId": "delete_projects_current", "parameters": [ { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "204": { "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "关闭项目", "tags": [ "Project" ] }, "get": { "description": "从数据库获取项目的详细信息,包括地图范围等。", "operationId": "get_projects_current", "parameters": [ { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectMetaResponse" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取项目信息", "tags": [ "Project" ] }, "post": { "description": "将指定项目加载到内存中,并初始化数据库连接池。", "operationId": "post_projects_current", "parameters": [ { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "打开项目", "tags": [ "Project" ] } }, "/api/v1/projects/current/database-health": { "get": { "description": "检查项目数据库连接的健康状况", "operationId": "get_projects_current_database_health", "parameters": [ { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "检查数据库健康状态", "tags": [ "Metadata" ] } }, "/api/v1/projects/current/exports/change-set": { "get": { "description": "导出项目的变更集 (ChangeSet),包含顶点、SCADA 元素、DMA、SA、VD 等信息。", "operationId": "get_projects_current_exports_change_set", "parameters": [ { "description": "版本号 (通常用于增量更新)", "in": "query", "name": "version", "required": true, "schema": { "description": "版本号 (通常用于增量更新)", "title": "Version", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "导出项目为 ChangeSet", "tags": [ "Project" ] } }, "/api/v1/projects/current/exports/inp": { "post": { "description": "将项目当前状态保存为 INP 文件到服务器文件系统。", "operationId": "post_projects_current_exports_inp", "parameters": [ { "description": "目标文件名", "in": "query", "name": "inp", "required": true, "schema": { "description": "目标文件名", "title": "Inp", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "title": "Response Post Projects Current Exports Inp", "type": "boolean" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "导出项目到 INP 文件", "tags": [ "Project" ] } }, "/api/v1/projects/current/files/inp": { "get": { "description": "从服务器数据目录下载指定的 INP 文件。", "operationId": "get_projects_current_files_inp", "parameters": [ { "description": "文件名", "in": "query", "name": "name", "required": true, "schema": { "description": "文件名", "title": "Name", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "下载 INP 文件", "tags": [ "Project" ] } }, "/api/v1/projects/current/imports": { "post": { "description": "从服务器文件系统中读取指定的 INP 文件并加载到项目中。", "operationId": "post_projects_current_imports", "parameters": [ { "description": "INP 文件名 (不包含路径)", "in": "query", "name": "inp", "required": true, "schema": { "description": "INP 文件名 (不包含路径)", "title": "Inp", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "title": "Response Post Projects Current Imports", "type": "boolean" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "读取 INP 文件到项目", "tags": [ "Project" ] } }, "/api/v1/projects/current/lock": { "delete": { "description": "释放对项目的锁定。", "operationId": "delete_projects_current_lock", "parameters": [ { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "204": { "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "解锁项目", "tags": [ "Project" ] }, "get": { "description": "检查指定项目是否处于锁定状态。", "operationId": "get_projects_current_lock", "parameters": [ { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "检查项目是否被锁定", "tags": [ "Project" ] }, "post": { "description": "锁定指定项目以防止并发修改。", "operationId": "post_projects_current_lock", "parameters": [ { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "锁定项目", "tags": [ "Project" ] } }, "/api/v1/projects/current/lock/ownership": { "get": { "description": "检查指定项目是否被当前客户端 (IP) 锁定。", "operationId": "get_projects_current_lock_ownership", "parameters": [ { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "检查项目是否被当前用户锁定", "tags": [ "Project" ] } }, "/api/v1/projects/current/metadata": { "get": { "description": "获取当前项目的元数据和配置信息", "operationId": "get_projects_current_metadata", "parameters": [ { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectMetaResponse" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取项目元数据", "tags": [ "Metadata" ] } }, "/api/v1/projects/current/status": { "get": { "description": "检查指定项目是否已被加载到内存中。", "operationId": "get_projects_current_status", "parameters": [ { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "检查项目是否已打开", "tags": [ "Project" ] } }, "/api/v1/projects/existence": { "get": { "description": "检查指定名称的项目是否存在。", "operationId": "get_projects_existence", "parameters": [ { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "检查项目是否存在", "tags": [ "Project" ] } }, "/api/v1/pump-failure-events": { "post": { "description": "记录和管理泵的故障状态,包括故障发生时间和受影响的泵列表。系统将记录故障日志并更新泵状态。", "operationId": "post_pump_failure_events", "parameters": [ { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PumpFailureState", "description": "泵故障状态信息" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "title": "Response Post Pump Failure Events", "type": "string" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "泵故障管理", "tags": [ "Simulation Control" ] } }, "/api/v1/pumps": { "delete": { "description": "从网络中删除指定的水泵", "operationId": "delete_pumps", "parameters": [ { "description": "要删除的水泵ID", "in": "query", "name": "pump", "required": true, "schema": { "description": "要删除的水泵ID", "title": "Pump", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "204": { "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "删除水泵", "tags": [ "Pumps" ] }, "get": { "description": "获取网络中所有水泵的属性信息列表", "operationId": "get_pumps", "parameters": [ { "in": "query", "name": "limit", "required": false, "schema": { "default": 100, "maximum": 1000, "minimum": 1, "title": "Limit", "type": "integer" } }, { "in": "query", "name": "offset", "required": false, "schema": { "default": 0, "minimum": 0, "title": "Offset", "type": "integer" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_dict_str__Any__" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取所有水泵属性", "tags": [ "Pumps" ] }, "post": { "description": "向网络中添加新的水泵,需要提供水泵的基本参数如功率等", "operationId": "post_pumps", "parameters": [ { "description": "水泵标识符", "in": "query", "name": "pump", "required": true, "schema": { "description": "水泵标识符", "title": "Pump", "type": "string" } }, { "description": "水泵起始节点ID", "in": "query", "name": "node1", "required": true, "schema": { "description": "水泵起始节点ID", "title": "Node1", "type": "string" } }, { "description": "水泵终止节点ID", "in": "query", "name": "node2", "required": true, "schema": { "description": "水泵终止节点ID", "title": "Node2", "type": "string" } }, { "description": "水泵功率(单位:千瓦)", "in": "query", "name": "power", "required": false, "schema": { "default": 0.0, "description": "水泵功率(单位:千瓦)", "title": "Power", "type": "number" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "添加水泵", "tags": [ "Pumps" ] } }, "/api/v1/pumps/existence": { "get": { "description": "检查指定ID是否为水网中的泵", "operationId": "get_pumps_existence", "parameters": [ { "description": "管线ID", "in": "query", "name": "link", "required": true, "schema": { "description": "管线ID", "title": "Link", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "title": "Response Get Pumps Existence", "type": "boolean" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "检查是否为泵", "tags": [ "Network General" ] } }, "/api/v1/pumps/node1": { "get": { "description": "获取指定水泵的起始节点ID", "operationId": "get_pumps_node1", "parameters": [ { "description": "水泵ID", "in": "query", "name": "pump", "required": true, "schema": { "description": "水泵ID", "title": "Pump", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Response Get Pumps Node1" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取水泵起始节点", "tags": [ "Pumps" ] }, "patch": { "description": "设置指定水泵的起始节点", "operationId": "patch_pumps_node1", "parameters": [ { "description": "水泵ID", "in": "query", "name": "pump", "required": true, "schema": { "description": "水泵ID", "title": "Pump", "type": "string" } }, { "description": "新的起始节点ID", "in": "query", "name": "node1", "required": true, "schema": { "description": "新的起始节点ID", "title": "Node1", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "设置水泵起始节点", "tags": [ "Pumps" ] } }, "/api/v1/pumps/node2": { "get": { "description": "获取指定水泵的终止节点ID", "operationId": "get_pumps_node2", "parameters": [ { "description": "水泵ID", "in": "query", "name": "pump", "required": true, "schema": { "description": "水泵ID", "title": "Pump", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Response Get Pumps Node2" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取水泵终止节点", "tags": [ "Pumps" ] }, "patch": { "description": "设置指定水泵的终止节点", "operationId": "patch_pumps_node2", "parameters": [ { "description": "水泵ID", "in": "query", "name": "pump", "required": true, "schema": { "description": "水泵ID", "title": "Pump", "type": "string" } }, { "description": "新的终止节点ID", "in": "query", "name": "node2", "required": true, "schema": { "description": "新的终止节点ID", "title": "Node2", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "设置水泵终止节点", "tags": [ "Pumps" ] } }, "/api/v1/pumps/properties": { "get": { "description": "获取指定水泵的所有属性信息", "operationId": "get_pumps_properties", "parameters": [ { "description": "水泵ID", "in": "query", "name": "pump", "required": true, "schema": { "description": "水泵ID", "title": "Pump", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "title": "Response Get Pumps Properties", "type": "object" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取水泵属性", "tags": [ "Pumps" ] }, "patch": { "description": "批量设置指定水泵的多个属性", "operationId": "patch_pumps_properties", "parameters": [ { "description": "水泵ID", "in": "query", "name": "pump", "required": true, "schema": { "description": "水泵ID", "title": "Pump", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "设置水泵属性", "tags": [ "Pumps" ] } }, "/api/v1/quality-configurations/properties": { "get": { "description": "获取指定节点的水质属性信息", "operationId": "get_quality_configurations_properties", "parameters": [ { "description": "节点ID", "in": "query", "name": "node", "required": true, "schema": { "description": "节点ID", "title": "Node", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "title": "Response Get Quality Configurations Properties", "type": "object" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取水质属性", "tags": [ "Quality" ] }, "patch": { "description": "更新指定节点的水质属性", "operationId": "patch_quality_configurations_properties", "parameters": [ { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "设置水质属性", "tags": [ "Quality" ] } }, "/api/v1/reactions": { "patch": { "description": "更新指定网络中的反应属性", "operationId": "patch_reactions", "parameters": [ { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "设置反应属性", "tags": [ "Quality" ] } }, "/api/v1/reactions/detail": { "get": { "description": "获取指定网络中的反应属性信息", "operationId": "get_reactions_detail", "parameters": [ { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "title": "Response Get Reactions Detail", "type": "object" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取反应属性", "tags": [ "Quality" ] } }, "/api/v1/redis": { "get": { "description": "获取Redis中所有的缓存键", "operationId": "get_redis", "parameters": [ { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "查询缓存键列表", "tags": [ "Cache" ] } }, "/api/v1/redis-keys": { "delete": { "description": "根据模式清除匹配的Redis缓存键", "operationId": "delete_redis_keys", "parameters": [ { "description": "缓存键模式(支持通配符)", "in": "query", "name": "keys", "required": true, "schema": { "description": "缓存键模式(支持通配符)", "title": "Keys", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "204": { "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "清除匹配的缓存键", "tags": [ "Cache" ] } }, "/api/v1/redis-keys/detail": { "delete": { "description": "根据键名清除单个Redis缓存", "operationId": "delete_redis_keys_detail", "parameters": [ { "description": "缓存键名", "in": "query", "name": "key", "required": true, "schema": { "description": "缓存键名", "title": "Key", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "204": { "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "清除单个缓存键", "tags": [ "Cache" ] } }, "/api/v1/redos": { "post": { "description": "重做网络上被撤销的操作", "operationId": "post_redos", "parameters": [ { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "重做操作", "tags": [ "Snapshots" ] } }, "/api/v1/regions": { "delete": { "description": "删除指定的区域", "operationId": "delete_regions", "parameters": [ { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "204": { "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "删除区域", "tags": [ "Regions & DMAs" ] }, "patch": { "description": "修改指定区域的属性信息", "operationId": "patch_regions", "parameters": [ { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "设置区域属性", "tags": [ "Regions & DMAs" ] }, "post": { "description": "向水网添加一个新的区域", "operationId": "post_regions", "parameters": [ { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "添加新区域", "tags": [ "Regions & DMAs" ] } }, "/api/v1/regions/detail": { "get": { "description": "获取指定ID的区域详细信息", "operationId": "get_regions_detail", "parameters": [ { "description": "区域ID", "in": "query", "name": "id", "required": true, "schema": { "description": "区域ID", "title": "Id", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "title": "Response Get Regions Detail", "type": "object" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取区域信息", "tags": [ "Regions & DMAs" ] } }, "/api/v1/reservoirs": { "delete": { "description": "从指定供水网络中删除指定的水库/水源节点", "operationId": "delete_reservoirs", "parameters": [ { "description": "要删除的水库的唯一标识符", "in": "query", "name": "reservoir", "required": true, "schema": { "description": "要删除的水库的唯一标识符", "title": "Reservoir", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "204": { "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "删除水库", "tags": [ "Reservoirs" ] }, "get": { "description": "获取指定供水网络中所有水库的属性", "operationId": "get_reservoirs", "parameters": [ { "in": "query", "name": "limit", "required": false, "schema": { "default": 100, "maximum": 1000, "minimum": 1, "title": "Limit", "type": "integer" } }, { "in": "query", "name": "offset", "required": false, "schema": { "default": 0, "minimum": 0, "title": "Offset", "type": "integer" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_dict_str__Any__" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取所有水库属性", "tags": [ "Reservoirs" ] }, "post": { "description": "在指定供水网络中添加新的水库/水源节点", "operationId": "post_reservoirs", "parameters": [ { "description": "水库的唯一标识符", "in": "query", "name": "reservoir", "required": true, "schema": { "description": "水库的唯一标识符", "title": "Reservoir", "type": "string" } }, { "description": "水库的X坐标", "in": "query", "name": "x", "required": true, "schema": { "description": "水库的X坐标", "title": "X", "type": "number" } }, { "description": "水库的Y坐标", "in": "query", "name": "y", "required": true, "schema": { "description": "水库的Y坐标", "title": "Y", "type": "number" } }, { "description": "水库的水头/总水头(米)", "in": "query", "name": "head", "required": true, "schema": { "description": "水库的水头/总水头(米)", "title": "Head", "type": "number" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "添加水库", "tags": [ "Reservoirs" ] } }, "/api/v1/reservoirs/coord": { "get": { "description": "获取指定水库的平面坐标(X和Y坐标)", "operationId": "get_reservoirs_coord", "parameters": [ { "description": "水库的唯一标识符", "in": "query", "name": "reservoir", "required": true, "schema": { "description": "水库的唯一标识符", "title": "Reservoir", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "anyOf": [ { "additionalProperties": { "type": "number" }, "type": "object" }, { "type": "null" } ], "title": "Response Get Reservoirs Coord" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取水库坐标", "tags": [ "Reservoirs" ] }, "patch": { "description": "更新指定水库的平面坐标(X和Y坐标)", "operationId": "patch_reservoirs_coord", "parameters": [ { "description": "水库的唯一标识符", "in": "query", "name": "reservoir", "required": true, "schema": { "description": "水库的唯一标识符", "title": "Reservoir", "type": "string" } }, { "description": "新的X坐标值", "in": "query", "name": "x", "required": true, "schema": { "description": "新的X坐标值", "title": "X", "type": "number" } }, { "description": "新的Y坐标值", "in": "query", "name": "y", "required": true, "schema": { "description": "新的Y坐标值", "title": "Y", "type": "number" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "设置水库坐标", "tags": [ "Reservoirs" ] } }, "/api/v1/reservoirs/existence": { "get": { "description": "检查指定ID是否为水网中的水源(水库/河流)", "operationId": "get_reservoirs_existence", "parameters": [ { "description": "节点ID", "in": "query", "name": "node", "required": true, "schema": { "description": "节点ID", "title": "Node", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "title": "Response Get Reservoirs Existence", "type": "boolean" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "检查是否为水源", "tags": [ "Network General" ] } }, "/api/v1/reservoirs/head": { "get": { "description": "获取指定水库的供水水头/总水头值", "operationId": "get_reservoirs_head", "parameters": [ { "description": "水库的唯一标识符", "in": "query", "name": "reservoir", "required": true, "schema": { "description": "水库的唯一标识符", "title": "Reservoir", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Response Get Reservoirs Head" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取水库水头", "tags": [ "Reservoirs" ] }, "patch": { "description": "更新指定水库的供水水头/总水头值", "operationId": "patch_reservoirs_head", "parameters": [ { "description": "水库的唯一标识符", "in": "query", "name": "reservoir", "required": true, "schema": { "description": "水库的唯一标识符", "title": "Reservoir", "type": "string" } }, { "description": "新的水头值(米)", "in": "query", "name": "head", "required": true, "schema": { "description": "新的水头值(米)", "title": "Head", "type": "number" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "设置水库水头", "tags": [ "Reservoirs" ] } }, "/api/v1/reservoirs/pattern": { "get": { "description": "获取指定水库的运行模式/供水模式", "operationId": "get_reservoirs_pattern", "parameters": [ { "description": "水库的唯一标识符", "in": "query", "name": "reservoir", "required": true, "schema": { "description": "水库的唯一标识符", "title": "Reservoir", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Response Get Reservoirs Pattern" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取水库模式", "tags": [ "Reservoirs" ] }, "patch": { "description": "更新指定水库的运行模式/供水模式", "operationId": "patch_reservoirs_pattern", "parameters": [ { "description": "水库的唯一标识符", "in": "query", "name": "reservoir", "required": true, "schema": { "description": "水库的唯一标识符", "title": "Reservoir", "type": "string" } }, { "description": "新的运行模式", "in": "query", "name": "pattern", "required": true, "schema": { "description": "新的运行模式", "title": "Pattern", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "设置水库模式", "tags": [ "Reservoirs" ] } }, "/api/v1/reservoirs/properties": { "get": { "description": "获取指定水库的所有属性", "operationId": "get_reservoirs_properties", "parameters": [ { "description": "水库的唯一标识符", "in": "query", "name": "reservoir", "required": true, "schema": { "description": "水库的唯一标识符", "title": "Reservoir", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "title": "Response Get Reservoirs Properties", "type": "object" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取水库属性", "tags": [ "Reservoirs" ] }, "patch": { "description": "批量更新指定水库的多个属性", "operationId": "patch_reservoirs_properties", "parameters": [ { "description": "水库的唯一标识符", "in": "query", "name": "reservoir", "required": true, "schema": { "description": "水库的唯一标识符", "title": "Reservoir", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "设置水库属性", "tags": [ "Reservoirs" ] } }, "/api/v1/reservoirs/x": { "get": { "description": "获取指定水库的X坐标位置", "operationId": "get_reservoirs_x", "parameters": [ { "description": "水库的唯一标识符", "in": "query", "name": "reservoir", "required": true, "schema": { "description": "水库的唯一标识符", "title": "Reservoir", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "anyOf": [ { "additionalProperties": { "type": "number" }, "type": "object" }, { "type": "null" } ], "title": "Response Get Reservoirs X" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取水库X坐标", "tags": [ "Reservoirs" ] }, "patch": { "description": "更新指定水库的X坐标位置", "operationId": "patch_reservoirs_x", "parameters": [ { "description": "水库的唯一标识符", "in": "query", "name": "reservoir", "required": true, "schema": { "description": "水库的唯一标识符", "title": "Reservoir", "type": "string" } }, { "description": "新的X坐标值", "in": "query", "name": "x", "required": true, "schema": { "description": "新的X坐标值", "title": "X", "type": "number" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "设置水库X坐标", "tags": [ "Reservoirs" ] } }, "/api/v1/reservoirs/y": { "get": { "description": "获取指定水库的Y坐标位置", "operationId": "get_reservoirs_y", "parameters": [ { "description": "水库的唯一标识符", "in": "query", "name": "reservoir", "required": true, "schema": { "description": "水库的唯一标识符", "title": "Reservoir", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "anyOf": [ { "additionalProperties": { "type": "number" }, "type": "object" }, { "type": "null" } ], "title": "Response Get Reservoirs Y" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取水库Y坐标", "tags": [ "Reservoirs" ] }, "patch": { "description": "更新指定水库的Y坐标位置", "operationId": "patch_reservoirs_y", "parameters": [ { "description": "水库的唯一标识符", "in": "query", "name": "reservoir", "required": true, "schema": { "description": "水库的唯一标识符", "title": "Reservoir", "type": "string" } }, { "description": "新的Y坐标值", "in": "query", "name": "y", "required": true, "schema": { "description": "新的Y坐标值", "title": "Y", "type": "number" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "设置水库Y坐标", "tags": [ "Reservoirs" ] } }, "/api/v1/restore-operations": { "get": { "description": "获取网络的恢复操作ID", "operationId": "get_restore_operations", "parameters": [ { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "title": "Response Get Restore Operations", "type": "integer" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取恢复操作ID", "tags": [ "Snapshots" ] }, "patch": { "description": "设置网络的恢复操作ID", "operationId": "patch_restore_operations", "parameters": [ { "description": "操作ID", "in": "query", "name": "operation", "required": true, "schema": { "description": "操作ID", "title": "Operation", "type": "integer" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "设置恢复操作ID", "tags": [ "Snapshots" ] } }, "/api/v1/rule-properties": { "get": { "description": "获取指定网络中的规则属性信息", "operationId": "get_rule_properties", "parameters": [ { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "title": "Response Get Rule Properties", "type": "object" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取规则属性", "tags": [ "Controls & Rules" ] }, "patch": { "description": "更新指定网络中的规则属性", "operationId": "patch_rule_properties", "parameters": [ { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "设置规则属性", "tags": [ "Controls & Rules" ] } }, "/api/v1/rule-schemas": { "get": { "description": "获取网络中规则对象的架构定义", "operationId": "get_rule_schemas", "parameters": [ { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": { "type": "object" }, "title": "Response Get Rule Schemas", "type": "object" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取规则架构", "tags": [ "Controls & Rules" ] } }, "/api/v1/scada-device-cleaning-runs": { "post": { "description": "清空SCADA设备表\n\n删除指定管网中所有的SCADA设备。\n\nArgs:\n network: 管网名称(或数据库名称)\n \nReturns:\n 变更集合信息", "operationId": "post_scada_device_cleaning_runs", "parameters": [ { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "清空SCADA设备表", "tags": [ "SCADA设备" ] } }, "/api/v1/scada-device-data-cleaning-runs": { "post": { "description": "清空SCADA设备数据表\n\n删除指定管网中所有SCADA设备的数据。\n\nArgs:\n network: 管网名称(或数据库名称)\n \nReturns:\n 变更集合信息", "operationId": "post_scada_device_data_cleaning_runs", "parameters": [ { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "清空SCADA设备数据表", "tags": [ "SCADA设备数据" ] } }, "/api/v1/scada-device-datas": { "delete": { "description": "删除SCADA设备数据\n\n删除指定SCADA设备的数据记录。\n\nArgs:\n network: 管网名称(或数据库名称)\n req: 请求体,包含要删除的数据ID\n \nReturns:\n 变更集合信息", "operationId": "delete_scada_device_datas", "parameters": [ { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "204": { "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "删除SCADA设备数据", "tags": [ "SCADA设备数据" ] }, "patch": { "description": "更新SCADA设备数据\n\n修改指定SCADA设备的数据。\n\nArgs:\n network: 管网名称(或数据库名称)\n req: 请求体,包含要更新的数据\n \nReturns:\n 变更集合信息", "operationId": "patch_scada_device_datas", "parameters": [ { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "更新SCADA设备数据", "tags": [ "SCADA设备数据" ] }, "post": { "description": "添加新的SCADA设备数据\n\n为指定SCADA设备添加新的数据记录。\n\nArgs:\n network: 管网名称(或数据库名称)\n req: 请求体,包含新数据的内容\n \nReturns:\n 变更集合信息", "operationId": "post_scada_device_datas", "parameters": [ { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "添加SCADA设备数据", "tags": [ "SCADA设备数据" ] } }, "/api/v1/scada-device-datas/detail": { "get": { "description": "获取单个SCADA设备的数据\n\n查询指定设备的监测数据或配置数据。\n\nArgs:\n network: 管网名称(或数据库名称)\n device_id: SCADA设备ID\n \nReturns:\n SCADA设备数据", "operationId": "get_scada_device_datas_detail", "parameters": [ { "description": "SCADA设备ID", "in": "query", "name": "device_id", "required": true, "schema": { "description": "SCADA设备ID", "title": "Device Id", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "title": "Response Get Scada Device Datas Detail", "type": "object" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取SCADA设备数据", "tags": [ "SCADA设备数据" ] } }, "/api/v1/scada-devices": { "delete": { "description": "删除SCADA设备\n\n从指定管网中删除一个SCADA设备。\n\nArgs:\n network: 管网名称(或数据库名称)\n req: 请求体,包含要删除的设备ID\n \nReturns:\n 变更集合信息", "operationId": "delete_scada_devices", "parameters": [ { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "204": { "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "删除SCADA设备", "tags": [ "SCADA设备" ] }, "get": { "description": "获取指定管网所有SCADA设备的完整信息\n\nArgs:\n network: 管网名称(或数据库名称)\n \nReturns:\n SCADA设备信息列表", "operationId": "get_scada_devices", "parameters": [ { "in": "query", "name": "limit", "required": false, "schema": { "default": 100, "maximum": 1000, "minimum": 1, "title": "Limit", "type": "integer" } }, { "in": "query", "name": "offset", "required": false, "schema": { "default": 0, "minimum": 0, "title": "Offset", "type": "integer" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_dict_str__Any__" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取所有SCADA设备", "tags": [ "SCADA设备" ] }, "patch": { "description": "更新SCADA设备信息\n\n修改指定SCADA设备的属性。\n\nArgs:\n network: 管网名称(或数据库名称)\n req: 请求体,包含要更新的设备属性\n \nReturns:\n 变更集合信息", "operationId": "patch_scada_devices", "parameters": [ { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "更新SCADA设备", "tags": [ "SCADA设备" ] }, "post": { "description": "添加新的SCADA设备\n\n在指定管网中添加一个新的SCADA设备。\n\nArgs:\n network: 管网名称(或数据库名称)\n req: 请求体,包含新设备的属性\n \nReturns:\n 变更集合信息", "operationId": "post_scada_devices", "parameters": [ { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "添加SCADA设备", "tags": [ "SCADA设备" ] } }, "/api/v1/scada-devices/detail": { "get": { "description": "获取单个SCADA设备的信息\n\n根据设备ID查询该设备的详细信息。\n\nArgs:\n network: 管网名称(或数据库名称)\n id: SCADA设备ID\n \nReturns:\n SCADA设备信息", "operationId": "get_scada_devices_detail", "parameters": [ { "description": "SCADA设备ID", "in": "query", "name": "id", "required": true, "schema": { "description": "SCADA设备ID", "title": "Id", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "title": "Response Get Scada Devices Detail", "type": "object" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取SCADA设备", "tags": [ "SCADA设备" ] } }, "/api/v1/scada-devices/ids": { "get": { "description": "获取指定管网所有SCADA设备的ID列表\n\nArgs:\n network: 管网名称(或数据库名称)\n \nReturns:\n SCADA设备ID列表", "operationId": "get_scada_devices_ids", "parameters": [ { "in": "query", "name": "limit", "required": false, "schema": { "default": 100, "maximum": 1000, "minimum": 1, "title": "Limit", "type": "integer" } }, { "in": "query", "name": "offset", "required": false, "schema": { "default": 0, "minimum": 0, "title": "Offset", "type": "integer" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_str_" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取所有SCADA设备ID", "tags": [ "SCADA设备" ] } }, "/api/v1/scada-element-cleaning-runs": { "post": { "description": "清空SCADA元素映射表\n\n删除指定管网中所有的SCADA元素映射。\n\nArgs:\n network: 管网名称(或数据库名称)\n \nReturns:\n 变更集合信息", "operationId": "post_scada_element_cleaning_runs", "parameters": [ { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "清空SCADA元素映射表", "tags": [ "SCADA元素映射" ] } }, "/api/v1/scada-elements": { "delete": { "description": "删除SCADA元素映射\n\n移除SCADA设备与管网元素的映射关系。\n\nArgs:\n network: 管网名称(或数据库名称)\n req: 请求体,包含要删除的映射ID\n \nReturns:\n 变更集合信息", "operationId": "delete_scada_elements", "parameters": [ { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "204": { "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "删除SCADA元素映射", "tags": [ "SCADA元素映射" ] }, "get": { "description": "获取指定管网所有SCADA元素映射\n\n查询所有SCADA设备与管网元素(节点/管道)的映射关系。\n\nArgs:\n network: 管网名称(或数据库名称)\n \nReturns:\n SCADA元素映射列表", "operationId": "get_scada_elements", "parameters": [ { "in": "query", "name": "limit", "required": false, "schema": { "default": 100, "maximum": 1000, "minimum": 1, "title": "Limit", "type": "integer" } }, { "in": "query", "name": "offset", "required": false, "schema": { "default": 0, "minimum": 0, "title": "Offset", "type": "integer" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_dict_str__Any__" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取所有SCADA元素映射", "tags": [ "SCADA元素映射" ] }, "patch": { "description": "更新SCADA元素映射\n\n修改SCADA设备与管网元素的映射关系。\n\nArgs:\n network: 管网名称(或数据库名称)\n req: 请求体,包含要更新的映射信息\n \nReturns:\n 变更集合信息", "operationId": "patch_scada_elements", "parameters": [ { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "更新SCADA元素映射", "tags": [ "SCADA元素映射" ] }, "post": { "description": "添加新的SCADA元素映射\n\n创建SCADA设备与管网元素的新映射关系。\n\nArgs:\n network: 管网名称(或数据库名称)\n req: 请求体,包含新映射的信息\n \nReturns:\n 变更集合信息", "operationId": "post_scada_elements", "parameters": [ { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "添加SCADA元素映射", "tags": [ "SCADA元素映射" ] } }, "/api/v1/scada-elements/detail": { "get": { "description": "获取单个SCADA元素映射的信息\n\n根据ID查询特定的SCADA设备与管网元素的映射关系。\n\nArgs:\n network: 管网名称(或数据库名称)\n id: SCADA元素映射ID\n \nReturns:\n SCADA元素映射信息", "operationId": "get_scada_elements_detail", "parameters": [ { "description": "SCADA元素映射ID", "in": "query", "name": "id", "required": true, "schema": { "description": "SCADA元素映射ID", "title": "Id", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "title": "Response Get Scada Elements Detail", "type": "object" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取单个SCADA元素映射", "tags": [ "SCADA元素映射" ] } }, "/api/v1/scada-info": { "get": { "description": "获取指定管网所有SCADA的信息\n\n查询该管网下所有已配置的SCADA的完整信息。\n\nArgs:\n network: 管网名称(或数据库名称)\n \nReturns:\n SCADA信息列表", "operationId": "get_scada_info", "parameters": [ { "in": "query", "name": "limit", "required": false, "schema": { "default": 100, "maximum": 1000, "minimum": 1, "title": "Limit", "type": "integer" } }, { "in": "query", "name": "offset", "required": false, "schema": { "default": 0, "minimum": 0, "title": "Offset", "type": "integer" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_dict_str__Any__" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取所有SCADA信息", "tags": [ "SCADA信息" ] } }, "/api/v1/scada-info-schemas": { "get": { "description": "获取SCADA信息表的结构\n\n返回SCADA信息表的字段定义和类型信息。\n\nArgs:\n network: 管网名称(或数据库名称)\n \nReturns:\n SCADA信息的字段架构信息", "operationId": "get_scada_info_schemas", "parameters": [ { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": { "type": "object" }, "title": "Response Get Scada Info Schemas", "type": "object" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取SCADA信息架构", "tags": [ "SCADA信息" ] } }, "/api/v1/scada-info/database-view": { "get": { "description": "使用连接池查询所有SCADA信息", "operationId": "get_scada_info_database_view", "parameters": [ { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取SCADA信息", "tags": [ "Project Data" ] } }, "/api/v1/scada-info/detail": { "get": { "description": "获取单个SCADA信息\n\n根据ID查询SCADA的详细配置信息。\n\nArgs:\n network: 管网名称(或数据库名称)\n id: SCADA信息ID\n \nReturns:\n SCADA信息详情", "operationId": "get_scada_info_detail", "parameters": [ { "description": "SCADA信息ID", "in": "query", "name": "id", "required": true, "schema": { "description": "SCADA信息ID", "title": "Id", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "title": "Response Get Scada Info Detail", "type": "object" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取SCADA信息", "tags": [ "SCADA信息" ] } }, "/api/v1/scada-properties": { "get": { "description": "获取指定SCADA点的属性信息", "operationId": "get_scada_properties", "parameters": [ { "description": "SCADA点ID", "in": "query", "name": "scada", "required": true, "schema": { "description": "SCADA点ID", "title": "Scada", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "title": "Response Get Scada Properties", "type": "object" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取SCADA点属性", "tags": [ "Network General" ] } }, "/api/v1/scheduling-analyses": { "post": { "description": "对管网的供水排程进行分析,优化泵的运行时间和出水流量,平衡水厂出水、水箱进出水,满足用户需求。", "operationId": "post_scheduling_analyses", "parameters": [ { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SchedulingAnalysisRest", "description": "排程分析参数" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "title": "Response Post Scheduling Analyses", "type": "string" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "排程分析", "tags": [ "Simulation Control" ] } }, "/api/v1/schemes": { "get": { "description": "获取指定网络的所有方案信息", "operationId": "get_schemes", "parameters": [ { "description": "方案类型;为空时返回全部类型", "in": "query", "name": "scheme_type", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "方案类型;为空时返回全部类型", "title": "Scheme Type" } }, { "description": "查询日期(可选)", "in": "query", "name": "query_date", "required": false, "schema": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "查询日期(可选)", "title": "Query Date" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 100, "maximum": 1000, "minimum": 1, "title": "Limit", "type": "integer" } }, { "in": "query", "name": "offset", "required": false, "schema": { "default": 0, "minimum": 0, "title": "Offset", "type": "integer" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_dict_Any__Any__" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取所有方案", "tags": [ "Schemes" ] } }, "/api/v1/schemes/detail": { "get": { "description": "根据名称获取指定的方案信息", "operationId": "get_schemes_detail", "parameters": [ { "description": "方案名称", "in": "query", "name": "schema_name", "required": true, "schema": { "description": "方案名称", "title": "Schema Name", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "title": "Response Get Schemes Detail", "type": "object" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取单个方案", "tags": [ "Schemes" ] } }, "/api/v1/schemes/list-with-connection": { "get": { "description": "使用连接池查询所有方案信息", "operationId": "get_schemes_list_with_connection", "parameters": [ { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取方案列表", "tags": [ "Project Data" ] } }, "/api/v1/schemes/{scheme_name}": { "get": { "description": "按方案类型获取指定方案详情", "operationId": "get_schemes_scheme_name", "parameters": [ { "description": "方案名称", "in": "path", "name": "scheme_name", "required": true, "schema": { "description": "方案名称", "title": "Scheme Name", "type": "string" } }, { "description": "方案类型;为空时返回通用方案详情", "in": "query", "name": "scheme_type", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "方案类型;为空时返回通用方案详情", "title": "Scheme Type" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "title": "Response Get Schemes Scheme Name", "type": "object" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取方案详情", "tags": [ "Schemes" ] } }, "/api/v1/sensor-placement-optimization-runs": { "post": { "operationId": "post_sensor_placement_optimization_runs", "parameters": [ { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SensorPlacementOptimizeRequestRest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SensorPlacementSchemeResponse" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "创建并返回监测点优化方案", "tags": [ "Sensor Placement" ] } }, "/api/v1/sensor-placement-schemes": { "get": { "description": "获取网络中所有传感器的放置位置信息", "operationId": "get_sensor_placement_schemes", "parameters": [ { "in": "query", "name": "limit", "required": false, "schema": { "default": 100, "maximum": 1000, "minimum": 1, "title": "Limit", "type": "integer" } }, { "in": "query", "name": "offset", "required": false, "schema": { "default": 0, "minimum": 0, "title": "Offset", "type": "integer" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_dict_Any__Any__" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取所有传感器位置", "tags": [ "Misc" ] }, "post": { "description": "创建新的传感器放置方案,支持灵敏度分析和KMeans聚类两种方法。根据指定的方法自动计算最优的传感器放置位置。", "operationId": "post_sensor_placement_schemes", "parameters": [ { "description": "放置方案名称", "in": "query", "name": "scheme_name", "required": true, "schema": { "description": "放置方案名称", "title": "Scheme Name", "type": "string" } }, { "description": "传感器类型", "in": "query", "name": "sensor_type", "required": true, "schema": { "description": "传感器类型", "title": "Sensor Type", "type": "string" } }, { "description": "放置方法('sensitivity'或'kmeans')", "in": "query", "name": "method", "required": true, "schema": { "description": "放置方法('sensitivity'或'kmeans')", "title": "Method", "type": "string" } }, { "description": "传感器数量", "in": "query", "name": "sensor_count", "required": true, "schema": { "description": "传感器数量", "title": "Sensor Count", "type": "integer" } }, { "description": "最小管径限制(毫米),默认0", "in": "query", "name": "min_diameter", "required": false, "schema": { "default": 0, "description": "最小管径限制(毫米),默认0", "title": "Min Diameter", "type": "integer" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "201": { "content": { "application/json": { "schema": { "title": "Response Post Sensor Placement Schemes", "type": "string" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "传感器放置方案创建", "tags": [ "Simulation Control" ] } }, "/api/v1/sensor-placement-schemes/{scheme_id}": { "get": { "operationId": "get_sensor_placement_schemes_scheme_id", "parameters": [ { "in": "path", "name": "scheme_id", "required": true, "schema": { "title": "Scheme Id", "type": "integer" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SensorPlacementSchemeResponse" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取监测点方案详情", "tags": [ "Sensor Placement" ] }, "put": { "operationId": "put_sensor_placement_schemes_scheme_id", "parameters": [ { "in": "path", "name": "scheme_id", "required": true, "schema": { "title": "Scheme Id", "type": "integer" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SensorPlacementUpdateRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SensorPlacementSchemeResponse" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "覆盖保存监测点方案", "tags": [ "Sensor Placement" ] } }, "/api/v1/sensor-placement-schemes/{scheme_id}/exports/excel": { "post": { "operationId": "post_sensor_placement_schemes_scheme_id_exports_excel", "parameters": [ { "in": "path", "name": "scheme_id", "required": true, "schema": { "title": "Scheme Id", "type": "integer" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SensorPlacementExportRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "导出监测点工程清单", "tags": [ "Sensor Placement" ] } }, "/api/v1/service-area-calculations": { "post": { "description": "计算指定水网的服务区分区,返回全部时间步结果", "operationId": "post_service_area_calculations", "parameters": [ { "in": "query", "name": "limit", "required": false, "schema": { "default": 100, "maximum": 1000, "minimum": 1, "title": "Limit", "type": "integer" } }, { "in": "query", "name": "offset", "required": false, "schema": { "default": 0, "minimum": 0, "title": "Offset", "type": "integer" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_dict_str__list_str___" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "计算服务区", "tags": [ "Regions & DMAs" ] } }, "/api/v1/service-area-generation-runs": { "post": { "description": "根据参数自动生成水网的服务区分区", "operationId": "post_service_area_generation_runs", "parameters": [ { "description": "膨胀参数", "in": "query", "name": "inflate_delta", "required": true, "schema": { "description": "膨胀参数", "title": "Inflate Delta", "type": "number" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "生成服务区分区", "tags": [ "Regions & DMAs" ] } }, "/api/v1/service-areas": { "delete": { "description": "删除指定的服务区", "operationId": "delete_service_areas", "parameters": [ { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "204": { "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "删除服务区", "tags": [ "Regions & DMAs" ] }, "get": { "description": "获取指定水网中的所有服务区信息", "operationId": "get_service_areas", "parameters": [ { "in": "query", "name": "limit", "required": false, "schema": { "default": 100, "maximum": 1000, "minimum": 1, "title": "Limit", "type": "integer" } }, { "in": "query", "name": "offset", "required": false, "schema": { "default": 0, "minimum": 0, "title": "Offset", "type": "integer" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_dict_str__Any__" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取所有服务区", "tags": [ "Regions & DMAs" ] }, "patch": { "description": "修改指定服务区的属性信息", "operationId": "patch_service_areas", "parameters": [ { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "设置服务区属性", "tags": [ "Regions & DMAs" ] }, "post": { "description": "向水网添加一个新的服务区", "operationId": "post_service_areas", "parameters": [ { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "添加新服务区", "tags": [ "Regions & DMAs" ] } }, "/api/v1/service-areas/detail": { "get": { "description": "获取指定ID的服务区详细信息", "operationId": "get_service_areas_detail", "parameters": [ { "description": "服务区ID", "in": "query", "name": "id", "required": true, "schema": { "description": "服务区ID", "title": "Id", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "title": "Response Get Service Areas Detail", "type": "object" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取服务区信息", "tags": [ "Regions & DMAs" ] } }, "/api/v1/simulation-runs": { "post": { "description": "根据指定的开始时间和持续时间,手动运行水力模拟。开始时间必须是显式带时区的 ISO 8601 / RFC3339 时间。", "operationId": "post_simulation_runs", "parameters": [ { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RunSimulationManuallyByDateRest", "description": "模拟运行参数" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": { "type": "string" }, "title": "Response Post Simulation Runs", "type": "object" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "手动运行日期指定模拟", "tags": [ "Simulation Control" ] } }, "/api/v1/snapshot-for-current-operations": { "get": { "description": "检查当前操作的快照是否存在", "operationId": "get_snapshot_for_current_operations", "parameters": [ { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "title": "Response Get Snapshot For Current Operations", "type": "boolean" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "检查当前操作快照是否存在", "tags": [ "Snapshots" ] }, "post": { "description": "为当前操作创建快照", "operationId": "post_snapshot_for_current_operations", "parameters": [ { "description": "快照标签", "in": "query", "name": "tag", "required": true, "schema": { "description": "快照标签", "title": "Tag", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "为当前操作创建快照", "tags": [ "Snapshots" ] } }, "/api/v1/snapshot-for-operations": { "get": { "description": "检查指定操作ID的快照是否存在", "operationId": "get_snapshot_for_operations", "parameters": [ { "description": "操作ID", "in": "query", "name": "operation", "required": true, "schema": { "description": "操作ID", "title": "Operation", "type": "integer" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "title": "Response Get Snapshot For Operations", "type": "boolean" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "检查操作快照是否存在", "tags": [ "Snapshots" ] }, "post": { "description": "为指定的操作创建快照", "operationId": "post_snapshot_for_operations", "parameters": [ { "description": "操作ID", "in": "query", "name": "operation", "required": true, "schema": { "description": "操作ID", "title": "Operation", "type": "integer" } }, { "description": "快照标签", "in": "query", "name": "tag", "required": true, "schema": { "description": "快照标签", "title": "Tag", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "为操作创建快照", "tags": [ "Snapshots" ] } }, "/api/v1/snapshots": { "get": { "description": "获取网络中的所有快照", "operationId": "get_snapshots", "parameters": [ { "in": "query", "name": "limit", "required": false, "schema": { "default": 100, "maximum": 1000, "minimum": 1, "title": "Limit", "type": "integer" } }, { "in": "query", "name": "offset", "required": false, "schema": { "default": 0, "minimum": 0, "title": "Offset", "type": "integer" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_tuple_int__str__" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取快照列表", "tags": [ "Snapshots" ] }, "patch": { "description": "选择并恢复到指定的快照", "operationId": "patch_snapshots", "parameters": [ { "description": "快照标签", "in": "query", "name": "tag", "required": true, "schema": { "description": "快照标签", "title": "Tag", "type": "string" } }, { "description": "是否丢弃当前更改", "in": "query", "name": "discard", "required": false, "schema": { "default": false, "description": "是否丢弃当前更改", "title": "Discard", "type": "boolean" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "选择快照", "tags": [ "Snapshots" ] }, "post": { "description": "为网络创建一个快照", "operationId": "post_snapshots", "parameters": [ { "description": "快照标签", "in": "query", "name": "tag", "required": true, "schema": { "description": "快照标签", "title": "Tag", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "创建快照", "tags": [ "Snapshots" ] } }, "/api/v1/snapshots/existence": { "get": { "description": "检查指定标签的快照是否存在", "operationId": "get_snapshots_existence", "parameters": [ { "description": "快照标签", "in": "query", "name": "tag", "required": true, "schema": { "description": "快照标签", "title": "Tag", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "title": "Response Get Snapshots Existence", "type": "boolean" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "检查快照是否存在", "tags": [ "Snapshots" ] } }, "/api/v1/sources": { "delete": { "description": "从网络中删除指定节点的水源", "operationId": "delete_sources", "parameters": [ { "description": "节点ID", "in": "query", "name": "node", "required": true, "schema": { "description": "节点ID", "title": "Node", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "204": { "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "删除水源", "tags": [ "Quality" ] }, "patch": { "description": "更新指定节点的水源属性", "operationId": "patch_sources", "parameters": [ { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "设置水源属性", "tags": [ "Quality" ] }, "post": { "description": "在网络中添加一个新的水源", "operationId": "post_sources", "parameters": [ { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "添加水源", "tags": [ "Quality" ] } }, "/api/v1/sources/detail": { "get": { "description": "获取指定节点的水源属性信息", "operationId": "get_sources_detail", "parameters": [ { "description": "节点ID", "in": "query", "name": "node", "required": true, "schema": { "description": "节点ID", "title": "Node", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "title": "Response Get Sources Detail", "type": "object" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取水源属性", "tags": [ "Quality" ] } }, "/api/v1/status": { "get": { "description": "获取指定管线的状态信息", "operationId": "get_status", "parameters": [ { "description": "管线ID", "in": "query", "name": "link", "required": true, "schema": { "description": "管线ID", "title": "Link", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "title": "Response Get Status", "type": "object" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取管线状态", "tags": [ "Network General" ] } }, "/api/v1/status-properties": { "patch": { "description": "设置指定管线的状态信息", "operationId": "patch_status_properties", "parameters": [ { "description": "管线ID", "in": "query", "name": "link", "required": true, "schema": { "description": "管线ID", "title": "Link", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "设置管线状态", "tags": [ "Network General" ] } }, "/api/v1/status-schemas": { "get": { "description": "获取指定水网的状态(Status)属性架构定义", "operationId": "get_status_schemas", "parameters": [ { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": { "type": "object" }, "title": "Response Get Status Schemas", "type": "object" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取状态属性架构", "tags": [ "Network General" ] } }, "/api/v1/sub-district-metering-areas": { "post": { "description": "为指定DMA生成子DMA分区", "operationId": "post_sub_district_metering_areas", "parameters": [ { "description": "DMA ID", "in": "query", "name": "dma", "required": true, "schema": { "description": "DMA ID", "title": "Dma", "type": "string" } }, { "description": "分区数量", "in": "query", "name": "part_count", "required": true, "schema": { "description": "分区数量", "exclusiveMinimum": 0, "title": "Part Count", "type": "integer" } }, { "description": "分区类型", "in": "query", "name": "part_type", "required": true, "schema": { "description": "分区类型", "title": "Part Type", "type": "integer" } }, { "description": "膨胀参数", "in": "query", "name": "inflate_delta", "required": true, "schema": { "description": "膨胀参数", "title": "Inflate Delta", "type": "number" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "生成DMA子分区", "tags": [ "Regions & DMAs" ] } }, "/api/v1/tags": { "get": { "description": "获取指定水网中的所有标签信息", "operationId": "get_tags", "parameters": [ { "in": "query", "name": "limit", "required": false, "schema": { "default": 100, "maximum": 1000, "minimum": 1, "title": "Limit", "type": "integer" } }, { "in": "query", "name": "offset", "required": false, "schema": { "default": 0, "minimum": 0, "title": "Offset", "type": "integer" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_dict_str__Any__" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取所有标签", "tags": [ "Tags" ] }, "patch": { "description": "为指定元素设置或修改标签信息", "operationId": "patch_tags", "parameters": [ { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "设置标签", "tags": [ "Tags" ] } }, "/api/v1/tags/detail": { "get": { "description": "获取指定类型和ID的标签信息", "operationId": "get_tags_detail", "parameters": [ { "description": "标签类型", "in": "query", "name": "t_type", "required": true, "schema": { "description": "标签类型", "title": "T Type", "type": "string" } }, { "description": "元素ID", "in": "query", "name": "id", "required": true, "schema": { "description": "元素ID", "title": "Id", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "title": "Response Get Tags Detail", "type": "object" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取标签信息", "tags": [ "Tags" ] } }, "/api/v1/tank-reactions": { "patch": { "description": "更新指定水池的反应属性", "operationId": "patch_tank_reactions", "parameters": [ { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "设置水池反应属性", "tags": [ "Quality" ] } }, "/api/v1/tank-reactions/detail": { "get": { "description": "获取指定水池的反应属性信息", "operationId": "get_tank_reactions_detail", "parameters": [ { "description": "水池ID", "in": "query", "name": "tank", "required": true, "schema": { "description": "水池ID", "title": "Tank", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "title": "Response Get Tank Reactions Detail", "type": "object" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取水池反应属性", "tags": [ "Quality" ] } }, "/api/v1/tanks": { "delete": { "description": "删除指定网络中的水箱", "operationId": "delete_tanks", "parameters": [ { "description": "水箱ID", "in": "query", "name": "tank", "required": true, "schema": { "description": "水箱ID", "title": "Tank", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "204": { "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "删除水箱", "tags": [ "Tanks" ] }, "get": { "description": "获取指定网络中所有水箱的属性", "operationId": "get_tanks", "parameters": [ { "in": "query", "name": "limit", "required": false, "schema": { "default": 100, "maximum": 1000, "minimum": 1, "title": "Limit", "type": "integer" } }, { "in": "query", "name": "offset", "required": false, "schema": { "default": 0, "minimum": 0, "title": "Offset", "type": "integer" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_dict_str__Any__" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取所有水箱属性", "tags": [ "Tanks" ] }, "post": { "description": "向指定网络中新增一个水箱", "operationId": "post_tanks", "parameters": [ { "description": "水箱ID", "in": "query", "name": "tank", "required": true, "schema": { "description": "水箱ID", "title": "Tank", "type": "string" } }, { "description": "X坐标", "in": "query", "name": "x", "required": true, "schema": { "description": "X坐标", "title": "X", "type": "number" } }, { "description": "Y坐标", "in": "query", "name": "y", "required": true, "schema": { "description": "Y坐标", "title": "Y", "type": "number" } }, { "description": "标高", "in": "query", "name": "elevation", "required": true, "schema": { "description": "标高", "title": "Elevation", "type": "number" } }, { "description": "初始水位", "in": "query", "name": "init_level", "required": false, "schema": { "default": 0, "description": "初始水位", "title": "Init Level", "type": "number" } }, { "description": "最小水位", "in": "query", "name": "min_level", "required": false, "schema": { "default": 0, "description": "最小水位", "title": "Min Level", "type": "number" } }, { "description": "最大水位", "in": "query", "name": "max_level", "required": false, "schema": { "default": 0, "description": "最大水位", "title": "Max Level", "type": "number" } }, { "description": "直径", "in": "query", "name": "diameter", "required": false, "schema": { "default": 0, "description": "直径", "title": "Diameter", "type": "number" } }, { "description": "最小体积", "in": "query", "name": "min_vol", "required": false, "schema": { "default": 0, "description": "最小体积", "title": "Min Vol", "type": "number" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "新增水箱", "tags": [ "Tanks" ] } }, "/api/v1/tanks/coord": { "get": { "description": "获取指定水箱的X和Y坐标", "operationId": "get_tanks_coord", "parameters": [ { "description": "水箱ID", "in": "query", "name": "tank", "required": true, "schema": { "description": "水箱ID", "title": "Tank", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": { "type": "number" }, "title": "Response Get Tanks Coord", "type": "object" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取水箱坐标", "tags": [ "Tanks" ] }, "patch": { "description": "设置指定水箱的X和Y坐标", "operationId": "patch_tanks_coord", "parameters": [ { "description": "水箱ID", "in": "query", "name": "tank", "required": true, "schema": { "description": "水箱ID", "title": "Tank", "type": "string" } }, { "description": "新的X坐标值", "in": "query", "name": "x", "required": true, "schema": { "description": "新的X坐标值", "title": "X", "type": "number" } }, { "description": "新的Y坐标值", "in": "query", "name": "y", "required": true, "schema": { "description": "新的Y坐标值", "title": "Y", "type": "number" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "设置水箱坐标", "tags": [ "Tanks" ] } }, "/api/v1/tanks/diameter": { "get": { "description": "获取指定水箱的直径值", "operationId": "get_tanks_diameter", "parameters": [ { "description": "水箱ID", "in": "query", "name": "tank", "required": true, "schema": { "description": "水箱ID", "title": "Tank", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Response Get Tanks Diameter" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取水箱直径", "tags": [ "Tanks" ] }, "patch": { "description": "设置指定水箱的直径值", "operationId": "patch_tanks_diameter", "parameters": [ { "description": "水箱ID", "in": "query", "name": "tank", "required": true, "schema": { "description": "水箱ID", "title": "Tank", "type": "string" } }, { "description": "新的直径值", "in": "query", "name": "diameter", "required": true, "schema": { "description": "新的直径值", "title": "Diameter", "type": "number" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "设置水箱直径", "tags": [ "Tanks" ] } }, "/api/v1/tanks/elevation": { "get": { "description": "获取指定水箱的标高值", "operationId": "get_tanks_elevation", "parameters": [ { "description": "水箱ID", "in": "query", "name": "tank", "required": true, "schema": { "description": "水箱ID", "title": "Tank", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Response Get Tanks Elevation" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取水箱标高", "tags": [ "Tanks" ] }, "patch": { "description": "设置指定水箱的标高值", "operationId": "patch_tanks_elevation", "parameters": [ { "description": "水箱ID", "in": "query", "name": "tank", "required": true, "schema": { "description": "水箱ID", "title": "Tank", "type": "string" } }, { "description": "新的标高值", "in": "query", "name": "elevation", "required": true, "schema": { "description": "新的标高值", "title": "Elevation", "type": "number" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "设置水箱标高", "tags": [ "Tanks" ] } }, "/api/v1/tanks/existence": { "get": { "description": "检查指定ID是否为水网中的蓄水池", "operationId": "get_tanks_existence", "parameters": [ { "description": "节点ID", "in": "query", "name": "node", "required": true, "schema": { "description": "节点ID", "title": "Node", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "title": "Response Get Tanks Existence", "type": "boolean" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "检查是否为蓄水池", "tags": [ "Network General" ] } }, "/api/v1/tanks/init-level": { "get": { "description": "获取指定水箱的初始水位值", "operationId": "get_tanks_init_level", "parameters": [ { "description": "水箱ID", "in": "query", "name": "tank", "required": true, "schema": { "description": "水箱ID", "title": "Tank", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Response Get Tanks Init Level" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取水箱初始水位", "tags": [ "Tanks" ] }, "patch": { "description": "设置指定水箱的初始水位值", "operationId": "patch_tanks_init_level", "parameters": [ { "description": "水箱ID", "in": "query", "name": "tank", "required": true, "schema": { "description": "水箱ID", "title": "Tank", "type": "string" } }, { "description": "新的初始水位值", "in": "query", "name": "init_level", "required": true, "schema": { "description": "新的初始水位值", "title": "Init Level", "type": "number" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "设置水箱初始水位", "tags": [ "Tanks" ] } }, "/api/v1/tanks/max-level": { "get": { "description": "获取指定水箱的最大水位值", "operationId": "get_tanks_max_level", "parameters": [ { "description": "水箱ID", "in": "query", "name": "tank", "required": true, "schema": { "description": "水箱ID", "title": "Tank", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Response Get Tanks Max Level" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取水箱最大水位", "tags": [ "Tanks" ] }, "patch": { "description": "设置指定水箱的最大水位值", "operationId": "patch_tanks_max_level", "parameters": [ { "description": "水箱ID", "in": "query", "name": "tank", "required": true, "schema": { "description": "水箱ID", "title": "Tank", "type": "string" } }, { "description": "新的最大水位值", "in": "query", "name": "max_level", "required": true, "schema": { "description": "新的最大水位值", "title": "Max Level", "type": "number" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "设置水箱最大水位", "tags": [ "Tanks" ] } }, "/api/v1/tanks/min-level": { "get": { "description": "获取指定水箱的最小水位值", "operationId": "get_tanks_min_level", "parameters": [ { "description": "水箱ID", "in": "query", "name": "tank", "required": true, "schema": { "description": "水箱ID", "title": "Tank", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Response Get Tanks Min Level" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取水箱最小水位", "tags": [ "Tanks" ] }, "patch": { "description": "设置指定水箱的最小水位值", "operationId": "patch_tanks_min_level", "parameters": [ { "description": "水箱ID", "in": "query", "name": "tank", "required": true, "schema": { "description": "水箱ID", "title": "Tank", "type": "string" } }, { "description": "新的最小水位值", "in": "query", "name": "min_level", "required": true, "schema": { "description": "新的最小水位值", "title": "Min Level", "type": "number" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "设置水箱最小水位", "tags": [ "Tanks" ] } }, "/api/v1/tanks/min-vol": { "get": { "description": "获取指定水箱的最小体积值", "operationId": "get_tanks_min_vol", "parameters": [ { "description": "水箱ID", "in": "query", "name": "tank", "required": true, "schema": { "description": "水箱ID", "title": "Tank", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Response Get Tanks Min Vol" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取水箱最小体积", "tags": [ "Tanks" ] }, "patch": { "description": "设置指定水箱的最小体积值", "operationId": "patch_tanks_min_vol", "parameters": [ { "description": "水箱ID", "in": "query", "name": "tank", "required": true, "schema": { "description": "水箱ID", "title": "Tank", "type": "string" } }, { "description": "新的最小体积值", "in": "query", "name": "min_vol", "required": true, "schema": { "description": "新的最小体积值", "title": "Min Vol", "type": "number" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "设置水箱最小体积", "tags": [ "Tanks" ] } }, "/api/v1/tanks/overflow": { "get": { "description": "获取指定水箱的溢流口配置", "operationId": "get_tanks_overflow", "parameters": [ { "description": "水箱ID", "in": "query", "name": "tank", "required": true, "schema": { "description": "水箱ID", "title": "Tank", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Response Get Tanks Overflow" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取水箱溢流口", "tags": [ "Tanks" ] }, "patch": { "description": "设置指定水箱的溢流口配置", "operationId": "patch_tanks_overflow", "parameters": [ { "description": "水箱ID", "in": "query", "name": "tank", "required": true, "schema": { "description": "水箱ID", "title": "Tank", "type": "string" } }, { "description": "新的溢流口配置", "in": "query", "name": "overflow", "required": true, "schema": { "description": "新的溢流口配置", "title": "Overflow", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "设置水箱溢流口", "tags": [ "Tanks" ] } }, "/api/v1/tanks/properties": { "get": { "description": "获取指定水箱的所有属性", "operationId": "get_tanks_properties", "parameters": [ { "description": "水箱ID", "in": "query", "name": "tank", "required": true, "schema": { "description": "水箱ID", "title": "Tank", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "title": "Response Get Tanks Properties", "type": "object" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取水箱属性", "tags": [ "Tanks" ] }, "patch": { "description": "批量设置指定水箱的多个属性", "operationId": "patch_tanks_properties", "parameters": [ { "description": "水箱ID", "in": "query", "name": "tank", "required": true, "schema": { "description": "水箱ID", "title": "Tank", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "设置水箱属性", "tags": [ "Tanks" ] } }, "/api/v1/tanks/vol-curve": { "get": { "description": "获取指定水箱的容积曲线标识", "operationId": "get_tanks_vol_curve", "parameters": [ { "description": "水箱ID", "in": "query", "name": "tank", "required": true, "schema": { "description": "水箱ID", "title": "Tank", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Response Get Tanks Vol Curve" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取水箱容积曲线", "tags": [ "Tanks" ] }, "patch": { "description": "设置指定水箱的容积曲线标识", "operationId": "patch_tanks_vol_curve", "parameters": [ { "description": "水箱ID", "in": "query", "name": "tank", "required": true, "schema": { "description": "水箱ID", "title": "Tank", "type": "string" } }, { "description": "新的容积曲线标识", "in": "query", "name": "vol_curve", "required": true, "schema": { "description": "新的容积曲线标识", "title": "Vol Curve", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "设置水箱容积曲线", "tags": [ "Tanks" ] } }, "/api/v1/tanks/x": { "get": { "description": "获取指定水箱的X坐标值", "operationId": "get_tanks_x", "parameters": [ { "description": "水箱ID", "in": "query", "name": "tank", "required": true, "schema": { "description": "水箱ID", "title": "Tank", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "title": "Response Get Tanks X", "type": "number" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取水箱X坐标", "tags": [ "Tanks" ] }, "patch": { "description": "设置指定水箱的X坐标值", "operationId": "patch_tanks_x", "parameters": [ { "description": "水箱ID", "in": "query", "name": "tank", "required": true, "schema": { "description": "水箱ID", "title": "Tank", "type": "string" } }, { "description": "新的X坐标值", "in": "query", "name": "x", "required": true, "schema": { "description": "新的X坐标值", "title": "X", "type": "number" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "设置水箱X坐标", "tags": [ "Tanks" ] } }, "/api/v1/tanks/y": { "get": { "description": "获取指定水箱的Y坐标值", "operationId": "get_tanks_y", "parameters": [ { "description": "水箱ID", "in": "query", "name": "tank", "required": true, "schema": { "description": "水箱ID", "title": "Tank", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "title": "Response Get Tanks Y", "type": "number" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取水箱Y坐标", "tags": [ "Tanks" ] }, "patch": { "description": "设置指定水箱的Y坐标值", "operationId": "patch_tanks_y", "parameters": [ { "description": "水箱ID", "in": "query", "name": "tank", "required": true, "schema": { "description": "水箱ID", "title": "Tank", "type": "string" } }, { "description": "新的Y坐标值", "in": "query", "name": "y", "required": true, "schema": { "description": "新的Y坐标值", "title": "Y", "type": "number" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "设置水箱Y坐标", "tags": [ "Tanks" ] } }, "/api/v1/time-properties": { "patch": { "description": "更新指定网络中的时间选项属性", "operationId": "patch_time_properties", "parameters": [ { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "设置时间选项属性", "tags": [ "Options" ] } }, "/api/v1/timeseries/realtime/links": { "delete": { "description": "按时间范围删除实时管道数据。start_time 和 end_time 必须显式带时区;允许传 UTC+8,服务端按请求中的绝对时间删除对应 UTC 数据。", "operationId": "delete_timeseries_realtime_links", "parameters": [ { "description": "时间范围开始时间。ISO 8601 / RFC 3339 时间,必须显式带时区;可直接传 UTC+8,服务端会先转换为 UTC 再处理。", "in": "query", "name": "start_time", "required": true, "schema": { "description": "时间范围开始时间。ISO 8601 / RFC 3339 时间,必须显式带时区;可直接传 UTC+8,服务端会先转换为 UTC 再处理。", "format": "date-time", "title": "Start Time", "type": "string" } }, { "description": "时间范围结束时间。ISO 8601 / RFC 3339 时间,必须显式带时区;可直接传 UTC+8,服务端会先转换为 UTC 再处理。", "in": "query", "name": "end_time", "required": true, "schema": { "description": "时间范围结束时间。ISO 8601 / RFC 3339 时间,必须显式带时区;可直接传 UTC+8,服务端会先转换为 UTC 再处理。", "format": "date-time", "title": "End Time", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "204": { "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "删除实时管道数据", "tags": [ "TimescaleDB - Realtime" ] }, "get": { "description": "按时间范围查询实时管道数据。start_time 和 end_time 必须显式带时区;允许传 UTC+8,服务端会先归一化为 UTC 再执行查询。", "operationId": "get_timeseries_realtime_links", "parameters": [ { "description": "时间范围开始时间。ISO 8601 / RFC 3339 时间,必须显式带时区;可直接传 UTC+8,服务端会先转换为 UTC 再处理。", "in": "query", "name": "start_time", "required": true, "schema": { "description": "时间范围开始时间。ISO 8601 / RFC 3339 时间,必须显式带时区;可直接传 UTC+8,服务端会先转换为 UTC 再处理。", "format": "date-time", "title": "Start Time", "type": "string" } }, { "description": "时间范围结束时间。ISO 8601 / RFC 3339 时间,必须显式带时区;可直接传 UTC+8,服务端会先转换为 UTC 再处理。", "in": "query", "name": "end_time", "required": true, "schema": { "description": "时间范围结束时间。ISO 8601 / RFC 3339 时间,必须显式带时区;可直接传 UTC+8,服务端会先转换为 UTC 再处理。", "format": "date-time", "title": "End Time", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "查询实时管道数据", "tags": [ "TimescaleDB - Realtime" ] } }, "/api/v1/timeseries/realtime/links/batches": { "post": { "description": "批量插入实时管道数据\n\n将管道的实时监测数据批量插入时间序列数据库。\n\nArgs:\n data: 管道数据列表\n \nReturns:\n 插入成功的记录数", "operationId": "post_timeseries_realtime_links_batches", "parameters": [ { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "description": "管道数据列表,每项包含管道ID、时间戳等信息", "items": { "type": "object" }, "title": "Data", "type": "array" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "批量插入实时管道数据", "tags": [ "TimescaleDB - Realtime" ] } }, "/api/v1/timeseries/realtime/links/{link_id}/field": { "patch": { "description": "更新指定管道的字段值\n\n更新实时管道在特定时间的某个字段数据。\n\nArgs:\n link_id: 管道ID\n time: 数据时间戳\n field: 字段名称\n value: 字段新值\n \nReturns:\n 更新结果信息\n \nRaises:\n HTTPException: 当字段不存在或更新失败时返回400错误", "operationId": "patch_timeseries_realtime_links_link_id_field", "parameters": [ { "description": "管道ID", "in": "path", "name": "link_id", "required": true, "schema": { "description": "管道ID", "title": "Link Id", "type": "string" } }, { "description": "要更新记录的时间戳。ISO 8601 / RFC 3339 时间,必须显式带时区;可直接传 UTC+8,服务端会先转换为 UTC 再处理。", "in": "query", "name": "time", "required": true, "schema": { "description": "要更新记录的时间戳。ISO 8601 / RFC 3339 时间,必须显式带时区;可直接传 UTC+8,服务端会先转换为 UTC 再处理。", "format": "date-time", "title": "Time", "type": "string" } }, { "description": "要更新的字段名称", "in": "query", "name": "field", "required": true, "schema": { "description": "要更新的字段名称", "title": "Field", "type": "string" } }, { "description": "更新的字段值", "in": "query", "name": "value", "required": true, "schema": { "description": "更新的字段值", "title": "Value", "type": "number" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "更新实时管道字段", "tags": [ "TimescaleDB - Realtime" ] } }, "/api/v1/timeseries/realtime/nodes": { "delete": { "description": "按时间范围删除实时节点数据。start_time 和 end_time 必须显式带时区;允许传 UTC+8,服务端按请求中的绝对时间删除对应 UTC 数据。", "operationId": "delete_timeseries_realtime_nodes", "parameters": [ { "description": "时间范围开始时间。ISO 8601 / RFC 3339 时间,必须显式带时区;可直接传 UTC+8,服务端会先转换为 UTC 再处理。", "in": "query", "name": "start_time", "required": true, "schema": { "description": "时间范围开始时间。ISO 8601 / RFC 3339 时间,必须显式带时区;可直接传 UTC+8,服务端会先转换为 UTC 再处理。", "format": "date-time", "title": "Start Time", "type": "string" } }, { "description": "时间范围结束时间。ISO 8601 / RFC 3339 时间,必须显式带时区;可直接传 UTC+8,服务端会先转换为 UTC 再处理。", "in": "query", "name": "end_time", "required": true, "schema": { "description": "时间范围结束时间。ISO 8601 / RFC 3339 时间,必须显式带时区;可直接传 UTC+8,服务端会先转换为 UTC 再处理。", "format": "date-time", "title": "End Time", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "204": { "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "删除实时节点数据", "tags": [ "TimescaleDB - Realtime" ] }, "get": { "description": "按时间范围查询实时节点数据。start_time 和 end_time 必须显式带时区;允许传 UTC+8,服务端会先归一化为 UTC 再执行查询。", "operationId": "get_timeseries_realtime_nodes", "parameters": [ { "description": "时间范围开始时间。ISO 8601 / RFC 3339 时间,必须显式带时区;可直接传 UTC+8,服务端会先转换为 UTC 再处理。", "in": "query", "name": "start_time", "required": true, "schema": { "description": "时间范围开始时间。ISO 8601 / RFC 3339 时间,必须显式带时区;可直接传 UTC+8,服务端会先转换为 UTC 再处理。", "format": "date-time", "title": "Start Time", "type": "string" } }, { "description": "时间范围结束时间。ISO 8601 / RFC 3339 时间,必须显式带时区;可直接传 UTC+8,服务端会先转换为 UTC 再处理。", "in": "query", "name": "end_time", "required": true, "schema": { "description": "时间范围结束时间。ISO 8601 / RFC 3339 时间,必须显式带时区;可直接传 UTC+8,服务端会先转换为 UTC 再处理。", "format": "date-time", "title": "End Time", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "查询实时节点数据", "tags": [ "TimescaleDB - Realtime" ] } }, "/api/v1/timeseries/realtime/nodes/batches": { "post": { "description": "批量插入实时节点数据\n\n将节点的实时监测数据批量插入时间序列数据库。\n\nArgs:\n data: 节点数据列表\n \nReturns:\n 插入成功的记录数", "operationId": "post_timeseries_realtime_nodes_batches", "parameters": [ { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "description": "节点数据列表,每项包含节点ID、时间戳等信息", "items": { "type": "object" }, "title": "Data", "type": "array" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "批量插入实时节点数据", "tags": [ "TimescaleDB - Realtime" ] } }, "/api/v1/timeseries/realtime/records": { "get": { "description": "查询指定时间点的实时属性值。query_time 必须显式带时区;允许传 UTC+8,服务端会先归一化为 UTC 再执行查询。", "operationId": "get_timeseries_realtime_records", "parameters": [ { "description": "查询时间。ISO 8601 / RFC 3339 时间,必须显式带时区;可直接传 UTC+8,服务端会先转换为 UTC 再处理。", "in": "query", "name": "query_time", "required": true, "schema": { "description": "查询时间。ISO 8601 / RFC 3339 时间,必须显式带时区;可直接传 UTC+8,服务端会先转换为 UTC 再处理。", "title": "Query Time", "type": "string" } }, { "description": "数据类型,pipe(管道)或 junction(节点)", "in": "query", "name": "type", "required": true, "schema": { "description": "数据类型,pipe(管道)或 junction(节点)", "title": "Type", "type": "string" } }, { "description": "要查询的属性名称", "in": "query", "name": "property", "required": true, "schema": { "description": "要查询的属性名称", "title": "Property", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "按时间和属性查询实时数据", "tags": [ "TimescaleDB - Realtime" ] } }, "/api/v1/timeseries/realtime/simulation-results": { "get": { "description": "查询指定元素在某一时间点的实时模拟结果。query_time 必须显式带时区;允许传 UTC+8,服务端会先归一化为 UTC 再执行查询。", "operationId": "get_timeseries_realtime_simulation_results", "parameters": [ { "description": "元素ID(管道ID或节点ID)", "in": "query", "name": "id", "required": true, "schema": { "description": "元素ID(管道ID或节点ID)", "title": "Id", "type": "string" } }, { "description": "元素类型,pipe(管道)或 junction(节点)", "in": "query", "name": "type", "required": true, "schema": { "description": "元素类型,pipe(管道)或 junction(节点)", "title": "Type", "type": "string" } }, { "description": "查询时间。ISO 8601 / RFC 3339 时间,必须显式带时区;可直接传 UTC+8,服务端会先转换为 UTC 再处理。", "in": "query", "name": "query_time", "required": true, "schema": { "description": "查询时间。ISO 8601 / RFC 3339 时间,必须显式带时区;可直接传 UTC+8,服务端会先转换为 UTC 再处理。", "title": "Query Time", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "按ID和时间查询实时模拟数据", "tags": [ "TimescaleDB - Realtime" ] }, "post": { "description": "存储实时模拟结果到时间序列数据库\n\n将节点和管道的实时模拟计算结果批量存储到TimescaleDB数据库。\n\nArgs:\n node_result_list: 节点模拟结果列表\n link_result_list: 管道模拟结果列表\n result_start_time: 模拟结果对应的起始时间\n \nReturns:\n 存储结果信息", "operationId": "post_timeseries_realtime_simulation_results", "parameters": [ { "description": "模拟结果开始时间。ISO 8601 / RFC 3339 时间,必须显式带时区;可直接传 UTC+8,服务端会先转换为 UTC 再处理。", "in": "query", "name": "result_start_time", "required": true, "schema": { "description": "模拟结果开始时间。ISO 8601 / RFC 3339 时间,必须显式带时区;可直接传 UTC+8,服务端会先转换为 UTC 再处理。", "title": "Result Start Time", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body_post_timeseries_realtime_simulation_results" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "存储实时模拟结果", "tags": [ "TimescaleDB - Realtime" ] } }, "/api/v1/timeseries/scada-cleaning-runs": { "post": { "description": "清洗SCADA监测数据\n\n根据device_ids查询monitored_value,清洗后更新cleaned_value。\n支持清洗指定设备或所有设备的数据。\n\nArgs:\n device_ids: 设备ID列表,用逗号分隔,或 'all' 表示清洗所有设备\n start_time: 清洗数据的开始时间\n end_time: 清洗数据的结束时间\n timescale_conn: TimescaleDB连接\n postgres_conn: PostgreSQL连接\n \nReturns:\n 清洗结果信息\n \nRaises:\n HTTPException: 当清洗过程出现错误时返回400错误", "operationId": "post_timeseries_scada_cleaning_runs", "parameters": [ { "description": "设备ID列表或 'all' 表示清洗所有设备", "in": "query", "name": "device_ids", "required": true, "schema": { "description": "设备ID列表或 'all' 表示清洗所有设备", "title": "Device Ids", "type": "string" } }, { "description": "清洗数据的开始时间", "in": "query", "name": "start_time", "required": true, "schema": { "description": "清洗数据的开始时间", "format": "date-time", "title": "Start Time", "type": "string" } }, { "description": "清洗数据的结束时间", "in": "query", "name": "end_time", "required": true, "schema": { "description": "清洗数据的结束时间", "format": "date-time", "title": "End Time", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "清洗SCADA监测数据", "tags": [ "TimescaleDB - Composite" ] } }, "/api/v1/timeseries/scada-readings": { "delete": { "description": "删除指定设备和时间范围内的SCADA数据\n\n删除在指定时间范围内的特定设备监测数据。\n\nArgs:\n device_id: 设备ID\n start_time: 删除开始时间\n end_time: 删除结束时间\n\nReturns:\n 删除结果信息", "operationId": "delete_timeseries_scada_readings", "parameters": [ { "description": "设备ID", "in": "query", "name": "device_id", "required": true, "schema": { "description": "设备ID", "title": "Device Id", "type": "string" } }, { "description": "删除开始时间", "in": "query", "name": "start_time", "required": true, "schema": { "description": "删除开始时间", "format": "date-time", "title": "Start Time", "type": "string" } }, { "description": "删除结束时间", "in": "query", "name": "end_time", "required": true, "schema": { "description": "删除结束时间", "format": "date-time", "title": "End Time", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "204": { "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "按设备ID和时间范围删除SCADA数据", "tags": [ "TimescaleDB - SCADA" ] }, "get": { "description": "按设备ID和时间范围查询SCADA监测数据\n\n查询多个设备在指定时间范围内的所有监测数据。\n\nArgs:\n start_time: 查询开始时间\n end_time: 查询结束时间\n device_ids: 设备ID列表,用逗号分隔\n\nReturns:\n SCADA监测数据列表", "operationId": "get_timeseries_scada_readings", "parameters": [ { "description": "查询开始时间", "in": "query", "name": "start_time", "required": true, "schema": { "description": "查询开始时间", "format": "date-time", "title": "Start Time", "type": "string" } }, { "description": "查询结束时间", "in": "query", "name": "end_time", "required": true, "schema": { "description": "查询结束时间", "format": "date-time", "title": "End Time", "type": "string" } }, { "description": "设备ID列表,逗号分隔,如 'device1,device2,device3'", "in": "query", "name": "device_ids", "required": true, "schema": { "description": "设备ID列表,逗号分隔,如 'device1,device2,device3'", "title": "Device Ids", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "按设备ID和时间范围查询SCADA数据", "tags": [ "TimescaleDB - SCADA" ] } }, "/api/v1/timeseries/scada-readings/batches": { "post": { "description": "批量插入SCADA监测数据\n\n将多个设备的实时监测数据批量插入时间序列数据库。\n\nArgs:\n data: SCADA设备监测数据列表,每项包含device_id、时间戳和监测值等信息\n\nReturns:\n 插入成功的记录数", "operationId": "post_timeseries_scada_readings_batches", "parameters": [ { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "description": "SCADA设备监测数据列表", "items": { "type": "object" }, "title": "Data", "type": "array" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "批量插入SCADA监测数据", "tags": [ "TimescaleDB - SCADA" ] } }, "/api/v1/timeseries/scada-readings/fields": { "get": { "description": "按设备ID、字段和时间范围查询特定SCADA数据\n\n查询多个设备在指定时间范围内的特定字段监测数据。\n\nArgs:\n start_time: 查询开始时间\n end_time: 查询结束时间\n field: 字段名称\n device_ids: 设备ID列表,用逗号分隔\n\nReturns:\n SCADA字段数据列表\n\nRaises:\n HTTPException: 当字段不存在或查询参数无效时返回400错误", "operationId": "get_timeseries_scada_readings_fields", "parameters": [ { "description": "查询开始时间", "in": "query", "name": "start_time", "required": true, "schema": { "description": "查询开始时间", "format": "date-time", "title": "Start Time", "type": "string" } }, { "description": "查询结束时间", "in": "query", "name": "end_time", "required": true, "schema": { "description": "查询结束时间", "format": "date-time", "title": "End Time", "type": "string" } }, { "description": "要查询的字段名称", "in": "query", "name": "field", "required": true, "schema": { "description": "要查询的字段名称", "title": "Field", "type": "string" } }, { "description": "设备ID列表,逗号分隔,如 'device1,device2,device3'", "in": "query", "name": "device_ids", "required": true, "schema": { "description": "设备ID列表,逗号分隔,如 'device1,device2,device3'", "title": "Device Ids", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "按设备ID、字段和时间范围查询SCADA数据", "tags": [ "TimescaleDB - SCADA" ] } }, "/api/v1/timeseries/scada-readings/{device_id}/field": { "patch": { "description": "更新指定设备的字段值\n\n更新SCADA设备在特定时间的某个字段监测数据。\n\nArgs:\n device_id: 设备ID\n time: 数据时间戳\n field: 字段名称\n value: 字段新值\n\nReturns:\n 更新结果信息\n\nRaises:\n HTTPException: 当字段不存在或更新失败时返回400错误", "operationId": "patch_timeseries_scada_readings_device_id_field", "parameters": [ { "description": "设备ID", "in": "path", "name": "device_id", "required": true, "schema": { "description": "设备ID", "title": "Device Id", "type": "string" } }, { "description": "更新数据的时间戳", "in": "query", "name": "time", "required": true, "schema": { "description": "更新数据的时间戳", "format": "date-time", "title": "Time", "type": "string" } }, { "description": "要更新的字段名称", "in": "query", "name": "field", "required": true, "schema": { "description": "要更新的字段名称", "title": "Field", "type": "string" } }, { "description": "更新的字段值", "in": "query", "name": "value", "required": true, "schema": { "description": "更新的字段值", "title": "Value", "type": "number" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "更新SCADA设备字段", "tags": [ "TimescaleDB - SCADA" ] } }, "/api/v1/timeseries/schemes/links": { "delete": { "description": "删除指定方案和时间范围内的管道数据\n\n删除在指定方案和时间范围内的所有管道模拟数据。\n\nArgs:\n scheme_type: 方案类型\n scheme_name: 方案名称\n start_time: 删除开始时间\n end_time: 删除结束时间\n\nReturns:\n 删除结果信息", "operationId": "delete_timeseries_schemes_links", "parameters": [ { "description": "方案类型", "in": "query", "name": "scheme_type", "required": true, "schema": { "description": "方案类型", "title": "Scheme Type", "type": "string" } }, { "description": "方案名称", "in": "query", "name": "scheme_name", "required": true, "schema": { "description": "方案名称", "title": "Scheme Name", "type": "string" } }, { "description": "删除开始时间", "in": "query", "name": "start_time", "required": true, "schema": { "description": "删除开始时间", "format": "date-time", "title": "Start Time", "type": "string" } }, { "description": "删除结束时间", "in": "query", "name": "end_time", "required": true, "schema": { "description": "删除结束时间", "format": "date-time", "title": "End Time", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "204": { "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "删除方案管道数据", "tags": [ "TimescaleDB - Scheme" ] }, "get": { "description": "查询指定方案和时间范围内的管道数据\n\n根据方案和时间范围查询管道的模拟值。\n\nArgs:\n scheme_type: 方案类型\n scheme_name: 方案名称\n start_time: 查询开始时间\n end_time: 查询结束时间\n\nReturns:\n 方案管道数据列表", "operationId": "get_timeseries_schemes_links", "parameters": [ { "description": "方案类型", "in": "query", "name": "scheme_type", "required": true, "schema": { "description": "方案类型", "title": "Scheme Type", "type": "string" } }, { "description": "方案名称", "in": "query", "name": "scheme_name", "required": true, "schema": { "description": "方案名称", "title": "Scheme Name", "type": "string" } }, { "description": "查询开始时间", "in": "query", "name": "start_time", "required": true, "schema": { "description": "查询开始时间", "format": "date-time", "title": "Start Time", "type": "string" } }, { "description": "查询结束时间", "in": "query", "name": "end_time", "required": true, "schema": { "description": "查询结束时间", "format": "date-time", "title": "End Time", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "查询方案管道数据", "tags": [ "TimescaleDB - Scheme" ] } }, "/api/v1/timeseries/schemes/links/batches": { "post": { "description": "批量插入方案管道数据\n\n将特定方案的管道模拟数据批量插入时间序列数据库。\n\nArgs:\n data: 方案管道数据列表\n\nReturns:\n 插入成功的记录数", "operationId": "post_timeseries_schemes_links_batches", "parameters": [ { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "description": "方案管道数据列表", "items": { "type": "object" }, "title": "Data", "type": "array" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "批量插入方案管道数据", "tags": [ "TimescaleDB - Scheme" ] } }, "/api/v1/timeseries/schemes/links/{link_id}/field": { "get": { "description": "查询指定方案管道的特定字段数据\n\n查询特定方案中指定管道在时间范围内的特定字段值。\n\nArgs:\n link_id: 管道ID\n scheme_type: 方案类型\n scheme_name: 方案名称\n start_time: 查询开始时间\n end_time: 查询结束时间\n field: 字段名称\n\nReturns:\n 字段数据列表\n\nRaises:\n HTTPException: 当查询参数无效时返回400错误", "operationId": "get_timeseries_schemes_links_link_id_field", "parameters": [ { "description": "管道ID", "in": "path", "name": "link_id", "required": true, "schema": { "description": "管道ID", "title": "Link Id", "type": "string" } }, { "description": "方案类型", "in": "query", "name": "scheme_type", "required": true, "schema": { "description": "方案类型", "title": "Scheme Type", "type": "string" } }, { "description": "方案名称", "in": "query", "name": "scheme_name", "required": true, "schema": { "description": "方案名称", "title": "Scheme Name", "type": "string" } }, { "description": "查询开始时间", "in": "query", "name": "start_time", "required": true, "schema": { "description": "查询开始时间", "format": "date-time", "title": "Start Time", "type": "string" } }, { "description": "查询结束时间", "in": "query", "name": "end_time", "required": true, "schema": { "description": "查询结束时间", "format": "date-time", "title": "End Time", "type": "string" } }, { "description": "要查询的字段名称", "in": "query", "name": "field", "required": true, "schema": { "description": "要查询的字段名称", "title": "Field", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "查询方案管道字段数据", "tags": [ "TimescaleDB - Scheme" ] }, "patch": { "description": "更新指定方案管道的字段值\n\n更新特定方案中指定管道在某个时间的字段数据。\n\nArgs:\n link_id: 管道ID\n scheme_type: 方案类型\n scheme_name: 方案名称\n time: 数据时间戳\n field: 字段名称\n value: 字段新值\n\nReturns:\n 更新结果信息\n\nRaises:\n HTTPException: 当字段不存在或更新失败时返回400错误", "operationId": "patch_timeseries_schemes_links_link_id_field", "parameters": [ { "description": "管道ID", "in": "path", "name": "link_id", "required": true, "schema": { "description": "管道ID", "title": "Link Id", "type": "string" } }, { "description": "方案类型", "in": "query", "name": "scheme_type", "required": true, "schema": { "description": "方案类型", "title": "Scheme Type", "type": "string" } }, { "description": "方案名称", "in": "query", "name": "scheme_name", "required": true, "schema": { "description": "方案名称", "title": "Scheme Name", "type": "string" } }, { "description": "更新数据的时间戳", "in": "query", "name": "time", "required": true, "schema": { "description": "更新数据的时间戳", "format": "date-time", "title": "Time", "type": "string" } }, { "description": "要更新的字段名称", "in": "query", "name": "field", "required": true, "schema": { "description": "要更新的字段名称", "title": "Field", "type": "string" } }, { "description": "更新的字段值", "in": "query", "name": "value", "required": true, "schema": { "description": "更新的字段值", "title": "Value", "type": "number" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "更新方案管道字段", "tags": [ "TimescaleDB - Scheme" ] } }, "/api/v1/timeseries/schemes/nodes": { "delete": { "description": "删除指定方案和时间范围内的节点数据\n\n删除在指定方案和时间范围内的所有节点模拟数据。\n\nArgs:\n scheme_type: 方案类型\n scheme_name: 方案名称\n start_time: 删除开始时间\n end_time: 删除结束时间\n\nReturns:\n 删除结果信息", "operationId": "delete_timeseries_schemes_nodes", "parameters": [ { "description": "方案类型", "in": "query", "name": "scheme_type", "required": true, "schema": { "description": "方案类型", "title": "Scheme Type", "type": "string" } }, { "description": "方案名称", "in": "query", "name": "scheme_name", "required": true, "schema": { "description": "方案名称", "title": "Scheme Name", "type": "string" } }, { "description": "删除开始时间", "in": "query", "name": "start_time", "required": true, "schema": { "description": "删除开始时间", "format": "date-time", "title": "Start Time", "type": "string" } }, { "description": "删除结束时间", "in": "query", "name": "end_time", "required": true, "schema": { "description": "删除结束时间", "format": "date-time", "title": "End Time", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "204": { "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "删除方案节点数据", "tags": [ "TimescaleDB - Scheme" ] } }, "/api/v1/timeseries/schemes/nodes/batches": { "post": { "description": "批量插入方案节点数据\n\n将特定方案的节点模拟数据批量插入时间序列数据库。\n\nArgs:\n data: 方案节点数据列表\n\nReturns:\n 插入成功的记录数", "operationId": "post_timeseries_schemes_nodes_batches", "parameters": [ { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "description": "方案节点数据列表", "items": { "type": "object" }, "title": "Data", "type": "array" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "批量插入方案节点数据", "tags": [ "TimescaleDB - Scheme" ] } }, "/api/v1/timeseries/schemes/nodes/{node_id}/field": { "get": { "description": "查询指定方案节点的特定字段数据\n\n查询特定方案中指定节点在时间范围内的特定字段值。\n\nArgs:\n node_id: 节点ID\n scheme_type: 方案类型\n scheme_name: 方案名称\n start_time: 查询开始时间\n end_time: 查询结束时间\n field: 字段名称\n\nReturns:\n 字段数据列表\n\nRaises:\n HTTPException: 当查询参数无效时返回400错误", "operationId": "get_timeseries_schemes_nodes_node_id_field", "parameters": [ { "description": "节点ID", "in": "path", "name": "node_id", "required": true, "schema": { "description": "节点ID", "title": "Node Id", "type": "string" } }, { "description": "方案类型", "in": "query", "name": "scheme_type", "required": true, "schema": { "description": "方案类型", "title": "Scheme Type", "type": "string" } }, { "description": "方案名称", "in": "query", "name": "scheme_name", "required": true, "schema": { "description": "方案名称", "title": "Scheme Name", "type": "string" } }, { "description": "查询开始时间", "in": "query", "name": "start_time", "required": true, "schema": { "description": "查询开始时间", "format": "date-time", "title": "Start Time", "type": "string" } }, { "description": "查询结束时间", "in": "query", "name": "end_time", "required": true, "schema": { "description": "查询结束时间", "format": "date-time", "title": "End Time", "type": "string" } }, { "description": "要查询的字段名称", "in": "query", "name": "field", "required": true, "schema": { "description": "要查询的字段名称", "title": "Field", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "查询方案节点字段数据", "tags": [ "TimescaleDB - Scheme" ] }, "patch": { "description": "更新指定方案节点的字段值\n\n更新特定方案中指定节点在某个时间的字段数据。\n\nArgs:\n node_id: 节点ID\n scheme_type: 方案类型\n scheme_name: 方案名称\n time: 数据时间戳\n field: 字段名称\n value: 字段新值\n\nReturns:\n 更新结果信息\n\nRaises:\n HTTPException: 当字段不存在或更新失败时返回400错误", "operationId": "patch_timeseries_schemes_nodes_node_id_field", "parameters": [ { "description": "节点ID", "in": "path", "name": "node_id", "required": true, "schema": { "description": "节点ID", "title": "Node Id", "type": "string" } }, { "description": "方案类型", "in": "query", "name": "scheme_type", "required": true, "schema": { "description": "方案类型", "title": "Scheme Type", "type": "string" } }, { "description": "方案名称", "in": "query", "name": "scheme_name", "required": true, "schema": { "description": "方案名称", "title": "Scheme Name", "type": "string" } }, { "description": "更新数据的时间戳", "in": "query", "name": "time", "required": true, "schema": { "description": "更新数据的时间戳", "format": "date-time", "title": "Time", "type": "string" } }, { "description": "要更新的字段名称", "in": "query", "name": "field", "required": true, "schema": { "description": "要更新的字段名称", "title": "Field", "type": "string" } }, { "description": "更新的字段值", "in": "query", "name": "value", "required": true, "schema": { "description": "更新的字段值", "title": "Value", "type": "number" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "更新方案节点字段", "tags": [ "TimescaleDB - Scheme" ] } }, "/api/v1/timeseries/schemes/records": { "get": { "description": "按指定方案、时间和属性查询所有方案数据\n\n查询在特定方案和时间点,所有指定类型元素的特定属性值。\n\nArgs:\n scheme_type: 方案类型\n scheme_name: 方案名称\n query_time: 查询时间\n type: 元素类型(pipe或junction)\n property: 属性名称\n\nReturns:\n 查询结果列表\n\nRaises:\n HTTPException: 当查询参数无效时返回400错误", "operationId": "get_timeseries_schemes_records", "parameters": [ { "description": "方案类型", "in": "query", "name": "scheme_type", "required": true, "schema": { "description": "方案类型", "title": "Scheme Type", "type": "string" } }, { "description": "方案名称", "in": "query", "name": "scheme_name", "required": true, "schema": { "description": "方案名称", "title": "Scheme Name", "type": "string" } }, { "description": "查询时间", "in": "query", "name": "query_time", "required": true, "schema": { "description": "查询时间", "title": "Query Time", "type": "string" } }, { "description": "元素类型,pipe(管道)或 junction(节点)", "in": "query", "name": "type", "required": true, "schema": { "description": "元素类型,pipe(管道)或 junction(节点)", "title": "Type", "type": "string" } }, { "description": "要查询的属性名称", "in": "query", "name": "property", "required": true, "schema": { "description": "要查询的属性名称", "title": "Property", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "按方案、时间和属性查询数据", "tags": [ "TimescaleDB - Scheme" ] } }, "/api/v1/timeseries/schemes/simulation-results": { "get": { "description": "按指定ID和时间查询方案模拟结果\n\n查询特定方案中的元素在某一时间点的模拟数据。\n\nArgs:\n scheme_type: 方案类型\n scheme_name: 方案名称\n id: 元素ID\n type: 元素类型(pipe或junction)\n query_time: 查询时间\n\nReturns:\n 模拟结果数据\n\nRaises:\n HTTPException: 当查询参数无效时返回400错误", "operationId": "get_timeseries_schemes_simulation_results", "parameters": [ { "description": "方案类型", "in": "query", "name": "scheme_type", "required": true, "schema": { "description": "方案类型", "title": "Scheme Type", "type": "string" } }, { "description": "方案名称", "in": "query", "name": "scheme_name", "required": true, "schema": { "description": "方案名称", "title": "Scheme Name", "type": "string" } }, { "description": "元素ID(管道ID或节点ID)", "in": "query", "name": "id", "required": true, "schema": { "description": "元素ID(管道ID或节点ID)", "title": "Id", "type": "string" } }, { "description": "元素类型,pipe(管道)或 junction(节点)", "in": "query", "name": "type", "required": true, "schema": { "description": "元素类型,pipe(管道)或 junction(节点)", "title": "Type", "type": "string" } }, { "description": "查询时间", "in": "query", "name": "query_time", "required": true, "schema": { "description": "查询时间", "title": "Query Time", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "按ID和时间查询方案模拟数据", "tags": [ "TimescaleDB - Scheme" ] }, "post": { "description": "存储方案模拟结果到时间序列数据库\n\n将特定方案的节点和管道模拟计算结果批量存储到TimescaleDB数据库。\n\nArgs:\n scheme_type: 方案类型\n scheme_name: 方案名称\n node_result_list: 节点模拟结果列表\n link_result_list: 管道模拟结果列表\n result_start_time: 模拟结果对应的起始时间\n\nReturns:\n 存储结果信息", "operationId": "post_timeseries_schemes_simulation_results", "parameters": [ { "description": "方案类型", "in": "query", "name": "scheme_type", "required": true, "schema": { "description": "方案类型", "title": "Scheme Type", "type": "string" } }, { "description": "方案名称", "in": "query", "name": "scheme_name", "required": true, "schema": { "description": "方案名称", "title": "Scheme Name", "type": "string" } }, { "description": "模拟结果开始时间", "in": "query", "name": "result_start_time", "required": true, "schema": { "description": "模拟结果开始时间", "title": "Result Start Time", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body_post_timeseries_schemes_simulation_results" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "存储方案模拟结果", "tags": [ "TimescaleDB - Scheme" ] } }, "/api/v1/timeseries/views/element-scada-readings": { "get": { "description": "获取link/node关联的SCADA监测值\n\n根据传入的link/node id,匹配SCADA信息,\n如果存在关联的SCADA device_id,获取实际的监测数据。\n\nArgs:\n element_id: 管网元素ID\n start_time: 查询开始时间\n end_time: 查询结束时间\n use_cleaned: 是否使用清洗后的数据,默认为False使用原始数据\n timescale_conn: TimescaleDB连接\n postgres_conn: PostgreSQL连接\n \nReturns:\n 管网元素关联的SCADA监测数据\n \nRaises:\n HTTPException: 当查询参数无效时返回400错误,未找到关联数据返回404错误", "operationId": "get_timeseries_views_element_scada_readings", "parameters": [ { "description": "管网元素ID(管道或节点)", "in": "query", "name": "element_id", "required": true, "schema": { "description": "管网元素ID(管道或节点)", "title": "Element Id", "type": "string" } }, { "description": "查询开始时间", "in": "query", "name": "start_time", "required": true, "schema": { "description": "查询开始时间", "format": "date-time", "title": "Start Time", "type": "string" } }, { "description": "查询结束时间", "in": "query", "name": "end_time", "required": true, "schema": { "description": "查询结束时间", "format": "date-time", "title": "End Time", "type": "string" } }, { "description": "是否使用清洗后的数据", "in": "query", "name": "use_cleaned", "required": false, "schema": { "default": false, "description": "是否使用清洗后的数据", "title": "Use Cleaned", "type": "boolean" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取管网元素关联的SCADA监测数据", "tags": [ "TimescaleDB - Composite" ] } }, "/api/v1/timeseries/views/element-simulations": { "get": { "description": "获取link/node模拟值\n\n根据传入的featureInfos,找到关联的link/node,\n并根据对应的type,查询对应的模拟数据。支持查询实时或方案数据。\n\nArgs:\n start_time: 查询开始时间\n end_time: 查询结束时间\n feature_infos: 格式为 \"element_id1:type1,element_id2:type2\"\n 例如: \"P1:pipe,J1:junction\"\n scheme_type: 方案类型,若为空则查询实时数据\n scheme_name: 方案名称,若为空则查询实时数据\n timescale_conn: TimescaleDB连接\n \nReturns:\n 管网元素的模拟数据\n \nRaises:\n HTTPException: 当feature_infos为空返回400错误,未找到数据返回404错误,其他错误返回400错误", "operationId": "get_timeseries_views_element_simulations", "parameters": [ { "description": "查询开始时间", "in": "query", "name": "start_time", "required": true, "schema": { "description": "查询开始时间", "format": "date-time", "title": "Start Time", "type": "string" } }, { "description": "查询结束时间", "in": "query", "name": "end_time", "required": true, "schema": { "description": "查询结束时间", "format": "date-time", "title": "End Time", "type": "string" } }, { "description": "特征信息,格式: id1:type1,id2:type2,type为pipe(管道)或junction(节点)", "in": "query", "name": "feature_infos", "required": true, "schema": { "description": "特征信息,格式: id1:type1,id2:type2,type为pipe(管道)或junction(节点)", "title": "Feature Infos", "type": "string" } }, { "description": "方案类型,若为空则查询实时数据", "in": "query", "name": "scheme_type", "required": false, "schema": { "description": "方案类型,若为空则查询实时数据", "title": "Scheme Type", "type": "string" } }, { "description": "方案名称,若为空则查询实时数据", "in": "query", "name": "scheme_name", "required": false, "schema": { "description": "方案名称,若为空则查询实时数据", "title": "Scheme Name", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取管网元素的模拟数据", "tags": [ "TimescaleDB - Composite" ] } }, "/api/v1/timeseries/views/scada-simulations": { "get": { "description": "获取SCADA关联的link/node模拟值\n\n根据传入的SCADA device_ids,找到关联的link/node,\n并根据对应的type,查询对应的模拟数据。支持查询实时或方案数据。\n\nArgs:\n start_time: 查询开始时间\n end_time: 查询结束时间\n device_ids: SCADA设备ID列表,用逗号分隔\n scheme_type: 方案类型,若为空则查询实时数据\n scheme_name: 方案名称,若为空则查询实时数据\n timescale_conn: TimescaleDB连接\n postgres_conn: PostgreSQL连接\n \nReturns:\n SCADA关联的模拟数据\n \nRaises:\n HTTPException: 当查询参数无效时返回400错误,未找到数据时返回404错误", "operationId": "get_timeseries_views_scada_simulations", "parameters": [ { "description": "查询开始时间", "in": "query", "name": "start_time", "required": true, "schema": { "description": "查询开始时间", "format": "date-time", "title": "Start Time", "type": "string" } }, { "description": "查询结束时间", "in": "query", "name": "end_time", "required": true, "schema": { "description": "查询结束时间", "format": "date-time", "title": "End Time", "type": "string" } }, { "description": "SCADA设备ID列表,逗号分隔", "in": "query", "name": "device_ids", "required": true, "schema": { "description": "SCADA设备ID列表,逗号分隔", "title": "Device Ids", "type": "string" } }, { "description": "方案类型,若为空则查询实时数据", "in": "query", "name": "scheme_type", "required": false, "schema": { "description": "方案类型,若为空则查询实时数据", "title": "Scheme Type", "type": "string" } }, { "description": "方案名称,若为空则查询实时数据", "in": "query", "name": "scheme_name", "required": false, "schema": { "description": "方案名称,若为空则查询实时数据", "title": "Scheme Name", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取SCADA关联的模拟数据", "tags": [ "TimescaleDB - Composite" ] } }, "/api/v1/title-schemas": { "get": { "description": "获取指定水网的标题(标题)属性架构定义", "operationId": "get_title_schemas", "parameters": [ { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": { "type": "object" }, "title": "Response Get Title Schemas", "type": "object" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取标题属性架构", "tags": [ "Network General" ] } }, "/api/v1/titles": { "get": { "description": "获取指定水网的标题(Title)信息", "operationId": "get_titles", "parameters": [ { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "title": "Response Get Titles", "type": "object" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取水网标题属性", "tags": [ "Network General" ] }, "patch": { "description": "设置指定水网的标题(Title)信息", "operationId": "patch_titles", "parameters": [ { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "设置水网标题属性", "tags": [ "Network General" ] } }, "/api/v1/undos": { "post": { "description": "撤销网络上最后的一个操作", "operationId": "post_undos", "parameters": [ { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "撤销操作", "tags": [ "Snapshots" ] } }, "/api/v1/users": { "get": { "description": "获取指定网络的所有用户列表", "operationId": "get_users", "parameters": [ { "in": "query", "name": "limit", "required": false, "schema": { "default": 100, "maximum": 1000, "minimum": 1, "title": "Limit", "type": "integer" } }, { "in": "query", "name": "offset", "required": false, "schema": { "default": 0, "minimum": 0, "title": "Offset", "type": "integer" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_dict_Any__Any__" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取所有用户", "tags": [ "Users" ] } }, "/api/v1/users/detail": { "get": { "description": "获取指定网络中的单个用户信息", "operationId": "get_users_detail", "parameters": [ { "description": "用户名", "in": "query", "name": "user_name", "required": true, "schema": { "description": "用户名", "title": "User Name", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "title": "Response Get Users Detail", "type": "object" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取单个用户", "tags": [ "Users" ] } }, "/api/v1/valve-closure-analyses": { "post": { "description": "高级版本的阀门关闭分析,支持同时关闭多个阀门,并在指定持续时间内进行模拟。返回纯文本格式的分析结果。", "operationId": "post_valve_closure_analyses", "parameters": [ { "description": "阀门关闭开始时间(ISO 8601格式)", "in": "query", "name": "start_time", "required": true, "schema": { "description": "阀门关闭开始时间(ISO 8601格式)", "title": "Start Time", "type": "string" } }, { "description": "要关闭的阀门ID列表", "in": "query", "name": "valves", "required": true, "schema": { "description": "要关闭的阀门ID列表", "items": { "type": "string" }, "title": "Valves", "type": "array" } }, { "description": "模拟持续时间(秒),默认900秒", "in": "query", "name": "duration", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "模拟持续时间(秒),默认900秒", "title": "Duration" } }, { "description": "阀门关闭方案名称", "in": "query", "name": "scheme_name", "required": true, "schema": { "description": "阀门关闭方案名称", "title": "Scheme Name", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "text/plain": { "schema": { "type": "string" } } }, "description": "Successful Response" }, "401": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "阀门关闭分析(高级)", "tags": [ "Simulation Control" ] } }, "/api/v1/valve-isolation-analyses": { "post": { "description": "分析当发生突发事件时,通过关闭指定阀门进行隔离,确定哪些阀门必须关闭、哪些可选关闭,以及隔离的可行性。", "operationId": "post_valve_isolation_analyses", "parameters": [ { "description": "发生事故的管段/节点ID列表", "in": "query", "name": "accident_element", "required": true, "schema": { "description": "发生事故的管段/节点ID列表", "items": { "type": "string" }, "title": "Accident Element", "type": "array" } }, { "description": "已故障的阀门ID列表(可选)", "in": "query", "name": "disabled_valves", "required": false, "schema": { "description": "已故障的阀门ID列表(可选)", "items": { "type": "string" }, "title": "Disabled Valves", "type": "array" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "阀门隔离分析", "tags": [ "Simulation Control" ] } }, "/api/v1/valves": { "delete": { "description": "从指定的水网中删除指定的阀门", "operationId": "delete_valves", "parameters": [ { "description": "阀门ID", "in": "query", "name": "valve", "required": true, "schema": { "description": "阀门ID", "title": "Valve", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "204": { "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "删除阀门", "tags": [ "Valves" ] }, "get": { "description": "获取指定水网中所有阀门的属性", "operationId": "get_valves", "parameters": [ { "in": "query", "name": "limit", "required": false, "schema": { "default": 100, "maximum": 1000, "minimum": 1, "title": "Limit", "type": "integer" } }, { "in": "query", "name": "offset", "required": false, "schema": { "default": 0, "minimum": 0, "title": "Offset", "type": "integer" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_dict_str__Any__" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取所有阀门属性", "tags": [ "Valves" ] }, "post": { "description": "在指定的水网中添加新的阀门", "operationId": "post_valves", "parameters": [ { "description": "阀门ID", "in": "query", "name": "valve", "required": true, "schema": { "description": "阀门ID", "title": "Valve", "type": "string" } }, { "description": "起点节点ID", "in": "query", "name": "node1", "required": true, "schema": { "description": "起点节点ID", "title": "Node1", "type": "string" } }, { "description": "终点节点ID", "in": "query", "name": "node2", "required": true, "schema": { "description": "终点节点ID", "title": "Node2", "type": "string" } }, { "description": "阀门直径(mm)", "in": "query", "name": "diameter", "required": false, "schema": { "default": 0, "description": "阀门直径(mm)", "title": "Diameter", "type": "number" } }, { "description": "阀门类型", "in": "query", "name": "v_type", "required": false, "schema": { "default": "PRV", "description": "阀门类型", "title": "V Type", "type": "string" } }, { "description": "阀门开度/设置值", "in": "query", "name": "setting", "required": false, "schema": { "default": 0, "description": "阀门开度/设置值", "title": "Setting", "type": "number" } }, { "description": "损失系数", "in": "query", "name": "minor_loss", "required": false, "schema": { "default": 0, "description": "损失系数", "title": "Minor Loss", "type": "number" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "添加阀门", "tags": [ "Valves" ] } }, "/api/v1/valves/diameter": { "get": { "description": "获取指定阀门的直径", "operationId": "get_valves_diameter", "parameters": [ { "description": "阀门ID", "in": "query", "name": "valve", "required": true, "schema": { "description": "阀门ID", "title": "Valve", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Response Get Valves Diameter" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取阀门直径", "tags": [ "Valves" ] }, "patch": { "description": "设置指定阀门的直径", "operationId": "patch_valves_diameter", "parameters": [ { "description": "阀门ID", "in": "query", "name": "valve", "required": true, "schema": { "description": "阀门ID", "title": "Valve", "type": "string" } }, { "description": "新的直径值(mm)", "in": "query", "name": "diameter", "required": true, "schema": { "description": "新的直径值(mm)", "title": "Diameter", "type": "number" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "设置阀门直径", "tags": [ "Valves" ] } }, "/api/v1/valves/existence": { "get": { "description": "检查指定ID是否为水网中的阀门", "operationId": "get_valves_existence", "parameters": [ { "description": "管线ID", "in": "query", "name": "link", "required": true, "schema": { "description": "管线ID", "title": "Link", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "title": "Response Get Valves Existence", "type": "boolean" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "检查是否为阀门", "tags": [ "Network General" ] } }, "/api/v1/valves/minor-loss": { "get": { "description": "获取指定阀门的损失系数", "operationId": "get_valves_minor_loss", "parameters": [ { "description": "阀门ID", "in": "query", "name": "valve", "required": true, "schema": { "description": "阀门ID", "title": "Valve", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Response Get Valves Minor Loss" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取阀门损失系数", "tags": [ "Valves" ] } }, "/api/v1/valves/node1": { "get": { "description": "获取指定阀门连接的起点节点ID", "operationId": "get_valves_node1", "parameters": [ { "description": "阀门ID", "in": "query", "name": "valve", "required": true, "schema": { "description": "阀门ID", "title": "Valve", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Response Get Valves Node1" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取阀门起点节点", "tags": [ "Valves" ] }, "patch": { "description": "设置指定阀门的起点节点", "operationId": "patch_valves_node1", "parameters": [ { "description": "阀门ID", "in": "query", "name": "valve", "required": true, "schema": { "description": "阀门ID", "title": "Valve", "type": "string" } }, { "description": "新的起点节点ID", "in": "query", "name": "node1", "required": true, "schema": { "description": "新的起点节点ID", "title": "Node1", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "设置阀门起点节点", "tags": [ "Valves" ] } }, "/api/v1/valves/node2": { "get": { "description": "获取指定阀门连接的终点节点ID", "operationId": "get_valves_node2", "parameters": [ { "description": "阀门ID", "in": "query", "name": "valve", "required": true, "schema": { "description": "阀门ID", "title": "Valve", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Response Get Valves Node2" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取阀门终点节点", "tags": [ "Valves" ] }, "patch": { "description": "设置指定阀门的终点节点", "operationId": "patch_valves_node2", "parameters": [ { "description": "阀门ID", "in": "query", "name": "valve", "required": true, "schema": { "description": "阀门ID", "title": "Valve", "type": "string" } }, { "description": "新的终点节点ID", "in": "query", "name": "node2", "required": true, "schema": { "description": "新的终点节点ID", "title": "Node2", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "设置阀门终点节点", "tags": [ "Valves" ] } }, "/api/v1/valves/properties": { "get": { "description": "获取指定阀门的所有属性", "operationId": "get_valves_properties", "parameters": [ { "description": "阀门ID", "in": "query", "name": "valve", "required": true, "schema": { "description": "阀门ID", "title": "Valve", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "title": "Response Get Valves Properties", "type": "object" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取阀门所有属性", "tags": [ "Valves" ] }, "patch": { "description": "批量设置指定阀门的多个属性", "operationId": "patch_valves_properties", "parameters": [ { "description": "阀门ID", "in": "query", "name": "valve", "required": true, "schema": { "description": "阀门ID", "title": "Valve", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "批量设置阀门属性", "tags": [ "Valves" ] } }, "/api/v1/valves/setting": { "get": { "description": "获取指定阀门的开度/设置值", "operationId": "get_valves_setting", "parameters": [ { "description": "阀门ID", "in": "query", "name": "valve", "required": true, "schema": { "description": "阀门ID", "title": "Valve", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Response Get Valves Setting" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取阀门开度", "tags": [ "Valves" ] }, "patch": { "description": "设置指定阀门的开度/设置值", "operationId": "patch_valves_setting", "parameters": [ { "description": "阀门ID", "in": "query", "name": "valve", "required": true, "schema": { "description": "阀门ID", "title": "Valve", "type": "string" } }, { "description": "新的开度值", "in": "query", "name": "setting", "required": true, "schema": { "description": "新的开度值", "title": "Setting", "type": "number" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "设置阀门开度", "tags": [ "Valves" ] } }, "/api/v1/valves/type": { "get": { "description": "获取指定阀门的类型", "operationId": "get_valves_type", "parameters": [ { "description": "阀门ID", "in": "query", "name": "valve", "required": true, "schema": { "description": "阀门ID", "title": "Valve", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Response Get Valves Type" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取阀门类型", "tags": [ "Valves" ] }, "patch": { "description": "设置指定阀门的类型", "operationId": "patch_valves_type", "parameters": [ { "description": "阀门ID", "in": "query", "name": "valve", "required": true, "schema": { "description": "阀门ID", "title": "Valve", "type": "string" } }, { "description": "新的阀门类型", "in": "query", "name": "type", "required": true, "schema": { "description": "新的阀门类型", "title": "Type", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "设置阀门类型", "tags": [ "Valves" ] } }, "/api/v1/virtual-district-calculations": { "post": { "description": "根据指定的压力监测节点作为中心节点计算虚拟分区方案", "operationId": "post_virtual_district_calculations", "parameters": [ { "description": "压力监测节点ID列表", "in": "query", "name": "centers", "required": true, "schema": { "description": "压力监测节点ID列表", "items": { "type": "string" }, "title": "Centers", "type": "array" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": { "items": {}, "type": "array" }, "title": "Response Post Virtual District Calculations", "type": "object" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "计算虚拟分区", "tags": [ "Regions & DMAs" ] } }, "/api/v1/virtual-district-generation-runs": { "post": { "description": "根据参数自动生成虚拟分区方案", "operationId": "post_virtual_district_generation_runs", "parameters": [ { "description": "膨胀参数", "in": "query", "name": "inflate_delta", "required": true, "schema": { "description": "膨胀参数", "title": "Inflate Delta", "type": "number" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "生成虚拟分区", "tags": [ "Regions & DMAs" ] } }, "/api/v1/virtual-districts": { "delete": { "description": "删除指定的虚拟分区", "operationId": "delete_virtual_districts", "parameters": [ { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "204": { "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "删除虚拟分区", "tags": [ "Regions & DMAs" ] }, "get": { "description": "获取指定水网中的所有虚拟分区信息", "operationId": "get_virtual_districts", "parameters": [ { "in": "query", "name": "limit", "required": false, "schema": { "default": 100, "maximum": 1000, "minimum": 1, "title": "Limit", "type": "integer" } }, { "in": "query", "name": "offset", "required": false, "schema": { "default": 0, "minimum": 0, "title": "Offset", "type": "integer" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_dict_str__Any__" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取所有虚拟分区", "tags": [ "Regions & DMAs" ] }, "patch": { "description": "修改指定虚拟分区的属性信息", "operationId": "patch_virtual_districts", "parameters": [ { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "设置虚拟分区属性", "tags": [ "Regions & DMAs" ] }, "post": { "description": "向水网添加一个新的虚拟分区", "operationId": "post_virtual_districts", "parameters": [ { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "添加新虚拟分区", "tags": [ "Regions & DMAs" ] } }, "/api/v1/virtual-districts/detail": { "get": { "description": "获取指定ID的虚拟分区详细信息", "operationId": "get_virtual_districts_detail", "parameters": [ { "description": "虚拟分区ID", "in": "query", "name": "id", "required": true, "schema": { "description": "虚拟分区ID", "title": "Id", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "title": "Response Get Virtual Districts Detail", "type": "object" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取虚拟分区信息", "tags": [ "Regions & DMAs" ] } }, "/api/v1/visual-elements": { "delete": { "description": "从网络中删除指定的图形元素", "operationId": "delete_visual_elements", "parameters": [ { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "204": { "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "删除图形元素", "tags": [ "Visuals" ] }, "post": { "description": "在网络中添加一个新的图形元素", "operationId": "post_visual_elements", "parameters": [ { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "添加图形元素", "tags": [ "Visuals" ] } }, "/api/v1/visual-elements/links": { "get": { "description": "获取网络中的所有图形元素链接列表", "operationId": "get_visual_elements_links", "parameters": [ { "in": "query", "name": "limit", "required": false, "schema": { "default": 100, "maximum": 1000, "minimum": 1, "title": "Limit", "type": "integer" } }, { "in": "query", "name": "offset", "required": false, "schema": { "default": 0, "minimum": 0, "title": "Offset", "type": "integer" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "text/plain": { "schema": { "type": "string" } } }, "description": "Successful Response" }, "401": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取所有图形元素链接", "tags": [ "Visuals" ] } }, "/api/v1/visual-elements/properties": { "get": { "description": "获取指定图形元素的属性信息", "operationId": "get_visual_elements_properties", "parameters": [ { "description": "图形元素链接", "in": "query", "name": "link", "required": true, "schema": { "description": "图形元素链接", "title": "Link", "type": "string" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "title": "Response Get Visual Elements Properties", "type": "object" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "获取图形元素属性", "tags": [ "Visuals" ] }, "patch": { "description": "更新指定图形元素的属性", "operationId": "patch_visual_elements_properties", "parameters": [ { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "设置图形元素属性", "tags": [ "Visuals" ] } }, "/api/v1/water-age-analyses": { "post": { "description": "高级版本的水龄分析,在指定时间点进行分析,支持自定义模拟持续时间。返回纯文本格式的分析结果。", "operationId": "post_water_age_analyses", "parameters": [ { "description": "分析开始时间(ISO 8601格式)", "in": "query", "name": "start_time", "required": true, "schema": { "description": "分析开始时间(ISO 8601格式)", "title": "Start Time", "type": "string" } }, { "description": "模拟持续时间(秒)", "in": "query", "name": "duration", "required": true, "schema": { "description": "模拟持续时间(秒)", "title": "Duration", "type": "integer" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "text/plain": { "schema": { "type": "string" } } }, "description": "Successful Response" }, "401": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "水龄分析(高级)", "tags": [ "Simulation Control" ] } }, "/api/v1/web-searches": { "post": { "description": "调用 Bocha Web Search API 获取实时网页搜索结果", "operationId": "post_web_searches", "parameters": [ { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebSearchRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "title": "Response Post Web Searches", "type": "object" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "Web Search", "tags": [ "Web Search" ] } }, "/api/v1/with-servers": { "post": { "description": "将网络与服务器同步到指定操作", "operationId": "post_with_servers", "parameters": [ { "description": "目标操作ID", "in": "query", "name": "operation", "required": true, "schema": { "description": "目标操作ID", "title": "Operation", "type": "integer" } }, { "in": "header", "name": "X-Project-Id", "required": true, "schema": { "title": "X-Project-Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValue" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Insufficient permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Resource conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Validation error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Dependency unavailable" } }, "security": [ { "OAuth2PasswordBearer": [] } ], "summary": "与服务器同步", "tags": [ "Snapshots" ] } } } }