根据方案库类型和业务类型查询对应方案库下启用的模板方案

GET

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

关键词：
模板方案、方案库、方案库类型、业务类型

使用场景：
用户在创建方案时，或者需要查询与模型相关的基础数据、映射关系、配置信息时，均需要先获取对应的模板方案，该接口可基于方案库类型和业务类型查询对应的方案库下的启用的模板方案，比如内涝（businessType=2）预报（type=1）库下启用的模板方案，并且能够相对高效得返回结果。

相关背景：
模板方案是创建普通方案的基础，同时它又绑定了模型相关的一系列基础数据，包括模型的空间坐标系，河道、管网、二维网格等GIS信息，各类模型点位（如管网、节点、河道、结构物、边界...）、映射关系等，甚至如滚动预报配置、阈值配置等一系列基础配置信息也是与模板方案绑定的，所以模板方案的查询是一个基础且常用的功能需求。

请求参数

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

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request GET 'http://10.174.150.25:32001/api/v2/scenario-manager/library/list/getcachedscenario?type=1&businessType=2'

返回响应

🟢200成功

text/plain

Success

Body

Scenario

string <uuid>

必需

方案ID，唯一性标识

scenarioCode

string

必需

方案代码，创建方案时自动生成

>= 0 字符<= 100 字符

scenarioName

string | null

方案名称

可选

>= 0 字符<= 200 字符

modelType

string | null

可选

方案对应的模型类型，枚举参考ModelTypeEnum，目前已存在的定义包括MIKE11Model、MIKEBASINModel、MIKE21Model、MIKE21FMModel、MIKE3FMModel、MIKEFloodModel、MIKESHEModel、MIKEUrbanCSModel、MIKEUrbanWDModel、HydroBasinModel、InpWDModel、XAJ11Model、FeflowModel、WestModel、SWMMModel、EFDCModel、WaterForecastModel、HydroBasinOptimModel、MIKEUrbanCSPlusModel、MIKEUrbanWDPlusModel、HammerModel、MIKEPlusFloodModel、MIKEPlusWDModel、EPANET、Unknown

>= 0 字符<= 100 字符

modelSubType

string | null

可选

方案子类型，枚举参考enumSubType，目前已存在的定义包括ManualSchedule、EconomicSchedule、OptimizeSchedule、UnprocessedWater、DataAssimilation、EmerResponse、Forecast、EmerMnt、Scenario、Incident、ParaOptimi、SourceAnalysis、WQEvaluation、SpatialTime、Planning、OilSpill、Year、Month、TenDays、PumpShutdown、PipeBurst、Unknown，如果以上枚举项都不符合，也可以完全自定义

>= 0 字符<= 200 字符

template

integer <int32>

可选

是否是模板方案，1表示模板方案，0表示非模板方案

inheritedScenario

string <uuid>

可选

父方案ID，如果方案是基于模板方案生成的，那它的父方案就是模板方案；如果方案是基于某个普通方案派生而来的，那它的父方案就是这个普通方案

readOnly

integer <int32>

可选

是否只读，1表示只读，0表示可读写

enabled

integer <int32>

可选

（模板方案）是否启用，1表示启用，0表示不启用

relativeFolder

string | null

可选

方案模型文件夹相对路径，但由于目前方案采用的是分布式文件系统，不在本地保存，因此该字段已无实际意义

>= 0 字符<= 1000 字符

projectFile

string | null

可选

模型文件名称，比如针对MIKE11模型，就是指模型文件夹中.sim11模型文件的名称

>= 0 字符<= 200 字符

currentTime

string <date-time>

可选

模型预报时刻，针对预报方案而言，预报时刻之前就是模型前算期，预报时刻之后就是预报期

startTime

string <date-time>

模型开始时刻

可选

endTime

string <date-time>

模型结束时刻

可选

createTime

string <date-time>

方案创建时刻

可选

autoCalculate

integer <int32>

可选

是否自动计算，但由于目前方案基于方案库进行管理，因此该字段已无实际意义

modified

integer <int32>

可选

方案是否修改过，1表示修改过，0表示没有修改过

checked

integer <int32>

可选

方案是否被选中，1表示被选中，0表示未被选中

calculated

integer <int32>

可选

方案是否计算完成，1表示计算完成，0表示未计算完成

published

integer <int32>

可选

方案是否已经发布，1表示已发布，0表示未发布

onlineFirst

integer <int32>

可选

是否优先使用在线数据，目前数据接入均已自动化，因此该字段已无实际意义

autoAmend

integer <int32>

可选

是否自动修正数据，目前数据接入均已自动化，因此该字段已无实际意义

state

string | null

方案的状态

可选

>= 0 字符<= 200 字符

description

string | null

方案的描述

可选

>= 0 字符<= 2000 字符

version

string <uuid>

方案版本信息

可选

tenantId

string | null

租户ID

可选

minIOPath

string | null

可选

部分方案文件，比如模板方案的模型文件等需要上传到分布式文件系统去保存，这个字段代表方案文件在分布式文件系统上的存储路径

>= 0 字符<= 1000 字符

minIOBucket

string | null

可选

方案文件在分布式文件系统上的存储桶

>= 0 字符<= 200 字符

creatorName

string | null

创建方案的用户账号

可选

attributes

string | null

方案自定义列

可选

name

string | null

可选

示例

{
    "data": {
        "id": "adfcbbcd-1335-4e01-8f23-d38232ab623d",
        "scenarioCode": "ZXGDMBFAV3806258",
        "scenarioName": "在线滚动模板方案V3",
        "modelType": "MIKEPlusFloodModel",
        "modelSubType": "Unknown",
        "template": 1,
        "inheritedScenario": "00000000-0000-0000-0000-000000000000",
        "readOnly": 0,
        "enabled": 1,
        "relativeFolder": "ZXGDMBFAV3806258",
        "projectFile": "BYJC_YS.mupp",
        "currentTime": "2024-12-18T11:35:03.7053",
        "startTime": "2024-12-18T11:35:03.7053",
        "endTime": "2024-12-18T11:35:03.7053",
        "createTime": "2024-12-18T11:35:03.7109",
        "autoCalculate": 0,
        "modified": 0,
        "checked": 0,
        "calculated": 0,
        "published": 0,
        "onlineFirst": 1,
        "autoAmend": 1,
        "state": null,
        "description": null,
        "version": "530223ea-b68b-41c9-b459-e32fbf2a2df4",
        "tenantId": "3a1654c5-4f41-00be-3508-362dee00b666",
        "minIOPath": "modelconfiguration/modeltemplatefiles/BYJC_YS_8d08bc82-3b95-4712-84ae-0b9d2f198717.zip",
        "minIOBucket": "MIKEPlusFloodModel",
        "creatorName": null,
        "attributes": null,
        "name": "ZXGDMBFAV3806258"
    },
    "status": true,
    "code": "000000",
    "message": null,
    "traceId": null
}

修改于 2025-03-13 09:22:00

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

根据方案库查询其下的所有方案列表