有奖捉虫:办公协同&微信生态&物联网文档专题 HOT

Action

动作信息

被如下接口引用:DescribeLinkRuleList。

名称 类型 描述
Id Integer 动作id
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
Name String 动作名
注意:此字段可能返回 null,表示取不到有效值。
示例值:a

ActionDetail

详细动作信息

被如下接口引用:DescribeActionList。

名称 类型 描述
Id Integer 动作id
注意:此字段可能返回 null,表示取不到有效值。
示例值:22
Name String 动作名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:a
ActionType String 动作类型
注意:此字段可能返回 null,表示取不到有效值。
示例值:deviceControl
ActionDesc String 动作说明
注意:此字段可能返回 null,表示取不到有效值。
示例值:测试控制开灯
MsgType String 消息类型,orgin/custom/model
注意:此字段可能返回 null,表示取不到有效值。
示例值:model
MsgContent String 消息内容,有效值为x-json:后的字段
注意:此字段可能返回 null,表示取不到有效值。
示例值:x-json:[{"model":"红灯(red)","value":"10","obj":{"name":"红灯","type":"int","modelName":"智能灯控模块","modelId":"2000126","define":{"type":"int","min":0,"max":255},"options":[]},"type":"int"},{"model":"绿灯(green)","value":"10","type":"int","obj":{"name":"绿灯","type":"int","modelName":"智能灯控模块","modelId":"2000126","define":{"type":"int","min":0,"max":255},"options":[]}}]
CreateTime String 创建时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:2023-05-15 16:29:17
WID String 设备唯一标识
注意:此字段可能返回 null,表示取不到有效值。
示例值:xxx
LinkRuleSet Array of LinkRule 关联故障列表
注意:此字段可能返回 null,表示取不到有效值。
示例值:{"Id":1,"Name":"a"}
SinkConfig String 动作下沉配置,有效值为x-json:后的字段
注意:此字段可能返回 null,表示取不到有效值。
示例值:x-json:{"nearbySearch":{"deviceType":"w0905001","pid":2000126,"limit":0,"objectLevel":0,"scopeLevel":"","scopeRadius":"","deviceAssign":"deviceType"}}

ActionObj

动作对象

被如下接口引用:DescribeRuleDetail。

名称 类型 描述
Id Integer 动作id
注意:此字段可能返回 null,表示取不到有效值。
示例值:71
Name String 动作名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:a
Type String 动作类型。(app/推送消息至应用-携带空间设备:无,appWithNearbyDevices/推送至应用-携带空间设备:携带,device/推送消息至设备-指定设备,nearbyDevices/推送消息至设备-事件所在范围内的设备,toAlarm/转换为告警,toNotification/转换为通知)
注意:此字段可能返回 null,表示取不到有效值。
示例值:nearbyDevices
Desc String 动作说明
注意:此字段可能返回 null,表示取不到有效值。
示例值:test
MsgType String 消息类型,orgin/custom/model
注意:此字段可能返回 null,表示取不到有效值。
示例值:nearbyDevices
MsgContent String 消息内容
注意:此字段可能返回 null,表示取不到有效值。
示例值:x-json:xxx
CreateTime String 创建时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:2023-05-23 14:38:13
SinkConfig String 动作下沉配置
注意:此字段可能返回 null,表示取不到有效值。
示例值:x-json:{"nearbySearch":{"deviceType":"w0201001","pid":0,"limit":2,"objectLevel":9,"scopeLevel":"6","scopeRadius":"100","deviceAssign":"deviceType"}}
ApplyDevice String 具体应用(appid)/具体设备(DIN/subID)
注意:此字段可能返回 null,表示取不到有效值。
示例值:10051

AddDeviceInfo

添加设备信息

被如下接口引用:BatchCreateDevice。

名称 类型 必选 描述
ProductId Integer 产品id
示例值:200022
SN String 设备sn序列号
示例值:test
ParentWID String 父设备wid,不为空表示导入子设备
示例值:xxx-aaa
KeySource Integer 密钥来源:0-使用产品密钥 1-使用设备特有的密钥
示例值:0

AdministrationData

行政区划数据结构

被如下接口引用:DescribeAdministrationByTag。

名称 类型 描述
AdministrationCode String 行政区划编码
注意:此字段可能返回 null,表示取不到有效值。
示例值:110000
AdministrationName String 行政区划名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:北京市

AdministrativeDetail

行政区划详情

被如下接口引用:DescribeCityWorkspaceList。

名称 类型 描述
AdministrativeTypeCode String 行政区域类型编码
注意:此字段可能返回 null,表示取不到有效值。
示例值:QH03
AdministrativeCode String 行政区域编码
注意:此字段可能返回 null,表示取不到有效值。
示例值:440305
AdministrativeName String 行政区域名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:南山区

AlarmInfo

告警信息

被如下接口引用:DescribeAlarmList。

名称 类型 描述
WorkspaceId Integer 工作空间id
注意:此字段可能返回 null,表示取不到有效值。
示例值:1016
Id String 告警ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:0c6ec1cc-25d6-43bc-96b1-6b4131f1771a
Status String 告警状态
注意:此字段可能返回 null,表示取不到有效值。
示例值:unprocessed
Time Integer 告警时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:1693416976
Type String 告警业务类型
注意:此字段可能返回 null,表示取不到有效值。
示例值:energy
TypeName String 告警业务类型名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:能源
SubType String 子告警类型
注意:此字段可能返回 null,表示取不到有效值。
示例值:water_limit
SubTypeName String 子告警类型名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:c
Level Integer 告警级别id
注意:此字段可能返回 null,表示取不到有效值。
示例值:3
LevelName String 告警级别名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:严重
AppId Integer 上报应用appid
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
WID String 设备wid
注意:此字段可能返回 null,表示取不到有效值。
示例值:b1fd7aa3-4407-4b82-9dc3-aff9b3034a9f
DeviceName String 设备名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:20楼水表
Position String 空间位置
注意:此字段可能返回 null,表示取不到有效值。
示例值:滨海大厦-7F
ReportImg ReportImg 上报图片
注意:此字段可能返回 null,表示取不到有效值。
示例值:{"Data": "","Type": 0}
Desc String 告警描述
注意:此字段可能返回 null,表示取不到有效值。
示例值:水量使用超限
HandlePersonSet Array of HandlerPersonInfo 处理人
注意:此字段可能返回 null,表示取不到有效值。
示例值:{"Id":12,"Name":"test"}
HandleRecordSet Array of HandleRecordInfo 处理记录
注意:此字段可能返回 null,表示取不到有效值。
示例值:{"AppId": 0,"Description": "消警-规则消警","ExtendOne": "x-json:","FileSet": [],"Id": 308504,"Name": "","OperationType": "消警","Time": "1693416991","Type": "rule_alarm_elimination"}
Extend String 扩展信息
注意:此字段可能返回 null,表示取不到有效值。
示例值:x-json:{"alarmLevel":3,"alarmValue":13730945.6}
ExtendOne String 应用扩展字段1
注意:此字段可能返回 null,表示取不到有效值。
示例值:x-json:xxxx
ExtendTwo String 应用扩展字段2
注意:此字段可能返回 null,表示取不到有效值。
示例值:x-json:xxxx
Echo String 应用透传字段,有效字段为x-json后的字段
注意:此字段可能返回 null,表示取不到有效值。
示例值:x-json:abc

AlarmLevelInfo

告警级别详情

被如下接口引用:DescribeAlarmLevelList。

名称 类型 描述
LevelId Integer 级别id
注意:此字段可能返回 null,表示取不到有效值。
示例值:3
LevelName String 级别名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:严重

AlarmStatusData

告警状态返回结构体

被如下接口引用:DescribeAlarmStatusList。

名称 类型 描述
StatusID String 告警状态ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:unprocessed
StatusName String 告警状态名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:待处理
StatusType String 告警状态类型
注意:此字段可能返回 null,表示取不到有效值。
示例值:0

AlarmTypeDetailInfo

告警类型详情信息

被如下接口引用:DescribeAlarmTypeList。

名称 类型 描述
Id Integer 告警类型id
注意:此字段可能返回 null,表示取不到有效值。
示例值:26
ParentId Integer 父节点id
注意:此字段可能返回 null,表示取不到有效值。
示例值:25
Type Integer 0-标准告警类型,1-自定义告警类型
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
Name String 告警名称类型
注意:此字段可能返回 null,表示取不到有效值。
示例值:人流数量异常
EnglishName String 告警类型英文名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:excessive

AlarmTypeInfo

告警类型

被如下接口引用:BatchKillAlarm, DescribeAlarmList。

名称 类型 必选 描述
Type String 告警父类型
示例值:xxx-a
SubType String 告警子类型(如果传告警子类型,则必传父类型)
示例值:xxx-b

ApiContent

API参数信息

被如下接口引用:DescribeInterfaceList。

名称 类型 描述
Id String 所属API的id
注意:此字段可能返回 null,表示取不到有效值。
示例值:741f3abd-639c-49ad-b9ed-b52a0f08a62e
Name String 参数名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:获取视频流
Type String 参数类型
注意:此字段可能返回 null,表示取不到有效值。
示例值:string
Dynamic Boolean 是否为动态值
注意:此字段可能返回 null,表示取不到有效值。
示例值:true
Required Boolean 是否必填
注意:此字段可能返回 null,表示取不到有效值。
示例值:true
Value String 参数值
注意:此字段可能返回 null,表示取不到有效值。
示例值:741f3abd-639c-49ad-b9ed-b52a0f08a62e
DefaultValue String 默认值
注意:此字段可能返回 null,表示取不到有效值。
示例值:741f3abd-639c-49ad-b9ed-b52a0f08a62e

ApiInfo

API描述

被如下接口引用:DescribeInterfaceList。

名称 类型 描述
ApiId String API的id
注意:此字段可能返回 null,表示取不到有效值。
示例值:741f3abd-639c-49ad-b9ed-b52a0f08a62e
Name String API名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:获取视频流
AppId String API所属应用的id
注意:此字段可能返回 null,表示取不到有效值。
示例值:10001
WorkspaceId String API所属的项目空间的id
注意:此字段可能返回 null,表示取不到有效值。
示例值:1101
PoiCode String API所属目录的编码
注意:此字段可能返回 null,表示取不到有效值。
示例值:api000
Type Integer 接口分类0. 其他服务 1. IOT服务 2. 空间服务 3.微应用服务 4.场景服务 5.AI算法服务 6.任务算法服务 7.第三方服务
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
DataAudit Integer 数据授权 0:否 1:是
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
ApplyAudit Integer 是否需要申请 0:否 1:是
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
Description String API详情
注意:此字段可能返回 null,表示取不到有效值。
示例值:获取视频流
Address String API地址
注意:此字段可能返回 null,表示取不到有效值。
示例值:/video/ControlCameraPtz
Method String 请求方法类型
注意:此字段可能返回 null,表示取不到有效值。
示例值:GET
Status Integer API状态
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
PreviewUrl String API预览地址
注意:此字段可能返回 null,表示取不到有效值。
示例值:http://t-apigw.twins.tencent.com/proxy/138c04de-4f1e-4bff-9498-4f16f2ed4cd5/video/ControlCameraPtz
QueryParams Array of ApiContent query参数
注意:此字段可能返回 null,表示取不到有效值。
示例值:[ { "DefaultValue": "", "Dynamic": false, "Id": "02066fae-0f05-4256-8554-506479c6cca4", "Name": "app-engine-preview", "Required": false, "Type": "string", "Value": "1" }, { "DefaultValue": "", "Dynamic": false, "Id": "02066fae-0f05-4256-8554-506479c6cca4", "Name": "x-sa-account", "Required": false, "Type": "string", "Value": "admin" }, { "DefaultValue": "", "Dynamic": false, "Id": "02066fae-0f05-4256-8554-506479c6cca4", "Name": "x-sa-device-project-id", "Required": false, "Type": "string", "Value": "1" }, { "DefaultValue": "", "Dynamic": false, "Id": "02066fae-0f05-4256-8554-506479c6cca4", "Name": "x-sa-project-id", "Required": false, "Type": "string", "Value": "211" } ]
PathParams Array of ApiContent 路径参数
注意:此字段可能返回 null,表示取不到有效值。
示例值:[ { "DefaultValue": "", "Dynamic": false, "Id": "02066fae-0f05-4256-8554-506479c6cca4", "Name": "app-engine-preview", "Required": false, "Type": "string", "Value": "1" }, { "DefaultValue": "", "Dynamic": false, "Id": "02066fae-0f05-4256-8554-506479c6cca4", "Name": "x-sa-account", "Required": false, "Type": "string", "Value": "admin" }, { "DefaultValue": "", "Dynamic": false, "Id": "02066fae-0f05-4256-8554-506479c6cca4", "Name": "x-sa-device-project-id", "Required": false, "Type": "string", "Value": "1" }, { "DefaultValue": "", "Dynamic": false, "Id": "02066fae-0f05-4256-8554-506479c6cca4", "Name": "x-sa-project-id", "Required": false, "Type": "string", "Value": "211" } ]
RequestHeaders Array of ApiContent 请求头
注意:此字段可能返回 null,表示取不到有效值。
示例值:[ { "DefaultValue": "", "Dynamic": false, "Id": "02066fae-0f05-4256-8554-506479c6cca4", "Name": "app-engine-preview", "Required": false, "Type": "string", "Value": "1" }, { "DefaultValue": "", "Dynamic": false, "Id": "02066fae-0f05-4256-8554-506479c6cca4", "Name": "x-sa-account", "Required": false, "Type": "string", "Value": "admin" }, { "DefaultValue": "", "Dynamic": false, "Id": "02066fae-0f05-4256-8554-506479c6cca4", "Name": "x-sa-device-project-id", "Required": false, "Type": "string", "Value": "1" }, { "DefaultValue": "", "Dynamic": false, "Id": "02066fae-0f05-4256-8554-506479c6cca4", "Name": "x-sa-project-id", "Required": false, "Type": "string", "Value": "211" } ]
ResponseHeaders Array of ApiContent 响应头
注意:此字段可能返回 null,表示取不到有效值。
示例值:[ { "DefaultValue": "", "Dynamic": false, "Id": "02066fae-0f05-4256-8554-506479c6cca4", "Name": "app-engine-preview", "Required": false, "Type": "string", "Value": "1" }, { "DefaultValue": "", "Dynamic": false, "Id": "02066fae-0f05-4256-8554-506479c6cca4", "Name": "x-sa-account", "Required": false, "Type": "string", "Value": "admin" }, { "DefaultValue": "", "Dynamic": false, "Id": "02066fae-0f05-4256-8554-506479c6cca4", "Name": "x-sa-device-project-id", "Required": false, "Type": "string", "Value": "1" }, { "DefaultValue": "", "Dynamic": false, "Id": "02066fae-0f05-4256-8554-506479c6cca4", "Name": "x-sa-project-id", "Required": false, "Type": "string", "Value": "211" } ]
IsCommonSpace Boolean 是否为公共空间接口
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
Body String 请求体(base64编码)
注意:此字段可能返回 null,表示取不到有效值。
示例值:W3tcInV1aWRcIjpcIjZmZDcxNjRjOWY5ZTQ0ZjM5M2I1N2UyZTA2OWJiYjY1XCIsXCJrZXlcIjpcInJvb3RcIixcInR5cGVcIjpcInN0cnVjdFwiLFwiaXNFeHBhbmRcIjp0cnVlLFwiZGVzY3JpcHRpb25cIjpcIlwiLFwiY2hpbGRyZW5cIjpbe1widXVpZFwiOlwiNGYyNTNjN2ZkNGRkNGMxMDhkNTIwNGVhNWU5ZjNkZTJcIixcImtleVwiOlwibmFtZVwiLFwidHlwZVwiOlwic3RyaW5nXCIsXCJkZXNjcmlwdGlvblwiOlwi5ZCN56ewXCIsXCJsZXZlbFwiOjEsXCJwb3NcIjpcIjAtMFwiLFwib3JkZXJcIjowLFwibmV3XCI6ZmFsc2UsXCJob3ZlclwiOmZhbHNlLFwibGFiZWxcIjpcIuWQjeensFwifV0sXCJvcmRlclwiOjAsXCJsZXZlbFwiOjAsXCJwb3NcIjpcIjBcIn1dCg==
ResponseBody String 响应体(base64编码)
注意:此字段可能返回 null,表示取不到有效值。
示例值:W3tcInV1aWRcIjpcIjZmZDcxNjRjOWY5ZTQ0ZjM5M2I1N2UyZTA2OWJiYjY1XCIsXCJrZXlcIjpcInJvb3RcIixcInR5cGVcIjpcInN0cnVjdFwiLFwiaXNFeHBhbmRcIjp0cnVlLFwiZGVzY3JpcHRpb25cIjpcIlwiLFwiY2hpbGRyZW5cIjpbe1widXVpZFwiOlwiNGYyNTNjN2ZkNGRkNGMxMDhkNTIwNGVhNWU5ZjNkZTJcIixcImtleVwiOlwibmFtZVwiLFwidHlwZVwiOlwic3RyaW5nXCIsXCJkZXNjcmlwdGlvblwiOlwi5ZCN56ewXCIsXCJsZXZlbFwiOjEsXCJwb3NcIjpcIjAtMFwiLFwib3JkZXJcIjowLFwibmV3XCI6ZmFsc2UsXCJob3ZlclwiOmZhbHNlLFwibGFiZWxcIjpcIuWQjeensFwifV0sXCJvcmRlclwiOjAsXCJsZXZlbFwiOjAsXCJwb3NcIjpcIjBcIn1dCg==
Style Integer 接口方式 1.http 2消息通知服务
注意:此字段可能返回 null,表示取不到有效值。
示例值:1

