文档

EditProhibitedDevices - 编辑禁用设备

更新时间:

编辑禁用设备

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求语法

POST /api/v1/carbon/hvac/editProhibitedDevices HTTP/1.1

请求参数

名称类型必填描述示例值
bodyobject

请求体参数。

factoryIdstring

场站 id

***
systemIdstring

站点 id

system1
hvacDeviceConfigVOListarray<object>

设备配置列表

object

设备配置对象

deviceNamestring

设备名称

name1
deviceIdstring

设备 id

id1
deviceTypestring

设备类型。

枚举值:
  • 空调机组6
  • 锅炉7
  • 冷机1
  • 冷却塔2
  • 水泵3
  • 室内环境4
1
isForbiddeninteger

是否禁用:1,0

1
isUnfavorableAreainteger

是否不利区:1,0

1
buildingIdstring

楼栋 id

build_01
floorIdstring

楼层 id

floor_01
fenceIdstring

围栏 id

fence_01

deviceType、isForbidden 是必传参数,不需要传 isUnfavorableArea。deviceType 取值有 1(冷机)、2(冷却塔)、3(水泵)、4(室内环境)、6(空调机组)、7(锅炉)。deviceType 取数为 1,2,3,6,7 时,deviceId 是必传字段,不需要传入 buildingId、floorId 和 fenceId。deviceType 取数为 4 时,不传 deviceId,需要传入 buildingId、floorId 和 fenceId。

返回参数

名称类型描述示例值
object

Schema of Response

requestIdstring

Id of the request

9bc20a5a-b26b-4c28-922a-7cd10b61f96f
databoolean

返回数据

枚举值:
  • 成功true
  • 失败false
true

示例

正常返回示例

JSON格式

{
  "requestId": "9bc20a5a-b26b-4c28-922a-7cd10b61f96f",
  "data": true
}

错误码

访问错误中心查看更多错误码。