ThingsKit物联网平台API文档-系统管理（平台通知-我的通知）

通知管理分页

接口地址:/api/yt/notice/page{?orderFiled,orderType,page,pageSize,type}

请求方式:GET

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

响应数据类型:*/*

请求参数:

参数名称参数说明请求类型是否必须数据类型
pagepagequerytruestring
pageSizepageSizequerytruestring
typetype,可用值:MEETING,NOTICE,OTHERqueryfalsestring
orderFiledorderFiledqueryfalsestring
orderTypeorderType,可用值:ASC,DESCqueryfalsestring

响应参数:

参数名称参数说明类型
itemsarray
avatar头像string
content内容string
createTime创建时间string(date-time)
creator创建用户string
defaultConfig租户默认配置string
description租户描述string
enabled租户状态：启用/禁用boolean
icon租户图标string
idIDstring
name租户名称string
pointId根据receiverType不同变化，0:传null，1:组织id，2:部门id，3:用户idstring
receiverType接收者（字典值receiver_type） 0：全部 1：组织 2：部门 3：个人integer(int32)
roleIds租户角色列表array
senderDate发送时间string(date-time)
senderName发送者string
status发送状态（字典值draft_status） 0：草稿 1：已发布integer(int32)
tenantExpireTime租户到期时间string(date-time)
tenantId租户IDstring
tenantProfileId租户配置string
tenantStatus可用值:DISABLED,EXPIRED,NORMALstring
title标题string
type通知类型,可用值:MEETING,NOTICE,OTHERstring
updateTime更新时间string(date-time)
updater更新用户string
totalinteger(int32)

响应示例:

{
	"items": [
		{
			"avatar": "",
			"content": "",
			"createTime": "",
			"creator": "",
			"defaultConfig": "",
			"description": "",
			"enabled": false,
			"icon": "",
			"id": "",
			"name": "",
			"pointId": "",
			"receiverType": 0,
			"roleIds": [],
			"senderDate": "",
			"senderName": "",
			"status": 0,
			"tenantExpireTime": "",
			"tenantId": "",
			"tenantProfileId": "",
			"tenantStatus": "",
			"title": "",
			"type": "",
			"updateTime": "",
			"updater": ""
		}
	],
	"total": 0
}

通知管理批量删除

接口地址:/api/yt/notice/delete

请求方式:DELETE

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

响应数据类型:*/*

请求示例:

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

请求参数:

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

响应参数:

参数名称参数说明类型
errorCodePlatform error code:\n2 – General error (HTTP: 500 – Internal Server Error)\n\n10 – Authentication failed (HTTP: 401 – Unauthorized)\n\n11 – JWT token expired (HTTP: 401 – Unauthorized)\n\n15 – Credentials expired (HTTP: 401 – Unauthorized)\n\n20 – Permission denied (HTTP: 403 – Forbidden)\n\n30 – Invalid arguments (HTTP: 400 – Bad Request)\n\n31 – Bad request params (HTTP: 400 – Bad Request)\n\n32 – Item not found (HTTP: 404 – Not Found)\n\n33 – Too many requests (HTTP: 429 – Too Many Requests)\n\n34 – Too many updates (Too many updates over Websocket session)\n\n* 40 – Subscription violation (HTTP: 403 – Forbidden)object
messageError messagestring
statusHTTP Response Status Codeinteger(int32)
timestampTimestampstring(date-time)

响应示例:

{}

响应状态码-401:

响应参数:

参数名称参数说明类型schema
errorCodePlatform error code:\n2 – General error (HTTP: 500 – Internal Server Error)\n\n10 – Authentication failed (HTTP: 401 – Unauthorized)\n\n11 – JWT token expired (HTTP: 401 – Unauthorized)\n\n15 – Credentials expired (HTTP: 401 – Unauthorized)\n\n20 – Permission denied (HTTP: 403 – Forbidden)\n\n30 – Invalid arguments (HTTP: 400 – Bad Request)\n\n31 – Bad request params (HTTP: 400 – Bad Request)\n\n32 – Item not found (HTTP: 404 – Not Found)\n\n33 – Too many requests (HTTP: 429 – Too Many Requests)\n\n34 – Too many updates (Too many updates over Websocket session)\n\n* 40 – Subscription violation (HTTP: 403 – Forbidden)object
messageError messagestring
statusHTTP Response Status Codeinteger(int32)integer(int32)
timestampTimestampstring(date-time)string(date-time)