ApiInfoList

API列表

被如下接口引用:DescribeInterfaceList。

名称 类型 描述
ApiInfo Array of ApiInfo API列表
注意:此字段可能返回 null,表示取不到有效值。
示例值:[ { "Address": "/weiling-pubsub/datafusion/", "ApiId": "013a8423-03f6-4c00-9181-ade7f124ae8f", "AppId": "10069", "ApplyAudit": 0, "Body": "", "DataAudit": 0, "Description": "", "IsCommonSpace": true, "Method": "get", "Name": "数据融合中心websocket勿删", "PathParams": [], "PoiCode": "api000", "PreviewUrl": "ws://dev-ws.twins.tencent.com/proxy/013a8423-03f6-4c00-9181-ade7f124ae8f/weiling-pubsub/datafusion/", "QueryParams": [], "RequestHeaders": [], "ResponseBody": "", "ResponseHeaders": [], "Status": 1, "Style": 2, "Type": 1, "WorkspaceId": "1015" }, { "Address": "/trpc.wetwin.trpc_wetwin_container_svr.AppAPI/DeviceList", "ApiId": "027d9a7a-1d1d-4974-9992-9a21d2ff843d", "AppId": "20134", "ApplyAudit": 0, "Body": "", "DataAudit": 0, "Description": "", "IsCommonSpace": true, "Method": "post", "Name": "测试cachess", "PathParams": [], "PoiCode": "api000", "PreviewUrl": "http://dev-apigw.twins.tencent.com/proxy/027d9a7a-1d1d-4974-9992-9a21d2ff843d/trpc.wetwin.trpc_wetwin_container_svr.AppAPI/DeviceList", "QueryParams": [], "RequestHeaders": [], "ResponseBody": "W3sidXVpZCI6IjA3ZjlhZjg3YWRmNzQ5ZWM5YmIyZTkzMzkwNGNlNTcwIiwia2V5Ijoicm9vdCIsInR5cGUiOiJzdHJ1Y3QiLCJpc0V4cGFuZCI6dHJ1ZSwiZGVzY3JpcHRpb24iOiIiLCJjaGlsZHJlbiI6W10sIm9yZGVyIjowLCJsZXZlbCI6MCwicG9zIjoiMCJ9XQ==", "ResponseHeaders": [], "Status": 1, "Style": 1, "Type": 1, "WorkspaceId": "1015" }, { "Address": "/trpc.bim.bim_data_bus.TBimOpen", "ApiId": "0571bcd5-77ea-458a-ab37-1e9b4ca131f9", "AppId": "98", "ApplyAudit": 0, "Body": "IiI=", "DataAudit": 0, "Description": "hhh", "IsCommonSpace": true, "Method": "post", "Name": "robbytest", "PathParams": [], "PoiCode": "api000002", "PreviewUrl": "http://dev-apigw.twins.tencent.com/proxy/0571bcd5-77ea-458a-ab37-1e9b4ca131f9/trpc.bim.bim_data_bus.TBimOpen", "QueryParams": [], "RequestHeaders": [], "ResponseBody": "W3sidXVpZCI6IjQ2NzBiZWQ2OGRjMDRmNTg5YmViYjY4NWFhZDY4ZTc4Iiwia2V5Ijoicm9vdCIsInR5cGUiOiJzdHJ1Y3QiLCJpc0V4cGFuZCI6dHJ1ZSwiZGVzY3JpcHRpb24iOiIiLCJjaGlsZHJlbiI6W10sIm9yZGVyIjowLCJsZXZlbCI6MCwicG9zIjoiMCJ9XQ==", "ResponseHeaders": [], "Status": 1, "Style": 1, "Type": 1, "WorkspaceId": "1015" }, { "Address": "/posts/2", "ApiId": "0fcca883-bd05-4b0d-8252-4f2ce5e7042f", "AppId": "10052", "ApplyAudit": 0, "Body": "", "DataAudit": 0, "Description": "123213", "IsCommonSpace": true, "Method": "get", "Name": "集华的接口", "PathParams": [], "PoiCode": "api000", "PreviewUrl": "http://dev-apigw.twins.tencent.com/proxy/0fcca883-bd05-4b0d-8252-4f2ce5e7042f/posts/2", "QueryParams": [], "RequestHeaders": [], "ResponseBody": "W3sidXVpZCI6ImI1NmMzMzIwNjU3ZTQ2N2M4ZDAzZmQ4MTQ2NTgwMWYzIiwia2V5Ijoicm9vdCIsInR5cGUiOiJzdHJ1Y3QiLCJpc0V4cGFuZCI6dHJ1ZSwiZGVzY3JpcHRpb24iOiIiLCJjaGlsZHJlbiI6W10sIm9yZGVyIjowLCJsZXZlbCI6MCwicG9zIjoiMCJ9XQ==", "ResponseHeaders": [], "Status": 1, "Style": 1, "Type": 1, "WorkspaceId": "1015" }, { "Address": "", "ApiId": "13108ad8-4c73-48f2-a70c-aaded78a9d89", "AppId": "10070", "ApplyAudit": 0, "Body": "", "DataAudit": 0, "Description": "", "IsCommonSpace": false, "Method": "get", "Name": "sxy测试", "PathParams": [], "PoiCode": "api001", "PreviewUrl": "http://dev-apigw.twins.tencent.com/proxy/13108ad8-4c73-48f2-a70c-aaded78a9d89", "QueryParams": [ { "DefaultValue": "", "Dynamic": false, "Id": "13108ad8-4c73-48f2-a70c-aaded78a9d89", "Name": "123123", "Required": false, "Type": "value", "Value": "123123" }, { "DefaultValue": "", "Dynamic": false, "Id": "13108ad8-4c73-48f2-a70c-aaded78a9d89", "Name": "123123", "Required": false, "Type": "value", "Value": "123123" }, { "DefaultValue": "", "Dynamic": false, "Id": "13108ad8-4c73-48f2-a70c-aaded78a9d89", "Name": "123123", "Required": false, "Type": "value", "Value": "123123" }, { "DefaultValue": "", "Dynamic": false, "Id": "13108ad8-4c73-48f2-a70c-aaded78a9d89", "Name": "123123", "Required": false, "Type": "value", "Value": "123123" }, { "DefaultValue": "", "Dynamic": false, "Id": "13108ad8-4c73-48f2-a70c-aaded78a9d89", "Name": "123123", "Required": false, "Type": "value", "Value": "123123" }, { "DefaultValue": "", "Dynamic": false, "Id": "13108ad8-4c73-48f2-a70c-aaded78a9d89", "Name": "33333", "Required": false, "Type": "value", "Value": "333333" } ], "RequestHeaders": [], "ResponseBody": "W3sidXVpZCI6IjNiZTFiODRmYzk2MDQyYWI5NzQ2ZWE4NzcwOGYyYTk1Iiwia2V5Ijoicm9vdCIsInR5cGUiOiJzdHJ1Y3QiLCJpc0V4cGFuZCI6dHJ1ZSwiZGVzY3JpcHRpb24iOiIiLCJjaGlsZHJlbiI6W10sIm9yZGVyIjowLCJsZXZlbCI6MCwicG9zIjoiMCJ9XQ==", "ResponseHeaders": [], "Status": 1, "Style": 1, "Type": 1, "WorkspaceId": "1016" }, { "Address": "", "ApiId": "136a66f7-a730-40ae-8aad-659f69c449b7", "AppId": "20768", "ApplyAudit": 0, "Body": "", "DataAudit": 0, "Description": "", "IsCommonSpace": true, "Method": "get", "Name": "测试新增目录接口", "PathParams": [], "PoiCode": "api000003002", "PreviewUrl": "http://dev-apigw.twins.tencent.com/proxy/136a66f7-a730-40ae-8aad-659f69c449b7", "QueryParams": [], "RequestHeaders": [], "ResponseBody": "W3sidXVpZCI6ImYzYTM0MDM2YzUzZDRlNDRhNjIzYmM5YTFiNDA5MTA3Iiwia2V5Ijoicm9vdCIsInR5cGUiOiJzdHJ1Y3QiLCJpc0V4cGFuZCI6dHJ1ZSwiZGVzY3JpcHRpb24iOiIiLCJjaGlsZHJlbiI6W10sIm9yZGVyIjowLCJsZXZlbCI6MCwicG9zIjoiMCJ9XQ==", "ResponseHeaders": [], "Status": 1, "Style": 1, "Type": 1, "WorkspaceId": "1015" }, { "Address": "/spaceFusion/appApi/message/batchReport", "ApiId": "1388c124-0acc-4cbc-931a-a5bfab400a1c", "AppId": "98", "ApplyAudit": 0, "Body": "", "DataAudit": 0, "Description": "", "IsCommonSpace": true, "Method": "post", "Name": "应用消息批量上报", "PathParams": [], "PoiCode": "api000002", "PreviewUrl": "http://dev-apigw.twins.tencent.com/proxy/1388c124-0acc-4cbc-931a-a5bfab400a1c/spaceFusion/appApi/message/batchReport", "QueryParams": [], "RequestHeaders": [], "ResponseBody": "", "ResponseHeaders": [], "Status": 1, "Style": 1, "Type": 1, "WorkspaceId": "1015" }, { "Address": "/trpc.wetwin.trpc_wetwin_container_svr.AppAPI/DescribeAlarmStatusList", "ApiId": "1e1005b8-2a79-4f76-97cc-57c819b3751d", "AppId": "10051", "ApplyAudit": 0, "Body": "", "DataAudit": 0, "Description": "", "IsCommonSpace": true, "Method": "post", "Name": "告警状态列表", "PathParams": [], "PoiCode": "api000006004", "PreviewUrl": "http://dev-apigw.twins.tencent.com/proxy/1e1005b8-2a79-4f76-97cc-57c819b3751d/trpc.wetwin.trpc_wetwin_container_svr.AppAPI/DescribeAlarmStatusList", "QueryParams": [], "RequestHeaders": [], "ResponseBody": "W3sidXVpZCI6IjEyYzQ5YzYzY2IxOTQ3ZTFhY2I3MTFlMGU4ZmQ4YmRiIiwia2V5Ijoicm9vdCIsInR5cGUiOiJzdHJ1Y3QiLCJpc0V4cGFuZCI6dHJ1ZSwiZGVzY3JpcHRpb24iOiIiLCJjaGlsZHJlbiI6W10sIm9yZGVyIjowLCJsZXZlbCI6MCwicG9zIjoiMCJ9XQ==", "ResponseHeaders": [], "Status": 1, "Style": 1, "Type": 1, "WorkspaceId": "1015" }, { "Address": "", "ApiId": "2a0206b6-3094-4c56-964c-568ce2b13a7f", "AppId": "10041", "ApplyAudit": 0, "Body": "", "DataAudit": 1, "Description": "", "IsCommonSpace": true, "Method": "", "Name": "wewe", "PathParams": [], "PoiCode": "api000002", "PreviewUrl": "ws://dev-ws.twins.tencent.com/proxy/2a0206b6-3094-4c56-964c-568ce2b13a7f", "QueryParams": [], "RequestHeaders": [], "ResponseBody": "", "ResponseHeaders": [], "Status": 1, "Style": 2, "Type": 1, "WorkspaceId": "1015" }, { "Address": "", "ApiId": "32ba90be-a5c9-4e22-8370-df09bb1092e2", "AppId": "10001", "ApplyAudit": 0, "Body": "", "DataAudit": 1, "Description": "", "IsCommonSpace": true, "Method": "post", "Name": "abba", "PathParams": [], "PoiCode": "api000", "PreviewUrl": "http://dev-apigw.twins.tencent.com/proxy/32ba90be-a5c9-4e22-8370-df09bb1092e2", "QueryParams": [], "RequestHeaders": [], "ResponseBody": "W3sidXVpZCI6ImQ3ZjI1NDE4NjdhMDQyYWE4MDJlMGUzOGZiNGNmMzlmIiwia2V5Ijoicm9vdCIsInR5cGUiOiJzdHJ1Y3QiLCJpc0V4cGFuZCI6dHJ1ZSwiZGVzY3JpcHRpb24iOiIiLCJjaGlsZHJlbiI6W10sIm9yZGVyIjowLCJsZXZlbCI6MCwicG9zIjoiMCJ9XQ==", "ResponseHeaders": [], "Status": 1, "Style": 1, "Type": 1, "WorkspaceId": "1015" }
TotalCount Integer 数据总条数
注意:此字段可能返回 null,表示取不到有效值。
示例值:10

ApplicationInfo

应用描述

被如下接口引用:DescribeApplicationList。

名称 类型 描述
ApplicationId String 应用分配的appId
注意:此字段可能返回 null,表示取不到有效值。
示例值:10001
Name String 应用中文名
注意:此字段可能返回 null,表示取不到有效值。
示例值:能源管理
Address String 应用地址
注意:此字段可能返回 null,表示取不到有效值。
示例值:http://www.capi.woa.com
ApplicationLogo ApplicationLogo 应用logo
注意:此字段可能返回 null,表示取不到有效值。
Type Integer 应用类型,0:saas应用 1:平台应用
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
EnglishName String engine
注意:此字段可能返回 null,表示取不到有效值。
示例值:应用英文名
Description String 能源管理应用
注意:此字段可能返回 null,表示取不到有效值。
示例值:应用详情

ApplicationList

应用列表

被如下接口引用:DescribeApplicationList。

名称 类型 描述
ApplicationInfoList Array of ApplicationInfo 应用列表
注意:此字段可能返回 null,表示取不到有效值。
示例值:[ { "Address": "http://checkproject-a6f6718d.dtwin.tencent.com/testcodingpush", "ApplicationId": "10041", "ApplicationLogo": { "FileId": "359cc1b5-88c1-4dd6-8ff4-21d0b36ac7e2", "Url": "https://wetwin-manager-1258344699.cos.ap-guangzhou.myqcloud.com/%2F100055/0/20230717/359cc1b5-88c1-4dd6-8ff4-21d0b36ac7e2/%E8%B5%84%E4%BA%A7%E7%AE%A1%E7%90%86-%E9%BB%91.png?q-sign-algorithm=sha1&q-ak=AKIDiFWWFo67rLZXFgrlNinb8NL2SaR2M0OU&q-sign-time=1693452005%3B1693453205&q-key-time=1693452005%3B1693453205&q-header-list=host&q-url-param-list=&q-signature=6bf531d1b08d6f75eb7e153c24746a61d7be37d0" }, "Description": "12345611111", "EnglishName": "zctest1111", "Name": "智能资产管理", "Type": 0 }, { "Address": "http://t-ws.twins.tencent.com/proxy/29098b25-447d-437e-987a-d493d55e84f5/weiling-pubsub/test", "ApplicationId": "10048", "ApplicationLogo": { "FileId": "", "Url": "" }, "Description": "", "EnglishName": "MsgCenter", "Name": "消息服务", "Type": 0 }, { "Address": "http://t.twins.tencent.com/", "ApplicationId": "10051", "ApplicationLogo": { "FileId": "", "Url": "" }, "Description": "", "EnglishName": "IOT", "Name": "孪生中台(物联感知中心)", "Type": 0 } ]
TotalCount String 当前查询条件命中的数据总条数
注意:此字段可能返回 null,表示取不到有效值。
示例值:符合查询条件的数据总条数

应用logo

被如下接口引用:DescribeApplicationList。

名称 类型 描述
FileId String logo图片对应的fileId
注意:此字段可能返回 null,表示取不到有效值。
示例值:d442d82a-ded2-49f1-92e7-81a7f0f45ac6
Url String logo图片地址
注意:此字段可能返回 null,表示取不到有效值。
示例值:https://wetwin-manager-1258344699.cos.ap-guangzhou.myqcloud.com/%2F100055/0/20231030/72f6c306-5819-42dc-98a9-758b4e7892aa/%E7%A7%9F%E6%88%B7%E5%88%9D%E5%A7%8B%E5%8C%96%E8%84%9A%E6%9C%AC-1698664462444.sql?q-sign-algorithm=sha1&q-ak=AKIDiFWWFo67rLZXFgrlNinb8NL2SaR2M0OU&q-sign-time=1698664464%3B1698665664&q-key-time=1698664464%3B1698665664&q-header-list=host&q-url-param-list=&q-signature=45bb085655d6a9722df5ec4dfd1aa80b1cdb08f8

ApplicationTokenInfo

应用Token令牌信息

被如下接口引用:CreateApplicationToken, DescribeEdgeApplicationToken。

名称 类型 描述
Token String 应用申请调用API的令牌
注意:此字段可能返回 null,表示取不到有效值。
示例值:Oq9lShbmhCT3FLnemDCecrXAnAHQe6SJ

BatchCreateDeviceRes

批量新增设备接口返回结果

被如下接口引用:BatchCreateDevice。

名称 类型 描述
SuccessSet Array of CreateDeviceSucceeded 新增成功的设备列表
注意:此字段可能返回 null,表示取不到有效值。
示例值:{"ParentWID": "","ProductId": 2000054,"SN": "atest","WID": "75c83fbd-4862-4c4e-8091-18ccba3e2419"}
FailSet Array of CreateDeviceFailed 新增失败的设备列表
注意:此字段可能返回 null,表示取不到有效值。
示例值:{"ParentWID": "","ProductId": 2000054,"SN": "atest","Reason": "xxxx"}

BatchReportAppMessageRes

批量消息上报结果

被如下接口引用:BatchReportAppMessage。

名称 类型 描述
TotalElements Integer 上报数量

注意:此字段可能返回 null,表示取不到有效值。
示例值:1
Commit Integer 提交数量(推送成功)
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
SpanMap Array of ReportMsgRes 消息推送结果列表
注意:此字段可能返回 null,表示取不到有效值。
示例值:{"ReportId": "0000000000000000","ReportStatus": 1}

BuildingListRes

建筑列表响应体

被如下接口引用:DescribeBuildingList。

名称 类型 描述
BuildingProfileList Array of BuildingProfile 建筑列表
注意:此字段可能返回 null,表示取不到有效值。
示例值:[ { "Address": "北京市,丰台区样例模型", "BuildingId": "2da7d294-483e-4033-a99a-49f7323fd6ef", "BuildingName": "样例模型1", "Latitude": 39.927326, "Longitude": 116.39177, "SpaceCode": "000009" }, { "Address": "1#楼", "BuildingId": "dfad5b19-79d8-4e40-9a8c-8efa32a1f425", "BuildingName": "1#楼", "Latitude": 39.92442, "Longitude": 116.38269, "SpaceCode": "000007" } ]

BuildingModel

建筑模型信息

被如下接口引用:DescribeBuildingModel。

名称 类型 描述
ElementId String 构件ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:82d5fb5a-52d0-4636-a225-d46245e911ef
ElementName String 构件名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:验证专用
ModelType String 模型类型
注意:此字段可能返回 null,表示取不到有效值。
示例值:MODEL_ORIGIN
ModelUrl String 模型URL
注意:此字段可能返回 null,表示取不到有效值。
示例值:https://bim-1301743406.cos.ap-guangzhou.myqcloud.com/100055/1016/cb6bad63-0855-4dc2-8908-20518627479b.glb?sign=q-sign-algorithm%3Dsha1%26q-ak%3DAKIDsyyqVvLagaL8lBZq5896tTxOfjbL2h8L%26q-sign-time%3D1692758001%3B1787366001%26q-key-time%3D1692758001%3B1787366001%26q-header-list%3D%26q-url-param-list%3D%26q-signature%3Ddbac70b180e5a2d8c343506dae755a01669ffb04

BuildingModelRes

建模模型信息响应体

被如下接口引用:DescribeBuildingModel。

名称 类型 描述
Models Array of BuildingModel 建模模型信息出参
注意:此字段可能返回 null,表示取不到有效值。
示例值:[ { "ElementId": "82d5fb5a-52d0-4636-a225-d46245e911ef", "ElementName": "验证专用", "ModelType": "MODEL_ORIGIN", "ModelUrl": "https://bim-1301743406.cos.ap-guangzhou.myqcloud.com/100055/1016/cb6bad63-0855-4dc2-8908-20518627479b.glb?sign=q-sign-algorithm%3Dsha1%26q-ak%3DAKIDsyyqVvLagaL8lBZq5896tTxOfjbL2h8L%26q-sign-time%3D1692758001%3B1787366001%26q-key-time%3D1692758001%3B1787366001%26q-header-list%3D%26q-url-param-list%3D%26q-signature%3Ddbac70b180e5a2d8c343506dae755a01669ffb04" }, { "ElementId": "82d5fb5a-52d0-4636-a225-d46245e911ef", "ElementName": "验证专用-外壳", "ModelType": "MODEL_HULL", "ModelUrl": "https://bim-1301743406.cos.ap-guangzhou.myqcloud.com/100055/1016/ff847c36-89f8-4644-9c1f-d265bd5d5167.glb?sign=q-sign-algorithm%3Dsha1%26q-ak%3DAKIDsyyqVvLagaL8lBZq5896tTxOfjbL2h8L%26q-sign-time%3D1692758001%3B1787366001%26q-key-time%3D1692758001%3B1787366001%26q-header-list%3D%26q-url-param-list%3D%26q-signature%3D7af0ab15cab83314e44026fedc0927467d07b776" }, { "ElementId": "0b00f88f-36f1-4ae3-a7b4-5db12332c005", "ElementName": "-1F", "ModelType": "MODEL_STOREY", "ModelUrl": "https://bim-1301743406.cos.ap-guangzhou.myqcloud.com/100055/1016/2ee86ae4-41a1-4c45-840b-4e9eae1b83a1.glb?sign=q-sign-algorithm%3Dsha1%26q-ak%3DAKIDsyyqVvLagaL8lBZq5896tTxOfjbL2h8L%26q-sign-time%3D1692758001%3B1787366001%26q-key-time%3D1692758001%3B1787366001%26q-header-list%3D%26q-url-param-list%3D%26q-signature%3De9b58a5293201d24c19e2bc28b49404035b569c1" } ]

BuildingProfile

建筑概要信息

被如下接口引用:DescribeBuildingList, DescribeBuildingProfile。

名称 类型 描述
BuildingId String 建筑id
注意:此字段可能返回 null,表示取不到有效值。
示例值:2da7d294-483e-4033-a99a-49f7323fd6ef
BuildingName String 建筑名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:样例模型1
SpaceCode String 空间编码
注意:此字段可能返回 null,表示取不到有效值。
示例值:000009
Longitude Float 经度
注意:此字段可能返回 null,表示取不到有效值。
示例值:116.38269
Latitude Float 纬度
注意:此字段可能返回 null,表示取不到有效值。
示例值:39.92442
Address String 地址
注意:此字段可能返回 null,表示取不到有效值。
示例值:北京市,丰台区样例地址1#楼

BuildingProfileRes

查询建筑信息响应体

被如下接口引用:DescribeBuildingProfile。

名称 类型 描述
BuildingProfile BuildingProfile 建筑概要信息
注意:此字段可能返回 null,表示取不到有效值。
示例值:{ "Address": "广东省,深圳市,南山区测试建筑", "BuildingId": "2e374df6-7ba7-45d2-a44d-2a92bb2a6668", "BuildingName": "测试建筑", "Latitude": 22.533192, "Longitude": 113.93048, "SpaceCode": "000003" }

CameraExtendInfoRes

视频扩展信息结果

被如下接口引用:DescribeCameraExtendInfo。

名称 类型 描述
SaveType String 存储方式 (nvr或cosmtav)
注意:此字段可能返回 null,表示取不到有效值。
示例值:nvr
SaveDay Integer 云存储天数(save_type是cosmtav时这个参数才有效)

注意:此字段可能返回 null,表示取不到有效值。
示例值:0
LiveResolution Integer 实时分辨率
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
HistoryResolution Integer 历史分辨率
注意:此字段可能返回 null,表示取不到有效值。
示例值:0

ControlDeviceRes

设备控制结果

被如下接口引用:ControlDevice。

名称 类型 描述
WID String 设备Id
注意:此字段可能返回 null,表示取不到有效值。
示例值:无=70e673c7-11b8-4ca0-b11c-dfa360a44638
Code Integer 指令接受, 0表示成功
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
Result String 控制结果
注意:此字段可能返回 null,表示取不到有效值。
示例值:success
Seq String 批量大于1时,可用此seq进行链路追踪
注意:此字段可能返回 null,表示取不到有效值。
示例值:21909094-b304-4942-af6a-eb781ddd0a2a

ControlDeviceSet

设备控制后返回结果集合

被如下接口引用:ControlDevice。

名称 类型 描述
Set Array of ControlDeviceRes 设备控制后返回结果集合
注意:此字段可能返回 null,表示取不到有效值。
示例值:{"Code": 0,"Result": "success","Seq": "21909094-b304-4942-af6a-eb781ddd0a2a","WID": "70e673c7-11b8-4ca0-b11c-dfa360a44638"}

CreateDeviceFailed

导入失败设备信息

被如下接口引用:BatchCreateDevice。

名称 类型 描述
ProductId Integer 产品id
注意:此字段可能返回 null,表示取不到有效值。
示例值:200022
ParentWID String 父设备wid,不为空表示导入自设备
注意:此字段可能返回 null,表示取不到有效值。
示例值:xxx-aaaa
Reason String 失败原因
注意:此字段可能返回 null,表示取不到有效值。
示例值:atest
SN String 设备sn序列号
注意:此字段可能返回 null,表示取不到有效值。
示例值:atest

CreateDeviceSucceeded

导入成功设备信息

被如下接口引用:BatchCreateDevice。

名称 类型 描述
ProductId Integer 产品id
注意:此字段可能返回 null,表示取不到有效值。
示例值:200200
ParentWID String 父设备wid,不为空表示导入自设备
注意:此字段可能返回 null,表示取不到有效值。
示例值:xxx-aaa
WID String 设备编码
注意:此字段可能返回 null,表示取不到有效值。
示例值:75c83fbd-4862-4c4e-8091-18ccba3e2419
SN String 设备sn序列号
注意:此字段可能返回 null,表示取不到有效值。
示例值:atest

CustomField

自定义字段

被如下接口引用:DescribeDeviceList。

名称 类型 必选 描述
Id Integer 字段id
示例值:1
Val String 字段内容
示例值:test

CustomFieldInfo

自定义字段

被如下接口引用:DescribeDeviceList。

名称 类型 描述
Id Integer 字段id
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
Key String 字段key
注意:此字段可能返回 null,表示取不到有效值。
示例值:color
Name String 字段名
注意:此字段可能返回 null,表示取不到有效值。
示例值:颜色
Val String 字段值
注意:此字段可能返回 null,表示取不到有效值。
示例值:a

DescribeActionListRes

动作列表查询结果

被如下接口引用:DescribeActionList。

名称 类型 描述
PageNumber Integer 第几页
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
PageSize Integer 每页条数
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
TotalPage Integer 总页数
注意:此字段可能返回 null,表示取不到有效值。
示例值:2
TotalRow Integer 总条数
注意:此字段可能返回 null,表示取不到有效值。
示例值:2
ActionDetailSet Array of ActionDetail 动作列表查询集合
注意:此字段可能返回 null,表示取不到有效值。
示例值:{"ActionDesc": "lena测试控制开灯","ActionType": "deviceControl","CreateTime": "2023-05-15 16:29:17","Id": 22,"LinkRuleSet": [],"MsgContent": "x-json:[{"model":"红灯(red)","value":"10","obj":{"name":"红灯","type":"int","modelName":"智能灯控模块","modelId":"2000126","define":{"type":"int","min":0,"max":255},"options":[]},"type":"int"},{"model":"绿灯(green)","value":"10","type":"int","obj":{"name":"绿灯","type":"int","modelName":"智能灯控模块","modelId":"2000126","define":{"type":"int","min":0,"max":255},"options":[]}}]","MsgType": "model","Name": "lena测试控制开灯","SinkConfig": "x-json:{"nearbySearch":{"deviceType":"w0905001","pid":2000126,"limit":0,"objectLevel":0,"scopeLevel":"","scopeRadius":"","deviceAssign":"deviceType"}}","WID": ""}

DescribeAdministrationByTagRes

根据Tag获取行政区划列表返回结构

被如下接口引用:DescribeAdministrationByTag。

名称 类型 描述
List Array of AdministrationData 行政区划列表
注意:此字段可能返回 null,表示取不到有效值。

DescribeAlarmLevelListRes

告警级别枚举获取

被如下接口引用:DescribeAlarmLevelList。

名称 类型 描述
AlarmLevelSet Array of AlarmLevelInfo 告警级别枚举获取数组
注意:此字段可能返回 null,表示取不到有效值。
示例值:{"LevelId": 3,"LevelName": "严重"}

DescribeAlarmListRes

告警列表回包

被如下接口引用:DescribeAlarmList。

名称 类型 描述
PageNumber Integer 第几页
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
PageSize Integer 每页条数
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
TotalPage Integer 总页数
注意:此字段可能返回 null,表示取不到有效值。
示例值:2
TotalRow Integer 总条数
注意:此字段可能返回 null,表示取不到有效值。
示例值:20
AlarmInfoSet Array of AlarmInfo 告警列表集合
注意:此字段可能返回 null,表示取不到有效值。
示例值:{"AppId": 0,"Desc": "水量使用超限","DeviceName": "20楼水表","Echo": "","Extend": "x-json:{"alarmLevel":3,"alarmValue":13730945.6}","ExtendOne": "x-json:","ExtendTwo": "x-json:","HandlePersonSet": [],"HandleRecordSet": [],"Id": "0c6ec1cc-25d6-43bc-96b1-6b4131f1771a","Level": 3,"LevelName": "严重","Position": "滨海大厦-7F","ReportImg": {"Data": "","Type": 0},"Status": "unprocessed","SubType": "water_limit","SubTypeName": "水量使用超限","Time": 1693416976,"Type": "energy","TypeName": "能源","WID": "b1fd7aa3-4407-4b82-9dc3-aff9b3034a9f","WorkspaceId": 1016}

DescribeAlarmStatusListRes

告警状态列表返回

被如下接口引用:DescribeAlarmStatusList。

名称 类型 描述
List Array of AlarmStatusData 告警状态返回结构
注意:此字段可能返回 null,表示取不到有效值。

DescribeAlarmTypeListRes

告警类型列表回包

被如下接口引用:DescribeAlarmTypeList。

名称 类型 描述
AlarmTypeSet Array of AlarmTypeDetailInfo 告警类型查询列表
注意:此字段可能返回 null,表示取不到有效值。
示例值:{"EnglishName": "excessive","Id": 26,"Name": "人流数量异常","ParentId": 25,"Type": 1}

DescribeCityWorkspaceListRes

通过城市id查询工作空间列表

被如下接口引用:DescribeCityWorkspaceList。

名称 类型 描述
WorkspaceSet Array of WorkspaceInfo 通过城市id查询工作空间列表结果
注意:此字段可能返回 null,表示取不到有效值。
示例值:{"workspaceId": 1016,"nameCh": "华南园区项目","description": "华南园区项目","status": 0,"parkName": "园区简称","parkNum": "001","administDetail":{}}

DescribeDeviceGroupListRes

设备分组信息

被如下接口引用:DescribeDeviceGroupList。

名称 类型 必选 描述
List Array of DescribeGroupInfo 设备分组list
注意:此字段可能返回 null,表示取不到有效值。

DescribeDeviceListRes

设备列表查询结果

被如下接口引用:DescribeDeviceList。

名称 类型 描述
PageNumber Integer 第几页
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
PageSize Integer 每页条数
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
TotalPage Integer 总页数
注意:此字段可能返回 null,表示取不到有效值。
示例值:2
TotalRow Integer 总条数
注意:此字段可能返回 null,表示取不到有效值。
示例值:20
DeviceDataSet Array of DeviceDataInfo 设备信息集合
注意:此字段可能返回 null,表示取不到有效值。
示例值:{"ActiveTime": "2023-04-13T09:41:38+08:00","DeviceName": "1c902558-d360-4a93-9b6f-1b49970534f7","DeviceTagSet": ["中文标签测试"],"DeviceTypeCode": "1c902558-d360-4a93-9b6f-1b49970534f7","DeviceTypeName": "1c902558-d360-4a93-9b6f-1b49970534f7","FieldList": [{"Id": 1,"Key": "color","Name": "颜色","Val": ""}],"IsActive": 1,"IsLive": false,"Location": {"X": -197697.515625,"Y": 22156.90234375,"Z": 0},"ModelId": "","ModelName": "","OtaVersion": "v1","ParentWID": "","ParentWIDName": "","ProductAbility": 1,"ProductId": 2000053,"ProductName": "其它网关","SN": "tony001","SpaceInfoSet": [{"Code": "001234","Id": "7e0eba7e-aa9b-43bd-8a68-2ea7153828de","Level": 6,"Name": "验证专用"}],"WID": "1c902558-d360-4a93-9b6f-1b49970534f7"}

DescribeEventListRes

事件列表查询结果

被如下接口引用:DescribeEventList。

名称 类型 描述
PageNumber Integer 第几页
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
PageSize Integer 每页条数
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
TotalPage Integer 总页数
注意:此字段可能返回 null,表示取不到有效值。
示例值:2
TotalRow Integer 总条数
注意:此字段可能返回 null,表示取不到有效值。
示例值:2
EventDetailSet Array of EventDetail 事件信息列表
注意:此字段可能返回 null,表示取不到有效值。
示例值:{"CreateTime": "2023-05-13 20:23:37","DeviceType": "","Id": 14,"LinkRuleSet": [{"Id": 23,"Name": ""}],"Name": "13","Tr

DescribeGroupInfo

分组信息实体类

被如下接口引用:DescribeDeviceGroupList。

名称 类型 必选 描述
Id Integer 分组
示例值:1
Name String 设备分组名称
示例值:分组001
Description String 分组描述
注意:此字段可能返回 null,表示取不到有效值。
示例值:分组描述
ParentId Integer 分组父级ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:1

DescribeLinkRuleListRes

联动规则列表查询结果

被如下接口引用:DescribeLinkRuleList。

名称 类型 描述
PageNumber Integer 第几页
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
PageSize Integer 每页条数
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
TotalPage Integer 总页数
注意:此字段可能返回 null,表示取不到有效值。
示例值:2
TotalRow Integer 总条数
注意:此字段可能返回 null,表示取不到有效值。
示例值:2
LinkRuleSet Array of LinkRuleInfo 联动规则列表
注意:此字段可能返回 null,表示取不到有效值。
示例值:{"ActionSet": [{"Id": 28,"Name": "瞿杨动作"}],"BeginDate": "2023-05-03","EndDate": "2023-05-22","EventSet": [{"Id": 33,"Name": "体验"}],"Id": 24,"Name": "体验","Status": 24,"ValidPeriod": ""}

DeviceDataInfo

设备数据信息

被如下接口引用:DescribeDeviceList。

名称 类型 描述
WID String 设备ID, wid
注意:此字段可能返回 null,表示取不到有效值。
示例值:1c902558-d360-4a93-9b6f-1b49970534f7中文标签测试
DeviceName String 设备名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:1c902558-d360-4a93-9b6f-1b49970534f7
DeviceTypeCode String 设备类型Id
注意:此字段可能返回 null,表示取不到有效值。
示例值:1c902558-d360-4a93-9b6f-1b49970534f7
DeviceTypeName String 设备类型名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:1c902558-d360-4a93-9b6f-1b49970534f7
ProductId Integer 产品Id
注意:此字段可能返回 null,表示取不到有效值。
示例值:2000053
ProductName String 产品名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:其它网关
ProductAbility Integer 产品能力:信令数据、音视频。二进制数值中第0位表示信令数据、第1位表示音视频 。1(信令数据),3(具有信令数据以及音视频能力)。
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
SpaceInfoSet Array of DeviceSpaceInfo 设备位置信息
注意:此字段可能返回 null,表示取不到有效值。
示例值:{"Code": "001234","Id": "7e0eba7e-aa9b-43bd-8a68-2ea7153828de","Level": 6,"Name": "验证专用"}
ModelId String 模型id
注意:此字段可能返回 null,表示取不到有效值。
示例值:1232
ModelName String 模型名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:a
DeviceTagSet Array of String 设备标签名,非必填
注意:此字段可能返回 null,表示取不到有效值。
示例值:中文标签测试
IsActive Integer 激活状态(1激活、0未激活)
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
ActiveTime String 激活时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:2023-04-13T09:41:38+08:00
IsLive Boolean 推流状态(推流中、未推流) 仅摄像机有的状态
注意:此字段可能返回 null,表示取不到有效值。
示例值:false
ParentWID String 设备所属父设备id(子设备才有)
注意:此字段可能返回 null,表示取不到有效值。
示例值:xxxx
ParentWIDName String 设备所有父设备名称(子设备才有)
注意:此字段可能返回 null,表示取不到有效值。
示例值:atest
SN String 序列号
注意:此字段可能返回 null,表示取不到有效值。
示例值:tony001
Location DeviceLocation 设备点位坐标值
注意:此字段可能返回 null,表示取不到有效值。
示例值:{"X": -197697.515625,"Y": 22156.90234375,"Z": 0}
FieldList Array of CustomFieldInfo 自定义字段
注意:此字段可能返回 null,表示取不到有效值。
示例值:{"Id": 1,"Key": "color","Name": "颜色","Val": ""}
GroupInfo String 分组信息
注意:此字段可能返回 null,表示取不到有效值。
示例值:xx/xx/xx
DeviceStatus String 通信在/离线状态(online=normal+fault,offline)
注意:此字段可能返回 null,表示取不到有效值。
示例值:online
Status String 设备业务状态(normal、fault、offline)
注意:此字段可能返回 null,表示取不到有效值。
示例值:normal

DeviceLocation

设备点位坐标值

被如下接口引用:DescribeDeviceList。

名称 类型 描述
X Float 点位X坐标值
注意:此字段可能返回 null,表示取不到有效值。
示例值:-197697.515625
Y Float 点位Y坐标值
注意:此字段可能返回 null,表示取不到有效值。
示例值:-197697.515625
Z Float 点位Z坐标值
注意:此字段可能返回 null,表示取不到有效值。
示例值:0

DeviceModifyInfo

设备修改信息入参

被如下接口引用:ModifyDeviceName。

名称 类型 必选 描述
WID String 设备id
示例值:be2ea997-b7f4-4167-9545-9aa275158a92
DeviceName String 修改后的设备名字
示例值:a

DeviceShadowInfo

设备影子信息

被如下接口引用:DescribeDeviceShadowList。

名称 类型 描述
WID String 设备ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:026d1dd8-a6d7-4fb7-9a94-0df07edaaff8
DeviceShadow String 设备影子数据,返回有效数据为"x-json:"后字段
注意:此字段可能返回 null,表示取不到有效值。
示例值:x-json:{"desired":{},"reported":{"events":{},"profile":{"modelId":"w0745001"},"properties":{"Ept":96,"IA":32,"IB":42},"reportTs":1693370542126}}
DeviceShadowUpdateTime String 设备影子更新时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:2023-08-30 12:42:22

DeviceShadowRes

设备影子查询列表

被如下接口引用:DescribeDeviceShadowList。

名称 类型 描述
PageNumber Integer 第几页
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
PageSize Integer 每页条数
注意:此字段可能返回 null,表示取不到有效值。
示例值:5
TotalPage Integer 总页数
注意:此字段可能返回 null,表示取不到有效值。
示例值:2
TotalRow Integer 总条数
注意:此字段可能返回 null,表示取不到有效值。
示例值:10
Set Array of DeviceShadowInfo 设备影子列表
注意:此字段可能返回 null,表示取不到有效值。
示例值:{"DeviceShadow": "x-json:{"desired":{},"reported":{"events":{},"profile":{"modelId":"w0745001"},"properties":{"Ept":96,"IA":32,"IB":42},"reportTs":1693370542126}}","DeviceShadowUpdateTime": "2023-08-30 12:42:22","WID": "026d1dd8-a6d7-4fb7-9a94-0df07edaaff8"}

DeviceSpaceInfo

设备位置信息

被如下接口引用:DescribeDeviceList。

名称 类型 描述
Id String 空间Id
注意:此字段可能返回 null,表示取不到有效值。
示例值:7e0eba7e-aa9b-43bd-8a68-2ea7153828de
Name String 空间名字
注意:此字段可能返回 null,表示取不到有效值。
示例值:验证专用
Level Integer 空间级别
注意:此字段可能返回 null,表示取不到有效值。
示例值:5
Code String 空间编码
注意:此字段可能返回 null,表示取不到有效值。
示例值:001234

DeviceSpaceInfoRes

设备挂接的空间信息

被如下接口引用:DescribeSpaceInfoByDeviceId。

名称 类型 描述
BuildingId String 建筑id
注意:此字段可能返回 null,表示取不到有效值。
示例值:82d5fb5a-52d0-4636-a225-d46245e911ef
ElementId String 构件id
注意:此字段可能返回 null,表示取不到有效值。
示例值:8a74aba0-46e3-4097-89e6-7adbeb9ccaef
EntityType String 构件类型
注意:此字段可能返回 null,表示取不到有效值。
示例值:TBIM_CAMERA
ElementName String 构件名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:1232533半球摄像头
Level Integer 构件级别
注意:此字段可能返回 null,表示取不到有效值。
示例值:9
BottomHeight Integer 底部标高(单位mm)
注意:此字段可能返回 null,表示取不到有效值。
示例值:3000
SpaceCode String 空间编码
注意:此字段可能返回 null,表示取不到有效值。
示例值:00003000300000008

DeviceStatusInfo

设备状态信息

被如下接口引用:DescribeDeviceStatusList。

名称 类型 描述
WID String 设备ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:be2ea997-b7f4-4167-9545-9aa275158a92
DeviceStatus String 设备状态(online=normal+fault、offline)
注意:此字段可能返回 null,表示取不到有效值。
示例值:online
DeviceStatusUpdateTime String 设备状态更新时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:2023-08-31 00:57:28
Status String 设备业务状态(normal、fault、offline)
注意:此字段可能返回 null,表示取不到有效值。
示例值:normal
IsAlive Boolean 推流状态。推流中-true,未推流-false
注意:此字段可能返回 null,表示取不到有效值。
示例值:true

DeviceStatusRes

设备状态获取接口结果

被如下接口引用:DescribeDeviceStatusList。

名称 类型 描述
PageNumber Integer 第几页
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
PageSize Integer 每页条数
注意:此字段可能返回 null,表示取不到有效值。
示例值:10
TotalPage Integer 总页数
注意:此字段可能返回 null,表示取不到有效值。
示例值:2
TotalRow Integer 总条数
注意:此字段可能返回 null,表示取不到有效值。
示例值:20
DeviceStatusSet Array of DeviceStatusInfo 设备状态信息列表
注意:此字段可能返回 null,表示取不到有效值。
示例值:{"DeviceStatus": "online","DeviceStatusUpdateTime": "2023-08-31 00:57:28","IsAlive": true,"Status": "normal","WID": "be2ea997-b7f4-4167-9545-9aa275158a92"}

DeviceStatusStatRes

设备状态统计结果

被如下接口引用:DescribeDeviceStatusStat。

名称 类型 描述
WorkspaceId Integer 工作空间Id
注意:此字段可能返回 null,表示取不到有效值。
示例值:1016
Total Integer 汇总数。在线(正常+故障) + 离线
注意:此字段可能返回 null,表示取不到有效值。
示例值:8791
NormalSum Integer 正常数
注意:此字段可能返回 null,表示取不到有效值。
示例值:87
OfflineSum Integer 离线数
注意:此字段可能返回 null,表示取不到有效值。
示例值:8689
FaultSum Integer 故障数
注意:此字段可能返回 null,表示取不到有效值。
示例值:15
DeviceTypeOverviewSet Array of DeviceTypeOverview 设备类型概览列表
注意:此字段可能返回 null,表示取不到有效值。
示例值:{"DeviceType":"string","Fault":0,"Name":"string","Offline":0,"Normal":0,"Total":0}
StatLevelSet Array of StatLevel 设备类型统计列表
注意:此字段可能返回 null,表示取不到有效值。
示例值:{"StatDeviceTypeSet":[{"DeviceType":"string","Fault":0,"Name":"string","Offline":0,"Normal":0,"Total":0}],"FaultSum":0,"OfflineSum":0,"NormalSum":0,"SpaceCode":"string","Total":0}

DeviceTagInfo

设备标签信息

被如下接口引用:DescribeDeviceTagList。

名称 类型 描述
TagId Integer 标签Id
注意:此字段可能返回 null,表示取不到有效值。
示例值:35
TagName String 标签名字
注意:此字段可能返回 null,表示取不到有效值。
示例值:西安真实摄像头

DeviceTagRes

设备标签列表查询结果

被如下接口引用:DescribeDeviceTagList。

名称 类型 描述
PageNumber Integer 第几页
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
PageSize Integer 每页条数
注意:此字段可能返回 null,表示取不到有效值。
示例值:20
TotalPage Integer 总页数
注意:此字段可能返回 null,表示取不到有效值。
示例值:2
TotalRow Integer 总条数
注意:此字段可能返回 null,表示取不到有效值。
示例值:40
Set Array of DeviceTagInfo 设备标签列表
注意:此字段可能返回 null,表示取不到有效值。
示例值:{"TagId": 35,"TagName": "西安真实摄像头"}

DeviceType

设备类型

被如下接口引用:DescribeDeviceTypeList。

名称 类型 描述
Code String 设备类型编码
注意:此字段可能返回 null,表示取不到有效值。
示例值:w0301006
Name String 设备类型名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:烟感报警器
ParentCode String 父设备类型编码
注意:此字段可能返回 null,表示取不到有效值。
示例值:0301
ParentName String 父设备类型名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:火灾自动报警及联动系统
IsSubsystem Integer 是否子系统,1是

注意:此字段可能返回 null,表示取不到有效值。
示例值:0

DeviceTypeOverview

设备类型概览信息

被如下接口引用:DescribeDeviceStatusStat。

名称 类型 描述
DeviceType String 设备类型值
注意:此字段可能返回 null,表示取不到有效值。
示例值:w02002
Name String 设备类型名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:atest
Total Integer 汇总数。在线(正常+故障) + 离线
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
Normal Integer 正常数
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
Offline Integer 离线数
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
Fault Integer 故障数
注意:此字段可能返回 null,表示取不到有效值。
示例值:0

DeviceTypeSet

设备类型列表

被如下接口引用:DescribeDeviceTypeList。

名称 类型 描述
Set Array of DeviceType 设备类型列表
注意:此字段可能返回 null,表示取不到有效值。
示例值:{"Code": "w0301006","IsSubsystem": 0,"Name": "烟感报警器","ParentCode": "0301","ParentName": "火灾自动报警及联动系统"}

ElementCoordinates

构件地理坐标

被如下接口引用:DescribePropertyList。

名称 类型 描述
Longitude Float 经度
注意:此字段可能返回 null,表示取不到有效值。
示例值:117.25139600000003
Latitude Float 纬度
注意:此字段可能返回 null,表示取不到有效值。
示例值:39.12852507853361
Altitude Float 高程
注意:此字段可能返回 null,表示取不到有效值。
示例值:0

ElementProfile

构件概要信息

被如下接口引用:DescribeElementProfilePage, DescribeElementProfileTree。

名称 类型 描述
BuildingId String 建筑id
注意:此字段可能返回 null,表示取不到有效值。
示例值:82d5fb5a-52d0-4636-a225-d46245e911ef
ElementId String 构件id
注意:此字段可能返回 null,表示取不到有效值。
示例值:61049c1b-158d-41bd-9f0b-df30a50401bd
EntityType String 构件类型
注意:此字段可能返回 null,表示取不到有效值。
示例值:TBIM_BUILDINGSTOREY
ElementName String 构件名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:RF
Level Integer 构件空间级别
注意:此字段可能返回 null,表示取不到有效值。
示例值:7
BottomHeight Integer 底部标高(单位mm)
注意:此字段可能返回 null,表示取不到有效值。
示例值:3000
Sort Integer 排序
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
SpaceCode String 空间编码
注意:此字段可能返回 null,表示取不到有效值。
示例值:000030003
SpaceTypeCode String 空间分类编码
注意:此字段可能返回 null,表示取不到有效值。
示例值:""
SpaceTypeName String 空间分类名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:""
ParentElementId String 父级构件id
注意:此字段可能返回 null,表示取不到有效值。
示例值:82d5fb5a-52d0-4636-a225-d46245e911ef
SpacePoiId String 空间层级类型编码
注意:此字段可能返回 null,表示取不到有效值。
示例值:""
ElementDesc String 构件描述
注意:此字段可能返回 null,表示取不到有效值。
示例值:""
IsDelete Integer 删除标记
注意:此字段可能返回 null,表示取不到有效值。
示例值:0

ElementProfilePageRes

构件分页查询响应体

被如下接口引用:DescribeElementProfilePage。

名称 类型 描述
TotalCount Integer 构件总数
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
List Array of ElementProfile 构件列表
注意:此字段可能返回 null,表示取不到有效值。
示例值:[ { "BottomHeight": -100, "BuildingId": "956bd069-c802-4bbb-b325-18d30d7bcd3c", "ElementDesc": "", "ElementId": "1Kjh8u2qf4uRSkCPoKigTI", "ElementName": "1F(结) -0.100", "EntityType": "TBIM_BUILDINGSTOREY", "IsDelete": 0, "Level": 7, "ParentElementId": "956bd069-c802-4bbb-b325-18d30d7bcd3c", "Sort": 1, "SpaceCode": "000185004", "SpacePoiId": "", "SpaceTypeCode": "", "SpaceTypeName": "" } ]

ElementProfileTreeNode

构件树节点信息

被如下接口引用:DescribeElementProfileTree。

名称 类型 描述
ElementProfile ElementProfile 构件概要信息
注意:此字段可能返回 null,表示取不到有效值。
示例值:{ "BottomHeight": 3000, "BuildingId": "82d5fb5a-52d0-4636-a225-d46245e911ef", "ElementDesc": "", "ElementId": "6042d426-6973-47ff-8ce1-3a63ef9f3c2f", "ElementName": "", "EntityType": "TBIM_SLASHWALL", "IsDelete": 0, "Level": 8, "ParentElementId": "61049c1b-158d-41bd-9f0b-df30a50401bd", "Sort": 1, "SpaceCode": "00003000300000001", "SpacePoiId": "", "SpaceTypeCode": "", "SpaceTypeName": "" }
Children Array of ElementProfileTreeNode 子节点信息
注意:此字段可能返回 null,表示取不到有效值。
示例值:[]

ElementProfileTreeRes

构件树响应体

被如下接口引用:DescribeElementProfileTree。

名称 类型 描述
BuildingId String 建筑id
注意:此字段可能返回 null,表示取不到有效值。
示例值:82d5fb5a-52d0-4636-a225-d46245e911ef
ParentElementId String 父级构件id
注意:此字段可能返回 null,表示取不到有效值。
示例值:61049c1b-158d-41bd-9f0b-df30a50401bd
Root ElementProfileTreeNode 构件树
注意:此字段可能返回 null,表示取不到有效值。
示例值: { "Children": [ { "Children": [], "ElementProfile": { "BottomHeight": 3000, "BuildingId": "82d5fb5a-52d0-4636-a225-d46245e911ef", "ElementDesc": "", "ElementId": "6042d426-6973-47ff-8ce1-3a63ef9f3c2f", "ElementName": "", "EntityType": "TBIM_SLASHWALL", "IsDelete": 0, "Level": 8, "ParentElementId": "61049c1b-158d-41bd-9f0b-df30a50401bd", "Sort": 1, "SpaceCode": "00003000300000001", "SpacePoiId": "", "SpaceTypeCode": "", "SpaceTypeName": "" } } ], "ElementProfile": { "BottomHeight": 3000, "BuildingId": "82d5fb5a-52d0-4636-a225-d46245e911ef", "ElementDesc": "", "ElementId": "61049c1b-158d-41bd-9f0b-df30a50401bd", "ElementName": "RF", "EntityType": "TBIM_BUILDINGSTOREY", "IsDelete": 0, "Level": 7, "ParentElementId": "", "Sort": 1, "SpaceCode": "000030003", "SpacePoiId": "", "SpaceTypeCode": "", "SpaceTypeName": "" } }

ElementProperty

构件属性信息

被如下接口引用:DescribePropertyList。

名称 类型 描述
Name String 属性名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:Materials and Finishes
Description String 属性描述
注意:此字段可能返回 null,表示取不到有效值。
示例值:""
Content String 属性内容
注意:此字段可能返回 null,表示取不到有效值。
示例值:{Material=None}

ElementPropertyRes

构件属性信息响应体

被如下接口引用:DescribePropertyList。

名称 类型 描述
BuildingId String 建筑id
注意:此字段可能返回 null,表示取不到有效值。
示例值:"377e4f9d-d20e-4209-b1e8-0ddb32e888c8"
ElementId String 构件id
注意:此字段可能返回 null,表示取不到有效值。
示例值:"b66aece1-62e9-49d3-872e-6e66156a853b"
PropertySet Array of ElementProperty 构件属性集合
注意:此字段可能返回 null,表示取不到有效值。
示例值:[ { "Content": "{Elevation=9500, Story Above=None}", "Description": "", "Name": "Constraints" }, { "Content": "{Computation Height=0}", "Description": "", "Name": "Dimensions" }, { "Content": "{Is ground plane=0}", "Description": "", "Name": "Display" }, { "Content": "{storeyType=TOP_FLOOR, floorHeight=3000, bottomHeight=9500}", "Description": "", "Name": "EDITOR_BUILDING_STOREY_EXTEND" }, { "Content": "{Scope Box=None}", "Description": "", "Name": "Extents" }, { "Content": "{IfcGUID=1LvAmy3$j18hHP$GEcP3rk, Export to IFC=0}", "Description": "", "Name": "IFC Parameters" }, { "Content": "{Structural=No, Design Option=None, Building Story=Yes}", "Description": "", "Name": "Identity Data" }, { "Content": "{Name=Level : F4, Type=C_上标高+层标, Childs=[Roofs], Family=Level, Type Id=87266, Category=OST_Levels, ClassName=OdBmCDANode, ODAUniqueID=214592, LocalizedName=, Family and Type=Level : C_上标高+层标}", "Description": "", "Name": "Invalid group" }, { "Content": "{Material=None}", "Description": "", "Name": "Materials and Finishes" } ]
Coordinates ElementCoordinates 构件地理坐标
注意:此字段可能返回 null,表示取不到有效值。
示例值:{ "Altitude": 0, "Latitude": 39.12852507853361, "Longitude": 117.25139600000003 }
Translate ElementTranslate 构件偏移量
注意:此字段可能返回 null,表示取不到有效值。
示例值:{ "X": 0, "Y": 0, "Z": 0 }
ElementName String 构件名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:"Level : F4"
EntityTypeCode String 构件类型代码
注意:此字段可能返回 null,表示取不到有效值。
示例值:"TBIM_BUILDINGSTOREY"
EntityTypeName String 构件类型名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:"楼层"

ElementTranslate

构件平移信息

被如下接口引用:DescribePropertyList。

名称 类型 描述
X Float X方向偏移量
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
Y Float Y方向偏移量
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
Z Float Z方向偏移量
注意:此字段可能返回 null,表示取不到有效值。
示例值:0

EmptyRes

空结果返回

被如下接口引用:AddAlarmProcessRecord, BatchDeleteDevice, BatchKillAlarm, ChangeAlarmStatus, ControlCameraPTZ, DeleteDeviceGroup, ModifyDeviceField, ModifyDeviceGroup, ModifyDeviceName, ModifyDeviceTag, ReportAppMessage, StopVideoStreaming, UpdateWorkspaceParkAttributes。

名称 类型 描述
Msg String 返回请求状态,成功ok,失败error
注意:此字段可能返回 null,表示取不到有效值。
示例值:ok

Event

事件信息

被如下接口引用:DescribeLinkRuleList。

名称 类型 描述
Id Integer 事件id或动作Id
注意:此字段可能返回 null,表示取不到有效值。
示例值:24
Name String 事件名称或动作名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:a

EventDetail

事件详细信息

被如下接口引用:DescribeEventList。

名称 类型 描述
Id Integer 事件id
注意:此字段可能返回 null,表示取不到有效值。
示例值:14
Name String 事件名
注意:此字段可能返回 null,表示取不到有效值。
示例值:a
TriggerType String 事件触发类型
注意:此字段可能返回 null,表示取不到有效值。
示例值:timer
TriggerCondition String 事件触发条件,返回为x-json后的字段
注意:此字段可能返回 null,表示取不到有效值。
示例值:x-json:xxx
ValidPeriod String 有效期
注意:此字段可能返回 null,表示取不到有效值。
示例值:xxx
LinkRuleSet Array of LinkRule 关联规则列表
注意:此字段可能返回 null,表示取不到有效值。
示例值:{"Id": 23,"Name": ""}
CreateTime String 创建时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:2023-05-13 20:23:37
DeviceType String 设备类型,当触发类型为deviceType时返回
注意:此字段可能返回 null,表示取不到有效值。
示例值:xxx
WID String 设备的wid,当触发类型是device返回
注意:此字段可能返回 null,表示取不到有效值。
示例值:xxx-xxx-xxx

EventObj

事件对象

被如下接口引用:DescribeRuleDetail。

名称 类型 描述
Id Integer 事件id
注意:此字段可能返回 null,表示取不到有效值。
示例值:36
Name String 事件名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:具体设备
Type String 事件触发类型名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:device
Condition String 时间触发条件
注意:此字段可能返回 null,表示取不到有效值。
示例值:"x-json:[{"type":"objmodel","attr":"properties.idtest","oper":"=","val":"348","obj":{"id":"idtest","name":"idtest","type":"int","modelName":"网关设备_直连类型","modelId":"2000085","define":{"type":"int"}},"valType":0,"otherObj":""}]

FileDownloadURL

文件下载URL

被如下接口引用:DescribeFileDownloadURL。

名称 类型 描述
FileURL String 下载地址

注意:此字段可能返回 null,表示取不到有效值。
示例值:https://xxx.xxx

FileInfo

文件信息

被如下接口引用:DescribeAlarmList。

名称 类型 描述
FileId String 文件id

注意:此字段可能返回 null,表示取不到有效值。
示例值:192
ReportName String 名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:test

FileUploadURL

获取文件上传URL接口回包

被如下接口引用:DescribeFileUploadURL。

名称 类型 描述
UploadURL String 上传地址
注意:此字段可能返回 null,表示取不到有效值。
示例值:http://xxx.xxx
FileId String 文件Id
注意:此字段可能返回 null,表示取不到有效值。
示例值:xxx
DownloadURL String 下载地址
注意:此字段可能返回 null,表示取不到有效值。
示例值:http://xxx.xxx

HandleRecordInfo

告警处理记录

被如下接口引用:DescribeAlarmList。

名称 类型 描述
Id Integer 告警处理记录id

注意:此字段可能返回 null,表示取不到有效值。
示例值:30293
Description String 描述
注意:此字段可能返回 null,表示取不到有效值。
示例值:test
Name String 名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:test
OperationType String 操作类型
注意:此字段可能返回 null,表示取不到有效值。
示例值:消警
Time String 处理时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:1693416991
Type String 类型
注意:此字段可能返回 null,表示取不到有效值。
示例值:rule_alarm_elimination
FileSet Array of FileInfo 文件列表

注意:此字段可能返回 null,表示取不到有效值。
示例值:{"Id":123,"Name":"a"}
AppId Integer 应用appid
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
ExtendOne String 扩展字段1,存非孪生中台用户id

注意:此字段可能返回 null,表示取不到有效值。
示例值:x-json:xxx

HandlerPersonInfo

告警处理人列表

被如下接口引用:DescribeAlarmList。

名称 类型 描述
Id String 用户id
注意:此字段可能返回 null,表示取不到有效值。
示例值:12
Name String 用户名
注意:此字段可能返回 null,表示取不到有效值。
示例值:test

LinkRule

关联规则信息

被如下接口引用:DescribeActionList, DescribeEventList。

名称 类型 描述
Id Integer 关联联动规则id
注意:此字段可能返回 null,表示取不到有效值。
示例值:23
Name String 关联联动规则名字
注意:此字段可能返回 null,表示取不到有效值。
示例值:a

LinkRuleInfo

联动规则信息

被如下接口引用:DescribeLinkRuleList。

名称 类型 描述
Id Integer 联动id
注意:此字段可能返回 null,表示取不到有效值。
示例值:24
Name String 联动名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:体验
EventSet Array of Event 事件列表
注意:此字段可能返回 null,表示取不到有效值。
示例值:{"Id": 33,"Name": "体验"}
ActionSet Array of Action 动作列表
注意:此字段可能返回 null,表示取不到有效值。
示例值:{"Id": 28,"Name": "动作"}
Status Integer 状态:0开,-1关
注意:此字段可能返回 null,表示取不到有效值。
示例值:24
BeginDate String 起始时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:2023-05-03
EndDate String 结束时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:2023-05-22
ValidPeriod String 有效周期内容,有效字段为x-json后的字段
注意:此字段可能返回 null,表示取不到有效值。
示例值:x-json:xxxx

MessageProfile

上报消息概要

被如下接口引用:BatchReportAppMessage, ReportAppMessage。

名称 类型 必选 描述
AppType String 应用类型
示例值:security_monitoring
ModelId String 模型Id
示例值:1000
PoiCode String 设备类型
示例值:t234329

ModelInfo

模型基础信息

被如下接口引用:DescribeModelList。

名称 类型 描述
WorkspaceId Integer 工作空间id
注意:此字段可能返回 null,表示取不到有效值。
示例值:1016
ModelName String 模型名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:边缘温控器
ModelId String 物模型id
注意:此字段可能返回 null,表示取不到有效值。
示例值:2000055
RelatedProduct Array of RelatedProduct 关联产品信息
注意:此字段可能返回 null,表示取不到有效值。
示例值:{"Id": 2000055,"Name": "边缘温控器"}
DeviceTypeName String 设备类型名
注意:此字段可能返回 null,表示取不到有效值。
示例值:空调温控器
DeviceType String 设备类型id
注意:此字段可能返回 null,表示取不到有效值。
示例值:w0404024
ModelType Integer 物模型类型,产品模型/标准模型
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
ModelParams String 模型参数内容,有效字段为"x-json:"后的字段
注意:此字段可能返回 null,表示取不到有效值。
示例值:x-json:"xxxx"

ModelSet

模型列表查询结果

被如下接口引用:DescribeModelList。

名称 类型 描述
PageNumber Integer 第几页
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
PageSize Integer 每页条数
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
TotalPage Integer 总页数
注意:此字段可能返回 null,表示取不到有效值。
示例值:2
TotalRow Integer 总条数
注意:此字段可能返回 null,表示取不到有效值。
示例值:2
Set Array of ModelInfo 模型基础信息
注意:此字段可能返回 null,表示取不到有效值。
示例值:{"DeviceType": "w0404024","DeviceTypeName": "空调温控器","ModelId": "2000055","ModelName": "边缘温控器","ModelParams": "x-json:"{}"}","ModelType": 1,"RelatedProduct": [{"Id": 2000055,"Name": "边缘温控器"}],"WorkspaceId": 1016}],"TotalPage": 156,"TotalRow": 156}

