{ "name": "weilingwith", "display_name": "微瓴同业开放平台", "description": "该云API提供控制台-项目空间管理相关操作接口。", "domain": "other", "api_version": "2023-04-27", "endpoint": "weilingwith.tencentcloudapi.com", "actions": [ { "name": "AddAlarmProcessRecord", "description": "添加告警处理记录", "status": "online", "parameters": [ { "name": "RecordSet", "type": "array", "required": true, "description": "处理记录项", "example": "{\"Id\": \"cdf85c7c-cf04-41b5-9631-fa4a7290e615\",\"ProcessTime\": 1688114263000,\"ProcessType\": \"add_record-other\",\"ProcessDescription\": \"test\",\"AppendixFileId\": \"[{\\\"fileId\\\":\\\"b87ae7ec-6874-4103-bfa0-2489374476eb\\\",\\\"fileName\\\":\\\"ecs.png\\\"}]\"}", "item_type": "object", "children": [ { "name": "Id", "type": "string", "required": true, "description": "告警的id", "example": "cdf85c7c-cf04-41b5-9631-fa4a7290e615" }, { "name": "ProcessTime", "type": "integer", "required": true, "description": "处理时间，毫秒", "example": "1688114263000" }, { "name": "ProcessType", "type": "string", "required": true, "description": "处理类型，此处操作类型固定填add_record", "example": "add_record-other" }, { "name": "Processor", "type": "string", "required": false, "description": "注:此字段填写的是孪生中台的用户，非孪生中台用户不填该字段 [{\\\"id\\\":\\\"123\\\",\\\"name\\\":\\\"tes\\\"}]", "example": "[{\\\"id\\\":\\\"123\\\",\\\"name\\\":\\\"tes\\\"}]" }, { "name": "ProcessDescription", "type": "string", "required": false, "description": "处理描述信息", "example": "processdesc" }, { "name": "AttachedFileId", "type": "string", "required": false, "description": "附加文件标识", "example": "[{\\\"fileId\\\":\\\"b87ae7ec-6874-4103-bfa0-2489374476eb\\\",\\\"fileName\\\":\\\"ecs.png\\\"}]" } ] }, { "name": "WorkspaceId", "type": "integer", "required": true, "description": "工作空间id", "example": "1016" }, { "name": "ApplicationToken", "type": "string", "required": true, "description": "应用token", "example": "baSTzPx0vZ6LPuv2EifNa5CqRBj9hoY0" }, { "name": "ApplicationId", "type": "integer", "required": false, "description": "非孪生平台外部应用appid", "example": "10051" }, { "name": "ExtendOne", "type": "string", "required": false, "description": "此字段填写的是非孪生中台的用户id（多个用逗号分隔），如果是非孪生中台用户必填该字段", "example": "cda323aa-da67-451f-8d27-71cb6748b0bf" } ], "required": [ "RecordSet", "WorkspaceId", "ApplicationToken" ] }, { "name": "BatchCreateDevice", "description": "单个/批量新增设备", "status": "online", "parameters": [ { "name": "WorkspaceId", "type": "integer", "required": true, "description": "工作空间Id", "example": "1016" }, { "name": "AddDeviceSet", "type": "array", "required": true, "description": "设备信息项", "example": "{\"ProductId\": 200022,\"ParentWID\": \"parentwid\",\"KeySource\": 0,\"SN\": \"sn\"}", "item_type": "object", "children": [ { "name": "ProductId", "type": "integer", "required": true, "description": "产品id", "example": "200022" }, { "name": "SN", "type": "string", "required": true, "description": "设备sn序列号", "example": "sn" }, { "name": "ParentWID", "type": "string", "required": false, "description": "父设备wid，不为空表示导入子设备", "example": "parentwid" }, { "name": "KeySource", "type": "integer", "required": false, "description": "密钥来源：0-使用产品密钥 1-使用设备特有的密钥", "example": "0" } ] }, { "name": "ApplicationToken", "type": "string", "required": true, "description": "应用token", "example": "YVySZSL1Lp5UtSJ5uJVLJYOKDEGfCCH2" } ], "required": [ "WorkspaceId", "AddDeviceSet", "ApplicationToken" ] }, { "name": "BatchDeleteDevice", "description": "批量删除设备", "status": "online", "parameters": [ { "name": "WorkspaceId", "type": "integer", "required": true, "description": "工作空间id", "example": "1016" }, { "name": "WIDSet", "type": "array", "required": true, "description": "设备wid数组列表", "example": "[\"wid1\",\"wid2\"]", "item_type": "string" }, { "name": "ApplicationToken", "type": "string", "required": true, "description": "应用token", "example": "YVySZSL1Lp5UtSJ5uJVLJYOKDEGfCCH2" } ], "required": [ "WorkspaceId", "WIDSet", "ApplicationToken" ] }, { "name": "BatchKillAlarm", "description": "批量消警", "status": "online", "parameters": [ { "name": "BeginTime", "type": "integer", "required": true, "description": "告警开始时间，必填,时间戳秒", "example": "1693416987" }, { "name": "EndTime", "type": "integer", "required": true, "description": "告警结束时间，必填，时间戳秒", "example": "1693417958" }, { "name": "StatusSet", "type": "array", "required": true, "description": "告警状态: unprocessed processing", "example": "unprocessed", "item_type": "string" }, { "name": "WorkspaceId", "type": "integer", "required": true, "description": "工作空间id", "example": "1016" }, { "name": "UserId", "type": "string", "required": true, "description": "当前操作用户id", "example": "12" }, { "name": "UserName", "type": "string", "required": true, "description": "当前操作用户名称", "example": "username" }, { "name": "ApplicationToken", "type": "string", "required": true, "description": "应用token", "example": "baSTzPx0vZ6LPuv2EifNa5CqRBj9hoY0" }, { "name": "ProcessorId", "type": "string", "required": false, "description": "当前告警处理人，填孪生中台用户id,多个用逗号分隔", "example": "12" }, { "name": "AlarmTypeSet", "type": "array", "required": false, "description": "告警子类型(如果传告警子类型，则必传父类型)", "example": "{\"Type\":\"\",\"SubType\":\"\"}", "item_type": "object", "children": [ { "name": "Type", "type": "string", "required": true, "description": "告警父类型", "example": "xxx-a" }, { "name": "SubType", "type": "string", "required": false, "description": "告警子类型(如果传告警子类型，则必传父类型)", "example": "xxx-b" } ] }, { "name": "LevelSet", "type": "array", "required": false, "description": "告警级别,包括1~5", "example": "3", "item_type": "integer" }, { "name": "WIDSet", "type": "array", "required": false, "description": "设备id", "example": "wueh-xxx", "item_type": "string" }, { "name": "IdSet", "type": "array", "required": false, "description": "告警id", "example": "dfac0463-b6a7-4df6-b825-c5414e17a419", "item_type": "string" }, { "name": "Desc", "type": "string", "required": false, "description": "告警处理的说明", "example": "消警" } ], "required": [ "BeginTime", "EndTime", "StatusSet", "WorkspaceId", "UserId", "UserName", "ApplicationToken" ] }, { "name": "BatchReportAppMessage", "description": "批量上报应用消息", "status": "online", "parameters": [ { "name": "WorkspaceId", "type": "integer", "required": true, "description": "工作空间Id", "example": "1016" }, { "name": "ApplicationToken", "type": "string", "required": true, "description": "应用token", "example": "baSTzPx0vZ6LPuv2EifNa5CqRBj9hoY0" }, { "name": "ReportSet", "type": "array", "required": false, "description": "消息上报请求列表", "example": "{\"WorkspaceId\": 1016,\"Profile\": {\"AppType\": \"security\",},\"ReportTs\": 1,\"Properties\": \"x-json:{\\\"executeId\\\": \\\"RX_TASK\\\"}\"}", "item_type": "object", "children": [ { "name": "WorkspaceId", "type": "integer", "required": true, "description": "工作空间Id", "example": "1016" }, { "name": "Profile", "type": "object", "required": false, "description": "消息定义", "example": "{\"modelId\": 1000,\"poiCode\": \"t234329\",\"appType\": \"security_monitoring\"}", "children": [ { "name": "AppType", "type": "string", "required": true, "description": "应用类型", "example": "security_monitoring" }, { "name": "ModelId", "type": "string", "required": false, "description": "模型Id", "example": "1000" }, { "name": "PoiCode", "type": "string", "required": false, "description": "设备类型", "example": "t234329" } ] }, { "name": "ReportTs", "type": "integer", "required": false, "description": "数据上报时间", "example": "1" }, { "name": "Properties", "type": "string", "required": false, "description": "属性定义 - KV，若为json格式，需在前加上x-json:，有效字段为x-json:后的字段", "example": "x-json:{\"executeId\": \"RX_TASK\"}" }, { "name": "EventSet", "type": "string", "required": false, "description": "事件定义 - KKV，若为json格式，需在前加上x-json:，有效字段为x-json:后的字段", "example": "x-json:{\"face_control\": {\"image\": {\"data\": \"8bb1230b-78bb-4635-991b-9746dda24a9e\",\"type\": 4},\"handler\": {\"type\": 0,\"data\": \"222111123123123123\"},\"describe\": \"\",\"eventType\": 0,\"eventTs\": 1650007523091}}" }, { "name": "ServiceSet", "type": "string", "required": false, "description": "服务定义 - KKV,若为json格式，需在前加上x-json:，有效字段为x-json:后的字段", "example": "x-json:xxx" }, { "name": "ExtendTwo", "type": "string", "required": false, "description": "扩展字段2，如：算法上报id，若为json格式，需在前加上x-json:", "example": "x-json:xxx" }, { "name": "Echo", "type": "string", "required": false, "description": "透传信息，若为json格式，需在前加上x-json:，有效字段为x-json:后的字段", "example": "x-json:{\"executeId\": \"RX_TASK\"}" } ] } ], "required": [ "WorkspaceId", "ApplicationToken" ] }, { "name": "ChangeAlarmStatus", "description": "变更告警状态", "status": "online", "parameters": [ { "name": "Id", "type": "string", "required": true, "description": "告警的id，返回的列表中的id", "example": "40b52dda-c596-4510-84c4-a5e1aa6ae359" }, { "name": "Status", "type": "string", "required": true, "description": "告警状态 processed unprocessed processing misreport shield", "example": "processed" }, { "name": "ProcessTime", "type": "integer", "required": true, "description": "告警处理时间", "example": "1683343450674" }, { "name": "ProcessType", "type": "string", "required": true, "description": "处理类型", "example": "kill_warning-other" }, { "name": "WorkspaceId", "type": "integer", "required": true, "description": "工作空间id", "example": "1016" }, { "name": "UserId", "type": "string", "required": true, "description": "当前操作用户id", "example": "1" }, { "name": "UserName", "type": "string", "required": true, "description": "当前操作用户名称", "example": "andy" }, { "name": "ApplicationToken", "type": "string", "required": true, "description": "应用token", "example": "YVySZSL1Lp5UtSJ5uJVLJYOKDEGfCCH2" }, { "name": "Processor", "type": "string", "required": false, "description": "平台告警处理人", "example": "Processor" }, { "name": "ProcessDescription", "type": "string", "required": false, "description": "告警处理的描述信息", "example": "ProcessDescription" }, { "name": "ProcessExtend", "type": "string", "required": false, "description": "告警处理的扩展信息，可以为JSON字符串", "example": "ProcessExtend" }, { "name": "ExtendOne", "type": "string", "required": false, "description": "扩展字段1，目前存的应用告警处理人", "example": "extend" }, { "name": "ApplicationId", "type": "integer", "required": false, "description": "应用id", "example": "10085" } ], "required": [ "Id", "Status", "ProcessTime", "ProcessType", "WorkspaceId", "UserId", "UserName", "ApplicationToken" ] }, { "name": "ControlCameraPTZ", "description": "云台控制", "status": "online", "parameters": [ { "name": "WID", "type": "string", "required": true, "description": "设备的唯一标识", "example": "4de8f447-b4b6-4f6c-a6a2-55eeb7b0da03" }, { "name": "CMD", "type": "string", "required": true, "description": "ptz指令 left - 向左移动 right - 向右移动 up - 向上移动 down - 向下 zoomOut - 镜头缩小 zoomIn - 镜头放大 irisIn - 光圈缩小 irisOut - 光圈放大 focusIn - 焦距变近 focusOut - 焦距变远", "example": "left" }, { "name": "WorkspaceId", "type": "integer", "required": true, "description": "工作空间Id", "example": "1016" }, { "name": "ApplicationToken", "type": "string", "required": true, "description": "应用token", "example": "ct5E8QNPQEZZqNW7ShPAJQVzrTV9xIbL" } ], "required": [ "WID", "CMD", "WorkspaceId", "ApplicationToken" ] }, { "name": "ControlDevice", "description": "设备控制（单个、批量控制）", "status": "online", "parameters": [ { "name": "WorkspaceId", "type": "integer", "required": true, "description": "工作空间id", "example": "1016" }, { "name": "WIDSet", "type": "array", "required": true, "description": "设备wid，最大100个", "example": "70e673c7-11b8-4ca0-b11c-dfa360a44638", "item_type": "string" }, { "name": "ControlData", "type": "string", "required": true, "description": "控制内容", "example": "left" }, { "name": "ApplicationToken", "type": "string", "required": true, "description": "应用token", "example": "YzenL5LdGoxQM5gqJfCCoMDeGqUSsY78" }, { "name": "IsSynchronized", "type": "boolean", "required": false, "description": "是否同步返回设备下控ack结果", "example": "false" } ], "required": [ "WorkspaceId", "WIDSet", "ControlData", "ApplicationToken" ] }, { "name": "CreateApplicationToken", "description": "调用方应用，创建调用租户API的授权令牌。", "status": "online", "parameters": [ { "name": "ApplicationId", "type": "integer", "required": true, "description": "应用id", "example": "10048" }, { "name": "Nonce", "type": "string", "required": true, "description": "一个随机数或者时间戳，用于防止重放攻击，每个请求唯一，建议用uuid", "example": "f9b25481-e060-43e3-ad26-cb4e5f2e5d67" }, { "name": "TenantId", "type": "integer", "required": true, "description": "租户id", "example": "100055" }, { "name": "RequestTime", "type": "integer", "required": true, "description": "请求时间，当前时间的unix毫秒时间戳", "example": "1691028252348" }, { "name": "Signature", "type": "string", "required": true, "description": "签名方法见用户使用文档", "example": "cfed53f585017cf8f2559e3ecd84b3b4" } ], "required": [ "ApplicationId", "Nonce", "TenantId", "RequestTime", "Signature" ] }, { "name": "DeleteDeviceGroup", "description": "删除设备分组", "status": "online", "parameters": [ { "name": "Id", "type": "integer", "required": true, "description": "设备分组的id", "example": "100" }, { "name": "WorkspaceId", "type": "integer", "required": true, "description": "工作空间的id", "example": "1016" }, { "name": "ApplicationToken", "type": "string", "required": true, "description": "应用token", "example": "YVySZSL1Lp5UtSJ5uJVLJYOKDEGfCCH2" } ], "required": [ "Id", "WorkspaceId", "ApplicationToken" ] }, { "name": "DescribeActionList", "description": "动作列表查询", "status": "online", "parameters": [ { "name": "WorkspaceId", "type": "integer", "required": true, "description": "工作空间id", "example": "1016" }, { "name": "PageNumber", "type": "integer", "required": true, "description": "分页查询，第几页，必传，大于0", "example": "1" }, { "name": "PageSize", "type": "integer", "required": true, "description": "每页条数，必传大于0", "example": "1" }, { "name": "ApplicationToken", "type": "string", "required": true, "description": "应用token", "example": "baSTzPx0vZ6LPuv2EifNa5CqRBj9hoY0" }, { "name": "ActionType", "type": "string", "required": false, "description": "动作类型，（app,device,toAlarm,toNotification）", "example": "device" }, { "name": "IdSet", "type": "array", "required": false, "description": "事件id详情", "example": "214", "item_type": "integer" } ], "required": [ "WorkspaceId", "PageNumber", "PageSize", "ApplicationToken" ] }, { "name": "DescribeAdministrationByTag", "description": "根据标签获取行政区划列表", "status": "online", "parameters": [ { "name": "ApplicationToken", "type": "string", "required": true, "description": "应用token", "example": "Lawbk967Ng41d934u8vveoS" }, { "name": "WorkspaceId", "type": "integer", "required": true, "description": "工作空间ID", "example": "1016" }, { "name": "Tag", "type": "string", "required": true, "description": "标签值", "example": "城市" } ], "required": [ "ApplicationToken", "WorkspaceId", "Tag" ] }, { "name": "DescribeAlarmLevelList", "description": "告警级别枚举获取", "status": "online", "parameters": [ { "name": "WorkspaceId", "type": "integer", "required": true, "description": "工作空间id", "example": "1016" }, { "name": "ApplicationToken", "type": "string", "required": true, "description": "应用token", "example": "baSTzPx0vZ6LPuv2EifNa5CqRBj9hoY0" } ], "required": [ "WorkspaceId", "ApplicationToken" ] }, { "name": "DescribeAlarmList", "description": "告警列表查询", "status": "online", "parameters": [ { "name": "BeginTime", "type": "integer", "required": true, "description": "告警开始时间，必填,时间戳秒", "example": "1684464518" }, { "name": "EndTime", "type": "integer", "required": true, "description": "告警结束时间，必填，时间戳秒", "example": "1684723718" }, { "name": "PageNumber", "type": "integer", "required": true, "description": "分页查询，第几页", "example": "1" }, { "name": "PageSize", "type": "integer", "required": true, "description": "每页条数", "example": "1" }, { "name": "WorkspaceId", "type": "integer", "required": true, "description": "工作空间id", "example": "1016" }, { "name": "ApplicationToken", "type": "string", "required": true, "description": "应用token", "example": "YVySZSL1Lp5UtSJ5uJVLJYOKDEGfCCH2" }, { "name": "Statuses", "type": "array", "required": false, "description": "告警状态", "example": "processed", "item_type": "string" }, { "name": "AlarmTypeSet", "type": "array", "required": false, "description": "告警类型", "example": "{ \"Type\": \"test1\", \"SubType\": \"test2\" }", "item_type": "object", "children": [ { "name": "Type", "type": "string", "required": true, "description": "告警父类型", "example": "xxx-a" }, { "name": "SubType", "type": "string", "required": false, "description": "告警子类型(如果传告警子类型，则必传父类型)", "example": "xxx-b" } ] }, { "name": "LevelSet", "type": "array", "required": false, "description": "告警级别id", "example": "1", "item_type": "integer" }, { "name": "IdSet", "type": "array", "required": false, "description": "告警id", "example": "atest", "item_type": "string" }, { "name": "AppIdSet", "type": "array", "required": false, "description": "应用id", "example": "0", "item_type": "integer" }, { "name": "WIDSet", "type": "array", "required": false, "description": "设备id", "example": "xxx-aaa", "item_type": "string" }, { "name": "SpaceCodeSet", "type": "array", "required": false, "description": "空间层级", "example": "10010", "item_type": "string" }, { "name": "ExtendOne", "type": "array", "required": false, "description": "应用扩展字段1", "example": "{\\\"a\\\":\\\"t\\\"}", "item_type": "string" }, { "name": "ExtendTwo", "type": "array", "required": false, "description": "应用扩展字段2", "example": "x-json:{\"a\":\"t\"}", "item_type": "string" }, { "name": "ProcessorSet", "type": "array", "required": false, "description": "当前告警处理人，填孪生中台的用户id", "example": "13", "item_type": "string" }, { "name": "GroupIdSet", "type": "array", "required": false, "description": "分组id", "example": "[1,2,3]", "item_type": "integer" } ], "required": [ "BeginTime", "EndTime", "PageNumber", "PageSize", "WorkspaceId", "ApplicationToken" ] }, { "name": "DescribeAlarmStatusList", "description": "用来查询系统中的告警状态列表", "status": "online", "parameters": [ { "name": "ApplicationToken", "type": "string", "required": true, "description": "应用token", "example": "Lawbk967Ng41d934u8vveoS" }, { "name": "WorkspaceId", "type": "string", "required": true, "description": "工作空间ID", "example": "1016" } ], "required": [ "ApplicationToken", "WorkspaceId" ] }, { "name": "DescribeAlarmTypeList", "description": "告警类型获取", "status": "online", "parameters": [ { "name": "WorkspaceId", "type": "integer", "required": true, "description": "工作空间id", "example": "1016" }, { "name": "ApplicationToken", "type": "string", "required": true, "description": "应用token", "example": "YVySZSL1Lp5UtSJ5uJVLJYOKDEGfCCH2" }, { "name": "ParentType", "type": "string", "required": false, "description": "一级类型", "example": "ParentType" } ], "required": [ "WorkspaceId", "ApplicationToken" ] }, { "name": "DescribeApplicationList", "description": "查询指定空间关联的应用列表", "status": "online", "parameters": [ { "name": "WorkspaceId", "type": "integer", "required": true, "description": "项目空间id，本次查询返回的应用均关联至该空间", "example": "1001" }, { "name": "ApplicationToken", "type": "string", "required": true, "description": "应用token", "example": "XaaJvayJyusfUwuoJ2OlT5Z2YAVb6bVo" }, { "name": "ApplicationId", "type": "array", "required": false, "description": "应用id数组，可选，填了则表示根据id批量查询", "example": "[10000,10001,10002]", "item_type": "integer" }, { "name": "PageNumber", "type": "integer", "required": false, "description": "请求页号", "example": "1" }, { "name": "PageSize", "type": "integer", "required": false, "description": "页容量，默认为10", "example": "10" } ], "required": [ "WorkspaceId", "ApplicationToken" ] }, { "name": "DescribeBuildingList", "description": "查询建筑列表", "status": "online", "parameters": [ { "name": "WorkspaceId", "type": "string", "required": true, "description": "项目空间id", "example": "\"1109\"" }, { "name": "ApplicationToken", "type": "string", "required": true, "description": "应用token", "example": "\"LMb6piRXpioR7nmwFhXpvZd4GC4wf0B4\"" }, { "name": "HasModel", "type": "boolean", "required": false, "description": "是否有模型文件", "example": "true" }, { "name": "SpaceCodes", "type": "array", "required": false, "description": "空间编码", "example": "spacecodes", "item_type": "string" } ], "required": [ "WorkspaceId", "ApplicationToken" ] }, { "name": "DescribeBuildingModel", "description": "查询建筑三维模型", "status": "online", "parameters": [ { "name": "BuildingId", "type": "string", "required": true, "description": "建筑id", "example": "\"82d5fb5a-52d0-4636-a225-d46245e911ef\"" }, { "name": "WorkspaceId", "type": "string", "required": true, "description": "项目空间id", "example": "\"1016\"" }, { "name": "ApplicationToken", "type": "string", "required": true, "description": "应用token", "example": "\"ZRCJHdnhqEUEqO1vyskCgWimPucHhREV\"" } ], "required": [ "BuildingId", "WorkspaceId", "ApplicationToken" ] }, { "name": "DescribeBuildingProfile", "description": "查询建筑信息", "status": "online", "parameters": [ { "name": "BuildingId", "type": "string", "required": true, "description": "建筑id", "example": "\"2e374df6-7ba7-45d2-a44d-2a92bb2a6668\"" }, { "name": "WorkspaceId", "type": "string", "required": true, "description": "项目空间id", "example": "\"1016\"" }, { "name": "ApplicationToken", "type": "string", "required": true, "description": "应用token", "example": "\"0VGYLwQaH4ejNnwSMIfYtl0zlstprsdZ\"" } ], "required": [ "BuildingId", "WorkspaceId", "ApplicationToken" ] }, { "name": "DescribeCameraExtendInfo", "description": "获取视频扩展信息", "status": "online", "parameters": [ { "name": "WID", "type": "string", "required": true, "description": "设备的唯一标识", "example": "4de8f447-b4b6-4f6c-a6a2-55eeb7b0da03" }, { "name": "WorkspaceId", "type": "integer", "required": true, "description": "工作空间Id", "example": "1016" }, { "name": "ApplicationToken", "type": "string", "required": true, "description": "应用token", "example": "ct5E8QNPQEZZqNW7ShPAJQVzrTV9xIbL" } ], "required": [ "WID", "WorkspaceId", "ApplicationToken" ] }, { "name": "DescribeDeviceGroupList", "description": "设备分组列表", "status": "online", "parameters": [ { "name": "ApplicationToken", "type": "string", "required": true, "description": "应用token", "example": "Lawbk967Ng41d934u8vveoS" }, { "name": "WorkspaceId", "type": "integer", "required": true, "description": "工作空间ID", "example": "1016" }, { "name": "GroupId", "type": "integer", "required": false, "description": "分组id, 不传默认全部", "example": "12836" } ], "required": [ "ApplicationToken", "WorkspaceId" ] }, { "name": "DescribeDeviceList", "description": "设备列表查询/单个查询（支持通过筛选条件查询，设备类型、标签、PID、空间）", "status": "online", "parameters": [ { "name": "WorkspaceId", "type": "integer", "required": true, "description": "工作空间id", "example": "1016" }, { "name": "PageNumber", "type": "integer", "required": true, "description": "分页查询，第几页，必传，大于0", "example": "1" }, { "name": "PageSize", "type": "integer", "required": true, "description": "每页条数，必传大于0", "example": "1" }, { "name": "ApplicationToken", "type": "string", "required": true, "description": "应用token", "example": "wA9bELuI4oulQCBK876UDBxe00dNcxQW" }, { "name": "DeviceTypeSet", "type": "array", "required": false, "description": "设备类型，非必填", "example": "w0202", "item_type": "string" }, { "name": "ProductIdSet", "type": "array", "required": false, "description": "产品 pid，非必填", "example": "29", "item_type": "integer" }, { "name": "TagIdSet", "type": "array", "required": false, "description": "设备标签，非必填", "example": "0", "item_type": "integer" }, { "name": "SpaceCodeSet", "type": "array", "required": false, "description": "空间层级", "example": "100100", "item_type": "string" }, { "name": "DeviceTagSet", "type": "array", "required": false, "description": "设备标签名，非必填", "example": "中文标签测试", "item_type": "string" }, { "name": "WIDSet", "type": "array", "required": false, "description": "设备wid,非必填", "example": "1c902558-d360-4a93-9b6f-1b49970534f7", "item_type": "string" }, { "name": "Field", "type": "object", "required": false, "description": "自定义字段", "example": "{\"Id\": 67,\"Val\": \"1\"}", "children": [ { "name": "Id", "type": "integer", "required": false, "description": "字段id", "example": "1" }, { "name": "Val", "type": "string", "required": false, "description": "字段内容", "example": "value" } ] }, { "name": "GroupIdSet", "type": "array", "required": false, "description": "分组id列表，非必填", "example": "[1,2,3]", "item_type": "integer" }, { "name": "IsActive", "type": "string", "required": false, "description": "是否激活，默认全部，\"1\"激活，\"0\"未激活", "example": "\"1\"" }, { "name": "IsCamera", "type": "string", "required": false, "description": "是否为摄像头，默认全部，\"true\"摄像头，\"false\"非摄像头", "example": "\"false\"" } ], "required": [ "WorkspaceId", "PageNumber", "PageSize", "ApplicationToken" ] }, { "name": "DescribeDeviceShadowList", "description": "获取设备影子数据", "status": "online", "parameters": [ { "name": "WorkspaceId", "type": "integer", "required": true, "description": "工作空间id", "example": "1016" }, { "name": "WIDSet", "type": "array", "required": true, "description": "WID", "example": "8eaebd6f-d780-424e-98d6-01de5c78e25f", "item_type": "string" }, { "name": "PageNumber", "type": "integer", "required": true, "description": "分页查询，第几页", "example": "1" }, { "name": "PageSize", "type": "integer", "required": true, "description": "每页条数", "example": "20" }, { "name": "ApplicationToken", "type": "string", "required": true, "description": "应用token", "example": "Lawbk967Ng41d934u8vveoS" }, { "name": "DeviceTypeSet", "type": "array", "required": false, "description": "设备类型code", "example": "w20011", "item_type": "string" }, { "name": "ProductIdSet", "type": "array", "required": false, "description": "产品 pid", "example": "2000252", "item_type": "integer" }, { "name": "TagIdSet", "type": "array", "required": false, "description": "设备标签id", "example": "45", "item_type": "integer" }, { "name": "SpaceCodeSet", "type": "array", "required": false, "description": "空间层级，（支持空间多层，比如具体建筑、具体楼层）", "example": "000381", "item_type": "string" }, { "name": "DeviceTagSet", "type": "array", "required": false, "description": "设备标签名", "example": "DeviceTags", "item_type": "string" } ], "required": [ "WorkspaceId", "WIDSet", "PageNumber", "PageSize", "ApplicationToken" ] }, { "name": "DescribeDeviceStatusList", "description": "设备状态获取", "status": "online", "parameters": [ { "name": "WorkspaceId", "type": "integer", "required": true, "description": "工作空间id", "example": "1016" }, { "name": "ApplicationToken", "type": "string", "required": true, "description": "应用token", "example": "YVySZSL1Lp5UtSJ5uJVLJYOKDEGfCCH2" }, { "name": "PageNumber", "type": "integer", "required": true, "description": "分页查询，第几页，必传，大于0", "example": "1" }, { "name": "PageSize", "type": "integer", "required": true, "description": "每页条数，必传大于0", "example": "1" }, { "name": "DeviceTypeSet", "type": "array", "required": false, "description": "设备类型", "example": "w010101", "item_type": "string" }, { "name": "ProductIdSet", "type": "array", "required": false, "description": "产品 pid", "example": "29", "item_type": "integer" }, { "name": "TagIdSet", "type": "array", "required": false, "description": "设备标签id", "example": "0", "item_type": "integer" }, { "name": "SpaceCodeSet", "type": "array", "required": false, "description": "空间位置（支持空间多层，比如具体建筑、具体楼层）", "example": "100110", "item_type": "string" }, { "name": "WIDSet", "type": "array", "required": false, "description": "设备编号列表", "example": "be2ea997-b7f4-4167-9545-9aa275158a92", "item_type": "string" }, { "name": "DeviceTagSet", "type": "array", "required": false, "description": "设备标签名，非必填", "example": "DeviceTags", "item_type": "string" }, { "name": "DeviceStatusSet", "type": "array", "required": false, "description": "通信在/离线状态（online=normal+fault、offline）", "example": "online", "item_type": "string" }, { "name": "StatusSet", "type": "array", "required": false, "description": "设备业务状态 （正常-normal、故障-fault、离线-offline）", "example": "normal", "item_type": "string" }, { "name": "IsAlive", "type": "array", "required": false, "description": "推流状态，推流中-true，未推流-false 仅摄像头有的状态", "example": "false", "item_type": "boolean" } ], "required": [ "WorkspaceId", "ApplicationToken", "PageNumber", "PageSize" ] }, { "name": "DescribeDeviceStatusStat", "description": "设备状态统计", "status": "online", "parameters": [ { "name": "Level", "type": "integer", "required": true, "description": "所属空间地理层级，必填。0表示查询所有层级（1、2）的设备状态，1表示楼栋，2表示楼层", "example": "0" }, { "name": "WorkspaceId", "type": "integer", "required": true, "description": "工作空间id", "example": "1016" }, { "name": "ApplicationToken", "type": "string", "required": true, "description": "应用token", "example": "YVySZSL1Lp5UtSJ5uJVLJYOKDEGfCCH2" }, { "name": "SpaceCodeSet", "type": "array", "required": false, "description": "空间位置，非必填。为空表示查询所有（1，2）层级", "example": "100110", "item_type": "string" }, { "name": "DeviceTypeSet", "type": "array", "required": false, "description": "设备类型，非必填。为空表示查询所有设备类型", "example": "w02023", "item_type": "string" } ], "required": [ "Level", "WorkspaceId", "ApplicationToken" ] }, { "name": "DescribeDeviceTagList", "description": "标签列表查询", "status": "online", "parameters": [ { "name": "WorkspaceId", "type": "integer", "required": true, "description": "工作空间id", "example": "1016" }, { "name": "PageNumber", "type": "integer", "required": true, "description": "分页查询，第几页，必传，大于0", "example": "1" }, { "name": "PageSize", "type": "integer", "required": true, "description": "每页条数，必传大于0", "example": "1" }, { "name": "ApplicationToken", "type": "string", "required": true, "description": "应用token", "example": "YVySZSL1Lp5UtSJ5uJVLJYOKDEGfCCH2" } ], "required": [ "WorkspaceId", "PageNumber", "PageSize", "ApplicationToken" ] }, { "name": "DescribeDeviceTypeList", "description": "拉取设备的设备类型列表", "status": "online", "parameters": [ { "name": "WorkspaceId", "type": "integer", "required": true, "description": "工作空间id", "example": "1016" }, { "name": "ApplicationToken", "type": "string", "required": true, "description": "应用token", "example": "YzenL5LdGoxQM5gqJfCCoMDeGqUSsY78" }, { "name": "Flag", "type": "integer", "required": false, "description": "默认0只拉取设备列表关联的设备类型列表；1拉取空间下所有的设备类型列表", "example": "0" } ], "required": [ "WorkspaceId", "ApplicationToken" ] }, { "name": "DescribeEdgeApplicationToken", "description": "查询边缘应用凭证", "status": "online", "parameters": [ { "name": "ApplicationToken", "type": "string", "required": true, "description": "应用token", "example": "XaaJvayJyusfUwuoJ2OlT5Z2YAVb6bVo" }, { "name": "Refresh", "type": "boolean", "required": false, "description": "是否刷新token，默认为false", "example": "true" } ], "required": [ "ApplicationToken" ] }, { "name": "DescribeElementProfilePage", "description": "查询分页构件信息", "status": "online", "parameters": [ { "name": "BuildingId", "type": "string", "required": true, "description": "建筑id", "example": "\"956bd069-c802-4bbb-b325-18d30d7bcd3c\"" }, { "name": "PageNumber", "type": "integer", "required": true, "description": "页码", "example": "1" }, { "name": "PageSize", "type": "integer", "required": true, "description": "页容量", "example": "10" }, { "name": "WorkspaceId", "type": "string", "required": true, "description": "项目空间id", "example": "\"1016\"" }, { "name": "ApplicationToken", "type": "string", "required": true, "description": "应用token", "example": "\"ZRCJHdnhqEUEqO1vyskCgWimPucHhREV\"" }, { "name": "ParentElementIds", "type": "array", "required": false, "description": "父级构件id", "example": "parentelementIds", "item_type": "string" }, { "name": "Level", "type": "integer", "required": false, "description": "空间层级", "example": "7" }, { "name": "SpaceTypeCode", "type": "string", "required": false, "description": "空间分类代码", "example": "spacetypecode" }, { "name": "EntityTypes", "type": "array", "required": false, "description": "构件类型", "example": "[ \t\t\"TBIM_SPACE\", \t\t\"TBIM_BUILDINGSTOREY\" \t]", "item_type": "string" }, { "name": "IncludeDelete", "type": "boolean", "required": false, "description": "是否包含已删除构件", "example": "false" }, { "name": "StartTime", "type": "integer", "required": false, "description": "时间范围-开始", "example": "1683981442" }, { "name": "EndTime", "type": "integer", "required": false, "description": "时间范围-结束", "example": "1699879043" } ], "required": [ "BuildingId", "PageNumber", "PageSize", "WorkspaceId", "ApplicationToken" ] }, { "name": "DescribeElementProfileTree", "description": "查询构件树", "status": "online", "parameters": [ { "name": "BuildingId", "type": "string", "required": true, "description": "建筑id", "example": "\"82d5fb5a-52d0-4636-a225-d46245e911ef\"" }, { "name": "WorkspaceId", "type": "string", "required": true, "description": "项目空间id", "example": "\"1016\"" }, { "name": "ApplicationToken", "type": "string", "required": true, "description": "应用token", "example": "\"0VGYLwQaH4ejNnwSMIfYtl0zlstprsdZ\"" }, { "name": "ElementId", "type": "string", "required": false, "description": "父级构件id", "example": "\"61049c1b-158d-41bd-9f0b-df30a50401bd\"" }, { "name": "Level", "type": "integer", "required": false, "description": "构件级别", "example": "8" }, { "name": "SpaceTypeCode", "type": "string", "required": false, "description": "空间分类代码", "example": "spacetypecode" } ], "required": [ "BuildingId", "WorkspaceId", "ApplicationToken" ] }, { "name": "DescribeEventList", "description": "事件列表查询", "status": "online", "parameters": [ { "name": "WorkspaceId", "type": "integer", "required": true, "description": "工作空间id", "example": "1016" }, { "name": "PageNumber", "type": "integer", "required": true, "description": "分页查询，第几页，必传，大于0", "example": "1" }, { "name": "PageSize", "type": "integer", "required": true, "description": "每页条数，必传大于0", "example": "1" }, { "name": "ApplicationToken", "type": "string", "required": true, "description": "应用token", "example": "baSTzPx0vZ6LPuv2EifNa5CqRBj9hoY0" }, { "name": "TriggerType", "type": "string", "required": false, "description": "事件触发类型，(app, device, timer)", "example": "app" }, { "name": "IdSet", "type": "array", "required": false, "description": "事件id详情", "example": "112", "item_type": "integer" } ], "required": [ "WorkspaceId", "PageNumber", "PageSize", "ApplicationToken" ] }, { "name": "DescribeFileDownloadURL", "description": "获取文件下载URL", "status": "online", "parameters": [ { "name": "WorkspaceId", "type": "integer", "required": true, "description": "工作空间Id", "example": "1016" }, { "name": "FileId", "type": "string", "required": true, "description": "文件Id", "example": "fileid" }, { "name": "ApplicationToken", "type": "string", "required": true, "description": "应用token", "example": "YzenL5LdGoxQM5gqJfCCoMDeGqUSsY78" } ], "required": [ "WorkspaceId", "FileId", "ApplicationToken" ] }, { "name": "DescribeFileUploadURL", "description": "文件上传接口", "status": "online", "parameters": [ { "name": "WorkspaceId", "type": "integer", "required": true, "description": "工作空间Id", "example": "1016" }, { "name": "FileName", "type": "string", "required": true, "description": "文件名称", "example": "filename" }, { "name": "FileSize", "type": "integer", "required": true, "description": "文件大小", "example": "10" }, { "name": "ApplicationToken", "type": "string", "required": true, "description": "应用token", "example": "YzenL5LdGoxQM5gqJfCCoMDeGqUSsY78" }, { "name": "FileMD5", "type": "string", "required": false, "description": "文件MD5", "example": "e096797dd8d220861b03f8df7386037b" }, { "name": "SaveType", "type": "string", "required": false, "description": "存储类型", "example": "TEST2" }, { "name": "FileExpireTime", "type": "integer", "required": false, "description": "过期时间，过期时间戳，精确到秒的时间戳，noExpireFlag为false时必填", "example": "1680259132" }, { "name": "NoExpireFlag", "type": "boolean", "required": false, "description": "永不过期标记", "example": "false" } ], "required": [ "WorkspaceId", "FileName", "FileSize", "ApplicationToken" ] }, { "name": "DescribeInterfaceList", "description": "查询接口列表", "status": "online", "parameters": [ { "name": "ApplicationToken", "type": "string", "required": true, "description": "应用token", "example": "XaaJvayJyusfUwuoJ2OlT5Z2YAVb6bVo" }, { "name": "PageNumber", "type": "integer", "required": false, "description": "请求页号", "example": "1" }, { "name": "PageSize", "type": "integer", "required": false, "description": "请求页容量，默认全量返回", "example": "10" }, { "name": "Keyword", "type": "string", "required": false, "description": "查询关键字", "example": "视频" }, { "name": "Style", "type": "array", "required": false, "description": "接口方式 1.http 2消息通知服务", "example": "[1,2]", "item_type": "integer" }, { "name": "Type", "type": "array", "required": false, "description": "接口分类0. 其他服务 1. IOT服务 2. 空间服务 3.微应用服务 4.场景服务 5.AI算法服务 6.任务算法服务 7.第三方服务 8.3DTiles服务", "example": "[1,2]", "item_type": "integer" } ], "required": [ "ApplicationToken" ] }, { "name": "DescribeLinkRuleList", "description": "联动规则列表查询", "status": "online", "parameters": [ { "name": "WorkspaceId", "type": "integer", "required": true, "description": "工作空间id", "example": "1016" }, { "name": "PageNumber", "type": "integer", "required": true, "description": "分页查询，第几页，必传，大于0", "example": "1" }, { "name": "PageSize", "type": "integer", "required": true, "description": "每页条数，必传大于0", "example": "1" }, { "name": "ApplicationToken", "type": "string", "required": true, "description": "应用token", "example": "baSTzPx0vZ6LPuv2EifNa5CqRBj9hoY0" }, { "name": "TriggerType", "type": "string", "required": false, "description": "事件触发类型", "example": "timer" }, { "name": "IdSet", "type": "array", "required": false, "description": "联动id", "example": "112", "item_type": "integer" } ], "required": [ "WorkspaceId", "PageNumber", "PageSize", "ApplicationToken" ] }, { "name": "DescribeModelList", "description": "模型列表查询/单个查询（产品模型/标准模型）", "status": "online", "parameters": [ { "name": "WorkspaceId", "type": "integer", "required": true, "description": "工作空间id", "example": "1016" }, { "name": "PageNumber", "type": "integer", "required": true, "description": "分页查询，第几页，大于0", "example": "1" }, { "name": "PageSize", "type": "integer", "required": true, "description": "每页条数，大于0", "example": "20" }, { "name": "ApplicationToken", "type": "string", "required": true, "description": "应用token", "example": "YzenL5LdGoxQM5gqJfCCoMDeGqUSsY78" }, { "name": "DeviceTypeSet", "type": "array", "required": false, "description": "设备类型", "example": "w02020", "item_type": "string" }, { "name": "ProductIdSet", "type": "array", "required": false, "description": "产品 pid", "example": "29", "item_type": "integer" }, { "name": "ModelIdSet", "type": "array", "required": false, "description": "模型id", "example": "0123", "item_type": "string" } ], "required": [ "WorkspaceId", "PageNumber", "PageSize", "ApplicationToken" ] }, { "name": "DescribeProductList", "description": "产品列表查询", "status": "online", "parameters": [ { "name": "WorkspaceId", "type": "integer", "required": true, "description": "工作空间id", "example": "1016" }, { "name": "PageNumber", "type": "integer", "required": true, "description": "分页查询，第几页", "example": "1" }, { "name": "PageSize", "type": "integer", "required": true, "description": "每页条数，大于0", "example": "1" }, { "name": "ApplicationToken", "type": "string", "required": true, "description": "应用token", "example": "YzenL5LdGoxQM5gqJfCCoMDeGqUSsY78" }, { "name": "DeviceTypeSet", "type": "array", "required": false, "description": "设备类型", "example": "w020202", "item_type": "string" }, { "name": "ProductIdSet", "type": "array", "required": false, "description": "产品 pid", "example": "12", "item_type": "integer" }, { "name": "ModelIdSet", "type": "array", "required": false, "description": "模型id", "example": "29", "item_type": "string" } ], "required": [ "WorkspaceId", "PageNumber", "PageSize", "ApplicationToken" ] }, { "name": "DescribePropertyList", "description": "查询构件属性（详情）", "status": "online", "parameters": [ { "name": "BuildingId", "type": "string", "required": true, "description": "建筑id", "example": "\"377e4f9d-d20e-4209-b1e8-0ddb32e888c8\"" }, { "name": "ElementId", "type": "string", "required": true, "description": "构件id", "example": "\"b66aece1-62e9-49d3-872e-6e66156a853b\"" }, { "name": "WorkspaceId", "type": "string", "required": true, "description": "项目空间id", "example": "\"1124\"" }, { "name": "ApplicationToken", "type": "string", "required": true, "description": "应用token", "example": "\"Sl5ZDmVuHzhN52o8n1KWagl7sLdrLfN7\"" } ], "required": [ "BuildingId", "ElementId", "WorkspaceId", "ApplicationToken" ] }, { "name": "DescribeRuleDetail", "description": "联动规则详情查询", "status": "online", "parameters": [ { "name": "WorkspaceId", "type": "string", "required": true, "description": "工作空间id", "example": "1016" }, { "name": "Id", "type": "string", "required": true, "description": "联动id", "example": "29" }, { "name": "ApplicationToken", "type": "string", "required": true, "description": "应用token", "example": "baSTzPx0vZ6LPuv2EifNa5CqRBj9hoY0" } ], "required": [ "WorkspaceId", "Id", "ApplicationToken" ] }, { "name": "DescribeSceneList", "description": "查询场景列表", "status": "online", "parameters": [ { "name": "WorkspaceId", "type": "string", "required": true, "description": "项目空间id", "example": "\"1016\"" }, { "name": "ApplicationToken", "type": "string", "required": true, "description": "应用token", "example": "\"x1DSknvmd61KzG20nGIBAx2fD4GZB8yh\"" } ], "required": [ "WorkspaceId", "ApplicationToken" ] }, { "name": "DescribeSpaceDeviceIdList", "description": "查询指定空间设备编号列表", "status": "online", "parameters": [ { "name": "ElementIds", "type": "array", "required": true, "description": "构件id列表", "example": "[\"377a53a6-c5a7-445d-a3b7-c2d721f95408\"]", "item_type": "string" }, { "name": "IsCascade", "type": "boolean", "required": true, "description": "是否级联", "example": "true" }, { "name": "WorkspaceId", "type": "string", "required": true, "description": "项目空间id", "example": "\"1016\"" }, { "name": "PageNumber", "type": "integer", "required": true, "description": "页码", "example": "1" }, { "name": "PageSize", "type": "integer", "required": true, "description": "页容量", "example": "10" }, { "name": "ApplicationToken", "type": "string", "required": true, "description": "应用token", "example": "\"GUsHDOIP614sDxEIiliCx7GIKTqyONoX\"" } ], "required": [ "ElementIds", "IsCascade", "WorkspaceId", "PageNumber", "PageSize", "ApplicationToken" ] }, { "name": "DescribeSpaceDeviceRelationList", "description": "查询指定空间下设备与构件绑定关系列表", "status": "online", "parameters": [ { "name": "ElementIds", "type": "array", "required": true, "description": "构件id列表", "example": " [ \"82d5fb5a-52d0-4636-a225-d46245e911ef\" ]", "item_type": "string" }, { "name": "IsCascade", "type": "boolean", "required": true, "description": "是否级联", "example": "true" }, { "name": "WorkspaceId", "type": "string", "required": true, "description": "项目空间id", "example": "\"1016\"" }, { "name": "PageNumber", "type": "integer", "required": true, "description": "页码", "example": "1" }, { "name": "PageSize", "type": "integer", "required": true, "description": "页容量", "example": "10" }, { "name": "ApplicationToken", "type": "string", "required": true, "description": "应用token", "example": "\"0VGYLwQaH4ejNnwSMIfYtl0zlstprsdZ\"" } ], "required": [ "ElementIds", "IsCascade", "WorkspaceId", "PageNumber", "PageSize", "ApplicationToken" ] }, { "name": "DescribeSpaceInfoByDeviceId", "description": "查询设备绑定的空间信息", "status": "online", "parameters": [ { "name": "DeviceId", "type": "string", "required": true, "description": "设备id", "example": "\"1c902558-d360-4a93-9b6f-1b49970534f7\"" }, { "name": "WorkspaceId", "type": "string", "required": true, "description": "项目空间id", "example": "\"1016\"" }, { "name": "ApplicationToken", "type": "string", "required": true, "description": "应用token", "example": "\"0VGYLwQaH4ejNnwSMIfYtl0zlstprsdZ\"" } ], "required": [ "DeviceId", "WorkspaceId", "ApplicationToken" ] }, { "name": "DescribeSpaceRelationByDeviceId", "description": "查询设备绑定的空间层级关系", "status": "online", "parameters": [ { "name": "DeviceId", "type": "string", "required": true, "description": "设备id", "example": "\"ad655ba1-975a-4238-94d7-5d2015d1cf1f\"" }, { "name": "WorkspaceId", "type": "string", "required": true, "description": "工作空间id", "example": "\"1016\"" }, { "name": "ApplicationToken", "type": "string", "required": true, "description": "应用token", "example": "\"GUsHDOIP614sDxEIiliCx7GIKTqyONoX\"" } ], "required": [ "DeviceId", "WorkspaceId", "ApplicationToken" ] }, { "name": "DescribeSpaceTypeList", "description": "查询空间分类", "status": "online", "parameters": [ { "name": "WorkspaceId", "type": "string", "required": true, "description": "项目空间ID", "example": "\"1124\"" }, { "name": "PageNumber", "type": "integer", "required": true, "description": "页码", "example": "1" }, { "name": "PageSize", "type": "integer", "required": true, "description": "页容量", "example": "10" }, { "name": "ApplicationToken", "type": "string", "required": true, "description": "应用token", "example": "\"Sl5ZDmVuHzhN52o8n1KWagl7sLdrLfN7\"" } ], "required": [ "WorkspaceId", "PageNumber", "PageSize", "ApplicationToken" ] }, { "name": "DescribeTenantBuildingCountAndArea", "description": "查询租户楼栋数量和楼栋建筑面积", "status": "online", "parameters": [ { "name": "WorkspaceIdList", "type": "array", "required": true, "description": "租户所有工作空间ID列表", "example": " [ \"1015\", \"1016\", \"1018\" ]", "item_type": "string" }, { "name": "ApplicationToken", "type": "string", "required": true, "description": "应用token", "example": "\"ZRCJHdnhqEUEqO1vyskCgWimPucHhREV\"" } ], "required": [ "WorkspaceIdList", "ApplicationToken" ] }, { "name": "DescribeTenantDepartmentList", "description": "查询租户组织部门列表", "status": "online", "parameters": [ { "name": "Offset", "type": "integer", "required": true, "description": "翻页页码", "example": "1" }, { "name": "Limit", "type": "integer", "required": true, "description": "翻页大小", "example": "10" }, { "name": "ApplicationToken", "type": "string", "required": true, "description": "token", "example": "zD3G1qtO9Fy4mu5HAMydrXNHBputBQVS" }, { "name": "TenantId", "type": "string", "required": false, "description": "租户ID", "example": "10001" }, { "name": "UpdateAt", "type": "integer", "required": false, "description": "更新时间戳，单位秒", "example": "1680836659" }, { "name": "DepartmentId", "type": "string", "required": false, "description": "部门ID", "example": "12" }, { "name": "Cursor", "type": "string", "required": false, "description": "用户id", "example": "财务部" } ], "required": [ "Offset", "Limit", "ApplicationToken" ] }, { "name": "DescribeTenantUserList", "description": "查询租户人员列表", "status": "online", "parameters": [ { "name": "Offset", "type": "integer", "required": true, "description": "翻页页码", "example": "1" }, { "name": "Limit", "type": "integer", "required": true, "description": "翻页大小", "example": "10" }, { "name": "ApplicationToken", "type": "string", "required": true, "description": "token", "example": "Z2GWsZyAcnKt1zIK65FQz5XsFk5nTKqx" }, { "name": "TenantId", "type": "string", "required": false, "description": "租户ID", "example": "10001" }, { "name": "UpdateAt", "type": "integer", "required": false, "description": "更新时间戳，单位秒", "example": "1681314106" }, { "name": "DepartmentId", "type": "string", "required": false, "description": "部门ID", "example": "12" }, { "name": "Cursor", "type": "string", "required": false, "description": "用户id", "example": "0d0a98561b3c4f72963eba5c5fcf56e1" }, { "name": "Status", "type": "integer", "required": false, "description": "状态，0，获取所有数据，1正常启用，2禁用", "example": "1" }, { "name": "WorkspaceId", "type": "string", "required": false, "description": "项目空间id", "example": "1016" }, { "name": "Keyword", "type": "string", "required": false, "description": "关键词", "example": "keyword" }, { "name": "NoRecursive", "type": "string", "required": false, "description": "是否递归获取子级数据，0需要，1不需要，默认为0", "example": "1" } ], "required": [ "Offset", "Limit", "ApplicationToken" ] }, { "name": "DescribeVideoCloudRecord", "description": "云录像接口", "status": "online", "parameters": [ { "name": "WID", "type": "string", "required": true, "description": "设备的唯一标识", "example": "c6cb1e55-7bd7-4f08-a97b-0b530f8a66f3" }, { "name": "StartTime", "type": "integer", "required": true, "description": "录像开始时间（s）", "example": "1693466144" }, { "name": "EndTime", "type": "integer", "required": true, "description": "录像结束时间（s）", "example": "1693470107" }, { "name": "WorkspaceId", "type": "integer", "required": true, "description": "工作空间Id", "example": "1016" }, { "name": "ApplicationToken", "type": "string", "required": true, "description": "应用token", "example": "RewYT6DXVWDg51Sx8tdcj89cX1pEns2h" } ], "required": [ "WID", "StartTime", "EndTime", "WorkspaceId", "ApplicationToken" ] }, { "name": "DescribeVideoLiveStream", "description": "实时流接口", "status": "online", "parameters": [ { "name": "WID", "type": "string", "required": true, "description": "设备的唯一标识", "example": "c0e3f641-6ec6-444e-8ac9-3cfecc755cb0" }, { "name": "Protocol", "type": "string", "required": true, "description": "枚举如下： flv rtmp hls webrtc raw (视频原始帧)", "example": "hls" }, { "name": "WorkspaceId", "type": "integer", "required": true, "description": "工作空间Id", "example": "1016" }, { "name": "ApplicationToken", "type": "string", "required": true, "description": "应用token", "example": "ct5E8QNPQEZZqNW7ShPAJQVzrTV9xIbL" }, { "name": "StreamId", "type": "integer", "required": false, "description": "主码流传0，子码流传1，默认主码流", "example": "0" }, { "name": "Env", "type": "string", "required": false, "description": "设备所在环境，公有云私有化项目传0或者不传，混合云项目一般传空间id", "example": "0" } ], "required": [ "WID", "Protocol", "WorkspaceId", "ApplicationToken" ] }, { "name": "DescribeVideoRecordStream", "description": "历史流接口", "status": "online", "parameters": [ { "name": "WID", "type": "string", "required": true, "description": "设备唯一标识", "example": "693bc0a4-ca2b-4f37-af04-4c8c0a88e000" }, { "name": "Protocol", "type": "string", "required": true, "description": "枚举如下： flvsh rtmp hls webrtc raw (视频原始帧)", "example": "hls" }, { "name": "StartTime", "type": "integer", "required": true, "description": "开始时间（精确到毫秒）", "example": "1699876800" }, { "name": "EndTime", "type": "integer", "required": true, "description": "结束时间（精确到毫秒）", "example": "1699876817" }, { "name": "PlayBackRate", "type": "float", "required": true, "description": "倍速 0.5、1、2、4", "example": "1" }, { "name": "WorkspaceId", "type": "integer", "required": true, "description": "工作空间id", "example": "1016" }, { "name": "ApplicationToken", "type": "string", "required": true, "description": "应用token", "example": "Lawbk967Ng41d934u8vveoSJgsj" }, { "name": "Stream", "type": "string", "required": false, "description": "流的唯一标识，播放链接尾缀", "example": "c6cb1e55-7bd7-4f08-a97b-0b530f8a60f1" }, { "name": "Env", "type": "string", "required": false, "description": "公有云私有化项目传0或者不传；混合云项目一般传空间id", "example": "0" } ], "required": [ "WID", "Protocol", "StartTime", "EndTime", "PlayBackRate", "WorkspaceId", "ApplicationToken" ] }, { "name": "DescribeWorkSpaceBuildingCountAndArea", "description": "查询项目空间楼栋数量与建筑面积", "status": "online", "parameters": [ { "name": "WorkspaceIdList", "type": "array", "required": true, "description": "工作空间ID列表", "example": " [ \t\t\"1016\", \t\t\"1015\", \t\t\"1018\" \t]", "item_type": "string" }, { "name": "ApplicationToken", "type": "string", "required": true, "description": "应用token", "example": "\"fquCgDi2QfNDMlNyQ5YPoMR2Zw4tQs2B\"" } ], "required": [ "WorkspaceIdList", "ApplicationToken" ] }, { "name": "DescribeWorkspaceList", "description": "获取租户下的空间列表", "status": "online", "parameters": [ { "name": "ApplicationToken", "type": "string", "required": true, "description": "应用token", "example": "XaaJvayJyusfUwuoJ2OlT5Z2YAVb6bVo" }, { "name": "WorkspaceId", "type": "integer", "required": false, "description": "工作空间id，非必填，填了则表示根据id进行批量查询", "example": "1101" } ], "required": [ "ApplicationToken" ] }, { "name": "DescribeWorkspaceUserList", "description": "查询项目空间人员列表", "status": "online", "parameters": [ { "name": "Offset", "type": "integer", "required": true, "description": "翻页页码", "example": "1" }, { "name": "Limit", "type": "integer", "required": true, "description": "翻页大小", "example": "10" }, { "name": "WorkspaceId", "type": "string", "required": true, "description": "工作空间ID", "example": "1016" }, { "name": "ApplicationToken", "type": "string", "required": true, "description": "token", "example": "o9ftuUNOFkOVf2o5etJ0nHou396ufAes" }, { "name": "TenantId", "type": "string", "required": false, "description": "租户ID", "example": "10001" }, { "name": "UpdateAt", "type": "integer", "required": false, "description": "更新时间戳，单位秒", "example": "1689755305" } ], "required": [ "Offset", "Limit", "WorkspaceId", "ApplicationToken" ] }, { "name": "ModifyDeviceField", "description": "批量修改设备自定义字段值", "status": "online", "parameters": [ { "name": "WorkspaceId", "type": "integer", "required": true, "description": "工作空间id", "example": "1016" }, { "name": "Set", "type": "array", "required": true, "description": "设备自定义字段修改信息集合", "example": "[{\"WID\":\"wid\",\"Key\":\"size\",\"Val\":\"100\"}}]", "item_type": "object", "children": [ { "name": "WID", "type": "string", "required": true, "description": "设备id", "example": "be2ea997-b7f4-4167-9545-9aa275158a92" }, { "name": "Key", "type": "string", "required": true, "description": "自定义字段key", "example": "keyname" }, { "name": "Val", "type": "string", "required": true, "description": "自定义字段值", "example": "value" } ] }, { "name": "ApplicationToken", "type": "string", "required": true, "description": "应用token", "example": "YVySZSL1Lp5UtSJ5uJVLJYOKDEGfCCH2" } ], "required": [ "WorkspaceId", "Set", "ApplicationToken" ] }, { "name": "ModifyDeviceGroup", "description": "批量修改设备组", "status": "online", "parameters": [ { "name": "WorkspaceId", "type": "integer", "required": true, "description": "工作空间id", "example": "1016" }, { "name": "Set", "type": "array", "required": true, "description": "设备组修改信息集合", "example": "[{\"WID\":\"wid1\",\"GroupId\":100},{\"WID\":\"wid2\",\"GroupId\":100}]", "item_type": "object", "children": [ { "name": "WID", "type": "string", "required": true, "description": "设备id", "example": "be2ea997-b7f4-4167-9545-9aa275158a92" }, { "name": "GroupId", "type": "integer", "required": true, "description": "设备分组id", "example": "100" } ] }, { "name": "ApplicationToken", "type": "string", "required": true, "description": "应用token", "example": "YVySZSL1Lp5UtSJ5uJVLJYOKDEGfCCH2" } ], "required": [ "WorkspaceId", "Set", "ApplicationToken" ] }, { "name": "ModifyDeviceName", "description": "批量修改设备名字", "status": "online", "parameters": [ { "name": "WorkspaceId", "type": "integer", "required": true, "description": "工作空间id", "example": "1016" }, { "name": "Set", "type": "array", "required": true, "description": "设备修改信息集合", "example": "{\"WID\":\"be2ea997-b7f4-4167-9545-9aa275158a92\",\"DeviceName\":\"devicename\"}", "item_type": "object", "children": [ { "name": "WID", "type": "string", "required": true, "description": "设备id", "example": "be2ea997-b7f4-4167-9545-9aa275158a92" }, { "name": "DeviceName", "type": "string", "required": true, "description": "修改后的设备名字", "example": "devicename" } ] }, { "name": "ApplicationToken", "type": "string", "required": true, "description": "应用token", "example": "YVySZSL1Lp5UtSJ5uJVLJYOKDEGfCCH2" } ], "required": [ "WorkspaceId", "Set", "ApplicationToken" ] }, { "name": "ModifyDeviceTag", "description": "批量修改设备标签", "status": "online", "parameters": [ { "name": "WorkspaceId", "type": "integer", "required": true, "description": "工作空间id", "example": "1016" }, { "name": "Set", "type": "array", "required": true, "description": "设备标签修改信息集合", "example": "[{\"WID\":\"wid\",\"NameSet\":[\"name1\",\"name2\"]}]", "item_type": "object", "children": [ { "name": "WID", "type": "string", "required": true, "description": "设备id", "example": "be2ea997-b7f4-4167-9545-9aa275158a92" }, { "name": "NameSet", "type": "array", "required": true, "description": "设备标签名称集合", "example": "[\"aaa\",\"bbb\"]", "item_type": "string" } ] }, { "name": "ApplicationToken", "type": "string", "required": true, "description": "应用token", "example": "YVySZSL1Lp5UtSJ5uJVLJYOKDEGfCCH2" } ], "required": [ "WorkspaceId", "Set", "ApplicationToken" ] }, { "name": "ReportAppMessage", "description": "上报应用消息", "status": "online", "parameters": [ { "name": "WorkspaceId", "type": "integer", "required": true, "description": "工作空间Id", "example": "1016" }, { "name": "Profile", "type": "object", "required": true, "description": "消息定义", "example": "{\"modelId\": \"1000\",\"poiCode\": \"t234329\",\"appType\": \"security_monitoring\"}", "children": [ { "name": "AppType", "type": "string", "required": true, "description": "应用类型", "example": "security_monitoring" }, { "name": "ModelId", "type": "string", "required": false, "description": "模型Id", "example": "1000" }, { "name": "PoiCode", "type": "string", "required": false, "description": "设备类型", "example": "t234329" } ] }, { "name": "ReportTs", "type": "integer", "required": true, "description": "数据上报时间", "example": "1" }, { "name": "Properties", "type": "string", "required": true, "description": "属性定义 - KV的json格式,有效字段为x-json:后的字段", "example": "x-json:{\"executeId\": \"RX_TASK\"}" }, { "name": "ApplicationToken", "type": "string", "required": true, "description": "应用token", "example": "baSTzPx0vZ6LPuv2EifNa5CqRBj9hoY0" }, { "name": "EventSet", "type": "string", "required": false, "description": "事件定义 - KKV的json格式,有效字段为x-json:后的字段", "example": "x-json:{\"face_control\": {\"image\": {\"data\": \"8bb1230b-78bb-4635-991b-9746dda24a9e\",\"type\": 4},\"handler\": {\"type\": 0,\"data\": \"222111123123123123\"},\"describe\": \"\",\"eventType\": 0,\"eventTs\": 1650007523091}}" }, { "name": "ServiceSet", "type": "string", "required": false, "description": "服务定义 - KKV的json格式,有效字段为x-json:后的字段", "example": "x-json:{}" }, { "name": "ExtendTwo", "type": "string", "required": false, "description": "扩展字段2，如：算法上报id，若为json格式，需传x-json:{}，有效字段为x-json:后的字段", "example": "extendtwo" }, { "name": "Echo", "type": "string", "required": false, "description": "透传信息，若为json格式，需传x-json:{}，有效字段为x-json:后的字段", "example": "echo" } ], "required": [ "WorkspaceId", "Profile", "ReportTs", "Properties", "ApplicationToken" ] }, { "name": "SaveDeviceGroup", "description": "设备分组新增/修改", "status": "online", "parameters": [ { "name": "Name", "type": "string", "required": true, "description": "分组名称", "example": "云API分组" }, { "name": "Description", "type": "string", "required": true, "description": "分组描述", "example": "云API分组描述" }, { "name": "WorkspaceId", "type": "integer", "required": true, "description": "空间id", "example": "1016" }, { "name": "ApplicationToken", "type": "string", "required": true, "description": "应用token", "example": "YVySZSL1Lp5UtSJ5uJVLJYOKDEGfCCH2" }, { "name": "Id", "type": "integer", "required": false, "description": "分组id, 携带则为修改, 不携带则为新增", "example": "100" }, { "name": "ParentId", "type": "integer", "required": false, "description": "分组父级id", "example": "1" } ], "required": [ "Name", "Description", "WorkspaceId", "ApplicationToken" ] }, { "name": "StopVideoStreaming", "description": "断流接口", "status": "online", "parameters": [ { "name": "Stream", "type": "string", "required": true, "description": "流的唯一标识，播放链接尾缀", "example": "c0e3f641-6ec6-444e-8ac9-3cfecc755cb0" }, { "name": "WID", "type": "string", "required": true, "description": "设备的唯一标识", "example": "c0e3f641-6ec6-444e-8ac9-3cfecc755cb0" }, { "name": "WorkspaceId", "type": "integer", "required": true, "description": "工作空间Id", "example": "1016" }, { "name": "ApplicationToken", "type": "string", "required": true, "description": "应用token", "example": "RewYT6DXVWDg51Sx8tdcj89cX1pEns2h" } ], "required": [ "Stream", "WID", "WorkspaceId", "ApplicationToken" ] }, { "name": "UpdateWorkspaceParkAttributes", "description": "修改工作空间园区属性", "status": "online", "parameters": [ { "name": "WorkspaceId", "type": "integer", "required": true, "description": "工作空间id", "example": "1016" }, { "name": "ApplicationToken", "type": "string", "required": true, "description": "应用token", "example": "vfy4zPtG74k6OYKr9rNa9" }, { "name": "ParkName", "type": "string", "required": false, "description": "园区简称", "example": "parkname" }, { "name": "ParkNum", "type": "string", "required": false, "description": "园区编号", "example": "1023" } ], "required": [ "WorkspaceId", "ApplicationToken" ] } ] }