1. 列出文档

获取document列表。

请求方式：GET

请求地址：/bosdocumentservice/{appKey}/documents?noRelation={noRelation}

1.1. 请求参数：

Headers：

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

PathParas：

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

SearchParas：

参数名	类型	示例	是否必填	参数含义
noRelation	boolean	true/false	否	true表示不返回关联关系，false表示返回所有关联关系
whitelist	string	xxx,yyy,zzz	否	指定返回属性字段，多个属性字段英文逗号隔开
limit	number	5	否	指定返回记录的数量
offset	number	1	否	指定返回记录的开始位置
page	number	2	否	指定第几页，依赖参数：per_page
per_page	number	10	否	每页的记录数，依赖参数：page
sortby	string	order	否	指定返回结果按照哪个属性排序，依赖参数：order
order	string	asc/desc	否	排序顺序:asc为升序,desc为降序，依赖参数：sortby

Body：

application/json：

NULL

1.2. 参数说明：

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

1.3. 正确返回：

Http Status Code：200
{
    "code": "SUCCESS",
    "message": "请求处理成功",
    "data": {
        "data": [
            {
            返回数据内容。
            "gLongCode": "",   //所属文件夹code路径
            "gLongName": ""   //所属文件夹name路径
            }
        ],
        "count": 10,
        "page": 1,
        "per_page": 20
    }
}

1.4. 状态码：

状态码	code	message	data	原因
NULL	NULL	NULL	NULL	NULL

1.5. 注意事项：

1、当noRelation为false时，同时返回用户有权限获取的关联关系。

2、 noRelation如若未传默认值为false，如若参数值非法按默认值为false处理。

3、同时返回gLongCode、gLongName，gLongCode代表文档所属文件夹key路径，依次由根文件夹到文档所属直接文件夹的key组成，中间用※分隔；gLongName代表文档所属文件夹name路径，依次由根文件夹到文档所属直接文件夹的name组成，中间用※分隔

1.6. 请求示例

请求URL

http://bosgw.bimwinner.com/bosfoundationservice/w8486e2a067e4bdab7630546ad01751a/documents

Headers

Authorization: eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyS2V5IjoiMTUyN2ZmYWRhZjhhNGY0YWJhZTk4NWM2N2JiZDQ5NmQiLCJ1c2VyTmFtZSI6InJhb2ppYWp1biIsInVzZXJUeXBlIjoiMCIsImFwcEtleSI6InE4NWU4NTdhZWIwODQ1ZjE5YzBkY2QyYTQyNmUxMWUwIiwiYXBwTmFtZSI6InRlc3QxMTExMTEyMyIsImFwcERiIjoicTg1ZTg1N2FlYjA4NDVmMTljMGRjZDJhNDI2ZTExZTAiLCJsb2dpblRpbWUiOiIxNTk2Njk4MDAyMTA3IiwiZXhwIjowfQ.XsKFdpYnnH1lJ__u6x-4tvCnJ2BX7WfJ5EMGMAWfCe8

Body（application/json）

null

正常响应 200

{
    "message": "请求处理成功",
    "code": "SUCCESS",
    "data": {
        "per_page": null,
        "data": [
            {
                "parameter": {
                    "bosclass": "documents",
                    "code": "doc-001",
                    "currentUserPermissions": "rwdc",
                    "description": "test",
                    "gacl": [
                        {
                            "principal": "users/1527ffadaf8a4f4abae985c67bbd496d",
                            "permissions": "rwdc",
                            "flags": "",
                            "type": "A"
                        }
                    ],
                    "gcreatetime": "1596793212441",
                    "gtime": "1596793212441",
                    "guser": "users/1527ffadaf8a4f4abae985c67bbd496d",
                    "key": "5247e9572aae434abe56644d0ec5ad69",
                    "name": "二维图纸",
                    "revision": "0",
                    "size": 20671267
                },
                "relationship": {
                    "irDocumentFile": {
                        "files": [
                            {
                                "code": "Z3JvdXAxMyxNNzgvMDQvMDQvckJBQUcxOHRJV1NBY0dLWkFUdHJJd0FwdzNnNTg5LmlmYw==",
                                "uri": "http://bosgw.bimwinner.com/bosfoundationservice/w8486e2a067e4bdab7630546ad01751a/prototype/entity/files/6ff47109865341dcb2cef982e0891b57",
                                "relationshipKey": "2fb3692d2db34b7ca2f7197f7d8d613e"
                            }
                        ]
                    }
                }
            },
            {
                "parameter": {
                    "bosclass": "documents",
                    "code": "09d1e1ec08904be6a83932f3a125a0cb",
                    "currentUserPermissions": "rwdc",
                    "description": "",
                    "gacl": [
                        {
                            "principal": "users/1527ffadaf8a4f4abae985c67bbd496d",
                            "permissions": "rwdc",
                            "flags": "",
                            "type": "A"
                        }
                    ],
                    "gcategory": "ifc",
                    "gcreatetime": "1596791096704",
                    "gtime": "1596791096704",
                    "guser": "users/1527ffadaf8a4f4abae985c67bbd496d",
                    "key": "033d59697bc6402484384345b0863f6a",
                    "name": "半球台灯.ifc",
                    "revision": "0",
                    "size": 586585
                },
                "relationship": {
                    "irFolderDocument": {
                        "folders": [
                            {
                                "code": "1596791068484",
                                "uri": "http://bosgw.bimwinner.com/bosfoundationservice/w8486e2a067e4bdab7630546ad01751a/prototype/entity/folders/2973ab63c9c04c99b30df8cb083fc62a",
                                "relationshipKey": "9ff2e186ba654817bbaef6a882920a48"
                            }
                        ]
                    }
                }
            },
            {
                "parameter": {
                    "bosclass": "documents",
                    "code": "doc-001",
                    "currentUserPermissions": "rwdc",
                    "description": "test",
                    "gacl": [
                        {
                            "principal": "users/1527ffadaf8a4f4abae985c67bbd496d",
                            "permissions": "rwdc",
                            "flags": "",
                            "type": "A"
                        }
                    ],
                    "gcreatetime": "1596792540802",
                    "gtime": "1596792777281",
                    "guser": "users/1527ffadaf8a4f4abae985c67bbd496d",
                    "key": "db902998b9a24e418d7a1714e25bc2af",
                    "name": "二维图纸",
                    "revision": "0",
                    "size": 586585
                },
                "relationship": {
                    "irDocumentFile": {
                        "files": [
                            {
                                "code": "Z3JvdXAxMyxNNzgvMDQvMDQvckJBQUcxOHRINW1BRUdZOUFUdHJJd0FwdzNnNzAzLmlmYw==",
                                "uri": "http://bosgw.bimwinner.com/bosfoundationservice/w8486e2a067e4bdab7630546ad01751a/prototype/entity/files/48b84d259ba747e58165705685f1b5ec",
                                "relationshipKey": "c4e209d2b9ed48309334db5f294f5c9c"
                            }
                        ]
                    }
                }
            }
        ],
        "count": 3,
        "page": 1
    }
}

列出文档