thingsboard的api

常用api


适用CUSTOMER_USER或TENANT_ADMIN的权限的api

[TOC]

报警 评论控制器 alarm comment controller

创建或更新报警注释

创建或更新警报注释。创建注释时,平台会生成警报注释 ID 作为基于时间的 UUID。新创建的警报注释 ID 将出现在响应中。指定现有警报注释 ID 以更新警报。引用不存在的警报注释 ID 将导致“未找到”错误。

要创建新的警报注释实体,只需使用“文本”节点指定“注释”json元素,例如:{“注释”:{“文本”:“我的注释”}}。

如果未指定注释类型,则将保存默认值“OTHER”。如果在正文中指定了“alarmId”或“userId”,则将其忽略。

适用于具有“TENANT_ADMIN”或“CUSTOMER_USER”权限的用户。

post api/alarm/ {alarmld} /comment

获取报警注释 getAlarmComments

返回指定警报的警报注释页。您可以指定参数来筛选结果。结果使用 PageData 对象包装,该对象允许您使用分页循环访问结果集。有关更多详细信息,请参阅响应类的“模型”选项卡。

适用于具有“TENANT_ADMIN”或“CUSTOMER_USER”权限的用户。

get /api/alarm/ {alarmld} /comment

删除报警注释 deleteAlarmComments

返回指定警报的警报注释页。您可以指定参数来筛选结果。结果使用 PageData 对象包装,该对象允许您使用分页循环访问结果集。有关更多详细信息,请参阅响应类的“模型”选项卡。

适用于具有“TENANT_ADMIN”或“CUSTOMER_USER”权限的用户。

DELETE  /api/alarm/ {alarmld} /comment/{commentid}

报警 控制器 alarm controller

报警控制器 的api 都是适用“TENANT_ADMIN”或“CUSTOMER_USER”权限

资产 控制者 Asset controller

创建或者更新资产 savaAsset

创建或更新资产。创建资产时,平台会生成资产 ID 作为基于时间的 UUID。新创建的资产 ID 将出现在响应中。指定现有资产 ID 以更新资产。引用不存在的资产 ID 将导致“未找到”错误。从请求正文示例(如下)中删除“id”、“tenantId”和可选的“customerId”,以创建新的资产实体。
适用于具有“TENANT_ADMIN”或“CUSTOMER_USER”权限的用户。
post /api/asset

获取资产 getAssetById

根据提供的资产 ID 获取资产对象。如果用户具有“租户管理员”的权限,服务器将检查资产是否由同一租户拥有。如果用户具有“客户用户”的权限,服务器将检查资产是否分配给同一客户。
适用于具有“TENANT_ADMIN”或“CUSTOMER_USER”权限的用户。
get /api/asset/{assetId}

删除资产 deleteAssetById

根据提供的资产 ID 获取资产对象。如果用户具有“租户管理员”的权限,服务器将检查资产是否由同一租户拥有。如果用户具有“客户用户”的权限,服务器将检查资产是否分配给同一客户。
适用于具有“TENANT_ADMIN”或“CUSTOMER_USER”权限的用户。
DELETE /api/asset/{assetId}

获取资产信息 getAssetlnfoByld

根据提供的资产 ID 获取资产信息对象。如果用户具有“租户管理员”的权限,服务器将检查资产是否由同一租户拥有。如果用户具有“客户用户”的权限,服务器将检查资产是否分配给同一客户。资产信息是默认资产对象的扩展,其中包含有关分配的客户名称的信息。
适用于具有“TENANT_ADMIN”或“CUSTOMER_USER”权限的用户。

get api/asset/info /{assetId}

资产配置文件控制器 asset-profile-controller Asset Profile Controller

获取资产配置文件信息 getAssetProfilelnfoByld

根据提供的资产配置文件 ID 获取资产配置文件信息对象。 资产配置文件信息是一个轻量级对象,包含有关资产配置文件的主要信息。
适用于具有“TENANT_ADMIN”或“CUSTOMER_USER”权限的用户。

GET /api/assetProfileInfo/ {assetProfileld}

获取默认资产配置文件 getDefaultAssetProfileInfo

获取默认资产配置文件信息对象。资产配置文件信息是一个轻量级对象,包含有关资产配置文件的主要信息。
适用于具有“TENANT_ADMIN”或“CUSTOMER_USER”权限的用户。

GET /api/assetProfileInfo/ default

获取资产配置文件信息(查询) getAset?roflelnfos

