# 获取文件夹下的所有文件

POST https://api.bimface.com/bdfs/data/v1/projects/{projectId}/folders/contents

# 说明

通过接口获取指定文件夹下所有的文件信息,也可获取指定项目下所有文件列表,BIMFACE支持根据父文件Id或父文件夹路径两种方式获取。

# 参数

Authorization * Bearer {accessToken} string
*为必填项
# Path
projectId * 项目id string
*为必填项
# Body
parentId* 父目录文件id(parentId和parentPath,必须二选一填入) string
parentPath* 父目录文件路径(parentId和parentPath,必须二选一填入) string
sourceId 调用方文件源id string
withItemSource 是否返回ItemSource信息,默认为false boolean
pageNo 开始页码,默认为1 int32
name 文件名字 string
pageSize 每页大小,默认20 int32
startTime 开始时间,格式为YYYY-MM-DD HH:mm:ss string
endTime 结束时间,格式为YYYY-MM-DD HH:mm:ss string
suffix 文件后缀 string
useFuzzySearch 当传了name,是否开启模糊查询,默认开启 boolean
excludeFolder 是否排除文件夹,默认为true boolean

# 响应

HTTP代码 说明 类型
200 OK RestResponse«PagedList«FileItemDTO»»
201 Created -
401 Unauthorized -
403 Forbidden -
404 Not Found -
# 200响应参数
RestResponse«PagedList«FileItemDTO»»
名称 说明 类型
code 状态代码 string
data 返回数据 PagedList«FileItemDTO»
list 返回列表 < FileItemDTO >array
physicalIndex 对象存储索引 string
fileItemId 文件id string
length 文件大小 int64
updateTime 文件更新时间 string
storeId 内部存储唯一标识 string
suffix 文件后缀 string
version 文件版本号 int32
parentId 父目录id string
folder 是否是文件夹 boolean
createTime 文件创建时间 string
name 文件名称 string
appKey appKey string
id versionId string
uploadMode 上传模式 string
projectId 项目id string
md5 md5 string
status 文件状态 string
message 提示信息 string

# 消耗

  • application/json

# 生成

  • application/json
  • */*

# HTTP请求示例

# 请求 path
https://api.bimface.com/bdfs/data/v1/projects/10000000006016/folders/contents
# 请求 header
"Authorization: Bearer cn-e9725999-0b36-4c0e-bdca-38ea88888888"
# 请求 body
{
  "endTime" : "2022-02-04 02:02:02",
  "excludeFolder" : false,
  "parentId" : "10000000006016",
  "startTime" : "2022-02-01 02:02:02",
  "suffix" : "rvt",
  "useFuzzySearch" : false,
}

# HTTP响应示例

# 响应 200
{
  "code" : "success",
  "data" : [
{
    "appKey" : "odatvZYUSAWMbdUjTU8HoZXB9tFt6123",
    "createTime" : "2022-02-02 02:02:02",
    "fileItemId" : "1938888813662976",
    "folder" : true,
    "id" : "1938888813662976",
    "length" : 0,
    "md5" : null,
    "name" : "BIMFACE文件夹",
    "parentId" : "10000000006016",
    "physicalIndex" : null,
    "projectId" : "10000000006016",
    "status" : "success",
    "storeId" : null,
    "suffix" : null,
    "updateTime" : "2022-02-02 02:02:02",
    "uploadMode" : null,
    "version" : 1
  },
  {
    "appKey" : "odatvZYUSAWMbdUjTU8HoZXB9tFt6123",
    "createTime" : "2022-02-02 02:02:02",
    "fileItemId" : "1938888813662955",
    "folder" : false,
    "id" : "1938888813662955",
    "length" : 345345345,
    "md5" : "sdfhskbvnksdiuewriusbndskudf",
    "name" : "BIMFACE示例文件.rvt",
    "parentId" : "10000000006016",
    "physicalIndex" : "a72eaf22f4214a6384429f78b690c983",
    "projectId" : "10000000006016",
    "status" : "success",
    "storeId" : "10000000021156",
    "suffix" : "rvt",
    "updateTime" : "2022-02-02 02:02:02",
    "uploadMode" : "GENERAL",
    "version" : 1
  }],
  "message" : "success"
}