Skip to content

新增设备 (POST)

更新时间:

该接口支持根据信息新增设备。

请求接口

POST /api/device/instance

TIP

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

请求参数

名称位置类型必选说明
X-Access-Tokenheaderstringtrue平台 token
bodybodyobjecttrue-
» idbodystringfalse设备唯一标识
» namebodystringtrue设备名称
» photoUrlbodystringfalse设备图标URL(默认值:/images/card/product.png)
» productIdbodystringtrue产品 ID
» describebodystringfalse说明

响应参数

以200 Response为例,响应参数如下:

名称类型必选约束说明
» messagestringtruenone返回信息
» resultobjecttruenone返回结果
»» idstringtruenone产品唯一标识
»» namestringtruenone产品名称
»» photoUrlstringtruenone产品图标
»» deviceTypeobjecttruenone设备类型
»»» textstringtruenone内容
»»» valuestringtruenone
»» describestringfalsenone说明
»» productIdstringtruenone说明
»» productNamestringtruenone说明
»» configurationobjecttruenone说明
»»» creatorIdstringtruenone创建者ID
»»» deviceNamestringtruenone创建者ID
»» stateobjecttruenone超级设备类型
»»» textstringtruenone内容
»»» valuestringtruenone
»» edgebooleantruenone超级设备类型
»» superDeviceTypeobjecttruenone超级设备类型
»»» textstringtruenone内容
»»» valuestringtruenone
»» creatorIdstringtruenone创建人
»» creatorNamestringtruenone创建人名称
»» createTimeintegertruenone创建时间
»» features[array]truenone设备特性
»» virtualTypeobjecttruenone虚拟设备类型:真实设备、虚拟设备
»»» textstringtruenone内容
»»» valuestringtruenone
»» regulatorbooleantruenone是否为控制器
»» childrenNumberintegertruenone子设备数量
»» serviceNumberintegertruenone服务数量
»» comeFromobjecttruenone设备来源:云生成、端生成
»»» textstringtruenone内容
»»» valuestringtruenone
»» deviceCreateTypeobjecttruenone设备新增类型
»»» textstringtruenone内容
»»» valuestringtruenone
»» modifierIdstringtruenone修改者ID
»» modifyTimeintegertruenone修改时间
»» modifyNamestringtruenone修改者姓名
»» presetTypeobjecttruenone类型
»»» textstringtruenone内容
»»» valuestringtruenone
»» classifiedIdstringtruenone产品分类ID
»» categoryTypeobjecttruenone分类类型
»»» textstringtruenone内容
»»» valuestringtruenone
»» mediaDevicebooleantruenone媒体设备
»» standAloneobjecttruenone是否从超级模型独立
»»» textstringtruenone内容
»»» valuestringtruenone
» statusintegertruenone响应状态码
» timestampintegertruenone时间戳

Body 示例

json
{
  "id":"create",
  "photoUrl":"/images/card/product.png",
  "name":"create",
  "productId":"sss"
}
{
  "id":"create",
  "photoUrl":"/images/card/product.png",
  "name":"create",
  "productId":"sss"
}

返回示例

以200 Response为例:

json
{
  "message": "success",
  "result": {
    "id": "1719229665952698368",
    "name": "nam001e",
    "deviceType": {
      "text": "直连设备",
      "value": "device"
    },
    "productId": "1718884053684473856",
    "productName": "010",
    "configuration": {
      "creatorId": "1199596756811550720",
      "deviceName": "nam001e"
    },
    "state": {
      "text": "Offline",
      "value": "offline"
    },
    "edge": false,
    "superDeviceType": {
      "text": "普通设备",
      "value": "normalDevice"
    },
    "creatorId": "1199596756811550720",
    "creatorName": "\t室内安防",
    "createTime": 1698731268755,
    "features": [],
    "virtualType": {
      "text": "真实设备",
      "value": "real"
    },
    "regulator": false,
    "childrenNumber": 0,
    "serviceNumber": 0,
    "comeFrom": {
      "text": "云生成",
      "value": "cloud"
    },
    "deviceCreateType": {
      "text": "根据产品(超级设备模型)生成",
      "value": "fromProduct"
    },
    "modifyTime": 1698731268755,
    "modifierId": "1199596756811550720",
    "modifierName": "\t室内安防",
    "presetType": {
      "text": "非内置",
      "value": "none"
    },
    "classifiedId": "-1-1001-1001001-",
    "categoryType": {
      "text": "默认类型",
      "value": "none"
    },
    "mediaDevice": false,
    "standAlone": {
      "text": "没有独立",
      "value": "none"
    }
  },
  "status": 200,
  "timestamp": 1698731268787
}
{
  "message": "success",
  "result": {
    "id": "1719229665952698368",
    "name": "nam001e",
    "deviceType": {
      "text": "直连设备",
      "value": "device"
    },
    "productId": "1718884053684473856",
    "productName": "010",
    "configuration": {
      "creatorId": "1199596756811550720",
      "deviceName": "nam001e"
    },
    "state": {
      "text": "Offline",
      "value": "offline"
    },
    "edge": false,
    "superDeviceType": {
      "text": "普通设备",
      "value": "normalDevice"
    },
    "creatorId": "1199596756811550720",
    "creatorName": "\t室内安防",
    "createTime": 1698731268755,
    "features": [],
    "virtualType": {
      "text": "真实设备",
      "value": "real"
    },
    "regulator": false,
    "childrenNumber": 0,
    "serviceNumber": 0,
    "comeFrom": {
      "text": "云生成",
      "value": "cloud"
    },
    "deviceCreateType": {
      "text": "根据产品(超级设备模型)生成",
      "value": "fromProduct"
    },
    "modifyTime": 1698731268755,
    "modifierId": "1199596756811550720",
    "modifierName": "\t室内安防",
    "presetType": {
      "text": "非内置",
      "value": "none"
    },
    "classifiedId": "-1-1001-1001001-",
    "categoryType": {
      "text": "默认类型",
      "value": "none"
    },
    "mediaDevice": false,
    "standAlone": {
      "text": "没有独立",
      "value": "none"
    }
  },
  "status": 200,
  "timestamp": 1698731268787
}