登录 注册
开源 企业版 高校版 私有云 Gitee AI NEW
扫描微信二维码支付
取消
支付完成
Watch
不关注 关注所有动态 仅关注版本发行动态 关注但不提醒动态
3 Star 6 Fork 2

ThingsKit / ThingsKit物联网平台文档

代码 Issues 0 Pull Requests 0 Wiki 统计 流水线
服务
加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目，私有仓库也完全免费 ：）
免费加入
克隆/下载
index.md 27.13 KB
一键复制 编辑 原始数据 按行查看 历史
TrueVoid 提交于 2023-01-18 20:20 . docs: release1.0.1

通知管理分页

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

请求方式:GET

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

响应数据类型:*/*

请求参数:

参数名称 参数说明 请求类型 是否必须 数据类型
page page query true string
pageSize pageSize query true string
type type,可用值:MEETING,NOTICE,OTHER query false string
orderFiled orderFiled query false string
orderType orderType,可用值:ASC,DESC query false string

响应参数:

参数名称 参数说明 类型
items array
  avatar 头像 string
  content 内容 string
  createTime 创建时间 string(date-time)
  creator 创建用户 string
  defaultConfig 租户默认配置 string
  description 租户描述 string
  enabled 租户状态：启用/禁用 boolean
  icon 租户图标 string
  id ID string
  name 租户名称 string
  pointId 根据receiverType不同变化，0:传null，1:组织id，2:部门id，3:用户id string
  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 租户ID string
  tenantProfileId 租户配置 string
  tenantStatus 可用值:DISABLED,EXPIRED,NORMAL string
  title 标题 string
  type 通知类型,可用值:MEETING,NOTICE,OTHER string
  updateTime 更新时间 string(date-time)
  updater 更新用户 string
total integer(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": ""
}

请求参数:

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

响应参数:

参数名称 参数说明 类型
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)

响应示例:

{}

响应状态码-401:

响应参数:

参数名称 参数说明 类型 schema
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) integer(int32)
timestamp Timestamp string(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": ""
}

请求参数:

参数名称 参数说明 请求类型 是否必须 数据类型
通知管理 通知管理 body true 通知管理
  avatar 头像 false string
  content 内容 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 租户名称 false string
  pointId 根据receiverType不同变化，0:传null，1:组织id，2:部门id，3:用户id true string
  receiverType 接收者（字典值receiver_type） 0：全部 1：组织 2：部门 3：个人 true integer(int32)
  roleIds 租户角色列表 false array
  senderDate 发送时间 false string(date-time)
  senderName 发送者 false string
  status 发送状态（字典值draft_status） 0：草稿 1：已发布 false integer(int32)
  tenantExpireTime 租户到期时间 false string(date-time)
  tenantId 租户ID false string
  tenantProfileId 租户配置 false string
  tenantStatus 可用值:DISABLED,EXPIRED,NORMAL false string
  title 标题 true string
  type 通知类型,可用值:MEETING,NOTICE,OTHER true string
  updateTime 更新时间 false string(date-time)
  updater 更新用户 false string

响应参数:

参数名称 参数说明 类型
avatar 头像 string
content 内容 string
createTime 创建时间 string(date-time)
creator 创建用户 string
defaultConfig 租户默认配置 string
description 租户描述 string
enabled 租户状态：启用/禁用 boolean
icon 租户图标 string
id ID string
name 租户名称 string
pointId 根据receiverType不同变化，0:传null，1:组织id，2:部门id，3:用户id string
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 租户ID string
tenantProfileId 租户配置 string
tenantStatus 可用值:DISABLED,EXPIRED,NORMAL string
title 标题 string
type 通知类型,可用值:MEETING,NOTICE,OTHER string
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": ""
}

请求参数:

参数名称 参数说明 请求类型 是否必须 数据类型
通知管理 通知管理 body true 通知管理
  avatar 头像 false string
  content 内容 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 租户名称 false string
  pointId 根据receiverType不同变化，0:传null，1:组织id，2:部门id，3:用户id true string
  receiverType 接收者（字典值receiver_type） 0：全部 1：组织 2：部门 3：个人 true integer(int32)
  roleIds 租户角色列表 false array
  senderDate 发送时间 false string(date-time)
  senderName 发送者 false string
  status 发送状态（字典值draft_status） 0：草稿 1：已发布 false integer(int32)
  tenantExpireTime 租户到期时间 false string(date-time)
  tenantId 租户ID false string
  tenantProfileId 租户配置 false string
  tenantStatus 可用值:DISABLED,EXPIRED,NORMAL false string
  title 标题 true string
  type 通知类型,可用值:MEETING,NOTICE,OTHER true string
  updateTime 更新时间 false string(date-time)
  updater 更新用户 false string

响应参数:

参数名称 参数说明 类型
avatar 头像 string
content 内容 string
createTime 创建时间 string(date-time)
creator 创建用户 string
defaultConfig 租户默认配置 string
description 租户描述 string
enabled 租户状态：启用/禁用 boolean
icon 租户图标 string
id ID string
name 租户名称 string
pointId 根据receiverType不同变化，0:传null，1:组织id，2:部门id，3:用户id string
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 租户ID string
tenantProfileId 租户配置 string
tenantStatus 可用值:DISABLED,EXPIRED,NORMAL string
title 标题 string
type 通知类型,可用值:MEETING,NOTICE,OTHER string
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

响应数据类型:*/*

请求参数:

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

响应参数:

参数名称 参数说明 类型
avatar 头像 string
content 内容 string
createTime 创建时间 string(date-time)
creator 创建用户 string
defaultConfig 租户默认配置 string
description 租户描述 string
enabled 租户状态：启用/禁用 boolean
icon 租户图标 string
id ID string
name 租户名称 string
pointId 根据receiverType不同变化，0:传null，1:组织id，2:部门id，3:用户id string
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 租户ID string
tenantProfileId 租户配置 string
tenantStatus 可用值:DISABLED,EXPIRED,NORMAL string
title 标题 string
type 通知类型,可用值:MEETING,NOTICE,OTHER string
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": ""
}
1
https://gitee.com/thingskit/thingskit-docs.git
git@gitee.com:thingskit/thingskit-docs.git
thingskit
thingskit-docs
ThingsKit物联网平台文档
master
点此查找更多帮助

搜索帮助

Git 命令在线学习 如何在 Gitee 导入 GitHub 仓库
Git 仓库基础操作
企业版和社区版功能对比
SSH 公钥设置
如何处理代码冲突
仓库体积过大，如何减小？
如何找回被删除的仓库数据
Gitee 产品配额说明
GitHub仓库快速导入Gitee及同步更新
什么是 Release（发行版）
将 PHP 项目自动发布到 packagist.org
评论
仓库举报
回到顶部