Appearance
getParamByFunctionId
调用该接口根据id获得相应参数的数据。
使用说明
暂无
接口地址
/gateway/openapi
请求方式
POST
请求参数
请求头
名称 | 类型 | 描述 |
---|---|---|
tokenauthorization | String | 平台颁发的token |
apiCode | String | 固定值:getParamByFunctionId |
请求参数
FunctionIdRequest
名称 | 类型 | 是否必选 | 描述 |
---|---|---|---|
functionId | String | 是 | 功能Id,可以是propertyId属性、eventId事件、commandId命令等的id |
返回数据
名称 | 类型 | 描述 |
---|---|---|
code | String | 调用成功,返回0,调用失败,查看错误信息。 |
msg | String | 调用成功,提示"操作成功",调用失败,查看错误信息。 |
data | Object | 返回结果列表。 |
ParamVO
名称 | 类型 | 描述 |
---|---|---|
paramId | String | 参数id |
pid | String | 参数标识符 |
name | String | 参数标识名称 |
inputOutput | String | 参数类型,是输入参数还是输出参数,命令特有的字段,input:输入参数,output:输出参数 |
type | String | 字段数据类型,int(原生)、float(原生)、double(原生)、text(原生)、date(String类型UTC毫秒)、bool(0或1的int类型)、enum(int类型,枚举项定义方法与bool类型定义0和1的值方法相同)、struct(结构体类型,可包含前面7种类型,下面使用'specs':[{}]描述包含的对象)、array(数组类型,支持int、double、float、text、struct) |
specsMin | String | 参数最小值(int、float、double类型特有) |
specsMax | String | 参数最大值(int、float、double类型特有) |
specsLength | int | 数据长度,最大10240(text类型特有) |
specsBoolFalse | String | 0的值(bool类型特有) |
specsBoolTrue | String | 1的值(bool类型特有) |
specsEnum | String | enum类型数据体,结构示例, key:value;key2:value2 |
示例
请求示例
json
{
"functionId": "a3969760053c46a8ae7db3db50132652"
}
返回示例
json
{
"code": "0",
"msg": "操作成功",
"data": [
{
"paramId": "b669ea5b63934ff9aa32f700ae9f0123",
"pid": "aa33",
"name": "中午",
"inputOutput": null,
"type": "text",
"specsMin": null,
"specsMax": null,
"specsLength": "10",
"specsBoolFalse": null,
"specsBoolTrue": null,
"specsEnum": null
}
]
}