ModifyDeviceFieldInfo

设备自定义值修改信息入参

被如下接口引用:ModifyDeviceField。

名称 类型 必选 描述
WID String 设备id
示例值:be2ea997-b7f4-4167-9545-9aa275158a92
Key String 自定义字段key
示例值:xxx
Val String 自定义字段值
示例值:xxx

ModifyDeviceGroupInfo

设备组修改信息入参

被如下接口引用:ModifyDeviceGroup。

名称 类型 必选 描述
WID String 设备id
示例值:be2ea997-b7f4-4167-9545-9aa275158a92
GroupId Integer 设备分组id
示例值:100

ModifyDeviceTagInfo

设备标签修改信息入参

被如下接口引用:ModifyDeviceTag。

名称 类型 必选 描述
WID String 设备id
示例值:be2ea997-b7f4-4167-9545-9aa275158a92
NameSet Array of String 设备标签名称集合
示例值:["aaa","bbb"]

ProcessRecordInfo

处理记录项

被如下接口引用:AddAlarmProcessRecord。

名称 类型 必选 描述
Id String 告警的id
示例值:cdf85c7c-cf04-41b5-9631-fa4a7290e615
ProcessTime Integer 处理时间,毫秒

示例值:1688114263000
ProcessType String 处理类型,此处操作类型固定填add_record

