ThingsKit物联网平台API文档-可视化（组态）

云腾小编

2024年9月27日2024年9月25日

新增组态

接口地址:/api/yt/configuration/center

请求方式:POST

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

响应数据类型:*/*

请求示例:

{
  "createTime": "",
  "creator": "",
  "defaultConfig": "",
  "defaultContent": "",
  "description": "",
  "enabled": false,
  "icon": "",
  "id": "",
  "name": ""，
  "organizationId": "",
  "platform": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
configurationCenterDTO	ConfigurationCenterDTO	body	true	ConfigurationCenterDTO
createTime	创建时间		false	string(date-time)
creator	创建用户		false	string
defaultConfig	租户默认配置		false	string
defaultContent	默认内容		false	string
description	租户描述		false	string
enabled	租户状态：启用/禁用		false	boolean
icon	租户图标		false	string
id	ID		false	string
name	组态名称		true	string
organizationDTO	组织信息		false	OrganizationDTO
children	子集		false	array
createTime	创建时间		false	string
creator	创建用户		false	string
defaultConfig	租户默认配置		false	string
description	租户描述		false	string
enabled	租户状态：启用/禁用		false	boolean
icon	租户图标		false	string
id	ID		false	string
name	组织名称		false	string
parentId	组织父ID		false	string
remark	备注		false	string
roleIds	租户角色列表		false	array
sort	排序		false	integer
tenantExpireTime	租户到期时间		false	string
tenantId	租户ID		false	string
tenantProfileId	租户配置		false	string
tenantStatus	可用值:DISABLED,EXPIRED,NORMAL		false	string
updateTime	更新时间		false	string
updater	更新用户		false	string
organizationId	组织ID		true	string
platform	终端类型		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
thumbnail	组态缩略图		false	string
updateTime	更新时间		false	string(date-time)
updater	更新用户		false	string

响应参数:

参数名称	参数说明	类型
createTime	创建时间	string(date-time)
creator	创建用户	string
defaultConfig	租户默认配置	string
defaultContent	默认内容	string
description	租户描述	string
enabled	租户状态：启用/禁用	boolean
icon	租户图标	string
id	ID	string
name	组态名称	string
organizationDTO	组织信息	OrganizationDTO
children	子集	array
createTime	创建时间	string(date-time)
creator	创建用户	string
defaultConfig	租户默认配置	string
description	租户描述	string
enabled	租户状态：启用/禁用	boolean
icon	租户图标	string
id	ID	string
name	组织名称	string
parentId	组织父ID	string
remark	备注	string
roleIds	租户角色列表	array
sort	排序	integer(int32)
tenantExpireTime	租户到期时间	string(date-time)
tenantId	租户ID	string
tenantProfileId	租户配置	string
tenantStatus	可用值:DISABLED,EXPIRED,NORMAL	string
updateTime	更新时间	string(date-time)
updater	更新用户	string
organizationId	组织ID	string
platform	终端类型	string
remark	组态描述	string
roleIds	租户角色列表	array
tenantExpireTime	租户到期时间	string(date-time)
tenantId	租户ID	string
tenantProfileId	租户配置	string
tenantStatus	可用值:DISABLED,EXPIRED,NORMAL	string
thumbnail	组态缩略图	string
updateTime	更新时间	string(date-time)
updater	更新用户	string

响应示例:

{
	"createTime": "",
	"creator": "",
	"defaultConfig": "",
	"defaultContent": "",
	"description": "",
	"enabled": false,
	"icon": "",
	"id": "",
	"name": "",
	"organizationDTO": {
		"children": [
			{
				"children": [
					{}
				],
				"createTime": "",
				"creator": "",
				"defaultConfig": "",
				"description": "",
				"enabled": false,
				"icon": "",
				"id": "",
				"name": "",
				"parentId": "",
				"remark": "",
				"roleIds": [],
				"sort": 0,
				"tenantExpireTime": "",
				"tenantId": "",
				"tenantProfileId": "",
				"tenantStatus": "",
				"updateTime": "",
				"updater": ""
			}
		],
		"createTime": "",
		"creator": "",
		"defaultConfig": "",
		"description": "",
		"enabled": false,
		"icon": "",
		"id": "",
		"name": "",
		"parentId": "",
		"remark": "",
		"roleIds": [],
		"sort": 0,
		"tenantExpireTime": "",
		"tenantId": "",
		"tenantProfileId": "",
		"tenantStatus": "",
		"updateTime": "",
		"updater": ""
	},
	"organizationId": "",
	"platform": "",
	"remark": "",
	"roleIds": [],
	"tenantExpireTime": "",
	"tenantId": "",
	"tenantProfileId": "",
	"tenantStatus": "",
	"thumbnail": "",
	"updateTime": "",
	"updater": ""
}

修改组态

接口地址:/api/yt/configuration/center

请求方式:PUT

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

响应数据类型:*/*

