用户中心

ResourceRestApi

com.magus.cloud.system.api.ResourceRestApi

listResourceName

接口说明

资源类型列表

请求地址

GET /magus-system/system/resource/name/list

请求参数

参数名	父级	类型	是否必须	示例值	描述

响应状态

状态码	说明	schema
200	OK
500	服务响应异常	CommonRsp

响应参数

参数名称	父级	类型	参数说明
result		BaseRspResult	BaseRspResult
bizCode	result	integer(int32)	业务代码，表示操作结果代码
resultCode	result	string	系统代码，表示操作结果,可用值:SUCCESS(0),FAIL_SYSTEM(1),FAIL_BUSINESS(2)
message	result	string	错误信息
validResults	result	array	表单校验错误对象
propertyPath	validResults	string	表单校验错误字段
message	validResults		表单校验错误消息
rspFlag		boolean
list		Array
id	list	String	id
code	list	String	编码
name	list	String	名称
type	list	String	类型
originRtLabel	list	String	引用表（如：project_info）
originRtName	list	String	引用表名称（如：项目表）
originNameColumn	list	String	引用资源名称字段（如：project_name）
originCodeColumn	list	String	引用资源编码字段（如：project_code）
originParentIdColumn	list	String	引用父级字段（如：parent_id）
remark	list	String	资源描述（如：项目资源描述...）
businessId	list	String	业务数据id
businessName	list	String	业务数据
businessCode	list	String	业务数据code
businessParentId	list	String	业务数据上级id

请求示例

响应示例

{
  "result": {
    "bizCode": 0,
    "resultCode": "",
    "message": "",
    "validResults": [
      {
        "propertyPath": "",
        "message": ""
      }
    ]
  },
  "rspFlag": true,
  "list": [
    {
      "id": "",
      "code": "",
      "name": "",
      "type": "",
      "originRtLabel": "",
      "originRtName": "",
      "originNameColumn": "",
      "originCodeColumn": "",
      "originParentIdColumn": "",
      "remark": "",
      "businessId": "",
      "businessName": "",
      "businessCode": "",
      "businessParentId": ""
    }
  ]
}

findByCode

接口说明

资源类型明细

请求地址

GET /magus-system/system/resource/system/resource/find/{code}

请求参数

参数名	父级	类型	是否必须	示例值	描述

响应状态

状态码	说明	schema
200	OK
500	服务响应异常	CommonRsp

响应参数

参数名称	父级	类型	参数说明
result		BaseRspResult	BaseRspResult
bizCode	result	integer(int32)	业务代码，表示操作结果代码
resultCode	result	string	系统代码，表示操作结果,可用值:SUCCESS(0),FAIL_SYSTEM(1),FAIL_BUSINESS(2)
message	result	string	错误信息
validResults	result	array	表单校验错误对象
propertyPath	validResults	string	表单校验错误字段
message	validResults		表单校验错误消息
rspFlag		boolean
data		Object
id	data	String	id
code	data	String	编码
name	data	String	名称
type	data	String	类型
originRtLabel	data	String	引用表（如：project_info）
originRtName	data	String	引用表名称（如：项目表）
originNameColumn	data	String	引用资源名称字段（如：project_name）
originCodeColumn	data	String	引用资源编码字段（如：project_code）
originParentIdColumn	data	String	引用父级字段（如：parent_id）
remark	data	String	资源描述（如：项目资源描述...）
businessId	data	String	业务数据id
businessName	data	String	业务数据
businessCode	data	String	业务数据code
businessParentId	data	String	业务数据上级id

请求示例

响应示例

{
  "result": {
    "bizCode": 0,
    "resultCode": "",
    "message": "",
    "validResults": [
      {
        "propertyPath": "",
        "message": ""
      }
    ]
  },
  "rspFlag": true,
  "data": {
    "id": "",
    "code": "",
    "name": "",
    "type": "",
    "originRtLabel": "",
    "originRtName": "",
    "originNameColumn": "",
    "originCodeColumn": "",
    "originParentIdColumn": "",
    "remark": "",
    "businessId": "",
    "businessName": "",
    "businessCode": "",
    "businessParentId": ""
  }
}

findByCodeIn

接口说明

批量资源类型明细

请求地址

GET /magus-system/system/resource/system/resource/find-by-code

请求参数

参数名	父级	类型	是否必须	示例值	描述

响应状态

状态码	说明	schema
200	OK
500	服务响应异常	CommonRsp

响应参数

参数名称	父级	类型	参数说明
result		BaseRspResult	BaseRspResult
bizCode	result	integer(int32)	业务代码，表示操作结果代码
resultCode	result	string	系统代码，表示操作结果,可用值:SUCCESS(0),FAIL_SYSTEM(1),FAIL_BUSINESS(2)
message	result	string	错误信息
validResults	result	array	表单校验错误对象
propertyPath	validResults	string	表单校验错误字段
message	validResults		表单校验错误消息
rspFlag		boolean
list		Array
id	list	String	id
code	list	String	编码
name	list	String	名称
type	list	String	类型
originRtLabel	list	String	引用表（如：project_info）
originRtName	list	String	引用表名称（如：项目表）
originNameColumn	list	String	引用资源名称字段（如：project_name）
originCodeColumn	list	String	引用资源编码字段（如：project_code）
originParentIdColumn	list	String	引用父级字段（如：parent_id）
remark	list	String	资源描述（如：项目资源描述...）
businessId	list	String	业务数据id
businessName	list	String	业务数据
businessCode	list	String	业务数据code
businessParentId	list	String	业务数据上级id

请求示例

响应示例

{
  "result": {
    "bizCode": 0,
    "resultCode": "",
    "message": "",
    "validResults": [
      {
        "propertyPath": "",
        "message": ""
      }
    ]
  },
  "rspFlag": true,
  "list": [
    {
      "id": "",
      "code": "",
      "name": "",
      "type": "",
      "originRtLabel": "",
      "originRtName": "",
      "originNameColumn": "",
      "originCodeColumn": "",
      "originParentIdColumn": "",
      "remark": "",
      "businessId": "",
      "businessName": "",
      "businessCode": "",
      "businessParentId": ""
    }
  ]
}

