修改属性

基本信息

Path： /v1/products/:instanceId/:productKey/features/properties/:name

Method： PUT

接口描述：

请求参数

路径参数

参数名称	示例	备注
instanceId
productKey
name

Body

名称	类型	是否必须	默认值	备注	其他信息
dataSchema	object	非必须
├─ @type	string	非必须
├─ format	string	非必须
├─ min	number	非必须
├─ max	number	非必须
├─ step	number	非必须
├─ pattern	string	非必须
├─ minLength	number	非必须
├─ maxLength	number	非必须
├─ enumType	string	非必须
├─ enumValues	object []	非必须
├─ name	string	必须
├─ enumValue	string	必须
├─ displayName	string	非必须
├─ elementType	object	非必须
├─ @type	string	非必须
├─ format	string	非必须
├─ min	number	非必须
├─ max	number	非必须
├─ step	number	非必须
├─ pattern	string	非必须
├─ minLength	number	非必须
├─ maxLength	number	非必须
├─ minItems	number	非必须
├─ maxItems	number	非必须
├─ fields	object	非必须
├─ field1	object	非必须
├─ @type	string	非必须
├─ format	string	非必须
├─ min	number	非必须
├─ max	number	非必须
├─ step	number	非必须
├─ pattern	string	非必须
├─ minLength	number	非必须
├─ maxLength	number	非必须
├─ required	string []	非必须
├─		非必须
displayName	string	非必须
description	string	非必须
writable	boolean	非必须
unitType	string	非必须
unit	string	非必须

返回数据

名称	类型	是否必须	默认值	备注	其他信息
name	string	非必须
dataSchema	object	非必须
├─ @type	string	非必须
├─ format	string	非必须
├─ min	number	非必须
├─ max	number	非必须
├─ step	number	非必须
├─ pattern	string	非必须
├─ minLength	number	非必须
├─ maxLength	number	非必须
├─ enumType	string	非必须
├─ enumValues	object []	非必须
├─ name	string	非必须
├─ enumValue	string	非必须
├─ displayName	string	非必须
├─ elementType	object	非必须
├─ @type	string	非必须
├─ format	string	非必须
├─ min	number	非必须
├─ max	number	非必须
├─ step	number	非必须
├─ pattern	string	非必须
├─ minLength	number	非必须
├─ maxLength	number	非必须
├─ minItems	number	非必须
├─ maxItems	number	非必须
├─ fields	object	非必须
├─ field1	object	非必须
├─ @type	string	非必须
├─ format	string	非必须
├─ min	number	非必须
├─ max	number	非必须
├─ step	number	非必须
├─ pattern	string	非必须
├─ minLength	number	非必须
├─ maxLength	number	非必须
├─ required	string []	非必须
├─		非必须
displayName	string	非必须
description	string	非必须
writable	boolean	非必须
unitType	string	非必须
unit	string	非必须
createTime	string	非必须
updateTime	string	非必须

删除属性

基本信息

Path： /v1/products/:instanceId/:productKey/features/properties/:name

Method： DELETE

接口描述：

请求参数

路径参数

参数名称	示例	备注
instanceId
productKey
name

返回数据

名称	类型	是否必须	默认值	备注	其他信息

添加属性

基本信息

Path： /v1/products/:instanceId/:productKey/features/properties

Method： POST

接口描述：

请求参数

路径参数

参数名称	示例	备注
instanceId
productKey

Body