请求示例:

{
  "createTime": "",
  "creator": "",
  "defaultConfig": "",
  "defaultContent": "",
  "description": "",
  "enabled": false,
  "icon": "",
  "id": "",
  "name": "",
  "organizationId": "",
  "platform": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
configurationCenterDTO	ConfigurationCenterDTO	body	true	ConfigurationCenterDTO
createTime	创建时间		false	string(date-time)
creator	创建用户		false	string
defaultConfig	租户默认配置		false	string
defaultContent	默认内容		false	string
description	租户描述		false	string
enabled	租户状态：启用/禁用		false	boolean
icon	租户图标		false	string
id	ID		false	string
name	组态名称		true	string
organizationDTO	组织信息		false	OrganizationDTO
children	子集		false	array
createTime	创建时间		false	string
creator	创建用户		false	string
defaultConfig	租户默认配置		false	string
description	租户描述		false	string
enabled	租户状态：启用/禁用		false	boolean
icon	租户图标		false	string
id	ID		false	string
name	组织名称		false	string
parentId	组织父ID		false	string
remark	备注		false	string
roleIds	租户角色列表		false	array
sort	排序		false	integer
tenantExpireTime	租户到期时间		false	string
tenantId	租户ID		false	string
tenantProfileId	租户配置		false	string
tenantStatus	可用值:DISABLED,EXPIRED,NORMAL		false	string
updateTime	更新时间		false	string
updater	更新用户		false	string
organizationId	组织ID		true	string
platform	终端类型		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
thumbnail	组态缩略图		false	string
updateTime	更新时间		false	string(date-time)
updater	更新用户		false	string

响应参数:

参数名称	参数说明	类型
createTime	创建时间	string(date-time)
creator	创建用户	string
defaultConfig	租户默认配置	string
defaultContent	默认内容	string
description	租户描述	string
enabled	租户状态：启用/禁用	boolean
icon	租户图标	string
id	ID	string
name	组态名称	string
organizationDTO	组织信息	OrganizationDTO
children	子集	array
createTime	创建时间	string(date-time)
creator	创建用户	string
defaultConfig	租户默认配置	string
description	租户描述	string
enabled	租户状态：启用/禁用	boolean
icon	租户图标	string
id	ID	string
name	组织名称	string
parentId	组织父ID	string
remark	备注	string
roleIds	租户角色列表	array
sort	排序	integer(int32)
tenantExpireTime	租户到期时间	string(date-time)
tenantId	租户ID	string
tenantProfileId	租户配置	string
tenantStatus	可用值:DISABLED,EXPIRED,NORMAL	string
updateTime	更新时间	string(date-time)
updater	更新用户	string
organizationId	组织ID	string
platform	终端类型	string
remark	组态描述	string
roleIds	租户角色列表	array
tenantExpireTime	租户到期时间	string(date-time)
tenantId	租户ID	string
tenantProfileId	租户配置	string
tenantStatus	可用值:DISABLED,EXPIRED,NORMAL	string
thumbnail	组态缩略图	string
updateTime	更新时间	string(date-time)
updater	更新用户	string

响应示例:

{
	"createTime": "",
	"creator": "",
	"defaultConfig": "",
	"defaultContent": "",
	"description": "",
	"enabled": false,
	"icon": "",
	"id": "",
	"name": "",
	"organizationDTO": {
		"children": [
			{
				"children": [
					{}
				],
				"createTime": "",
				"creator": "",
				"defaultConfig": "",
				"description": "",
				"enabled": false,
				"icon": "",
				"id": "",
				"name": "",
				"parentId": "",
				"remark": "",
				"roleIds": [],
				"sort": 0,
				"tenantExpireTime": "",
				"tenantId": "",
				"tenantProfileId": "",
				"tenantStatus": "",
				"updateTime": "",
				"updater": ""
			}
		],
		"createTime": "",
		"creator": "",
		"defaultConfig": "",
		"description": "",
		"enabled": false,
		"icon": "",
		"id": "",
		"name": "",
		"parentId": "",
		"remark": "",
		"roleIds": [],
		"sort": 0,
		"tenantExpireTime": "",
		"tenantId": "",
		"tenantProfileId": "",
		"tenantStatus": "",
		"updateTime": "",
		"updater": ""
	},
	"organizationId": "",
	"platform": "",
	"remark": "",
	"roleIds": [],
	"tenantExpireTime": "",
	"tenantId": "",
	"tenantProfileId": "",
	"tenantStatus": "",
	"thumbnail": "",
	"updateTime": "",
	"updater": ""
}

删除组态

接口地址:/api/yt/configuration/center

请求方式:DELETE

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

响应数据类型:*/*

请求示例:

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

请求参数:

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

获取组态信息

接口地址:/api/yt/configuration/center/get_configuration_info/{id}

请求方式:GET

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

响应数据类型:*/*

请求参数:

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

响应参数:

参数名称	参数说明	类型
configurationContentList	组态内容	array
configurationId	组织中心ID	string
content	页面内容	string
contentId	页面内容ID	string
createTime	创建时间	string(date-time)
creator	创建用户	string
defaultConfig	租户默认配置	string
description	租户描述	string
enabled	租户状态：启用/禁用	boolean
icon	租户图标	string
id	ID	string
name	页面名称	string
nodeIds	节点列表	array
remark	组态描述	string
roleIds	租户角色列表	array
tenantExpireTime	租户到期时间	string(date-time)
tenantId	租户ID	string
tenantProfileId	租户配置	string
tenantStatus	可用值:DISABLED,EXPIRED,NORMAL	string
type	类型：0手机 1PC	integer(int32)
updateTime	更新时间	string(date-time)
updater	更新用户	string
configurationId	组态中心ID	string
configurationName	组态中心名称	string
platform	终端类型	string

响应示例:

{
	"configurationContentList": [
		{
			"configurationId": "",
			"content": "",
			"contentId": "",
			"createTime": "",
			"creator": "",
			"defaultConfig": "",
			"description": "",
			"enabled": false,
			"icon": "",
			"id": "",
			"name": "",
			"nodeIds": [],
			"remark": "",
			"roleIds": [],
			"tenantExpireTime": "",
			"tenantId": "",
			"tenantProfileId": "",
			"tenantStatus": "",
			"type": 0,
			"updateTime": "",
			"updater": ""
		}
	],
	"configurationId": "",
	"configurationName": "",
	"platform": ""
}

组态分页

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

请求方式:GET

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

响应数据类型:*/*

请求参数:

参数名称	参数说明	是否必须	数据类型
page	page	true	int
pageSize	pageSize	true	int
name	name	false	string
platform	platform	false	string
organizationId	organizationId	false	string
orderFiled	orderFiled	false	string
orderType	orderType,可用值:ASC,DESC	false	string

响应参数:

参数名称	参数说明	类型
items		array
createTime	创建时间	string(date-time)
creator	创建用户	string
defaultConfig	租户默认配置	string
defaultContent	默认内容	string
description	租户描述	string
enabled	租户状态：启用/禁用	boolean
icon	租户图标	string
id	ID	string
name	组态名称	string
organizationDTO	组织信息	OrganizationDTO
children	子集	array
createTime	创建时间	string
creator	创建用户	string
defaultConfig	租户默认配置	string
description	租户描述	string
enabled	租户状态：启用/禁用	boolean
icon	租户图标	string
id	ID	string
name	组织名称	string
parentId	组织父ID	string
remark	备注	string
roleIds	租户角色列表	array
sort	排序	integer
tenantExpireTime	租户到期时间	string
tenantId	租户ID	string
tenantProfileId	租户配置	string
tenantStatus	可用值:DISABLED,EXPIRED,NORMAL	string
updateTime	更新时间	string
updater	更新用户	string
organizationId	组织ID	string
platform	终端类型	string
remark	组态描述	string
roleIds	租户角色列表	array
tenantExpireTime	租户到期时间	string(date-time)
tenantId	租户ID	string
tenantProfileId	租户配置	string
tenantStatus	可用值:DISABLED,EXPIRED,NORMAL	string
thumbnail	组态缩略图	string
updateTime	更新时间	string(date-time)
updater	更新用户	string
total		integer(int32)

响应示例:

{
	"items": [
		{
			"createTime": "",
			"creator": "",
			"defaultConfig": "",
			"defaultContent": "",
			"description": "",
			"enabled": false,
			"icon": "",
			"id": "",
			"name": "",
			"organizationDTO": {
				"children": [
					{
						"children": [
							{}
						],
						"createTime": "",
						"creator": "",
						"defaultConfig": "",
						"description": "",
						"enabled": false,
						"icon": "",
						"id": "",
						"name": "",
						"parentId": "",
						"remark": "",
						"roleIds": [],
						"sort": 0,
						"tenantExpireTime": "",
						"tenantId": "",
						"tenantProfileId": "",
						"tenantStatus": "",
						"updateTime": "",
						"updater": ""
					}
				],
				"createTime": "",
				"creator": "",
				"defaultConfig": "",
				"description": "",
				"enabled": false,
				"icon": "",
				"id": "",
				"name": "",
				"parentId": "",
				"remark": "",
				"roleIds": [],
				"sort": 0,
				"tenantExpireTime": "",
				"tenantId": "",
				"tenantProfileId": "",
				"tenantStatus": "",
				"updateTime": "",
				"updater": ""
			},
			"organizationId": "",
			"platform": "",
			"remark": "",
			"roleIds": [],
			"tenantExpireTime": "",
			"tenantId": "",
			"tenantProfileId": "",
			"tenantStatus": "",
			"thumbnail": "",
			"updateTime": "",
			"updater": ""
		}
	],
	"total": 0
}

组态内容新增

接口地址:/api/yt/configuration/content

请求方式:POST

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

响应数据类型:*/*

请求示例:

{
  "configurationId": "",
  "content": "",
  "contentId": "",
  "createTime": "",
  "creator": "",
  "defaultConfig": "",
  "description": "",
  "enabled": false,
  "icon": "",
  "id": "",
  "name": "",
  "type": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
configurationContentDTO	ConfigurationContentDTO	body	true	ConfigurationContentDTO
configurationId	组织中心ID		true	string
content	页面内容		false	string
contentId	页面内容ID		true	string
createTime	创建时间		false	string(date-time)
creator	创建用户		false	string
defaultConfig	租户默认配置		false	string
description	租户描述		false	string
enabled	租户状态：启用/禁用		false	boolean
icon	租户图标		false	string
id	ID		false	string
name	页面名称		true	string
nodeIds	节点列表		false	array
remark	组态描述		false	string
roleIds	租户角色列表		false	array
tenantExpireTime	租户到期时间		false	string(date-time)
tenantId	租户ID		false	string
tenantProfileId	租户配置		false	string
tenantStatus	可用值:DISABLED,EXPIRED,NORMAL		false	string
type	类型：0手机 1PC		true	integer(int32)
updateTime	更新时间		false	string(date-time)
updater	更新用户		false	string

响应参数:

参数名称	参数说明	类型
configurationId	组织中心ID	string
content	页面内容	string
contentId	页面内容ID	string
createTime	创建时间	string(date-time)
creator	创建用户	string
defaultConfig	租户默认配置	string
description	租户描述	string
enabled	租户状态：启用/禁用	boolean
icon	租户图标	string
id	ID	string
name	页面名称	string
nodeIds	节点列表	array
remark	组态描述	string
roleIds	租户角色列表	array
tenantExpireTime	租户到期时间	string(date-time)
tenantId	租户ID	string
tenantProfileId	租户配置	string
tenantStatus	可用值:DISABLED,EXPIRED,NORMAL	string
type	类型：0手机 1PC	integer(int32)
updateTime	更新时间	string(date-time)
updater	更新用户	string

响应示例:

{
	"configurationId": "",
	"content": "",
	"contentId": "",
	"createTime": "",
	"creator": "",
	"defaultConfig": "",
	"description": "",
	"enabled": false,
	"icon": "",
	"id": "",
	"name": "",
	"nodeIds": [],
	"remark": "",
	"roleIds": [],
	"tenantExpireTime": "",
	"tenantId": "",
	"tenantProfileId": "",
	"tenantStatus": "",
	"type": 0,
	"updateTime": "",
	"updater": ""
}

修改

接口地址:/api/yt/configuration/content

请求方式:PUT

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

响应数据类型:*/*

请求示例:

{
  "configurationContentList": [
    {
      "configurationId": "",
      "content": "",
      "contentId": "",
      "createTime": "",
      "creator": "",
      "defaultConfig": "",
      "description": "",
      "enabled": false,
      "icon": "",
      "id": "",
      "name": "",
      "type": 0,
      "updateTime": "",
      "updater": ""
    }
  ],
  "configurationId": "",
  "platform": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
组态编辑	组态编辑	body	true	组态编辑
configurationContentList	组态内容		true	array
configurationId	组织中心ID		true	string
content	页面内容		false	string
contentId	页面内容ID		true	string
createTime	创建时间		false	string
creator	创建用户		false	string
defaultConfig	租户默认配置		false	string
description	租户描述		false	string
enabled	租户状态：启用/禁用		false	boolean
icon	租户图标		false	string
id	ID		false	string
name	页面名称		true	string
nodeIds	节点列表		false	array
remark	组态描述		false	string
roleIds	租户角色列表		false	array
tenantExpireTime	租户到期时间		false	string
tenantId	租户ID		false	string
tenantProfileId	租户配置		false	string
tenantStatus	可用值:DISABLED,EXPIRED,NORMAL		false	string
type	类型：0手机 1PC		true	integer
updateTime	更新时间		false	string
updater	更新用户		false	string
configurationId	组态中心ID		true	string
configurationName	组态中心名称		false	string
platform	终端类型		true	string

响应参数:

参数名称	参数说明	类型
configurationContentList	组态内容	array
configurationId	组织中心ID	string
content	页面内容	string
contentId	页面内容ID	string
createTime	创建时间	string(date-time)
creator	创建用户	string
defaultConfig	租户默认配置	string
description	租户描述	string
enabled	租户状态：启用/禁用	boolean
icon	租户图标	string
id	ID	string
name	页面名称	string
nodeIds	节点列表	array
remark	组态描述	string
roleIds	租户角色列表	array
tenantExpireTime	租户到期时间	string(date-time)
tenantId	租户ID	string
tenantProfileId	租户配置	string
tenantStatus	可用值:DISABLED,EXPIRED,NORMAL	string
type	类型：0手机 1PC	integer(int32)
updateTime	更新时间	string(date-time)
updater	更新用户	string
configurationId	组态中心ID	string
configurationName	组态中心名称	string
platform	终端类型	string

响应示例:

{
	"configurationContentList": [
		{
			"configurationId": "",
			"content": "",
			"contentId": "",
			"createTime": "",
			"creator": "",
			"defaultConfig": "",
			"description": "",
			"enabled": false,
			"icon": "",
			"id": "",
			"name": "",
			"nodeIds": [],
			"remark": "",
			"roleIds": [],
			"tenantExpireTime": "",
			"tenantId": "",
			"tenantProfileId": "",
			"tenantStatus": "",
			"type": 0,
			"updateTime": "",
			"updater": ""
		}
	],
	"configurationId": "",
	"configurationName": "",
	"platform": ""
}

删除

接口地址:/api/yt/configuration/content

请求方式:DELETE

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

响应数据类型:*/*

请求示例:

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

请求参数:

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

2022年1月22日

云腾五洲科技2022年春节放假通知

2022年3月17日

团队就地解散！苹果汽车彻底“凉凉”了；华为最新全屋智能售价4万，简直比去年便宜太多；全球股市大反弹，抄底人赚翻？| 物联网头条

2022年3月19日

ThingsKit物联网平台API文档-可视化（组态）

新增组态

修改组态

删除组态

获取组态信息

组态分页

组态内容新增

修改

删除

Related Articles

云腾五洲科技2022年春节放假通知

团队就地解散！苹果汽车彻底“凉凉”了；华为最新全屋智能售价4万，简直比去年便宜太多；全球股市大反弹，抄底人赚翻？| 物联网头条

罗永浩拿上亿分手费？传交个朋友天价买账号；百度被裁员工爆料：团队曾超额完成业绩；华为自研编程语言可试用；中芯国际换帅 | 物联网头条