DictRestApi

com.magus.cloud.system.api.DictRestApi

findEntryById

接口说明

查询指定字典

请求地址

GET /magus-system/system/dicts/entry/find-by-id/{id}

请求参数

参数名	父级	类型	是否必须	示例值	描述
Id		String	0		字典id

响应状态

状态码	说明	schema
200	OK
500	服务响应异常	CommonRsp

响应参数

参数名称	父级	类型	参数说明
result		BaseRspResult	BaseRspResult
bizCode	result	integer(int32)	业务代码，表示操作结果代码
resultCode	result	string	系统代码，表示操作结果,可用值:SUCCESS(0),FAIL_SYSTEM(1),FAIL_BUSINESS(2)
message	result	string	错误信息
validResults	result	array	表单校验错误对象
propertyPath	validResults	string	表单校验错误字段
message	validResults		表单校验错误消息
rspFlag		boolean
data		Array
id	data	string	字典Id
code	data	string	字典编码
name	data	string	字典名
sort	data	integer(int64)	排序
dictTypeId	data	String	字典类型id
enabled	data	Boolean	是否可用

请求示例

响应示例

{
  "result": {
    "bizCode": 0,
    "resultCode": "",
    "message": "",
    "validResults": [
      {
        "propertyPath": "",
        "message": ""
      }
    ]
  },
  "rspFlag": true,
  "data": {
    "id": "",
    "code": "",
    "name": "",
    "sort": 0,
    "dictTypeId": "",
    "enabled": false
  }
}

findEntry

接口说明

获取type下所有的字典项

请求地址

GET /magus-system/system/dicts/find-by-code/{code}

请求参数

参数名	父级	类型	是否必须	示例值	描述
Id		String	1		组织id

响应状态

状态码	说明	schema
200	OK
500	服务响应异常	CommonRsp

响应参数

参数名称	父级	类型	参数说明
result		BaseRspResult	BaseRspResult
bizCode	result	integer(int32)	业务代码，表示操作结果代码
resultCode	result	string	系统代码，表示操作结果,可用值:SUCCESS(0),FAIL_SYSTEM(1),FAIL_BUSINESS(2)
message	result	string	错误信息
validResults	result	array	表单校验错误对象
propertyPath	validResults	string	表单校验错误字段
message	validResults		表单校验错误消息
rspFlag		boolean
data		Object
nodePid	data	string	上级
nodeId	data	string	节点id
entityId	data	string	实体类id
entityType	data	string
text	data	string	文本
icon	data	string
iconCls	data	string
checked	data	Boolean
expanded	data	Boolean
leaf	data	Boolean
extend	data	Object	扩展变量
children	data	Array	子级

请求示例

响应示例

{
  "result": {
    "bizCode": 0,
    "resultCode": "",
    "message": "",
    "validResults": [
      {
        "propertyPath": "",
        "message": ""
      }
    ]
  },
  "rspFlag": true,
  "data": {
    "nodePid": "",
    "nodeId": "",
    "entityId": "",
    "entityType": "",
    "text": "",
    "icon": "",
    "iconCls": "",
    "checked": false,
    "expanded": false,
    "leaf": false,
    "extend": {},
    "children": []
  }
}

findEntry

接口说明

查询指定字典

请求地址

GET /magus-system/system/dicts/find-by-type-and-entry

请求参数

参数名	父级	类型	是否必须	示例值	描述
typeCode		String	0		字典类型code
entryCode		String	0		字典项code

响应状态

状态码	说明	schema
200	OK
500	服务响应异常	CommonRsp

响应参数

参数名称	父级	类型	参数说明
result		BaseRspResult	BaseRspResult
bizCode	result	integer(int32)	业务代码，表示操作结果代码
resultCode	result	string	系统代码，表示操作结果,可用值:SUCCESS(0),FAIL_SYSTEM(1),FAIL_BUSINESS(2)
message	result	string	错误信息
validResults	result	array	表单校验错误对象
propertyPath	validResults	string	表单校验错误字段
message	validResults		表单校验错误消息
rspFlag		boolean
data		Array
id	data	string	字典Id
code	data	string	字典编码
name	data	string	字典名
sort	data	integer(int64)	排序
dictTypeId	data	String	字典类型id
enabled	data	Boolean	是否可用

请求示例

响应示例

{
  "result": {
    "bizCode": 0,
    "resultCode": "",
    "message": "",
    "validResults": [
      {
        "propertyPath": "",
        "message": ""
      }
    ]
  },
  "rspFlag": true,
  "data": {
    "id": "",
    "code": "",
    "name": "",
    "sort": 0,
    "dictTypeId": "",
    "enabled": false
  }
}

AppApplicationRestApi

com.magus.cloud.system.api.AppApplicationRestApi

findOne

接口说明

根据ID查询应用

请求地址

GET /magus-system/system/apps/find-by-id/{id}

请求参数

参数名	父级	类型	是否必须	示例值	描述
id		String	0		应用id

响应状态

状态码	说明	schema
200	OK
500	服务响应异常	CommonRsp

响应参数

参数名称	父级	类型	参数说明
result		BaseRspResult	BaseRspResult
bizCode	result	integer(int32)	业务代码，表示操作结果代码
resultCode	result	string	系统代码，表示操作结果,可用值:SUCCESS(0),FAIL_SYSTEM(1),FAIL_BUSINESS(2)
message	result	string	错误信息
validResults	result	array	表单校验错误对象
propertyPath	validResults	string	表单校验错误字段
message	validResults		表单校验错误消息
rspFlag		boolean
data		Array
id	data	string	Id
code	data	string	应用编码
name	data	string	应用名
enName	data	String	应用的英文名
sort	data	Integer	排序
type	data	Boolean	应用类型
protocolType	data	String	访问协议类型
ipAddr	data	String	应用IP
ipPort	data	String	应用端口
path	data	String	应用上下文
compCode	data	String	租户编码
generator	data	Boolean	是否为低代码开发应用
remark		String	备注
deleted	data	String	是否删除
sysGroups	data	String	功能组
id	sysGroups	String	功能组id
name	sysGroups	String	功能组名
enName	sysGroups	String	功能组英文名
code	sysGroups	String	功能组编码
showName	sysGroups	String	菜单名称
page	sysGroups	String	页面路径
parentId	sysGroups	String	父级功能分组
appId	sysGroups	String	所属应用模块
sort	sysGroups	Integer	排列顺序
deleted	sysGroups	String	是否删除
procDefKey	sysGroups	String	所属流程key
sysGroups	sysGroups	String	功能组

