更新空间规格信息

功能介绍

应用服务器可调用此接口更新单个空间规格信息。

注意：

不允许更新规格的ID。
该接口为全量更新。
规格正在被使用时，不允许更新。
系统规格$default-sub-zone不允许更新。

URI

PUT /v1/iotfm/zone-definitions/{definition_code}

表1 路径参数
参数	是否必选	参数类型	描述
definition_code	是	String	空间规格编码，实例级唯一

请求参数

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

表3 请求Body参数
参数	是否必选	参数类型	描述
name	否	String	参数说明：规格定义名称，实例级唯一。取值范围：长度1-32，只允许中文、大小写字母、数字以及_-字符的组合。
description	否	String	参数说明：规格定义描述。取值范围：长度0-256，只允许中文、大小写字母、数字以及_-字符的组合。
definition_properties	否	Object	参数说明：规格属性字段列表。取值范围：长度0-200，最大长度范围系统可配置，当前最大值默认是50。

表4 PropertyDefinition
参数	是否必选	参数类型	描述
property_name	是	String	参数说明：属性名称。注：设备服务内不允许重复。属性名称作为设备影子JSON文档中的key不支持特殊字符：点(.)、dollar符号($)、空char(十六进制的ASCII码为00)，如果包含了以上特殊字符则无法正常刷新影子文档。取值范围：长度不超过64，只允许中文、字母、数字、以及_?'#().,&%@!-字符的组合。
property_code	是	String	参数说明：属性名称。注：设备服务内不允许重复。属性名称作为设备影子JSON文档中的key不支持特殊字符：点(.)、dollar符号($)、空char(十六进制的ASCII码为00)，如果包含了以上特殊字符则无法正常刷新影子文档。取值范围：长度不超过64，只允许中文、字母、数字、以及_?'#().,&%@!-字符的组合。
data_type	是	String	参数说明：属性的数据类型。取值范围：int，long，decimal，string，DateTime，jsonObject，enum，boolean，string list。
required	否	Boolean	参数说明：属性是否必选。默认为false。
enum_list	否	Array of strings	参数说明：属性的枚举值列表。
min	否	String	参数说明：属性的最小值，用来支持int、long、decimal类型。取值范围：长度不超过16，int类型值范围为：-2147483648~2147483647。
max	否	String	参数说明：属性的最大值，用来支持int、long、decimal类型。取值范围：长度不超过16，int类型值范围为：-2147483648~2147483647
max_length	否	Integer	参数说明：属性的最大长度。
min_length	否	Integer	参数说明：属性的最小长度。
unit	否	String	参数说明：属性的单位。取值范围：长度不超过16。
description	否	String	参数说明：属性的描述。取值范围：长度不超过128，只允许中文、字母、数字、空白字符、以及_?'#().,;&%@!- ，、：；。/字符的组合。
default_value	否	Object	参数说明：属性的默认值。如果设置了默认值，使用该产品创建设备时，会将该属性的默认值写入到该设备的设备影子预期数据中，待设备上线时将该属性默认值下发给设备。
display_in_list	否	Boolean	参数说明：属性是否呈现在列表页。如果值为True，该属性将被展现在列表页中，否则，将不再列表页展示。不设置，则默认为false。

响应参数

状态码：200

表5 响应Body参数
参数	参数类型	描述
id	String	参数说明：规格唯一ID。取值范围：长度1-32。
code	String	参数说明：规格定义编码，实例级唯一。取值范围：长度1-32，只允许大小写字母、数字以及-字符的组合。
name	String	参数说明：规格定义名称，实例级唯一。取值范围：长度1-32，只允许中文、大小写字母、数字以及_-字符的组合。
description	String	参数说明：规格定义描述。取值范围：长度0-256，只允许中文、大小写字母、数字以及_-字符的组合。
properties	Array of PropertyDefinition objects	参数说明：规格属性字段列表，其中display_in_list属性保留，未使用。取值范围：长度0-200，最大长度范围系统可配置，当前最大值默认是50。
create_time	String	参数说明：创建时间，格式为：yyyy-MM-dd'T'HH:mm:ss.SSS'Z'。取值范围：大小为0-24。