响应示例:

{}

保存草稿

接口地址:/api/yt/notice/save

请求方式:POST

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

响应数据类型:*/*

请求示例:

{
  "avatar": "",
  "content": "",
  "createTime": "",
  "creator": "",
  "defaultConfig": "",
  "description": "",
  "enabled": false,
  "icon": "",
  "id": "",
  "name": "",
  "pointId": "",
  "receiverType": 0,
  "roleIds": [],
  "senderDate": "",
  "senderName": "",
  "status": 0,
  "tenantExpireTime": "",
  "tenantId": "",
  "tenantProfileId": "",
  "tenantStatus": "",
  "title": "",
  "type": "",
  "updateTime": "",
  "updater": ""
}

请求参数:

参数名称参数说明请求类型是否必须数据类型
通知管理通知管理bodytrue通知管理
avatar头像falsestring
content内容truestring
createTime创建时间falsestring(date-time)
creator创建用户falsestring
defaultConfig租户默认配置falsestring
description租户描述falsestring
enabled租户状态：启用/禁用falseboolean
icon租户图标falsestring
idIDfalsestring
name租户名称falsestring
pointId根据receiverType不同变化，0:传null，1:组织id，2:部门id，3:用户idtruestring
receiverType接收者（字典值receiver_type） 0：全部 1：组织 2：部门 3：个人trueinteger(int32)
roleIds租户角色列表falsearray
senderDate发送时间falsestring(date-time)
senderName发送者falsestring
status发送状态（字典值draft_status） 0：草稿 1：已发布falseinteger(int32)
tenantExpireTime租户到期时间falsestring(date-time)
tenantId租户IDfalsestring
tenantProfileId租户配置falsestring
tenantStatus可用值:DISABLED,EXPIRED,NORMALfalsestring
title标题truestring
type通知类型,可用值:MEETING,NOTICE,OTHERtruestring
updateTime更新时间falsestring(date-time)
updater更新用户falsestring

响应参数:

参数名称参数说明类型
avatar头像string
content内容string
createTime创建时间string(date-time)
creator创建用户string
defaultConfig租户默认配置string
description租户描述string
enabled租户状态：启用/禁用boolean
icon租户图标string
idIDstring
name租户名称string
pointId根据receiverType不同变化，0:传null，1:组织id，2:部门id，3:用户idstring
receiverType接收者（字典值receiver_type） 0：全部 1：组织 2：部门 3：个人integer(int32)
roleIds租户角色列表array
senderDate发送时间string(date-time)
senderName发送者string
status发送状态（字典值draft_status） 0：草稿 1：已发布integer(int32)
tenantExpireTime租户到期时间string(date-time)
tenantId租户IDstring
tenantProfileId租户配置string
tenantStatus可用值:DISABLED,EXPIRED,NORMALstring
title标题string
type通知类型,可用值:MEETING,NOTICE,OTHERstring
updateTime更新时间string(date-time)
updater更新用户string

响应示例:

{
	"avatar": "",
	"content": "",
	"createTime": "",
	"creator": "",
	"defaultConfig": "",
	"description": "",
	"enabled": false,
	"icon": "",
	"id": "",
	"name": "",
	"pointId": "",
	"receiverType": 0,
	"roleIds": [],
	"senderDate": "",
	"senderName": "",
	"status": 0,
	"tenantExpireTime": "",
	"tenantId": "",
	"tenantProfileId": "",
	"tenantStatus": "",
	"title": "",
	"type": "",
	"updateTime": "",
	"updater": ""
}

发布通知

接口地址:/api/yt/notice/send

请求方式:POST

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

响应数据类型:*/*

请求示例:

{
  "avatar": "",
  "content": "",
  "createTime": "",
  "creator": "",
  "defaultConfig": "",
  "description": "",
  "enabled": false,
  "icon": "",
  "id": "",
  "name": "",
  "pointId": "",
  "receiverType": 0,
  "roleIds": [],
  "senderDate": "",
  "senderName": "",
  "status": 0,
  "tenantExpireTime": "",
  "tenantId": "",
  "tenantProfileId": "",
  "tenantStatus": "",
  "title": "",
  "type": "",
  "updateTime": "",
  "updater": ""
}

请求参数:

