基于分布式文件系统，创建一个新的方案

关键词：
方案

使用场景：
系统功能中，很多地方都会用到创建方案的接口，比如创建预报方案、创建调度方案、创建情景方案等，此接口支持对基于分布式文件系统进行存储的普通方案的创建。

输入：
输入包括父方案ID、方案组ID、方案名称、子类型、开始时间、结束时间、描述、属性等。
其中父方案ID，即ParentScenarioId，通常为模板方案的ID，如果是派生自普通方案，则为普通方案的ID；
方案组ID，即GroupId，可以通过方案库的Scenariogroup字段获取；
属性，即Attributes，用于自定义方案信息。
子类型，即SubType可自定义。

请求参数

Authorization

在 Header 添加参数

Authorization

，其值为在 Bearer 之后拼接 Token

示例：

Authorization: Bearer ********************

Path 参数

version

string

必需

Body 参数application/json

parentScenarioId

string | null

可选

父方案的ID，父方案可以是某个模板方案，也可以是某个普通方案

groupId

string | null

可选

方案所属的方案组ID

newScenarioName

string | null

方案名称

可选

startTime

string <date-time>

模型开始时刻

可选

endTime

string <date-time>

模型结束时刻

可选

subType

string | null

可选

方案的子类型，枚举，目前已存在的定义包括ManualSchedule、EconomicSchedule、OptimizeSchedule、UnprocessedWater、DataAssimilation、EmerResponse、Forecast、EmerMnt、Scenario、Incident、ParaOptimi、SourceAnalysis、WQEvaluation、SpatialTime、Planning、OilSpill、Year、Month、TenDays、PumpShutdown、PipeBurst、Unknown，也可以自定义

description

string | null

方案描述

可选

attributes

string | null

可选

通常为json格式的，用户自定义的方案属性，用于扩展

示例

{
    "parentScenarioId": "f379f17f-50ac-4697-b42e-37d14121c08c",
    "groupId": "abfcfe31-2546-487a-9551-51c7183ff475",
    "newScenarioName": "测试大雨方案",
    "startTime": "2025-02-01T00:00:00",
    "endTime": "2025-02-02T00:00:00",
    "subType": "Schedule",
    "description": "用于测试大雨场景下的预演方案",
    "attributes": ""
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢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": "40ecc254-9511-4896-aa7e-8573470af10c",
        "scenarioCode": "CSDYFA589019",
        "scenarioName": "测试大雨方案",
        "modelType": "MIKEPlusFloodModel",
        "modelSubType": "Schedule",
        "template": 0,
        "inheritedScenario": "f379f17f-50ac-4697-b42e-37d14121c08c",
        "readOnly": 0,
        "enabled": 1,
        "relativeFolder": "CSDYFA589019",
        "projectFile": "BYJC_YS.mupp",
        "currentTime": "2025-02-01T00:00:00",
        "startTime": "2025-02-01T00:00:00",
        "endTime": "2025-02-02T00:00:00",
        "createTime": "2025-03-14T09:23:37.8525",
        "autoCalculate": 0,
        "modified": 0,
        "checked": 0,
        "calculated": 0,
        "published": 0,
        "onlineFirst": 1,
        "autoAmend": 1,
        "state": null,
        "description": "用于测试大雨场景下的预演方案",
        "version": "04234f71-e1c8-4d6f-9ef8-57209294d80f",
        "tenantId": "3a1654c5-4f41-00be-3508-362dee00b666",
        "minIOPath": "modelconfiguration/modeltemplatefiles/CSDYFA589019.zip",
        "minIOBucket": "MIKEPlusFloodModel",
        "creatorName": "",
        "attributes": "",
        "name": "CSDYFA589019"
    },
    "status": true,
    "code": "000000",
    "message": null,
    "traceId": null
}