1. 复制文档到其它文件夹
复制文档到其他文件夹。
请求方式:POST
请求地址:/bosdocumentservice/{appKey}/documents/copy-to-folder?rename={true}
1.1. 请求参数:
Headers:
参数名 | 类型 | 示例 | 是否必填 | 参数含义 |
---|---|---|---|---|
Authorization | string | c4570cb9ca324bc8ba7dd9d1967710ea | 是 | access_token |
PathParas:
参数名 | 类型 | 示例 | 是否必填 | 参数含义 |
---|---|---|---|---|
appKey | string | xb05cd3a35614caa85c0f8f86c58fcc1 | 是 | 应用Key |
rename | boolean | true/false | 是 | 文档重名时是否自动重命名,true为重命名;false为不重命名,如重名则报错 |
SearchParas:
参数名 | 类型 | 示例 | 是否必填 | 参数含义 |
---|---|---|---|---|
transactionCode | string | 3MD2XzN70VkcvbXllg7x7V | 否 | 业务事务编码 |
Body:
application/json:
{
"source": [
"doc001_0",
" doc002_0"
], //文档key列表
"destination": "FLD-001", //目标文件夹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 | ENTITY_NOTFOUND | Key为{key}的{bosclass}实体对象不存在 | NULL | 当{destination}对应的folder不存在时 |
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、 复制文档及历史版本文档及其关联文件。
2、 如rename为false则不可与目标文件夹中现有文档同名;如rename为true,当文档重名时自动重命名,格式为“原名_yyyyMMddHHmmss”。
3、 用户必须有该文档和目标文件夹的写权限。
4、 copyGacl如为false,则当前文档、历史版本文档、当前文档及历史版本文档关联的文件使用目标文件夹的权限。
5、 更新目标文件夹的size属性。
6、 所有文档都复制成功该接口才执行成功。