表6 PropertyDefinition
参数	参数类型	描述
property_name	String	参数说明：属性名称。注：设备服务内不允许重复。属性名称作为设备影子JSON文档中的key不支持特殊字符：点(.)、dollar符号($)、空char(十六进制的ASCII码为00)，如果包含了以上特殊字符则无法正常刷新影子文档。取值范围：长度不超过64，只允许中文、字母、数字、以及_?'#().,&%@!-字符的组合。
property_code	String	参数说明：属性名称。注：设备服务内不允许重复。属性名称作为设备影子JSON文档中的key不支持特殊字符：点(.)、dollar符号($)、空char(十六进制的ASCII码为00)，如果包含了以上特殊字符则无法正常刷新影子文档。取值范围：长度不超过64，只允许中文、字母、数字、以及_?'#().,&%@!-字符的组合。
data_type	String	参数说明：属性的数据类型。取值范围：int，long，decimal，string，DateTime，jsonObject，enum，boolean，string list。
required	Boolean	参数说明：属性是否必选。默认为false。
enum_list	Array of strings	参数说明：属性的枚举值列表。
min	String	参数说明：属性的最小值，用来支持int、long、decimal类型。取值范围：长度不超过16，int类型值范围为：-2147483648~2147483647。
max	String	参数说明：属性的最大值，用来支持int、long、decimal类型。取值范围：长度不超过16，int类型值范围为：-2147483648~2147483647
max_length	Integer	参数说明：属性的最大长度。
min_length	Integer	参数说明：属性的最小长度。
unit	String	参数说明：属性的单位。取值范围：长度不超过16。
description	String	参数说明：属性的描述。取值范围：长度不超过128，只允许中文、字母、数字、空白字符、以及_?'#().,;&%@!- ，、：；。/字符的组合。
default_value	Object	参数说明：属性的默认值。如果设置了默认值，使用该产品创建设备时，会将该属性的默认值写入到该设备的设备影子预期数据中，待设备上线时将该属性默认值下发给设备。
display_in_list	Boolean	参数说明：属性是否呈现在列表页。如果值为True，该属性将被展现在列表页中，否则，将不再列表页展示。不设置，则默认为false。

状态码：400

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

请求示例

更新空间规格名称

PUT https://{endpoint}/v1/iotfm/zone-definitions/store

{
  "name" : "深圳基地高端旗舰店类型"
}

更新空间规格属性

PUT https://{endpoint}/v1/iotfm/zone-definitions/store

{
  "definition_properties" : [ {
    "property_name" : "门店类型",
    "property_code" : "store_type",
    "data_type" : "enum",
    "enum_list" : [ "荣耀Life店", "荣耀高级体验店", "荣耀体验店", "HFS:旗舰店", "HES-H:高级体验店", "HES:授权体验店", "HES-R:授权专卖店", "旗舰服务中心FSC", "综合服务中心MSC", "授权服务中心ASC" ]
  }, {
    "property_name" : "门店状态",
    "property_code" : "store_status",
    "data_type" : "enum",
    "enum_list" : [ "筹建中", "建设中", "运营中", "暂停营业" ]
  } ]
}

响应示例

状态码：200

{
  "id" : "a0ed5ea25c3cc3d328f61af50fc9452a",
  "code" : "store",
  "name" : "门店解决方案",
  "description" : "门店解决方案",
  "properties" : [ {
    "property_name" : "门店类型",
    "property_code" : "store_type",
    "data_type" : "enum",
    "enum_list" : [ "荣耀Life店", "荣耀高级体验店", "荣耀体验店", "HFS:旗舰店", "HES-H:高级体验店", "HES:授权体验店", "HES-R:授权专卖店", "旗舰服务中心FSC", "综合服务中心MSC", "授权服务中心ASC" ]
  }, {
    "property_name" : "门店状态",
    "property_code" : "store_status",
    "data_type" : "enum",
    "enum_list" : [ "筹建中", "建设中", "运营中", "暂停营业" ]
  } ],
  "create_time" : "2022-12-26T01:52:49.999Z"
}