请求示例

响应示例

{
  "result": {
    "bizCode": 0,
    "resultCode": "",
    "message": "",
    "validResults": [
      {
        "propertyPath": "",
        "message": ""
      }
    ]
  },
  "rspFlag": true,
  "data": {
    "id": "",
    "name": "",
    "enName": "",
    "code": "",
    "sort": 0,
    "type": "",
    "protocolType": "",
    "ipAddr": "",
    "ipPort": "",
    "path": "",
    "compCode": "",
    "generator": false,
    "remark": "",
    "deleted": false,
    "sysGroups": [
      {
        "id": "",
        "name": "",
        "enName": "",
        "code": "",
        "showName": "",
        "page": "",
        "parentId": "",
        "appId": "",
        "sort": 0,
        "deleted": false,
        "procDefKey": "",
        "sysGroups": []
      }
    ]
  }
}

findByCode

接口说明

根据编码查询应用

请求地址

GET /magus-system/system/apps/find-by-code/{code}

请求参数

参数名	父级	类型	是否必须	示例值	描述
code		String	0		应用编码

响应状态

状态码	说明	schema
200	OK
500	服务响应异常	CommonRsp

响应参数

参数名称	父级	类型	参数说明
result		BaseRspResult	BaseRspResult
bizCode	result	integer(int32)	业务代码，表示操作结果代码
resultCode	result	string	系统代码，表示操作结果,可用值:SUCCESS(0),FAIL_SYSTEM(1),FAIL_BUSINESS(2)
message	result	string	错误信息
validResults	result	array	表单校验错误对象
propertyPath	validResults	string	表单校验错误字段
message	validResults		表单校验错误消息
rspFlag		boolean
data		Array
id	data	string	Id
code	data	string	应用编码
name	data	string	应用名
enName	data	String	应用的英文名
sort	data	Integer	排序
type	data	Boolean	应用类型
protocolType	data	String	访问协议类型
ipAddr	data	String	应用IP
ipPort	data	String	应用端口
path	data	String	应用上下文
compCode	data	String	租户编码
generator	data	Boolean	是否为低代码开发应用
remark		String	备注
deleted	data	String	是否删除
sysGroups	data	String	功能组
id	sysGroups	String	功能组id
name	sysGroups	String	功能组名
enName	sysGroups	String	功能组英文名
code	sysGroups	String	功能组编码
showName	sysGroups	String	菜单名称
page	sysGroups	String	页面路径
parentId	sysGroups	String	父级功能分组
appId	sysGroups	String	所属应用模块
sort	sysGroups	Integer	排列顺序
deleted	sysGroups	String	是否删除
procDefKey	sysGroups	String	所属流程key
sysGroups	sysGroups	String	功能组

请求示例

响应示例

{
  "result": {
    "bizCode": 0,
    "resultCode": "",
    "message": "",
    "validResults": [
      {
        "propertyPath": "",
        "message": ""
      }
    ]
  },
  "rspFlag": true,
  "data": {
    "id": "",
    "name": "",
    "enName": "",
    "code": "",
    "sort": 0,
    "type": "",
    "protocolType": "",
    "ipAddr": "",
    "ipPort": "",
    "path": "",
    "compCode": "",
    "generator": false,
    "remark": "",
    "deleted": false,
    "sysGroups": [
      {
        "id": "",
        "name": "",
        "enName": "",
        "code": "",
        "showName": "",
        "page": "",
        "parentId": "",
        "appId": "",
        "sort": 0,
        "deleted": false,
        "procDefKey": "",
        "sysGroups": []
      }
    ]
  }
}

listAll

接口说明

查询所有应用

请求地址

POST /magus-system/system/apps/list-all

请求参数

参数名	父级	类型	是否必须	示例值	描述

响应状态

状态码	说明	schema
200	OK
500	服务响应异常	CommonRsp

响应参数

参数名称	父级	类型	参数说明
result		BaseRspResult	BaseRspResult
bizCode	result	integer(int32)	业务代码，表示操作结果代码
resultCode	result	string	系统代码，表示操作结果,可用值:SUCCESS(0),FAIL_SYSTEM(1),FAIL_BUSINESS(2)
message	result	string	错误信息
validResults	result	array	表单校验错误对象
propertyPath	validResults	string	表单校验错误字段
message	validResults		表单校验错误消息
rspFlag		boolean
List		Array
id	list	string	Id
code	list	string	应用编码
name	list	string	应用名
enName	list	String	应用的英文名
sort	list	Integer	排序
type	list	Boolean	应用类型
protocolType	list	String	访问协议类型
ipAddr	list	String	应用IP
ipPort	list	String	应用端口
path	list	String	应用上下文
compCode	list	String	租户编码
generator	list	Boolean	是否为低代码开发应用
remark	list	String	备注
deleted	list	String	是否删除
sysGroups	list	String	功能组
id	sysGroups	String	功能组id
name	sysGroups	String	功能组名
enName	sysGroups	String	功能组英文名
code	sysGroups	String	功能组编码
showName	sysGroups	String	菜单名称
page	sysGroups	String	页面路径
parentId	sysGroups	String	父级功能分组
appId	sysGroups	String	所属应用模块
sort	sysGroups	Integer	排列顺序
deleted	sysGroups	String	是否删除
procDefKey	sysGroups	String	所属流程key
sysGroups	sysGroups	String	功能组

请求示例

响应示例

