数据结构

Action

动作信息

被如下接口引用：DescribeLinkRuleList。

名称	类型	描述
Id	Integer	动作id 示例值：1
Name	String	动作名 示例值：name

ActionDetail

详细动作信息

被如下接口引用：DescribeActionList。

名称	类型	描述
Id	Integer	动作id 示例值：22
Name	String	动作名称 示例值：name
ActionType	String	动作类型 示例值：deviceControl
ActionDesc	String	动作说明 示例值：测试控制开灯
MsgType	String	消息类型，orgin/custom/model 示例值：model
MsgContent	String	消息内容,有效值为x-json:后的字段 示例值：msgcontent
CreateTime	String	创建时间 示例值：2023-05-15 16:29:17
WID	String	设备唯一标识 示例值：wid
LinkRuleSet	Array of LinkRule	关联故障列表 示例值：{"Id":1,"Name":"a"}
SinkConfig	String	动作下沉配置,有效值为x-json:后的字段 示例值：x-json:{"nearbySearch":{"deviceType":"w0905001","pid":2000126,"limit":0,"objectLevel":0,"scopeLevel":"","scopeRadius":"","deviceAssign":"deviceType"}}

ActionObj

动作对象

被如下接口引用：DescribeRuleDetail。

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

AddDeviceInfo

添加设备信息

被如下接口引用：BatchCreateDevice。

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

AdministrationData

行政区划数据结构

被如下接口引用：DescribeAdministrationByTag。

名称	类型	描述
AdministrationCode	String	行政区划编码 示例值：110000
AdministrationName	String	行政区划名称 示例值：北京市

AdministrativeDetail

行政区划详情

被如下接口引用：DescribeCityWorkspaceList。

名称	类型	描述
AdministrativeTypeCode	String	行政区域类型编码 示例值：QH03
AdministrativeCode	String	行政区域编码 示例值：440305
AdministrativeName	String	行政区域名称 示例值：南山区

AlarmInfo

告警信息

被如下接口引用：DescribeAlarmList。

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

AlarmLevelInfo

告警级别详情

被如下接口引用：DescribeAlarmLevelList。

名称	类型	描述
LevelId	Integer	级别id 示例值：3
LevelName	String	级别名称 示例值：严重

AlarmStatusData

告警状态返回结构体

被如下接口引用：DescribeAlarmStatusList。

名称	类型	描述
StatusID	String	告警状态ID 示例值：unprocessed
StatusName	String	告警状态名称 示例值：待处理
StatusType	String	告警状态类型 示例值：0

AlarmTypeDetailInfo

告警类型详情信息

被如下接口引用：DescribeAlarmTypeList。

名称	类型	描述
Id	Integer	告警类型id 示例值：26
ParentId	Integer	父节点id 示例值：25
Type	Integer	0-标准告警类型，1-自定义告警类型 示例值：1
Name	String	告警名称类型 示例值：人流数量异常
EnglishName	String	告警类型英文名称 示例值：excessive

AlarmTypeInfo

告警类型

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

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

ApiContent

API参数信息

被如下接口引用：DescribeInterfaceList。

名称	类型	描述
Id	String	所属API的id 示例值：741f3abd-639c-49ad-b9ed-b52a0f08a62e
Name	String	参数名称 示例值：获取视频流
Type	String	参数类型 示例值：string
Dynamic	Boolean	是否为动态值 示例值：true
Required	Boolean	是否必填 示例值：true
Value	String	参数值 示例值：741f3abd-639c-49ad-b9ed-b52a0f08a62e
DefaultValue	String	默认值 示例值：741f3abd-639c-49ad-b9ed-b52a0f08a62e

ApiInfo

API描述

被如下接口引用：DescribeInterfaceList。

名称	类型	描述
ApiId	String	API的id 示例值：741f3abd-639c-49ad-b9ed-b52a0f08a62e
Name	String	API名称 示例值：获取视频流
AppId	String	API所属应用的id 示例值：10001
WorkspaceId	String	API所属的项目空间的id 示例值：1101
PoiCode	String	API所属目录的编码 示例值：api000
Type	Integer	接口分类0. 其他服务 1. IOT服务 2. 空间服务 3.微应用服务 4.场景服务 5.AI算法服务 6.任务算法服务 7.第三方服务 示例值：1
DataAudit	Integer	数据授权 0:否 1:是 示例值：1
ApplyAudit	Integer	是否需要申请 0:否 1:是 示例值：1
Description	String	API详情 示例值：获取视频流
Address	String	API地址 示例值：/video/ControlCameraPtz
Method	String	请求方法类型 示例值：GET
Status	Integer	API状态 示例值：1
PreviewUrl	String	API预览地址 示例值：http://t-apigw.twins.tencent.com/proxy/138c04de-4f1e-4bff-9498-4f16f2ed4cd5/video/ControlCameraPtz
QueryParams	Array of ApiContent	query参数
PathParams	Array of ApiContent	路径参数
RequestHeaders	Array of ApiContent	请求头
ResponseHeaders	Array of ApiContent	响应头
IsCommonSpace	Boolean	是否为公共空间接口 示例值：1
Body	String	请求体（base64编码） 示例值：body
ResponseBody	String	响应体（base64编码） 示例值：responsebody
Style	Integer	接口方式 1.http 2消息通知服务 示例值：1

ApiInfoList

API列表

