1. 更新文件夹实例
更新文件夹信息,更新key为{key}的文件夹。
请求方式:PUT
请求地址:/bosdocumentservice/{appKey}/folders/{key}
1.1. 请求参数:
Headers:
参数名 | 类型 | 示例 | 是否必填 | 参数含义 |
---|---|---|---|---|
Authorization | string | c4570cb9ca324bc8ba7dd9d1967710ea | 是 | access_token |
PathParas:
参数名 | 类型 | 示例 | 是否必填 | 参数含义 |
---|---|---|---|---|
appKey | string | xb05cd3a35614caa85c0f8f86c58fcc1 | 是 | 应用Key |
key | string | 3a0f185b7cbd4fb49d587aeba1c4b43a | 是 | 文件夹Key |
SearchParas:
参数名 | 类型 | 示例 | 是否必填 | 参数含义 |
---|---|---|---|---|
transactionCode | string | 3MD2XzN70VkcvbXllg7x7V | 否 | 业务事务编码 |
Body:
application/json:
{
"bosclass": "folders",
"code": "33a895949c2d4c27a0973b2a162b72a9",
"name": "二维图纸",
"description": "可选"
}
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 | 当{key}的folder不存在时 |
200 | ENTITY_NOTFOUND | Key为{key}的{bosclass}实体对象不存在 | NULL | 当parentId对应的的folder不存在时 |
200 | ENTITY_WRITEPERMISSION_REQUIRED | 缺少实体对象{bosclass/parentId}的写权限 | NULL | 如对parentId对应的文件夹无写权限 |
200 | PARENTID_INVALID | 无效的父节点 | NULL | parentId设置当前文件夹或其任何下层节点 |
200 | ENTITY_NAME_INVALID | 实体对象name属性值无效 | NULL | 当name包含※时 |
1.5. 注意事项:
1、 bosclass不允许更新,如传递则忽略。
2、 仅需传递需更新的属性。
3、 可设置parentId指定父文件夹,值格式为“folders/xxxx”,需对父文件夹有写权限。
4、 不可将parentId指向当前文件夹。
5、 不可将parentId指向其所有下层节点(包括子文件夹、子文件内的子文件夹等)。
6、 修改文件夹名称时需同时修改所有下层节点(包括子文件夹、子文件内的子文件夹等)的longName。