部门模块

一、部门查询列表

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

请求方式 GET

consumes ["application/json"]

produces ["*/*"]

接口描述 ``

请求参数

参数名称	参数说明	请求类型	是否必须	数据类型	schema
appId	appId	query	false	string
departmentIds	部门id集合	query	false	array	string
rangeViewFlag	范围查看标识	query	false	boolean
banDeptId	需要禁用的部门id	query	false	string
isFindParent	是否只查父部门	query	false	boolean

响应状态

状态码	说明	schema
200	OK	响应结果对象«List«部门响应数据»»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数

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

schema属性说明

部门响应数据

参数名称	参数说明	类型	schema
children	子节点列表	array	部门响应数据
description	描述	string
disabled	禁止选择	boolean
enableReadOrManageFlag	可见可管理	boolean
id	主键ID	string
name	部门名称	string
parentId	父部门id	string
rootNode	是否根节点	boolean

响应示例


xxxxxxxxxx
{
    "code": 0,
    "data": {
        "body": [
            {
                "children": [
                    {
                        "children": [
                            {}
                        ],
                        "description": "",
                        "disabled": false,
                        "enableReadOrManageFlag": false,
                        "id": "",
                        "name": "",
                        "parentId": "",
                        "rootNode": false
                    }
                ],
                "description": "",
                "disabled": false,
                "enableReadOrManageFlag": false,
                "id": "",
                "name": "",
                "parentId": "",
                "rootNode": false
            }
        ]
    },
    "message": "",
    "timestamp": 0
}

二、创建部门

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

请求方式 POST

consumes ["application/json"]

produces ["*/*"]

接口描述 新增一条记录

请求参数

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

schema属性说明

部门创建请求体

参数名称	参数说明	请求类型	是否必须	数据类型
description	描述	body	false	string
name	部门名称	body	false	string
parentId	父部门id	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属性说明

部门响应数据

参数名称	参数说明	类型	schema
children	子节点列表	array	部门响应数据
description	描述	string
disabled	禁止选择	boolean
enableReadOrManageFlag	可见可管理	boolean
id	主键ID	string
name	部门名称	string
parentId	父部门id	string
rootNode	是否根节点	boolean

响应示例


xxxxxxxxxx
{
    "code": 0,
    "data": {
        "children": [
            {
                "children": [
                    {}
                ],
                "description": "",
                "disabled": false,
                "enableReadOrManageFlag": false,
                "id": "",
                "name": "",
                "parentId": "",
                "rootNode": false
            }
        ],
        "description": "",
        "disabled": false,
        "enableReadOrManageFlag": false,
        "id": "",
        "name": "",
        "parentId": "",
        "rootNode": false
    },
    "message": "",
    "timestamp": 0
}

三、修改部门

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

请求方式 PUT

consumes ["application/json"]

produces ["*/*"]

接口描述 修改一条记录

请求参数

参数名称	参数说明	请求类型	是否必须	数据类型	schema
departmentId	departmentId	path	true	string
body	body	body	true	部门修改请求体	部门修改请求体

schema属性说明

部门修改请求体

参数名称	参数说明	请求类型	是否必须	数据类型
description	描述	body	false	string
name	部门名称	body	false	string
parentId	父部门id	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属性说明

部门响应数据

参数名称	参数说明	类型	schema
children	子节点列表	array	部门响应数据
description	描述	string
disabled	禁止选择	boolean
enableReadOrManageFlag	可见可管理	boolean
id	主键ID	string
name	部门名称	string
parentId	父部门id	string
rootNode	是否根节点	boolean

响应示例


xxxxxxxxxx
{
    "code": 0,
    "data": {
        "children": [
            {
                "children": [
                    {}
                ],
                "description": "",
                "disabled": false,
                "enableReadOrManageFlag": false,
                "id": "",
                "name": "",
                "parentId": "",
                "rootNode": false
            }
        ],
        "description": "",
        "disabled": false,
        "enableReadOrManageFlag": false,
        "id": "",
        "name": "",
        "parentId": "",
        "rootNode": false
    },
    "message": "",
    "timestamp": 0
}

四、删除部门

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

请求方式 DELETE

consumes ["application/json"]

produces ["*/*"]

接口描述 删除一条记录

请求参数

参数名称	参数说明	请求类型	是否必须	数据类型	schema
departmentId	departmentId	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
}