名称	类型	是否必须	默认值	备注	其他信息
name	string	必须		^[a-zA-Z](?:[a-zA-Z0-9_]{0,48}[a-zA-Z0-9])?$
dataSchema	object	必须		DataSchema类型，见备注
├─ @type	string	必须		[boolean, date, dateTime, timestamp, time, double, float, integer, long, string, array, enum, object ]
├─ format	string	非必须		[date, dateTime, time]
├─ min	number	非必须		[double, float, integer, long]
├─ max	number	非必须		[double, float, integer, long]
├─ step	number	非必须		[double, float, integer, long]
├─ pattern	string	非必须		[string]，最大100个字符
├─ minLength	integer	非必须		[string]，(0, MAX_INT32]
├─ maxLength	integer	非必须		[string], (minLength, MAX_INT32]
├─ enumType	string	非必须		[enum]，optional: [integer, string]
├─ enumValues	object []	非必须		[enum]，最大20个enumValue
├─ name	string	必须		^[a-zA-Z](?:[a-zA-Z0-9_]{0,62}[a-zA-Z0-9])?$
├─ enumValue	string	必须		^[\w\W]{1,32}$
├─ displayName	string	非必须		可以不填该参数，填写该参数时需符合^[\w\W]{1,64}$
├─ elementType	object	非必须		[array]，DataSchema类型，见备注，不支持array、enum、object
├─ @type	string	必须		boolean、date、dateTime、timestamp、time、double、float、integer、long、string
├─ format	string	非必须
├─ min	number	非必须
├─ max	number	非必须
├─ step	number	非必须
├─ pattern	string	非必须		最大200个字符
├─ minLength	number	非必须
├─ maxLength	number	非必须
├─ minItems	number	非必须		[array], (0, MAX_INT32]
├─ maxItems	number	非必须		[array], (minItems, MAX_INT32]
├─ fields	object	非必须		[object]，可以有最大30个field，field名由用户指定，需符合^[a-zA-Z](?:[a-zA-Z0-9_]{0,62}[a-zA-Z0-9])?$
├─ field1	object	非必须		DataSchema类型，见备注，不支持array、enum、object
├─ @type	string	必须		boolean、date、dateTime、timestamp、time、double、float、integer、long、string
├─ format	string	非必须
├─ min	number	非必须
├─ max	number	非必须
├─ step	number	非必须
├─ pattern	string	非必须		最大200个字符
├─ minLength	number	非必须
├─ maxLength	number	非必须
├─ required	string []	非必须		[object]
├─		非必须
displayName	string	必须		"^[\\s\\S]{2,50}$"
description	string	非必须		"^[\\s\\S]{0,200}$"
writable	boolean	非必须
unitType	string	非必须		使用unit参数时，unitType为必需参数
unit	string	非必须

返回数据

名称	类型	是否必须	默认值	备注	其他信息
name	string	非必须
dataSchema	object	非必须
├─ @type	string	非必须
├─ format	string	非必须
├─ min	number	非必须
├─ max	number	非必须
├─ step	number	非必须
├─ pattern	string	非必须
├─ minLength	number	非必须
├─ maxLength	number	非必须
├─ enumType	string	非必须
├─ enumValues	object []	非必须
├─ name	string	非必须
├─ enumValue	string	非必须
├─ displayName	string	非必须
├─ elementType	object	非必须
├─ @type	string	非必须
├─ format	string	非必须
├─ min	number	非必须
├─ max	number	非必须
├─ step	number	非必须
├─ pattern	string	非必须
├─ minLength	number	非必须
├─ maxLength	number	非必须
├─ minItems	number	非必须
├─ maxItems	number	非必须
├─ fields	object	非必须
├─ field1	object	非必须
├─ @type	string	非必须
├─ format	string	非必须
├─ min	number	非必须
├─ max	number	非必须
├─ step	number	非必须
├─ pattern	string	非必须
├─ minLength	number	非必须
├─ maxLength	number	非必须
├─ required	string []	非必须
├─		非必须
displayName	string	非必须
description	string	非必须
writable	boolean	非必须
unitType	string	非必须
unit	string	非必须
createTime	string	非必须
updateTime	string	非必须

获取属性

基本信息

Path： /v1/products/:instanceId/:productKey/features/properties/:name

Method： GET

接口描述：

请求参数

路径参数

参数名称	示例	备注
instanceId
productKey
name

