3 Star 6 Fork 2

ThingsKit / ThingsKit物联网平台文档

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
index.md 12.53 KB
一键复制 编辑 原始数据 按行查看 历史
TrueVoid 提交于 2023-01-18 20:20 . docs: release1.0.1

updateDeviceStateLogInfo(待翻译)

接口地址:/api/yt/device/state/log

请求方式:POST

请求数据类型:application/x-www-form-urlencoded,application/json

响应数据类型:*/*

请求示例:

{
  "createTime": "",
  "creator": "",
  "defaultConfig": "",
  "description": "",
  "deviceName": "",
  "deviceProfileName": "",
  "deviceType": "",
  "enabled": false,
  "icon": "",
  "id": "",
  "name": "",
  "organizationName": "",
  "remark": "",
  "roleIds": [],
  "status": 0,
  "tbDeviceId": "",
  "tenantExpireTime": "",
  "tenantId": "",
  "tenantProfileId": "",
  "tenantStatus": "",
  "updateTime": "",
  "updater": ""
}

请求参数:

参数名称 参数说明 请求类型 是否必须 数据类型
tkDeviceStateLogDTO TkDeviceStateLogDTO body true TkDeviceStateLogDTO

响应参数:

参数名称 参数说明 类型
createTime 创建时间 string(date-time)
creator 创建用户 string
defaultConfig 租户默认配置 string
description 租户描述 string
deviceName 设备名称 string
deviceProfileName 设备配置名称 string
deviceType 设备类型,可用值:DIRECT_CONNECTION,GATEWAY,SENSOR string
enabled 租户状态:启用/禁用 boolean
icon 租户图标 string
id ID string
name 租户名称 string
organizationName 组织名称 string
remark 备注 string
roleIds 租户角色列表 array
status 设备状态:0离线 1在线 integer(int32)
tbDeviceId 设备ID string
tenantExpireTime 租户到期时间 string(date-time)
tenantId 租户ID string
tenantProfileId 租户配置 string
tenantStatus 可用值:DISABLED,EXPIRED,NORMAL string
updateTime 更新时间 string(date-time)
updater 更新用户 string

响应示例:

{
	"createTime": "",
	"creator": "",
	"defaultConfig": "",
	"description": "",
	"deviceName": "",
	"deviceProfileName": "",
	"deviceType": "",
	"enabled": false,
	"icon": "",
	"id": "",
	"name": "",
	"organizationName": "",
	"remark": "",
	"roleIds": [],
	"status": 0,
	"tbDeviceId": "",
	"tenantExpireTime": "",
	"tenantId": "",
	"tenantProfileId": "",
	"tenantStatus": "",
	"updateTime": "",
	"updater": ""
}

deleteDeviceStateLog(待翻译)

接口地址:/api/yt/device/state/log

请求方式:DELETE

请求数据类型:application/x-www-form-urlencoded,application/json

响应数据类型:*/*

请求示例:

{
  "ids": [],
  "tenantId": ""
}

请求参数:

参数名称 参数说明 请求类型 是否必须 数据类型
deleteDTO DeleteDTO body true DeleteDTO
  ids 删除ID列表 true array

响应参数:

参数名称 参数说明 类型
errorCode Platform error code:\n* 2 - General error (HTTP: 500 - Internal Server Error)\n\n* 10 - Authentication failed (HTTP: 401 - Unauthorized)\n\n* 11 - JWT token expired (HTTP: 401 - Unauthorized)\n\n* 15 - Credentials expired (HTTP: 401 - Unauthorized)\n\n* 20 - Permission denied (HTTP: 403 - Forbidden)\n\n* 30 - Invalid arguments (HTTP: 400 - Bad Request)\n\n* 31 - Bad request params (HTTP: 400 - Bad Request)\n\n* 32 - Item not found (HTTP: 404 - Not Found)\n\n* 33 - Too many requests (HTTP: 429 - Too Many Requests)\n\n* 34 - Too many updates (Too many updates over Websocket session)\n\n* 40 - Subscription violation (HTTP: 403 - Forbidden) object
message Error message string
status HTTP Response Status Code integer(int32)
timestamp Timestamp string(date-time)