示例值:add_record-other
Processor String 注:此字段填写的是孪生中台的用户,非孪生中台用户不填该字段
[{"id":"123","name":"tes"}]

示例值:[{"id":"123","name":"tes"}]
ProcessDescription String 处理描述信息
示例值:test
AttachedFileId String 附加文件标识
示例值:[{"fileId":"b87ae7ec-6874-4103-bfa0-2489374476eb","fileName":"ecs.png"}]

ProductInfo

产品信息

被如下接口引用:DescribeProductList。

名称 类型 描述
WorkspaceId Integer 工作空间id
注意:此字段可能返回 null,表示取不到有效值。
示例值:1016
ProductId Integer 产品PID
注意:此字段可能返回 null,表示取不到有效值。
示例值:200055
ProductName String 产品名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:atest
DeviceTypeName String 设备类型
注意:此字段可能返回 null,表示取不到有效值。
示例值:温控器
DeviceTypeId String 设备类型id
注意:此字段可能返回 null,表示取不到有效值。
示例值:w04042
Attribute Integer 产品属性,如:网关(1)、直连设备(2)、子设备(3)
注意:此字段可能返回 null,表示取不到有效值。
示例值:3
ProductType String 产品型号
注意:此字段可能返回 null,表示取不到有效值。
示例值:atest
ProductAbility Integer 产品能力:信令数据、音视频。二进制数值中第0位表示信令数据、第1位表示音视频 。1(信令数据),3(具有信令数据以及音视频能力)。
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
Manufacturer String 生产厂商
注意:此字段可能返回 null,表示取不到有效值。
示例值:atest
MaintenanceMfr String 维保厂商
注意:此字段可能返回 null,表示取不到有效值。
示例值:atest
ModelName String 物模型名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:温控
ModelId String 物模型id
注意:此字段可能返回 null,表示取不到有效值。
示例值:200055
ModelType Integer 物模型类型,产品模型/标准模型
注意:此字段可能返回 null,表示取不到有效值。
示例值:1