返回数据

名称	类型	是否必须	默认值	备注	其他信息
name	string	非必须			mock: @word
dataSchema	object	非必须
├─ @type	string	非必须			枚举: enum,string,float,enum,array,object,timestamp,dateTime
├─ format	string	非必须			枚举: HH:mm:ss.SSS,yyyy-MM-dd,yyyy-MM-dd'T'HH:mm:ss.SSS
├─ min	number	非必须
├─ max	number	非必须
├─ step	number	非必须
├─ pattern	string	非必须
├─ minLength	number	非必须
├─ maxLength	number	非必须
├─ enumType	string	非必须			枚举: string,integer
├─ enumValues	object []	非必须			item 类型: object
├─ name	string	必须			mock: @word
├─ enumValue	string	必须			mock: @word
├─ displayName	string	非必须			mock: @word
├─ elementType	object	非必须
├─ @type	string	非必须			枚举: string,float,timestamp,dateTime
├─ format	string	非必须
├─ min	number	非必须
├─ max	number	非必须
├─ step	number	非必须
├─ pattern	string	非必须
├─ minLength	number	非必须
├─ maxLength	number	非必须
├─ minItems	number	非必须
├─ maxItems	number	非必须
├─ fields	object	非必须
├─ field1	object	非必须
├─ @type	string	非必须			枚举: enum,string,float,timestamp,dateTime
├─ format	string	非必须
├─ min	number	非必须
├─ max	number	非必须
├─ step	number	非必须
├─ pattern	string	非必须
├─ minLength	number	非必须
├─ maxLength	number	非必须
├─ field2	object	必须
├─ @type	string	必须
├─ required	string []	非必须			item 类型: string
├─		非必须
displayName	string	非必须			mock: @word
description	string	非必须			mock: @natural
writable	boolean	非必须
unitType	string	非必须
unit	string	非必须
createTime	string	非必须
updateTime	string	非必须

获取属性列表

基本信息

Path： /v1/products/:instanceId/:productKey/features/properties

Method： GET

接口描述：

请求参数

路径参数

参数名称	示例	备注
instanceId
productKey

Query

参数名称	是否必须	示例	备注
pageNo	是
pageSize	是

返回数据

名称	类型	是否必须	默认值	备注	其他信息
totalCount	number	非必须
result	object []	非必须			item 类型: object
├─ name	string	非必须			mock: @word
├─ dataSchema	object	非必须
├─ @type	string	非必须			枚举: enum,string,float,array,object,timestamp,dateTime
├─ format	string	非必须
├─ min	number	非必须
├─ max	number	非必须
├─ step	number	非必须
├─ pattern	string	非必须
├─ minLength	number	非必须
├─ maxLength	number	非必须
├─ enumType	string	非必须
├─ enumValues	object []	非必须			item 类型: object
├─ name	string	非必须
├─ enumValue	string	非必须
├─ displayName	string	非必须
├─ elementType	object	非必须
├─ @type	string	非必须
├─ format	string	非必须
├─ min	number	非必须
├─ max	number	非必须
├─ step	number	非必须
├─ pattern	string	非必须
├─ minLength	number	非必须
├─ maxLength	number	非必须
├─ minItems	number	非必须
├─ maxItems	number	非必须
├─ fields	object	非必须
├─ field1	object	非必须
├─ @type	string	非必须
├─ format	string	非必须
├─ min	number	非必须
├─ max	number	非必须
├─ step	number	非必须
├─ pattern	string	非必须
├─ minLength	number	非必须
├─ maxLength	number	非必须
├─ required	string []	非必须			item 类型: string
├─		非必须
├─ displayName	string	非必须
├─ description	string	非必须
├─ writable	boolean	非必须
├─ unitType	string	非必须
├─ unit	string	非必须
├─ createTime	string	非必须
├─ updateTime	string	非必须
pageNo	number	非必须
pageSize	number	非必须