获取所有方案库列表

GET

/api/v2/scenario-manager/library/list

关键词：
方案库

使用场景：
用于获取项目下所有的方案库的信息列表，用户可以基于此列表，再进一步筛选指定类型（Type）和业务类型（BusinessType）的方案库。
基于方案库，用户可进一步通过接口/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

必需

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200成功

text/plain

Success

Body

array of:

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": "自动预报"
        },
        {
            "id": "7e76b063-a47a-4e39-945b-6ff67728787f",
            "tenantId": "3a1654c5-4f41-00be-3508-362dee00b666",
            "scenariogroup": "abfcfe31-2546-487a-9551-51c7183ff475",
            "name": "预演库",
            "type": 6,
            "businessType": 2,
            "readonly": 1,
            "bindTemplate": 0,
            "bindType": 1,
            "bindBusinessType": 2,
            "enableMultiTemplate": null,
            "description": "预演库"
        }
    ],
    "status": true,
    "code": "000000",
    "message": null,
    "traceId": null
}

修改于 2025-03-13 08:47:52

设置方案库中方案过期时间

根据类型查询方案库列表