API 文档

更新物模型 (PUT)

更新时间:

请求接口 ​

PUT /api/device/instance/{id}/metadata

TIP

访问权限：需要登录超级设备管理平台获取token，并校验token。

请求参数 ​

名称位置类型必选说明
X-Access-Tokenheaderstringtrue平台 token
idpathstringtrue设备ID
bodybodyobjecttrue-
» functionsbody[object]false功能
» propertiesbodyintegerfalse属性
»» idbodystringfalse标识
»» namebodystringfalse名称
»» descriptionbodystringfalse说明
»» valueTypebodyobjectfalsejson对象
»»» expandsbodyobjectfalse-
»»» typebodystringfalse数据类型
»»» elementsbodystringfalse-
»» expandsbodyobjectfalse-
»»» sourcebodystringfalse属性来源
»»» metricsbody[object]false-
»»» typebody[object]false属性类型，可选值："read"（读）、"write"（写）、"report"（上报）

响应参数 ​

以200 Response为例，响应参数如下：

名称类型说明
»messagestring返回信息
»statusinteger(int32)响应状态码
»timestampinteger(int64)时间戳（毫秒）

响应状态码 ​

状态码状态码含义说明
200OK成功
401Unauthorized登录状态已过期，token不能为空
500Internal Server Error服务器内部异常

Body示例 ​

json
{
  "functions":[],
  "properties":[
    {
      "id":"real_state_net",
      "valueType": {
        "expands":{},
        "type":"string"
      },
      "name":"网络",
      "description":"网络",
      "expands":{
        "source":"device",
        "metrics":[],
        "type":["read","report"]
      }
    },
    {
      "id":"real_state_system_version",
      "valueType":{
      "expands":{},
        "type":"string"
      },
      "name":"系统版本",
      "description":"系统版本",
      "expands":{
        "source":"device",
        "metrics":[],
        "type":["read","report"]
      }
    },
    {
      "valueType": {
        "type":"string",
        "expands":{},
        "elements":[{}]
      },
      "expands":{
        "type":["read","write","report"],
        "metrics":[]
      },
      "id":"1111",
      "name":"11",
      "sortsIndex":0
    }
  ],
  "events":[],
  "tags":[]
}
{
  "functions":[],
  "properties":[
    {
      "id":"real_state_net",
      "valueType": {
        "expands":{},
        "type":"string"
      },
      "name":"网络",
      "description":"网络",
      "expands":{
        "source":"device",
        "metrics":[],
        "type":["read","report"]
      }
    },
    {
      "id":"real_state_system_version",
      "valueType":{
      "expands":{},
        "type":"string"
      },
      "name":"系统版本",
      "description":"系统版本",
      "expands":{
        "source":"device",
        "metrics":[],
        "type":["read","report"]
      }
    },
    {
      "valueType": {
        "type":"string",
        "expands":{},
        "elements":[{}]
      },
      "expands":{
        "type":["read","write","report"],
        "metrics":[]
      },
      "id":"1111",
      "name":"11",
      "sortsIndex":0
    }
  ],
  "events":[],
  "tags":[]
}

返回示例 ​

以200 Response为例：

json
{
  "message":"success",
  "status":200,
  "timestamp":1690877241779
}
{
  "message":"success",
  "status":200,
  "timestamp":1690877241779
}