# 属性手册
本节将列举文件管理服务所有存储类型以及属性,每种存储类型的返回码见后文示例。
# Hub
Hub中文名为存储中心,目前BIMFACE拥有专属的存储中心,未来也支持其他广联达产品创建存储中心。Hub的主要属性见下表:
属性 | 说明 |
---|---|
appKey | 当前查询Hub的用户的appKey |
sourceId | 调用方的文件源ID |
info | 描述该Hub的信息 |
name | Hub的名称 |
tenantCode | Hub所属的产品领域代码,每个Hub都隶属于唯一的产品领域(例如BIMFACE),每个产品领域有专属的代码,产品领域与对应的代码见接口文档。 |
createTime | 创建时间 |
updataTime | 更新时间 |
# Project
Project为项目存储空间,为Hub的下一层级。用户可以在一个Hub下创建多个项目存储空间。Project的主要属性见下表:
属性 | 说明 |
---|---|
appKey | 当前查询Project的用户的appKey |
hubId | 描述项目所属的HubId |
id | 项目标识码 |
info | 描述该项目的信息 |
name | 项目名称 |
tenantCode | 项目所在的Hub的产品领域代码,每个Hub都隶属于唯一的产品领域(例如BIMFACE),每个产品领域有专属的代码,产品领域与对应的代码见接口文档。 |
thumbnail | 项目缩略图 |
type | 项目类型 |
createTime | 创建时间 |
updataTime | 更新时间 |
# Folder
Folder中文名为文件夹,为文件或其他文件夹的集合,也是项目的下一层级存储单位。每一个项目可以包含多个文件夹和文件,其中文件夹和文件也可以在同一层级。Folder的主要属性见下表:
属性 | 说明 |
---|---|
appKey | 当前查询Folder的用户的appKey |
fileItemId | 文件夹的唯一标识码,和接口URI中folderId相同 |
folder | 判断是否为文件夹 |
id | 文件夹的标识码,目前文件夹暂无版本区别,和接口URI中folderId相同 |
length | 文件夹的大小,字节数 |
md5 | md5 |
name | 文件夹名称 |
parentId | 所属的父文件夹标识码,如果没有父文件夹,则为所属项目的标识码 |
physicalIndex | 对象存储索引 |
projectId | 所属项目的标识码 |
status | 任务状态 |
storeId | 内部存储唯一标识 |
uploadMode | 上传模式 |
createTime | 创建时间 |
updataTime | 更新时间 |
# FileItem
FileItem中文名为文件项。FileItem的主要属性见下表:
属性 | 说明 |
---|---|
appKey | 当前查询FileItem的用户的appKey |
fileItemId | 文件项的唯一标识码 |
fileItemName | 文件项的名称 |
id | 文件的标识码,这里与文件项标识码一致 |
name | 文件名称,这里与文件项名称一致 |
length | 文件的大小,字节数 |
md5 | md5 |
parentId | 所属的父文件夹标识码,如果没有父文件夹,则为所属项目的标识码 |
physicalIndex | 对象存储索引 |
projectId | 所属项目的标识码 |
status | 任务状态 |
storeId | 内部存储唯一标识 |
suffix | 文件后缀 |
uploadMode | 上传模式 |
createTime | 创建时间 |
updataTime | 更新时间 |
# File
File中文名为文件,可以视为FileItem的一个子集。File的主要属性见下表:
属性 | 说明 |
---|---|
appKey | 当前查询FileItem的用户的appKey |
fileItemId | 所属文件项的标识码 |
fileItemName | 所属文件项的名称 |
fileId | 文件的唯一标识码 |
id | 文件的标识码 |
name | 文件名称 |
length | 文件的大小,字节数 |
md5 | md5 |
parentId | 所属的父文件夹标识码,如果没有父文件夹,则为所属项目的标识码 |
physicalIndex | 对象存储索引 |
projectId | 所属项目的标识码 |
status | 任务状态 |
storeId | 内部存储唯一标识 |
suffix | 文件后缀 |
uploadMode | 上传模式 |
version | 文件版本 |
createTime | 创建时间 |
updataTime | 更新时间 |