在鸿云文档

Appearance

QueryCommand ​

根据命令Id查询命令详情数据

使用说明 ​

暂无

请求参数 ​

QueryCommandRequest ​

名称类型是否必选描述
commandIdString是命令id

返回数据 ​

QueryProductCommandResponse ​

名称类型描述
codeString调用成功，返回0，调用失败，查看错误信息。
msgString调用成功，提示"操作成功"，调用失败，查看错误信息。
dataObject返回结果。结果内容详情，查看下方示例。

data ​

名称类型描述
commandIdString命令id
blockIdString模块id
customString是否自定义功能，0：不是，1：是
nameString功能名称
pidString功能标识
callTypeString命令调用类型，async：异步，sync：同步
requiredString是否必须，0：可选，1：必须
methodString方法名，command.${tsl.command.pid}.exec按此规则生成
commandDescString命令描述信息
paramBeansList属性参数数据

paramBeans ​

名称类型描述
paramIdString主键编号
nameString功能名称
pidString功能标识
inputOutputString参数类型，是输入参数还是输出参数，命令特有的字段，input：输入参数，output：输出参数
parentIdString结构体参数有嵌套，但是要注意不允许嵌套中再有嵌套
typeString字段数据类型，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）
specsMinString参数最小值（int、float、double类型特有）
specsMaxString参数最大值（int、float、double类型特有）
specsUnitString属性单位（int、float、double类型特有，非必填）
specsUnitNameString单位名称（int、float、double类型特有，非必填）
specsSizeint数组元素的个数，最大512（array类型特有）
specsStepString步长（text、enum类型无此参数）
specsLengthint数据长度，最大10240（text类型特有）
specsBoolFalseString0的值（bool类型特有）
specsBoolTrueString1的值（bool类型特有）
specsItemTypeString数组元素的类型（array类型特有）
specsEnumStringenum类型数据体，结构示例， key:value;key2:value2

示例 ​

请求示例 ​

json
{
	"commandId": "f1e7482a983f44d38597cd9eda0ac26f"
}

返回示例 ​

json
{
  "code": "0",
  "msg": "操作成功",
  "data": {
    "commandId": "f1e7482a983f44d38597cd9eda0ac26f",
    "blockId": "c6cf73e4f38e4554be491c40384d7dde",
    "custom": "1",
    "pid": "setWaterStatus",
    "name": "设置开关状态",
    "callType": "sync",
    "required": "0",
    "method": "command.setWaterStatus.exec",
    "commandDesc": null,
    "paramBeans": [
      {
        "paramId": "b3951b37ee0b4e1eab0caf3b3af66851",
        "functionId": "f1e7482a983f44d38597cd9eda0ac26f",
        "pid": "key",
        "name": "开关状态",
        "inputOutput": "input",
        "parentId": null,
        "type": "bool",
        "specsMin": null,
        "specsMax": null,
        "specsUnit": null,
        "specsUnitName": null,
        "specsSize": 0,
        "specsStep": null,
        "specsLength": 0,
        "specsBoolFalse": "关",
        "specsBoolTrue": "开",
        "specsItemType": null,
        "specsEnum": null
      }
    ]
  }
}