ThingsKit物联网平台API文档-可视化(看板)

删除数据看板

接口地址:/api/yt/data_board

请求方式:DELETE

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

响应数据类型:*/*

请求示例:

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

请求参数:

参数名称参数说明请求类型是否必须数据类型
deleteDTODeleteDTObodytrueDeleteDTO
ids删除ID列表truearray
tenantId租户IDfalsestring

响应参数:

参数名称参数说明类型
codeinteger(int32)
databoolean
messagestring

响应示例:

{
	"code": 0,
	"data": true,
	"message": ""
}

新增数据看板

接口地址:/api/yt/data_board/add

请求方式:POST

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

响应数据类型:*/*

请求示例:

{
  "componentNum": 0,
  "createTime": "",
  "creator": "",
  "defaultConfig": "",
  "description": "",
  "enabled": false,
  "icon": "",
  "id": "",
  "layout": [
    {
      "h": 0,
      "id": "",
      "w": 0,
      "x": 0,
      "y": 0
    }
  ]
}

请求参数:

参数名称参数说明请求类型是否必须数据类型
dataBoardDTODataBoardDTObodytrueDataBoardDTO
componentNum组件数falseinteger(int32)
createTime创建时间falsestring(date-time)
creator创建用户falsestring
defaultConfig租户默认配置falsestring
description租户描述falsestring
enabled租户状态:启用/禁用falseboolean
icon租户图标falsestring
idIDfalsestring
layout组件布局falsearray
h高度trueinteger
id组件元素IDfalsestring
w宽度trueinteger
xX坐标trueinteger
yY坐标trueinteger
name数据看板名称truestring
organizationId组织IDtruestring
remark备注falsestring
roleIds租户角色列表falsearray
tenantExpireTime租户到期时间falsestring(date-time)
tenantId租户IDfalsestring
tenantProfileId租户配置falsestring
tenantStatus可用值:DISABLED,EXPIRED,NORMALfalsestring
updateTime更新时间falsestring(date-time)
updater更新用户falsestring
viewType视图类型,可用值:PRIVATE_VIEW,PUBLIC_VIEWfalsestring

响应参数:

参数名称参数说明类型
codeinteger(int32)
dataDataBoardDTO
componentNum组件数integer(int32)
createTime创建时间string(date-time)
creator创建用户string
defaultConfig租户默认配置string
description租户描述string
enabled租户状态:启用/禁用boolean
icon租户图标string
idIDstring
layout组件布局array
h高度integer
id组件元素IDstring
w宽度integer
xX坐标integer
yY坐标integer
name数据看板名称string
organizationId组织IDstring
remark备注string
roleIds租户角色列表array
tenantExpireTime租户到期时间string(date-time)
tenantId租户IDstring
tenantProfileId租户配置string
tenantStatus可用值:DISABLED,EXPIRED,NORMALstring
updateTime更新时间string(date-time)
updater更新用户string
viewType视图类型,可用值:PRIVATE_VIEW,PUBLIC_VIEWstring
messagestring

响应示例:

{
	"code": 0,
	"data": {
		"componentNum": 0,
		"createTime": "",
		"creator": "",
		"defaultConfig": "",
		"description": "",
		"enabled": false,
		"icon": "",
		"id": "",
		"layout": [
			{
				"h": 0,
				"id": "",
				"w": 0,
				"x": 0,
				"y": 0
			}
		],
		"name": "",
		"organizationId": "",
		"remark": "",
		"roleIds": [],
		"tenantExpireTime": "",
		"tenantId": "",
		"tenantProfileId": "",
		"tenantStatus": "",
		"updateTime": "",
		"updater": "",
		"viewType": ""
	},
	"message": ""
}

编辑数据看板

接口地址:/api/yt/data_board/update

请求方式:POST

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

