1. 添加文档中包含的文件

添加文档中包含的文件,为key为{key}的文档添加包含的文件。

请求方式:POST

请求地址:/bosdocumentservice/{appKey}/documents/files?key={key}

1.1. 请求参数:

Headers:

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

PathParas:

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

SearchParas:

参数名 类型 示例 是否必填 参数含义
transactionCode string 3MD2XzN70VkcvbXllg7x7V 业务事务编码
key string doc-01 文档document key

Body:

application/json:

{
    "files": [
        "file_key1"    //物理文件key
    ]
}

1.2. 参数说明:

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

1.3. 正确返回:

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

1.4. 状态码:

状态码 code message data 原因
400 ENTITY_NOTFOUND Key为{key}的{bosclass}实体对象不存在 NULL 当file不存在时
400 RELATIONSHIP_EXIST 已存在左对象为{bosclass/key}、右对象为{bosclass/key}的关系对象 NULL 当file关联已存在时
400 ENTITY_NOTFOUND Key为{key}的{bosclass}实体对象不存在 NULL 当{key}的document不存在时
400 ENTITY_READPERMISSION_REQUIRED 缺少实体对象{bosclass/key}的读权限 NULL 如对files中指定key的物理文件无读权限
400 ENTITY_WRITEPERMISSION_REQUIRED 缺少实体对象{bosclass/key}的写权限 NULL 如对{key}对应的文档无写权限

1.5. 注意事项:

1、建立文档与物理文件的关联关系,需检查物理文件是否存在。

2、需对物理文件有读权限。

3、需对文档有写权限。

4、更新文档的size属性、文档所属所有上层文件夹的size属性。

1.6. 请求示例

请求URL

http://bosgw.bimwinner.com/bosfoundationservice/w8486e2a067e4bdab7630546ad01751a/documents/files?key=5247e9572aae434abe56644d0ec5ad69

Headers

Authorization: eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyS2V5IjoiMTUyN2ZmYWRhZjhhNGY0YWJhZTk4NWM2N2JiZDQ5NmQiLCJ1c2VyTmFtZSI6InJhb2ppYWp1biIsInVzZXJUeXBlIjoiMCIsImFwcEtleSI6InE4NWU4NTdhZWIwODQ1ZjE5YzBkY2QyYTQyNmUxMWUwIiwiYXBwTmFtZSI6InRlc3QxMTExMTEyMyIsImFwcERiIjoicTg1ZTg1N2FlYjA4NDVmMTljMGRjZDJhNDI2ZTExZTAiLCJsb2dpblRpbWUiOiIxNTk2Njk4MDAyMTA3IiwiZXhwIjowfQ.XsKFdpYnnH1lJ__u6x-4tvCnJ2BX7WfJ5EMGMAWfCe8

Body(application/json)

{
    "files": [
        "e3cb027258484bdd95233f959424f67d"    //物理文件key
    ]
}

正常响应 200

{
    "message": "请求处理成功",
    "code": "SUCCESS",
    "data": "http://bosgw.bimwinner.com/bosfoundationservice/w8486e2a067e4bdab7630546ad01751a/documents/5247e9572aae434abe56644d0ec5ad69"
}
版权所有@盈嘉互联(北京)科技有限公司 京ICP备15051988号-9 Copyright © 2022 all right reserved,powered by Gitbook该文件修订时间: 2022-05-16 19:01:04

results matching ""

    No results matching ""