获取所有的模板方案列表

关键词：
模板方案

使用场景：
此接口用于获取项目下所有的模板方案列表，不区分所属的方案库，不区分是否启用。如果项目是基于方案库对方案进行管理的，并且明确知道需要获取的是某个方案库下的模板方案，那么可以采用接口/api/v1/scenario-manager/library/templatelist来代替。

返回响应

🟢200成功

text/plain

Success

Body

array of:

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": "504dcf0e-0f8b-4a02-916e-13e740fbb614",
            "scenarioCode": "ZXGDMBFAV2578050",
            "scenarioName": "在线滚动模板方案V2",
            "modelType": "MIKEPlusFloodModel",
            "modelSubType": "Unknown",
            "template": 1,
            "inheritedScenario": "00000000-0000-0000-0000-000000000000",
            "readOnly": 0,
            "enabled": 0,
            "relativeFolder": "ZXGDMBFAV2578050",
            "projectFile": "Model_BYJC_YS.mupp",
            "currentTime": "2024-12-12T14:39:00.988",
            "startTime": "2024-12-12T14:39:00.988",
            "endTime": "2024-12-12T14:39:00.988",
            "createTime": "2024-12-12T14:39:00.9911",
            "autoCalculate": 0,
            "modified": 0,
            "checked": 0,
            "calculated": 0,
            "published": 0,
            "onlineFirst": 1,
            "autoAmend": 1,
            "state": null,
            "description": null,
            "version": "68d298db-166c-45bc-9bb1-b9b80d503aa2",
            "tenantId": "3a1654c5-4f41-00be-3508-362dee00b666",
            "minIOPath": "modelconfiguration/modeltemplatefiles/Model_BYJC_YS_44bfa445-9b68-4046-be2f-e5c32f1a99e2.zip",
            "minIOBucket": "MIKEPlusFloodModel",
            "creatorName": null,
            "attributes": null,
            "name": "ZXGDMBFAV2578050"
        },
        {
            "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": "ca285a83-5e04-46ff-a1ff-33069ed85093",
            "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"
        },
        {
            "id": "87a75994-ed41-4b4a-8a77-1f08304b7d72",
            "scenarioCode": "WSMBFAV1427060",
            "scenarioName": "污水模板方案V1",
            "modelType": "MIKEPlusFloodModel",
            "modelSubType": "Unknown",
            "template": 1,
            "inheritedScenario": "00000000-0000-0000-0000-000000000000",
            "readOnly": 0,
            "enabled": 1,
            "relativeFolder": "WSMBFAV1427060",
            "projectFile": "Model_BYJC_DPQ_GCS_WGS_1984.mupp",
            "currentTime": "2024-12-31T13:32:31.4633",
            "startTime": "2024-12-31T13:32:31.4633",
            "endTime": "2024-12-31T13:32:31.4633",
            "createTime": "2024-12-31T13:32:31.4731",
            "autoCalculate": 0,
            "modified": 0,
            "checked": 0,
            "calculated": 0,
            "published": 0,
            "onlineFirst": 1,
            "autoAmend": 1,
            "state": null,
            "description": null,
            "version": "2e6ba183-d48a-4575-afa9-ad639f1f634d",
            "tenantId": "3a1654c5-4f41-00be-3508-362dee00b666",
            "minIOPath": "modelconfiguration/modeltemplatefiles/BYJC_WS_cea8c40e-b74c-490f-ace6-25e16c588907.zip",
            "minIOBucket": "MIKEPlusFloodModel",
            "creatorName": null,
            "attributes": null,
            "name": "WSMBFAV1427060"
        }
    ],
    "status": true,
    "code": "000000",
    "message": null,
    "traceId": null
}

获取所有的模板方案列表

请求参数

示例代码

返回响应