响应数据类型:*/*

请求示例:

{
  "componentNum": 0,
  "createTime": "",
  "creator": "",
  "defaultConfig": "",
  "description": "",
  "enabled": false,
  "icon": "",
  "id": "",
  "layout": [
    {
      "h": 0,
      "id": "",
      "w": 0,
      "x": 0,
      "y": 0
    }
  ]
}

请求参数:

参数名称参数说明请求类型是否必须数据类型
dataBoardDTODataBoardDTObodytrueDataBoardDTO
componentNum组件数falseinteger(int32)
createTime创建时间falsestring(date-time)
creator创建用户falsestring
defaultConfig租户默认配置falsestring
description租户描述falsestring
enabled租户状态:启用/禁用falseboolean
icon租户图标falsestring
idIDfalsestring
layout组件布局falsearray
h高度trueinteger
id组件元素IDfalsestring
w宽度trueinteger
xX坐标trueinteger
yY坐标trueinteger
name数据看板名称truestring
organizationId组织IDtruestring
remark备注falsestring
roleIds租户角色列表falsearray
tenantExpireTime租户到期时间falsestring(date-time)
tenantId租户IDfalsestring
tenantProfileId租户配置falsestring
tenantStatus可用值:DISABLED,EXPIRED,NORMALfalsestring
updateTime更新时间falsestring(date-time)
updater更新用户falsestring
viewType视图类型,可用值:PRIVATE_VIEW,PUBLIC_VIEWfalsestring

响应参数:

参数名称参数说明类型
codeinteger(int32)
dataDataBoardDTO
componentNum组件数integer(int32)
createTime创建时间string(date-time)
creator创建用户string
defaultConfig租户默认配置string
description租户描述string
enabled租户状态:启用/禁用boolean
icon租户图标string
idIDstring
layout组件布局array
h高度integer
id组件元素IDstring
w宽度integer
xX坐标integer
yY坐标integer
name数据看板名称string
organizationId组织IDstring
remark备注string
roleIds租户角色列表array
tenantExpireTime租户到期时间string(date-time)
tenantId租户IDstring
tenantProfileId租户配置string
tenantStatus可用值:DISABLED,EXPIRED,NORMALstring
updateTime更新时间string(date-time)
updater更新用户string
viewType视图类型,可用值:PRIVATE_VIEW,PUBLIC_VIEWstring
messagestring

响应示例:

{
	"code": 0,
	"data": {
		"componentNum": 0,
		"createTime": "",
		"creator": "",
		"defaultConfig": "",
		"description": "",
		"enabled": false,
		"icon": "",
		"id": "",
		"layout": [
			{
				"h": 0,
				"id": "",
				"w": 0,
				"x": 0,
				"y": 0
			}
		],
		"name": "",
		"organizationId": "",
		"remark": "",
		"roleIds": [],
		"tenantExpireTime": "",
		"tenantId": "",
		"tenantProfileId": "",
		"tenantStatus": "",
		"updateTime": "",
		"updater": "",
		"viewType": ""
	},
	"message": ""
}

保存看板的组件布局

接口地址:/api/yt/data_board/{boardId}/layout/

请求方式:POST

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

响应数据类型:*/*

请求示例:

[
  {
    "h": 0,
    "id": "",
    "w": 0,
    "x": 0,
    "y": 0
  }
]

请求参数:

参数名称参数说明请求类型是否必须数据类型
boardIdboardIdpathtruestring
componentLayoutDTOsComponentLayoutDTObodytruearray
h高度trueinteger(int32)
id组件元素IDfalsestring
w宽度trueinteger(int32)
xX坐标trueinteger(int32)
yY坐标trueinteger(int32)

响应参数:

参数名称参数说明类型
codeinteger(int32)
databoolean
messagestring

响应示例:

{
	"code": 0,
	"data": true,
	"message": ""
}

分页查询

接口地址:/api/yt/data_board{?name,orderFiled,orderType,organizationId,page,pageSize}

请求方式:GET

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