ProductSet

产品列表查询结果

被如下接口引用:DescribeProductList。

名称 类型 描述
PageNumber Integer 第几页
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
PageSize Integer 每页条数
注意:此字段可能返回 null,表示取不到有效值。
示例值:20
TotalPage Integer 总页数
注意:此字段可能返回 null,表示取不到有效值。
示例值:3
TotalRow Integer 总条数
注意:此字段可能返回 null,表示取不到有效值。
示例值:100
Product Array of ProductInfo 产品信息列表
注意:此字段可能返回 null,表示取不到有效值。
示例值:{"WorkspaceId": 1016,"PoductId": 2000055,"ProductName": "边缘温控器","DeviceTypeName": "空调温控器","DeviceType": "w0404024","Attribute": 3,"ProductType": "","ProductAbility": 1,"Manufacturer": "dagakng","MaintenanceMfr": "","ModelName": "边缘温控器","ModelId": "2000055","ModelType": 1}

RawInfo

视频流Raw协议信息

被如下接口引用:DescribeVideoLiveStream。

名称 类型 描述
SM4Vector String 加密向量(如果视频网关选择流为非加密传输这个参数可忽略)
注意:此字段可能返回 null,表示取不到有效值。
示例值:LT50CB5unVXLDjkM
NATIP String 专线ip (非专线接入可忽略)
注意:此字段可能返回 null,表示取不到有效值。
示例值:1.47.110.0
StreamToken String 客户端握手鉴权参数
注意:此字段可能返回 null,表示取不到有效值。
示例值:18c434ca
Port Integer 拉流端口
注意:此字段可能返回 null,表示取不到有效值。
示例值:9001
StreamEnKey String 视频流加密key,目前为AES128加密KEY(如果视频网关选择流为非加密传输这个参数可忽略)
注意:此字段可能返回 null,表示取不到有效值。
示例值:VRK0JsivUkHWon7K
IP String 拉流公网地址(非公网接入时,这个地址是内网地址)
注意:此字段可能返回 null,表示取不到有效值。
示例值:185.47.110.0
InnerIP String 拉流内网地址
注意:此字段可能返回 null,表示取不到有效值。
示例值:11.121.500.32