{
  "result": {
    "bizCode": 0,
    "resultCode": "",
    "message": "",
    "validResults": [
      {
        "propertyPath": "",
        "message": ""
      }
    ]
  },
  "rspFlag": true,
  "list": [
    {
      "id": "",
      "name": "",
      "enName": "",
      "code": "",
      "sort": 0,
      "type": "",
      "protocolType": "",
      "ipAddr": "",
      "ipPort": "",
      "path": "",
      "compCode": "",
      "generator": false,
      "remark": "",
      "deleted": false,
      "sysGroups": [
        {
          "id": "",
          "name": "",
          "enName": "",
          "code": "",
          "showName": "",
          "page": "",
          "parentId": "",
          "appId": "",
          "sort": 0,
          "deleted": false,
          "procDefKey": "",
          "sysGroups": []
        }
      ]
    }
  ]
}

AppGroupRestApi

com.magus.cloud.system.api.AppGroupRestApi

findOne

接口说明

根据id查询功能组

请求地址

GET /magus-system/system/app-groups/find-by-id/{id}

请求参数

参数名	父级	类型	是否必须	示例值	描述
id		String	0		功能组id

响应状态

状态码	说明	schema
200	OK
500	服务响应异常	CommonRsp

响应参数

参数名称	父级	类型	参数说明
result		BaseRspResult	BaseRspResult
bizCode	result	integer(int32)	业务代码，表示操作结果代码
resultCode	result	string	系统代码，表示操作结果,可用值:SUCCESS(0),FAIL_SYSTEM(1),FAIL_BUSINESS(2)
message	result	string	错误信息
validResults	result	array	表单校验错误对象
propertyPath	validResults	string	表单校验错误字段
message	validResults		表单校验错误消息
rspFlag		boolean
data		Object
id	data	String	功能组id
name	data	String	功能组名
enName	data	String	功能组英文名
code	data	String	功能组编码
showName	data	String	菜单名称
page	data	String	页面路径
parentId	data	String	父级功能分组
appId	data	String	所属应用模块
sort	data	Integer	排列顺序
deleted	data	String	是否删除
procDefKey	data	String	所属流程key
sysGroups	data	String	功能组

请求示例

响应示例

{
  "result": {
    "bizCode": 0,
    "resultCode": "",
    "message": "",
    "validResults": [
      {
        "propertyPath": "",
        "message": ""
      }
    ]
  },
  "rspFlag": true,
  "data": {
      "id": "",
      "name": "",
      "enName": "",
      "code": "",
      "showName": "",
      "page": "",
      "parentId": "",
      "appId": "",
      "sort": 0,
      "deleted": false,
      "procDefKey": "",
      "sysGroups": []
  }
}

findByCode

接口说明

根据编码查询功能组

请求地址

GET /magus-system/system/app-groups/find-by-code

请求参数

参数名	父级	类型	是否必须	示例值	描述
code		String	0		应用编码

响应状态

状态码	说明	schema
200	OK
500	服务响应异常	CommonRsp

响应参数

参数名称	父级	类型	参数说明
result		BaseRspResult	BaseRspResult
bizCode	result	integer(int32)	业务代码，表示操作结果代码
resultCode	result	string	系统代码，表示操作结果,可用值:SUCCESS(0),FAIL_SYSTEM(1),FAIL_BUSINESS(2)
message	result	string	错误信息
validResults	result	array	表单校验错误对象
propertyPath	validResults	string	表单校验错误字段
message	validResults		表单校验错误消息
rspFlag		boolean
data		Object
id	data	String	功能组id
name	data	String	功能组名
enName	data	String	功能组英文名
code	data	String	功能组编码
showName	data	String	菜单名称
page	data	String	页面路径
parentId	data	String	父级功能分组
appId	data	String	所属应用模块
sort	data	Integer	排列顺序
deleted	data	String	是否删除
procDefKey	data	String	所属流程key
sysGroups	data	String	功能组

请求示例

响应示例

{
  "result": {
    "bizCode": 0,
    "resultCode": "",
    "message": "",
    "validResults": [
      {
        "propertyPath": "",
        "message": ""
      }
    ]
  },
  "rspFlag": true,
  "data": {
      "id": "",
      "name": "",
      "enName": "",
      "code": "",
      "showName": "",
      "page": "",
      "parentId": "",
      "appId": "",
      "sort": 0,
      "deleted": false,
      "procDefKey": "",
      "sysGroups": []
  }
}

AppFunctionRestApi

com.magus.cloud.system.api.AppFunctionRestApi

listAll

接口说明

查询所有的应用功能

请求地址

GET /magus-system/system/app-functions/list-all

请求参数

参数名	父级	类型	是否必须	示例值	描述

响应状态

状态码	说明	schema
200	OK
500	服务响应异常	CommonRsp

响应参数

参数名称	父级	类型	参数说明
result		BaseRspResult	BaseRspResult
bizCode	result	integer(int32)	业务代码，表示操作结果代码
resultCode	result	string	系统代码，表示操作结果,可用值:SUCCESS(0),FAIL_SYSTEM(1),FAIL_BUSINESS(2)
message	result	string	错误信息
validResults	result	array	表单校验错误对象
propertyPath	validResults	string	表单校验错误字段
message	validResults		表单校验错误消息
rspFlag		boolean
list		Object
id	list	String	功能id
name	list	String	功能名
action	list	String	功能入口
code	list	String	功能CODE
type	list	String	功能类型
params	list	String	参数
method	list	String	请求方式
groupId	list	String	所属功能组
isAuthz	list	Boolean	是否需要权限检查
deleted	list	Boolean	是否删除
isMenu	list	Boolean	是否为菜单

请求示例

响应示例

{
  "result": {
    "bizCode": 0,
    "resultCode": "",
    "message": "",
    "validResults": [
      {
        "propertyPath": "",
        "message": ""
      }
    ]
  },
  "rspFlag": true,
  "list": [
    {
      "id": "",
      "deleted": false,
      "name": "",
      "code": "",
      "type": "",
      "action": "",
      "method": "",
      "params": "",
      "isAuthz": false,
      "isMenu": false,
      "groupId": ""
    }
  ]
}

DataAuthRestApi

com.magus.cloud.system.api.DataAuthRestApi

listAll

接口说明

查询所有的应用功能

请求地址

GET /magus-system/system/data/auths/find/auth-data/{dataId}

请求参数

参数名	父级	类型	是否必须	示例值	描述
dataId		String	1		业务id

响应状态