响应数据类型:*/*

请求参数:

参数名称参数说明是否必须数据类型
pagepagetrueint
pageSizepageSizetrueint
orderFiledorderFiledfalsestring
orderTypeorderType,可用值:ASC,DESCfalsestring
organizationIdorganizationIdfalsestring
namenamefalsestring

响应参数:

参数名称参数说明类型
itemsarray
componentNum组件数integer(int32)
createTime创建时间string(date-time)
creator创建用户string
defaultConfig租户默认配置string
description租户描述string
enabled租户状态:启用/禁用boolean
icon租户图标string
idIDstring
layout组件布局array
h高度integer
id组件元素IDstring
w宽度integer
xX坐标integer
yY坐标integer
name数据看板名称string
organizationId组织IDstring
remark备注string
roleIds租户角色列表array
tenantExpireTime租户到期时间string(date-time)
tenantId租户IDstring
tenantProfileId租户配置string
tenantStatus可用值:DISABLED,EXPIRED,NORMALstring
updateTime更新时间string(date-time)
updater更新用户string
viewType视图类型,可用值:PRIVATE_VIEW,PUBLIC_VIEWstring
totalinteger(int32)

响应示例:

{
	"items": [
		{
			"componentNum": 0,
			"createTime": "",
			"creator": "",
			"defaultConfig": "",
			"description": "",
			"enabled": false,
			"icon": "",
			"id": "",
			"layout": [
				{
					"h": 0,
					"id": "",
					"w": 0,
					"x": 0,
					"y": 0
				}
			],
			"name": "",
			"organizationId": "",
			"remark": "",
			"roleIds": [],
			"tenantExpireTime": "",
			"tenantId": "",
			"tenantProfileId": "",
			"tenantStatus": "",
			"updateTime": "",
			"updater": "",
			"viewType": ""
		}
	],
	"total": 0
}

查询看板下的所有组件信息

接口地址:/api/yt/data_component/{boardId}

请求方式:GET

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

响应数据类型:*/*

请求参数:

参数名称参数说明请求类型是否必须数据类型
boardIdboardIdpathtruestring

响应参数:

参数名称参数说明类型
codeinteger(int32)
dataMoreDataComponentInfoDTO
componentData组件数据信息array
createTime创建时间string
creator创建用户string
dataBoardId数据看板IDstring
dataSource数据源array
attribute属性string
attributeRename属性重命名string
componentInfo组件选项信息ComponentInfoDTO
fontColor数值字体颜色string
gradientInfo梯度信息array
color梯度颜色string
key梯度keystring
value梯度值integer
iconicon图标string
iconColoricon图标颜色string
showDeviceName显示设备名称:默认trueboolean
unit数值单位string
deviceId设备IDstring
deviceName设备名称string
deviceProfileId设备配置IDstring
deviceRename设备重命名string
deviceType组织ID,可用值:DIRECT_CONNECTION,GATEWAY,SENSORstring
gatewayDevice是否网关设备boolean
organizationId组织IDstring
slaveDeviceId子设备IDstring
defaultConfig租户默认配置string
description租户描述string
enabled租户状态:启用/禁用boolean
frontId前端组件IDstring
icon租户图标string
idIDstring
layout布局ComponentLayoutDTO
h高度integer
id组件元素IDstring
w宽度integer
xX坐标integer
yY坐标integer
name组件名称string
remark备注string
roleIds租户角色列表array
tenantExpireTime租户到期时间string
tenantId租户IDstring
tenantProfileId租户配置string
tenantStatus可用值:DISABLED,EXPIRED,NORMALstring
updateTime更新时间string
updater更新用户string
componentLayout组件布局信息array
h高度integer
id组件元素IDstring
w宽度integer
xX坐标integer
yY坐标integer
messagestring

响应示例:

{
	"code": 0,
	"data": {
		"componentData": [
			{
				"createTime": "",
				"creator": "",
				"dataBoardId": "",
				"dataSource": [
					{
						"attribute": "",
						"attributeRename": "",
						"componentInfo": {
							"fontColor": "",
							"gradientInfo": [
								{
									"color": "",
									"key": "",
									"value": 0
								}
							],
							"icon": "",
							"iconColor": "",
							"showDeviceName": false,
							"unit": ""
						},
						"deviceId": "",
						"deviceName": "",
						"deviceProfileId": "",
						"deviceRename": "",
						"deviceType": "",
						"gatewayDevice": false,
						"organizationId": "",
						"slaveDeviceId": ""
					}
				],
				"defaultConfig": "",
				"description": "",
				"enabled": false,
				"frontId": "",
				"icon": "",
				"id": "",
				"layout": {
					"h": 0,
					"id": "",
					"w": 0,
					"x": 0,
					"y": 0
				},
				"name": "",
				"remark": "",
				"roleIds": [],
				"tenantExpireTime": "",
				"tenantId": "",
				"tenantProfileId": "",
				"tenantStatus": "",
				"updateTime": "",
				"updater": ""
			}
		],
		"componentLayout": [
			{
				"h": 0,
				"id": "",
				"w": 0,
				"x": 0,
				"y": 0
			}
		]
	},
	"message": ""
}

