帮助中心
所有文章
组织架构 API
最后更新于 2023/07/31   阅读数 259

GET 获取当前组织架构信息

获取当前组织架构信息。

此操作将返回您当前所在的组织架构信息。包括租户,部门,员工和用户在内的全部信息。

接口地址/bee/api/v1/organizations/current-org

响应状态

状态码

说明

schema

200

OK 成功

租户对象

401

Unauthorized 未授权

404

Not Found 未找到

组织架构对象

参数名称

参数说明

类型

schema

departments

部门信息

array

部门对象

tenant

租户信息

租户对象

租户对象

部门对象

参数名称

参数说明

类型

schema

id

主键Id

string

name

部门名称

string

parentId

父节点id

string

createdBy

创建人

string

createdOn

创建时间

string

lastUpdatedBy

修改人

string

lastUpdatedOn

修改时间

string

employees

员工信息

array

员工对象

员工对象

参数名称

参数说明

类型

schema

createdBy

创建人

string

createdOn

创建时间

string

gender

性别(1男;2女)

string

id

主键Id

string

lastUpdatedBy

修改人

string

lastUpdatedOn

修改时间

string

name

员工名称

string

number

员工工号

string

phoneNumber

手机号

string

position

职位

string

roleName

角色名称

string

status

员工状态(在职-可用,离职-不可用)

string

user

用户信息

用户对象

用户对象

用户对象

参数名称

参数说明

类型

schema

email

邮箱

string

id

id主键

string

name

用户名称

string

password

密码

string

picture

头像

string

租户对象

参数名称

参数说明

类型

schema

id

租户id

string

name

租户名称

string

响应示例

