获取团队文档库列表

获取文档库（团队文档）列表

请求说明

请求地址	https://openapi.wps.cn/v7/doclibs
请求方法	GET
签名方式	KSO-1
权限要求	查询和管理文档库（用户授权） kso.doclib.readwrite 查询文档库（用户授权） kso.doclib.read

请求头（Header）

Header 名称	参数类型	是否必填	说明
Content-Type	string	是	使用：application/json
X-Kso-Date	string	是	RFC1123 格式的日期，例: Wed, 23 Jan 2013 06:43:08 GMT
X-Kso-Authorization	string	是	KSO-1 签名值，详见《签名方法》
Authorization	string	是	授权凭证，格式为：Bearer {access_token}

查询参数（Query）

名称	参数类型	是否必填	说明
page_size	integer	是	分页大小
page_token	string	否	分页 token

请求地址示例

[GET] https://openapi.wps.cn/v7/doclibs?page_size={integer}&page_token={string}

响应体

名称	参数类型	说明
code	integer	响应代码。非 0 表示失败，参照《状态码说明》
msg	string	响应信息
data	object	响应数据
∟ items	array[object]	文档库列表
∟ ∟ drive	object	文档库驱动盘信息
∟ ∟ ∟ allotee_id	string	盘归属身份 id
∟ ∟ ∟ allotee_type	string[enum]	盘归属身份类型 user：用户；group：用户组；app：应用
∟ ∟ ∟ company_id	string	企业 id
∟ ∟ ∟ created_by	object	创建者
∟ ∟ ∟ created_by	object	创建者
∟ ∟ ∟ ∟ avatar	string	创建者头像
∟ ∟ ∟ ∟ company_id	string	创建者企业 id
∟ ∟ ∟ ∟ id	string	创建者 id
∟ ∟ ∟ ∟ name	string	创建者名称
∟ ∟ ∟ ∟ type	string[enum]	身份类型 user：用户；sp：服务主体
∟ ∟ ∟ ctime	integer	创建时间
∟ ∟ ∟ description	string	盘描述
∟ ∟ ∟ ext_attrs	array[object]	盘扩展属性
∟ ∟ ∟ ∟ name	string	属性名
∟ ∟ ∟ ∟ value	string	属性值
∟ ∟ ∟ ext_attrs	array[object]	盘扩展属性
∟ ∟ ∟ id	string	盘 id
∟ ∟ ∟ mtime	integer	修改时间
∟ ∟ ∟ name	string	驱动盘名称
∟ ∟ ∟ quota	object	盘容量
∟ ∟ ∟ ∟ deleted	integer	回收站中的文件占用的总空间，以字节为单位。只读
∟ ∟ ∟ ∟ remaining	integer	剩余的总空间，以字节为单位。只读
∟ ∟ ∟ ∟ total	integer	允许的总存储空间，以字节为单位。只读
∟ ∟ ∟ ∟ used	integer	已使用的总空间，以字节为单位。只读
∟ ∟ ∟ source	string	盘来源
∟ ∟ ∟ status	string[enum]	盘状态 inuse：使用中；deleted：已刪除
∟ ∟ group	object	文档库用户组信息
∟ ∟ ∟ avatar	string	头像
∟ ∟ ∟ company_id	string	组织 id
∟ ∟ ∟ creator_id	string	创建者 id 创建时即确定，不被修改
∟ ∟ ∟ ctime	integer	创建时间
∟ ∟ ∟ dept_id	string	关联部门 id，默认 0
∟ ∟ ∟ description	string	描述介绍
∟ ∟ ∟ id	string	组 id，此处与用户组接口对应，可使用用户组接口管理组内成员，查看用户组接口
∟ ∟ ∟ member_total	integer	成员数量
∟ ∟ ∟ mtime	integer	更新时间
∟ ∟ ∟ name	string	名称
∟ ∟ ∟ owner_id	string	拥有者 id
∟ ∟ ∟ source	string	用户组的引用业务方
∟ ∟ ∟ status	string[enum]	状态 enable：正常；recycled：回收站
∟ ∟ ∟ type	string[enum]	类型 normal：普通用户组；dept：部门用户组；org_dynamic：企业动态用户组；org_normal：企业静态用户组
∟ ∟ pinned	boolean	是否置顶
∟ ∟ user_role	string[enum]	当前成员角色 normal：普通成员；admin：管理员；owner：拥有者
∟ next_page_token	string	下一页 token
more	object	更多的错误信息

响应体示例

{
  "data": {
    "items": [
      {
        "drive": {
          "allotee_id": "string",
          "allotee_type": "string[enum]",
          "company_id": "string",
          "created_by": {
            "avatar": "string",
            "company_id": "string",
            "id": "string",
            "name": "string",
            "type": "string[enum]"
          },
          "ctime": 0,
          "description": "string",
          "ext_attrs": [
            {
              "name": "string",
              "value": "string"
            }
          ],
          "id": "string",
          "mtime": 0,
          "name": "string",
          "quota": {
            "deleted": 0,
            "remaining": 0,
            "total": 0,
            "used": 0
          },
          "source": "string",
          "status": "string[enum]"
        },
        "group": {
          "avatar": "string",
          "company_id": "string",
          "creator_id": "string",
          "ctime": 0,
          "dept_id": "string",
          "description": "string",
          "id": "string",
          "member_total": 0,
          "mtime": 0,
          "name": "string",
          "owner_id": "string",
          "source": "string",
          "status": "string[enum]",
          "type": "string[enum]"
        },
        "pinned": false,
        "user_role": "string[enum]"
      }
    ],
    "next_page_token": "string"
  },
  "msg": "string",
  "code": 0
}