添加实体到孪生体

文档信息

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

服务接口简介

指定实体添加到孪生体下

接口信息

项 内容
方法 POST
路径 /bv-microservice-intelligent-spaces/api/intelligentSpaces/addEntityToTwin
协议 HTTP
是否鉴权 是
幂等性 否
超时时间建议 5s

请求参数

请求体：

字段 类型 是否必填 说明 示例
dto true 否 dto -
entityList true 否 实体列表 [{"deviceId": "", "deviceRemarkName": "", "deviceSecret": "", "productName": ""}]
deviceId false 否 设备id（产品下唯一） -
deviceRemarkName false 否 设备名称 -
deviceSecret false 否 设备签名（和设备id组合使用） -
productName false 否 产品名称 -
productId true 否 产品编号 -
twinId true 否 孪生体编号 -

请求体示例：

{
  "entityList": [
    {
      "deviceId": "",
      "deviceRemarkName": "",
      "deviceSecret": "",
      "productName": ""
    }
  ],
  "productId": "",
  "twinId": ""
}

响应参数

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

响应示例：

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

调用示例

curl 示例：

curl -X POST "http://<Host>/bv-microservice-intelligent-spaces/api/intelligentSpaces/addEntityToTwin" \
  -H "bv-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"entityList": [{"deviceId": "", "deviceRemarkName": "", "deviceSecret": "", "productName": ""}], "productId": "", "twinId": ""}'

接口错误码

错误码 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 17:58
最后编辑：北京-产品-yantings  更新时间：2026-07-07 18:15
上一篇：
下一篇：