# 上传文件

要使用File Management文档管理的丰富的API,第一步需要把文件上传到File Management存储中心。本节将介绍如何上传文件到项目中。

  • 准备阶段

在上传文件前,您需要获取有效的Access Token, 有关Access Token 的详细说明和具体操作,请参见 Access Token (opens new window)

文件上传前,请确认文件名称不包含特殊字符,/ \n  * \ <> | " : ?,否则无法上传成功。

# 1. 查找文件所属的Hub空间

File Management提供获取Hub列表 (opens new window) 接口,帮助您查询您的账号已注册哪些存储中心(Hub),您可以将文件上传到已注册的存储空间中。

# HTTP请求示例

# 请求 path
GET https://api.bimface.com/bdfs/domain/v1/hubs
# 请求 header
"Authorization: Bearer cn-e9725999-0b36-4c0e-bdca-38ea88888888"

# HTTP响应示例

# 响应 200
{
  "code" : "success",
  "data" : [ {
    "appKey" : "odatvZYUSAWMbdUjTU8HoZXB9tFt6123",
    "createTime" : "2022-02-02 02:02:02",
    "id" : "10000000000060002",
    "info" : "BIMFACE的hub",
    "name" : "BIMFACE",
    "tenantCode" : "BIMFACE",
    "updateTime" : "2022-02-02 02:02:02"
  } ],
  "message" : "success"
}

# 2. 查找到文件所属的Project

上一步您查找到了您账户注册的存储中心(Hub),假设您已经注册了"BIMFACE"的存储中心,请记住上一节响应正文中的id字段,它代表了HubId(10000000000060002)。

您需要在接口获取项目列表 (opens new window)中使用HubId,来获取可使用的项目列表(Project),正如基本概念里所说,创建项目(Project)的同时会自动创建对应的根文件夹,所有的文件会存放于项目的根文件夹下。

# HTTP请求示例

# 请求 path
GET https://api.bimface.com/bdfs/domain/v1/hubs/10000000000060002/projects
# 请求 header
"Authorization: Bearer cn-e9725999-0b36-4c0e-bdca-38ea88888888"

# HTTP响应示例

# 响应 200
{
  "code" : "success",
  "data" : [ {
    "appKey" : "odatvZYUSAWMbdUjTU8HoZXB9tFt6123",
    "createTime" : "2022-02-02 02:02:02",
    "hubId" : "10000000000060002",
    "id" : "10000000006016",
    "info" : "图纸对比的项目中心",
    "name" : "图纸对比",
    "tenantCode" : "BIMFACE",
    "thumbnail" : "https://static.bimface.com/bdfs/project/thumbnail/8e21fc91481e42ce805f0db938e04958_200X150.png",
    "type" : "NORMAL",
    "updateTime" : "2022-02-02 02:02:02"
  } ],
  "message" : "success"
}

# 3. 查询项目的根文件夹信息

在上一步中,您查找到了文件存放的项目信息,假设您将在项目“图纸对比”中上传文件,请记住该项目的id(10000000006016),您需要在获取项目根文件夹信息 (opens new window)和上传文件相关的接口中使用projectId。

这一步将介绍根文件夹的概念,每个项目都有唯一且对应的根文件夹,根文件夹会跟随项目自动创建,所有存放于该项目的文件都位于根文件夹下。

您可在这一步查询根文件夹的信息。根文件夹的信息(例如id和path)可用于查询项目下文件列表 (opens new window)上传文件 (opens new window);由于在BIMFACE中,项目id和根文件夹id相同,若您想直接在项目根目录下上传文件、创建文件夹,也可将项目Id作为parentId填入参数,这样您可直接跳过这一步。

# HTTP请求示例

# 请求 path
https://api.bimface.com/bdfs/v1/domain/hubs/10000000000060002/projects/10000000006016/root-folder
# 请求 header
"Authorization: Bearer cn-e9725999-0b36-4c0e-bdca-38ea88888888"

# HTTP响应示例

# 响应 200
{
  "code" : "bimfaceservice-0000",
  "data" : {
    "appKey" : "odatvZYUSAWMbdUjTU8HoZXB9tFt6123",
    "createTime" : "2022-02-02 02:02:02",
    "fileItemId" : "10000000006016",
    "folder" : false,
    "id" : "10000000006016",
    "length" : 0,
    "md5" : null,
    "name" : "/",
    "parentId" : null,
    "path" : "/",
    "physicalIndex" : null,
    "projectId" : "10000000006016",
    "status" : "success",
    "storeId" : null,
    "suffix" : null,
    "updateTime" : "2022-02-02 02:02:02",
    "uploadMode" : null,
    "version" : 1
  },
  "message" : null
}

