Class: APIClient

APIClient(domainOrOptionsopt)

new APIClient(domainOrOptionsopt)

demo
Parameters:
Name Type Attributes Description
domainOrOptions string | object <optional>
 The project domain or options object. If object, see the object's optional properties.
Properties
Name Type Attributes Description
domain string <optional>
 The project domain
token object <optional>
 auth token - object with value property and optional headerOrQueryName and isQuery properties
Source:

Methods

addArchivesUsingPOST(parameters)

新增设备档案
Parameters:
Name Type Description
parameters object method options and parameters
Properties
Name Type Description
addArchive addArchive
sessionToken string session-token
Source:

addDeviceDelegationsUsingPOST(parameters)

新增设备转授
Parameters:
Name Type Description
parameters object method options and parameters
Properties
Name Type Description
request request
sessionToken string session-token
Source:

addDeviceSharesUsingPOST(parameters)

新增设备分享信息
Parameters:
Name Type Description
parameters object method options and parameters
Properties
Name Type Description
request request
sessionToken string session-token
Source:

addDevicesUsingPOST(parameters)

批量导入设备
Parameters:
Name Type Description
parameters object method options and parameters
Properties
Name Type Description
deviceImport deviceImport
sessionToken string session-token
Source:

addDeviceUsingPOST(parameters)

导入单个设备
Parameters:
Name Type Description
parameters object method options and parameters
Properties
Name Type Description
addDevice addDevice
sessionToken string session-token
Source:

addExternalDataUsingPOST(parameters)

添加外部数据
Parameters:
Name Type Description
parameters object method options and parameters
Properties
Name Type Description
addExternalData addExternalData
sessionToken string session-token
Source:

assignDevicesUsingPUT(parameters)

分配设备
Parameters:
Name Type Description
parameters object method options and parameters
Properties
Name Type Description
assignDevice assignDevice
sessionToken string session-token
Source:

checkCommandScriptUsingPOST(parameters)

验证短信验证码
Parameters:
Name Type Description
parameters object method options and parameters
Properties
Name Type Description
smsVerificationRequest smsVerificationRequest
appToken string appToken
Source:

deleteArchiveByDeviceIdUsingDELETE(parameters)

删除设备档案
Parameters:
Name Type Description
parameters object method options and parameters
Properties
Name Type Description
sessionToken string session-token
archiveName string 档案类型
deviceId string 设备ID
Source:

deleteArchivesBySQLUsingDELETE(parameters)

根据sql删除设备档案
Parameters:
Name Type Description
parameters object method options and parameters
Properties
Name Type Description
findMongoDataRequest findMongoDataRequest
sessionToken string session-token
Source:

deleteArchivesUsingDELETE(parameters)

删除设备档案
Parameters:
Name Type Description
parameters object method options and parameters
Properties
Name Type Description
sessionToken string session-token
archiveName string 档案类型
archiveId string 设备档案ID
Source:

deleteDeviceDelegationsUsingDELETE(parameters)

收回设备转授
Parameters:
Name Type Description
parameters object method options and parameters
Properties
Name Type Description
delegateId integer delegateId
sessionToken string session-token
Source:

deleteDeviceSharesUsingDELETE(parameters)

收回设备分享
Parameters:
Name Type Description
parameters object method options and parameters
Properties
Name Type Description
shareId integer shareId
sessionToken string session-token
Source:

deleteDevicesUsingDELETE(parameters)

删除设备
Parameters:
Name Type Description
parameters object method options and parameters
Properties
Name Type Description
deviceId string deviceId
sessionToken string session-token
Source:

deleteExternalDataBySQLUsingDELETE(parameters)

根据sql删除外部数据
Parameters:
Name Type Description
parameters object method options and parameters
Properties
Name Type Description
mongoDataRequest mongoDataRequest
sessionToken string session-token
Source:

deleteExternalDataUsingDELETE(parameters)

删除外部数据
Parameters:
Name Type Description
parameters object method options and parameters
Properties
Name Type Description
sessionToken string session-token
externalDataName string 外部数据名
recordId string 外部数据id
Source:

deleteUserByUserIdUsingDELETE(parameters)

删除子用户
Parameters:
Name Type Description
parameters object method options and parameters
Properties
Name Type Description
userId integer userId
sessionToken string session-token
Source:

disableDevicesByIdUsingPUT(parameters)

停用设备
Parameters:
Name Type Description
parameters object method options and parameters
Properties
Name Type Description
deviceId string deviceId
sessionToken string session-token
Source:

disableUserUsingPUT(parameters)

停用子用户
Parameters:
Name Type Description
parameters object method options and parameters
Properties
Name Type Description
userId integer userId
sessionToken string session-token
Source:

emailVerificationUsingPOST(parameters)