返回租户拥有的资产配置文件信息对象的页面。您可以指定参数来筛选结果。结果使用 PageData 对象包装,该对象允许您使用分页循环访问结果集。有关更多详细信息,请参阅响应类的“模型”选项卡。资产配置文件信息是一个轻量级对象,包含有关资产配置文件的主要信息。
适用于具有“TENANT_ADMIN”或“CUSTOMER_USER”权限的用户。

GET /api/assetProfilelnfos

客户控制者Customer

客户 ID 获取客户对象 getCustomerByld

根据提供的客户 ID 获取客户对象。如果用户具有“租户管理员”的权限,服务器将检查客户是否由同一租户拥有。如果用户具有“客户用户”的权限,服务器将检查该用户是否属于该客户。

适用于具有“TENANT_ADMIN”或“CUSTOMER_USER”权限的用户。
get /api/customer/ [customerId] Get Customer (getCustomerByld)

获取简短的客户信息 getShortCustomerlnfoByld

get /api/customer/{customerId }/shortInfo Get short Customer info (getShortCustomerlnfoByld)

获取客户标题 getCustomerTitleByld

获得客户的称号。如果用户具有“租户管理员”的权限,服务器将检查客户是否属于同一租户。如果用户具有“客户用户”的权限,服务器将检查该用户是否属于该客户。

get /api/customer/ [customerId] /title  Get Customer Title (getCustomerTitleByld)

仪表板控制器 Dashboard

获取客户仪表板 (getCustomerDashboards)

返回指定客户拥有的仪表板信息对象的页面。仪表板信息对象包含有关仪表板的轻量级信息(例如标题、图像、分配的客户),但不包含重量级配置 JSON。您可以指定参数来筛选结果。结果使用 PageData 对象包装,该对象允许您使用分页循环访问结果集。有关更多详细信息,请参阅响应类的“模型”选项卡。

适用于具有“TENANT_ADMIN”或“CUSTOMER_USER”权限的用户。
get /api/customer/ (customerId) /dashboards

获取仪表板(获取数据库格式)(getDashboardByld}

获取基于“dashboardId”参数的仪表板。仪表板对象是一个重量级对象,包含有关仪表板的信息(例如标题、图像、分配的客户)以及配置 JSON(例如布局、小部件、实体别名)。

适用于具有“TENANT_ADMIN”或“CUSTOMER_USER”权限的用户。
get /api/dashboard/ (dashboardId}

Gethome仪表板 getHomeDashboard

返回在用户的“附加信息”中配置为“homeDashboardId”参数的主仪表板对象。如果未在用户级别设置“homeDashboardId”参数,并且用户具有“CUSTOMER_USER”权限,请检查相应客户的相同参数。如果未在用户和客户级别设置“homeDashboardId”参数,则检查拥有该用户的租户的相同参数。仪表板对象是一个重量级对象,包含有关仪表板的信息(例如标题、图像、分配的客户)以及配置 JSON(例如布局、小部件、实体别名)。

get /api/dashboard/home

获取主页仪表盘信息 getHomeDashboardlnfo

返回在用户的“additionalInfo”中配置为“homeDashboardId”参数的主页仪表板信息对象。如果用户级别未设置“homeDashboardId”参数,并且用户具有权限“CUSTOMER_USER”,请检查相应客户的相同参数。如果未在用户和客户级别设置“homeDashboardId”参数,则检查拥有该用户的租户的相同参数。

适用于具有“TENANT_ADMIN”或“CUSTOMER_USER”权限的用户。
get /api/dashboard/home/info

获取Edge 边缘仪表盘 getEdgeDashboards

返回分配给指定边缘的仪表板信息对象的页面。Dashboard Info 对象包含有关仪表板的轻量级信息(例如标题、图像、分配的客户),但不包含重量级配置 JSON。您可以指定参数来过滤结果。结果用 PageData 对象包装,该对象允许您使用分页迭代结果集。有关更多详细信息,请参阅响应类的“模型”选项卡。

适用于具有“TENANT_ADMIN”或“CUSTOMER_USER”权限的用户。

GET api/edge/(edgeld/dashboards

设备连接控制器 device-connectivity-controller Device Connectivity Controller

获取用于发布设备遥测的命令 getDeviceublishlelemetryCommands

获取启动网关的命令 getGatewaylaunchCommand

设备控制器 device Controller

获取客户设备信息 getCustomerDevicelnfos

获取客户设备 getCustomerDevices

页面列表

ITEM_HTML