1. 删除文件夹实例

删除文件夹实例,删除key为{key}的文件夹。

请求方式:DELETE

请求地址:/bosdocumentservice/{appKey}/folders/{key}

1.1. 请求参数:

Headers:

参数名 类型 示例 是否必填 参数含义
Authorization string c4570cb9ca324bc8ba7dd9d1967710ea access_token

PathParas:

参数名 类型 示例 是否必填 参数含义
appKey string xb05cd3a35614caa85c0f8f86c58fcc1 应用Key
key string 33a895949c2d4c27a0973b2a162b72a9 文件夹Key

SearchParas:

参数名 类型 示例 是否必填 参数含义
delRelation boolean true/false true表示删除关联关系;false表示不删除任何关联关系,如有关系存在返回错误信息
transactionCode string 3MD2XzN70VkcvbXllg7x7V 业务事务编码
inheritDelete boolean true/false 表示删除文件夹下全部子文件夹和文档 默认值false

Body:

application/json:

NULL

1.2. 参数说明:

参数名 类型 示例 是否必填 参数含义
NULL NULL NULL NULL NULL

1.3. 正确返回:

Http Status Code:200
{
    "code": "SUCCESS",
    "message": "请求处理成功",
    "data": "{key}"
}

1.4. 状态码:

状态码 code message data 原因
200 ENTITY_NOTFOUND Key为{key}的{bosclass}实体对象不存在 NULL 当{key}的folder不存在时
200 FOLDER_SUBFOLDER_EXIST 当前文件夹下存在子文件夹 NULL 当文件夹下有子文件夹时
200 FOLDER_DOCUMENT_EXIST 当前文件夹下存在文档 NULL 当文件夹下有文档时
200 ENTITY_DELETEPERMISSION_REQUIRED 缺少实体对象{bosclass/key}的删除权限 NULL 当对{key}的folder无删除权限时

1.5. 注意事项:

1、文件夹下如包含文档或子文件夹时不允许删除。

2、delRelation如若未传默认值为false,如若参数值非法按默认值为false处理。

版权所有@盈嘉互联(北京)科技有限公司 京ICP备15051988号-9 Copyright © 2022 all right reserved,powered by Gitbook该文件修订时间: 2022-05-16 19:01:04

results matching ""

    No results matching ""