验证邮箱验证码
Parameters:
Name Type Description
parameters object method options and parameters
Properties
Name Type Description
emailVerificationRequest emailVerificationRequest
appToken string appToken
Source:

enableDevicesByIdUsingPUT(parameters)

启用设备
Parameters:
Name Type Description
parameters object method options and parameters
Properties
Name Type Description
deviceId string deviceId
sessionToken string session-token
Source:

enableUserUsingPUT(parameters)

启用子用户
Parameters:
Name Type Description
parameters object method options and parameters
Properties
Name Type Description
userId integer userId
sessionToken string session-token
Source:

findArchivesUsingPOST(parameters)

查询设备档案列表
Parameters:
Name Type Description
parameters object method options and parameters
Properties
Name Type Description
mongoDataRequest mongoDataRequest
sessionToken string session-token
Source:

findCustomPermissionByUserUsingGET(parameters)

查询当前用户拥有的自定义权限
Parameters:
Name Type Description
parameters object method options and parameters
Properties
Name Type Description
sessionToken string session-token
Source:

findCustomPermissionUsingGET(parameters)

查询自定义权限
Parameters:
Name Type Description
parameters object method options and parameters
Properties
Name Type Description
sessionToken string session-token
customPermissionId string 自定义权限的id（不支持模糊查询）
customPermissionName string 自定义权限名
pageNum string 页数
pageSize string 每页条数
Source:

findDeviceAlarmUsingPOST(parameters)

查询告警数据
Parameters:
Name Type Description
parameters object method options and parameters
Properties
Name Type Description
findMongoDataRequest findMongoDataRequest
sessionToken string session-token
Source:

findDeviceDataUsingPOST(parameters)

查询全局设备数据
Parameters:
Name Type Description
parameters object method options and parameters
Properties
Name Type Description
mongoDataRequest mongoDataRequest
sessionToken string session-token
Source:

findExternalDataByIdUsingGET(parameters)

根据id查询某一条外部数据
Parameters:
Name Type Description
parameters object method options and parameters
Properties
Name Type Description
sessionToken string session-token
id string 外部数据id
externalDataName string 外部数据名
Source:

findExternalDataUsingPOST(parameters)

查询外部数据
Parameters:
Name Type Description
parameters object method options and parameters
Properties
Name Type Description
findMongoDataRequest findMongoDataRequest
sessionToken string session-token
Source:

findRoleAllowRegUsingGET(parameters)

查询允许注册的角色
Parameters:
Name Type Description
parameters object method options and parameters
Properties
Name Type Description
appToken string appToken
Source:

findRoleNameListUsingGET(parameters)

查询当前用户所能创建的角色
Parameters:
Name Type Description
parameters object method options and parameters
Properties
Name Type Description
sessionToken string session-token
Source:

findSingleArchiveByDeviceIdUsingGET(parameters)

根据设备id查询设备档案
Parameters:
Name Type Description
parameters object method options and parameters
Properties
Name Type Description
sessionToken string session-token
archiveName string 档案类型
deviceId string 设备ID
Source:

findSingleArchiveUsingGET(parameters)

查询单个设备档案
Parameters:
Name Type Description
parameters object method options and parameters
Properties
Name Type Description
sessionToken string session-token
archiveName string 档案类型
archiveId string 设备档案ID
Source:

findStatisticsDataUsingPOST(parameters)

查询统计数据
Parameters:
Name Type Description
parameters object method options and parameters
Properties
Name Type Description
findMongoDataRequest findMongoDataRequest
sessionToken string session-token
Source:

findStatTaskDataUsingPOST(parameters)

查询离线统计数据
Parameters:
Name Type Description
parameters object method options and parameters
Properties
Name Type Description
findMongoDataRequest findMongoDataRequest
sessionToken string session-token
Source:

findTableConfigUsingGET(parameters)

查询表配置信息，返回格式：{ "tableName": [ { "field_desc": "求均值", "field_type": "6", "field_name": "avgZ" ...... } ...... ] }其中field_type，1：String；2：int；3：Float；4：Boolean；5：Long；6：Double；7：Date
Parameters:
Name Type Description
parameters object method options and parameters
Properties
Name Type Description
sessionToken string session-token
tableType integer 表类型,2：转换数据；3：实时统计数据；4：告警数据；5：离线统计数据；6：外部数据；7：档案数据；
tableName string 表名
Source:

findTemplateByIdUsingGET(parameters)

查询指定sql模版
Parameters:
Name Type Description
parameters object method options and parameters
Properties
Name Type Description
sqlTemplateId integer sqlTemplateId
sessionToken string session-token
Source:

getCommandStatusByCmdUuidUsingGET(parameters)

