方案管理服务
  1. Library
方案管理服务
  • Library
    • 创建新的方案库
      POST
    • 删除方案库下过期的方案
      POST
    • 根据方案库ID列表删除方案库
      POST
    • 获取方案库中方案的过期时间配置
      GET
    • 更新方案库信息
      POST
    • 设置方案库中方案过期时间
      POST
    • 获取所有方案库列表
      GET
    • 根据类型查询方案库列表
      GET
    • 根据方案库类型和业务类型查询方案库
      GET
    • 根据方案库类型和业务类型查询对应方案库下启用的模板方案
      GET
    • 根据方案库查询其下的所有方案列表
      GET
    • 根据方案库查询其下最近一次计算完成的方案
      GET
    • 根据方案库,以及模板方案名称与模型类型,查询其下最近一次计算完成的方案
      GET
    • 根据方案库查询其下所绑定的模板方案列表
      GET
    • 启用方案库下面的某个模板方案
      POST
    • 删除方案库下过期的方案
      POST
    • 删除方案库下指定时间段内的方案
      POST
  • ScenarioGroup
    • 获取所有的根方案组
      GET
    • 根据父方案组查询其下所有的子方案组
      GET
    • 根据方案组查询其关联的方案列表
      GET
    • 创建一个新的根方案组
      POST
    • 创建一个新的方案组
      POST
    • 删除方案组,同时删除其下的方案
      POST
    • 基于分布式文件系统,删除方案组,同时删除其下的方案
      POST
    • 重命名方案组
      POST
  • ScenarioManager
    • 根据方案ID获取方案基本信息
      GET
    • 根据方案ID获取方案的主模型文件绝对路径
      GET
    • 根据方案ID获取方案文件夹的绝对路径
      GET
    • 获取所有的模板方案列表
      GET
    • 根据子类型来查询和筛选方案列表
      GET
    • 根据父方案ID获取其下子方案的列表
      GET
    • 根据方案ID查询其对应的模板方案
      GET
    • 创建一个新的模板方案
      POST
    • 基于分布式文件系统,创建模板方案
      POST
    • 创建一个新的方案
      POST
    • 基于分布式文件系统,创建一个新的方案
      POST
    • 更新方案基本信息
      POST
    • 根据方案ID删除方案
      POST
    • 基于分布式文件系统,删除方案
      POST
    • 重命名方案
      POST
    • 更新方案,同时更新其对应的模型文件
      POST
    • 设置方案库下一个用于默认展示的方案
      POST
  1. Library

根据方案库类型和业务类型查询方案库

GET
/api/v2/scenario-manager/library/list/type_businesstype
Library
关键词:
方案库、方案库类型、业务类型
使用场景:
用于获取项目下指定类型和业务类型的方案库,比如内涝(业务类型)预报(类型)库,通常一个项目下指定类型和业务类型对应的方案库只会有一个。
基于方案库,用户可进一步通过接口/api/v1/scenario-manager/library/scenariolist查询方案库包含的所有方案,通过接口/api/v1/scenario-manager/library/latestscenario查询方案库下最新一个完成计算的方案,通过接口/api/v1/scenario-manager/library/templatelist查询方案库包含的所有模板方案。
相关背景:
方案库类型是对方案库在功能性上进行的一种分类,比如预报库、调度库、情景模拟库、经验库等。
业务类型是对方案库在业务方向上进行的一种分类,比如内涝、水环境、供水、排水、污水等。

请求参数

Authorization
在 Header 添加参数
Authorization
,其值为在 Bearer 之后拼接 Token
示例:
Authorization: Bearer ********************
Path 参数
version
string 
必需
Query 参数
type
enum<integer> <int32>
可选
方案库类型,枚举,目前已存在0-19种定义,包括0:未定义;1:自动预报库;2:人工预报库;3:预报库;4:调度库;5:经验库;6:情景模拟库;7:突发水污染事故库;8:在线水动力库(供水);9:水锤库(供水);10:管道充满度库;11:爆管库(供水);12:污染事故响应库;13:规划库;14:管道冲洗库(供水);15:污染事故库(供水);16:关阀库(供水);17:在线滚动预报库(污水厂);18:在线滚动优化库(污水厂);19:模拟实验室库(污水厂)
枚举值:
012345678910111213141516171819
businessType
enum<integer> <int32>
可选
业务类型,枚举,目前已存在0-6种定义,包括0:未定义;1:水环境;2:内涝;3:供水;4:流域洪水;5:污水厂;6:排水
枚举值:
0123456

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request GET 'http://10.174.150.25:32001/api/v2/scenario-manager/library/list/type_businesstype?type=1&businessType=2'

返回响应

🟢200成功
text/plain
Success
Body
array of:
id
string <uuid>
必需
方案库的ID,唯一性标识
tenantId
string  | null 
租户ID
可选
>= 0 字符<= 100 字符
scenariogroup
string <uuid>
必需
方案库所关联的方案组ID
name
string 
方案库的名称
必需
>= 0 字符<= 100 字符
type
integer <int32>
可选
方案库的类型,枚举参考LibraryTypeEnum,目前已存在0-19种定义,包括0:未定义;1:自动预报库;2:人工预报库;3:预报库;4:调度库;5:经验库;6:情景模拟库;7:突发水污染事故库;8:在线水动力库(供水);9:水锤库(供水);10:管道充满度库;11:爆管库(供水);12:污染事故响应库;13:规划库;14:管道冲洗库(供水);15:污染事故库(供水);16:关阀库(供水);17:在线滚动预报库(污水厂);18:在线滚动优化库(污水厂);19:模拟实验室库(污水厂)
businessType
integer <int32>
可选
方案库的业务类型,枚举参考BusinessTypeEnum,目前已存在0-6种定义,包括0:未定义;1:水环境;2:内涝;3:供水;4:流域洪水;5:污水厂;6:排水
readonly
integer <int32>
可选
是否只读,0代表可读写,1代表只读
bindTemplate
integer <int32>
可选
是否直接绑定模板方案,1表示该方案库直接绑定一个模板方案,0表示不直接绑定,而是采用BindType和BindBusinessType所对应的那个方案库下的模板方案,属于间接绑定
bindType
integer <int32>
可选
当BindTemplate为0,此项表示该方案库采用的模板方案所对应的方案库的类型,枚举参考LibraryTypeEnum
bindBusinessType
integer <int32>
可选
当BindTemplate为0,此项表示该方案库采用的模板方案所对应的方案库的业务类型,枚举参考BusinessTypeEnum
enableMultiTemplate
integer <int32> | null 
可选
是否支持绑定多个启用的模板方案,0表示只能绑定单个启用的模板方案,1表示可以绑定多个启用的模板方案
description
string  | null 
方案库的描述信息
可选
>= 0 字符<= 1000 字符
示例
{
    "data": [
        {
            "id": "b48cb1a1-3c36-469d-be99-1fe3231ac8f6",
            "tenantId": "3a1654c5-4f41-00be-3508-362dee00b666",
            "scenariogroup": "4f3020a7-7e79-4a6b-b356-1d961389088d",
            "name": "自动预报",
            "type": 1,
            "businessType": 2,
            "readonly": 1,
            "bindTemplate": 1,
            "bindType": 0,
            "bindBusinessType": 0,
            "enableMultiTemplate": null,
            "description": "白云机场内涝_自动预报"
        }
    ],
    "status": true,
    "code": "000000",
    "message": null,
    "traceId": null
}
上一页
根据类型查询方案库列表
下一页
根据方案库类型和业务类型查询对应方案库下启用的模板方案
Built with