RecordInfo

录像信息

被如下接口引用:DescribeVideoCloudRecord。

名称 类型 描述
StartTime Integer 本录像片段开始时间(s)
注意:此字段可能返回 null,表示取不到有效值。
示例值:1616466060
EndTime Integer 本录像片段结束时间(s)
注意:此字段可能返回 null,表示取不到有效值。
示例值:1616466098
VideoURL String 录像片段文件url
注意:此字段可能返回 null,表示取不到有效值。
示例值:http://1304886180.vod2.myqcloud.com/cac4da69vodcq1304886180/618f1d115285890815878290403/f0.mp4

RelatedProduct

关联产品信息

被如下接口引用:DescribeModelList。

名称 类型 描述
Id Integer 关联产品pid
注意:此字段可能返回 null,表示取不到有效值。
示例值:2000055
Name String 关联产品名字
注意:此字段可能返回 null,表示取不到有效值。
示例值:边缘温控器

ReportAppMessage

单条消息上报请求

被如下接口引用:BatchReportAppMessage。

名称 类型 必选 描述
WorkspaceId Integer 工作空间Id
示例值:1016
Profile MessageProfile 消息定义
示例值:{"modelId": 1000,"poiCode": "t234329","appType": "security_monitoring"}
ReportTs Integer 数据上报时间
示例值:1
Properties String 属性定义 - KV,若为json格式,需在前加上x-json:,有效字段为x-json:后的字段
示例值:x-json:{"executeId": "RX_TASK"}
EventSet String 事件定义 - KKV,若为json格式,需在前加上x-json:,有效字段为x-json:后的字段
示例值:x-json:{"face_control": {"image": {"data": "8bb1230b-78bb-4635-991b-9746dda24a9e","type": 4},"handler": {"type": 0,"data": "222111123123123123"},"describe": "","eventType": 0,"eventTs": 1650007523091}}
ServiceSet String 服务定义 - KKV,若为json格式,需在前加上x-json:,有效字段为x-json:后的字段
示例值:x-json:xxx
ExtendTwo String 扩展字段2,如:算法上报id,若为json格式,需在前加上x-json:
示例值:x-json:xxx
Echo String 透传信息,若为json格式,需在前加上x-json:,有效字段为x-json:后的字段
示例值:x-json:{"executeId": "RX_TASK"}