# 4. 创建文件夹

在第2步中,您获取了将要存储文件的项目(Project),假设您将在项目“图纸对比”中上传文件,请记住该项目的id(10000000006016),您需要在创建文件夹 (opens new window)和上传文件相关的接口中使用projectId。

这一步将介绍如何在指定项目下创建文件夹,您可以将文件分类上传至不同文件夹中;您也可以跳过这一步,不创建文件夹,直接在项目下上传文件。

# HTTP请求示例

# 请求 path
POST https://api.bimface.com/bdfs/data/v1/projects/10000000006016/folders
# 请求 header
"Authorization: Bearer cn-e9725999-0b36-4c0e-bdca-38ea88888888"
# 请求 body
{
  "autoRename" : false,
  "name" : "dwg图纸文件夹",
  "parentId" : "10000000006016",
}

# 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" : "dwg图纸文件夹",
    "parentId" : "10000000006016",
    "physicalIndex" : null,
    "projectId" : "10000000006016",
    "status" : "success",
    "storeId" : null,
    "suffix" : null,
    "updateTime" : "2022-02-02 02:02:02",
    "uploadMode" : null,
    "version" : 1
  },
  "message" : "success"
}

# 5. 上传文件

在上一步中您创建了文件夹(Folder),用于分类存放文件,请记住您要存放的文件夹“dwg图纸文件夹”的id,上传普通文件流 (opens new window)的接口需要folderId来明确文件存放的位置。

在上传文件的接口中,您可以根据实际情况,填写parentId,若文件存放在文件夹中,则parentId处需填入文件夹id(folderId);若文件直接存放在项目下,则parentId处需填入项目id(projectId)或根文件夹id.

本节将介绍File Management文件上传的两种方法。除此之外,BIMFACE还支持追加上传 (opens new window)分片上传 (opens new window),主要解决大文件上传,或者网络环境较差时的上传问题,具体方法请参见相关接口文档。

  • 普通文件流上传

需要上传的文件在本地,可使用普通文件流上传。

# HTTP请求示例

# 请求 path
POST https://api.bimface.com/bdfs/data/v1/projects/10000000006016/fileItems?length=345345345&name=sample.dwg
# 请求 header
"Authorization: Bearer cn-e9725999-0b36-4c0e-bdca-38ea88888888"

# HTTP响应示例

# 响应 200
{
  "code" : "success",
  "data" : {
    "appKey" : "odatvZYUSAWMbdUjTU8HoZXB9tFt6123",
    "createTime" : "2022-02-02 02:02:02",
    "fileItemId" : "1938888813662976",
    "folder" : false,
    "id" : "1938888813662976",
    "length" : 345345345,
    "md5" : "sdfhskbvnksdiuewriusbndskudf",
    "name" : "sample.dwg",
    "parentId" : "10000000006555",
    "physicalIndex" : "a72eaf22f4214a6384429f78b690c983",
    "projectId" : "10000000006016",
    "status" : "success",
    "storeId" : "10000000021156",
    "suffix" : "dwg",
    "updateTime" : "2022-02-02 02:02:02",
    "uploadMode" : "GENERAL",
    "version" : 1
  },
  "message" : "success"
}
  • 指定外部文件url方式上传

如果需要上传的文件不在本地,且该文件可以通过HTTP协议的URL进行下载,BIMFACE支持传入该文件的URL,自动进行下载并完成文件上传,无须用户先下载,再上传。

# HTTP请求示例

# 请求 path
POST https://api.bimface.com/bdfs/data/v1/projects/10000000006016/fileItems/sourceUrl?name=sample.rvt&url=https://static.bimface.com/attach/cccc1d004e66a98569c7963a077d_sample.dwg&parentId=10000000006555
# 请求 header
"Authorization: Bearer cn-e9725999-0b36-4c0e-bdca-38ea88888888"

# HTTP响应示例S

# 响应 200
{
  "code" : "success",
  "data" : {
    "appKey" : "odatvZYUSAWMbdUjTU8HoZXB9tFt6123",
    "createTime" : "2022-02-02 02:02:02",
    "fileItemId" : "1938888813662976",
    "folder" : false,
    "id" : "1938888813662976",
    "length" : 345345345,
    "md5" : "sdfhskbvnksdiuewriusbndskudf",
    "name" : "sample.dwg",
    "parentId" : "10000000006555",
    "physicalIndex" : "a72eaf22f4214a6384429f78b690c983",
    "projectId" : "10000000006016",
    "status" : "success",
    "storeId" : "10000000021156",
    "suffix" : "dwg",
    "updateTime" : "2022-02-02 02:02:02",
    "uploadMode" : "GENERAL",
    "version" : 1
  },
  "message" : "success"
}