Skip to main content
2023-12-13 02:52 更新Version: latest

团队和部门

特殊 ID 说明​

❗ 特殊部门 ID 说明​

在石墨 SDK 中，默认 根节点部门 对应 团队 信息，因此在获取

  • 部门信息
  • 部门的下级部门
  • 部门下的成员列表

时，使用如下规则表示根节点的部门 ID：

TEAM_{团队 ID}

如：

从 获取当前用户所在团队信息 获取的 Team ID 为 123，则获取部门信息时请求的 URL 形式为：

  • GET /departments/TEAM_123
  • GET /departments/TEAM_123/children
    • 获取团队层级部门的下级部门，一级部门，返回 部门列表
  • GET /departments/TEAM_123/members?page=1&pageSize=20
    • 获取团队层级部门下的成员列表，以 团队成员用户列表按照 部门成员列表 形式返回

❗ 表格锁定 中设置 全员锁定 设置说明​

石墨 SDK 表格编辑器中，若添加 表格锁定 时，选择对 企业全员 设置锁定权限时，回调接口需要满足以下条件：

  1. currentUser.teamGuid 不为空
  2. file.teamGuid 不为空
  3. currentUser.teamGuid 与 file.teamGuid 相等时，当前用户才会被判定属于全员锁定的范围内

❗ 表格锁定 限制说明​

在使用接入团队、部门功能后，由于表格编辑器会检查 当前用户 及 当前文件 的 teamGuid 是否相等，若不相等，则无法进行表格锁定操作。

获取团队下的成员列表​

请求地址

GET /teams/{teamGuid}/members?pagination=true&page={page}&pageSize={pageSize}

HTTP Request Headers

Header 名值说明
X-Shimo-Token接入方提供的 Token用于接入方对本次请求鉴权

HTTP Query Parameters

参数名类型值说明
paginationbooleantrue是否为分页查询
pagenumber1分页查询第几页
pageSizenumber10分页大小

HTTP Response Body

字段名类型值示例说明
items[0].idstringuserid123接入方系统的用户 ID
items[0].namestring张三接入方系统的用户名称
items[0].avatarstringhttp://fake.site/user-123.png接入方系统的用户头像地址
items[0].emailstringuser123@fake.site接入方系统的用户邮箱

Response Body Example

[
  {
    "id": "userid123",
    "name": "张三",
    "avatar": "http://fake.site/user-123.png",
    "email": "user123@fake.site"
  },
  {
    "id": "userid1234",
    "name": "李四",
    "avatar": "http://fake.site/user-123.png",
    "email": "user123@fake.site"
  }
]

获取部门信息​

提示

当部门 ID 为根节点 ID 时，以特殊形式传递部门 ID ，参考 特殊部门 ID 说明。

请求地址

GET /departments/{departmentId}

HTTP Request Headers

Header 名值说明
X-Shimo-Token接入方提供的 Token用于接入方对本次请求鉴权

HTTP Response Body

字段名类型值示例说明
idstring123接入方系统的部门 ID
namestring研发部接入方系统的部门名称
allMemberCountnumber99接入方当前部门下的所有成员数量

Response Body Example

{
  "id": "123",
  "name": "研发部",
  "allMemberCount": 99
}

获取部门的下级部门节点​

提示

当部门 ID 为根节点 ID 时，以特殊形式传递部门 ID ，参考 特殊部门 ID 说明。

请求地址

GET /departments/{departmentId}/children

HTTP Request Headers

Header 名值说明
X-Shimo-Token接入方提供的 Token用于接入方对本次请求鉴权

HTTP Response Body

字段名类型值示例说明
items[0].idstring123接入方系统的部门 ID
items[0].namestring研发部接入方系统的部门名称
items[0].allMemberCountnumber99接入方当前部门下的所有成员数量

Response Body Example

[
  {
    "id": "123",
    "name": "研发部",
    "allMemberCount": 99
  },
  {
    "id": "124",
    "name": "财务部",
    "allMemberCount": 10
  }
]

获取部门下的成员分页列表​

提示

当部门 ID 为根节点 ID 时，以特殊形式传递部门 ID ，参考 特殊部门 ID 说明。

请求地址

GET /departments/{departmentId}/members?page={page}&pageSize={pageSize}

HTTP Request Headers

Header 名值说明
X-Shimo-Token接入方提供的 Token用于接入方对本次请求鉴权

HTTP Query Parameters

参数名类型值说明
pagenumber1分页查询第几页
pageSizenumber20分页大小

HTTP Response Body

字段名类型值示例说明
totalnumber20接入方系统部门下的成员总数
members[0].idstringuserid123接入方系统的用户的 ID
members[0].namestring张三接入方系统的用户名称
members[0].avatarstringhttp://fake.site/user-123.png接入方系统的用户头像地址
members[0].emailstringuser123@fake.site接入方系统的用户邮箱

Response Body Example

{
  "total": 20,
  "members": [
    {
      "id": "userid123",
      "name": "张三",
      "avatar": "http://fake.site/user-123.png",
      "email": "user123@fake.site"
    },
    {
      "id": "userid1234",
      "name": "李四",
      "avatar": "http://fake.site/user-123.png",
      "email": "user123@fake.site"
    }
  ]
}