GET v2/CtrlMachine/GetDeviceSchema?num={num}&Id={Id}&Timeout={Timeout}

获取中控机下的某个设备描述

请求信息

URI参数

字段名称描述类型约束
num

中控机机身号

 string

必须
id

中控机的设备id

 string

必填
timeout

超时的秒数 如果在Timeout秒之后才收到数据则不处理

 integer

范围 [1, 30]

Body参数

无

响应信息

返回类型

ApiResultOfDeviceSchema
字段名称描述类型约束
code

错误码

 ErrorCode

必填
msg

相关提示信息

 string

必填
data

业务数据

 DeviceSchema

必填

响应格式

application/json, text/json

例子: 
{
  "code": 0,
  "msg": "sample string 1",
  "data": {
    "events": [
      {
        "name": "sample string 1",
        "display": {
          "sample string 1": "sample string 2",
          "sample string 3": "sample string 4"
        }
      },
      {
        "name": "sample string 1",
        "display": {
          "sample string 1": "sample string 2",
          "sample string 3": "sample string 4"
        }
      }
    ],
    "properties": [
      {
        "name": "sample string 1",
        "type": 1,
        "unit": "sample string 2",
        "display": {
          "sample string 1": "sample string 2",
          "sample string 3": "sample string 4"
        },
        "value": {},
        "nullable": true,
        "access": 0,
        "xCtrlType": 1,
        "xNumberRange": {
          "min": 1.1,
          "max": 1.1,
          "step": 1.1,
          "precision": 1
        },
        "xStringRange": {
          "min": 1,
          "max": 1
        },
        "xEnumRange": [
          {
            "value": 1,
            "display": {
              "sample string 1": "sample string 2",
              "sample string 3": "sample string 4"
            }
          },
          {
            "value": 1,
            "display": {
              "sample string 1": "sample string 2",
              "sample string 3": "sample string 4"
            }
          }
        ]
      },
      {
        "name": "sample string 1",
        "type": 1,
        "unit": "sample string 2",
        "display": {
          "sample string 1": "sample string 2",
          "sample string 3": "sample string 4"
        },
        "value": {},
        "nullable": true,
        "access": 0,
        "xCtrlType": 1,
        "xNumberRange": {
          "min": 1.1,
          "max": 1.1,
          "step": 1.1,
          "precision": 1
        },
        "xStringRange": {
          "min": 1,
          "max": 1
        },
        "xEnumRange": [
          {
            "value": 1,
            "display": {
              "sample string 1": "sample string 2",
              "sample string 3": "sample string 4"
            }
          },
          {
            "value": 1,
            "display": {
              "sample string 1": "sample string 2",
              "sample string 3": "sample string 4"
            }
          }
        ]
      }
    ],
    "id": "sample string 1",
    "name": "sample string 2",
    "roomId": "sample string 3",
    "classify": 0,
    "devType": 4
  }
}

接口调试

Authorization

AppId

Token

URI

GET

请求header

响应body