1. 移动文档到其它文件夹

移动文档到其他文件夹。

请求方式:POST

请求地址:/bosdocumentservice/{appKey}/documents/move-to-folder

1.1. 请求参数:

Headers:

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

PathParas:

参数名 类型 示例 是否必填 参数含义
appKey string xb05cd3a35614caa85c0f8f86c58fcc1 应用Key

SearchParas:

参数名 类型 示例 是否必填 参数含义
transactionCode string 3MD2XzN70VkcvbXllg7x7V 业务事务编码

Body:

application/json:

{
    "source": [
        "DOC-001",
        " DOC-002"
    ],    //文档key列表
    "destination": "FLD-003",    //目标文件夹key
    "copyGacl": true    //true表示移动后的文档带原权限,false表示移动后的文档使用目标文件夹的权限
}

1.2. 参数说明:

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

1.3. 正确返回:

Http Status Code:200{"code":"SUCCESS","message":"请求处理成功","data":"http://bosgw.bimwinner.com/bosdocumentservice/h5e4ff8257dc4e86a8042097f67d2718/folders/xxxx"}

1.4. 状态码:

状态码 code message data 原因
200 ENTITY_NOTFOUND Key为{key}的{bosclass}实体对象不存在 NULL 当{source}中有文件夹对象不存在时
200 DOCUMENT_NAME_EXIST 当前文件夹已存在名称为{name}的文档 NULL 当目标目录中有同名文档时
200 ENTITY_WRITEPERMISSION_REQUIRED 缺少实体对象{bosclass/key}的写权限 NULL 当用户对该文档没有写权限时
200 ENTITY_WRITEPERMISSION_REQUIRED 缺少实体对象{bosclass/key}的写权限 NULL 当用户对目标文件夹没有写权限时
200 SOURCE_DOCUMENT_REQUIRED 复制文档source参数必填 NULL 当source属性未提供时
200 DESTINATION_FOLDER_REQUIRED 目标文件夹destination参数必填 NULL 当destination属性未提供时

1.5. 注意事项:

1、当{key}的folder不存在时,HTTP200返回的数据体为:

{"code":"ENTITY_NOTFOUND","message":"Key为{key}的{bosclass}实体对象不存在","data":NULL}

2、当目标目录中有同名文档时,HTTP200返回的数据体为:

{"code":"DOCUMENT_NAME_EXIST","message":"当前文件夹已存在名称为{name}的文档","data":NULL}

3、当用户对该文档没有写权限时,HTTP200返回的数据体为:

{"code":"ENTITY_WRITEPERMISSION_REQUIRED", "message":"缺少实体对象{bosclass/key}的写权限","data":NULL}

4、当用户对目标文件夹没有写权限时,HTTP200返回的数据体为:

{"code":"ENTITY_WRITEPERMISSION_REQUIRED", "message":"缺少实体对象{bosclass/key}的写权限","data":NULL}

5、当source属性未提供时,HTTP200返回的数据体为:

{"code":"SOURCE_DOCUMENT_REQUIRED", "message":"复制文档source参数必填","data":NULL}

6、当destination属性未提供时,HTTP200返回的数据体为:

{"code":"DESTINATION_FOLDER_REQUIRED", "message":"目标文件夹destination参数必填","data":NULL}

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

results matching ""

    No results matching ""