新增组件

接口地址:/api/yt/data_component/{boardId}/add

请求方式:POST

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

响应数据类型:*/*

请求示例:

{
  "dataBoardId": "",
  "dataSource": [
    {
      "attribute": "",
      "attributeRename": "",
      "componentInfo": {
        "fontColor": "",
        "gradientInfo": [
          {
            "color": "",
            "key": "",
            "value": 0
          }
        ]
      },
      "deviceId": "",
      "deviceName": "",
      "deviceProfileId": "",
      "deviceRename": "",
      "deviceType": "",
      "gatewayDevice": false,
      "organizationId": ""
    }
  ],
  "frontId": "",
  "icon": "",
  "id": "",
  "layout": {
    "h": 0,
    "id": "",
    "w": 0,
    "x": 0,
    "y": 0
  }
}

请求参数:

参数名称参数说明请求类型是否必须数据类型
boardIdboardIdpathtruestring
dataComponentDTODataComponentDTObodytrueDataComponentDTO
createTime创建时间falsestring(date-time)
creator创建用户falsestring
dataBoardId数据看板IDtruestring
dataSource数据源truearray
attribute属性truestring
attributeRename属性重命名falsestring
componentInfo组件选项信息falseComponentInfoDTO
fontColor数值字体颜色truestring
gradientInfo梯度信息falsearray
color梯度颜色falsestring
key梯度keyfalsestring
value梯度值falseinteger
iconicon图标falsestring
iconColoricon图标颜色falsestring
showDeviceName显示设备名称:默认truefalseboolean
unit数值单位falsestring
deviceId设备IDtruestring
deviceName设备名称falsestring
deviceProfileId设备配置IDtruestring
deviceRename设备重命名falsestring
deviceType组织ID,可用值:DIRECT_CONNECTION,GATEWAY,SENSORtruestring
gatewayDevice是否网关设备falseboolean
organizationId组织IDtruestring
slaveDeviceId子设备IDfalsestring
defaultConfig租户默认配置falsestring
description租户描述falsestring
enabled租户状态:启用/禁用falseboolean
frontId前端组件IDtruestring
icon租户图标falsestring
idIDfalsestring
layout布局trueComponentLayoutDTO
h高度trueinteger
id组件元素IDfalsestring
w宽度trueinteger
xX坐标trueinteger
yY坐标trueinteger
name组件名称falsestring
remark备注falsestring
roleIds租户角色列表falsearray
tenantExpireTime租户到期时间falsestring(date-time)
tenantId租户IDfalsestring
tenantProfileId租户配置falsestring
tenantStatus可用值:DISABLED,EXPIRED,NORMALfalsestring
updateTime更新时间falsestring(date-time)
updater更新用户falsestring

响应参数:

参数名称参数说明类型
codeinteger(int32)
dataDataComponentDTO
createTime创建时间string(date-time)
creator创建用户string
dataBoardId数据看板IDstring
dataSource数据源array
attribute属性string
attributeRename属性重命名string
componentInfo组件选项信息ComponentInfoDTO
fontColor数值字体颜色string
gradientInfo梯度信息array
color梯度颜色string
key梯度keystring
value梯度值integer
iconicon图标string
iconColoricon图标颜色string
showDeviceName显示设备名称:默认trueboolean
unit数值单位string
deviceId设备IDstring
deviceName设备名称string
deviceProfileId设备配置IDstring
deviceRename设备重命名string
deviceType组织ID,可用值:DIRECT_CONNECTION,GATEWAY,SENSORstring
gatewayDevice是否网关设备boolean
organizationId组织IDstring
slaveDeviceId子设备IDstring
defaultConfig租户默认配置string
description租户描述string
enabled租户状态:启用/禁用boolean
frontId前端组件IDstring
icon租户图标string
idIDstring
layout布局ComponentLayoutDTO
h高度integer
id组件元素IDstring
w宽度integer
xX坐标integer
yY坐标integer
name组件名称string
remark备注string
roleIds租户角色列表array
tenantExpireTime租户到期时间string(date-time)
tenantId租户IDstring
tenantProfileId租户配置string
tenantStatus可用值:DISABLED,EXPIRED,NORMALstring
updateTime更新时间string(date-time)
updater更新用户string
messagestring

响应示例:

{
	"code": 0,
	"data": {
		"createTime": "",
		"creator": "",
		"dataBoardId": "",
		"dataSource": [
			{
				"attribute": "",
				"attributeRename": "",
				"componentInfo": {
					"fontColor": "",
					"gradientInfo": [
						{
							"color": "",
							"key": "",
							"value": 0
						}
					],
					"icon": "",
					"iconColor": "",
					"showDeviceName": false,
					"unit": ""
				},
				"deviceId": "",
				"deviceName": "",
				"deviceProfileId": "",
				"deviceRename": "",
				"deviceType": "",
				"gatewayDevice": false,
				"organizationId": "",
				"slaveDeviceId": ""
			}
		],
		"defaultConfig": "",
		"description": "",
		"enabled": false,
		"frontId": "",
		"icon": "",
		"id": "",
		"layout": {
			"h": 0,
			"id": "",
			"w": 0,
			"x": 0,
			"y": 0
		},
		"name": "",
		"remark": "",
		"roleIds": [],
		"tenantExpireTime": "",
		"tenantId": "",
		"tenantProfileId": "",
		"tenantStatus": "",
		"updateTime": "",
		"updater": ""
	},
	"message": ""
}

编辑组件

接口地址:/api/yt/data_component/{boardId}/update

请求方式:POST

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

响应数据类型:*/*