状态码	说明	schema
200	OK
500	服务响应异常	CommonRsp

响应参数

参数名称	父级	类型	参数说明
result		BaseRspResult	BaseRspResult
bizCode	result	integer(int32)	业务代码，表示操作结果代码
resultCode	result	string	系统代码，表示操作结果,可用值:SUCCESS(0),FAIL_SYSTEM(1),FAIL_BUSINESS(2)
message	result	string	错误信息
validResults	result	array	表单校验错误对象
propertyPath	validResults	string	表单校验错误字段
message	validResults		表单校验错误消息
rspFlag		boolean
list		Object
id	list	String	id
dataTable	list	String	数据来源表
dataId	list	String	业务数据id
groupId	list	String	系统工作组id
resourceCode	list	String	资源类型code
resId	list	String	资源实体编号
resName	list	String	资源实体名称

请求示例

响应示例

{
  "result": {
    "bizCode": 0,
    "resultCode": "",
    "message": "",
    "validResults": [
      {
        "propertyPath": "",
        "message": ""
      }
    ]
  },
  "rspFlag": true,
  "list": [
    {
      "id": "",
      "dataTable": "",
      "dataId": "",
      "groupId": "",
      "resourceCode": "",
      "resId": "",
      "resName": ""
    }
  ]
}

existByDataTable

接口说明

判断表里是否存在需要查询的数据

请求地址

GET /magus-system/system/data/auths/exists-auth-data

请求参数

参数名	父级	类型	是否必须	示例值	描述
dataTable		String	1		数据来源表
groupId		String	1		功能组id

响应状态

状态码	说明	schema
200	OK
500	服务响应异常	CommonRsp

响应参数

参数名称	父级	类型	参数说明
result		BaseRspResult	BaseRspResult
bizCode	result	integer(int32)	业务代码，表示操作结果代码
resultCode	result	string	系统代码，表示操作结果,可用值:SUCCESS(0),FAIL_SYSTEM(1),FAIL_BUSINESS(2)
message	result	string	错误信息
validResults	result	array	表单校验错误对象
propertyPath	validResults	string	表单校验错误字段
message	validResults		表单校验错误消息
rspFlag		boolean
Data		Object
exists	Data	Boolean	是否存在

请求示例

响应示例

{
  "result": {
    "bizCode": 0,
    "resultCode": "",
    "message": "",
    "validResults": [
      {
        "propertyPath": "",
        "message": ""
      }
    ]
  },
  "rspFlag": true,
  "data": {
    "exists": true
  }
}

saveAll

接口说明

保存数据权限

请求地址

POST /magus-system/system/data/auths/save-all

请求参数

参数名	父级	类型	是否必须	描述
req		Array	1	数据来源表
id	req	String	0	id
dataTable	req	String	0	数据来源表
dataId	req	String	0	业务数据id
groupId	req	String	0	系统工作组id
resourceCode	req	String	0	资源类型code
resId	req	String	0	资源实体编号
resName	req	String	0	资源实体名称

响应状态

状态码	说明	schema
200	OK
500	服务响应异常	CommonRsp

响应参数

参数名称	父级	类型	参数说明
result		BaseRspResult	BaseRspResult
bizCode	result	integer(int32)	业务代码，表示操作结果代码
resultCode	result	string	系统代码，表示操作结果,可用值:SUCCESS(0),FAIL_SYSTEM(1),FAIL_BUSINESS(2)
message	result	string	错误信息
validResults	result	array	表单校验错误对象
propertyPath	validResults	string	表单校验错误字段
message	validResults		表单校验错误消息
rspFlag		boolean

请求示例

[{
  "dataTable": "",
  "dataId": "",
  "groupId": "",
  "resourceCode": "",
  "resId": "",
  "resName": ""
}]

响应示例

{
  "result": {
    "bizCode": 0,
    "resultCode": "",
    "message": "",
    "validResults": [
      {
        "propertyPath": "",
        "message": ""
      }
    ]
  },
  "rspFlag": true
}

deleteInId

接口说明

删除数据权限

请求地址

POST /magus-system/system/data/auths/delete/{groupId}

请求参数

参数名	父级	类型	是否必须	示例值	描述
groupId	req	String	1		系统工作组id
ids	req	Array	0		数据id

响应状态

状态码	说明	schema
200	OK
500	服务响应异常	CommonRsp

响应参数

参数名称	父级	类型	参数说明
result		BaseRspResult	BaseRspResult
bizCode	result	integer(int32)	业务代码，表示操作结果代码
resultCode	result	string	系统代码，表示操作结果,可用值:SUCCESS(0),FAIL_SYSTEM(1),FAIL_BUSINESS(2)
message	result	string	错误信息
validResults	result	array	表单校验错误对象
propertyPath	validResults	string	表单校验错误字段
message	validResults		表单校验错误消息
rspFlag		boolean

请求示例

响应示例

{
  "result": {
    "bizCode": 0,
    "resultCode": "",
    "message": "",
    "validResults": [
      {
        "propertyPath": "",
        "message": ""
      }
    ]
  },
  "rspFlag": true
}

delete

接口说明

删除数据权限

请求地址

POST /magus-system/system/data/auths/delete

请求参数

参数名	父级	类型	是否必须	示例值	描述
dataTable	req	String	1		数据来源表
ids	req	Array	0		数据id

响应状态

状态码	说明	schema
200	OK
500	服务响应异常	CommonRsp

响应参数

参数名称	父级	类型	参数说明
result		BaseRspResult	BaseRspResult
bizCode	result	integer(int32)	业务代码，表示操作结果代码
resultCode	result	string	系统代码，表示操作结果,可用值:SUCCESS(0),FAIL_SYSTEM(1),FAIL_BUSINESS(2)
message	result	string	错误信息
validResults	result	array	表单校验错误对象
propertyPath	validResults	string	表单校验错误字段
message	validResults		表单校验错误消息
rspFlag		boolean

请求示例

响应示例

{
  "result": {
    "bizCode": 0,
    "resultCode": "",
    "message": "",
    "validResults": [
      {
        "propertyPath": "",
        "message": ""
      }
    ]
  },
  "rspFlag": true
}

