跳转至

部门管理

主动调用通用参数请参阅全局说明

SDK示例:https://github.com/youduim/youdu-sdk-java

创建部门

请求说明

POST方式请求URL: http://[SERVER:7080]/cgi/dept/create?accessToken=$access_token

请求结构体

{
     "id": $dept_id,
     "name": "$dept_name",
     "parentId": $parent_dept_id,
     "sortId": $sort_id,
     "alias":"alias"
}

参数说明

参数 必须 说明
id 部门id,整型。必须大于0
name 部门名称。不能超过32个字符(包括汉字和英文字母)
parentId 父部门id。根部门id为0
sortId 整型。在父部门中的排序值。值越小排序越靠前。填0自动生成。同级部门不允许重复(推荐全局唯一)
alias 字符串。部门id的别名(通常存放以字符串表示的部门id)。唯一不为空,相同会覆盖旧数据。

返回结果

{
     "id":  $dept_id
}

更新部门

请求说明

POST方式请求URL: http://[SERVER:7080]/cgi/dept/update?accessToken=$access_token

请求结构体

{
     "id": $dept_id,
     "name": "$dept_name",
     "parentId": $parent_dept_id,
     "sortId": $sort_id,
     "alias": "alias"
}

参数说明

参数 必须 说明
id 部门id,整型。不能修改根部门
name 部门名称。不能超过32个字符(包括汉字和英文字母)
parentId 父部门id。根部门id为0
sortId 整型。在父部门中的排序值。值越大排序越靠前。填0自动生成(末尾)。
alias 字符串。部门id的别名(通常存放以字符串表示的部门id)。唯一不为空,相同会覆盖旧数据。

返回结果

全局状态码

删除部门

请求说明

GET方式请求URL: http://[SERVER:7080]/cgi/dept/delete?accessToken=$access_token&id=$dept_id

参数说明

参数 必须 说明
id 部门id,整型。不能删除根部门;不能删除含有子部门和成员的部门

返回结果

全局状态码

获取部门列表

请求说明

GET方式请求URL: http://[SERVER:7080]/cgi/dept/list?accessToken=$access_token&id=$dept_id

参数说明

参数 必须 说明
id 部门id。获取指定部门及其下的直属子部门。根部门id为0

返回结果

{
   "deptList": [
      {
         "id": $dept_id_1,
         "name": "$dept_name_1",
         "parentId": $parent_dept_id,
         "sortId": $dept_sort_id
      },
      {
         "id": $dept_id_2,
         "name": "$dept_name_2",
         "parentId": $parent_dept_id,
         "sortId": $dept_sort_id
      }
   ]
}
参数 说明
deptList 部门列表
id 部门id
name 部门名称
parentId 父部门id
sortId 在父部门中的排序值

获取部门ID

请求说明

GET方式请求URL: http://[SERVER:7080]/cgi/dept/getid?accessToken=$access_token&alias="alias"

参数说明

参数 必须 说明
alias 部门alias。携带时查询该alias对应的部门id。不带alias参数时查询全部映射关系。

返回结果

  • 带alias查询 { “id”:5 }
  • 查询全部 { “aliasList”:[ { "id":1, "alias":"we3pj6cv" }, { "id":2, "alias":"zx37ivgm" } ] }