1. 更新文档
更新{key}的document实例。
请求方式:PUT
请求地址:/bosdocumentservice/{appKey}/documents/{key}
1.1. 请求参数:
Headers:
参数名 | 类型 | 示例 | 是否必填 | 参数含义 |
---|---|---|---|---|
Authorization | string | c4570cb9ca324bc8ba7dd9d1967710ea | 是 | access_token |
PathParas:
参数名 | 类型 | 示例 | 是否必填 | 参数含义 |
---|---|---|---|---|
appKey | string | xb05cd3a35614caa85c0f8f86c58fcc1 | 是 | 应用Key |
key | string | document-123 | 是 | 文档document key |
SearchParas:
参数名 | 类型 | 示例 | 是否必填 | 参数含义 |
---|---|---|---|---|
transactionCode | string | 3MD2XzN70VkcvbXllg7x7V | 否 | 业务事务编码 |
Body:
application/json:
{
"name": "二维图纸",
"files": [
{
"key": "xxx" //文件的key
}
],
"description": ""
}
1.2. 参数说明:
参数名 | 类型 | 示例 | 是否必填 | 参数含义 |
---|---|---|---|---|
name | string | NULL | 否 | 二维图纸 |
key | string | NULL | 否 | 文件的key |
1.3. 正确返回:
Http Status Code:200
{
"code": "SUCCESS",
"message": "请求处理成功",
"data": "http://bosgw.bimwinner.com/bosdocumentservice/h5e4ff8257dc4e86a8042097f67d2718/documents/xxxx"
}
1.4. 状态码:
状态码 | code | message | data | 原因 |
---|---|---|---|---|
200 | ENTITY_NOTFOUND | Key为{key}的{bosclass}实体对象不存在 | NULL | 当key为{key}的文档不存在时 |
200 | DOCUMENT_NAME_EXIST | 当前文件夹已存在名称为{name}的文档 | NULL | 当存在同名文档对象时 |
200 | ENTITY_NOTFOUND | Key为{key}的{bosclass}实体对象不存在 | NULL | 当files中的key不存在时 |
200 | ENTITY_READPERMISSION_REQUIRED | 缺少实体对象{bosclass/key}的读权限 | NULL | 如对files中指定key的物理文件无读权限 |
200 | ENTITY_READPERMISSION_REQUIRED | 缺少实体对象{bosclass/key}的写权限 | NULL | 如对{key}对应的文档无写权限 |
200 | ENTITY_NAME_INVALID | 实体对象name属性值无效 | NULL | 当name包含※时 |
1.5. 注意事项:
1、 如修改name参数时,需检查当前目录下是否有同名文档。
2、 如对file参数进行更新,需检查物理文件是否存在,同时更新文档的size属性、文档所属所有上层文件夹的size属性。
3、 需对物理文件有读权限。
4、 需对文档有写权限。
5、 如对象类启用了属性结构,则修改对象名称时需同时修改所有下层节点的longName。
1.6. 请求示例
请求URL
http://bosgw.bimwinner.com/bosfoundationservice/w8486e2a067e4bdab7630546ad01751a/documents/db902998b9a24e418d7a1714e25bc2af
Headers
Authorization: eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyS2V5IjoiMTUyN2ZmYWRhZjhhNGY0YWJhZTk4NWM2N2JiZDQ5NmQiLCJ1c2VyTmFtZSI6InJhb2ppYWp1biIsInVzZXJUeXBlIjoiMCIsImFwcEtleSI6InE4NWU4NTdhZWIwODQ1ZjE5YzBkY2QyYTQyNmUxMWUwIiwiYXBwTmFtZSI6InRlc3QxMTExMTEyMyIsImFwcERiIjoicTg1ZTg1N2FlYjA4NDVmMTljMGRjZDJhNDI2ZTExZTAiLCJsb2dpblRpbWUiOiIxNTk2Njk4MDAyMTA3IiwiZXhwIjowfQ.XsKFdpYnnH1lJ__u6x-4tvCnJ2BX7WfJ5EMGMAWfCe8
Body(application/json)
{
"bosclass": "documents",
"code": "doc-001", //文档编码
"name": "二维图纸", //文档名称
"files": [
{
"key": "48b84d259ba747e58165705685f1b5ec" //文件Key
}
],
"description": "test"
}
正常响应 200
{
"message": "请求处理成功",
"code": "SUCCESS",
"data": "http://bosgw.bimwinner.com/bosfoundationservice/w8486e2a067e4bdab7630546ad01751a/documents/db902998b9a24e418d7a1714e25bc2af"
}