添加文件夹

POST

/v1.0/storage/spaces/{spaceId}/dentries/{parentId}/folders

接口调用量说明钉钉标准版接口累计可调用次数为1万次/月，当前接口会消耗调用次数。若该调用量无法满足需求，你可升级钉钉专业版(Open API调用量50万次/月)或钉钉专属版(Open API调用量500万次/月)扩容调用次数。

调用本接口，在存储空间内添加文件夹。

接口调用说明

在添加存储空间后，可调用本接口在空间内添加文件夹。

存储空间类型为USER时，只有空间拥有者和管理者有操作权限，其他员工均需要授权。

企业内部应用，调用添加权限接口进行授权。

第三方企业应用，调用添加权限接口进行授权。

存储空间类型为APP时，任何人操作都需要先进行授权。

企业内部应用，调用添加权限接口进行授权。

第三方企业应用，调用添加权限接口进行授权。

权限

要调用此API，需要以下权限之一。

应用类型	是否支持	权限	API Explorer调试
企业内部应用	支持	企业存储文件写权限	API Explorer
第三方企业应用	支持	企业存储文件写权限	API Explorer
第三方个人应用	暂不支持	企业存储文件写权限	暂不支持

错误码

HttpCode	错误码	错误信息	说明
400	operationConcurrentControl	%s	并发控制
400	paramError	%s	参数错误
400	paramError.conflictStrategy	%s	参数错误-conflictStrategy
400	dentryNameIllegal	%s	文件名非法
400	dentryAlreadyExist	%s	文件已存在
403	permissionDenied	%s	用户缺少添加文件夹的权限
404	dentryNotExist	%s	父目录不存在
500	systemError	%s	系统错误
500	unknownError	Unknown Error	未知错误
503	operationTimeout	%s	请求超时

请求示例

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://api.dingtalk.com/v1.0/storage/spaces//dentries//folders?unionId=String' \
--header 'x-acs-dingtalk-access-token;' \
--header 'Content-Type: application/json' \
--data-raw '{
  "name" : "String",
  "option" : {
    "conflictStrategy" : "String",
    "appProperties" : [ {
      "name" : "String",
      "value" : "String",
      "visibility" : "String"
    } ]
  }
}'

响应示例

{
  "dentry": {
    "id": "string",
    "spaceId": "string",
    "parentId": "string",
    "type": "string",
    "name": "string",
    "size": 0,
    "path": "string",
    "version": 0,
    "status": "string",
    "extension": "string",
    "creatorId": "string",
    "modifierId": "string",
    "createTime": "string",
    "modifiedTime": "string",
    "properties": {
      "readOnly": true
    },
    "appProperties": [
      {
        "name": "string",
        "value": "string",
        "visibility": "string"
      }
    ],
    "uuid": "string",
    "partitionType": "string",
    "storageDriver": "string"
  }
}

请求参数

Path 参数

spaceId

string

必需

空间Id。

企业内部应用，调用添加空间接口获取id参数值。

第三方企业应用，调用添加空间接口获取id参数值。

parentId

string

必需

企业内部应用，调用获取文件或文件夹列表接口获取parentId参数值。

第三方企业应用，调用获取文件或文件夹列表接口获取parentId参数值。

Query 参数

unionId

string

必需

操作者unionId。

企业内部应用，调用查询用户详情接口获取unionid参数值。

第三方企业应用，调用查询用户详情接口获取unionid参数值。

示例值:

String

Header 参数

x-acs-dingtalk-access-token

string

必需

调用该接口的访问凭证。

企业内部应用，调用获取企业内部应用的accessToken接口获取。

第三方企业应用，调用获取第三方应用授权企业的accessToken接口获取。

Body 参数application/json

name

string

必需

文件夹的名称，命名有以下要求：头尾不能包含空格，否则会自动去除不能包含特殊字符，包括：制表符、*、"、<、>、| 不能以"."结尾

option

object

可选参数。

可选

conflictStrategy

string

必需

文件夹名称冲突策略。 AUTO_RENAME：自动重命名，默认值 OVERWRITE：覆盖 RETURN_DENTRY_IF_EXISTS：返回已存在文件夹 RETURN_ERROR_IF_EXISTS：文件夹已存在时报错

appProperties

array [object {3}]

可选

当前文件夹的应用属性列表，最大值3。

示例

返回响应

🟢200成功

application/json

Body

dentry

object

文件夹信息。

必需

string

文件夹id。

必需

spaceId

string

所在空间Id。

必需

parentId

string

必需

type

string

必需

类型，本接口返回类型是固定值。 FOLDER：文件夹

name

string

文件夹的名称。

必需

size

integer

必需

大小, 单位Byte。说明本接口添加文件夹，不返回该字段。

path

string

必需

文件夹在空间内的路径。

version

integer

必需

版本。说明本接口添加文件夹，不返回该字段。

status

string

必需

状态。 NORMAL：正常 DELETED：已删除

extension

string

必需

后缀。说明本接口添加文件夹，不返回该字段。

creatorId

string

必需

创建者unionId。

modifierId

string

必需

修改者unionId。

createTime

string

必需

创建时间，iso8601格式，例如：2022-07-29T14:55Z。

modifiedTime

string

必需

修改时间，iso8601格式，例如：2022-07-29T14:55Z。

properties

object

文件夹属性。

必需

appProperties

array [object {3}]

必需

在特定应用上的属性。key是空间的ownerId，value是属性列表。

uuid

string

标识字段。

必需

partitionType

string

必需

存储分区。 PUBLIC_OSS_PARTITION：公有云OSS存储分区 MINI_OSS_PARTITION：专属MiniOSS存储分区

storageDriver

string

必需

驱动类型。 DINGTALK：钉钉统一存储驱动 ALIDOC：钉钉文档存储驱动 UNKNOWN：未知驱动

修改于 2024-01-15 09:03:47

获取空间信息

复制文件或文件夹

添加文件夹

接口调用说明#

权限#

请求参数

返回响应

接口调用说明

权限