查询命令状态
Parameters:
Name Type Description
parameters object method options and parameters
Properties
Name Type Description
cmdUuid string cmdUuid
sessionToken string session-token
Source:

getCommandStatusListUsingGET(parameters)

查询命令状态列表
Parameters:
Name Type Description
parameters object method options and parameters
Properties
Name Type Description
sessionToken string session-token
commandName string 命令名称
deviceId string 设备ID
deviceName string 设备名称
status string 命令状态
pageNum string 页数
pageSize string 每页条数
Source:

getDeviceDelegateOthersUsingGET(parameters)

查询转授出去的设备列表
Parameters:
Name Type Description
parameters object method options and parameters
Properties
Name Type Description
sessionToken string session-token
deviceId string 设备ID
toUserLoginName string 被转授人loginName
toUserUserName string 被转授人userName
startDate string 开始日期
endDate string 截止日期
pageNum string 页数
pageSize string 每页条数
Source:

getDeviceDelegateSelfUsingGET(parameters)

查询转授给自己的设备列表
Parameters:
Name Type Description
parameters object method options and parameters
Properties
Name Type Description
sessionToken string session-token
deviceId string 设备ID
fromUserLoginName string 转授人loginName
fromUserUserName string 转授人userName
startDate string 开始日期
endDate string 截止日期
pageNum string 页数
pageSize string 每页条数
Source:

getDeviceDelegationsByIdUsingGET(parameters)

查询设备转授
Parameters:
Name Type Description
parameters object method options and parameters
Properties
Name Type Description
delegateId integer delegateId
sessionToken string session-token
Source:

getDeviceDelegationsListUsingGET(parameters)

查询设备转授列表(仅超管可用)
Parameters:
Name Type Description
parameters object method options and parameters
Properties
Name Type Description
sessionToken string session-token
deviceId string 设备ID
fromUserLoginName string 转授人
toUserLoginName string 被转授人
startDate string 开始日期
endDate string 截止日期
pageNum string 页数
pageSize string 每页条数
Source:

getDeviceLogsListUsingGET(parameters)

查询设备日志列表
Parameters:
Name Type Description
parameters object method options and parameters
Properties
Name Type Description
sessionToken string session-token
deviceId string 设备ID
deviceName string 设备名称
logType string 日志类型
beginDate string 开始日期
endDate string 结束日期
userName string 用户名
operator string 操作人
pageNum string 页数
pageSize string 每页条数
Source:

getDevicesByIdUsingGET(parameters)

查询设备信息
Parameters:
Name Type Description
parameters object method options and parameters
Properties
Name Type Description
deviceId string deviceId
sessionToken string session-token
Source:

getDeviceShareOthersUsingGET(parameters)

查询分享出去的设备列表
Parameters:
Name Type Description
parameters object method options and parameters
Properties
Name Type Description
sessionToken string session-token
deviceId string 设备id
toUserLoginName string 被分享者登录名
toUserUserName string 被分享者用户名
startDate string 开始时间
endDate string 结束时间
pageNum string 页数
pageSize string 每页条数
Source:

getDeviceSharesByIdUsingGET(parameters)

查询设备分享信息
Parameters:
Name Type Description
parameters object method options and parameters
Properties
Name Type Description
shareId integer shareId
sessionToken string session-token
Source:

getDeviceShareSelfUsingGET(parameters)

查询分享给自己的设备列表
Parameters:
Name Type Description
parameters object method options and parameters
Properties
Name Type Description
sessionToken string session-token
deviceId string 设备id
fromUserLoginName string 分享者登录名
fromUserUserName string 分享者用户名
startDate string 开始时间
endDate string 结束时间
pageNum string 页数
pageSize string 每页条数
Source:

getDeviceSharesListUsingGET(parameters)

查询设备分享信息列表(仅超管可用)
Parameters:
Name Type Description
parameters object method options and parameters
Properties
Name Type Description
sessionToken string session-token
deviceId string 设备ID
fromUserLoginName string 分享人
toUserLoginName string 被分享人
startDate string 开始时间
endDate string 结束时间
pageNum string 页数
pageSize string 每页条数
Source:

getDevicesListUsingGET(parameters)

查询设备列表
Parameters:
Name Type Description
parameters object method options and parameters
Properties
Name Type Description
sessionToken string session-token
deviceName string 设备名
deviceStatus string 设备状态
deviceGroupId string 设备分组
deviceOwner string 设备所有者loginName
beginTime string 起始时间限制
endTime string 结束时间限制
pageNum string 页数
pageSize string 每页条数
Source:

getTemplatesUsingGET(parameters)

