角色模块

一、角色查看

接口地址 https://www.yingxiongyun.com/tenant/api/v1/t/roles

请求方式 GET

consumes ["application/json"]

produces ["*/*"]

接口描述 ``

请求参数

参数名称	参数说明	请求类型	是否必须	数据类型	schema
roleIds	角色id集合	query	false	array	string
keyword	搜索词(PS:角色名称)	query	false	string
groupId	角色组主键id	query	false	string
rangeViewFlag	范围查看标识	query	false	boolean

响应状态

状态码	说明	schema
200	OK	响应结果对象«分页对象«角色响应数据»»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数

参数名称	参数说明	类型	schema
code	结果码	integer(int32)	integer(int32)
data	结果数据	分页对象«角色响应数据»	分页对象«角色响应数据»
message	结果描述	string
timestamp	时间戳	integer(int64)	integer(int64)

schema属性说明

分页对象«角色响应数据»

参数名称	参数说明	类型	schema
body	分页数据	array	角色响应数据
pageNum	当前页数	integer(int32)
pageSize	每页条数	integer(int32)
total	总条数	integer(int64)

角色响应数据

参数名称	参数说明	类型
departmentIds	部门id集合	array
departments	部门列表	array
description	角色描述	string
enableManageFlag	可管理	boolean
groupId	角色组主键id	string
id	主键ID	string
name	角色名称	string
status	角色状态 normal正常，deactivate停用	string

响应示例


xxxxxxxxxx
{
    "code": 0,
    "data": {
        "body": [
            {
                "departmentIds": [],
                "departments": [],
                "description": "",
                "enableManageFlag": false,
                "groupId": "",
                "id": "",
                "name": "",
                "status": ""
            }
        ],
        "pageNum": 0,
        "pageSize": 0,
        "total": 0
    },
    "message": "",
    "timestamp": 0
}

二、角色创建

接口地址 https://www.yingxiongyun.com/tenant/api/v1/t/roles

请求方式 POST

consumes ["application/json"]

produces ["*/*"]

接口描述 新增一条记录

请求参数

参数名称	参数说明	请求类型	是否必须	数据类型	schema
body	body	body	true	角色创建请求体	角色创建请求体

schema属性说明

角色创建请求体

参数名称	参数说明	请求类型	是否必须	数据类型
departmentIds	部门id集合	body	false	array
description	角色描述	body	false	string
groupId	角色组主键id	body	false	string
memberIds	成员id列表	body	false	array
name	角色名称	body	false	string

响应状态

状态码	说明	schema
200	OK	响应结果对象«角色响应数据»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数

参数名称	参数说明	类型	schema
code	结果码	integer(int32)	integer(int32)
data	结果数据	角色响应数据	角色响应数据
message	结果描述	string
timestamp	时间戳	integer(int64)	integer(int64)

schema属性说明

角色响应数据

参数名称	参数说明	类型
departmentIds	部门id集合	array
departments	部门列表	array
description	角色描述	string
enableManageFlag	可管理	boolean
groupId	角色组主键id	string
id	主键ID	string
name	角色名称	string
status	角色状态 normal正常，deactivate停用	string

响应示例


xxxxxxxxxx
{
    "code": 0,
    "data": {
        "departmentIds": [],
        "departments": [],
        "description": "",
        "enableManageFlag": false,
        "groupId": "",
        "id": "",
        "name": "",
        "status": ""
    },
    "message": "",
    "timestamp": 0
}

三、角色修改

接口地址 https://www.yingxiongyun.com/tenant/api/v1/t/roles/{roleId}

请求方式 PUT

consumes ["application/json"]

produces ["*/*"]

接口描述 修改一条记录

请求参数

参数名称	参数说明	请求类型	是否必须	数据类型	schema
roleId	roleId	path	true	string
body	body	body	true	角色修改请求体	角色修改请求体

schema属性说明

角色修改请求体

参数名称	参数说明	请求类型	是否必须	数据类型
departmentIds	部门id集合	body	false	array
description	角色描述	body	false	string
groupId	角色组主键id	body	false	string
memberIds	成员id列表	body	false	array
name	角色名称	body	false	string

响应状态

状态码	说明	schema
200	OK	响应结果对象«角色响应数据»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数

参数名称	参数说明	类型	schema
code	结果码	integer(int32)	integer(int32)
data	结果数据	角色响应数据	角色响应数据
message	结果描述	string
timestamp	时间戳	integer(int64)	integer(int64)

schema属性说明

角色响应数据

参数名称	参数说明	类型
departmentIds	部门id集合	array
departments	部门列表	array
description	角色描述	string
enableManageFlag	可管理	boolean
groupId	角色组主键id	string
id	主键ID	string
name	角色名称	string
status	角色状态 normal正常，deactivate停用	string

响应示例


xxxxxxxxxx
{
    "code": 0,
    "data": {
        "departmentIds": [],
        "departments": [],
        "description": "",
        "enableManageFlag": false,
        "groupId": "",
        "id": "",
        "name": "",
        "status": ""
    },
    "message": "",
    "timestamp": 0
}

四、删除角色

接口地址 https://www.yingxiongyun.com/tenant/api/v1/t/roles/{roleId}

请求方式 DELETE

consumes ["application/json"]

produces ["*/*"]

接口描述 删除一条记录

请求参数

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

响应状态

状态码	说明	schema
200	OK	响应结果对象«boolean»
204	No Content
401	Unauthorized
403	Forbidden

响应参数

参数名称	参数说明	类型	schema
code	结果码	integer(int32)	integer(int32)
data	结果数据	boolean
message	结果描述	string
timestamp	时间戳	integer(int64)	integer(int64)

响应示例


xxxxxxxxxx
{
    "code": 0,
    "data": false,
    "message": "",
    "timestamp": 0
}