ThingsKit物联网平台API文档-系统管理（字典管理）

云腾小编

2024年11月18日2024年11月14日

saveSysDict（待翻译）

接口地址:/api/yt/dict

请求方式:POST

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

响应数据类型:*/*

请求示例:

{
  "createTime": "",
  "creator": "",
  "description": "",
  "dictCode": "",
  "dictName": "",
  "id": "",
  "updateTime": "",
  "updater": ""
}

请求参数:

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

响应参数:

参数名称	参数说明	类型
code		integer(int32)
data		SysDictDTO
createTime	创建时间	string(date-time)
creator	创建用户	string
description	字典描述	string
dictCode	字典编码	string
dictName	字典名称	string
id	ID	string
updateTime	更新时间	string(date-time)
updater	更新用户	string
message		string

响应示例:

{
	"code": 0,
	"data": {
		"createTime": "",
		"creator": "",
		"description": "",
		"dictCode": "",
		"dictName": "",
		"id": "",
		"updateTime": "",
		"updater": ""
	},
	"message": ""
}

updateSysDict（待翻译）

接口地址:/api/yt/dict

请求方式:PUT

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

响应数据类型:`/

请求示例:

{
  "createTime": "",
  "creator": "",
  "description": "",
  "dictCode": "",
  "dictName": "",
  "id": "",
  "updateTime": "",
  "updater": ""
}

请求参数:

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

响应参数:

参数名称	参数说明	类型
code		integer(int32)
data		SysDictDTO
createTime	创建时间	string(date-time)
creator	创建用户	string
description	字典描述	string
dictCode	字典编码	string
dictName	字典名称	string
id	ID	string
updateTime	更新时间	string(date-time)
updater	更新用户	string
message		string

响应示例:

{
	"code": 0,
	"data": {
		"createTime": "",
		"creator": "",
		"description": "",
		"dictCode": "",
		"dictName": "",
		"id": "",
		"updateTime": "",
		"updater": ""
	},
	"message": ""
}

deleteSysDict（待翻译）

接口地址:/api/yt/dict

请求方式:DELETE

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

响应数据类型:`/

请求示例:

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

请求参数:

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

响应参数:

参数名称	参数说明	类型
code		integer(int32)
data		string
message		string

响应示例:

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

pageSysDict（待翻译）

接口地址:/api/yt/dict{?dictCode,dictName,orderFiled,orderType,page,pageSize}

请求方式:GET

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

响应数据类型:*/*

请求参数:

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

响应参数:

参数名称	参数说明	类型
items		array
createTime	创建时间	string(date-time)
creator	创建用户	string
description	字典描述	string
dictCode	字典编码	string
dictName	字典名称	string
id	ID	string
updateTime	更新时间	string(date-time)
updater	更新用户	string
total		integer(int32)

响应示例:

{
	"items": [
		{
			"createTime": "",
			"creator": "",
			"description": "",
			"dictCode": "",
			"dictName": "",
			"id": "",
			"updateTime": "",
			"updater": ""
		}
	],
	"total": 0
}

saveSysDictItem（待翻译）

接口地址:/api/yt/dict_item

请求方式:POST

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

响应数据类型:*/*

接口描述:

请求示例:

{
  "createTime": "",
  "creator": "",
  "description": "",
  "dictId": "",
  "id": "",
  "itemText": "",
  "itemValue": "",
  "sort": 0,
  "status": 0,
  "sysDict": {
    "createTime": "",
    "creator": "",
    "description": "",
    "dictCode": "",
    "dictName": "",
    "id": "",
    "updateTime": "",
    "updater": ""
  },
  "tenantId": "",
  "updateTime": "",
  "updater": ""
}

请求参数:

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

响应参数:

参数名称	参数说明	类型
code		integer(int32)
data		SysDictItemDTO
createTime	创建时间	string(date-time)
creator	创建用户	string
description	子项字典描述	string
dictId	字典子项ID	string
id	ID	string
itemText	子项字典文本	string
itemValue	子项字典值	string
sort	子项字典排序	integer(int32)
status	子项字典状态	integer(int32)
sysDict	字典信息	SysDictDTO
createTime	创建时间	string
creator	创建用户	string
description	字典描述	string
dictCode	字典编码	string
dictName	字典名称	string
id	ID	string
updateTime	更新时间	string
updater	更新用户	string
tenantId	租户ID	string
updateTime	更新时间	string(date-time)
updater	更新用户	string
message		string

响应示例:

{
	"code": 0,
	"data": {
		"createTime": "",
		"creator": "",
		"description": "",
		"dictId": "",
		"id": "",
		"itemText": "",
		"itemValue": "",
		"sort": 0,
		"status": 0,
		"sysDict": {
			"createTime": "",
			"creator": "",
			"description": "",
			"dictCode": "",
			"dictName": "",
			"id": "",
			"updateTime": "",
			"updater": ""
		},
		"tenantId": "",
		"updateTime": "",
		"updater": ""
	},
	"message": ""
}

updateSysDictItem（待翻译）

接口地址:/api/yt/dict_item

请求方式:PUT

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

响应数据类型:*/*