被如下接口引用：DescribeInterfaceList。

名称	类型	描述
ApiInfo	Array of ApiInfo	API列表
TotalCount	Integer	数据总条数 示例值：10

ApplicationInfo

应用描述

被如下接口引用：DescribeApplicationList。

名称	类型	描述
ApplicationId	String	应用分配的appId 示例值：10001
Name	String	应用中文名 示例值：能源管理
Address	String	应用地址 示例值：http://www.address.com
ApplicationLogo	ApplicationLogo	应用logo 示例值：logo
Type	Integer	应用类型，0:saas应用 1:平台应用 示例值：1
EnglishName	String	engine 示例值：应用英文名
Description	String	能源管理应用 示例值：应用详情

ApplicationList

应用列表

被如下接口引用：DescribeApplicationList。

名称	类型	描述
ApplicationInfoList	Array of ApplicationInfo	应用列表
TotalCount	String	当前查询条件命中的数据总条数 示例值：符合查询条件的数据总条数

ApplicationLogo

应用logo

被如下接口引用：DescribeApplicationList。

名称	类型	描述
FileId	String	logo图片对应的fileId 示例值：d442d82a-ded2-49f1-92e7-81a7f0f45ac6
Url	String	logo图片地址 示例值：https://wetwin-manager-1258344699.cos.ap-guangzhou.myqcloud.com/%2F100055/0/20231030/72f6c306-5819-42dc-98a9-758b4e7892aa

ApplicationTokenInfo

应用Token令牌信息

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

名称	类型	描述
Token	String	应用申请调用API的令牌 示例值：Oq9lShbmhCT3FLnemDCecrXAnAHQe6SJ

BatchCreateDeviceRes

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

被如下接口引用：BatchCreateDevice。

名称	类型	描述
SuccessSet	Array of CreateDeviceSucceeded	新增成功的设备列表 示例值：{"ParentWID": "","ProductId": 2000054,"SN": "atest","WID": "75c83fbd-4862-4c4e-8091-18ccba3e2419"}
FailSet	Array of CreateDeviceFailed	新增失败的设备列表 示例值：{"ParentWID": "","ProductId": 2000054,"SN": "atest","Reason": "xxxx"}

BatchReportAppMessageRes

批量消息上报结果

被如下接口引用：BatchReportAppMessage。

名称	类型	描述
TotalElements	Integer	上报数量 示例值：1
Commit	Integer	提交数量（推送成功） 示例值：1
SpanMap	Array of ReportMsgRes	消息推送结果列表 示例值：{"ReportId": "0000000000000000","ReportStatus": 1}

BuildingListRes

建筑列表响应体

被如下接口引用：DescribeBuildingList。

名称	类型	描述
BuildingProfileList	Array of BuildingProfile	建筑列表 示例值：[ { "Address": "北京市,丰台区样例模型", "BuildingId": "2da7d294-483e-4033-a99a-49f7323fd6ef", "BuildingName": "样例模型1", "Latitude": 39.927326, "Longitude": 116.39177, "SpaceCode": "000009" }]

BuildingModel

建筑模型信息

被如下接口引用：DescribeBuildingModel。

名称	类型	描述
ElementId	String	构件ID 示例值：82d5fb5a-52d0-4636-a225-d46245e911ef
ElementName	String	构件名称 示例值：验证专用
ModelType	String	模型类型 示例值：MODEL_ORIGIN
ModelUrl	String	模型URL 示例值：https://bim-1301743406.cos.ap-guangzhou.myqcloud.com/100055/1016/cb6bad63-0855-4dc2-8908-20518627479b.glb

BuildingModelRes

建模模型信息响应体

被如下接口引用：DescribeBuildingModel。

名称	类型	描述
Models	Array of BuildingModel	建模模型信息出参 示例值：[ { "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" } ]

BuildingProfile

建筑概要信息

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

名称	类型	描述
BuildingId	String	建筑id 示例值：2da7d294-483e-4033-a99a-49f7323fd6ef
BuildingName	String	建筑名称 示例值：样例模型1
SpaceCode	String	空间编码 示例值：000009
Longitude	Float	经度 示例值：116.38269
Latitude	Float	纬度 示例值：39.92442
Address	String	地址 示例值：北京市,丰台区样例地址1#楼

BuildingProfileRes

查询建筑信息响应体

被如下接口引用：DescribeBuildingProfile。

名称	类型	描述
BuildingProfile	BuildingProfile	建筑概要信息 示例值：{ "Address": "广东省,深圳市,南山区测试建筑", "BuildingId": "2e374df6-7ba7-45d2-a44d-2a92bb2a6668", "BuildingName": "测试建筑", "Latitude": 22.533192, "Longitude": 113.93048, "SpaceCode": "000003" }

CameraExtendInfoRes

视频扩展信息结果

被如下接口引用：DescribeCameraExtendInfo。

名称	类型	描述
SaveType	String	存储方式 (nvr或cosmtav) 示例值：nvr
SaveDay	Integer	云存储天数（save_type是cosmtav时这个参数才有效） 示例值：0
LiveResolution	Integer	实时分辨率 示例值：0
HistoryResolution	Integer	历史分辨率 示例值：0

ControlDeviceRes

设备控制结果

被如下接口引用：ControlDevice。

