UNPKG

@nocobase/plugin-verification

Version:

User identity verification management, including SMS, TOTP authenticator, with extensibility.

3,086 lines (3,078 loc) 125 kB
/** * DescribeWorkSpaceBuildingCountAndArea请求参数结构体 */ export interface DescribeWorkSpaceBuildingCountAndAreaRequest { /** * 工作空间ID列表 */ WorkspaceIdList: Array<string>; /** * 应用token */ ApplicationToken: string; } /** * 应用列表 */ export interface ApplicationList { /** * 应用列表 注意:此字段可能返回 null,表示取不到有效值。 */ ApplicationInfoList?: Array<ApplicationInfo>; /** * 当前查询条件命中的数据总条数 注意:此字段可能返回 null,表示取不到有效值。 */ TotalCount?: string; } /** * 模型基础信息 */ export interface ModelInfo { /** * 工作空间id 注意:此字段可能返回 null,表示取不到有效值。 */ WorkspaceId?: number; /** * 模型名称 注意:此字段可能返回 null,表示取不到有效值。 */ ModelName?: string; /** * 物模型id 注意:此字段可能返回 null,表示取不到有效值。 */ ModelId?: string; /** * 关联产品信息 注意:此字段可能返回 null,表示取不到有效值。 */ RelatedProduct?: Array<RelatedProduct>; /** * 设备类型名 注意:此字段可能返回 null,表示取不到有效值。 */ DeviceTypeName?: string; /** * 设备类型id 注意:此字段可能返回 null,表示取不到有效值。 */ DeviceType?: string; /** * 物模型类型,产品模型/标准模型 注意:此字段可能返回 null,表示取不到有效值。 */ ModelType?: number; /** * 模型参数内容,有效字段为"x-json:"后的字段 注意:此字段可能返回 null,表示取不到有效值。 */ ModelParams?: string; } /** * 告警信息 */ export interface AlarmInfo { /** * 工作空间id 注意:此字段可能返回 null,表示取不到有效值。 */ WorkspaceId?: number; /** * 告警ID 注意:此字段可能返回 null,表示取不到有效值。 */ Id?: string; /** * 告警状态 注意:此字段可能返回 null,表示取不到有效值。 */ Status?: string; /** * 告警时间 注意:此字段可能返回 null,表示取不到有效值。 */ Time?: number; /** * 告警业务类型 注意:此字段可能返回 null,表示取不到有效值。 */ Type?: string; /** * 告警业务类型名称 注意:此字段可能返回 null,表示取不到有效值。 */ TypeName?: string; /** * 子告警类型 注意:此字段可能返回 null,表示取不到有效值。 */ SubType?: string; /** * 子告警类型名称 注意:此字段可能返回 null,表示取不到有效值。 */ SubTypeName?: string; /** * 告警级别id 注意:此字段可能返回 null,表示取不到有效值。 */ Level?: number; /** * 告警级别名称 注意:此字段可能返回 null,表示取不到有效值。 */ LevelName?: string; /** * 上报应用appid 注意:此字段可能返回 null,表示取不到有效值。 */ AppId?: number; /** * 设备wid 注意:此字段可能返回 null,表示取不到有效值。 */ WID?: string; /** * 设备名称 注意:此字段可能返回 null,表示取不到有效值。 */ DeviceName?: string; /** * 空间位置 注意:此字段可能返回 null,表示取不到有效值。 */ Position?: string; /** * 上报图片 注意:此字段可能返回 null,表示取不到有效值。 */ ReportImg?: ReportImg; /** * 告警描述 注意:此字段可能返回 null,表示取不到有效值。 */ Desc?: string; /** * 处理人 注意:此字段可能返回 null,表示取不到有效值。 */ HandlePersonSet?: Array<HandlerPersonInfo>; /** * 处理记录 注意:此字段可能返回 null,表示取不到有效值。 */ HandleRecordSet?: Array<HandleRecordInfo>; /** * 扩展信息 注意:此字段可能返回 null,表示取不到有效值。 */ Extend?: string; /** * 应用扩展字段1 注意:此字段可能返回 null,表示取不到有效值。 */ ExtendOne?: string; /** * 应用扩展字段2 注意:此字段可能返回 null,表示取不到有效值。 */ ExtendTwo?: string; /** * 应用透传字段,有效字段为x-json后的字段 注意:此字段可能返回 null,表示取不到有效值。 */ Echo?: string; } /** * 设备数据信息 */ export interface DeviceDataInfo { /** * 设备ID, wid 注意:此字段可能返回 null,表示取不到有效值。 */ WID?: string; /** * 设备名称 注意:此字段可能返回 null,表示取不到有效值。 */ DeviceName?: string; /** * 设备类型Id 注意:此字段可能返回 null,表示取不到有效值。 */ DeviceTypeCode?: string; /** * 设备类型名称 注意:此字段可能返回 null,表示取不到有效值。 */ DeviceTypeName?: string; /** * 产品Id 注意:此字段可能返回 null,表示取不到有效值。 */ ProductId?: number; /** * 产品名称 注意:此字段可能返回 null,表示取不到有效值。 */ ProductName?: string; /** * 产品能力:信令数据、音视频。第0位表示信令数据、第1表示音视频 ,默认为1(信令数据) 注意:此字段可能返回 null,表示取不到有效值。 */ ProductAbility?: number; /** * 设备位置信息 注意:此字段可能返回 null,表示取不到有效值。 */ SpaceInfoSet?: Array<DeviceSpaceInfo>; /** * 模型id 注意:此字段可能返回 null,表示取不到有效值。 */ ModelId?: string; /** * 模型名称 注意:此字段可能返回 null,表示取不到有效值。 */ ModelName?: string; /** * 设备标签名,非必填 注意:此字段可能返回 null,表示取不到有效值。 */ DeviceTagSet?: Array<string>; /** * 激活状态(1激活、0未激活) 注意:此字段可能返回 null,表示取不到有效值。 */ IsActive?: number; /** * 激活时间 注意:此字段可能返回 null,表示取不到有效值。 */ ActiveTime?: string; /** * 推流状态(推流中、未推流) 仅摄像机有的状态 注意:此字段可能返回 null,表示取不到有效值。 */ IsLive?: boolean; /** * 设备所属父设备id(子设备才有) 注意:此字段可能返回 null,表示取不到有效值。 */ ParentWID?: string; /** * 设备所有父设备名称(子设备才有) 注意:此字段可能返回 null,表示取不到有效值。 */ ParentWIDName?: string; /** * 序列号 注意:此字段可能返回 null,表示取不到有效值。 */ SN?: string; /** * 设备点位坐标值 注意:此字段可能返回 null,表示取不到有效值。 */ Location?: DeviceLocation; /** * 自定义字段 注意:此字段可能返回 null,表示取不到有效值。 */ FieldList?: Array<CustomFieldInfo>; /** * 分组信息 注意:此字段可能返回 null,表示取不到有效值。 */ GroupInfo?: string; } /** * 查询建筑信息响应体 */ export interface BuildingProfileRes { /** * 建筑概要信息 注意:此字段可能返回 null,表示取不到有效值。 */ BuildingProfile?: BuildingProfile; } /** * DescribeAlarmTypeList返回参数结构体 */ export interface DescribeAlarmTypeListResponse { /** * 告警类型列表查询 */ Result?: DescribeAlarmTypeListRes; /** * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeDeviceStatusStat请求参数结构体 */ export interface DescribeDeviceStatusStatRequest { /** * 所属空间地理层级,必填。0表示查询所有层级(1、2)的设备状态,1表示楼栋,2表示楼层 */ Level: number; /** * 工作空间id */ WorkspaceId: number; /** * 应用token */ ApplicationToken: string; /** * 空间位置,非必填。为空表示查询所有(1,2)层级 */ SpaceCodeSet?: Array<string>; /** * 设备类型,非必填。为空表示查询所有设备类型 */ DeviceTypeSet?: Array<string>; } /** * 产品列表查询结果 */ export interface ProductSet { /** * 第几页 注意:此字段可能返回 null,表示取不到有效值。 */ PageNumber?: number; /** * 每页条数 注意:此字段可能返回 null,表示取不到有效值。 */ PageSize?: number; /** * 总页数 注意:此字段可能返回 null,表示取不到有效值。 */ TotalPage?: number; /** * 总条数 注意:此字段可能返回 null,表示取不到有效值。 */ TotalRow?: number; /** * 产品信息列表 注意:此字段可能返回 null,表示取不到有效值。 */ Product?: Array<ProductInfo>; } /** * 动作信息 */ export interface Action { /** * 动作id 注意:此字段可能返回 null,表示取不到有效值。 */ Id?: number; /** * 动作名 注意:此字段可能返回 null,表示取不到有效值。 */ Name?: string; } /** * DescribeTenantBuildingCountAndArea请求参数结构体 */ export interface DescribeTenantBuildingCountAndAreaRequest { /** * 租户所有工作空间ID列表 */ WorkspaceIdList: Array<string>; /** * 应用token */ ApplicationToken: string; } /** * AddAlarmProcessRecord请求参数结构体 */ export interface AddAlarmProcessRecordRequest { /** * 处理记录项 */ RecordSet: Array<ProcessRecordInfo>; /** * 工作空间id */ WorkspaceId: number; /** * 应用token */ ApplicationToken: string; /** * 非孪生平台外部应用appid */ ApplicationId?: number; /** * 此字段填写的是非孪生中台的用户id(多个用逗号分隔),如果是非孪生中台用户必填该字段 */ ExtendOne?: string; } /** * DescribeInterfaceList返回参数结构体 */ export interface DescribeInterfaceListResponse { /** * API列表 */ Result?: ApiInfoList; /** * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 上报消息概要 */ export interface MessageProfile { /** * 应用类型 */ AppType: string; /** * 模型Id */ ModelId?: string; /** * 设备类型 */ PoiCode?: string; } /** * ModifyDeviceName返回参数结构体 */ export interface ModifyDeviceNameResponse { /** * 返回请求结果 */ Result?: EmptyRes; /** * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeEdgeApplicationToken返回参数结构体 */ export interface DescribeEdgeApplicationTokenResponse { /** * 边缘应用令牌信息 */ Result?: ApplicationTokenInfo; /** * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 设备点位坐标值 */ export interface DeviceLocation { /** * 点位X坐标值 注意:此字段可能返回 null,表示取不到有效值。 */ X?: number; /** * 点位Y坐标值 注意:此字段可能返回 null,表示取不到有效值。 */ Y?: number; /** * 点位Z坐标值 注意:此字段可能返回 null,表示取不到有效值。 */ Z?: number; } /** * 租户人员结果 */ export interface SsoUserResult { /** * 总数 注意:此字段可能返回 null,表示取不到有效值。 */ Total?: number; /** * 租户人员数据 注意:此字段可能返回 null,表示取不到有效值。 */ Users?: Array<SsoUser>; } /** * 部门用户 */ export interface SsoTeamUser { /** * 用户ID 注意:此字段可能返回 null,表示取不到有效值。 */ UserId?: string; /** * 用户名称 注意:此字段可能返回 null,表示取不到有效值。 */ RealName?: string; /** * 用户类型,1-超级管理员;2-1号管理员;3-普通管理员;99-普通用户 注意:此字段可能返回 null,表示取不到有效值。 */ UserType?: string; /** * 所属租户ID 注意:此字段可能返回 null,表示取不到有效值。 */ TenantId?: string; /** * 邮箱 注意:此字段可能返回 null,表示取不到有效值。 */ Email?: string; /** * 电话 注意:此字段可能返回 null,表示取不到有效值。 */ Phone?: string; /** * 用户状态 注意:此字段可能返回 null,表示取不到有效值。 */ Status?: number; /** * 创建时间 注意:此字段可能返回 null,表示取不到有效值。 */ CreateAt?: number; /** * 部门ID 注意:此字段可能返回 null,表示取不到有效值。 */ DepartmentId?: string; /** * 部门名称 注意:此字段可能返回 null,表示取不到有效值。 */ DepartmentName?: string; /** * 是否关联权限 注意:此字段可能返回 null,表示取不到有效值。 */ LinkFilter?: number; } /** * 添加设备信息 */ export interface AddDeviceInfo { /** * 产品id */ ProductId: number; /** * 设备sn序列号 */ SN: string; /** * 父设备wid,不为空表示导入子设备 */ ParentWID?: string; /** * 密钥来源:0-使用产品密钥 1-使用设备特有的密钥 */ KeySource?: number; } /** * 空结果返回 */ export interface EmptyRes { /** * 返回请求状态,成功ok,失败error 注意:此字段可能返回 null,表示取不到有效值。 */ Msg?: string; } /** * API参数信息 */ export interface ApiContent { /** * 所属API的id 注意:此字段可能返回 null,表示取不到有效值。 */ Id?: string; /** * 参数名称 注意:此字段可能返回 null,表示取不到有效值。 */ Name?: string; /** * 参数类型 注意:此字段可能返回 null,表示取不到有效值。 */ Type?: string; /** * 是否为动态值 注意:此字段可能返回 null,表示取不到有效值。 */ Dynamic?: boolean; /** * 是否必填 注意:此字段可能返回 null,表示取不到有效值。 */ Required?: boolean; /** * 参数值 注意:此字段可能返回 null,表示取不到有效值。 */ Value?: string; /** * 默认值 注意:此字段可能返回 null,表示取不到有效值。 */ DefaultValue?: string; } /** * DescribeWorkspaceList返回参数结构体 */ export interface DescribeWorkspaceListResponse { /** * 项目空间列表 */ Result?: WorkspaceInfoList; /** * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 产品信息 */ export interface ProductInfo { /** * 工作空间id 注意:此字段可能返回 null,表示取不到有效值。 */ WorkspaceId?: number; /** * 产品PID 注意:此字段可能返回 null,表示取不到有效值。 */ ProductId?: number; /** * 产品名称 注意:此字段可能返回 null,表示取不到有效值。 */ ProductName?: string; /** * 设备类型 注意:此字段可能返回 null,表示取不到有效值。 */ DeviceTypeName?: string; /** * 设备类型id 注意:此字段可能返回 null,表示取不到有效值。 */ DeviceTypeId?: string; /** * 产品属性,如:网关(1)、直连设备(2)、子设备(3) 注意:此字段可能返回 null,表示取不到有效值。 */ Attribute?: number; /** * 产品型号 注意:此字段可能返回 null,表示取不到有效值。 */ ProductType?: string; /** * 产品能力:信令数据、音视频,用二进制表示,第0位表示信令数据、第1表示音视频 ,默认为1(信令数据) 注意:此字段可能返回 null,表示取不到有效值。 */ ProductAbility?: number; /** * 生产厂商 注意:此字段可能返回 null,表示取不到有效值。 */ Manufacturer?: string; /** * 维保厂商 注意:此字段可能返回 null,表示取不到有效值。 */ MaintenanceMfr?: string; /** * 物模型名称 注意:此字段可能返回 null,表示取不到有效值。 */ ModelName?: string; /** * 物模型id 注意:此字段可能返回 null,表示取不到有效值。 */ ModelId?: string; /** * 物模型类型,产品模型/标准模型 注意:此字段可能返回 null,表示取不到有效值。 */ ModelType?: number; } /** * API描述 */ export interface ApiInfo { /** * API的id 注意:此字段可能返回 null,表示取不到有效值。 */ ApiId?: string; /** * API名称 注意:此字段可能返回 null,表示取不到有效值。 */ Name?: string; /** * API所属应用的id 注意:此字段可能返回 null,表示取不到有效值。 */ AppId?: string; /** * API所属的项目空间的id 注意:此字段可能返回 null,表示取不到有效值。 */ WorkspaceId?: string; /** * API所属目录的编码 注意:此字段可能返回 null,表示取不到有效值。 */ PoiCode?: string; /** * 接口分类0. 其他服务 1. IOT服务 2. 空间服务 3.微应用服务 4.场景服务 5.AI算法服务 6.任务算法服务 7.第三方服务 注意:此字段可能返回 null,表示取不到有效值。 */ Type?: number; /** * 数据授权 0:否 1:是 注意:此字段可能返回 null,表示取不到有效值。 */ DataAudit?: number; /** * 是否需要申请 0:否 1:是 注意:此字段可能返回 null,表示取不到有效值。 */ ApplyAudit?: number; /** * API详情 注意:此字段可能返回 null,表示取不到有效值。 */ Description?: string; /** * API地址 注意:此字段可能返回 null,表示取不到有效值。 */ Address?: string; /** * 请求方法类型 注意:此字段可能返回 null,表示取不到有效值。 */ Method?: string; /** * API状态 注意:此字段可能返回 null,表示取不到有效值。 */ Status?: number; /** * API预览地址 注意:此字段可能返回 null,表示取不到有效值。 */ PreviewUrl?: string; /** * query参数 注意:此字段可能返回 null,表示取不到有效值。 */ QueryParams?: Array<ApiContent>; /** * 路径参数 注意:此字段可能返回 null,表示取不到有效值。 */ PathParams?: Array<ApiContent>; /** * 请求头 注意:此字段可能返回 null,表示取不到有效值。 */ RequestHeaders?: Array<ApiContent>; /** * 响应头 注意:此字段可能返回 null,表示取不到有效值。 */ ResponseHeaders?: Array<ApiContent>; /** * 是否为公共空间接口 注意:此字段可能返回 null,表示取不到有效值。 */ IsCommonSpace?: boolean; /** * 请求体(base64编码) 注意:此字段可能返回 null,表示取不到有效值。 */ Body?: string; /** * 响应体(base64编码) 注意:此字段可能返回 null,表示取不到有效值。 */ ResponseBody?: string; /** * 接口方式 1.http 2消息通知服务 注意:此字段可能返回 null,表示取不到有效值。 */ Style?: number; } /** * DescribeModelList返回参数结构体 */ export interface DescribeModelListResponse { /** * 模型列表查询结果 */ Result?: ModelSet; /** * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeRuleDetail请求参数结构体 */ export interface DescribeRuleDetailRequest { /** * 工作空间id */ WorkspaceId: string; /** * 联动id */ Id: string; /** * 应用token */ ApplicationToken: string; } /** * BatchCreateDevice返回参数结构体 */ export interface BatchCreateDeviceResponse { /** * 批量新增设备返回结果 */ Result?: BatchCreateDeviceRes; /** * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 构件属性信息响应体 */ export interface ElementPropertyRes { /** * 建筑id 注意:此字段可能返回 null,表示取不到有效值。 */ BuildingId?: string; /** * 构件id 注意:此字段可能返回 null,表示取不到有效值。 */ ElementId?: string; /** * 构件属性集合 注意:此字段可能返回 null,表示取不到有效值。 */ PropertySet?: Array<ElementProperty>; /** * 构件地理坐标 注意:此字段可能返回 null,表示取不到有效值。 */ Coordinates?: ElementCoordinates; /** * 构件偏移量 注意:此字段可能返回 null,表示取不到有效值。 */ Translate?: ElementTranslate; /** * 构件名称 注意:此字段可能返回 null,表示取不到有效值。 */ ElementName?: string; /** * 构件类型代码 注意:此字段可能返回 null,表示取不到有效值。 */ EntityTypeCode?: string; /** * 构件类型名称 注意:此字段可能返回 null,表示取不到有效值。 */ EntityTypeName?: string; } /** * CreateApplicationToken返回参数结构体 */ export interface CreateApplicationTokenResponse { /** * 应用令牌信息 */ Result?: ApplicationTokenInfo; /** * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeTenantUserList请求参数结构体 */ export interface DescribeTenantUserListRequest { /** * 翻页页码 */ Offset: number; /** * 翻页大小 */ Limit: number; /** * token */ ApplicationToken: string; /** * 租户ID */ TenantId?: string; /** * 更新时间戳,单位秒 */ UpdateAt?: number; /** * 部门ID */ DepartmentId?: string; /** * 用户id */ Cursor?: string; /** * 状态,0,获取所有数据,1正常启用,2禁用 */ Status?: number; /** * 项目空间id */ WorkspaceId?: string; /** * 关键词 */ Keyword?: string; /** * 是否递归获取子级数据,0需要,1不需要,默认为0 */ NoRecursive?: string; } /** * StopVideoStreaming返回参数结构体 */ export interface StopVideoStreamingResponse { /** * 停流接口返回结果 */ Result?: EmptyRes; /** * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeDeviceStatusList返回参数结构体 */ export interface DescribeDeviceStatusListResponse { /** * 查询设备状态结果 */ Result?: DeviceStatusRes; /** * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyDeviceName请求参数结构体 */ export interface ModifyDeviceNameRequest { /** * 工作空间id */ WorkspaceId: number; /** * 设备修改信息集合 */ Set: Array<DeviceModifyInfo>; /** * 应用token */ ApplicationToken: string; } /** * DescribeAlarmStatusList请求参数结构体 */ export interface DescribeAlarmStatusListRequest { /** * 应用token */ ApplicationToken: string; /** * 工作空间ID */ WorkspaceId: string; } /** * DescribeFileDownloadURL返回参数结构体 */ export interface DescribeFileDownloadURLResponse { /** * 文件下载URL地址 */ Result?: FileDownloadURL; /** * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeRuleDetail返回参数结构体 */ export interface DescribeRuleDetailResponse { /** * 规则详情查询结果 */ Result?: RuleDetailRes; /** * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 上报消息结果 */ export interface ReportMsgRes { /** * 上报消息对应下标的16位标识Id, 即第几个消息 注意:此字段可能返回 null,表示取不到有效值。 */ ReportId?: string; /** * 上报消息结果,1表示成功推送,0表示推送失败 注意:此字段可能返回 null,表示取不到有效值。 */ ReportStatus?: number; } /** * DescribeSpaceInfoByDeviceId返回参数结构体 */ export interface DescribeSpaceInfoByDeviceIdResponse { /** * 设备绑定的空间信息出参 */ Result?: DeviceSpaceInfoRes; /** * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeApplicationList请求参数结构体 */ export interface DescribeApplicationListRequest { /** * 项目空间id,本次查询返回的应用均关联至该空间 */ WorkspaceId: number; /** * 应用token */ ApplicationToken: string; /** * 应用id数组,可选,填了则表示根据id批量查询 */ ApplicationId?: Array<number | bigint>; /** * 请求页号 */ PageNumber?: number; /** * 页容量,默认为10 */ PageSize?: number; } /** * 构件树节点信息 */ export interface ElementProfileTreeNode { /** * 构件概要信息 注意:此字段可能返回 null,表示取不到有效值。 */ ElementProfile?: ElementProfile; /** * 子节点信息 注意:此字段可能返回 null,表示取不到有效值。 */ Children?: Array<ElementProfileTreeNode>; } /** * 工作空间信息描述 */ export interface WorkspaceInfo { /** * 工作空间Id 注意:此字段可能返回 null,表示取不到有效值。 */ WorkspaceId?: number; /** * 工作空间中文名字 注意:此字段可能返回 null,表示取不到有效值。 */ ChineseName?: string; /** * 工作空间描述 注意:此字段可能返回 null,表示取不到有效值。 */ Description?: string; /** * 工作空间是否删除状态 注意:此字段可能返回 null,表示取不到有效值。 */ Status?: number; /** * 该工作空间绑定的区/县的行政区名字 注意:此字段可能返回 null,表示取不到有效值。 */ ParkName?: string; /** * 该工作空间绑定的区/县的行政区编码 注意:此字段可能返回 null,表示取不到有效值。 */ ParkNum?: string; /** * 获取该工作空间绑定的区/县的上级行政区划信息 注意:此字段可能返回 null,表示取不到有效值。 */ AdministrativeDetailSet?: Array<AdministrativeDetail>; } /** * DescribeSceneList请求参数结构体 */ export interface DescribeSceneListRequest { /** * 项目空间id */ WorkspaceId: string; /** * 应用token */ ApplicationToken: string; } /** * DescribeDeviceList请求参数结构体 */ export interface DescribeDeviceListRequest { /** * 工作空间id */ WorkspaceId: number; /** * 分页查询,第几页,必传,大于0 */ PageNumber: number; /** * 每页条数,必传大于0 */ PageSize: number; /** * 应用token */ ApplicationToken: string; /** * 设备类型,非必填 */ DeviceTypeSet?: Array<string>; /** * 产品 pid,非必填 */ ProductIdSet?: Array<number | bigint>; /** * 设备标签,非必填 */ TagIdSet?: Array<number | bigint>; /** * 空间层级 */ SpaceCodeSet?: Array<string>; /** * 设备标签名,非必填 */ DeviceTagSet?: Array<string>; /** * 设备wid,非必填 */ WIDSet?: Array<string>; /** * 自定义字段 */ Field?: CustomField; /** * 分组id列表,非必填 */ GroupIdSet?: Array<number | bigint>; } /** * DescribeSpaceRelationByDeviceId请求参数结构体 */ export interface DescribeSpaceRelationByDeviceIdRequest { /** * 设备id */ DeviceId: string; /** * 工作空间id */ WorkspaceId: string; /** * 应用token */ ApplicationToken: string; } /** * 告警类型详情信息 */ export interface AlarmTypeDetailInfo { /** * 告警类型id 注意:此字段可能返回 null,表示取不到有效值。 */ Id?: number; /** * 父节点id 注意:此字段可能返回 null,表示取不到有效值。 */ ParentId?: number; /** * 0-标准告警类型,1-自定义告警类型 注意:此字段可能返回 null,表示取不到有效值。 */ Type?: number; /** * 告警名称类型 注意:此字段可能返回 null,表示取不到有效值。 */ Name?: string; /** * 告警类型英文名称 注意:此字段可能返回 null,表示取不到有效值。 */ EnglishName?: string; } /** * ChangeAlarmStatus返回参数结构体 */ export interface ChangeAlarmStatusResponse { /** * 返回空结果 */ Result?: EmptyRes; /** * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeBuildingModel返回参数结构体 */ export interface DescribeBuildingModelResponse { /** * 建模模型信息出参 */ Result?: BuildingModelRes; /** * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * BatchReportAppMessage返回参数结构体 */ export interface BatchReportAppMessageResponse { /** * 批量消息上报结果 */ Result?: BatchReportAppMessageRes; /** * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeElementProfilePage请求参数结构体 */ export interface DescribeElementProfilePageRequest { /** * 建筑id */ BuildingId: string; /** * 页码 */ PageNumber: number; /** * 页容量 */ PageSize: number; /** * 项目空间id */ WorkspaceId: string; /** * 应用token */ ApplicationToken: string; /** * 父级构件id */ ParentElementIds?: Array<string>; /** * 空间层级 */ Level?: number; /** * 空间分类代码 */ SpaceTypeCode?: string; /** * 构件类型 */ EntityTypes?: Array<string>; /** * 是否包含已删除构件 */ IncludeDelete?: boolean; /** * 时间范围-开始 */ StartTime?: number; /** * 时间范围-结束 */ EndTime?: number; } /** * DescribePropertyList返回参数结构体 */ export interface DescribePropertyListResponse { /** * 构件属性信息出参 */ Result?: ElementPropertyRes; /** * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeSpaceDeviceRelationList请求参数结构体 */ export interface DescribeSpaceDeviceRelationListRequest { /** * 构件id列表 */ ElementIds: Array<string>; /** * 是否级联 */ IsCascade: boolean; /** * 项目空间id */ WorkspaceId: string; /** * 页码 */ PageNumber: number; /** * 页容量 */ PageSize: number; /** * 应用token */ ApplicationToken: string; } /** * 获取文件上传URL接口回包 */ export interface FileUploadURL { /** * 上传地址 注意:此字段可能返回 null,表示取不到有效值。 */ UploadURL?: string; /** * 文件Id 注意:此字段可能返回 null,表示取不到有效值。 */ FileId?: string; /** * 下载地址 注意:此字段可能返回 null,表示取不到有效值。 */ DownloadURL?: string; } /** * DescribeApplicationList返回参数结构体 */ export interface DescribeApplicationListResponse { /** * 应用列表 */ Result?: ApplicationList; /** * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 构件属性信息 */ export interface ElementProperty { /** * 属性名称 注意:此字段可能返回 null,表示取不到有效值。 */ Name?: string; /** * 属性描述 注意:此字段可能返回 null,表示取不到有效值。 */ Description?: string; /** * 属性内容 注意:此字段可能返回 null,表示取不到有效值。 */ Content?: string; } /** * 建筑列表响应体 */ export interface BuildingListRes { /** * 建筑列表 注意:此字段可能返回 null,表示取不到有效值。 */ BuildingProfileList?: Array<BuildingProfile>; } /** * 设备位置信息 */ export interface DeviceSpaceInfo { /** * 空间Id 注意:此字段可能返回 null,表示取不到有效值。 */ Id?: string; /** * 空间名字 注意:此字段可能返回 null,表示取不到有效值。 */ Name?: string; /** * 空间级别 注意:此字段可能返回 null,表示取不到有效值。 */ Level?: number; /** * 空间编码 注意:此字段可能返回 null,表示取不到有效值。 */ Code?: string; } /** * DescribeFileDownloadURL请求参数结构体 */ export interface DescribeFileDownloadURLRequest { /** * 工作空间Id */ WorkspaceId: number; /** * 文件Id */ FileId: string; /** * 应用token */ ApplicationToken: string; } /** * 设备状态统计结果 */ export interface DeviceStatusStatRes { /** * 工作空间Id 注意:此字段可能返回 null,表示取不到有效值。 */ WorkspaceId?: number; /** * 汇总数。在线(正常+故障) + 离线 注意:此字段可能返回 null,表示取不到有效值。 */ Total?: number; /** * 正常数 注意:此字段可能返回 null,表示取不到有效值。 */ NormalSum?: number; /** * 离线数 注意:此字段可能返回 null,表示取不到有效值。 */ OfflineSum?: number; /** * 故障数 注意:此字段可能返回 null,表示取不到有效值。 */ FaultSum?: number; /** * 设备类型概览列表 注意:此字段可能返回 null,表示取不到有效值。 */ DeviceTypeOverviewSet?: Array<DeviceTypeOverview>; /** * 设备类型统计列表 注意:此字段可能返回 null,表示取不到有效值。 */ StatLevelSet?: Array<StatLevel>; } /** * 告警处理人列表 */ export interface HandlerPersonInfo { /** * 用户id 注意:此字段可能返回 null,表示取不到有效值。 */ Id?: string; /** * 用户名 注意:此字段可能返回 null,表示取不到有效值。 */ Name?: string; } /** * 事件信息 */ export interface Event { /** * 事件id或动作Id 注意:此字段可能返回 null,表示取不到有效值。 */ Id?: number; /** * 事件名称或动作名称 注意:此字段可能返回 null,表示取不到有效值。 */ Name?: string; } /** * StopVideoStreaming请求参数结构体 */ export interface StopVideoStreamingRequest { /** * 流的唯一标识,播放链接尾缀 */ Stream: string; /** * 设备的唯一标识 */ WID: string; /** * 工作空间Id */ WorkspaceId: number; /** * 应用token */ ApplicationToken: string; } /** * 项目空间楼栋数量与建筑面积出参 */ export interface SpaceDataStats { /** * 工作空间ID 注意:此字段可能返回 null,表示取不到有效值。 */ WorkspaceId?: string; /** * 工作空间名称 注意:此字段可能返回 null,表示取不到有效值。 */ WorkspaceName?: string; /** * 楼栋数量 注意:此字段可能返回 null,表示取不到有效值。 */ BuildingCount?: number; /** * 建筑面积 注意:此字段可能返回 null,表示取不到有效值。 */ BuildingArea?: number; } /** * DescribeSpaceTypeList请求参数结构体 */ export interface DescribeSpaceTypeListRequest { /** * 项目空间ID */ WorkspaceId: string; /** * 页码 */ PageNumber: number; /** * 页容量 */ PageSize: number; /** * 应用token */ ApplicationToken: string; } /** * 项目空间详细信息 */ export interface SpaceInfo { /** * 项目空间id 注意:此字段可能返回 null,表示取不到有效值。 */ WorkspaceId?: number; /** * 租户id 注意:此字段可能返回 null,表示取不到有效值。 */ TenantId?: number; /** * 英文名 注意:此字段可能返回 null,表示取不到有效值。 */ EnglishName?: string; /** * 中文名 注意:此字段可能返回 null,表示取不到有效值。 */ ChineseName?: string; /** * 项目空间描述 注意:此字段可能返回 null,表示取不到有效值。 */ Description?: string; /** * 项目空间状态:0 启用 1 停用 -1 已删除 注意:此字段可能返回 null,表示取不到有效值。 */ Status?: number; /** * 是否是公共空间 注意:此字段可能返回 null,表示取不到有效值。 */ IsCommWorkspace?: boolean; /** * 有效期开始时间 注意:此字段可能返回 null,表示取不到有效值。 */ ValidityStartTime?: string; /** * 有效期结束时间 注意:此字段可能返回 null,表示取不到有效值。 */ ValidityEndTime?: string; /** * 选中状态 注意:此字段可能返回 null,表示取不到有效值。 */ Selected?: number; /** * 系统生成状态 注意:此字段可能返回 null,表示取不到有效值。 */ IsSystem?: number; } /** * DescribeModelList请求参数结构体 */ export interface DescribeModelListRequest { /** * 工作空间id */ WorkspaceId: number; /** * 分页查询,第几页,大于0 */ PageNumber: number; /** * 每页条数,大于0 */ PageSize: number; /** * 应用token */ ApplicationToken: string; /** * 设备类型 */ DeviceTypeSet?: Array<string>; /** * 产品 pid */ ProductIdSet?: Array<number | bigint>; /** * 模型id */ ModelIdSet?: Array<string>; } /** * 云录像接口结果 */ export interface VideoCloudRecordRes { /** * 录像信息总数 注意:此字段可能返回 null,表示取不到有效值。 */ TotalCount?: number; /** * 录像信息列表 注意:此字段可能返回 null,表示取不到有效值。 */ RecordSet?: Array<RecordInfo>; } /** * 部门用户结果 */ export interface SsoDepartmentsResult { /** * 总数 注意:此字段可能返回 null,表示取不到有效值。 */ Total?: number; /** * 部门列表 注意:此字段可能返回 null,表示取不到有效值。 */ Departments?: Array<SsoDepartment>; } /** * 视频流查询结果 */ export interface VideoRecordStreamRes { /** * FLV协议格式视频流 注意:此字段可能返回 null,表示取不到有效值。 */ FLV?: string; /** * RTMP协议格式视频流 注意:此字段可能返回 null,表示取不到有效值。 */ RTMP?: string; /** * HLS协议格式视频流 注意:此字段可能返回 null,表示取不到有效值。 */ HLS?: string; /** * WebRtc协议格式视频流 注意:此字段可能返回 null,表示取不到有效值。 */ WebRTC?: string; /** * RAW协议格式视频流 注意:此字段可能返回 null,表示取不到有效值。 */ RAW?: RawInfo; /** * 视频流的唯一标识 注意:此字段可能返回 null,表示取不到有效值。 */ Stream?: string; } /** * 设备控制结果 */ export interface ControlDeviceRes { /** * 设备Id 注意:此字段可能返回 null,表示取不到有效值。 */ WID?: string; /** * 指令接受, 0表示成功 注意:此字段可能返回 null,表示取不到有效值。 */ Code?: number; /** * 控制结果 注意:此字段可能返回 null,表示取不到有效值。 */ Result?: string; /** * 批量大于1时,可用此seq进行链路追踪 注意:此字段可能返回 null,表示取不到有效值。 */ Seq?: string; } /** * 项目空间列表 */ export interface WorkspaceInfoList { /** * 项目空间列表 注意:此字段可能返回 null,表示取不到有效值。 */ List?: Array<SpaceInfo>; } /** * 建模模型信息响应体 */ export interface BuildingModelRes { /** * 建模模型信息出参 注意:此字段可能返回 null,表示取不到有效值。 */ Models?: Array<BuildingModel>; } /** * DescribeBuildingList返回参数结构体 */ export interface DescribeBuildingListResponse { /** * 查询建筑列表出参 */ Result?: BuildingListRes; /** * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 空间层级关系响应体 */ export interface SpaceRelationRes { /** * 空间层级关系 注意:此字段可能返回 null,表示取不到有效值。 */ SpaceRelation?: SpaceRelation; } /** * 空间用户结果 */ export interface SsoTeamUserResult { /** * 总数 注意:此字段可能返回 null,表示取不到有效值。 */ Total?: number; /** * 部门用户列表 注意:此字段可能返回 null,表示取不到有效值。 */ Users?: Array<SsoTeamUser>; } /** * DescribeWorkspaceUserList返回参数结构体 */ export interface DescribeWorkspaceUserListResponse { /** * 返回数据 */ Result?: SsoTeamUserResult; /** * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribePropertyList请求参数结构体 */ export interface DescribePropertyListRequest { /** * 建筑id */ BuildingId: string; /** * 构件id */ ElementId: string; /** * 项目空间id */ WorkspaceId: string; /** * 应用token */ ApplicationToken: string; } /** * 事件列表查询结果 */ export interface DescribeEventListRes { /** * 第几页 注意:此字段可能返回 null,表示取不到有效值。 */ PageNumber?: number; /** * 每页条数 注意:此字段可能返回 null,表示取不到有效值。 */ PageSize?: number; /** * 总页数 注意:此字段可能返回 null,表示取不到有效值。 */ TotalPage?: number; /** * 总条数 注意:此字段可能返回 null,表示取不到有效值。 */ TotalRow?: number; /** * 事件信息列表 注意:此字段可能返回 null,表示取不到有效值。 */ EventDetailSet?: Array<EventDetail>; } /** * DescribeProductList请求参数结构体 */ export interface DescribeProductListRequest { /** * 工作空间id */ WorkspaceId: number; /** * 分页查询,第几页 */ PageNumber: number; /** * 每页条数,大于0 */ PageSize: number; /** * 应用token */ ApplicationToken: string; /** * 设备类型 */ DeviceTypeSet?: Array<string>; /** * 产品 pid */ ProductIdSet?: Array<number | bigint>; /** * 模型id */ ModelIdSet?: Array<string>; } /** * 应用logo */ export interface ApplicationLogo { /** * logo图片对应的fileId 注意:此字段可能返回 null,表示取不到有效值。 */ FileId?: string; /** * logo图片地址 注意:此字段可能返回 null,表示取不到有效值。 */ Url?: string; } /** * 联动规则列表查询结果 */ export interface DescribeLinkRuleListRes { /** * 第几页 注意:此字段可能返回 null,表示取不到有效值。 */ PageNumber?: number; /** * 每页条数 注意:此字段可能返回 null,表示取不到有效值。 */ PageSize?: number; /** * 总页数 注意:此字段可能返回 null,表示取不到有效值。 */ TotalPage?: number; /** * 总条数 注意:此字段可能返回 null,表示取不到有效值。 */ TotalRow?: number; /** * 联动规则列表 注意:此字段可能返回 null,表示取不到有效值。 */ LinkRuleSet?: Array<LinkRuleInfo>; } /** * 导入失败设备信息 */ export interface CreateDeviceFailed { /** * 产品id 注意:此字段可能返回 null,表示取不到有效值。 */ ProductId?: number; /** * 父设备wid,不为空表示导入自设备 注意:此字段可能返回 null,表示取不到有效值。 */ ParentWID?: string; /** * 失败原因 注意:此字段可能返回 null,表示取不到有效值。 */ Reason?: string; /** * 设备sn序列号 注意:此字段可能返回 null,表示取不到有效值。 */ SN?: string; } /** * 构件平移信息 */ export interface ElementTranslate { /** * X方向偏移量 注意:此字段可能返回 null,表示取不到有效值。 */ X?: number; /** * Y方向偏移量 注意:此字段可能返回 null,表示取不到有效值。 */ Y?: number; /** * Z方向偏移量 注意:此字段可能返回 null,表示取不到有效值。 */ Z?: number; } /** * ControlCameraPTZ返回参数结构体 */ export interface ControlCameraPTZResponse { /** * 控制摄像头结果返回 */ Result?: EmptyRes; /** * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeWorkspaceList请求参数结构体 */ export interface DescribeWorkspaceListRequest { /** * 应用token */ ApplicationToken: string; /** * 工作空间id,非必填,填了则表示根据id进行批量查询 */ WorkspaceId?: number; } /** * 建筑概要信息 */ export interface BuildingProfile { /** * 建筑id 注意:此字段可能返回 null,表示取不到有效值。 */ BuildingId?: string; /** * 建筑名称 注意:此字段可能返回 null,表示取不到有效值。 */ BuildingName?: string; /** * 空间编码 注意:此字段可能返回 null,表示取不到有效值。 */ SpaceCode?: string; /** * 经度 注意:此字段可能返回 null,表示取不到有效值。 */ Longitude?: number; /** * 纬度 注意:此字段可能返回 null,表示取不到有效值。 */ Latitude?: number; /** * 地址 注意:此字段可能返回 null,表示取不到有效值。 */ Address?: string; } /** * DescribeDeviceTypeList返回参数结构体 */ export interface DescribeDeviceTypeListResponse { /** * 设备的设备类型列表 */ Result?: DeviceTypeSet; /** * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 告警状态返回结构体 */ export interface AlarmStatusData { /** * 告警状态ID 注意:此字段可能返回 null,表示取不到有效值。 */ StatusID?: string; /** * 告警状态名称 注意:此字段可能返回 null,表示取不到有效值。 */ StatusName?: string; /** * 告警状态类型 注意:此字段可能返回 null,表示取不到有效值。 */ StatusType?: string; } /** * 录像信息 */ export interface RecordInfo { /** * 本录像片段开始时间(s) 注意:此字段可能返回 null,表示取不到有效值。 */ StartTime?: number; /** * 本录像片段结束时间(s) 注意:此字段可能返回 null,表示取不到有效值。 */ EndTime?: number; /** * 录像片段文件url 注意:此字段可能返回 null,表示取不到有效值。 */ VideoURL?: string; } /** * DescribeVideoRecordStream返回参数结构体 */ export interface DescribeVideoRecordStreamResponse { /** * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 导入成功设备信息 */ export interface CreateDeviceSucceeded { /** * 产品id 注意:此字段可能返回 null,表示取不到有效值。 */ ProductId?: number; /** * 父设备wid,不为空表示导入自设备 注意:此字段可能返回 null,表示取不到有效值。 */ ParentWID?: string; /** * 设备编码 注意:此字段可能返回 null,表示取不到有效值。 */ WID?: string; /** * 设备sn序列号 注意:此字段可能返回 null,表示取不到有效值。 */ SN?: string; } /** * 场景信息 */ export interface SceneInfo { /** * 场景id 注意:此字段可能返回 null,表示取不到有效值。 */ SceneId?: string; /** * 场景名称 注意:此字段可能返回 null,表示取不到有效值。 */ SceneName?: string; /** * 场景版本 注意:此字段可能返回 null,表示取不到有效值。 */ Version?: string; } /** * 规则详情查询结果 */ export interface RuleDetailRes { /** * 联动id 注意:此字段可能返回 null,表示取不到有效值。 */ RuleId?: number; /** * 联动名称 注意:此字段可能返回 null,表示取不到有效值。 */ RuleName?: string; /** * 联动说明 注意:此字段可能返回 null,表示取不到有效值。 */ RuleDesc?: string; /** * 1 全天有效,0:固定时间段有效 注意:此字段可能返回 null,表示取不到有效值。 */ ValidType?: number; /** * 有效期,json字符串(全天有效时为空) 注意:此字段可能返回 null,表示取不到有效值。 */ ValidPeriod?: string; /** * 起始时间 注意:此字段可能返回 null,表示取不到有效值。 */ BeginDate?: string; /** * 结束时间 注意:此字段可能返回 null,表示取不到有效值。 */ EndDate?: string; /** * 启用状态。1-启用,0-停用 注意:此字段可能返回 null,表示取不到有效值。 */ Status?: number; /** * 触发规则,事件的组合 注意:此字段可能返回 null,表示取不到有效值。 */ EventRule?: string; /** * 事件对象集合 注意:此字段可能返回 null,表示取不到有效值。 */ EventInfoSet?: Array<EventObj>; /** * 动作对象集合 注意:此字段可能返回 null,表示取不到有效值。 */ ActionInfoSet?: Array<ActionObj>; } /** * DescribeAlarmLevelList请求参数结构体 */ export interface DescribeAlarmLevelListRequest { /** * 工作空间id */ WorkspaceId: number; /** * 应用token */ ApplicationToken: string; } /** * BatchReportAppMessage请求参数结构体 */ export interface BatchReportAppMessageRequest { /** * 工作空间Id */ WorkspaceId: number; /** * 应用token */ ApplicationToken: string; /** * 消息上报请求列表 */ ReportSet?: Array<ReportAppMessage>; } /** * DescribeDeviceStatusStat返回参数结构体 */ export interface DescribeDeviceStatusStatResponse { /** * 设备状态统计结果 */ Result?: DeviceStatusStatRes; /** * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 设备影子查询列表 */ export interface DeviceShadowRes { /** * 第几页 注意:此字段可能返回 null,表示取不到有效值。 */ PageNumber?: number; /** * 每页条数 注意:此字段可能返回 null,表示取不到有效值。 */ PageSize?: number; /** * 总页数 注意:此字段可能返回 null,表示取不到有效值。 */ TotalPage?: number; /** * 总条数 注意:此字段可能返回 null,表示取不到有效值。 */ TotalRow?: number; /** * 设备影子列表 注意:此字段可能返回 null,表示取不到有效值。 */ Set?: Array<DeviceShadowInfo>; } /** * 告警类型列表回包 */ export interface DescribeAlarmTypeListRes { /** * 告警类型查询列表 注意:此字段可能返回 null,表示取不到有效值。 */ AlarmTypeSet?: Array<AlarmTypeDetailInfo>; } /** * DescribeBuildingModel请求参数结构体 */ export interface DescribeBuildingModelRequest { /** * 建筑id */ BuildingId: string; /** * 项目空间id */ WorkspaceId: string; /** * 应用token */ ApplicationToken: string; } /** * 用户结果 */ export interface SsoUser { /** * 用户ID 注意:此字段可能返回 null,表示取不到有效值。 */ UserId?: string; /** * 用户昵称 注意:此字段可能返回 null,表示取不到有效值。 */ UserName?: string; /** * 用户名称 注意:此字段可能返回 null,表示取不到有效值。 */ RealName?: string; /** * 用户类型,1-超级管理员;2-1号管理员;3-普通管理员;99-普通用户 注意:此字段可能返回 null,表示取不到有效值。 */ UserType?: string; /** * 所属租户ID 注意:此字段可能返回 null,表示取不到有效值。 */ TenantId?: string; /** * 所属组ID 注意:此字段可能返回 null,表示取不到有效值。 */ UserGroup?: string; /** * 邮箱 注意:此字段可能返回 null,表示取不到有效值。 */ Email?: string; /** * 电话 注意:此字段可能返回 null,表示取不到有效值。 */ Phone?: string; /** * 用户状态,0待审核,1正常启用,2禁用 注意:此字段可能返回 null,表示取不到有效值。 */ Status?: number; /** * 创建时间 注意:此字段可能返回 null,表示取不到有效值。 */ CreateAt?: number; /** * 更新时间 注意:此字段可能返回 null,表示取不到有效值。 */ UpdateAt?: number; /** * 是否属于团队,0不可用,1属于,2不属 注意:此字段可能返回 null,表示取不到有效值。 */ BelongTeam?: number; /** * 部门ID 注意:此字段可能返回 null,表示取不到有效值。 */ DepartmentId?: string; /** * 部门名称 注意:此字段可能返回 null,表示取不到有效值。 */ DepartmentName?: string; /** * 子账户ID 注意:此字段可能返回 null,表示取不到有效值。 */ DepartmentUserId?: number; /** * 密码 注意:此字段可能返回 null,表示取不到有效值。 */ Password?: string; } /** * 行政区划详情 */ export interface AdministrativeDetail { /** * 行政区域类型编码 注意:此字段可能返回 null,表示取不到有效值。 */ AdministrativeTypeCode?: string; /** * 行政区域编码 注意:此字段可能返回 null,表示取不到有效值。 */ AdministrativeCode?: string; /** * 行政区域名称 注意:此字段可能返回 null,表示取不到有效值。 */ AdministrativeName?: string; } /** * 建筑模型信息 */ export interface BuildingModel { /** * 构件ID 注意:此字段可能返回 null,表示取不到有效值。 */ ElementId?: string; /** * 构件名称 注意:此字段可能返回 null,表示取不到有效值。 */ ElementName?: string; /** * 模型类型 注意:此字段可能返回 null,表示取不到有效值。 */ ModelType?: string; /** * 模型URL 注意:此字段可能返回 null,表示取不到有效值。 */ ModelUrl?: string; } /** * 设备-空间绑定关系 */ export interface SpaceDeviceRelation { /** * 设备id 注意:此字段可能返回 null,表示取不到有效值。 */ DeviceId?: string; /** * 构件id 注意:此字段可能返回 null,表示取不到有效值。 */ ElementId?: string; } /** * ControlCameraPTZ请求参数结构体 */ export interface ControlCameraPTZRequest { /** * 设备的唯一标识 */ WID: string; /** * ptz指令 left - 向左移动 right - 向右移动 up - 向上移动 down - 向下 zoomOut - 镜头缩小 zoomIn - 镜头放大 irisIn - 光圈缩小 irisOut - 光圈放大 focusIn - 焦距变近 focusOut - 焦距变远 */ CMD: string; /** * 工作空间Id */ WorkspaceId: number; /** * 应用token */ ApplicationToken: string; } /** * 行政区划数据结构 */ export interface AdministrationData { /** * 行政区划编码 注意:此字段可能返回 null,表示取不到有效值。 */ AdministrationCode?: string; /** * 行政区划名称 注意:此字段可能返回 null,表示取不到有效值。 */ AdministrationName?: string; } /** * DescribeSpaceDeviceIdList返回参数结构体 */ export interface DescribeSpaceDeviceIdListResponse { /** * 设备ID列表 */ Result?: SpaceDeviceIdListRes; /** * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeElementProfileTree返回参数结构体 */ export interface DescribeElementProfileTreeResponse { /** * 构件树出参 */ Result?: ElementProfileTreeRes; /** * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeTenantDepartmentList请求参数结构体 */ export interface DescribeTenantDepartmentListRequest { /** * 翻页页码 */ Offset: number; /** * 翻页大小 */ Limit: number; /** * token */ ApplicationToken: string; /** * 租户ID */ TenantId?: string; /** * 更新时间戳,单位秒 */ UpdateAt?: number; /** * 部门ID */ DepartmentId?: string; /** * 用户id */ Cursor?: string; } /** * 批量消息上报结果 */ export interface BatchReportAppMessageRes { /** * 上报数量 注意:此字段可能返回 null,表示取不到有效值。 */ TotalElements?: number; /** * 提交数量(推送成功) 注意:此字段可能返回 null,表示取不到有效值。 */ Commit?: number; /** * 消息推送结果列表 注意:此字段可能返回 null,表示取不到有效值。 */ SpanMap?: Array<ReportMsgRes>; } /** * DescribeBuildingProfile请求参数结构体 */ export interface DescribeBuildingProfileRequest { /** * 建筑id */ BuildingId: string; /** * 项目空间id */ WorkspaceId: string; /** * 应用token */ ApplicationToken: string; } /** * DescribeDeviceShadowList返回参数结构体 */ export interface DescribeDeviceShadowListResponse { /** * 获取设备影子结果 */ Result?: DeviceShadowRes; /** * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 查询租户楼栋数量和楼栋建筑面积相应体 */ export interface SpaceDataTotalStatsRes { /** * 总楼栋数量 注意:此字段可能返回 null,表示取不到有效值。 */ BuildingCount?: number; /** * 总建筑面积 注意:此字段可能返回 null,表示取不到有效值。 */ BuildingArea?: number; } /** * 通过城市id查询工作空间列表 */ export interface DescribeCityWorkspaceListRes { /** * 通过城市id查询工作空间列表结果 注意:此字段可能返回 null,表示取不到有效值。 */ WorkspaceSet?: Array<WorkspaceInfo>; } /** * 设备类型列表 */ export interface DeviceTypeSet { /** * 设备类型列表 注意:此字段可能返回 null,表示取不到有效值。 */ Set?: Array<DeviceType>; } /** * DescribeBuildingList请求参数结构体 */ export interface DescribeBuildingListRequest { /** * 项目空间id */ WorkspaceId: string; /** * 应用token */ ApplicationToken: string; /** * 是否有模型文件 */ HasModel?: boolean; /** * 空间编码 */ SpaceCodes?: Array<string>; } /** * 设备-空间绑定关系响应体 */ export interface SpaceDeviceRelationRes { /** * 设备空间绑定关系列表 注意:此字段可能返回 null,表示取不到有效值。 */ SpaceDeviceRelationList?: Array<SpaceDeviceRelation>; } /** * 层级统计 */ export interface StatLevel { /** * 汇总数。在线(正常+故障) + 离线 注意:此字段可能返回 null,表示取不到有效值。 */ Total?: number; /** * 正常数 注意:此字段可能返回 null,表示取不到有效值。 */ NormalSum?: number; /** * 离线数 注意:此字段可能返回 null,表示取不到有效值。 */ OfflineSum?: number; /** * 故障数 注意:此字段可能返回 null,表示取不到有效值。 */ FaultSum?: number; /** * 空间id 注意:此字段可能返回 null,表示取不到有效值。 */ SpaceCode?: string; /** * 设备类型统计列表 注意:此字段可能返回 null,表示取不到有效值。 */ StatDeviceTypeSet?: Array<StatDeviceType>; } /** * DescribeWorkspaceUserList请求参数结构体 */ export interface DescribeWorkspaceUserListRequest { /** * 翻页页码 */ Offset: number; /** * 翻页大小 */ Limit: number; /** * 工作空间ID */ WorkspaceId: string; /** * token */ ApplicationToken: string; /** * 租户ID */ TenantId?: string; /** * 更新时间戳,单位秒 */ UpdateAt?: number; } /** * 设备控制后返回结果集合 */ export interface ControlDeviceSet { /** * 设备控制后返回结果集合 注意:此字段可能返回 null,表示取不到有效值。 */ Set?: Array<ControlDeviceRes>; } /** * 批量新增设备接口返回结果 */ export interface BatchCreateDeviceRes { /** * 新增成功的设备列表 注意:此字段可能返回 null,表示取不到有效值。 */ SuccessSet?: Array<CreateDeviceSucceeded>; /** * 新增失败的设备列表 注意:此字段可能返回 null,表示取不到有效值。 */ FailSet?: Array<CreateDeviceFailed>; } /** * DescribeVideoCloudRecord返回参数结构体 */ export interface DescribeVideoCloudRecordResponse { /** * 获取云录像结果 */ Result?: VideoCloudRecordRes; /** * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 设备列表查询结果 */ export interface DescribeDeviceListRes { /** * 第几页 注意:此字段可能返回 null,表示取不到有效值。 */ PageNumber?: number; /** * 每页条数 注意:此字段可能返回 null,表示取不到有效值。 */ PageSize?: number; /** * 总页数 注意:此字段可能返回 null,表示取不到有效值。 */ TotalPage?: number; /** * 总条数 注意:此字段可能返回 null,表示取不到有效值。 */ TotalRow?: number; /** * 设备信息集合 注意:此字段可能返回 null,表示取不到有效值。 */ DeviceDataSet?: Array<DeviceDataInfo>; } /** * DescribeSpaceDeviceRelationList返回参数结构体 */ export interface DescribeSpaceDeviceRelationListResponse { /** * 查询指定空间下设备与构件绑定关系列表出参 */ Result?: SpaceDeviceRelationRes; /** * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * UpdateWorkspaceParkAttributes请求参数结构体 */ export interface UpdateWorkspaceParkAttributesRequest { /** * 工作空间id */ WorkspaceId: number; /** * 应用token */ ApplicationToken: string; /** * 园区简称 */ ParkName?: string; /** * 园区编号 */ ParkNum?: string; } /** * DescribeLinkRuleList返回参数结构体 */ export interface DescribeLinkRuleListResponse { /** * 联动规则列表查询结果 */ Result?: DescribeLinkRuleListRes; /** * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeSpaceTypeList返回参数结构体 */ export interface DescribeSpaceTypeListResponse { /** * 空间分类列表出参 */ Result?: SpaceTypeListRes; /** * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ControlDevice请求参数结构体 */ export interface ControlDeviceRequest { /** * 工作空间id */ WorkspaceId: number; /** * 设备wid,最大100个 */ WIDSet: Array<string>; /** * 控制内容 */ ControlData: string; /** * 应用token */ ApplicationToken: string; } /** * 应用Token令牌信息 */ export interface ApplicationTokenInfo { /** * 应用申请调用API的令牌 注意:此字段可能返回 null,表示取不到有效值。 */ Token?: string; } /** * DescribeAlarmLevelList返回参数结构体 */ export interface DescribeAlarmLevelListResponse { /** * 告警级别列表查询结果 */ Result?: DescribeAlarmLevelListRes; /** * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 告警级别详情 */ export interface AlarmLevelInfo { /** * 级别id 注意:此字段可能返回 null,表示取不到有效值。 */ LevelId?: number; /** * 级别名称 注意:此字段可能返回 null,表示取不到有效值。 */ LevelName?: string; } /** * 告警处理记录 */ export interface HandleRecordInfo { /** * 告警处理记录id 注意:此字段可能返回 null,表示取不到有效值。 */ Id?: number; /** * 描述 注意:此字段可能返回 null,表示取不到有效值。 */ Description?: string; /** * 名称 注意:此字段可能返回 null,表示取不到有效值。 */ Name?: string; /** * 操作类型 注意:此字段可能返回 null,表示取不到有效值。 */ OperationType?: string; /** * 处理时间 注意:此字段可能返回 null,表示取不到有效值。 */ Time?: string; /** * 类型 注意:此字段可能返回 null,表示取不到有效值。 */ Type?: string; /** * 文件列表 注意