请求示例:

{
  "createTime": "",
  "creator": "",
  "dataBoardId": "",
  "dataSource": [
    {
      "attribute": "",
      "attributeRename": "",
      "componentInfo": {
        "fontColor": "",
        "gradientInfo": [
          {
            "color": "",
            "key": "",
            "value": 0
          }
        ],
        "icon": "",
        "iconColor": "",
        "showDeviceName": false,
        "unit": ""
      },
      "deviceId": "",
      "deviceName": "",
      "deviceProfileId": "",
      "deviceRename": "",
      "deviceType": "",
      "gatewayDevice": false,
      "organizationId": ""
    }
  ],
  "defaultConfig": "",
  "description": "",
  "enabled": false,
  "frontId": "",
  "icon": "",
  "id": "",
  "layout": {
    "h": 0,
    "id": "",
    "w": 0,
    "x": 0,
    "y": 0
  }
}

请求参数:

参数名称参数说明请求类型是否必须数据类型
boardIdboardIdpathtruestring
dataComponentDTODataComponentDTObodytrueDataComponentDTO
createTime创建时间falsestring(date-time)
creator创建用户falsestring
dataBoardId数据看板IDtruestring
dataSource数据源truearray
attribute属性truestring
attributeRename属性重命名falsestring
componentInfo组件选项信息falseComponentInfoDTO
fontColor数值字体颜色truestring
gradientInfo梯度信息falsearray
color梯度颜色falsestring
key梯度keyfalsestring
value梯度值falseinteger
iconicon图标falsestring
iconColoricon图标颜色falsestring
showDeviceName显示设备名称:默认truefalseboolean
unit数值单位falsestring
deviceId设备IDtruestring
deviceName设备名称falsestring
deviceProfileId设备配置IDtruestring
deviceRename设备重命名falsestring
deviceType组织ID,可用值:DIRECT_CONNECTION,GATEWAY,SENSORtruestring
gatewayDevice是否网关设备falseboolean
organizationId组织IDtruestring
slaveDeviceId子设备IDfalsestring
defaultConfig租户默认配置falsestring
description租户描述falsestring
enabled租户状态:启用/禁用falseboolean
frontId前端组件IDtruestring
icon租户图标falsestring
idIDfalsestring
layout布局trueComponentLayoutDTO
h高度trueinteger
id组件元素IDfalsestring
w宽度trueinteger
xX坐标trueinteger
yY坐标trueinteger
name组件名称falsestring
remark备注falsestring
roleIds租户角色列表falsearray
tenantExpireTime租户到期时间falsestring(date-time)
tenantId租户IDfalsestring
tenantProfileId租户配置falsestring
tenantStatus可用值:DISABLED,EXPIRED,NORMALfalsestring
updateTime更新时间falsestring(date-time)
updater更新用户falsestring

