1. 获取文件列表
获取文件列表。
请求方式：GET
请求地址：/bosdocumentservice/{appKey}/files?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": [
{
返回数据内容。
}
],
"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处理。
1.6. 请求示例
请求URL
http://bosgw.bimwinner.com/bosfoundationservice/w8486e2a067e4bdab7630546ad01751a/files
Headers
Authorization: eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyS2V5IjoiMTUyN2ZmYWRhZjhhNGY0YWJhZTk4NWM2N2JiZDQ5NmQiLCJ1c2VyTmFtZSI6InJhb2ppYWp1biIsInVzZXJUeXBlIjoiMCIsImFwcEtleSI6InE4NWU4NTdhZWIwODQ1ZjE5YzBkY2QyYTQyNmUxMWUwIiwiYXBwTmFtZSI6InRlc3QxMTExMTEyMyIsImFwcERiIjoicTg1ZTg1N2FlYjA4NDVmMTljMGRjZDJhNDI2ZTExZTAiLCJsb2dpblRpbWUiOiIxNTk2Njk4MDAyMTA3IiwiZXhwIjowfQ.XsKFdpYnnH1lJ__u6x-4tvCnJ2BX7WfJ5EMGMAWfCe8
Body（application/json）
null
正常响应 200
{
"message": "请求处理成功",
"code": "SUCCESS",
"data": {
"per_page": null,
"data": [
{
"parameter": {
"bosclass": "files",
"code": "Z3JvdXAxMyxNNzgvMDQvMDMvckJBQUcxOHRHVGFBTnhFNEFBanpXUmtaejUwODM4LmlmYw==",
"currentUserPermissions": "rwdc",
"gacl": [
{
"principal": "users/1527ffadaf8a4f4abae985c67bbd496d",
"permissions": "rwdc",
"flags": "",
"type": "A"
}
],
"gcreatetime": "1596791094628",
"gtime": "1596791095919",
"guser": "users/1527ffadaf8a4f4abae985c67bbd496d",
"key": "e219f0b1ea954f3aa5631747ce482e59",
"mimeType": "application/octet-stream",
"modelDB": "o5ef1e5649cd47fca423ad1bb7669a03",
"modelFileKey": "Z3JvdXAxMyxNNzgvMDQvMDMvckJBQUcxOHRHVGFBTnhFNEFBanpXUmtaejUwODM4LmlmYw==",
"modelKey": "M1596791095745",
"modelType": "IFC",
"name": "半球台灯.ifc",
"path": "Z3JvdXAxMyxNNzgvMDQvMDMvckJBQUcxOHRHVGFBTnhFNEFBanpXUmtaejUwODM4LmlmYw==",
"size": 586585
},
"relationship": {
"irDocumentFile": {
"documents": [
{
"code": "09d1e1ec08904be6a83932f3a125a0cb",
"uri": "http://bosgw.bimwinner.com/bosfoundationservice/w8486e2a067e4bdab7630546ad01751a/prototype/entity/documents/033d59697bc6402484384345b0863f6a",
"relationshipKey": "9c8dc3106a764bbdb2cbed2a45c92254"
}
]
}
}
},
{
"parameter": {
"bosclass": "files",
"code": "Z3JvdXAxMyxNNzgvMDQvMDQvckJBQUcxOHRHbUdBZDNtTUFBanpXUmtaejUwMjMyLmlmYw==",
"currentUserPermissions": "rwdc",
"gacl": [
{
"principal": "users/1527ffadaf8a4f4abae985c67bbd496d",
"permissions": "rwdc",
"flags": "",
"type": "A"
}
],
"gcreatetime": "1596791393561",
"gtime": "1596791393765",
"guser": "users/1527ffadaf8a4f4abae985c67bbd496d",
"key": "fa782634023b4ba389d8212efbb5cc7f",
"mimeType": "application/octet-stream",
"modelDB": "o5ef1e5649cd47fca423ad1bb7669a03",
"modelFileKey": "Z3JvdXAxMyxNNzgvMDQvMDQvckJBQUcxOHRHbUdBZDNtTUFBanpXUmtaejUwMjMyLmlmYw==",
"modelKey": "M1596791393752",
"modelType": "IFC",
"name": "半球台灯.ifc",
"path": "Z3JvdXAxMyxNNzgvMDQvMDQvckJBQUcxOHRHbUdBZDNtTUFBanpXUmtaejUwMjMyLmlmYw==",
"size": 586585
},
"relationship": {}
},
{
"parameter": {
"bosclass": "files",
"code": "Z3JvdXAxMyxNNzgvMDQvMDQvckJBQUcxOHRIQ0tBYVlhakFBanpXUmtaejUwMzMwLmlmYw==",
"currentUserPermissions": "rwdc",
"gacl": [
{
"principal": "users/1527ffadaf8a4f4abae985c67bbd496d",
"permissions": "rwdc",
"flags": "",
"type": "A"
}
],
"gcreatetime": "1596791842119",
"gtime": "1596791842349",
"guser": "users/1527ffadaf8a4f4abae985c67bbd496d",
"key": "752a613884594df3a8865a9f277d3cfd",
"mimeType": "application/octet-stream",
"modelDB": "o5ef1e5649cd47fca423ad1bb7669a03",
"modelFileKey": "Z3JvdXAxMyxNNzgvMDQvMDQvckJBQUcxOHRIQ0tBYVlhakFBanpXUmtaejUwMzMwLmlmYw==",
"modelKey": "M1596791842334",
"modelType": "IFC",
"name": "半球台灯.ifc",
"path": "Z3JvdXAxMyxNNzgvMDQvMDQvckJBQUcxOHRIQ0tBYVlhakFBanpXUmtaejUwMzMwLmlmYw==",
"size": 586585
},
"relationship": {}
},
{
"parameter": {
"bosclass": "files",
"code": "Z3JvdXAxMyxNNzgvMDQvMDQvckJBQUcxOHRHVktBRzZKSUFBanpXUmtaejUwOTk1LmlmYw==",
"currentUserPermissions": "rwdc",
"gacl": [
{
"principal": "users/1527ffadaf8a4f4abae985c67bbd496d",
"permissions": "rwdc",
"flags": "",
"type": "A"
}
],
"gcreatetime": "1596791122673",
"gtime": "1596791122922",
"guser": "users/1527ffadaf8a4f4abae985c67bbd496d",
"key": "94f800f254a6438982eafccbcb301aba",
"mimeType": "application/octet-stream",
"modelDB": "o5ef1e5649cd47fca423ad1bb7669a03",
"modelFileKey": "Z3JvdXAxMyxNNzgvMDQvMDQvckJBQUcxOHRHVktBRzZKSUFBanpXUmtaejUwOTk1LmlmYw==",
"modelKey": "M1596791122913",
"modelType": "IFC",
"name": "半球台灯.ifc",
"path": "Z3JvdXAxMyxNNzgvMDQvMDQvckJBQUcxOHRHVktBRzZKSUFBanpXUmtaejUwOTk1LmlmYw==",
"size": 586585
},
"relationship": {}
}
],
"count": 4,
"page": 1
}
}