参数名称参数说明请求类型是否必须数据类型
通知管理通知管理bodytrue通知管理
avatar头像falsestring
content内容truestring
createTime创建时间falsestring(date-time)
creator创建用户falsestring
defaultConfig租户默认配置falsestring
description租户描述falsestring
enabled租户状态：启用/禁用falseboolean
icon租户图标falsestring
idIDfalsestring
name租户名称falsestring
pointId根据receiverType不同变化，0:传null，1:组织id，2:部门id，3:用户idtruestring
receiverType接收者（字典值receiver_type） 0：全部 1：组织 2：部门 3：个人trueinteger(int32)
roleIds租户角色列表falsearray
senderDate发送时间falsestring(date-time)
senderName发送者falsestring
status发送状态（字典值draft_status） 0：草稿 1：已发布falseinteger(int32)
tenantExpireTime租户到期时间falsestring(date-time)
tenantId租户IDfalsestring
tenantProfileId租户配置falsestring
tenantStatus可用值:DISABLED,EXPIRED,NORMALfalsestring
title标题truestring
type通知类型,可用值:MEETING,NOTICE,OTHERtruestring
updateTime更新时间falsestring(date-time)
updater更新用户falsestring

响应参数:

参数名称参数说明类型
avatar头像string
content内容string
createTime创建时间string(date-time)
creator创建用户string
defaultConfig租户默认配置string
description租户描述string
enabled租户状态：启用/禁用boolean
icon租户图标string
idIDstring
name租户名称string
pointId根据receiverType不同变化，0:传null，1:组织id，2:部门id，3:用户idstring
receiverType接收者（字典值receiver_type） 0：全部 1：组织 2：部门 3：个人integer(int32)
roleIds租户角色列表array
senderDate发送时间string(date-time)
senderName发送者string
status发送状态（字典值draft_status） 0：草稿 1：已发布integer(int32)
tenantExpireTime租户到期时间string(date-time)
tenantId租户IDstring
tenantProfileId租户配置string
tenantStatus可用值:DISABLED,EXPIRED,NORMALstring
title标题string
type通知类型,可用值:MEETING,NOTICE,OTHERstring
updateTime更新时间string(date-time)
updater更新用户string

响应示例:

{
	"avatar": "",
	"content": "",
	"createTime": "",
	"creator": "",
	"defaultConfig": "",
	"description": "",
	"enabled": false,
	"icon": "",
	"id": "",
	"name": "",
	"pointId": "",
	"receiverType": 0,
	"roleIds": [],
	"senderDate": "",
	"senderName": "",
	"status": 0,
	"tenantExpireTime": "",
	"tenantId": "",
	"tenantProfileId": "",
	"tenantStatus": "",
	"title": "",
	"type": "",
	"updateTime": "",
	"updater": ""
}

详情

接口地址:/api/yt/notice/{id}

请求方式:GET

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

响应数据类型:*/*

请求参数:

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

响应参数:

参数名称参数说明类型
avatar头像string
content内容string
createTime创建时间string(date-time)
creator创建用户string
defaultConfig租户默认配置string
description租户描述string
enabled租户状态：启用/禁用boolean
icon租户图标string
idIDstring
name租户名称string
pointId根据receiverType不同变化，0:传null，1:组织id，2:部门id，3:用户idstring
receiverType接收者（字典值receiver_type） 0：全部 1：组织 2：部门 3：个人integer(int32)
roleIds租户角色列表array
senderDate发送时间string(date-time)
senderName发送者string
status发送状态（字典值draft_status） 0：草稿 1：已发布integer(int32)
tenantExpireTime租户到期时间string(date-time)
tenantId租户IDstring
tenantProfileId租户配置string
tenantStatus可用值:DISABLED,EXPIRED,NORMALstring
title标题string
type通知类型,可用值:MEETING,NOTICE,OTHERstring
updateTime更新时间string(date-time)
updater更新用户string

响应示例:

{
	"avatar": "",
	"content": "",
	"createTime": "",
	"creator": "",
	"defaultConfig": "",
	"description": "",
	"enabled": false,
	"icon": "",
	"id": "",
	"name": "",
	"pointId": "",
	"receiverType": 0,
	"roleIds": [],
	"senderDate": "",
	"senderName": "",
	"status": 0,
	"tenantExpireTime": "",
	"tenantId": "",
	"tenantProfileId": "",
	"tenantStatus": "",
	"title": "",
	"type": "",
	"updateTime": "",
	"updater": ""
}
Tags:

Related Articles

2022年1月22日

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

2022年3月17日

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

2022年3月19日

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