DutyRestApi

com.magus.cloud.system.api.DutyRestApi

findRspById

接口说明

职务详情

请求地址

GET /magus-system/system/duty/find-rsp-by-id

请求参数

参数名	父级	类型	是否必须	示例值	描述
id	req	String	1		id

响应状态

状态码	说明	schema
200	OK
500	服务响应异常	CommonRsp

响应参数

参数名称	父级	类型	参数说明
result		BaseRspResult	BaseRspResult
bizCode	result	integer(int32)	业务代码，表示操作结果代码
resultCode	result	string	系统代码，表示操作结果,可用值:SUCCESS(0),FAIL_SYSTEM(1),FAIL_BUSINESS(2)
message	result	string	错误信息
validResults	result	array	表单校验错误对象
propertyPath	validResults	string	表单校验错误字段
message	validResults		表单校验错误消息
rspFlag		boolean
data		Object
id	data	String
compId	data	String	租户id
name	data	String	职务名
code	data	String	职务编码
sort	data	Integer	排序
remark	Data	String	备注

请求示例

响应示例

{
  "result": {
    "bizCode": 0,
    "resultCode": "",
    "message": "",
    "validResults": [
      {
        "propertyPath": "",
        "message": ""
      }
    ]
  },
  "rspFlag": true,
  "data": {
    "id": "",
    "compId": "",
    "name": "",
    "code": "",
    "sort": "",
    "remark": ""
  }
}

listByIds

接口说明

批量查询职务详情

请求地址

GET /magus-system/system/duty/list-by-id

请求参数

参数名	父级	类型	是否必须	示例值	描述
ids		Array	1		Id

响应状态

状态码	说明	schema
200	OK
500	服务响应异常	CommonRsp

响应参数

参数名称	父级	类型	参数说明
result		BaseRspResult	BaseRspResult
bizCode	result	integer(int32)	业务代码，表示操作结果代码
resultCode	result	string	系统代码，表示操作结果,可用值:SUCCESS(0),FAIL_SYSTEM(1),FAIL_BUSINESS(2)
message	result	string	错误信息
validResults	result	array	表单校验错误对象
propertyPath	validResults	string	表单校验错误字段
message	validResults		表单校验错误消息
rspFlag		boolean
list		Object
id	list	String
compId	list	String	租户id
name	list	String	职务名
code	list	String	职务编码
sort	list	Integer	排序
remark	list	String	备注

请求示例

响应示例

{
  "result": {
    "bizCode": 0,
    "resultCode": "",
    "message": "",
    "validResults": [
      {
        "propertyPath": "",
        "message": ""
      }
    ]
  },
  "rspFlag": true,
  "list": [
    {
      "id": "",
      "compId": "",
      "name": "",
      "code": "",
      "sort": "",
      "remark": ""
    }
  ]
}

OrgDutyUserRestApi

com.magus.cloud.system.api.OrgDutyUserRestApi

listOrgDutyUser

接口说明

查询组织职务用户关系

请求地址

POST /magus-system/system/duty/list-by-id

请求参数

参数名	父级	类型	是否必须	描述
req		Object	1	com.magus.cloud.system.dto.req.OrgDutyUserListReq
orgIds	req	Array	0	组织
dutyIds	req	Array	0	职务
userIds	req	Array	0	用户

响应状态

状态码	说明	schema
200	OK
500	服务响应异常	CommonRsp

响应参数

参数名称	父级	类型	参数说明
result		BaseRspResult	BaseRspResult
bizCode	result	integer(int32)	业务代码，表示操作结果代码
resultCode	result	string	系统代码，表示操作结果,可用值:SUCCESS(0),FAIL_SYSTEM(1),FAIL_BUSINESS(2)
message	result	string	错误信息
validResults	result	array	表单校验错误对象
propertyPath	validResults	string	表单校验错误字段
message	validResults		表单校验错误消息
rspFlag		boolean
list		Object
orgId	list	String	组织id
orgName	list	String	组织名
dutyId	list	String	职务id
dutyName	list	String	职务名
userId	list	String	用户id
majorOrg	list	Boolean	是否是主部门

请求示例

{
  "orgIds": [
    ""
  ],
  "dutyIds": [
    ""
  ],
  "userIds": [
    ""
  ]
}

响应示例

{
  "result": {
    "bizCode": 0,
    "resultCode": "",
    "message": "",
    "validResults": [
      {
        "propertyPath": "",
        "message": ""
      }
    ]
  },
  "rspFlag": true,
  "list": [
    {
      "orgId": "",
      "orgName": "",
      "dutyId": "",
      "dutyName": "",
      "userId": "",
      "majorOrg": false
    }
  ]
}

PositionRestApi

com.magus.cloud.system.api.PositionRestApi

listByIds

接口说明

查询岗位

请求地址

GET /magus-system/system/positions/list-by-id

请求参数

参数名	父级	类型	是否必须	示例值	描述
ids		Array	1		岗位id

响应状态

状态码	说明	schema
200	OK
500	服务响应异常	CommonRsp

响应参数

参数名称	父级	类型	参数说明
result		BaseRspResult	BaseRspResult
bizCode	result	integer(int32)	业务代码，表示操作结果代码
resultCode	result	string	系统代码，表示操作结果,可用值:SUCCESS(0),FAIL_SYSTEM(1),FAIL_BUSINESS(2)
message	result	string	错误信息
validResults	result	array	表单校验错误对象
propertyPath	validResults	string	表单校验错误字段
message	validResults		表单校验错误消息
rspFlag		boolean
list		Array
compId	list	String	租户id
name	list	String	岗位名
code	list	String	岗位编码
remark	list	String	备注

请求示例

{
  "orgIds": [
    ""
  ],
  "dutyIds": [
    ""
  ],
  "userIds": [
    ""
  ]
}

响应示例

{
  "result": {
    "bizCode": 0,
    "resultCode": "",
    "message": "",
    "validResults": [
      {
        "propertyPath": "",
        "message": ""
      }
    ]
  },
  "rspFlag": true,
  "list": [
    {
      "compId": "",
      "name": "",
      "code": "",
      "remark": ""
    }
  ]
}