响应参数:

参数名称参数说明类型
codeinteger(int32)
dataDataComponentDTO
createTime创建时间string(date-time)
creator创建用户string
dataBoardId数据看板IDstring
dataSource数据源array
attribute属性string
attributeRename属性重命名string
componentInfo组件选项信息ComponentInfoDTO
fontColor数值字体颜色string
gradientInfo梯度信息array
color梯度颜色string
key梯度keystring
value梯度值integer
iconicon图标string
iconColoricon图标颜色string
showDeviceName显示设备名称:默认trueboolean
unit数值单位string
deviceId设备IDstring
deviceName设备名称string
deviceProfileId设备配置IDstring
deviceRename设备重命名string
deviceType组织ID,可用值:DIRECT_CONNECTION,GATEWAY,SENSORstring
gatewayDevice是否网关设备boolean
organizationId组织IDstring
slaveDeviceId子设备IDstring
defaultConfig租户默认配置string
description租户描述string
enabled租户状态:启用/禁用boolean
frontId前端组件IDstring
icon租户图标string
idIDstring
layout布局ComponentLayoutDTO
h高度integer
id组件元素IDstring
w宽度integer
xX坐标integer
yY坐标integer
name组件名称string
remark备注string
roleIds租户角色列表array
tenantExpireTime租户到期时间string(date-time)
tenantId租户IDstring
tenantProfileId租户配置string
tenantStatus可用值:DISABLED,EXPIRED,NORMALstring
updateTime更新时间string(date-time)
updater更新用户string
messagestring

响应示例:

{
	"code": 0,
	"data": {
		"createTime": "",
		"creator": "",
		"dataBoardId": "",
		"dataSource": [
			{
				"attribute": "",
				"attributeRename": "",
				"componentInfo": {
					"fontColor": "",
					"gradientInfo": [
						{
							"color": "",
							"key": "",
							"value": 0
						}
					],
					"icon": "",
					"iconColor": "",
					"showDeviceName": false,
					"unit": ""
				},
				"deviceId": "",
				"deviceName": "",
				"deviceProfileId": "",
				"deviceRename": "",
				"deviceType": "",
				"gatewayDevice": false,
				"organizationId": "",
				"slaveDeviceId": ""
			}
		],
		"defaultConfig": "",
		"description": "",
		"enabled": false,
		"frontId": "",
		"icon": "",
		"id": "",
		"layout": {
			"h": 0,
			"id": "",
			"w": 0,
			"x": 0,
			"y": 0
		},
		"name": "",
		"remark": "",
		"roleIds": [],
		"tenantExpireTime": "",
		"tenantId": "",
		"tenantProfileId": "",
		"tenantStatus": "",
		"updateTime": "",
		"updater": ""
	},
	"message": ""
}

删除数据组件

接口地址:/api/yt/data_component/{dataBoardId}

请求方式:DELETE

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

响应数据类型:*/*

请求示例:

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

请求参数:

参数名称参数说明请求类型是否必须数据类型
dataBoardIddataBoardIdpathtruestring
deleteDTODeleteDTObodytrueDeleteDTO
ids删除ID列表truearray
tenantId租户IDfalsestring

响应参数:

参数名称参数说明类型
codeinteger(int32)
databoolean
messagestring

响应示例:

{
	"code": 0,
	"data": true,
	"message": ""
}