Skip to content

创建文档库

适用版本>=v7.0.2310a.20231019

接口说明:创建文档库

请求说明

请求地址配置域名+/graph+/v7/doclib/create
请求方法POST
签名方式WPS-4签名/WPS-4-GM签名(配置域名+/graph不参与签名)
权限要求更新文档库(用户授权) kso.doclib.write管理文档库(应用授权) kso.appdrive.doclib.write

请求头(Header)

名称是否必填说明
Content-Type固定为: application/json
Wps-Docs-Date取当前时间,示例: Wed, 23 Jan 2013 06:43:08 GMT
Wps-Docs-Authorization计算方法参考签名说明
Authorization授权凭证,格式为: Bearer {access_token}

请求体(Body)

名称类型是否必填说明
membersobject<= 1024 items,文档库成员列表
item_idstring<= 1024 characters,组成员ID
item_typestringEnum: “normal” “dept”,组成员类型
nicknamestring[ 1 … 255 ] characters,昵称
rolestringitem_type为normal时Enum: “normal” “admin”,item_type为dept时Enum: “normal”,成员角色
signstring<= 255 characters,签名
namestring<= 255 characters,文档库名称,不能包含特殊字符<>/
dept_idstring<= 128 characters,部门ID,仅在应用授权场景支持

请求体示例

json
{
  "members": [
    {
      "item_id": "string",
      "item_type": "normal",
      "nickname": "string",
      "role": "normal",
      "sign": "string"
    }
  ],
  "name": "string",
  "dept_id": "string"
}

响应体(Response)

名称类型说明
codeintegercode
detailstringdetail
msgstringmsg
dataobject文档库模型
driveobject文档库驱动盘信息
allotee_idstring盘归属身份idallotee_type=user,allotee_id代表用户id;allotee_type=group,allotee_id代表用户组id
allotee_typestring盘归属身份类型,可选值: user:用户 group:用户组
company_idstring企业id,<= 1024 characters
created_byobject创建者
avatarstring创建者头像,<= 1024 characters
company_idstring创建者企业id,<= 1024 characters
idstring创建者id,<= 1024 characters
namestring创建者名称,<= 1024 characters
typestring创建者身份类型,user:用户
ctimeint创建时间,时间戳,单位为秒
descriptionstring盘描述,<= 1024 characters
ext_attrsobject[]盘扩展属性,<= 1024 items
namestring属性名,<= 1024 characters
valuestring属性值,<= 1024 characters
idstring驱动盘id
mtimeint修改时间,时间戳,单位为秒
namestring驱动盘名称
quotaobject盘容量
deletedint回收站中的文件占用的总空间,以字节为单位。只读。
remainingint剩余的总空间,以字节为单位。只读。
totalint允许的总存储空间,以字节为单位。只读。
usedint已使用的总空间,以字节为单位。只读。
statusstring盘状态
inuse:使用中;deleted:已删除;
groupobject文档库用户组信息
company_idstring企业id
avatarstring头像
creator_idstring创建者ID 创建时即确定,不被修改。
ctimeint创建时间,时间戳,单位为秒
descriptionstring描述介绍
idstring组ID
mtimeint修改时间,时间戳,单位为秒
namestring名称
owner_idstring拥有者ID
statusstring用户组状态
enable:正常;deleted:删除;
typestring用户组类型
normal:普通用户组;
dept:部门用户组;
whole:全员用户组
user_rolestring当前成员角色信息
normal:普通成员;
admin:管理员;
owner:拥有者

响应体示例

{
  "data": {
    "drive": {
      "allotee_id": "string",
      "allotee_type": "user",
      "company_id": "string",
      "created_by": {
        "avatar": "string",
        "company_id": "string",
        "id": "string",
        "name": "string",
        "type": "user"
      },
      "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
      },
      "status": "inuse"
    },
    "group": {
      "avatar": "string",
      "company_id": "string",
      "creator_id": "string",
      "ctime": 1,
      "description": "string",
      "id": "string",
      "mtime": 1,
      "name": "string",
      "owner_id": "string",
      "status": "enable",
      "type": "normal"
    },
    "user_role": "normal"
  },
  "code": 0,
  "detail": "string",
  "msg": "string"
}