名称	类型	描述
WID	String	设备Id 示例值：70e673c7-11b8-4ca0-b11c-dfa360a44638
Code	Integer	指令接受, 0表示成功 示例值：0
Result	String	控制结果 示例值：success
Seq	String	批量大于1时，可用此seq进行链路追踪 示例值：21909094-b304-4942-af6a-eb781ddd0a2a

ControlDeviceSet

设备控制后返回结果集合

被如下接口引用：ControlDevice。

名称	类型	描述
Set	Array of ControlDeviceRes	设备控制后返回结果集合 示例值：{"Code": 0,"Result": "success","Seq": "21909094-b304-4942-af6a-eb781ddd0a2a","WID": "70e673c7-11b8-4ca0-b11c-dfa360a44638"}

CreateDeviceFailed

导入失败设备信息

被如下接口引用：BatchCreateDevice。

名称	类型	描述
ProductId	Integer	产品id 示例值：200022
ParentWID	String	父设备wid，不为空表示导入自设备 示例值：xxx-aaaa
Reason	String	失败原因 示例值：atest
SN	String	设备sn序列号 示例值：atest

CreateDeviceSucceeded

导入成功设备信息

被如下接口引用：BatchCreateDevice。

名称	类型	描述
ProductId	Integer	产品id 示例值：200200
ParentWID	String	父设备wid，不为空表示导入自设备 示例值：xxx-aaa
WID	String	设备编码 示例值：75c83fbd-4862-4c4e-8091-18ccba3e2419
SN	String	设备sn序列号 示例值：atest

CustomField

自定义字段

被如下接口引用：DescribeDeviceList。

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

CustomFieldInfo

自定义字段

被如下接口引用：DescribeDeviceList。

名称	类型	描述
Id	Integer	字段id 示例值：1
Key	String	字段key 示例值：color
Name	String	字段名 示例值：颜色
Val	String	字段值 示例值：yellow

DescribeActionListRes

动作列表查询结果

被如下接口引用：DescribeActionList。

名称	类型	描述
PageNumber	Integer	第几页 示例值：1
PageSize	Integer	每页条数 示例值：1
TotalPage	Integer	总页数 示例值：2
TotalRow	Integer	总条数 示例值：2
ActionDetailSet	Array of ActionDetail	动作列表查询集合

DescribeAdministrationByTagRes

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

被如下接口引用：DescribeAdministrationByTag。

名称	类型	描述
List	Array of AdministrationData	行政区划列表

DescribeAlarmLevelListRes

告警级别枚举获取

被如下接口引用：DescribeAlarmLevelList。

名称	类型	描述
AlarmLevelSet	Array of AlarmLevelInfo	告警级别枚举获取数组 示例值：{"LevelId": 3,"LevelName": "严重"}

DescribeAlarmListRes

告警列表回包

被如下接口引用：DescribeAlarmList。

名称	类型	描述
PageNumber	Integer	第几页 示例值：1
PageSize	Integer	每页条数 示例值：1
TotalPage	Integer	总页数 示例值：2
TotalRow	Integer	总条数 示例值：20
AlarmInfoSet	Array of AlarmInfo	告警列表集合

DescribeAlarmStatusListRes

告警状态列表返回

被如下接口引用：DescribeAlarmStatusList。

名称	类型	描述
List	Array of AlarmStatusData	告警状态返回结构

DescribeAlarmTypeListRes

告警类型列表回包

被如下接口引用：DescribeAlarmTypeList。

名称	类型	描述
AlarmTypeSet	Array of AlarmTypeDetailInfo	告警类型查询列表 示例值：{"EnglishName": "excessive","Id": 26,"Name": "人流数量异常","ParentId": 25,"Type": 1}

DescribeCityWorkspaceListRes

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

被如下接口引用：DescribeCityWorkspaceList。

名称	类型	描述
WorkspaceSet	Array of WorkspaceInfo	通过城市id查询工作空间列表结果 示例值：{"workspaceId": 1016,"nameCh": "华南园区项目","description": "华南园区项目","status": 0,"parkName": "园区简称","parkNum": "001","administDetail":{}}

DescribeDeviceGroupListRes

设备分组信息

被如下接口引用：DescribeDeviceGroupList。

名称	类型	必选	描述
List	Array of DescribeGroupInfo	否	设备分组list

DescribeDeviceListRes

设备列表查询结果

被如下接口引用：DescribeDeviceList。

名称	类型	描述
PageNumber	Integer	第几页 示例值：1
PageSize	Integer	每页条数 示例值：1
TotalPage	Integer	总页数 示例值：2
TotalRow	Integer	总条数 示例值：20
DeviceDataSet	Array of DeviceDataInfo	设备信息集合

DescribeEventListRes

事件列表查询结果

被如下接口引用：DescribeEventList。

