ThingsKit

新增|编辑 ¶

接口地址:/api/yt/opinion

请求方式:POST

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

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "category": "",
  "contact": "",
  "createTime": "",
  "creator": "",
  "defaultConfig": "",
  "description": "",
  "enabled": false,
  "icon": "",
  "id": "",
  "images": "",
  "message": "",
  "name": "",
  "remark": "",
  "roleIds": [],
  "status": "",
  "tenantExpireTime": "",
  "tenantId": "",
  "tenantProfileId": "",
  "tenantStatus": "",
  "title": "",
  "updateTime": "",
  "updater": ""
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
tkOpinionDTO	TkOpinionDTO	body	true	TkOpinionDTO
message	意见详细说明		true	string
name	联系人姓名		true	string
title	意见标题		true	string

响应参数:

参数名称	参数说明	类型
category	意见分类	string
contact	联系方式，json格式	string
createTime	创建时间	string(date-time)
creator	创建用户	string
defaultConfig	租户默认配置	string
description	租户描述	string
enabled	租户状态：启用/禁用	boolean
icon	租户图标	string
id	ID	string
images	意见附件，多个附件用逗号分割	string
message	意见详细说明	string
name	联系人姓名	string
remark	意见处理意见	string
roleIds	租户角色列表	array
status	意见处理状态	string
tenantExpireTime	租户到期时间	string(date-time)
tenantId	租户ID	string
tenantProfileId	租户配置	string
tenantStatus	可用值:DISABLED,EXPIRED,NORMAL	string
title	意见标题	string
updateTime	更新时间	string(date-time)
updater	更新用户	string

响应示例:

javascript

{
	"category": "",
	"contact": "",
	"createTime": "",
	"creator": "",
	"defaultConfig": "",
	"description": "",
	"enabled": false,
	"icon": "",
	"id": "",
	"images": "",
	"message": "",
	"name": "",
	"remark": "",
	"roleIds": [],
	"status": "",
	"tenantExpireTime": "",
	"tenantId": "",
	"tenantProfileId": "",
	"tenantStatus": "",
	"title": "",
	"updateTime": "",
	"updater": ""
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24

删除 ¶

接口地址:/api/yt/opinion

请求方式:DELETE

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

响应数据类型:*/*

请求示例:

javascript

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

1
2
3
4

请求参数:

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

响应参数:

参数名称	参数说明	类型
errorCode	Platform error code:\n* `2` - General error (HTTP: 500 - Internal Server Error)\n\n* `10` - Authentication failed (HTTP: 401 - Unauthorized)\n\n* `11` - JWT token expired (HTTP: 401 - Unauthorized)\n\n* `15` - Credentials expired (HTTP: 401 - Unauthorized)\n\n* `20` - Permission denied (HTTP: 403 - Forbidden)\n\n* `30` - Invalid arguments (HTTP: 400 - Bad Request)\n\n* `31` - Bad request params (HTTP: 400 - Bad Request)\n\n* `32` - Item not found (HTTP: 404 - Not Found)\n\n* `33` - Too many requests (HTTP: 429 - Too Many Requests)\n\n* `34` - Too many updates (Too many updates over Websocket session)\n\n* `40` - Subscription violation (HTTP: 403 - Forbidden)	object
message	Error message	string
status	HTTP Response Status Code	integer(int32)
timestamp	Timestamp	string(date-time)

响应示例:

javascript

{}

详情 ¶

接口地址:/api/yt/opinion/{entityId}

请求方式:GET

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

响应数据类型:*/*

请求参数:

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

响应参数:

参数名称	参数说明	类型
category	意见分类	string
contact	联系方式，json格式	string
createTime	创建时间	string(date-time)
creator	创建用户	string
defaultConfig	租户默认配置	string
description	租户描述	string
enabled	租户状态：启用/禁用	boolean
icon	租户图标	string
id	ID	string
images	意见附件，多个附件用逗号分割	string
message	意见详细说明	string
name	联系人姓名	string
remark	意见处理意见	string
roleIds	租户角色列表	array
status	意见处理状态	string
tenantExpireTime	租户到期时间	string(date-time)
tenantId	租户ID	string
tenantProfileId	租户配置	string
tenantStatus	可用值:DISABLED,EXPIRED,NORMAL	string
title	意见标题	string
updateTime	更新时间	string(date-time)
updater	更新用户	string

响应示例:

javascript

{
	"category": "",
	"contact": "",
	"createTime": "",
	"creator": "",
	"defaultConfig": "",
	"description": "",
	"enabled": false,
	"icon": "",
	"id": "",
	"images": "",
	"message": "",
	"name": "",
	"remark": "",
	"roleIds": [],
	"status": "",
	"tenantExpireTime": "",
	"tenantId": "",
	"tenantProfileId": "",
	"tenantStatus": "",
	"title": "",
	"updateTime": "",
	"updater": ""
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24

分页 ¶

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

请求方式:GET

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

响应数据类型:*/*

请求参数:

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

响应参数:

参数名称	参数说明	类型
items		array
category	意见分类	string
contact	联系方式，json格式	string
createTime	创建时间	string(date-time)
creator	创建用户	string
defaultConfig	租户默认配置	string
description	租户描述	string
enabled	租户状态：启用/禁用	boolean
icon	租户图标	string
id	ID	string
images	意见附件，多个附件用逗号分割	string
message	意见详细说明	string
name	联系人姓名	string
remark	意见处理意见	string
roleIds	租户角色列表	array
status	意见处理状态	string
tenantExpireTime	租户到期时间	string(date-time)
tenantId	租户ID	string
tenantProfileId	租户配置	string
tenantStatus	可用值:DISABLED,EXPIRED,NORMAL	string
title	意见标题	string
updateTime	更新时间	string(date-time)
updater	更新用户	string
total		integer(int32)

响应示例:

javascript

{
	"items": [
		{
			"category": "",
			"contact": "",
			"createTime": "",
			"creator": "",
			"defaultConfig": "",
			"description": "",
			"enabled": false,
			"icon": "",
			"id": "",
			"images": "",
			"message": "",
			"name": "",
			"remark": "",
			"roleIds": [],
			"status": "",
			"tenantExpireTime": "",
			"tenantId": "",
			"tenantProfileId": "",
			"tenantStatus": "",
			"title": "",
			"updateTime": "",
			"updater": ""
		}
	],
	"total": 0
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29