更新方案库信息

POST

/api/v2/scenario-manager/library/update

关键词：
方案库

使用场景：
方案库在项目初始化时完成创建，如果对于创建后的方案库有修改的需求（一般情况下不需要修改），则可以调用此接口实现。需要注意的是，如果方案库本身是只读的，即Readonly字段为1，则不能执行更新操作。

输入：
输入需要更新的方案库的所有字段信息，包括库的ID、库的名称、库的类型、业务类型、库所对应的方案组ID、是否只读、是否直接绑定模板方案、是否支持绑定多个启用的模板方案等。
其中库的ID作为方案库的唯一性标识，不可修改，系统将通过库的ID来寻找对应的方案库，并进行更新。
库所对应的方案组ID，即Scenariogroup，必须确保该方案组存在。

请求参数

Authorization

在 Header 添加参数

Authorization

，其值为在 Bearer 之后拼接 Token

示例：

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

Path 参数

version

string

必需

Body 参数application/json

string <uuid>

可选

方案库的ID，唯一性标识

scenariogroup

string <uuid>

可选

方案库所关联的方案组ID，需确保对应的方案组存在

name

string | null

方案库的名称

可选

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

方案库的描述信息

可选

示例

{
    "id": "56a81760-a573-4191-aabd-440faeb85496",
    "scenariogroup": "5b39c2f3-b01c-409e-8a16-8292b57f28a6",
    "name": "调度库",
    "type": 4,
    "businessType": 2,
    "readonly": 0,
    "bindTemplate": 1,
    "bindType": 0,
    "bindBusinessType": 0,
    "enableMultiTemplate": 1,
    "description": "内涝调度方案库"
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'http://10.174.150.25:32001/api/v2/scenario-manager/library/update' \
--header 'Content-Type: application/json' \
--data-raw '{
    "id": "56a81760-a573-4191-aabd-440faeb85496",
    "scenariogroup": "5b39c2f3-b01c-409e-8a16-8292b57f28a6",
    "name": "调度库",
    "type": 4,
    "businessType": 2,
    "readonly": 0,
    "bindTemplate": 1,
    "bindType": 0,
    "bindBusinessType": 0,
    "enableMultiTemplate": 1,
    "description": "内涝调度方案库"
}'

返回响应

🟢200成功

text/plain

Success

Body

boolean

可选

示例

成功示例异常示例异常示例

{
    "data": true,
    "status": true,
    "code": "000000",
    "message": null,
    "traceId": null
}

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

获取方案库中方案的过期时间配置

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