{
	"code": 200,
	"success": true,
	"message": "请求成功",
	"data": {
		"departments": [
			{
				"id": "70",
				"name": "产品",
				"parentId": "-1",
				"createdBy": "1528998103067779074",
				"createdOn": "2022-07-14 23:06:40",
				"lastUpdatedBy": "1528998103067779074",
				"lastUpdatedOn": "2022-07-14 23:07:08",
				"employees": [
					{
						"id": "89",
						"name": "Julia",
						"gender": "女",
						"number": "007",
						"phoneNumber": "18601225086",
						"position": "Sales",
						"roleName": "默认角色",
						"status": "在职",
						"createdBy": "1528998103067779074",
						"createdOn": "2022-07-14 23:06:40",
						"lastUpdatedBy": "1547598458449494018",
						"lastUpdatedOn": "2022-07-14 23:07:08",
						"user": {
							"id": "1547598458449494018",
							"email": "julia.zhu@dingyuefeng.com",
							"name": "Julia",
							"password": "",
							"picture": ""
						}
					}
				]
			}
		],
		"tenant": {
			"id": "1593529858673625462",
			"name": "北京阅丰科技有限公司"
		}
	}
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
json

POST 创建租户

接口地址 /bee/api/v1/tenants

请求方式 POST

consumes ["application/json"]

produces ["*/*"]

接口描述 ``

请求参数

参数名称

参数说明

请求类型

是否必须

数据类型

schema

dto

dto

body

true

CreateTenantDto

CreateTenantDto

schema属性说明

CreateTenantDto

参数名称

参数说明

请求类型

是否必须

数据类型

schema

address

公司地址

body

false

string

email

公司邮箱地址

body

false

string

logoImageUrl

公司logoUrl

body

false

string

name

公司名称

body

false

string

telephone

公司联系电话

body

false

string

website

公司域名

body

false

string

响应状态

状态码

说明

schema

200

OK

ResponseData«CreateTenantVo»

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

响应参数

参数名称

参数说明

类型

schema

code

响应状态码

integer(int32)

integer(int32)

data

通用返回数据

CreateTenantVo

CreateTenantVo

message

状态描述信息

string

success

是否成功

boolean

schema属性说明

CreateTenantVo

参数名称

参数说明

类型

schema

address

公司地址

string

email

公司邮箱地址

string

id

租户id

integer(int64)

logoImageUrl

公司logoUrl

string

name

公司名称

string

telephone

公司联系电话

string

website

公司域名

string

响应示例

{
	"code": 0,
	"data": {
		"address": "",
		"email": "",
		"id": 0,
		"logoImageUrl": "",
		"name": "",
		"telephone": "",
		"website": ""
	},
	"message": "",
	"success": true
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
json

GET 获取租户 API KEY

接口地址 /bee/api/v1/tenants/{tenant-id}/api-key

请求方式 GET

consumes ``

produces ["*/*"]

接口描述 ``

请求参数

参数名称

参数说明

请求类型

是否必须

数据类型

schema

tenant-id

tenant-id

path

true

integer

响应状态

状态码

说明

schema

200

OK

ResponseData«TenantApiVo»

401

Unauthorized

403

Forbidden

404

Not Found

响应参数

参数名称

参数说明

类型

schema

code

响应状态码

integer(int32)

integer(int32)

data

通用返回数据

TenantApiVo

TenantApiVo

message

状态描述信息

string

success

是否成功

boolean

schema属性说明

TenantApiVo

参数名称

参数说明

类型

schema

apiKey

apiKey

string

id

租户id

integer(int64)

name

租户名称

string

响应示例

{
	"code": 0,
	"data": {
		"apiKey": "",
		"id": 0,
		"name": ""
	},
	"message": "",
	"success": true
}
1
2
3
4
5
6
7
8
9
10
json

GET 获取当前租户信息

获取当前组织架构中的租户基本信息。

此操作将返回您当前所在的组织架构中的租户基本信息,目前只包含了租户ID和租户名称。

接口地址/bee/api/v1/tenants/current-tenant

响应状态

状态码

说明

schema

200

OK 成功

租户对象

401

Unauthorized 未授权

404

Not Found 未找到

响应参数

参数名称

参数说明

类型

schema

code

响应状态码

number

data

通用返回数据

租户对象

租户对象

message

状态描述信息

string

success

是否成功

boolean

schema属性说明

租户对象

参数名称

参数说明

类型

schema

id

租户id

string

name

租户名称

string

响应示例

{
	"code": 200,
	"success": true,
	"message": "请求成功",
	"data": {
		"id": "1593529858673625462",
		"name": "北京阅丰科技有限公司"
	}
}
1
2
3
4
5
6
7
8
9
json

PUT 修改当前租户信息

修改当前租户的基本信息,目前只能修改租户的名称

接口地址/bee/api/v1/tenants/current-tenant

租户对象

参数名称

参数说明

请求类型

是否必须

数据类型

schema

name

租户名称(长度:100, 不可为空)

body

true

string(100)

请求示例

{
	"name": "璀璨未来科技有限公司"
}
1
2
3
plaintext

响应状态

状态码

说明

schema

200

OK 成功

ResponseData

201

Created 创建成功

401

Unauthorized 未授权

404

Not Found 未找到

响应参数

参数名称

参数说明

类型

schema

code

响应状态码

string

data

通用返回数据

object

message

状态描述信息

string

success

是否成功

boolean

响应示例

{
	"code": 200,
	"success": true,
	"message": "请求成功",
	"data": {
		"id": "1593529858673625462",
		"name": "北京阅丰科技有限公司"
	}
}
1
2
3
4
5
6
7
8
9
json

GET 获取组织部门信息

获取当前组织部门信息,包含部门基本信息和员工信息

接口地址: /bee/api/v1/departments

响应状态

状态码

说明

schema

200

OK 成功

租户对象

401

Unauthorized 未授权

404

Not Found 未找到

响应参数

参数名称

参数说明

类型

schema

code

响应状态码

number

data

通用返回数据

array

部门对象

message

状态描述信息

string

success

是否成功

boolean

部门对象

参数名称

参数说明

类型

schema

id

主键Id

string

name

部门名称

string

parentId

父节点id

string

createdBy

创建人

string

createdOn

创建时间

string

lastUpdatedBy

修改人

string

lastUpdatedOn

修改时间

string

employees

员工信息

array

员工对象

员工对象

参数名称

参数说明

类型

schema

createdBy

创建人

string

createdOn

创建时间

string

gender

性别(1男;2女)

string

id

主键Id

string

lastUpdatedBy

修改人

string

lastUpdatedOn

修改时间

string

name

员工名称

string

number

员工工号

string

phoneNumber

手机号

string

position

职位

string

roleName

角色名称

string

status

员工状态(1未响应 2 以接受 3已拒绝 4已离职)

string

user

用户信息

用户对象

用户对象

用户对象

参数名称

参数说明

类型

schema

email

邮箱

string

id

id主键

string

name

用户名称

string

password

密码

string

picture

头像

string

响应示例

{
	"code": 0,
	"data": [
		{
			"id": "70",
				"name": "产品",
				"parentId": "-1",
				"createdBy": "1528998103067779074",
				"createdOn": "2022-07-14 23:06:40",
				"lastUpdatedBy": "1528998103067779074",
				"lastUpdatedOn": "2022-07-14 23:07:08",
				"employees": [
					{
						"id": "89",
						"name": "Julia",
						"gender": "女",
						"number": "007",
						"phoneNumber": "18601225086",
						"position": "Sales",
						"roleName": "默认角色",
						"status": "在职",
						"createdBy": "1528998103067779074",
						"createdOn": "2022-07-14 23:06:40",
						"lastUpdatedBy": "1547598458449494018",
						"lastUpdatedOn": "2022-07-14 23:07:08",
						"user": {
							"id": "1547598458449494018",
							"email": "julia.zhu@dingyuefeng.com",
							"name": "Julia",
							"password": "",
							"picture": ""
						}
					}
				]
		}
	],
	"message": "请求成功",
	"success": true
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
json

POST 创建新的部门

创建新的部门信息

接口地址/bee/api/v1/departments

请求示例

{
	"parentId": 1598546327436452542,
	"name": "hr"
}
1
2
3
4
json

部门对象

参数名称

参数说明

请求类型

是否必须

数据类型

schema

name

组织名称

(长度:100,必填且不能重复)

body

true

string(100)

parentId

上级部门ID

body

false

number(long id)

响应状态

状态码

说明

schema

200

OK 成功

租户对象

401

Unauthorized 未授权

404

Not Found 未找到

响应参数

参数名称

参数说明

类型

schema

code

响应状态码

number

number

data

通用返回数据

object

message

状态描述信息

string

success

是否成功

boolean

响应示例

{
	"code": 200,
	"message": "请求成功",
	"success": true,
	"data": {
		"id": 1598546327436452542
	}
}
1
2
3
4
5
6
7
8
json

PUT 修改部门信息

修改部门信息,目前只支持修改部门名称。

接口地址/bee/api/v1/departments/{department-id}

请求示例

{
	"name": "pm"
}
1
2
3
json

请求参数

参数名称

参数说明

请求类型

是否必须

数据类型

schema

department-id

department-id

path

true

number(long id)

部门对象

参数名称

参数说明

请求类型

是否必须

数据类型

schema

name

组织名称

(长度:100, 不能为空)

body

true

string(100)

响应状态

状态码

说明

schema

200

OK 成功

租户对象

401

Unauthorized 未授权

404

Not Found 未找到

响应参数

参数名称

参数说明

类型

schema

code

响应状态码

number

number

data

通用返回数据

object

message

状态描述信息

string

success

是否成功

boolean

响应示例

{
	"code": 200,
	"message": "请求成功",
	"success": true,
	"data": null
}
1
2
3
4
5
6
json

DELETE 删除指定部门

通过ID删除部门

接口地址: /bee/api/v1/departments/{department-id}

请求方式: DELETE

请求参数

参数名称

参数说明

请求类型

是否必须

数据类型

schema

department-id

department-id

path

true

number(long id)

响应状态

状态码

说明

schema

200

OK 成功

租户对象

401

Unauthorized 未授权

404

Not Found 未找到

响应参数

参数名称

参数说明

类型

schema

code

响应状态码

number

number

data

通用返回数据

object

message

状态描述信息

string

success

是否成功

boolean

响应示例

{
	"code": 200,
	"data": {},
	"message": "请求成功",
	"success": true
}
1
2
3
4
5
6
json

GET 获取员工信息

接口地址 /bee/api/v1/employees/{employee-id}

请求方式 GET

consumes ``

produces ["*/*"]

请求参数

参数名称

参数说明

请求类型

是否必须

数据类型

schema

employee-id

employee-id

path

true

integer

响应状态

状态码

说明

schema

200

OK

ResponseData«PersonnelVo对象»

401

Unauthorized

403

Forbidden

404

Not Found

响应参数

参数名称

参数说明

类型

schema

code

响应状态码

integer(int32)

integer(int32)

data

通用返回数据

PersonnelVo对象

PersonnelVo对象

message

状态描述信息

string

success

是否成功

boolean

schema属性说明

PersonnelVo对象

参数名称

参数说明

类型

schema

createdBy

创建人

string

createdOn

创建时间

string

gender

性别(1男;2女)

string

id

主键Id

string

internalReferenceId

内部引用id

string

commissionRate

返佣比例(0.5表示50%)

number

lastUpdatedBy

修改人

string

lastUpdatedOn

修改时间

string

name

员工名称

string

number

员工工号

string

phoneNumber

手机号

string

position

职位

string

roleName

角色名称

string

status

员工状态(在职-可用,离职-不可用)

string

user

用户信息

用户对象

用户对象

用户对象

参数名称

参数说明

类型

schema

email

邮箱

string

id

id主键

string

name

用户名称

string

password

密码

string

picture

头像

string

响应示例

{
  "code": 200,
  "data": {
    "id": "159340393828504930",
    "name": "Ella",
    "gender": "女",
    "picture": "file.png",
    "number": "D-007",
    "position": "产品负责人",
    "phoneNumber": "13522918133",
    "roleName": "产品管理员",
    "internalReferenceId": "4943473990393824000",
    "commissionRate": 0.5,
    "createdBy": "Ella",
    "createdOn": "2022-08-01 18:43:25",
    "lastUpdatedBy": "Michael",
    "lastUpdatedOn": "2022-08-10 13:22:12",
    "user": {
      "id": "159340393828504930",
      "name": "Ella",
      "picture": "file.png",
      "phoneNumber": "13522918133",
      "emailAddress": "ella.zhumy@dingyuefeng.com",
      "password": "xjMKsk1deyf2YZQ"
    }
  },
  "message": "请求成功",
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
json

POST 创建新的员工

创建新的员工,包含员工信息和用户信息。

接口地址/bee/api/v1/employees/department/{department-id}

请求方式POST

请求参数

参数名称

参数说明

请求类型

是否必须

数据类型

schema

department-id

department-id

path

true

number(long id)

请求示例

{
	"name": "Julia",
	"gender": "女",
	"number": "001",
	"phoneNumber": "13522222222",
	"position": "CTO",
	"roleId": 1598403952094912305,
    "internalReferenceId": 1599603952094912302,
    "commissionRate": 0.5

}
1
2
3
4
5
6
7
8
9
10
11
json

员工对象

参数名称

参数说明

请求类型

是否必须

数据类型

schema

name

员工名称

(长度:100, 不能为空)

body

true

string

gender

性别

(1男;2女)

body

false

integer(int32)

number

员工工号

(长度:20,可以为空)

body

false

string

phoneNumber

手机号

(11位手机号码,不能为空)

body

true

string

position

职位

(长度:20, 可以为空)

body

false

string

roleId

角色id

(如果不填会初始化默认权限)

body

false

number(long id)

internalReferenceId

内部引用Id

body

false

string

commissionRate

返佣比例(0.5表示50%)

body

false

number

响应状态

状态码

说明

schema

200

OK 成功

租户对象

401

Unauthorized 未授权

404

Not Found 未找到

响应参数

参数名称

参数说明

类型

schema

code

响应状态码

number

number

data

通用返回数据

object

message

状态描述信息

string

success

是否成功

boolean

响应示例

{
	"code": 200,
	"data": {
		"id": "159340393828504930",
      "name": "Ella",
      "gender": "女",
      "picture": "file.png",
      "number": "D-007",
      "position": "产品负责人",
      "phoneNumber": "13522918133",
      "roleName": "产品管理员",
      "commissionRate": 0.5,
      "createdBy": "Ella",
      "createdOn": "2022-08-01 18:43:25",
      "lastUpdatedBy": "Michael",
      "lastUpdatedOn": "2022-08-10 13:22:12",
      "user": {
        "id": "159340393828504930",
        "name": "Ella",
        "picture": "file.png",
        "phoneNumber": "13522918133",
        "emailAddress": "ella.zhumy@dingyuefeng.com",
        "password": "xjMKsk1deyf2YZQ"
      }
	},
	"message": "请求成功",
	"success": true
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
json

GET 获取部门人员列表

接口地址 /bee/api/v1/employees/department/{department-id}

请求方式 GET

consumes ``

produces ["*/*"]

请求参数

参数名称

参数说明

请求类型

是否必须

数据类型

schema

department-id

department-id

path

true

integer

响应状态

状态码

说明

schema

200

OK

ResponseData«List«PersonnelVo对象»»

401

Unauthorized

403

Forbidden

404

Not Found

响应参数

参数名称

参数说明

类型

schema

code

响应状态码

integer(int32)

integer(int32)

data

通用返回数据

array

PersonnelVo对象

message

状态描述信息

string

success

是否成功

boolean

schema属性说明

PersonnelVo对象

参数名称

参数说明

类型

schema

createdBy

创建人

string

createdOn

创建时间

string

gender

性别(1男;2女)

string

id

主键Id

string

lastUpdatedBy

修改人

string

lastUpdatedOn

修改时间

string

name

员工名称

string

number

员工工号

string

phoneNumber

手机号

string

position

职位

string

roleName

角色名称

string

status

员工状态(1未响应 2 以接受 3已拒绝 4已离职)

string

internalReferenceId

内部引用Id

string

commissionRate

返佣比例(0.5表示50%)

number

user

用户信息

用户对象

用户对象

用户对象

参数名称

参数说明

类型

schema

email

邮箱

string

id

id主键

string

name

用户名称

string

password

密码

string

picture

头像

string

响应示例


{
  "code": 200,
  "data": [
    {
      "id": "159340393828504930",
      "name": "Ella",
      "gender": "女",
      "picture": "file.png",
      "number": "D-007",
      "position": "产品负责人",
      "phoneNumber": "13522918133",
      "commissionRate": 0.5,
      "roleName": "产品管理员",
      "createdBy": "Ella",
      "createdOn": "2022-08-01 18:43:25",
      "lastUpdatedBy": "Michael",
      "lastUpdatedOn": "2022-08-10 13:22:12",
      "user": {
        "id": "159340393828504930",
        "name": "Ella",
        "picture": "file.png",
        "phoneNumber": "13522918133",
        "emailAddress": "ella.zhumy@dingyuefeng.com",
        "password": "xjMKsk1deyf2YZQ"
      }
    }
  ],
  "message": "请求成功",
  "success": true
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
json

PUT 修改员工信息

修改员工信息,包含名字和其它信息。

接口地址/bee/api/v1/employees/{employee-id}

请求方式PUT

请求参数

参数名称

参数说明

请求类型

是否必须

数据类型

schema

department-id

department-id

path

true

number(long id)

请求示例

{
	"name": "Julia",
	"gender": "女",
	"number": "001",
	"phoneNumber": "13522222222",
	"position": "CTO",
	"roleId": 1598403952094912305,
    "internalReferenceId": 1599603952094912302,
    "commissionRate": 0.5
}
1
2
3
4
5
6
7
8
9
10
json

员工对象

参数名称

参数说明

请求类型

是否必须

数据类型

schema

name

员工名称

(长度:100, 不能为空)

body

false

string

gender

性别

(1男;2女)

body

false

integer(int32)

number

员工工号

(长度:20,可以为空)

body

false

string

phoneNumber

手机号

(11位手机号码,不能为空)

body

false

string

position

职位

(长度:20,可以为空)

body

false

string

roleId

角色id

(如果不填会初始化默认权限)

body

false

number(long id)

internalReferrenceId

内部引用ID(OA系统里的User ID)

body

false

string(64)

commissionRate

返佣比例(0.5表示50%)

body

false

number

响应状态

状态码

说明

schema

200

OK 成功

租户对象

401

Unauthorized 未授权

404

Not Found 未找到

响应参数

参数名称

参数说明

类型

schema

code

响应状态码

number

number

data

通用返回数据

object

message

状态描述信息

string

success

是否成功

boolean

响应示例

{
	"code": 200,
	"data": null,
	"message": "请求成功",
	"success": true
}
1
2
3
4
5
6
json

DELETE 删除指定员工

接口地址: /bee/api/v1/employees/{employee-id}

请求方式: DELETE

请求参数

参数名称

参数说明

请求类型

是否必须

数据类型

schema

employee-id

employee-id

path

true

number(long id)

响应状态

状态码

说明

schema

200

OK 成功

租户对象

401

Unauthorized 未授权

404

Not Found 未找到

响应参数

参数名称

参数说明

类型

schema

code

响应状态码

number

number

data

通用返回数据

object

message

状态描述信息

string

success

是否成功

boolean

响应示例

{
	"code": 200,
	"data": {},
	"message": "请求成功",
	"success": true
}
1
2
3
4
5
6
json

如调用API返回异常,可点击这里查看异常资源代码。

本篇目录

GET 获取当前组织架构信息

POST 创建租户

GET 获取租户 API KEY

GET 获取当前租户信息

PUT 修改当前租户信息

GET 获取组织部门信息

POST 创建新的部门

PUT 修改部门信息

DELETE 删除指定部门

GET 获取员工信息

POST 创建新的员工

GET 获取部门人员列表

PUT 修改员工信息

DELETE 删除指定员工