ReportImg

上报图片列表

被如下接口引用:DescribeAlarmList。

名称 类型 描述
Type Integer 类型
注意:此字段可能返回 null,表示取不到有效值。
示例值:4
Data String 数据
注意:此字段可能返回 null,表示取不到有效值。
示例值:testurl

ReportMsgRes

上报消息结果

被如下接口引用:BatchReportAppMessage。

名称 类型 描述
ReportId String 上报消息对应下标的16位标识Id, 即第几个消息

注意:此字段可能返回 null,表示取不到有效值。
示例值:0000000000000000
ReportStatus Integer 上报消息结果,1表示成功推送,0表示推送失败

注意:此字段可能返回 null,表示取不到有效值。
示例值:1

RuleDetailRes

规则详情查询结果

被如下接口引用:DescribeRuleDetail。

名称 类型 描述
RuleId Integer 联动id
注意:此字段可能返回 null,表示取不到有效值。
示例值:29
RuleName String 联动名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:联动同一建筑332
RuleDesc String 联动说明
注意:此字段可能返回 null,表示取不到有效值。
示例值:联动同一建筑
ValidType Integer 1 全天有效,0:固定时间段有效
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
ValidPeriod String 有效期,json字符串(全天有效时为空)
注意:此字段可能返回 null,表示取不到有效值。
示例值:x-json:xxxx
BeginDate String 起始时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:2023-8-22
EndDate String 结束时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:2023-8-24
Status Integer 启用状态。1-启用,0-停用
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
EventRule String 触发规则,事件的组合
注意:此字段可能返回 null,表示取不到有效值。
示例值:26
EventInfoSet Array of EventObj 事件对象集合
注意:此字段可能返回 null,表示取不到有效值。
示例值:"Condition": "x-json:[{"type":"objmodel","attr":"properties.idtest","oper":"=","val":"348","obj":{"id":"idtest","name":"idtest","type":"int","modelName":"网关设备_直连类型","modelId":"2000085","define":{"type":"int"}},"valType":0,"otherObj":""}]","Id": 36,"Name": "具体设备","Type": "device"}
ActionInfoSet Array of ActionObj 动作对象集合
注意:此字段可能返回 null,表示取不到有效值。
示例值:{"ApplyDevice": "","CreateTime": "2023-05-23 14:38:13","Desc": "事件范围内同一建筑","Id": 71,"MsgContent": "x-json:","MsgType": "origin","Name": "事件范围内同一建筑","SinkConfig": "x-json:{"nearbySearch":{"deviceType":"w0201001","pid":0,"limit":2,"objectLevel":9,"scopeLevel":"6","scopeRadius":"100","deviceAssign":"deviceType"}}","Type": "nearbyDevices"}

SaveDeviceGroupRes

保存or修改设备分组回包

被如下接口引用:SaveDeviceGroup。

名称 类型 描述
Id Integer 保存or修改设备分组回包信息
注意:此字段可能返回 null,表示取不到有效值。
示例值:1

SceneInfo

场景信息

被如下接口引用:DescribeSceneList。

名称 类型 描述
SceneId String 场景id
注意:此字段可能返回 null,表示取不到有效值。
示例值:0abe73dd-d06f-44f5-af82-43dea23af230
SceneName String 场景名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:三层商务办公楼单位修正
Version String 场景版本
注意:此字段可能返回 null,表示取不到有效值。
示例值:20230705160410780

SceneListRes

场景列表响应体

被如下接口引用:DescribeSceneList。

名称 类型 描述
SceneList Array of SceneInfo 场景列表
注意:此字段可能返回 null,表示取不到有效值。
示例值: [ { "SceneId": "0abe73dd-d06f-44f5-af82-43dea23af230", "SceneName": "三层商务办公楼单位修正", "Version": "20230705160410780" }, { "SceneId": "e9f2b87f-9078-4546-8d4f-99356ec3f82c", "SceneName": "商务办公楼模型", "Version": "20230630151240729" } ]

SpaceDataListStatsRes

查询项目空间楼栋数量与建筑面积响应体

被如下接口引用:DescribeWorkSpaceBuildingCountAndArea。

名称 类型 描述
List Array of SpaceDataStats 楼栋数量与建筑面积列表
注意:此字段可能返回 null,表示取不到有效值。
示例值: [ { "BuildingArea": 0, "BuildingCount": 2, "WorkspaceId": "1018", "WorkspaceName": "华北园区项目" }, { "BuildingArea": 202928.77732501808, "BuildingCount": 127, "WorkspaceId": "1016", "WorkspaceName": "华南园区项目" }, { "BuildingArea": 0, "BuildingCount": 8, "WorkspaceId": "1015", "WorkspaceName": "公共空间" } ]

SpaceDataStats

项目空间楼栋数量与建筑面积出参

被如下接口引用:DescribeWorkSpaceBuildingCountAndArea。

名称 类型 描述
WorkspaceId String 工作空间ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:1016
WorkspaceName String 工作空间名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:华南园区项目
BuildingCount Integer 楼栋数量
注意:此字段可能返回 null,表示取不到有效值。
示例值:127
BuildingArea Float 建筑面积
注意:此字段可能返回 null,表示取不到有效值。
示例值:202928.77732501808

SpaceDataTotalStatsRes

查询租户楼栋数量和楼栋建筑面积相应体

被如下接口引用:DescribeTenantBuildingCountAndArea。

名称 类型 描述
BuildingCount Integer 总楼栋数量
注意:此字段可能返回 null,表示取不到有效值。
示例值:137
BuildingArea Float 总建筑面积
注意:此字段可能返回 null,表示取不到有效值。
示例值:202928.77732501808

SpaceDeviceIdListRes

查询指定空间id列表响应

被如下接口引用:DescribeSpaceDeviceIdList。

名称 类型 描述
DeviceIds Array of String 设备id列表
注意:此字段可能返回 null,表示取不到有效值。
示例值: [ "2b538c57-933f-4820-b1d0-4df70d64aee3", "ad655ba1-975a-4238-94d7-5d2015d1cf1f", "5a1a0b73-7aa3-4699-a893-21846e7853ec", "0a198d6e-40f0-499f-bf99-7a959b7f4ef2" ]

SpaceDeviceRelation

设备-空间绑定关系

被如下接口引用:DescribeSpaceDeviceRelationList。

名称 类型 描述
DeviceId String 设备id
注意:此字段可能返回 null,表示取不到有效值。
示例值:1c902558-d360-4a93-9b6f-1b49970534f7
ElementId String 构件id
注意:此字段可能返回 null,表示取不到有效值。
示例值:8a74aba0-46e3-4097-89e6-7adbeb9ccaef

SpaceDeviceRelationRes

设备-空间绑定关系响应体

被如下接口引用:DescribeSpaceDeviceRelationList。

名称 类型 描述
SpaceDeviceRelationList Array of SpaceDeviceRelation 设备空间绑定关系列表
注意:此字段可能返回 null,表示取不到有效值。
示例值:[ { "DeviceId": "1c902558-d360-4a93-9b6f-1b49970534f7", "ElementId": "8a74aba0-46e3-4097-89e6-7adbeb9ccaef" }, { "DeviceId": "b66603af-7f8c-46c0-8712-1353a08d5806", "ElementId": "af7f7d83-17f8-4dff-80e2-a5129a39eab0" } ]

SpaceInfo

项目空间详细信息

被如下接口引用:DescribeWorkspaceList。

名称 类型 描述
WorkspaceId Integer 项目空间id
注意:此字段可能返回 null,表示取不到有效值。
示例值:1101
TenantId Integer 租户id
注意:此字段可能返回 null,表示取不到有效值。
示例值:100000
EnglishName String 英文名
注意:此字段可能返回 null,表示取不到有效值。
示例值:testspace
ChineseName String 中文名
注意:此字段可能返回 null,表示取不到有效值。
示例值:华南项目空间
Description String 项目空间描述
注意:此字段可能返回 null,表示取不到有效值。
示例值:华南项目空间
Status Integer 项目空间状态:0 启用 1 停用 -1 已删除
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
IsCommWorkspace Boolean 是否是公共空间
注意:此字段可能返回 null,表示取不到有效值。
示例值:true
ValidityStartTime String 有效期开始时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:1693193293
ValidityEndTime String 有效期结束时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:1693193293
Selected Integer 选中状态
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
IsSystem Integer 系统生成状态
注意:此字段可能返回 null,表示取不到有效值。
示例值:1