名称	类型	描述
PageNumber	Integer	第几页 示例值：1
PageSize	Integer	每页条数 示例值：1
TotalPage	Integer	总页数 示例值：2
TotalRow	Integer	总条数 示例值：2
EventDetailSet	Array of EventDetail	事件信息列表 示例值：{"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	否	分组描述 示例值：分组描述
ParentId	Integer	否	分组父级ID 示例值：1

DescribeLinkRuleListRes

联动规则列表查询结果

被如下接口引用：DescribeLinkRuleList。

名称	类型	描述
PageNumber	Integer	第几页 示例值：1
PageSize	Integer	每页条数 示例值：1
TotalPage	Integer	总页数 示例值：2
TotalRow	Integer	总条数 示例值：2
LinkRuleSet	Array of LinkRuleInfo	联动规则列表 示例值：{"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 示例值：1c902558-d360-4a93-9b6f-1b49970534f7中文标签测试
DeviceName	String	设备名称 示例值：1c902558-d360-4a93-9b6f-1b49970534f7
DeviceTypeCode	String	设备类型Id 示例值：1c902558-d360-4a93-9b6f-1b49970534f7
DeviceTypeName	String	设备类型名称 示例值：1c902558-d360-4a93-9b6f-1b49970534f7
ProductId	Integer	产品Id 示例值：2000053
ProductName	String	产品名称 示例值：其它网关
ProductAbility	Integer	产品能力:信令数据、音视频。二进制数值中第0位表示信令数据、第1位表示音视频 。1（信令数据），3（具有信令数据以及音视频能力）。 示例值：1
SpaceInfoSet	Array of DeviceSpaceInfo	设备位置信息 示例值：{"Code": "001234","Id": "7e0eba7e-aa9b-43bd-8a68-2ea7153828de","Level": 6,"Name": "验证专用"}
ModelId	String	模型id 示例值：1232
ModelName	String	模型名称 示例值：modelname
DeviceTagSet	Array of String	设备标签名，非必填 示例值：中文标签测试
IsActive	Integer	激活状态（1激活、0未激活） 示例值：1
ActiveTime	String	激活时间 示例值：2023-04-13T09:41:38+08:00
IsLive	Boolean	推流状态（推流中、未推流） 仅摄像机有的状态 示例值：false
ParentWID	String	设备所属父设备id（子设备才有） 示例值：parentwid
ParentWIDName	String	设备所有父设备名称（子设备才有） 示例值：parentwidname
SN	String	序列号 示例值：tony001
Location	DeviceLocation	设备点位坐标值 示例值：{"X": -197697.515625,"Y": 22156.90234375,"Z": 0}
FieldList	Array of CustomFieldInfo	自定义字段 示例值：{"Id": 1,"Key": "color","Name": "颜色","Val": ""}
GroupInfo	String	分组信息 示例值：xx/xx/xx
DeviceStatus	String	通信在/离线状态（online=normal+fault，offline） 示例值：online
Status	String	设备业务状态（normal、fault、offline） 示例值：normal

DeviceLocation

设备点位坐标值

被如下接口引用：DescribeDeviceList。

名称	类型	描述
X	Float	点位X坐标值 示例值：-197697.515625
Y	Float	点位Y坐标值 示例值：-197697.515625
Z	Float	点位Z坐标值 示例值：0

DeviceModifyInfo

设备修改信息入参

被如下接口引用：ModifyDeviceName。

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

DeviceShadowInfo

设备影子信息

被如下接口引用：DescribeDeviceShadowList。

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

DeviceShadowRes

设备影子查询列表

被如下接口引用：DescribeDeviceShadowList。

名称	类型	描述
PageNumber	Integer	第几页 示例值：1
PageSize	Integer	每页条数 示例值：5
TotalPage	Integer	总页数 示例值：2
TotalRow	Integer	总条数 示例值：10
Set	Array of DeviceShadowInfo	设备影子列表

DeviceSpaceInfo

设备位置信息

被如下接口引用：DescribeDeviceList。

名称	类型	描述
Id	String	空间Id 示例值：7e0eba7e-aa9b-43bd-8a68-2ea7153828de
Name	String	空间名字 示例值：验证专用
Level	Integer	空间级别 示例值：5
Code	String	空间编码 示例值：001234

DeviceSpaceInfoRes

设备挂接的空间信息

被如下接口引用：DescribeSpaceInfoByDeviceId。

名称	类型	描述
BuildingId	String	建筑id 示例值：82d5fb5a-52d0-4636-a225-d46245e911ef
ElementId	String	构件id 示例值：8a74aba0-46e3-4097-89e6-7adbeb9ccaef
EntityType	String	构件类型 示例值：TBIM_CAMERA
ElementName	String	构件名称 示例值：1232533半球摄像头
Level	Integer	构件级别 示例值：9
BottomHeight	Integer	底部标高（单位mm） 示例值：3000
SpaceCode	String	空间编码 示例值：00003000300000008

DeviceStatusInfo

设备状态信息

被如下接口引用：DescribeDeviceStatusList。

名称	类型	描述
WID	String	设备ID 示例值：be2ea997-b7f4-4167-9545-9aa275158a92
DeviceStatus	String	设备状态（online=normal+fault、offline） 示例值：online
DeviceStatusUpdateTime	String	设备状态更新时间 示例值：2023-08-31 00:57:28
Status	String	设备业务状态（normal、fault、offline） 示例值：normal
IsAlive	Boolean	推流状态。推流中-true，未推流-false 示例值：true

DeviceStatusRes

设备状态获取接口结果

被如下接口引用：DescribeDeviceStatusList。

名称	类型	描述
PageNumber	Integer	第几页 示例值：1
PageSize	Integer	每页条数 示例值：10
TotalPage	Integer	总页数 示例值：2
TotalRow	Integer	总条数 示例值：20
DeviceStatusSet	Array of DeviceStatusInfo	设备状态信息列表 示例值：{"DeviceStatus": "online","DeviceStatusUpdateTime": "2023-08-31 00:57:28","IsAlive": true,"Status": "normal","WID": "be2ea997-b7f4-4167-9545-9aa275158a92"}

DeviceStatusStatRes

设备状态统计结果

被如下接口引用：DescribeDeviceStatusStat。

名称	类型	描述
WorkspaceId	Integer	工作空间Id 示例值：1016
Total	Integer	汇总数。在线（正常+故障） + 离线 示例值：8791
NormalSum	Integer	正常数 示例值：87
OfflineSum	Integer	离线数 示例值：8689
FaultSum	Integer	故障数 示例值：15
DeviceTypeOverviewSet	Array of DeviceTypeOverview	设备类型概览列表 示例值：{"DeviceType":"string","Fault":0,"Name":"string","Offline":0,"Normal":0,"Total":0}
StatLevelSet	Array of StatLevel	设备类型统计列表 示例值：{"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 示例值：35
TagName	String	标签名字 示例值：西安真实摄像头

DeviceTagRes

设备标签列表查询结果

被如下接口引用：DescribeDeviceTagList。

名称	类型	描述
PageNumber	Integer	第几页 示例值：1
PageSize	Integer	每页条数 示例值：20
TotalPage	Integer	总页数 示例值：2
TotalRow	Integer	总条数 示例值：40
Set	Array of DeviceTagInfo	设备标签列表 示例值：{"TagId": 35,"TagName": "西安真实摄像头"}

DeviceType

设备类型

被如下接口引用：DescribeDeviceTypeList。

名称	类型	描述
Code	String	设备类型编码 示例值：w0301006
Name	String	设备类型名称 示例值：烟感报警器
ParentCode	String	父设备类型编码 示例值：0301
ParentName	String	父设备类型名称 示例值：火灾自动报警及联动系统
IsSubsystem	Integer	是否子系统，1是 示例值：0

DeviceTypeOverview

设备类型概览信息

被如下接口引用：DescribeDeviceStatusStat。

名称	类型	描述
DeviceType	String	设备类型值 示例值：w02002
Name	String	设备类型名称 示例值：atest
Total	Integer	汇总数。在线（正常+故障） + 离线 示例值：0
Normal	Integer	正常数 示例值：0
Offline	Integer	离线数 示例值：0
Fault	Integer	故障数 示例值：0

DeviceTypeSet

设备类型列表

被如下接口引用：DescribeDeviceTypeList。

名称	类型	描述
Set	Array of DeviceType	设备类型列表 示例值：{"Code": "w0301006","IsSubsystem": 0,"Name": "烟感报警器","ParentCode": "0301","ParentName": "火灾自动报警及联动系统"}

ElementCoordinates

构件地理坐标

被如下接口引用：DescribePropertyList。

名称	类型	描述
Longitude	Float	经度 示例值：117.25139600000003
Latitude	Float	纬度 示例值：39.12852507853361
Altitude	Float	高程 示例值：0

ElementProfile

构件概要信息

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

名称	类型	描述
BuildingId	String	建筑id 示例值：82d5fb5a-52d0-4636-a225-d46245e911ef
ElementId	String	构件id 示例值：61049c1b-158d-41bd-9f0b-df30a50401bd
EntityType	String	构件类型 示例值：TBIM_BUILDINGSTOREY
ElementName	String	构件名称 示例值：RF
Level	Integer	构件空间级别 示例值：7
BottomHeight	Integer	底部标高（单位mm） 示例值：3000
Sort	Integer	排序 示例值：1
SpaceCode	String	空间编码 示例值：000030003
SpaceTypeCode	String	空间分类编码 示例值：spacetypecode
SpaceTypeName	String	空间分类名称 示例值：spacetypename
ParentElementId	String	父级构件id 示例值：82d5fb5a-52d0-4636-a225-d46245e911ef
SpacePoiId	String	空间层级类型编码 示例值：spacepoiid
ElementDesc	String	构件描述 示例值：elementdesc
IsDelete	Integer	删除标记 示例值：0

ElementProfilePageRes

构件分页查询响应体

被如下接口引用：DescribeElementProfilePage。

名称	类型	描述
TotalCount	Integer	构件总数 示例值：1
List	Array of ElementProfile	构件列表

ElementProfileTreeNode

构件树节点信息

被如下接口引用：DescribeElementProfileTree。

名称	类型	描述
ElementProfile	ElementProfile	构件概要信息
Children	Array of ElementProfileTreeNode	子节点信息

ElementProfileTreeRes

构件树响应体

被如下接口引用：DescribeElementProfileTree。

名称	类型	描述
BuildingId	String	建筑id 示例值：82d5fb5a-52d0-4636-a225-d46245e911ef
ParentElementId	String	父级构件id 示例值：61049c1b-158d-41bd-9f0b-df30a50401bd
Root	ElementProfileTreeNode	构件树

ElementProperty

构件属性信息

被如下接口引用：DescribePropertyList。

名称	类型	描述
Name	String	属性名称 示例值：Materials and Finishes
Description	String	属性描述 示例值：description
Content	String	属性内容 示例值：{Material=None}

ElementPropertyRes

构件属性信息响应体

被如下接口引用：DescribePropertyList。

名称	类型	描述
BuildingId	String	建筑id 示例值："377e4f9d-d20e-4209-b1e8-0ddb32e888c8"
ElementId	String	构件id 示例值："b66aece1-62e9-49d3-872e-6e66156a853b"
PropertySet	Array of ElementProperty	构件属性集合
Coordinates	ElementCoordinates	构件地理坐标 示例值：{ "Altitude": 0, "Latitude": 39.12852507853361, "Longitude": 117.25139600000003 }
Translate	ElementTranslate	构件偏移量 示例值：{ "X": 0, "Y": 0, "Z": 0 }
ElementName	String	构件名称 示例值："Level : F4"
EntityTypeCode	String	构件类型代码 示例值："TBIM_BUILDINGSTOREY"
EntityTypeName	String	构件类型名称 示例值："楼层"

ElementTranslate

构件平移信息

被如下接口引用：DescribePropertyList。

名称	类型	描述
X	Float	X方向偏移量 示例值：0
Y	Float	Y方向偏移量 示例值：0
Z	Float	Z方向偏移量 示例值：0

EmptyRes

空结果返回

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

名称	类型	描述
Msg	String	返回请求状态,成功ok，失败error 示例值：ok

Event

事件信息

被如下接口引用：DescribeLinkRuleList。

名称	类型	描述
Id	Integer	事件id或动作Id 示例值：24
Name	String	事件名称或动作名称 示例值：name

EventDetail

事件详细信息

被如下接口引用：DescribeEventList。

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

EventObj

事件对象

被如下接口引用：DescribeRuleDetail。

名称	类型	描述
Id	Integer	事件id 示例值：36
Name	String	事件名称 示例值：具体设备
Type	String	事件触发类型名称 示例值：device
Condition	String	时间触发条件 示例值：condition

FileDownloadURL

文件下载URL

被如下接口引用：DescribeFileDownloadURL。

名称	类型	描述
FileURL	String	下载地址 示例值：https://xxx.xxx

FileInfo

文件信息

被如下接口引用：DescribeAlarmList。

名称	类型	描述
FileId	String	文件id 示例值：192
ReportName	String	名称 示例值：reportname

FileUploadURL

获取文件上传URL接口回包

被如下接口引用：DescribeFileUploadURL。

名称	类型	描述
UploadURL	String	上传地址 示例值：http://xxx.xxx
FileId	String	文件Id 示例值：fileid
DownloadURL	String	下载地址 示例值：http://xxx.xxx

HandleRecordInfo

告警处理记录

被如下接口引用：DescribeAlarmList。

名称	类型	描述
Id	Integer	告警处理记录id 示例值：30293
Description	String	描述 示例值：description
Name	String	名称 示例值：name
OperationType	String	操作类型 示例值：消警
Time	String	处理时间 示例值：1693416991
Type	String	类型 示例值：rule_alarm_elimination
FileSet	Array of FileInfo	文件列表 示例值：{"Id":123,"Name":"a"}
AppId	Integer	应用appid 示例值：0
ExtendOne	String	扩展字段1，存非孪生中台用户id 示例值：x-json:xxx

HandlerPersonInfo

告警处理人列表

被如下接口引用：DescribeAlarmList。

名称	类型	描述
Id	String	用户id 示例值：12
Name	String	用户名 示例值：name

LinkRule

关联规则信息

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

名称	类型	描述
Id	Integer	关联联动规则id 示例值：23
Name	String	关联联动规则名字 示例值：name

LinkRuleInfo

联动规则信息

被如下接口引用：DescribeLinkRuleList。

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

MessageProfile

上报消息概要

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

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

ModelInfo

模型基础信息

被如下接口引用：DescribeModelList。

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

ModelSet

模型列表查询结果

被如下接口引用：DescribeModelList。

名称	类型	描述
PageNumber	Integer	第几页 示例值：1
PageSize	Integer	每页条数 示例值：1
TotalPage	Integer	总页数 示例值：2
TotalRow	Integer	总条数 示例值：2
Set	Array of ModelInfo	模型基础信息

ModifyDeviceFieldInfo

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

被如下接口引用：ModifyDeviceField。

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

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	否	处理描述信息 示例值：processdesc
AttachedFileId	String	否	附加文件标识 示例值：[{"fileId":"b87ae7ec-6874-4103-bfa0-2489374476eb","fileName":"ecs.png"}]

ProductInfo

产品信息

被如下接口引用：DescribeProductList。

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

ProductSet

产品列表查询结果

被如下接口引用：DescribeProductList。

名称	类型	描述
PageNumber	Integer	第几页 示例值：1
PageSize	Integer	每页条数 示例值：20
TotalPage	Integer	总页数 示例值：3
TotalRow	Integer	总条数 示例值：100
Product	Array of ProductInfo	产品信息列表

RawInfo

视频流Raw协议信息

被如下接口引用：DescribeVideoLiveStream。

名称	类型	描述
SM4Vector	String	加密向量（如果视频网关选择流为非加密传输这个参数可忽略） 示例值：LT50CB5unVXLDjkM
NATIP	String	专线ip (非专线接入可忽略) 示例值：1.47.110.0
StreamToken	String	客户端握手鉴权参数 示例值：18c434ca
Port	Integer	拉流端口 示例值：9001
StreamEnKey	String	视频流加密key,目前为AES128加密KEY（如果视频网关选择流为非加密传输这个参数可忽略） 示例值：VRK0JsivUkHWon7K
IP	String	拉流公网地址（非公网接入时，这个地址是内网地址） 示例值：185.47.110.0
InnerIP	String	拉流内网地址 示例值：11.121.500.32

RecordInfo

录像信息

被如下接口引用：DescribeVideoCloudRecord。

名称	类型	描述
StartTime	Integer	本录像片段开始时间（s） 示例值：1616466060
EndTime	Integer	本录像片段结束时间（s） 示例值：1616466098
VideoURL	String	录像片段文件url 示例值：http://1304886180.vod2.myqcloud.com/cac4da69vodcq1304886180/618f1d115285890815878290403/f0.mp4

RelatedProduct

关联产品信息

被如下接口引用：DescribeModelList。

名称	类型	描述
Id	Integer	关联产品pid 示例值：2000055
Name	String	关联产品名字 示例值：边缘温控器

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	类型 示例值：4
Data	String	数据 示例值：testurl

ReportMsgRes

上报消息结果

被如下接口引用：BatchReportAppMessage。

名称	类型	描述
ReportId	String	上报消息对应下标的16位标识Id, 即第几个消息 示例值：0000000000000000
ReportStatus	Integer	上报消息结果，1表示成功推送，0表示推送失败 示例值：1

RuleDetailRes

规则详情查询结果

被如下接口引用：DescribeRuleDetail。

名称	类型	描述
RuleId	Integer	联动id 示例值：29
RuleName	String	联动名称 示例值：联动同一建筑332
RuleDesc	String	联动说明 示例值：联动同一建筑
ValidType	Integer	1 全天有效，0：固定时间段有效 示例值：1
ValidPeriod	String	有效期，json字符串（全天有效时为空） 示例值：x-json:xxxx
BeginDate	String	起始时间 示例值：2023-8-22
EndDate	String	结束时间 示例值：2023-8-24
Status	Integer	启用状态。1-启用，0-停用 示例值：0
EventRule	String	触发规则，事件的组合 示例值：26
EventInfoSet	Array of EventObj	事件对象集合
ActionInfoSet	Array of ActionObj	动作对象集合

SaveDeviceGroupRes

保存or修改设备分组回包

被如下接口引用：SaveDeviceGroup。

名称	类型	描述
Id	Integer	保存or修改设备分组回包信息 示例值：1

SceneInfo

场景信息

被如下接口引用：DescribeSceneList。

名称	类型	描述
SceneId	String	场景id 示例值：0abe73dd-d06f-44f5-af82-43dea23af230
SceneName	String	场景名称 示例值：三层商务办公楼单位修正
Version	String	场景版本 示例值：20230705160410780

SceneListRes

场景列表响应体

被如下接口引用：DescribeSceneList。

名称	类型	描述
SceneList	Array of SceneInfo	场景列表

SpaceDataListStatsRes

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

被如下接口引用：DescribeWorkSpaceBuildingCountAndArea。

名称	类型	描述
List	Array of SpaceDataStats	楼栋数量与建筑面积列表

SpaceDataStats

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

被如下接口引用：DescribeWorkSpaceBuildingCountAndArea。

名称	类型	描述
WorkspaceId	String	工作空间ID 示例值：1016
WorkspaceName	String	工作空间名称 示例值：华南园区项目
BuildingCount	Integer	楼栋数量 示例值：127
BuildingArea	Float	建筑面积 示例值：202928.77732501808

SpaceDataTotalStatsRes

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

被如下接口引用：DescribeTenantBuildingCountAndArea。

名称	类型	描述
BuildingCount	Integer	总楼栋数量 示例值：137
BuildingArea	Float	总建筑面积 示例值：202928.77732501808

SpaceDeviceIdListRes

查询指定空间id列表响应

被如下接口引用：DescribeSpaceDeviceIdList。

名称	类型	描述
DeviceIds	Array of String	设备id列表 示例值： [ "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 示例值：1c902558-d360-4a93-9b6f-1b49970534f7
ElementId	String	构件id 示例值：8a74aba0-46e3-4097-89e6-7adbeb9ccaef

SpaceDeviceRelationRes

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

被如下接口引用：DescribeSpaceDeviceRelationList。

名称	类型	描述
SpaceDeviceRelationList	Array of SpaceDeviceRelation	设备空间绑定关系列表 示例值：[ { "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 示例值：1101
TenantId	Integer	租户id 示例值：100000
EnglishName	String	英文名 示例值：testspace
ChineseName	String	中文名 示例值：华南项目空间
Description	String	项目空间描述 示例值：华南项目空间
Status	Integer	项目空间状态:0 启用 1 停用 -1 已删除 示例值：1
IsCommWorkspace	Boolean	是否是公共空间 示例值：true
ValidityStartTime	String	有效期开始时间 示例值：1693193293
ValidityEndTime	String	有效期结束时间 示例值：1693193293
Selected	Integer	选中状态 示例值：1
IsSystem	Integer	系统生成状态 示例值：1

SpaceRelation

空间层级关系

被如下接口引用：DescribeSpaceRelationByDeviceId。

名称	类型	描述
ElementId	String	构件id 示例值：bdbbf537-d6c4-4b1e-80ae-e0bcaab8b06f
ElementName	String	构件名称 示例值：test_no_100
Level	Integer	空间层级 示例值：9
SpaceCode	String	空间编码 示例值：00016200200000003
ParentSpaceCode	String	父级空间编码 示例值：000162002
Children	Array of SpaceRelation	子构件信息

SpaceRelationRes

空间层级关系响应体

被如下接口引用：DescribeSpaceRelationByDeviceId。

名称	类型	描述
SpaceRelation	SpaceRelation	空间层级关系

SpaceType

空间分类

被如下接口引用：DescribeSpaceTypeList。

名称	类型	描述
SpaceTypeCode	String	空间分类编码 示例值：DIANTIJIAN
SpaceTypeName	String	空间分类名称 示例值：电梯间

SpaceTypeListRes

空间分类列表响应体

被如下接口引用：DescribeSpaceTypeList。

名称	类型	描述
SpaceTypeList	Array of SpaceType	空间分类列表

SsoDepartment

部门用户

被如下接口引用：DescribeTenantDepartmentList。

名称	类型	描述
DepartmentId	String	部门ID 示例值：21
Name	String	部门名称 示例值：财务部
ParentDepartmentId	String	父级部门ID 示例值：9

SsoDepartmentsResult

部门用户结果

被如下接口引用：DescribeTenantDepartmentList。

名称	类型	描述
Total	Integer	总数 示例值：1
Departments	Array of SsoDepartment	部门列表 示例值：[{"DepartmentId":"21","Name":"财务部","ParentDepartmentId":"9"},{"DepartmentId":"22","Name":"商务部","ParentDepartmentId":"10"}]

SsoTeamUser

部门用户

被如下接口引用：DescribeWorkspaceUserList。

名称	类型	描述
UserId	String	用户ID 示例值：0d0a98561b3c4f72963eba5c5fcf56e1
RealName	String	用户名称 示例值：张三
UserType	String	用户类型，1-超级管理员；2-1号管理员；3-普通管理员；99-普通用户 示例值：3
TenantId	String	所属租户ID 示例值：10001
Email	String	邮箱 示例值：test@163.com
Phone	String	电话 示例值：186xxxx234
Status	Integer	用户状态 示例值：用户状态，0待审核，1正常启用，2禁用
CreateAt	Integer	创建时间 示例值：1680836659
DepartmentId	String	部门ID 示例值：12
DepartmentName	String	部门名称 示例值：财务部
LinkFilter	Integer	是否关联权限 示例值：1

SsoTeamUserResult

空间用户结果

被如下接口引用：DescribeWorkspaceUserList。

名称	类型	描述
Total	Integer	总数 示例值：1
Users	Array of SsoTeamUser	部门用户列表 示例值：[{"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 示例值：0d0a98561b3c4f72963eba5c5fcf56e1
UserName	String	用户昵称 示例值：张三
RealName	String	用户名称 示例值：张三
UserType	String	用户类型，1-超级管理员；2-1号管理员；3-普通管理员；99-普通用户 示例值：3
TenantId	String	所属租户ID 示例值：100055
UserGroup	String	所属组ID 示例值：12
Email	String	邮箱 示例值：test@163.com
Phone	String	电话 示例值：18612341234
Status	Integer	用户状态，0待审核，1正常启用，2禁用 示例值：1
CreateAt	Integer	创建时间 示例值：1680836659
UpdateAt	Integer	更新时间 示例值：1680836659
BelongTeam	Integer	是否属于团队，0不可用，1属于，2不属 示例值：1
DepartmentId	String	部门ID 示例值：departmentid
DepartmentName	String	部门名称 示例值：财务部
DepartmentUserId	Integer	子账户ID 示例值：100011
Password	String	密码 示例值：***

SsoUserResult

租户人员结果

被如下接口引用：DescribeTenantUserList。

名称	类型	描述
Total	Integer	总数 示例值：28
Users	Array of SsoUser	租户人员数据

StatDeviceType

设备类型统计

被如下接口引用：DescribeDeviceStatusStat。

名称	类型	描述
Total	Integer	汇总数。在线（正常+故障） + 离线 示例值：0
Normal	Integer	正常数 示例值：0
Offline	Integer	离线数 示例值：0
Fault	Integer	故障数 示例值：0
Name	String	设备名 示例值：name
DeviceType	String	设备类型 示例值：w020202

StatLevel

层级统计

被如下接口引用：DescribeDeviceStatusStat。

名称	类型	描述
Total	Integer	汇总数。在线（正常+故障） + 离线 示例值：0
NormalSum	Integer	正常数 示例值：0
OfflineSum	Integer	离线数 示例值：0
FaultSum	Integer	故障数 示例值：0
SpaceCode	String	空间id 示例值：100110
StatDeviceTypeSet	Array of StatDeviceType	设备类型统计列表 示例值：{"DeviceType":"string","Fault":0,"Name":"string","Offline":0,"Normal":0,"Total":0}

VideoCloudRecordRes

云录像接口结果

被如下接口引用：DescribeVideoCloudRecord。

名称	类型	描述
TotalCount	Integer	录像信息总数 示例值：1
RecordSet	Array of RecordInfo	录像信息列表 示例值：{"StartTime":1616466060,"EndTime":1616466098,"VideoURL":"http://1304886180.vod2.myqcloud.com/cac4da69vodcq1304886180/618f1d115285890815878290403/f0.mp4"}

VideoRecordStreamRes

视频流查询结果

被如下接口引用：DescribeVideoLiveStream。

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

WorkspaceInfo

工作空间信息描述

被如下接口引用：DescribeCityWorkspaceList。

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

WorkspaceInfoList

项目空间列表

被如下接口引用：DescribeWorkspaceList。

名称	类型	描述
List	Array of SpaceInfo	项目空间列表