查询sql模版列表
Parameters:
Name Type Description
parameters object method options and parameters
Properties
Name Type Description
sessionToken string session-token
sqlType string 模板sql类型:（0：查询；1：新增；2：修改；3：删除）
sqlTemplateType string 模板类型（1：默认模板；2：自定义模板）
sqlTemplateName string 模板名（模糊查询）
sqlDataTypes string 模板数据类型，多个用逗号隔开(2：转换数据；3：实时统计数据；4：告警数据；5：离线统计数据；6：外部数据；7：档案数据；8：档案和转换数据；9：统计数据、告警数据和外部数据)
pageNum string 当前页
pageSize string 每页多少条
Source:

getUserByUserIdUsingGET(parameters)

查询单个用户
Parameters:
Name Type Description
parameters object method options and parameters
Properties
Name Type Description
userId integer userId
sessionToken string session-token
Source:

getUsersUsingGET(parameters)

查询用户列表
Parameters:
Name Type Description
parameters object method options and parameters
Properties
Name Type Description
sessionToken string session-token
loginName string 登录名
status string 状态
email string 邮箱
mobile string 手机
roleId string 角色Id
pageNum string 页数
pageSize string 每页条数
Source:

insertUserUsingPOST(parameters)

增加用户
Parameters:
Name Type Description
parameters object method options and parameters
Properties
Name Type Description
addUserRequest addUserRequest
sessionToken string session-token
Source:

loginUsingPOST(parameters)

用户登录
Parameters:
Name Type Description
parameters object method options and parameters
Properties
Name Type Description
appToken string appToken
loginName string loginName
password string password
Source:

queryChildInfoUsingGET(parameters)

查询子用户列表
Parameters:
Name Type Description
parameters object method options and parameters
Properties
Name Type Description
userId integer userId
sessionToken string session-token
pageNum string 页数
pageSize string 每页条数
Source:

registerUserUsingPOST(parameters)

注册用户
Parameters:
Name Type Description
parameters object method options and parameters
Properties
Name Type Description
registerUserRequest registerUserRequest
appToken string appToken
Source:

request(options, deferred)

HTTP Request
Parameters:
Name Type Description
options object
Properties
Name Type Description
method string http method
url string url to do request
parameters object
body object body parameters / object
headers object header parameters
queryParameters object querystring parameters
form object form data object
deferred object promise object
Source:

resetPasswordUsingPUT(parameters)

重置子用户密码
Parameters:
Name Type Description
parameters object method options and parameters
Properties
Name Type Description
userId integer userId
sessionToken string session-token
Source:

sendCommandsUsingPOST(parameters)

发送命令
Parameters:
Name Type Description
parameters object method options and parameters
Properties
Name Type Description
sendCommandRequest sendCommandRequest
sessionToken string session-token
Source:

sendEmailVerificationUsingPOST(parameters)

发送邮箱验证码
Parameters:
Name Type Description
parameters object method options and parameters
Properties
Name Type Description
appToken string appToken
address string 邮箱地址
invalid string 失效时间
Source:

sendSmsVerificationUsingPOST(parameters)

发送短信验证码
Parameters:
Name Type Description
parameters object method options and parameters
Properties
Name Type Description
appToken string appToken
mobile string 手机号码
invalid string 失效时间
Source:

updateArchiveByIdUsingPUT(parameters)

修改设备档案
Parameters:
Name Type Description
parameters object method options and parameters
Properties
Name Type Description
updateArchive updateArchive
sessionToken string session-token
Source:

updateArchivesUsingPUT(parameters)

根据SQL语句修改设备档案
Parameters:
Name Type Description
parameters object method options and parameters
Properties
Name Type Description
findMongoDataRequest findMongoDataRequest
sessionToken string session-token
Source:

updateDevicesUsingPUT(parameters)

编辑设备
Parameters:
Name Type Description
parameters object method options and parameters
Properties
Name Type Description
deviceId string deviceId
updateDevice updateDevice
sessionToken string session-token
Source:

updateExternalDataByIdUsingPUT(parameters)

修改外部数据
Parameters:
Name Type Description
parameters object method options and parameters
Properties
Name Type Description
updateExternalData updateExternalData
sessionToken string session-token
Source:

updateExternalDataUsingPUT(parameters)

根据sql修改外部数据
Parameters:
Name Type Description
parameters object method options and parameters
Properties
Name Type Description
mongoDataRequest mongoDataRequest
sessionToken string session-token
Source:

updatePasswordUsingPUT(parameters)

修改密码
Parameters:
Name Type Description
parameters object method options and parameters
Properties
Name Type Description
password password
sessionToken string session-token
Source:

updateUserUsingPUT(parameters)

编辑子用户
Parameters:
Name Type Description
parameters object method options and parameters
Properties
Name Type Description
updateUserRequest updateUserRequest
userId integer userId
sessionToken string session-token
Source: