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

ThingsKit / ThingsKit物联网平台文档

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

获取菜单列表

接口地址:/api/yt/admin/me/menus{?needButton}

请求方式:GET

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

响应数据类型:*/*

请求参数:

参数名称 参数说明 请求类型 是否必须 数据类型
needButton needButton query false boolean

响应参数:

参数名称 参数说明 类型
caseSensitive 区分大小写 boolean
children 子节点 array
  caseSensitive 区分大小写 boolean
  children 子节点 array
  component 组件路径 string
  createTime 创建时间 string(date-time)
  creator 创建用户 string
  id ID string
  meta 元数据 JsonNode
  name 菜单名称 string
  parentId 上级ID string
  path 路由地址 string
  permission 权限标识 string
  redirect 重定向地址 string
  sort 排序字段 integer(int32)
  type 菜单类型,可用值:CUSTOM,SYSADMIN string
  updateTime 更新时间 string(date-time)
  updater 更新用户 string
component 组件路径 string
createTime 创建时间 string(date-time)
creator 创建用户 string
id ID string
meta 元数据 JsonNode
name 菜单名称 string
parentId 上级ID string
path 路由地址 string
permission 权限标识 string
redirect 重定向地址 string
sort 排序字段 integer(int32)
type 菜单类型,可用值:CUSTOM,SYSADMIN string
updateTime 更新时间 string(date-time)
updater 更新用户 string

响应示例:

[
	{
		"caseSensitive": false,
		"children": [
			{
				"caseSensitive": false,
				"children": [],
				"component": "",
				"createTime": "",
				"creator": "",
				"id": "",
				"meta": "",
				"name": "",
				"parentId": "",
				"path": "",
				"permission": "",
				"redirect": "",
				"sort": 0,
				"type": "",
				"updateTime": "",
				"updater": ""
			}
		],
		"component": "",
		"createTime": "",
		"creator": "",
		"id": "",
		"meta": {},
		"name": "",
		"parentId": "",
		"path": "",
		"permission": "",
		"redirect": "",
		"sort": 0,
		"type": "",
		"updateTime": "",
		"updater": ""
	}
]

新增和编辑租户

接口地址:/api/yt/admin/tenant/updateOrCreateTenant

请求方式:POST

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

响应数据类型:*/*

请求示例:

{
  "defaultConfig": "",
  "description": "",
  "enabled": true,
  "icon": "",
  "id": "",
  "name": "",
  "roleIds": [],
  "tenantExpireTime": "",
  "tenantId": "",
  "tenantProfileId": {
    "entityType": "TENANT_PROFILE",
    "id": "784f394c-42b6-435a-983c-b7beff2784f9"
  },
  "tenantStatus": ""
}

请求参数:

参数名称 参数说明 请求类型 是否必须 数据类型
tenantReqDTO TenantReqDTO body true TenantReqDTO
  defaultConfig false string
  description false string
  enabled false boolean
  icon false string
  id false string
  name true string
  roleIds true array
  tenantExpireTime false string(date-time)
  tenantId false string
  tenantProfileId false TenantProfileId
    entityType string,可用值:TENANT_PROFILE true string
    id ID of the entity, time-based UUID v1 true string
  tenantStatus 可用值:DISABLED,EXPIRED,NORMAL false string

响应参数:

参数名称 参数说明 类型
createTime 创建时间 string(date-time)
creator 创建用户 string
defaultConfig 租户默认配置 string
description 租户描述 string
enabled 租户状态：启用/禁用 boolean
icon 租户图标 string
id ID string
name 租户名称 string
roleIds 租户角色列表 array
tenantExpireTime 租户到期时间 string(date-time)
tenantId 租户ID string
tenantProfileId 租户配置 string
tenantStatus 可用值:DISABLED,EXPIRED,NORMAL string
updateTime 更新时间 string(date-time)
updater 更新用户 string

响应示例:

{
	"createTime": "",
	"creator": "",
	"defaultConfig": "",
	"description": "",
	"enabled": false,
	"icon": "",
	"id": "",
	"name": "",
	"roleIds": [],
	"tenantExpireTime": "",
	"tenantId": "",
	"tenantProfileId": "",
	"tenantStatus": "",
	"updateTime": "",
	"updater": ""
}