SysOrganizationRestApi

com.magus.cloud.system.api.SysOrganizationRestApi

listByIds

接口说明

查询岗位

请求地址

POST /magus-system/system/orgs/list-org-by-org-id

请求参数

参数名	父级	类型	是否必须	示例值	描述
orgIds		Array	1		组织id

响应状态

状态码	说明	schema
200	OK
500	服务响应异常	CommonRsp

响应参数

参数名称	父级	类型	参数说明
result		BaseRspResult	BaseRspResult
bizCode	result	integer(int32)	业务代码，表示操作结果代码
resultCode	result	string	系统代码，表示操作结果,可用值:SUCCESS(0),FAIL_SYSTEM(1),FAIL_BUSINESS(2)
message	result	string	错误信息
validResults	result	array	表单校验错误对象
propertyPath	validResults	string	表单校验错误字段
message	validResults		表单校验错误消息
rspFlag		boolean
list		Array
id	list	String	id
type	list	String	组织类型
compId	list	String	租户id
name	list	String	岗位名
code	list	String	岗位编码
sort	list	Integer	排序
parentId	list	String	上级id
remark	list	String	备注

请求示例

响应示例

{
  "result": {
    "bizCode": 0,
    "resultCode": "",
    "message": "",
    "validResults": [
      {
        "propertyPath": "",
        "message": ""
      }
    ]
  },
  "rspFlag": true,
  "list": [
    {
      "id": "",
      "code": "",
      "name": "",
      "remark": "",
      "type": "",
      "sort": 0,
      "compId": "",
      "parentId": ""
    }
  ]
}

SysUserRestApi

com.magus.cloud.system.api.SysUserRestApi

findById

接口说明

根据id查询用户

请求地址

GET /magus-system/system/users/find-by-id/{id}

请求参数

参数名	父级	类型	是否必须	示例值	描述
id		String	1		用户id

响应状态

状态码	说明	schema
200	OK
500	服务响应异常	CommonRsp

响应参数

参数名称	父级	类型	参数说明
result		BaseRspResult	BaseRspResult
bizCode	result	integer(int32)	业务代码，表示操作结果代码
resultCode	result	string	系统代码，表示操作结果,可用值:SUCCESS(0),FAIL_SYSTEM(1),FAIL_BUSINESS(2)
message	result	string	错误信息
validResults	result	array	表单校验错误对象
propertyPath	validResults	string	表单校验错误字段
message	validResults		表单校验错误消息
rspFlag		boolean
Data		Object
id	data	string	用户Id
userName	data	string	用户名
loginId	data	string	登录ID
passwordLastModified	data		密码修改时间
endDate	data	integer(int64)	密码失效日期
salt	data	string	加密密码的盐
authMode	data	string	认证模式:local 本地认证, AD windows域认证
state	data	string	用户状态 normal:正常; locked:锁定
stateDesc	data		用户状态 normal:正常; locked:锁定
profile	data	string	用户头像
phone	data	string	手机号
email	data	string	邮箱
remark	data	string	备注
compName	data	string	租户名
compCode	data	array	租户code
compShowName	data		租户展示名
compLogo	data		租户logo
positionId	data	string	职位ID
formalFlag	data	boolean	是否实体用户 0=临时用户;1=正式用户
orgId	data	string	组织Id
orgCode	data		组织机构编码
orgName	data		组织机构名
dutyId	data	string	职务Id
wechat	data	String	wechat
dingtalk	data	String	钉钉
formalFlag	data	Boolean	是否实体用户 0=临时用户;1=正式用户
createDate	data	Date	创建时间
modifyPassword	data	Boolean	是否需要修改密码
systemAdmin	data	Boolean	是否超级用户
admin	data	Boolean	是否管理员

请求示例

响应示例

{
  "result": {
    "bizCode": 0,
    "resultCode": "",
    "message": "",
    "validResults": [
      {
        "propertyPath": "",
        "message": ""
      }
    ]
  },
  "rspFlag": true,
  "data": {
    "id": "",
    "userName": "",
    "loginId": "",
    "passwordLastModified": "2023-11-22 09:08:03",
    "endDate": 0,
    "authMode": "",
    "state": "",
    "stateDesc": "",
    "profile": "",
    "phone": "",
    "email": "",
    "remark": "",
    "compId": "",
    "compCode": "",
    "compName": "",
    "compShowName": "",
    "compLogo": "",
    "orgId": "",
    "orgCode": "",
    "orgName": "",
    "wechat": "",
    "dingtalk": "",
    "positionId": "",
    "dutyId": "",
    "formalFlag": false,
    "createDate": "2023-11-22 09:08:03",
    "modifyPassword": false,
    "systemAdmin": false,
    "admin": false
  }
}

findByLoginId

接口说明

根据Loginid查询用户

请求地址

GET /magus-system/system/users/find-by-login-id/{loginId}

请求参数

参数名	父级	类型	是否必须	示例值	描述
loginId		String	1		用户Loginid

响应状态

状态码	说明	schema
200	OK
500	服务响应异常	CommonRsp

响应参数

参数名称	父级	类型	参数说明
result		BaseRspResult	BaseRspResult
bizCode	result	integer(int32)	业务代码，表示操作结果代码
resultCode	result	string	系统代码，表示操作结果,可用值:SUCCESS(0),FAIL_SYSTEM(1),FAIL_BUSINESS(2)
message	result	string	错误信息
validResults	result	array	表单校验错误对象
propertyPath	validResults	string	表单校验错误字段
message	validResults		表单校验错误消息
rspFlag		boolean
Data		Object
id	data	string	用户Id
userName	data	string	用户名
loginId	data	string	登录ID
passwordLastModified	data		密码修改时间
endDate	data	integer(int64)	密码失效日期
salt	data	string	加密密码的盐
authMode	data	string	认证模式:local 本地认证, AD windows域认证
state	data	string	用户状态 normal:正常; locked:锁定
stateDesc	data		用户状态 normal:正常; locked:锁定
profile	data	string	用户头像
phone	data	string	手机号
email	data	string	邮箱
remark	data	string	备注
compName	data	string	租户名
compCode	data	array	租户code
compShowName	data		租户展示名
compLogo	data		租户logo
positionId	data	string	职位ID
formalFlag	data	boolean	是否实体用户 0=临时用户;1=正式用户
orgId	data	string	组织Id
orgCode	data		组织机构编码
orgName	data		组织机构名
dutyId	data	string	职务Id
wechat	data	String	wechat
dingtalk	data	String	钉钉
formalFlag	data	Boolean	是否实体用户 0=临时用户;1=正式用户
createDate	data	Date	创建时间
modifyPassword	data	Boolean	是否需要修改密码
systemAdmin	data	Boolean	是否超级用户
admin	data	Boolean	是否管理员