接口描述:

请求示例:

{
  "createTime": "",
  "creator": "",
  "description": "",
  "dictId": "",
  "id": "",
  "itemText": "",
  "itemValue": "",
  "sort": 0,
  "status": 0,
  "sysDict": {
    "createTime": "",
    "creator": "",
    "description": "",
    "dictCode": "",
    "dictName": "",
    "id": "",
    "updateTime": "",
    "updater": ""
  },
  "tenantId": "",
  "updateTime": "",
  "updater": ""
}

请求参数:

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

响应参数:

参数名称	参数说明	类型
code		integer(int32)
data		SysDictItemDTO
createTime	创建时间	string(date-time)
creator	创建用户	string
description	子项字典描述	string
dictId	字典子项ID	string
id	ID	string
itemText	子项字典文本	string
itemValue	子项字典值	string
sort	子项字典排序	integer(int32)
status	子项字典状态	integer(int32)
sysDict	字典信息	SysDictDTO
createTime	创建时间	string
creator	创建用户	string
description	字典描述	string
dictCode	字典编码	string
dictName	字典名称	string
id	ID	string
updateTime	更新时间	string
updater	更新用户	string
tenantId	租户ID	string
updateTime	更新时间	string(date-time)
updater	更新用户	string
message		string

响应示例:

{
	"code": 0,
	"data": {
		"createTime": "",
		"creator": "",
		"description": "",
		"dictId": "",
		"id": "",
		"itemText": "",
		"itemValue": "",
		"sort": 0,
		"status": 0,
		"sysDict": {
			"createTime": "",
			"creator": "",
			"description": "",
			"dictCode": "",
			"dictName": "",
			"id": "",
			"updateTime": "",
			"updater": ""
		},
		"tenantId": "",
		"updateTime": "",
		"updater": ""
	},
	"message": ""
}

deleteSysDictItem（待翻译）

接口地址:/api/yt/dict_item

请求方式:DELETE

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

响应数据类型:`/

请求示例:

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

请求参数:

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

响应参数:

参数名称	参数说明	类型
code		integer(int32)
data		string
message		string

响应示例:

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

findDictItemByDictCode（待翻译）

接口地址:/api/yt/dict_item/find

请求方式:POST

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

响应数据类型:*/*

接口描述:

请求参数:

暂无

响应参数:

参数名称	参数说明	类型
createTime	创建时间	string(date-time)
creator	创建用户	string
description	子项字典描述	string
dictId	字典子项ID	string
id	ID	string
itemText	子项字典文本	string
itemValue	子项字典值	string
sort	子项字典排序	integer(int32)
status	子项字典状态	integer(int32)
sysDict	字典信息	SysDictDTO
createTime	创建时间	string(date-time)
creator	创建用户	string
description	字典描述	string
dictCode	字典编码	string
dictName	字典名称	string
id	ID	string
updateTime	更新时间	string(date-time)
updater	更新用户	string
tenantId	租户ID	string
updateTime	更新时间	string(date-time)
updater	更新用户	string

响应示例:

[
	{
		"createTime": "",
		"creator": "",
		"description": "",
		"dictId": "",
		"id": "",
		"itemText": "",
		"itemValue": "",
		"sort": 0,
		"status": 0,
		"sysDict": {
			"createTime": "",
			"creator": "",
			"description": "",
			"dictCode": "",
			"dictName": "",
			"id": "",
			"updateTime": "",
			"updater": ""
		},
		"tenantId": "",
		"updateTime": "",
		"updater": ""
	}
]

pageSysDictItem（待翻译）

接口地址:/api/yt/dict_item{?dictId,itemText,orderFiled,orderType,page,pageSize,status}

请求方式:GET

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

响应数据类型:*/*

请求参数:

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

响应参数:

参数名称	参数说明	类型
items		array
createTime	创建时间	string(date-time)
creator	创建用户	string
description	子项字典描述	string
dictId	字典子项ID	string
id	ID	string
itemText	子项字典文本	string
itemValue	子项字典值	string
sort	子项字典排序	integer(int32)
status	子项字典状态	integer(int32)
sysDict	字典信息	SysDictDTO
createTime	创建时间	string
creator	创建用户	string
description	字典描述	string
dictCode	字典编码	string
dictName	字典名称	string
id	ID	string
updateTime	更新时间	string
updater	更新用户	string
tenantId	租户ID	string
updateTime	更新时间	string(date-time)
updater	更新用户	string
total		integer(int32)

响应示例:

{
	"items": [
		{
			"createTime": "",
			"creator": "",
			"description": "",
			"dictId": "",
			"id": "",
			"itemText": "",
			"itemValue": "",
			"sort": 0,
			"status": 0,
			"sysDict": {
				"createTime": "",
				"creator": "",
				"description": "",
				"dictCode": "",
				"dictName": "",
				"id": "",
				"updateTime": "",
				"updater": ""
			},
			"tenantId": "",
			"updateTime": "",
			"updater": ""
		}
	],
	"total": 0
}