修改实体详情

文档信息

字段 内容
关联产品 [[DTS]]
服务名称 Microservice-DigitalTwin-Center
接口类型 对外开放接口
协议类型 HTTP
当前版本 v1.0.0
维护人 产品组
适用对象 后端开发 / 第三方集成商

服务接口简介

修改指定实体的详情信息。

接口信息

项 内容
方法 POST
路径 /bv-microservice-digitaltwin-center/device/updateDevice
协议 HTTP
是否鉴权 是
幂等性 否
超时时间建议 5s

请求参数

请求体：

字段 类型 是否必填 说明 示例
equipmentInfo true 否 equipmentInfo -
addTime false 否 添加时间 -
constituteItemParentId false 否 组合项父级id（当设备类型为组合设备时存在） -
detailLinkUrl false 否 详情链接地址 -
deviceDescription false 否 设备描述 -
deviceGuid false 否 设备Guid（全局唯一） -
deviceId false 否 设备id（产品下唯一） -
deviceRemarkName false 否 设备名称 -
deviceSecret false 否 设备签名（和设备id组合使用） -
deviceStatus false 否 设备状态 0 禁用 1 启用 0
deviceType false 否 设备类型 0 设备 1 POI 2 组合设备 0
gatewayId false 否 网关id -
gatewayIdentifier false 否 网关标识符 -
gatewayName false 否 网关名称 -
gatewayType false 否 网关类型 0 Dumb网关（默认） 1 视频网关 2 第三方接入网关 0
location false 否 位置 -
productId false 否 产品id -
productName false 否 产品名称 -
properties false 否 属性 [{"addTime": "", "addUser": "", "dataTypeParentId": "", "productId": "", "productName": "", "propertyDescription": "", "propertyId": "", "propertyIdentifier": "", "propertyName": "", "propertyReadWrite": 0, "propertyRequired": 0, "propertyValue": ""}]
addTime false 否 - -
addUser false 否 - -
dataTypeParentId false 否 数据类型父级编号 -
productId false 否 产品编号 -
productName false 否 产品名称 -
propertyDescription false 否 描述 -
propertyId false 否 属性编号 -
propertyIdentifier false 否 属性标识符 -
propertyName false 否 属性名称 -
propertyReadWrite false 否 属性读写类型 0 读写 1 只读 -
propertyRequired false 否 是否为标准功能的必选 0 可选 1 必选 2 自定义 -
propertyValue false 否 属性值 -
updateTime false 否 更新时间 -

请求体示例：

{
  "addTime": "",
  "constituteItemParentId": "",
  "detailLinkUrl": "",
  "deviceDescription": "",
  "deviceGuid": "",
  "deviceId": "",
  "deviceRemarkName": "",
  "deviceSecret": "",
  "deviceStatus": 0,
  "deviceType": 0,
  "gatewayId": "",
  "gatewayIdentifier": "",
  "gatewayName": "",
  "gatewayType": 0,
  "location": "",
  "productId": "",
  "productName": "",
  "properties": [
    {
      "addTime": "",
      "addUser": "",
      "dataTypeParentId": "",
      "productId": "",
      "productName": "",
      "propertyDescription": "",
      "propertyId": "",
      "propertyIdentifier": "",
      "propertyName": "",
      "propertyReadWrite": 0,
      "propertyRequired": 0,
      "propertyValue": ""
    }
  ],
  "updateTime": ""
}

响应参数

字段 类型 说明 示例
code integer(int32) - 0
info object - {}
message string - -

响应示例：

{
    "code": 0,
    "info": {},
    "message": ""
}

调用示例

curl 示例：

curl -X POST "http://<Host>/bv-microservice-digitaltwin-center/device/updateDevice" \
  -H "bv-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"addTime": "", "constituteItemParentId": "", "detailLinkUrl": "", "deviceDescription": "", "deviceGuid": "", "deviceId": "", "deviceRemarkName": "", "deviceSecret": "", "deviceStatus": 0, "deviceType": 0, "gatewayId": "", "gatewayIdentifier": "", "gatewayName": "", "gatewayType": 0, "location": "", "productId": "", "productName": "", "properties": [{"addTime": "", "addUser": "", "dataTypeParentId": "", "productId": "", "productName": "", "propertyDescription": "", "propertyId": "", "propertyIdentifier": "", "propertyName": "", "propertyReadWrite": 0, "propertyRequired": 0, "propertyValue": ""}], "updateTime": ""}'

接口错误码

错误码 HTTP 状态 场景 处理建议
200 200 OK (ResponseData) 成功
201 201 Created 创建成功
401 401 Unauthorized 请登录通用用户系统获取 API Key，并在 Header 中携带 bv-api-key
403 403 Forbidden 请检查该 API Key 是否被授权访问该接口
404 404 Not Found 检查接口 URL 是否正确

备注

  • 前置条件：API Key 已在“通用用户系统”中创建并关联了相应的 DTS 权限。
  • 副作用：无。
作者：北京-产品-yantings  创建时间：2025-11-26 10:26
最后编辑：北京-产品-yantings  更新时间：2026-07-07 18:15
上一篇：
下一篇：