请求示例

响应示例

{
  "result": {
    "bizCode": 0,
    "resultCode": "",
    "message": "",
    "validResults": [
      {
        "propertyPath": "",
        "message": ""
      }
    ]
  },
  "rspFlag": true,
  "data": {
    "id": "",
    "userName": "",
    "loginId": "",
    "passwordLastModified": "2023-11-22 09:08:03",
    "endDate": 0,
    "authMode": "",
    "state": "",
    "stateDesc": "",
    "profile": "",
    "phone": "",
    "email": "",
    "remark": "",
    "compId": "",
    "compCode": "",
    "compName": "",
    "compShowName": "",
    "compLogo": "",
    "orgId": "",
    "orgCode": "",
    "orgName": "",
    "wechat": "",
    "dingtalk": "",
    "positionId": "",
    "dutyId": "",
    "formalFlag": false,
    "createDate": "2023-11-22 09:08:03",
    "modifyPassword": false,
    "systemAdmin": false,
    "admin": false
  }
}

listByIds

接口说明

查询岗位

请求地址

POST /magus-system/system/users/list-user

请求参数

参数名	父级	类型	是否必须	示例值	描述
Ids		Array	1		用户id

响应状态

状态码	说明	schema
200	OK
500	服务响应异常	CommonRsp

响应参数

参数名称	父级	类型	参数说明
result		BaseRspResult	BaseRspResult
bizCode	result	integer(int32)	业务代码，表示操作结果代码
resultCode	result	string	系统代码，表示操作结果,可用值:SUCCESS(0),FAIL_SYSTEM(1),FAIL_BUSINESS(2)
message	result	string	错误信息
validResults	result	array	表单校验错误对象
propertyPath	validResults	string	表单校验错误字段
message	validResults		表单校验错误消息
rspFlag		boolean
list		Array
id	list	string	用户Id
userName	list	string	用户名
loginId	list	string	登录ID
passwordLastModified	list		密码修改时间
endDate	list	integer(int64)	密码失效日期
salt	list	string	加密密码的盐
authMode	list	string	认证模式:local 本地认证, AD windows域认证
state	list	string	用户状态 normal:正常; locked:锁定
stateDesc	list	String	用户状态 normal:正常; locked:锁定
profile	list	string	用户头像
phone	list	string	手机号
email	list	string	邮箱
remark	list	string	备注
compName	list	string	租户名
compCode	list	array	租户code
compShowName	list	String	租户展示名
compLogo	list	String	租户logo
positionId	list	string	职位ID
formalFlag	list	boolean	是否实体用户 0=临时用户;1=正式用户
orgId	list	string	组织Id
orgCode	list	String	组织机构编码
orgName	list	String	组织机构名
dutyId	list	string	职务Id
wechat	list	String	wechat
dingtalk	list	String	钉钉
formalFlag	list	Boolean	是否实体用户 0=临时用户;1=正式用户
createDate	list	Date	创建时间
modifyPassword	list	Boolean	是否需要修改密码
systemAdmin	list	Boolean	是否超级用户
admin	list	Boolean	是否管理员

请求示例

响应示例

{
  "result": {
    "bizCode": 0,
    "resultCode": "",
    "message": "",
    "validResults": [
      {
        "propertyPath": "",
        "message": ""
      }
    ]
  },
  "rspFlag": true,
  "list": [
    {
      "id": "",
      "userName": "",
      "loginId": "",
      "passwordLastModified": "2023-11-22 09:08:03",
      "endDate": 0,
      "authMode": "",
      "state": "",
      "stateDesc": "",
      "profile": "",
      "phone": "",
      "email": "",
      "remark": "",
      "compId": "",
      "compCode": "",
      "compName": "",
      "compShowName": "",
      "compLogo": "",
      "orgId": "",
      "orgCode": "",
      "orgName": "",
      "wechat": "",
      "dingtalk": "",
      "positionId": "",
      "dutyId": "",
      "formalFlag": false,
      "createDate": "2023-11-22 09:08:03",
      "modifyPassword": false,
      "systemAdmin": false,
      "admin": false
    }
  ]
}

配置

数据

网络

维护

用户中心 ​

ResourceRestApi ​

listResourceName ​

findByCode ​

findByCodeIn ​

DictRestApi ​

findEntryById ​

findEntry ​

findEntry ​

AppApplicationRestApi ​

findOne ​

findByCode ​

listAll ​

AppGroupRestApi ​

findOne ​

findByCode ​

AppFunctionRestApi ​

listAll ​

DataAuthRestApi ​

listAll ​

existByDataTable ​

saveAll ​

deleteInId ​

delete ​

DutyRestApi ​

findRspById ​

listByIds ​

OrgDutyUserRestApi ​

listOrgDutyUser ​

PositionRestApi ​

listByIds ​

SysOrganizationRestApi ​

listByIds ​

SysUserRestApi ​

findById ​

findByLoginId ​

listByIds ​

用户中心

ResourceRestApi

listResourceName

findByCode

findByCodeIn

DictRestApi

findEntryById

findEntry

findEntry

AppApplicationRestApi

findOne

findByCode

listAll

AppGroupRestApi

findOne

findByCode

AppFunctionRestApi

listAll

DataAuthRestApi

listAll

existByDataTable

saveAll

deleteInId

delete

DutyRestApi

findRspById

listByIds

OrgDutyUserRestApi

listOrgDutyUser

PositionRestApi

listByIds

SysOrganizationRestApi

listByIds

SysUserRestApi

findById

findByLoginId

listByIds