1. 删除文档
删除文档,更新key为{key}的文档实例。
请求方式:DELETE
请求地址:/bosdocumentservice/{appKey}/documents/{key}?allVersion={allVersion}&delRelation={ delRelation}
1.1. 请求参数:
Headers:
参数名 | 类型 | 示例 | 是否必填 | 参数含义 |
---|---|---|---|---|
Authorization | string | c4570cb9ca324bc8ba7dd9d1967710ea | 是 | access_token |
PathParas:
参数名 | 类型 | 示例 | 是否必填 | 参数含义 |
---|---|---|---|---|
appKey | string | xb05cd3a35614caa85c0f8f86c58fcc1 | 是 | 应用Key |
key | string | 33a895949c2d4c27a0973b2a162b72a9 | 是 | 文档document key |
SearchParas:
参数名 | 类型 | 示例 | 是否必填 | 参数含义 |
---|---|---|---|---|
allVersion | boolean | true/false | 是 | true代表删除所有历史版本;false代表仅删除最高版本 |
delRelation | boolean | true/false | 是 | true表示删除关联关系;false表示不删除任何关联关系,如有关系存在返回错误信息 |
transactionCode | string | 3MD2XzN70VkcvbXllg7x7V | 否 | 业务事务编码 |
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}的document不存在时 |
200 | ENTITY_DELETEPERMISSION_REQUIRED | 缺少实体对象{entity/key}的删除权限 | NULL | 当对文档无删除权限时 |
200 | ENTITY_RELATIONSHIP_EXIST | 实体对象{entity/key}存在关联关系 | NULL | 当delRelation值为false,且{key}的对象还存在关联关系时 |
200 | RELATIONSHIP_RELATIONENT | 缺少对关联实体对象{bosclass/key}的读权限 | NULL | 当删除关系时如果对关系中另一关联实体对象无读权限 |
200 | DOCUMENT_NOT_LATEST | Key为{key}的文档不是最高版本文档 | NULL | 当{key}对应的文档不是最高版本时 |
1.5. 注意事项:
1、 allVersion选填,true代表删除所有历史版本;false代表仅删除最高版本,如若未传默认值为false,如若参数值非法按默认值为false处理。
2、 当delRelation值为true,删除文档前先删除文档所有已存在的关联实例数据。delRelation如若未传默认值为false,如若参数值非法按默认值为false处理。
3、 删除文档时,如有历史版本文档则上一版变为最高版。
4、 如文档有关联的物理文件且delRelation值为true,则在删除文档时同时删除物理文件(不物理删除实际文件, documents、files、folders与documents的关联关系、documents与files的关联关系都存入历史数据表,以备还原操作)
5、 如文档有关联的物理文件且delRelation值为true,则在删除文档后更新文档原所属所有上层文件夹的size属性。
1.6. 请求示例
请求URL
http://bosgw.bimwinner.com/bosfoundationservice/w8486e2a067e4bdab7630546ad01751a/documents/b66ec83a912340cfbde45d70461f98df?delRelation=true&allVersion=true
Headers
Authorization: eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyS2V5IjoiMTUyN2ZmYWRhZjhhNGY0YWJhZTk4NWM2N2JiZDQ5NmQiLCJ1c2VyTmFtZSI6InJhb2ppYWp1biIsInVzZXJUeXBlIjoiMCIsImFwcEtleSI6InE4NWU4NTdhZWIwODQ1ZjE5YzBkY2QyYTQyNmUxMWUwIiwiYXBwTmFtZSI6InRlc3QxMTExMTEyMyIsImFwcERiIjoicTg1ZTg1N2FlYjA4NDVmMTljMGRjZDJhNDI2ZTExZTAiLCJsb2dpblRpbWUiOiIxNTk2Njk4MDAyMTA3IiwiZXhwIjowfQ.XsKFdpYnnH1lJ__u6x-4tvCnJ2BX7WfJ5EMGMAWfCe8
Body(application/json)
null
正常响应 200
{
"message": "请求处理成功",
"code": "SUCCESS",
"data": "b66ec83a912340cfbde45d70461f98df"
}