SpaceRelation

空间层级关系

被如下接口引用:DescribeSpaceRelationByDeviceId。

名称 类型 描述
ElementId String 构件id
注意:此字段可能返回 null,表示取不到有效值。
示例值:bdbbf537-d6c4-4b1e-80ae-e0bcaab8b06f
ElementName String 构件名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:test_no_100
Level Integer 空间层级
注意:此字段可能返回 null,表示取不到有效值。
示例值:9
SpaceCode String 空间编码
注意:此字段可能返回 null,表示取不到有效值。
示例值:00016200200000003
ParentSpaceCode String 父级空间编码
注意:此字段可能返回 null,表示取不到有效值。
示例值:000162002
Children Array of SpaceRelation 子构件信息
注意:此字段可能返回 null,表示取不到有效值。
示例值:[]

SpaceRelationRes

空间层级关系响应体

被如下接口引用:DescribeSpaceRelationByDeviceId。

名称 类型 描述
SpaceRelation SpaceRelation 空间层级关系
注意:此字段可能返回 null,表示取不到有效值。
示例值:{ "Children": [ { "Children": [ { "Children": [], "ElementId": "bdbbf537-d6c4-4b1e-80ae-e0bcaab8b06f", "ElementName": "test_no_100", "Level": 9, "ParentSpaceCode": "000162002", "SpaceCode": "00016200200000003" } ], "ElementId": "f3c5ffa5-05e3-4c26-a447-0edf71aa9783", "ElementName": "1F", "Level": 7, "ParentSpaceCode": "000162", "SpaceCode": "000162002" } ], "ElementId": "377a53a6-c5a7-445d-a3b7-c2d721f95408", "ElementName": "小智新设备挂接0628", "Level": 6, "ParentSpaceCode": "", "SpaceCode": "000162" }

SpaceType

空间分类

被如下接口引用:DescribeSpaceTypeList。

名称 类型 描述
SpaceTypeCode String 空间分类编码
注意:此字段可能返回 null,表示取不到有效值。
示例值:DIANTIJIAN
SpaceTypeName String 空间分类名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:电梯间

SpaceTypeListRes

空间分类列表响应体

被如下接口引用:DescribeSpaceTypeList。

名称 类型 描述
SpaceTypeList Array of SpaceType 空间分类列表
注意:此字段可能返回 null,表示取不到有效值。
示例值: [ { "SpaceTypeCode": "DIANTIJIAN", "SpaceTypeName": "电梯间" }, { "SpaceTypeCode": "LOUTIJIAN", "SpaceTypeName": "楼梯间" }, { "SpaceTypeCode": "WODEFANGJIAN", "SpaceTypeName": "我的房间" }, { "SpaceTypeCode": "XIUXISHI", "SpaceTypeName": "休息室" } ]

SsoDepartment

部门用户

被如下接口引用:DescribeTenantDepartmentList。

名称 类型 描述
DepartmentId String 部门ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:21
Name String 部门名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:财务部
ParentDepartmentId String 父级部门ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:9

SsoDepartmentsResult

部门用户结果

被如下接口引用:DescribeTenantDepartmentList。

名称 类型 描述
Total Integer 总数
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
Departments Array of SsoDepartment 部门列表
注意:此字段可能返回 null,表示取不到有效值。
示例值:[{"DepartmentId":"21","Name":"财务部","ParentDepartmentId":"9"},{"DepartmentId":"22","Name":"商务部","ParentDepartmentId":"10"}]

SsoTeamUser

部门用户

被如下接口引用:DescribeWorkspaceUserList。

名称 类型 描述
UserId String 用户ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:0d0a98561b3c4f72963eba5c5fcf56e1
RealName String 用户名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:张三
UserType String 用户类型,1-超级管理员;2-1号管理员;3-普通管理员;99-普通用户
注意:此字段可能返回 null,表示取不到有效值。
示例值:3
TenantId String 所属租户ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:10001
Email String 邮箱
注意:此字段可能返回 null,表示取不到有效值。
示例值:test@163.com
Phone String 电话
注意:此字段可能返回 null,表示取不到有效值。
示例值:186xxxx234
Status Integer 用户状态
注意:此字段可能返回 null,表示取不到有效值。
示例值:用户状态,0待审核,1正常启用,2禁用
CreateAt Integer 创建时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:1680836659
DepartmentId String 部门ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:12
DepartmentName String 部门名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:财务部
LinkFilter Integer 是否关联权限
注意:此字段可能返回 null,表示取不到有效值。
示例值:1

SsoTeamUserResult

空间用户结果

被如下接口引用:DescribeWorkspaceUserList。

名称 类型 描述
Total Integer 总数
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
Users Array of SsoTeamUser 部门用户列表
注意:此字段可能返回 null,表示取不到有效值。
示例值:[{"UserId":"0d0a98561b3c4f72963eba5c5fcf56e1","RealName":"张三","UserType":"3","TenantId":"10001","Email":"test@163.com","Phone":"186xxxx234","Status":0,"CreateAt":"1680836659","DepartmentId":"12","DepartmentName":"财务部","LinkFilter":1}]

SsoUser

用户结果

被如下接口引用:DescribeTenantUserList。

名称 类型 描述
UserId String 用户ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:0d0a98561b3c4f72963eba5c5fcf56e1
UserName String 用户昵称
注意:此字段可能返回 null,表示取不到有效值。
示例值:张三
RealName String 用户名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:张三
UserType String 用户类型,1-超级管理员;2-1号管理员;3-普通管理员;99-普通用户
注意:此字段可能返回 null,表示取不到有效值。
示例值:3
TenantId String 所属租户ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:100055
UserGroup String 所属组ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:12
Email String 邮箱
注意:此字段可能返回 null,表示取不到有效值。
示例值:test@163.com
Phone String 电话
注意:此字段可能返回 null,表示取不到有效值。
示例值:18612341234
Status Integer 用户状态,0待审核,1正常启用,2禁用
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
CreateAt Integer 创建时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:1680836659
UpdateAt Integer 更新时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:1680836659
BelongTeam Integer 是否属于团队,0不可用,1属于,2不属
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
DepartmentId String 部门ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:123
DepartmentName String 部门名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:财务部
DepartmentUserId Integer 子账户ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:123
Password String 密码
注意:此字段可能返回 null,表示取不到有效值。
示例值:***

SsoUserResult

租户人员结果

被如下接口引用:DescribeTenantUserList。

名称 类型 描述
Total Integer 总数
注意:此字段可能返回 null,表示取不到有效值。
示例值:28
Users Array of SsoUser 租户人员数据
注意:此字段可能返回 null,表示取不到有效值。

StatDeviceType

设备类型统计

被如下接口引用:DescribeDeviceStatusStat。

名称 类型 描述
Total Integer 汇总数。在线(正常+故障) + 离线
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
Normal Integer 正常数
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
Offline Integer 离线数
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
Fault Integer 故障数
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
Name String 设备名
注意:此字段可能返回 null,表示取不到有效值。
示例值:test
DeviceType String 设备类型
注意:此字段可能返回 null,表示取不到有效值。
示例值:w020202

StatLevel

层级统计

被如下接口引用:DescribeDeviceStatusStat。

名称 类型 描述
Total Integer 汇总数。在线(正常+故障) + 离线
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
NormalSum Integer 正常数
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
OfflineSum Integer 离线数
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
FaultSum Integer 故障数
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
SpaceCode String 空间id
注意:此字段可能返回 null,表示取不到有效值。
示例值:100110
StatDeviceTypeSet Array of StatDeviceType 设备类型统计列表
注意:此字段可能返回 null,表示取不到有效值。
示例值:{"DeviceType":"string","Fault":0,"Name":"string","Offline":0,"Normal":0,"Total":0}

VideoCloudRecordRes

云录像接口结果

被如下接口引用:DescribeVideoCloudRecord。

名称 类型 描述
TotalCount Integer 录像信息总数
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
RecordSet Array of RecordInfo 录像信息列表
注意:此字段可能返回 null,表示取不到有效值。
示例值:{"StartTime":1616466060,"EndTime":1616466098,"VideoURL":"http://1304886180.vod2.myqcloud.com/cac4da69vodcq1304886180/618f1d115285890815878290403/f0.mp4"}

VideoRecordStreamRes

视频流查询结果

被如下接口引用:DescribeVideoLiveStream。

名称 类型 描述
FLV String FLV协议格式视频流
注意:此字段可能返回 null,表示取不到有效值。
示例值:"https://t-video.twins.tencent.com:443/hls1935/76d8109e-64cd-4a85-b011-4a0c29a654e8.flv?ticket=75f35918756c42ee89abde1b5c0c7df2"
RTMP String RTMP协议格式视频流
注意:此字段可能返回 null,表示取不到有效值。
示例值:rtmp://11.141.177.239:8080/hls1935/76d8109e-64cd-4a85-b011-4a0c29a654e8?ticket=fbb63fb0c65c4574835880cf2aa59c55
HLS String HLS协议格式视频流
注意:此字段可能返回 null,表示取不到有效值。
示例值:https://t-video.twins.tencent.com:443/hls1935/76d8109e-64cd-4a85-b011-4a0c29a654e8.m3u8?ticket=39c6e6b59d4545ccb7811155c52d6208
WebRTC String WebRtc协议格式视频流
注意:此字段可能返回 null,表示取不到有效值。
示例值:webrtc://t-video.twins.tencent.com:443/hls1935/76d8109e-64cd-4a85-b011-4a0c29a654e8?ticket=bb3f73b226ae42c1b2ec6cbb2211be2a
RAW RawInfo RAW协议格式视频流
注意:此字段可能返回 null,表示取不到有效值。
示例值:{"IP":"183.47.110.99","InnerIP":"11.141.200.32","NATIP":"","Port":9001,"SM4Vector":"LT50CB5unVXLDjkM","StreamEnKey":"VRK0JsivUkHWon7K","StreamToken":"18c434ba"}
Stream String 视频流的唯一标识
注意:此字段可能返回 null,表示取不到有效值。
示例值:76d8109e-64cd-4a85-b011-4a0c29a654e8

WorkspaceInfo

工作空间信息描述

被如下接口引用:DescribeCityWorkspaceList。

名称 类型 描述
WorkspaceId Integer 工作空间Id
注意:此字段可能返回 null,表示取不到有效值。
示例值:1016
ChineseName String 工作空间中文名字
注意:此字段可能返回 null,表示取不到有效值。
示例值:空间
Description String 工作空间描述
注意:此字段可能返回 null,表示取不到有效值。
示例值:腾讯大厦
Status Integer 工作空间是否删除状态
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
ParkName String 该工作空间绑定的区/县的行政区名字
注意:此字段可能返回 null,表示取不到有效值。
示例值:园区简称
ParkNum String 该工作空间绑定的区/县的行政区编码
注意:此字段可能返回 null,表示取不到有效值。
示例值:001
AdministrativeDetailSet Array of AdministrativeDetail 获取该工作空间绑定的区/县的上级行政区划信息
注意:此字段可能返回 null,表示取不到有效值。
示例值:{ "administTypeCode": "QH01","administCode": "440000","administName": "广东省"}

WorkspaceInfoList

项目空间列表

被如下接口引用:DescribeWorkspaceList。

名称 类型 描述
List Array of SpaceInfo 项目空间列表
注意:此字段可能返回 null,表示取不到有效值。
示例值:[ { "ChineseName": "lv测试空间", "Description": "lv测试空间", "EnglishName": "", "IsCommWorkspace": false, "Status": 0, "TenantId": 100055, "ValidityEndTime": "1744387200", "ValidityStartTime": "1682524800", "WorkspaceId": 1092 }, { "ChineseName": "RayDataWeb", "Description": "RayDataWeb测试使用测完后删除", "EnglishName": "", "IsCommWorkspace": false, "Status": 0, "TenantId": 100055, "ValidityEndTime": "2000390400", "ValidityStartTime": "1684684800", "WorkspaceId": 1166 }, { "ChineseName": "华东项目空间", "Description": "演练项目空间", "EnglishName": "", "IsCommWorkspace": false, "Status": 0, "TenantId": 100055, "ValidityEndTime": "1693411200", "ValidityStartTime": "1682870400", "WorkspaceId": 1175 }, { "ChineseName": "ces", "Description": "123", "EnglishName": "", "IsCommWorkspace": false, "Status": 1, "TenantId": 100055, "ValidityEndTime": "1688400000", "ValidityStartTime": "1688313600", "WorkspaceId": 1524 }, { "ChineseName": "公共空间", "Description": "租户默认工作空间", "EnglishName": "comm_workspace", "IsCommWorkspace": true, "Status": 0, "TenantId": 100055, "ValidityEndTime": "4834882335", "ValidityStartTime": "1681282335", "WorkspaceId": 1015 }, { "ChineseName": "华南园区项目", "Description": "华南园区项目", "EnglishName": "", "IsCommWorkspace": false, "Status": 0, "TenantId": 100055, "ValidityEndTime": "2153664000", "ValidityStartTime": "1680278400", "WorkspaceId": 1016 }, { "ChineseName": "华北园区项目", "Description": "华北园区项目", "EnglishName": "", "IsCommWorkspace": false, "Status": 0, "TenantId": 100055, "ValidityEndTime": "2153664000", "ValidityStartTime": "1680278400", "WorkspaceId": 1018 }, { "ChineseName": "test", "Description": "ceshi", "EnglishName": "", "IsCommWorkspace": false, "Status": 0, "TenantId": 100055, "ValidityEndTime": "1747584000", "ValidityStartTime": "1685289600", "WorkspaceId": 1263 }, { "ChineseName": "report2test", "Description": "report2test", "EnglishName": "", "IsCommWorkspace": false, "Status": 0, "TenantId": 100055, "ValidityEndTime": "2192976000", "ValidityStartTime": "1687795200", "WorkspaceId": 1439 } ]