名词解释

文件管理服务API由以下基本类型构成，您需要熟悉以下的名词，以便更好的理解文件管理服务。

服务	基本类型	说明
domain	hubs	广联达产品为用户创建的存储空间，所有文件和数据都隶属于某个存储中心
domain	projects	项目，是存储中心下隶属于用户的项目，所有的文件都需要存放在相应的项目中
data	folders	文件夹
data	fileItems	文件项，可视为一个或多个版本的文件集
data	files	文件，用来描述同一文件项下不同的版本文件

以上几种存储类型之间存在关联关系，层级关系如下所示：

• 需要通过Hub导航到Project，每个用户的Project都隶属于某个广联达产品的存储中心（Hub）；
• Folder隶属于Project，Project会自动创建一个根文件夹，所有项目下的文件都存放于根文件夹下;
• FileItem位于Folder下一层级，也可以和Folder同一层级；
• File可以视为FileItem的一个子集，一个FileItem下可以有多个File。

访问密钥（Access Token）

Access Token代表了用户当前应用的身份，用户可以通过Access Token对自己应用内的文件发起文件上传、下载、删除、更新等操作，同时也能访问所有BIMFACE的服务端数据接口进行轻量化和数据服务等操作。因此，获取AccessToken是程序开发的第一步，更多关于Access Token的说明可参考Access Token (opens new window)。

错误码

当用户访问文件管理服务出现错误时，文件管理服务将返回给用户一个HTTP状态码，错误原因将在响应正文中返回，便于用户定位问题。

以下是伴随HTTP 404的错误码响应示例。

{
    "timestamp": 1646985853402,
    "status": 404,
    "error": "Not Found",
    "message": "",
    "path": "/bdfs/v1/projects/10000000006016/folders/10000000006017/parent"
}

术语表

名词	说明
Hub	广联达产品创建的存储中心
Project	项目
Folder	文件夹
FileItem	文件项
File	文件
Access Token	访问密钥
AppendFile	追加上传文件
Callback	回调
tenantCode	产品所属的租户
Meta	文件元信息。用来描述文件信息，例如长度，类型等
Data	文件数据