删除租户(待翻译)

接口地址:/api/yt/admin/tenant

请求方式: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)

租户分页

接口地址:/api/yt/admin/tenant/page{?orderFiled,orderType,page,pageSize,tenantName}

请求方式:GET

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

响应数据类型:*/*

请求参数:

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

响应参数:

参数名称 参数说明 类型
items array
  createTime 创建时间 string(date-time)
  creator 创建用户 string
  defaultConfig 租户默认配置 string
  description 租户描述 string
  enabled 租户状态：启用/禁用 boolean
  icon 租户图标 string
  id ID string
  name 租户名称 string
  roleIds 租户角色列表 array
  tenantExpireTime 租户到期时间 string(date-time)
  tenantId 租户ID string
  tenantProfileId 租户配置 string
  tenantStatus 可用值:DISABLED,EXPIRED,NORMAL string
  updateTime 更新时间 string(date-time)
  updater 更新用户 string
total integer(int32)

响应示例:

{
	"items": [
		{
			"createTime": "",
			"creator": "",
			"defaultConfig": "",
			"description": "",
			"enabled": false,
			"icon": "",
			"id": "",
			"name": "",
			"roleIds": [],
			"tenantExpireTime": "",
			"tenantId": "",
			"tenantProfileId": "",
			"tenantStatus": "",
			"updateTime": "",
			"updater": ""
		}
	],
	"total": 0
}

新增租户管理员

接口地址:/api/yt/admin/tenant/adminUser{?sendEmail,sendMsg}

请求方式:POST

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

响应数据类型:*/*

请求示例:

{
  "accountExpireTime": "",
  "avatar": "",
  "customerId": "",
  "email": "",
  "hasPassword": false,
  "id": "",
  "organizationIds": [],
  "password": "",
  "phoneNumber": "",
  "realName": "",
  "roleIds": [],
  "roles": [
    {
      "roleId": "",
      "roleName": ""
    }
  ],
  "username": ""
}

请求参数:

参数名称 参数说明 请求类型 是否必须 数据类型
userDTO UserDTO body true UserDTO
  accountExpireTime 账号失效时间 false string(date-time)
  activateToken 激活token false string
  avatar 头像 false string
  createTime 创建时间 false string(date-time)
  creator 创建用户 false string
  customerId 客户ID false string
  email 邮箱 false string
  enabled 账号状态 false boolean
  hasPassword 是否已重置密码 false boolean
  id ID false string
  level 角色级别：0：超级管理员；1：平台管理员 2：租户账号 3：租户下的账号 false integer(int32)
  organizationIds 所辖组织ids false array
  password 密码 false string
  phoneNumber 电话号码 false string
  realName 真实名称 false string
  remark 备注 false string
  roleIds 角色ids false array
  roles 角色信息列表 false array
    roleId 角色ID false string
    roleName 角色名称 false string
  tbUser TB的UserId false string
  tenantId 租户ID false string
  tenantName 租户名称 false string
  updateTime 更新时间 false string(date-time)
  updater 更新用户 false string
  userStatusEnum 用户状态,可用值:DISABLED,EXPIRED,NORMAL false string
  username 用户名 false string
sendEmail sendEmail query false boolean
sendMsg sendMsg query false boolean

响应参数:

参数名称 参数说明 类型
accountExpireTime 账号失效时间 string(date-time)
activateToken 激活token string
avatar 头像 string
createTime 创建时间 string(date-time)
creator 创建用户 string
customerId 客户ID string
email 邮箱 string
enabled 账号状态 boolean
hasPassword 是否已重置密码 boolean
id ID string
level 角色级别：0：超级管理员；1：平台管理员 2：租户账号 3：租户下的账号 integer(int32)
organizationIds 所辖组织ids array
password 密码 string
phoneNumber 电话号码 string
realName 真实名称 string
remark 备注 string
roleIds 角色ids array
roles 角色信息列表 array
  roleId 角色ID string
  roleName 角色名称 string
tbUser TB的UserId string
tenantId 租户ID string
tenantName 租户名称 string
updateTime 更新时间 string(date-time)
updater 更新用户 string
userStatusEnum 用户状态,可用值:DISABLED,EXPIRED,NORMAL string
username 用户名 string

响应示例:

