Skip to content
开发文档
能力中心
应用市场
WebOffice
开发者后台

获取文档库信息

获取文档库(团队文档)信息

请求说明

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

请求头(Header)

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

查询参数(Query)

名称参数类型是否必填说明
drive_idstring文档库驱动盘 id

请求地址示例

[GET] https://openapi.wps.cn/v7/doclib/meta?drive_id={string}

响应体

名称参数类型说明
codeinteger响应代码。非 0 表示失败,参照《状态码说明》
msgstring响应信息
dataobject响应数据
∟ driveobject文档库驱动盘信息
∟ ∟ allotee_idstring盘归属身份 id
∟ ∟ allotee_typestring[enum]盘归属身份类型
user:用户;group:用户组;app:应用
∟ ∟ company_idstring企业 id
∟ ∟ created_byobject创建者
∟ ∟ ∟ avatarstring创建者头像
∟ ∟ ∟ company_idstring创建者企业 id
∟ ∟ ∟ idstring创建者 id
∟ ∟ ∟ namestring创建者名称
∟ ∟ ∟ typestring[enum]身份类型
user:用户;sp:服务主体
∟ ∟ ctimeinteger创建时间
∟ ∟ descriptionstring盘描述
∟ ∟ ext_attrsarray[object]盘扩展属性
∟ ∟ ∟ namestring属性名
∟ ∟ ∟ valuestring属性值
∟ ∟ idstring驱动盘 id
∟ ∟ mtimeinteger修改时间
∟ ∟ namestring驱动盘名称
∟ ∟ quotaobject盘容量
∟ ∟ ∟ deletedinteger回收站中的文件占用的总空间,以字节为单位。只读
∟ ∟ ∟ remaininginteger剩余的总空间,以字节为单位。只读
∟ ∟ ∟ totalinteger允许的总存储空间,以字节为单位。只读
∟ ∟ ∟ usedinteger已使用的总空间,以字节为单位。只读
∟ ∟ sourcestring盘来源
∟ ∟ statusstring[enum]盘状态
inuse:使用中;deleted:已删除
∟ groupobject文档库用户组信息
∟ ∟ avatarstring头像
∟ ∟ company_idstring组织 id
∟ ∟ creator_idstring创建者 id 创建时即确定,不被修改
∟ ∟ ctimeinteger创建时间
∟ ∟ dept_idstring关联部门 id,默认 0
∟ ∟ descriptionstring描述介绍
∟ ∟ idstring组 id,此处与用户组接口对应,可使用用户组接口管理组内成员,查看用户组接口
∟ ∟ member_totalinteger成员数量
∟ ∟ mtimeinteger更新时间
∟ ∟ namestring名称
∟ ∟ owner_idstring拥有者 id
∟ ∟ sourcestring用户组的引用业务方
∟ ∟ statusstring[enum]状态
enable:正常;recycled:回收站
∟ ∟ typestring[enum]类型
normal:普通用户组;dept:部门用户组;org_dynamic:企业动态用户组;org_normal:企业静态用户组
∟ pinnedboolean是否置顶
∟ user_rolestring[enum]当前成员信息
normal:普通成员;admin:管理员;owner:拥有者
moreobject更多的错误信息

响应体示例

json
{
  "code": 0,
  "data": {
    "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]"
  },
  "msg": "string"
}
回到旧版