删除数据看板
接口地址:/api/yt/data_board
请求方式:DELETE
请求数据类型:application/x-www-form-urlencoded,application/json
响应数据类型:*/*
请求示例:
{
"ids": [],
"tenantId": ""
}
请求参数:
参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 |
deleteDTO | DeleteDTO | body | true | DeleteDTO |
ids | 删除ID列表 | true | array | |
tenantId | 租户ID | false | string |
响应参数:
参数名称 | 参数说明 | 类型 |
code | integer(int32) | |
data | boolean | |
message | string |
响应示例:
{
"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
}
]
}
请求参数:
参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 |
dataBoardDTO | DataBoardDTO | body | true | DataBoardDTO |
componentNum | 组件数 | false | integer(int32) | |
createTime | 创建时间 | false | string(date-time) | |
creator | 创建用户 | false | string | |
defaultConfig | 租户默认配置 | false | string | |
description | 租户描述 | false | string | |
enabled | 租户状态:启用/禁用 | false | boolean | |
icon | 租户图标 | false | string | |
id | ID | false | string | |
layout | 组件布局 | false | array | |
h | 高度 | true | integer | |
id | 组件元素ID | false | string | |
w | 宽度 | true | integer | |
x | X坐标 | true | integer | |
y | Y坐标 | true | integer | |
name | 数据看板名称 | true | string | |
organizationId | 组织ID | true | string | |
remark | 备注 | false | string | |
roleIds | 租户角色列表 | false | array | |
tenantExpireTime | 租户到期时间 | false | string(date-time) | |
tenantId | 租户ID | false | string | |
tenantProfileId | 租户配置 | false | string | |
tenantStatus | 可用值:DISABLED,EXPIRED,NORMAL | false | string | |
updateTime | 更新时间 | false | string(date-time) | |
updater | 更新用户 | false | string | |
viewType | 视图类型,可用值:PRIVATE_VIEW,PUBLIC_VIEW | false | string |
响应参数:
参数名称 | 参数说明 | 类型 |
code | integer(int32) | |
data | DataBoardDTO | |
componentNum | 组件数 | integer(int32) |
createTime | 创建时间 | string(date-time) |
creator | 创建用户 | string |
defaultConfig | 租户默认配置 | string |
description | 租户描述 | string |
enabled | 租户状态:启用/禁用 | boolean |
icon | 租户图标 | string |
id | ID | string |
layout | 组件布局 | array |
h | 高度 | integer |
id | 组件元素ID | string |
w | 宽度 | integer |
x | X坐标 | integer |
y | Y坐标 | integer |
name | 数据看板名称 | string |
organizationId | 组织ID | string |
remark | 备注 | string |
roleIds | 租户角色列表 | array |
tenantExpireTime | 租户到期时间 | string(date-time) |
tenantId | 租户ID | string |
tenantProfileId | 租户配置 | string |
tenantStatus | 可用值:DISABLED,EXPIRED,NORMAL | string |
updateTime | 更新时间 | string(date-time) |
updater | 更新用户 | string |
viewType | 视图类型,可用值:PRIVATE_VIEW,PUBLIC_VIEW | string |
message | string |
响应示例:
{
"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
}
]
}
请求参数:
参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 |
dataBoardDTO | DataBoardDTO | body | true | DataBoardDTO |
componentNum | 组件数 | false | integer(int32) | |
createTime | 创建时间 | false | string(date-time) | |
creator | 创建用户 | false | string | |
defaultConfig | 租户默认配置 | false | string | |
description | 租户描述 | false | string | |
enabled | 租户状态:启用/禁用 | false | boolean | |
icon | 租户图标 | false | string | |
id | ID | false | string | |
layout | 组件布局 | false | array | |
h | 高度 | true | integer | |
id | 组件元素ID | false | string | |
w | 宽度 | true | integer | |
x | X坐标 | true | integer | |
y | Y坐标 | true | integer | |
name | 数据看板名称 | true | string | |
organizationId | 组织ID | true | string | |
remark | 备注 | false | string | |
roleIds | 租户角色列表 | false | array | |
tenantExpireTime | 租户到期时间 | false | string(date-time) | |
tenantId | 租户ID | false | string | |
tenantProfileId | 租户配置 | false | string | |
tenantStatus | 可用值:DISABLED,EXPIRED,NORMAL | false | string | |
updateTime | 更新时间 | false | string(date-time) | |
updater | 更新用户 | false | string | |
viewType | 视图类型,可用值:PRIVATE_VIEW,PUBLIC_VIEW | false | string |
响应参数:
参数名称 | 参数说明 | 类型 |
code | integer(int32) | |
data | DataBoardDTO | |
componentNum | 组件数 | integer(int32) |
createTime | 创建时间 | string(date-time) |
creator | 创建用户 | string |
defaultConfig | 租户默认配置 | string |
description | 租户描述 | string |
enabled | 租户状态:启用/禁用 | boolean |
icon | 租户图标 | string |
id | ID | string |
layout | 组件布局 | array |
h | 高度 | integer |
id | 组件元素ID | string |
w | 宽度 | integer |
x | X坐标 | integer |
y | Y坐标 | integer |
name | 数据看板名称 | string |
organizationId | 组织ID | string |
remark | 备注 | string |
roleIds | 租户角色列表 | array |
tenantExpireTime | 租户到期时间 | string(date-time) |
tenantId | 租户ID | string |
tenantProfileId | 租户配置 | string |
tenantStatus | 可用值:DISABLED,EXPIRED,NORMAL | string |
updateTime | 更新时间 | string(date-time) |
updater | 更新用户 | string |
viewType | 视图类型,可用值:PRIVATE_VIEW,PUBLIC_VIEW | string |
message | string |
响应示例:
{
"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
}
]
请求参数:
参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 |
boardId | boardId | path | true | string |
componentLayoutDTOs | ComponentLayoutDTO | body | true | array |
h | 高度 | true | integer(int32) | |
id | 组件元素ID | false | string | |
w | 宽度 | true | integer(int32) | |
x | X坐标 | true | integer(int32) | |
y | Y坐标 | true | integer(int32) |
响应参数:
参数名称 | 参数说明 | 类型 |
code | integer(int32) | |
data | boolean | |
message | string |
响应示例:
{
"code": 0,
"data": true,
"message": ""
}
分页查询
接口地址:/api/yt/data_board{?name,orderFiled,orderType,organizationId,page,pageSize}
请求方式:GET
请求数据类型:application/x-www-form-urlencoded
响应数据类型:*/*
请求参数:
参数名称 | 参数说明 | 是否必须 | 数据类型 |
page | page | true | int |
pageSize | pageSize | true | int |
orderFiled | orderFiled | false | string |
orderType | orderType,可用值:ASC,DESC | false | string |
organizationId | organizationId | false | string |
name | name | false | string |
响应参数:
参数名称 | 参数说明 | 类型 |
items | array | |
componentNum | 组件数 | integer(int32) |
createTime | 创建时间 | string(date-time) |
creator | 创建用户 | string |
defaultConfig | 租户默认配置 | string |
description | 租户描述 | string |
enabled | 租户状态:启用/禁用 | boolean |
icon | 租户图标 | string |
id | ID | string |
layout | 组件布局 | array |
h | 高度 | integer |
id | 组件元素ID | string |
w | 宽度 | integer |
x | X坐标 | integer |
y | Y坐标 | integer |
name | 数据看板名称 | string |
organizationId | 组织ID | string |
remark | 备注 | string |
roleIds | 租户角色列表 | array |
tenantExpireTime | 租户到期时间 | string(date-time) |
tenantId | 租户ID | string |
tenantProfileId | 租户配置 | string |
tenantStatus | 可用值:DISABLED,EXPIRED,NORMAL | string |
updateTime | 更新时间 | string(date-time) |
updater | 更新用户 | string |
viewType | 视图类型,可用值:PRIVATE_VIEW,PUBLIC_VIEW | string |
total | integer(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
响应数据类型:*/*
请求参数:
参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 |
boardId | boardId | path | true | string |
响应参数:
参数名称 | 参数说明 | 类型 |
code | integer(int32) | |
data | MoreDataComponentInfoDTO | |
componentData | 组件数据信息 | array |
createTime | 创建时间 | string |
creator | 创建用户 | string |
dataBoardId | 数据看板ID | string |
dataSource | 数据源 | array |
attribute | 属性 | string |
attributeRename | 属性重命名 | string |
componentInfo | 组件选项信息 | ComponentInfoDTO |
fontColor | 数值字体颜色 | string |
gradientInfo | 梯度信息 | array |
color | 梯度颜色 | string |
key | 梯度key | string |
value | 梯度值 | integer |
icon | icon图标 | string |
iconColor | icon图标颜色 | string |
showDeviceName | 显示设备名称:默认true | boolean |
unit | 数值单位 | string |
deviceId | 设备ID | string |
deviceName | 设备名称 | string |
deviceProfileId | 设备配置ID | string |
deviceRename | 设备重命名 | string |
deviceType | 组织ID,可用值:DIRECT_CONNECTION,GATEWAY,SENSOR | string |
gatewayDevice | 是否网关设备 | boolean |
organizationId | 组织ID | string |
slaveDeviceId | 子设备ID | string |
defaultConfig | 租户默认配置 | string |
description | 租户描述 | string |
enabled | 租户状态:启用/禁用 | boolean |
frontId | 前端组件ID | string |
icon | 租户图标 | string |
id | ID | string |
layout | 布局 | ComponentLayoutDTO |
h | 高度 | integer |
id | 组件元素ID | string |
w | 宽度 | integer |
x | X坐标 | integer |
y | Y坐标 | integer |
name | 组件名称 | string |
remark | 备注 | string |
roleIds | 租户角色列表 | array |
tenantExpireTime | 租户到期时间 | string |
tenantId | 租户ID | string |
tenantProfileId | 租户配置 | string |
tenantStatus | 可用值:DISABLED,EXPIRED,NORMAL | string |
updateTime | 更新时间 | string |
updater | 更新用户 | string |
componentLayout | 组件布局信息 | array |
h | 高度 | integer |
id | 组件元素ID | string |
w | 宽度 | integer |
x | X坐标 | integer |
y | Y坐标 | integer |
message | string |
响应示例:
{
"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
}
}
请求参数:
参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 |
boardId | boardId | path | true | string |
dataComponentDTO | DataComponentDTO | body | true | DataComponentDTO |
createTime | 创建时间 | false | string(date-time) | |
creator | 创建用户 | false | string | |
dataBoardId | 数据看板ID | true | string | |
dataSource | 数据源 | true | array | |
attribute | 属性 | true | string | |
attributeRename | 属性重命名 | false | string | |
componentInfo | 组件选项信息 | false | ComponentInfoDTO | |
fontColor | 数值字体颜色 | true | string | |
gradientInfo | 梯度信息 | false | array | |
color | 梯度颜色 | false | string | |
key | 梯度key | false | string | |
value | 梯度值 | false | integer | |
icon | icon图标 | false | string | |
iconColor | icon图标颜色 | false | string | |
showDeviceName | 显示设备名称:默认true | false | boolean | |
unit | 数值单位 | false | string | |
deviceId | 设备ID | true | string | |
deviceName | 设备名称 | false | string | |
deviceProfileId | 设备配置ID | true | string | |
deviceRename | 设备重命名 | false | string | |
deviceType | 组织ID,可用值:DIRECT_CONNECTION,GATEWAY,SENSOR | true | string | |
gatewayDevice | 是否网关设备 | false | boolean | |
organizationId | 组织ID | true | string | |
slaveDeviceId | 子设备ID | false | string | |
defaultConfig | 租户默认配置 | false | string | |
description | 租户描述 | false | string | |
enabled | 租户状态:启用/禁用 | false | boolean | |
frontId | 前端组件ID | true | string | |
icon | 租户图标 | false | string | |
id | ID | false | string | |
layout | 布局 | true | ComponentLayoutDTO | |
h | 高度 | true | integer | |
id | 组件元素ID | false | string | |
w | 宽度 | true | integer | |
x | X坐标 | true | integer | |
y | Y坐标 | true | integer | |
name | 组件名称 | false | string | |
remark | 备注 | false | string | |
roleIds | 租户角色列表 | false | array | |
tenantExpireTime | 租户到期时间 | false | string(date-time) | |
tenantId | 租户ID | false | string | |
tenantProfileId | 租户配置 | false | string | |
tenantStatus | 可用值:DISABLED,EXPIRED,NORMAL | false | string | |
updateTime | 更新时间 | false | string(date-time) | |
updater | 更新用户 | false | string |
响应参数:
参数名称 | 参数说明 | 类型 |
code | integer(int32) | |
data | DataComponentDTO | |
createTime | 创建时间 | string(date-time) |
creator | 创建用户 | string |
dataBoardId | 数据看板ID | string |
dataSource | 数据源 | array |
attribute | 属性 | string |
attributeRename | 属性重命名 | string |
componentInfo | 组件选项信息 | ComponentInfoDTO |
fontColor | 数值字体颜色 | string |
gradientInfo | 梯度信息 | array |
color | 梯度颜色 | string |
key | 梯度key | string |
value | 梯度值 | integer |
icon | icon图标 | string |
iconColor | icon图标颜色 | string |
showDeviceName | 显示设备名称:默认true | boolean |
unit | 数值单位 | string |
deviceId | 设备ID | string |
deviceName | 设备名称 | string |
deviceProfileId | 设备配置ID | string |
deviceRename | 设备重命名 | string |
deviceType | 组织ID,可用值:DIRECT_CONNECTION,GATEWAY,SENSOR | string |
gatewayDevice | 是否网关设备 | boolean |
organizationId | 组织ID | string |
slaveDeviceId | 子设备ID | string |
defaultConfig | 租户默认配置 | string |
description | 租户描述 | string |
enabled | 租户状态:启用/禁用 | boolean |
frontId | 前端组件ID | string |
icon | 租户图标 | string |
id | ID | string |
layout | 布局 | ComponentLayoutDTO |
h | 高度 | integer |
id | 组件元素ID | string |
w | 宽度 | integer |
x | X坐标 | integer |
y | Y坐标 | integer |
name | 组件名称 | string |
remark | 备注 | string |
roleIds | 租户角色列表 | array |
tenantExpireTime | 租户到期时间 | string(date-time) |
tenantId | 租户ID | string |
tenantProfileId | 租户配置 | string |
tenantStatus | 可用值:DISABLED,EXPIRED,NORMAL | string |
updateTime | 更新时间 | string(date-time) |
updater | 更新用户 | string |
message | string |
响应示例:
{
"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
}
}
请求参数:
参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 |
boardId | boardId | path | true | string |
dataComponentDTO | DataComponentDTO | body | true | DataComponentDTO |
createTime | 创建时间 | false | string(date-time) | |
creator | 创建用户 | false | string | |
dataBoardId | 数据看板ID | true | string | |
dataSource | 数据源 | true | array | |
attribute | 属性 | true | string | |
attributeRename | 属性重命名 | false | string | |
componentInfo | 组件选项信息 | false | ComponentInfoDTO | |
fontColor | 数值字体颜色 | true | string | |
gradientInfo | 梯度信息 | false | array | |
color | 梯度颜色 | false | string | |
key | 梯度key | false | string | |
value | 梯度值 | false | integer | |
icon | icon图标 | false | string | |
iconColor | icon图标颜色 | false | string | |
showDeviceName | 显示设备名称:默认true | false | boolean | |
unit | 数值单位 | false | string | |
deviceId | 设备ID | true | string | |
deviceName | 设备名称 | false | string | |
deviceProfileId | 设备配置ID | true | string | |
deviceRename | 设备重命名 | false | string | |
deviceType | 组织ID,可用值:DIRECT_CONNECTION,GATEWAY,SENSOR | true | string | |
gatewayDevice | 是否网关设备 | false | boolean | |
organizationId | 组织ID | true | string | |
slaveDeviceId | 子设备ID | false | string | |
defaultConfig | 租户默认配置 | false | string | |
description | 租户描述 | false | string | |
enabled | 租户状态:启用/禁用 | false | boolean | |
frontId | 前端组件ID | true | string | |
icon | 租户图标 | false | string | |
id | ID | false | string | |
layout | 布局 | true | ComponentLayoutDTO | |
h | 高度 | true | integer | |
id | 组件元素ID | false | string | |
w | 宽度 | true | integer | |
x | X坐标 | true | integer | |
y | Y坐标 | true | integer | |
name | 组件名称 | false | string | |
remark | 备注 | false | string | |
roleIds | 租户角色列表 | false | array | |
tenantExpireTime | 租户到期时间 | false | string(date-time) | |
tenantId | 租户ID | false | string | |
tenantProfileId | 租户配置 | false | string | |
tenantStatus | 可用值:DISABLED,EXPIRED,NORMAL | false | string | |
updateTime | 更新时间 | false | string(date-time) | |
updater | 更新用户 | false | string |
响应参数:
参数名称 | 参数说明 | 类型 |
code | integer(int32) | |
data | DataComponentDTO | |
createTime | 创建时间 | string(date-time) |
creator | 创建用户 | string |
dataBoardId | 数据看板ID | string |
dataSource | 数据源 | array |
attribute | 属性 | string |
attributeRename | 属性重命名 | string |
componentInfo | 组件选项信息 | ComponentInfoDTO |
fontColor | 数值字体颜色 | string |
gradientInfo | 梯度信息 | array |
color | 梯度颜色 | string |
key | 梯度key | string |
value | 梯度值 | integer |
icon | icon图标 | string |
iconColor | icon图标颜色 | string |
showDeviceName | 显示设备名称:默认true | boolean |
unit | 数值单位 | string |
deviceId | 设备ID | string |
deviceName | 设备名称 | string |
deviceProfileId | 设备配置ID | string |
deviceRename | 设备重命名 | string |
deviceType | 组织ID,可用值:DIRECT_CONNECTION,GATEWAY,SENSOR | string |
gatewayDevice | 是否网关设备 | boolean |
organizationId | 组织ID | string |
slaveDeviceId | 子设备ID | string |
defaultConfig | 租户默认配置 | string |
description | 租户描述 | string |
enabled | 租户状态:启用/禁用 | boolean |
frontId | 前端组件ID | string |
icon | 租户图标 | string |
id | ID | string |
layout | 布局 | ComponentLayoutDTO |
h | 高度 | integer |
id | 组件元素ID | string |
w | 宽度 | integer |
x | X坐标 | integer |
y | Y坐标 | integer |
name | 组件名称 | string |
remark | 备注 | string |
roleIds | 租户角色列表 | array |
tenantExpireTime | 租户到期时间 | string(date-time) |
tenantId | 租户ID | string |
tenantProfileId | 租户配置 | string |
tenantStatus | 可用值:DISABLED,EXPIRED,NORMAL | string |
updateTime | 更新时间 | string(date-time) |
updater | 更新用户 | string |
message | string |
响应示例:
{
"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": ""
}
请求参数:
参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 |
dataBoardId | dataBoardId | path | true | string |
deleteDTO | DeleteDTO | body | true | DeleteDTO |
ids | 删除ID列表 | true | array | |
tenantId | 租户ID | false | string |
响应参数:
参数名称 | 参数说明 | 类型 |
code | integer(int32) | |
data | boolean | |
message | string |
响应示例:
{
"code": 0,
"data": true,
"message": ""
}