1. 获取文档内的文件列表
获取文档内的文件列表,获取key为{key}的文档内的文件列表。
请求方式:GET
请求地址:/bosdocumentservice/{appKey}/documents/{key}/files?noRelation={noRelation}
1.1. 请求参数:
Headers:
参数名 | 类型 | 示例 | 是否必填 | 参数含义 |
---|---|---|---|---|
Authorization | string | c4570cb9ca324bc8ba7dd9d1967710ea | 是 | access_token |
PathParas:
参数名 | 类型 | 示例 | 是否必填 | 参数含义 |
---|---|---|---|---|
appKey | string | xb05cd3a35614caa85c0f8f86c58fcc1 | 是 | 应用Key |
key | string | doc-01 | 是 | 文档document 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 | 原因 |
---|---|---|---|---|
200 | ENTITY_NOTFOUND | Key为{key}的{bosclass}实体对象不存在 | NULL | 当{key}对应的文档不存在时 |
200 | ENTITY_READPERMISSION_REQUIRED | 缺少实体对象{bosclass/key}的读权限 | NULL | 如对{key}对应的文档无读权限 |
1.5. 注意事项:
1、当noRelation为false时,同时返回用户有权限获取的关联关系。
2、noRelation如若未传默认值为false,如若参数值非法按默认值为false处理。
3、需对文档{key}有读权限。
1.6. 请求示例
请求URL
http://bosgw.bimwinner.com/bosfoundationservice/w8486e2a067e4bdab7630546ad01751a/documents/5247e9572aae434abe56644d0ec5ad69/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": "Z3JvdXAxMyxNNzgvMDQvMDQvckJBQUcxOHRJV1NBY0dLWkFUdHJJd0FwdzNnNTg5LmlmYw==",
"currentUserPermissions": "rwdc",
"gacl": [
{
"principal": "users/1527ffadaf8a4f4abae985c67bbd496d",
"permissions": "rwdc",
"flags": "",
"type": "A"
}
],
"gcreatetime": "1596793188652",
"gtime": "1596793189279",
"guser": "users/1527ffadaf8a4f4abae985c67bbd496d",
"key": "6ff47109865341dcb2cef982e0891b57",
"mimeType": "application/octet-stream",
"modelDB": "o5ef1e5649cd47fca423ad1bb7669a03",
"modelFileKey": "Z3JvdXAxMyxNNzgvMDQvMDQvckJBQUcxOHRJV1NBY0dLWkFUdHJJd0FwdzNnNTg5LmlmYw==",
"modelKey": "M1596793189271",
"modelType": "IFC",
"name": "边坡填充.ifc",
"path": "Z3JvdXAxMyxNNzgvMDQvMDQvckJBQUcxOHRJV1NBY0dLWkFUdHJJd0FwdzNnNTg5LmlmYw==",
"size": 20671267
},
"relationship": {
"irDocumentFile": {
"documents": [
{
"code": "doc-001",
"uri": "http://bosgw.bimwinner.com/bosfoundationservice/w8486e2a067e4bdab7630546ad01751a/prototype/entity/documents/5247e9572aae434abe56644d0ec5ad69",
"relationshipKey": "2fb3692d2db34b7ca2f7197f7d8d613e"
}
]
}
}
}
],
"count": 1,
"page": 1
}
}