响应示例:

{}

getDeviceStateLogInfo(待翻译)

接口地址:/api/yt/device/state/log/{id}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

请求参数:

参数名称 参数说明 请求类型 是否必须 数据类型
id id path true string

响应参数:

参数名称 参数说明 类型
createTime 创建时间 string(date-time)
creator 创建用户 string
defaultConfig 租户默认配置 string
description 租户描述 string
deviceName 设备名称 string
deviceProfileName 设备配置名称 string
deviceType 设备类型,可用值:DIRECT_CONNECTION,GATEWAY,SENSOR string
enabled 租户状态:启用/禁用 boolean
icon 租户图标 string
id ID string
name 租户名称 string
organizationName 组织名称 string
remark 备注 string
roleIds 租户角色列表 array
status 设备状态:0离线 1在线 integer(int32)
tbDeviceId 设备ID string
tenantExpireTime 租户到期时间 string(date-time)
tenantId 租户ID string
tenantProfileId 租户配置 string
tenantStatus 可用值:DISABLED,EXPIRED,NORMAL string
updateTime 更新时间 string(date-time)
updater 更新用户 string

响应示例:

{
	"createTime": "",
	"creator": "",
	"defaultConfig": "",
	"description": "",
	"deviceName": "",
	"deviceProfileName": "",
	"deviceType": "",
	"enabled": false,
	"icon": "",
	"id": "",
	"name": "",
	"organizationName": "",
	"remark": "",
	"roleIds": [],
	"status": 0,
	"tbDeviceId": "",
	"tenantExpireTime": "",
	"tenantId": "",
	"tenantProfileId": "",
	"tenantStatus": "",
	"updateTime": "",
	"updater": ""
}
查询

接口地址:/api/yt/device/state/log{?deviceName,deviceProfileName,endTime,orderFiled,orderType,organizationName,page,pageSize,startTime,status}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

请求参数:

参数名称 参数说明 是否必须 数据类型
page page true int
pageSize pageSize true int

响应参数:

参数名称 参数说明 类型
items array
  createTime 创建时间 string(date-time)
  creator 创建用户 string
  defaultConfig 租户默认配置 string
  description 租户描述 string
  deviceName 设备名称 string
  deviceProfileName 设备配置名称 string
  deviceType 设备类型,可用值:DIRECT_CONNECTION,GATEWAY,SENSOR string
  enabled 租户状态:启用/禁用 boolean
  icon 租户图标 string
  id ID string
  name 租户名称 string
  organizationName 组织名称 string
  remark 备注 string
  roleIds 租户角色列表 array
  status 设备状态:0离线 1在线 integer(int32)
  tbDeviceId 设备ID string
  tenantExpireTime 租户到期时间 string(date-time)
  tenantId 租户ID string
  tenantProfileId 租户配置 string
  tenantStatus 可用值:DISABLED,EXPIRED,NORMAL string
  updateTime 更新时间 string(date-time)
  updater 更新用户 string
total integer(int32)

响应示例:

{
	"items": [
		{
			"createTime": "",
			"creator": "",
			"defaultConfig": "",
			"description": "",
			"deviceName": "",
			"deviceProfileName": "",
			"deviceType": "",
			"enabled": false,
			"icon": "",
			"id": "",
			"name": "",
			"organizationName": "",
			"remark": "",
			"roleIds": [],
			"status": 0,
			"tbDeviceId": "",
			"tenantExpireTime": "",
			"tenantId": "",
			"tenantProfileId": "",
			"tenantStatus": "",
			"updateTime": "",
			"updater": ""
		}
	],
	"total": 0
}

1
https://gitee.com/thingskit/thingskit-docs.git
git@gitee.com:thingskit/thingskit-docs.git
thingskit
thingskit-docs
ThingsKit物联网平台文档
master

搜索帮助