修改设备(API名称:updateDevice)
功能介绍
该接口用于与客户系统对接修改设备。
相关API
调用流程
URL
请求方式 |
HTTPS地址 |
服务架构 |
消息体类型 |
---|---|---|---|
POST |
https://isdp+域名/openapi/v1/ivmRemote/updateDevice |
OpenAPI |
application/json |
请求头
KEY |
VALUE |
是否必填 |
描述 |
---|---|---|---|
Content-Type |
application/json |
是 |
无 |
Authorization |
bearer ${access_token} |
是 |
bearer +“ ”+5.2.1中获取的access_token的值 |
请求参数
参数 |
类型 |
是否必填 |
描述 |
---|---|---|---|
deviceId |
String |
是 |
设备编号,请输入数字、英文、_、#等字符 获取设备编号API请参见:摄像头列表查询(好望云平台)(API名称:getDeviceList) |
isdpDeviceId |
String |
是 |
isdp唯一设备ID 获取isdp唯一设备ID API请参见:摄像头列表查询(好望云平台)(API名称:getDeviceList) |
deviceName |
String |
是 |
设备名称,请输入数字、中文、英文、_、-等字符 |
deviceAddress |
String |
否 |
设备位置信息 |
projectName |
String |
否 |
项目名称 |
projectNumber |
String |
否 |
项目编码 |
model |
String |
否 |
model |
deviceType |
Long |
是 |
设备类型 可选值WEBCAM/MONITOR_BALL/BODY_WORN_CAMERA/INTELLIGENT_SAFETY_HELMET/INTELLIGENT_MINER_L IGHT/MOBILE/IVS1800/IVS3800 多个以英文逗号分隔,不传默认查询所有 |
deviceManageState |
String |
否 |
设备管理状态 可选值NoActivation/ ACTIVATION,不传默认空 |
deviceSubType |
String |
否 |
设备子类型 |
manufacture |
String |
否 |
制造商 |
description |
String |
否 |
描述 |
deviceAddressNumber |
String |
否 |
设备位置编码 |
autoJoin |
String |
是 |
是否主动接入视频 可选值Y或者N,Y标识开启,N标识不开启 |
enableEndSide |
String |
是 |
是否开启边缘AI 可选值Y或者N,Y标识开启,N标识不开启 |
enableVideoRecording |
String |
是 |
是否开启视频录制 可选值Y或者N,Y标识开启,N标识不开启 |
ownnerId |
Long |
否 |
设备责任人Id |
deviceUserId |
Long |
否 |
设备使用人Id |
customerOrgName |
String |
否 |
使用区域名称 |
customerOrgCode |
String |
否 |
使用区域编码 |
buOrgId |
Long |
是 |
组织Id |
buOrgName |
String |
是 |
组织名称 |
响应参数
参数 |
类型 |
描述 |
---|---|---|
isdpDeviceId |
String |
isdp唯一设备ID |
deviceId |
String |
设备ID |
channelId |
String |
通道ID |
deviceName |
String |
设备名称 |
deviceState |
String |
设备状态 |
accessProtocol |
String |
接入协议 |
deviceType |
String |
设备类型 |
deviceSystemState |
String |
设备管理状态 |
description |
String |
描述 |
model |
String |
设备型号 |
manufacture |
String |
生产厂商 |
channelTotal |
int |
通道总数 |
streamTotal |
int |
每个通道码流数量 |
firmware |
String |
摄像头固件版本号 |
deviceAbility |
String |
能力集 |
mac |
String |
mac地址 |
createTime |
String |
创建时间 |
updateTime |
String |
更新时间 |
protocolVersion |
String |
协议版本 |
deviceIp |
String |
设备ip |
devicePort |
String |
设备端口 |
projectName |
String |
项目名称 |
projectNumber |
String |
项目编码 |
deviceAddress |
String |
设备地址 |
fileId |
String |
图片编号 |
sysType |
String |
系统类型 |
fileSize |
String |
文件大小 |
fileName |
String |
文件名称 |
fileExt |
String |
文件扩展名 |
deviceAddressNumber |
String |
设备地址编号 |
deviceSubType |
String |
子设备类型 |
deviceAlarmStatus |
String |
设备告警状态 |
autoJoin |
String |
是否主动入会 |
battery |
String |
电量 |
ownnerId |
String |
设备责任人ID |
longitude |
String |
经度 |
latitude |
String |
纬度 |
chatJid |
String |
IM群组ID |
chatId |
String |
IM聊天ID |
liveChannelId |
String |
频道播放ID |
userName |
String |
设备使用人名称 |
ownnerName |
String |
设备责任人名称 |
webPlayUrl |
String |
web播放地址 |
bindStatus |
Integer |
设备绑定状态 |
bindUserId |
Long |
设备绑定的用户Id |
buOrgId |
Long |
设备所在组织Id |
buOrgName |
String |
设备所在组织名称 |
coordType |
String |
坐标类型 |
creationDate |
Date |
创建时间 |
deviceManageState |
String |
设备管理状态 |
deviceStateBefore |
String |
设备上报之前的状态 |
deviceTypeName |
String |
设备类型名称 |
deviceUserId |
Long |
设备使用人Id |
deviceUserName |
String |
设备使用人名称 |
deviceUserNameOnly |
String |
设备使用人名称 |
enableEndSide |
String |
是否开启边缘AI |
enableVideoRecording |
String |
是否开启录像 |
groupId |
Long |
群组Id |
groupName |
String |
群组名称 |
integrationPlatform |
String |
集成平台 |
lastReportTime |
Date |
最后一次上报时间(时间戳) |
lastUpdateDate |
Date |
最后更新时间(时间戳) |
lastUpdatedBy |
Long |
最后更新人 |
onlineDuration |
Long |
设备在线时长 |
stateChangeReason |
String |
设备状态改变原因 |
stateChangeReasonCode |
String |
设备状态改变原因码 |
storageRemain |
Long |
存储保留 |
storageTotal |
Long |
存储总计 |
deviceTypeName |
String |
设备类型名称 |
tenantId |
Long |
租户Id |
请求示例
{ "deviceId" : "rerererr", "deviceName" : "rerererr", "deviceAddress" : "", "projectName" : null, "model" : "", "deviceType" : "INTELLIGENT_SAFETY_HELMET", "deviceManageState" : "ACTIVATION", "deviceSubType" : "其他", "manufacture" : "", "description" : "", "deviceAddressNumber" : "", "projectNumber" : null, "isdpDeviceId" : "rerererr--1", "ownnerId" : null, "deviceUserId" : null, "buOrgName" : "杨凌作业系统测试", "buOrgId" : 830, "customerOrgName" : "", "customerOrgCode" : "", "autoJoin" : "Y", "enableEndSide" : "Y", "enableVideoRecording" : "Y" }
响应示例
{ "status" : 1, "message" : "SUCCESS", "error" : null, "data" : { "deviceId" : "rerererr", "deviceName" : "rerererr", "publicKey" : null, "deviceState" : null, "deviceType" : null, "description" : "", "createTime" : null, "updateTime" : null, "accessProtocol" : null, "manufacture" : "", "channelTotal" : 0, "streamTotal" : 0, "deviceSystemState" : null, "model" : "", "firmware" : null, "deviceAbility" : null, "mac" : null, "protocolVersion" : null, "deviceIp" : null, "devicePort" : null, "tenantId" : 0, "lastUpdatedBy" : 0, "createdBy" : 0, "projectNumber" : "", "projectName" : "", "deviceAddress" : "", "deviceAddressNumber" : "", "fileId" : null, "sysType" : null, "fileSize" : null, "fileName" : null, "fileExt" : null, "webPlayUrl" : null, "verificationCode" : null, "password" : null, "isdpDeviceId" : "rerererr--1", "channelId" : null, "deviceAlarmStatus" : null, "deviceManageState" : "", "deviceSubType" : null, "sort" : null, "sortBy" : null, "autoJoin" : "Y", "battery" : null, "ownnerName" : null, "ownnerId" : null, "deviceGbUsername" : null, "deviceGbPassword" : null, "buOrgId" : 830, "deviceUserId" : null, "deviceUserName" : null, "longitude" : null, "latitude" : null, "coordType" : null, "buOrgName" : "杨凌作业系统测试", "storageTotal" : null, "storageRemain" : null, "onlineDuration" : null, "groupName" : null, "enableEndSide" : "Y", "updateDeviceType" : true, "networkType" : null, "systemVersion" : null, "applicationVersionName" : null, "applicationVersionCode" : null, "enableVideoRecording" : "Y", "deleteFlag" : 0, "functionCode" : null, "functionAutho" : null, "ivsLoginAccount" : null, "ivsLoginPsw" : null, "isPlayNode" : 0, "ivsLoginUrl" : null, "parentDeviceId" : null, "integrationPlatform" : null, "subDeviceTotal" : 0, "activeType" : false, "orgId" : null, "orgPath" : "-1.830", "userId" : null, "searchType" : 0, "domainCode" : null, "stateChangeReason" : null, "stateChangeReasonCode" : null, "deviceStateBefore" : null, "cloudRecords" : null, "chatJid" : null, "chatId" : null, "liveChannelId" : null, "startTime" : null, "endTime" : null, "status" : 0, "exportExcel" : null, "customerOrgName" : "", "customerOrgCode" : "", "orgIdList" : null, "groupId" : null, "lastReportTime" : null, "reportTime" : null, "reportType" : false, "createState" : null, "filter" : null, "helmetFilter" : null, "platFilter" : null, "webcam" : false }, "timestamp" : "2022-09-06T18:10:18.883+0800" }
状态码
状态码请参见状态码。
错误码
错误码请参见错误码。