1. 组织管理
1.1. 添加组织
基础信息
路径: /v1/api/org/add
请求方法: POST
请求参数
Headers:
| 名称 | 值 | 必须 | 备注 |
|---|---|---|---|
| Content-Type | application/json | 是 |
Body:
| 名称 | 类型 | 必须 | 默认值 | 备注 |
|---|---|---|---|---|
| fullName | string | 是 | 名称 | |
| parentUuid | string | 是 | 父机构uuid |
Body示例:
{
"fullName":"AAA",
"parentUuid":"0"
}
返回数据
Headers:
| 名称 | 值 | 必须 | 备注 |
|---|---|---|---|
| content-type | application/json;charset=UTF-8 | 否 |
Body:
| 名称 | 类型 | 必须 | 默认值 | 备注 |
|---|---|---|---|---|
| code | integer | 否 | ||
| msg | string | 否 | ||
| data | object | 否 | ||
| |─uuid | string | 否 | UUID | |
| |─fullName | string | 否 | 名称 | |
| |─parentUuid | string | 否 | 父机构uuid |
响应示例:
{
"code": 0,
"data": {
"fullName": "AAA",
"parentUuid": "0",
"uuid": "61aea6061c044031b81474132ac48b3c"
},
"msg": "成功"
}
1.2. 修改组织信息
基础信息
路径: /v1/api/org/update
请求方法: POST
请求参数
Headers:
| 名称 | 值 | 必须 | 备注 |
|---|---|---|---|
| Content-Type | application/json | 是 |
Body:
| 名称 | 类型 | 必须 | 默认值 | 备注 |
|---|---|---|---|---|
| uuid | string | 是 | 组织或公司uuid | |
| fullName | string | 否 | 名称 |
Body示例:
{
"uuid":"61aea6061c044031b81474132ac48b3c",
"fullName":"AAA"
}
返回数据
Headers:
| 名称 | 值 | 必须 | 备注 |
|---|---|---|---|
| content-type | application/json;charset=UTF-8 | 否 |
Body:
| 名称 | 类型 | 必须 | 默认值 | 备注 |
|---|---|---|---|---|
| code | integer | 否 | ||
| msg | string | 否 | ||
| data | object | 否 |
响应示例:
{
"code": 0,
"msg": "成功"
}
1.3. 查询组织树
基础信息
路径: /v1/api/org/tree
请求方法: POST
请求参数
Headers:
| 名称 | 值 | 必须 | 备注 |
|---|---|---|---|
| Content-Type | application/json | 是 |
Body:
| 名称 | 类型 | 必须 | 默认值 | 备注 |
|---|---|---|---|---|
| orgName | string | 否 | 机构名 |
Body示例:
{
"orgName": "AAA"
}
返回数据
Headers:
| 名称 | 值 | 必须 | 备注 |
|---|---|---|---|
| content-type | application/json;charset=UTF-8 | 否 |
Body:
| 名称 | 类型 | 必须 | 默认值 | 备注 |
|---|---|---|---|---|
| code | integer | 否 | ||
| msg | string | 否 | ||
| data | array | 否 | ||
| |─ | object | |||
| |─orgUuid | string | 否 | 组织uuid | |
| |─orgName | string | 否 | 组织名称 | |
| |─parentUuid | string | 否 | 父组织uuid | |
| |─childNum | integer | 否 | 组织下人员数量(仅为该组织,不包括其子组织 | |
| |─childTotal | integer | 否 | 组织下人员数量(包括其下所有子组织) |
响应示例:
{
"code": 0,
"data": [
{
"childNum": 1,
"childTotal": 2,
"orgName": "默认部门",
"orgUuid": "0",
"parentUuid": "-1"
},
{
"childNum": 0,
"childTotal": 0,
"orgName": "AAA",
"orgUuid": "61aea6061c044031b81474132ac48b3c",
"parentUuid": "0"
}
],
"msg": "成功"
}
1.4. 删除组织
基础信息
路径: /v1/api/org/delete
请求方法: POST
请求参数
Headers:
| 名称 | 值 | 必须 | 备注 |
|---|---|---|---|
| Content-Type | application/json | 是 |
Body:
| 名称 | 类型 | 必须 | 默认值 | 备注 |
|---|---|---|---|---|
| uuid | string | 是 | uuid | |
| personInOrgHandleMode | integer | 否 | 0 | 部门内人员处理模式,0表示删除,1表示移动到父部门内 默认为0 |
Body示例:
{
"uuid":"61aea6061c044031b81474132ac48b3c"
}
返回数据
Headers:
| 名称 | 值 | 必须 | 备注 |
|---|---|---|---|
| content-type | application/json;charset=UTF-8 | 否 |
Body:
| 名称 | 类型 | 必须 | 默认值 | 备注 |
|---|---|---|---|---|
| code | integer | 否 | ||
| msg | string | 否 | ||
| data | object | 否 |
响应示例:
{
"code": 0,
"msg": "成功"
}
1.5. 获取最上级组织信息
基础信息
路径: /v1/api/org/top/detail
请求方法: POST
请求参数
Headers:
| 名称 | 值 | 必须 | 备注 |
|---|---|---|---|
| Content-Type | application/json;charset=UTF-8 | 是 |
Body示例:
{}
返回数据
Headers:
| 名称 | 值 | 必须 | 备注 |
|---|---|---|---|
| content-type | application/json;charset=UTF-8 | 否 |
Body:
| 名称 | 类型 | 必须 | 默认值 | 备注 |
|---|---|---|---|---|
| code | integer | 否 | ||
| msg | string | 否 | ||
| data | object | 否 | ||
| |─orgUuid | string | 否 | 组织uuid | |
| |─orgName | string | 否 | 组织名称 |
响应示例:
{
"code": 0,
"data": {
"orgName": "默认部门",
"orgUuid": "0"
},
"msg": "成功"
}
1.6. 查询组织详情
基础信息
路径: /v1/api/org/detail
请求方法: POST
请求参数
Headers:
| 名称 | 值 | 必须 | 备注 |
|---|---|---|---|
| Content-Type | application/json | 是 |
Body:
| 名称 | 类型 | 必须 | 默认值 | 备注 |
|---|---|---|---|---|
| uuid | string | 是 | uuid |
Body示例:
{
"uuid":"61aea6061c044031b81474132ac48b3c"
}
返回数据
Headers:
| 名称 | 值 | 必须 | 备注 |
|---|---|---|---|
| content-type | application/json;charset=UTF-8 | 否 |
Body:
| 名称 | 类型 | 必须 | 默认值 | 备注 |
|---|---|---|---|---|
| code | integer | 否 | ||
| msg | string | 否 | ||
| data | object | 否 | ||
| |─orgUuid | string | 否 | 组织uuid | |
| |─orgName | string | 否 | 组织名称 | |
| |─parentUuid | string | 否 | 父组织uuid |
响应示例:
{
"code": 0,
"msg": "成功",
"data":{
"orgUuid":"61aea6061c044031b81474132ac48b3c",
"orgName": "test",
"parentUuid": "61aea6061c044031b81474132ac48b3d"
}
}