Skip to content

新建文件(夹)

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

接口说明:新建文件(夹)

请求说明

请求地址配置域名+/graph+/v7/drives/{drive_id}/files/{parent_id}/create
请求方法POST
签名方式WPS-4签名/WPS-4-GM签名(配置域名+/graph不参与签名)
权限要求更新文件(用户授权) kso.file.write 应用管理文件(应用授权) kso.appdrive.file.write

请求头(Header)

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

路径参数(Path)

名称参数类型是否必填说明
drive_idstring驱动盘id,<= 1024 characters
parent_idstring文件(夹)id(根目录时为0),<= 1024 characters

请求体(Body)

名称类型是否必填说明
file_typestring文件类型,folder:文件夹;file:文件
namestring文件名,须带上后缀,不支持"/:*?"<>|"特殊符号,长度范围[1,240]。例: abc.txt 支持格式后缀: 文字文件:doc,docx 表格文件:xls,xlsx 演示文件:ppt,pptx 多维表格:dbt,(需有多维表格组件集成权益) 轻文档:otl,(需有轻文档组件集成权益)
on_name_conflictstring文件名冲突行为,fail:失败;rename:重命名;overwrite:覆盖;replace:替换。默认为rename

响应体(Response)

名称类型说明
dataobject新建文件(夹)信息返回
idstring文件id
drive_idstring驱动盘id
parent_idstring父文件id
created_byobject创建者信息
avatarstring创建者头像,<= 1024 characters
company_idstring创建者企业id,<= 1024 characters
idstring创建者id,<= 1024 characters
namestring创建者名称,<= 1024 characters
typestring创建者身份类型,user:用户;
modified_byobject修改者信息
avatarstring修改者头像,<= 1024 characters
company_idstring修改者企业id,<= 1024 characters
idstring修改者id,<= 1024 characters
namestring修改者名称,<= 1024 characters
typestring修改者身份类型,user:用户;
sizeint64文件大小
versionint文件版本
typestring文件类型
namestring文件名称
ctimeint64文件创建时间,时间戳,单位为秒
mtimeint64文件修改时间,时间戳,单位为秒
hashobject文件哈希信息
sumstring哈希结果
typestring哈希类型,固定为s2s
ext_attrsobject[]文件扩展属性
permissionobject文件权限
link_urlstring分享链接
link_idstring分享链接id
codeinteger错误码,参照《错误码说明》
msgstring状态信息
detailstring详细信息

响应体示例

{
  "data": {
    "created_by": {
      "avatar": "string",
      "company_id": "string",
      "id": "string",
      "name": "string",
      "type": "user"
    },
    "ctime": 0,
    "drive_id": "string",
    "ext_attrs": [
      {
        "name": "string",
        "value": "string"
      }
    ],
    "hash": {
      "sum": "string",
      "type": "s2s"
    },
    "id": "string",
    "link_id": "string",
    "link_url": "string",
    "modified_by": {
      "avatar": "string",
      "company_id": "string",
      "id": "string",
      "name": "string",
      "type": "user"
    },
    "mtime": 0,
    "name": "string",
    "parent_id": "string",
    "permission": {
      "comment": true,
      "copy": true,
      "copy_content": true,
      "delete": true,
      "download": true,
      "list": true,
      "move": true,
      "new_empty": true,
      "perm_ctl": true,
      "preview": true,
      "print": true,
      "rename": true,
      "share": true,
      "update": true,
      "upload": true
    },
    "size": 0,
    "type": "folder",
    "version": 0
  },
  "code": 0,
  "detail": "string",
  "msg": "string"
}