{
	"accountExpireTime": "",
	"activateToken": "",
	"avatar": "",
	"createTime": "",
	"creator": "",
	"customerId": "",
	"email": "",
	"enabled": false,
	"hasPassword": false,
	"id": "",
	"level": 0,
	"organizationIds": [],
	"password": "",
	"phoneNumber": "",
	"realName": "",
	"remark": "",
	"roleIds": [],
	"roles": [
		{
			"roleId": "",
			"roleName": ""
		}
	],
	"tbUser": "",
	"tenantId": "",
	"tenantName": "",
	"updateTime": "",
	"updater": "",
	"userStatusEnum": "",
	"username": ""
}

修改租户管理员

接口地址:/api/yt/user/save_tenant_admin

请求方式:POST

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

响应数据类型:*/*

请求示例:

{
  "accountExpireTime": "",
  "activateToken": "",
  "email": "",
  "enabled": false,
  "hasPassword": false,
  "id": "",
  "level": 0,
  "organizationIds": [],
  "password": "",
  "phoneNumber": "",
  "realName": "",
  "remark": "",
  "roleIds": [],
  "roles": [
    {
      "roleId": "",
      "roleName": ""
    }
  ],
  "username": ""
}

请求参数:

参数名称 参数说明 请求类型 是否必须 数据类型
userDTO UserDTO body true UserDTO
  accountExpireTime 账号失效时间 false string(date-time)
  activateToken 激活token false string
  avatar 头像 false string
  createTime 创建时间 false string(date-time)
  creator 创建用户 false string
  customerId 客户ID false string
  email 邮箱 false string
  enabled 账号状态 false boolean
  hasPassword 是否已重置密码 false boolean
  id ID false string
  level 角色级别：0：超级管理员；1：平台管理员 2：租户账号 3：租户下的账号 false integer(int32)
  organizationIds 所辖组织ids false array
  password 密码 false string
  phoneNumber 电话号码 false string
  realName 真实名称 false string
  remark 备注 false string
  roleIds 角色ids false array
  roles 角色信息列表 false array
    roleId 角色ID false string
    roleName 角色名称 false string
  tbUser TB的UserId false string
  tenantId 租户ID false string
  tenantName 租户名称 false string
  updateTime 更新时间 false string(date-time)
  updater 更新用户 false string
  userStatusEnum 用户状态,可用值:DISABLED,EXPIRED,NORMAL false string
  username 用户名 false string

响应参数:

参数名称 参数说明 类型
accountExpireTime 账号失效时间 string(date-time)
activateToken 激活token string
avatar 头像 string
createTime 创建时间 string(date-time)
creator 创建用户 string
customerId 客户ID string
email 邮箱 string
enabled 账号状态 boolean
hasPassword 是否已重置密码 boolean
id ID string
level 角色级别：0：超级管理员；1：平台管理员 2：租户账号 3：租户下的账号 integer(int32)
organizationIds 所辖组织ids array
password 密码 string
phoneNumber 电话号码 string
realName 真实名称 string
remark 备注 string
roleIds 角色ids array
roles 角色信息列表 array
  roleId 角色ID string
  roleName 角色名称 string
tbUser TB的UserId string
tenantId 租户ID string
tenantName 租户名称 string
updateTime 更新时间 string(date-time)
updater 更新用户 string
userStatusEnum 用户状态,可用值:DISABLED,EXPIRED,NORMAL string
username 用户名 string

响应示例:

{
	"accountExpireTime": "",
	"activateToken": "",
	"avatar": "",
	"createTime": "",
	"creator": "",
	"customerId": "",
	"email": "",
	"enabled": false,
	"hasPassword": false,
	"id": "",
	"level": 0,
	"organizationIds": [],
	"password": "",
	"phoneNumber": "",
	"realName": "",
	"remark": "",
	"roleIds": [],
	"roles": [
		{
			"roleId": "",
			"roleName": ""
		}
	],
	"tbUser": "",
	"tenantId": "",
	"tenantName": "",
	"updateTime": "",
	"updater": "",
	"userStatusEnum": "",
	"username": ""
}

删除租户管理员(待翻译)

接口地址:/api/yt/admin/user/deleteTenantAdmin

请求方式: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)

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
评论
仓库举报
回到顶部