修改边界

功能介绍

修改边界

URI

PUT /v1/iotfm/energy-eff/boundaries/{boundary_id}

表1 路径参数
参数	是否必选	参数类型	描述
boundary_id	是	String	边界ID

请求参数

表2 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	参数说明：用户Token。通过调用生成Token 接口获取，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。
X-Instance-Id	是	String	参数说明：实例ID。通过访问智能设施云平台界面后获取，智能设施云平台资源均为实例级隔离，所有业务接口必须填写正确的实例ID才能被成功调用。取值范围：长度8-36，只允许大小写字母、数字和-字符的组合。
X-Root-Zone-Id	否	String	参数说明：项目ID。取值范围：长度不超过24，只允许字母、数字的组合。

表3 请求Body参数
参数	是否必选	参数类型	描述
boundary_name	是	String	边界名称。长度不超过64，只允许中文、字母、数字、以及_-等字符的组合。
boundary_description	否	String	边界描述。长度不超过256，只允许中文、字母、数字、以及_-等字符的组合。
boundary_type	是	String	边界类型。空间-ZONE; 系统-SYSTEM
zone_id	否	String	区域ID
system_type	否	String	系统类型。冷站-COLD_SITE; 空压站-COMPRESSOR_SITE
system_id	否	String	系统ID。长度不超过36，只允许字母、数字、以及_-等字符的组合。
is_statistic_configs	否	IsStatisticConfigs object	是否统计配置。

表4 IsStatisticConfigs
参数	是否必选	参数类型	描述
is_statistic_electricity_quantity	否	Boolean	参数说明：是否统计用电量。取值范围：true\|false。
is_statistic_water_quantity	否	Boolean	参数说明：是否统计用水量。取值范围：true\|false。
is_statistic_electricity_fee	否	Boolean	参数说明：是否统计电费。取值范围：true\|false。
is_statistic_cooling_capacity	否	Boolean	参数说明：是否统计供冷量。取值范围：true\|false。
is_statistic_heat_capacity	否	Boolean	参数说明：是否统计供热量。取值范围：true\|false。
is_statistic_air_flow_quantity	否	Boolean	参数说明：是否统计用气量。取值范围：true\|false。

响应参数

状态码：200

表5 响应Header参数
参数	参数类型	描述
X-Request-Id	String	This field is the request ID number for task tracking. Format is request_uuid-timestamp-hostname.

表6 响应Body参数
参数	参数类型	描述
boundary_id	String	边界ID。长度不超过36，只允许字母、数字、以及_-等字符的组合。
boundary_name	String	边界名称。长度不超过64，只允许中文、字母、数字、以及_-等字符的组合。
boundary_description	String	边界描述。长度不超过256，只允许中文、字母、数字、以及_-等字符的组合。
boundary_type	String	边界类型。空间-ZONE; 系统-SYSTEM
zone_id	String	区域ID
zone_name	String	参数说明：空间名称。取值范围：长度1-256。
system_type	String	系统类型。冷站-SITE; 空压站-COMPRESSOR
system_id	String	系统ID。长度不超过36，只允许字母、数字、以及_-等字符的组合。
system_name	String	系统名称。长度不超过64，只允许中文、字母、数字、以及_-等字符的组合。
parent_boundary_id	String	父级边界ID。长度不超过36，只允许字母、数字、以及_-等字符的组合。
child_boundary_count	Integer	参数说明：直接下级边界数量。取值范围：大小为0-100。
create_time	String	创建时间，格式为："yyyy-MM-dd'T'HH:mm:ss.SSS'Z'"。
update_time	String	更新时间，格式为："yyyy-MM-dd'T'HH:mm:ss.SSS'Z'"。
boundary_path	Array of BoundaryPathItem objects	边界路径。
meters	Array of MeterInfo objects	关联的表计。
is_statistic_configs	IsStatisticConfigs object	是否统计配置。

表7 BoundaryPathItem
参数	参数类型	描述
boundary_id	String	边界ID。长度不超过36，只允许字母、数字、以及_-等字符的组合。
boundary_name	String	边界名称。长度不超过64，只允许中文、字母、数字、以及_-等字符的组合。
boundary_depth	Integer	边界深度。

表8 MeterInfo
参数	参数类型	描述
meter_id	String	表计ID。长度不超过36，只允许字母、数字、以及_-等字符的组合。
meter_name	String	表计名称。长度不超过64，只允许中文、字母、数字、以及_-等字符的组合。
share_percentage	Integer	分摊比例。

表9 IsStatisticConfigs
参数	参数类型	描述
is_statistic_electricity_quantity	Boolean	参数说明：是否统计用电量。取值范围：true\|false。
is_statistic_water_quantity	Boolean	参数说明：是否统计用水量。取值范围：true\|false。
is_statistic_electricity_fee	Boolean	参数说明：是否统计电费。取值范围：true\|false。
is_statistic_cooling_capacity	Boolean	参数说明：是否统计供冷量。取值范围：true\|false。
is_statistic_heat_capacity	Boolean	参数说明：是否统计供热量。取值范围：true\|false。
is_statistic_air_flow_quantity	Boolean	参数说明：是否统计用气量。取值范围：true\|false。

状态码：400

**表10** 响应Header参数
参数	参数类型	描述
X-Request-Id	String	This field is the request ID number for task tracking. Format is request_uuid-timestamp-hostname.

**表11** 响应Body参数
参数	参数类型	描述
error_code	String	参数说明：错误码。取值范围：长度8-36。
error_msg	String	参数说明：错误描述。取值范围：长度2-512。

请求示例

修改边界

PUT https://{endpoint}/v1/iotfm/energy-eff/boundaries/{boundary_id}

{
  "boundary_name" : "龙山基地-A1厂房",
  "boundary_description" : "龙山基地-A1厂房",
  "boundary_type" : "SYSTEM",
  "system_type" : "COLD_SITE",
  "system_id" : "1904a11e552733524b30cc1a"
}